blob: 420ec9529fb4414c646d640ec264e3c710a097e2 [file] [log] [blame]
Simon Glassafb61342013-12-03 16:43:25 -07001SPI (Serial Peripheral Interface) busses
2
3SPI busses can be described with a node for the SPI master device
4and a set of child nodes for each SPI slave on the bus. For this
5discussion, it is assumed that the system's SPI controller is in
6SPI master mode. This binding does not describe SPI controllers
7in slave mode.
8
9The SPI master node requires the following properties:
10- #address-cells - number of cells required to define a chip select
11 address on the SPI bus.
12- #size-cells - should be zero.
13- compatible - name of SPI bus controller following generic names
14 recommended practice.
15- cs-gpios - (optional) gpios chip select.
16No other properties are required in the SPI bus node. It is assumed
17that a driver for an SPI bus device will understand that it is an SPI bus.
18However, the binding does not attempt to define the specific method for
19assigning chip select numbers. Since SPI chip select configuration is
20flexible and non-standardized, it is left out of this binding with the
21assumption that board specific platform code will be used to manage
22chip selects. Individual drivers can define additional properties to
23support describing the chip select layout.
24
25Optional property:
26- num-cs : total number of chipselects
27
28If cs-gpios is used the number of chip select will automatically increased
29with max(cs-gpios > hw cs)
30
31So if for example the controller has 2 CS lines, and the cs-gpios
32property looks like this:
33
34cs-gpios = <&gpio1 0 0> <0> <&gpio1 1 0> <&gpio1 2 0>;
35
36Then it should be configured so that num_chipselect = 4 with the
37following mapping:
38
39cs0 : &gpio1 0 0
40cs1 : native
41cs2 : &gpio1 1 0
42cs3 : &gpio1 2 0
43
44SPI slave nodes must be children of the SPI master node and can
45contain the following properties.
46- reg - (required) chip select address of device.
47- compatible - (required) name of SPI device following generic names
48 recommended practice
49- spi-max-frequency - (required) Maximum SPI clocking speed of device in Hz
50- spi-cpol - (optional) Empty property indicating device requires
51 inverse clock polarity (CPOL) mode
52- spi-cpha - (optional) Empty property indicating device requires
53 shifted clock phase (CPHA) mode
54- spi-cs-high - (optional) Empty property indicating device requires
55 chip select active high
56- spi-3wire - (optional) Empty property indicating device requires
57 3-wire mode.
58- spi-tx-bus-width - (optional) The bus width(number of data wires) that
59 used for MOSI. Defaults to 1 if not present.
60- spi-rx-bus-width - (optional) The bus width(number of data wires) that
61 used for MISO. Defaults to 1 if not present.
Simon Glass22052c62014-07-07 10:16:39 -060062- spi-half-duplex - (optional) Indicates that the SPI bus should wait for
63 a header byte before reading data from the slave.
Simon Glassafb61342013-12-03 16:43:25 -070064
65Some SPI controllers and devices support Dual and Quad SPI transfer mode.
Vagrant Cascadiana6f70a32016-03-15 12:16:39 -070066It allows data in SPI system transferred in 2 wires(DUAL) or 4 wires(QUAD).
Simon Glassafb61342013-12-03 16:43:25 -070067Now the value that spi-tx-bus-width and spi-rx-bus-width can receive is
68only 1(SINGLE), 2(DUAL) and 4(QUAD).
69Dual/Quad mode is not allowed when 3-wire mode is used.
70
71If a gpio chipselect is used for the SPI slave the gpio number will be passed
72via the cs_gpio
73
74SPI example for an MPC5200 SPI bus:
75 spi@f00 {
76 #address-cells = <1>;
77 #size-cells = <0>;
78 compatible = "fsl,mpc5200b-spi","fsl,mpc5200-spi";
79 reg = <0xf00 0x20>;
80 interrupts = <2 13 0 2 14 0>;
81 interrupt-parent = <&mpc5200_pic>;
82
83 ethernet-switch@0 {
84 compatible = "micrel,ks8995m";
85 spi-max-frequency = <1000000>;
86 reg = <0>;
87 };
88
89 codec@1 {
90 compatible = "ti,tlv320aic26";
91 spi-max-frequency = <100000>;
92 reg = <1>;
93 };
94 };