[Перечисления]

Перечисление app_timer_mode_t определяет режимы работы Application Timer.

/**@brief Timer modes. */

typedef enum
{
    APP_TIMER_MODE_SINGLE_SHOT,  /**< Таймер сработает по таймауту

                                      только один раз. */
    APP_TIMER_MODE_REPEATED      /**< Таймер при таймауте будет

                                      автоматически перезапускаться. */
} app_timer_mode_t;

[Структуры]

// Структура, используемая для выделения данных таймера.

typedef struct app_timer_t {
    uint32_t data[CEIL_DIV(APP_TIMER_NODE_SIZE, sizeof(uint32_t))];
} app_timer_t;

// Структура, передаваемая в планировщик.

typedef struct
{
    app_timer_timeout_handler_t timeout_handler;
    void *                      p_context;
} app_timer_event_t;

[Определения типа]

typedef void(* app_timer_timeout_handler_t )(void *p_context);

Тип для обработчика таймаута таймера приложения.

typedef struct app_timer_t app_timer_t;

typedef app_timer_t * app_timer_id_t;

Тип для идентификатора таймера. Никогда не декларируйте переменную такого типа, вместо этого используйте макрос APP_TIMER_DEF (см. ниже врезку с описанием макросов).

[Макросы конфигурации Application Timer]

Эти макросы конфигурации находятся в sdk_config.h [4].

#define APP_TIMER_ENABLED 1

Разрешает функционал модуля app_timer. Установите в 1, чтобы были доступны Application Timer.

#define APP_TIMER_CONFIG_RTC_FREQUENCY n

Конфигурирует прескалер RTC [5] для работы его счетчика на одной из заданных частот. Здесь N устанавливается в одно из следующих значений:

#define APP_TIMER_CONFIG_IRQ_PRIORITY n

Значение n конфигурирует приоритет прерывания. Имейте в виду, что приоритеты 0, 2 (nRF51) и 0, 1, 4, 5 (nRF52) зарезервированы для SoftDevice. Доступны следующие варианты выбора приоритета (чем значение меньше, тем приоритет выше):

#define APP_TIMER_CONFIG_OP_QUEUE_SIZE n

Здесь n задает емкость очереди запросов таймеров (по умолчанию 10). Размер очереди зависит от того, сколько таймеров используется в системе, как часто таймеры запускаются, и от общей латентности системы. Если очередь слишком мала, то будут происходить неудачи с API-вызовами app_timer.

#define APP_TIMER_CONFIG_USE_SCHEDULER 0

Разрешает обработку событий app_timer на основе планировщика (app_scheduler). Установите в 1, чтобы разрешить использовать планировщик для таймеров приложения.

#define APP_TIMER_KEEPS_RTC_ACTIVE 0

Разрешает RTC работать всегда, установите в 1 для активации. Если эта опция разрешена, то RTC работает даже тогда, когда нет активных таймеров, что может использоваться, если app_timer используется для отсчета реального времени (timestamping).

#define APP_TIMER_WITH_PROFILER 0

Разрешает анализ производительности (профилирование) кода app_timer.

#define APP_TIMER_CONFIG_SWI_NUMBER 0

Конфигурирует используемый экземпляр SWI.

[Макросы для работы с Application Timer]

#define APP_TIMER_LOG_NAME app_timer

Задает имя модуля для сообщений лога.

#define APP_TIMER_CLOCK_FREQ 32768

Частота тактов таймера, Гц. Частота тактов RTC, используемого для реализации таймера приложения.

#define APP_TIMER_MIN_TIMEOUT_TICKS 5

Минимальная длительность таймаута в тиках, которую можно указать в качестве параметра для app_timer_start().

#define APP_TIMER_NODE_SIZE 32

Размер app_timer.timer_node_t (используется для выделения памяти).

#define APP_TIMER_SCHED_EVENT_DATA_SIZE sizeof(app_timer_event_t)

Размер данных события, когда используется планировщик.

#define APP_TIMER_MAX_CNT_VAL RTC_COUNTER_COUNTER_Msk

Максимальное значение счетчика, которое может быть возвращено из вызова app_timer_cnt_get.

