diff options
Diffstat (limited to 'os/hal/dox/hal_flash.dox')
| -rw-r--r-- | os/hal/dox/hal_flash.dox | 30 |
1 files changed, 30 insertions, 0 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
*/
|