Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
EVBME Message definitions

Data structures and definitions used for EVBME Messages. More...

Collaboration diagram for EVBME Message definitions:

Classes

struct  evbme_dfu_reboot_cmd
 Reboot command to boot into DFU or APROM. More...
 
struct  evbme_dfu_erase_cmd
 Erase command to erase whole pages. More...
 
struct  evbme_dfu_write_cmd
 Write command to write words of data. More...
 
struct  evbme_dfu_check_cmd
 Check command to validate flash against a checksum. More...
 
struct  evbme_dfu_status_cmd
 Status command used as a reply from the Chili2 to host. More...
 
struct  evbme_dfu_bootmode_cmd
 Boot mode command to set default boot into DFU or APROM. More...
 
union  evbme_dfu_sub_cmd
 Union of all DFU sub-commands. More...
 
struct  EVBME_GET_confirm
 EVBME Get data confirm structure. More...
 
struct  EVBME_GET_request
 EVBME Get data request structure. More...
 
struct  EVBME_SET_confirm
 EVBME Set data confirm structure. More...
 
struct  EVBME_SET_request
 EVBME Set data request structure. More...
 
struct  EVBME_MESSAGE_indication
 EVBME Message indication structure. More...
 
struct  EVBME_COMM_CHECK_request
 Structure of the EVBME_COMM_CHECK message that can be used to test comms by host. More...
 
struct  EVBME_COMM_indication
 Structure of the EVBME_COMM_INDICATION message that is used in response to EVBME_COMM_CHECK_request. More...
 
struct  EVBME_DFU_cmd
 EVBME DFU command holder, contains various sub-dfu commands from evbme_dfu_sub_cmd. More...
 
struct  EVBME_Message
 EVBME Message command in Cascoda TLV format. More...
 

Enumerations

enum  evbme_command_ids {
  EVBME_GET_CONFIRM = 0x5C , EVBME_GET_REQUEST = 0x5D , EVBME_SET_CONFIRM = 0x5E , EVBME_SET_REQUEST = 0x5F ,
  EVBME_HOST_CONNECTED = 0x81 , EVBME_HOST_DISCONNECTED = 0x82 , EVBME_MESSAGE_INDICATION = 0xA0 , EVBME_COMM_CHECK = 0xA1 ,
  EVBME_COMM_INDICATION = 0xA2 , EVBME_DFU_CMD = 0xA3 , EVBME_RXRDY = 0xAA , EVBME_RXFAIL = 0xAB
}
 EVBME Command IDs. More...
 
enum  evbme_attribute {
  EVBME_RESETRF = 0x00 , EVBME_CFGPINS = 0x01 , EVBME_WAKEUPRF = 0x02 , EVBME_VERSTRING = 0x80 ,
  EVBME_PLATSTRING = 0x81 , EVBME_APPSTRING = 0x82 , EVBME_SERIALNO = 0x83 , EVBME_OT_EUI64 = 0x84 ,
  EVBME_OT_JOINCRED = 0x85 , EVBME_EXTERNAL_FLASH_AVAILABLE = 0x86 , EVBME_ONBOARD_FLASH_INFO = 0x87
}
 EVBME attribute ids for use with EVBME_SET_REQUEST and EVBME_GET_REQUEST. More...
 
enum  evbme_dfu_const { DFU_WRITE_MAX_LEN = 244 }
 General constants for DFU. More...
 
enum  evbme_dfu_cmdid {
  DFU_REBOOT = 0 , DFU_ERASE = 1 , DFU_WRITE = 2 , DFU_CHECK = 3 ,
  DFU_STATUS = 4 , DFU_BOOTMODE = 5
}
 Command IDs for DFU commands. More...
 
enum  evbme_dfu_rebootmode { EVBME_DFU_REBOOT_APROM = 0 , EVBME_DFU_REBOOT_DFU = 1 }
 Reboot mode. More...
 

Detailed Description

Data structures and definitions used for EVBME Messages.

Enumeration Type Documentation

◆ evbme_attribute

EVBME attribute ids for use with EVBME_SET_REQUEST and EVBME_GET_REQUEST.

Enumerator
EVBME_RESETRF 

ResetRF - Write only.

EVBME_CFGPINS 

CfgPins - Write only.

EVBME_WAKEUPRF 

Wakeup CA8211 - Write only.

EVBME_VERSTRING 

Version string - Read only.

EVBME_PLATSTRING 

Platform string - Read only.

EVBME_APPSTRING 

Application string - Read only.

EVBME_SERIALNO 

SerialNo 64 bit binary - Read only.

EVBME_OT_EUI64 

Openthread EUI64 for commissioning - Read only.

EVBME_OT_JOINCRED 

Openthread joining credential for commissioning - Read only.

EVBME_EXTERNAL_FLASH_AVAILABLE 

Whether an external flash chip is available - Read only.

EVBME_ONBOARD_FLASH_INFO 

Information about the usage of onboard flash - Read only.

◆ evbme_command_ids

EVBME Command IDs.

Enumerator
EVBME_GET_CONFIRM 

M<-S Response containing EVBME parameter data (sync resp)

EVBME_GET_REQUEST 

M->S Get an EVBME parameter (sync req)

EVBME_SET_CONFIRM 

M<-S Response including status for EVBME set (sync resp)

EVBME_SET_REQUEST 

M->S Set an EVBME parameter (sync req)

EVBME_HOST_CONNECTED 

M->S Notification from host that connection is established.

EVBME_HOST_DISCONNECTED 

M->S Notification from host that connection is about to be terminated.

EVBME_MESSAGE_INDICATION 

M<-S Text message to be printed by host.

EVBME_COMM_CHECK 

M->S Communication check message from host that generates COMM_INDICATIONS.

EVBME_COMM_INDICATION 

M<-S Communication check indication from slave to master as requested.

EVBME_DFU_CMD 

M<>S DFU Commands for Device Firmware Upgrade in system.

EVBME_RXRDY 

M<>S RXRDY signal, used for interfaces without built in flow control like raw UART.

EVBME_RXFAIL 

M<>S RXFAIL signal, used for interfaces without built in flow control like raw UART.

◆ evbme_dfu_cmdid

Command IDs for DFU commands.

Enumerator
DFU_REBOOT 

Reboot into DFU or non-dfu mode.

DFU_ERASE 

Erase given flash pages.

DFU_WRITE 

Write given data to already erased flash.

DFU_CHECK 

Check flash checksum in given range.

DFU_STATUS 

Status command returned from chili to host.

DFU_BOOTMODE 

Set default boot mode of device.

◆ evbme_dfu_const

General constants for DFU.

Enumerator
DFU_WRITE_MAX_LEN 

Maximum number of bytes that can be written in one command.

◆ evbme_dfu_rebootmode

Reboot mode.

Enumerator
EVBME_DFU_REBOOT_APROM 

Reboot into application.

EVBME_DFU_REBOOT_DFU 

Reboot into Device Firmware Upgrade mode.