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@30:d775c1409849, 2016-05-25 (annotated)

Committer:
Jeej
Date:
Wed May 25 08:23:15 2016 +0000
Revision:
30:d775c1409849
Parent:
29:8e7c5c1e9aab
Child:
33:f9a542d3efaa
Compatibility with version 3.1.476

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