timer.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef TIMER_H
#define TIMER_H

 
#include "type.h"
#include "io.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ========================================================================== */
/* SUB-GROUP : REGISTER DEFINITIONS                                          */
/* ========================================================================== */
    #define TIMER_CONFIG_WITH_PRESCALER     0x2         
    #define TIMER_CONFIG_WITHOUT_PRESCALER  0x1         
    #define TIMER_CONFIG_SELF_RESTART       0x10000      // End of TIMER_Macros group
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                     */
/* ========================================================================== */
    typedef volatile struct 
    {
        u32 PRESCALER;                      
        u32 reserved0[(0x0040U-0x4U)/4U];   
        u32 TIMER_CONFIG;                   
        u32 TIMER_LIMIT;                    
        u32 TIMER_VALUE;                    
    } timer_hwreg_t;

    typedef struct
    {
        timer_hwreg_t  *hwreg;              
        u32             prescaler_value;    
        u32             prescaler_enable;   
        u32             self_restart;       
        u32             timer_limit;        
    }timer_instance_t;
     // End of TIMER_Types group
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                     */
/* ========================================================================== */

    void timer_applyConfig(timer_instance_t *inst);
    void timer_clearValue(timer_instance_t *inst);

        u32 timer_getConfig(timer_instance_t *inst);
        u32 timer_getLimit(timer_instance_t *inst);
        u32 timer_getValue(timer_instance_t *inst);
        u32 timer_getPrescalerValue(timer_instance_t *inst);

    
        u32 timer_setConfig(timer_instance_t *inst, u32 value);
        u32 timer_setPrescalerValue(timer_instance_t *inst, u32 value);
        u32 timer_setLimit(timer_instance_t *inst, u32 value);
 // End of TIMER_Funcs group
 
#ifdef __cplusplus
}
#endif
 // End of MAIN UserTimer Group
 
#endif // TIMER_H