Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Kory Maincent and committed by
Paolo Abeni
dad51ea0 42fa8f17

+7 -1
+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