Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/analogout_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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