gr55xx_hal_adc_voltage_api.h
Go to the documentation of this file.
1 /**
2 ****************************************************************************************
3 *
4 * @file gr55xx_hal_adc_voltage_api.h
5 *
6 * @brief Header file - GR55xx ADC voltage module.
7 *
8 ****************************************************************************************
9 * @attention
10 #####Copyright (c) 2019 GOODIX
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of GOODIX nor the names of its contributors may be used
21 to endorse or promote products derived from this software without
22 specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
35 *****************************************************************************************
36 */
37 #ifndef __GR55XX_HAL_ADC_VOLTAGE_API_H__
38 #define __GR55XX_HAL_ADC_VOLTAGE_API_H__
39
40 /*
41 * INCLUDE FILES
42 *****************************************************************************************
43 */
44 #include <stdint.h>
45 #include "gr55xx_hal_adc.h"
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 /*
52 * GLOBAL FUNCTION DEFINITIONS
53 *****************************************************************************************
54 */
55 /**
56 ****************************************************************************************
57 * @brief Convert the ADC conversion results to a voltage value(internal reference).
58 *
59 * @param[in] hadc: Pointer to a ADC handle which contains the configuration information for
60 * the specified ADC module.
61 * @param[in] inbuf: Pointer to data buffer which storage ADC conversion results.
62 * @param[out] outbuf: Pointer to data buffer which to storage voltage results.
63 * @param[in] buflen: Length of data buffer, ranging between 0 and 4095.
64 *
65 * @return Result of operation.
66 ****************************************************************************************
67 */
68 void hal_adc_voltage_intern(adc_handle_t *hadc, uint16_t *inbuf, double *outbuf, uint32_t buflen);
69
70 /**
71 ****************************************************************************************
72 * @brief Convert the ADC conversion results to a voltage value(external reference).
73 *
74 * @param[in] hadc: Pointer to a ADC handle which contains the configuration information for
75 * the specified ADC module.
76 * @param[in] vref: slope of ADC.
77 * @param[in] inbuf: Pointer to data buffer which storage ADC conversion results.
78 * @param[out] outbuf: Pointer to data buffer which to storage voltage results.
79 * @param[in] buflen: Length of data buffer, ranging between 0 and 4095.
80 *
81 * @return Result of operation.
82 ****************************************************************************************
83 */
84 void hal_adc_voltage_extern(adc_handle_t *hadc, double vref, uint16_t *inbuf, double *outbuf, uint32_t buflen);
85
86 #ifdef __cplusplus
87 }
88 #endif
89
90 #endif // __GR55XX_HAL_ADC_VOLTAGE_API_H__
hal_adc_voltage_intern
void hal_adc_voltage_intern(adc_handle_t *hadc, uint16_t *inbuf, double *outbuf, uint32_t buflen)
Convert the ADC conversion results to a voltage value(internal reference).
hal_adc_voltage_extern
void hal_adc_voltage_extern(adc_handle_t *hadc, double vref, uint16_t *inbuf, double *outbuf, uint32_t buflen)
Convert the ADC conversion results to a voltage value(external reference).
gr55xx_hal_adc.h
Header file containing functions prototypes of ADC HAL library.
_adc_handle
ADC handle Structure definition.
Definition: gr55xx_hal_adc.h:111