This patch updates fail-over scheduling mode description.
Signed-off-by: Fan Zhang <roy.fan.zh...@intel.com>
---
doc/guides/cryptodevs/scheduler.rst | 8 ++++++++
doc/guides/rel_notes/release_17_05.rst | 7 +++++++
2 files changed, 15 insertions(+)
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.
diff --git a/doc/guides/rel_notes/release_17_05.rst
b/doc/guides/rel_notes/release_17_05.rst
index 918f483..741f37c 100644
--- a/doc/guides/rel_notes/release_17_05.rst
+++ b/doc/guides/rel_notes/release_17_05.rst
@@ -49,6 +49,13 @@ New Features
sPAPR IOMMU based pci probing enabled for vfio-pci devices.
+* **Added fail-over mode to Cryptodev Scheduler PMD.**
+
+ Fail-over mode is a scheduling mode that works with 2 slaves.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.
+
Resolved Issues
---------------
--
2.7.4
