Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/hal/analogin_api.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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