refactor(freertos): Deprecate xPortGetTickRateHz()

This commit deprecates xPortGetTickRateHz() from the FreeRTOS port API
as the FreeRTOS tickrate is constant for an application and can be
inferred using the CONFIG_FREERTOS_HZ config option.
This commit is contained in:
Sudeep Mohanty
2025-09-17 17:07:32 +02:00
parent 141e62806c
commit cf12478049
2 changed files with 6 additions and 5 deletions

View File

@@ -407,11 +407,11 @@ void vApplicationSleep(TickType_t xExpectedIdleTime);
/**
* @brief Get the tick rate per second
*
* @note [refactor-todo] make this inline
* @note [refactor-todo] Check if this function should be renamed (due to uint return type)
* @deprecated This function will be removed in IDF 7.0. Use CONFIG_FREERTOS_HZ directly instead.
* @note [refactor-todo] Remove this function in IDF 7.0 (IDF-14115)
* @return uint32_t Tick rate in Hz
*/
uint32_t xPortGetTickRateHz(void);
uint32_t xPortGetTickRateHz(void) __attribute__((deprecated("This function will be removed in IDF 7.0. Use CONFIG_FREERTOS_HZ directly instead.")));
/**
* @brief Set a watchpoint to watch the last 32 bytes of the stack

View File

@@ -345,10 +345,11 @@ void vApplicationSleep(TickType_t xExpectedIdleTime);
/**
* @brief Get the tick rate per second
*
* @note [refactor-todo] make this inline
* @deprecated This function will be removed in IDF 7.0. Use CONFIG_FREERTOS_HZ directly instead.
* @note [refactor-todo] Remove this function in IDF 7.0 (IDF-14115)
* @return uint32_t Tick rate in Hz
*/
uint32_t xPortGetTickRateHz(void);
uint32_t xPortGetTickRateHz(void) __attribute__((deprecated("This function will be removed in IDF 7.0. Use CONFIG_FREERTOS_HZ directly instead.")));
/**
* @brief Set a watchpoint to watch the last 32 bytes of the stack