Merge branch 'async-scsi-resume' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux.git] / Documentation / devicetree / bindings / mmc / mmc.txt
1 These properties are common to multiple MMC host controllers. Any host
2 that requires the respective functionality should implement them using
3 these definitions.
4
5 Interpreted by the OF core:
6 - reg: Registers location and length.
7 - interrupts: Interrupts used by the MMC controller.
8
9 Card detection:
10 If no property below is supplied, host native card detect is used.
11 Only 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
16 Optional 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 - sd-uhs-sdr12: SD UHS SDR12 speed is supported
30 - sd-uhs-sdr25: SD UHS SDR25 speed is supported
31 - sd-uhs-sdr50: SD UHS SDR50 speed is supported
32 - sd-uhs-sdr104: SD UHS SDR104 speed is supported
33 - sd-uhs-ddr50: SD UHS DDR50 speed is supported
34 - cap-power-off-card: powering off the card is safe
35 - cap-sdio-irq: enable SDIO IRQ signalling on this interface
36 - full-pwr-cycle: full power cycle of the card is supported
37 - mmc-highspeed-ddr-1_8v: eMMC high-speed DDR mode(1.8V I/O) is supported
38 - mmc-highspeed-ddr-1_2v: eMMC high-speed DDR mode(1.2V I/O) is supported
39 - mmc-hs200-1_8v: eMMC HS200 mode(1.8V I/O) is supported
40 - mmc-hs200-1_2v: eMMC HS200 mode(1.2V I/O) is supported
41
42 *NOTE* on CD and WP polarity. To use common for all SD/MMC host controllers line
43 polarity properties, we have to fix the meaning of the "normal" and "inverted"
44 line levels. We choose to follow the SDHCI standard, which specifies both those
45 lines as "active low." Therefore, using the "cd-inverted" property means, that
46 the CD line is active high, i.e. it is high, when a card is inserted. Similar
47 logic applies to the "wp-inverted" property.
48
49 CD and WP lines can be implemented on the hardware in one of two ways: as GPIOs,
50 specified in cd-gpios and wp-gpios properties, or as dedicated pins. Polarity of
51 dedicated pins can be specified, using *-inverted properties. GPIO polarity can
52 also be specified using the OF_GPIO_ACTIVE_LOW flag. This creates an ambiguity
53 in the latter case. We choose to use the XOR logic for GPIO CD and WP lines.
54 This means, the two properties are "superimposed," for example leaving the
55 OF_GPIO_ACTIVE_LOW flag clear and specifying the respective *-inverted
56 property results in a double-inversion and actually means the "normal" line
57 polarity is in effect.
58
59 Optional SDIO properties:
60 - keep-power-in-suspend: Preserves card power during a suspend/resume cycle
61 - enable-sdio-wakeup: Enables wake up of host system on SDIO IRQ assertion
62
63 Example:
64
65 sdhci@ab000000 {
66         compatible = "sdhci";
67         reg = <0xab000000 0x200>;
68         interrupts = <23>;
69         bus-width = <4>;
70         cd-gpios = <&gpio 69 0>;
71         cd-inverted;
72         wp-gpios = <&gpio 70 0>;
73         max-frequency = <50000000>;
74         keep-power-in-suspend;
75         enable-sdio-wakeup;
76 }