Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/hal/analogin_api.h@11:b3f2a8bdac4d, 2017-12-16 (annotated)

Committer:
Zaitsev
Date:
Sat Dec 16 10:26:48 2017 +0000
Revision:
11:b3f2a8bdac4d
Parent:
10:41552d038a69 
A copy for D.S;

Who changed what in which revision?

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