Commit ee1a0c65 authored by Paolo Abeni's avatar Paolo Abeni
Browse files

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: default avatarKory Maincent <kory.maincent@bootlin.com>
====================

Link: https://patch.msgid.link/20250620-poe_doc_improve-v1-0-96357bb95d52@bootlin.com


Signed-off-by: default avatarPaolo Abeni <pabeni@redhat.com>
parents a6a4db16 dad51ea0
Loading
Loading
Loading
Loading
+6 −4
Original line number Diff line number Diff line
@@ -30,10 +30,12 @@ properties:
    maxItems: 1

  channels:
    description: each set of 8 ports can be assigned to one physical
      channels or two for PoE4. This parameter describes the configuration
      of the ports conversion matrix that establishes relationship between
      the logical ports and the physical channels.
    description: |
      Defines the 8 physical delivery channels on the controller that can
      be referenced by PSE PIs through their "pairsets" property. The actual
      port matrix mapping is created when PSE PIs reference these channels in
      their pairsets. For 4-pair operation, two channels from the same group
      (0-3 or 4-7) must be referenced by a single PSE PI.
    type: object
    additionalProperties: false

+7 −1
Original line number Diff line number Diff line
@@ -159,7 +159,13 @@ struct ethtool_pse_control_status {
/**
 * struct pse_controller_ops - PSE controller driver callbacks
 *
 * @setup_pi_matrix: setup PI matrix of the PSE controller
 * @setup_pi_matrix: Setup PI matrix of the PSE controller.
 *		     The PSE PIs devicetree nodes have already been parsed by
 *		     of_load_pse_pis() and the pcdev->pi[x]->pairset[y].np
 *		     populated. This callback should establish the
 *		     relationship between the PSE controller hardware ports
 *		     and the PSE Power Interfaces, either through software
 *		     mapping or hardware configuration.
 * @pi_get_admin_state: Get the operational state of the PSE PI. This ops
 *			is mandatory.
 * @pi_get_pw_status: Get the power detection status of the PSE PI. This