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
  23 Required properties:
  24
  25   - compatible : One of the following strings:
  26                  "cirrus,lochnagar1"
  27                  "cirrus,lochnagar2"
  28
  29   - reg : I2C slave address
  30
  31   - reset-gpios : Reset line to the Lochnagar, see [1].
  32
  33 Required sub-nodes:
  34
  35   - lochnagar-clk : Binding for the clocking components, see [4].
  36
  37   - lochnagar-pinctrl : Binding for the pin control components, see [5].
  38
  39 Optional sub-nodes:
  40
  41   - Bindings for the regulator components, see [6]. Only available on
  42     Lochnagar 2.
  43
  44 Optional properties:
  45
  46   - present-gpios : Host present line, indicating the presence of a
  47     host system, see [1]. This can be omitted if the present line is
  48     tied in hardware.
  49
  50 Example:
  51
  52 lochnagar: lochnagar@22 {
  53         compatible = "cirrus,lochnagar2";
  54         reg = <0x22>;
  55
  56         reset-gpios = <&gpio0 55 0>;
  57         present-gpios = <&gpio0 60 0>;
  58
  59         lochnagar-clk {
  60                 compatible = "cirrus,lochnagar2-clk";
  61                 ...
  62         };
  63
  64         lochnagar-pinctrl {
  65                 compatible = "cirrus,lochnagar-pinctrl";
  66                 ...
  67         };
  68 };