hal_adc.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_ADC_H
#define _HAL_ADC_H


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


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

typedef enum {
    HAL_ADC_CH0 = 0u,               
    HAL_ADC_CH1 = 1u,               
    HAL_ADC_CH2 = 2u,               
    HAL_ADC_CH3 = 3u,               
    HAL_ADC_CH4 = 4u,               
    HAL_ADC_CH5 = 5u,               
    HAL_ADC_CH6 = 6u,               
    HAL_ADC_CH7 = 7u,               
    HAL_ADC_CH8 = 8u,               
    HAL_ADC_CH9 = 9u,               
    HAL_ADC_CH10 = 10u,             
    HAL_ADC_CH11 = 11u,             
    HAL_ADC_CH12 = 12u,             
    HAL_ADC_CH13 = 13u,             
    HAL_ADC_CH14 = 14u,             
    HAL_ADC_CH15 = 15u,             
    HAL_ADC_TEMP = 18u,             
    HAL_ADC_VREF = 17u,             
    HAL_ADC_VBAT = 18u,             
} hal_adc_channel_t;

typedef enum {
    HAL_ADC_RES_6B = 0x03,          
    HAL_ADC_RES_8B = 0x02,          
    HAL_ADC_RES_10B = 0x01,         
    HAL_ADC_RES_12B = 0x00          
} hal_adc_resolution_t;

typedef enum {
    HAL_ADC_POLARITY_NONE = 0x0,    
    HAL_ADC_POLARITY_RISING = 0x1,  
    HAL_ADC_POLARITY_FALLING = 0x2, 
    HAL_ADC_POLARITY_BOOTH = 0x3    
} hal_adc_polarity_t;

typedef enum {
    /* TIM1 */
    HAL_ADC_REGTRG_T1CC1 = 0u,      
    HAL_ADC_REGTRG_T1CC2 = 1u,      
    HAL_ADC_REGTRG_T1CC3 = 2u,      
    /* TIM2 */
    HAL_ADC_REGTRG_T2CC2 = 3u,      
    HAL_ADC_REGTRG_T2CC3 = 4u,      
    HAL_ADC_REGTRG_T2CC4 = 5u,      
    HAL_ADC_REGTRG_T2TRGO = 6u,     
    /* TIM3 */
    HAL_ADC_REGTRG_T3CC1 = 7u,      
    HAL_ADC_REGTRG_T3TRGO = 8u,     
    /* TIM4 */
    HAL_ADC_REGTRG_T4CC4 = 9u,      
    /* TIM5 */
    HAL_ADC_REGTRG_T5CC1 = 10u,     
    HAL_ADC_REGTRG_T5CC2 = 11u,     
    HAL_ADC_REGTRG_T5CC3 = 12u,     
    /* TIM8 */
    HAL_ADC_REGTRG_T8CC1 = 13u,     
    HAL_ADC_REGTRG_T8TRGO = 14u,    
    /* others */
    HAL_ADC_REGTRG_EXTI11 = 15u     
} hal_adc_regular_trg_t;

typedef enum {
    /* TIM1 */
    HAL_ADC_INJTRG_T1CC4 = 0u,      
    HAL_ADC_INJTRG_T1TRGO = 1u,     
    /* TIM2 */
    HAL_ADC_INJTRG_T2CC1 = 2u,      
    HAL_ADC_INJTRG_T2TRGO = 3u,     
    /* TIM3 */
    HAL_ADC_INJTRG_T3CC2 = 4u,      
    HAL_ADC_INJTRG_T3CC4 = 5u,      
    /* TIM4 */
    HAL_ADC_INJTRG_T4CC1 = 6u,      
    HAL_ADC_INJTRG_T4CC2 = 7u,      
    HAL_ADC_INJTRG_T4CC3 = 8u,      
    HAL_ADC_INJTRG_T4TRGO = 9u,     
    /* TIM5 */
    HAL_ADC_INJTRG_T5CC4 = 10u,     
    HAL_ADC_INJTRG_T5TRGO = 11u,    
    /* TIM8 */
    HAL_ADC_INJTRG_T8CC2 = 12u,     
    HAL_ADC_INJTRG_T8CC3 = 13u,     
    HAL_ADC_INJTRG_T8CC4 = 14u,     
    /* others */
    HAL_ADC_INJTRG_EXTI15 = 15u     
} hal_adc_injected_trg_t;

typedef enum {
    HAL_ADC_ALIGN_RIGHT = 0x0,      
    HAL_ADC_ALIGN_LEFT = 0x1        
} hal_adc_align_t;

typedef enum {
    HAL_ADC_SAMPLING_3C = 0u,       
    HAL_ADC_SAMPLING_15C = 1u,      
    HAL_ADC_SAMPLING_28C = 2u,      
    HAL_ADC_SAMPLING_56C = 3u,      
    HAL_ADC_SAMPLING_84C = 4u,      
    HAL_ADC_SAMPLING_112C = 5u,     
    HAL_ADC_SAMPLING_144C = 6u,     
    HAL_ADC_SAMPLING_480C = 7u      
} hal_adc_sample_time_t;

typedef struct {
    hal_adc_resolution_t resolution;    
    hal_bool_t scan_mode;               
    hal_bool_t continuous_mode;         
    hal_adc_polarity_t polarity;        
    hal_adc_regular_trg_t trigger;      
    hal_adc_align_t alignment;          
    uint8_t nr_conversions;             
} hal_adc_init_t;

typedef struct {
    uint8_t rank;                       
    hal_adc_sample_time_t cycles;       
} hal_adc_ch_init_t;


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

void hal_adc_reset(reg_adc_t *adc)
__attribute__((deprecated("Please use ADCx_RESET().")));

void hal_adc_init_base(reg_adc_t *adc, hal_adc_init_t init);

void hal_adc_init_channel(reg_adc_t *adc, 
                          hal_adc_channel_t channel,
                          hal_adc_ch_init_t init);

void hal_adc_start(reg_adc_t *adc);

void hal_adc_stop(reg_adc_t *adc);

void hal_adc_set_dma(reg_adc_t *adc,
                     hal_bool_t status);


#endif