xref: /linux/Documentation/devicetree/bindings/mmc/mmc.txt (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
1These properties are common to multiple MMC host controllers. Any host
2that requires the respective functionality should implement them using
3these definitions.
4
5Interpreted by the OF core:
6- reg: Registers location and length.
7- interrupts: Interrupts used by the MMC controller.
8
9Card detection:
10If no property below is supplied, host native card detect is used.
11Only one of the properties in this section should be supplied:
12  - broken-cd: There is no card detection available; polling must be used.
13  - cd-gpios: Specify GPIOs for card detection, see gpio binding
14  - non-removable: non-removable slot (like eMMC); assume always present.
15
16Optional properties:
17- bus-width: Number of data lines, can be <1>, <4>, or <8>.  The default
18  will be <1> if the property is absent.
19- wp-gpios: Specify GPIOs for write protection, see gpio binding
20- cd-inverted: when present, polarity on the CD line is inverted. See the note
21  below for the case, when a GPIO is used for the CD line
22- wp-inverted: when present, polarity on the WP line is inverted. See the note
23  below for the case, when a GPIO is used for the WP line
24- max-frequency: maximum operating clock frequency
25- no-1-8-v: when present, denotes that 1.8v card voltage is not supported on
26  this system, even if the controller claims it is.
27- cap-sd-highspeed: SD high-speed timing is supported
28- cap-mmc-highspeed: MMC high-speed timing is supported
29- cap-power-off-card: powering off the card is safe
30- cap-sdio-irq: enable SDIO IRQ signalling on this interface
31- full-pwr-cycle: full power cycle of the card is supported
32
33*NOTE* on CD and WP polarity. To use common for all SD/MMC host controllers line
34polarity properties, we have to fix the meaning of the "normal" and "inverted"
35line levels. We choose to follow the SDHCI standard, which specifies both those
36lines as "active low." Therefore, using the "cd-inverted" property means, that
37the CD line is active high, i.e. it is high, when a card is inserted. Similar
38logic applies to the "wp-inverted" property.
39
40CD and WP lines can be implemented on the hardware in one of two ways: as GPIOs,
41specified in cd-gpios and wp-gpios properties, or as dedicated pins. Polarity of
42dedicated pins can be specified, using *-inverted properties. GPIO polarity can
43also be specified using the OF_GPIO_ACTIVE_LOW flag. This creates an ambiguity
44in the latter case. We choose to use the XOR logic for GPIO CD and WP lines.
45This means, the two properties are "superimposed," for example leaving the
46OF_GPIO_ACTIVE_LOW flag clear and specifying the respective *-inverted
47property results in a double-inversion and actually means the "normal" line
48polarity is in effect.
49
50Optional SDIO properties:
51- keep-power-in-suspend: Preserves card power during a suspend/resume cycle
52- enable-sdio-wakeup: Enables wake up of host system on SDIO IRQ assertion
53
54Example:
55
56sdhci@ab000000 {
57	compatible = "sdhci";
58	reg = <0xab000000 0x200>;
59	interrupts = <23>;
60	bus-width = <4>;
61	cd-gpios = <&gpio 69 0>;
62	cd-inverted;
63	wp-gpios = <&gpio 70 0>;
64	max-frequency = <50000000>;
65	keep-power-in-suspend;
66	enable-sdio-wakeup;
67}
68