ASoc: SOF: core: Update the FW boot state transition diagram

Update the state flow diagram to reflect the current implementation.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Reviewed-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Reviewed-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Link: https://lore.kernel.org/r/20211223113628.18582-15-peter.ujfalusi@linux.intel.com
Signed-off-by: Mark Brown <broonie@kernel.org>

diff --git a/sound/soc/sof/core.c b/sound/soc/sof/core.c
index aa7a721f34e4a67b887e09b3175ad6779b3a0721..bc3d7192bdda365874c83ddb411f0e96bdda1aee 100644 (file)
--- a/sound/soc/sof/core.c
+++ b/sound/soc/sof/core.c
@@ -114,32 +114,32 @@ EXPORT_SYMBOL(snd_sof_get_status);
 /*
  *                     FW Boot State Transition Diagram
  *
- *    +-----------------------------------------------------------------------+
- *    |                                                                              |
- * ------------------       ------------------                               |
- * |               |        |                |                               |
- * |   BOOT_FAILED  |       |  READY_FAILED  |-------------------------+     |
- * |               |        |                |                         |     |
- * ------------------       ------------------                         |     |
- *     ^                           ^                                   |     |
- *     |                           |                                   |     |
- * (FW Boot Timeout)           (FW_READY FAIL)                         |     |
- *     |                           |                                   |     |
- *     |                           |                                   |     |
- * ------------------              |              ------------------   |     |
- * |               |               |              |                |   |     |
- * |   IN_PROGRESS  |---------------+------------->|    COMPLETE    |  |     |
- * |               | (FW Boot OK)   (FW_READY OK) |                |   |     |
- * ------------------                             ------------------   |     |
- *     ^                                               |               |     |
- *     |                                               |               |     |
- * (FW Loading OK)                            (System Suspend/Runtime Suspend)
- *     |                                               |               |     |
- *     |                                               |               |     |
- * ------------------          ------------------      |               |     |
- * |               |           |                |<-----+               |     |
- * |   PREPARE     |           |   NOT_STARTED  |<---------------------+     |
- * |               |           |                |<---------------------------+
+ *    +----------------------------------------------------------------------+
+ *    |                                                                             |
+ * ------------------       ------------------                              |
+ * |               |        |                |                              |
+ * |   BOOT_FAILED  |<-------|  READY_FAILED  |                                     |
+ * |               |<--+    |                |    ------------------        |
+ * ------------------  |    ------------------    |                |        |
+ *     ^               |           ^              |    CRASHED     |---+    |
+ *     |               |           |              |                |   |    |
+ * (FW Boot Timeout)   |       (FW_READY FAIL)    ------------------   |    |
+ *     |               |           |                ^                  |    |
+ *     |               |           |                |(DSP Panic)       |    |
+ * ------------------  |           |              ------------------   |    |
+ * |               |   |           |              |                |   |    |
+ * |   IN_PROGRESS  |---------------+------------->|    COMPLETE    |  |    |
+ * |               | (FW Boot OK)   (FW_READY OK) |                |   |    |
+ * ------------------  |                          ------------------   |    |
+ *     ^               |                               |               |    |
+ *     |               |                               |               |    |
+ * (FW Loading OK)     |                       (System Suspend/Runtime Suspend)
+ *     |               |                               |               |    |
+ *     |       (FW Loading Fail)                       |               |    |
+ * ------------------  |       ------------------      |               |    |
+ * |               |   |       |                |<-----+               |    |
+ * |   PREPARE     |---+       |   NOT_STARTED  |<---------------------+    |
+ * |               |           |                |<--------------------------+
  * ------------------          ------------------
  *    |            ^                       |      ^
  *    |            |                       |      |