Gan likun / The prosthetic control

The prosthetic control（MIT）

hal/analogout_api.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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