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
  48   - wlf,gpio-defaults : A list of GPIO configuration register values. Defines
  49     for the appropriate values can found in <dt-bindings/mfd/arizona.txt>. If
  50     absent, no configuration of these registers is performed. If any entry has
  51     a value that is out of range for a 16 bit register then the chip default
  52     will be used. If present exactly five values must be specified.
  53
  54   - wlf,inmode : A list of INn_MODE register values, where n is the number
  55     of input signals. Valid values are 0 (Differential), 1 (Single-ended) and
  56     2 (Digital Microphone). If absent, INn_MODE registers set to 0 by default.
  57     If present, values must be specified less than or equal to the number of
  58     input signals. If values less than the number of input signals, elements
  59     that have not been specified are set to 0 by default. Entries are:
  60     <IN1, IN2, IN3, IN4> (wm5102, wm5110, wm8280, wm8997)
  61     <IN1A, IN2A, IN1B, IN2B> (wm8998, wm1814)
  62
  63   - wlf,dmic-ref : DMIC reference voltage source for each input, can be
  64     selected from either MICVDD or one of the MICBIAS's, defines
  65     (ARIZONA_DMIC_xxxx) are provided in <dt-bindings/mfd/arizona.txt>. If
  66     present, the number of values should be less than or equal to the
  67     number of inputs, unspecified inputs will use the chip default.
  68
  69   - DCVDD-supply, MICVDD-supply : Power supplies, only need to be specified if
  70     they are being externally supplied. As covered in
  71     Documentation/devicetree/bindings/regulator/regulator.txt
  72
  73 Also see child specific device properties:
  74   Regulator - ../regulator/arizona-regulator.txt
  75   Extcon    - ../extcon/extcon-arizona.txt
  76
  77 Example:
  78
  79 codec: wm5102@1a {
  80         compatible = "wlf,wm5102";
  81         reg = <0x1a>;
  82         interrupts = <347>;
  83         interrupt-controller;
  84         #interrupt-cells = <2>;
  85         interrupt-parent = <&gic>;
  86
  87         gpio-controller;
  88         #gpio-cells = <2>;
  89
  90         wlf,gpio-defaults = <
  91                 ARIZONA_GP_FN_TXLRCLK
  92                 ARIZONA_GP_DEFAULT
  93                 ARIZONA_GP_DEFAULT
  94                 ARIZONA_GP_DEFAULT
  95                 ARIZONA_GP_DEFAULT
  96         >;
  97 };