John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

hal/analogin_api.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff
Child:
149:156823d33999
This updates the lib to the mbed lib v125

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 2 * Copyright (c) 2006-2013 ARM Limited
<> 144:ef7eb2e8f9f7 3 *
<> 144:ef7eb2e8f9f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 144:ef7eb2e8f9f7 5 * you may not use this file except in compliance with the License.
<> 144:ef7eb2e8f9f7 6 * You may obtain a copy of the License at
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 144:ef7eb2e8f9f7 9 *
<> 144:ef7eb2e8f9f7 10 * Unless required by applicable law or agreed to in writing, software
<> 144:ef7eb2e8f9f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 144:ef7eb2e8f9f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 144:ef7eb2e8f9f7 13 * See the License for the specific language governing permissions and
<> 144:ef7eb2e8f9f7 14 * limitations under the License.
<> 144:ef7eb2e8f9f7 15 */
<> 144:ef7eb2e8f9f7 16 #ifndef MBED_ANALOGIN_API_H
<> 144:ef7eb2e8f9f7 17 #define MBED_ANALOGIN_API_H
<> 144:ef7eb2e8f9f7 18
<> 144:ef7eb2e8f9f7 19 #include "device.h"
<> 144:ef7eb2e8f9f7 20
<> 144:ef7eb2e8f9f7 21 #if DEVICE_ANALOGIN
<> 144:ef7eb2e8f9f7 22
<> 144:ef7eb2e8f9f7 23 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 24 extern "C" {
<> 144:ef7eb2e8f9f7 25 #endif
<> 144:ef7eb2e8f9f7 26
<> 144:ef7eb2e8f9f7 27 /** Analogin hal structure. analogin_s is declared in the target's hal
<> 144:ef7eb2e8f9f7 28 */
<> 144:ef7eb2e8f9f7 29 typedef struct analogin_s analogin_t;
<> 144:ef7eb2e8f9f7 30
<> 144:ef7eb2e8f9f7 31 /**
<> 144:ef7eb2e8f9f7 32 * \defgroup hal_analogin Analogin hal functions
<> 144:ef7eb2e8f9f7 33 * @{
<> 144:ef7eb2e8f9f7 34 */
<> 144:ef7eb2e8f9f7 35
<> 144:ef7eb2e8f9f7 36 /** Initialize the analogin peripheral
<> 144:ef7eb2e8f9f7 37 *
<> 144:ef7eb2e8f9f7 38 * Configures the pin used by analogin.
<> 144:ef7eb2e8f9f7 39 * @param obj The analogin object to initialize
<> 144:ef7eb2e8f9f7 40 * @param pin The analogin pin name
<> 144:ef7eb2e8f9f7 41 */
<> 144:ef7eb2e8f9f7 42 void analogin_init(analogin_t *obj, PinName pin);
<> 144:ef7eb2e8f9f7 43
<> 144:ef7eb2e8f9f7 44 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
<> 144:ef7eb2e8f9f7 45 *
<> 144:ef7eb2e8f9f7 46 * @param obj The analogin object
<> 144:ef7eb2e8f9f7 47 * @return A floating value representing the current input voltage
<> 144:ef7eb2e8f9f7 48 */
<> 144:ef7eb2e8f9f7 49 float analogin_read(analogin_t *obj);
<> 144:ef7eb2e8f9f7 50
<> 144:ef7eb2e8f9f7 51 /** Read the value from analogin pin, represented as an unsigned 16bit value
<> 144:ef7eb2e8f9f7 52 *
<> 144:ef7eb2e8f9f7 53 * @param obj The analogin object
<> 144:ef7eb2e8f9f7 54 * @return An unsigned 16bit value representing the current input voltage
<> 144:ef7eb2e8f9f7 55 */
<> 144:ef7eb2e8f9f7 56 uint16_t analogin_read_u16(analogin_t *obj);
<> 144:ef7eb2e8f9f7 57
<> 144:ef7eb2e8f9f7 58 /**@}*/
<> 144:ef7eb2e8f9f7 59
<> 144:ef7eb2e8f9f7 60 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 61 }
<> 144:ef7eb2e8f9f7 62 #endif
<> 144:ef7eb2e8f9f7 63
<> 144:ef7eb2e8f9f7 64 #endif
<> 144:ef7eb2e8f9f7 65
<> 144:ef7eb2e8f9f7 66 #endif