| Message ID | 20220104072658.69756-10-marcan@marcan.st (mailing list archive) |
|---|---|
| State | Awaiting Upstream |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | brcmfmac: Support Apple T2 and M1 platforms | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
On Tue, Jan 4, 2022 at 9:28 AM Hector Martin <marcan@marcan.st> wrote: > > On Apple platforms, firmware selection uses the following elements: > > Property Example Source > ============== ======= ======================== > * Chip name 4378 Device ID > * Chip revision B1 OTP > * Platform shikoku DT (ARM64) or ACPI (x86) > * Module type RASP OTP > * Module vendor m OTP > * Module version 6.11 OTP > * Antenna SKU X3 DT (ARM64) or ACPI (x86) > > In macOS, these firmwares are stored using filenames in this format > under /usr/share/firmware/wifi: > > C-4378__s-B1/P-shikoku-X3_M-RASP_V-m__m-6.11.txt > > To prepare firmwares for Linux, we rename these to a scheme following > the existing brcmfmac convention: > > brcmfmac<chip><lower(rev)>-pcie.apple,<platform>-<mod_type>-\ > <mod_vendor>-<mod_version>-<antenna_sku>.txt > > The NVRAM uses all the components, while the firmware and CLM blob only > use the chip/revision/platform/antenna_sku: > > brcmfmac<chip><lower(rev)>-pcie.apple,<platform>-<antenna_sku>.bin > > e.g. > > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11-X3.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-X3.bin > > In addition, since there are over 1000 files in total, many of which are > symlinks or outright duplicates, we deduplicate and prune the firmware > tree to reduce firmware filenames to fewer dimensions. For example, the > shikoku platform (MacBook Air M1 2020) simplifies to just 4 files: > > brcm/brcmfmac4378b1-pcie.apple,shikoku.clm_blob > brcm/brcmfmac4378b1-pcie.apple,shikoku.bin > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-u.txt > > This reduces the total file count to around 170, of which 75 are > symlinks and 95 are regular files: 7 firmware blobs, 27 CLM blobs, and > 61 NVRAM config files. We also slightly process NVRAM files to correct > some formatting issues. > > To handle this, the driver must try the following path formats when > looking for firmware files: > > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11-X3.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-X3.txt * > brcm/brcmfmac4378b1-pcie.apple,shikoku.txt > > * Not relevant for NVRAM, only for firmware/CLM. > > The chip revision nominally comes from OTP on Apple platforms, but it > can be mapped to the PCI revision number, so we ignore the OTP revision > and continue to use the existing PCI revision mechanism to identify chip > revisions, as the driver already does for other chips. Unfortunately, > the mapping is not consistent between different chip types, so this has > to be determined experimentally. ... > + /* Apple platforms with fancy firmware/NVRAM selection */ > + if (devinfo->settings->board_type && > + devinfo->settings->antenna_sku && > + devinfo->otp.valid) { > + char *buf; > + int len; > + > + brcmf_dbg(PCIE, "Apple board: %s\n", > + devinfo->settings->board_type); > + > + /* Example: apple,shikoku-RASP-m-6.11-X3 */ > + len = (strlen(devinfo->settings->board_type) + 1 + > + strlen(devinfo->otp.module) + 1 + > + strlen(devinfo->otp.vendor) + 1 + > + strlen(devinfo->otp.version) + 1 + > + strlen(devinfo->settings->antenna_sku) + 1); NIH devm_kasprrintf() ? > + /* apple,shikoku */ > + fwreq->board_types[5] = devinfo->settings->board_type; > + > + buf = devm_kzalloc(&devinfo->pdev->dev, len, GFP_KERNEL); > + > + strscpy(buf, devinfo->settings->board_type, len); > + strlcat(buf, "-", len); > + strlcat(buf, devinfo->settings->antenna_sku, len); > + /* apple,shikoku-X3 */ > + fwreq->board_types[4] = devm_kstrdup(&devinfo->pdev->dev, buf, > + GFP_KERNEL); > + > + strscpy(buf, devinfo->settings->board_type, len); > + strlcat(buf, "-", len); > + strlcat(buf, devinfo->otp.module, len); > + /* apple,shikoku-RASP */ > + fwreq->board_types[3] = devm_kstrdup(&devinfo->pdev->dev, buf, > + GFP_KERNEL); > + > + strlcat(buf, "-", len); > + strlcat(buf, devinfo->otp.vendor, len); > + /* apple,shikoku-RASP-m */ > + fwreq->board_types[2] = devm_kstrdup(&devinfo->pdev->dev, buf, > + GFP_KERNEL); > + > + strlcat(buf, "-", len); > + strlcat(buf, devinfo->otp.version, len); > + /* apple,shikoku-RASP-m-6.11 */ > + fwreq->board_types[1] = devm_kstrdup(&devinfo->pdev->dev, buf, > + GFP_KERNEL); > + > + strlcat(buf, "-", len); > + strlcat(buf, devinfo->settings->antenna_sku, len); > + /* apple,shikoku-RASP-m-6.11-X3 */ > + fwreq->board_types[0] = buf;
On 04/01/2022 23.24, Andy Shevchenko wrote: > On Tue, Jan 4, 2022 at 9:28 AM Hector Martin <marcan@marcan.st> wrote: >> + /* Example: apple,shikoku-RASP-m-6.11-X3 */ >> + len = (strlen(devinfo->settings->board_type) + 1 + >> + strlen(devinfo->otp.module) + 1 + >> + strlen(devinfo->otp.vendor) + 1 + >> + strlen(devinfo->otp.version) + 1 + >> + strlen(devinfo->settings->antenna_sku) + 1); > > NIH devm_kasprrintf() ? This one builds it incrementally, but you're right, kasprintf is probably more readable here and fewer lines even though it'll duplicate all the previous argument references for each pattern. I'll redo it with devm_kasprintf(). > >> + /* apple,shikoku */ >> + fwreq->board_types[5] = devinfo->settings->board_type; >> + >> + buf = devm_kzalloc(&devinfo->pdev->dev, len, GFP_KERNEL); >> + >> + strscpy(buf, devinfo->settings->board_type, len); >> + strlcat(buf, "-", len); >> + strlcat(buf, devinfo->settings->antenna_sku, len); >> + /* apple,shikoku-X3 */ >> + fwreq->board_types[4] = devm_kstrdup(&devinfo->pdev->dev, buf, >> + GFP_KERNEL); >> + >> + strscpy(buf, devinfo->settings->board_type, len); >> + strlcat(buf, "-", len); >> + strlcat(buf, devinfo->otp.module, len); >> + /* apple,shikoku-RASP */ >> + fwreq->board_types[3] = devm_kstrdup(&devinfo->pdev->dev, buf, >> + GFP_KERNEL); >> + >> + strlcat(buf, "-", len); >> + strlcat(buf, devinfo->otp.vendor, len); >> + /* apple,shikoku-RASP-m */ >> + fwreq->board_types[2] = devm_kstrdup(&devinfo->pdev->dev, buf, >> + GFP_KERNEL); >> + >> + strlcat(buf, "-", len); >> + strlcat(buf, devinfo->otp.version, len); >> + /* apple,shikoku-RASP-m-6.11 */ >> + fwreq->board_types[1] = devm_kstrdup(&devinfo->pdev->dev, buf, >> + GFP_KERNEL); >> + >> + strlcat(buf, "-", len); >> + strlcat(buf, devinfo->settings->antenna_sku, len); >> + /* apple,shikoku-RASP-m-6.11-X3 */ >> + fwreq->board_types[0] = buf; >
On 1/4/2022 8:26 AM, Hector Martin wrote: > On Apple platforms, firmware selection uses the following elements: > > Property Example Source > ============== ======= ======================== > * Chip name 4378 Device ID > * Chip revision B1 OTP > * Platform shikoku DT (ARM64) or ACPI (x86) > * Module type RASP OTP > * Module vendor m OTP > * Module version 6.11 OTP > * Antenna SKU X3 DT (ARM64) or ACPI (x86) > > In macOS, these firmwares are stored using filenames in this format > under /usr/share/firmware/wifi: > > C-4378__s-B1/P-shikoku-X3_M-RASP_V-m__m-6.11.txt > > To prepare firmwares for Linux, we rename these to a scheme following > the existing brcmfmac convention: > > brcmfmac<chip><lower(rev)>-pcie.apple,<platform>-<mod_type>-\ > <mod_vendor>-<mod_version>-<antenna_sku>.txt > > The NVRAM uses all the components, while the firmware and CLM blob only > use the chip/revision/platform/antenna_sku: > > brcmfmac<chip><lower(rev)>-pcie.apple,<platform>-<antenna_sku>.bin > > e.g. > > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11-X3.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-X3.bin > > In addition, since there are over 1000 files in total, many of which are > symlinks or outright duplicates, we deduplicate and prune the firmware > tree to reduce firmware filenames to fewer dimensions. For example, the > shikoku platform (MacBook Air M1 2020) simplifies to just 4 files: > > brcm/brcmfmac4378b1-pcie.apple,shikoku.clm_blob > brcm/brcmfmac4378b1-pcie.apple,shikoku.bin > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-u.txt > > This reduces the total file count to around 170, of which 75 are > symlinks and 95 are regular files: 7 firmware blobs, 27 CLM blobs, and > 61 NVRAM config files. We also slightly process NVRAM files to correct > some formatting issues. > > To handle this, the driver must try the following path formats when > looking for firmware files: > > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11-X3.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP.txt > brcm/brcmfmac4378b1-pcie.apple,shikoku-X3.txt * > brcm/brcmfmac4378b1-pcie.apple,shikoku.txt > > * Not relevant for NVRAM, only for firmware/CLM. > > The chip revision nominally comes from OTP on Apple platforms, but it > can be mapped to the PCI revision number, so we ignore the OTP revision > and continue to use the existing PCI revision mechanism to identify chip > revisions, as the driver already does for other chips. Unfortunately, > the mapping is not consistent between different chip types, so this has > to be determined experimentally. Not sure I understand this. The chip revision comes from the chipcommon register [1]. Maybe that is what you mean by "PCI revision number". For some chips it is possible OTP is used to override that. Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com> > Reviewed-by: Linus Walleij <linus.walleij@linaro.org> > Signed-off-by: Hector Martin <marcan@marcan.st> > --- > .../broadcom/brcm80211/brcmfmac/pcie.c | 58 ++++++++++++++++++- > 1 file changed, 56 insertions(+), 2 deletions(-) > > diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c > index 74c9a4f74813..250e0bd40cb3 100644 > --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c > +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c > @@ -2094,8 +2094,62 @@ brcmf_pcie_prepare_fw_request(struct brcmf_pciedev_info *devinfo) > fwreq->domain_nr = pci_domain_nr(devinfo->pdev->bus) + 1; > fwreq->bus_nr = devinfo->pdev->bus->number; > > - brcmf_dbg(PCIE, "Board: %s\n", devinfo->settings->board_type); > - fwreq->board_types[0] = devinfo->settings->board_type; > + /* Apple platforms with fancy firmware/NVRAM selection */ > + if (devinfo->settings->board_type && > + devinfo->settings->antenna_sku && > + devinfo->otp.valid) { > + char *buf; > + int len; > + > + brcmf_dbg(PCIE, "Apple board: %s\n", > + devinfo->settings->board_type); maybe good to use local reference for devinfo->settings->board_type, which is used several times below. > + > + /* Example: apple,shikoku-RASP-m-6.11-X3 */ > + len = (strlen(devinfo->settings->board_type) + 1 + > + strlen(devinfo->otp.module) + 1 + > + strlen(devinfo->otp.vendor) + 1 + > + strlen(devinfo->otp.version) + 1 + > + strlen(devinfo->settings->antenna_sku) + 1); > + > + /* apple,shikoku */ > + fwreq->board_types[5] = devinfo->settings->board_type; [1] https://elixir.bootlin.com/linux/latest/source/include/linux/bcma/bcma_driver_chipcommon.h#L12
On 09/01/2022 05.03, Arend van Spriel wrote: >> The chip revision nominally comes from OTP on Apple platforms, but it >> can be mapped to the PCI revision number, so we ignore the OTP revision >> and continue to use the existing PCI revision mechanism to identify chip >> revisions, as the driver already does for other chips. Unfortunately, >> the mapping is not consistent between different chip types, so this has >> to be determined experimentally. > > Not sure I understand this. The chip revision comes from the chipcommon > register [1]. Maybe that is what you mean by "PCI revision number". For > some chips it is possible OTP is used to override that. What I mean is the Apple custom OTP segment stores a textual revision number, like "C0". Apple's driver uses this to pick a firmware. There is an ad-hoc mapping between this and the numeric revision (which as you say is present in chipcommon but AFAICT the same number also ends up as the Revision ID in PCI config space). > > Reviewed-by: Arend van Spriel <arend.vanspriel@broadcom.com> >> Reviewed-by: Linus Walleij <linus.walleij@linaro.org> >> Signed-off-by: Hector Martin <marcan@marcan.st> >> --- >> .../broadcom/brcm80211/brcmfmac/pcie.c | 58 ++++++++++++++++++- >> 1 file changed, 56 insertions(+), 2 deletions(-) >> >> diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c >> index 74c9a4f74813..250e0bd40cb3 100644 >> --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c >> +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c >> @@ -2094,8 +2094,62 @@ brcmf_pcie_prepare_fw_request(struct brcmf_pciedev_info *devinfo) >> fwreq->domain_nr = pci_domain_nr(devinfo->pdev->bus) + 1; >> fwreq->bus_nr = devinfo->pdev->bus->number; >> >> - brcmf_dbg(PCIE, "Board: %s\n", devinfo->settings->board_type); >> - fwreq->board_types[0] = devinfo->settings->board_type; >> + /* Apple platforms with fancy firmware/NVRAM selection */ >> + if (devinfo->settings->board_type && >> + devinfo->settings->antenna_sku && >> + devinfo->otp.valid) { >> + char *buf; >> + int len; >> + >> + brcmf_dbg(PCIE, "Apple board: %s\n", >> + devinfo->settings->board_type); > > maybe good to use local reference for devinfo->settings->board_type, > which is used several times below. Yup, and also antenna_sku.
diff --git a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c index 74c9a4f74813..250e0bd40cb3 100644 --- a/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c +++ b/drivers/net/wireless/broadcom/brcm80211/brcmfmac/pcie.c @@ -2094,8 +2094,62 @@ brcmf_pcie_prepare_fw_request(struct brcmf_pciedev_info *devinfo) fwreq->domain_nr = pci_domain_nr(devinfo->pdev->bus) + 1; fwreq->bus_nr = devinfo->pdev->bus->number; - brcmf_dbg(PCIE, "Board: %s\n", devinfo->settings->board_type); - fwreq->board_types[0] = devinfo->settings->board_type; + /* Apple platforms with fancy firmware/NVRAM selection */ + if (devinfo->settings->board_type && + devinfo->settings->antenna_sku && + devinfo->otp.valid) { + char *buf; + int len; + + brcmf_dbg(PCIE, "Apple board: %s\n", + devinfo->settings->board_type); + + /* Example: apple,shikoku-RASP-m-6.11-X3 */ + len = (strlen(devinfo->settings->board_type) + 1 + + strlen(devinfo->otp.module) + 1 + + strlen(devinfo->otp.vendor) + 1 + + strlen(devinfo->otp.version) + 1 + + strlen(devinfo->settings->antenna_sku) + 1); + + /* apple,shikoku */ + fwreq->board_types[5] = devinfo->settings->board_type; + + buf = devm_kzalloc(&devinfo->pdev->dev, len, GFP_KERNEL); + + strscpy(buf, devinfo->settings->board_type, len); + strlcat(buf, "-", len); + strlcat(buf, devinfo->settings->antenna_sku, len); + /* apple,shikoku-X3 */ + fwreq->board_types[4] = devm_kstrdup(&devinfo->pdev->dev, buf, + GFP_KERNEL); + + strscpy(buf, devinfo->settings->board_type, len); + strlcat(buf, "-", len); + strlcat(buf, devinfo->otp.module, len); + /* apple,shikoku-RASP */ + fwreq->board_types[3] = devm_kstrdup(&devinfo->pdev->dev, buf, + GFP_KERNEL); + + strlcat(buf, "-", len); + strlcat(buf, devinfo->otp.vendor, len); + /* apple,shikoku-RASP-m */ + fwreq->board_types[2] = devm_kstrdup(&devinfo->pdev->dev, buf, + GFP_KERNEL); + + strlcat(buf, "-", len); + strlcat(buf, devinfo->otp.version, len); + /* apple,shikoku-RASP-m-6.11 */ + fwreq->board_types[1] = devm_kstrdup(&devinfo->pdev->dev, buf, + GFP_KERNEL); + + strlcat(buf, "-", len); + strlcat(buf, devinfo->settings->antenna_sku, len); + /* apple,shikoku-RASP-m-6.11-X3 */ + fwreq->board_types[0] = buf; + } else { + brcmf_dbg(PCIE, "Board: %s\n", devinfo->settings->board_type); + fwreq->board_types[0] = devinfo->settings->board_type; + } return fwreq; }
On Apple platforms, firmware selection uses the following elements: Property Example Source ============== ======= ======================== * Chip name 4378 Device ID * Chip revision B1 OTP * Platform shikoku DT (ARM64) or ACPI (x86) * Module type RASP OTP * Module vendor m OTP * Module version 6.11 OTP * Antenna SKU X3 DT (ARM64) or ACPI (x86) In macOS, these firmwares are stored using filenames in this format under /usr/share/firmware/wifi: C-4378__s-B1/P-shikoku-X3_M-RASP_V-m__m-6.11.txt To prepare firmwares for Linux, we rename these to a scheme following the existing brcmfmac convention: brcmfmac<chip><lower(rev)>-pcie.apple,<platform>-<mod_type>-\ <mod_vendor>-<mod_version>-<antenna_sku>.txt The NVRAM uses all the components, while the firmware and CLM blob only use the chip/revision/platform/antenna_sku: brcmfmac<chip><lower(rev)>-pcie.apple,<platform>-<antenna_sku>.bin e.g. brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11-X3.txt brcm/brcmfmac4378b1-pcie.apple,shikoku-X3.bin In addition, since there are over 1000 files in total, many of which are symlinks or outright duplicates, we deduplicate and prune the firmware tree to reduce firmware filenames to fewer dimensions. For example, the shikoku platform (MacBook Air M1 2020) simplifies to just 4 files: brcm/brcmfmac4378b1-pcie.apple,shikoku.clm_blob brcm/brcmfmac4378b1-pcie.apple,shikoku.bin brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m.txt brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-u.txt This reduces the total file count to around 170, of which 75 are symlinks and 95 are regular files: 7 firmware blobs, 27 CLM blobs, and 61 NVRAM config files. We also slightly process NVRAM files to correct some formatting issues. To handle this, the driver must try the following path formats when looking for firmware files: brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11-X3.txt brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m-6.11.txt brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP-m.txt brcm/brcmfmac4378b1-pcie.apple,shikoku-RASP.txt brcm/brcmfmac4378b1-pcie.apple,shikoku-X3.txt * brcm/brcmfmac4378b1-pcie.apple,shikoku.txt * Not relevant for NVRAM, only for firmware/CLM. The chip revision nominally comes from OTP on Apple platforms, but it can be mapped to the PCI revision number, so we ignore the OTP revision and continue to use the existing PCI revision mechanism to identify chip revisions, as the driver already does for other chips. Unfortunately, the mapping is not consistent between different chip types, so this has to be determined experimentally. Reviewed-by: Linus Walleij <linus.walleij@linaro.org> Signed-off-by: Hector Martin <marcan@marcan.st> --- .../broadcom/brcm80211/brcmfmac/pcie.c | 58 ++++++++++++++++++- 1 file changed, 56 insertions(+), 2 deletions(-)