From patchwork Thu Mar 3 21:27:20 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 63493 Delivered-To: patch@linaro.org Received: by 10.112.199.169 with SMTP id jl9csp129906lbc; Thu, 3 Mar 2016 13:27:53 -0800 (PST) X-Received: by 10.55.75.144 with SMTP id y138mr5954417qka.96.1457040473310; Thu, 03 Mar 2016 13:27:53 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id f89si416932qga.111.2016.03.03.13.27.52; Thu, 03 Mar 2016 13:27:53 -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 82E2A66794; Thu, 3 Mar 2016 21:27:52 +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 358E266789; Thu, 3 Mar 2016 21:27:48 +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 DCAFF6678E; Thu, 3 Mar 2016 21:27:45 +0000 (UTC) Received: from mail-qg0-f47.google.com (mail-qg0-f47.google.com [209.85.192.47]) by lists.linaro.org (Postfix) with ESMTPS id 23C1D6677F for ; Thu, 3 Mar 2016 21:27:45 +0000 (UTC) Received: by mail-qg0-f47.google.com with SMTP id y89so28315648qge.2 for ; Thu, 03 Mar 2016 13:27:45 -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=TfuD30vb0DEhTRGMB+h+JyxcdtBAFeLW2xRHePaw5g8=; b=SCN1oXpWCp5gQ2IhRLo92CsJzg7vrimukZhBI+vgdKor3bF6hQm3AwQpzBhKDNQqZU j8DGEDzS9k4fYHh225r+wfVNC0Zr6mCSrbOQh8gva//OojETpjIWWl9SnW6WA3pvh3SH nX380SiK1W5ksWl+QH87PxKSyuyceSmbC1ijmzRBopaiOt/89PHyAKG3rDL+2r5ahyRP +q/ClRssAzU0QN9CnLWinJxShW1B2d1Z74Pzyua/hTXML0KqCU48ilVzSfWHiYdnUgNS HTSTM7KOja3cUjo+pX/ZxJkmCTC5H0f+7htdLzsz+ZRZHhm/HX/YunwEFzOJ7k32AC20 duIg== X-Gm-Message-State: AD7BkJKSGO0A0Mx0Xp+qje1nMX5jizqSoF5jXm5mUak+cXIhLZniea2yPvR05uyLAdQSTBnlhFM= X-Received: by 10.140.177.71 with SMTP id x68mr6314566qhx.39.1457040464916; Thu, 03 Mar 2016 13:27:44 -0800 (PST) Received: from Ubuntu15.localdomain ([64.88.227.134]) by smtp.gmail.com with ESMTPSA id q198sm200019qhb.16.2016.03.03.13.27.37 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 03 Mar 2016 13:27:43 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 3 Mar 2016 15:27:20 -0600 Message-Id: <1457040442-25227-1-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv3 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 --- 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