Greg Steiert / maxim_dev

Maxim mbed development library

Dependents:   sensomed

hal/analogout_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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