diff mbox series

[net-next,v5,1/2] dt-bindings: net: microchip,ksz: document microchip,rmii-clk-internal

Message ID 0ea1db6b2f2e93c3531645f98888775a4d3165d4.1700841353.git.ante.knezic@helmholz.de
State Superseded
Headers show
Series net: dsa: microchip: enable setting rmii reference | expand

Commit Message

Ante Knezic Nov. 24, 2023, 4:01 p.m. UTC
Add documentation for selecting reference rmii clock on KSZ88X3 devices
Signed-off-by: Ante Knezic <ante.knezic@helmholz.de>
---
 .../devicetree/bindings/net/dsa/microchip,ksz.yaml | 38 +++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

Comments

kernel test robot Nov. 25, 2023, 12:18 a.m. UTC | #1
Hi Ante,

kernel test robot noticed the following build warnings:

[auto build test WARNING on net-next/main]

url:    https://github.com/intel-lab-lkp/linux/commits/Ante-Knezic/dt-bindings-net-microchip-ksz-document-microchip-rmii-clk-internal/20231125-000625
base:   net-next/main
patch link:    https://lore.kernel.org/r/0ea1db6b2f2e93c3531645f98888775a4d3165d4.1700841353.git.ante.knezic%40helmholz.de
patch subject: [PATCH net-next v5 1/2] dt-bindings: net: microchip,ksz: document microchip,rmii-clk-internal
compiler: loongarch64-linux-gcc (GCC) 13.2.0
reproduce: (https://download.01.org/0day-ci/archive/20231125/202311250528.gG5FVdW6-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202311250528.gG5FVdW6-lkp@intel.com/

dtcheck warnings: (new ones prefixed by >>)
>> Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml:99:1: [error] syntax error: found character '\t' that cannot start any token (syntax)
--
>> Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml:99:1: found character that cannot start any token
--
>> Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml: ignoring, error parsing file

vim +99 Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml

     8	
     9	maintainers:
    10	  - Marek Vasut <marex@denx.de>
    11	  - Woojung Huh <Woojung.Huh@microchip.com>
    12	
    13	allOf:
    14	  - $ref: /schemas/spi/spi-peripheral-props.yaml#
    15	
    16	properties:
    17	  # See Documentation/devicetree/bindings/net/dsa/dsa.yaml for a list of additional
    18	  # required and optional properties.
    19	  compatible:
    20	    enum:
    21	      - microchip,ksz8765
    22	      - microchip,ksz8794
    23	      - microchip,ksz8795
    24	      - microchip,ksz8863
    25	      - microchip,ksz8873
    26	      - microchip,ksz9477
    27	      - microchip,ksz9897
    28	      - microchip,ksz9896
    29	      - microchip,ksz9567
    30	      - microchip,ksz8565
    31	      - microchip,ksz9893
    32	      - microchip,ksz9563
    33	      - microchip,ksz8563
    34	
    35	  reset-gpios:
    36	    description:
    37	      Should be a gpio specifier for a reset line.
    38	    maxItems: 1
    39	
    40	  wakeup-source: true
    41	
    42	  microchip,synclko-125:
    43	    $ref: /schemas/types.yaml#/definitions/flag
    44	    description:
    45	      Set if the output SYNCLKO frequency should be set to 125MHz instead of 25MHz.
    46	
    47	  microchip,synclko-disable:
    48	    $ref: /schemas/types.yaml#/definitions/flag
    49	    description:
    50	      Set if the output SYNCLKO clock should be disabled. Do not mix with
    51	      microchip,synclko-125.
    52	
    53	  microchip,io-drive-strength-microamp:
    54	    description:
    55	      IO Pad Drive Strength
    56	    enum: [8000, 16000]
    57	    default: 16000
    58	
    59	  microchip,hi-drive-strength-microamp:
    60	    description:
    61	      High Speed Drive Strength. Controls drive strength of GMII / RGMII /
    62	      MII / RMII (except TX_CLK/REFCLKI, COL and CRS) and CLKO_25_125 lines.
    63	    enum: [2000, 4000, 8000, 12000, 16000, 20000, 24000, 28000]
    64	    default: 24000
    65	
    66	  microchip,lo-drive-strength-microamp:
    67	    description:
    68	      Low Speed Drive Strength. Controls drive strength of TX_CLK / REFCLKI,
    69	      COL, CRS, LEDs, PME_N, NTRP_N, SDO and SDI/SDA/MDIO lines.
    70	    enum: [2000, 4000, 8000, 12000, 16000, 20000, 24000, 28000]
    71	    default: 8000
    72	
    73	  interrupts:
    74	    maxItems: 1
    75	
    76	required:
    77	  - compatible
    78	  - reg
    79	
    80	if:
    81	  not:
    82	    properties:
    83	      compatible:
    84	        enum:
    85	          - microchip,ksz8863
    86	          - microchip,ksz8873
    87	then:
    88	  $ref: dsa.yaml#/$defs/ethernet-ports
    89	else:
    90	  patternProperties:
    91	    "^(ethernet-)?ports$":
    92	      patternProperties:
    93	        "^(ethernet-)?port@[0-2]$":
    94	          $ref: dsa-port.yaml#
    95	          properties:
    96	            microchip,rmii-clk-internal:
    97	              $ref: /schemas/types.yaml#/definitions/flag
    98	              description:
  > 99		        When ksz88x3 is acting as clock provier (via REFCLKO) it
   100			can select between internal and external RMII reference
   101			clock. Internal reference clock means that the clock for
   102			the RMII of ksz88x3 is provided by the ksz88x3 internally
   103			and the REFCLKI pin is unconnected. For the external
   104			reference clock, the clock needs to be fed back to ksz88x3
   105			via REFCLKI.
   106			If microchip,rmii-clk-internal is set, ksz88x3 will provide
   107			rmii reference clock internally, otherwise reference clock
   108			should be provided externally.
   109	          if:
   110	            not:
   111	              required: [ ethernet ]
   112	          then:
   113	            properties:
   114	              microchip,rmii-clk-internal: false
   115	          unevaluatedProperties: false
   116
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml b/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
index b3029c64d0d5..3cebb9c9b1c8 100644
--- a/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
+++ b/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
@@ -11,7 +11,6 @@  maintainers:
   - Woojung Huh <Woojung.Huh@microchip.com>
 
 allOf:
-  - $ref: dsa.yaml#/$defs/ethernet-ports
   - $ref: /schemas/spi/spi-peripheral-props.yaml#
 
 properties:
@@ -78,6 +77,43 @@  required:
   - compatible
   - reg
 
+if:
+  not:
+    properties:
+      compatible:
+        enum:
+          - microchip,ksz8863
+          - microchip,ksz8873
+then:
+  $ref: dsa.yaml#/$defs/ethernet-ports
+else:
+  patternProperties:
+    "^(ethernet-)?ports$":
+      patternProperties:
+        "^(ethernet-)?port@[0-2]$":
+          $ref: dsa-port.yaml#
+          properties:
+            microchip,rmii-clk-internal:
+              $ref: /schemas/types.yaml#/definitions/flag
+              description:
+	        When ksz88x3 is acting as clock provier (via REFCLKO) it
+		can select between internal and external RMII reference
+		clock. Internal reference clock means that the clock for
+		the RMII of ksz88x3 is provided by the ksz88x3 internally
+		and the REFCLKI pin is unconnected. For the external
+		reference clock, the clock needs to be fed back to ksz88x3
+		via REFCLKI.
+		If microchip,rmii-clk-internal is set, ksz88x3 will provide
+		rmii reference clock internally, otherwise reference clock
+		should be provided externally.
+          if:
+            not:
+              required: [ ethernet ]
+          then:
+            properties:
+              microchip,rmii-clk-internal: false
+          unevaluatedProperties: false
+
 unevaluatedProperties: false
 
 examples: