diff options
| author | Kory Maincent <kory.maincent@bootlin.com> | 2025-06-20 13:02:40 +0300 |
|---|---|---|
| committer | Paolo Abeni <pabeni@redhat.com> | 2025-06-24 11:57:43 +0300 |
| commit | dad51ea09040f9ac2ea2a0f694e5e3ed5cf167b9 (patch) | |
| tree | 6f5163e17a14854e921a1ea059a682fa48f3be7b /include/linux | |
| parent | 42fa8f17e453ca142d3ed1b2a7b264bf52e8599e (diff) | |
| download | linux-dad51ea09040f9ac2ea2a0f694e5e3ed5cf167b9.tar.xz | |
net: pse-pd: tps23881: Clarify setup_pi_matrix callback documentation
Improve the setup_pi_matrix callback documentation to clarify its purpose
and usage. The enhanced description explains that PSE PI devicetree nodes
are pre-parsed before this callback is invoked, and drivers should utilize
pcdev->pi[x]->pairset[y].np to map PSE controller hardware ports to their
corresponding Power Interfaces.
This clarification helps driver implementers understand the callback's
role in establishing the hardware-to-PI relationship mapping.
Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
Link: https://patch.msgid.link/20250620-poe_doc_improve-v1-2-96357bb95d52@bootlin.com
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
Diffstat (limited to 'include/linux')
| -rw-r--r-- | include/linux/pse-pd/pse.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/include/linux/pse-pd/pse.h b/include/linux/pse-pd/pse.h index e5f305cef82e..4e5696cfade7 100644 --- a/include/linux/pse-pd/pse.h +++ b/include/linux/pse-pd/pse.h @@ -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 |