#define APP_TIMER_TICKS (MS) ((uint32_t)ROUNDED_DIV(       \

            (MS) * (uint64_t)APP_TIMER_CLOCK_FREQ,         \

            1000 * (APP_TIMER_CONFIG_RTC_FREQUENCY + 1)))

Преобразовывает миллисекунды в тики таймера. Этот макрос использует целочисленную 64-разрядную арифметику. Поэтому только пока в качестве параметра указана константа (например, определенная через #define), вычисления будут делаться препроцессором. Соответственно если в качестве параметра используется переменная, то для макроса сгенерируется программный код.

#define APP_TIMER_DEF(timer_id) _APP_TIMER_DEF(timer_id)

Создает идентификатор таймера и статически выделит для таймера память. Параметр макроса timer_id это имя для переменной идентификатора таймера, которая будет использоваться для управления этим таймером.

ret_code_t app_timer_init (void);

Функция для инициализации модуля таймера. Вернет значение NRF_SUCCESS, если инициализация прошла успешно.

ret_code_t app_timer_init (ret_code_t app_timer_create (app_timer_id_t const *p_timer_id,
                             app_timer_mode_t mode,
                             app_timer_timeout_handler_t timeout_handler);void);

Функция для создания экземпляра таймера. Параметры:

Возвращаемые значения:

Функция app_timer_create выделяет ресурсы для таймера в контексте кода, который её вызвал. Также вызов этой функции не защищен критическим регионом. По этой причине следует позаботиться о том, чтобы не было вызова функции app_timer_create из нескольких контекстов одновременно (например, из нескольких уровней прерывания). Функция app_timer_create может быть вызвана повторно для одного и того же экземпляра таймера, если он в настоящий момент не работает.

Внимание: FreeRTOS и RTX реализация app_timer не позволяют вызвать app_timer_create на ранее инициализированном экземпляре таймера.

ret_code_t app_timer_start (app_timer_id_t timer_id,
                            uint32_t timeout_ticks,
                            void *p_context);

Функция для запуска таймера. Параметры:

Возвращаемые значения:

Минимальное значение для timeout_ticks равно 5. Для нескольких активных таймеров таймауты, которые происходят в непосредственной близости друг от друга (в диапазоне от 1 до 3 тиков), получат положительный джиттер максимум в 3 тика. Когда эта функция вызывается на таймере, который уже работает, вторая операция запуска игнорируется.

ret_code_t app_timer_stop (app_timer_id_t timer_id);

Функция останавливает указанный таймер (переданный через параметр timer_id). Возвращаемые значения:

ret_code_t app_timer_stop_all (void);

Функция останавливает все работающие таймеры. Возвращаемые значения:

uint32_t app_timer_cnt_get (void);

Функция вернет текущее значение счетчика RTC1.

uint32_t app_timer_cnt_diff_compute (uint32_t ticks_to, uint32_t ticks_from);

Эта функция предназначена для вычисления разницы между двумя значениями счетчика RTC1. Параметры ticks_to и ticks_from это значения, полученные вызовами app_timer_cnt_get(). Возвращаемое значение - количество тиков RTC1 от ticks_from до ticks_to.

uint8_t app_timer_op_queue_utilization_get (void);

Эта функция предназначена для получения максимальной наблюдаемой загрузки очереди операций таймера. С помощью её можно настроить модуль таймера и определить значение OP_QUEUE_SIZE, чтобы оптимально использовать память RAM. Возвращаемое значение - максимальное количество событий в очереди, которое наблюдалось на данный момент.

Чтобы функция app_timer_op_queue_utilization_get была доступна, должна быть разрешена опция APP_TIMER_WITH_PROFILER (см. выше описание макросов).

void app_timer_pause (void);

Функция для постановки на паузу активности RTC, который управляет поведением модуля app_timer. Эта функция может использоваться в целях отладки, чтобы гарантировать, что приложение приостановлено при входе в breakpoint.

void app_timer_resume (void);

Функция для возобновления активности RTC, который управляет поведением модуля app_timer. Эта функция может использоваться в целях отладки для восстановления активности приложения.