michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: remove references to device_pm_control_nop

Browse source 
Remove it from examples and from PM reference.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-04-28 22:54:11 +02:00 • committed by Anas Nashif
commit 70fc2dc8f8
3 changed files with 6 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/guides/dts/howtos.rst
View file

@ -465,7 +465,7 @@ using instance numbers. Do this after defining ``my_api_funcs``.
}; \ }; \
DEVICE_DT_INST_DEFINE(inst, \ DEVICE_DT_INST_DEFINE(inst, \
my_dev_init_function, \ my_dev_init_function, \
device_pm_control_nop, \ NULL, \
&my_data_##inst, \ &my_data_##inst, \
&my_cfg_##inst, \ &my_cfg_##inst, \
MY_DEV_INIT_LEVEL, MY_DEV_INIT_PRIORITY, \ MY_DEV_INIT_LEVEL, MY_DEV_INIT_PRIORITY, \
@ -542,7 +542,7 @@ devicetree to operate on specific device nodes:
static const struct my_dev_cfg my_cfg_##idx = { /* ... */ }; \ static const struct my_dev_cfg my_cfg_##idx = { /* ... */ }; \
DEVICE_DT_DEFINE(MYDEV(idx), \ DEVICE_DT_DEFINE(MYDEV(idx), \
my_dev_init_function, \ my_dev_init_function, \
device_pm_control_nop, \ NULL, \
&my_data_##idx, \ &my_data_##idx, \
&my_cfg_##idx, \ &my_cfg_##idx, \
MY_DEV_INIT_LEVEL, MY_DEV_INIT_PRIORITY, \ MY_DEV_INIT_LEVEL, MY_DEV_INIT_PRIORITY, \

2
doc/reference/drivers/index.rst
View file

@ -326,7 +326,7 @@ Then when the particular instance is declared:
static struct my_data_0; static struct my_data_0;
DEVICE_DEFINE(my_driver_0, MY_DRIVER_0_NAME, my_driver_init, DEVICE_DEFINE(my_driver_0, MY_DRIVER_0_NAME, my_driver_init,
device_pm_control_nop, &my_data_0, &my_driver_config_0, NULL, &my_data_0, &my_driver_config_0,
POST_KERNEL, MY_DRIVER_0_PRIORITY, &my_api_funcs); POST_KERNEL, MY_DRIVER_0_PRIORITY, &my_api_funcs);
#endif /* CONFIG_MY_DRIVER_0 */ #endif /* CONFIG_MY_DRIVER_0 */

18
doc/reference/power_management/index.rst
View file

@ -264,21 +264,9 @@ Device Model with Power Management Support
Drivers initialize the devices using macros. See :ref:`device_model_api` for Drivers initialize the devices using macros. See :ref:`device_model_api` for
details on how these macros are used. Use the DEVICE_DEFINE macro to initialize details on how these macros are used. Use the DEVICE_DEFINE macro to initialize
drivers providing power management support via the PM control function. drivers providing power management support via the PM control function.
One of the macro parameters is the pointer to the device_pm_control handler function. One of the macro parameters is the pointer to the device_pm_control handler
function. If the driver doesn't implement any power control operations, it can
Default Initializer Function initialize the corresponding pointer with ``NULL``.
----------------------------
.. code-block:: c
int device_pm_control_nop(const struct device *unused_device, uint32_t unused_ctrl_command, void *unused_context);
If the driver doesn't implement any power control operations, the driver can
initialize the corresponding pointer with this default nop function. This
default nop function does nothing and should be used instead of
implementing a dummy function to avoid wasting code memory in the driver.
Device Power Management API Device Power Management API
=========================== ===========================