kernel/Documentation/devicetree/bindings/mfd/arizona.txt

   1 Wolfson Arizona class audio SoCs
   2
   3 These devices are audio SoCs with extensive digital capabilites and a range
   4 of analogue I/O.
   5
   6 Required properties:
   7
   8   - compatible : One of the following chip-specific strings:
   9         "wlf,wm5102"
  10         "wlf,wm5110"
  11         "wlf,wm8280"
  12         "wlf,wm8997"
  13   - reg : I2C slave address when connected using I2C, chip select number when
  14     using SPI.
  15
  16   - interrupts : The interrupt line the /IRQ signal for the device is
  17     connected to.
  18   - interrupt-controller : Arizona class devices contain interrupt controllers
  19     and may provide interrupt services to other devices.
  20   - interrupt-parent : The parent interrupt controller.
  21   - #interrupt-cells: the number of cells to describe an IRQ, this should be 2.
  22     The first cell is the IRQ number.
  23     The second cell is the flags, encoded as the trigger masks from
  24     Documentation/devicetree/bindings/interrupts.txt
  25
  26   - gpio-controller : Indicates this device is a GPIO controller.
  27   - #gpio-cells : Must be 2. The first cell is the pin number and the
  28     second cell is used to specify optional parameters (currently unused).
  29
  30   - AVDD-supply, DBVDD1-supply, CPVDD-supply : Power supplies for the device,
  31     as covered in Documentation/devicetree/bindings/regulator/regulator.txt
  32
  33   - DBVDD2-supply, DBVDD3-supply : Additional databus power supplies (wm5102,
  34     wm5110, wm8280)
  35
  36   - SPKVDDL-supply, SPKVDDR-supply : Speaker driver power supplies (wm5102,
  37     wm5110, wm8280)
  38
  39   - SPKVDD-supply : Speaker driver power supply (wm8997)
  40
  41 Optional properties:
  42
  43   - wlf,reset : GPIO specifier for the GPIO controlling /RESET
  44   - wlf,ldoena : GPIO specifier for the GPIO controlling LDOENA
  45
  46   - wlf,gpio-defaults : A list of GPIO configuration register values. Defines
  47     for the appropriate values can found in <dt-bindings/mfd/arizona.txt>. If
  48     absent, no configuration of these registers is performed. If any entry has
  49     a value that is out of range for a 16 bit register then the chip default
  50     will be used. If present exactly five values must be specified.
  51
  52   - wlf,inmode : A list of INn_MODE register values, where n is the number
  53     of input signals. Valid values are 0 (Differential), 1 (Single-ended) and
  54     2 (Digital Microphone). If absent, INn_MODE registers set to 0 by default.
  55     If present, values must be specified less than or equal to the number of
  56     input singals. If values less than the number of input signals, elements
  57     that has not been specifed are set to 0 by default.
  58
  59   - wlf,dmic-ref : DMIC reference voltage source for each input, can be
  60     selected from either MICVDD or one of the MICBIAS's, defines
  61     (ARIZONA_DMIC_xxxx) are provided in <dt-bindings/mfd/arizona.txt>. If
  62     present, the number of values should be less than or equal to the
  63     number of inputs, unspecified inputs will use the chip default.
  64
  65   - DCVDD-supply, MICVDD-supply : Power supplies, only need to be specified if
  66     they are being externally supplied. As covered in
  67     Documentation/devicetree/bindings/regulator/regulator.txt
  68
  69 Optional subnodes:
  70   - ldo1 : Initial data for the LDO1 regulator, as covered in
  71     Documentation/devicetree/bindings/regulator/regulator.txt
  72   - micvdd : Initial data for the MICVDD regulator, as covered in
  73     Documentation/devicetree/bindings/regulator/regulator.txt
  74
  75 Example:
  76
  77 codec: wm5102@1a {
  78         compatible = "wlf,wm5102";
  79         reg = <0x1a>;
  80         interrupts = <347>;
  81         interrupt-controller;
  82         #interrupt-cells = <2>;
  83         interrupt-parent = <&gic>;
  84
  85         gpio-controller;
  86         #gpio-cells = <2>;
  87
  88         wlf,gpio-defaults = <
  89                 ARIZONA_GP_FN_TXLRCLK
  90                 ARIZONA_GP_DEFAULT
  91                 ARIZONA_GP_DEFAULT
  92                 ARIZONA_GP_DEFAULT
  93                 ARIZONA_GP_DEFAULT
  94         >;
  95 };