Skip to content

Commit

Permalink
Add more information to NAND driver documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertRostohar committed Nov 25, 2024
1 parent 9db2abc commit 50efdc4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Documentation/Doxygen/src/introduction.txt
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,17 @@ int main (void) {
\page driver_NAND NAND

This is a CMSIS compliant driver for NAND Flash devices that are connected to the microcontroller's memory bus.
It exports a NAND CMSIS-Driver with a maximum of four memory mapped NAND Flash devices.

The driver is configured using the NAND_MemBus_Config.h configuration file, which contains the following options:
- \c \#define \c NAND_DRIVER exports the NAND CMSIS-Driver instance, which can be used to access the memory mapped NAND Flash devices.
- \c \#define \c NAND_DEVx enables the memory mapped NAND Flash device.
- \c \#define \c NAND_DEVx_ADDR_BASE specifies the base address of the Flash device, which is used to control the data/address lines and nCE, nRE, nWE lines.
- \c \#define \c NAND_DEVx_ADDR_ALE specifies the ALE address of the Flash device, which is used to control the ALE line.
- \c \#define \c NAND_DEVx_ADDR_CLE specifies the CLE address of the Flash device, which is used to control the CLE line.
- \c \#define \c NAND_DEVx_DATA_WIDTH specifies the data bus width of the Flash device.
- \c \#define \c NAND_DEVx_RB_PIN specifies if Ready/Busy line of the Flash device is available (used for Ready/Busy monitoring).
- \c \#define \c NAND_DEVx_RB_PIN_IRQ specifies if Ready/Busy line of the Flash device can trigger an interrupt.
*/


Expand Down

0 comments on commit 50efdc4

Please sign in to comment.