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