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 capabilites 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 (currently unused).
  34
  35   - AVDD-supply, DBVDD1-supply, CPVDD-supply : Power supplies for the device,
  36     as covered in Documentation/devicetree/bindings/regulator/regulator.txt
  37
  38   - DBVDD2-supply, DBVDD3-supply : Additional databus power supplies (wm5102,
  39     wm5110, wm8280, wm8998, wm1814)
  40
  41   - SPKVDDL-supply, SPKVDDR-supply : Speaker driver power supplies (wm5102,
  42     wm5110, wm8280, wm8998, wm1814)
  43
  44   - SPKVDD-supply : Speaker driver power supply (wm8997)
  45
  46   - DCVDD-supply : Main power supply (cs47l24, wm1831)
  47
  48   - MICVDD-supply : Microphone power supply (cs47l24, wm1831)
  49
  50 Optional properties:
  51
  52   - wlf,reset : GPIO specifier for the GPIO controlling /RESET
  53
  54   - wlf,gpio-defaults : A list of GPIO configuration register values. Defines
  55     for the appropriate values can found in <dt-bindings/mfd/arizona.txt>. If
  56     absent, no configuration of these registers is performed. If any entry has
  57     a value that is out of range for a 16 bit register then the chip default
  58     will be used. If present exactly five values must be specified.
  59
  60   - wlf,inmode : A list of INn_MODE register values, where n is the number
  61     of input signals. Valid values are 0 (Differential), 1 (Single-ended) and
  62     2 (Digital Microphone). If absent, INn_MODE registers set to 0 by default.
  63     If present, values must be specified less than or equal to the number of
  64     input signals. If values less than the number of input signals, elements
  65     that have not been specified are set to 0 by default. Entries are:
  66     <IN1, IN2, IN3, IN4> (wm5102, wm5110, wm8280, wm8997)
  67     <IN1A, IN2A, IN1B, IN2B> (wm8998, wm1814)
  68   - wlf,out-mono : A list of boolean values indicating whether each output is
  69     mono or stereo. Position within the list indicates the output affected
  70     (eg. First entry in the list corresponds to output 1). A non-zero value
  71     indicates a mono output. If present, the number of values should be less
  72     than or equal to the number of outputs, if less values are supplied the
  73     additional outputs will be treated as stereo.
  74
  75   - wlf,dmic-ref : DMIC reference voltage source for each input, can be
  76     selected from either MICVDD or one of the MICBIAS's, defines
  77     (ARIZONA_DMIC_xxxx) are provided in <dt-bindings/mfd/arizona.txt>. If
  78     present, the number of values should be less than or equal to the
  79     number of inputs, unspecified inputs will use the chip default.
  80
  81   - DCVDD-supply, MICVDD-supply : Power supplies, only need to be specified if
  82     they are being externally supplied. As covered in
  83     Documentation/devicetree/bindings/regulator/regulator.txt
  84     (wm5102, wm5110, wm8280, wm8997, wm8998, wm1814)
  85
  86 Also see child specific device properties:
  87   Regulator - ../regulator/arizona-regulator.txt
  88   Extcon    - ../extcon/extcon-arizona.txt
  89
  90 Example:
  91
  92 codec: wm5102@1a {
  93         compatible = "wlf,wm5102";
  94         reg = <0x1a>;
  95         interrupts = <347>;
  96         interrupt-controller;
  97         #interrupt-cells = <2>;
  98         interrupt-parent = <&gic>;
  99
 100         gpio-controller;
 101         #gpio-cells = <2>;
 102
 103         wlf,gpio-defaults = <
 104                 ARIZONA_GP_FN_TXLRCLK
 105                 ARIZONA_GP_DEFAULT
 106                 ARIZONA_GP_DEFAULT
 107                 ARIZONA_GP_DEFAULT
 108                 ARIZONA_GP_DEFAULT
 109         >;
 110 };