Documentation/devicetree/bindings/mmc/synopsys-dw-mshc.txt

   1 * Synopsys Designware Mobile Storage Host Controller
   2
   3 The Synopsys designware mobile storage host controller is used to interface
   4 a SoC with storage medium such as eMMC or SD/MMC cards. This file documents
   5 differences between the core mmc properties described by mmc.txt and the
   6 properties used by the Synopsys Designware Mobile Storage Host Controller.
   7
   8 Required Properties:
   9
  10 * compatible: should be
  11         - snps,dw-mshc: for controllers compliant with synopsys dw-mshc.
  12 * #address-cells: should be 1.
  13 * #size-cells: should be 0.
  14
  15 # Slots: The slot specific information are contained within child-nodes with
  16   each child-node representing a supported slot. There should be atleast one
  17   child node representing a card slot. The name of the child node representing
  18   the slot is recommended to be slot@n where n is the unique number of the slot
  19   connnected to the controller. The following are optional properties which
  20   can be included in the slot child node.
  21
  22         * reg: specifies the physical slot number. The valid values of this
  23           property is 0 to (num-slots -1), where num-slots is the value
  24           specified by the num-slots property.
  25
  26         * bus-width: as documented in mmc core bindings.
  27
  28         * wp-gpios: specifies the write protect gpio line. The format of the
  29           gpio specifier depends on the gpio controller. If a GPIO is not used
  30           for write-protect, this property is optional.
  31
  32         * disable-wp: If the wp-gpios property isn't present then (by default)
  33           we'd assume that the write protect is hooked up directly to the
  34           controller's special purpose write protect line (accessible via
  35           the WRTPRT register).  However, it's possible that we simply don't
  36           want write protect.  In that case specify 'disable-wp'.
  37           NOTE: This property is not required for slots known to always
  38           connect to eMMC or SDIO cards.
  39
  40 Optional properties:
  41
  42 * clocks: from common clock binding: handle to biu and ciu clocks for the
  43   bus interface unit clock and the card interface unit clock.
  44
  45 * clock-names: from common clock binding: Shall be "biu" and "ciu".
  46   If the biu clock is missing we'll simply skip enabling it.  If the
  47   ciu clock is missing we'll just assume that the clock is running at
  48   clock-frequency.  It is an error to omit both the ciu clock and the
  49   clock-frequency.
  50
  51 * clock-frequency: should be the frequency (in Hz) of the ciu clock.  If this
  52   is specified and the ciu clock is specified then we'll try to set the ciu
  53   clock to this at probe time.
  54
  55 * clock-freq-min-max (DEPRECATED): Minimum and Maximum clock frequency for card output
  56   clock(cclk_out). If it's not specified, max is 200MHZ and min is 400KHz by default.
  57           (Use the "max-frequency" instead of "clock-freq-min-max".)
  58
  59 * num-slots: specifies the number of slots supported by the controller.
  60   The number of physical slots actually used could be equal or less than the
  61   value specified by num-slots. If this property is not specified, the value
  62   of num-slot property is assumed to be 1.
  63
  64 * fifo-depth: The maximum size of the tx/rx fifo's. If this property is not
  65   specified, the default value of the fifo size is determined from the
  66   controller registers.
  67
  68 * card-detect-delay: Delay in milli-seconds before detecting card after card
  69   insert event. The default value is 0.
  70
  71 * supports-highspeed (DEPRECATED): Enables support for high speed cards (up to 50MHz)
  72                            (use "cap-mmc-highspeed" or "cap-sd-highspeed" instead)
  73
  74 * broken-cd: as documented in mmc core bindings.
  75
  76 * vmmc-supply: The phandle to the regulator to use for vmmc.  If this is
  77   specified we'll defer probe until we can find this regulator.
  78
  79 * dmas: List of DMA specifiers with the controller specific format as described
  80   in the generic DMA client binding. Refer to dma.txt for details.
  81
  82 * dma-names: request names for generic DMA client binding. Must be "rx-tx".
  83   Refer to dma.txt for details.
  84
  85 Aliases:
  86
  87 - All the MSHC controller nodes should be represented in the aliases node using
  88   the following format 'mshc{n}' where n is a unique number for the alias.
  89
  90 Example:
  91
  92 The MSHC controller node can be split into two portions, SoC specific and
  93 board specific portions as listed below.
  94
  95         dwmmc0@12200000 {
  96                 compatible = "snps,dw-mshc";
  97                 clocks = <&clock 351>, <&clock 132>;
  98                 clock-names = "biu", "ciu";
  99                 reg = <0x12200000 0x1000>;
 100                 interrupts = <0 75 0>;
 101                 #address-cells = <1>;
 102                 #size-cells = <0>;
 103         };
 104
 105 [board specific internal DMA resources]
 106
 107         dwmmc0@12200000 {
 108                 clock-frequency = <400000000>;
 109                 clock-freq-min-max = <400000 200000000>;
 110                 num-slots = <1>;
 111                 broken-cd;
 112                 fifo-depth = <0x80>;
 113                 card-detect-delay = <200>;
 114                 vmmc-supply = <&buck8>;
 115                 bus-width = <8>;
 116                 cap-mmc-highspeed;
 117                 cap-sd-highspeed;
 118         };
 119
 120 [board specific generic DMA request binding]
 121
 122         dwmmc0@12200000 {
 123                 clock-frequency = <400000000>;
 124                 clock-freq-min-max = <400000 200000000>;
 125                 num-slots = <1>;
 126                 broken-cd;
 127                 fifo-depth = <0x80>;
 128                 card-detect-delay = <200>;
 129                 vmmc-supply = <&buck8>;
 130                 bus-width = <8>;
 131                 cap-mmc-highspeed;
 132                 cap-sd-highspeed;
 133                 dmas = <&pdma 12>;
 134                 dma-names = "rx-tx";
 135         };