aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBill Fischofer <bill.fischofer@linaro.org>2017-09-20 13:39:26 -0500
committerMaxim Uvarov <maxim.uvarov@linaro.org>2017-12-27 21:41:46 +0300
commit7dfd88da00d0430580ca372d4ef93fa607b34c5c (patch)
tree7dc00ede9b966cc75d1800d3b5e8ba004606ac2b /doc
parentef7d5719af375c7a571995a6e5c3530dbd7b4d18 (diff)
doc: images: add graphviz source for ipsec fsm
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org> Reviewed-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/images/.gitignore1
-rw-r--r--doc/images/ipsec_fsm.gv32
-rw-r--r--doc/users-guide/Makefile.am2
3 files changed, 35 insertions, 0 deletions
diff --git a/doc/images/.gitignore b/doc/images/.gitignore
index 003dbe653..0aa34793f 100644
--- a/doc/images/.gitignore
+++ b/doc/images/.gitignore
@@ -1,4 +1,5 @@
resource_management.svg
+ipsec_fsm.svg
pktio_fsm.svg
timer_fsm.svg
timeout_fsm.svg
diff --git a/doc/images/ipsec_fsm.gv b/doc/images/ipsec_fsm.gv
new file mode 100644
index 000000000..1e78c8b85
--- /dev/null
+++ b/doc/images/ipsec_fsm.gv
@@ -0,0 +1,32 @@
+digraph ipsec_state_machine {
+ rankdir=LR;
+ size="12,12";
+ node [fontsize=28];
+ edge [fontsize=28];
+ node [shape=doublecircle]; Unconfigured Configured SA_Ready SA_Expired;
+ node [shape=circle];
+ Unconfigured -> Configured [label="odp_ipsec_config()"
+ constraint=false];
+ Configured -> SA_Ready [label="odp_ipsec_sa_create()"];
+ SA_Ready -> Disable_Pending [label="odp_ipsec_sa_disable()"];
+ Disable_Pending -> Disable_Check [label="odp_queue_deq()"];
+ Disable_Pending -> Disable_Check [label="odp_schedule()"];
+ SA_Disabled -> Configured [label="odp_ipsec_sa_destroy()"
+ constraint=false];
+ SA_Ready -> Processing [label="odp_ipsec_in_enq()"];
+ SA_Ready -> Processing [label="odp_ipsec_out_enq()"];
+ Processing -> Op_Complete [label="odp_queue_deq()"];
+ Processing -> Op_Complete [label="odp_schedule()"];
+ Op_Complete -> SA_Expired [label="hard limit reached" constraint=false];
+ SA_Ready -> SA_Ready [label="odp_ipsec_in()"];
+ SA_Ready -> SA_Ready [label="odp_ipsec_out()"];
+ SA_Ready -> SA_Ready [label="odp_ipsec_out_inline()"];
+ SA_Ready -> SA_Expired [label="hard limit reached"];
+ Op_Complete -> SA_Ready [label="odp_ipsec_result()"]
+ Op_Complete -> SA_Ready [label="odp_ipsec_status()"]
+ Disable_Check -> SA_Disabled [label="odp_ipsec_status()"
+ constraint=false];
+ Disable_Check -> Disable_Pending [label="odp_ipsec_result()"
+ constraint=false];
+ SA_Expired -> Disable_Pending [label="odp_ipsec_sa_disable()"];
+}
diff --git a/doc/users-guide/Makefile.am b/doc/users-guide/Makefile.am
index e6a44d983..d88d7f9e4 100644
--- a/doc/users-guide/Makefile.am
+++ b/doc/users-guide/Makefile.am
@@ -10,6 +10,7 @@ SRC = users-guide.adoc \
TARGET = users-guide.html
IMAGES = $(IMAGES_DIR)/overview.svg \
$(IMAGES_DIR)/atomic_queue.svg \
+ $(IMAGES_DIR)/ipsec_fsm.svg \
$(IMAGES_DIR)/odp_components.svg \
$(IMAGES_DIR)/ODP-Logo-HQ.svg \
$(IMAGES_DIR)/odp_rx_processing.svg \
@@ -46,6 +47,7 @@ IMAGES += $(IMAGES_DIR)/resource_management.svg
endif
IMAGES_SRCS = \
+ $(IMAGES_DIR)/ipsec_fsm.gv \
$(IMAGES_DIR)/pktio_fsm.gv \
$(IMAGES_DIR)/resource_management.msc \
$(IMAGES_DIR)/timeout_fsm.gv \