xipfs_fs.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 Université de Lille
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef FS_XIPFS_FS_H
#define FS_XIPFS_FS_H
 
#include "vfs.h"
#include "mtd_flashpage.h"
#include "mutex.h"
#include "include/xipfs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define XIPFS_NEW_PARTITION(id, path, num)            \
    FLASH_WRITABLE_INIT(xipfs_part_##id, num);        \
    static mutex_t execution_mutex_##id = MUTEX_INIT; \
    static mutex_t mutex_##id = MUTEX_INIT;           \
    static vfs_xipfs_mount_t id = {                   \
        .vfs_mp = {                                   \
            .fs = &xipfs_file_system,                 \
            .mount_point = path,                      \
        },                                            \
        .magic = XIPFS_MAGIC,                         \
        .mount_path = path,                           \
        .page_num = num,                              \
        .page_addr = (void *)xipfs_part_##id,         \
        .execution_mutex = &execution_mutex_##id,     \
        .mutex = &mutex_##id                          \
    }
 
typedef struct vfs_xipfs_mount_s {
    vfs_mount_t vfs_mp;      
    unsigned magic;          
    const char *mount_path;  
    size_t page_num;         
    void *page_addr;         
    mutex_t *execution_mutex;
    mutex_t *mutex;          
} vfs_xipfs_mount_t;
 
extern const vfs_file_system_t xipfs_file_system;
 
int xipfs_construct_from_flashpage(mtd_flashpage_t *flashpage, const char *path,
                                   mutex_t *execution_mutex, mutex_t *mutex,
                                   vfs_xipfs_mount_t *vfs_xipfs_mount);
 
/* Extended driver handling executables */
 
int xipfs_extended_driver_new_file(const char *full_path, uint32_t size, uint32_t exec);
 
int xipfs_extended_driver_execv(const char *full_path, char *const argv[]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* FS_XIPFS_FS_H */