Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/analogout_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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