Replicant

h1. WiFi Research

h2. Issue

Currently, the internal WiFi chip cannot be used on any of the Replicant-supported devices without having to load non-free firmware. See [[ReplicantStatus|Replicant status]] and the [[Index#Supported-devices|device pages]] for more information. 

On desktops and laptops, several WiFi chips don't require non-free firmwares to be loaded.

Several cases exist:

* The WiFi chip doesn't need a firmware, and the driver talks directly to the hardware (ath5k and ath9k compatible chips)

* The WiFi chip has a free software firmware (ath9k_htc, carl1970, and some b43 compatible chips)

* The WiFi chip has a non-free firmware in a flash chip and don't need loadable firmware.

On phones, the only WiFi chip that doesn't require a non-free firmware that we know of is the OpenMoko FreeRunner WiFi chip. The firmware is in a flash chip.

The idea here is to find ways to still get WiFi on Replicant Supported devices, without needing to load any non-free firmware.

h2. WiFi Drivers and Firmwares types

Either the firmware implements the WiFi operations (scanning, association, and so on), either the driver implements it.

h3. Firmware implementing the WiFi operations

This is also known as Hard-MAC. 

An easy way to find out is to look into the WiFi driver Kconfig for "select CFG80211" or "depends CFG80211"

Example:

<pre>

config LIBERTAS

        tristate "Marvell 8xxx Libertas WLAN driver support"

        depends on CFG80211

[...]

</pre>

If it is implemented by the firmware, it often contains bugs which cannot be fixed by the community. That also severally limit the use case of such WiFi chip beyond its most common uses cases.

This can result in more help in getting a free software firmware to run on such chip. However the amount of work to re-implement such firmware may be bigger.

The best way to reimplement it would be to write a new driver taking care of such WiFi operations and to make the firmware do the smallest amount of work possible.

h3. Driver implementing the WiFi operations

This is also known as Soft-MAC. 

An easy way to find out is to look into the WiFi driver Kconfig for "select MAC80211" or "depends MAC80211"

Example:

<pre>

config WL1251

        tristate "TI wl1251 driver support"

        depends on MAC80211

[...]

</pre>

h2. Internal WiFi chips on devices currently targeted by Replicant

|_. Device |_. WiFi chip |_. driver(s) |_. Research |

| Galaxy S |/3. Broadcom BCM4329 |/3. BCMDHD (cfg80211) |

| LG Optimus Black |

| Nexus S |

| Galaxy Nexus |/5. Broadcom BCM4330 |/5. |/8. * See the "nextmon project":https://github.com/seemoo-lab/nexmon

* The BCM4330 has a rom. Can the driver use it? do functional free software firmware 'patches' exist for it ?

* "Some documentation exists at least for the BCM4334":http://www.cypress.com/file/298706/download |

| Galaxy Note |

| Galaxy S 2 |

| Galaxy Tab 2 7.0 |

| Galaxy Tab 2 10.1 |

| Galaxy S 3 |/3. Broadcom BCM4334 |/3. |

| Galaxy S 3 4G |

| Galaxy Note 2 |

|/2. GTA04 |/2. Marvell 8686 (W2CBW003) | libertas_sdio(mainline, cfg80211) |

| libertas_tf_sdio(patches, mac80211) |

h2. Available Internal WiFi chips for smartphones and tablets

|_. Driver |_. Busses |_. Firmware |_. Issues |_. Research |

| ath5k | PCI, PCIe, PCMCIA, AHB  | None(Driver<->Hardware) | Busses? chip size? power consumption? | |

| ath9k | PCI, PCIe, PCMCIA, AHB  | None(Driver<->Hardware) | Busses? chip size? power consumption? | |

| ath9k_htc | USB | Free firmware | Bus? chip size? power consumption? | |

| carl9170 | USB | Free firmware | Bus? chip size? power consumption? | |

| airo | PCI, PCMCIA | Non-free firmware on flash | ? | |

| at76c50x-usb | USB | Non-free firmware needed for some cards only | ? | |

| b43/b43-legacy | SSB, PCI, PCI-E, PCMCIA | OpenFWWF with 4306, 4311(rev1), 4318, 4320 | ? | |

| rt2400 | PCI | No non-free firmware needed | ? | |

| rt2500 | PCI | No non-free firmware needed | ? | |

| rt2500usb | PCI | No non-free firmware needed | ? | |

| rtl818x | PCI, USB | No non-free firmware needed | ? | |

| esp8266 |  UART, SPI, SDIO  | "Out of tree Linux driver available":https://github.com/george-hopkins/esp8089-spi which depend on nonfree firmware | "nonfree binaries required to make WiFi work":https://github.com/espressif/ESP8266_NONOS_SDK/tree/master/lib | |

| esp32 | | | "nonfree binaries required to make WiFi work":https://github.com/espressif/esp32-wifi-lib |  |

| rsi91x | SDIO, USB, other? | * nonfree firmware required

* "may be possible to add it on a dedicated flash chip":https://puri.sm/posts/librem5-2018-09-hardware-report/ |  | |

| brcmfmac | SDIO, USB, pcie | ROM + nonfree firmware | nonfree firmware | * TODO: Look if it works once firmware loading has been patched out of the upstream Linux driver

* TODO: Look at the nextmon project if there are usable free firmwares

* According to the "BCM4334 documentation":http://www.cypress.com/file/298706/download it's possible to have the firmware on dedicated flash chip. |

| rtlwifi (staging) | SDIO, USB, PCIe | nonfree firmware | nonfree firmware | * The nonfree firmware allow reverse engineering (GPL)

* "Reverse engineering the nonfree firmware looks easy":https://libreplanet.org/wiki/Group:Hardware/Freest/e-readers/Aura_H2O_Edition_2#WiFi_firmware |

Notes:

* PCI, PCIe and PCMCIA are available on very few SOCs (Like I.MX)

* We are not aware of phone designs using USB WiFi chips.

* AHB and SSB are usually used as internal memory bus for SOCS. Maybe it can be used to connect a WiFi chip to the SOC memory, like with the I.MX WEIM bus?

* Chip size is important to fit inside a phone. Might be less an issue for tablets.

References:

* https://en.wikipedia.org/wiki/Comparison_of_open-source_wireless_drivers#Status

* https://wireless.wiki.kernel.org/en/users/drivers

* http://netweb.ing.unibs.it/~openfwwf/index.php

* https://nurdspace.nl/ESP8266

h3. TODO

* Coordinate the work with the "Libreplanet wiki":https://libreplanet.org/wiki/Group:Hardware/ReverseEngineering#WiFi.2FBluetooth_chips_for_Smartphones_and_Tablets

* Look into broadcom chipset reverse engineering tools like "nextmon":https://github.com/nextmon and internalblue:"https://github.com/seemoo-lab/internalblue" for bluetooth

h2. Internal WiFi chips on devices currently targeted by Replicant

h2. External Wifi solution

Most/All Replicant supported devices support USB OTG. With the proper (standard) cable, the USB port of the device can do USB host.

However devices differ a lot in the number of Milli-ampers they can deliver through that USB port. Some phones also have USB host enabled by default in their kernel configuration, and some other require patching the kernel.

On Replicant kernels, USB WiFi drivers are probably not compiled in by default. So you will also need to recompile.

|_. Device |_. Replicant Kernel |_. Max mA |

| Galaxy Nexus | | |

| Galaxy Note | | |

| Galaxy Note 2 | | |

| Galaxy S | | |

| Galaxy S 2 | | |

| Galaxy S 3 | | |

| Galaxy Tab 2 7.0 | | |

| Galaxy Tab 2 10.1 | | |

| GTA04 | | |

| Nexus S | | |

| Optimus Black | |