WizziLab / modem_ref

Exportable version of WizziLab's modem driver.

Dependents:   modem_ref_helper

include/alp_spec.h@30:74aa36420c61, 2018-06-04 (annotated)

Committer:
Jeej
Date:
Mon Jun 04 15:32:05 2018 +0000
Revision:
30:74aa36420c61
Parent:
26:2c934a269914
Child:
35:ac940cf8ebe6
Updated to v5.1.174

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jeej 19:701d5669f2e9 1 /// @copyright
Jeej 19:701d5669f2e9 2 /// ========================================================================={{{
Jeej 30:74aa36420c61 3 /// Copyright (c) 2012-2018 WizziLab /
Jeej 19:701d5669f2e9 4 /// All rights reserved /
Jeej 19:701d5669f2e9 5 /// /
Jeej 19:701d5669f2e9 6 /// IMPORTANT: This Software may not be modified, copied or distributed unless /
Jeej 19:701d5669f2e9 7 /// embedded on a WizziLab product. Other than for the foregoing purpose, this /
Jeej 19:701d5669f2e9 8 /// Software and/or its documentation may not be used, reproduced, copied, /
Jeej 19:701d5669f2e9 9 /// prepared derivative works of, modified, performed, distributed, displayed /
Jeej 19:701d5669f2e9 10 /// or sold for any purpose. For the sole purpose of embedding this Software /
Jeej 19:701d5669f2e9 11 /// on a WizziLab product, copy, modification and distribution of this /
Jeej 19:701d5669f2e9 12 /// Software is granted provided that the following conditions are respected: /
Jeej 19:701d5669f2e9 13 /// /
Jeej 19:701d5669f2e9 14 /// * Redistributions of source code must retain the above copyright notice, /
Jeej 19:701d5669f2e9 15 /// this list of conditions and the following disclaimer /
Jeej 19:701d5669f2e9 16 /// /
Jeej 19:701d5669f2e9 17 /// * Redistributions in binary form must reproduce the above copyright /
Jeej 19:701d5669f2e9 18 /// notice, this list of conditions and the following disclaimer in the /
Jeej 19:701d5669f2e9 19 /// documentation and/or other materials provided with the distribution. /
Jeej 19:701d5669f2e9 20 /// /
Jeej 19:701d5669f2e9 21 /// * The name of WizziLab can not be used to endorse or promote products /
Jeej 19:701d5669f2e9 22 /// derived from this software without specific prior written permission. /
Jeej 19:701d5669f2e9 23 /// /
Jeej 19:701d5669f2e9 24 /// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS /
Jeej 19:701d5669f2e9 25 /// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED /
Jeej 19:701d5669f2e9 26 /// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR /
Jeej 19:701d5669f2e9 27 /// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR /
Jeej 19:701d5669f2e9 28 /// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, /
Jeej 19:701d5669f2e9 29 /// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, /
Jeej 19:701d5669f2e9 30 /// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, /
Jeej 19:701d5669f2e9 31 /// OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY /
Jeej 19:701d5669f2e9 32 /// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING /
Jeej 19:701d5669f2e9 33 /// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS /
Jeej 19:701d5669f2e9 34 /// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /
Jeej 19:701d5669f2e9 35 /// WIZZILAB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, /
Jeej 19:701d5669f2e9 36 /// ENHANCEMENTS OR MODIFICATIONS. /
Jeej 19:701d5669f2e9 37 /// /
Jeej 19:701d5669f2e9 38 /// Should you have any questions regarding your right to use this Software, /
Jeej 19:701d5669f2e9 39 /// contact WizziLab at www.wizzilab.com. /
Jeej 19:701d5669f2e9 40 /// /
Jeej 19:701d5669f2e9 41 /// =========================================================================}}}
Jeej 19:701d5669f2e9 42 /// @endcopyright
Jeej 19:701d5669f2e9 43
Jeej 19:701d5669f2e9 44 // =======================================================================
Jeej 19:701d5669f2e9 45 /// @file alp_spec.h
Jeej 19:701d5669f2e9 46 /// @defgroup ALP
Jeej 19:701d5669f2e9 47 /// @brief ALP definitions from D7A specification
Jeej 19:701d5669f2e9 48 // =======================================================================
Jeej 19:701d5669f2e9 49
Jeej 19:701d5669f2e9 50 #ifndef __ALP_SPEC_H__
Jeej 19:701d5669f2e9 51 #define __ALP_SPEC_H__
Jeej 19:701d5669f2e9 52
Jeej 19:701d5669f2e9 53 #include "hal_types.h"
Jeej 19:701d5669f2e9 54
Jeej 19:701d5669f2e9 55 // Opcode Modifiers / Preemption flags
Jeej 30:74aa36420c61 56 #define ALP_OPCODE_RESP 0x40
Jeej 30:74aa36420c61 57 #define ALP_OPCODE_GROUP 0x80
Jeej 30:74aa36420c61 58 #define ALP_OPCODE_ERR 0x40
Jeej 30:74aa36420c61 59 #define ALP_OPCODE_EOP 0x80
Jeej 30:74aa36420c61 60 #define ALP_OPCODE_ITF 0x40
Jeej 30:74aa36420c61 61 #define ALP_OPCODE_INDIRECT 0x40
Jeej 30:74aa36420c61 62 #define ALP_OPCODE_OVERLOAD 0x80
Jeej 19:701d5669f2e9 63
Jeej 19:701d5669f2e9 64 typedef enum {
Jeej 30:74aa36420c61 65 // OPCODE | OPERAND
Jeej 30:74aa36420c61 66 ALP_OPCODE_NOP = 0, //| -
Jeej 19:701d5669f2e9 67
Jeej 30:74aa36420c61 68 ALP_OPCODE_F_RD_DATA = 1, //| FDR
Jeej 30:74aa36420c61 69 ALP_OPCODE_F_RD_PROP = 2, //| FID
Jeej 19:701d5669f2e9 70
Jeej 30:74aa36420c61 71 ALP_OPCODE_F_WR_DATA = 4, //| FD
Jeej 30:74aa36420c61 72 ALP_OPCODE_F_WR_FLUSH = 5, //| FD
Jeej 30:74aa36420c61 73 ALP_OPCODE_F_WR_PROP = 6, //| FD
Jeej 30:74aa36420c61 74 ALP_OPCODE_F_TOUCH = 7, //| FD
Jeej 19:701d5669f2e9 75
Jeej 30:74aa36420c61 76 ALP_OPCODE_QUERY = 8, //| Q
Jeej 30:74aa36420c61 77 ALP_OPCODE_QBREAK = 9, //| Q
Jeej 30:74aa36420c61 78 ALP_OPCODE_PERM_REQ = 10, //| P
Jeej 19:701d5669f2e9 79
Jeej 30:74aa36420c61 80 ALP_OPCODE_CRC_CHECK = 11, //| Q
Jeej 19:701d5669f2e9 81
Jeej 30:74aa36420c61 82 ALP_OPCODE_F_EXIST = 16, //| FID
Jeej 30:74aa36420c61 83 ALP_OPCODE_F_CREATE = 17, //| FD
Jeej 30:74aa36420c61 84 ALP_OPCODE_F_DELETE = 18, //| FID
Jeej 30:74aa36420c61 85 ALP_OPCODE_F_RESTORE = 19, //| FID
Jeej 30:74aa36420c61 86 ALP_OPCODE_F_FLUSH = 20, //| FID
Jeej 30:74aa36420c61 87 ALP_OPCODE_F_DECLARE = 21, //| FH XXX Deprecated DO NOT USE !!!
Jeej 30:74aa36420c61 88 ALP_OPCODE_F_CLOSE = 22, //| FID
Jeej 30:74aa36420c61 89 ALP_OPCODE_F_COPY = 23, //| 2xFID
Jeej 30:74aa36420c61 90 ALP_OPCODE_F_EXECUTE = 31, //| FID
Jeej 19:701d5669f2e9 91
Jeej 30:74aa36420c61 92 ALP_OPCODE_RSP_F_DATA = 32, //| FD
Jeej 30:74aa36420c61 93 ALP_OPCODE_RSP_F_PROP = 33, //| FH
Jeej 30:74aa36420c61 94 ALP_OPCODE_RSP_STATUS = 34, //| S
Jeej 30:74aa36420c61 95 ALP_OPCODE_RSP_ISTATUS = ALP_OPCODE_RSP_STATUS + ALP_OPCODE_ITF, //| SI
Jeej 30:74aa36420c61 96 ALP_OPCODE_RSP_TAG = 35, //| PID
Jeej 30:74aa36420c61 97 ALP_OPCODE_RSP_EOPTAG = ALP_OPCODE_RSP_TAG + ALP_OPCODE_EOP, //| PID
Jeej 30:74aa36420c61 98 ALP_OPCODE_RSP_ERRTAG = ALP_OPCODE_RSP_TAG + ALP_OPCODE_ERR, //| PID
Jeej 30:74aa36420c61 99 ALP_OPCODE_RSP_URC = 36, //|
Jeej 19:701d5669f2e9 100
Jeej 30:74aa36420c61 101 ALP_OPCODE_CHUNK = 48, //| -
Jeej 30:74aa36420c61 102 ALP_OPCODE_LOGIC = 49, //| -
Jeej 30:74aa36420c61 103 ALP_OPCODE_FORWARD = 50, //| I
Jeej 30:74aa36420c61 104 ALP_OPCODE_IFORWARD = 51, //| IFID
Jeej 30:74aa36420c61 105 ALP_OPCODE_TAG = 52, //| PID
Jeej 30:74aa36420c61 106 ALP_OPCODE_URCC = 53, //|
Jeej 19:701d5669f2e9 107
Jeej 30:74aa36420c61 108 ALP_OPCODE_EXT = 63, //| OP |ARGC| ARGS |
Jeej 30:74aa36420c61 109 //| 1B | 1B | ARGC-bytes |
Jeej 19:701d5669f2e9 110 } alp_opcodes_t;
Jeej 30:74aa36420c61 111 #define ALP_OPCODE_UNKNOWN (-1)
Jeej 19:701d5669f2e9 112
Jeej 19:701d5669f2e9 113 typedef enum {
Jeej 30:74aa36420c61 114 ALP_ITF_TYPE_HOST = 0x00,
Jeej 30:74aa36420c61 115 ALP_ITF_TYPE_BLE = 0xB0,
Jeej 30:74aa36420c61 116 ALP_ITF_TYPE_COM = 0xC0,
Jeej 30:74aa36420c61 117 ALP_ITF_TYPE_D7A = 0xD7, // Only this one actually in D7A Spec
Jeej 30:74aa36420c61 118 ALP_ITF_TYPE_LWAN = 0x10,
Jeej 30:74aa36420c61 119
Jeej 30:74aa36420c61 120 ALP_ITF_TYPE_NONE = 0xFF
Jeej 19:701d5669f2e9 121 } alp_itf_type_t;
Jeej 19:701d5669f2e9 122
Jeej 19:701d5669f2e9 123 // EXTOpcode Modifiers / Preemption flags
Jeej 30:74aa36420c61 124 #define ALP_EXTOPCODE_DISTANT 0x40 // Used w/ EXTOPCODE_F_DECLARE
Jeej 19:701d5669f2e9 125
Jeej 19:701d5669f2e9 126 typedef enum {
Jeej 19:701d5669f2e9 127 // WIZZILAB OPCODE EXTENSION
Jeej 30:74aa36420c61 128 ALP_EXTOPCODE_ITF_START = 0, //| 'ITF' activation operations:
Jeej 30:74aa36420c61 129 ALP_EXTOPCODE_ITF_STOP = 1, //| TYPE | DEVQ | IFID | FLAGS |
Jeej 30:74aa36420c61 130 ALP_EXTOPCODE_ITF_PAUSE = 2, //| 1B | 1B | 1B | 1B |
Jeej 30:74aa36420c61 131 //| TYPE: ITF Type (D7A,LWAN,BLE...)
Jeej 30:74aa36420c61 132 //| DEVQ: ITF Max Device number if applicable
Jeej 30:74aa36420c61 133 //| IFID: ITF Config file if applicable
Jeej 30:74aa36420c61 134 //| FLAG: Additional configuration flags if applicable
Jeej 30:74aa36420c61 135 ALP_EXTOPCODE_F_DECLARE = 21, //| FH
Jeej 19:701d5669f2e9 136 } alp_ext_opcodes_t;
Jeej 19:701d5669f2e9 137
Jeej 19:701d5669f2e9 138 typedef enum
Jeej 19:701d5669f2e9 139 {
Jeej 19:701d5669f2e9 140 ALP_ERR_ITF_FULL = 2, // 0x02: For interfaces supporting buffering, indicates buffer reached maximum capacity (no data loss)
Jeej 19:701d5669f2e9 141 ALP_ERR_PARTIAL_COMPLETION = 1, // 0x01: Action received and partially completed at response. To be completed after response
Jeej 19:701d5669f2e9 142
Jeej 19:701d5669f2e9 143 ALP_ERR_NONE = 0, // 0x00: Action completed (OK)
Jeej 19:701d5669f2e9 144 ALP_ERR_FILE_NOT_FOUND = -1, // 0xFF: Error access file: File ID does not exist
Jeej 19:701d5669f2e9 145 ALP_ERR_FILE_EXIST = -2, // 0xFE: Error create file: File ID already exists
Jeej 19:701d5669f2e9 146 ALP_ERR_FILE_NOT_RESTORABLE = -3, // 0xFD: Error restore file: File is not restorable
Jeej 19:701d5669f2e9 147 ALP_ERR_PERMISSION_DENIED = -4, // 0xFC: Error access file: Insufficient permissions
Jeej 19:701d5669f2e9 148 ALP_ERR_LENGTH_OVERFLOW = -5, // 0xFB: Error create file: Supplied length (in header) is beyond file limits
Jeej 19:701d5669f2e9 149 ALP_ERR_ALLOC_OVERFLOW = -6, // 0xFA: Error create file: Supplied allocation (in header) is beyond file limits
Jeej 19:701d5669f2e9 150 ALP_ERR_OFFSET_OVERFLOW = -7, // 0xF9: Error write: Supplied start offset is out of bounds of file allocation
Jeej 19:701d5669f2e9 151 ALP_ERR_WRITE_OVERFLOW = -8, // 0xF8: Error complete write: Supplied data goes beyond file allocation
Jeej 19:701d5669f2e9 152 ALP_ERR_WRITE_ERROR = -9, // 0xF7: Error write: impossible to write in storage location
Jeej 19:701d5669f2e9 153 ALP_ERR_OPERATION_UNKNOWN = -10,// 0xF6: Error unknown Operation
Jeej 19:701d5669f2e9 154 ALP_ERR_OPERAND_INCOMPLETE = -11,// 0xF5: Error incomplete Operand
Jeej 19:701d5669f2e9 155 ALP_ERR_OPERAND_WRONG_FORMAT = -12,// 0xF4: Error wrong Operand format
Jeej 19:701d5669f2e9 156 ALP_ERR_ITF_INVALID = -13,// 0xF3: Error invalid interface
Jeej 19:701d5669f2e9 157 ALP_ERR_ITF_OVERFLOW = -14,// 0xF2: Error interface overflown (i.e. resources exhausted, buffer full with data discarded)
Jeej 19:701d5669f2e9 158 ALP_ERR_QUERY_FAIL = -15,// 0xF1: (Group of) Query result was false (Informative error code).
Jeej 19:701d5669f2e9 159
Jeej 19:701d5669f2e9 160 ALP_ERR_UNKNOWN = -128,// 0x80: Unknown error
Jeej 19:701d5669f2e9 161 ALP_ERR_FS_TIMEOUT, // 0x81: Internal FS Error
Jeej 19:701d5669f2e9 162 ALP_ERR_ITF_UNKNOWN, // 0x82: Unknown Interface
Jeej 19:701d5669f2e9 163 ALP_ERR_ITF_TIMEOUT, // 0x83: Internal ITF Error
Jeej 19:701d5669f2e9 164
Jeej 19:701d5669f2e9 165 } alp_errors_t;
Jeej 19:701d5669f2e9 166
Jeej 19:701d5669f2e9 167 typedef enum {
Jeej 30:74aa36420c61 168 ALP_QCOMP_NE = 0,
Jeej 30:74aa36420c61 169 ALP_QCOMP_EQ = 1,
Jeej 30:74aa36420c61 170 ALP_QCOMP_LT = 2,
Jeej 30:74aa36420c61 171 ALP_QCOMP_LTE = 3,
Jeej 30:74aa36420c61 172 ALP_QCOMP_GT = 4,
Jeej 30:74aa36420c61 173 ALP_QCOMP_GTE = 5
Jeej 30:74aa36420c61 174 } alp_q_comp_t;
Jeej 30:74aa36420c61 175 #define ALP_QCOMP(v) (((v) & 7) << 0)
Jeej 30:74aa36420c61 176
Jeej 30:74aa36420c61 177 typedef enum {
Jeej 30:74aa36420c61 178 // This is not matching ALP's spec on purpose...
Jeej 30:74aa36420c61 179 ALP_QLOGIC_AND = 0,
Jeej 30:74aa36420c61 180 ALP_QLOGIC_OR = 1,
Jeej 30:74aa36420c61 181 ALP_QLOGIC_XOR = 2,
Jeej 30:74aa36420c61 182 ALP_QLOGIC_NOR = 3,
Jeej 30:74aa36420c61 183 ALP_QLOGIC_NAND = 4,
Jeej 30:74aa36420c61 184 } alp_q_logic_t;
Jeej 30:74aa36420c61 185
Jeej 30:74aa36420c61 186 typedef enum {
Jeej 30:74aa36420c61 187 ALP_QDATA_SIGNED = 0,
Jeej 30:74aa36420c61 188 ALP_QDATA_UNSIGNED = 1
Jeej 30:74aa36420c61 189 } alp_q_data_t;
Jeej 30:74aa36420c61 190 #define ALP_QDATA(v) (((v) & 1) << 3)
Jeej 30:74aa36420c61 191 #define ALP_QMASK(v) (((v) & 1) << 4)
Jeej 30:74aa36420c61 192
Jeej 30:74aa36420c61 193 typedef enum {
Jeej 30:74aa36420c61 194 ALP_QTYPE_NONVOID = 0, // This is better done by "EXIST"
Jeej 30:74aa36420c61 195 ALP_QTYPE_ACOMP_ZERO = 1,
Jeej 30:74aa36420c61 196 ALP_QTYPE_ACOMP_IMMEDIATE = 2,
Jeej 30:74aa36420c61 197 ALP_QTYPE_ACOMP_FILE = 3,
Jeej 30:74aa36420c61 198 ALP_QTYPE_INRANGE = 4,
Jeej 30:74aa36420c61 199 ALP_QTYPE_STR_TOKEN = 7 //
Jeej 30:74aa36420c61 200 }alp_q_type_t;
Jeej 30:74aa36420c61 201 #define ALP_QTYPE(v) (((v) & 7) << 5)
Jeej 30:74aa36420c61 202
Jeej 30:74aa36420c61 203 typedef enum {
Jeej 19:701d5669f2e9 204 /// Disable all URCs on requesting ITF
Jeej 30:74aa36420c61 205 ALP_URC_TYPE_NONE = 0xFF,
Jeej 19:701d5669f2e9 206 /// Enable Link Quality (on IFID) URCs on requesting ITF
Jeej 30:74aa36420c61 207 ALP_URC_TYPE_LQUAL = 0,
Jeej 19:701d5669f2e9 208 /// Enable Link Down (on IFID) URCs on requesting ITF
Jeej 30:74aa36420c61 209 ALP_URC_TYPE_LDOWN = 1,
Jeej 19:701d5669f2e9 210
Jeej 19:701d5669f2e9 211 ALP_URC_TYPE_QTY,
Jeej 19:701d5669f2e9 212
Jeej 30:74aa36420c61 213 ALP_URC_TYPE_BUSY = 2, // XXX TODO this is awkward: BUSY is not an ITF-URC but a system/modem URC
Jeej 19:701d5669f2e9 214 } alp_urc_type_t;
Jeej 19:701d5669f2e9 215
Jeej 19:701d5669f2e9 216 TYPEDEF_STRUCT_PACKED {
Jeej 19:701d5669f2e9 217 u8 perm;
Jeej 19:701d5669f2e9 218 u8 prop;
Jeej 19:701d5669f2e9 219 u8 afid;
Jeej 19:701d5669f2e9 220 u8 ifid;
Jeej 19:701d5669f2e9 221 u32 size; // XXX Big Endian
Jeej 19:701d5669f2e9 222 u32 alloc;// XXX Big Endian
Jeej 19:701d5669f2e9 223 } alp_file_header_t;
Jeej 19:701d5669f2e9 224 #define ALP_FILE_HEADER_SIZE (sizeof(alp_file_header_t))
Jeej 19:701d5669f2e9 225
Jeej 19:701d5669f2e9 226 // RESPONSES Building helpers
Jeej 19:701d5669f2e9 227 // ======================================================================
Jeej 19:701d5669f2e9 228 #define ALP_RSP_STATUS_SIZE (3) // OPCODE + ACTION_ID + ERR
Jeej 19:701d5669f2e9 229 #define ALP_RSP_F_PROP_SIZE (2+ALP_FILE_HEADER_SIZE) // OPCODE + FID + 12xDATA
Jeej 19:701d5669f2e9 230 #define ALP_LFIELD_SIZE(a) (((a) <= 0x3F) ? 1 : \
Jeej 19:701d5669f2e9 231 (((a) <= 0x3FFF) ? 2 : \
Jeej 19:701d5669f2e9 232 (((a) <= 0x3FFFFF) ? 3 : 4)))
Jeej 19:701d5669f2e9 233
Jeej 19:701d5669f2e9 234 // ACTIONS Building helpers
Jeej 19:701d5669f2e9 235 // ----------------------------------------------------------------------
Jeej 19:701d5669f2e9 236 // Usual arguments:
Jeej 19:701d5669f2e9 237 // _p : pointer to the output string buffer (incremented by the macro)
Jeej 19:701d5669f2e9 238 // _r : ALP response Flag (true/false)
Jeej 19:701d5669f2e9 239 // _fid : File ID
Jeej 19:701d5669f2e9 240 // _o : Access Offset
Jeej 19:701d5669f2e9 241 // _l : Access Length
Jeej 30:74aa36420c61 242 // _m : Mask
Jeej 30:74aa36420c61 243 // _v : Immediate value
Jeej 19:701d5669f2e9 244 // ======================================================================
Jeej 19:701d5669f2e9 245 #define ALP_ACTION_NOP_SIZE (1)
Jeej 19:701d5669f2e9 246 #define ALP_ACTION_NOP(_p,_r) do {\
Jeej 19:701d5669f2e9 247 *(p)++ = (_r)?ALP_OPCODE_NOP+ALP_OPCODE_RESP:ALP_OPCODE_NOP;\
Jeej 19:701d5669f2e9 248 } while(0)
Jeej 19:701d5669f2e9 249
Jeej 19:701d5669f2e9 250 #define ALP_ACTION_TAG_SIZE (2)
Jeej 19:701d5669f2e9 251 #define ALP_ACTION_TAG(p,tag,eop) do {\
Jeej 19:701d5669f2e9 252 *(p)++ = (eop)?ALP_OPCODE_TAG+ALP_OPCODE_EOP:ALP_OPCODE_TAG;\
Jeej 19:701d5669f2e9 253 *(p)++ = (tag);\
Jeej 19:701d5669f2e9 254 } while(0)
Jeej 19:701d5669f2e9 255
Jeej 19:701d5669f2e9 256 #define ALP_ACTION_F_RD_DATA_SIZE(_o,_l) (2+ALP_LFIELD_SIZE(_o)+ALP_LFIELD_SIZE(_l))
Jeej 19:701d5669f2e9 257 #define ALP_ACTION_F_RD_DATA_SIZE_MAX (2+4+4)
Jeej 19:701d5669f2e9 258 #define ALP_ACTION_F_RD_DATA(_p,_r,_fid,_o,_l) do {\
Jeej 19:701d5669f2e9 259 *(_p)++ = (_r)?ALP_OPCODE_F_RD_DATA+ALP_OPCODE_RESP:ALP_OPCODE_F_RD_DATA;\
Jeej 19:701d5669f2e9 260 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 261 (_p) += alp_encode_length(_p,_o);\
Jeej 19:701d5669f2e9 262 (_p) += alp_encode_length(_p,_l);\
Jeej 19:701d5669f2e9 263 } while(0)
Jeej 19:701d5669f2e9 264
Jeej 19:701d5669f2e9 265 #define ALP_ACTION_F_RD_PROP_SIZE (2)
Jeej 19:701d5669f2e9 266 #define ALP_ACTION_F_RD_PROP(_p,_r,_fid) do {\
Jeej 19:701d5669f2e9 267 *(_p)++ = (_r)?ALP_OPCODE_F_RD_PROP+ALP_OPCODE_RESP:ALP_OPCODE_F_RD_PROP;\
Jeej 19:701d5669f2e9 268 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 269 } while(0)
Jeej 19:701d5669f2e9 270
Jeej 19:701d5669f2e9 271 #define ALP_ACTION_F_WR_DATA_SIZE(_o,_l) (2+ALP_LFIELD_SIZE(_o)+ALP_LFIELD_SIZE(_l)+(_l))
Jeej 19:701d5669f2e9 272 #define ALP_ACTION_F_WR_DATA_SIZE_MAX(_l) (2+4+4+(_l))
Jeej 19:701d5669f2e9 273 #define ALP_ACTION_F_WR_DATA(_p,_r,_fid,_o,_l,_data) do {\
Jeej 19:701d5669f2e9 274 *(_p)++ = (_r)?ALP_OPCODE_F_WR_DATA+ALP_OPCODE_RESP:ALP_OPCODE_F_WR_DATA;\
Jeej 19:701d5669f2e9 275 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 276 (_p) += alp_encode_length(_p,_o);\
Jeej 19:701d5669f2e9 277 (_p) += alp_encode_length(_p,_l);\
Jeej 19:701d5669f2e9 278 memcpy((_p),_data,_l);(_p) += (_l);\
Jeej 19:701d5669f2e9 279 } while(0)
Jeej 19:701d5669f2e9 280
Jeej 19:701d5669f2e9 281 #define ALP_ACTION_F_WR_FLUSH_SIZE(_o,_l) (2+ALP_LFIELD_SIZE(_o)+ALP_LFIELD_SIZE(_l)+(_l))
Jeej 19:701d5669f2e9 282 #define ALP_ACTION_F_WR_FLUSH_SIZE_MAX(_l) (2+4+(_l))
Jeej 19:701d5669f2e9 283 #define ALP_ACTION_F_WR_FLUSH(_p,_r,_fid,_o,_l,_data) do {\
Jeej 19:701d5669f2e9 284 *(_p)++ = (_r)?ALP_OPCODE_F_WR_FLUSH+ALP_OPCODE_RESP:ALP_OPCODE_F_WR_FLUSH;\
Jeej 19:701d5669f2e9 285 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 286 (_p) += alp_encode_length(_p,_o);\
Jeej 19:701d5669f2e9 287 (_p) += alp_encode_length(_p,_l);\
Jeej 19:701d5669f2e9 288 memcpy((_p),_data,_l);(_p) += (_l);\
Jeej 19:701d5669f2e9 289 } while(0)
Jeej 19:701d5669f2e9 290
Jeej 19:701d5669f2e9 291 #define ALP_ACTION_F_WR_PROP_SIZE_MAX (2+2+sizeof(alp_file_header_t))
Jeej 19:701d5669f2e9 292 #define ALP_ACTION_F_WR_PROP(_p,_r,_fid,_o,_l,_data) do {\
Jeej 19:701d5669f2e9 293 *(_p)++ = (_r)?ALP_OPCODE_F_WR_PROP+ALP_OPCODE_RESP:ALP_OPCODE_F_WR_PROP;\
Jeej 19:701d5669f2e9 294 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 295 *(_p)++ = (_o);\
Jeej 19:701d5669f2e9 296 *(_p)++ = (_l);\
Jeej 19:701d5669f2e9 297 memcpy((_p),(u8*)(_data),(_l));(_p) += (_l);\
Jeej 19:701d5669f2e9 298 } while(0)
Jeej 19:701d5669f2e9 299
Jeej 19:701d5669f2e9 300 #define ALP_ACTION_F_TOUCH_SIZE(_o,_l) (2+ALP_LFIELD_SIZE(_o)+ALP_LFIELD_SIZE(_l))
Jeej 19:701d5669f2e9 301 #define ALP_ACTION_F_TOUCH_SIZE_MAX (2+4+4)
Jeej 19:701d5669f2e9 302 #define ALP_ACTION_F_TOUCH(_p,_r,_fid,_o,_l) do {\
Jeej 19:701d5669f2e9 303 *(_p)++ = (_r)?ALP_OPCODE_F_TOUCH+ALP_OPCODE_RESP:ALP_OPCODE_F_TOUCH;\
Jeej 19:701d5669f2e9 304 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 305 (_p) += alp_encode_length(_p,_o);\
Jeej 19:701d5669f2e9 306 (_p) += alp_encode_length(_p,_l);\
Jeej 19:701d5669f2e9 307 } while(0)
Jeej 19:701d5669f2e9 308
Jeej 19:701d5669f2e9 309 #define ALP_ACTION_F_EXIST_SIZE (2)
Jeej 19:701d5669f2e9 310 #define ALP_ACTION_F_EXIST(_p,_r,_fid) do {\
Jeej 19:701d5669f2e9 311 *(_p)++ = (_r)?ALP_OPCODE_F_EXIST+ALP_OPCODE_RESP:ALP_OPCODE_F_EXIST;\
Jeej 19:701d5669f2e9 312 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 313 } while(0)
Jeej 19:701d5669f2e9 314
Jeej 19:701d5669f2e9 315 #define ALP_ACTION_F_DELETE_SIZE (2)
Jeej 19:701d5669f2e9 316 #define ALP_ACTION_F_DELETE(_p,_r,_fid) do {\
Jeej 19:701d5669f2e9 317 *(_p)++ = (_r)?ALP_OPCODE_F_DELETE+ALP_OPCODE_RESP:ALP_OPCODE_F_DELETE;\
Jeej 19:701d5669f2e9 318 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 319 } while(0)
Jeej 19:701d5669f2e9 320
Jeej 19:701d5669f2e9 321 #define ALP_ACTION_F_FLUSH_SIZE (2)
Jeej 19:701d5669f2e9 322 #define ALP_ACTION_F_FLUSH(_p,_r,_fid) do {\
Jeej 19:701d5669f2e9 323 *(_p)++ = (_r)?ALP_OPCODE_F_FLUSH+ALP_OPCODE_RESP:ALP_OPCODE_F_FLUSH;\
Jeej 19:701d5669f2e9 324 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 325 } while(0)
Jeej 19:701d5669f2e9 326
Jeej 19:701d5669f2e9 327 #define ALP_ACTION_F_CREATE_SIZE (2+sizeof(alp_file_header_t))
Jeej 19:701d5669f2e9 328 #define ALP_ACTION_F_CREATE(_p,_r,_fid,_hdr) do {\
Jeej 19:701d5669f2e9 329 *(_p)++ = (_r)?ALP_OPCODE_F_CREATE+ALP_OPCODE_RESP:ALP_OPCODE_F_CREATE;\
Jeej 19:701d5669f2e9 330 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 331 memcpy((_p),(u8*)(_hdr),sizeof(alp_file_header_t));(_p) += sizeof(alp_file_header_t);\
Jeej 19:701d5669f2e9 332 } while(0)
Jeej 19:701d5669f2e9 333
Jeej 19:701d5669f2e9 334 #define ALP_PERM_REQ_USER 0
Jeej 19:701d5669f2e9 335 #define ALP_PERM_REQ_ROOT 1
Jeej 19:701d5669f2e9 336 // Wizzilab's specific Authentication-Protocol-Id
Jeej 19:701d5669f2e9 337 #define ALP_WIZZILAB_AUTH_PROTOCOL_ID 42
Jeej 19:701d5669f2e9 338 #define ALP_WIZZILAB_AUTH_PROTOCOL_TOKEN_SIZE 8
Jeej 19:701d5669f2e9 339 #define ALP_ACTION_PERM_REQ_OFFSET (3+ALP_WIZZILAB_AUTH_PROTOCOL_TOKEN_SIZE)
Jeej 19:701d5669f2e9 340 #define ALP_ACTION_PERM_REQ_SIZE(_l) (ALP_ACTION_PERM_REQ_OFFSET+(_l))
Jeej 19:701d5669f2e9 341 #define ALP_ACTION_PERM_REQ(_p,_r,_role) do {\
Jeej 19:701d5669f2e9 342 *(_p)++ = (_r)?ALP_OPCODE_PERM_REQ+ALP_OPCODE_RESP:ALP_OPCODE_PERM_REQ;\
Jeej 19:701d5669f2e9 343 *(_p)++ = (_role);\
Jeej 19:701d5669f2e9 344 *(_p)++ = ALP_WIZZILAB_AUTH_PROTOCOL_ID;\
Jeej 19:701d5669f2e9 345 } while(0)
Jeej 19:701d5669f2e9 346
Jeej 19:701d5669f2e9 347 #define ALP_ACTION_URCC_SIZE(t) ((t==ALP_URC_TYPE_NONE)?2:4)
Jeej 19:701d5669f2e9 348 #define ALP_ACTION_URCC_EN(_p,_r,_type,_ifid,_cfg) do {\
Jeej 19:701d5669f2e9 349 *(_p)++ = (_r)?ALP_OPCODE_URCC+ALP_OPCODE_GROUP+ALP_OPCODE_RESP:ALP_OPCODE_URCC+ALP_OPCODE_GROUP;\
Jeej 19:701d5669f2e9 350 *(_p)++ = (_type);\
Jeej 19:701d5669f2e9 351 if((_type)!=ALP_URC_TYPE_NONE && (_type)!=ALP_URC_TYPE_BUSY)\
Jeej 19:701d5669f2e9 352 {\
Jeej 19:701d5669f2e9 353 *(_p)++ = (_ifid);\
Jeej 19:701d5669f2e9 354 *(_p)++ = (_cfg);\
Jeej 19:701d5669f2e9 355 }\
Jeej 19:701d5669f2e9 356 } while(0)
Jeej 19:701d5669f2e9 357
Jeej 19:701d5669f2e9 358 #define ALP_ACTION_URCC_DIS(_p,_r,_type,_ifid,_cfg) do {\
Jeej 19:701d5669f2e9 359 *(_p)++ = (_r)?ALP_OPCODE_URCC+ALP_OPCODE_RESP:ALP_OPCODE_URCC;\
Jeej 19:701d5669f2e9 360 *(_p)++ = (_type);\
Jeej 19:701d5669f2e9 361 if((_type)!=ALP_URC_TYPE_NONE && (_type)!=ALP_URC_TYPE_BUSY)\
Jeej 19:701d5669f2e9 362 {\
Jeej 19:701d5669f2e9 363 *(_p)++ = (_ifid);\
Jeej 19:701d5669f2e9 364 *(_p)++ = (_cfg);\
Jeej 19:701d5669f2e9 365 }\
Jeej 19:701d5669f2e9 366 } while(0)
Jeej 19:701d5669f2e9 367
Jeej 19:701d5669f2e9 368 #define ALP_ACTION_FORWARD_SIZE(s) (1+(s))
Jeej 19:701d5669f2e9 369 #define ALP_ACTION_FORWARD(p,itf,itfs) do {\
Jeej 19:701d5669f2e9 370 *(p)++ = ALP_OPCODE_FORWARD;\
Jeej 19:701d5669f2e9 371 memcpy((p),(itf),(itfs));(p) += (itfs);\
Jeej 19:701d5669f2e9 372 } while(0)
Jeej 19:701d5669f2e9 373
Jeej 19:701d5669f2e9 374 #define ALP_ACTION_RSP_F_DATA_SIZE(_o,_l) (2+ALP_LFIELD_SIZE(_o)+ALP_LFIELD_SIZE(_l)+(_l))
Jeej 19:701d5669f2e9 375 #define ALP_ACTION_RSP_F_DATA_SIZE_MAX(_l) (2+4+4+(_l))
Jeej 19:701d5669f2e9 376 #define ALP_ACTION_RSP_F_DATA(_p,_fid,_o,_l,_data) do {\
Jeej 19:701d5669f2e9 377 *(_p)++ = ALP_OPCODE_RSP_F_DATA;\
Jeej 19:701d5669f2e9 378 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 379 (_p) += alp_encode_length(_p,_o);\
Jeej 19:701d5669f2e9 380 (_p) += alp_encode_length(_p,_l);\
Jeej 19:701d5669f2e9 381 memcpy((_p),(u8*)(_data),(_l));(_p) += (_l);\
Jeej 19:701d5669f2e9 382 } while(0)
Jeej 19:701d5669f2e9 383
Jeej 19:701d5669f2e9 384 #define ALP_ACTION_RSP_F_PROP_SIZE (2+ALP_FILE_HEADER_SIZE)
Jeej 19:701d5669f2e9 385 #define ALP_ACTION_RSP_F_PROP(_p,_fid,_hdr) do {\
Jeej 19:701d5669f2e9 386 *(_p)++ = ALP_OPCODE_RSP_F_PROP;\
Jeej 19:701d5669f2e9 387 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 388 memcpy((_p),(u8*)(_hdr),ALP_FILE_HEADER_SIZE);(_p) += ALP_FILE_HEADER_SIZE;\
Jeej 19:701d5669f2e9 389 } while(0)
Jeej 19:701d5669f2e9 390
Jeej 19:701d5669f2e9 391 #define ALP_ACTION_RSP_STATUS_SIZE (2)
Jeej 19:701d5669f2e9 392 #define ALP_ACTION_RSP_STATUS(_p,_a,_s) do {\
Jeej 19:701d5669f2e9 393 *(_p)++ = ALP_OPCODE_RSP_STATUS;\
Jeej 19:701d5669f2e9 394 *(_p)++ = (_a);\
Jeej 19:701d5669f2e9 395 *(_p)++ = (_s);\
Jeej 19:701d5669f2e9 396 } while(0)
Jeej 19:701d5669f2e9 397
Jeej 19:701d5669f2e9 398 #define ALP_ACTION_RSP_TAG_SIZE (2)
Jeej 19:701d5669f2e9 399 #define ALP_ACTION_RSP_TAG(_p,_val,_eop,_err) do {\
Jeej 19:701d5669f2e9 400 u8 tmp = ALP_OPCODE_RSP_TAG;\
Jeej 19:701d5669f2e9 401 tmp += (_eop)?ALP_OPCODE_EOP:0;\
Jeej 19:701d5669f2e9 402 tmp += (_err)?ALP_OPCODE_ERR:0;\
Jeej 19:701d5669f2e9 403 *(_p)++ = tmp;\
Jeej 19:701d5669f2e9 404 *(_p)++ = (_val);\
Jeej 19:701d5669f2e9 405 } while(0)
Jeej 19:701d5669f2e9 406
Jeej 19:701d5669f2e9 407 #define ALP_ACTION_EXT_SIZE(_argc) (3+(_argc))
Jeej 19:701d5669f2e9 408 #define ALP_ACTION_EXT(_p,_r,_op,_argc) do {\
Jeej 19:701d5669f2e9 409 *(_p)++ = (_r)?ALP_OPCODE_EXT+ALP_OPCODE_RESP:ALP_OPCODE_EXT;\
Jeej 19:701d5669f2e9 410 *(_p)++ = (_op);\
Jeej 19:701d5669f2e9 411 *(_p)++ = (_argc);\
Jeej 19:701d5669f2e9 412 } while(0)
Jeej 19:701d5669f2e9 413
Jeej 19:701d5669f2e9 414 // WIZZILAB Specific Extensions
Jeej 19:701d5669f2e9 415 #define _ALP_ACTION_ACTIVATE_ITF_SIZE (4)
Jeej 19:701d5669f2e9 416 #define ALP_ACTION_ACTIVATE_ITF_SIZE (ALP_ACTION_EXT_SIZE(_ALP_ACTION_ACTIVATE_ITF_SIZE))
Jeej 19:701d5669f2e9 417 #define ALP_ACTION_ACTIVATE_ITF(_p,_r,_en,_type,_dev,_ifid,_flag) do {\
Jeej 19:701d5669f2e9 418 ALP_ACTION_EXT(_p,_r,(_en)?ALP_EXTOPCODE_ITF_START:ALP_EXTOPCODE_ITF_STOP,_ALP_ACTION_ACTIVATE_ITF_SIZE);\
Jeej 19:701d5669f2e9 419 *(p)++ = _type;\
Jeej 19:701d5669f2e9 420 *(p)++ = _dev;\
Jeej 19:701d5669f2e9 421 *(p)++ = _ifid;\
Jeej 19:701d5669f2e9 422 *(p)++ = _flag;\
Jeej 19:701d5669f2e9 423 } while(0)
Jeej 19:701d5669f2e9 424
Jeej 19:701d5669f2e9 425 #define _ALP_ACTION_F_DECLARE_SIZE (1+sizeof(alp_file_header_t))
Jeej 19:701d5669f2e9 426 #define ALP_ACTION_F_DECLARE_SIZE (ALP_ACTION_EXT_SIZE(_ALP_ACTION_F_DECLARE_SIZE))
Jeej 19:701d5669f2e9 427 #define ALP_ACTION_F_DECLARE(_p,_r,_fid,_hdr,_dist) do {\
Jeej 19:701d5669f2e9 428 ALP_ACTION_EXT(_p,_r,(_dist)?ALP_EXTOPCODE_F_DECLARE+ALP_EXTOPCODE_DISTANT:ALP_EXTOPCODE_F_DECLARE,_ALP_ACTION_F_DECLARE_SIZE);\
Jeej 19:701d5669f2e9 429 *(_p)++ = (_fid);\
Jeej 19:701d5669f2e9 430 memcpy((_p),(u8*)(_hdr),sizeof(alp_file_header_t));(_p) += sizeof(alp_file_header_t);\
Jeej 19:701d5669f2e9 431 } while(0)
Jeej 19:701d5669f2e9 432
Jeej 19:701d5669f2e9 433
Jeej 19:701d5669f2e9 434 // Simple "report/notify" actions. For both, FID,Offset and size will be
Jeej 19:701d5669f2e9 435 // substituted thanks to specific Offset-Operand token
Jeej 19:701d5669f2e9 436 #define ALP_ACTION_REPORT_FULL_FILE { \
Jeej 19:701d5669f2e9 437 ALP_OPCODE_F_RD_DATA | ALP_OPCODE_RESP,\
Jeej 19:701d5669f2e9 438 0, HAL_U16_BE_DEPOSIT(0x4000), 0 }
Jeej 19:701d5669f2e9 439
Jeej 19:701d5669f2e9 440 #define ALP_ACTION_REPORT_PART_FILE { \
Jeej 19:701d5669f2e9 441 ALP_OPCODE_F_RD_DATA | ALP_OPCODE_RESP,\
Jeej 19:701d5669f2e9 442 0, HAL_U16_BE_DEPOSIT(0x8000), 0 }
Jeej 19:701d5669f2e9 443
Jeej 30:74aa36420c61 444 // Simple Query actions
Jeej 30:74aa36420c61 445 /// Match immediate value to file value
Jeej 30:74aa36420c61 446 #define ALP_ACTION_QUERY_EQVAL_SIZE(_o,_l,_mbit) (4+ALP_LFIELD_SIZE(_o)+(1+(_mbit))*(_l))
Jeej 30:74aa36420c61 447 #define ALP_ACTION_QUERY_EQVAL(_p,_m,_v,_fid,_o,_l) do {\
Jeej 30:74aa36420c61 448 u8 _mbit = (_m) ? 1 : 0;\
Jeej 30:74aa36420c61 449 *(_p)++ = ALP_OPCODE_QUERY;\
Jeej 30:74aa36420c61 450 *(_p)++ = ALP_QCOMP(ALP_QCOMP_EQ) | ALP_QDATA(ALP_QDATA_UNSIGNED) | ALP_QMASK(_mbit) | ALP_QTYPE(ALP_QTYPE_ACOMP_IMMEDIATE);\
Jeej 30:74aa36420c61 451 *(_p)++ = _l;\
Jeej 30:74aa36420c61 452 if (_mbit) {memcpy((_p),&(_m),_l);(_p) += (_l);}\
Jeej 30:74aa36420c61 453 memcpy((_p),&(_v),_l);(_p) += (_l);\
Jeej 30:74aa36420c61 454 *(_p)++ = _fid;\
Jeej 30:74aa36420c61 455 (_p) += alp_encode_length(_p,_o);\
Jeej 30:74aa36420c61 456 } while(0)
Jeej 30:74aa36420c61 457
Jeej 30:74aa36420c61 458 // Query with break actions
Jeej 30:74aa36420c61 459 /// Match immediate value to file value
Jeej 30:74aa36420c61 460 #define ALP_ACTION_QBREAK_EQVAL_SIZE(_o,_l,_mbit) (4+ALP_LFIELD_SIZE(_o)+(1+(_mbit))*(_l))
Jeej 30:74aa36420c61 461 #define ALP_ACTION_QBREAK_EQVAL(_p,_m,_v,_fid,_o,_l) do {\
Jeej 30:74aa36420c61 462 u8 _mbit = (_m) ? 1 : 0;\
Jeej 30:74aa36420c61 463 *(_p)++ = ALP_OPCODE_QBREAK;\
Jeej 30:74aa36420c61 464 *(_p)++ = ALP_QCOMP(ALP_QCOMP_EQ) | ALP_QDATA(ALP_QDATA_UNSIGNED) | ALP_QMASK(_mbit) | ALP_QTYPE(ALP_QTYPE_ACOMP_IMMEDIATE);\
Jeej 30:74aa36420c61 465 *(_p)++ = _l;\
Jeej 30:74aa36420c61 466 if (_mbit) {memcpy((_p),&(_m),_l);(_p) += (_l);}\
Jeej 30:74aa36420c61 467 memcpy((_p),&(_v),_l);(_p) += (_l);\
Jeej 30:74aa36420c61 468 *(_p)++ = _fid;\
Jeej 30:74aa36420c61 469 (_p) += alp_encode_length(_p,_o);\
Jeej 30:74aa36420c61 470 } while(0)
Jeej 30:74aa36420c61 471
Jeej 26:2c934a269914 472 #endif // __ALP_SPEC_H__
Jeej 26:2c934a269914 473