From patchwork Tue Mar 8 08:38:06 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 63655 Delivered-To: patch@linaro.org Received: by 10.112.199.169 with SMTP id jl9csp1900833lbc; Tue, 8 Mar 2016 00:38:24 -0800 (PST) X-Received: by 10.50.142.7 with SMTP id rs7mr17320080igb.90.1457426303996; Tue, 08 Mar 2016 00:38:23 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id qf2si18143330igb.91.2016.03.08.00.38.23; Tue, 08 Mar 2016 00:38:23 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 274A462F9D; Tue, 8 Mar 2016 08:38:23 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 71BC761795; Tue, 8 Mar 2016 08:38:18 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id E75B36179F; Tue, 8 Mar 2016 08:38:15 +0000 (UTC) Received: from mail-pa0-f43.google.com (mail-pa0-f43.google.com [209.85.220.43]) by lists.linaro.org (Postfix) with ESMTPS id 012D761786 for ; Tue, 8 Mar 2016 08:38:14 +0000 (UTC) Received: by mail-pa0-f43.google.com with SMTP id bj10so7934792pad.2 for ; Tue, 08 Mar 2016 00:38:13 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=DLjTjPC3fep/ICxkDKMrzsTJb4ReBfl0Eli6QS9KZ2E=; b=XB0gh2cyiFxA/8n2n1JcAXL0oadfaNie/PORaVKmFt0vjFHYp9kSfXI3hzksRgURjp Yg2K4J+AePQDHTrMDV5XXp6Ezbwe+D2z0XdqvEePJglbB/j8Od/hXDecUd9U9ZSoU4hZ va/ikQWsq6c3sdc/6Qf7lwuJoSN3LOZQfvVi+B0RS0QgxEoSptW/sFI28GJKI6ITbYHz xIh6eZb5DCBFLmz4VZ1sbXyCAoFMU+I4GF9zYpZtZx2DJZHAQNIY08/PC+KaFtatAmVx FHaVSzOjCiY9SmHWjqoeOz4hBDIZPwOZiY05W3svUShk8zXX6ajvbYuR6PtK8XU9hU8W JDwA== X-Gm-Message-State: AD7BkJJBjAlRs89QtmQSKPsQqrhVXOKj6WyZ40JXbtXDtBmiSZyoNhiWeN/Knw/Q75fESp1Hgr8= X-Received: by 10.66.190.40 with SMTP id gn8mr39442922pac.64.1457426293244; Tue, 08 Mar 2016 00:38:13 -0800 (PST) Received: from Ubuntu15.localdomain (110-170-137-3.static.asianet.co.th. [110.170.137.3]) by smtp.gmail.com with ESMTPSA id lq10sm2994498pab.36.2016.03.08.00.38.11 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 08 Mar 2016 00:38:12 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Tue, 8 Mar 2016 15:38:06 +0700 Message-Id: <1457426288-28538-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCH4 1/3] doc: images: add gv file for pktio state machine X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" 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 Reviewed-by: Christophe Milard --- doc/Makefile.inc | 3 +++ doc/images/.gitignore | 1 + doc/images/pktio_fsm.gv | 17 +++++++++++++++++ doc/users-guide/Makefile.am | 2 ++ 4 files changed, 23 insertions(+) create mode 100644 doc/images/pktio_fsm.gv diff --git a/doc/Makefile.inc b/doc/Makefile.inc index cab5286..86b2427 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 1647e41..a19aa75 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 0000000..09199c6 --- /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 4f5b1fe..3f8ce3d 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