mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

analogin_api.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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