[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Peter Korsgaard]

Add firmware (NVRAM data) for the Raspberry Pi 3 and Zero W wifi module.

Notice that linux-firmware provides the main firmware
(brcmfmac43430-sdio.bin), but the module also needs board specific
configuration (NVRAM) data.

For the rpi, this data is available in the RPI firmware-nonfree git repo.
As this repo contains a lot of unrelated data (~70MB), simply download the
single NVRAM file instead of cloning the entire repo.

A similar approach is used by openwrt and opensuse:

https://dev.openwrt.org/browser/trunk/package/firmware/brcmfmac43430-firmware/Makefile?rev=49139
https://build.opensuse.org/package/view_file/hardware/bcm43xx-firmware/bcm43xx-firmware.spec?rev=b1628448b36c85abc9215eab4785ef29

Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
---
 package/Config.in                                |  1 +
 package/rpi-wifi-firmware/Config.in              | 10 ++++++++++
 package/rpi-wifi-firmware/rpi-wifi-firmware.hash |  2 ++
 package/rpi-wifi-firmware/rpi-wifi-firmware.mk   | 22 ++++++++++++++++++++++
 4 files changed, 35 insertions(+)
 create mode 100644 package/rpi-wifi-firmware/Config.in
 create mode 100644 package/rpi-wifi-firmware/rpi-wifi-firmware.hash
 create mode 100644 package/rpi-wifi-firmware/rpi-wifi-firmware.mk

diff --git a/package/Config.in b/package/Config.in
index 1af815086..d57813c5c 100644
--- a/package/Config.in
+++ b/package/Config.in
@@ -348,6 +348,7 @@ menu "Firmware"
 	source "package/linux-firmware/Config.in"
 	source "package/rpi-bt-firmware/Config.in"
 	source "package/rpi-firmware/Config.in"
+	source "package/rpi-wifi-firmware/Config.in"
 	source "package/sunxi-boards/Config.in"
 	source "package/ts4900-fpga/Config.in"
 	source "package/ux500-firmware/Config.in"
diff --git a/package/rpi-wifi-firmware/Config.in b/package/rpi-wifi-firmware/Config.in
new file mode 100644
index 000000000..2c87c7584
--- /dev/null
+++ b/package/rpi-wifi-firmware/Config.in
@@ -0,0 +1,10 @@
+config BR2_PACKAGE_RPI_WIFI_FIRMWARE
+	bool "rpi-wifi-firmware"
+	depends on BR2_arm || BR2_aarch64
+	select BR2_PACKAGE_LINUX_FIRMWARE
+	select BR2_PACKAGE_LINUX_FIRMWARE_BRCM_BCM43XXX # runtime
+	help
+	  Raspberry Pi 3 and Zero W Broadcom BCM43430 wifi module
+	  NVRAM data.
+
+	  https://github.com/RPi-Distro/firmware-nonfree/
diff --git a/package/rpi-wifi-firmware/rpi-wifi-firmware.hash b/package/rpi-wifi-firmware/rpi-wifi-firmware.hash
new file mode 100644
index 000000000..c20506536
--- /dev/null
+++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.hash
@@ -0,0 +1,2 @@
+# Locally calculated
+sha256  872fde4f9942d9aba805880d6eaddfe050305626fd58ad955bfe77c04f6b75a5  brcmfmac43430-sdio.txt
diff --git a/package/rpi-wifi-firmware/rpi-wifi-firmware.mk b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
new file mode 100644
index 000000000..e90864fae
--- /dev/null
+++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
@@ -0,0 +1,22 @@
+################################################################################
+#
+# rpi-wifi-firmware
+#
+################################################################################
+
+RPI_WIFI_FIRMWARE_VERSION = 54bab3d6a6d43239c71d26464e6e10e5067ffea7
+# brcmfmac43430-sdio.bin comes from linux-firmware
+RPI_WIFI_FIRMWARE_SOURCE = brcmfmac43430-sdio.txt
+# git repo contains a lot of unrelated files
+RPI_WIFI_FIRMWARE_SITE = https://raw.githubusercontent.com/RPi-Distro/firmware-nonfree/$(RPI_WIFI_FIRMWARE_VERSION)/brcm80211/brcm
+
+define RPI_WIFI_FIRMWARE_EXTRACT_CMDS
+	cp $(DL_DIR)/$($(PKG)_SOURCE) $(@D)/
+endef
+
+define RPI_WIFI_FIRMWARE_INSTALL_TARGET_CMDS
+	$(INSTALL) -D -m 0644 $(@D)/$(RPI_WIFI_FIRMWARE_SOURCE) \
+		$(TARGET_DIR)/lib/firmware/brcm/$(RPI_WIFI_FIRMWARE_SOURCE)
+endef
+
+$(eval $(generic-package))
-- 
2.11.0

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Yann E. MORIN]

