Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/labplus-cn/mkfatfs

A tools use for pack/unpack flash file system.
https://github.com/labplus-cn/mkfatfs

Last synced: about 2 months ago
JSON representation

A tools use for pack/unpack flash file system.

Awesome Lists containing this project

README

        

# mkfatfs
Tool to build and unpack [FATFS](https://github.com/jkearins/ESP32_mkfatfs) images.

## Usage

```

in windows:

mkfatfs {-c |-u |-l|-i} [-d <0-5>] [-b ]
[-p ] [-s ] [--] [--version] [-t ] [-h]

in linux:
./mkfatfs {-c |-u |-l|-i} [-d <0-5>] [-b ]
[-p ] [-s ] [--] [--version] [-t ] [-h]

eg:
pack:
windows:
mkfatfs.exe -c Test -s 0x200000 -t littlefs test.bin
linux:
./mkfatfs -c Test -s 0x200000 -t littlefs test.bin

unpack:
windows:
mkfatfs.exe -u Test -s 0 -t littlefs test.bin
linux:
./mkfatfs -u Test -s 0 -t littlefs test.bin

Where:

-c , --create
(OR required) create fatfs image from a directory
-- OR --
-u , --unpack
(OR required) unpack fatfs image to a directory
-- OR --
-l, --list
(OR required) list files in fatfs image
-- OR --
-i, --visualize
(OR required) visualize fatfs image

-d <0-5>, --debug <0-5>
Debug level. 0 means no debug output.

-b , --block
fs block size, in bytes

-p , --page
fs page size, in bytes

-s , --size
fs image size, in bytes

-t --type
fs type, surport fatfs and littlefs

--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.

--version
Displays version information and exits.

-h, --help
Displays usage information and exits.


(required) fatfs image file

```
## Build

You need gcc (≥4.8) or clang(≥600.0.57), and make. On Windows, use MinGW.
You need cmake (≥3.0.0).
Youn can develop in vscode. install extension CMake and CMake Tools.
More help for build project, please read the extension's help.
in linux:
cd mkfatfs
cmake .
make

## License

MIT

## To do

- [ ] Flag -u is not released yet
- [ ] Flag -l is not released yet
- [ ] Flag -i is not released yet
- [ ] Add more debug output and print FATFS debug output
- [ ] Error handling
- [ ] Determine the image size automatically when opening a file
- [ ] Code cleanup