From patchwork Fri Apr 7 08:14:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Pavan Nikhilesh Bhagavatula X-Patchwork-Id: 125857 X-Patchwork-Delegate: jerinj@marvell.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D1888428E5; Fri, 7 Apr 2023 10:14:19 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5B44C40E03; Fri, 7 Apr 2023 10:14:19 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id D99D940150 for ; Fri, 7 Apr 2023 10:14:17 +0200 (CEST) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 337601CX009753; Fri, 7 Apr 2023 01:14:17 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=RXefXMCP7urH/9V8qjH9VbYt648Z//Ay3kiPgGS57go=; b=cX+DjgtjJN6iieJK7/AMGImoZR0sQlVuF9rE6jXrjKiMSmD3LFEMpp56RtCrNM7KKI37 yZFhSbKzRxddwcHKhPIiIOiwgUwmUWGjyKUwtySPneK3eAduIvWHTHI1rcKBBZfwPN2H TLBLbIEJc698oAcMdEWcZyJALCjpNj7Q9nUMVhtDpn+Vj9lr95YWpxQYWtF7KiM8i6oG JVN05r0VjRIqr1qoVF1svpvsFk1ADxWIOunSlK8/GV9c6ncXopI+BXVbW+zRMGD2pw1o vnzS8aY50jNFcB9atDtL/rlh+v7hICVl89P5JzqDcBrlQTyKdDLgml00al7e2hGx2AnK uA== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3ptayc8t4r-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Fri, 07 Apr 2023 01:14:17 -0700 Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.48; Fri, 7 Apr 2023 01:14:14 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.48 via Frontend Transport; Fri, 7 Apr 2023 01:14:14 -0700 Received: from MININT-80QBFE8.corp.innovium.com (unknown [10.28.164.122]) by maili.marvell.com (Postfix) with ESMTP id E52813F7043; Fri, 7 Apr 2023 01:14:12 -0700 (PDT) From: To: , Erik Gabriel Carrillo CC: , Pavan Nikhilesh Subject: [PATCH] doc: fix event timer adapter guide Date: Fri, 7 Apr 2023 13:44:10 +0530 Message-ID: <20230407081410.1714-1-pbhagavatula@marvell.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-Proofpoint-ORIG-GUID: B14fVtr0rjW2IejP4v8DOgaHF79h-bKN X-Proofpoint-GUID: B14fVtr0rjW2IejP4v8DOgaHF79h-bKN X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22 definitions=2023-04-07_04,2023-04-06_03,2023-02-09_01 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Pavan Nikhilesh Remove incorrect spec definition from programmers guide, it is applications responsibility to set ev.event_ptr to a valid value. Fixes: 30e7fbd62839 ("doc: add event timer adapter guide") Signed-off-by: Pavan Nikhilesh Acked-by: Erik Gabriel Carrillo --- doc/guides/prog_guide/event_timer_adapter.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst index 2a15ed8f5c..adeddbedfc 100644 --- a/doc/guides/prog_guide/event_timer_adapter.rst +++ b/doc/guides/prog_guide/event_timer_adapter.rst @@ -247,9 +247,7 @@ Note that it is necessary to initialize the event timer state to RTE_EVENT_TIMER_NOT_ARMED. Also note that we have saved a pointer to the ``conn`` object in the timer's event payload. This will allow us to locate the connection object again once we dequeue the timer expiry event from the -event device later. As a convenience, the application may specify no value for -ev.event_ptr, and the adapter will by default set it to point at the event -timer itself. +event device later. Now we can arm the event timer with ``rte_event_timer_arm_burst()``: