file_system.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2024 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _FILE_SYSTEM_H_
#define _FILE_SYSTEM_H_
 
#ifdef __cplusplus
extern "C"{
#endif
 
#include "physical_drive.h"
#include "cstdio.h"
#include "assembly.h"
 
#define NOP() assembly(nop)
 
#define FS_MAX_VOLUMES                   ((uint8_t)5)
 
#define FS_MAX_OBJECTS                   ((uint8_t)10)
 
 // file_system_config_group
 
#define FSS_OK                           ((uint8_t)0)
 
#define FSS_GENERAL_ERROR                ((uint8_t)1)
 
#define FSS_DRIVE_FULL                   ((uint8_t)2)
 
#define FSS_END_OF_FILE                  ((uint8_t)3)
 
#define FSS_END_OF_DIRECTORY             ((uint8_t)4)
 
#define FSS_NOT_IMPLEMENTED              ((uint8_t)5)
 
 // file_system_status_group
 
 
#define FS_FILE_READ                     0x01
 
#define FS_FILE_WRITE                    0x02
 
#define FS_FILE_OPEN_EXISTING            0x00
 
#define FS_FILE_CREATE_NEW               0x04
 
#define FS_FILE_CREATE_ALWAYS            0x08
 
#define FS_FILE_OPEN_ALWAYS              0x10
 
#define FS_FILE_OPEN_APPEND              0x30
 
 // file_flags_group
 
 
typedef int8_t fs_status_t;
 
 
typedef enum {
    SEEK_START = 0, 
    SEEK_CURRENT,   
    SEEK_END,       
} fs_file_rw_pointer_t;
 
typedef void * fs_file_t;
 
 
typedef void * fs_dir_t;
 
typedef struct logical_drive_vector_table logical_drive_vector_table_t;
 
 
typedef enum {
    FS_TYPE_UNINITIALIZED = 0, 
    FS_TYPE_FATFS              
} logical_drive_type_t;
 
typedef struct {
    logical_drive_vector_table_t * vtptr; 
    logical_drive_type_t type;            
    uint8_t volume_id;                    
    uint8_t object_count;                 
    uint8_t error;                        
} logical_drive_t;
 
 // logical_drive_group
 
 
fs_status_t file_system_format(const char * __generic_ptr path);
 
fs_status_t file_system_mount(logical_drive_t * const ldrive_base, const char * __generic_ptr path, physical_drive_t * const pdrive_base);
 
fs_status_t file_system_unmount(const char * __generic_ptr path);
 
fs_status_t file_system_remove(const char * __generic_ptr path);
 
fs_status_t file_system_rename(const char * __generic_ptr old_path, const char * __generic_ptr new_path);
 
fs_status_t file_system_mkdir(const char * __generic_ptr path);
 
 // file_system_management_group
 
#ifdef __cplusplus
}
#endif
 
#endif // !_FILE_SYSTEM_H_