Gan likun / mbed1-dev

001

hal/analogout_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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