Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/hal/analogin_api.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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