Hi Valentin,
On 06/13/2017 03:20 PM, Valentin Sitdikov wrote:
> This patch adds documentation for the max7360 bindings.
> The max7360 is Multi-functional Device containing gpio,
> keypad, pwm and rotary encoder submodules.
>
> Signed-off-by: Andrei Dranitca <andrei_drani...@mentor.com>
> Signed-off-by: Valentin Sitdikov <valentin_sitdi...@mentor.com>
> ---
> Documentation/devicetree/bindings/mfd/max7360.txt | 74
> +++++++++++++++++++++++
> 1 file changed, 74 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/mfd/max7360.txt
>
> diff --git a/Documentation/devicetree/bindings/mfd/max7360.txt
> b/Documentation/devicetree/bindings/mfd/max7360.txt
> new file mode 100644
> index 0000000..c2ceaf9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mfd/max7360.txt
> @@ -0,0 +1,74 @@
> +* Maxim MAX7360 Multi-function Device
> +
> +The Maxim MAX7360 is a Multi-function Device which includes
> +64 key switches, 8 LED drivers/GPIOs, PWM intensity control,
> +and rotary switch control.
> +
> +Required properties:
> +- compatible: Should be the following: "maxim,max7360".
> +- reg: Specifies the I2C slave address of the max7360 block.
> + It can be 0x38, 0x3a, 0x3c or 0x3e IIUC.
"IIUC" note is highly undesirable ;)
> +
> +Optional properties:
> +- interrupt-parent: Specifies the phandle of the interrupt controller to
> + which the interrupts from MAX7360 are routed to.
> +- interrupts: List of IRQ lines specifiers.
> +- interrupt-names: List of "inti" and "intk".
> +- interrupt-controller: Identifies the device as an interrupt
> controller.
> +- #interrupt-cells : Number of cells to encode an interrupt source,
> + shall be 1.
> +
> +Examples:
> +
> +Without subnodes:
> + max7360@38 {
> + compatible = "maxim,max7360";
> + reg = <0x38>;
> + interrupt-parent = <&gpio1>;
> + interrupts = <23 IRQ_TYPE_LEVEL_LOW>, <23 IRQ_TYPE_LEVEL_LOW>;
> + interrupt-names = "inti", "intk";
> + interrupt-controller;
> + #interrupt-cells = <0x1>;
> + };
Can you drop the example above? It does not bring any new information.
> +
> +With subnodes:
> + max7360@38 {
Commonly for device node names generic/device class names are utilized,
however I can not suggest what name is better.
> + compatible = "maxim,max7360";
> + reg = <0x38>;
> + interrupt-parent = <&gpio1>;
> + interrupts = <23 IRQ_TYPE_LEVEL_LOW>, <23 IRQ_TYPE_LEVEL_LOW>;
> + interrupt-names = "inti", "intk";
> + interrupt-controller;
> + #interrupt-cells = <0x1>;
For #*-cells properties plese specify plain integers, #interrupt-cells = <1>;
> +
> + gpio {
> + compatible = "maxim,max7360-gpio";
> + gpio-controller;
> + #gpio-cells = <0x2>;
Please use a plain integer.
> + interrupt-controller;
> + #interrupt-cells = <0x2>;
Please use a plain integer.
> + interrupts = <0>;
> + };
> +
> + keypad {
> + compatible = "maxim,max7360-keypad";
> + maxim,debounce_reg = /bits/ 8 <0xef>;
> + maxim,ports_reg = /bits/ 8 <0xae>;
Here I'd rather suggest
1) use 32-bit values,
2) rename properties by replacing underscore by a hyphen.
> + linux,keymap = < MATRIX_KEY(0, 0, KEY_F5)
> + MATRIX_KEY(1, 0, KEY_F4) >;
> + keypad,num-rows = <2>;
> + keypad,num-columns = <1>;
> + interrupts = <1>;
> + };
> +
> + pwm {
> + compatible = "maxim,max7360-pwm";
> + #pwm-cells = <0x2>;
Please use a plain integer.
> + };
> +
> + rotary-encoder {
> + compatible = "maxim,max7360-rotary";
> + interrupts = <2>;
> + };
> +
Please drop an empty line above.
> + };
>
--
With best wishes,
Vladimir
