Skip to content

Commit

Permalink
drivers: rstctrl: Fix function description
Browse files Browse the repository at this point in the history
Fix the description of functions rstctrl_dt_get_func() and
rstctrl_register_provider() and rstctrl_get_exclusive().

By the way, append parentheses ("()") to function names in
inline description comment for consistency in core header files.

Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com>
Signed-off-by: Etienne Carriere <etienne.carriere@foss.st.com>
Acked-by: Jerome Forissier <jerome.forissier@linaro.org>
  • Loading branch information
patrickdelaunay authored and jforissier committed Sep 10, 2024
1 parent 7b76de3 commit f84c5df
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions core/include/drivers/rstctrl.h
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ struct rstctrl {
#define RSTCTRL_NO_TIMEOUT 0

/*
* rstctrl_assert_to - Assert reset control possibly with timeout
* rstctrl_assert - Assert reset control
* rstctrl_deassert_to - Deassert reset control possibly with timeout
* rstctrl_deassert - Deassert reset control
* rstctrl_assert_to() - Assert reset control possibly with timeout
* rstctrl_assert() - Assert reset control
* rstctrl_deassert_to() - Deassert reset control possibly with timeout
* rstctrl_deassert() - Deassert reset control
*
* @rstctrl: Reset controller
* @to_us: Timeout in microseconds
Expand Down Expand Up @@ -102,7 +102,7 @@ static inline TEE_Result rstctrl_deassert(struct rstctrl *rstctrl)
}

/*
* rstctrl_name - Get a name for the reset level control or NULL
* rstctrl_name() - Get a name for the reset level control or NULL
*
* @rstctrl: Reset controller
* Return a pointer to controller name or NULL
Expand All @@ -116,22 +116,22 @@ static inline const char *rstctrl_name(struct rstctrl *rstctrl)
}

/**
* rstctrl_dt_get_exclusive - Get exclusive access to reset controller
* rstctrl_get_exclusive() - Get exclusive access to reset controller
*
* @rstctrl: Reset controller
* Return a TEE_Result compliant value
*/
TEE_Result rstctrl_get_exclusive(struct rstctrl *rstctrl);

/**
* rstctrl_put_exclusive - Release exclusive access to target
* rstctrl_put_exclusive() - Release exclusive access to target
*
* @rstctrl: Reset controller
*/
void rstctrl_put_exclusive(struct rstctrl *rstctrl);

/**
* rstctrl_ops_is_valid - Check reset controller ops is valid
* rstctrl_ops_is_valid() - Check reset controller ops is valid
*
* @ops: Reference to reset controller operator instance
*/
Expand All @@ -142,7 +142,7 @@ static inline bool rstctrl_ops_is_valid(const struct rstctrl_ops *ops)

#ifdef CFG_DT
/**
* rstctrl_dt_get_by_index - Get a reset controller at a specific index in
* rstctrl_dt_get_by_index() - Get a reset controller at a specific index in
* 'resets' property
*
* @fdt: Device tree to work on
Expand Down Expand Up @@ -182,7 +182,7 @@ static inline TEE_Result rstctrl_dt_get_by_index(const void *fdt __unused,
#endif /*CFG_DT*/

/**
* rstctrl_dt_get_by_name - Get a reset controller matching a name in the
* rstctrl_dt_get_by_name() - Get a reset controller matching a name in the
* 'reset-names' property
*
* @fdt: Device tree to work on
Expand All @@ -203,14 +203,14 @@ TEE_Result rstctrl_dt_get_by_name(const void *fdt, int nodeoffset,
* devicetree properties
*
* @args: Pointer to devicetree description of the reset controller to parse
* @data: Pointer to data given at rstctrl_dt_register_provider() call
* @data: Pointer to data given at rstctrl_register_provider() call
* @rstctrl: Output reset controller reference upon success
*/
typedef TEE_Result (*rstctrl_dt_get_func)(struct dt_pargs *args, void *data,
struct rstctrl **out_rstctrl);

/**
* rstctrl_dt_register_provider - Register a reset controller provider
* rstctrl_register_provider() - Register a reset controller provider
*
* @fdt: Device tree to work on
* @nodeoffset: Node offset of the reset controller
Expand All @@ -228,4 +228,3 @@ static inline TEE_Result rstctrl_register_provider(const void *fdt,
DT_DRIVER_RSTCTRL);
}
#endif /* __DRIVERS_RSTCTRL_H */

0 comments on commit f84c5df

Please sign in to comment.