Add instructions for the external loader

This commit is contained in:
L-diy
2023-11-15 21:08:30 +01:00
parent e6255c4fea
commit 5eb7f36a5e
4 changed files with 18 additions and 0 deletions

View File

@@ -6,6 +6,7 @@
- [Style Guide](#style-guide)
- [Editor Configuration](#editor-configuration)
- [Commit Messages Conventions](#commit-messages-conventions)
- [Writing File System Data to QSPI Flash](#writing-file-system-data-to-qspi-flash)
- [Documentation](#documentation)
## Used Libs, Compiler and Apps
@@ -52,6 +53,10 @@ Implement access right management
The body of a commit message may be used to explain the what and why of a commit.
## Writing File System Data to QSPI Flash
Please read the [llfs.md](./docs/llfs.md#enabling-the-external-loader-in-stm32cubeide) document for instructions
on how to enable the external loader in STM32CubeIDE.
## Documentation
Documentation is placed in the [docs](docs) folder.
If your part needs documentation (e.g. how to use tcp cmd interface), add a markdown file in the above-mentioned folder.

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@@ -24,6 +24,7 @@ restricting operations solely to read functions.
- [Reading a file](#reading-a-file)
- [Getting the number of files](#getting-the-number-of-files)
- [Using the POSIX file functions](#using-the-posix-file-functions)
- [Enabling the external loader in STM32CubeIDE](#enabling-the-external-loader-in-stm32cubeide)
## Initialization
Before using the llfs API, or the file related POSIX (fopen, fgetc, ...) functions, the filesystem must be initialized by calling `llfs_init()`.
@@ -161,3 +162,15 @@ The following functions are tested and working, but other functions might also w
- `rewind`
- `fstat`
- `fileno`
## Enabling the external loader in STM32CubeIDE
In order to write the file system data to the QSPI flash, the external loader must be enabled in STM32CubeIDE.
This can be done by opening the debug configuration:
![](img\ext_loader_step_1.png)
Then, in the `Debugger` tab:
3. Enable the `External Loader`
4. Click the `Scan` button
5. Select the correct loader: `N25Q128A_STM32F746G-DISCO, 0x90000000 ...`
![](img\ext_loader_step_2.png)