From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by dpdk.org (Postfix) with ESMTP id B69514CA0 for ; Tue, 12 Mar 2019 21:41:26 +0100 (CET) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x2CKZQLZ007220; Tue, 12 Mar 2019 13:41:26 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=pfpt0818; bh=L84WuFmoy72XrmFh/MPNo7FcqYc2kyiN0GHwnAEAo+w=; b=IYSqLXSvoiYZBQLGiI5HZFxnTFVfb//p/VwE4ke5jJHLJr4ZUrmbZLcsbq6Yr/p6lcPb HV76Tqu4WttQAGwdMDt/41H5fh8kYO1CaYsAL1NVZK+sTUDumF9v05/+z1hQIFmkM9X+ ec72uRb5QSMMvUBECm447ARvGiIGktZFqxhXgT7zg14ubpPvfrC5MO2q9gE9E44I+oLx XcZsGXVZqR9s3akktWxA8lX8yNbUC+6FWOmU/kP0I+dH62QQc/+lAGRz09LLGXnFyMvE W0Ci4ffTbuV9+1xLnCmBzbZGdsXc0gt9EzzxwByby1Sa1q+dgAKiv3H/cuXwOpqGSaDc 4A== Received: from sc-exch02.marvell.com ([199.233.58.182]) by mx0a-0016f401.pphosted.com with ESMTP id 2r69kgtad3-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Tue, 12 Mar 2019 13:41:25 -0700 Received: from SC-EXCH02.marvell.com (10.93.176.82) by SC-EXCH02.marvell.com (10.93.176.82) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Tue, 12 Mar 2019 13:41:14 -0700 Received: from NAM04-CO1-obe.outbound.protection.outlook.com (104.47.45.58) by SC-EXCH02.marvell.com (10.93.176.82) with Microsoft SMTP Server (TLS) id 15.0.1367.3 via Frontend Transport; Tue, 12 Mar 2019 13:41:14 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector1-marvell-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=L84WuFmoy72XrmFh/MPNo7FcqYc2kyiN0GHwnAEAo+w=; b=VR61rOUubo760KNx1YX42HGJO6VZKasUf641q0TuaR6Q5T+/8XSQ+BsyVXCgSySnUzJFoDxAlGOwCWlxtSgQm3zrOX4X/jHShrRQ82xq+MaaB141rUzP3XYlQCUl8SDkr1hCEJlb7J1qYzLWbQgn4pBxeTQOjIRheN4TgqqZU0g= Received: from CY4PR1801MB1863.namprd18.prod.outlook.com (10.171.255.14) by CY4PR1801MB1848.namprd18.prod.outlook.com (10.171.255.11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1686.21; Tue, 12 Mar 2019 20:41:13 +0000 Received: from CY4PR1801MB1863.namprd18.prod.outlook.com ([fe80::286d:5e93:974e:8bfa]) by CY4PR1801MB1863.namprd18.prod.outlook.com ([fe80::286d:5e93:974e:8bfa%2]) with mapi id 15.20.1686.021; Tue, 12 Mar 2019 20:41:13 +0000 From: Pavan Nikhilesh Bhagavatula To: Jerin Jacob Kollanukkaran , "harry.van.haaren@intel.com" , "nikhil.rao@intel.com" , "erik.g.carrillo@intel.com" , "abhinandan.gujjar@intel.com" , "john.mcnamara@intel.com" CC: "dev@dpdk.org" , Pavan Nikhilesh Bhagavatula Thread-Topic: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency Thread-Index: AQHU2RPuISJr0AKp9kejkVBtGVqXVA== Date: Tue, 12 Mar 2019 20:41:13 +0000 Message-ID: <20190312204037.16141-3-pbhagavatula@marvell.com> References: <20190227200019.1085-1-pbhagavatula@marvell.com> <20190312204037.16141-1-pbhagavatula@marvell.com> In-Reply-To: <20190312204037.16141-1-pbhagavatula@marvell.com> Accept-Language: en-IN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-clientproxiedby: MAXPR0101CA0029.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:d::15) To CY4PR1801MB1863.namprd18.prod.outlook.com (2603:10b6:910:7a::14) x-ms-exchange-messagesentrepresentingtype: 1 x-mailer: git-send-email 2.21.0 x-originating-ip: [117.216.244.113] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 89fa0551-30f8-47c4-57ae-08d6a72b10d7 x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(5600127)(711020)(4605104)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(2017052603328)(7153060)(7193020); SRVR:CY4PR1801MB1848; x-ms-traffictypediagnostic: CY4PR1801MB1848: x-microsoft-exchange-diagnostics: =?iso-8859-1?Q?1; CY4PR1801MB1848; 23:AKanqgvP0kuncziGwO5IGlDT6qDVHLfZcX4T2?= =?iso-8859-1?Q?hSMswJyibZZCBnbEM3LUjVd+XGx6evAvR9kB6qyKfc5WpUMEeJubhzUr+w?= =?iso-8859-1?Q?k+49vliPvkGndlRn8Zqy9c86s67CzVDyE8FO0RXaILYj2I4MZsp1YW22VK?= =?iso-8859-1?Q?uxjZbgOy0J6uAFPYaISEulW1Kj7I4YLIDbhCsMxuxDzqc1csOwfFZkK624?= =?iso-8859-1?Q?oV4uhYlzrGkqit5DGmYgzeDZ+2sjy7haIVw2gTQCHm+X444E0okFmdyh6H?= =?iso-8859-1?Q?v2ZxB3fgtHw559YwBHFMf70KtPgGa8CcBXoZkKXnapWMvaGtyrV4mJeIC6?= =?iso-8859-1?Q?fG8CybpPdgt+Mdu7iZa1+5FK0eT9frC9iNYG4zobQ6k0TDQOZ3qW8aJNB6?= =?iso-8859-1?Q?jlAXXRjYzdEVSSvsl9w/UTOSjEVp7cmi0dcXlWr8u9qXF+yzY5lbedam7C?= =?iso-8859-1?Q?1GRRT1j7Qx2NsHeVBRyUttK/IztA6lL9q5AKmo4vvK3DisqnBfont8SaYe?= =?iso-8859-1?Q?eygtZtI4wKq8TUn46ivszI2K5QnB9QDv6GB88++/5jQZoJDLP/pkR/sPzX?= =?iso-8859-1?Q?oCYyJjYwqidH22S/doP5dp67voa/u7SmXERv1bmY13EWecjp8PGxYjXNlN?= =?iso-8859-1?Q?RAflYOfA+yh+26P/9qX4FGL/Tqg4G/fmP1CYXa+QLuB6023XiHXdiPzcdL?= =?iso-8859-1?Q?olNsYliKFom2gJ20vey+zqsOEmw9k7GQXRsf3cgqqD0qGUanmR5aP82wc8?= =?iso-8859-1?Q?qFPYyxTkNuubOlCRwR1V7IcifsHN/dyGtejLH1yG8vc32JXxgqo4PCSBPv?= =?iso-8859-1?Q?B33amFLW0kn5iiAxiA6O5Q/tJ/7TjyemG5PKjbgIjKxEgnP2A0+gBvC93g?= =?iso-8859-1?Q?88n9ORKucwt5v6tklMo7e9/EesZKxKsydYukVIzRHDq+uXuJEhYcSGTgta?= =?iso-8859-1?Q?tW7Q4ksA3kRFvI/JFsQ8QwNKeFVig5Oo3gyInew7fRQYdr0KbhRK8BMKR6?= =?iso-8859-1?Q?WgBMKy8SOLi2fiD5hoodSBhy7SEn1RWTIhpeXMxcPv3z+Jr3aCj7jFNHU3?= =?iso-8859-1?Q?x9llngLAIAGS81lG2dikhddj5j50FhYGyFZgYnM88XePIwkkCeElGkMb1A?= =?iso-8859-1?Q?+AN69IOQ5YPXjdI6bmUwmZzFxSOACg8wvFYREcUVFpUmg/kIP3SS7WK4vX?= =?iso-8859-1?Q?2jDFbLavOJgAFM5rtAVuoTNhOwiCNydEW85vMV+RBhniOKov8QogMQkpiq?= =?iso-8859-1?Q?kWxujuyoH9w6TwsANhi1aaPbaCZIpWK2niXmIxR+kNJszz68wjgFPv09Jd?= =?iso-8859-1?Q?dxuZfVLPtTnb9eaysRxWhKnCmYpjIGUpxM9TwJY5R+kBGryp5Su8FzfqpD?= =?iso-8859-1?Q?XaDSx/Qjjo=3D?= x-microsoft-antispam-prvs: x-forefront-prvs: 09749A275C x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(366004)(39860400002)(396003)(346002)(376002)(136003)(189003)(199004)(55236004)(25786009)(81156014)(3846002)(81166006)(11346002)(486006)(476003)(2616005)(316002)(305945005)(8676002)(68736007)(2501003)(8936002)(7736002)(66066001)(6116002)(446003)(110136005)(54906003)(14444005)(1076003)(186003)(256004)(14454004)(99286004)(106356001)(71200400001)(6506007)(105586002)(52116002)(50226002)(107886003)(2906002)(86362001)(71190400001)(4326008)(102836004)(2201001)(5660300002)(478600001)(76176011)(36756003)(26005)(386003)(6436002)(6512007)(6486002)(97736004)(53936002); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR1801MB1848; H:CY4PR1801MB1863.namprd18.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; received-spf: None (protection.outlook.com: marvell.com does not designate permitted sender hosts) x-ms-exchange-senderadcheck: 1 x-microsoft-antispam-message-info: jMGETyS/WzXZbQn6dZIvvmuPqqos3ASPgX4u9f4iQIizw6TcKHMeLlBkXkJ1v7OwWws3ZYNBPnuq3l/EmvDVwWUzPye4nkTapYKpbVr8+znO8CSQfkEsge3bGItARcLM/nXU0leutOejMkx4iFy02oYJ1Ueu+oNmUaN0QI97Npew4B0OkFJBCznpMuNinJoyY5Q3GR34fB0ohz3ZtaTu+wMaSrbTltvSmtvZ+lohfqr/ikZYluV3zi/o0r6flxPyoK7+8DFl8eHcbMuQBp0WXVs9diUlRMnrS26/nlnwwH+nK3YbzJWeLU9lIO3SDObR01lTXYH0ajkitA/kXHdF6S58RMG+Ee4wrp6P1gpUMObEkPaF1sEzhrVtqz2OADwIGEkuqbdUbmXkuEHDIvjHElD1Ucj8teq93Pbq+XTs26g= Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 89fa0551-30f8-47c4-57ae-08d6a72b10d7 X-MS-Exchange-CrossTenant-originalarrivaltime: 12 Mar 2019 20:41:13.3768 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR1801MB1848 X-OriginatorOrg: marvell.com X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-03-12_12:, , signatures=0 Subject: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 12 Mar 2019 20:41:27 -0000 From: Pavan Nikhilesh EventDev i.e consumer needs to be started before starting the event producers. Update documentation of EventDev and EventDev adapters. Signed-off-by: Pavan Nikhilesh --- v2 Changes: Add Notes to doxygen API. doc/guides/prog_guide/event_crypto_adapter.rst | 5 +++++ doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++ doc/guides/prog_guide/event_timer_adapter.rst | 5 +++++ doc/guides/prog_guide/eventdev.rst | 5 +++++ lib/librte_eventdev/rte_event_crypto_adapter.h | 4 ++++ lib/librte_eventdev/rte_event_eth_rx_adapter.h | 4 ++++ lib/librte_eventdev/rte_event_timer_adapter.h | 4 ++++ 7 files changed, 32 insertions(+) diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst b/doc/guides/pr= og_guide/event_crypto_adapter.rst index 9fe09c805..1e3eb7139 100644 --- a/doc/guides/prog_guide/event_crypto_adapter.rst +++ b/doc/guides/prog_guide/event_crypto_adapter.rst @@ -286,6 +286,11 @@ service function if one exists. rte_event_crypto_adapter_start(id, mode); +.. Note:: + + The eventdev to which the event_crypto_adapter is connected needs= to + be started before calling rte_event_crypto_adapter_start(). + Get adapter statistics ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guid= es/prog_guide/event_ethernet_rx_adapter.rst index 0166bb45d..e95529974 100644 --- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst +++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst @@ -135,6 +135,11 @@ This function calls the start callbacks of the eventde= v PMDs for hardware based eventdev-ethdev connections and ``rte_service_run_state_set()`` to enable = the service function if one exists. +.. Note:: + + The eventdev to which the event_eth_rx_adapter is connected needs= to + be started before calling rte_event_eth_rx_adapter_start(). + Getting Adapter Statistics ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/pro= g_guide/event_timer_adapter.rst index 3b4446ee9..eb195ebd4 100644 --- a/doc/guides/prog_guide/event_timer_adapter.rst +++ b/doc/guides/prog_guide/event_timer_adapter.rst @@ -179,6 +179,11 @@ running the event timer adapter. This function calls t= he start entry points defined by eventdev PMDs for hardware implementations or puts a service component into the running state in the software implementation. +.. Note:: + + The eventdev to which the event_timer_adapter is connected needs = to + be started before calling rte_event_timer_adapter_start(). + Arming Event Timers ~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eve= ntdev.rst index 8fcae5469..dcdfeb75e 100644 --- a/doc/guides/prog_guide/eventdev.rst +++ b/doc/guides/prog_guide/eventdev.rst @@ -296,6 +296,11 @@ eventdev. int err =3D rte_event_dev_start(dev_id); +.. Note:: + + EventDev needs to be started before starting the event producers = such + as event_eth_rx_adapter, event_timer_adapter and event_crypto_ada= pter. + Ingress of New Events ~~~~~~~~~~~~~~~~~~~~~ diff --git a/lib/librte_eventdev/rte_event_crypto_adapter.h b/lib/librte_ev= entdev/rte_event_crypto_adapter.h index d367309cb..a7419e91c 100644 --- a/lib/librte_eventdev/rte_event_crypto_adapter.h +++ b/lib/librte_eventdev/rte_event_crypto_adapter.h @@ -472,6 +472,10 @@ rte_event_crypto_adapter_queue_pair_del(uint8_t id, ui= nt8_t cdev_id, * @return * - 0: Success, adapter started successfully. * - <0: Error code on failure. + * + * @note + * The eventdev to which the event_crypto_adapter is connected needs to + * be started before calling rte_event_crypto_adapter_start(). */ int __rte_experimental rte_event_crypto_adapter_start(uint8_t id); diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.h b/lib/librte_ev= entdev/rte_event_eth_rx_adapter.h index 863b72a10..2314b93f6 100644 --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h @@ -405,6 +405,10 @@ int rte_event_eth_rx_adapter_queue_del(uint8_t id, uin= t16_t eth_dev_id, * @return * - 0: Success, Adapter started correctly. * - <0: Error code on failure. + * + * @note + * The eventdev to which the event_eth_rx_adapter is connected needs to + * be started before calling rte_event_eth_rx_adapter_start(). */ int rte_event_eth_rx_adapter_start(uint8_t id); diff --git a/lib/librte_eventdev/rte_event_timer_adapter.h b/lib/librte_eve= ntdev/rte_event_timer_adapter.h index db98dec46..cc4518d41 100644 --- a/lib/librte_eventdev/rte_event_timer_adapter.h +++ b/lib/librte_eventdev/rte_event_timer_adapter.h @@ -339,6 +339,10 @@ rte_event_timer_adapter_get_info( * - -EINVAL if adapter identifier invalid * - -ENOENT if software adapter but no service core mapped * - -ENOTSUP if software adapter and more than one service core mapped + * + * @note + * The eventdev to which the event_timer_adapter is connected needs to + * be started before calling rte_event_timer_adapter_start(). */ int __rte_experimental rte_event_timer_adapter_start( -- 2.21.0