i40e.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. .. SPDX-License-Identifier: GPL-2.0
  2. ====================
  3. i40e devlink support
  4. ====================
  5. This document describes the devlink features implemented by the ``i40e``
  6. device driver.
  7. Parameters
  8. ==========
  9. .. list-table:: Generic parameters implemented
  10. :widths: 5 5 90
  11. * - Name
  12. - Mode
  13. - Notes
  14. * - ``max_mac_per_vf``
  15. - runtime
  16. - Controls the maximum number of MAC addresses a VF can use
  17. on i40e devices.
  18. By default (``0``), the driver enforces its internally calculated per-VF
  19. MAC filter limit, which is based on the number of allocated VFS.
  20. If set to a non-zero value, this parameter acts as a strict cap:
  21. the driver will use the user-provided value instead of its internal
  22. calculation.
  23. **Important notes:**
  24. - This value **must be set before enabling SR-IOV**.
  25. Attempting to change it while SR-IOV is enabled will return an error.
  26. - MAC filters are a **shared hardware resource** across all VFs.
  27. Setting a high value may cause other VFs to be starved of filters.
  28. - This value is a **Administrative policy**. The hardware may return
  29. errors when its absolute limit is reached, regardless of the value
  30. set here.
  31. The default value is ``0`` (internal calculation is used).
  32. Info versions
  33. =============
  34. The ``i40e`` driver reports the following versions
  35. .. list-table:: devlink info versions implemented
  36. :widths: 5 5 5 90
  37. * - Name
  38. - Type
  39. - Example
  40. - Description
  41. * - ``board.id``
  42. - fixed
  43. - K15190-000
  44. - The Product Board Assembly (PBA) identifier of the board.
  45. * - ``fw.mgmt``
  46. - running
  47. - 9.130
  48. - 2-digit version number of the management firmware that controls the
  49. PHY, link, etc.
  50. * - ``fw.mgmt.api``
  51. - running
  52. - 1.15
  53. - 2-digit version number of the API exported over the AdminQ by the
  54. management firmware. Used by the driver to identify what commands
  55. are supported.
  56. * - ``fw.mgmt.build``
  57. - running
  58. - 73618
  59. - Build number of the source for the management firmware.
  60. * - ``fw.undi``
  61. - running
  62. - 1.3429.0
  63. - Version of the Option ROM containing the UEFI driver. The version is
  64. reported in ``major.minor.patch`` format. The major version is
  65. incremented whenever a major breaking change occurs, or when the
  66. minor version would overflow. The minor version is incremented for
  67. non-breaking changes and reset to 1 when the major version is
  68. incremented. The patch version is normally 0 but is incremented when
  69. a fix is delivered as a patch against an older base Option ROM.
  70. * - ``fw.psid.api``
  71. - running
  72. - 9.30
  73. - Version defining the format of the flash contents.
  74. * - ``fw.bundle_id``
  75. - running
  76. - 0x8000e5f3
  77. - Unique identifier of the firmware image file that was loaded onto
  78. the device. Also referred to as the EETRACK identifier of the NVM.