michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: state: use code/endcode for code examples

Browse source 
Enclode code examples using code/endcode Doxygen commands.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-10-29 11:17:47 +02:00 • committed by Carles Cufí
commit aa5b1d5503
1 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
include/pm/state.h
View file

@ -117,6 +117,7 @@ struct pm_state_info {
* one Zephyr power state. This property allows the platform * one Zephyr power state. This property allows the platform
* distinguish them. e.g: * distinguish them. e.g:
* *
* @code{.dts}
* power-states { * power-states {
* state0: state0 { * state0: state0 {
* compatible = "zephyr,power-state"; * compatible = "zephyr,power-state";
@ -132,7 +133,8 @@ struct pm_state_info {
* min-residency-us = <20000>; * min-residency-us = <20000>;
* exit-latency-us = <200>; * exit-latency-us = <200>;
* }; * };
* } * };
* @endcode
*/ */
uint8_t substate_id; uint8_t substate_id;
@ -196,6 +198,8 @@ struct pm_state_info {
* UTIL_LISTIFY func * UTIL_LISTIFY func
* *
* Example devicetree fragment: * Example devicetree fragment:
*
* @code{.dts}
* cpus { * cpus {
* ... * ...
* cpu0: cpu@0 { * cpu0: cpu@0 {
@ -221,10 +225,14 @@ struct pm_state_info {
* exit-latency-us = <500>; * exit-latency-us = <500>;
* }; * };
* }; * };
* @endcode
* *
* Example usage: * * Example usage:
*
* @code{.c}
* const struct pm_state_info states[] = * const struct pm_state_info states[] =
* PM_STATE_INFO_DT_ITEMS_LIST(DT_NODELABEL(cpu0)); * PM_STATE_INFO_DT_ITEMS_LIST(DT_NODELABEL(cpu0));
* @endcode
* *
* @param node_id A node identifier with compatible zephyr,power-state * @param node_id A node identifier with compatible zephyr,power-state
* @return an array of struct pm_state_info. * @return an array of struct pm_state_info.
@ -264,6 +272,8 @@ struct pm_state_info {
* UTIL_LISTIFY func * UTIL_LISTIFY func
* *
* Example devicetree fragment: * Example devicetree fragment:
*
* @code{.dts}
* cpus { * cpus {
* ... * ...
* cpu0: cpu@0 { * cpu0: cpu@0 {
@ -287,9 +297,13 @@ struct pm_state_info {
* min-residency-us = <50000>; * min-residency-us = <50000>;
* exit-latency-us = <500>; * exit-latency-us = <500>;
* }; * };
* @endcode
* *
* Example usage: * * Example usage:
*
* @code{.c}
* const enum pm_state states[] = PM_STATE_DT_ITEMS_LIST(DT_NODELABEL(cpu0)); * const enum pm_state states[] = PM_STATE_DT_ITEMS_LIST(DT_NODELABEL(cpu0));
* @endcode
* *
* @param node_id A node identifier with compatible zephyr,power-state * @param node_id A node identifier with compatible zephyr,power-state
* @return an array of enum pm_state items. * @return an array of enum pm_state items.