Skip to main content

tkl_timer | Hardware Timer

The tkl_timer interface drives an on-chip hardware timer for precise, interrupt-driven timing. You configure a timer with a counting mode and an interrupt service callback, start it with a microsecond interval, and read back its configured interval or current count. It is the kernel abstraction layer (TKL) port each platform implements.

Typesโ€‹

A timer is selected by TUYA_TIMER_NUM_E and configured with TUYA_TIMER_BASE_CFG_T:

typedef enum {
    TUYA_TIMER_NUM_0,
    TUYA_TIMER_NUM_1,
    TUYA_TIMER_NUM_2,
    TUYA_TIMER_NUM_3,
    TUYA_TIMER_NUM_4,
    TUYA_TIMER_NUM_5,
    TUYA_TIMER_NUM_MAX,
} TUYA_TIMER_NUM_E;

typedef enum {
    TUYA_TIMER_MODE_ONCE = 0,
    TUYA_TIMER_MODE_PERIOD,
} TUYA_TIMER_MODE_E;

typedef void (*TUYA_TIMER_ISR_CB)(void *args);

typedef struct {
    TUYA_TIMER_MODE_E mode;  // counting mode
    TUYA_TIMER_ISR_CB cb;    // interrupt service callback
    void             *args;  // argument passed to the callback
} TUYA_TIMER_BASE_CFG_T;

TUYA_TIMER_MODE_E values:

ValueDescription
TUYA_TIMER_MODE_ONCEOne-shot timer; fires once.
TUYA_TIMER_MODE_PERIODPeriodic timer; fires repeatedly.
warning

cb runs in interrupt context. Keep it short and do not call blocking APIs from it.

tkl_timer_initโ€‹

OPERATE_RET tkl_timer_init(TUYA_TIMER_NUM_E timer_id, TUYA_TIMER_BASE_CFG_T *cfg);

Initializes the specified timer with the given configuration.

ParameterDescription
timer_idTimer ID.
cfgBasic configuration: counting mode, callback, and callback argument.
  • Return value: OPRT_OK on success. Any other value indicates an error; see tuya_error_code.h.

tkl_timer_deinitโ€‹

OPERATE_RET tkl_timer_deinit(TUYA_TIMER_NUM_E timer_id);

Deinitializes the timer. Stops it and releases its software and hardware resources.

ParameterDescription
timer_idTimer ID.
  • Return value: OPRT_OK on success. Any other value indicates an error; see tuya_error_code.h.

tkl_timer_startโ€‹

OPERATE_RET tkl_timer_start(TUYA_TIMER_NUM_E timer_id, uint32_t us);

Starts the timer with the given interval.

ParameterDescription
timer_idTimer ID.
usTiming interval, in microseconds.
  • Return value: OPRT_OK on success. Any other value indicates an error; see tuya_error_code.h.

tkl_timer_stopโ€‹

OPERATE_RET tkl_timer_stop(TUYA_TIMER_NUM_E timer_id);

Stops the timer.

ParameterDescription
timer_idTimer ID.
  • Return value: OPRT_OK on success. Any other value indicates an error; see tuya_error_code.h.

tkl_timer_getโ€‹

OPERATE_RET tkl_timer_get(TUYA_TIMER_NUM_E timer_id, uint32_t *us);

Gets the timer's configured interval.

ParameterDescription
timer_idTimer ID.
usOutput parameter. Receives the interval in microseconds, matching the value set by tkl_timer_start.
  • Return value: OPRT_OK on success. Any other value indicates an error; see tuya_error_code.h.

tkl_timer_get_current_valueโ€‹

OPERATE_RET tkl_timer_get_current_value(TUYA_TIMER_NUM_E timer_id, uint32_t *us);

Gets the timer's current count value.

ParameterDescription
timer_idTimer ID.
usOutput parameter. Receives the current count value, in microseconds.
  • Return value: OPRT_OK on success. Any other value indicates an error; see tuya_error_code.h.

Exampleโ€‹

Configure a periodic timer, run it, read back its interval and current count, then deinitialize it:

static void tkl_timer_isr_cb_fun(void *args)
{
    PR_NOTICE("hw_timer test");
}

void tuya_timer_test(void)
{
    OPERATE_RET ret;
    TUYA_TIMER_BASE_CFG_T cfg;
    uint32_t interval_us;
    uint32_t get_us;

    cfg.mode = TUYA_TIMER_MODE_PERIOD;
    cfg.cb = tkl_timer_isr_cb_fun;
    cfg.args = NULL;

    ret = tkl_timer_init(TUYA_TIMER_NUM_0, &cfg);
    if (ret != OPRT_OK) {
        return;
    }
    ret = tkl_timer_start(TUYA_TIMER_NUM_0, 1000);
    if (ret != OPRT_OK) {
        return;
    }
    tkl_system_delay(5000);
    ret = tkl_timer_stop(TUYA_TIMER_NUM_0);
    if (ret != OPRT_OK) {
        return;
    }
    ret = tkl_timer_get(TUYA_TIMER_NUM_0, &interval_us);
    if (ret != OPRT_OK) {
        return;
    }
    if (interval_us != 2000) {
        interval_us = 2000;
    }
    ret = tkl_timer_start(TUYA_TIMER_NUM_0, interval_us);
    if (ret != OPRT_OK) {
        return;
    }
    tkl_system_delay(1000);
    ret = tkl_timer_get_current_value(TUYA_TIMER_NUM_0, &get_us);
    if (ret != OPRT_OK) {
        return;
    }
    PR_DEBUG("current run time:%d us", get_us);
    tkl_system_delay(5000);
    ret = tkl_timer_deinit(TUYA_TIMER_NUM_0);
    if (ret != OPRT_OK) {
        // failed
    }
}

See alsoโ€‹