This patch updates packet size based scheduling mode description.
Signed-off-by: Fan Zhang <roy.fan.zh...@intel.com>
---
doc/guides/cryptodevs/scheduler.rst | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/doc/guides/cryptodevs/scheduler.rst
b/doc/guides/cryptodevs/scheduler.rst
index 70fb62e..51f2a78 100644
--- a/doc/guides/cryptodevs/scheduler.rst
+++ b/doc/guides/cryptodevs/scheduler.rst
@@ -126,3 +126,17 @@ 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_PKT_SIZE_DISTR:**
+
+ Packet-size based distribution mode, which works with 2 slaves, primary
+ slave and secondary slave, and distribute the enqueued crypto ops to them
+ based on their data lengths. A crypto op will be distributed to the primary
+ slave if its data length equals or bigger than the designated threshold,
+ otherwise it will be handled by the secondary slave.
+
+ A typical usecase of this mode is with QAT cryptodev as primary and a
+ software cryptodev as secondary slave. This may help the application being
+ capable of processing extra crypto workload than what the sole QAT cryptodev
+ can handle, by making use of the available CPU cycles to deal with lesser
+ crypto workloads.
--
2.7.4
