Maxim Integrated / MaximBLE

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BLE_Thermometer MAXWSNENV_demo

Embed: (wiki syntax)

« Back to documentation index

dm_api.h File Reference
Data Structures | Typedefs | Enumerations | Functions

dm_api.h File Reference

Device Manager subsystem API. More...

Go to the source code of this file.

Data Structures

struct  dmCfg_t
struct  dmSecLtk_t
struct  dmSecIrk_t
struct  dmSecCsrk_t
union  dmSecKey_t
struct  dmSecPairCmplIndEvt_t
struct  dmSecEncryptIndEvt_t
struct  dmSecAuthReqIndEvt_t
struct  dmSecPairIndEvt_t
struct  dmSecSlaveIndEvt_t
struct  dmSecKeyIndEvt_t
struct  dmAdvNewAddrIndEvt_t
union  dmEvt_t

Typedefs

typedef uint8_t dmConnId_t
typedef void(* dmCback_t )(dmEvt_t *pDmEvt)

Enumerations

enum  { ,
  DM_ADV_START_IND, DM_ADV_STOP_IND, DM_ADV_NEW_ADDR_IND, DM_SCAN_START_IND,
  DM_SCAN_STOP_IND, DM_SCAN_REPORT_IND, DM_CONN_OPEN_IND, DM_CONN_CLOSE_IND,
  DM_CONN_UPDATE_IND, DM_SEC_PAIR_CMPL_IND, DM_SEC_PAIR_FAIL_IND, DM_SEC_ENCRYPT_IND,
  DM_SEC_ENCRYPT_FAIL_IND, DM_SEC_AUTH_REQ_IND, DM_SEC_KEY_IND, DM_SEC_LTK_REQ_IND,
  DM_SEC_PAIR_IND, DM_SEC_SLAVE_REQ_IND, DM_PRIV_RESOLVED_ADDR_IND, DM_HW_ERROR_IND,
  DM_VENDOR_SPEC_IND
}

Functions

void DmAdvInit (void)
 Initialize DM advertising.
void DmAdvStop (void)
 Stop advertising.
void DmAdvPrivInit (void)
 Initialize private advertising.
void DmAdvPrivStop (void)
 Stop using a private resolvable address.
void DmScanInit (void)
 Initialize DM scanning.
void DmScanStop (void)
 Stop scanning.
void DmConnInit (void)
 Initialize DM connection manager.
void DmConnMasterInit (void)
 Initialize DM connection manager for operation as master.
void DmConnSlaveInit (void)
 Initialize DM connection manager for operation as slave.
void DmDevReset (void)
 Reset the device.
uint8_t DmDevRole (void)
 Return the device role indicating master or slave.
void DmDevWhiteListClear (void)
 Clear the white list. Note that this function cannot be called while advertising, scanning, or connecting with white list filtering active.
void DmSecInit (void)
 Initialize DM security.
void DmPrivInit (void)
 Initialize DM privacy module.
uint8_t * DmSecGetLocalCsrk (void)
 For internal use only. This function gets the local CSRK used by the device.
uint8_t * DmSecGetLocalIrk (void)
 For internal use only. This function gets the local IRK used by the device.

Detailed Description

Device Manager subsystem API.

Date:
2012-09-11 16:18:57 -0700 (Tue, 11 Sep 2012)
Revision:
349

Copyright (c) 2009-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 dm_api.h.

Typedef Documentation

typedef void(* dmCback_t)(dmEvt_t *pDmEvt)

Callback type

Definition at line 350 of file dm_api.h.

typedef uint8_t dmConnId_t

Connection identifier

Definition at line 235 of file dm_api.h.

Enumeration Type Documentation

anonymous enum
Enumerator:
DM_ADV_START_IND 

Reset complete

DM_ADV_STOP_IND 

Advertising started

DM_ADV_NEW_ADDR_IND 

Advertising stopped

DM_SCAN_START_IND 

New resolvable address has been generated

DM_SCAN_STOP_IND 

Scanning started

DM_SCAN_REPORT_IND 

Scanning stopped

DM_CONN_OPEN_IND 

Scan data received from peer device

DM_CONN_CLOSE_IND 

Connection opened

DM_CONN_UPDATE_IND 

Connection closed

DM_SEC_PAIR_CMPL_IND 

Connection update complete

DM_SEC_PAIR_FAIL_IND 

Pairing completed successfully

DM_SEC_ENCRYPT_IND 

Pairing failed or other security failure

DM_SEC_ENCRYPT_FAIL_IND 

Connection encrypted

DM_SEC_AUTH_REQ_IND 

Encryption failed

DM_SEC_KEY_IND 

PIN or OOB data requested for pairing

DM_SEC_LTK_REQ_IND 

Security key indication

DM_SEC_PAIR_IND 

LTK requested for encyption

DM_SEC_SLAVE_REQ_IND 

Incoming pairing request from master

DM_PRIV_RESOLVED_ADDR_IND 

Incoming security request from slave

DM_HW_ERROR_IND 

Private address resolved

DM_VENDOR_SPEC_IND 

Hardware Error

Definition at line 202 of file dm_api.h.

Function Documentation

DmAdvInit ( void   )

Initialize DM advertising.

Returns:
None.
DmAdvPrivInit ( void   )

Initialize private advertising.

Returns:
None.
DmAdvPrivStop ( void   )

Stop using a private resolvable address.

Returns:
None.
DmAdvStop ( void   )

Stop advertising.

Returns:
None.
DmConnInit ( void   )

Initialize DM connection manager.

Returns:
None.
DmConnMasterInit ( void   )

Initialize DM connection manager for operation as master.

Returns:
None.
DmConnSlaveInit ( void   )

Initialize DM connection manager for operation as slave.

Returns:
None.
DmDevReset ( void   )

Reset the device.

Returns:
None.
DmDevRole ( void   )

Return the device role indicating master or slave.

Returns:
Device role.
DmDevWhiteListClear ( void   )

Clear the white list. Note that this function cannot be called while advertising, scanning, or connecting with white list filtering active.

Returns:
None.
DmPrivInit ( void   )

Initialize DM privacy module.

Returns:
None.
DmScanInit ( void   )

Initialize DM scanning.

Returns:
None.
DmScanStop ( void   )

Stop scanning.

Returns:
None.
DmSecGetLocalCsrk ( void   )

For internal use only. This function gets the local CSRK used by the device.

Returns:
Pointer to CSRK.
DmSecGetLocalIrk ( void   )

For internal use only. This function gets the local IRK used by the device.

Returns:
Pointer to IRK.
DmSecInit ( void   )

Initialize DM security.

Returns:
None.
Generated on Tue Jul 12 2022 19:59:22 by  doxygen 1.7.2