Peter, All,

On 2017-05-05 20:37 +0200, Peter Korsgaard spake thusly:
> Add firmware (NVRAM data) for the Raspberry Pi 3 and Zero W wifi module.
> 
> Notice that linux-firmware provides the main firmware
> (brcmfmac43430-sdio.bin), but the module also needs board specific
> configuration (NVRAM) data.
> 
> For the rpi, this data is available in the RPI firmware-nonfree git repo.
> As this repo contains a lot of unrelated data (~70MB), simply download the
> single NVRAM file instead of cloning the entire repo.
> 
> A similar approach is used by openwrt and opensuse:
> 
> https://dev.openwrt.org/browser/trunk/package/firmware/brcmfmac43430-firmware/Makefile?rev=49139
> https://build.opensuse.org/package/view_file/hardware/bcm43xx-firmware/bcm43xx-firmware.spec?rev=b1628448b36c85abc9215eab4785ef29
> 
> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
[--SNIP--]
> diff --git a/package/rpi-wifi-firmware/Config.in b/package/rpi-wifi-firmware/Config.in
> new file mode 100644
> index 000000000..2c87c7584
> --- /dev/null
> +++ b/package/rpi-wifi-firmware/Config.in
> @@ -0,0 +1,10 @@
> +config BR2_PACKAGE_RPI_WIFI_FIRMWARE
> +	bool "rpi-wifi-firmware"
> +	depends on BR2_arm || BR2_aarch64

I know it read "rpi-wifi-firmware" and thus it is arm or aarch64. But
can we expect the same chip to be used on a non-arm board?

I would just drop the architecture dependency here, because there is
nothing specific to the SoC here; the WiFi chip is a secondary chip, so
could well be present on other boards that are non-arm.

> +	select BR2_PACKAGE_LINUX_FIRMWARE
> +	select BR2_PACKAGE_LINUX_FIRMWARE_BRCM_BCM43XXX # runtime
> +	help
> +	  Raspberry Pi 3 and Zero W Broadcom BCM43430 wifi module
> +	  NVRAM data.
> +
> +	  https://github.com/RPi-Distro/firmware-nonfree/
> diff --git a/package/rpi-wifi-firmware/rpi-wifi-firmware.hash b/package/rpi-wifi-firmware/rpi-wifi-firmware.hash
> new file mode 100644
> index 000000000..c20506536
> --- /dev/null
> +++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.hash
> @@ -0,0 +1,2 @@
> +# Locally calculated
> +sha256  872fde4f9942d9aba805880d6eaddfe050305626fd58ad955bfe77c04f6b75a5  brcmfmac43430-sdio.txt
> diff --git a/package/rpi-wifi-firmware/rpi-wifi-firmware.mk b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
> new file mode 100644
> index 000000000..e90864fae
> --- /dev/null
> +++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
> @@ -0,0 +1,22 @@
> +################################################################################
> +#
> +# rpi-wifi-firmware
> +#
> +################################################################################
> +
> +RPI_WIFI_FIRMWARE_VERSION = 54bab3d6a6d43239c71d26464e6e10e5067ffea7
> +# brcmfmac43430-sdio.bin comes from linux-firmware
> +RPI_WIFI_FIRMWARE_SOURCE = brcmfmac43430-sdio.txt
> +# git repo contains a lot of unrelated files
> +RPI_WIFI_FIRMWARE_SITE = https://raw.githubusercontent.com/RPi-Distro/firmware-nonfree/$(RPI_WIFI_FIRMWARE_VERSION)/brcm80211/brcm

License?

Regards,
Yann E. MORIN.

> +define RPI_WIFI_FIRMWARE_EXTRACT_CMDS
> +	cp $(DL_DIR)/$($(PKG)_SOURCE) $(@D)/
> +endef
> +
> +define RPI_WIFI_FIRMWARE_INSTALL_TARGET_CMDS
> +	$(INSTALL) -D -m 0644 $(@D)/$(RPI_WIFI_FIRMWARE_SOURCE) \
> +		$(TARGET_DIR)/lib/firmware/brcm/$(RPI_WIFI_FIRMWARE_SOURCE)
> +endef
> +
> +$(eval $(generic-package))
> -- 
> 2.11.0
> 
> _______________________________________________
> buildroot mailing list
> buildroot at busybox.net
> http://lists.busybox.net/mailman/listinfo/buildroot

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Peter Korsgaard]

