Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Merge branch 'pse-improve-documentation-clarity'
Kory Maincent says:
====================
PSE: Improve documentation clarity
Thanks to new PSE driver being proposed on the mailinglist figured out
there was some unclear documentation, which lead the developer on the
wrong path. Clarify these documentation.
The changes focus on clarifying the setup_pi_matrix callback behavior
and improving device tree binding descriptions, particularly around
channel-to-PI mapping relationships that are critical for proper PSE
controller integration.
Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
====================
Link: https://patch.msgid.link/20250620-poe_doc_improve-v1-0-96357bb95d52@bootlin.com
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
+13
-5
+6
-4
Documentation/devicetree/bindings/net/pse-pd/ti,tps23881.yaml
+6
-4
Documentation/devicetree/bindings/net/pse-pd/ti,tps23881.yaml
···
30
30
maxItems: 1
31
31
32
32
channels:
33
-
description: each set of 8 ports can be assigned to one physical
34
-
channels or two for PoE4. This parameter describes the configuration
35
-
of the ports conversion matrix that establishes relationship between
36
-
the logical ports and the physical channels.
33
+
description: |
34
+
Defines the 8 physical delivery channels on the controller that can
35
+
be referenced by PSE PIs through their "pairsets" property. The actual
36
+
port matrix mapping is created when PSE PIs reference these channels in
37
+
their pairsets. For 4-pair operation, two channels from the same group
38
+
(0-3 or 4-7) must be referenced by a single PSE PI.
37
39
type: object
38
40
additionalProperties: false
39
41
+7
-1
include/linux/pse-pd/pse.h
+7
-1
include/linux/pse-pd/pse.h
···
159
159
/**
160
160
* struct pse_controller_ops - PSE controller driver callbacks
161
161
*
162
-
* @setup_pi_matrix: setup PI matrix of the PSE controller
162
+
* @setup_pi_matrix: Setup PI matrix of the PSE controller.
163
+
* The PSE PIs devicetree nodes have already been parsed by
164
+
* of_load_pse_pis() and the pcdev->pi[x]->pairset[y].np
165
+
* populated. This callback should establish the
166
+
* relationship between the PSE controller hardware ports
167
+
* and the PSE Power Interfaces, either through software
168
+
* mapping or hardware configuration.
163
169
* @pi_get_admin_state: Get the operational state of the PSE PI. This ops
164
170
* is mandatory.
165
171
* @pi_get_pw_status: Get the power detection status of the PSE PI. This