| Message ID | 20210526094609.14068-2-steven_lee@aspeedtech.com |
|---|---|
| State | New |
| Headers | show |
| Series | ASPEED sgpio driver enhancement. | expand |
On Wed, 26 May 2021 17:46:05 +0800, Steven Lee wrote: > SGPIO bindings should be converted as yaml format. > In addition to the file conversion, a new property max-ngpios is > added in the yaml file as well. > The new property is required by the enhanced sgpio driver for > making the configuration of the max number of gpio pins more flexible. > > Signed-off-by: Steven Lee <steven_lee@aspeedtech.com> > --- > .../bindings/gpio/aspeed,sgpio.yaml | 91 +++++++++++++++++++ > .../devicetree/bindings/gpio/sgpio-aspeed.txt | 46 ---------- > 2 files changed, 91 insertions(+), 46 deletions(-) > create mode 100644 Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml > delete mode 100644 Documentation/devicetree/bindings/gpio/sgpio-aspeed.txt > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13): yamllint warnings/errors: dtschema/dtc warnings/errors: ./Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml: $id: relative path/filename doesn't match actual path or filename expected: http://devicetree.org/schemas/gpio/aspeed,sgpio.yaml# See https://patchwork.ozlabs.org/patch/1483966 This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1. If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date: pip3 install dtschema --upgrade Please check and re-submit.
Hi Steven, On Wed, 26 May 2021, at 19:16, Steven Lee wrote: > SGPIO bindings should be converted as yaml format. > In addition to the file conversion, a new property max-ngpios is > added in the yaml file as well. > The new property is required by the enhanced sgpio driver for > making the configuration of the max number of gpio pins more flexible. Please add the new property in a separate patch to the YAML conversion. Having changes to the properties in addition to switching to dt schema makes it harder to catch errors, and it seems Rob's bot has already picked up some. Reviewing the changes as separate patches means its easier to give you a Reviewed-by tag on that patches I'm happy with. Andrew
The 05/27/2021 08:57, Andrew Jeffery wrote: > Hi Steven, > > On Wed, 26 May 2021, at 19:16, Steven Lee wrote: > > SGPIO bindings should be converted as yaml format. > > In addition to the file conversion, a new property max-ngpios is > > added in the yaml file as well. > > The new property is required by the enhanced sgpio driver for > > making the configuration of the max number of gpio pins more flexible. > > Please add the new property in a separate patch to the YAML conversion. > Having changes to the properties in addition to switching to dt schema > makes it harder to catch errors, and it seems Rob's bot has already > picked up some. > > Reviewing the changes as separate patches means its easier to give you > a Reviewed-by tag on that patches I'm happy with. > Thanks for your suggestion, I will add the new property in a separate patch in v3 patch series. > Andrew
Hi Steven, > SGPIO bindings should be converted as yaml format. > In addition to the file conversion, a new property max-ngpios is > added in the yaml file as well. > The new property is required by the enhanced sgpio driver for > making the configuration of the max number of gpio pins more > flexible. There are a number of things going on here - you're doing the YAML conversion, introducing the max-gpios property, and changing the compatible value. The first two make sense, but may be better split into separate changes, so that the YAML conversion is a "linear" change. I'm not clear on why you're changing the compatible value though, particularly as you're dropping support for the existing compatible value anyway. How about we keep the old one, and use the default of 128 for cases where max-ngpios is absent? That way, we retain support for the existing device trees. > + max-ngpios: > + description: > + represents the number of actual hardware-supported GPIOs (ie, > + slots within the clocked serial GPIO data). Since each HW GPIO is both an > + input and an output, we provide max_ngpios * 2 lines on our gpiochip > + device. We also use it to define the split between the inputs and > + outputs; the inputs start at line 0, the outputs start at max_ngpios. Most of this description is better suited to the ngpios property, which controls the number of lines that the gpiochip will expose. Also, minor nit: max_ngpios -> max-ngpios. How about something like: ngpios: description: Number of GPIO lines to expose. Since each HW GPIO is an input and an output, we provide ngpios * 2 lines on our chip device. We also use it to define the split between the inputs and outputs; the inputs start at line 0, the outputs start at ngpios. max-ngpios: description: Represents the number of actual hardware-supported GPIOs (ie, slots within the clocked serial GPIO data), and therefore the maximum value for the ngpios property > + minimum: 0 > + maximum: 128 Will this be the case for all (future) hardware? Can we leave this unbound? Cheers, Jeremy
The 05/26/2021 20:56, Rob Herring wrote: > On Wed, 26 May 2021 17:46:05 +0800, Steven Lee wrote: > > SGPIO bindings should be converted as yaml format. > > In addition to the file conversion, a new property max-ngpios is > > added in the yaml file as well. > > The new property is required by the enhanced sgpio driver for > > making the configuration of the max number of gpio pins more flexible. > > > > Signed-off-by: Steven Lee <steven_lee@aspeedtech.com> > > --- > > .../bindings/gpio/aspeed,sgpio.yaml | 91 +++++++++++++++++++ > > .../devicetree/bindings/gpio/sgpio-aspeed.txt | 46 ---------- > > 2 files changed, 91 insertions(+), 46 deletions(-) > > create mode 100644 Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml > > delete mode 100644 Documentation/devicetree/bindings/gpio/sgpio-aspeed.txt > > > > My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' > on your patch (DT_CHECKER_FLAGS is new in v5.13): > > yamllint warnings/errors: > > dtschema/dtc warnings/errors: > ./Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml: $id: relative path/filename doesn't match actual path or filename > expected: http://devicetree.org/schemas/gpio/aspeed,sgpio.yaml# > > See https://patchwork.ozlabs.org/patch/1483966 > > This check can fail if there are any dependencies. The base for a patch > series is generally the most recent rc1. > > If you already ran 'make dt_binding_check' and didn't see the above > error(s), then make sure 'yamllint' is installed and dt-schema is up to > date: > > pip3 install dtschema --upgrade > > Please check and re-submit. > Thanks, I will modify it.
The 05/27/2021 09:42, Jeremy Kerr wrote: > Hi Steven, > > > SGPIO bindings should be converted as yaml format. > > In addition to the file conversion, a new property max-ngpios is > > added in the yaml file as well. > > The new property is required by the enhanced sgpio driver for > > making the configuration of the max number of gpio pins more > > flexible. > > There are a number of things going on here - you're doing the YAML > conversion, introducing the max-gpios property, and changing the > compatible value. > > The first two make sense, but may be better split into separate > changes, so that the YAML conversion is a "linear" change. > Thanks for your suggestion, I will split them into 2 patches. > I'm not clear on why you're changing the compatible value though, > particularly as you're dropping support for the existing compatible > value anyway. How about we keep the old one, and use the default of 128 > for cases where max-ngpios is absent? That way, we retain support for > the existing device trees. > AST2600 support both SGPIO master and slave interfaces. So we decide to rename sgpio to sgpiom as it is the driver for sgpio master interface. Since Andrew also point out the compatibility issues, I will modify driver to keep the original design. > > + max-ngpios: > > + description: > > + represents the number of actual hardware-supported GPIOs (ie, > > + slots within the clocked serial GPIO data). Since each HW GPIO is both an > > + input and an output, we provide max_ngpios * 2 lines on our gpiochip > > + device. We also use it to define the split between the inputs and > > + outputs; the inputs start at line 0, the outputs start at max_ngpios. > > Most of this description is better suited to the ngpios property, which > controls the number of lines that the gpiochip will expose. > > Also, minor nit: max_ngpios -> max-ngpios. > > How about something like: > > ngpios: > description: > Number of GPIO lines to expose. Since each HW GPIO is an input and an > output, we provide ngpios * 2 lines on our chip device. We also use it > to define the split between the inputs and outputs; the inputs start at > line 0, the outputs start at ngpios. > > max-ngpios: > description: > Represents the number of actual hardware-supported GPIOs (ie, slots within > the clocked serial GPIO data), and therefore the maximum value for > the ngpios property > I will modify the description as you suggested. > > + minimum: 0 > > + maximum: 128 > > Will this be the case for all (future) hardware? Can we leave this > unbound? > Since the future hardware may supports more gpios, I will remove it. > Cheers, > > > Jeremy >
diff --git a/Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml b/Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml new file mode 100644 index 000000000000..8b8588a29685 --- /dev/null +++ b/Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml @@ -0,0 +1,91 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/gpio/sgpio-aspeed.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Aspeed SGPIO controller + +maintainers: + - Andrew Jeffery <andrew@aj.id.au> + +description: + This SGPIO controller is for ASPEED AST2400, AST2500 and AST2600 SoC, + AST2600 have two sgpio master one with 128 pins another one with 80 pins, + AST2500/AST2400 have one sgpio master with 80 pins. Each of the Serial + GPIO pins can be programmed to support the following options + - Support interrupt option for each input port and various interrupt + sensitivity option (level-high, level-low, edge-high, edge-low) + - Support reset tolerance option for each output port + - Directly connected to APB bus and its shift clock is from APB bus clock + divided by a programmable value. + - Co-work with external signal-chained TTL components (74LV165/74LV595) + +properties: + compatible: + enum: + - aspeed,ast2400-sgpiom + - aspeed,ast2500-sgpiom + - aspeed,ast2600-sgpiom + + reg: + maxItems: 1 + + gpio-controller: true + + '#gpio-cells': + const: 2 + + interrupts: + maxItems: 1 + + interrupt-controller: true + + clocks: + maxItems: 1 + + ngpios: + minimum: 0 + maximum: 128 + + max-ngpios: + description: + represents the number of actual hardware-supported GPIOs (ie, + slots within the clocked serial GPIO data). Since each HW GPIO is both an + input and an output, we provide max_ngpios * 2 lines on our gpiochip + device. We also use it to define the split between the inputs and + outputs; the inputs start at line 0, the outputs start at max_ngpios. + minimum: 0 + maximum: 128 + + bus-frequency: true + +required: + - compatible + - reg + - gpio-controller + - '#gpio-cells' + - interrupts + - interrupt-controller + - ngpios + - max-ngpios + - clocks + - bus-frequency + +additionalProperties: false + +examples: + - | + #include <dt-bindings/clock/aspeed-clock.h> + sgpio: sgpio@1e780200 { + #gpio-cells = <2>; + compatible = "aspeed,ast2500-sgpiom"; + gpio-controller; + interrupts = <40>; + reg = <0x1e780200 0x0100>; + clocks = <&syscon ASPEED_CLK_APB>; + interrupt-controller; + ngpios = <8>; + max-ngpios = <80>; + bus-frequency = <12000000>; + }; diff --git a/Documentation/devicetree/bindings/gpio/sgpio-aspeed.txt b/Documentation/devicetree/bindings/gpio/sgpio-aspeed.txt deleted file mode 100644 index be329ea4794f..000000000000 --- a/Documentation/devicetree/bindings/gpio/sgpio-aspeed.txt +++ /dev/null @@ -1,46 +0,0 @@ -Aspeed SGPIO controller Device Tree Bindings --------------------------------------------- - -This SGPIO controller is for ASPEED AST2500 SoC, it supports up to 80 full -featured Serial GPIOs. Each of the Serial GPIO pins can be programmed to -support the following options: -- Support interrupt option for each input port and various interrupt - sensitivity option (level-high, level-low, edge-high, edge-low) -- Support reset tolerance option for each output port -- Directly connected to APB bus and its shift clock is from APB bus clock - divided by a programmable value. -- Co-work with external signal-chained TTL components (74LV165/74LV595) - -Required properties: - -- compatible : Should be one of - "aspeed,ast2400-sgpio", "aspeed,ast2500-sgpio" -- #gpio-cells : Should be 2, see gpio.txt -- reg : Address and length of the register set for the device -- gpio-controller : Marks the device node as a GPIO controller -- interrupts : Interrupt specifier, see interrupt-controller/interrupts.txt -- interrupt-controller : Mark the GPIO controller as an interrupt-controller -- ngpios : number of *hardware* GPIO lines, see gpio.txt. This will expose - 2 software GPIOs per hardware GPIO: one for hardware input, one for hardware - output. Up to 80 pins, must be a multiple of 8. -- clocks : A phandle to the APB clock for SGPM clock division -- bus-frequency : SGPM CLK frequency - -The sgpio and interrupt properties are further described in their respective -bindings documentation: - -- Documentation/devicetree/bindings/gpio/gpio.txt -- Documentation/devicetree/bindings/interrupt-controller/interrupts.txt - - Example: - sgpio: sgpio@1e780200 { - #gpio-cells = <2>; - compatible = "aspeed,ast2500-sgpio"; - gpio-controller; - interrupts = <40>; - reg = <0x1e780200 0x0100>; - clocks = <&syscon ASPEED_CLK_APB>; - interrupt-controller; - ngpios = <8>; - bus-frequency = <12000000>; - };
SGPIO bindings should be converted as yaml format. In addition to the file conversion, a new property max-ngpios is added in the yaml file as well. The new property is required by the enhanced sgpio driver for making the configuration of the max number of gpio pins more flexible. Signed-off-by: Steven Lee <steven_lee@aspeedtech.com> --- .../bindings/gpio/aspeed,sgpio.yaml | 91 +++++++++++++++++++ .../devicetree/bindings/gpio/sgpio-aspeed.txt | 46 ---------- 2 files changed, 91 insertions(+), 46 deletions(-) create mode 100644 Documentation/devicetree/bindings/gpio/aspeed,sgpio.yaml delete mode 100644 Documentation/devicetree/bindings/gpio/sgpio-aspeed.txt