shared.h

Go to the documentation of this file.

/* Copyright (c) 2026 Zane A. Maple
   Licensed under the MIT license. See LICENSE in the main repository for more information. */
 
/* Includes standard struct definitions to be used across hardware implementations */

 
#ifndef W_HAL_SHARED_H
#define W_HAL_SHARED_H
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
/* Note: these are not set in stone and will be expanded upon more than likely as time goes on */
typedef uint8_t HAL_ERROR;
#define HAL_OKAY            0
#define HAL_FS_DISK_ERR     1
#define HAL_FS_INT_ERR      2 
#define HAL_FS_NOT_READY    3
#define HAL_FS_NO_FILE      4
#define HAL_FS_NO_PATH      5
#define HAL_FS_INVALID_NAME 6
#define HAL_FS_ACCESS_DENY  7
#define HAL_FS_ALRDY_EXISTS 8
#define HAL_FS_INVALID_OBJ  9
#define HAL_FS_NOT_ENABLED  10
#define HAL_FS_NO_FS        11
#define HAL_FS_MKFS_ABORTED 12
#define HAL_FS_TIMEOUT      13 
#define HAL_FS_LOCKED       14
#define HAL_FS_NOT_ENOUGH_M 15
#define HAL_FS_TOO_MANY_OPN 16
#define HAL_FS_INVALID_PARM 17
#define HAL_FS_WRITE_PROT   18
#define HAL_FS_INVALID_DRIV 19
#define HAL_FS_DOUBLE_OPEN  20
#define HAL_FS_UNKNOWN_ERR  21
 
#define HAL_FLASH_OUT_OF_BOUNDS 22
#define HAL_FLASH_BAD_INTEGRITY 23
#define HAL_USB_CANNOT_INITIALIZE 24
#define HAL_FS_READDIR_RESET 25
/* File system settings */
 
#define HAL_FS_MAX_OPEN_FILES 16
#define HAL_FS_MAX_OPEN_DIRS  4
#define HAL_SD_USE_HW_CD false 

typedef struct hal_file
{
    /* Basic metadata */
    char *filename; 
    size_t fsize; 
    uint8_t fattrs; 
    uint16_t fdate; 
    uint16_t ftime; 
    uint32_t fd; 
 
    /* Internal pointer based on underlying implementation, points to actual internal file object */
    void * _internal_fp; 
    bool _internal_has_file; 
 
    /* If any of the file functions fail, this is where the err is set */
    HAL_ERROR errno; 
} _FILE;

typedef struct hal_dir
{
    uint8_t dattrs; 
    uint16_t fdate; 
    uint16_t ftime; 
    uint32_t dd; 
    
    /* Internal pointer based on underlying implementation, points to actual internal dir object */
    void * _internal_dp; 
    bool _internal_has_dir; 
 
    /* If any of the file functions fail, this is where the err is set */
    HAL_ERROR errno; 
} _DIR;

 
/* Mainly used as an pointer holder for internal sd/fatfs code */
typedef struct disk_info
{
    bool disk_mounted; 
    bool is_externally_writable; 
    void * _internal_sdp; 
    void * _internal_fsp; 
    bool (*_internal_read_fp)(uint32_t, uint32_t, void*); 
    bool (*_internal_write_fp)(uint32_t, uint32_t, uint8_t*); 
    uint32_t _internal_blocksize; 
    uint32_t _internal_sectorcount; 
    
 
    /* Errno for all disk operations */
    HAL_ERROR errno; 
 
} _DISK_INFO;

const char * HAL_ERROR_to_str(HAL_ERROR errno);
 
#endif