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_alp.h@45:b85384e7d825, 2016-09-01 (annotated)

Committer:
Jeej
Date:
Thu Sep 01 09:35:27 2016 +0000
Revision:
45:b85384e7d825
Parent:
43:28202405094d
Child:
46:665391110051
New API working for local read/write.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jeej 43:28202405094d 1 #ifndef _D7A_ALP_H_
Jeej 43:28202405094d 2 #define _D7A_ALP_H_
Jeej 43:28202405094d 3
Jeej 43:28202405094d 4
Jeej 43:28202405094d 5 #define ALP_CTRL_GROUP 0x80
Jeej 43:28202405094d 6 #define ALP_CTRL_RESP 0x40
Jeej 43:28202405094d 7 #define ALP_CTRL_OVERLOAD 0x80
Jeej 43:28202405094d 8 #define ALP_CTRL_INDIRECT 0x40
Jeej 43:28202405094d 9 #define ALP_CTRL_EOP 0x80
Jeej 43:28202405094d 10 #define ALP_CTRL_ERR 0x40
Jeej 43:28202405094d 11
Jeej 43:28202405094d 12
Jeej 43:28202405094d 13 typedef enum {
Jeej 43:28202405094d 14 // OPCODE | OPERAND
Jeej 43:28202405094d 15 ALP_OPCODE_NOP = 0, //| -
Jeej 43:28202405094d 16
Jeej 43:28202405094d 17 ALP_OPCODE_F_RD_DATA = 1, //| FDR
Jeej 43:28202405094d 18 ALP_OPCODE_F_RD_PROP = 2, //| FID
Jeej 43:28202405094d 19
Jeej 43:28202405094d 20 ALP_OPCODE_F_WR_DATA = 4, //| FD
Jeej 43:28202405094d 21 ALP_OPCODE_F_WR_FLUSH = 5, //| FD
Jeej 43:28202405094d 22 ALP_OPCODE_F_WR_PROP = 6, //| FD
Jeej 43:28202405094d 23
Jeej 43:28202405094d 24 ALP_OPCODE_QUERY = 8, //| Q
Jeej 43:28202405094d 25 ALP_OPCODE_QBREAK = 9, //| Q
Jeej 43:28202405094d 26 ALP_OPCODE_PERM_REQ = 10, //| P
Jeej 43:28202405094d 27
Jeej 43:28202405094d 28 ALP_OPCODE_CRC_CHECK = 11, //| Q
Jeej 43:28202405094d 29
Jeej 43:28202405094d 30 ALP_OPCODE_F_EXIST = 16, //| FID
Jeej 43:28202405094d 31 ALP_OPCODE_F_CREATE = 17, //| FD
Jeej 43:28202405094d 32 ALP_OPCODE_F_DELETE = 18, //| FID
Jeej 43:28202405094d 33 ALP_OPCODE_F_RESTORE = 19, //| FID
Jeej 43:28202405094d 34 ALP_OPCODE_F_FLUSH = 20, //| FID
Jeej 43:28202405094d 35 ALP_OPCODE_F_OPEN = 21, //| FID
Jeej 43:28202405094d 36 ALP_OPCODE_F_CLOSE = 22, //| FID
Jeej 43:28202405094d 37 ALP_OPCODE_F_COPY = 23, //| 2xFID
Jeej 43:28202405094d 38 ALP_OPCODE_F_EXECUTE = 31, //| FID
Jeej 43:28202405094d 39
Jeej 43:28202405094d 40 ALP_OPCODE_RSP_F_DATA = 32, //| FD
Jeej 43:28202405094d 41 ALP_OPCODE_RSP_F_PROP = 33, //| FH
Jeej 43:28202405094d 42 ALP_OPCODE_RSP_STATUS = 34, //| S
Jeej 43:28202405094d 43 ALP_OPCODE_RSP_ISTATUS = ALP_OPCODE_RSP_STATUS + (1 << 6), //| SI
Jeej 43:28202405094d 44 ALP_OPCODE_RSP_TAG = 35, //| PID
Jeej 43:28202405094d 45 ALP_OPCODE_RSP_EOPTAG = ALP_OPCODE_RSP_TAG + (2 << 6), //| PID
Jeej 43:28202405094d 46 ALP_OPCODE_RSP_ERRTAG = ALP_OPCODE_RSP_TAG + (1 << 6), //| PID
Jeej 43:28202405094d 47
Jeej 43:28202405094d 48 ALP_OPCODE_CHUNK = 48, //| -
Jeej 43:28202405094d 49 ALP_OPCODE_LOGIC = 49, //| -
Jeej 43:28202405094d 50 ALP_OPCODE_FORWARD = 50, //| I
Jeej 43:28202405094d 51 ALP_OPCODE_IFORWARD = 51, //| IFID
Jeej 43:28202405094d 52 ALP_OPCODE_TAG = 52, //| PID
Jeej 43:28202405094d 53
Jeej 43:28202405094d 54 ALP_OPCODE_EXT = 63, //| RFU
Jeej 43:28202405094d 55
Jeej 43:28202405094d 56 // Modifiers
Jeej 43:28202405094d 57 ALP_OPCODE_RESP = 0x40,
Jeej 43:28202405094d 58 ALP_OPCODE_GROUP = 0x80,
Jeej 43:28202405094d 59
Jeej 43:28202405094d 60 ALP_OPCODE_ERR = 0x40,
Jeej 43:28202405094d 61 ALP_OPCODE_EOP = 0x80,
Jeej 43:28202405094d 62
Jeej 43:28202405094d 63 ALP_OPCODE_INDIRECT = 0x40,
Jeej 43:28202405094d 64 ALP_OPCODE_OVERLOAD = 0x80,
Jeej 43:28202405094d 65
Jeej 43:28202405094d 66 } alp_opcodes_t;
Jeej 43:28202405094d 67
Jeej 43:28202405094d 68 // =======================================================================
Jeej 43:28202405094d 69 // d7a_id_t
Jeej 43:28202405094d 70 // -----------------------------------------------------------------------
Jeej 43:28202405094d 71 /// Identifier types enumerator
Jeej 43:28202405094d 72 // =======================================================================
Jeej 43:28202405094d 73 typedef enum
Jeej 43:28202405094d 74 {
Jeej 43:28202405094d 75 /// Void identifier (broadcast)
Jeej 43:28202405094d 76 /// with indication of number of reached devices
Jeej 43:28202405094d 77 D7A_ID_NBID = 0,
Jeej 43:28202405094d 78 /// Void identifier (broadcast)
Jeej 43:28202405094d 79 D7A_ID_NOID = 1,
Jeej 43:28202405094d 80 /// Unique Identifier
Jeej 43:28202405094d 81 D7A_ID_UID = 2,
Jeej 43:28202405094d 82 /// Virtual identifier
Jeej 43:28202405094d 83 D7A_ID_VID = 3,
Jeej 43:28202405094d 84
Jeej 43:28202405094d 85 } d7a_id_t;
Jeej 43:28202405094d 86
Jeej 45:b85384e7d825 87 typedef enum {
Jeej 45:b85384e7d825 88 ALP_RESP_TYPE_UNKNOWN = 0,
Jeej 45:b85384e7d825 89 ALP_RESP_TYPE_F_DATA = ALP_OPCODE_RSP_F_DATA,
Jeej 45:b85384e7d825 90 ALP_RESP_TYPE_F_PROP = ALP_OPCODE_RSP_F_PROP,
Jeej 45:b85384e7d825 91 ALP_RESP_TYPE_ISTATUS = ALP_OPCODE_RSP_ISTATUS,
Jeej 45:b85384e7d825 92 ALP_RESP_TYPE_STATUS = ALP_OPCODE_RSP_STATUS,
Jeej 45:b85384e7d825 93 ALP_RESP_TYPE_TAG = ALP_OPCODE_RSP_TAG,
Jeej 45:b85384e7d825 94 } alp_resp_type_t;
Jeej 45:b85384e7d825 95
Jeej 45:b85384e7d825 96 typedef struct {
Jeej 45:b85384e7d825 97 uint8_t type;
Jeej 45:b85384e7d825 98 uint8_t* data; // data
Jeej 45:b85384e7d825 99 union
Jeej 45:b85384e7d825 100 {
Jeej 45:b85384e7d825 101 struct {
Jeej 45:b85384e7d825 102 uint32_t length;
Jeej 45:b85384e7d825 103 uint32_t offset;
Jeej 45:b85384e7d825 104 uint8_t fid;
Jeej 45:b85384e7d825 105 } f_data;
Jeej 45:b85384e7d825 106 struct {
Jeej 45:b85384e7d825 107 uint32_t length;
Jeej 45:b85384e7d825 108 uint32_t offset;
Jeej 45:b85384e7d825 109 uint8_t fid;
Jeej 45:b85384e7d825 110 } f_prop;
Jeej 45:b85384e7d825 111 struct {
Jeej 45:b85384e7d825 112 uint8_t code;
Jeej 45:b85384e7d825 113 uint8_t id; // Action ID
Jeej 45:b85384e7d825 114 } status;
Jeej 45:b85384e7d825 115 struct {
Jeej 45:b85384e7d825 116 uint32_t length;
Jeej 45:b85384e7d825 117 uint8_t type;
Jeej 45:b85384e7d825 118 } itf;
Jeej 45:b85384e7d825 119 struct {
Jeej 45:b85384e7d825 120 uint8_t id;
Jeej 45:b85384e7d825 121 uint8_t eop;
Jeej 45:b85384e7d825 122 uint8_t err;
Jeej 45:b85384e7d825 123 } tag;
Jeej 45:b85384e7d825 124 } meta;
Jeej 45:b85384e7d825 125 } alp_uns_resp_parsed_t;
Jeej 45:b85384e7d825 126
Jeej 45:b85384e7d825 127 TYPEDEF_STRUCT_PACKED
Jeej 45:b85384e7d825 128 {
Jeej 45:b85384e7d825 129 uint8_t aid;
Jeej 45:b85384e7d825 130 int8_t status;
Jeej 45:b85384e7d825 131 } d7a_alp_rsp_status_t;
Jeej 45:b85384e7d825 132
Jeej 45:b85384e7d825 133 TYPEDEF_STRUCT_PACKED
Jeej 45:b85384e7d825 134 {
Jeej 45:b85384e7d825 135 uint8_t ctrl;
Jeej 45:b85384e7d825 136 uint8_t fid;
Jeej 45:b85384e7d825 137 uint32_t offset;
Jeej 45:b85384e7d825 138 uint32_t length;
Jeej 45:b85384e7d825 139 uint8_t data[1];
Jeej 45:b85384e7d825 140 } d7a_alp_rsp_f_data_t;
Jeej 45:b85384e7d825 141
Jeej 45:b85384e7d825 142 TYPEDEF_STRUCT_PACKED
Jeej 45:b85384e7d825 143 {
Jeej 45:b85384e7d825 144 uint8_t tag;
Jeej 45:b85384e7d825 145 } d7a_alp_rsp_tag_t;
Jeej 45:b85384e7d825 146
Jeej 45:b85384e7d825 147
Jeej 45:b85384e7d825 148 TYPEDEF_STRUCT_PACKED
Jeej 45:b85384e7d825 149 {
Jeej 45:b85384e7d825 150 uint8_t tag;
Jeej 45:b85384e7d825 151 uint8_t tag_status;
Jeej 45:b85384e7d825 152 uint8_t nb_status;
Jeej 45:b85384e7d825 153 d7a_alp_rsp_status_t status[5];
Jeej 45:b85384e7d825 154 uint32_t length;
Jeej 45:b85384e7d825 155 uint8_t* data;
Jeej 45:b85384e7d825 156 } d7a_alp_rsp_t;
Jeej 45:b85384e7d825 157
Jeej 43:28202405094d 158 void d7a_alp_open(void);
Jeej 43:28202405094d 159 void d7a_alp_new_pkt(d7a_com_rx_msg_t* pkt);
Jeej 43:28202405094d 160 d7a_com_rx_msg_t* d7a_alp_wait_pkt(uint32_t millisec = osWaitForever);
Jeej 45:b85384e7d825 161 int8_t d7a_alp_write_file(const uint8_t file_id, const uint32_t offset, const uint32_t size, const uint8_t* const buf, d7a_addressee_t* addressee = NULL, uint8_t retry = 0, bool resp = true);
Jeej 45:b85384e7d825 162 int8_t d7a_alp_read_file(const uint8_t file_id, const uint32_t offset, const uint32_t size, const uint8_t* const buf, d7a_addressee_t* addressee = NULL, uint8_t retry = 0);
Jeej 43:28202405094d 163
Jeej 43:28202405094d 164 #endif // _D7A_ALP_H_