From patchwork Wed Feb 27 20:00:43 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pavan Nikhilesh Bhagavatula X-Patchwork-Id: 50551 X-Patchwork-Delegate: jerinj@marvell.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E18C45F36; Wed, 27 Feb 2019 21:01:00 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by dpdk.org (Postfix) with ESMTP id 21FE75F28 for ; Wed, 27 Feb 2019 21:00:57 +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 x1RK0TPo031362; Wed, 27 Feb 2019 12:00:47 -0800 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=M/rQVSEmFdWTrvsgrVHUZRmz3T/vByfbjDGRhGPJSuY=; b=vONeGBS4SKGJaxrgHADJhX/VcXHx7C4/xBYURTs6+nV7SODqndFmdP4Pgu/XTfuALP+B 20M6Pzj5pUQT+Z0gJLKbwIhBMUHJZ8w0UUoe2OHH07Xvoda0HMV9eKhdXFg1xWtn4cSa WzQbYZ1NwcVU6yEM5V3jua7eMQDxFHL4MVlWVAUm0YpL4mOZo/lvcNiFsGbmG+9OagYg 7h8DPma79YGK0i+C0FGcoH0rawkQRIR6imKAhacJlrA8HzhbOInPug70FPgIXDt2pi9s EHROr3UrEH05F4JRqlh/rqU6O7G86sk9wI81D5qIYzT8UczPpJrkv4MeBYemSbPASRZ/ jQ== Received: from sc-exch01.marvell.com ([199.233.58.181]) by mx0a-0016f401.pphosted.com with ESMTP id 2qwt361fdt-6 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Wed, 27 Feb 2019 12:00:47 -0800 Received: from SC-EXCH04.marvell.com (10.93.176.84) by SC-EXCH01.marvell.com (10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Wed, 27 Feb 2019 12:00:44 -0800 Received: from NAM04-CO1-obe.outbound.protection.outlook.com (104.47.45.55) by SC-EXCH04.marvell.com (10.93.176.84) with Microsoft SMTP Server (TLS) id 15.0.1367.3 via Frontend Transport; Wed, 27 Feb 2019 12:00:44 -0800 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=M/rQVSEmFdWTrvsgrVHUZRmz3T/vByfbjDGRhGPJSuY=; b=HdTk4Q7/crNUkHmNe6eVKeYVIpuoBFWAqNgxdj1CucfWg03eLylBAxseuTdh/hqBhnFZ1gsUETUmT6XD4JkTubST14vDZ/+abaOYbpzPfoiYLQA9+yJOul+A20NN4Xx5k+qFOvyoUtcisCA9CxTLrc97ecOK8uYjuyrlccxjTS4= Received: from CY4PR1801MB1863.namprd18.prod.outlook.com (10.171.255.14) by CY4PR1801MB1862.namprd18.prod.outlook.com (10.171.255.13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1665.15; Wed, 27 Feb 2019 20:00:43 +0000 Received: from CY4PR1801MB1863.namprd18.prod.outlook.com ([fe80::51f1:659f:d799:d1ad]) by CY4PR1801MB1863.namprd18.prod.outlook.com ([fe80::51f1:659f:d799:d1ad%4]) with mapi id 15.20.1643.022; Wed, 27 Feb 2019 20:00:43 +0000 From: Pavan Nikhilesh Bhagavatula To: Jerin Jacob Kollanukkaran CC: "john.mcnamara@intel.com" , "dev@dpdk.org" , Pavan Nikhilesh Bhagavatula Thread-Topic: [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev producer consumer dependency Thread-Index: AQHUztcfpEza44qDXkKB7MRzYDVUWg== Date: Wed, 27 Feb 2019 20:00:43 +0000 Message-ID: <20190227200019.1085-2-pbhagavatula@marvell.com> References: <20190227200019.1085-1-pbhagavatula@marvell.com> In-Reply-To: <20190227200019.1085-1-pbhagavatula@marvell.com> Accept-Language: en-IN, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-clientproxiedby: SG2PR04CA0145.apcprd04.prod.outlook.com (2603:1096:3:16::29) 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: [49.205.223.117] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 7bb93e14-e42f-411b-1258-08d69cee417d x-microsoft-antispam: BCL:0; PCL:0; RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600127)(711020)(4605104)(2017052603328)(7153060)(7193020); SRVR:CY4PR1801MB1862; x-ms-traffictypediagnostic: CY4PR1801MB1862: x-microsoft-exchange-diagnostics: =?iso-8859-1?Q?1; CY4PR1801MB1862; 23:e2m/XG0QMLOEWfSOgPokHkFRlJKCQEA76T0p4?= =?iso-8859-1?q?aAJF5+JCXff3eqdYNm9qf5jk7?= =?iso-8859-1?q?qsPkD723FSzIw+kQ9SCDn7MkoXSe4zEfYOd+LDBMDp1A5j38zOB?= =?iso-8859-1?q?0KoESQu0O2w3ojUse3dUQLmCzfsfZ4OgWIl/FUstzh/UcmGoz76?= =?iso-8859-1?q?SgOatd+Oj8jIyPMFDKRF87UXb55Cc3l4eJCA21aZEqhOTPmUcTq?= =?iso-8859-1?q?aMD2Sl672LFP6eh1sucMFN2oHQ/2k0VqYe0weZS3cHMny9NURln?= =?iso-8859-1?q?7anGJnVOUONHcHMn3seP9wG3pjnMKu8uLfk5pUpOPnpZpo4+jUn?= =?iso-8859-1?q?Ab9d8xWASUDUBABQIag8IgI7aUKgWpWFe2WgIItoKF5J+26CDl5?= =?iso-8859-1?q?frJ6gnWFzvUQ8+M7tsuMujIljXjAc/jwcPQFgqWQ6j8gKniQEQa?= =?iso-8859-1?q?uQ4hdPV8lV1bS8/a85RXKXV2Bh4+2Gw2ubCFxOWJ2VeJV4WYcsC?= =?iso-8859-1?q?EFwKU4C8e7h3y91moN8WiGISN4Kl1tdDPrj6j2l1RQ7mxWt7rwM?= =?iso-8859-1?q?fR2QOnLAUrjnZ0m/LrFuHXYK5mATW3foIoInWbWcLlaExQVLYs6?= =?iso-8859-1?q?fwKMgyqOrGD3Y8FlWgXxbRe5FAk9pJheZT7fPWFwA7fOTm8DbiS?= =?iso-8859-1?q?lGcL8VDS9xuBLnt9QqZqmi5eqJ+7HD7AwekOq3Ic3ycI4F2A5IL?= =?iso-8859-1?q?hzqEv6bJw4jQxJ+MvuDYY3Rzqe1TdIYUlB9dxiPsAlnPyuGYlMc?= =?iso-8859-1?q?4MCM/MLR0DWwto+KB6v2lka3ogEuaFONuiC2bLt2QVqjGBsDFTn?= =?iso-8859-1?q?tnPLh7DFnZKGh3zzQPls94KjXLyYdzuy9a8jdrQksCC6nwObhR4?= =?iso-8859-1?q?a3d3R4uxCINQAf3fESnjGiWkOHhDxr4izmyvic1jKf7Iq+GN+79?= =?iso-8859-1?q?6LDVeaPrKfeaPBdVz6U0amq2adsxh2AVsh2NP67AdyJC8ecu8yS?= =?iso-8859-1?q?yOH11vyQ6Esy0K+sT4I5YSQUODsqzJC/O+ddRLn/e95xJptxIOP?= =?iso-8859-1?q?YMj9ylKn5vK/lp0ca0JJODKSk6gN/uKu054y4Zv5xBN2JKvAHjE?= =?iso-8859-1?q?2BJIMU2+vlDyYcxOW6R198XhBpTiA+Gm93cv2qjxZWR3xGTlaZj?= =?iso-8859-1?q?ISxz+wZgDLqw5CO2FXDpDG1/aQ9sbDafWFvxP1HJTGZmxAmetBV?= =?iso-8859-1?q?lliV1o4yJiF/AFhnERS1PVsjS68GpOfWDx++4Sts8RhSnBM8DPj?= =?iso-8859-1?q?R0pHEL0Wo8Kj+8INcKho7jZ8mlFsoWgiObtjy7RXmtOGuXRW6Ph?= =?iso-8859-1?q?dEG3/GcAzYjdRlH/3ooMv1bQggkIwp7JjokoVwnsHBcYf4y6OFh?= =?iso-8859-1?q?P95n0pvt8T/ZhNBhdYO8poxxQwI0LG96ahETg=3D?= x-microsoft-antispam-prvs: x-forefront-prvs: 0961DF5286 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(136003)(39850400004)(396003)(376002)(346002)(366004)(199004)(189003)(6116002)(186003)(6636002)(53936002)(26005)(6512007)(50226002)(6436002)(6486002)(446003)(97736004)(476003)(11346002)(2616005)(71200400001)(25786009)(3846002)(5660300002)(106356001)(71190400001)(105586002)(68736007)(86362001)(305945005)(316002)(8936002)(2906002)(8676002)(478600001)(7736002)(37006003)(14444005)(107886003)(6862004)(256004)(36756003)(81166006)(4326008)(54906003)(78486014)(1076003)(76176011)(99286004)(52116002)(486006)(6506007)(386003)(66066001)(14454004)(102836004)(81156014); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR1801MB1862; H:CY4PR1801MB1863.namprd18.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX: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: CnKOVnVgj/3kjnDjAPCckRni2cwn+g+cmU2JNw/b8knnhtXV3yfFiIXvbxfRyv9NliL+YIV7opyFCzHzW80DZwK+9Uh8o2NzzZhIZKLBlPGDVZ2BXnyFjPgl9yzdaV5Fr99lpMHu9XKBcC6+v+wCcjWolj6gRD76aDNoX5pgyVfhhrBCQCpSiKtshH48ez8QuNsyb+U4e5Qf2ydrFRbNqsa3gcRr2dxcSChflckZr4/lT7uZ2FpvU3HmzysjrYZJ6j4d20SQvShnM4yWcv2ccoM9wZ0StpVdFHah+mIgjluyOzHXzIjGFPD8+v+bBHwEXltqSIHMG+z2ZIAnLMsOrOuOXznkHBHmFRdB8HkqgcjHf/VXT2vm9iqBKTAGv6nd6G5Y26OwtAdU0KKBPlxgG6n2q60U5svw4c38F8HKdwA= MIME-Version: 1.0 X-MS-Exchange-CrossTenant-Network-Message-Id: 7bb93e14-e42f-411b-1258-08d69cee417d X-MS-Exchange-CrossTenant-originalarrivaltime: 27 Feb 2019 20:00:41.2844 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR1801MB1862 X-OriginatorOrg: marvell.com X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-02-27_13:, , signatures=0 X-Proofpoint-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=985 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1902270133 Subject: [dpdk-dev] [PATCH 2/2] doc: add notes regarding 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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 +++++ 4 files changed, 20 insertions(+) diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst b/doc/guides/prog_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/guides/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 eventdev 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/prog_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 the 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/eventdev.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 = 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_adapter. + Ingress of New Events ~~~~~~~~~~~~~~~~~~~~~