BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/analogout_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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