bm_mode.h File Reference

BM mode.

Defines BM mode APIs to switch between different BM operation modes such as EEPROM Mode and Application Mode.

Copyright (c) 2018 Microchip Technology Inc. and its subsidiaries.

Defines BM operation mode enumerations.

#include "stdint.h"

Enumerations
enum	BM_MODE {   BM_MODE_PROGRAM = 0,   BM_MODE_APPLICATION }

Functions
uint16_t	BM_ConfigurationLibraryVersion (void)
	Gets the version of the BM configuration library. More...
void	BM_MODE_Get (BM_MODE mode)
	Gets the curent BM operation mode. More...
void	BM_MODE_Init (void)
	Initializes BM mode configuration library. More...
void	BM_MODE_Set (BM_MODE mode)
	Sets the BM operation mode. More...

enum BM_MODE

Enumeration of the BM operation modes.

Enumerator
BM_MODE_PROGRAM	Flash update mode.
BM_MODE_APPLICATION	Application mode.

uint16_t BM_ConfigurationLibraryVersion

(

void

)

Gets the version of the BM configuration library.

Precondition

None.

Returns

BM Configuration Library version (0xMMmm).

void BM_MODE BM_MODE_Get

(

BM_MODE

mode

)

Gets the curent BM operation mode.

Parameters

mode	Variable to load the current BM operation mode.

Precondition

BM mode initalize function should be invoked prior.

Returns

None.

Referenced by platform_mode_get().

void BM_MODE_Init

(

void

)

Initializes BM mode configuration library.

Precondition

None.

Returns

None.

Referenced by ble_mgr_device_init(), and platform_ble_mode_select().

void BM_MODE_Set

(

BM_MODE

mode

)

Sets the BM operation mode.

Parameters

mode	The BM operation mode to be set.

Precondition

BM mode initalize function should be invoked prior.

Returns

None.

Referenced by platform_ble_mode_select(), and platform_mode_set().