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_fs.h@29:8e7c5c1e9aab, 2016-05-03 (annotated)

Committer:
Jeej
Date:
Tue May 03 16:53:52 2016 +0000
Revision:
29:8e7c5c1e9aab
Parent:
27:934ab7455115
Child:
30:d775c1409849
Appli can now receive distant read and write commands.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jeej 25:aac250164497 1 #ifndef _D7A_FS_H_
Jeej 25:aac250164497 2 #define _D7A_FS_H_
Jeej 25:aac250164497 3
Jeej 25:aac250164497 4 #include "mbed.h"
Jeej 25:aac250164497 5 #include "rtos.h"
Jeej 25:aac250164497 6 #include "d7a_common.h"
Jeej 25:aac250164497 7 #include "d7a_com.h"
Jeej 25:aac250164497 8
Jeej 29:8e7c5c1e9aab 9 #define TO_FS (2000)
Jeej 26:9f0b9833cac6 10
Jeej 25:aac250164497 11 typedef uint32_t (*WriteFileFunction)( const uint8_t file_id,
Jeej 25:aac250164497 12 const uint16_t offset,
Jeej 25:aac250164497 13 const uint16_t file_size,
Jeej 25:aac250164497 14 const uint8_t * const content);
Jeej 25:aac250164497 15
Jeej 25:aac250164497 16 typedef uint32_t (*ReadFileFunction)( const uint8_t file_id,
Jeej 25:aac250164497 17 const uint16_t offset,
Jeej 25:aac250164497 18 const uint16_t file_size,
Jeej 25:aac250164497 19 uint8_t* buf);
Jeej 25:aac250164497 20
Jeej 29:8e7c5c1e9aab 21 typedef uint32_t (*TouchFileFunction)( const uint8_t file_id,
Jeej 29:8e7c5c1e9aab 22 const uint16_t offset,
Jeej 29:8e7c5c1e9aab 23 const uint16_t file_size);
Jeej 29:8e7c5c1e9aab 24
Jeej 26:9f0b9833cac6 25 // PROP Byte
Jeej 26:9f0b9833cac6 26 #define FS_BFO_STORAGE_CLASS 0
Jeej 26:9f0b9833cac6 27 #define FS_BFO_ACT_COND 4
Jeej 26:9f0b9833cac6 28 #define FS_BFO_ACT_EN 7
Jeej 26:9f0b9833cac6 29 #define FS_BFS_STORAGE_CLASS 2
Jeej 26:9f0b9833cac6 30 #define FS_BFS_ACT_COND 3
Jeej 26:9f0b9833cac6 31 #define FS_BFS_ACT_EN 1
Jeej 26:9f0b9833cac6 32
Jeej 26:9f0b9833cac6 33 //======================================================================
Jeej 26:9f0b9833cac6 34 // Attributes and macros
Jeej 26:9f0b9833cac6 35 //======================================================================
Jeej 26:9f0b9833cac6 36 // "Piped" File: rd/wr are not stored but just sent on IF
Jeej 26:9f0b9833cac6 37 #define FS_TRANSIENT (TRANSIENT << FS_BFO_STORAGE_CLASS)
Jeej 26:9f0b9833cac6 38 // "RAM" File: rd/wr to a volatile buffer.
Jeej 26:9f0b9833cac6 39 #define FS_VOLATILE (VOLATILE << FS_BFO_STORAGE_CLASS)
Jeej 26:9f0b9833cac6 40 // "Mirrored" File: loaded from NVM, cached/used in RAM. Flushable to NVM.
Jeej 26:9f0b9833cac6 41 #define FS_RESTORABLE (RESTORABLE << FS_BFO_STORAGE_CLASS)
Jeej 26:9f0b9833cac6 42 // "Normal" File: rd/wr from/to NVM
Jeej 26:9f0b9833cac6 43 #define FS_PERMANENT (PERMANENT << FS_BFO_STORAGE_CLASS)
Jeej 26:9f0b9833cac6 44 #define FS_ACT_COND(c) ((c & 0x7) << FS_BFO_ACT_COND)
Jeej 26:9f0b9833cac6 45 #define FS_ACT_EN (1 << FS_BFO_ACT_EN)
Jeej 26:9f0b9833cac6 46
Jeej 26:9f0b9833cac6 47 #define FS_RUNNABLE (1 << FS_BFO_RUNNABLE)
Jeej 26:9f0b9833cac6 48 #define FS_ENCRYPTED (1 << FS_BFO_ENCRYPTED)
Jeej 26:9f0b9833cac6 49
Jeej 26:9f0b9833cac6 50 // XXX Old ALP Hack
Jeej 26:9f0b9833cac6 51 #define NACK FS_RUNNABLE
Jeej 26:9f0b9833cac6 52 #define NOTIF FS_ENCRYPTED
Jeej 26:9f0b9833cac6 53
Jeej 26:9f0b9833cac6 54 // D7AactP Enabled File properties
Jeej 26:9f0b9833cac6 55 #if 0 // Condition is not used (nor usable)
Jeej 26:9f0b9833cac6 56 #define FS_TRANSIENT_NOTIF(c) (FS_TRANSIENT | FS_ACT_EN | FS_ACT_COND(c))
Jeej 26:9f0b9833cac6 57 #define FS_VOLATILE_NOTIF(c) (FS_VOLATILE | FS_ACT_EN | FS_ACT_COND(c))
Jeej 26:9f0b9833cac6 58 #define FS_RESTORABLE_NOTIF(c)(FS_RESTORABLE | FS_ACT_EN | FS_ACT_COND(c))
Jeej 26:9f0b9833cac6 59 #define FS_PERMANENT_NOTIF(c) (FS_PERMANENT | FS_ACT_EN | FS_ACT_COND(c))
Jeej 26:9f0b9833cac6 60 #else
Jeej 26:9f0b9833cac6 61 #define FS_TRANSIENT_NOTIF (FS_TRANSIENT | FS_ACT_EN)
Jeej 26:9f0b9833cac6 62 #define FS_VOLATILE_NOTIF (FS_VOLATILE | FS_ACT_EN)
Jeej 26:9f0b9833cac6 63 #define FS_RESTORABLE_NOTIF (FS_RESTORABLE | FS_ACT_EN)
Jeej 26:9f0b9833cac6 64 #define FS_PERMANENT_NOTIF (FS_PERMANENT | FS_ACT_EN)
Jeej 26:9f0b9833cac6 65 #endif
Jeej 26:9f0b9833cac6 66
Jeej 26:9f0b9833cac6 67 #define RWX_RWX 0b00111111
Jeej 26:9f0b9833cac6 68 #define RW_ALL 0b00110110
Jeej 26:9f0b9833cac6 69 #define RW_RW 0b00110110
Jeej 26:9f0b9833cac6 70 #define RW_STANDARD 0b00110100
Jeej 26:9f0b9833cac6 71 #define RW_R 0b00110100
Jeej 26:9f0b9833cac6 72 #define R_R 0b00100100
Jeej 26:9f0b9833cac6 73
Jeej 26:9f0b9833cac6 74
Jeej 25:aac250164497 75 // COM-FS Operation-codes. Mimics ALP ones.
Jeej 25:aac250164497 76 #define FS_OP_NULL 0
Jeej 25:aac250164497 77 #define FS_OP_RD 1
Jeej 25:aac250164497 78 #define FS_OP_WR 4
Jeej 29:8e7c5c1e9aab 79 #define FS_OP_TOUCH 7 // Not in ALP but '7' is still in 'write' actions area
Jeej 25:aac250164497 80 #define FS_OP_STAT 16
Jeej 29:8e7c5c1e9aab 81 #define FS_OP_DSTAT 30 // Not in ALP: Variant of STAT for distant files
Jeej 25:aac250164497 82 #define FS_OP_CREATE 17
Jeej 25:aac250164497 83 #define FS_OP_FLUSH 20
Jeej 25:aac250164497 84 #define FS_OP_RETSTAT 32
Jeej 25:aac250164497 85 #define FS_OP_RETDATA 34
Jeej 25:aac250164497 86
Jeej 29:8e7c5c1e9aab 87
Jeej 25:aac250164497 88 // FS/COM-FS Status-codes. Mimics ALP ones.
Jeej 25:aac250164497 89 enum {
Jeej 25:aac250164497 90 FS_STAT_PENDING = 1,
Jeej 25:aac250164497 91 FS_STAT_OK = 0,
Jeej 25:aac250164497 92 FS_STAT_ERR_FID_NOEXIST = -1, // FF
Jeej 25:aac250164497 93 FS_STAT_ERR_FID_ALREADYEXIST = -2, // FE
Jeej 25:aac250164497 94 FS_STAT_ERR_NOTRESTORABLE = -3, // FD
Jeej 25:aac250164497 95 FS_STAT_ERR_PERMISSION = -4, // FC
Jeej 25:aac250164497 96 FS_STAT_ERR_LENGTH_OVFL = -5, // FB
Jeej 25:aac250164497 97 FS_STAT_ERR_ALLOC_OVFL = -6, // FA
Jeej 25:aac250164497 98 FS_STAT_ERR_START_OFFSET_OVFL = -7, // F9
Jeej 25:aac250164497 99 FS_STAT_ERR_WRITE_OVFL = -8, // F8
Jeej 25:aac250164497 100 FS_STAT_ERR_WRITE_PROTECTED = -9, // F7
Jeej 25:aac250164497 101 FS_STAT_ERR_UNKNOWN_OPERATION = -10, // F6
Jeej 25:aac250164497 102 FS_STAT_ERR_INCOMPLETE_OPERAND = -11, // F5
Jeej 25:aac250164497 103 FS_STAT_ERR_WRONG_OPERAND = -12, // F4
Jeej 25:aac250164497 104 FS_STAT_ERR_UNKNOWN = -127, // 80
Jeej 25:aac250164497 105 };
Jeej 25:aac250164497 106
Jeej 25:aac250164497 107
Jeej 25:aac250164497 108 // Memory "TYPE"
Jeej 25:aac250164497 109 #define FS_TYPE_DISTANT 0x80
Jeej 25:aac250164497 110 enum { NOFILE = 0,
Jeej 25:aac250164497 111 PFLASH,
Jeej 25:aac250164497 112 EEPROM,
Jeej 25:aac250164497 113 RAM,
Jeej 25:aac250164497 114
Jeej 25:aac250164497 115 HOST = 0x80 + 0x10, // Distant HST_COM Files
Jeej 25:aac250164497 116
Jeej 25:aac250164497 117 ERASED = 0xff
Jeej 25:aac250164497 118 };
Jeej 25:aac250164497 119 // File "Storage Class"
Jeej 25:aac250164497 120 enum { TRANSIENT=0, VOLATILE, RESTORABLE, PERMANENT};
Jeej 25:aac250164497 121 // D7AactP "trigger" TODO: is it really applicable ?
Jeej 25:aac250164497 122 enum { LIST=0, READ, WRITE, WRITE_FLUSH};
Jeej 25:aac250164497 123
Jeej 25:aac250164497 124 // =======================================================================
Jeej 25:aac250164497 125 // d7a_fs_header_t
Jeej 25:aac250164497 126 // -----------------------------------------------------------------------
Jeej 25:aac250164497 127 /// Header Structure
Jeej 25:aac250164497 128 // =======================================================================
Jeej 25:aac250164497 129 TYPEDEF_STRUCT_PACKED{
Jeej 25:aac250164497 130 uint32_t addr : 32;
Jeej 25:aac250164497 131
Jeej 25:aac250164497 132 uint32_t type : 8;
Jeej 25:aac250164497 133
Jeej 25:aac250164497 134 // RAM Mirroring
Jeej 25:aac250164497 135 uint32_t mirror_idx : 7;
Jeej 25:aac250164497 136 uint32_t mirrored : 1;
Jeej 25:aac250164497 137
Jeej 25:aac250164497 138 uint32_t fid : 8;
Jeej 25:aac250164497 139
Jeej 25:aac250164497 140 uint32_t afid : 8;
Jeej 25:aac250164497 141
Jeej 25:aac250164497 142 /// Storage Class
Jeej 25:aac250164497 143 uint32_t storage_class : 2;
Jeej 25:aac250164497 144 /// RFU
Jeej 25:aac250164497 145 uint32_t rfu_2 : 1;
Jeej 25:aac250164497 146 uint32_t rfu_3 : 1;
Jeej 25:aac250164497 147 /// D7AactP condition
Jeej 25:aac250164497 148 uint32_t act_cond : 3;
Jeej 25:aac250164497 149 /// D7AactP is enabled
Jeej 25:aac250164497 150 uint32_t act_en : 1;
Jeej 25:aac250164497 151
Jeej 25:aac250164497 152 /// Guest permissions
Jeej 25:aac250164497 153 uint32_t guest_x : 1;
Jeej 25:aac250164497 154 uint32_t guest_w : 1;
Jeej 25:aac250164497 155 uint32_t guest_r : 1;
Jeej 25:aac250164497 156 /// User permissions
Jeej 25:aac250164497 157 uint32_t user_x : 1;
Jeej 25:aac250164497 158 uint32_t user_w : 1;
Jeej 25:aac250164497 159 uint32_t user_r : 1;
Jeej 25:aac250164497 160 /// File is executable
Jeej 25:aac250164497 161 uint32_t runable : 1;
Jeej 25:aac250164497 162 /// File is encrypted
Jeej 25:aac250164497 163 uint32_t encrypted : 1;
Jeej 25:aac250164497 164
Jeej 25:aac250164497 165
Jeej 25:aac250164497 166 uint32_t length : 24;
Jeej 25:aac250164497 167 uint32_t alloc : 24;
Jeej 25:aac250164497 168
Jeej 25:aac250164497 169 uint32_t ifid : 8;
Jeej 25:aac250164497 170 } d7a_fs_header_bf_t;
Jeej 25:aac250164497 171
Jeej 25:aac250164497 172 TYPEDEF_STRUCT_PACKED{
Jeej 25:aac250164497 173 uint32_t addr;
Jeej 25:aac250164497 174 uint8_t type;
Jeej 25:aac250164497 175 uint8_t mirror;
Jeej 25:aac250164497 176 uint8_t fid;
Jeej 25:aac250164497 177
Jeej 25:aac250164497 178 uint8_t afid;
Jeej 25:aac250164497 179 uint8_t prop;
Jeej 25:aac250164497 180 uint8_t perm;
Jeej 25:aac250164497 181
Jeej 25:aac250164497 182 uint8_t length[3];
Jeej 25:aac250164497 183 uint8_t alloc[3];
Jeej 25:aac250164497 184 uint8_t ifid;
Jeej 25:aac250164497 185 } d7a_fs_header_byte_t;
Jeej 25:aac250164497 186
Jeej 25:aac250164497 187 typedef union
Jeej 25:aac250164497 188 {
Jeej 25:aac250164497 189 d7a_fs_header_bf_t bf;
Jeej 25:aac250164497 190 d7a_fs_header_byte_t byte;
Jeej 25:aac250164497 191
Jeej 25:aac250164497 192 } d7a_fs_header_t;
Jeej 25:aac250164497 193
Jeej 25:aac250164497 194
Jeej 25:aac250164497 195 typedef enum {
Jeej 25:aac250164497 196 KAL_FS_PROP_SIZE,
Jeej 25:aac250164497 197 KAL_FS_PROP_ALLOC,
Jeej 25:aac250164497 198 KAL_FS_PROP_TYPE,
Jeej 25:aac250164497 199 KAL_FS_PROP_ADDR,
Jeej 25:aac250164497 200 KAL_FS_PROP_AFID,
Jeej 25:aac250164497 201 KAL_FS_PROP_IFID,
Jeej 25:aac250164497 202 KAL_FS_PROP_PROP,
Jeej 25:aac250164497 203 KAL_FS_PROP_PERM,
Jeej 25:aac250164497 204
Jeej 25:aac250164497 205 KAL_FS_PROP_ALL,
Jeej 25:aac250164497 206 } d7a_fs_property_t;
Jeej 25:aac250164497 207
Jeej 25:aac250164497 208 typedef struct{
Jeej 25:aac250164497 209 uint32_t addr;
Jeej 25:aac250164497 210 uint8_t type;
Jeej 25:aac250164497 211 uint8_t afid;
Jeej 25:aac250164497 212 uint8_t ifid;
Jeej 25:aac250164497 213 uint8_t prop;
Jeej 25:aac250164497 214 uint8_t perm;
Jeej 25:aac250164497 215 uint32_t length;
Jeej 25:aac250164497 216 uint32_t alloc;
Jeej 25:aac250164497 217 } d7a_fs_properties_t;
Jeej 25:aac250164497 218
Jeej 29:8e7c5c1e9aab 219 void d7a_fs_open(WriteFileFunction write_file, ReadFileFunction read_file, TouchFileFunction touch_file);
Jeej 26:9f0b9833cac6 220 void* d7a_fs_wait_done(uint32_t millisec = osWaitForever);
Jeej 25:aac250164497 221 void d7a_fs_new_pkt(d7a_com_rx_msg_t* pkt);
Jeej 25:aac250164497 222 d7a_com_rx_msg_t* d7a_fs_wait_pkt( uint32_t millisec = osWaitForever );
Jeej 25:aac250164497 223 uint32_t d7a_fs_get_properties(uint8_t fid, d7a_fs_property_t prop, d7a_fs_properties_t* props);
Jeej 26:9f0b9833cac6 224 void d7a_fs_distant_stat(uint8_t fid, int* length);
Jeej 25:aac250164497 225 int d7a_fs_distant_create(uint8_t fid, d7a_fs_properties_t* props);
Jeej 27:934ab7455115 226 int d7a_fs_read(uint8_t fid, void *data, uint32_t offset, uint32_t length);
Jeej 25:aac250164497 227
Jeej 25:aac250164497 228
Jeej 25:aac250164497 229 #endif