From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <david.hunt@intel.com>
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
by dpdk.org (Postfix) with ESMTP id 2108F2C74
for <dev@dpdk.org>; Wed, 15 Mar 2017 14:18:54 +0100 (CET)
Received: from orsmga005.jf.intel.com ([10.7.209.41])
by fmsmga105.fm.intel.com with ESMTP; 15 Mar 2017 06:18:54 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.36,168,1486454400"; d="scan'208";a="75672965"
Received: from silpixa00397515.ir.intel.com (HELO
silpixa00397515.ger.corp.intel.com) ([10.237.223.14])
by orsmga005.jf.intel.com with ESMTP; 15 Mar 2017 06:18:53 -0700
From: David Hunt <david.hunt@intel.com>
To: dev@dpdk.org
Cc: bruce.richardson@intel.com,
David Hunt <david.hunt@intel.com>
Date: Wed, 15 Mar 2017 06:19:25 +0000
Message-Id: <1489558767-56329-17-git-send-email-david.hunt@intel.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1489558767-56329-1-git-send-email-david.hunt@intel.com>
References: <1488791433-186137-2-git-send-email-david.hunt@intel.com>
<1489558767-56329-1-git-send-email-david.hunt@intel.com>
Subject: [dpdk-dev] [PATCH v10 16/18] doc: distributor library changes for
new burst API
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 15 Mar 2017 13:18:55 -0000
Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/prog_guide/packet_distrib_lib.rst | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/guides/prog_guide/packet_distrib_lib.rst b/doc/guides/prog_guide/packet_distrib_lib.rst
index b5bdabb..e0adcaa 100644
--- a/doc/guides/prog_guide/packet_distrib_lib.rst
+++ b/doc/guides/prog_guide/packet_distrib_lib.rst
@@ -42,6 +42,9 @@ The model of operation is shown in the diagram below.
Packet Distributor mode of operation
+There are two modes of operation of the API in the distributor Library, one which sends one packet at a time
+to workers using 32-bits for flow_id, and an optiomised mode which sends bursts of up to 8 packets at a time
+to workers, using 15 bits of flow_id. The mode is selected by the type field in the ``rte_distributor_create function``.
Distributor Core Operation
--------------------------
--
2.7.4