documentation/html/_wi_m_o_d___s_a_p___d_e_v_m_g_m_t___i_ds_8h_source.html

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

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


/*

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

 * FOR FIRMWARE: LR-BASE

 *

 * SEE FILE: WiMOD_LR_Base_HCI_Spec_V1_8.pdf for detailed information

 */


#ifndef ARDUINO_WIMOD_SAP_DEVMGMT_IDS_H_

#define ARDUINO_WIMOD_SAP_DEVMGMT_IDS_H_


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

//

// Section Includes Files

//

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


#include "utils/WMDefs.h"


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

//

// Service Access Point Identifier

//

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


#define DEVMGMT_SAP_ID                      0x01


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

//

//  Device Management Message Identifier

//

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


// Status Codes

#define DEVMGMT_STATUS_OK                   0x00

#define DEVMGMT_STATUS_ERROR                0x01

#define DEVMGMT_STATUS_CMD_NOT_SUPPORTED    0x02

#define DEVMGMT_STATUS_WRONG_PARAMETER      0x03

#define DEVMGMT_STATUS_WRONG_DEVICE_MODE    0x04

#define DEVMGMT_STATUS_DEVICE_BUSY          0x06


// Message IDs

#define DEVMGMT_MSG_PING_REQ                0x01

#define DEVMGMT_MSG_PING_RSP                0x02


#define DEVMGMT_MSG_GET_DEVICEINFO_REQ      0x03

#define DEVMGMT_MSG_GET_DEVICEINFO_RSP      0x04


#define DEVMGMT_MSG_GET_FW_VERSION_REQ      0x05

#define DEVMGMT_MSG_GET_FW_VERSION_RSP      0x06


#define DEVMGMT_MSG_RESET_REQ               0x07

#define DEVMGMT_MSG_RESET_RSP               0x08


#define DEVMGMT_MSG_SET_OPMODE_REQ          0x09

#define DEVMGMT_MSG_SET_OPMODE_RSP          0x0A


#define DEVMGMT_MSG_GET_OPMODE_REQ          0x0B

#define DEVMGMT_MSG_GET_OPMODE_RSP          0x0C


#define DEVMGMT_MSG_SET_RTC_REQ             0x0D

#define DEVMGMT_MSG_SET_RTC_RSP             0x0E

#define DEVMGMT_MSG_GET_RTC_REQ             0x0F

#define DEVMGMT_MSG_GET_RTC_RSP             0x10


#define DEVMGMT_MSG_SET_RADIO_CONFIG_REQ    0x11

#define DEVMGMT_MSG_SET_RADIO_CONFIG_RSP    0x12

#define DEVMGMT_MSG_GET_RADIO_CONFIG_REQ    0x13

#define DEVMGMT_MSG_GET_RADIO_CONFIG_RSP    0x14


#define DEVMGMT_MSG_RESET_RADIO_CONFIG_REQ  0x15

#define DEVMGMT_MSG_RESET_RADIO_CONFIG_RSP  0x16


#define DEVMGMT_MSG_GET_SYSTEM_STATUS_REQ   0x17

#define DEVMGMT_MSG_GET_SYSTEM_STATUS_RSP   0x18


#define DEVMGMT_MSG_SET_RADIO_MODE_REQ      0x19

#define DEVMGMT_MSG_SET_RADIO_MODE_RSP      0x1A


#define DEVMGMT_MSG_SET_PSV_MODE_REQ        0x1B

#define DEVMGMT_MSG_SET_PSV_MODE_RSP        0x1C


#define DEVMGMT_MSG_POWER_UP_IND            0x20


#define DEVMGMT_MSG_SET_AES_KEY_REQ         0x21

#define DEVMGMT_MSG_SET_AES_KEY_RSP         0x22


#define DEVMGMT_MSG_GET_AES_KEY_REQ         0x23

#define DEVMGMT_MSG_GET_AES_KEY_RSP         0x24


#define DEVMGMT_MSG_SET_RTC_ALARM_REQ           0x31

#define DEVMGMT_MSG_SET_RTC_ALARM_RSP           0x32


#define DEVMGMT_MSG_CLEAR_RTC_ALARM_REQ         0x33

#define DEVMGMT_MSG_CLEAR_RTC_ALARM_RSP         0x34


#define DEVMGMT_MSG_GET_RTC_ALARM_REQ           0x35

#define DEVMGMT_MSG_GET_RTC_ALARM_RSP           0x36


