diff options
| author | Jonas Bonn <jonas@southpole.se> | 2010-11-24 19:26:22 +0300 |
|---|---|---|
| committer | Ben Dooks <ben-linux@fluff.org> | 2011-01-04 04:04:29 +0300 |
| commit | d9240e612ba79287e29f2eac52f94a2016fb0914 (patch) | |
| tree | fb07170246eeb12c87a3e1261b008d7e13360385 | |
| parent | 47def5b80f087d033013c0609679812cfafd6b49 (diff) | |
| download | linux-d9240e612ba79287e29f2eac52f94a2016fb0914.tar.xz | |
i2c-ocores: add some device tree documentation
This puts some documentation for the device tree configuration at the head
of the driver file. Hopefully this can get moved to a common area for this
type of documentation at a later date; unfortunately, there isn't really
such a place in the kernel tree at this time.
Furthermore, the regstep and clock-frequency parameters are really bus
parameters and should probably be passed to the driver in a better way.
Consider that a TODO.
Signed-off-by: Jonas Bonn <jonas@southpole.se>
Signed-off-by: Ben Dooks <ben-linux@fluff.org>
| -rw-r--r-- | drivers/i2c/busses/i2c-ocores.c | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/drivers/i2c/busses/i2c-ocores.c b/drivers/i2c/busses/i2c-ocores.c index dee0352737d7..ef3bcb1ce864 100644 --- a/drivers/i2c/busses/i2c-ocores.c +++ b/drivers/i2c/busses/i2c-ocores.c @@ -9,6 +9,41 @@ * kind, whether express or implied. */ +/* + * Device tree configuration: + * + * Required properties: + * - compatible : "opencores,i2c-ocores" + * - reg : bus address start and address range size of device + * - interrupts : interrupt number + * - regstep : size of device registers in bytes + * - clock-frequency : frequency of bus clock in Hz + * + * Example: + * + * i2c0: ocores@a0000000 { + * compatible = "opencores,i2c-ocores"; + * reg = <0xa0000000 0x8>; + * interrupts = <10>; + * + * regstep = <1>; + * clock-frequency = <20000000>; + * + * -- Devices connected on this I2C bus get + * -- defined here; address- and size-cells + * -- apply to these child devices + * + * #address-cells = <1>; + * #size-cells = <0>; + * + * dummy@60 { + * compatible = "dummy"; + * reg = <60>; + * }; + * }; + * + */ + #include <linux/kernel.h> #include <linux/module.h> #include <linux/init.h> |