hal/nrf24le1/hal_adc.h

Go to the documentation of this file.

/* Copyright (c) 2009 Nordic Semiconductor. All Rights Reserved.
 *
 * The information contained herein is confidential property of Nordic 
 * Semiconductor ASA.Terms and conditions of usage are described in detail 
 * in NORDIC SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. 
 *
 * Licensees are granted free, non-transferable use of the information. NO
 * WARRENTY of ANY KIND is provided. This heading must NOT be removed from
 * the file.
 *              
 * $LastChangedRevision: 133 $
 */

#ifndef HAL_ADC_H__
#define HAL_ADC_H__

#include <stdint.h>
#include <stdbool.h>

#define ADC_STARTUP_CNT 1;

#define HAL_INP_AIN0   0x00
#define HAL_INP_AIN1   0x01
#define HAL_INP_AIN2   0x02
#define HAL_INP_AIN3   0x03
#define HAL_INP_AIN4   0x04
#define HAL_INP_AIN5   0x05
#define HAL_INP_AIN6   0x06
#define HAL_INP_AIN7   0x07
#define HAL_INP_AIN8   0x08
#define HAL_INP_AIN9   0x09 
#define HAL_INP_AIN10  0x0A
#define HAL_INP_AIN11  0x0B
#define HAL_INP_AIN12  0x0C
#define HAL_INP_AIN13  0x0D
#define HAL_INP_VDD1_3 0x0E
#define HAL_INP_VDD2_3 0x0F

typedef enum {
  HAL_ADC_INP_AIN0   = HAL_INP_AIN0,
  HAL_ADC_INP_AIN1   = HAL_INP_AIN1,
  HAL_ADC_INP_AIN2   = HAL_INP_AIN2,
  HAL_ADC_INP_AIN3   = HAL_INP_AIN3,
  HAL_ADC_INP_AIN4   = HAL_INP_AIN4,
  HAL_ADC_INP_AIN5   = HAL_INP_AIN5,
  HAL_ADC_INP_AIN6   = HAL_INP_AIN6,
  HAL_ADC_INP_AIN7   = HAL_INP_AIN7,
  HAL_ADC_INP_AIN8   = HAL_INP_AIN8,
  HAL_ADC_INP_AIN9   = HAL_INP_AIN9, 
  HAL_ADC_INP_AIN10  = HAL_INP_AIN10,
  HAL_ADC_INP_AIN11  = HAL_INP_AIN11,
  HAL_ADC_INP_AIN12  = HAL_INP_AIN12,
  HAL_ADC_INP_AIN13  = HAL_INP_AIN13,
  HAL_ADC_INP_VDD1_3 = HAL_INP_VDD1_3,
  HAL_ADC_INP_VDD2_3 = HAL_INP_VDD2_3
} hal_adc_input_channel_t;

typedef enum {
  HAL_ADC_REF_INT  = 0x00,    
  HAL_ADC_REF_VDD  = 0x01,    
  HAL_ADC_REF_AIN3 = 0x02,    
  HAL_ADC_REF_AIN9 = 0x03     
} hal_adc_reference_t;

typedef enum {
  HAL_ADC_SINGLE    = 0x00,   
  HAL_ADC_DIFF_AIN2 = 0x01,   
  HAL_ADC_DIFF_AIN6 = 0x02    
} hal_adc_input_mode_t;

typedef enum {
  HAL_ADC_SINGLE_STEP = 0x00, 
  HAL_ADC_CONTINOUS   = 0x01  
} hal_adc_conversion_mode_t;

typedef enum {
  HAL_ADC_2KSPS  = 0x00,      
  HAL_ADC_4KSPS  = 0x01,      
  HAL_ADC_8KSPS  = 0x02,      
  HAL_ADC_16KSPS = 0x03       
} hal_adc_sampling_rate_t;

typedef enum {               
  HAL_ADC_PDD_0US  = 0x00,    
  HAL_ADC_PDD_6US  = 0x01,    
  HAL_ADC_PDD_24US = 0x02,    
  HAL_ADC_PDD_INF  = 0x03     
} hal_adc_power_down_delay_t;

typedef enum {
  HAL_ADC_AQW_075US = 0x00,   
  HAL_ADC_AQW_3US   = 0x01,   
  HAL_ADC_AQW_12US  = 0x02,   
  HAL_ADC_AQW_36US  = 0x03    
} hal_adc_acq_window_t;

typedef enum {
  HAL_ADC_RES_6BIT  = 0x00,   
  HAL_ADC_RES_8BIT  = 0x01,   
  HAL_ADC_RES_10BIT = 0x02,   
  HAL_ADC_RES_12BIT = 0x03    
} hal_adc_resolution_t;

typedef enum {
  HAL_ADC_JUST_LEFT  = 0x00,
  HAL_ADC_JUST_RIGHT = 0x01
} hal_adc_data_just_t;

typedef enum {
  HAL_ADC_FLOW_NONE  = 0x00,   
  HAL_ADC_FLOW_OVER  = 0x01,   
  HAL_ADC_FLOW_UNDER = 0x02,   
  HAL_ADC_FLOW_BOTH  = 0x03    
} hal_adc_overflow_t;

/* Setup function prototypes */

void hal_adc_set_input_channel(hal_adc_input_channel_t chsel);

void hal_adc_set_reference(hal_adc_reference_t refsel);

void hal_adc_set_input_mode(hal_adc_input_mode_t input_mode);

void hal_adc_set_conversion_mode(hal_adc_conversion_mode_t conv_mode);

void hal_adc_set_sampling_rate(hal_adc_sampling_rate_t rate);

void hal_adc_set_power_down_delay(hal_adc_power_down_delay_t pdd);

void hal_adc_set_acq_window(hal_adc_acq_window_t tacq);

void hal_adc_set_resolution(hal_adc_resolution_t res);

void hal_adc_set_data_just(hal_adc_data_just_t just);


/* Operation function prototypes */

void hal_adc_start(void);

uint8_t hal_adc_read_LSB(void);

uint8_t hal_adc_read_MSB(void);

/* Status functions prototypes */

bool hal_adc_busy(void);

hal_adc_overflow_t hal_adc_get_overflow_status(void);

#endif // HAL_ADC_H__