Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/analogout_api.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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