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@58:38a366236bda, 2016-09-12 (annotated)

Committer:
Jeej
Date:
Mon Sep 12 16:36:09 2016 +0000
Revision:
58:38a366236bda
Parent:
57:fd9c8b67ffdc
Child:
59:b42eae56b51b
Broadcast.

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