> Make some textual improvements to the introduction to eventdev and event > devices in the eventdev header file. This text appears in the doxygen > output for the header file, and introduces the key concepts, for > example: events, event devices, queues, ports and scheduling. > > This patch makes the following improvements: > * small textual fixups, e.g. correcting use of singular/plural > * rewrites of some sentences to improve clarity > * using doxygen markdown to split the whole large block up into > sections, thereby making it easier to read. > > No large-scale changes are made, and blocks are not reordered > > Signed-off-by: Bruce Richardson <bruce.richard...@intel.com> >
Acked-by: Pavan Nikhilesh <pbhagavat...@marvell.com> > --- > V4: reworked following review by Jerin > V3: reworked following feedback from Mattias > --- > lib/eventdev/rte_eventdev.h | 140 ++++++++++++++++++++++-------------- > 1 file changed, 86 insertions(+), 54 deletions(-) > > diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h > index 1f99e933c0..985286c616 100644 > --- a/lib/eventdev/rte_eventdev.h > +++ b/lib/eventdev/rte_eventdev.h > @@ -12,25 +12,35 @@ > * @file > * > * RTE Event Device API > - * > - * In a polling model, lcores poll ethdev ports and associated rx queues > - * directly to look for packet. In an event driven model, by contrast, lcores > - * call the scheduler that selects packets for them based on programmer > - * specified criteria. Eventdev library adds support for event driven > - * programming model, which offer applications automatic multicore scaling, > - * dynamic load balancing, pipelining, packet ingress order maintenance and > - * synchronization services to simplify application packet processing. > + * ==================== > + * > + * In a traditional DPDK application model, the application polls Ethdev port > RX > + * queues to look for work, and processing is done in a run-to-completion > manner, > + * after which the packets are transmitted on a Ethdev TX queue. Load is > + * distributed by statically assigning ports and queues to lcores, and NIC > + * receive-side scaling (RSS), or similar, is employed to distribute network > flows > + * (and thus work) on the same port across multiple RX queues. > + * > + * In contrast, in an event-driver model, as supported by this "eventdev" Should be event-driven model. > library, > + * incoming packets (or other input events) are fed into an event device, > which > + * schedules those packets across the available lcores, in accordance with > its > configuration. > + * This event-driven programming model offers applications automatic > multicore scaling, > + * dynamic load balancing, pipelining, packet order maintenance, > synchronization, <snip>
