Gan likun / mbed-dev11

hal/analogin_api.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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