Elijah Stanger-Jones / mbed-dev

Lightweight Mbed Library for STM F4 and F7

hal/analogin_api.h@2:0edeaf13dfb2, 2021-02-04 (annotated)

Committer:
elijahsj
Date:
Thu Feb 04 20:44:34 2021 +0000
Revision:
2:0edeaf13dfb2
Parent:
0:083111ae2a11 
modfiied for spine board;

Who changed what in which revision?

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