-
Notifications
You must be signed in to change notification settings - Fork 0
/
apolloadc.h
130 lines (105 loc) · 6.13 KB
/
apolloadc.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/******************************************************************************
Copyright (C) 2013-2017, Fujitsu Electronics Europe GmbH or a
subsidiary of Fujitsu Electronics Europe GmbH. All rights reserved.
This software, including source code, documentation and related
materials ("Software"), is owned by Fujitsu Electronics Europe GmbH or
one of its subsidiaries ("Fujitsu").
If no EULA applies, Fujitsu hereby grants you a personal, non-exclusive,
non-transferable license to copy, modify, and compile the
Software source code solely for use in connection with Fujitsu's
integrated circuit products. Any reproduction, modification, translation,
compilation, or representation of this Software except as specified
above is prohibited without the express written permission of Fujitsu.
Disclaimer: THIS SOFTWARE IS PROVIDED AS-IS, WITH NO
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING,
BUT NOT LIMITED TO, NONINFRINGEMENT, IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE. Fujitsu reserves the right to make
changes to the Software without notice. Fujitsu does not assume any
liability arising out of the application or use of the Software or any
product or circuit described in the Software. Fujitsu does not
authorize its products for use in any products where a malfunction or
failure of the Fujitsu product may reasonably be expected to result in
significant property damage, injury or death ("High Risk Product"). By
including Fujitsu's product in a High Risk Product, the manufacturer
of such system or application assumes all risk of such use and in doing
so agrees to indemnify Fujitsu against all liability.
******************************************************************************/
/******************************************************************************/
/** \file ApolloAdc.h
**
** A detailed description is available at
** @link ApolloAdcGroup Apollo ADC Module description @endlink
**
** History:
** - 2017-09-20 V1.0 Manuel Schreiner First Version
** - 2018-06-07 V1.1 Manuel Schreiner Added missing ApolloAdc_SimpleRead prototype
** - 2018-07-06 V1.2 Manuel Schreiner Updated documentation,
** now part of the FEEU ClickBeetle(TM) SW Framework
** - 2018-08-09 V1.3 Manuel Schreiner Added support for Apollo3
** - 2019-03-07 V1.4 Manuel Schreiner Fixed wrong battload setting for Apollo2
** - 2019-03-25 V1.5 Manuel Schreiner Added __APOLLOADC_VERSION__ and __APOLLOADC_DATE__ defines
**
*****************************************************************************/
#ifndef __APOLLOADC_H__
#define __APOLLOADC_H__
#define __APOLLOADC_VERSION__ 15
#define __APOLLOADC_DATE__ "2019-03-25"
/* C binding of definitions if building with C++ compiler */
#ifdef __cplusplus
extern "C"
{
#endif
/**
******************************************************************************
** \defgroup ApolloAdcGroup Low-Level-Driver for Apollo 1/2 ADC
**
** Provided functions of ApolloAdc:
**
**
******************************************************************************/
//@{
/**
******************************************************************************
** \page apolloadc_module_includes Required includes in main application
** \brief Following includes are required
** @code
** #include "apolloadc.h"
** @endcode
**
******************************************************************************/
/**
******************************************************************************
** \page apolloadc_module_rte_device Required defines in RTE_Device.h to set and enable features
** \brief Following includes are required
** @code
** #define APOLLOADC_ENABLED 1 //set following define to enable the ADC module
** @endcode
**
******************************************************************************/
/*****************************************************************************/
/* Include files */
/*****************************************************************************/
#include "mcu.h"
/*****************************************************************************/
/* Global pre-processor symbols/macros ('#define') */
/*****************************************************************************/
/*****************************************************************************/
/* Global type definitions ('typedef') */
/*****************************************************************************/
/*****************************************************************************/
/* Global variable declarations ('extern', definition in C source) */
/*****************************************************************************/
/*****************************************************************************/
/* Global function prototypes ('extern', definition in C source) */
/*****************************************************************************/
float32_t ApolloAdc_SimpleRead(uint32_t pin, boolean_t bLowPower);
float32_t ApolloAdc_CheckBattery(boolean_t bLowPower);
#ifdef __cplusplus
}
#endif
//@} // ApolloAdcGroup
#endif /*__APOLLOADC_H__*/
/******************************************************************************/
/* EOF (not truncated) */
/******************************************************************************/