Difference between revisions of "WLAN device tree configuration"

[quality revision] [quality revision]
 
Template:ArticleMainWriter Template:ArticleApprovedVersion

1 Article purpose[edit]

The purpose of this article is to explain how to configure the WLAN when the peripheral (or peripheral associated to the framework) is assigned to Linux® OS.

The configuration is performed using the device tree mechanism that provides a hardware description of the WLAN peripheral connected on SDIO bus.

The purpose of this article is to explain Cypress WLAN/BT companion chip[1]device tree node

2 DT bindings documentation[edit]

The WLAN[2] tree bindings are composed by :

  • SDIO link configuration[3]
  • WLAN device configuration[4]

3 DT configuration[edit]

This hardware description is a combination of the STM32 microprocessor device tree files (.dtsi extension) and board device tree files (.dts extension). See the Device tree for an explanation of the device tree file split.

3.1 DT configuration (STM32 level)[edit]

The companion chip uses the SDIO link so the DT is based on the SDMMC peripheral node which is located in stm32mp157c.dtsi

  • This is a set of properties that may not vary for given STM32 device, such as: registers address, clock, reset.

The SDMMC DT configuration is explained at SDMMC device tree configuration

Warning.png This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.

3.2 DT configuration (board level)[edit]

Part of the device tree is used to describe the WLAN hardware used on a given board. The DT node ("sdmmc2") must be filled in:

  • mmc-pwrseq: phandle to the MMC power sequence node
  • keep-power-in-suspend: preserves the card power during a suspend/resume cycle
&sdmmc2 {
       ...
       vmmc-supply = <&v3v3>;
       mmc-pwrseq = <&wifi_pwrseq>;                 /* phandle to the MMC power sequence node */
       ...
       keep-power-in-suspend;                       /* preserves the card power during a suspend/resume cycle */
       brcmf: bcrmf@1 {                             /* node of WLAN companion chip */
          reg = <1>;
          compatible = "brcm,bcm4329-fmac";
       }
}

4 References[edit]


<noinclude>

{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
{{ArticleMainWriter | ChristopheR}}
{{ArticleApprovedVersion | ChristopheR | AlexandreT (Done 4July'18), GeraldB (Not Done), ErwanL (Not Done), LoicP (Failed W51.1) | No previous approved version | AlainF - 03Jan'19 - 10169 | January'19}}
[[Category:Device tree configuration]]
[[Category:WLAN]]</noinclude>

== Article purpose ==
The purpose of this article is to explain how to configure the [[WLAN and Bluetooth hardware component|WLAN]] when the peripheral ''(or peripheral associated to the framework)'' is assigned to Linux<sup>&reg;</sup> OS'''. 

The configuration is performed using the [[Device tree|device tree]] mechanism that provides a hardware description of the WLAN peripheral connected on SDIO bus.

The purpose of this article is to explain Cypress WLAN/BT companion chip<ref>[http://wireless.murata.com/datasheet?/RFM/data/lbee5kl1dx.pdf], CYW4343W</ref>         [[Device tree|device tree]] node

== DT bindings documentation ==

The ''WLAN''<ref name="WLAN and Bluetooth hardware component"> [[WLAN and Bluetooth hardware component]]</ref> ''' tree bindings are composed by :

* SDIO link configuration<ref>[[SDMMC device tree configuration]]</ref>


* WLAN device configuration<ref>{{CodeSource | Linux kernel | Documentation/devicetree/bindings/net/wireless/brcm,bcm43xx-fmac.txt}}</ref>


== DT configuration ==
This hardware description is a combination of the STM32 microprocessor device tree files (.dtsi extension) and board device tree files (.dts extension). See the Device tree for an explanation of the device tree file split. 

=== DT configuration (STM32 level) ===
The companion chip uses the SDIO link so the DT is based on the SDMMC peripheral node which is located in ''stm32mp157c.dtsi''
* This is a set of properties that may not vary for given STM32 device, such as: registers address, clock, reset.
The SDMMC DT configuration is explained at [[SDMMC device tree configuration]]
{{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}}

=== DT configuration (board level) ===
Part of the [[Device tree|device tree]] is used to describe the WLAN hardware used on a given board. The DT node ('''"sdmmc2"''') must be filled in:
* mmc-pwrseq: phandle to the MMC power sequence node
* keep-power-in-suspend: preserves the card power during a suspend/resume cycle

 &sdmmc2 {
        ...
        vmmc-supply = <&v3v3>;
        mmc-pwrseq = <&wifi_pwrseq>;                 {{highlight|/* phandle to the MMC power sequence node */}}
        ...
        keep-power-in-suspend;                       {{highlight|/* preserves the card power during a suspend/resume cycle */}}
        brcmf: bcrmf@1 {                             {{highlight|/* node of WLAN companion chip */}}
           reg = <1>;
           compatible = "brcm,bcm4329-fmac";
        }
 }

==References==<references />

<noinclude>

[[Category:Device tree configuration]]
[[Category:WLAN]]
{{PublicationRequestId | 10169 | 2019-01-03 | AlainF}}
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}</noinclude>
Line 1: Line 1:
<noinclude>
 
{{ArticleBasedOnModel | [[Peripheral or framework device tree configuration model]]}}
 
{{ArticleMainWriter | ChristopheR}}
 
{{ArticleApprovedVersion | ChristopheR | AlexandreT (Done 4July'18), GeraldB (Not Done), ErwanL (Not Done), LoicP (Failed W51.1) | No previous approved version | AlainF - 03Jan'19 - 10169 | January'19}}
 
[[Category:Device tree configuration]]
 
[[Category:WLAN]]
 
</noinclude>
 
 
 
== Article purpose ==
 
== Article purpose ==
 
The purpose of this article is to explain how to configure the [[WLAN and Bluetooth hardware component|WLAN]] when the peripheral ''(or peripheral associated to the framework)'' is assigned to Linux<sup>&reg;</sup> OS'''.  
 
The purpose of this article is to explain how to configure the [[WLAN and Bluetooth hardware component|WLAN]] when the peripheral ''(or peripheral associated to the framework)'' is assigned to Linux<sup>&reg;</sup> OS'''.  
Line 50: Line 42:
 
==References==
 
==References==
 
<references />
 
<references />
  +
  +
<noinclude>
  +
[[Category:Device tree configuration]]
  +
[[Category:WLAN]]
  +
{{PublicationRequestId | 10169 | 2019-01-03 | AlainF}}
  +
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
  +
</noinclude>