Trond Enger / d7a_1x

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of d7a_1x by WizziLab

include/d7a.h@60:8d4133fbc060, 2016-09-26 (annotated)

Committer:
Jeej
Date:
Mon Sep 26 12:42:32 2016 +0000
Revision:
60:8d4133fbc060
Parent:
59:b42eae56b51b
Child:
61:87be16080640
Fixed max responses nb.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jeej 43:28202405094d 1 #ifndef _D7A_H_
Jeej 43:28202405094d 2 #define _D7A_H_
Jeej 43:28202405094d 3
Jeej 43:28202405094d 4 #include "d7a_common.h"
Jeej 43:28202405094d 5
Jeej 43:28202405094d 6
Jeej 43:28202405094d 7 //======================================================================
Jeej 43:28202405094d 8 // Defines
Jeej 43:28202405094d 9 //======================================================================
Jeej 43:28202405094d 10
Jeej 43:28202405094d 11 #define D7A_UID_LEN (8)
Jeej 43:28202405094d 12
Jeej 55:5ea18a3a01b9 13 #define D7A_XCL_ENDPOINT (0x01)
Jeej 55:5ea18a3a01b9 14 #define D7A_XCL_GATEWAY (0x21)
Jeej 55:5ea18a3a01b9 15
Jeej 58:38a366236bda 16 #define D7A_CTF_VAL(mant,exp) ((uint8_t)(mant|(exp<<5)))
Jeej 58:38a366236bda 17
Jeej 58:38a366236bda 18 #define D7A_NBID(nbid) (nbid >= 32)? D7A_CTF_VAL(8,1) : D7A_CTF_VAL(nbid,0)
Jeej 58:38a366236bda 19
Jeej 43:28202405094d 20
Jeej 43:28202405094d 21 //======================================================================
Jeej 43:28202405094d 22 // Enums
Jeej 43:28202405094d 23 //======================================================================
Jeej 43:28202405094d 24
Jeej 43:28202405094d 25 //======================================================================
Jeej 43:28202405094d 26 // d7a_fs_storage_t
Jeej 43:28202405094d 27 //----------------------------------------------------------------------
Jeej 43:28202405094d 28 /// File "Storage Class"
Jeej 43:28202405094d 29 //======================================================================
Jeej 43:28202405094d 30 typedef enum {
Jeej 55:5ea18a3a01b9 31 /// No data is keeped. Write only!
Jeej 43:28202405094d 32 /// Ex: Use for commands.
Jeej 43:28202405094d 33 TRANSIENT = 0,
Jeej 43:28202405094d 34 /// Data is stocked in RAM and initialized at 0.
Jeej 43:28202405094d 35 /// Can not guarantee data integrity over time.
Jeej 43:28202405094d 36 /// Ex: Use for often updated data.
Jeej 43:28202405094d 37 VOLATILE,
Jeej 43:28202405094d 38 /// Data is stocked in RAM and initialized with the last flushed data from EEPROM.
Jeej 43:28202405094d 39 /// Can not guarantee data integrity over time.
Jeej 43:28202405094d 40 /// Ex: Use for temporary configurations.
Jeej 43:28202405094d 41 RESTORABLE,
Jeej 43:28202405094d 42 /// Data is stoked in EEPROM.
Jeej 43:28202405094d 43 /// Data integrity is guaranteed.
Jeej 43:28202405094d 44 /// Ex: Use for important configurations.
Jeej 43:28202405094d 45 /// /!\ Use sparingly as operations on these type of files are time and ressource consuming
Jeej 43:28202405094d 46 PERMANENT
Jeej 43:28202405094d 47 } d7a_fs_storage_t;
Jeej 43:28202405094d 48
Jeej 43:28202405094d 49 //======================================================================
Jeej 43:28202405094d 50 // d7a_fs_perm_t
Jeej 43:28202405094d 51 //----------------------------------------------------------------------
Jeej 43:28202405094d 52 /// File permissions for USER/GUEST
Jeej 43:28202405094d 53 //======================================================================
Jeej 43:28202405094d 54 typedef enum {
Jeej 43:28202405094d 55 O_O = 0b00000000,
Jeej 43:28202405094d 56 R_O = 0b00100000,
Jeej 43:28202405094d 57 R_R = 0b00100100,
Jeej 43:28202405094d 58 W_O = 0b00010000,
Jeej 43:28202405094d 59 W_W = 0b00010010,
Jeej 43:28202405094d 60 RW_O = 0b00110000,
Jeej 43:28202405094d 61 RW_R = 0b00110100,
Jeej 43:28202405094d 62 RW_W = 0b00110010,
Jeej 43:28202405094d 63 RW_RW = 0b00110110,
Jeej 43:28202405094d 64 RWX_O = 0b00111000,
Jeej 43:28202405094d 65 RWX_RWX = 0b00111111,
Jeej 43:28202405094d 66 } d7a_fs_perm_t;
Jeej 43:28202405094d 67
Jeej 43:28202405094d 68 // =======================================================================
Jeej 43:28202405094d 69 // d7a_nls_t
Jeej 43:28202405094d 70 // -----------------------------------------------------------------------
Jeej 43:28202405094d 71 /// Enumerator of the NWL security modes
Jeej 43:28202405094d 72 // =======================================================================
Jeej 43:28202405094d 73 typedef enum
Jeej 43:28202405094d 74 {
Jeej 43:28202405094d 75 /// No security enabled
Jeej 43:28202405094d 76 D7A_NLS_NO = 0,
Jeej 43:28202405094d 77 /// Encryption only, Counter Mode
Jeej 43:28202405094d 78 D7A_NLS_AES_CTR,
Jeej 43:28202405094d 79 /// No encryption, Authentication, Cipher-block chaining with 128 bit MAC
Jeej 43:28202405094d 80 D7A_NLS_AES_CBC_MAC_128,
Jeej 43:28202405094d 81 /// No encryption, Authentication, Cipher-block chaining with 64 bit MAC
Jeej 43:28202405094d 82 D7A_NLS_AES_CBC_MAC_64,
Jeej 43:28202405094d 83 /// No encryption, Authentication, Cipher-block chaining with 32 bit MAC
Jeej 43:28202405094d 84 D7A_NLS_AES_CBC_MAC_32,
Jeej 43:28202405094d 85 /// Authentication with CBC-MAC-128 and Encryption with Counter Mode
Jeej 43:28202405094d 86 D7A_NLS_AES_CCM_128,
Jeej 43:28202405094d 87 /// Authentication with CBC-MAC-64 and Encryption with Counter Mode
Jeej 43:28202405094d 88 D7A_NLS_AES_CCM_64,
Jeej 43:28202405094d 89 /// Authentication with CBC-MAC-32 and Encryption with Counter Mode
Jeej 43:28202405094d 90 D7A_NLS_AES_CCM_32,
Jeej 43:28202405094d 91 /// QTY
Jeej 43:28202405094d 92 D7A_NLS_QTY
Jeej 43:28202405094d 93
Jeej 43:28202405094d 94 } d7a_nls_t;
Jeej 43:28202405094d 95
Jeej 43:28202405094d 96
Jeej 45:b85384e7d825 97 // Mimic ALP Errors
Jeej 45:b85384e7d825 98 typedef enum
Jeej 45:b85384e7d825 99 {
Jeej 45:b85384e7d825 100 D7A_ERR_ITF_FULL = 2, // 0x02: For interfaces supporting buffering, indicates buffer reached maximum capacity (no data loss)
Jeej 45:b85384e7d825 101 D7A_ERR_PARTIAL_COMPLETION = 1, // 0x01: Action received and partially completed at response. To be completed after response
Jeej 45:b85384e7d825 102
Jeej 45:b85384e7d825 103 D7A_ERR_NONE = 0, // 0x00: Action completed (OK)
Jeej 45:b85384e7d825 104 D7A_ERR_FILE_NOT_FOUND = -1, // 0xFF: Error access file: File ID does not exist
Jeej 45:b85384e7d825 105 D7A_ERR_FILE_EXIST = -2, // 0xFE: Error create file: File ID already exists
Jeej 45:b85384e7d825 106 D7A_ERR_FILE_NOT_RESTORABLE = -3, // 0xFD: Error restore file: File is not restorable
Jeej 45:b85384e7d825 107 D7A_ERR_PERMISSION_DENIED = -4, // 0xFC: Error access file: Insufficient permissions
Jeej 45:b85384e7d825 108 D7A_ERR_LENGTH_OVERFLOW = -5, // 0xFB: Error create file: Supplied length (in header) is beyond file limits
Jeej 45:b85384e7d825 109 D7A_ERR_ALLOC_OVERFLOW = -6, // 0xFA: Error create file: Supplied allocation (in header) is beyond file limits
Jeej 45:b85384e7d825 110 D7A_ERR_OFFSET_OVERFLOW = -7, // 0xF9: Error write: Supplied start offset is out of bounds of file allocation
Jeej 45:b85384e7d825 111 D7A_ERR_WRITE_OVERFLOW = -8, // 0xF8: Error complete write: Supplied data goes beyond file allocation
Jeej 45:b85384e7d825 112 D7A_ERR_WRITE_ERROR = -9, // 0xF7: Error write: impossible to write in storage location
Jeej 45:b85384e7d825 113 D7A_ERR_OPERATION_UNKNOWN = -10,// 0xF6: Error unknown Operation
Jeej 45:b85384e7d825 114 D7A_ERR_OPERAND_INCOMPLETE = -11,// 0xF5: Error incomplete Operand
Jeej 45:b85384e7d825 115 D7A_ERR_OPERAND_WRONG_FORMAT = -12,// 0xF4: Error wrong Operand format
Jeej 45:b85384e7d825 116 D7A_ERR_ITF_INVALID = -13,// 0xF3: Error invalid interface
Jeej 45:b85384e7d825 117 D7A_ERR_ITF_OVERFLOW = -14,// 0xF2: Error interface overflown (i.e. ressources exhausted, buffer full with data discarded)
Jeej 45:b85384e7d825 118 D7A_ERR_QUERY_FAIL = -15,// 0xF1: (Group of) Query result was false (Informative error code).
Jeej 45:b85384e7d825 119
Jeej 45:b85384e7d825 120 D7A_ERR_UNKNOWN = -128,// 0x80: Unknown error
Jeej 57:fd9c8b67ffdc 121 D7A_ERR_FS_TIMEOUT ,// 0x81: Internal FS Error
Jeej 57:fd9c8b67ffdc 122 D7A_ERR_ITF_UNKNOWN ,// 0x82: Unknown Interface
Jeej 45:b85384e7d825 123
Jeej 45:b85384e7d825 124 // Modem errors
Jeej 45:b85384e7d825 125 D7A_ERR_NOT_READY ,// The modem is not ready to recieve commands
Jeej 45:b85384e7d825 126 D7A_ERR_COM_LINK ,// A serial link timeout occured
Jeej 45:b85384e7d825 127 D7A_ERR_ILLEGAL_FID ,// The FID specified is illegal
Jeej 45:b85384e7d825 128 D7A_ERR_ILLEGAL_FILE_DEF ,// The FILE parameters specified are illegal
Jeej 45:b85384e7d825 129 D7A_ERR_CMD_TO ,// The command expired
Jeej 45:b85384e7d825 130 D7A_ERR_TX_FAILED ,// Transmission failed
Jeej 56:da34fc11e760 131
Jeej 45:b85384e7d825 132 } d7a_errors_t;
Jeej 45:b85384e7d825 133
Jeej 55:5ea18a3a01b9 134
Jeej 55:5ea18a3a01b9 135 /// Types of retry policies
Jeej 55:5ea18a3a01b9 136 /// Respond: When finished the host will be notified
Jeej 55:5ea18a3a01b9 137 /// Persist: When finished on error data is kept in the queue for next transmission
Jeej 55:5ea18a3a01b9 138 /// Depth: Number of commands kept in the queue
Jeej 55:5ea18a3a01b9 139 /// Bulk: Notifications sent only when the queue is full
Jeej 55:5ea18a3a01b9 140 /// Retries: Number of retries after initial transmission
Jeej 55:5ea18a3a01b9 141 /// Slot: Time between retries (sec)
Jeej 46:665391110051 142 typedef enum {
Jeej 55:5ea18a3a01b9 143 /// Respond: true
Jeej 55:5ea18a3a01b9 144 /// Persist: false
Jeej 55:5ea18a3a01b9 145 /// Depth: 1
Jeej 55:5ea18a3a01b9 146 /// Bulk: false
Jeej 55:5ea18a3a01b9 147 /// Retries: 0
Jeej 55:5ea18a3a01b9 148 /// Slot: 0
Jeej 46:665391110051 149 ALP_RPOL_ONESHOT = 0,
Jeej 55:5ea18a3a01b9 150 /// Respond: true
Jeej 55:5ea18a3a01b9 151 /// Persist: false
Jeej 55:5ea18a3a01b9 152 /// Depth: 1
Jeej 55:5ea18a3a01b9 153 /// Bulk: false
Jeej 55:5ea18a3a01b9 154 /// Retries: 3
Jeej 55:5ea18a3a01b9 155 /// Slot: 2
Jeej 46:665391110051 156 ALP_RPOL_SINGLE = 1,
Jeej 55:5ea18a3a01b9 157 /// Respond: true
Jeej 55:5ea18a3a01b9 158 /// Persist: false
Jeej 55:5ea18a3a01b9 159 /// Depth: 1
Jeej 55:5ea18a3a01b9 160 /// Bulk: false
Jeej 55:5ea18a3a01b9 161 /// Retries: 3
Jeej 55:5ea18a3a01b9 162 /// Slot: 2
Jeej 46:665391110051 163 ALP_RPOL_REPORT = 2,
Jeej 55:5ea18a3a01b9 164 /// Respond: false
Jeej 55:5ea18a3a01b9 165 /// Persist: true
Jeej 55:5ea18a3a01b9 166 /// Depth: 4
Jeej 55:5ea18a3a01b9 167 /// Bulk: false
Jeej 55:5ea18a3a01b9 168 /// Retries: 16
Jeej 55:5ea18a3a01b9 169 /// Slot: 20
Jeej 46:665391110051 170 ALP_RPOL_REPORT_CHECKED = 3,
Jeej 55:5ea18a3a01b9 171 /// Respond: true
Jeej 55:5ea18a3a01b9 172 /// Persist: false
Jeej 55:5ea18a3a01b9 173 /// Depth: 4
Jeej 55:5ea18a3a01b9 174 /// Bulk: true
Jeej 55:5ea18a3a01b9 175 /// Retries: 0
Jeej 55:5ea18a3a01b9 176 /// Slot: 1
Jeej 46:665391110051 177 ALP_RPOL_BULK = 4,
Jeej 59:b42eae56b51b 178 /// Respond: false
Jeej 59:b42eae56b51b 179 /// Persist: false
Jeej 59:b42eae56b51b 180 /// Depth: 1
Jeej 59:b42eae56b51b 181 /// Bulk: false
Jeej 59:b42eae56b51b 182 /// Retries: 0
Jeej 59:b42eae56b51b 183 /// Slot: 1
Jeej 59:b42eae56b51b 184 ALP_RPOL_BLINK = 5,
Jeej 55:5ea18a3a01b9 185
Jeej 55:5ea18a3a01b9 186 //ALP_RPOL_SPARE_2 = 6,
Jeej 55:5ea18a3a01b9 187 //ALP_RPOL_SPARE_3 = 7,
Jeej 55:5ea18a3a01b9 188 } alp_rpol_t;
Jeej 46:665391110051 189
Jeej 55:5ea18a3a01b9 190 /// Action when file notifying
Jeej 55:5ea18a3a01b9 191 typedef enum {
Jeej 55:5ea18a3a01b9 192 D7A_ACTION_NONE = 0,
Jeej 55:5ea18a3a01b9 193 /// Notify the whole file
Jeej 55:5ea18a3a01b9 194 D7A_NOTIFICATION_FULL = 100,
Jeej 55:5ea18a3a01b9 195 /// Notify only part of the file
Jeej 55:5ea18a3a01b9 196 D7A_NOTIFICATION_PART
Jeej 55:5ea18a3a01b9 197 } d7a_action_t;
Jeej 45:b85384e7d825 198
Jeej 58:38a366236bda 199
Jeej 58:38a366236bda 200 // =======================================================================
Jeej 58:38a366236bda 201 // d7a_id_t
Jeej 58:38a366236bda 202 // -----------------------------------------------------------------------
Jeej 58:38a366236bda 203 // Identifier types enumerator
Jeej 58:38a366236bda 204 // =======================================================================
Jeej 58:38a366236bda 205 typedef enum
Jeej 58:38a366236bda 206 {
Jeej 58:38a366236bda 207 // Void identifier (broadcast)
Jeej 58:38a366236bda 208 // with indication of number of reached devices
Jeej 58:38a366236bda 209 D7A_ID_NBID = 0,
Jeej 58:38a366236bda 210 // Void identifier (broadcast)
Jeej 58:38a366236bda 211 D7A_ID_NOID = 1,
Jeej 58:38a366236bda 212 // Unique Identifier
Jeej 58:38a366236bda 213 D7A_ID_UID = 2,
Jeej 58:38a366236bda 214 // Virtual identifier
Jeej 58:38a366236bda 215 D7A_ID_VID = 3,
Jeej 58:38a366236bda 216
Jeej 58:38a366236bda 217 } d7a_id_t;
Jeej 58:38a366236bda 218
Jeej 43:28202405094d 219 //======================================================================
Jeej 43:28202405094d 220 // Structures
Jeej 43:28202405094d 221 //======================================================================
Jeej 43:28202405094d 222
Jeej 43:28202405094d 223 //======================================================================
Jeej 43:28202405094d 224 // d7a_com_config_t
Jeej 43:28202405094d 225 //----------------------------------------------------------------------
Jeej 43:28202405094d 226 /// Com port configuration structure
Jeej 43:28202405094d 227 //======================================================================
Jeej 43:28202405094d 228 typedef struct {
Jeej 43:28202405094d 229 /// Tx pin
Jeej 43:28202405094d 230 PinName tx;
Jeej 43:28202405094d 231 /// RX pin
Jeej 43:28202405094d 232 PinName rx;
Jeej 43:28202405094d 233 /// WKUP pin
Jeej 43:28202405094d 234 PinName rts;
Jeej 43:28202405094d 235 /// HST_WKUP pin
Jeej 43:28202405094d 236 PinName cts;
Jeej 43:28202405094d 237 /// Size of RX buffer
Jeej 43:28202405094d 238 uint16_t rx_buffer_size;
Jeej 43:28202405094d 239 } d7a_com_config_t;
Jeej 43:28202405094d 240
Jeej 59:b42eae56b51b 241 TYPEDEF_STRUCT_PACKED {
Jeej 59:b42eae56b51b 242 uint8_t fid;
Jeej 59:b42eae56b51b 243 uint32_t length;
Jeej 59:b42eae56b51b 244 uint32_t offset;
Jeej 59:b42eae56b51b 245 uint8_t buf[1];
Jeej 59:b42eae56b51b 246 } d7a_data_t;
Jeej 59:b42eae56b51b 247
Jeej 59:b42eae56b51b 248 // =======================================================================
Jeej 59:b42eae56b51b 249 // d7a_msg_t
Jeej 59:b42eae56b51b 250 // -----------------------------------------------------------------------
Jeej 59:b42eae56b51b 251 /// Response data and meta-data from a device
Jeej 59:b42eae56b51b 252 // =======================================================================
Jeej 59:b42eae56b51b 253 typedef struct
Jeej 59:b42eae56b51b 254 {
Jeej 59:b42eae56b51b 255 /// Error code
Jeej 59:b42eae56b51b 256 int8_t err;
Jeej 59:b42eae56b51b 257 /// Responder's UID
Jeej 59:b42eae56b51b 258 uint8_t id[D7A_UID_LEN];
Jeej 59:b42eae56b51b 259 /// Transmission Link Budget
Jeej 59:b42eae56b51b 260 int8_t lb;
Jeej 59:b42eae56b51b 261 /// Potential data
Jeej 59:b42eae56b51b 262 d7a_data_t* data;
Jeej 59:b42eae56b51b 263 } d7a_msg_t;
Jeej 49:81d5bddb02f0 264
Jeej 49:81d5bddb02f0 265
Jeej 43:28202405094d 266 typedef uint32_t (*WriteFileFunction)( const uint8_t file_id,
Jeej 43:28202405094d 267 const uint16_t offset,
Jeej 43:28202405094d 268 const uint16_t size,
Jeej 43:28202405094d 269 const uint8_t* const content);
Jeej 43:28202405094d 270
Jeej 43:28202405094d 271 typedef uint32_t (*ReadFileFunction)( const uint8_t file_id,
Jeej 43:28202405094d 272 const uint16_t offset,
Jeej 43:28202405094d 273 const uint16_t size,
Jeej 43:28202405094d 274 uint8_t* buf);
Jeej 43:28202405094d 275
Jeej 46:665391110051 276 typedef void (*NotifDoneFunction)( const uint8_t file_id,
Jeej 46:665391110051 277 const uint8_t error);
Jeej 59:b42eae56b51b 278
Jeej 59:b42eae56b51b 279 typedef void (*UnsolicitedMsgFunction)( d7a_msg_t** msg);
Jeej 46:665391110051 280
Jeej 43:28202405094d 281 //======================================================================
Jeej 43:28202405094d 282 // d7a_fs_callbacks_t
Jeej 43:28202405094d 283 //----------------------------------------------------------------------
Jeej 43:28202405094d 284 /// File system callbacks
Jeej 43:28202405094d 285 //======================================================================
Jeej 43:28202405094d 286 typedef struct {
Jeej 43:28202405094d 287 /// Write in local file
Jeej 43:28202405094d 288 WriteFileFunction write_file;
Jeej 43:28202405094d 289 /// Read from local file
Jeej 43:28202405094d 290 ReadFileFunction read_file;
Jeej 49:81d5bddb02f0 291 /// Is called when the notification is finished (depending on the retry policy)
Jeej 46:665391110051 292 NotifDoneFunction notif_done;
Jeej 59:b42eae56b51b 293 /// This function is called when an unsolicited message is catched
Jeej 59:b42eae56b51b 294 UnsolicitedMsgFunction unsolicited_msg;
Jeej 49:81d5bddb02f0 295 } d7a_callbacks_t;
Jeej 43:28202405094d 296
Jeej 43:28202405094d 297 //======================================================================
Jeej 43:28202405094d 298 // fw_version_t
Jeej 43:28202405094d 299 //----------------------------------------------------------------------
Jeej 43:28202405094d 300 /// Firmware version Structure
Jeej 43:28202405094d 301 /// Used within the revision structure
Jeej 43:28202405094d 302 //======================================================================
Jeej 43:28202405094d 303 TYPEDEF_STRUCT_PACKED
Jeej 43:28202405094d 304 {
Jeej 43:28202405094d 305 /// Software identifier
Jeej 43:28202405094d 306 uint8_t id;
Jeej 43:28202405094d 307 /// Version major
Jeej 43:28202405094d 308 uint8_t major;
Jeej 43:28202405094d 309 /// Version minor
Jeej 43:28202405094d 310 uint8_t minor;
Jeej 43:28202405094d 311 /// Version patch
Jeej 43:28202405094d 312 uint16_t patch;
Jeej 43:28202405094d 313 /// Version hash
Jeej 43:28202405094d 314 uint32_t hash;
Jeej 43:28202405094d 315 } fw_version_t;
Jeej 43:28202405094d 316
Jeej 43:28202405094d 317 //======================================================================
Jeej 43:28202405094d 318 // d7a_revision_t
Jeej 43:28202405094d 319 //----------------------------------------------------------------------
Jeej 43:28202405094d 320 /// Revision Structure
Jeej 43:28202405094d 321 ///
Jeej 43:28202405094d 322 /// Usage within D7B server:
Jeej 43:28202405094d 323 /// An XML describing the File system of a device is associated to a
Jeej 43:28202405094d 324 /// couple manufacturer_id/device_id (==Device).
Jeej 43:28202405094d 325 /// Different versions of the Device's XML can exist and can be mapped
Jeej 43:28202405094d 326 /// according to fw_version id/major/minor
Jeej 43:28202405094d 327 //======================================================================
Jeej 43:28202405094d 328 TYPEDEF_STRUCT_PACKED
Jeej 43:28202405094d 329 {
Jeej 43:28202405094d 330 /// Manufacturer ID: provided by Wizzilab
Jeej 43:28202405094d 331 uint32_t manufacturer_id;
Jeej 43:28202405094d 332 /// Device ID: Arbitrary number, at user/customer choice
Jeej 43:28202405094d 333 uint32_t device_id;
Jeej 43:28202405094d 334 /// Hardware Board ID:
Jeej 43:28202405094d 335 uint32_t hw_version;
Jeej 43:28202405094d 336 /// Firmware Version: made of
Jeej 43:28202405094d 337 /// - major,minor and patch indexes : comes from versioning tool
Jeej 43:28202405094d 338 /// - fw_id : "build-flavour" : comes from build setup
Jeej 43:28202405094d 339 /// FW_ID | MAJOR | MINOR | PATCH | HASH |
Jeej 43:28202405094d 340 /// 1B | 1B | 1B | 2B | 4B |
Jeej 43:28202405094d 341 fw_version_t fw_version;
Jeej 43:28202405094d 342 /// "file-system" signature XXX: to be worked out
Jeej 43:28202405094d 343 uint32_t fs_crc;
Jeej 43:28202405094d 344 } d7a_revision_t;
Jeej 43:28202405094d 345
Jeej 43:28202405094d 346
Jeej 43:28202405094d 347 // =======================================================================
Jeej 43:28202405094d 348 // d7a_addressee_ctrl_t
Jeej 43:28202405094d 349 // -----------------------------------------------------------------------
Jeej 43:28202405094d 350 /// Bitfield structure of the Addressee control byte
Jeej 43:28202405094d 351 // =======================================================================
Jeej 43:28202405094d 352 typedef union
Jeej 43:28202405094d 353 {
Jeej 53:3e4aa4b57090 354 /// bit access fields
Jeej 43:28202405094d 355 struct {
Jeej 43:28202405094d 356 /// Network security method
Jeej 43:28202405094d 357 uint8_t nls : 4;
Jeej 43:28202405094d 358 /// ID type
Jeej 43:28202405094d 359 uint8_t idf : 2;
Jeej 43:28202405094d 360 /// RFU
Jeej 43:28202405094d 361 uint8_t rfu_6 : 1;
Jeej 43:28202405094d 362 uint8_t rfu_7 : 1;
Jeej 43:28202405094d 363 } bf;
Jeej 43:28202405094d 364
Jeej 53:3e4aa4b57090 365 /// byte access
Jeej 43:28202405094d 366 uint8_t byte;
Jeej 43:28202405094d 367
Jeej 43:28202405094d 368 } d7a_addressee_ctrl_t;
Jeej 43:28202405094d 369
Jeej 43:28202405094d 370 // =======================================================================
Jeej 43:28202405094d 371 // d7a_xcl_t
Jeej 43:28202405094d 372 // -----------------------------------------------------------------------
Jeej 43:28202405094d 373 /// Bitfield structure of the Addressee Access Class
Jeej 43:28202405094d 374 // =======================================================================
Jeej 43:28202405094d 375 typedef union
Jeej 43:28202405094d 376 {
Jeej 53:3e4aa4b57090 377 /// bit access fields
Jeej 43:28202405094d 378 struct {
Jeej 43:28202405094d 379 /// Subclass mask
Jeej 43:28202405094d 380 uint8_t m : 4;
Jeej 43:28202405094d 381 /// Specifier
Jeej 43:28202405094d 382 uint8_t s : 4;
Jeej 43:28202405094d 383 } bf;
Jeej 43:28202405094d 384
Jeej 53:3e4aa4b57090 385 /// byte access
Jeej 43:28202405094d 386 uint8_t byte;
Jeej 43:28202405094d 387
Jeej 43:28202405094d 388 } d7a_xcl_t;
Jeej 43:28202405094d 389
Jeej 43:28202405094d 390 // =======================================================================
Jeej 43:28202405094d 391 // d7a_addressee_t
Jeej 43:28202405094d 392 // -----------------------------------------------------------------------
Jeej 43:28202405094d 393 /// Structure of the D7ATP Addressee byte
Jeej 43:28202405094d 394 // =======================================================================
Jeej 43:28202405094d 395 TYPEDEF_STRUCT_PACKED
Jeej 43:28202405094d 396 {
Jeej 54:540b327bfa14 397 /// Addressee control byte
Jeej 43:28202405094d 398 d7a_addressee_ctrl_t ctrl;
Jeej 54:540b327bfa14 399 /// Access Class
Jeej 43:28202405094d 400 d7a_xcl_t xcl;
Jeej 54:540b327bfa14 401 /// UID
Jeej 43:28202405094d 402 uint8_t id[D7A_UID_LEN];
Jeej 43:28202405094d 403
Jeej 43:28202405094d 404 } d7a_addressee_t;
Jeej 43:28202405094d 405
Jeej 43:28202405094d 406
Jeej 43:28202405094d 407 //======================================================================
Jeej 43:28202405094d 408 // Prototypes
Jeej 43:28202405094d 409 //======================================================================
Jeej 43:28202405094d 410
Jeej 43:28202405094d 411 //======================================================================
Jeej 43:28202405094d 412 // d7a_open
Jeej 43:28202405094d 413 //----------------------------------------------------------------------
Jeej 43:28202405094d 414 /// @brief Open D7A driver and start the modem
Jeej 53:3e4aa4b57090 415 /// @param com_config Com port configuration structure
Jeej 53:3e4aa4b57090 416 /// @param reset_pin Reset pin
Jeej 53:3e4aa4b57090 417 /// @param callbacks File system callbacks (You cannot use local files if this is not specified)
Jeej 45:b85384e7d825 418 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 419 //======================================================================
Jeej 55:5ea18a3a01b9 420 d7a_errors_t d7a_open(const d7a_com_config_t* com_config,
Jeej 55:5ea18a3a01b9 421 PinName reset_pin,
Jeej 55:5ea18a3a01b9 422 const d7a_callbacks_t* callbacks);
Jeej 43:28202405094d 423
Jeej 43:28202405094d 424 //======================================================================
Jeej 43:28202405094d 425 // d7a_close
Jeej 43:28202405094d 426 //----------------------------------------------------------------------
Jeej 43:28202405094d 427 /// @brief Close D7A driver and stop the modem
Jeej 45:b85384e7d825 428 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 429 //======================================================================
Jeej 45:b85384e7d825 430 d7a_errors_t d7a_close(void);
Jeej 43:28202405094d 431
Jeej 43:28202405094d 432 //======================================================================
Jeej 43:28202405094d 433 // d7a_start
Jeej 43:28202405094d 434 //----------------------------------------------------------------------
Jeej 43:28202405094d 435 /// @brief Start the modem
Jeej 45:b85384e7d825 436 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 437 //======================================================================
Jeej 45:b85384e7d825 438 d7a_errors_t d7a_start(void);
Jeej 43:28202405094d 439
Jeej 43:28202405094d 440 //======================================================================
Jeej 43:28202405094d 441 // d7a_stop
Jeej 43:28202405094d 442 //----------------------------------------------------------------------
Jeej 43:28202405094d 443 /// @brief Stop the modem (goes to low power)
Jeej 45:b85384e7d825 444 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 445 //======================================================================
Jeej 45:b85384e7d825 446 d7a_errors_t d7a_stop(void);
Jeej 43:28202405094d 447
Jeej 43:28202405094d 448 //======================================================================
Jeej 43:28202405094d 449 // d7a_create
Jeej 43:28202405094d 450 //----------------------------------------------------------------------
Jeej 43:28202405094d 451 /// @brief Creates a file on the modem
Jeej 53:3e4aa4b57090 452 /// @param file_id ID of the file to create
Jeej 53:3e4aa4b57090 453 /// @param prop Type of file
Jeej 53:3e4aa4b57090 454 /// @param perm Access permissions
Jeej 53:3e4aa4b57090 455 /// @param size Length of the created file
Jeej 53:3e4aa4b57090 456 /// @param alloc Maximum size of the file
Jeej 55:5ea18a3a01b9 457 /// @param action Type of action to trigger
Jeej 55:5ea18a3a01b9 458 /// @param retry Index to the retry policy to use when notifying
Jeej 45:b85384e7d825 459 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 460 //======================================================================
Jeej 55:5ea18a3a01b9 461 d7a_errors_t d7a_create(const uint8_t file_id,
Jeej 55:5ea18a3a01b9 462 d7a_fs_storage_t prop,
Jeej 55:5ea18a3a01b9 463 d7a_fs_perm_t perm,
Jeej 55:5ea18a3a01b9 464 uint32_t size,
Jeej 55:5ea18a3a01b9 465 uint32_t alloc,
Jeej 55:5ea18a3a01b9 466 d7a_action_t action = D7A_ACTION_NONE,
Jeej 55:5ea18a3a01b9 467 alp_rpol_t retry = ALP_RPOL_ONESHOT);
Jeej 43:28202405094d 468
Jeej 43:28202405094d 469 //======================================================================
Jeej 43:28202405094d 470 // d7a_declare
Jeej 43:28202405094d 471 //----------------------------------------------------------------------
mikl_andre 48:950406be9810 472 /// @brief Declare a file stored on the host to the modem (need to have implemented the fs_callbacks)
Jeej 53:3e4aa4b57090 473 /// @param file_id ID of the file to declare
Jeej 53:3e4aa4b57090 474 /// @param prop Type of file
Jeej 53:3e4aa4b57090 475 /// @param perm Access permissions
Jeej 53:3e4aa4b57090 476 /// @param size Length of the created file
Jeej 53:3e4aa4b57090 477 /// @param alloc Maximum size of the file
Jeej 55:5ea18a3a01b9 478 /// @param action Type of action to trigger
Jeej 55:5ea18a3a01b9 479 /// @param retry Index to the retry policy to use when notifying
Jeej 45:b85384e7d825 480 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 481 //======================================================================
Jeej 55:5ea18a3a01b9 482 d7a_errors_t d7a_declare(const uint8_t file_id,
Jeej 55:5ea18a3a01b9 483 d7a_fs_storage_t prop,
Jeej 55:5ea18a3a01b9 484 d7a_fs_perm_t perm,
Jeej 55:5ea18a3a01b9 485 uint32_t size,
Jeej 55:5ea18a3a01b9 486 uint32_t alloc,
Jeej 55:5ea18a3a01b9 487 d7a_action_t action = D7A_ACTION_NONE,
Jeej 55:5ea18a3a01b9 488 alp_rpol_t retry = ALP_RPOL_ONESHOT);
Jeej 43:28202405094d 489
Jeej 43:28202405094d 490 //======================================================================
Jeej 43:28202405094d 491 // d7a_read
Jeej 43:28202405094d 492 //----------------------------------------------------------------------
Jeej 43:28202405094d 493 /// @brief Read data from a file
Jeej 53:3e4aa4b57090 494 /// @param file_id File ID of file to read
Jeej 53:3e4aa4b57090 495 /// @param offset Offset from which to start reading
Jeej 53:3e4aa4b57090 496 /// @param size Size of data to read
Jeej 53:3e4aa4b57090 497 /// @param buf Buffer to retrieve data
Jeej 53:3e4aa4b57090 498 /// @param addressee Addressee to an eventual distant device
Jeej 53:3e4aa4b57090 499 /// @param retry Index to the retry policy to use
Jeej 45:b85384e7d825 500 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 501 //======================================================================
Jeej 58:38a366236bda 502 d7a_msg_t** d7a_read(const uint8_t file_id,
Jeej 55:5ea18a3a01b9 503 const uint32_t offset,
Jeej 55:5ea18a3a01b9 504 const uint32_t size,
Jeej 55:5ea18a3a01b9 505 d7a_addressee_t* addressee = NULL,
Jeej 55:5ea18a3a01b9 506 alp_rpol_t retry = ALP_RPOL_ONESHOT);
Jeej 43:28202405094d 507
Jeej 43:28202405094d 508 //======================================================================
Jeej 43:28202405094d 509 // d7a_write
Jeej 43:28202405094d 510 //----------------------------------------------------------------------
Jeej 43:28202405094d 511 /// @brief Write data to a file
Jeej 53:3e4aa4b57090 512 /// @param file_id File ID of file to write
Jeej 53:3e4aa4b57090 513 /// @param offset Offset from which to start reading
Jeej 53:3e4aa4b57090 514 /// @param size Size of data to read
Jeej 53:3e4aa4b57090 515 /// @param buf Buffer to retrieve data
Jeej 53:3e4aa4b57090 516 /// @param addressee Addressee to an eventual distant device
Jeej 53:3e4aa4b57090 517 /// @param retry Index to the retry policy to use
Jeej 53:3e4aa4b57090 518 /// @param resp Wait to see if write is OK
Jeej 45:b85384e7d825 519 /// @return d7a_errors_t Error code
Jeej 43:28202405094d 520 //======================================================================
Jeej 58:38a366236bda 521 d7a_msg_t** d7a_write(const uint8_t file_id,
Jeej 55:5ea18a3a01b9 522 const uint32_t offset,
Jeej 55:5ea18a3a01b9 523 const uint32_t size,
Jeej 55:5ea18a3a01b9 524 const uint8_t* const buf,
Jeej 55:5ea18a3a01b9 525 d7a_addressee_t* addressee = NULL,
Jeej 55:5ea18a3a01b9 526 alp_rpol_t retry = ALP_RPOL_ONESHOT,
Jeej 55:5ea18a3a01b9 527 bool resp = true);
Jeej 46:665391110051 528
Jeej 46:665391110051 529 //======================================================================
mikl_andre 48:950406be9810 530 // d7a_notify
Jeej 46:665391110051 531 //----------------------------------------------------------------------
Jeej 46:665391110051 532 /// @brief Write data to a file
Jeej 53:3e4aa4b57090 533 /// @param file_id File ID of file to write
Jeej 53:3e4aa4b57090 534 /// @param offset Offset from which to start writing
Jeej 53:3e4aa4b57090 535 /// @param size Size of data to write
Jeej 46:665391110051 536 /// @return d7a_errors_t Error code
Jeej 46:665391110051 537 //======================================================================
Jeej 55:5ea18a3a01b9 538 d7a_errors_t d7a_notify(const uint8_t file_id,
Jeej 55:5ea18a3a01b9 539 const uint32_t offset = 0,
Jeej 55:5ea18a3a01b9 540 const uint32_t size = 0);
Jeej 43:28202405094d 541
Jeej 60:8d4133fbc060 542 //======================================================================
Jeej 60:8d4133fbc060 543 // d7a_free_msg
Jeej 60:8d4133fbc060 544 //----------------------------------------------------------------------
Jeej 60:8d4133fbc060 545 /// @brief Free the modem infos
Jeej 60:8d4133fbc060 546 /// @param msg message to free
Jeej 60:8d4133fbc060 547 //======================================================================
Jeej 60:8d4133fbc060 548 void d7a_free_msg(d7a_msg_t** msg);
Jeej 50:30440c9aeb7c 549
Jeej 60:8d4133fbc060 550 //======================================================================
Jeej 60:8d4133fbc060 551 // d7a_print_msg
Jeej 60:8d4133fbc060 552 //----------------------------------------------------------------------
Jeej 60:8d4133fbc060 553 /// @brief Prints the message
Jeej 60:8d4133fbc060 554 /// @param msg message to print
Jeej 60:8d4133fbc060 555 //======================================================================
Jeej 60:8d4133fbc060 556 void d7a_print_msg(d7a_msg_t** msg);
Jeej 58:38a366236bda 557
Jeej 50:30440c9aeb7c 558 //======================================================================
Jeej 50:30440c9aeb7c 559 // d7a_modem_print_infos
Jeej 50:30440c9aeb7c 560 //----------------------------------------------------------------------
Jeej 50:30440c9aeb7c 561 /// @brief Prints the modem infos
Jeej 50:30440c9aeb7c 562 //======================================================================
Jeej 50:30440c9aeb7c 563 void d7a_modem_print_infos(void);
Jeej 50:30440c9aeb7c 564
Jeej 50:30440c9aeb7c 565
Jeej 50:30440c9aeb7c 566
Jeej 50:30440c9aeb7c 567
Jeej 43:28202405094d 568 #endif // _D7A_H_