Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/hal/analogout_api.h@10:41552d038a69, 2017-01-10 (annotated)

Committer:
Zaitsev
Date:
Tue Jan 10 20:42:26 2017 +0000
Revision:
10:41552d038a69
USB Serial bi-directional bridge

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Zaitsev 10:41552d038a69 1
Zaitsev 10:41552d038a69 2 /** \addtogroup hal */
Zaitsev 10:41552d038a69 3 /** @{*/
Zaitsev 10:41552d038a69 4 /* mbed Microcontroller Library
Zaitsev 10:41552d038a69 5 * Copyright (c) 2006-2013 ARM Limited
Zaitsev 10:41552d038a69 6 *
Zaitsev 10:41552d038a69 7 * Licensed under the Apache License, Version 2.0 (the "License");
Zaitsev 10:41552d038a69 8 * you may not use this file except in compliance with the License.
Zaitsev 10:41552d038a69 9 * You may obtain a copy of the License at
Zaitsev 10:41552d038a69 10 *
Zaitsev 10:41552d038a69 11 * http://www.apache.org/licenses/LICENSE-2.0
Zaitsev 10:41552d038a69 12 *
Zaitsev 10:41552d038a69 13 * Unless required by applicable law or agreed to in writing, software
Zaitsev 10:41552d038a69 14 * distributed under the License is distributed on an "AS IS" BASIS,
Zaitsev 10:41552d038a69 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Zaitsev 10:41552d038a69 16 * See the License for the specific language governing permissions and
Zaitsev 10:41552d038a69 17 * limitations under the License.
Zaitsev 10:41552d038a69 18 */
Zaitsev 10:41552d038a69 19 #ifndef MBED_ANALOGOUT_API_H
Zaitsev 10:41552d038a69 20 #define MBED_ANALOGOUT_API_H
Zaitsev 10:41552d038a69 21
Zaitsev 10:41552d038a69 22 #include "device.h"
Zaitsev 10:41552d038a69 23
Zaitsev 10:41552d038a69 24 #if DEVICE_ANALOGOUT
Zaitsev 10:41552d038a69 25
Zaitsev 10:41552d038a69 26 #ifdef __cplusplus
Zaitsev 10:41552d038a69 27 extern "C" {
Zaitsev 10:41552d038a69 28 #endif
Zaitsev 10:41552d038a69 29
Zaitsev 10:41552d038a69 30 /** Analogout hal structure. dac_s is declared in the target's hal
Zaitsev 10:41552d038a69 31 */
Zaitsev 10:41552d038a69 32 typedef struct dac_s dac_t;
Zaitsev 10:41552d038a69 33
Zaitsev 10:41552d038a69 34 /**
Zaitsev 10:41552d038a69 35 * \defgroup hal_analogout Analogout hal functions
Zaitsev 10:41552d038a69 36 * @{
Zaitsev 10:41552d038a69 37 */
Zaitsev 10:41552d038a69 38
Zaitsev 10:41552d038a69 39 /** Initialize the analogout peripheral
Zaitsev 10:41552d038a69 40 *
Zaitsev 10:41552d038a69 41 * Configures the pin used by analogout.
Zaitsev 10:41552d038a69 42 * @param obj The analogout object to initialize
Zaitsev 10:41552d038a69 43 * @param pin The analogout pin name
Zaitsev 10:41552d038a69 44 */
Zaitsev 10:41552d038a69 45 void analogout_init(dac_t *obj, PinName pin);
Zaitsev 10:41552d038a69 46
Zaitsev 10:41552d038a69 47 /** Release the analogout object
Zaitsev 10:41552d038a69 48 *
Zaitsev 10:41552d038a69 49 * Note: This is not currently used in the mbed-drivers
Zaitsev 10:41552d038a69 50 * @param obj The analogout object
Zaitsev 10:41552d038a69 51 */
Zaitsev 10:41552d038a69 52 void analogout_free(dac_t *obj);
Zaitsev 10:41552d038a69 53
Zaitsev 10:41552d038a69 54 /** Set the output voltage, specified as a percentage (float)
Zaitsev 10:41552d038a69 55 *
Zaitsev 10:41552d038a69 56 * @param obj The analogin object
Zaitsev 10:41552d038a69 57 * @param value The floating-point output voltage to be set
Zaitsev 10:41552d038a69 58 */
Zaitsev 10:41552d038a69 59 void analogout_write(dac_t *obj, float value);
Zaitsev 10:41552d038a69 60
Zaitsev 10:41552d038a69 61 /** Set the output voltage, specified as unsigned 16-bit
Zaitsev 10:41552d038a69 62 *
Zaitsev 10:41552d038a69 63 * @param obj The analogin object
Zaitsev 10:41552d038a69 64 * @param value The unsigned 16-bit output voltage to be set
Zaitsev 10:41552d038a69 65 */
Zaitsev 10:41552d038a69 66 void analogout_write_u16(dac_t *obj, uint16_t value);
Zaitsev 10:41552d038a69 67
Zaitsev 10:41552d038a69 68 /** Read the current voltage value on the pin
Zaitsev 10:41552d038a69 69 *
Zaitsev 10:41552d038a69 70 * @param obj The analogin object
Zaitsev 10:41552d038a69 71 * @return A floating-point value representing the current voltage on the pin,
Zaitsev 10:41552d038a69 72 * measured as a percentage
Zaitsev 10:41552d038a69 73 */
Zaitsev 10:41552d038a69 74 float analogout_read(dac_t *obj);
Zaitsev 10:41552d038a69 75
Zaitsev 10:41552d038a69 76 /** Read the current voltage value on the pin, as a normalized unsigned 16bit value
Zaitsev 10:41552d038a69 77 *
Zaitsev 10:41552d038a69 78 * @param obj The analogin object
Zaitsev 10:41552d038a69 79 * @return An unsigned 16-bit value representing the current voltage on the pin
Zaitsev 10:41552d038a69 80 */
Zaitsev 10:41552d038a69 81 uint16_t analogout_read_u16(dac_t *obj);
Zaitsev 10:41552d038a69 82
Zaitsev 10:41552d038a69 83 /**@}*/
Zaitsev 10:41552d038a69 84
Zaitsev 10:41552d038a69 85 #ifdef __cplusplus
Zaitsev 10:41552d038a69 86 }
Zaitsev 10:41552d038a69 87 #endif
Zaitsev 10:41552d038a69 88
Zaitsev 10:41552d038a69 89 #endif
Zaitsev 10:41552d038a69 90
Zaitsev 10:41552d038a69 91 #endif
Zaitsev 10:41552d038a69 92
Zaitsev 10:41552d038a69 93 /** @}*/