treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / regulator / cirrus,lochnagar.txt
blob91974e6ee251b3da061f9bb53f326ef1f810a9b9
1 Cirrus Logic Lochnagar Audio Development Board
3 Lochnagar is an evaluation and development board for Cirrus Logic
4 Smart CODEC and Amp devices. It allows the connection of most Cirrus
5 Logic devices on mini-cards, as well as allowing connection of
6 various application processor systems to provide a full evaluation
7 platform.  Audio system topology, clocking and power can all be
8 controlled through the Lochnagar, allowing the device under test
9 to be used in a variety of possible use cases.
11 This binding document describes the binding for the regulator portion
12 of the driver.
14 Also see these documents for generic binding information:
15   [1] Regulator: ../regulator/regulator.txt
17 This binding must be part of the Lochnagar MFD binding:
18   [2] ../mfd/cirrus,lochnagar.txt
20 Optional sub-nodes:
22   - VDDCORE : Initialisation data for the VDDCORE regulator, which
23     supplies the CODECs digital core if it has no build regulator for that
24     purpose.
25       Required Properties:
26       - compatible : One of the following strings:
27                      "cirrus,lochnagar2-vddcore"
28       - SYSVDD-supply: Primary power supply for the Lochnagar.
30   - MICVDD : Initialisation data for the MICVDD regulator, which
31     supplies the CODECs MICVDD.
32       Required Properties:
33       - compatible : One of the following strings:
34                      "cirrus,lochnagar2-micvdd"
35       - SYSVDD-supply: Primary power supply for the Lochnagar.
37   - MIC1VDD, MIC2VDD : Initialisation data for the MICxVDD supplies.
38       Required Properties:
39       - compatible : One of the following strings:
40                      "cirrus,lochnagar2-mic1vdd", "cirrus,lochnagar2-mic2vdd"
41       Optional Properties:
42       - cirrus,micbias-input : A property selecting which of the CODEC
43         minicard micbias outputs should be used, valid values are 1 - 4.
44       - MICBIAS1-supply, MICBIAS2-supply: Regulator supplies for the
45         MICxVDD outputs, supplying the digital microphones, normally
46         supplied from the attached CODEC.
48   - VDD1V8 : Recommended fixed regulator for the VDD1V8 regulator, which supplies the
49     CODECs analog and 1.8V digital supplies.
50       Required Properties:
51       - compatible : Should be set to "regulator-fixed"
52       - regulator-min-microvolt : Should be set to 1.8V
53       - regulator-max-microvolt : Should be set to 1.8V
54       - regulator-boot-on
55       - regulator-always-on
56       - vin-supply : Should be set to same supply as SYSVDD
58 Example:
60 lochnagar {
61         lochnagar-micvdd: MICVDD {
62                 compatible = "cirrus,lochnagar2-micvdd";
64                 SYSVDD-supply = <&wallvdd>;
66                 regulator-min-microvolt = <3300000>;
67                 regulator-max-microvolt = <3300000>;
68         };
70         lochnagar-vdd1v8: VDD1V8 {
71                 compatible = "regulator-fixed";
73                 regulator-name = "VDD1V8";
74                 regulator-min-microvolt = <1800000>;
75                 regulator-max-microvolt = <1800000>;
76                 regulator-boot-on;
77                 regulator-always-on;
79                 vin-supply = <&wallvdd>;
80         };