Message ID | 20240118092612.117491-3-dharma.b@microchip.com (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | Convert Microchip's HLCDC Text based DT bindings to JSON schema | expand |
Hello, On Thu, Jan 18, 2024 at 02:56:11PM +0530, Dharma Balasubiramani wrote: > Convert device tree bindings for Atmel's HLCDC PWM controller to YAML > format. > > Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com> > Reviewed-by: Conor Dooley <conor.dooley@microchip.com> Reviewed-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> I will update the short log to dt-bindings: pwm: atmel,hlcdc: Convert bindings to json-schema to match my preferences (unless you object) and apply for next after the merge window. Best regards Uwe
On Thu, Jan 18, 2024 at 02:56:11PM +0530, Dharma Balasubiramani wrote: > Convert device tree bindings for Atmel's HLCDC PWM controller to YAML > format. > > Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com> > Reviewed-by: Conor Dooley <conor.dooley@microchip.com> > --- > changelog > v2 -> v3 > - Remove '|' in description, as there is no formatting to preserve. > - Delete the description for pwm-cells. > - Drop the label for pwm node as it not used. > v1 -> v2 > - Remove the explicit copyrights. > - Modify title (not include words like binding/driver). > - Modify description actually describing the hardware and not the driver. > - Remove pinctrl properties which aren't required. > - Drop parent node and it's other sub-device node which are not related here. > --- > .../bindings/pwm/atmel,hlcdc-pwm.yaml | 44 +++++++++++++++++++ > .../bindings/pwm/atmel-hlcdc-pwm.txt | 29 ------------ > 2 files changed, 44 insertions(+), 29 deletions(-) > create mode 100644 Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml > delete mode 100644 Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt > > diff --git a/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml > new file mode 100644 > index 000000000000..4f4cc21fe4f7 > --- /dev/null > +++ b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml > @@ -0,0 +1,44 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/pwm/atmel,hlcdc-pwm.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Atmel's HLCDC's PWM controller > + > +maintainers: > + - Nicolas Ferre <nicolas.ferre@microchip.com> > + - Alexandre Belloni <alexandre.belloni@bootlin.com> > + - Claudiu Beznea <claudiu.beznea@tuxon.dev> > + > +description: > + The LCDC integrates a Pulse Width Modulation (PWM) Controller. This block > + generates the LCD contrast control signal (LCD_PWM) that controls the > + display's contrast by software. LCDC_PWM is an 8-bit PWM signal that can be > + converted to an analog voltage with a simple passive filter. LCD display > + panels have different backlight specifications in terms of minimum/maximum > + values for PWM frequency. If the LCDC PWM frequency range does not match the > + LCD display panel, it is possible to use the standalone PWM Controller to > + drive the backlight. > + > +properties: > + compatible: > + const: atmel,hlcdc-pwm > + > + "#pwm-cells": > + const: 3 > + > +required: > + - compatible > + - "#pwm-cells" > + > +additionalProperties: false > + > +examples: > + - | > + pwm { > + compatible = "atmel,hlcdc-pwm"; > + pinctrl-names = "default"; > + pinctrl-0 = <&pinctrl_lcd_pwm>; > + #pwm-cells = <3>; > + }; Move the example to the MFD schema. Or just drop if already there. Rob
Hello, On Thu, Jan 18, 2024 at 11:16:49AM +0100, Uwe Kleine-König wrote: > On Thu, Jan 18, 2024 at 02:56:11PM +0530, Dharma Balasubiramani wrote: > > Convert device tree bindings for Atmel's HLCDC PWM controller to YAML > > format. > > > > Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com> > > Reviewed-by: Conor Dooley <conor.dooley@microchip.com> > > Reviewed-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > > I will update the short log to > > dt-bindings: pwm: atmel,hlcdc: Convert bindings to json-schema > > to match my preferences (unless you object) and apply for next after the > merge window. Dropped from my todo-list after Rob's feedback. Best regards Uwe
Hi Rob, On 20/01/24 1:15 am, Rob Herring wrote: > EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe > > On Thu, Jan 18, 2024 at 02:56:11PM +0530, Dharma Balasubiramani wrote: >> Convert device tree bindings for Atmel's HLCDC PWM controller to YAML >> format. >> >> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com> >> Reviewed-by: Conor Dooley <conor.dooley@microchip.com> >> --- >> changelog >> v2 -> v3 >> - Remove '|' in description, as there is no formatting to preserve. >> - Delete the description for pwm-cells. >> - Drop the label for pwm node as it not used. >> v1 -> v2 >> - Remove the explicit copyrights. >> - Modify title (not include words like binding/driver). >> - Modify description actually describing the hardware and not the driver. >> - Remove pinctrl properties which aren't required. >> - Drop parent node and it's other sub-device node which are not related here. >> --- >> .../bindings/pwm/atmel,hlcdc-pwm.yaml | 44 +++++++++++++++++++ >> .../bindings/pwm/atmel-hlcdc-pwm.txt | 29 ------------ >> 2 files changed, 44 insertions(+), 29 deletions(-) >> create mode 100644 Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml >> delete mode 100644 Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt >> >> diff --git a/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml >> new file mode 100644 >> index 000000000000..4f4cc21fe4f7 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml >> @@ -0,0 +1,44 @@ >> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) >> +%YAML 1.2 >> +--- >> +$id: http://devicetree.org/schemas/pwm/atmel,hlcdc-pwm.yaml# >> +$schema: http://devicetree.org/meta-schemas/core.yaml# >> + >> +title: Atmel's HLCDC's PWM controller >> + >> +maintainers: >> + - Nicolas Ferre <nicolas.ferre@microchip.com> >> + - Alexandre Belloni <alexandre.belloni@bootlin.com> >> + - Claudiu Beznea <claudiu.beznea@tuxon.dev> >> + >> +description: >> + The LCDC integrates a Pulse Width Modulation (PWM) Controller. This block >> + generates the LCD contrast control signal (LCD_PWM) that controls the >> + display's contrast by software. LCDC_PWM is an 8-bit PWM signal that can be >> + converted to an analog voltage with a simple passive filter. LCD display >> + panels have different backlight specifications in terms of minimum/maximum >> + values for PWM frequency. If the LCDC PWM frequency range does not match the >> + LCD display panel, it is possible to use the standalone PWM Controller to >> + drive the backlight. >> + >> +properties: >> + compatible: >> + const: atmel,hlcdc-pwm >> + >> + "#pwm-cells": >> + const: 3 >> + >> +required: >> + - compatible >> + - "#pwm-cells" >> + >> +additionalProperties: false >> + >> +examples: >> + - | >> + pwm { >> + compatible = "atmel,hlcdc-pwm"; >> + pinctrl-names = "default"; >> + pinctrl-0 = <&pinctrl_lcd_pwm>; >> + #pwm-cells = <3>; >> + }; > > Move the example to the MFD schema. Or just drop if already there. As Sam suggested I will send v4 series with this binding as it is and will send the clean up patch later.
diff --git a/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml new file mode 100644 index 000000000000..4f4cc21fe4f7 --- /dev/null +++ b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml @@ -0,0 +1,44 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/pwm/atmel,hlcdc-pwm.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Atmel's HLCDC's PWM controller + +maintainers: + - Nicolas Ferre <nicolas.ferre@microchip.com> + - Alexandre Belloni <alexandre.belloni@bootlin.com> + - Claudiu Beznea <claudiu.beznea@tuxon.dev> + +description: + The LCDC integrates a Pulse Width Modulation (PWM) Controller. This block + generates the LCD contrast control signal (LCD_PWM) that controls the + display's contrast by software. LCDC_PWM is an 8-bit PWM signal that can be + converted to an analog voltage with a simple passive filter. LCD display + panels have different backlight specifications in terms of minimum/maximum + values for PWM frequency. If the LCDC PWM frequency range does not match the + LCD display panel, it is possible to use the standalone PWM Controller to + drive the backlight. + +properties: + compatible: + const: atmel,hlcdc-pwm + + "#pwm-cells": + const: 3 + +required: + - compatible + - "#pwm-cells" + +additionalProperties: false + +examples: + - | + pwm { + compatible = "atmel,hlcdc-pwm"; + pinctrl-names = "default"; + pinctrl-0 = <&pinctrl_lcd_pwm>; + #pwm-cells = <3>; + }; diff --git a/Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt b/Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt deleted file mode 100644 index afa501bf7f94..000000000000 --- a/Documentation/devicetree/bindings/pwm/atmel-hlcdc-pwm.txt +++ /dev/null @@ -1,29 +0,0 @@ -Device-Tree bindings for Atmel's HLCDC (High-end LCD Controller) PWM driver - -The Atmel HLCDC PWM is subdevice of the HLCDC MFD device. -See ../mfd/atmel-hlcdc.txt for more details. - -Required properties: - - compatible: value should be one of the following: - "atmel,hlcdc-pwm" - - pinctr-names: the pin control state names. Should contain "default". - - pinctrl-0: should contain the pinctrl states described by pinctrl - default. - - #pwm-cells: should be set to 3. This PWM chip use the default 3 cells - bindings defined in pwm.yaml in this directory. - -Example: - - hlcdc: hlcdc@f0030000 { - compatible = "atmel,sama5d3-hlcdc"; - reg = <0xf0030000 0x2000>; - clocks = <&lcdc_clk>, <&lcdck>, <&clk32k>; - clock-names = "periph_clk","sys_clk", "slow_clk"; - - hlcdc_pwm: hlcdc-pwm { - compatible = "atmel,hlcdc-pwm"; - pinctrl-names = "default"; - pinctrl-0 = <&pinctrl_lcd_pwm>; - #pwm-cells = <3>; - }; - };