Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/analogin_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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