X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Feventdevs%2Fsw.rst;h=afdcad7600c060ade490fc3edd88910d0baca9ac;hb=72cf92b318558db98312e49b548aa93e237eded7;hp=b0c984546153bfa56a457a0853ca8fefd6c181a1;hpb=0857b942113874c69dc3db5df11a828ee3cc9b6b;p=dpdk.git diff --git a/doc/guides/eventdevs/sw.rst b/doc/guides/eventdevs/sw.rst index b0c9845461..afdcad7600 100644 --- a/doc/guides/eventdevs/sw.rst +++ b/doc/guides/eventdevs/sw.rst @@ -1,38 +1,14 @@ -.. BSD LICENSE - Copyright(c) 2017 Intel Corporation. All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2017 Intel Corporation. Software Eventdev Poll Mode Driver ================================== The software eventdev is an implementation of the eventdev API, that provides a wide range of the eventdev features. The eventdev relies on a CPU core to -perform event scheduling. +perform event scheduling. This PMD can use the service core library to run the +scheduling function, allowing an application to utilize the power of service +cores to multiplex other work on the same core if required. Features @@ -60,10 +36,10 @@ Configuration and Options The software eventdev is a vdev device, and as such can be created from the application code, or from the EAL command line: -* Call ``rte_eal_vdev_init("event_sw0")`` from the application +* Call ``rte_vdev_init("event_sw0")`` from the application * Use ``--vdev="event_sw0"`` in the EAL options, which will call - rte_eal_vdev_init() internally + rte_vdev_init() internally Example: @@ -76,9 +52,9 @@ Scheduling Quanta ~~~~~~~~~~~~~~~~~ The scheduling quanta sets the number of events that the device attempts to -schedule before returning to the application from the ``rte_event_schedule()`` -function. Note that is a *hint* only, and that fewer or more events may be -scheduled in a given iteration. +schedule in a single schedule call performed by the service core. Note that +is a *hint* only, and that fewer or more events may be scheduled in a given +iteration. The scheduling quanta can be set using a string argument to the vdev create call: @@ -138,10 +114,9 @@ eventdev. Distributed Scheduler ~~~~~~~~~~~~~~~~~~~~~ -The software eventdev is a centralized scheduler, requiring the -``rte_event_schedule()`` function to be called by a CPU core to perform the -required event distribution. This is not really a limitation but rather a -design decision. +The software eventdev is a centralized scheduler, requiring a service core to +perform the required event distribution. This is not really a limitation but +rather a design decision. The ``RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED`` flag is not set in the ``event_dev_cap`` field of the ``rte_event_dev_info`` struct for the software