vendor_data.h File Reference

Declarations of API functions to access vendor specific data functionality.

Id:

vendor_data.h 27820 2011-07-24 17:20:51Z pawan.jadia

Author

Microchip Technology Inc: http://www.microchip.com

Support: https://www.microchip.com/support/

#include <stdio.h>
#include "rf4ce.h"
#include "zrc.h"

Data Structures
struct	fw_data_frame_tag
	Structure handling firmware data frames. More...

Macros
#define	MAX_NWK_VENDOR_DATA_SIZE   90
	The maximum size of a vendor-specific data frame; i.e. More...

Typedefs
typedef struct fw_data_frame_tag	fw_data_frame_t
	Structure handling firmware data frames. More...
typedef enum vendor_cmd_id_tag	vendor_cmd_id_t
	Enum Ids for vendor-specific commands. More...
typedef enum vendor_status_tag	vendor_status_t
	Enum Ids for vendor status code. More...

Enumerations
enum	vendor_cmd_id_tag {   BATTERY_STATUS_REQ,   BATTERY_STATUS_RESP,   ALIVE_REQ,   ALIVE_RESP,   FW_VERSION_REQ,   FW_VERSION_RESP,   RX_ON_REQ,   RX_ON_RESP,   FW_DATA_REQ,   FW_DATA_RESP,   FW_SWAP_REQ,   FW_SWAP_RESP }
	Enum Ids for vendor-specific commands. More...
enum	vendor_status_tag {   VD_SUCCESS,   VD_NOT_SUPPORTED_ATTRIBUTE,   VD_UNSUPPORTED_SIZE,   VD_INVALID_CHECKSUM }
	Enum Ids for vendor status code. More...

Functions
void	vendor_app_alive_req (void)
	Vendor data alive request. More...
void	vendor_data_confirm (nwk_enum_t Status, uint8_t PairingRef)
	Vendor data confirm. More...
void	vendor_data_ind (uint8_t PairingRef, profile_id_t ProfileId, uint16_t VendorId, uint8_t nsduLength, uint8_t *nsdu, uint8_t RxLinkQuality, uint8_t RxFlags)
	Vendor data indication. More...
bool	vendor_data_request (uint8_t PairingRef, profile_id_t ProfileId, uint16_t VendorId, uint8_t nsduLength, uint8_t *nsdu, uint8_t TxOptions)
	Vendor data request. More...

#define MAX_NWK_VENDOR_DATA_SIZE   90

The maximum size of a vendor-specific data frame; i.e.

maximum MSDU - header and footer overhead: aMxMACSafePayloadSize - 12

typedef struct fw_data_frame_tag fw_data_frame_t

Structure handling firmware data frames.

typedef enum vendor_cmd_id_tag vendor_cmd_id_t

Enum Ids for vendor-specific commands.

typedef enum vendor_status_tag vendor_status_t

Enum Ids for vendor status code.

enum vendor_cmd_id_tag

Enum Ids for vendor-specific commands.

Enumerator
BATTERY_STATUS_REQ
BATTERY_STATUS_RESP
ALIVE_REQ
ALIVE_RESP
FW_VERSION_REQ
FW_VERSION_RESP
RX_ON_REQ
RX_ON_RESP
FW_DATA_REQ
FW_DATA_RESP
FW_SWAP_REQ
FW_SWAP_RESP

enum vendor_status_tag

Enum Ids for vendor status code.

Enumerator
VD_SUCCESS
VD_NOT_SUPPORTED_ATTRIBUTE
VD_UNSUPPORTED_SIZE
VD_INVALID_CHECKSUM

void vendor_app_alive_req

(

void

)

Vendor data alive request.

Hook for the application indicating that an alive request command was received.

Vendor data alive request.

Referenced by vendor_data_ind().

void vendor_data_confirm	(	nwk_enum_t	Status,
		uint8_t	PairingRef
	)

Vendor data confirm.

Callback function indicating status of the request

Parameters

Status	Status of the request
PairingRef	Pairing reference used for the transmission
Status	Status of the vendor-data-request
PairingRef	The pairing reference

References IDLE, led1_toggle(), node_status, NWK_SUCCESS, TX_index, and UNUSED.

void vendor_data_ind	(	uint8_t	PairingRef,
		profile_id_t	ProfileId,
		uint16_t	VendorId,
		uint8_t	nsduLength,
		uint8_t *	nsdu,
		uint8_t	RxLinkQuality,
		uint8_t	RxFlags
	)

Vendor data indication.

Callback function indicating incoming vendor data.

Parameters

PairingRef	Pairing reference of the sender
ProfileId	Profile id used for the transmission
VendorId	Vendor id used for the transmission
nsduLength	Length of the payload data
nsdu	Pointer to the payload data
RxLinkQuality	LQI of the incoming frame
RxFlags	Options used for transmission

Returns

true if command could be handled; else false

Vendor data indication.

Parameters

PairingRef	The pairing reference of the device.
ProfileId	Profile-Id (ZRC or ZID)
VendorId	Vendor-id
nsduLength	length of the data
nsdu	The data pointer.
TxOptions	Receive flags

References ALIVE_REQ, ALIVE_RESP, BATTERY_STATUS_REQ, BATTERY_STATUS_RESP, flash_fill_page_buffer(), flash_program_page(), flash_swap(), fw_data_frame_tag::frame_cnt, fw_data_frame_tag::fw_data, FW_DATA_REQ, FW_DATA_RESP, FW_SWAP_REQ, FW_VERSION_MAJOR, FW_VERSION_MINOR, FW_VERSION_REQ, FW_VERSION_RESP, FW_VERSION_REV, IMAGE_SIZE, IMAGE_START_ADDR, nlde_data_request(), nlme_rx_enable_request(), PGM_READ_WORD, PROFILE_ID_VENDOR_DATA, QDebug_ProcessCommands(), RX_FLAG_WITH_SEC, RX_index, RX_ON_REQ, RX_ON_RESP, RxHandler(), tfa_get_batmon_voltage(), fw_data_frame_tag::total_num_frames, TXO_ACK_REQ, TXO_CH_NOT_SPEC, TXO_DST_ADDR_NET, TXO_MULTI_CH, TXO_SEC_REQ, TXO_UNICAST, TXO_VEND_SPEC, UNUSED, VD_NOT_SUPPORTED_ATTRIBUTE, VD_SUCCESS, VD_UNSUPPORTED_SIZE, and vendor_app_alive_req().

bool vendor_data_request	(	uint8_t	PairingRef,
		profile_id_t	ProfileId,
		uint16_t	VendorId,
		uint8_t	nsduLength,
		uint8_t *	nsdu,
		uint8_t	TxOptions
	)

Vendor data request.

The vendor data request allows a device to send a vendor specific data frame.

Parameters

PairingRef	Pairing reference of the recipient of the transmission
ProfileId	Profile id used for the transmission
VendorId	Vendor id used for the transmission
nsduLength	Length of the payload data
nsdu	Pointer to the payload data
TxOptions	Transit options

Returns

true if command could be handled; else false

Vendor data request.

Parameters

PairingRef	The pairing reference of the device.
ProfileId	Profile-Id (ZRC or ZID)
VendorId	Vendor-id
nsduLength	length of the data
nsdu	The data pointer.
TxOptions	To fill in the control field

References nlde_data_request(), PROFILE_ID_VENDOR_DATA, and UNUSED.