[v4,02/12] eventdev: move text on driver internals to proper section

Message ID 20240221103221.933238-3-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series improve eventdev API specification/documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Bruce Richardson Feb. 21, 2024, 10:32 a.m. UTC
  Inside the doxygen introduction text, some internal details of how
eventdev works was mixed in with application-relevant details. Move
these details on probing etc. to the driver-relevant section.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 lib/eventdev/rte_eventdev.h | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)
  

Comments

Pavan Nikhilesh Bhagavatula Feb. 26, 2024, 5:01 a.m. UTC | #1
> Inside the doxygen introduction text, some internal details of how
> eventdev works was mixed in with application-relevant details. Move
> these details on probing etc. to the driver-relevant section.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Pavan Nikhilesh <pbhagavatula@marvell.com>

> ---
>  lib/eventdev/rte_eventdev.h | 32 ++++++++++++++++----------------
>  1 file changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
> index 985286c616..c2782b2e30 100644
> --- a/lib/eventdev/rte_eventdev.h
> +++ b/lib/eventdev/rte_eventdev.h
> @@ -124,22 +124,6 @@
>   * In all functions of the Event API, the Event device is
>   * designated by an integer >= 0 named the device identifier *dev_id*
>   *
> - * At the Event driver level, Event devices are represented by a generic
> - * data structure of type *rte_event_dev*.
> - *
> - * Event devices are dynamically registered during the PCI/SoC device probing
> - * phase performed at EAL initialization time.
> - * When an Event device is being probed, an *rte_event_dev* structure is
> allocated
> - * for it and the event_dev_init() function supplied by the Event driver
> - * is invoked to properly initialize the device.
> - *
> - * The role of the device init function is to reset the device hardware or
> - * to initialize the software event driver implementation.
> - *
> - * If the device init operation is successful, the device is assigned a device
> - * id (dev_id) for application use.
> - * Otherwise, the *rte_event_dev* structure is freed.
> - *
>   * The functions exported by the application Event API to setup a device
>   * must be invoked in the following order:
>   *     - rte_event_dev_configure()
> @@ -175,6 +159,22 @@
>   * Driver-Oriented Event API
>   * -------------------------
>   *
> + * At the Event driver level, Event devices are represented by a generic
> + * data structure of type *rte_event_dev*.
> + *
> + * Event devices are dynamically registered during the PCI/SoC device probing
> + * phase performed at EAL initialization time.
> + * When an Event device is being probed, an *rte_event_dev* structure is
> allocated
> + * for it and the event_dev_init() function supplied by the Event driver
> + * is invoked to properly initialize the device.
> + *
> + * The role of the device init function is to reset the device hardware or
> + * to initialize the software event driver implementation.
> + *
> + * If the device init operation is successful, the device is assigned a device
> + * id (dev_id) for application use.
> + * Otherwise, the *rte_event_dev* structure is freed.
> + *
>   * Each function of the application Event API invokes a specific function
>   * of the PMD that controls the target device designated by its device
>   * identifier.
> --
> 2.40.1
  

Patch

diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h
index 985286c616..c2782b2e30 100644
--- a/lib/eventdev/rte_eventdev.h
+++ b/lib/eventdev/rte_eventdev.h
@@ -124,22 +124,6 @@ 
  * In all functions of the Event API, the Event device is
  * designated by an integer >= 0 named the device identifier *dev_id*
  *
- * At the Event driver level, Event devices are represented by a generic
- * data structure of type *rte_event_dev*.
- *
- * Event devices are dynamically registered during the PCI/SoC device probing
- * phase performed at EAL initialization time.
- * When an Event device is being probed, an *rte_event_dev* structure is allocated
- * for it and the event_dev_init() function supplied by the Event driver
- * is invoked to properly initialize the device.
- *
- * The role of the device init function is to reset the device hardware or
- * to initialize the software event driver implementation.
- *
- * If the device init operation is successful, the device is assigned a device
- * id (dev_id) for application use.
- * Otherwise, the *rte_event_dev* structure is freed.
- *
  * The functions exported by the application Event API to setup a device
  * must be invoked in the following order:
  *     - rte_event_dev_configure()
@@ -175,6 +159,22 @@ 
  * Driver-Oriented Event API
  * -------------------------
  *
+ * At the Event driver level, Event devices are represented by a generic
+ * data structure of type *rte_event_dev*.
+ *
+ * Event devices are dynamically registered during the PCI/SoC device probing
+ * phase performed at EAL initialization time.
+ * When an Event device is being probed, an *rte_event_dev* structure is allocated
+ * for it and the event_dev_init() function supplied by the Event driver
+ * is invoked to properly initialize the device.
+ *
+ * The role of the device init function is to reset the device hardware or
+ * to initialize the software event driver implementation.
+ *
+ * If the device init operation is successful, the device is assigned a device
+ * id (dev_id) for application use.
+ * Otherwise, the *rte_event_dev* structure is freed.
+ *
  * Each function of the application Event API invokes a specific function
  * of the PMD that controls the target device designated by its device
  * identifier.