Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
analogin_api.h
1 
2 /** \addtogroup hal */
3 /** @{*/
4 /* mbed Microcontroller Library
5  * Copyright (c) 2006-2013 ARM Limited
6  * SPDX-License-Identifier: Apache-2.0
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 #ifndef MBED_ANALOGIN_API_H
21 #define MBED_ANALOGIN_API_H
22 
23 #include "device.h"
24 #include "pinmap.h"
25 
26 #if DEVICE_ANALOGIN
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 /** Analogin hal structure. analogin_s is declared in the target's hal
33  */
34 typedef struct analogin_s analogin_t;
35 
36 /**
37  * \defgroup hal_analogin Analogin hal functions
38  *
39  * # Defined behaviour
40  * * The function ::analogin_init initializes the analogin_t control structure
41  * * The function ::analogin_free returns the pin owned by the Analogin object to its reset state
42  * * The function ::analogin_read reads the input voltage, represented as a float in the range [0.0 (GND), 1.0 (VCC)]
43  * * The function ::analogin_read_u16 reads the value from analogin pin, represented as an unsigned 16bit value [0.0 (GND), MAX_UINT16 (VCC)]
44  * * The accuracy of the ADC is +/- 10%
45  * * The ADC operations ::analogin_read, ::analogin_read_u16 take less than 20us to complete
46  *
47  * # Undefined behaviour
48  *
49  * * ::analogin_init is called with invalid pin (which does not support analog input function)
50  * * Calling ::analogin_read, ::analogin_read_u16 before ::analogin_init
51  * @{
52  */
53 
54 /**
55  * \defgroup hal_analogin_tests Analogin hal tests
56  * The Analogin HAL tests ensure driver conformance to defined behaviour.
57  *
58  * To run the Analogin hal tests use the command:
59  *
60  * mbed test -t <toolchain> -m <target> -n tests-mbed_hal_fpga_ci_test_shield-analogin
61  *
62  */
63 
64 /** Initialize the analogin peripheral
65  *
66  * Configures the pin used by analogin.
67  * @param obj The analogin object to initialize
68  * @param pinmap pointer to structure which holds static pinmap
69  */
70 void analogin_init_direct(analogin_t *obj, const PinMap *pinmap);
71 
72 /** Initialize the analogin peripheral
73  *
74  * Configures the pin used by analogin.
75  * @param obj The analogin object to initialize
76  * @param pin The analogin pin name
77  */
78 void analogin_init(analogin_t *obj, PinName pin);
79 
80 /** Release the analogin peripheral
81  *
82  * Releases the pin used by analogin.
83  * @param obj The analogin object to initialize
84  */
85 void analogin_free(analogin_t *obj);
86 
87 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
88  *
89  * @param obj The analogin object
90  * @return A floating value representing the current input voltage
91  */
92 float analogin_read(analogin_t *obj);
93 
94 /** Read the value from analogin pin, represented as an unsigned 16bit value
95  *
96  * @param obj The analogin object
97  * @return An unsigned 16bit value representing the current input voltage
98  */
99 uint16_t analogin_read_u16(analogin_t *obj);
100 
101 /** Get the pins that support analogin
102  *
103  * Return a PinMap array of pins that support analogin. The
104  * array is terminated with {NC, NC, 0}.
105  *
106  * @return PinMap array
107  */
108 const PinMap *analogin_pinmap(void);
109 
110 /**@}*/
111 
112 #ifdef __cplusplus
113 }
114 #endif
115 
116 #endif
117 
118 #endif
119 
120 /** @}*/
analogin_init_direct
void analogin_init_direct(analogin_t *obj, const PinMap *pinmap)
Initialize the analogin peripheral.
analogin_t
struct analogin_s analogin_t
Analogin hal structure.
Definition: analogin_api.h:34
analogin_read_u16
uint16_t analogin_read_u16(analogin_t *obj)
Read the value from analogin pin, represented as an unsigned 16bit value.
PinMap
Definition: pinmap.h:31
analogin_free
void analogin_free(analogin_t *obj)
Release the analogin peripheral.
analogin_read
float analogin_read(analogin_t *obj)
Read the input voltage, represented as a float in the range [0.0, 1.0].
analogin_pinmap
const PinMap * analogin_pinmap(void)
Get the pins that support analogin.
analogin_init
void analogin_init(analogin_t *obj, PinName pin)
Initialize the analogin peripheral.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.