Maxim Integrated / MaximBLE

Dependents:   BLE_Thermometer MAXWSNENV_demo

Embed: (wiki syntax)

« Back to documentation index

smp_api.h File Reference

smp_api.h File Reference

SMP subsystem API. More...

Go to the source code of this file.

Data Structures

struct  smpCfg_t
struct  smpDmPair_t
struct  smpDmAuthRsp_t
struct  smpDmSecurityReq_t
union  smpDmMsg_t

Enumerations

enum  { ,
  SMP_MSG_API_PAIR_RSP, SMP_MSG_API_CANCEL_REQ, SMP_MSG_API_AUTH_RSP, SMP_MSG_API_SECURITY_REQ,
  SMP_MSG_CMD_PKT, SMP_MSG_CMD_PAIRING_FAILED, SMP_MSG_DM_ENCRYPT_CMPL, SMP_MSG_DM_ENCRYPT_FAILED,
  SMP_MSG_DM_CONN_CLOSE, SMP_MSG_WSF_AES_CMPL, SMP_MSG_INT_SEND_NEXT_KEY, SMP_MSG_INT_MAX_ATTEMPTS,
  SMP_MSG_INT_PAIRING_CMPL, SMP_MSG_INT_TIMEOUT, SMP_NUM_MSGS
}

Functions

void SmpiInit (void)
 Initialize SMP initiator role.
void SmprInit (void)
 Initialize SMP responder role.
void SmpNonInit (void)
 Use this SMP init function when SMP is not supported.

Variables

smpCfg_tpSmpCfg

Detailed Description

SMP subsystem API.

Date:
2011-10-14 21:35:03 -0700 (Fri, 14 Oct 2011)
Revision:
191

Copyright (c) 2010-2016 ARM Limited. All rights reserved.

SPDX-License-Identifier: LicenseRef-PBL

Licensed under the Permissive Binary License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.mbed.com/licenses/PBL-1.0

See the License for the specific language governing permissions and limitations under the License.

Definition in file smp_api.h.


Enumeration Type Documentation

anonymous enum

Event handler messages for SMP state machines

Enumerator:
SMP_MSG_API_PAIR_RSP 

API pairing request

SMP_MSG_API_CANCEL_REQ 

API pairing response

SMP_MSG_API_AUTH_RSP 

API cancel request

SMP_MSG_API_SECURITY_REQ 

API pin response

SMP_MSG_CMD_PKT 

API security request

SMP_MSG_CMD_PAIRING_FAILED 

SMP command packet received

SMP_MSG_DM_ENCRYPT_CMPL 

SMP pairing failed packet received

SMP_MSG_DM_ENCRYPT_FAILED 

Link encrypted

SMP_MSG_DM_CONN_CLOSE 

Link encryption failed

SMP_MSG_WSF_AES_CMPL 

Connection closed

SMP_MSG_INT_SEND_NEXT_KEY 

AES calculation complete

SMP_MSG_INT_MAX_ATTEMPTS 

Send next key to be distributed

SMP_MSG_INT_PAIRING_CMPL 

Maximum pairing attempts reached

SMP_MSG_INT_TIMEOUT 

Pairing complete

SMP_NUM_MSGS 

Pairing protocol timeout

Definition at line 38 of file smp_api.h.


Function Documentation

SmpiInit ( void   )

Initialize SMP initiator role.

Returns:
None.
SmpNonInit ( void   )

Use this SMP init function when SMP is not supported.

Returns:
None.
SmprInit ( void   )

Initialize SMP responder role.

Returns:
None.

Variable Documentation

Configuration pointer