#define DEVMGMT_MSG_RTC_ALARM_IND                       0x38


// new Message IDs (only part of LR-BASE PLUS & LoRaWAN EndNode FW)


#define DEVMGMT_MSG_SET_HCI_CFG_REQ         0x41

#define DEVMGMT_MSG_SET_HCI_CFG_RSP         0x42

#define DEVMGMT_MSG_GET_HCI_CFG_REQ         0x43

#define DEVMGMT_MSG_GET_HCI_CFG_RSP         0x44


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

//

// misc. defines

//

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


#define DEVMGMT_AES_KEY_LEN                         16      // 128 bit


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

//

// structures

//

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

typedef struct TWiMODLR_DevMgmt_DevInfo

{

    UINT8       Status;

    UINT8       ModuleType;

    UINT16      DevAdr;

    UINT8       GroupAdr;

    UINT32      DevID;

} TWiMODLR_DevMgmt_DevInfo;


#define WIMOD_DEVMGMT_BUILDDATE_LEN                     (10)

#define WIMOD_DEVMGMT_MAX_BUILDDATE_LEN                 (WIMOD_DEVMGMT_BUILDDATE_LEN+1)

#define WIMOD_DEVMGMT_FIRMWARE_NAME_LEN                 (40)

#define WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN             (WIMOD_DEVMGMT_FIRMWARE_NAME_LEN+1)


// @endcond


// WiMOD Module Types

#define WIMOD_MODULE_TYPE_IM880B                                                (0x98)


typedef enum TWiMOD_ModuleType

{

  ModuleType_iM880A    = 0x90,

  ModuleType_iM880A_L  = 0x92,

  ModuleType_iU880A      = 0x93,

  ModuleType_iM880B    = 0x98,

  ModuleType_iU880B    = 0x99,

  ModuleType_iM980A    = 0x9A,

    ModuleType_iU980A    = 0x9B,

    ModuleType_iM980B    = 0x9C,

  ModuleType_iM881A    = 0xA0,

  ModuleType_iU881A    = 0xA1,

  ModuleType_iM282A    = 0xB0

} TWiMOD_ModuleType;


typedef struct TWiMODLR_DevMgmt_FwInfo

{

    UINT8       Status;

    UINT8       FirmwareMinorVersion;

    UINT8       FirmwareMayorVersion;

    UINT16      BuildCount;

    UINT8       BuildDateStr[WIMOD_DEVMGMT_MAX_BUILDDATE_LEN];

    UINT8       FirmwareName[WIMOD_DEVMGMT_MAX_FIRMWARE_NAME_LEN];

} TWiMODLR_DevMgmt_FwInfo;


typedef struct TWiMODLR_DevMgmt_SystemStatus

{

    UINT8       Status;

    UINT8       SysTickResolution;

    UINT32      SysTickCounter;

    UINT32      RtcTime;

    UINT16      NvmStatus;

    UINT16      BatteryStatus;

    UINT16      ExtraStatus;

    UINT32              RxPackets;

  UINT32                RxAddressMatch;

  UINT32                RxCRCError;

  UINT32                TxPackets;

  UINT32                TxError;

  UINT32                TxMediaBusyEvents;

} TWiMODLR_DevMgmt_SystemStatus;


typedef enum TRadioCfg_RadioMode

{

    RadioMode_Standard = 0,

    RadioMode_Reserved,

    RadioMode_Sniffer,

} TRadioCfg_RadioMode;


typedef enum TRadioCfg_Modulation

{

    Modulation_LoRa = 0,

    Modulation_FSK,

} TRadioCfg_Modulation;


typedef enum TRadioCfg_LoRaBandwidth

{

    LoRaBandwith_125kHz = 0,

    LoRaBandwith_250kHz,

    LoRaBandwith_500kHz

} TRadioCfg_LoRaBandwidth;


typedef enum TRadioCfg_LoRaSpreadingFactor

{

    LoRa0_SF7 = 0,

    LoRa1_SF7,

    LoRa2_SF7,

    LoRa3_SF7,

    LoRa4_SF7,

    LoRa5_SF7,

    LoRa6_SF7,

    LoRa7_SF7,

    LoRa8_SF8,

    LoRa9_SF9,

    LoRa10_SF10,

    LoRa11_SF11,

    LoRa12_SF12,

} TRadioCfg_LoRaSpreadingFactor;


typedef enum TRadioCfg_ErrorCoding

