dmadev: clarify visibility of completed jobs

Clarify that once an operation has completed, the output of that
operation is visible to all cores.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>

diff --git a/lib/dmadev/rte_dmadev.h b/lib/dmadev/rte_dmadev.h
index ad9e7a09758f89387040d631798376c8ba93827f..a7081e633c2a752be702c22e8c486f804584016f 100644 (file)
--- a/lib/dmadev/rte_dmadev.h
+++ b/lib/dmadev/rte_dmadev.h
@@ -1001,6 +1001,8 @@ rte_dma_submit(int16_t dev_id, uint16_t vchan)
  * @b EXPERIMENTAL: this API may change without prior notice.
  *
  * Return the number of operations that have been successfully completed.
+ * Once an operation has been reported as completed, the results of that
+ * operation will be visible to all cores on the system.
  *
  * @param dev_id
  *   The identifier of the device.
@@ -1058,6 +1060,8 @@ rte_dma_completed(int16_t dev_id, uint16_t vchan, const uint16_t nb_cpls,
  *
  * Return the number of operations that have been completed, and the operations
  * result may succeed or fail.
+ * Once an operation has been reported as completed successfully, the results of that
+ * operation will be visible to all cores on the system.
  *
  * @param dev_id
  *   The identifier of the device.