zhang boie / mbed-dev-f30333

mbed-dev-f303

drivers/AnalogOut.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 1 /* mbed Microcontroller Library
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 2 * Copyright (c) 2006-2013 ARM Limited
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 3 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 4 * Licensed under the Apache License, Version 2.0 (the "License");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 5 * you may not use this file except in compliance with the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 6 * You may obtain a copy of the License at
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 7 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 8 * http://www.apache.org/licenses/LICENSE-2.0
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 9 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 10 * Unless required by applicable law or agreed to in writing, software
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 11 * distributed under the License is distributed on an "AS IS" BASIS,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 13 * See the License for the specific language governing permissions and
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 14 * limitations under the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 15 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 16 #ifndef MBED_ANALOGOUT_H
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 17 #define MBED_ANALOGOUT_H
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 18
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 19 #include "platform/platform.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 20
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 21 #if defined (DEVICE_ANALOGOUT) || defined(DOXYGEN_ONLY)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 22
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 23 #include "hal/analogout_api.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 24 #include "platform/PlatformMutex.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 25
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 26 namespace mbed {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 27 /** \addtogroup drivers */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 28
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 29 /** An analog output, used for setting the voltage on a pin
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 30 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 31 * @note Synchronization level: Thread safe
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 32 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 33 * Example:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 34 * @code
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 35 * // Make a sawtooth output
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 36 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 37 * #include "mbed.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 38 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 39 * AnalogOut tri(p18);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 40 * int main() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 41 * while(1) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 42 * tri = tri + 0.01;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 43 * wait_us(1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 44 * if(tri == 1) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 45 * tri = 0;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 46 * }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 47 * }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 48 * }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 49 * @endcode
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 50 * @ingroup drivers
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 51 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 52 class AnalogOut {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 53
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 54 public:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 55
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 56 /** Create an AnalogOut connected to the specified pin
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 57 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 58 * @param pin AnalogOut pin to connect to
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 59 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 60 AnalogOut(PinName pin) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 61 analogout_init(&_dac, pin);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 62 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 63
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 64 /** Set the output voltage, specified as a percentage (float)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 65 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 66 * @param value A floating-point value representing the output voltage,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 67 * specified as a percentage. The value should lie between
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 68 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 69 * Values outside this range will be saturated to 0.0f or 1.0f.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 70 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 71 void write(float value) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 72 lock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 73 analogout_write(&_dac, value);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 74 unlock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 75 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 76
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 77 /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 78 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 79 * @param value 16-bit unsigned short representing the output voltage,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 80 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 81 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 82 void write_u16(unsigned short value) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 83 lock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 84 analogout_write_u16(&_dac, value);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 85 unlock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 86 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 87
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 88 /** Return the current output voltage setting, measured as a percentage (float)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 89 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 90 * @returns
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 91 * A floating-point value representing the current voltage being output on the pin,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 92 * measured as a percentage. The returned value will lie between
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 93 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 94 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 95 * @note
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 96 * This value may not match exactly the value set by a previous write().
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 97 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 98 float read() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 99 lock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 100 float ret = analogout_read(&_dac);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 101 unlock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 102 return ret;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 103 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 104
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 105 /** An operator shorthand for write()
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 106 * \sa AnalogOut::write()
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 107 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 108 AnalogOut& operator= (float percent) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 109 // Underlying write call is thread safe
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 110 write(percent);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 111 return *this;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 112 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 113
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 114 /** An operator shorthand for write()
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 115 * \sa AnalogOut::write()
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 116 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 117 AnalogOut& operator= (AnalogOut& rhs) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 118 // Underlying write call is thread safe
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 119 write(rhs.read());
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 120 return *this;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 121 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 122
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 123 /** An operator shorthand for read()
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 124 * \sa AnalogOut::read()
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 125 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 126 operator float() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 127 // Underlying read call is thread safe
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 128 return read();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 129 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 130
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 131 virtual ~AnalogOut() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 132 // Do nothing
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 133 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 134
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 135 protected:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 136
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 137 virtual void lock() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 138 _mutex.lock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 139 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 140
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 141 virtual void unlock() {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 142 _mutex.unlock();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 143 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 144
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 145 dac_t _dac;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 146 PlatformMutex _mutex;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 147 };
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 148
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 149 } // namespace mbed
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 150
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 151 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 152
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 153 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 154