{

    ErrorCoding0_4_5 = 0,

    ErrorCoding1_4_5,

    ErrorCoding2_4_6,

    ErrorCoding3_4_7,

    ErrorCoding4_4_8,

} TRadioCfg_ErrorCoding;


typedef enum TRadioCfg_TxPowerLevel

{

    TxPowerLevel_5_dBm = 5,

    TxPowerLevel_6_dBm,

    TxPowerLevel_7_dBm,

    TxPowerLevel_8_dBm,

    TxPowerLevel_9_dBm,

    TxPowerLevel_10_dBm,

    TxPowerLevel_11_dBm,

    TxPowerLevel_12_dBm,

    TxPowerLevel_13_dBm,

    TxPowerLevel_14_dBm,

    TxPowerLevel_15_dBm,

    TxPowerLevel_16_dBm,

    TxPowerLevel_17_dBm,

    TxPowerLevel_18_dBm,

    TxPowerLevel_19_dBm,

    TxPowerLevel_20_dBm,

} TRadioCfg_PowerLevel;


// bit field for TxControl field of RadioConfig structure

#define DEVMGMT_RADIO_CFG_TX_CTRL_TX_NARROW_FILTER_ON       (1 << 0)

#define DEVMGMT_RADIO_CFG_TX_CTRL_LBT_ON                    (1 << 1)


typedef enum TRadioCfg_RxControl

{

    RxCtrl_Receiver_Off = 0,

    RxCtrl_Receiver_AlwaysOn,

    RxCtrl_Receiver_RxWindowed,

} TRadioCfg_RxControl;


// bit field for LedControl in RadioConfig structure

#define DEVMGMT_RADIO_CFG_LED_CTRL_LED3_RX_IND_ON           (1 << 0)

#define DEVMGMT_RADIO_CFG_LED_CTRL_LED2_TX_IND_ON           (1 << 1)

#define DEVMGMT_RADIO_CFG_LED_CTRL_LED4_ALIVE_IND_ON        (1 << 2)

#define DEVMGMT_RADIO_CFG_LED_CTRL_LED1_BUTTON_IND_ON       (1 << 3)

// update in HCI spec V1.3++

#define DEVMGMT_RADIO_CFG_LED_CTRL_LED3_RX_STATE_ON         (1 << 4) // overrides Bit0 if enabled

#define DEVMGMT_RADIO_CFG_LED_CTRL_LED2_TX_STATE_ON         (1 << 5) // overrides Bit1 if enabled


// bit field for Misc.Options in RadioConfig structure

#define DEVMGMT_RADIO_CFG_MISC_EXTENDED_HCI_OUTPUT_FORMAT   (1 << 0)

#define DEVMGMT_RADIO_CFG_MISC_RTC_ENABLED                  (1 << 1)

#define DEVMGMT_RADIO_CFG_MISC_HCI_TX_IND_ENABLED           (1 << 2)

#define DEVMGMT_RADIO_CFG_MISC_HCI_PWR_UP_IND_ENABLED       (1 << 3)

#define DEVMGMT_RADIO_CFG_MISC_HCI_BTN_PRESS_IND_ENABLED    (1 << 4)

#define DEVMGMT_RADIO_CFG_MISC_HCI_ENCTRYPTION_ENABLED      (1 << 5)


typedef enum TRadioCfg_FskDatarate

{

    FskDatarate_50kbps = 0,

    FskDatarate_100kbps,

    FskDatarate_250kbps,

} TRadioCfg_FskDatarate;


// power saving mode field of the RadioConfig structure

#define DEVMGMT_RADIO_CFG_POWER_SAVING_MODE_OFF              0

#define DEVMGMT_RADIO_CFG_POWER_SAVING_MODE_ON               1


typedef enum TRadioCfg_PowerSavingMode

{

    PowerSaving_Off = 0,

    PowerSaving_On  = 1,

} TRadioCfg_PowerSavingMode;


typedef struct TWiMODLR_DevMgmt_RadioConfig

