michaelh/zephyr
1
0
Fork 0
Code Releases Activity

device: Rephrase data parameter documentation

Browse source 
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 <tomasz.bursztyka@linux.intel.com>
This commit is contained in:
Tomasz Bursztyka 2020-05-29 09:18:31 +02:00 • committed by Carles Cufí
commit 549cfff6c9
3 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/device.h
View file

@ -67,7 +67,7 @@ extern "C" {
* *
* @param init_fn Address to the init function of the driver. * @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 * @param cfg_info The address to the structure containing the
* configuration information for this instance of the driver. * configuration information for this instance of the driver.

2
include/net/ethernet.h
View file

@ -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 init_fn Address to the init function of the driver.
* @param pm_control_fn Pointer to device_pm_control function. * @param pm_control_fn Pointer to device_pm_control function.
* Can be empty function (device_pm_control_nop) if not implemented. * 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 * @param cfg_info The address to the structure containing the
* configuration information for this instance of the driver. * configuration information for this instance of the driver.
* @param prio The initialization level at which configuration occurs. * @param prio The initialization level at which configuration occurs.

6
include/net/net_if.h
View file

@ -2232,7 +2232,7 @@ struct net_if_api {
* @param init_fn Address to the init function of the driver. * @param init_fn Address to the init function of the driver.
* @param pm_control_fn Pointer to device_pm_control function. * @param pm_control_fn Pointer to device_pm_control function.
* Can be empty function (device_pm_control_nop) if not implemented. * 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 * @param cfg_info The address to the structure containing the
* configuration information for this instance of the driver. * configuration information for this instance of the driver.
* @param prio The initialization level at which configuration occurs. * @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 init_fn Address to the init function of the driver.
* @param pm_control_fn Pointer to device_pm_control function. * @param pm_control_fn Pointer to device_pm_control function.
* Can be empty function (device_pm_control_nop) if not implemented. * 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 * @param cfg_info The address to the structure containing the
* configuration information for this instance of the driver. * configuration information for this instance of the driver.
* @param prio The initialization level at which configuration occurs. * @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 init_fn Address to the init function of the driver.
* @param pm_control_fn Pointer to device_pm_control function. * @param pm_control_fn Pointer to device_pm_control function.
* Can be empty function (device_pm_control_nop) if not implemented. * 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 * @param cfg_info The address to the structure containing the
* configuration information for this instance of the driver. * configuration information for this instance of the driver.
* @param prio The initialization level at which configuration occurs. * @param prio The initialization level at which configuration occurs.