Documentation/devicetree/bindings/mfd/arizona.txt

   1 Cirrus Logic/Wolfson Microelectronics Arizona class audio SoCs
   2
   3 These devices are audio SoCs with extensive digital capabilities and a range
   4 of analogue I/O.
   5
   6 Required properties:
   7
   8   - compatible : One of the following chip-specific strings:
   9         "cirrus,cs47l24"
  10         "wlf,wm5102"
  11         "wlf,wm5110"
  12         "wlf,wm8280"
  13         "wlf,wm8997"
  14         "wlf,wm8998"
  15         "wlf,wm1814"
  16         "wlf,wm1831"
  17
  18   - reg : I2C slave address when connected using I2C, chip select number when
  19     using SPI.
  20
  21   - interrupts : The interrupt line the /IRQ signal for the device is
  22     connected to.
  23   - interrupt-controller : Arizona class devices contain interrupt controllers
  24     and may provide interrupt services to other devices.
  25   - interrupt-parent : The parent interrupt controller.
  26   - #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
  27     The first cell is the IRQ number.
  28     The second cell is the flags, encoded as the trigger masks from
  29     Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
  30
  31   - gpio-controller : Indicates this device is a GPIO controller.
  32   - #gpio-cells : Must be 2. The first cell is the pin number and the
  33     second cell is used to specify optional parameters, see ../gpio/gpio.txt
  34     for details.
  35
  36   - AVDD-supply, DBVDD1-supply, CPVDD-supply : Power supplies for the device,
  37     as covered in Documentation/devicetree/bindings/regulator/regulator.txt
  38
  39   - DBVDD2-supply, DBVDD3-supply : Additional databus power supplies (wm5102,
  40     wm5110, wm8280, wm8998, wm1814)
  41
  42   - SPKVDDL-supply, SPKVDDR-supply : Speaker driver power supplies (wm5102,
  43     wm5110, wm8280, wm8998, wm1814)
  44
  45   - SPKVDD-supply : Speaker driver power supply (wm8997)
  46
  47   - DCVDD-supply : Main power supply (cs47l24, wm1831)
  48
  49   - MICVDD-supply : Microphone power supply (cs47l24, wm1831)
  50
  51 Optional properties:
  52
  53   - reset-gpios : GPIO specifier for the GPIO controlling /RESET
  54
  55   - clocks: Should reference the clocks supplied on MCLK1 and MCLK2
  56   - clock-names: Should contains two strings:
  57       "mclk1" for the clock supplied on MCLK1, recommended to be a high
  58       quality audio reference clock
  59       "mclk2" for the clock supplied on MCLK2, recommended to be an always on
  60       32k clock
  61
  62   - wlf,gpio-defaults : A list of GPIO configuration register values. Defines
  63     for the appropriate values can found in <dt-bindings/mfd/arizona.txt>. If
  64     absent, no configuration of these registers is performed. If any entry has
  65     a value that is out of range for a 16 bit register then the chip default
  66     will be used. If present exactly five values must be specified.
  67
  68   - DCVDD-supply, MICVDD-supply : Power supplies, only need to be specified if
  69     they are being externally supplied. As covered in
  70     Documentation/devicetree/bindings/regulator/regulator.txt
  71     (wm5102, wm5110, wm8280, wm8997, wm8998, wm1814)
  72
  73 Deprecated properties:
  74
  75   - wlf,reset : GPIO specifier for the GPIO controlling /RESET
  76
  77 Also see child specific device properties:
  78   Regulator - ../regulator/arizona-regulator.txt
  79   Extcon    - ../extcon/extcon-arizona.txt
  80   Sound     - ../sound/arizona.txt
  81
  82 Example:
  83
  84 codec: wm5102@1a {
  85         compatible = "wlf,wm5102";
  86         reg = <0x1a>;
  87         interrupts = <347>;
  88         interrupt-controller;
  89         #interrupt-cells = <2>;
  90         interrupt-parent = <&gic>;
  91
  92         gpio-controller;
  93         #gpio-cells = <2>;
  94
  95         wlf,gpio-defaults = <
  96                 ARIZONA_GP_FN_TXLRCLK
  97                 ARIZONA_GP_DEFAULT
  98                 ARIZONA_GP_DEFAULT
  99                 ARIZONA_GP_DEFAULT
 100                 ARIZONA_GP_DEFAULT
 101         >;
 102 };