Commit 549cfff6 authored by Tomasz Bursztyka's avatar Tomasz Bursztyka Committed by Carles Cufi
Browse files

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: default avatarTomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
parent 794665e7

include/device.h

+1 −1
Original line number Diff line number Diff line
@@ -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.

include/net/ethernet.h

+1 −1
Original line number Diff line number Diff line
@@ -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.

include/net/net_if.h

+3 −3
Original line number Diff line number Diff line
@@ -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.

CRA Git | Maintained and supported by SUSTech CRA and CCSE