documentation/html/_wi_m_o_d___s_a_p___radio_link___i_ds_8h_source.html

//------------------------------------------------------------------------------

//------------------------------------------------------------------------------


/*

 * THIS IS AN EXAMPLE IMPLEMENTATION ACCORDING THE THE HCI SPEC: V1.10

 * FOR FIRMWARE: LR-BASE

 *

 * SEE FILE: WiMOD_LR_Base_HCI_Spec_V1_10.pdf for detailed information

 */


#ifndef ARDUINO_SAP_WIMOD_SAP_RADIOLINK_IDS_H_

#define ARDUINO_SAP_WIMOD_SAP_RADIOLINK_IDS_H_


//------------------------------------------------------------------------------

//

// Section Includes Files

//

//------------------------------------------------------------------------------


#include "utils/WMDefs.h"


//------------------------------------------------------------------------------

//

// Service Access Point Identifier

//

//------------------------------------------------------------------------------


#define RADIOLINK_SAP_ID                      0x03


//------------------------------------------------------------------------------

//

//  Radio Link Services Identifier

//

//------------------------------------------------------------------------------

#define RADIOLINK_MSG_SEND_U_DATA_REQ                   0x01

#define RADIOLINK_MSG_SEND_U_DATA_RSP                   0x02

#define RADIOLINK_MSG_U_DATA_RX_IND                     0x04

#define RADIOLINK_MSG_U_DATA_TX_IND                     0x06

#define RADIOLINK_MSG_RAW_DATA_RX_IND                   0x08

#define RADIOLINK_MSG_SEND_C_DATA_REQ                   0x09

#define RADIOLINK_MSG_SEND_C_DATA_RSP                   0x0A

#define RADIOLINK_MSG_C_DATA_RX_IND                     0x0C

#define RADIOLINK_MSG_C_DATA_TX_IND                     0x0E

#define RADIOLINK_MSG_ACK_RX_IND                        0x10

#define RADIOLINK_MSG_ACK_TIMEOUT_IND                   0x12

#define RADIOLINK_MSG_ACK_TX_IND                        0x14

#define RADIOLINK_MSG_SET_ACK_DATA_REQ                  0x15

#define RADIOLINK_MSG_SET_ACK_DATA_RSP                  0x16


//------------------------------------------------------------------------------

//

//  Radio Link Status Codes

//

//------------------------------------------------------------------------------


#define RADIOLINK_STATUS_OK                             0x00

#define RADIOLINK_STATUS_ERROR                          0x01

#define RADIOLINK_STATUS_CMD_NOT_SUPPORTED              0x02

#define RADIOLINK_STATUS_WRONG_PARAMETER                0x03

#define RADIOLINK_STATUS_WRONG_RADIO_MODE               0x04

#define RADIOLINK_STATUS_MEDIA_BUSY                     0x05

#define RADIOLINK_STATUS_BUFFER_FULL                    0x07

#define RADIOLINK_STATUS_LENGTH_ERROR                   0x08


//------------------------------------------------------------------------------

//

//  Format / Status Field defines

//

//------------------------------------------------------------------------------

#define RADIOLINK_FORMAT_EXTENDED_OUTPUT                (1 << 0) // bit field

#define RADIOLINK_FORMAT_DECRYPTED_DATA                 (1 << 5) // bit field

#define RADIOLINK_FORMAT_DECRYPTION_ERROR               (1 << 6) // bit field

#define RADIOLINK_FORMAT_ENCRYPTED_DATA                 (1 << 7) // bit field

//------------------------------------------------------------------------------

//

//  Misc. Defines

//

//------------------------------------------------------------------------------

#define RADIOLINK_BROADCAST_GROUP_ADR                  0xFF

#define RADIOLINK_BROADCAST_DEVICE_ADR                 0xFFFF


/*

 * Number of payload bytes for a user defined message

 *

 * Notes:

 *

 * 1) the actual number of payload bytes can be less, if the air frame

 * contains a list of MAC commands.

 *

 * 2) The value of the WiMODLRBASE_APP_PAYLOAD_LEN taken here is a tradeoff.

 * The actual size of the payload is mostly bigger than 100 and depends on the

 * settings of the radio and its firmware itself. Please consult the according

 * firmware HCI documentation to figure out the exact value possible.

 * But the amount of memory must be reserved on the host MCU system, too. Some

 * memory contrained Arduino boards (e.g.) the UNO have got only ~2kB of memory.

 * So the default message size has been reduced here. If you want to use the

 * maximal payload size possible you can change this define here.

 */

#define WiMODLRBASE_APP_PAYLOAD_LEN                       100


#define RADIOLINK_HEADER_SIZE                             (1+1+2+1+2+2+1+4)

//------------------------------------------------------------------------------

//

// structures

//

//------------------------------------------------------------------------------

#define WIMOD_RADIOLINK_PAYLOAD_LEN                      (WiMODLRBASE_APP_PAYLOAD_LEN - RADIOLINK_HEADER_SIZE)


#define WIMOD_RADIOLINK_ACK_DATA_LEN                     ( 0x08 )


typedef struct

{

    // only for RX

    UINT8       StatusFormat;

    // RX + TX

    UINT8       DestinationGroupAddress;

    UINT16      DestinationDeviceAddress;

    //only for RX

    UINT8       SourceGroupAddress;

    UINT16      SourceDeviceAddress;

    // RX + TX

    UINT8       Length;

    UINT8       Payload[WIMOD_RADIOLINK_PAYLOAD_LEN];

    // note: in case of encrypted data the sequence number and MIC

    //       is included in this payload field. The user must check the

    //       StatusFormat field


    bool        OptionalInfoAvaiable;

    // optional fields; only for RX

    INT16       RSSI;

    INT8        SNR;

    INT32       RxTime;

    //optional: only if decryption error occurred

    INT16               MIC;

} TWiMODLR_RadioLink_Msg;


typedef struct

{

    // only for RX

    UINT8       StatusFormat;

    UINT8       RadioCtrlField;                                                 /*1> Radio Control Field (low level) */

    UINT8       DestinationGroupAddress;

    UINT16      DestinationDeviceAddress;

    UINT8       SourceGroupAddress;

    UINT16      SourceDeviceAddress;

    UINT16      RadioStackField;

    UINT8       Length;

    UINT8       Payload[WIMOD_RADIOLINK_PAYLOAD_LEN];

    bool        OptionalInfoAvaiable;

    INT16       RSSI;

    INT8        SNR;

    INT32       RxTime;

} TWiMODLR_RadioLink_RawMsg;


typedef struct

{

    UINT8       Status;

    UINT16      TxEventCounter;

    UINT32              AirTime;

} TWiMODLR_RadioLink_CdataInd;


typedef struct

{

    UINT8       Status;

    UINT16      TxEventCounter;

    UINT32              AirTime;

} TWiMODLR_RadioLink_UdataInd;


typedef struct

{

    UINT8       Status;

//    UINT16      TxEventCounter;                                                 /*!< TX event counter value */

//    UINT32      AirTime;                                                        /*!< Air time of last transmission in ms (new SpeV 1V10 */

} TWiMODLR_AckTxInd_Msg;


#endif /* ARDUINO_SAP_WIMOD_SAP_RADIOLINK_IDS_H_ */