fwupd/plugins/bcm57xx/README.md
Richard Hughes 078beafb2d Add a new internal flag to opt-in to GUID matching
It is far too easy to forget to set FWUPD_DEVICE_FLAG_NO_GUID_MATCHING for new
plugins, and without it it all works really well *until* a user has two devices
of the same type installed at the same time and then one 'disappears' for hard
to explain reasons. Typically we only need it for replug anyway!

Explicitly opt-in to this rarely-required behaviour, with the default to just
use the physical and logical IDs. Also document the update behavior for each
plugin to explain why the flag is being used.

This allows you to have two identical Unifying plugged in without one of them
being hidden from the user, at the same time allowing a HIDRAW<->USB transition
when going to and from bootloader and runtime modes.

This removes the workaround added in 99eb3f06b6.

Fixes https://github.com/fwupd/fwupd/issues/2915
2021-02-25 15:47:25 +00:00

1.2 KiB

BCM57xx Support

Introduction

This plugin updates BCM57xx wired network adaptors from Broadcom using a reverse-engineered flashing protocol. It is designed to be used with the clean-room reimplementation of the BCM5719 firmware found here: https://github.com/meklort/bcm5719-fw

Protocol

BCM57xx devices support a custom com.broadcom.bcm57xx protocol which is implemented as ioctls like ethtool does.

GUID Generation

These devices use the standard PCI instance IDs, for example:

  • PCI\VEN_14E4&DEV_1657
  • PCI\VEN_14E4&DEV_1657&SUBSYS_17AA222E

Update Behavior

The device usually presents in runtime mode, and the firmware is written to the device without disconnecting the working kernel driver. Once complete the APE is reset which may cause a brief link reconnection.

On flash failure the device is nonfunctional, but is recoverable using direct BAR writes, which is typically much slower than updating the device using the kernel driver and the ethtool API.

Vendor ID Security

The vendor ID is set from the PCI vendor, in this instance set to PCI:0x14E4

External interface access

This plugin requires the SIOCETHTOOL ioctl interface.