Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/AnalogOut.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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