> -----Original Message----- > From: dev [mailto:dev-boun...@dpdk.org] On Behalf Of Nikhil Rao > Sent: Wednesday, October 18, 2017 10:58 AM > To: jerin.ja...@caviumnetworks.com > Cc: dev@dpdk.org > Subject: [dpdk-dev] [PATCH v2] doc: add event eth Rx adapter programmer's > guide > > Add programmer's guide doc to explain the use of the Event Ethernet Rx > Adapter library. > > Signed-off-by: Nikhil Rao <nikhil....@intel.com> > + > +Event Ethernet Rx Adapter Library > +================================= > + > +The DPDK Eventdev API allows the application to use an event driven > +programming model for packet processing. In this model, the application > +polls an event device port for receiving events that reference packets > +instead of polling Rx queues of ethdev ports. Packet transfer between > +ethdev and the event device can be supported in hardware or require a > +software thread to receive packets from the ethdev port using ethdev > +poll mode APIs and enqueue these as events to the event device using > +the eventdev API. Both transfer mechanisms may be present on the same > platform depending on the particular combination of the ethdev and the > event device.
In general the text in paragraphs should be wrapped at 80 chars: http://dpdk.org/doc/guides/contributing/documentation.html#line-length > + > +For SW based packet transfers from ethdev to eventdev, the the adapter s/the the/the/ > +.. code-block:: c > + > + int err; > + uint8_t dev_id; > + struct rte_event_dev_info dev_info; > + struct rte_event_port_conf rx_p_conf; Code in the docs should be indented with spaces not tabs: http://dpdk.org/doc/guides/contributing/documentation.html#whitespace > + > +Querying Adapter Capabilties > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ s/Capabilties/Capabilities/ Also adjust the underline length to match. > +Adding Rx Queues to the Adapter Instance > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > + > +Ethdev Rx queues are added to the instance using the > +rte_event_eth_rx_adapter_queue_add() function. Configuration for the Rx > +queue is passed in using a struct rte_event_eth_rx_adapter_queue_conf > +parameter. Event information for packets from this Rx queue is encoded > +in the ''ev'' field of struct rte_event_eth_rx_adapter_queue_conf. The Probably ''ev'' should be in backquotes: ``ev``. Also all function and struct names in the doc should be in backquotes. http://dpdk.org/doc/guides/contributing/documentation.html#code-and-literal-block-sections Also, could you mark the previous version of this doc as superseded in patchwork: http://dpdk.org/dev/patchwork/project/dpdk/list/?submitter=&state=&q=doc%3A+add+event+eth+Rx+adapter+programmer&archive=&delegate= Thanks, John
