Documentation/devicetree/bindings/net/wireless/qcom,ath10k.txt

   1 * Qualcomm Atheros ath10k wireless devices
   2
   3 Required properties:
   4 - compatible: Should be one of the following:
   5         * "qcom,ath10k"
   6         * "qcom,ipq4019-wifi"
   7         * "qcom,wcn3990-wifi"
   8
   9 PCI based devices uses compatible string "qcom,ath10k" and takes calibration
  10 data along with board specific data via "qcom,ath10k-calibration-data".
  11 Rest of the properties are not applicable for PCI based devices.
  12
  13 AHB based devices (i.e. ipq4019) uses compatible string "qcom,ipq4019-wifi"
  14 and also uses most of the properties defined in this doc (except
  15 "qcom,ath10k-calibration-data"). It uses "qcom,ath10k-pre-calibration-data"
  16 to carry pre calibration data.
  17
  18 In general, entry "qcom,ath10k-pre-calibration-data" and
  19 "qcom,ath10k-calibration-data" conflict with each other and only one
  20 can be provided per device.
  21
  22 SNOC based devices (i.e. wcn3990) uses compatible string "qcom,wcn3990-wifi".
  23
  24 Optional properties:
  25 - reg: Address and length of the register set for the device.
  26 - reg-names: Must include the list of following reg names,
  27              "membase"
  28 - resets: Must contain an entry for each entry in reset-names.
  29           See ../reset/reseti.txt for details.
  30 - reset-names: Must include the list of following reset names,
  31                "wifi_cpu_init"
  32                "wifi_radio_srif"
  33                "wifi_radio_warm"
  34                "wifi_radio_cold"
  35                "wifi_core_warm"
  36                "wifi_core_cold"
  37 - clocks: List of clock specifiers, must contain an entry for each required
  38           entry in clock-names.
  39 - clock-names: Should contain the clock names "wifi_wcss_cmd", "wifi_wcss_ref",
  40                "wifi_wcss_rtc".
  41 - interrupts: List of interrupt lines. Must contain an entry
  42               for each entry in the interrupt-names property.
  43 - interrupt-names: Must include the entries for MSI interrupt
  44                    names ("msi0" to "msi15") and legacy interrupt
  45                    name ("legacy"),
  46 - qcom,msi_addr: MSI interrupt address.
  47 - qcom,msi_base: Base value to add before writing MSI data into
  48                 MSI address register.
  49 - qcom,ath10k-calibration-variant: string to search for in the board-2.bin
  50                                    variant list with the same bus and device
  51                                    specific ids
  52 - qcom,ath10k-calibration-data : calibration data + board specific data
  53                                  as an array, the length can vary between
  54                                  hw versions.
  55 - qcom,ath10k-pre-calibration-data : pre calibration data as an array,
  56                                      the length can vary between hw versions.
  57 - <supply-name>-supply: handle to the regulator device tree node
  58                            optional "supply-name" is "vdd-0.8-cx-mx".
  59 - memory-region:
  60         Usage: optional
  61         Value type: <phandle>
  62         Definition: reference to the reserved-memory for the msa region
  63                     used by the wifi firmware running in Q6.
  64
  65 Example (to supply the calibration data alone):
  66
  67 In this example, the node is defined as child node of the PCI controller.
  68
  69 pci {
  70         pcie@0 {
  71                 reg = <0 0 0 0 0>;
  72                 #interrupt-cells = <1>;
  73                 #size-cells = <2>;
  74                 #address-cells = <3>;
  75                 device_type = "pci";
  76
  77                 ath10k@0,0 {
  78                         reg = <0 0 0 0 0>;
  79                         device_type = "pci";
  80                         qcom,ath10k-calibration-data = [ 01 02 03 ... ];
  81                 };
  82         };
  83 };
  84
  85 Example (to supply ipq4019 SoC wifi block details):
  86
  87 wifi0: wifi@a000000 {
  88         compatible = "qcom,ipq4019-wifi";
  89         reg = <0xa000000 0x200000>;
  90         resets = <&gcc WIFI0_CPU_INIT_RESET>,
  91                  <&gcc WIFI0_RADIO_SRIF_RESET>,
  92                  <&gcc WIFI0_RADIO_WARM_RESET>,
  93                  <&gcc WIFI0_RADIO_COLD_RESET>,
  94                  <&gcc WIFI0_CORE_WARM_RESET>,
  95                  <&gcc WIFI0_CORE_COLD_RESET>;
  96         reset-names = "wifi_cpu_init",
  97                       "wifi_radio_srif",
  98                       "wifi_radio_warm",
  99                       "wifi_radio_cold",
 100                       "wifi_core_warm",
 101                       "wifi_core_cold";
 102         clocks = <&gcc GCC_WCSS2G_CLK>,
 103                  <&gcc GCC_WCSS2G_REF_CLK>,
 104                  <&gcc GCC_WCSS2G_RTC_CLK>;
 105         clock-names = "wifi_wcss_cmd",
 106                       "wifi_wcss_ref",
 107                       "wifi_wcss_rtc";
 108         interrupts = <0 0x20 0x1>,
 109                      <0 0x21 0x1>,
 110                      <0 0x22 0x1>,
 111                      <0 0x23 0x1>,
 112                      <0 0x24 0x1>,
 113                      <0 0x25 0x1>,
 114                      <0 0x26 0x1>,
 115                      <0 0x27 0x1>,
 116                      <0 0x28 0x1>,
 117                      <0 0x29 0x1>,
 118                      <0 0x2a 0x1>,
 119                      <0 0x2b 0x1>,
 120                      <0 0x2c 0x1>,
 121                      <0 0x2d 0x1>,
 122                      <0 0x2e 0x1>,
 123                      <0 0x2f 0x1>,
 124                      <0 0xa8 0x0>;
 125         interrupt-names = "msi0",  "msi1",  "msi2",  "msi3",
 126                           "msi4",  "msi5",  "msi6",  "msi7",
 127                           "msi8",  "msi9",  "msi10", "msi11",
 128                           "msi12", "msi13", "msi14", "msi15",
 129                           "legacy";
 130         qcom,msi_addr = <0x0b006040>;
 131         qcom,msi_base = <0x40>;
 132         qcom,ath10k-pre-calibration-data = [ 01 02 03 ... ];
 133 };
 134
 135 Example (to supply wcn3990 SoC wifi block details):
 136
 137 wifi@18000000 {
 138                 compatible = "qcom,wcn3990-wifi";
 139                 reg = <0x18800000 0x800000>;
 140                 reg-names = "membase";
 141                 clocks = <&clock_gcc clk_aggre2_noc_clk>;
 142                 clock-names = "smmu_aggre2_noc_clk"
 143                 interrupts =
 144                            <0 130 0 /* CE0 */ >,
 145                            <0 131 0 /* CE1 */ >,
 146                            <0 132 0 /* CE2 */ >,
 147                            <0 133 0 /* CE3 */ >,
 148                            <0 134 0 /* CE4 */ >,
 149                            <0 135 0 /* CE5 */ >,
 150                            <0 136 0 /* CE6 */ >,
 151                            <0 137 0 /* CE7 */ >,
 152                            <0 138 0 /* CE8 */ >,
 153                            <0 139 0 /* CE9 */ >,
 154                            <0 140 0 /* CE10 */ >,
 155                            <0 141 0 /* CE11 */ >;
 156                 vdd-0.8-cx-mx-supply = <&pm8998_l5>;
 157                 memory-region = <&wifi_msa_mem>;
 158 };