{

    // only for reading

    UINT8                           Status;

    // only for writing

    UINT8                           StoreNwmFlag;

    TRadioCfg_RadioMode             RadioMode;

    UINT8                           GroupAddress;

    UINT8                           TxGroupAddress;

    UINT16                          DeviceAddress;

    UINT16                          TxDeviceAddress;

    TRadioCfg_Modulation            Modulation;

    UINT8                           RfFreq_LSB;

    UINT8                           RfFreq_MID;

    UINT8                           RfFreq_MSB;

    TRadioCfg_LoRaBandwidth         LoRaBandWidth;

    TRadioCfg_LoRaSpreadingFactor   LoRaSpreadingFactor;

    TRadioCfg_ErrorCoding           ErrorCoding;

    TRadioCfg_PowerLevel            PowerLevel;

    UINT8                           TxControl;

    TRadioCfg_RxControl             RxControl;

    UINT16                          RxWindowTime;

    UINT8                           LedControl;

    UINT8                           MiscOptions;

    TRadioCfg_FskDatarate           FskDatarate;

    TRadioCfg_PowerSavingMode       PowerSavingMode;

    INT16                           LbtThreshold;

} TWiMODLR_DevMgmt_RadioConfig;


typedef enum TWiMOD_OperationMode

{

    OperationMode_Application = 0,

    OperationMode_Test,

    OperationMode_Reserved2 = 2,

    OperationMode_Customer  = 3,

} TWiMOD_OperationMode;


// RTC alarm status

#define DEVMGMT_RTC_ALARM_STATUS_NO_ALARM_SET              0

#define DEVMGMT_RTC_ALARM_STATUS_ALARM_SET                 1


typedef enum TWiMOD_RtcAlarmStatus

{

  RTC_Alarm_No_Alarm_Set = 0,

  RTC_Alarm_Alarm_Set,

} TWiMOD_RtcAlarmStatus;


// RTC alarm options / alarm type

#define DEVMGMT_RTC_ALARM_TYPE_SIGNLE              0

#define DEVMGMT_RTC_ALARM_TYPE_DAILY_REPEATED      1


typedef enum TWiMOD_RtcAlarmType

{

  RTC_Alarm_Single = 0,

  RTC_Alarm_DailyRepeated,

} TWiMOD_RtcAlarmType;


typedef struct TWiMODLR_DevMgmt_RtcAlarm

{

    // RX only

  TWiMOD_RtcAlarmStatus   AlarmStatus;

  TWiMOD_RtcAlarmType           Options;

  UINT8                                 Hour;

  UINT8                                 Minutes;

  UINT8                                 Seconds;

} TWiMODLR_DevMgmt_RtcAlarm;


typedef enum TWiMOD_HCI_Baudrate

{

    WimodHciBaudrate_9600    = 0x00,

    WimodHciBaudrate_19200   = 0x01,

    WimodHciBaudrate_38400   = 0x02,

    WimodHciBaudrate_57600   = 0x03,

    WimodHciBaudrate_115200  = 0x04,

    WimodHciBaudrate_230400  = 0x05,

    WimodHciBaudrate_460800  = 0x06,

} TWiMOD_HCI_Baudrate;


typedef struct TWiMODLR_DevMgmt_HciConfig

{

    // only for writing

    UINT8                           StoreNwmFlag;

    // only for reading

    UINT8                           Status;

    TWiMOD_HCI_Baudrate             BaudrateID;

    UINT16                          NumWakeUpChars;

    UINT8                           TxHoldTime;

    UINT8                           RxHoldTime;

} TWiMODLR_DevMgmt_HciConfig;


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

//

// Section Macros

//

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


#define WiMOD_RTC_YEAR_OFFSET              2000


#define WIMOD_RTC_GET_SECONDS(t)  (t & 0x3F)


#define WIMOD_RTC_GET_MINUTES(t)  ((t >> 6) & 0x3F)


#define WIMOD_RTC_GET_MONTHS(t)   ((t >> 12) & 0x0F)


#define WIMOD_RTC_GET_HOURS(t)    ((t >> 16) & 0x1F)


#define WIMOD_RTC_GET_DAYS(t)     ((t >> 21) & 0x1F)


#define WIMOD_RTC_GET_YEARS(t)    (((t >> 26) & 0x3F) + WiMOD_RTC_YEAR_OFFSET)


#define WIMOD_RTC_MAKE_DATETIME_U32(s,m,h,dd,mm,yy)         \

                    (((UINT32)s) | ((UINT32)m << 6)   \

                  | ((UINT32)mm << 12)                \

                  | ((UINT32)h << 16)                 \

                  | ((UINT32)dd << 21)                \

                  | ((UINT32)(yy-WiMOD_RTC_YEAR_OFFSET) << 26))


#endif /* ARDUINO_WIMOD_SAP_DEVMGMT_IDS_H_ */