MCUXpresso_MIMXRT1052xxxxB/boards/evkbimxrt1050/littlefs_examples/littlefs_shell
Yilin Sun ded8674389
Updated to v2.12.1
Signed-off-by: Yilin Sun <imi415@imi.moe>
2022-12-08 23:33:41 +08:00
..
armgcc Updated to v2.12.0 2022-08-24 23:30:23 +08:00
board.c Updated to v2.12.0 2022-08-24 23:30:23 +08:00
board.h Updated to v2.12.0 2022-08-24 23:30:23 +08:00
clock_config.c SDK v2.11.1 2022-04-08 22:46:35 +08:00
clock_config.h SDK v2.11.1 2022-04-08 22:46:35 +08:00
dcd.c SDK v2.11.1 2022-04-08 22:46:35 +08:00
dcd.h SDK v2.11.1 2022-04-08 22:46:35 +08:00
evkbimxrt1050_sdram_init.jlinkscript SDK v2.11.1 2022-04-08 22:46:35 +08:00
lfs_mflash.c SDK v2.11.1 2022-04-08 22:46:35 +08:00
lfs_mflash.h SDK v2.11.1 2022-04-08 22:46:35 +08:00
littlefs_shell_v3_10.xml Updated to v2.12.0 2022-08-24 23:30:23 +08:00
littlefs_shell.c SDK v2.11.1 2022-04-08 22:46:35 +08:00
peripherals.c Updated to v2.12.1 2022-12-08 23:33:41 +08:00
peripherals.h Updated to v2.12.1 2022-12-08 23:33:41 +08:00
pin_mux.c SDK v2.11.1 2022-04-08 22:46:35 +08:00
pin_mux.h SDK v2.11.1 2022-04-08 22:46:35 +08:00
readme.txt Updated to v2.12.0 2022-08-24 23:30:23 +08:00

Overview
========
The littlefs_shell demonstrates the capabilities of LittleFS FLASH filesystem:

After the example is loaded into the target and launched the shell prompt is printed to the console.
Type "help" to obtain list of available commands. The FLASH storage has to be formatted upon first use.
After mounting the filesystem it is possible to create/delete/list directories and read/write files using appropriate commands.
There is no concept of current directory in LittleFS, hence it is always necessary to specify full directory path.

List of supported commands:
  format       Formats the filesystem
  mount        Mounts the filesystem
  unmount      Unmounts the filesystem
  ls           Lists directory content
  rm           Removes file or directory
  mkdir        Creates a new directory
  write        Writes/appends text to a file
  cat          Prints file content

Example workflow:
To perform initial format of the storage, issue 'format yes' command.
Mount the storage by issuing 'mount' command.
Create new directory by 'mkdir mynewdir'.
Create new file in the 'mynewdir' directory by writing line of text to it using 'write mynewdir/foo.txt firstline'
Append another line to the same file using 'write mynewdir/foo.txt secondline'
Print the content of the file using 'cat mynewdir/foo.txt'. The expected output is:
  firstline
  secondline

Toolchain supported
===================
- IAR embedded Workbench  9.30.1
- MCUXpresso  11.6.0
- Keil MDK  5.37
- GCC ARM Embedded  10.3.1

Hardware requirements
=====================
- Mini/micro USB cable
- EVKB-IMXRT1050 board
- Personal Computer

Board settings
==============

Prepare the Demo
================
1.  Connect a USB cable between the host PC and the OpenSDA USB port on the target board. 
2.  Open a serial terminal with the following settings:
    - 115200 baud rate
    - 8 data bits
    - No parity
    - One stop bit
    - No flow control
3.  Download the program to the target board.
4.  Either press the reset button on your board or launch the debugger in your IDE to begin running the demo.

Running the demo
================

Note: LittleFS example built using arm-gcc does not work as expected out-of-the box. Other supported toolchains are not affected.

When the example runs successfully, you can see the similar information from the terminal as below.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SHELL (build: Feb 28 2018)
Copyright  2017  NXP
LFS>>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~