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

Message ID 1490274162-85053-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 23, 2017, 1:02 p.m. UTC
  This patch updates fail-over scheduling mode description.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
 doc/guides/cryptodevs/scheduler.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Patch

diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst
index 70fb62e..da051ad 100644
--- a/doc/guides/cryptodevs/scheduler.rst
+++ b/doc/guides/cryptodevs/scheduler.rst
@@ -126,3 +126,10 @@  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, primary slave and secondary
+   slave. In this mode, the scheduler will enqueues the incoming crypto op
+   burst to the primary slave. When one or more crypto ops are failed to
+   be enqueued, they then will be enqueued to the secondary slave.