UserTimer Driver

Overview

Timer driver API definitions.

This module provides functions to configure and control Timer input/output and interrupt behavior.

Usage & Initialization.

This is an example show how to instantiate TIMER with timer_instance_t.

This implementation depends on PLIC Controller Driver for interrupt configuration.

 #include "timer/timer.h"
 #include "irq.h"
 
 #define TIMER_0                    ((timer_hwreg_t *)SYSTEM_USER_TIMER_0_CTRL)
 #define PRESCALER_VALUE            127
 #define TIMER_LIMIT_VALUE          4095
 
 // Interrupt handler for user timer 0
 int irq_m_userTimer0_handler(void) {}
 
 // User Timer instance configuration
 timer_instance_t timer0 = {
    .hwreg              = TIMER_0,
    .prescaler_value    = PRESCALER_VALUE,
    .prescaler_enable   = 0x1U,
    .self_restart       = 0x1U,
    .timer_limit        = TIMER_LIMIT_VALUE,
 };
 
 // PLIC instance configuration for user timer 0
 plic_instance_t timer0_plic = {
    // Configure the interrupt source
    .target    = BSP_PLIC_CPU_0,
    .gateway   = SYSTEM_USER_TIMER_0_INTERRUPTS_0,
    .priority  = 0x1U,
    .enable    = 0x1U,
    .threshold = 0x0U,
 };
 
 void isrInit(){
    timer_applyConfig(&timer0);
    plic_applyConfig(&timer0_plic);
    irq_setTrapVector(trap_entry);
    irq_setType(IRQ_EXTERNAL);
    irq_enable();
}

See also

Example User Timer Demo - Learn how to use the driver for timer operations

Topics
	API Functions
	Function definitions for Timer driver.
	Data Structures
	Structs used by the driver.
	Register Definitions
	Register bitmasks and offsets.