From patchwork Thu Jan 18 13:45:52 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 135955 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 C99CB438F3; Thu, 18 Jan 2024 14:46:26 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1A87542DA6; Thu, 18 Jan 2024 14:46:17 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.13]) by mails.dpdk.org (Postfix) with ESMTP id 9F87D42D89 for ; Thu, 18 Jan 2024 14:46:15 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1705585576; x=1737121576; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=y2Ve+nG3X8nOWMsHnECp86Z1V/xau0sRwjR7SSfULMo=; b=bTHtxTloQ6LF8vUvnYTOFUi3zBOhTJBm0R/oI+HnX50s5HaySnRR5lHy SZwvjo5Fj3JiC65ITdzJUuRCDmnKyGPUbAzR0mRYUDat3x3n3gXE5Ohif 98q9FMnsK/yYS8DBo04X3kGtdYVjpiSeJDmiKbgJ4O4NHgblFdOb8pVgz BHfwlblV/r7GP0wxsNr1nZ6aXyUv0XLflsSEexfmY9jwaOi5t/FdLIUl1 LU9wbG2u7eGwrIH/ivI8v+wOpAEf8/yygEGpF2UHFhs+fMSKvClm/KXaW YLiYkhTw1XWYRKJufDsCFru3rTb3ZW/IpIRhGfwyx5ZpANa00bj9a8gle g==; X-IronPort-AV: E=McAfee;i="6600,9927,10956"; a="7542773" X-IronPort-AV: E=Sophos;i="6.05,201,1701158400"; d="scan'208";a="7542773" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orvoesa105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 18 Jan 2024 05:46:15 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10956"; a="734274132" X-IronPort-AV: E=Sophos;i="6.05,201,1701158400"; d="scan'208";a="734274132" Received: from silpixa00400957.ir.intel.com (HELO silpixa00401385.ir.intel.com) ([10.237.214.26]) by orsmga003.jf.intel.com with ESMTP; 18 Jan 2024 05:46:13 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Jerin Jacob Subject: [PATCH v1 2/7] eventdev: move text on driver internals to proper section Date: Thu, 18 Jan 2024 13:45:52 +0000 Message-Id: <20240118134557.73172-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20240118134557.73172-1-bruce.richardson@intel.com> References: <20240118134557.73172-1-bruce.richardson@intel.com> MIME-Version: 1.0 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 Inside the doxygen introduction text, some internal details of how eventdev works was mixed in with application-relevant details. Move these details on probing etc. to the driver-relevant section. Signed-off-by: Bruce Richardson --- lib/eventdev/rte_eventdev.h | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/lib/eventdev/rte_eventdev.h b/lib/eventdev/rte_eventdev.h index a36c89c7a4..949e957f1b 100644 --- a/lib/eventdev/rte_eventdev.h +++ b/lib/eventdev/rte_eventdev.h @@ -112,22 +112,6 @@ * In all functions of the Event API, the Event device is * designated by an integer >= 0 named the device identifier *dev_id* * - * At the Event driver level, Event devices are represented by a generic - * data structure of type *rte_event_dev*. - * - * Event devices are dynamically registered during the PCI/SoC device probing - * phase performed at EAL initialization time. - * When an Event device is being probed, an *rte_event_dev* structure is allocated - * for it and the event_dev_init() function supplied by the Event driver - * is invoked to properly initialize the device. - * - * The role of the device init function is to reset the device hardware or - * to initialize the software event driver implementation. - * - * If the device init operation is successful, the device is assigned a device - * id (dev_id) for application use. - * Otherwise, the *rte_event_dev* structure is freed. - * * The functions exported by the application Event API to setup a device * must be invoked in the following order: * - rte_event_dev_configure() @@ -163,6 +147,22 @@ * Driver-Oriented Event API * ------------------------- * + * At the Event driver level, Event devices are represented by a generic + * data structure of type *rte_event_dev*. + * + * Event devices are dynamically registered during the PCI/SoC device probing + * phase performed at EAL initialization time. + * When an Event device is being probed, an *rte_event_dev* structure is allocated + * for it and the event_dev_init() function supplied by the Event driver + * is invoked to properly initialize the device. + * + * The role of the device init function is to reset the device hardware or + * to initialize the software event driver implementation. + * + * If the device init operation is successful, the device is assigned a device + * id (dev_id) for application use. + * Otherwise, the *rte_event_dev* structure is freed. + * * Each function of the application Event API invokes a specific function * of the PMD that controls the target device designated by its device * identifier.