mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/hal/analogout_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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