ezradio_plugin_manager.h File Reference

Detailed Description

This file contains the plug-in manager for the EZRadio and EZRadioPRO chip families.

Version

5.1.2

License

(C) Copyright 2015 Silicon Labs, http://www.silabs.com

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
   
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
   
3. This notice may not be removed or altered from any source distribution.

DISCLAIMER OF WARRANTY/LIMITATION OF REMEDIES: Silicon Labs has no obligation to support this Software. Silicon Labs is providing the Software "AS IS", with no express or implied warranties of any kind, including, but not limited to, any implied warranties of merchantability or fitness for any particular purpose or warranties against infringement of any proprietary rights of a third party.

Silicon Labs will not be liable for any consequential, incidental, or special damages, or any other relief, or for any claim by any third party, arising from your use of this Software.

Definition in file ezradio_plugin_manager.h.

#include "ecode.h"
#include "app-config.h"
#include "ezradio_transmit_plugin.h"
#include "ezradio_receive_plugin.h"
#include "ezradio_crcerror_plugin.h"
#include "ezradio_auto_ack_plugin.h"
#include "ezradio_unmod_carrier_plugin.h"
#include "ezradio_pn9_plugin.h"
#include "ezradio_direct_transmit_plugin.h"
#include "ezradio_direct_receive_plugin.h"

Go to the source code of this file.

Data Structures
struct	EZRADIODRV_HandleData

Macros
#define	ECODE_EMDRV_EZRADIODRV_AUTO_ACK_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000400 )
	Receive plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_CRC_ERROR_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000300 )
	CRC error plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_DIRECT_RECEIVE_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000800 )
	Receive plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_DIRECT_TRANSMIT_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000700 )
	Transmit plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_ILLEGAL_HANDLE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000001 )
	Illegal SPI handle.
#define	ECODE_EMDRV_EZRADIODRV_OK   ( ECODE_OK )
	Success return value.
#define	ECODE_EMDRV_EZRADIODRV_PN9_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000600 )
	Receive plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_RECEIVE_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000200 )
	Receive plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_TRANSMIT_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000100 )
	Transmit plugin base error code.
#define	ECODE_EMDRV_EZRADIODRV_UNMOD_CARRIER_PLUGIN_BASE   ( ECODE_EMDRV_EZRADIODRV_BASE | 0x00000500 )
	Receive plugin base error code.
#define	EZRADIODRV_INIT_DEFAULT
	Configuration data for EzRadio plugin manager. More...
#define	RADIO_CONFIG_DATA_FIELD_LENGTH
#define	RADIO_CONFIG_DATA_MAX_PACKET_LENGTH   RADIO_CONFIG_DATA_FIELD1_LENGTH

Typedefs
typedef void(*	EZRADIODRV_Callback_t) (EZRADIODRV_Handle_t handle, Ecode_t status)
	EZRADIODRV feature callback function interface. More...
typedef EZRADIODRV_HandleData_t *	EZRADIODRV_Handle_t
	EZRadio driver instance handle.
typedef struct EZRADIODRV_HandleData	EZRADIODRV_HandleData_t
	Interface for EZRADIODRV_HandleData structure type defined below.
typedef ezradio_cmd_reply_t *	EZRADIODRV_ReplyHandle_t
	EZradio reply union handle.

Functions
void	ezradioInit (EZRADIODRV_Handle_t handle)
	Radio Initialization. More...
Ecode_t	ezradioPluginManager (EZRADIODRV_Handle_t handle)
	EzRadio plugin manager state machine handler. This function should be called in the application in an infinite loop, in order to manage the EzRadio plug-ins properly. More...
void	ezradioResetTRxFifo (void)
	Resets both the TX and RX FIFOs.