Firmware (FW) log support was added to the ice driver, but that version is no longer supported. There is a newer version of FW logging (v2) that adds more control knobs to get the exact data out of the FW for debugging.
The interface for FW logging is debugfs. This was chosen based on discussions here: https://lore.kernel.org/netdev/20230214180712.53fc8...@kernel.org/ and https://lore.kernel.org/netdev/20231012164033.1069f...@kernel.org/ We talked about using devlink in a variety of ways, but none of those options made any sense for the way the FW reports data. We briefly talked about using ethtool, but that seemed to go by the wayside. Ultimately it seems like using debugfs is the way to go so re-implement the code to use that. FW logging is across all the PFs on the device so restrict the commands to only PF0. If the device supports FW logging then a directory named 'fwlog' will be created under '/sys/kernel/debug/ice/<pci_dev>'. A variety of files will be created to manage the behavior of logging. The following files will be created: - modules/<module> - nr_messages - enable - log_size - data where modules/<module> is used to read/write the log level for a specific module nr_messages is used to determine how many events should be in each message sent to the driver enable is used to start/stop FW logging. This is a boolean value so only 1 or 0 are permissible values log_size is used to configure the amount of memory the driver uses for log data data is used to read/clear the log data Generally there is a lot of data and dumping that data to syslog will result in a loss of data. This causes problems when decoding the data and the user doesn't know that data is missing until later. Instead of dumping the FW log output to syslog use debugfs. This ensures that all the data the driver has gets retrieved correctly. The FW log data is binary data that the FW team decodes to determine what happened in firmware. The binary blob is sent to Intel for decoding. --- v20: - update sscanf call to check return code correctly v19 at: https://lore.kernel.org/intel-wired-lan/20231211172226.110-1-paul.m.stillwell...@intel.com/ v19: - use seq_printf() for outputing module info when reading from 'module' file - replaced code that created argc and argv for handling command line input - remove checks in all the _read() and _write() functions to see if FW logging is supported because the files will not exist if it is not supported - removed warnings on allocation failures or on debugfs file creation failures v18 at: https://lore.kernel.org/intel-wired-lan/20231128232647.114-1-paul.m.stillwell...@intel.com/ v18: - changed the memory allocation from a buffer per ring to a single buffer that gets divided up for each ring - updated the documentation to indicate that FW logging must be disabled to clear the data. also clarified that any value written to the 'data' file will clear the data v17 at: https://lore.kernel.org/intel-wired-lan/20231109003830.154-1-paul.m.stillwell...@intel.com/ v17: - changed the log level configuration from a single file for all modules to a file per module. - changed 'nr_buffs' to 'log_size' because users understand memory sizes better than a number of buffers - changed 'resolution' to 'nr_messages' to better reflect what it represents - updated documentation to reflect these changes v16 at: https://lore.kernel.org/intel-wired-lan/20230823222152.106-1-paul.m.stillwell...@intel.com/ v16: - removed CONFIG_DEBUG_FS wrapper around code because the debugfs calls handle this case already - moved ice_debugfs_exit() call to remove unreachable code issue - minor changes to documentation based on community feedback v15 at: https://lore.kernel.org/intel-wired-lan/20230808224310.127-1-paul.m.stillwell...@intel.com/ v15: - changed PAGE_SIZE to ICE_AQ_MAX_BUF_LEN because PAGE_SIZE can be bigger than 4K v14 at: https://lore.kernel.org/intel-wired-lan/20230713222558.142-1-paul.m.stillwell...@intel.com/ v14: - fixed an issue where 0 was a valid number for 'nr_buffs' - fixed an issue with the output from 'enable' not being a 1 when FW logging was enabled v13 at: https://lore.kernel.org/intel-wired-lan/20230628231402.176-1-paul.m.stillwell...@intel.com/ v13: - moved the enable code out into it's own patch - added linux/vmalloc.h header file in ice_fwlog.c - removed NULL check before freeing ring->data v12 at: https://lore.kernel.org/intel-wired-lan/20230607222443.119-1-paul.m.stillwell...@intel.com/ v12: - re-wrote debugfs code to use individual files for configuration instead of parsing the strings within the driver. - use sysfs_match_string() to parse the 2 values we need for configuring the modules instead of strncmp() - use ring buffers to contain log data instead of a list. this allows for wrapping the data instead of stopping log capture - split documentation into it's own patch v11 at: https://lore.kernel.org/intel-wired-lan/20230313231841.113-1-paul.m.stillwell...@intel.com/ v11: - changed 'events' variable to be u32 instead of unsigned long since the FW expects a 32-bit value. This caused some changes to a few functions that pass 'events' and changed the parsing in debugfs. Also fixed an issue with i386 cross compile where BIT_ULL() was being used incorrectly and causing compiler issues on i386 because the value was larger than the variable. v10 at: https://lore.kernel.org/intel-wired-lan/20230308235102.170-1-paul.m.stillwell...@intel.com/ v10: - updated code to only create 'fwlog' file if FW logging is supported - combined code under single ifdef in header file - removed defines that were not used and added them when the correct patch is applied - added newline between defines and variables in structure - moved include header into alphabetical order at top of file - removed unnecessary casts - updated return statements for more efficient code - changed BIT() to BIT_ULL() to try to fix i386 cross compile issue - fixed RCT issue - added documentation in Documentation/networking/device-drivers/ethernet/intel/ice.rst - updated commit messages appropriately - v9 at: https://lore.kernel.org/intel-wired-lan/20230302215109.124-1-paul.m.stillwell...@intel.com/ v9: - rewrote code to use debugfs instead of devlink v8 at: https://lore.kernel.org/intel-wired-lan/20230124221428.114-1-paul.m.stillwell...@intel.com/ v8: - added vmalloc.h file for correct prototypes - moved code change from patch 5 to patch 3 where it was supposed to be - fixed a style issue v7 at: https://lore.kernel.org/intel-wired-lan/20230120233511.131-1-paul.m.stillwell...@intel.com/ v7: - removed dev_info() in ice_debugfs_command_read() since it wasn't needed - refactored ice_debugfs_command_read() to split the copying of the data and the freeing of the buffers. This allows for better error recovery in case the copy_to_user() fails - changed allocation of fwlog buffers and structure from kernel memory to virtual memory (vmalloc/vzalloc) - fixed a compile bug v6 at: https://lore.kernel.org/intel-wired-lan/20230113222319.111-1-paul.m.stillwell...@intel.com/ v6: - removed cache_cfg() based on feedback - a couple of other minor changes based on feedback v5 at: https://lore.kernel.org/intel-wired-lan/20230111191906.131-1-paul.m.stillwell...@intel.com/ v5: - handle devlink reload path correctly so debugfs directories don't get added twice - fix issue where code wrapped with CONFIG_DEBUG_FS was causing sparc compile issues with multiple defines No v4 cover letter v4: - actually changed the modes in ice.rst for new params v3 at: https://lore.kernel.org/intel-wired-lan/20221217045828.222-1-paul.m.stillwell...@intel.com/ v3: - fixed ice.rst to have proper mode for new params and fixed formatting v2 at: https://lore.kernel.org/intel-wired-lan/20221209232748.189-1-paul.m.stillwell...@intel.com/ v2: - removed some unused admin queue commands - updated copyright in ice_fwlog.[ch] to 2022 - moved defines in structures under the variables and added blank line - removed a couple of unused defines - changed fwlog_support_ena to fwlog_supported to be clearer - consolidated ice_devlink_param_id enum together - changed ice_fwlog_set_support_ena() to ice_fwlog_set_supported() - consolidated return status logic in ice_devlink_fwlog_enabled_set() - pull up functions in ice_fwlog.c where appropriate - add newline for FW Logging Commands comment - changed any new u[8/16] loop variables to int - moved ice_pf_fwlog_deinit() from patch 5 to patch 4 - changed error message to be clearer - updated Documentation/networking/devlink/ice.rst - updated commit messages with examples of devlink commands and using debugfs to get log files v1 at: https://lore.kernel.org/intel-wired-lan/20221128214749.110-1-paul.m.stillwell...@intel.com/ Paul M Stillwell Jr (5): ice: remove FW logging code ice: configure FW logging ice: enable FW logging ice: add ability to read and configure FW log data ice: add documentation for FW logging .../device_drivers/ethernet/intel/ice.rst | 141 ++++ drivers/net/ethernet/intel/ice/Makefile | 4 +- drivers/net/ethernet/intel/ice/ice.h | 9 + .../net/ethernet/intel/ice/ice_adminq_cmd.h | 161 ++-- drivers/net/ethernet/intel/ice/ice_common.c | 219 +----- drivers/net/ethernet/intel/ice/ice_common.h | 1 - drivers/net/ethernet/intel/ice/ice_debugfs.c | 698 ++++++++++++++++++ drivers/net/ethernet/intel/ice/ice_fwlog.c | 470 ++++++++++++ drivers/net/ethernet/intel/ice/ice_fwlog.h | 80 ++ drivers/net/ethernet/intel/ice/ice_main.c | 48 +- drivers/net/ethernet/intel/ice/ice_type.h | 23 +- 11 files changed, 1539 insertions(+), 315 deletions(-) create mode 100644 drivers/net/ethernet/intel/ice/ice_debugfs.c create mode 100644 drivers/net/ethernet/intel/ice/ice_fwlog.c create mode 100644 drivers/net/ethernet/intel/ice/ice_fwlog.h -- 2.35.1 _______________________________________________ Intel-wired-lan mailing list Intel-wired-lan@osuosl.org https://lists.osuosl.org/mailman/listinfo/intel-wired-lan
