analogout_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_ANALOGOUT_API_H
00017 #define MBED_ANALOGOUT_API_H
00018 
00019 #include "device.h"
00020 
00021 #if DEVICE_ANALOGOUT
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /** Analogout hal structure. dac_s is declared in the target's hal
00028  */
00029 typedef struct dac_s dac_t;
00030 
00031 /**
00032  * \defgroup hal_analogout Analogout hal functions
00033  * @{
00034  */
00035 
00036 /** Initialize the analogout peripheral
00037  *
00038  * Configures the pin used by analogout.
00039  * @param obj The analogout object to initialize
00040  * @param pin The analogout pin name
00041  */
00042 void analogout_init(dac_t *obj, PinName pin);
00043 
00044 /** Release the analogout object
00045  *
00046  * Note: This is not currently used in the mbed-drivers
00047  * @param obj The analogout object
00048  */
00049 void analogout_free(dac_t *obj);
00050 
00051 /** Set the output voltage, specified as a percentage (float)
00052  *
00053  * @param obj The analogin object
00054  * @param value The floating-point output voltage to be set
00055  */
00056 void analogout_write(dac_t *obj, float value);
00057 
00058 /** Set the output voltage, specified as unsigned 16-bit
00059  *
00060  * @param obj The analogin object
00061  * @param value The unsigned 16-bit output voltage to be set
00062  */
00063 void analogout_write_u16(dac_t *obj, uint16_t value);
00064 
00065 /** Read the current voltage value on the pin
00066  *
00067  * @param obj The analogin object
00068  * @return A floating-point value representing the current voltage on the pin,
00069  *     measured as a percentage
00070  */
00071 float analogout_read(dac_t *obj);
00072 
00073 /** Read the current voltage value on the pin, as a normalized unsigned 16bit value
00074  *
00075  * @param obj The analogin object
00076  * @return An unsigned 16-bit value representing the current voltage on the pin
00077  */
00078 uint16_t analogout_read_u16(dac_t *obj);
00079 
00080 /**@}*/
00081 
00082 #ifdef __cplusplus
00083 }
00084 #endif
00085 
00086 #endif
00087 
00088 #endif