patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

drivers: pwm: add instance versions of the PWM_DT_SPEC* helpers

Browse source 
The instance based version macros were not added when the new
PWM_DT_SPEC* helpers were introduced. This means drivers are forced to
make usage of DT_DRV_INST(inst) macro to obtain a node identifier, what
is required by existing macros. Following other driver classes, provide
the PWM_DT_SPEC_INST* family of macros.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2022-05-17 16:53:09 +02:00 committed by Marti Bolivar
parent 25e6279493
commit ef3d5e0461
1 changed files with 101 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
include/zephyr/drivers/pwm.h
View file

@ -145,6 +145,8 @@ struct pwm_dt_spec {
* the node's pwm-names property.
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_INST_GET_BY_NAME
*/
#define PWM_DT_SPEC_GET_BY_NAME(node_id, name) \
{ \
@ -154,6 +156,21 @@ struct pwm_dt_spec {
.flags = DT_PWMS_FLAGS_BY_NAME(node_id, name), \
}
/**
* @brief Static initializer for a struct pwm_dt_spec from a DT_DRV_COMPAT
* instance.
*
* @param inst DT_DRV_COMPAT instance number
* @param name Lowercase-and-underscores name of a pwms element as defined by
* the node's pwm-names property.
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_GET_BY_NAME
*/
#define PWM_DT_SPEC_INST_GET_BY_NAME(inst, name) \
PWM_DT_SPEC_GET_BY_NAME(DT_DRV_INST(inst), name)
/**
* @brief Like PWM_DT_SPEC_GET_BY_NAME(), with a fallback to a default value.
*
@ -169,12 +186,31 @@ struct pwm_dt_spec {
*
* @return Static initializer for a struct pwm_dt_spec for the property,
* or @p default_value if the node or property do not exist.
*
* @see PWM_DT_SPEC_INST_GET_BY_NAME_OR
*/
#define PWM_DT_SPEC_GET_BY_NAME_OR(node_id, name, default_value) \
COND_CODE_1(DT_NODE_HAS_PROP(node_id, pwms), \
(PWM_DT_SPEC_GET_BY_NAME(node_id, name)), \
(default_value))
/**
* @brief Like PWM_DT_SPEC_INST_GET_BY_NAME(), with a fallback to a default
* value.
*
* @param inst DT_DRV_COMPAT instance number
* @param name Lowercase-and-underscores name of a pwms element as defined by
* the node's pwm-names property.
* @param default_value Fallback value to expand to.
*
* @return Static initializer for a struct pwm_dt_spec for the property,
* or @p default_value if the node or property do not exist.
*
* @see PWM_DT_SPEC_GET_BY_NAME_OR
*/
#define PWM_DT_SPEC_INST_GET_BY_NAME_OR(inst, name, default_value) \
PWM_DT_SPEC_GET_BY_NAME_OR(DT_DRV_INST(inst), name, default_value)
/**
* @brief Static initializer for a struct pwm_dt_spec
*
@ -214,6 +250,8 @@ struct pwm_dt_spec {
* @param idx Logical index into 'pwms' property.
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_INST_GET_BY_IDX
*/
#define PWM_DT_SPEC_GET_BY_IDX(node_id, idx) \
{ \
@ -223,6 +261,20 @@ struct pwm_dt_spec {
.flags = DT_PWMS_FLAGS_BY_IDX(node_id, idx), \
}
/**
* @brief Static initializer for a struct pwm_dt_spec from a DT_DRV_COMPAT
* instance.
*
* @param inst DT_DRV_COMPAT instance number
* @param idx Logical index into 'pwms' property.
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_GET_BY_IDX
*/
#define PWM_DT_SPEC_INST_GET_BY_IDX(inst, idx) \
PWM_DT_SPEC_GET_BY_IDX(DT_DRV_INST(inst), idx)
/**
* @brief Like PWM_DT_SPEC_GET_BY_IDX(), with a fallback to a default value.
*
@ -237,12 +289,30 @@ struct pwm_dt_spec {
*
* @return Static initializer for a struct pwm_dt_spec for the property,
* or @p default_value if the node or property do not exist.
*
* @see PWM_DT_SPEC_INST_GET_BY_IDX_OR
*/
#define PWM_DT_SPEC_GET_BY_IDX_OR(node_id, idx, default_value) \
COND_CODE_1(DT_NODE_HAS_PROP(node_id, pwms), \
(PWM_DT_SPEC_GET_BY_IDX(node_id, idx)), \
(default_value))
/**
* @brief Like PWM_DT_SPEC_INST_GET_BY_IDX(), with a fallback to a default
* value.
*
* @param inst DT_DRV_COMPAT instance number
* @param idx Logical index into 'pwms' property.
* @param default_value Fallback value to expand to.
*
* @return Static initializer for a struct pwm_dt_spec for the property,
* or @p default_value if the node or property do not exist.
*
* @see PWM_DT_SPEC_GET_BY_IDX_OR
*/
#define PWM_DT_SPEC_INST_GET_BY_IDX_OR(inst, idx, default_value) \
PWM_DT_SPEC_GET_BY_IDX_OR(DT_DRV_INST(inst), idx, default_value)
/**
* @brief Equivalent to <tt>PWM_DT_SPEC_GET_BY_IDX(node_id, 0)</tt>.
*
@ -250,10 +320,23 @@ struct pwm_dt_spec {
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_GET_BY_IDX()
* @see PWM_DT_SPEC_GET_BY_IDX
* @see PWM_DT_SPEC_INST_GET
*/
#define PWM_DT_SPEC_GET(node_id) PWM_DT_SPEC_GET_BY_IDX(node_id, 0)
/**
* @brief Equivalent to <tt>PWM_DT_SPEC_INST_GET_BY_IDX(inst, 0)</tt>.
*
* @param inst DT_DRV_COMPAT instance number
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_INST_GET_BY_IDX
* @see PWM_DT_SPEC_GET
*/
#define PWM_DT_SPEC_INST_GET(inst) PWM_DT_SPEC_GET(DT_DRV_INST(inst))
/**
* @brief Equivalent to
* <tt>PWM_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value)</tt>.
@ -263,11 +346,27 @@ struct pwm_dt_spec {
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_GET_BY_IDX_OR()
* @see PWM_DT_SPEC_GET_BY_IDX_OR
* @see PWM_DT_SPEC_INST_GET_OR
*/
#define PWM_DT_SPEC_GET_OR(node_id, default_value) \
PWM_DT_SPEC_GET_BY_IDX_OR(node_id, 0, default_value)
/**
* @brief Equivalent to
* <tt>PWM_DT_SPEC_INST_GET_BY_IDX_OR(inst, 0, default_value)</tt>.
*
* @param inst DT_DRV_COMPAT instance number
* @param default_value Fallback value to expand to.
*
* @return Static initializer for a struct pwm_dt_spec for the property.
*
* @see PWM_DT_SPEC_INST_GET_BY_IDX_OR
* @see PWM_DT_SPEC_GET_OR
*/
#define PWM_DT_SPEC_INST_GET_OR(inst, default_value) \
PWM_DT_SPEC_GET_OR(DT_DRV_INST(inst), default_value)
/**
* @brief PWM capture callback handler function signature
*