Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

hal/analogout_api.h@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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