hal_timer.h

Go to the documentation of this file.

/* ----------------------------------------------------------------------------
 * --  _____       ______  _____                                              -
 * -- |_   _|     |  ____|/ ____|                                             -
 * --   | |  _ __ | |__  | (___    Institute of Embedded Systems              -
 * --   | | | '_ \|  __|  \___ \   Zurich University of                       -
 * --  _| |_| | | | |____ ____) |  Applied Sciences                           -
 * -- |_____|_| |_|______|_____/   8401 Winterthur, Switzerland               -
 * ------------------------------------------------------------------------- */
/* Re-definition guard */
#ifndef _HAL_TIMER_H
#define _HAL_TIMER_H


/* User includes */
#include "reg_stm32f4xx.h"
#include "hal_common.h"


/* -- Type definitions 
 * ------------------------------------------------------------------------- */

/* **** Basic **** */

typedef enum {
    HAL_TIMER_CH1 = 0u,             
    HAL_TIMER_CH2 = 1u,             
    HAL_TIMER_CH3 = 2u,             
    HAL_TIMER_CH4 = 3u,             
    /* Only as output in adv. timer 1/8 */
    HAL_TIMER_CH1N = 16u,           
    HAL_TIMER_CH2N = 17u,           
    HAL_TIMER_CH3N = 18u,           
} hal_timer_channel_t;


typedef enum {
    HAL_TIMER_MODE_UP = 0x0,        
    HAL_TIMER_MODE_DOWN = 0x1,      
    HAL_TIMER_MODE_CENTER1 = 0x2,   
    HAL_TIMER_MODE_CENTER2 = 0x4,   
    HAL_TIMER_MODE_CENTER3 = 0x6    
} hal_timer_mode_t;


typedef enum {
    HAL_TIMER_RUN_CONTINOUS = 0x0,  
    HAL_TIMER_RUN_ONCE = 0x1        
} hal_timer_run_t;


typedef enum {
    HAL_TIMER_IRQ_UE = 0x01,            
    HAL_TIMER_IRQ_CC1 = 0x02,           
    HAL_TIMER_IRQ_CC2 = 0x04,           
    HAL_TIMER_IRQ_CC3 = 0x08,           
    HAL_TIMER_IRQ_CC4 = 0x10,           
    HAL_TIMER_IRQ_TRIGGER = 0x40        
} hal_timer_irq_t;


typedef enum {
    HAL_TIMER_DMA_UDE = 0x0100,         
    HAL_TIMER_DMA_CC1 = 0x0200,         
    HAL_TIMER_DMA_CC2 = 0x0400,         
    HAL_TIMER_DMA_CC3 = 0x0800,         
    HAL_TIMER_DMA_CC4 = 0x1000,         
    HAL_TIMER_DMA_TRG = 0x4000          
} hal_timer_dmasrc_t;


typedef enum {
    HAL_TIMER_MASTER_RESET = 0u,        
    HAL_TIMER_MASTER_ENABLE = 1u,       
    HAL_TIMER_MASTER_UPDATE = 2u,       
    HAL_TIMER_MASTER_COMPARE = 3u,      
    HAL_TIMER_MASTER_COMPOC1 = 4u,      
    HAL_TIMER_MASTER_COMPOC2 = 5u,      
    HAL_TIMER_MASTER_COMPOC3 = 6u,      
    HAL_TIMER_MASTER_COMPOC4 = 7u       
} hal_timer_mastermode_t;


/* **** Filter **** */

typedef enum {
    HAL_TIMER_POLARITY_HIGH = 0x0,      
    HAL_TIMER_POLARITY_LOW = 0x1,       
    /* Only for input */
    HAL_TIMER_POLARITY_BOTH = 0x5       
} hal_timer_polarity_t;


typedef enum {
    HAL_TIMER_PSC_OFF = 0x0,            
    HAL_TIMER_PSC_DIV2 = 0x1,           
    HAL_TIMER_PSC_DIV4 = 0x2,           
    HAL_TIMER_PSC_DIV8 = 0x3            
} hal_timer_psc_t;


typedef enum {
    HAL_TIMER_FILTER_OFF = 0u,
    HAL_TIMER_FILTER_INT_N2 = 1u,
    HAL_TIMER_FILTER_INT_N4 = 2u,
    HAL_TIMER_FILTER_INT_N8 = 3u,
    HAL_TIMER_FILTER_DTS2_N6 = 4u,
    HAL_TIMER_FILTER_DTS2_N8 = 5u,
    HAL_TIMER_FILTER_DTS4_N6 = 6u,
    HAL_TIMER_FILTER_DTS4_N8 = 7u,
    HAL_TIMER_FILTER_DTS8_N6 = 8u,
    HAL_TIMER_FILTER_DTS8_N8 = 9u,
    HAL_TIMER_FILTER_DTS16_N5 = 10u,
    HAL_TIMER_FILTER_DTS16_N6 = 11u,
    HAL_TIMER_FILTER_DTS16_N8 = 12u,
    HAL_TIMER_FILTER_DTS32_N5 = 13u,
    HAL_TIMER_FILTER_DTS32_N6 = 14u,
    HAL_TIMER_FILTER_DTS32_N8 = 15u
} hal_timer_filter_t;


/* **** Output Compare **** */

