drivers/staging/wfx/Documentation/devicetree/bindings/net/wireless/siliabs,wfx.txt

   1 The WFxxx chip series can be connected via SPI or via SDIO.
   2
   3 SPI
   4 ---
   5
   6 You have to declare the WFxxx chip in your device tree.
   7
   8 Required properties:
   9  - compatible: Should be "silabs,wfx-spi"
  10  - reg: Chip select address of device
  11  - spi-max-frequency: Maximum SPI clocking speed of device in Hz
  12  - interrupts-extended: Should contain interrupt line (interrupt-parent +
  13    interrupt can also been used). Trigger should be `IRQ_TYPE_EDGE_RISING`.
  14
  15 Optional properties:
  16  - reset-gpios: phandle of gpio that will be used to reset chip during probe.
  17    Without this property, you may encounter issues with warm boot.
  18
  19 Please consult Documentation/devicetree/bindings/spi/spi-bus.txt for optional
  20 SPI connection related properties,
  21
  22 Example:
  23
  24 &spi1 {
  25         wfx {
  26                 compatible = "silabs,wfx-spi";
  27                 pinctrl-names = "default";
  28                 pinctrl-0 = <&wfx_irq &wfx_gpios>;
  29                 interrupts-extended = <&gpio 16 IRQ_TYPE_EDGE_RISING>;
  30                 wakeup-gpios = <&gpio 12 GPIO_ACTIVE_HIGH>;
  31                 reset-gpios = <&gpio 13 GPIO_ACTIVE_HIGH>;
  32                 reg = <0>;
  33                 spi-max-frequency = <42000000>;
  34         };
  35 };
  36
  37
  38 SDIO
  39 ----
  40
  41 The driver is able to detect a WFxxx chip on SDIO bus by matching its Vendor ID
  42 and Product ID. However, driver will only provide limited features in this
  43 case. Thus declaring WFxxx chip in device tree is strongly recommended (and may
  44 become mandatory in the future).
  45
  46 Required properties:
  47  - compatible: Should be "silabs,wfx-sdio"
  48  - reg: Should be 1
  49
  50 In addition, it is recommended to declare a mmc-pwrseq on SDIO host above WFx.
  51 Without it, you may encounter issues with warm boot. mmc-pwrseq should be
  52 compatible with mmc-pwrseq-simple. Please consult
  53 Documentation/devicetree/bindings/mmc/mmc-pwrseq-simple.txt for more
  54 information.
  55
  56 Example:
  57
  58 / {
  59         wfx_pwrseq: wfx_pwrseq {
  60                 compatible = "mmc-pwrseq-simple";
  61                 pinctrl-names = "default";
  62                 pinctrl-0 = <&wfx_reset>;
  63                 reset-gpios = <&gpio 13 GPIO_ACTIVE_LOW>;
  64         };
  65 };
  66
  67 &mmc1 {
  68         mmc-pwrseq = <&wfx_pwrseq>;
  69         #address-size = <1>;
  70         #size = <0>;
  71
  72         mmc@1 {
  73                 compatible = "silabs,wfx-sdio";
  74                 reg = <1>;
  75                 pinctrl-names = "default";
  76                 pinctrl-0 = <&wfx_wakeup>;
  77                 wakeup-gpios = <&gpio 12 GPIO_ACTIVE_HIGH>;
  78         };
  79 };
  80
  81 Note that #address-size and #size shoud already be defined in node mmc1, but it
  82 is rarely the case.
  83
  84 Common properties
  85 -----------------
  86
  87 Some properties are recognized either by SPI and SDIO versions:
  88  - wakeup-gpios: phandle of gpio that will be used to wake-up chip. Without
  89    this property, driver will disable most of power saving features.
  90  - config-file: Use an alternative file as PDS. Default is `wf200.pds`. Only
  91    necessary for development/debug purpose.
  92  - slk_key: String representing hexadecimal value of secure link key to use.
  93    Must contains 64 hexadecimal digits. Not supported in current version.
  94
  95 WFx driver also supports `mac-address` and `local-mac-address` as described in
  96 Documentation/devicetree/binding/net/ethernet.txt
  97