>>>>> "Yann" == Yann E MORIN <yann.morin.1998@free.fr> writes:

 > Peter, All,
 > On 2017-05-05 20:37 +0200, Peter Korsgaard spake thusly:
 >> Add firmware (NVRAM data) for the Raspberry Pi 3 and Zero W wifi module.
 >> 
 >> Notice that linux-firmware provides the main firmware
 >> (brcmfmac43430-sdio.bin), but the module also needs board specific
 >> configuration (NVRAM) data.
 >> 
 >> For the rpi, this data is available in the RPI firmware-nonfree git repo.
 >> As this repo contains a lot of unrelated data (~70MB), simply download the
 >> single NVRAM file instead of cloning the entire repo.
 >> 
 >> A similar approach is used by openwrt and opensuse:
 >> 
 >> https://dev.openwrt.org/browser/trunk/package/firmware/brcmfmac43430-firmware/Makefile?rev=49139
 >> https://build.opensuse.org/package/view_file/hardware/bcm43xx-firmware/bcm43xx-firmware.spec?rev=b1628448b36c85abc9215eab4785ef29
 >> 
 >> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
 > [--SNIP--]
 >> diff --git a/package/rpi-wifi-firmware/Config.in b/package/rpi-wifi-firmware/Config.in
 >> new file mode 100644
 >> index 000000000..2c87c7584
 >> --- /dev/null
 >> +++ b/package/rpi-wifi-firmware/Config.in
 >> @@ -0,0 +1,10 @@
 >> +config BR2_PACKAGE_RPI_WIFI_FIRMWARE
 >> +	bool "rpi-wifi-firmware"
 >> +	depends on BR2_arm || BR2_aarch64

 > I know it read "rpi-wifi-firmware" and thus it is arm or aarch64. But
 > can we expect the same chip to be used on a non-arm board?

Posssibly, yes - But then with different nvram settings. See the
opensuse link above for how they handle rpi + a few sunxi boards.


 > I would just drop the architecture dependency here, because there is
 > nothing specific to the SoC here; the WiFi chip is a secondary chip, so
 > could well be present on other boards that are non-arm.

I disagree. I haven't found any detailed documentation, but my
understanding is that this nvram data is board(-family) specific,
E.G. it differs between the sunxi boards. From what I could find, the
rpi0-w uses the same nvram file as rpi3 though.


 >> +++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
 >> @@ -0,0 +1,22 @@
 >> +################################################################################
 >> +#
 >> +# rpi-wifi-firmware
 >> +#
 >> +################################################################################
 >> +
 >> +RPI_WIFI_FIRMWARE_VERSION = 54bab3d6a6d43239c71d26464e6e10e5067ffea7
 >> +# brcmfmac43430-sdio.bin comes from linux-firmware
 >> +RPI_WIFI_FIRMWARE_SOURCE = brcmfmac43430-sdio.txt
 >> +# git repo contains a lot of unrelated files
 >> +RPI_WIFI_FIRMWARE_SITE =
 >> https://raw.githubusercontent.com/RPi-Distro/firmware-nonfree/$(RPI_WIFI_FIRMWARE_VERSION)/brcm80211/brcm

 > License?

Yeah, that's where things get complicated. There is no explicit license
given. The other brcm*bin files in linux-firmware are covered by
LICENCE.broadcom_bcm43xx, but the question is if this also applies to
this nvram file.

Maybe we should just do:

RPI_WIFI_FIRMWARE_LICENSE = PROPRIETARY

Like we do for the bluetooth part.

-- 
Bye, Peter Korsgaard

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Yann E. MORIN]

Peter, All,

