blob: cc128ae6134a379bd83c78f9d3956fa033eff090 [file] [log] [blame]
Kumar Galab053dc52009-06-19 08:31:05 -05001SPI (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.
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010015- cs-gpios - (optional) gpios chip select.
Kumar Galab053dc52009-06-19 08:31:05 -050016No 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
Roland Stigge41962f92012-08-22 15:49:19 +020025Optional property:
26- num-cs : total number of chipselects
27
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010028If 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
Kumar Galab053dc52009-06-19 08:31:05 -050044SPI 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
Lars-Peter Clausenc20151d2012-12-06 16:55:33 +010056- spi-3wire - (optional) Empty property indicating device requires
57 3-wire mode.
wangyuhanga110f932013-09-01 17:36:21 +080058- 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.
62
63Some SPI controllers and devices support Dual and Quad SPI transfer mode.
Carlos Garciac98be0c2014-04-04 22:31:00 -040064It allows data in the SPI system to be transferred in 2 wires(DUAL) or 4 wires(QUAD).
wangyuhanga110f932013-09-01 17:36:21 +080065Now the value that spi-tx-bus-width and spi-rx-bus-width can receive is
66only 1(SINGLE), 2(DUAL) and 4(QUAD).
67Dual/Quad mode is not allowed when 3-wire mode is used.
Kumar Galab053dc52009-06-19 08:31:05 -050068
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010069If a gpio chipselect is used for the SPI slave the gpio number will be passed
Baruch Siachba1271b2013-12-05 13:39:05 +020070via the SPI master node cs-gpios property.
Jean-Christophe PLAGNIOL-VILLARD74317982012-11-15 20:19:57 +010071
Kumar Galab053dc52009-06-19 08:31:05 -050072SPI example for an MPC5200 SPI bus:
73 spi@f00 {
74 #address-cells = <1>;
75 #size-cells = <0>;
76 compatible = "fsl,mpc5200b-spi","fsl,mpc5200-spi";
77 reg = <0xf00 0x20>;
78 interrupts = <2 13 0 2 14 0>;
79 interrupt-parent = <&mpc5200_pic>;
80
81 ethernet-switch@0 {
82 compatible = "micrel,ks8995m";
83 spi-max-frequency = <1000000>;
84 reg = <0>;
85 };
86
87 codec@1 {
88 compatible = "ti,tlv320aic26";
89 spi-max-frequency = <100000>;
90 reg = <1>;
91 };
92 };