1 # SPDX-License-Identifier: GPL-2.0 1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2 2 %YAML 1.2
3 --- 3 ---
4 $id: http://devicetree.org/schemas/serial/pl01 4 $id: http://devicetree.org/schemas/serial/pl011.yaml#
5 $schema: http://devicetree.org/meta-schemas/co 5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6 6
7 title: ARM AMBA Primecell PL011 serial UART 7 title: ARM AMBA Primecell PL011 serial UART
8 8
9 maintainers: 9 maintainers:
10 - Rob Herring <robh@kernel.org> 10 - Rob Herring <robh@kernel.org>
11 11
12 allOf: 12 allOf:
13 - $ref: /schemas/arm/primecell.yaml# 13 - $ref: /schemas/arm/primecell.yaml#
14 - $ref: serial.yaml# 14 - $ref: serial.yaml#
15 15
16 # Need a custom select here or 'arm,primecell' 16 # Need a custom select here or 'arm,primecell' will match on lots of nodes
17 select: 17 select:
18 properties: 18 properties:
19 compatible: 19 compatible:
20 contains: 20 contains:
21 enum: 21 enum:
22 - arm,pl011 22 - arm,pl011
23 required: 23 required:
24 - compatible 24 - compatible
25 25
26 properties: 26 properties:
27 compatible: 27 compatible:
28 items: 28 items:
29 - const: arm,pl011 29 - const: arm,pl011
30 - const: arm,primecell 30 - const: arm,primecell
31 31
32 reg: 32 reg:
33 maxItems: 1 33 maxItems: 1
34 34
35 interrupts: 35 interrupts:
36 maxItems: 1 36 maxItems: 1
37 37
38 pinctrl-0: true 38 pinctrl-0: true
39 pinctrl-1: true 39 pinctrl-1: true
40 40
41 pinctrl-names: 41 pinctrl-names:
42 description: 42 description:
43 When present, must have one state named 43 When present, must have one state named "default",
44 and may contain a second name named "sle 44 and may contain a second name named "sleep". The former
45 state sets up pins for ordinary operatio 45 state sets up pins for ordinary operation whereas
46 the latter state will put the associated 46 the latter state will put the associated pins to sleep
47 when the UART is unused 47 when the UART is unused
48 minItems: 1 48 minItems: 1
49 items: 49 items:
50 - const: default 50 - const: default
51 - const: sleep 51 - const: sleep
52 52
53 clocks: 53 clocks:
54 description: 54 description:
55 When present, the first clock listed mus 55 When present, the first clock listed must correspond to
56 the clock named UARTCLK on the IP block, 56 the clock named UARTCLK on the IP block, i.e. the clock
57 to the external serial line, whereas the 57 to the external serial line, whereas the second clock
58 must correspond to the PCLK clocking the 58 must correspond to the PCLK clocking the internal logic
59 of the block. Just listing one clock (th 59 of the block. Just listing one clock (the first one) is
60 deprecated. 60 deprecated.
61 maxItems: 2 61 maxItems: 2
62 62
63 clock-names: 63 clock-names:
64 items: 64 items:
65 - const: uartclk 65 - const: uartclk
66 - const: apb_pclk 66 - const: apb_pclk
67 67
68 dmas: 68 dmas:
69 minItems: 1 69 minItems: 1
70 maxItems: 2 70 maxItems: 2
71 71
72 dma-names: 72 dma-names:
73 minItems: 1 73 minItems: 1
74 items: 74 items:
75 - const: rx 75 - const: rx
76 - const: tx 76 - const: tx
77 77
78 auto-poll: 78 auto-poll:
79 description: 79 description:
80 Enables polling when using RX DMA. 80 Enables polling when using RX DMA.
81 type: boolean 81 type: boolean
82 82
83 poll-rate-ms: 83 poll-rate-ms:
84 description: 84 description:
85 Rate at which poll occurs when auto-poll 85 Rate at which poll occurs when auto-poll is set.
86 default 100ms. 86 default 100ms.
87 default: 100 87 default: 100
88 88
89 poll-timeout-ms: 89 poll-timeout-ms:
90 description: 90 description:
91 Poll timeout when auto-poll is set, defa 91 Poll timeout when auto-poll is set, default
92 3000ms. 92 3000ms.
93 default: 3000 93 default: 3000
94 94
95 resets: 95 resets:
96 maxItems: 1 96 maxItems: 1
97 97
98 reg-io-width: 98 reg-io-width:
99 description: 99 description:
100 The size (in bytes) of the IO accesses t 100 The size (in bytes) of the IO accesses that should be performed
101 on the device. 101 on the device.
102 enum: [1, 4] 102 enum: [1, 4]
103 103
104 required: 104 required:
105 - compatible 105 - compatible
106 - reg 106 - reg
107 - interrupts 107 - interrupts
108 108
109 dependencies: 109 dependencies:
110 poll-rate-ms: [ auto-poll ] 110 poll-rate-ms: [ auto-poll ]
111 poll-timeout-ms: [ auto-poll ] 111 poll-timeout-ms: [ auto-poll ]
112 112
113 unevaluatedProperties: false 113 unevaluatedProperties: false
114 114
115 examples: 115 examples:
116 - | 116 - |
117 serial@80120000 { 117 serial@80120000 {
118 compatible = "arm,pl011", "arm,primecell 118 compatible = "arm,pl011", "arm,primecell";
119 reg = <0x80120000 0x1000>; 119 reg = <0x80120000 0x1000>;
120 interrupts = <0 11 4>; 120 interrupts = <0 11 4>;
121 dmas = <&dma 13 0 0x2>, <&dma 13 0 0x0>; 121 dmas = <&dma 13 0 0x2>, <&dma 13 0 0x0>;
122 dma-names = "rx", "tx"; 122 dma-names = "rx", "tx";
123 clocks = <&foo_clk>, <&bar_clk>; 123 clocks = <&foo_clk>, <&bar_clk>;
124 clock-names = "uartclk", "apb_pclk"; 124 clock-names = "uartclk", "apb_pclk";
125 }; 125 };
126 126
127 ... 127 ...
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.