MT2523 API Reference  LinkIt SDK v4
hal_adc.h
1 /* Copyright Statement:
2  *
3  * (C) 2005-2016 MediaTek Inc. All rights reserved.
4  *
5  * This software/firmware and related documentation ("MediaTek Software") are
6  * protected under relevant copyright laws. The information contained herein
7  * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
8  * Without the prior written permission of MediaTek and/or its licensors,
9  * any reproduction, modification, use or disclosure of MediaTek Software,
10  * and information contained herein, in whole or in part, shall be strictly prohibited.
11  * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
12  * if you have agreed to and been bound by the applicable license agreement with
13  * MediaTek ("License Agreement") and been granted explicit permission to do so within
14  * the License Agreement ("Permitted User"). If you are not a Permitted User,
15  * please cease any access or use of MediaTek Software immediately.
16  * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
17  * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
18  * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
19  * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
21  * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
22  * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
23  * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
24  * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
25  * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
26  * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
27  * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
28  * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
29  * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
30  * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
31  * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
32  * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
33  */
34 
35 #ifndef __HAL_ADC_H__
36 #define __HAL_ADC_H__
37 #include "hal_platform.h"
38 
39 #ifdef HAL_ADC_MODULE_ENABLED
40 
66 #ifdef HAL_ADC_FEATURE_NO_NEED_PINMUX
67 
89 #elif defined HAL_ADC_FEATURE_SET_INPUT_AND_DISABLE_PULL
90 
120 #else
121 
147 #endif
148 
149 #ifdef __cplusplus
150 extern "C" {
151 #endif
152 
153 
154 /*****************************************************************************
155  * Enums
156  *****************************************************************************/
157 
163 typedef enum {
170 
176 /*****************************************************************************
177  * Structures
178  *****************************************************************************/
179 
180 
181 
182 /*****************************************************************************
183  * Functions
184  *****************************************************************************/
185 
194 
195 
203 
204 
217 
218 
219 #ifdef __cplusplus
220 }
221 #endif
222 
227 #endif /*HAL_ADC_MODULE_ENABLED*/
228 #endif /* __HAL_ADC_H__ */
229 
230 
231 
232 
hal_adc_status_t hal_adc_deinit(void)
ADC deinit function.
hal_adc_status_t hal_adc_init(void)
ADC init function.
Invalid parameter.
Definition: hal_adc.h:164
hal_adc_channel_t
ADC channel.
Definition: hal_platform.h:457
ADC error.
Definition: hal_adc.h:167
ADC channel number error.
Definition: hal_adc.h:166
ADC ok.
Definition: hal_adc.h:168
ADC is busy.
Definition: hal_adc.h:165
hal_adc_status_t
This enum defines the ADC API return status.
Definition: hal_adc.h:163
hal_adc_status_t hal_adc_get_data_polling(hal_adc_channel_t channel, uint32_t *data)
ADC receives a sample data for a channel.