From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id A691CA057B for ; Mon, 13 Apr 2020 01:01:00 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 154D42B86; Mon, 13 Apr 2020 01:01:00 +0200 (CEST) Received: from mail.valinux.co.jp (mail.valinux.co.jp [210.128.90.3]) by dpdk.org (Postfix) with ESMTP id 2490D2986 for ; Mon, 13 Apr 2020 01:00:59 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by mail.valinux.co.jp (Postfix) with ESMTP id 4E5AF9F6FC; Mon, 13 Apr 2020 08:00:58 +0900 (JST) X-Virus-Scanned: Debian amavisd-new at valinux.co.jp Received: from mail.valinux.co.jp ([127.0.0.1]) by localhost (mail.valinux.co.jp [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id HA5lYphJN2s8; Mon, 13 Apr 2020 08:00:58 +0900 (JST) Received: from valinux.co.jp (vagw.valinux.co.jp [210.128.90.14]) by mail.valinux.co.jp (Postfix) with ESMTP id 1EDE59FC97; Mon, 13 Apr 2020 08:00:58 +0900 (JST) From: Itsuro Oda To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Mon, 13 Apr 2020 08:00:56 +0900 Message-Id: <20200412230057.28631-3-oda@valinux.co.jp> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200412230057.28631-1-oda@valinux.co.jp> References: <20200412230057.28631-1-oda@valinux.co.jp> Subject: [spp] [PATCH 2/3] docs: add REST API for pipe PMD X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: spp-bounces@dpdk.org Sender: "spp" This patch adds description about REST API for pipe PMD. Signed-off-by: Itsuro Oda --- docs/guides/api_ref/spp_primary.rst | 54 ++++++++++++++++++++++++----- 1 file changed, 46 insertions(+), 8 deletions(-) diff --git a/docs/guides/api_ref/spp_primary.rst b/docs/guides/api_ref/spp_primary.rst index fbf8874..28596cb 100644 --- a/docs/guides/api_ref/spp_primary.rst +++ b/docs/guides/api_ref/spp_primary.rst @@ -41,6 +41,8 @@ Response +------------+-------+----------------------------------------+ | ring_ports | array | Array of statistics of ring ports. | +------------+-------+----------------------------------------+ + | pipes | array | Array of pipe ports. | + +------------+-------+----------------------------------------+ Physical port object. @@ -84,6 +86,23 @@ Ring port object. | tx_drop | integer | The total number of dropped packets of transferred. | +---------+---------+-----------------------------------------------------+ +Pipe port object. + +.. _table_spp_ctl_primary_status_pipe: + +.. table:: Attributes of pipe port of primary status. + + +---------+---------+-----------------------------------------------------+ + | Name | Type | Description | + | | | | + +=========+=========+=====================================================+ + | id | integer | Port ID of the pipe port. | + +---------+---------+-----------------------------------------------------+ + | rx | integer | Port ID of the ring port for rx. | + +---------+---------+-----------------------------------------------------+ + | tx | integer | Port ID of the ring port for tx. | + +---------+---------+-----------------------------------------------------+ + Response example ~~~~~~~~~~~~~~~~ @@ -132,6 +151,13 @@ Response example "tx": 0, "tx_drop": 0 } + ], + "pipes": [ + { + "id": 0, + "rx": 0, + "tx": 1 + } ] } @@ -192,14 +218,18 @@ Request (body) .. table:: Request body params of ports of ``spp_primary``. - +--------+--------+--------------------------------------------------+ - | Name | Type | Description | - | | | | - +========+========+==================================================+ - | action | string | ``add`` or ``del``. | - +--------+--------+--------------------------------------------------+ - | port | string | Resource UID of {port_type}:{port_id}. | - +--------+--------+--------------------------------------------------+ + +--------+--------+---------------------------------------------------------+ + | Name | Type | Description | + | | | | + +========+========+=========================================================+ + | action | string | ``add`` or ``del``. | + +--------+--------+---------------------------------------------------------+ + | port | string | Resource UID of {port_type}:{port_id}. | + +--------+--------+---------------------------------------------------------+ + | rx | string | Rx ring for pipe. It is necessary for adding pipe only. | + +--------+--------+---------------------------------------------------------+ + | tx | string | Tx ring for pipe. It is necessary for adding pipe only. | + +--------+--------+---------------------------------------------------------+ Request example @@ -211,6 +241,14 @@ Request example -d '{"action": "add", "port": "ring:0"}' \ http://127.0.0.1:7777/v1/primary/ports +For adding pipe. + +.. code-block:: console + + $ curl -X PUT -H 'application/json' \ + -d '{"action": "add", "port": "pipe:0", \ + "rx": "ring:0", "tx": "ring:1"}' \ + http://127.0.0.1:7777/v1/primary/ports Response ~~~~~~~~ -- 2.17.0