This repository defines a DMOD Interface (DIF) for file systems. It provides a standardized interface that can be implemented by various file system modules (e.g., FatFS, RamFS, FlashFS) to enable virtual file system (VFS) mounting in DMOD-based systems.

The DMFSI (DMOD File System Interface) defines a comprehensive set of file system operations based on POSIX-like semantics. This interface allows different file system implementations to be used interchangeably through the DMOD dynamic module system.

The interface includes:

• File operations: open, close, read, write, seek, flush
• Character I/O: getc, putc
• File information: size, tell, eof, error
• Directory operations: opendir, closedir, readdir
• File management: stat, unlink, rename, chmod, utime
• Directory management: mkdir, direxists
• Initialization: init, deinit

• DMOD library (https://github.com/choco-technologies/dmod.git)
• GNU Make or CMake (version 3.18 or higher)
• GCC or compatible C compiler

DMOD modules can be built using CMake in two modes:

In this mode, modules are built as dynamically loadable DMF (DMOD Module Format) files:

# First, build DMOD
cd /path/to/dmod
make

# Set DMOD_DIR to point to your DMOD installation
export DMOD_DIR=/path/to/dmod

# Build the DMFSI interface module with examples (DMOD_MODULE is the default)
cd /path/to/dmod-fsi
cmake -B build -DDMOD_BUILD_EXAMPLES=ON
cmake --build build

# DMF files will be created in build/dmf/

In this mode, modules are built as static libraries that can be linked into a DMOD system application:

# First, build DMOD
cd /path/to/dmod
make

# Set DMOD_DIR to point to your DMOD installation
export DMOD_DIR=/path/to/dmod

# Build the DMFSI interface as a static library
cd /path/to/dmod-fsi
cmake -B build -DDMOD_MODE=DMOD_SYSTEM -DDMOD_BUILD_EXAMPLES=ON
cmake --build build

# Static libraries (.a files) will be created in build/

DMOD modules can also be built using the DMOD build system with Make:

# First, build DMOD
cd /path/to/dmod
make

# Set DMOD_DIR to point to your DMOD installation
export DMOD_DIR=/path/to/dmod

# Build the DMFSI interface module
cd /path/to/dmod-fsi
make

# Build the RamFS example
cd examples/ramfs
make

The build process will generate DMF (DMOD Module Format) files that can be dynamically loaded by DMOD.

Note: This module was structured following DMOD's module conventions. To create new DMOD modules, use the new-module.sh script from the DMOD repository (available in scripts/new-module.sh on the develop branch).

The interface is defined in inc/dmfsi.h. All operations return integer status codes (DMFSI_OK on success, negative error codes on failure).

The examples/ramfs directory contains a simple RAM-based file system implementation demonstrating how to implement the DMFSI interface. This serves as a reference for creating new file system modules.

To implement a new file system:

1. Create a new module directory
2. Include dmfsi.h in your implementation
3. Implement the DIF functions using dmod_dmfsi_dif_api_declaration macro
4. Create Makefile and CMakeLists.txt based on the examples
5. Build your module as a DMOD DMF file

dmod-fsi/
├── inc/
│   ├── dmfsi.h         # Main interface definition
│   └── dmfsi_defs.h    # DMOD-generated definitions
├── src/
│   └── dmfsi.c         # Interface registration
├── examples/
│   ├── ramfs/          # Example RAM file system implementation
│   │   ├── ramfs.c
│   │   ├── Makefile
│   │   └── CMakeLists.txt
│   └── CMakeLists.txt
├── Makefile            # Build file for Make
└── CMakeLists.txt      # Build file for CMake

MIT License - See LICENSE file for details