[PATCHv2 1/2] dt: document the of_serial bindings

[Grant Likely]

On Thu, Jun 23, 2011 at 8:56 AM, Grant Likely <grant.likely at secretlab.ca> wrote:
> On Thu, Jun 23, 2011 at 8:55 AM, Grant Likely <grant.likely at secretlab.ca> wrote:
>> On Thu, Jun 23, 2011 at 8:08 AM, Jamie Iles <jamie at jamieiles.com> wrote:
>>> The of_serial bindings can be used to register a number of serial
>>> devices.  Document this binding with all of the others.
>>>
>>> Cc: Grant Likely <grant.likely at secretlab.ca>
>>> Cc: Arnd Bergmann <arnd at arndb.de>
>>> Signed-off-by: Jamie Iles <jamie at jamieiles.com>
>>> ---
>>>  .../devicetree/bindings/tty/serial/of-serial.txt   |   34 ++++++++++++++++++++
>>>  1 files changed, 34 insertions(+), 0 deletions(-)
>>>  create mode 100644 Documentation/devicetree/bindings/tty/serial/of-serial.txt
>>>
>>> diff --git a/Documentation/devicetree/bindings/tty/serial/of-serial.txt b/Documentation/devicetree/bindings/tty/serial/of-serial.txt
>>> new file mode 100644
>>> index 0000000..b0c52c2
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/tty/serial/of-serial.txt
>>> @@ -0,0 +1,34 @@
>>> +* UART (Universal Asynchronous Receiver/Transmitter)
>>> +
>>> +Required properties:
>>> +- compatible : one of:
>>> +       - "ns8250"
>>> +       - "ns16450"
>>> +       - "ns16550a"
>>> +       - "ns16550"
>>> +       - "ns16750"
>>> +       - "ns16850"
>>> +       - "nvidia,tegra250-uart"
>>> +       - "ibm,qpace-nwp-serial"
>>> +       - "serial" if the port type is unknown.
>>> +- reg : offset and length of the register set for the device.
>>> +- interrupts : should contain uart interrupt.
>>> +- clock-frequency : the input clock frequency for the UART.
>>> +
>>> +Optional properties:
>>> +- current-speed : the current active speed of the UART.
>>> +- reg-offset : offset to apply to the mapbase from the start of the registers.
>>> +- reg-shift : quantity to shift the register offsets by.
>>> +- used-by-rtas : set to indicate that the port is in use by the firmware and
>>> +  should not be registered.
>>> +
>>> +Example:
>>> +
>>> +       uart at 80230000 {
>>> +               compatible = "ns8250";
>>> +               device-type = "serial";
>>
>> Drop device-type.  Otherwise looks good.
>
> Although the used-by-rtas description should probably mention
> specifically that it is used by OpenFirmware RTAS.

Oh, and device tree documentation changes should cc: the
devicetree-discuss at lists.ozlabs.org mailing list.

g.