diff options
Diffstat (limited to 'os/hal/dox')
| -rw-r--r-- | os/hal/dox/hal_flash.dox | 30 | ||||
| -rw-r--r-- | os/hal/dox/hal_norflash.dox | 28 |
2 files changed, 42 insertions, 16 deletions
diff --git a/os/hal/dox/hal_flash.dox b/os/hal/dox/hal_flash.dox index 4cf395292..8be3efea8 100644 --- a/os/hal/dox/hal_flash.dox +++ b/os/hal/dox/hal_flash.dox @@ -18,5 +18,35 @@ * @defgroup HAL_FLASH Generic NOR Flash Interface
* @brief HAL Generic NOR Flash Driver Interface.
*
+ * @section flash_1 Driver State Machine
+ * The flash driver implements a state machine internally, not all the driver
+ * functionalities can be used in any moment, any transition not explicitly
+ * shown in the following diagram has to be considered an error and shall
+ * be captured by an assertion (if enabled).
+ * @dot
+ digraph example {
+ rankdir="LR";
+ node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true", width="0.9", height="0.9"];
+ edge [fontname=Helvetica, fontsize=8];
+ stop [label="FLS_STOP\nLow Power"];
+ uninit [label="FLS_UNINIT", style="bold"];
+ ready [label="FLS_READY\nClock Enabled"];
+ read [label="FLS_READ\nReading"];
+ pgm [label="FLS_PGM\nProgramming"];
+ erase [label="FLS_ERASE\nErasing"];
+ uninit -> stop [label=" xxxInit()", constraint=false];
+ stop -> stop [label=" xxxStop()"];
+ stop -> ready [label=" xxxStart()"];
+ ready -> stop [label=" xStop()"];
+ ready -> read [label=" flashRead()\nflashVerifyErase()"];
+ read -> ready [label=" return"];
+ ready -> pgm [label=" flashProgram()"];
+ pgm -> ready [label=" return"];
+ ready -> erase [label=" \n\nflashEraseAll()\nflashEraseSector()"];
+ erase -> ready [label=" flashQueryErase()\nFLASH_NO_ERROR\nFLASH_ERROR_*"];
+ erase -> erase [label=" flashQueryErase()\nflashProgram()\nflashRead()\nFLASH_BUSY_ERASING"];
+ }
+ * @enddot
+ *
* @ingroup HAL_ABSTRACT_PERIPHERALS
*/
diff --git a/os/hal/dox/hal_norflash.dox b/os/hal/dox/hal_norflash.dox index 2196363bd..24f30d9e4 100644 --- a/os/hal/dox/hal_norflash.dox +++ b/os/hal/dox/hal_norflash.dox @@ -20,7 +20,7 @@ * @details This module implements a generic driver for serial NOR Flash
* devices.
*
- * @section flash_1 Driver State Machine
+ * @section snorflash_1 Driver State Machine
* The flash driver implements a state machine internally, not all the driver
* functionalities can be used in any moment, any transition not explicitly
* shown in the following diagram has to be considered an error and shall
@@ -34,23 +34,19 @@ uninit [label="FLS_UNINIT", style="bold"];
ready [label="FLS_READY\nClock Enabled"];
read [label="FLS_READ\nReading"];
- program [label="FLS_PGM\nProgramming"];
- erasea [label="FLS_ERASEA\nErasing All"];
- erases [label="FLS_ERASES\nErasing Sector"];
- uninit -> stop [label=" flashInit()", constraint=false];
- stop -> stop [label=" flashStop()"];
- stop -> ready [label=" flashStart()"];
- ready -> stop [label=" flashStop()"];
+ pgm [label="FLS_PGM\nProgramming"];
+ erase [label="FLS_ERASE\nErasing"];
+ uninit -> stop [label=" snorInit()", constraint=false];
+ stop -> stop [label=" snorStop()"];
+ stop -> ready [label=" snorStart()"];
+ ready -> stop [label=" snorStop()"];
ready -> read [label=" flashRead()\nflashVerifyErase()"];
read -> ready [label=" return"];
- ready -> program [label=" flashProgram()"];
- program -> ready [label=" return"];
- ready -> erasea [label=" flashEraseAll)"];
- erasea -> ready [label=" flashQueryErase()\nFLASH_NO_ERROR\nFLASH_ERROR_*"];
- erasea -> erasea [label=" flashQueryErase()\nflashProgram()\nflashRead()\nFLASH_BUSY_ERASE"];
- ready -> erases [label=" flashEraseSector()"];
- erases -> ready [label=" flashQueryErase()\nFLASH_NO_ERROR\nFLASH_ERROR_*"];
- erases -> erases [label=" flashQueryErase()\nflashProgram()\nflashRead()\nFLASH_BUSY_ERASE"];
+ ready -> pgm [label=" flashProgram()"];
+ pgm -> ready [label=" return"];
+ ready -> erase [label=" \n\nflashEraseAll()\nflashEraseSector()"];
+ erase -> ready [label=" flashQueryErase()\nFLASH_NO_ERROR\nFLASH_ERROR_*"];
+ erase -> erase [label=" flashQueryErase()\nflashProgram()\nflashRead()\nFLASH_BUSY_ERASING"];
}
* @enddot
*
|