diff mbox series

[net-next,v3,1/3] dt-bindings: net: fec: add pps channel property

Message ID 20240809094804.391441-2-francesco@dolcini.it (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series net: fec: add PPS channel configuration | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 7 this patch: 7
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 14 of 14 maintainers
netdev/build_clang success Errors and warnings before: 7 this patch: 7
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 7 this patch: 7
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 13 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-08-09--15-00 (tests: 705)

Commit Message

Francesco Dolcini Aug. 9, 2024, 9:48 a.m. UTC
From: Francesco Dolcini <francesco.dolcini@toradex.com>

Add fsl,pps-channel property to specify to which timer instance the PPS
channel is connected to.

Signed-off-by: Francesco Dolcini <francesco.dolcini@toradex.com>
---
v3: added net-next subject prefix
v2: no changes
---
 Documentation/devicetree/bindings/net/fsl,fec.yaml | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Conor Dooley Aug. 9, 2024, 2:27 p.m. UTC | #1
On Fri, Aug 09, 2024 at 11:48:02AM +0200, Francesco Dolcini wrote:
> From: Francesco Dolcini <francesco.dolcini@toradex.com>
> 
> Add fsl,pps-channel property to specify to which timer instance the PPS
> channel is connected to.

In the driver patch you say "depending on the soc ... might be routed to
different timer instances", why is a soc-specific compatible
insufficient to determine which timer instance is in use?
I think I know what you mean, but I'm not 100%.

That said, the explanation in the driver patch is better than the one
here, so a commit message improvement is required.

Cheers,
Conor.

> 
> Signed-off-by: Francesco Dolcini <francesco.dolcini@toradex.com>
> ---
> v3: added net-next subject prefix
> v2: no changes
> ---
>  Documentation/devicetree/bindings/net/fsl,fec.yaml | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/net/fsl,fec.yaml b/Documentation/devicetree/bindings/net/fsl,fec.yaml
> index 5536c06139ca..24e863fdbdab 100644
> --- a/Documentation/devicetree/bindings/net/fsl,fec.yaml
> +++ b/Documentation/devicetree/bindings/net/fsl,fec.yaml
> @@ -183,6 +183,13 @@ properties:
>      description:
>        Register bits of stop mode control, the format is <&gpr req_gpr req_bit>.
>  
> +  fsl,pps-channel:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    default: 0
> +    description:
> +      Specifies to which timer instance the PPS signal is routed.
> +    enum: [0, 1, 2, 3]
> +
>    mdio:
>      $ref: mdio.yaml#
>      unevaluatedProperties: false
> -- 
> 2.39.2
>
Francesco Dolcini Aug. 9, 2024, 2:49 p.m. UTC | #2
On Fri, Aug 09, 2024 at 03:27:39PM +0100, Conor Dooley wrote:
> On Fri, Aug 09, 2024 at 11:48:02AM +0200, Francesco Dolcini wrote:
> > From: Francesco Dolcini <francesco.dolcini@toradex.com>
> > 
> > Add fsl,pps-channel property to specify to which timer instance the PPS
> > channel is connected to.
> 
> In the driver patch you say "depending on the soc ... might be routed to
> different timer instances", why is a soc-specific compatible
> insufficient to determine which timer instance is in use?
> I think I know what you mean, but I'm not 100%.
> 
> That said, the explanation in the driver patch is better than the one
> here, so a commit message improvement is required.

This was clarified by NXP during the discussion on this series [1] and the
commit messages were not amended to take this new information into
account, my fault.

I would propose something like this here:

```
Add fsl,pps-channel property to select where to connect the PPS
signal. This depends on the internal SoC routing and on the board, for
example on the i.MX8 SoC it can be connected to an external pin (using
channel 1) or to internal eDMA as DMA request (channel 0).
```

Francesco

[1] https://lore.kernel.org/all/ZrPYOWA3FESx197L@lizhi-Precision-Tower-5810/
Conor Dooley Aug. 9, 2024, 3:10 p.m. UTC | #3
On Fri, Aug 09, 2024 at 04:49:14PM +0200, Francesco Dolcini wrote:
> On Fri, Aug 09, 2024 at 03:27:39PM +0100, Conor Dooley wrote:
> > On Fri, Aug 09, 2024 at 11:48:02AM +0200, Francesco Dolcini wrote:
> > > From: Francesco Dolcini <francesco.dolcini@toradex.com>
> > > 
> > > Add fsl,pps-channel property to specify to which timer instance the PPS
> > > channel is connected to.
> > 
> > In the driver patch you say "depending on the soc ... might be routed to
> > different timer instances", why is a soc-specific compatible
> > insufficient to determine which timer instance is in use?
> > I think I know what you mean, but I'm not 100%.
> > 
> > That said, the explanation in the driver patch is better than the one
> > here, so a commit message improvement is required.
> 
> This was clarified by NXP during the discussion on this series [1] and the
> commit messages were not amended to take this new information into
> account, my fault.
> 
> I would propose something like this here:
> 
> ```
> Add fsl,pps-channel property to select where to connect the PPS
> signal. This depends on the internal SoC routing and on the board, for
> example on the i.MX8 SoC it can be connected to an external pin (using
> channel 1) or to internal eDMA as DMA request (channel 0).
> ```

That's definitely better, as it illustrates why the compatible is not
sufficient.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/fsl,fec.yaml b/Documentation/devicetree/bindings/net/fsl,fec.yaml
index 5536c06139ca..24e863fdbdab 100644
--- a/Documentation/devicetree/bindings/net/fsl,fec.yaml
+++ b/Documentation/devicetree/bindings/net/fsl,fec.yaml
@@ -183,6 +183,13 @@  properties:
     description:
       Register bits of stop mode control, the format is <&gpr req_gpr req_bit>.
 
+  fsl,pps-channel:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    default: 0
+    description:
+      Specifies to which timer instance the PPS signal is routed.
+    enum: [0, 1, 2, 3]
+
   mdio:
     $ref: mdio.yaml#
     unevaluatedProperties: false