Richard Fitzgerald | 9a65a6d | 2015-11-03 15:08:33 +0000 | [diff] [blame] | 1 | Cirrus Logic/Wolfson Microelectronics Arizona class audio SoCs |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 2 | |
Kees Cook | 0855965 | 2016-04-26 16:41:21 -0700 | [diff] [blame] | 3 | These devices are audio SoCs with extensive digital capabilities and a range |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 4 | of analogue I/O. |
| 5 | |
| 6 | Required properties: |
| 7 | |
Charles Keepax | 72e6e79 | 2014-03-19 10:18:54 +0000 | [diff] [blame] | 8 | - compatible : One of the following chip-specific strings: |
Richard Fitzgerald | 9a65a6d | 2015-11-03 15:08:33 +0000 | [diff] [blame] | 9 | "cirrus,cs47l24" |
Charles Keepax | 72e6e79 | 2014-03-19 10:18:54 +0000 | [diff] [blame] | 10 | "wlf,wm5102" |
| 11 | "wlf,wm5110" |
Richard Fitzgerald | c4ac3719 | 2015-01-17 15:21:23 +0000 | [diff] [blame] | 12 | "wlf,wm8280" |
Charles Keepax | 72e6e79 | 2014-03-19 10:18:54 +0000 | [diff] [blame] | 13 | "wlf,wm8997" |
Richard Fitzgerald | b64610d | 2015-05-01 16:15:19 +0100 | [diff] [blame] | 14 | "wlf,wm8998" |
| 15 | "wlf,wm1814" |
Richard Fitzgerald | 9a65a6d | 2015-11-03 15:08:33 +0000 | [diff] [blame] | 16 | "wlf,wm1831" |
Richard Fitzgerald | b64610d | 2015-05-01 16:15:19 +0100 | [diff] [blame] | 17 | |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 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. |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 25 | - #interrupt-cells: the number of cells to describe an IRQ, this should be 2. |
| 26 | The first cell is the IRQ number. |
| 27 | The second cell is the flags, encoded as the trigger masks from |
Andrew F. Davis | 51669f8 | 2015-09-21 11:25:40 -0500 | [diff] [blame] | 28 | Documentation/devicetree/bindings/interrupt-controller/interrupts.txt |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 29 | |
| 30 | - gpio-controller : Indicates this device is a GPIO controller. |
| 31 | - #gpio-cells : Must be 2. The first cell is the pin number and the |
Charles Keepax | 7a456cb | 2017-05-23 15:47:32 +0100 | [diff] [blame] | 32 | second cell is used to specify optional parameters, see ../gpio/gpio.txt |
| 33 | for details. |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 34 | |
Richard Fitzgerald | c4ac3719 | 2015-01-17 15:21:23 +0000 | [diff] [blame] | 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, |
Richard Fitzgerald | b64610d | 2015-05-01 16:15:19 +0100 | [diff] [blame] | 39 | wm5110, wm8280, wm8998, wm1814) |
Richard Fitzgerald | c4ac3719 | 2015-01-17 15:21:23 +0000 | [diff] [blame] | 40 | |
| 41 | - SPKVDDL-supply, SPKVDDR-supply : Speaker driver power supplies (wm5102, |
Richard Fitzgerald | b64610d | 2015-05-01 16:15:19 +0100 | [diff] [blame] | 42 | wm5110, wm8280, wm8998, wm1814) |
Richard Fitzgerald | c4ac3719 | 2015-01-17 15:21:23 +0000 | [diff] [blame] | 43 | |
| 44 | - SPKVDD-supply : Speaker driver power supply (wm8997) |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 45 | |
Richard Fitzgerald | 9a65a6d | 2015-11-03 15:08:33 +0000 | [diff] [blame] | 46 | - DCVDD-supply : Main power supply (cs47l24, wm1831) |
| 47 | |
| 48 | - MICVDD-supply : Microphone power supply (cs47l24, wm1831) |
| 49 | |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 50 | Optional properties: |
| 51 | |
Charles Keepax | fced296 | 2018-05-09 11:23:48 +0100 | [diff] [blame] | 52 | - reset-gpios : GPIO specifier for the GPIO controlling /RESET |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 53 | |
Charles Keepax | 0b81995 | 2016-01-08 11:29:42 +0000 | [diff] [blame] | 54 | - clocks: Should reference the clocks supplied on MCLK1 and MCLK2 |
| 55 | - clock-names: Should contains two strings: |
| 56 | "mclk1" for the clock supplied on MCLK1, recommended to be a high |
| 57 | quality audio reference clock |
| 58 | "mclk2" for the clock supplied on MCLK2, recommended to be an always on |
| 59 | 32k clock |
| 60 | |
Charles Keepax | 4901033 | 2015-02-25 15:37:13 +0000 | [diff] [blame] | 61 | - wlf,gpio-defaults : A list of GPIO configuration register values. Defines |
| 62 | for the appropriate values can found in <dt-bindings/mfd/arizona.txt>. If |
| 63 | absent, no configuration of these registers is performed. If any entry has |
| 64 | a value that is out of range for a 16 bit register then the chip default |
| 65 | will be used. If present exactly five values must be specified. |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 66 | |
Charles Keepax | 819b2dd | 2014-07-10 17:04:09 +0100 | [diff] [blame] | 67 | - DCVDD-supply, MICVDD-supply : Power supplies, only need to be specified if |
| 68 | they are being externally supplied. As covered in |
Charles Keepax | a6d97c1 | 2014-07-10 17:04:08 +0100 | [diff] [blame] | 69 | Documentation/devicetree/bindings/regulator/regulator.txt |
Richard Fitzgerald | 9a65a6d | 2015-11-03 15:08:33 +0000 | [diff] [blame] | 70 | (wm5102, wm5110, wm8280, wm8997, wm8998, wm1814) |
Charles Keepax | a6d97c1 | 2014-07-10 17:04:08 +0100 | [diff] [blame] | 71 | |
Charles Keepax | fced296 | 2018-05-09 11:23:48 +0100 | [diff] [blame] | 72 | Deprecated properties: |
| 73 | |
| 74 | - wlf,reset : GPIO specifier for the GPIO controlling /RESET |
| 75 | |
Charles Keepax | f2f48a5 | 2015-10-27 16:01:58 +0000 | [diff] [blame] | 76 | Also see child specific device properties: |
| 77 | Regulator - ../regulator/arizona-regulator.txt |
| 78 | Extcon - ../extcon/extcon-arizona.txt |
Charles Keepax | 689f7a7 | 2018-09-17 16:33:22 +0100 | [diff] [blame^] | 79 | Sound - ../sound/wlf,arizona.txt |
Charles Keepax | a6d97c1 | 2014-07-10 17:04:08 +0100 | [diff] [blame] | 80 | |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 81 | Example: |
| 82 | |
| 83 | codec: wm5102@1a { |
| 84 | compatible = "wlf,wm5102"; |
| 85 | reg = <0x1a>; |
| 86 | interrupts = <347>; |
Charles Keepax | 72e6e79 | 2014-03-19 10:18:54 +0000 | [diff] [blame] | 87 | interrupt-controller; |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 88 | #interrupt-cells = <2>; |
| 89 | interrupt-parent = <&gic>; |
| 90 | |
| 91 | gpio-controller; |
| 92 | #gpio-cells = <2>; |
| 93 | |
| 94 | wlf,gpio-defaults = < |
Charles Keepax | 4901033 | 2015-02-25 15:37:13 +0000 | [diff] [blame] | 95 | ARIZONA_GP_FN_TXLRCLK |
| 96 | ARIZONA_GP_DEFAULT |
| 97 | ARIZONA_GP_DEFAULT |
| 98 | ARIZONA_GP_DEFAULT |
| 99 | ARIZONA_GP_DEFAULT |
Mark Brown | d781009 | 2013-03-25 00:11:27 +0000 | [diff] [blame] | 100 | >; |
| 101 | }; |