file_format.h

Go to the documentation of this file.

 
#ifndef INC_FILE_FORMAT_H_
#define INC_FILE_FORMAT_H_
 
#include "memory_driver.h"
 
#ifndef FS_SIZE_VARIANT
    #error MEMORY VARIANT NOT DEFINED!
#endif
 
#if FS_SIZE_VARIANT == FS_VARIANT_U
    #define MAXIMUM_FS_FILES                1
    #define MAXIMUM_FS_SENSORS_PER_FILE     4
#elif FS_SIZE_VARIANT == FS_VARIANT_X
    #define MAXIMUM_FS_FILES                2
    #define MAXIMUM_FS_SENSORS_PER_FILE     8
#elif FS_SIZE_VARIANT == FS_VARIANT_S
    #define MAXIMUM_FS_FILES                8
    #define MAXIMUM_FS_SENSORS_PER_FILE     16
#elif FS_SIZE_VARIANT == FS_VARIANT_L
 
    #define MAXIMUM_FS_FILES                22
 
    #define MAXIMUM_FS_SENSORS_PER_FILE     42
#endif
 
#define FILENAME_LENGTH                 16
 
 
#define FILE_META_SENSOR_LENGTH         12
 
#define FILE_HEADER_RECORD_LENGTH       32
 
#define FILE_HEADER_ADDRESS             FILE_HEADER_RECORD_LENGTH
 
#define FILE_HEADER_SIZE                (MAXIMUM_FS_FILES * FILE_HEADER_RECORD_LENGTH)
 
 
#define FILE_META_RECORD_LENGTH     (FILE_META_SENSOR_LENGTH * MAXIMUM_FS_SENSORS_PER_FILE)
 
#define FILE_META_SIZE              (MAXIMUM_FS_FILES * FILE_META_RECORD_LENGTH)
 
#define FILE_META_ADDRESS           (FILE_HEADER_ADDRESS + FILE_HEADER_SIZE)
 
#define FILE_DATA_ADDRESS           (FILE_HEADER_ADDRESS + FILE_HEADER_SIZE + MAXIMUM_FS_FILES*FILE_META_RECORD_LENGTH)
 
 
#define MAX_SENORS_PER_FLASH_PAGE       (MEMORY_PAGE_SIZE / FILE_META_SENSOR_LENGTH)
 
#define DUMMY_VALUE     0xFF
 
#define NUM_DRIVERS     14
 
typedef enum sensor_type {
    SENSOR_TYPE_NONE = 0x00,
    SENSOR_TYPE_INTEGER = 0x01,
    SENSOR_TYPE_CHAR = 0x02,
    SENSOR_TYPE_FLOAT = 0x03,
    SENSOR_TYPE_TIME = 0x04,
    SENSOR_TYPE_TEMPERATURE = 0x05,
    SENSOR_TYPE_HUMIDITY = 0x06,
    SENSOR_TYPE_PRESSURE = 0x07,
    SENSOR_TYPE_LIGHT_VISIBLE = 0x08,
    SENSOR_TYPE_LIGHT_IR = 0x09,
    SENSOR_TYPE_LIGHT_UV = 0x0A,
    SENSOR_TYPE_ADC = 0x0B,
    SENSOR_TYPE_ACC = 0x0C,
    SENSOR_TYPE_GYR = 0x0D,
} SensorType_t;
 
typedef enum value_format {
    FORMAT_META_LENGTH_1B = 0x1,
    FORMAT_META_LENGTH_2B = 0x2,
    FORMAT_META_LENGTH_3B = 0x3,
    FORMAT_META_LENGTH_4B = 0x4,
    FORMAT_META_LENGTH_5B = 0x5,
    FORMAT_META_LENGTH_6B = 0x6,
    FORMAT_META_LENGTH_7B = 0x7,
    FORMAT_META_LENGTH_8B = 0x8,
    FORMAT_META_LENGTH_9B = 0x9,
    FORMAT_META_LENGTH_10B = 0xA,
    FORMAT_META_LENGTH_11B = 0xB,
    FORMAT_META_LENGTH_12B = 0xC,
    FORMAT_META_LENGTH_13B = 0xD,
    FORMAT_META_LENGTH_14B = 0xE,
    FORMAT_META_LENGTH_15B = 0xF,
    FORMAT_META_LENGTH_16B = 0x10,
    FORMAT_META_LENGTH_24B = 0x11,
    FORMAT_META_LENGTH_32B = 0x12,
    FORMAT_META_LENGTH_40B = 0x13,
    FORMAT_META_LENGTH_48B = 0x14,
    FORMAT_META_LENGTH_56B = 0x15,
    FORMAT_META_LENGTH_64B = 0x16,
    FORMAT_META_LENGTH_72B = 0x17,
    FORMAT_META_LENGTH_80B = 0x18,
    FORMAT_META_LENGTH_88B = 0x19,
    FORMAT_META_LENGTH_96B = 0x1A,
    FORMAT_META_LENGTH_104B = 0x1B,
    FORMAT_META_LENGTH_112B = 0x1C,
    FORMAT_META_LENGTH_120B = 0x1D,
    FORMAT_META_LENGTH_128B = 0x1E,
 
    FORMAT_META_NONE = 0xFF,
} ValueFormatMetaLength_t;
 
#define FORMAT_META_MASK_FMT    0xE0
#define FORMAT_META_MASK_LENGTH    0x1F
 
typedef enum meta_fmt {
    FORMAT_META_FMT_INT = 0,
    FORMAT_META_FMT_UINT = (0x01) << 5,
    FORMAT_META_FMT_Q = (0x02) << 5,
    FORMAT_META_FMT_SPECIAL_TIME = (0x03) << 5,
    FORMAT_META_FMT_SPECIAL_BCD = (0x04) << 5,
    FORMAT_META_FMT_SPECIAL_FUTURE2 = (0x05) << 5,
    FORMAT_META_FMT_SPECIAL_FUTURE3 = (0x06) << 5,
    FORMAT_META_FMT_SPECIAL_FUTURE4 = (0x07) << 5,
} ValueFormatMetaFmt_t;
 
 
#define Q_FORMAT_NONE            0xFF
 
typedef struct{
    uint8_t m, n;
} RecordTypeQ_t;
 
typedef struct {
 
    ValueFormatMetaFmt_t meta_format;        // FMT
    ValueFormatMetaLength_t meta_length;    // LEN
    RecordTypeQ_t Q;
 
} RecordTypeValue_t;
 
typedef struct {
    uint8_t sensor_id[8];
    SensorType_t sensor_type;  // 1B
    RecordTypeValue_t value_format;    // 3B
} RecordDescriptor_t;
 
 
typedef struct {     //1B
    uint8_t ID;
    uint32_t meta_address;        //4B
    uint32_t data_address;        //4B
    uint8_t name[FILENAME_LENGTH]; //FILENAME_LENGTH B = 16 B
    uint8_t num_parts;        // 1B
    RecordDescriptor_t format[MAXIMUM_FS_SENSORS_PER_FILE]; // 4B
    uint16_t record_length; // 2B
    uint16_t recordAddressMap[MAXIMUM_FS_SENSORS_PER_FILE];
} FileDescriptor_t;
 
typedef struct {
    FileDescriptor_t file;
    uint8_t num_files;
} SimpleFS_t;
 
typedef struct {
    uint8_t version;
    uint8_t manufacturer;
    uint8_t memory_type;
    uint8_t memory_capacity;
    uint8_t memory_id[8];
} FS_Header_t;
 
 
 
#endif /* INC_FILE_FORMAT_H_ */