filesystem.h

Go to the documentation of this file.

/**************************************************************************************************************************************
* Project:       discoverpixy
* Website:       https://github.com/t-moe/discoverpixy
* Authors:       Aaron Schmocker, Timo Lang
* Institution:   BFH Bern University of Applied Sciences
* File:          common/filesystem/filesystem.h
*
* Version History:
* Date          Autor Email         SHA     Changes
* 2015-04-03    timolang@gmail.com  51089aa Refactored Project Structure for use with emulator
* 2015-05-10    timolang@gmail.com  e2bce8f Added filesystem module, tests and implementation for it in emulator.
* 2015-05-15    timolang@gmail.com  9a16865 Added doxgen comments to filesyste, checkbox, numupdown and screen module. And some minor changes to the other modules.
*
**************************************************************************************************************************************/

#ifndef FILESYSTEM_H
#define FILESYSTEM_H

#include <stdbool.h>
#include <stdint.h>


typedef enum {
    F_RDO = 0x01, 
    F_HID = 0x02, 
    F_SYS = 0x04, 
    F_DIR = 0x10, 
    F_ARC = 0x20 
} FILE_ATTRIBUTES;

typedef struct {
    unsigned year : 7; 
    unsigned month: 4; 
    unsigned day: 5; 
} FILE_DATE_STRUCT;

typedef struct {
    unsigned hour : 5; 
    unsigned min: 6; 
    unsigned sec: 5; 
} FILE_TIME_STRUCT;

typedef struct {
    uint32_t fsize; 
    FILE_DATE_STRUCT fdate; 
    FILE_TIME_STRUCT ftime; 
    uint8_t fattrib; 
    char*    fname; 
} FILE_STRUCT;

typedef struct {
    const char* path; 
    uint16_t num_files; 
    FILE_STRUCT* files; 
} DIRECTORY_STRUCT;

typedef struct {
    const char* fname; 
    uint32_t fpos; 
    uint32_t fsize; 
} FILE_HANDLE;

typedef enum {
    F_OK,          
    F_EOF,         
    F_EACCESS,     
    F_INVALIDPARAM,
    F_DISKERROR    
} FILE_STATUS;

bool filesystem_init();

DIRECTORY_STRUCT* filesystem_dir_open(const char* path);

void filesystem_dir_close(DIRECTORY_STRUCT* dir);

FILE_HANDLE* filesystem_file_open(const char* filename);

void filesystem_file_close(FILE_HANDLE* handle);

FILE_STATUS filesystem_file_seek(FILE_HANDLE* handle, uint32_t offset);

FILE_STATUS filesystem_file_read(FILE_HANDLE* handle, uint8_t* buf, uint32_t size);

FILE_STATUS filesystem_file_write(FILE_HANDLE* handle, uint8_t* buf, uint32_t size);


#endif /* FILESYSTEM_H */