ethernet/netronome/nfp.rst

1 .. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
12 - `Overview`_
13 - `Acquiring Firmware`_
20 incorporated in the company's family of Agilio SmartNICs. The SR-IOV
24 Acquiring Firmware
27 The NFP4000 and NFP6000 devices require application specific firmware
28 to function.  Application firmware can be located either on the host file system
29 or in the device flash (if supported by management firmware).
31 Firmware files on the host filesystem contain card type (`AMDA-*` string), media
32 config etc.  They should be placed in `/lib/firmware/netronome` directory to
33 load firmware from the host file system.
35 Firmware for basic NIC operation is available in the upstream
36 `linux-firmware.git` repository.
38 Firmware in NVRAM
39 -----------------
41 Recent versions of management firmware supports loading application
42 firmware from flash when the host driver gets probed.  The firmware loading
45 Devlink or ethtool can be used to update the application firmware on the device
47 command.  Users need to take care to write the correct firmware image for the
53 ------------------------------
56 firmware images targeting different applications.
58 When using application firmware from host, we recommend placing
59 actual firmware files in application-named subdirectories in
60 `/lib/firmware/netronome` and linking the desired files, e.g.::
62     $ tree /lib/firmware/netronome/
63     /lib/firmware/netronome/
65     │   ├── nic_AMDA0081-0001_1x40.nffw
66     │   └── nic_AMDA0081-0001_4x10.nffw
68     │   ├── nic_AMDA0081-0001_1x40.nffw
69     │   └── nic_AMDA0081-0001_4x10.nffw
71     │   ├── nic_AMDA0081-0001_1x40.nffw
72     │   └── nic_AMDA0081-0001_4x10.nffw
73     ├── nic_AMDA0081-0001_1x40.nffw -> bpf/nic_AMDA0081-0001_1x40.nffw
74     └── nic_AMDA0081-0001_4x10.nffw -> bpf/nic_AMDA0081-0001_4x10.nffw
81 After changing firmware files you may need to regenerate the initramfs
82 image.  Initramfs contains drivers and firmware files your system may
85 is system loading wrong driver or firmware on boot, but when driver is
88 Selecting firmware per device
89 -----------------------------
91 Most commonly all cards on the system use the same type of firmware.
92 If you want to load specific firmware image for a specific card, you
96     nfp: Looking for firmware file in order of priority:
97     nfp:  netronome/serial-00-12-34-aa-bb-cc-10-ff.nffw: not found
98     nfp:  netronome/pci-0000:02:00.0.nffw: not found
99     nfp:  netronome/nic_AMDA0081-0001_1x40.nffw: found, loading...
101 In this case if file (or link) called *serial-00-12-34-aa-bb-5d-10-ff.nffw*
102 or *pci-0000:02:00.0.nffw* is present in `/lib/firmware/netronome` this
103 firmware file will take precedence over `nic_AMDA*` files.
105 Note that `serial-*` and `pci-*` files are **not** automatically included
109 Firmware loading policy
110 -----------------------
112 Firmware loading policy is controlled via three HWinfo parameters
116     Defines which firmware should take precedence, 'Disk' (0), 'Flash' (1) or
117     the 'Preferred' (2) firmware. When 'Preferred' is selected, the management
118     firmware makes the decision over which firmware will be loaded by comparing
119     versions of the flash firmware and the host supplied firmware.
124     Defines if the driver should reset the firmware when
125     the driver is probed, either 'Disk' (0) if firmware was found on disk,
126     'Always' (1) reset or 'Never' (2) reset. Note that the device is always
127     reset on driver unload if firmware was loaded when the driver was probed.
138 Following device statistics are available through the ``ethtool -S`` interface:
140 .. flat-table:: NFP device statistics
141    :header-rows: 1
144    * - Name
145      - ID
146      - Meaning
148    * - dev_rx_discards
149      - 1
150      - Packet can be discarded on the RX path for one of the following reasons:
163    * - dev_rx_errors
164      - 2
165      - A packet can be counted (and dropped) as RX error for the following
168        * A problem with the VEB lookup (only when SR-IOV is used).
172    * - dev_rx_bytes
173      - 3
174      - Total number of bytes received.
176    * - dev_rx_uc_bytes
177      - 4
178      - Unicast bytes received.
180    * - dev_rx_mc_bytes
181      - 5
182      - Multicast bytes received.
184    * - dev_rx_bc_bytes
185      - 6
186      - Broadcast bytes received.
188    * - dev_rx_pkts
189      - 7
190      - Total number of packets received.
192    * - dev_rx_mc_pkts
193      - 8
194      - Multicast packets received.
196    * - dev_rx_bc_pkts
197      - 9
198      - Broadcast packets received.
200    * - dev_tx_discards
201      - 10
202      - A packet can be discarded in the TX direction if the MAC is
205    * - dev_tx_errors
206      - 11
207      - A packet can be counted as TX error (and dropped) for one for the
219    * - dev_tx_bytes
220      - 12
221      - Total number of bytes transmitted.
223    * - dev_tx_uc_bytes
224      - 13
225      - Unicast bytes transmitted.
227    * - dev_tx_mc_bytes
228      - 14
229      - Multicast bytes transmitted.
231    * - dev_tx_bc_bytes
232      - 15
233      - Broadcast bytes transmitted.
235    * - dev_tx_pkts
236      - 16
237      - Total number of packets transmitted.
239    * - dev_tx_mc_pkts
240      - 17
241      - Multicast packets transmitted.
243    * - dev_tx_bc_pkts
244      - 18
245      - Broadcast packets transmitted.