On 2017-05-06 10:50 +0200, Peter Korsgaard spake thusly:
> >>>>> "Yann" == Yann E MORIN <yann.morin.1998@free.fr> writes:
> 
>  > Peter, All,
>  > On 2017-05-05 20:37 +0200, Peter Korsgaard spake thusly:
>  >> Add firmware (NVRAM data) for the Raspberry Pi 3 and Zero W wifi module.
>  >> 
>  >> Notice that linux-firmware provides the main firmware
>  >> (brcmfmac43430-sdio.bin), but the module also needs board specific
>  >> configuration (NVRAM) data.
>  >> 
>  >> For the rpi, this data is available in the RPI firmware-nonfree git repo.
>  >> As this repo contains a lot of unrelated data (~70MB), simply download the
>  >> single NVRAM file instead of cloning the entire repo.
>  >> 
>  >> A similar approach is used by openwrt and opensuse:
>  >> 
>  >> https://dev.openwrt.org/browser/trunk/package/firmware/brcmfmac43430-firmware/Makefile?rev=49139
>  >> https://build.opensuse.org/package/view_file/hardware/bcm43xx-firmware/bcm43xx-firmware.spec?rev=b1628448b36c85abc9215eab4785ef29
>  >> 
>  >> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
>  > [--SNIP--]
>  >> diff --git a/package/rpi-wifi-firmware/Config.in b/package/rpi-wifi-firmware/Config.in
>  >> new file mode 100644
>  >> index 000000000..2c87c7584
>  >> --- /dev/null
>  >> +++ b/package/rpi-wifi-firmware/Config.in
>  >> @@ -0,0 +1,10 @@
>  >> +config BR2_PACKAGE_RPI_WIFI_FIRMWARE
>  >> +	bool "rpi-wifi-firmware"
>  >> +	depends on BR2_arm || BR2_aarch64
> 
>  > I know it read "rpi-wifi-firmware" and thus it is arm or aarch64. But
>  > can we expect the same chip to be used on a non-arm board?
> 
> Posssibly, yes - But then with different nvram settings. See the
> opensuse link above for how they handle rpi + a few sunxi boards.
> 
> 
>  > I would just drop the architecture dependency here, because there is
>  > nothing specific to the SoC here; the WiFi chip is a secondary chip, so
>  > could well be present on other boards that are non-arm.
> 
> I disagree. I haven't found any detailed documentation, but my
> understanding is that this nvram data is board(-family) specific,
> E.G. it differs between the sunxi boards. From what I could find, the
> rpi0-w uses the same nvram file as rpi3 though.

If it is (familly-of-)board-specific then keep the dependency, then.

>  >> +++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
>  >> @@ -0,0 +1,22 @@
>  >> +################################################################################
>  >> +#
>  >> +# rpi-wifi-firmware
>  >> +#
>  >> +################################################################################
>  >> +
>  >> +RPI_WIFI_FIRMWARE_VERSION = 54bab3d6a6d43239c71d26464e6e10e5067ffea7
>  >> +# brcmfmac43430-sdio.bin comes from linux-firmware
>  >> +RPI_WIFI_FIRMWARE_SOURCE = brcmfmac43430-sdio.txt
>  >> +# git repo contains a lot of unrelated files
>  >> +RPI_WIFI_FIRMWARE_SITE =
>  >> https://raw.githubusercontent.com/RPi-Distro/firmware-nonfree/$(RPI_WIFI_FIRMWARE_VERSION)/brcm80211/brcm
> 
>  > License?
> 
> Yeah, that's where things get complicated. There is no explicit license
> given. The other brcm*bin files in linux-firmware are covered by
> LICENCE.broadcom_bcm43xx, but the question is if this also applies to
> this nvram file.
> 
> Maybe we should just do:
> 
> RPI_WIFI_FIRMWARE_LICENSE = PROPRIETARY
> 
> Like we do for the bluetooth part.

The OpenSUSE link you pointed above states:

    # From
    # https://github.com/raspberrypi/linux/issues/1325#issuecomment-195560582
    # Phil Elwell (Raspberry Pi Foundation) wrote: "Broadcom have said that
    # the firmware files for the BCM43438 are covered under this licence:"
    Source0:
    https://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/plain/LICENCE.broadcom_bcm43xx

BTW, I love the way they force local names to be board-specific.

Regards,
Yann E. MORIN.

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Peter Korsgaard]

>>>>> "Yann" == Yann E MORIN <yann.morin.1998@free.fr> writes:

Hi,

 >> I disagree. I haven't found any detailed documentation, but my
 >> understanding is that this nvram data is board(-family) specific,
 >> E.G. it differs between the sunxi boards. From what I could find, the
 >> rpi0-w uses the same nvram file as rpi3 though.

 > If it is (familly-of-)board-specific then keep the dependency, then.

