diff options
author | Matt Porter <mporter@konsulko.com> | 2015-02-26 10:38:45 -0500 |
---|---|---|
committer | Tony Lindgren <tony@atomide.com> | 2015-03-16 17:59:43 -0400 |
commit | 5c8a521d447682037221535bd898a9d182d25c7d (patch) | |
tree | 575cd9abdc28e903592f0dccd867eb1a821391ef /Documentation | |
parent | 49d094570c59ba9e60efacd5b08a248ab9f6d59a (diff) |
Documentation: DT: omap_serial: document missing properties and add an example
The omap_serial.txt binding documentation lacks a number of properties
that are used in DTS files for platforms incorporating this peripheral.
Fix this by documenting the missing required and optional fields and
add an example.
Signed-off-by: Matt Porter <mporter@konsulko.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/devicetree/bindings/serial/omap_serial.txt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/serial/omap_serial.txt b/Documentation/devicetree/bindings/serial/omap_serial.txt index 342eedd10050..54c2a155c783 100644 --- a/Documentation/devicetree/bindings/serial/omap_serial.txt +++ b/Documentation/devicetree/bindings/serial/omap_serial.txt | |||
@@ -4,7 +4,27 @@ Required properties: | |||
4 | - compatible : should be "ti,omap2-uart" for OMAP2 controllers | 4 | - compatible : should be "ti,omap2-uart" for OMAP2 controllers |
5 | - compatible : should be "ti,omap3-uart" for OMAP3 controllers | 5 | - compatible : should be "ti,omap3-uart" for OMAP3 controllers |
6 | - compatible : should be "ti,omap4-uart" for OMAP4 controllers | 6 | - compatible : should be "ti,omap4-uart" for OMAP4 controllers |
7 | - reg : address and length of the register space | ||
8 | - interrupts or interrupts-extended : Should contain the uart interrupt | ||
9 | specifier or both the interrupt | ||
10 | controller phandle and interrupt | ||
11 | specifier. | ||
7 | - ti,hwmods : Must be "uart<n>", n being the instance number (1-based) | 12 | - ti,hwmods : Must be "uart<n>", n being the instance number (1-based) |
8 | 13 | ||
9 | Optional properties: | 14 | Optional properties: |
10 | - clock-frequency : frequency of the clock input to the UART | 15 | - clock-frequency : frequency of the clock input to the UART |
16 | - dmas : DMA specifier, consisting of a phandle to the DMA controller | ||
17 | node and a DMA channel number. | ||
18 | - dma-names : "rx" for receive channel, "tx" for transmit channel. | ||
19 | |||
20 | Example: | ||
21 | |||
22 | uart4: serial@49042000 { | ||
23 | compatible = "ti,omap3-uart"; | ||
24 | reg = <0x49042000 0x400>; | ||
25 | interrupts = <80>; | ||
26 | dmas = <&sdma 81 &sdma 82>; | ||
27 | dma-names = "tx", "rx"; | ||
28 | ti,hwmods = "uart4"; | ||
29 | clock-frequency = <48000000>; | ||
30 | }; | ||