From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id C4DB8459C8; Thu, 19 Sep 2024 05:15:05 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8DC6640668; Thu, 19 Sep 2024 05:15:05 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.12]) by mails.dpdk.org (Postfix) with ESMTP id 5F35140295 for ; Thu, 19 Sep 2024 05:15:03 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1726715703; x=1758251703; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=7YK2LSr4mbOAVxwmQmj7grkx6F9PWYA4wBRUwbMQF8M=; b=F4W6A1ZOQjgYX72WNim7V9zmMdjeDrseSgIwj4xj3v8LvClT2lPNrMfi MKqBEQF+TtMELLrULAs+AtJE//7wEROWXRAdY+2kvT0q/E1Q3pIBXgZkf Q00y/5PVCj27C+0qZU7LShMcDmaUv931bo9W3eQOt25hbpqYOUHHrA9fm MBwonXq4CuMkwIodtJH3lO17G+5Zppe5z+uA94dD7HRdHnxYAVV5LqMn1 cIA2iHcdAHyB80cb4KsLQ3/CC6ucc16SyyhmbjGUR46tLAY/vCRFsYbtD Ncic6BemMVR9jfCufPgYBcdngWuIDTjIb8CfqUOgWxyJ37sN5SdhHPEDN Q==; X-CSE-ConnectionGUID: hhk3wPoIR0Gyt3AABobgCg== X-CSE-MsgGUID: gnSMw6b1RVm0A8Seql13VA== X-IronPort-AV: E=McAfee;i="6700,10204,11199"; a="29554941" X-IronPort-AV: E=Sophos;i="6.10,240,1719903600"; d="scan'208";a="29554941" Received: from orviesa006.jf.intel.com ([10.64.159.146]) by fmvoesa106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 18 Sep 2024 20:14:59 -0700 X-CSE-ConnectionGUID: J/CHaOyzTFixRhGPMwSVrw== X-CSE-MsgGUID: c2/01KtTRzyvbbw8iPo2lQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.10,240,1719903600"; d="scan'208";a="70078208" Received: from unknown (HELO zhichao-dpdk..) ([10.239.252.103]) by orviesa006-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 18 Sep 2024 20:14:57 -0700 From: Zhichao Zeng To: dev@dpdk.org Cc: bruce.richardson@intel.com, Zhichao Zeng Subject: [PATCH v5] net/ice: support customized search path for DDP package Date: Thu, 19 Sep 2024 11:29:34 +0800 Message-Id: <20240919032934.800979-1-zhichaox.zeng@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240913061537.2077253-1-zhichaox.zeng@intel.com> References: <20240913061537.2077253-1-zhichaox.zeng@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 This patch adds support for customizing firmware search path for DDP package like the kernel behavior, it will read the search path from "/sys/module/firmware_class/parameters/path", and try to load DDP package. Also, updates documentation for loading the DDP package in ice.rst. Signed-off-by: Zhichao Zeng --- v5: update documentation, fix code logic v4: fix CI error v3: update doc, fix code error v2: separate the patch and rewrite the log --- doc/guides/nics/ice.rst | 61 +++++++++++++++++++----------------- drivers/net/ice/ice_ethdev.c | 44 ++++++++++++++++++++++++-- drivers/net/ice/ice_ethdev.h | 1 + 3 files changed, 75 insertions(+), 31 deletions(-) diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index ae975d19ad..1494f70415 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -80,6 +80,38 @@ are listed in the Tested Platforms section of the Release Notes for each release | 24.03 | 1.13.7 | 1.3.35 | 1.3.45 | 1.3.13 | 4.4 | +-----------+---------------+-----------------+-----------+--------------+-----------+ +Dynamic Device Personalization (DDP) package loading +---------------------------------------------------- + +The Intel E810 requires a programmable pipeline package be downloaded +by the driver to support normal operations. The E810 has limited +functionality built in to allow PXE boot and other use cases, but for DPDK use +the driver must download a package file during the driver initialization +stage. + +The default DDP package file name is ``ice.pkg``. For a specific NIC, the +DDP package supposed to be loaded can have a filename: ``ice-xxxxxx.pkg``, +where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For +example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68, +the device-specific DDP package filename is ``ice-00ccbbffffaa0568.pkg`` +(in hex and all low case), please review README from +`Intel® Ethernet 800 Series Dynamic Device Personalization (DDP) for Telecommunication (Comms) Package +`_ +for more information. A symbolic link to the DDP package file is also ok. +The same package file is used by both the kernel driver and the ICE PMD. + +ICE PMD supports using a customized DDP search path. The driver will read +the search path from '/sys/module/firmware_class/parameters/path' +as 'CUSTOMIZED_PATH'. +During initialization, the driver searches in the following paths in order: +'CUSTOMIZED_PATH', '/lib/firmware/updates/intel/ice/ddp' and '/lib/firmware/intel/ice/ddp'. +The device-specific DDP package has a higher loading priority than default DDP package. +The type of loaded package is stored in ``ice_adapter->active_pkg_type``. + + .. Note:: + + Windows support: DDP packages are not supported on Windows. + Configuration ------------- @@ -487,32 +519,3 @@ Usage:: In "brief" mode, all scheduling nodes in the tree are displayed. In "detail" mode, each node's configuration parameters are also displayed. - -Limitations or Known issues ---------------------------- - -The Intel E810 requires a programmable pipeline package be downloaded -by the driver to support normal operations. The E810 has a limited -functionality built in to allow PXE boot and other use cases, but the -driver must download a package file during the driver initialization -stage. - -The default DDP package file name is ice.pkg. For a specific NIC, the -DDP package supposed to be loaded can have a filename: ice-xxxxxx.pkg, -where 'xxxxxx' is the 64-bit PCIe Device Serial Number of the NIC. For -example, if the NIC's device serial number is 00-CC-BB-FF-FF-AA-05-68, -the device-specific DDP package filename is ice-00ccbbffffaa0568.pkg -(in hex and all low case). During initialization, the driver searches -in the following paths in order: /lib/firmware/updates/intel/ice/ddp -and /lib/firmware/intel/ice/ddp. The corresponding device-specific DDP -package will be downloaded first if the file exists. If not, then the -driver tries to load the default package. The type of loaded package -is stored in ``ice_adapter->active_pkg_type``. - -A symbolic link to the DDP package file is also ok. The same package -file is used by both the kernel driver and the DPDK PMD. - - .. Note:: - - Windows support: The DDP package is not supported on Windows so, - loading of the package is disabled on Windows. diff --git a/drivers/net/ice/ice_ethdev.c b/drivers/net/ice/ice_ethdev.c index 304f959b7e..f0389cc4ee 100644 --- a/drivers/net/ice/ice_ethdev.c +++ b/drivers/net/ice/ice_ethdev.c @@ -1873,21 +1873,61 @@ ice_load_pkg_type(struct ice_hw *hw) return package_type; } +static int ice_read_customized_path(char *pkg_file, uint16_t buff_len) +{ + FILE *fp = fopen(ICE_PKG_FILE_CUSTOMIZED_PATH, "r"); + int ret = 0; + + if (fp == NULL) { + PMD_INIT_LOG(INFO, "Failed to read CUSTOMIZED_PATH"); + return -EIO; + } + + if (fgets(pkg_file, buff_len, fp) == NULL) { + ret = -EIO; + goto exit; + } + + if (strlen(pkg_file) <= 1) + goto exit; + + pkg_file[strlen(pkg_file) - 1] = '\0'; +exit: + fclose(fp); + return ret; +} + int ice_load_pkg(struct ice_adapter *adapter, bool use_dsn, uint64_t dsn) { struct ice_hw *hw = &adapter->hw; char pkg_file[ICE_MAX_PKG_FILENAME_SIZE]; + char customized_path[ICE_MAX_PKG_FILENAME_SIZE]; char opt_ddp_filename[ICE_MAX_PKG_FILENAME_SIZE]; void *buf; size_t bufsz; int err; - if (!use_dsn) - goto no_dsn; + ice_read_customized_path(customized_path, ICE_MAX_PKG_FILENAME_SIZE); memset(opt_ddp_filename, 0, ICE_MAX_PKG_FILENAME_SIZE); snprintf(opt_ddp_filename, ICE_MAX_PKG_FILENAME_SIZE, "ice-%016" PRIx64 ".pkg", dsn); + + if (strlen(customized_path) > 1) { + if (use_dsn) { + snprintf(pkg_file, RTE_DIM(pkg_file), + "%s/%s", customized_path, opt_ddp_filename); + if (rte_firmware_read(pkg_file, &buf, &bufsz) == 0) + goto load_fw; + } + snprintf(pkg_file, RTE_DIM(pkg_file), "%s/%s", customized_path, "ice.pkg"); + if (rte_firmware_read(pkg_file, &buf, &bufsz) == 0) + goto load_fw; + } + + if (!use_dsn) + goto no_dsn; + strncpy(pkg_file, ICE_PKG_FILE_SEARCH_PATH_UPDATES, ICE_MAX_PKG_FILENAME_SIZE); strcat(pkg_file, opt_ddp_filename); diff --git a/drivers/net/ice/ice_ethdev.h b/drivers/net/ice/ice_ethdev.h index 3ea9f37dc8..8b644ed700 100644 --- a/drivers/net/ice/ice_ethdev.h +++ b/drivers/net/ice/ice_ethdev.h @@ -51,6 +51,7 @@ #define ICE_PKG_FILE_UPDATES "/lib/firmware/updates/intel/ice/ddp/ice.pkg" #define ICE_PKG_FILE_SEARCH_PATH_DEFAULT "/lib/firmware/intel/ice/ddp/" #define ICE_PKG_FILE_SEARCH_PATH_UPDATES "/lib/firmware/updates/intel/ice/ddp/" +#define ICE_PKG_FILE_CUSTOMIZED_PATH "/sys/module/firmware_class/parameters/path" #define ICE_MAX_PKG_FILENAME_SIZE 256 #define MAX_ACL_NORMAL_ENTRIES 256 -- 2.34.1