net: fix pm argument documentation

The `pm` field is used to provide a reference to pre-allocated PM
resources. Its usage as a callback was removed a while ago, and these
headers missed the migration.

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

include/zephyr/net/ethernet.h

@@ -860,8 +860,8 @@ static inline bool net_eth_get_vlan_status(struct net_if *iface)
  * @param name The name this instance of the driver exposes to
  * the system.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.
@@ -881,8 +881,8 @@ static inline bool net_eth_get_vlan_status(struct net_if *iface)
  *
  * @param node_id The devicetree node identifier.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.

include/zephyr/net/net_if.h

@@ -2330,8 +2330,8 @@ struct net_if_api {
  * @param name The name this instance of the driver exposes to
  * the system.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.
@@ -2353,8 +2353,8 @@ struct net_if_api {
  *
  * @param node_id The devicetree node identifier.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.
@@ -2403,8 +2403,8 @@ struct net_if_api {
  * the system.
  * @param instance Instance identifier.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.
@@ -2432,8 +2432,8 @@ struct net_if_api {
  * @param node_id The devicetree node identifier.
  * @param instance Instance identifier.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.
@@ -2482,8 +2482,8 @@ struct net_if_api {
  * @param name The name this instance of the driver exposes to
  * the system.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.
@@ -2506,8 +2506,8 @@ struct net_if_api {
  *
  * @param node_id The devicetree node identifier.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.

include/zephyr/net/virtual.h

@@ -290,8 +290,8 @@ net_virtual_get_iface_capabilities(struct net_if *iface)
  * @param name The name this instance of the driver exposes to
  * the system.
  * @param init_fn Address to the init function of the driver.
- * @param pm Pointer to PM action callback.
- * Can be NULL if not implemented.
+ * @param pm Reference to struct pm_device associated with the device.
+ * (optional).
  * @param data Pointer to the device's private data.
  * @param config The address to the structure containing the
  * configuration information for this instance of the driver.