xref: /freebsd-src/sys/contrib/device-tree/Bindings/mmc/mmc-pwrseq-simple.yaml (revision cb7aa33ac6cd46a5434798e50363136e64f3ae98)
1c66ec88fSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0
2c66ec88fSEmmanuel Vadot%YAML 1.2
3c66ec88fSEmmanuel Vadot---
4c66ec88fSEmmanuel Vadot$id: http://devicetree.org/schemas/mmc/mmc-pwrseq-simple.yaml#
5c66ec88fSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6c66ec88fSEmmanuel Vadot
78bab661aSEmmanuel Vadottitle: Simple MMC power sequence provider
8c66ec88fSEmmanuel Vadot
9c66ec88fSEmmanuel Vadotmaintainers:
10c66ec88fSEmmanuel Vadot  - Ulf Hansson <ulf.hansson@linaro.org>
11c66ec88fSEmmanuel Vadot
12c66ec88fSEmmanuel Vadotdescription:
13c66ec88fSEmmanuel Vadot  The purpose of the simple MMC power sequence provider is to supports a set
14c66ec88fSEmmanuel Vadot  of common properties between various SOC designs. It thus enables us to use
15c66ec88fSEmmanuel Vadot  the same provider for several SOC designs.
16c66ec88fSEmmanuel Vadot
17c66ec88fSEmmanuel Vadotproperties:
18c66ec88fSEmmanuel Vadot  compatible:
19c66ec88fSEmmanuel Vadot    const: mmc-pwrseq-simple
20c66ec88fSEmmanuel Vadot
21c66ec88fSEmmanuel Vadot  reset-gpios:
22c66ec88fSEmmanuel Vadot    minItems: 1
236be33864SEmmanuel Vadot    # Put some limit to avoid false warnings
246be33864SEmmanuel Vadot    maxItems: 32
25c66ec88fSEmmanuel Vadot    description:
26c66ec88fSEmmanuel Vadot      contains a list of GPIO specifiers. The reset GPIOs are asserted
27c66ec88fSEmmanuel Vadot      at initialization and prior we start the power up procedure of the card.
28c66ec88fSEmmanuel Vadot      They will be de-asserted right after the power has been provided to the
29c66ec88fSEmmanuel Vadot      card.
30c66ec88fSEmmanuel Vadot
31c66ec88fSEmmanuel Vadot  clocks:
32c66ec88fSEmmanuel Vadot    minItems: 1
33c66ec88fSEmmanuel Vadot    description: Handle for the entry in clock-names.
34c66ec88fSEmmanuel Vadot
35c66ec88fSEmmanuel Vadot  clock-names:
36c66ec88fSEmmanuel Vadot    items:
37c66ec88fSEmmanuel Vadot      - const: ext_clock
38c66ec88fSEmmanuel Vadot    description: External clock provided to the card.
39c66ec88fSEmmanuel Vadot
40c66ec88fSEmmanuel Vadot  post-power-on-delay-ms:
41c66ec88fSEmmanuel Vadot    description:
42c66ec88fSEmmanuel Vadot      Delay in ms after powering the card and de-asserting the
43c66ec88fSEmmanuel Vadot      reset-gpios (if any).
44c66ec88fSEmmanuel Vadot
45c66ec88fSEmmanuel Vadot  power-off-delay-us:
46c66ec88fSEmmanuel Vadot    description:
47c66ec88fSEmmanuel Vadot      Delay in us after asserting the reset-gpios (if any)
48c66ec88fSEmmanuel Vadot      during power off of the card.
49c66ec88fSEmmanuel Vadot
50c66ec88fSEmmanuel Vadotrequired:
51c66ec88fSEmmanuel Vadot  - compatible
52c66ec88fSEmmanuel Vadot
536be33864SEmmanuel VadotadditionalProperties: false
546be33864SEmmanuel Vadot
55c66ec88fSEmmanuel Vadotexamples:
56c66ec88fSEmmanuel Vadot  - |
57c66ec88fSEmmanuel Vadot    #include <dt-bindings/gpio/gpio.h>
58*cb7aa33aSEmmanuel Vadot    pwrseq {
59c66ec88fSEmmanuel Vadot      compatible = "mmc-pwrseq-simple";
60c66ec88fSEmmanuel Vadot      reset-gpios = <&gpio1 12 GPIO_ACTIVE_LOW>;
61c66ec88fSEmmanuel Vadot      clocks = <&clk_32768_ck>;
62c66ec88fSEmmanuel Vadot      clock-names = "ext_clock";
63c66ec88fSEmmanuel Vadot    };
64c66ec88fSEmmanuel Vadot...
65