EFR32 Blue Gecko 1 Software Documentation  efr32bg1-doc-5.1.2
ezradio_auto_ack_plugin.h
Go to the documentation of this file.
1 /***************************************************************************/
34 #ifndef EZRADIO_AUTO_ACK_PLUGIN_H_
35 #define EZRADIO_AUTO_ACK_PLUGIN_H_
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 /***************************************************************************/
46 /***************************************************************************/
51 /***************************************************************************/
56 /***************************************************************************/
63 #if defined(EZRADIO_PLUGIN_AUTO_ACK) && defined(EZRADIO_PLUGIN_TRANSMIT) && defined(EZRADIO_PLUGIN_RECEIVE)
64 
66 typedef enum EZRADIODRV_AutoAckMode
67 {
68  ezradiodrvAutoAckDisabled = 0,
69  ezradiodrvAutoAckImmediate = 1,
70  ezradiodrvAutoAckSkipOne = 2,
71 } EZRADIODRV_AutoAckMode_t;
72 
74 typedef enum EZRADIODRV_AutoAckPacketMode
75 {
76  ezradiodrvAutoAckPktDefault = 0,
77  ezradiodrvAutoAckPktCustom = 1,
78 } EZRADIODRV_AutoAckPacketMode_t;
79 
81 typedef struct EZRADIODRV_AutoAckHandle
82 {
83  EZRADIODRV_Callback_t userCallback;
84  EZRADIODRV_AutoAckMode_t ackMode;
85  EZRADIODRV_AutoAckPacketMode_t pktMode;
86  EZRADIODRV_PacketLengthConfig_t lenConfig;
87  uint8_t * pktBuf;
88  uint16_t pktId;
89 } EZRADIODRV_AutoAckHandle_t;
90 
91 
92 void ezradioEnableAutoAck(EZRADIODRV_AutoAckHandle_t *autoAckHandle);
93 void ezradioDisableAutoAck(EZRADIODRV_AutoAckHandle_t *autoAckHandle);
94 void ezradioSkipAutoAck(EZRADIODRV_AutoAckHandle_t *autoAckHandle);
95 
97 #define EZRADIODRV_AUTO_ACK_PLUGIN_INIT_DEFAULT \
98 { /* Auto acknowledge */ \
99  NULL, /* CallBack */ \
100  ezradiodrvAutoAckDisabled, /* Ack mode */ \
101  ezradiodrvAutoAckPktDefault, /* Ack packet mode */ \
102  { /* Packet length config */ \
103  ezradiodrvTransmitLenghtDefault, /* Default length mode */ \
104  0, /* Packet length */ \
105  RADIO_CONFIG_DATA_FIELD_LENGTH, /* Field lengths */ \
106  }, \
107  NULL, /* Packet buffer */ \
108  0, /* Packet ID */ \
109 },
110 
111 #else //#if defined( EZRADIO_PLUGIN_AUTO_ACK ) && defined( EZRADIO_PLUGIN_TRANSMIT ) && defined( EZRADIO_PLUGIN_RECEIVE )
112 
113 #define EZRADIODRV_AUTO_ACK_PLUGIN_INIT_DEFAULT
114 
115 #endif //#if defined( EZRADIO_PLUGIN_AUTO_ACK ) && defined( EZRADIO_PLUGIN_TRANSMIT ) && defined( EZRADIO_PLUGIN_RECEIVE )
116 
122 #ifdef __cplusplus
123 }
124 #endif
125 
126 #endif /* EZRADIO_AUTO_ACK_PLUGIN_H_ */
EZRADIODRV_AutoAckHandle::pktMode
EZRADIODRV_AutoAckPacketMode_t pktMode
Packet mode for aut ack.
Definition: ezradio_auto_ack_plugin.h:85
EZRADIODRV_AutoAckHandle_t
struct EZRADIODRV_AutoAckHandle EZRADIODRV_AutoAckHandle_t
EzRadio auto acknowledge plug-in instance initialization and handler structure.
EZRADIODRV_AutoAckHandle::userCallback
EZRADIODRV_Callback_t userCallback
User callback.
Definition: ezradio_auto_ack_plugin.h:83
EZRADIODRV_AutoAckMode
EZRADIODRV_AutoAckMode
EzRadio auto acknowledge mode.
Definition: ezradio_auto_ack_plugin.h:66
ezradiodrvAutoAckSkipOne
Acknowledge transmission is skipped for one cycle, eg. not to transmit ACK if ACK is received...
Definition: ezradio_auto_ack_plugin.h:70
EZRADIODRV_PacketLengthConfig
EzRadio transmit packet length configuration structure.
Definition: ezradio_transmit_plugin.h:97
EZRADIODRV_AutoAckPacketMode
EZRADIODRV_AutoAckPacketMode
EzRadio packet mode for auto acknowledge plug-in.
Definition: ezradio_auto_ack_plugin.h:74
EZRADIODRV_AutoAckHandle::pktId
uint16_t pktId
Auto ack packet ID.
Definition: ezradio_auto_ack_plugin.h:88
ezradiodrvAutoAckPktDefault
Auto acknowledge uses the same transmission configuration as the actual configuration.
Definition: ezradio_auto_ack_plugin.h:76
ezradiodrvAutoAckPktCustom
Auto acknowledge uses custom packet configuration.
Definition: ezradio_auto_ack_plugin.h:77
ezradiodrvAutoAckDisabled
Auto acknowledge transmission disabled.
Definition: ezradio_auto_ack_plugin.h:68
EZRADIODRV_Callback_t
void(* EZRADIODRV_Callback_t)(EZRADIODRV_Handle_t handle, Ecode_t status)
EZRADIODRV feature callback function interface.
Definition: ezradio_plugin_manager.h:284
ezradioEnableAutoAck
void ezradioEnableAutoAck(EZRADIODRV_AutoAckHandle_t *autoAckHandle)
Enables auto acknowledge sending feature.
Definition: ezradio_auto_ack_plugin.c:53
ezradiodrvAutoAckImmediate
Immediate acknowledge transmission.
Definition: ezradio_auto_ack_plugin.h:69
EZRADIODRV_AutoAckHandle
EzRadio auto acknowledge plug-in instance initialization and handler structure.
Definition: ezradio_auto_ack_plugin.h:81
EZRADIODRV_AutoAckPacketMode_t
enum EZRADIODRV_AutoAckPacketMode EZRADIODRV_AutoAckPacketMode_t
EzRadio packet mode for auto acknowledge plug-in.
ezradioSkipAutoAck
void ezradioSkipAutoAck(EZRADIODRV_AutoAckHandle_t *autoAckHandle)
Configures auto acknowledge sending feature so that there will be no acknowledge transmitted to the n...
Definition: ezradio_auto_ack_plugin.c:83
EZRADIODRV_AutoAckMode_t
enum EZRADIODRV_AutoAckMode EZRADIODRV_AutoAckMode_t
EzRadio auto acknowledge mode.
EZRADIODRV_AutoAckHandle::ackMode
EZRADIODRV_AutoAckMode_t ackMode
Auto ack mode.
Definition: ezradio_auto_ack_plugin.h:84
ezradioDisableAutoAck
void ezradioDisableAutoAck(EZRADIODRV_AutoAckHandle_t *autoAckHandle)
Disables auto acknowledge sending feature.
Definition: ezradio_auto_ack_plugin.c:67
EZRADIODRV_AutoAckHandle::lenConfig
EZRADIODRV_PacketLengthConfig_t lenConfig
Pakcet length config for auto ack.
Definition: ezradio_auto_ack_plugin.h:86
EZRADIODRV_AutoAckHandle::pktBuf
uint8_t * pktBuf
Pointer to the buffer that holds the auto ack packet.
Definition: ezradio_auto_ack_plugin.h:87