diff options
| author | Bill Fischofer <bill.fischofer@linaro.org> | 2016-03-08 15:38:06 +0700 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2016-03-15 11:13:37 +0300 |
| commit | e55947893971184f64ab859af46c1236955e7f5f (patch) | |
| tree | 8fe013aecd7d3c41fd203e7a3b22f3331cb2d917 /doc | |
| parent | 51e8e4ee5df95fe48b3e714eebec748f0a814bf8 (diff) | |
doc: images: add gv file for pktio state machine
The PktIO FSM state diagram is built using GraphVis. Add the files and
associated Makefile and .gitignore changes needed to support this new
file.
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
Reviewed-by: Christophe Milard <christophe.milard@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.inc | 3 | ||||
| -rw-r--r-- | doc/images/.gitignore | 1 | ||||
| -rw-r--r-- | doc/images/pktio_fsm.gv | 17 | ||||
| -rw-r--r-- | doc/users-guide/Makefile.am | 2 |
4 files changed, 23 insertions, 0 deletions
diff --git a/doc/Makefile.inc b/doc/Makefile.inc index cab528686..86b242751 100644 --- a/doc/Makefile.inc +++ b/doc/Makefile.inc @@ -3,4 +3,7 @@ VPATH=$(top_builddir)/doc/images .msc.svg: mscgen -T svg -i $^ -o $@ +.gv.svg: + dot -T svg $^ -o $@ + ASCIIDOC_FLAGS =-a data-uri -b html5 -a icons -a toc2 -a max-width=55em diff --git a/doc/images/.gitignore b/doc/images/.gitignore index 1647e415d..a19aa7505 100644 --- a/doc/images/.gitignore +++ b/doc/images/.gitignore @@ -1 +1,2 @@ resource_management.svg +pktio_fsm.svg diff --git a/doc/images/pktio_fsm.gv b/doc/images/pktio_fsm.gv new file mode 100644 index 000000000..09199c607 --- /dev/null +++ b/doc/images/pktio_fsm.gv @@ -0,0 +1,17 @@ +digraph pktio_state_machine { + rankdir=LR; + size="9,12"; + node [fontsize=28]; + edge [fontsize=28]; + node [shape=doublecircle]; Unallocated Ready; + node [shape=circle]; + Unallocated -> Unconfigured [label="odp_pktio_open()"]; + Unconfigured -> Unallocated [label="odp_pktio_close()"]; + Unconfigured -> Configured [label="odp_pktin_queue_config()"]; + Unconfigured -> Configured [label="odp_pktout_queue_config()"]; + Configured -> Configured [label="odp_pktin_queue_config()"]; + Configured -> Configured [label="odp_pktout_queue_config()"]; + Configured -> Ready [label="odp_pktio_start()"]; + Ready -> Configured [label="odp_pktio_stop()"]; + Configured -> Unallocated [label="odp_pktio_close()"]; +}
\ No newline at end of file diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am index 4f5b1fe6d..3f8ce3d74 100644 --- a/doc/users-guide/Makefile.am +++ b/doc/users-guide/Makefile.am @@ -11,6 +11,8 @@ IMAGES = $(top_srcdir)/doc/images/overview.svg \ $(top_srcdir)/doc/images/atomic_queue.svg \ $(top_srcdir)/doc/images/ordered_queue.svg +IMAGES += $(top_srcdir)/doc/images/pktio_fsm.svg + if HAVE_MSCGEN IMAGES += $(top_srcdir)/doc/images/resource_management.svg endif |