diff mbox series

[v2,2/3] dt-bindings: atmel,hlcdc: convert pwm bindings to json-schema

Message ID 20240116113800.82529-3-dharma.b@microchip.com
State New
Headers show
Series Convert Microchip's HLCDC Text based DT bindings to JSON schema | expand

Commit Message

Dharma Balasubiramani Jan. 16, 2024, 11:37 a.m. UTC
Convert device tree bindings for Atmel's HLCDC PWM controller to YAML
format.

Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
---
changelog
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         | 47 +++++++++++++++++++
 .../bindings/pwm/atmel-hlcdc-pwm.txt          | 29 ------------
 2 files changed, 47 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

Comments

Dharma Balasubiramani Jan. 18, 2024, 9:04 a.m. UTC | #1
On 17/01/24 9:03 pm, Conor Dooley wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> 
> ForwardedMessage.eml
> 
> Subject:
> Re: [PATCH v2 2/3] dt-bindings: atmel,hlcdc: convert pwm bindings to 
> json-schema
> From:
> Conor Dooley <conor@kernel.org>
> Date:
> 17/01/24, 9:03 pm
> 
> To:
> Dharma.B@microchip.com
> CC:
> alexandre.belloni@bootlin.com, Conor.Dooley@microchip.com, 
> sam@ravnborg.org, bbrezillon@kernel.org, 
> maarten.lankhorst@linux.intel.com, mripard@kernel.org, 
> tzimmermann@suse.de, airlied@gmail.com, daniel@ffwll.ch, 
> robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org, 
> conor+dt@kernel.org, Nicolas.Ferre@microchip.com, 
> claudiu.beznea@tuxon.dev, dri-devel@lists.freedesktop.org, 
> devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org, 
> linux-kernel@vger.kernel.org, lee@kernel.org, thierry.reding@gmail.com, 
> u.kleine-koenig@pengutronix.de, linux-pwm@vger.kernel.org, 
> Linux4Microchip@microchip.com
> 
> 
> On Wed, Jan 17, 2024 at 02:43:00AM +0000,Dharma.B@microchip.com  wrote:
>> On 17/01/24 1:40 am, Alexandre Belloni wrote:
>>> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
>>>
>>> On 16/01/2024 18:03:19+0000, Conor Dooley wrote:
>>>> On Tue, Jan 16, 2024 at 05:07:59PM +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>
>>>>> ---
>>>>> changelog
>>>>> 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         | 47 +++++++++++++++++++
>>>>>    .../bindings/pwm/atmel-hlcdc-pwm.txt          | 29 ------------
>>>>>    2 files changed, 47 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..751122309fa9
>>>>> --- /dev/null
>>>>> +++ b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml
>>>>> @@ -0,0 +1,47 @@
>>>>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>>>> The original file has no license, but was originally written by a
>>>> free-electrons employee, so the relicensing here is fine.
>>>>
>>> I confirm relicensing is fine, even assigning the copyright to
>>> Microchip (note that Bootlin is legally the same entity as
>>> free-electrons)
>> Thanks Conor and Alexandre.
>> I will add the copyrights back in v3.
> Just to note, in case you misunderstood my original comment here:
> What I said had nothing to do with adding a Microchip copyright assignment
> to the file, but rather about the fact that your patch relicenses the
> binding from GPL v2 to GPL v2 OR BSD 2 Clause.
I appreciate the clarification; my initial understanding was not 
accurate. Thanks
>
diff mbox series

Patch

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..751122309fa9
--- /dev/null
+++ b/Documentation/devicetree/bindings/pwm/atmel,hlcdc-pwm.yaml
@@ -0,0 +1,47 @@ 
+# 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
+    description: |
+      This PWM chip uses the default 3 cells bindings defined in pwm.yaml in
+      this directory.
+
+required:
+  - compatible
+  - "#pwm-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    pwm: 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>;
-		};
-	};