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

clock_control: nrf: fix references to kconfig

Browse source 
Fix references to kconfig variables.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2024-04-27 19:57:20 -04:00 committed by Carles Cufí
parent ad63db9808
commit 49d443d56f
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/zephyr/drivers/clock_control/nrf_clock_control.h
View file

@ -99,7 +99,7 @@ void z_nrf_clock_calibration_force_start(void);
/** @brief Return number of calibrations performed. /** @brief Return number of calibrations performed.
* *
* Valid when @ref CONFIG_CLOCK_CONTROL_NRF_CALIBRATION_DEBUG is set. * Valid when @kconfig{CONFIG_CLOCK_CONTROL_NRF_CALIBRATION_DEBUG} is set.
* *
* @return Number of calibrations or -1 if feature is disabled. * @return Number of calibrations or -1 if feature is disabled.
*/ */
@ -107,7 +107,7 @@ int z_nrf_clock_calibration_count(void);
/** @brief Return number of attempts when calibration was skipped. /** @brief Return number of attempts when calibration was skipped.
* *
* Valid when @ref CONFIG_CLOCK_CONTROL_NRF_CALIBRATION_DEBUG is set. * Valid when @kconfig{CONFIG_CLOCK_CONTROL_NRF_CALIBRATION_DEBUG} is set.
* *
* @return Number of calibrations or -1 if feature is disabled. * @return Number of calibrations or -1 if feature is disabled.
*/ */

18
include/zephyr/drivers/timer/nrf_rtc_timer.h
View file

@ -59,7 +59,7 @@ uint64_t z_nrf_rtc_timer_read(void);
* *
* Address can be used for (D)PPI. * Address can be used for (D)PPI.
* *
* @param chan Channel ID between 0 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 0 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @return Register address. * @return Register address.
*/ */
@ -71,7 +71,7 @@ uint32_t z_nrf_rtc_timer_compare_evt_address_get(int32_t chan);
* *
* @note Not all platforms have CAPTURE task. * @note Not all platforms have CAPTURE task.
* *
* @param chan Channel ID between 1 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 1 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @return Register address. * @return Register address.
*/ */
@ -81,7 +81,7 @@ uint32_t z_nrf_rtc_timer_capture_task_address_get(int32_t chan);
* *
* Function returns key indicating whether interrupt was already disabled. * Function returns key indicating whether interrupt was already disabled.
* *
* @param chan Channel ID between 1 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 1 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @return key passed to @ref z_nrf_rtc_timer_compare_int_unlock. * @return key passed to @ref z_nrf_rtc_timer_compare_int_unlock.
*/ */
@ -91,7 +91,7 @@ bool z_nrf_rtc_timer_compare_int_lock(int32_t chan);
* *
* Event interrupt is conditionally enabled based on @p key. * Event interrupt is conditionally enabled based on @p key.
* *
* @param chan Channel ID between 1 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 1 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @param key Key returned by @ref z_nrf_rtc_timer_compare_int_lock. * @param key Key returned by @ref z_nrf_rtc_timer_compare_int_lock.
*/ */
@ -99,7 +99,7 @@ void z_nrf_rtc_timer_compare_int_unlock(int32_t chan, bool key);
/** @brief Read compare register value. /** @brief Read compare register value.
* *
* @param chan Channel ID between 0 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 0 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @return Value set in the compare register. * @return Value set in the compare register.
*/ */
@ -116,7 +116,7 @@ uint32_t z_nrf_rtc_timer_compare_read(int32_t chan);
* from that compare channel is disabled. Other interrupts are not locked during * from that compare channel is disabled. Other interrupts are not locked during
* this operation. * this operation.
* *
* @param chan Channel ID between 1 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 1 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @param target_time Absolute target time in ticks. * @param target_time Absolute target time in ticks.
* *
@ -144,7 +144,7 @@ int z_nrf_rtc_timer_set(int32_t chan, uint64_t target_time,
* value (as would @ref z_nrf_rtc_timer_set function do), neither the hardware * value (as would @ref z_nrf_rtc_timer_set function do), neither the hardware
* event nor interrupt will be generated and the function fails. * event nor interrupt will be generated and the function fails.
* *
* @param chan Channel ID between 1 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 1 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
* *
* @param target_time Absolute target time in ticks. * @param target_time Absolute target time in ticks.
* *
@ -171,7 +171,7 @@ int z_nrf_rtc_timer_exact_set(int32_t chan, uint64_t target_time,
* operation interrupt from that compare channel is disabled. Other interrupts * operation interrupt from that compare channel is disabled. Other interrupts
* are not locked during this operation. * are not locked during this operation.
* *
* @param chan Channel ID between 1 and CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT. * @param chan Channel ID between 1 and @kconfig{CONFIG_NRF_RTC_TIMER_USER_CHAN_COUNT}.
*/ */
void z_nrf_rtc_timer_abort(int32_t chan); void z_nrf_rtc_timer_abort(int32_t chan);
@ -190,7 +190,7 @@ uint64_t z_nrf_rtc_timer_get_ticks(k_timeout_t t);
* *
* Returned value added to the current system tick on network cpu gives current * Returned value added to the current system tick on network cpu gives current
* application cpu system tick. Function can only be used on network cpu. It * application cpu system tick. Function can only be used on network cpu. It
* requires @ref CONFIG_NRF53_SYNC_RTC being enabled. * requires @kconfig{CONFIG_NRF53_SYNC_RTC} being enabled.
* *
* @retval Non-negative offset given in RTC ticks. * @retval Non-negative offset given in RTC ticks.
* @retval -ENOSYS if operation is not supported. * @retval -ENOSYS if operation is not supported.