87 lines
3.3 KiB
C
87 lines
3.3 KiB
C
/*-----------------------------------------------------------------------------
|
|
* Name: Board_ADC.h
|
|
* Purpose: A/D Converter interface header file
|
|
* Rev.: 1.0.0
|
|
*-----------------------------------------------------------------------------*/
|
|
|
|
/* Copyright (c) 2013 - 2014 ARM LIMITED
|
|
|
|
All rights reserved.
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
- Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
- Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
- Neither the name of ARM nor the names of its contributors may be used
|
|
to endorse or promote products derived from this software without
|
|
specific prior written permission.
|
|
*
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
|
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
---------------------------------------------------------------------------*/
|
|
|
|
#ifndef __BOARD_ADC_H
|
|
#define __BOARD_ADC_H
|
|
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
\fn int32_t ADC_Initialize (void)
|
|
\brief Initialize Analog-to-Digital Converter
|
|
\returns
|
|
- \b 0: function succeeded
|
|
- \b -1: function failed
|
|
*/
|
|
/**
|
|
\fn int32_t ADC_Uninitialize (void)
|
|
\brief De-initialize Analog-to-Digital Converter
|
|
\returns
|
|
- \b 0: function succeeded
|
|
- \b -1: function failed
|
|
*/
|
|
/**
|
|
\fn int32_t ADC_StartConversion (void)
|
|
\brief Start conversion
|
|
\returns
|
|
- \b 0: function succeeded
|
|
- \b -1: function failed
|
|
*/
|
|
/**
|
|
\fn int32_t ADC_ConversionDone (void)
|
|
\brief Check if conversion finished
|
|
\returns
|
|
- \b 0: conversion finished
|
|
- \b -1: conversion in progress
|
|
*/
|
|
/**
|
|
\fn int32_t ADC_GetValue (void)
|
|
\brief Get converted value
|
|
\returns
|
|
- <b> >=0</b>: converted value
|
|
- \b -1: conversion in progress or failed
|
|
*/
|
|
/**
|
|
\fn uint32_t ADC_GetResolution (void)
|
|
\brief Get resolution of Analog-to-Digital Converter
|
|
\returns Resolution (in bits)
|
|
*/
|
|
|
|
extern int32_t ADC_Initialize (void);
|
|
extern int32_t ADC_Uninitialize (void);
|
|
extern int32_t ADC_StartConversion (void);
|
|
extern int32_t ADC_ConversionDone (void);
|
|
extern int32_t ADC_GetValue (void);
|
|
extern uint32_t ADC_GetResolution (void);
|
|
|
|
#endif /* __BOARD_ADC_H */
|