From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D05FE15AF7 for ; Tue, 15 Aug 2023 17:06:27 +0000 (UTC) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.20]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A11A11737; Tue, 15 Aug 2023 10:06:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1692119186; x=1723655186; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=dotDLlo/a9YsWNlJpXd8Bf3iFLwvIMCiIU+o/OVT2tA=; b=HRLsU2IZSO5iIeCl76TZbNVArSiJqjPg3pslBFiq3yTI3Ksi9tXUCAhk 3nEp+Mp/wwONOsUivxBIZEhVbqEZzLE/JEe94pCpS3yZ1h1S0+jGHEqpu 2nRj2ryhwFFNF+bNTFofCdNlU7KNfrJvMOUCdTRzgbbzla66e3LNn7r/x JnYmf6/7ulHPgrv9Dmk+O4UJck8qLN+XdN8YhCsojg6D6N1fLQldBEDX1 YfjlhKGp9FBk8WV41nQabWZlvPbeYsbwZqY/5nyIE7+v7s52KEUO5/OOL j3fkO31dtl5jmUtH840MZv4jTbx0cPV0BhFJLheVbT2l+GW5yryegmegV w==; X-IronPort-AV: E=McAfee;i="6600,9927,10803"; a="362483565" X-IronPort-AV: E=Sophos;i="6.01,175,1684825200"; d="scan'208";a="362483565" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Aug 2023 10:04:48 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10803"; a="733913263" X-IronPort-AV: E=Sophos;i="6.01,175,1684825200"; d="scan'208";a="733913263" Received: from anguy11-upstream.jf.intel.com ([10.166.9.133]) by orsmga002.jf.intel.com with ESMTP; 15 Aug 2023 10:04:47 -0700 From: Tony Nguyen To: davem@davemloft.net, kuba@kernel.org, pabeni@redhat.com, edumazet@google.com, netdev@vger.kernel.org Cc: Paul M Stillwell Jr , anthony.l.nguyen@intel.com, jacob.e.keller@intel.com, horms@kernel.org, corbet@lwn.net, linux-doc@vger.kernel.org Subject: [PATCH net-next v3 5/5] ice: add documentation for FW logging Date: Tue, 15 Aug 2023 09:57:50 -0700 Message-Id: <20230815165750.2789609-6-anthony.l.nguyen@intel.com> X-Mailer: git-send-email 2.38.1 In-Reply-To: <20230815165750.2789609-1-anthony.l.nguyen@intel.com> References: <20230815165750.2789609-1-anthony.l.nguyen@intel.com> Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF, RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL, SPF_HELO_NONE,SPF_NONE,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net From: Paul M Stillwell Jr Add documentation for FW logging in Documentation/networking/device-drivers/ethernet/intel/ice.rst Signed-off-by: Paul M Stillwell Jr Signed-off-by: Tony Nguyen --- .../device_drivers/ethernet/intel/ice.rst | 117 ++++++++++++++++++ 1 file changed, 117 insertions(+) diff --git a/Documentation/networking/device_drivers/ethernet/intel/ice.rst b/Documentation/networking/device_drivers/ethernet/intel/ice.rst index e4d065c55ea8..3ddef911faaa 100644 --- a/Documentation/networking/device_drivers/ethernet/intel/ice.rst +++ b/Documentation/networking/device_drivers/ethernet/intel/ice.rst @@ -895,6 +895,123 @@ driver writes raw bytes by the GNSS object to the receiver through i2c. Please refer to the hardware GNSS module documentation for configuration details. +Firmware (FW) logging +--------------------- +The driver supports FW logging via the debugfs interface on PF 0 only. In order +for FW logging to work, the NVM must support it. The 'fwlog' file will only get +created in the ice debugfs directory if the NVM supports FW logging. + +Module configuration +~~~~~~~~~~~~~~~~~~~~ +To see the status of FW logging then read the 'fwlog/modules' file like this:: + + # cat /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/modules + +To configure FW logging then write to the 'fwlog/modules' file like this:: + + # echo > /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/modules + +where + +* fwlog_level is a name as described below. Each level includes the + messages from the previous/lower level + + * NONE + * ERROR + * WARNING + * NORMAL + * VERBOSE + +* fwlog_event is a name that represents the module to receive events for. The + module names are + + * GENERAL + * CTRL + * LINK + * LINK_TOPO + * DNL + * I2C + * SDP + * MDIO + * ADMINQ + * HDMA + * LLDP + * DCBX + * DCB + * XLR + * NVM + * AUTH + * VPD + * IOSF + * PARSER + * SW + * SCHEDULER + * TXQ + * RSVD + * POST + * WATCHDOG + * TASK_DISPATCH + * MNG + * SYNCE + * HEALTH + * TSDRV + * PFREG + * MDLVER + * ALL + +The name ALL is special and specifies setting all of the modules to the +specified fwlog_level. + +Example usage to configure the modules:: + + # echo LINK VERBOSE > /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/modules + +Enabling FW log +~~~~~~~~~~~~~~~ +Once the desired modules are configured the user will enable the logging. To do +this the user can write a 1 (enable) or 0 (disable) to 'fwlog/enable'. An +example is:: + + # echo 1 > /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/enable + +Retrieving FW log data +~~~~~~~~~~~~~~~~~~~~~~ +The FW log data can be retrieved by reading from 'fwlog/data'. The user can +write to 'fwlog/data' to clear the data. The data can only be cleared when FW +logging is disabled. The FW log data is a binary file that is sent to Intel and +used to help debug user issues. + +An example to read the data is:: + + # cat /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/data > fwlog.bin + +An example to clear the data is:: + + # echo 0 > /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/data + +Changing how often the log events are sent to the driver +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The driver receives FW log data from the Admin Receive Queue (ARQ). The +frequency that the FW sends the ARQ events can be configured by writing to +'fwlog/resolution'. The range is 1-128 (1 means push every log message, 128 +means push only when the max AQ command buffer is full). The suggested value is +10. The user can see what the value is configured to by reading +'fwlog/resolution'. An example to set the value is:: + + # echo 50 > /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/resolution + +Configuring the number of buffers used to store FW log data +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The driver stores FW log data in a ring within the driver. The default size of +the ring is 256 4K buffers. Some use cases may require more or less data so +the user can change the number of buffers that are allocated for FW log data. +To change the number of buffers write to 'fwlog/nr_buffs'. The value must be a +power of two and between the values 64-512. FW logging must be disabled to +change the value. An example of changing the value is:: + + # echo 128 > /sys/kernel/debug/ice/0000\:18\:00.0/fwlog/nr_buffs + + Performance Optimization ======================== Driver defaults are meant to fit a wide variety of workloads, but if further -- 2.38.1