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