[dpdk-dev,v4,3/3] doc: update cryptodev scheduler PMD documentation

Message ID 1490775868-65199-4-git-send-email-roy.fan.zhang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Fan Zhang March 29, 2017, 8:24 a.m. UTC
  This patch updates fail-over scheduling mode description.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
v4:
- Fixed grammer errors in documentation
- Polished documentation

 doc/guides/cryptodevs/scheduler.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

John McNamara March 29, 2017, 9:52 a.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Fan Zhang
> Sent: Wednesday, March 29, 2017 9:24 AM
> To: dev@dpdk.org
> Cc: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Gonzalez
> Monroy, Sergio <sergio.gonzalez.monroy@intel.com>; Doherty, Declan
> <declan.doherty@intel.com>
> Subject: [dpdk-dev] [PATCH v4 3/3] doc: update cryptodev scheduler PMD
> documentation
> 
> This patch updates fail-over scheduling mode description.
> 
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>


Acked-by: John McNamara <john.mcnamara@intel.com>
  

Patch

diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst
index 70fb62e..9f6c477 100644
--- a/doc/guides/cryptodevs/scheduler.rst
+++ b/doc/guides/cryptodevs/scheduler.rst
@@ -126,3 +126,11 @@  operation:
    among its slaves in a round-robin manner. This mode may help to fill
    the throughput gap between the physical core and the existing cryptodevs
    to increase the overall performance.
+
+*   **CDEV_SCHED_MODE_FAILOVER:**
+
+   Fail-over mode, which works with 2 slaves, the primary slave and the
+   secondary slave. In this mode, the scheduler will enqueue the incoming
+   crypto operation burst to the primary slave. When one or more crypto
+   operations fail to be enqueued, then they will be enqueued to the secondary
+   slave.