From 549cfff6c96366917783ce064c8c94bff61bd9bd Mon Sep 17 00:00:00 2001 From: Tomasz Bursztyka Date: Fri, 29 May 2020 09:18:31 +0200 Subject: [PATCH] device: Rephrase data parameter documentation This parameter points to the driver instance private data, and not to its configuration data, which one is set via cfg_info parameter. Signed-off-by: Tomasz Bursztyka --- include/device.h | 2 +- include/net/ethernet.h | 2 +- include/net/net_if.h | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/include/device.h b/include/device.h index 968bb0020b8..33be2b79b7e 100644 --- a/include/device.h +++ b/include/device.h @@ -67,7 +67,7 @@ extern "C" { * * @param init_fn Address to the init function of the driver. * - * @param data Pointer to the device's configuration data. + * @param data Pointer to the device's private data. * * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. diff --git a/include/net/ethernet.h b/include/net/ethernet.h index 843ebd14ea0..cca2179f7db 100644 --- a/include/net/ethernet.h +++ b/include/net/ethernet.h @@ -618,7 +618,7 @@ static inline bool net_eth_get_vlan_status(struct net_if *iface) * @param init_fn Address to the init function of the driver. * @param pm_control_fn Pointer to device_pm_control function. * Can be empty function (device_pm_control_nop) if not implemented. - * @param data Pointer to the device's configuration data. + * @param data Pointer to the device's private data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs. diff --git a/include/net/net_if.h b/include/net/net_if.h index c879f604829..060c33047f4 100644 --- a/include/net/net_if.h +++ b/include/net/net_if.h @@ -2232,7 +2232,7 @@ struct net_if_api { * @param init_fn Address to the init function of the driver. * @param pm_control_fn Pointer to device_pm_control function. * Can be empty function (device_pm_control_nop) if not implemented. - * @param data Pointer to the device's configuration data. + * @param data Pointer to the device's private data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs. @@ -2265,7 +2265,7 @@ struct net_if_api { * @param init_fn Address to the init function of the driver. * @param pm_control_fn Pointer to device_pm_control function. * Can be empty function (device_pm_control_nop) if not implemented. - * @param data Pointer to the device's configuration data. + * @param data Pointer to the device's private data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs. @@ -2296,7 +2296,7 @@ struct net_if_api { * @param init_fn Address to the init function of the driver. * @param pm_control_fn Pointer to device_pm_control function. * Can be empty function (device_pm_control_nop) if not implemented. - * @param data Pointer to the device's configuration data. + * @param data Pointer to the device's private data. * @param cfg_info The address to the structure containing the * configuration information for this instance of the driver. * @param prio The initialization level at which configuration occurs.