typedef enum {
    HAL_TIMER_OCMODE_NONE = 0x0,        
    HAL_TIMER_OCMODE_ACTIVE   = 0x1,    
    HAL_TIMER_OCMODE_INACTIVE = 0x2,    
    HAL_TIMER_OCMODE_TOGGLE   = 0x3,    
    HAL_TIMER_OCMODE_PWM1 = 0x6,        
    HAL_TIMER_OCMODE_PWM2 = 0x7         
} hal_timer_oc_mode_t;


/* **** Input Capture **** */

typedef enum {
    HAL_TIMER_IC_SEL_DIRECT = 0x1,      
    HAL_TIMER_IC_SEL_INDIRECT = 0x2,    
    HAL_TIMER_IC_SEL_TRC = 0x3          
} hal_timer_ic_sel_t;


/* **** Clock Source **** */

typedef enum {
    HAL_TIMER_CLKSRC_INT,               
    HAL_TIMER_CLKSRC_ETRF,              
    HAL_TIMER_CLKSRC_TRGI               
} hal_timer_source_t;


typedef enum {
    HAL_TIMER_CLK_OFF = 0x00,           
    HAL_TIMER_CLK_DIV2 = 0x01,          
    HAL_TIMER_CLK_DIV4 = 0x02           
} hal_timer_clk_dts_t;


typedef enum {
    HAL_TIMER_TRGSRC_ITR0 = 0u,         
    HAL_TIMER_TRGSRC_ITR1 = 1u,         
    HAL_TIMER_TRGSRC_ITR2 = 2u,         
    HAL_TIMER_TRGSRC_ITR3 = 3u,         
    HAL_TIMER_TRGSRC_TI1F_ED = 4u,      
    HAL_TIMER_TRGSRC_TI1FP = 5u,        
    HAL_TIMER_TRGSRC_TI2FP = 6u,        
    HAL_TIMER_TRGSRC_ETRF = 7u          
} hal_timer_trgsrc_t;


typedef enum {
    HAL_TIMER_SLAVE_OFF = 0u,           
    HAL_TIMER_SLAVE_ENC1 = 1u,          
    HAL_TIMER_SLAVE_ENC2 = 2u,          
    HAL_TIMER_SLAVE_ENC3 = 3u,          
    HAL_TIMER_SLAVE_RESET = 4u,         
    HAL_TIMER_SLAVE_GATED = 5u,         
    HAL_TIMER_SLAVE_TRIGGER = 6u,       
    HAL_TIMER_SLAVE_EXT = 7u            
} hal_timer_slavemode_t;


/* **** Init Structs **** */

typedef struct {
    uint16_t prescaler;                 
    hal_timer_mode_t mode;              
    hal_timer_run_t run_mode;           
    uint32_t count;                     
    hal_timer_mastermode_t master_mode; 
} hal_timer_base_init_t;


typedef struct {
    hal_timer_filter_t mode;            
    hal_timer_polarity_t polarity;      
    hal_timer_psc_t prescaler;          
} hal_timer_filter_init_t;


typedef struct {
    hal_timer_source_t source;          
    hal_timer_slavemode_t slave_mode;   
    /* Only if ETRF is used as source */
    hal_timer_filter_init_t filter;     
    hal_timer_clk_dts_t filter_div;     
    /* Only if TRGI is used as source */
    hal_timer_trgsrc_t trg_source;      
} hal_timer_clock_init_t;


typedef struct {
    hal_timer_ic_sel_t input;           
    hal_timer_filter_init_t filter;     
    hal_bool_t input_state;             
} hal_timer_input_init_t;


typedef struct {
    hal_timer_oc_mode_t mode;           
    hal_timer_polarity_t polarity;      
    hal_bool_t output_state;            
    /* Only for PWM */
    uint32_t pulse;                     
} hal_timer_output_init_t;


/* -- Public function declarations 
 * ------------------------------------------------------------------------- */

void hal_timer_reset(reg_tim_t *timer)
__attribute__((deprecated("Please use ATIMx_RESET().")));

void hal_timer_init_base(reg_tim_t *timer,
                         hal_timer_base_init_t init);

void hal_timer_init_clock(reg_tim_t *timer, hal_timer_clock_init_t init);

void hal_timer_init_input(reg_tim_t *timer,
                          hal_timer_channel_t channel, 
                          hal_timer_input_init_t init);

void hal_timer_init_output(reg_tim_t *timer,
                           hal_timer_channel_t channel,
                           hal_timer_output_init_t init);

void hal_timer_start(reg_tim_t *timer);

void hal_timer_stop(reg_tim_t *timer);

void hal_timer_channel_set(reg_tim_t *timer,
                           hal_timer_channel_t channel,
                           hal_bool_t status);

void hal_timer_irq_set(reg_tim_t *timer,
                       hal_timer_irq_t irq,
                       hal_bool_t status);

hal_bool_t hal_timer_irq_status(reg_tim_t *timer, hal_timer_irq_t irq);

void hal_timer_irq_clear(reg_tim_t *timer, hal_timer_irq_t irq);

void hal_timer_dma_set(reg_tim_t *timer, 
                       hal_timer_dmasrc_t dma,
                       hal_bool_t status);

uint32_t hal_timer_counter_read(reg_tim_t *timer);

void hal_timer_reload_write(reg_tim_t *timer, uint32_t value);

void hal_timer_prescaler_write(reg_tim_t *timer, uint32_t value);

uint32_t hal_timer_compare_read(reg_tim_t *timer,
                                hal_timer_channel_t channel);

int8_t hal_timer_compare_write(reg_tim_t *timer,
                                hal_timer_channel_t channel,
                                uint32_t value);
#endif