Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt

   1 Cirrus Logic Lochnagar Audio Development Board
   2
   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.
  10
  11 Also see these documents for generic binding information:
  12   [1] GPIO : ../gpio/gpio.txt
  13
  14 And these for relevant defines:
  15   [2] include/dt-bindings/pinctrl/lochnagar.h
  16   [3] include/dt-bindings/clock/lochnagar.h
  17
  18 And these documents for the required sub-node binding details:
  19   [4] Clock: ../clock/cirrus,lochnagar.txt
  20   [5] Pinctrl: ../pinctrl/cirrus,lochnagar.txt
  21   [6] Regulator: ../regulator/cirrus,lochnagar.txt
  22   [7] Sound: ../sound/cirrus,lochnagar.txt
  23   [8] Hardware Monitor: ../hwmon/cirrus,lochnagar.txt
  24
  25 Required properties:
  26
  27   - compatible : One of the following strings:
  28                  "cirrus,lochnagar1"
  29                  "cirrus,lochnagar2"
  30
  31   - reg : I2C slave address
  32
  33   - reset-gpios : Reset line to the Lochnagar, see [1].
  34
  35 Required sub-nodes:
  36
  37   - lochnagar-clk : Binding for the clocking components, see [4].
  38
  39   - lochnagar-pinctrl : Binding for the pin control components, see [5].
  40
  41 Optional sub-nodes:
  42
  43   - Bindings for the regulator components, see [6]. Only available on
  44     Lochnagar 2.
  45
  46   - lochnagar-sc : Binding for the sound card components, see [7].
  47                    Only available on Lochnagar 2.
  48   - lochnagar-hwmon : Binding for the hardware monitor components, see [8].
  49                       Only available on Lochnagar 2.
  50
  51 Optional properties:
  52
  53   - present-gpios : Host present line, indicating the presence of a
  54     host system, see [1]. This can be omitted if the present line is
  55     tied in hardware.
  56
  57 Example:
  58
  59 lochnagar: lochnagar@22 {
  60         compatible = "cirrus,lochnagar2";
  61         reg = <0x22>;
  62
  63         reset-gpios = <&gpio0 55 0>;
  64         present-gpios = <&gpio0 60 0>;
  65
  66         lochnagar-clk {
  67                 compatible = "cirrus,lochnagar2-clk";
  68                 ...
  69         };
  70
  71         lochnagar-pinctrl {
  72                 compatible = "cirrus,lochnagar-pinctrl";
  73                 ...
  74         };
  75
  76         lochnagar-sc {
  77                 compatible = "cirrus,lochnagar2-soundcard";
  78                 ...
  79         };
  80
  81         lochnagar-hwmon {
  82                 compatible = "cirrus,lochnagar2-hwmon";
  83                 ...
  84         };
  85 };