Documentation/devicetree/bindings/slimbus/bus.txt

   1 SLIM(Serial Low Power Interchip Media Bus) bus
   2
   3 SLIMbus is a 2-wire bus, and is used to communicate with peripheral
   4 components like audio-codec.
   5
   6 Required property for SLIMbus controller node:
   7 - compatible    - name of SLIMbus controller
   8
   9 Child nodes:
  10 Every SLIMbus controller node can contain zero or more child nodes
  11 representing slave devices on the bus. Every SLIMbus slave device is
  12 uniquely determined by the enumeration address containing 4 fields:
  13 Manufacturer ID, Product code, Device index, and Instance value for
  14 the device.
  15 If child node is not present and it is instantiated after device
  16 discovery (slave device reporting itself present).
  17
  18 In some cases it may be necessary to describe non-probeable device
  19 details such as non-standard ways of powering up a device. In
  20 such cases, child nodes for those devices will be present as
  21 slaves of the SLIMbus controller, as detailed below.
  22
  23 Required property for SLIMbus child node if it is present:
  24 - reg           - Should be ('Device index', 'Instance ID') from SLIMbus
  25                   Enumeration  Address.
  26                   Device Index Uniquely identifies multiple Devices within
  27                   a single Component.
  28                   Instance ID Is for the cases where multiple Devices of the
  29                   same type or Class are attached to the bus.
  30
  31 - compatible    -"slimMID,PID". The textual representation of Manufacturer ID,
  32                   Product Code, shall be in lower case hexadecimal with leading
  33                   zeroes suppressed
  34
  35 Optional property for SLIMbus child node if it is present:
  36 - slim-ifc-dev  - Should be phandle to SLIMBus Interface device.
  37                   Required for devices which deal with streams.
  38
  39 SLIMbus example for Qualcomm's slimbus manager component:
  40
  41         slim@28080000 {
  42                 compatible = "qcom,apq8064-slim", "qcom,slim";
  43                 reg = <0x28080000 0x2000>,
  44                 interrupts = <0 33 0>;
  45                 clocks = <&lcc SLIMBUS_SRC>, <&lcc AUDIO_SLIMBUS_CLK>;
  46                 clock-names = "iface", "core";
  47                 #address-cells = <2>;
  48                 #size-cell = <0>;
  49
  50                 codec_ifd: ifd@0,0{
  51                         compatible = "slim217,60";
  52                         reg = <0 0>;
  53                 };
  54
  55                 codec: wcd9310@1,0{
  56                         compatible = "slim217,60";
  57                         reg = <1 0>;
  58                         slim-ifc-dev  = <&codec_ifd>;
  59                 };
  60         };