riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

tests/pkg_fatfs: Word wrap README

Browse Source
This commit is contained in:
Joakim Nohlgård 2018-02-21 09:45:13 +01:00
parent f8a9e6303f
commit 0735614376
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
tests/pkg_fatfs/README.md
View File

@ -3,15 +3,25 @@ Using FatFs on RIOT
# native # native
To use this test on native you can either use a FAT-formatted image file or directly use the mkfs command from the RIOT shell. To use this test on native you can either use a FAT-formatted image file or
Use `make image` to extract a prepared image file that already contains a simple test.txt file. directly use the mkfs command from the RIOT shell. Use `make image` to extract
This is only a convinience function to allow testing against a "default linux" formatted fat volume without the need to call mount or other stuff that may require super user privileges. a prepared image file that already contains a simple test.txt file. This is
Optionally `make compressed-image` can be used to generate the compressed image that is in turn used by `make image`. only a convinience function to allow testing against a "default linux"
formatted fat volume without the need to call mount or other stuff that may
require super user privileges. Optionally `make compressed-image` can be used
to generate the compressed image that is in turn used by `make image`.
To tell RIOT where your image file is located you can use the define `MTD_NATIVE_FILENAME`. To tell RIOT where your image file is located you can use the define
`MTD_NATIVE_FILENAME`.
NOTE: You shouldn't leave the image mounted while you use it in RIOT, the abstraction layer between FatFs and the image file mimics a dumb block device (i.e. behaves much like the devices that are actually meant to be used with FAT) That implies it doesn't show any modifications in RIOT that you perform on your OS and the other way round. So always remember to mount/unmount correctly or your FS will probably get damaged. NOTE: You shouldn't leave the image mounted while you use it in RIOT, the
abstraction layer between FatFs and the image file mimics a dumb block device
(i.e. behaves much like the devices that are actually meant to be used with
FAT) That implies it doesn't show any modifications in RIOT that you perform on
your OS and the other way round. So always remember to mount/unmount correctly
or your FS will probably get damaged.
# Real Hardware # Real Hardware
Currently the test defaults to sdcard_spi on real hardware. But generally any device that supports the mtd-interface can be used with FatFs. Currently the test defaults to sdcard_spi on real hardware. But generally any
device that supports the mtd-interface can be used with FatFs.