PRIME Serial MLME

This module provides configuration and utils for the serialization of PRIME MLME.

Enumerations
enum	ADDRESS_IND {   NOADDRESS,   EUI48,   SNA_REQ }

Functions
static int	_serial_if_mlme_pack_active_conn (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_active_conn_ex (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_available_switch_table (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_direct_conn (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_direct_switch_table (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_ex_snr_table (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_list_phy_comm (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_mcast_entries (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_mlme_callback (uint8_t *puc_mlme_command, int l_len)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_node_432_table (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_reg_devices (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misalignments. More...
static int	_serial_if_mlme_pack_switch_table (uint8_t *puc_buf_des, uint8_t *px_buf_org)
	Packets a MLME Callback to avoid misaligments. More...
static int	_serial_if_mlme_unpack_demote_req_base (void)
	This function extracts the MLME SAP Demote.Request. More...
static int	_serial_if_mlme_unpack_get_req (void)
	This function extracts the MLME SAP Get.Request. More...
static int	_serial_if_mlme_unpack_list_get_req (void)
	This function extracts the MLME SAP List.Get.Request. More...
static int	_serial_if_mlme_unpack_promote_req_base (void)
	This function extracts the MLME SAP Promote.Request. More...
static int	_serial_if_mlme_unpack_register_req (void)
	This function extracts the MLME SAP Register.Request. More...
static int	_serial_if_mlme_unpack_set_req (void)
	This function extracts the MLME SAP Set.Request. More...
static int	_serial_if_mlme_unpack_unregister_req_base (void)
	This function extracts the MLME SAP Unregister.Request. More...
uint8_t	serial_if_mlme_api_parser (uint8_t *puc_rx_msg, uint16_t us_len)
	Received message. More...
int8_t	serial_if_mlme_process (void)
	Function to encapsulate MLME Tx Control Process. More...

Variables
static uint8_t	commandMlmeToPack [MLME_DATA_SIZE]
static uint8_t	NewMlmeCallBackCmd [MLME_DATA_SIZE]
static uint8_t *	puc_rx

enum ADDRESS_IND

Enumerator
NOADDRESS
EUI48
SNA_REQ

static int _serial_if_mlme_pack_active_conn ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_active_conn_ex ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_available_switch_table ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_direct_conn ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_direct_switch_table ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_ex_snr_table ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_list_phy_comm ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_mcast_entries ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_mlme_callback ( uint8_t *  puc_mlme_command, int  l_len  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_mlme_command	Pointer to the MLME command
l_len	Command length

Return values

length

of the buffer packet

References _serial_if_mlme_pack_active_conn(), _serial_if_mlme_pack_active_conn_ex(), _serial_if_mlme_pack_available_switch_table(), _serial_if_mlme_pack_direct_conn(), _serial_if_mlme_pack_direct_switch_table(), _serial_if_mlme_pack_ex_snr_table(), _serial_if_mlme_pack_list_phy_comm(), _serial_if_mlme_pack_mcast_entries(), _serial_if_mlme_pack_node_432_table(), _serial_if_mlme_pack_reg_devices(), _serial_if_mlme_pack_switch_table(), PIB_432_LIST_NODES, PIB_MAC_LIST_ACTIVE_CONN, PIB_MAC_LIST_ACTIVE_CONN_EX, PIB_MAC_LIST_AVAILABLE_SWITCHES, PIB_MAC_LIST_DIRECT_CONN, PIB_MAC_LIST_DIRECT_TABLE, PIB_MAC_LIST_EX_SNR, PIB_MAC_LIST_MCAST_ENTRIES, PIB_MAC_LIST_PHY_COMM, PIB_MAC_LIST_REGISTER_DEVICES, PIB_MAC_LIST_SWITCH_TABLE, PRIME_MAC_LENGTH, PRIME_MLME_DEMOTE_CONFIRM, PRIME_MLME_DEMOTE_INDICATION, PRIME_MLME_GET_CONFIRM, PRIME_MLME_LIST_GET_CONFIRM, PRIME_MLME_PROMOTE_CONFIRM, PRIME_MLME_PROMOTE_INDICATION, PRIME_MLME_REGISTER_CONFIRM, PRIME_MLME_REGISTER_INDICATION, PRIME_MLME_RESET_CONFIRM, PRIME_MLME_SET_CONFIRM, PRIME_MLME_UNREGISTER_CONFIRM, PRIME_MLME_UNREGISTER_INDICATION, and sna.

Referenced by serial_if_mlme_process().

static int _serial_if_mlme_pack_node_432_table ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH, and SERIAL_NUMBER_432_MAC.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_reg_devices ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misalignments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

References PRIME_MAC_LENGTH.

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_pack_switch_table ( uint8_t *  puc_buf_des, uint8_t *  px_buf_org  )

static

Packets a MLME Callback to avoid misaligments.

Parameters

puc_buf_des	Pointer to the destination buffer
px_buf_org	Pointer to the source buffer

Return values

length

of the buffer packet

Referenced by _serial_if_mlme_pack_mlme_callback().

static int _serial_if_mlme_unpack_demote_req_base ( void  )

static

This function extracts the MLME SAP Demote.Request.

Note

This function extracts the MLME SAP Demote.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References PRIME_MAC_LENGTH, prime_MLME_DEMOTE_request_base(), and puc_rx.

Referenced by serial_if_mlme_api_parser().

static int _serial_if_mlme_unpack_get_req ( void  )

static

This function extracts the MLME SAP Get.Request.

Note

This function extracts the MLME SAP Get.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References prime_MLME_GET_request(), and puc_rx.

Referenced by serial_if_mlme_api_parser().

static int _serial_if_mlme_unpack_list_get_req ( void  )

static

This function extracts the MLME SAP List.Get.Request.

Note

This function extracts the MLME SAP List.Get.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References prime_MLME_LIST_GET_request(), and puc_rx.

Referenced by serial_if_mlme_api_parser().

static int _serial_if_mlme_unpack_promote_req_base ( void  )

static

This function extracts the MLME SAP Promote.Request.

Note

This function extracts the MLME SAP Promote.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References PRIME_MAC_LENGTH, prime_MLME_PROMOTE_request_base(), and puc_rx.

Referenced by serial_if_mlme_api_parser().

static int _serial_if_mlme_unpack_register_req ( void  )

static

This function extracts the MLME SAP Register.Request.

Note

This function extracts the MLME SAP Register.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References EUI48, NOADDRESS, PRIME_MAC_LENGTH, prime_MLME_REGISTER_request(), puc_rx, and SNA_REQ.

Referenced by serial_if_mlme_api_parser().

static int _serial_if_mlme_unpack_set_req ( void  )

static

This function extracts the MLME SAP Set.Request.

Note

This function extracts the MLME SAP Set.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References PIB_CERTIFICATION_SEND_MSG, PIB_MAC_ACTION_APPEMU_DATA_BURST, PIB_MAC_ACTION_BROADCAST_BURST, PIB_MAC_ACTION_CONN_CLOSE_BN, PIB_MAC_ACTION_DEMOTE, PIB_MAC_ACTION_MGMT_CON, PIB_MAC_ACTION_MGMT_MUL, PIB_MAC_ACTION_PRM, PIB_MAC_ACTION_PROMOTE, PIB_MAC_ACTION_REJECT, PIB_MAC_ACTION_SEGMENTED_432, PIB_MAC_ACTION_UNREGISTER_BN, PIB_MAC_BOARD_SERIAL_NUMBER, PIB_MAC_EUI48, PRIME_MAC_LENGTH, prime_MLME_SET_BUF_request(), prime_MLME_SET_request(), and puc_rx.

Referenced by serial_if_mlme_api_parser().

static int _serial_if_mlme_unpack_unregister_req_base ( void  )

static

This function extracts the MLME SAP Unregister.Request.

Note

This function extracts the MLME SAP Unregister.Request from the received packet and stores the data in the circular buffer if possible.

Return values

0	primitive stored
-1	primitive could not be stored

References PRIME_MAC_LENGTH, prime_MLME_UNREGISTER_request_base(), and puc_rx.

Referenced by serial_if_mlme_api_parser().

uint8_t serial_if_mlme_api_parser	(	uint8_t *	puc_rx_msg,
		uint16_t	us_len
	)

Received message.

Note

Process Dialogue with peer

• Proces Profiles
• Wait for received message
• Process incoming message
• Send response if necessary

Parameters

puc_rx_msg	Pointer to the data attached to the connection request
us_len	Data length of the data attached to the request

Return values

1	primitive stored
0	primitive could not be stored

References _serial_if_mlme_unpack_demote_req_base(), _serial_if_mlme_unpack_get_req(), _serial_if_mlme_unpack_list_get_req(), _serial_if_mlme_unpack_promote_req_base(), _serial_if_mlme_unpack_register_req(), _serial_if_mlme_unpack_set_req(), _serial_if_mlme_unpack_unregister_req_base(), CMD_PRIME_PROTOCOL, PRIME_MLME_DEMOTE_REQUEST_BASE, PRIME_MLME_DEMOTE_REQUEST_SERVICE, prime_MLME_DEMOTE_request_service(), PRIME_MLME_GET_REQUEST, PRIME_MLME_LIST_GET_REQUEST, PRIME_MLME_PROMOTE_REQUEST_BASE, PRIME_MLME_PROMOTE_REQUEST_SERVICE, prime_MLME_PROMOTE_request_service(), PRIME_MLME_REGISTER_REQUEST, PRIME_MLME_RESET_REQUEST, prime_MLME_RESET_request(), PRIME_MLME_SET_REQUEST, PRIME_MLME_UNREGISTER_REQUEST_BASE, PRIME_MLME_UNREGISTER_REQUEST_SERVICE, prime_MLME_UNREGISTER_request_service(), and UNUSED.

Referenced by _process_msg().

int8_t serial_if_mlme_process

(

void

)

Function to encapsulate MLME Tx Control Process.

Note

This function will be called using a pointer

Return values

0	if the request has been sent
-1	if the request has not been sent

References _serial_if_mlme_pack_mlme_callback(), prime_MLME_callback(), PROTOCOL_MLME_PRIME, x_usi_serial_cmd_params_t::ptr_buf, x_usi_serial_cmd_params_t::uc_protocol_type, x_usi_serial_cmd_params_t::us_len, and usi_send_cmd().

uint8_t commandMlmeToPack[MLME_DATA_SIZE]

static

uint8_t NewMlmeCallBackCmd[MLME_DATA_SIZE]

static

uint8_t* puc_rx

static

Referenced by _serial_if_mlme_unpack_demote_req_base(), _serial_if_mlme_unpack_get_req(), _serial_if_mlme_unpack_list_get_req(), _serial_if_mlme_unpack_promote_req_base(), _serial_if_mlme_unpack_register_req(), _serial_if_mlme_unpack_set_req(), and _serial_if_mlme_unpack_unregister_req_base().