Ok, good.

 >> >> +++ b/package/rpi-wifi-firmware/rpi-wifi-firmware.mk
 >> >> @@ -0,0 +1,22 @@
 >> >> +################################################################################
 >> >> +#
 >> >> +# rpi-wifi-firmware
 >> >> +#
 >> >> +################################################################################
 >> >> +
 >> >> +RPI_WIFI_FIRMWARE_VERSION = 54bab3d6a6d43239c71d26464e6e10e5067ffea7
 >> >> +# brcmfmac43430-sdio.bin comes from linux-firmware
 >> >> +RPI_WIFI_FIRMWARE_SOURCE = brcmfmac43430-sdio.txt
 >> >> +# git repo contains a lot of unrelated files
 >> >> +RPI_WIFI_FIRMWARE_SITE =
 >> >> https://raw.githubusercontent.com/RPi-Distro/firmware-nonfree/$(RPI_WIFI_FIRMWARE_VERSION)/brcm80211/brcm
 >> 
 >> > License?
 >> 
 >> Yeah, that's where things get complicated. There is no explicit license
 >> given. The other brcm*bin files in linux-firmware are covered by
 >> LICENCE.broadcom_bcm43xx, but the question is if this also applies to
 >> this nvram file.
 >> 
 >> Maybe we should just do:
 >> 
 >> RPI_WIFI_FIRMWARE_LICENSE = PROPRIETARY
 >> 
 >> Like we do for the bluetooth part.

 > The OpenSUSE link you pointed above states:

 >     # From
 >     # https://github.com/raspberrypi/linux/issues/1325#issuecomment-195560582
 >     # Phil Elwell (Raspberry Pi Foundation) wrote: "Broadcom have said that
 >     # the firmware files for the BCM43438 are covered under this licence:"
 >     Source0:
 >     https://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/plain/LICENCE.broadcom_bcm43xx

Yes, the question is just if that only covers the generic .bin file or
also the board(-family) specific nvram file, but OK.

As rpi-wifi-firmware already pulls in the .bin file from linux-firmware
(and hence LICENSE.broadcom_bcm43xx) I'll just set _FIRMWARE_LICENSE to
PROPRIETARY and not specify any license file here.

 > BTW, I love the way they force local names to be board-specific.

The # syntax?

-- 
Bye, Peter Korsgaard

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Yann E. MORIN]

Peter, All,

On 2017-05-06 11:28 +0200, Peter Korsgaard spake thusly:
> >>>>> "Yann" == Yann E MORIN <yann.morin.1998@free.fr> writes:
>  > The OpenSUSE link you pointed above states:
> 
>  >     # From
>  >     # https://github.com/raspberrypi/linux/issues/1325#issuecomment-195560582
>  >     # Phil Elwell (Raspberry Pi Foundation) wrote: "Broadcom have said that
>  >     # the firmware files for the BCM43438 are covered under this licence:"
>  >     Source0:
>  >     https://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/plain/LICENCE.broadcom_bcm43xx
> 
> Yes, the question is just if that only covers the generic .bin file or
> also the board(-family) specific nvram file, but OK.
> 
> As rpi-wifi-firmware already pulls in the .bin file from linux-firmware
> (and hence LICENSE.broadcom_bcm43xx) I'll just set _FIRMWARE_LICENSE to
> PROPRIETARY and not specify any license file here.

ACK.

>  > BTW, I love the way they force local names to be board-specific.
> 
> The # syntax?

Yep.

Regards,
Yann E. MORIN.


-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'

[Buildroot] [PATCH] rpi-wifi-firmware: new package

[Peter Korsgaard]

>>>>> "Peter" == Peter Korsgaard <peter@korsgaard.com> writes:

 > Add firmware (NVRAM data) for the Raspberry Pi 3 and Zero W wifi module.
 > Notice that linux-firmware provides the main firmware
 > (brcmfmac43430-sdio.bin), but the module also needs board specific
 > configuration (NVRAM) data.

 > For the rpi, this data is available in the RPI firmware-nonfree git repo.
 > As this repo contains a lot of unrelated data (~70MB), simply download the
 > single NVRAM file instead of cloning the entire repo.

 > A similar approach is used by openwrt and opensuse:

 > https://dev.openwrt.org/browser/trunk/package/firmware/brcmfmac43430-firmware/Makefile?rev=49139
 > https://build.opensuse.org/package/view_file/hardware/bcm43xx-firmware/bcm43xx-firmware.spec?rev=b1628448b36c85abc9215eab4785ef29

 > Signed-off-by: Peter Korsgaard <peter@korsgaard.com>

Committed after adding _LICENSE = PROPRIETARY, thanks.

-- 
Bye, Peter Korsgaard