Merge pull request #131 from zhigang-wu/topic/state-machine-change1

component: draw the state machine flow chart
thesofproject · Jul 20, 2018 · 5334612 · 5334612
2 parents 40bf6b7 + d0aa5bf
commit 5334612
Showing 1 changed file with 23 additions and 8 deletions.
diff --git a/src/include/sof/audio/component.h b/src/include/sof/audio/component.h
@@ -49,16 +49,31 @@
  *
  * States may transform as below:-
  *
- * 1) i.e. Initialisation to playback and pause/release
- * init --> setup --> prepare --> active <-> paused --+
- *                       ^                             |
- *                       +-----------------------------+
  *
- * 2) i.e. Suspend
+ *                            -------------
+ *                   pause    |           |    stop/xrun
+ *              +-------------| ACTIVITY  |---------------+
+ *              |             |           |               |      prepare
+ *              |             -------------               |   +-----------+
+ *              |                ^     ^                  |   |           |
+ *              |                |     |                  |   |           |
+ *              v                |     |                  v   |           |
+ *       -------------           |     |             -------------        |
+ *       |           |   release |     |   start     |           |        |
+ *       |   PAUSED  |-----------+     +-------------|  PREPARE  |<-------+
+ *       |           |                               |           |
+ *       -------------                               -------------
+ *              |                                      ^     ^
+ *              |               stop/xrun              |     |
+ *              +--------------------------------------+     |
+ *                                                           | prepare
+ *                            -------------                  |
+ *                            |           |                  |
+ *                ----------->|   READY   |------------------+
+ *                    reset   |           |
+ *                            -------------
+ *
  *
- * setup --> suspend --> setup OR
- * prepare --> suspend -> prepare OR
- * paused --> suspend --> paused
  */
 
 #define COMP_STATE_INIT		0	/* component being initialised */