mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/PwmOut.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
165:d1b4690b3f8b
Child:
171:3a7713b1edbc
mbed library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 5 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 6 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 13 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 14 * limitations under the License.
AnnaBridge 156:ff21514d8981 15 */
AnnaBridge 156:ff21514d8981 16 #ifndef MBED_PWMOUT_H
AnnaBridge 156:ff21514d8981 17 #define MBED_PWMOUT_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 20
AnnaBridge 156:ff21514d8981 21 #if defined (DEVICE_PWMOUT) || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 22 #include "hal/pwmout_api.h"
AnnaBridge 156:ff21514d8981 23 #include "platform/mbed_critical.h"
AnnaBridge 165:d1b4690b3f8b 24 #include "platform/mbed_power_mgmt.h"
AnnaBridge 156:ff21514d8981 25
AnnaBridge 156:ff21514d8981 26 namespace mbed {
AnnaBridge 156:ff21514d8981 27 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 28
AnnaBridge 156:ff21514d8981 29 /** A pulse-width modulation digital output
AnnaBridge 156:ff21514d8981 30 *
AnnaBridge 156:ff21514d8981 31 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 32 *
AnnaBridge 156:ff21514d8981 33 * Example
AnnaBridge 156:ff21514d8981 34 * @code
AnnaBridge 156:ff21514d8981 35 * // Fade a led on.
AnnaBridge 156:ff21514d8981 36 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * PwmOut led(LED1);
AnnaBridge 156:ff21514d8981 39 *
AnnaBridge 156:ff21514d8981 40 * int main() {
AnnaBridge 156:ff21514d8981 41 * while(1) {
AnnaBridge 156:ff21514d8981 42 * led = led + 0.01;
AnnaBridge 156:ff21514d8981 43 * wait(0.2);
AnnaBridge 156:ff21514d8981 44 * if(led == 1.0) {
AnnaBridge 156:ff21514d8981 45 * led = 0;
AnnaBridge 156:ff21514d8981 46 * }
AnnaBridge 156:ff21514d8981 47 * }
AnnaBridge 156:ff21514d8981 48 * }
AnnaBridge 156:ff21514d8981 49 * @endcode
AnnaBridge 156:ff21514d8981 50 * @ingroup drivers
AnnaBridge 156:ff21514d8981 51 */
AnnaBridge 156:ff21514d8981 52 class PwmOut {
AnnaBridge 156:ff21514d8981 53
AnnaBridge 156:ff21514d8981 54 public:
AnnaBridge 156:ff21514d8981 55
AnnaBridge 156:ff21514d8981 56 /** Create a PwmOut connected to the specified pin
AnnaBridge 156:ff21514d8981 57 *
AnnaBridge 156:ff21514d8981 58 * @param pin PwmOut pin to connect to
AnnaBridge 156:ff21514d8981 59 */
AnnaBridge 170:e95d10626187 60 PwmOut(PinName pin) : _deep_sleep_locked(false)
AnnaBridge 170:e95d10626187 61 {
AnnaBridge 156:ff21514d8981 62 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 63 pwmout_init(&_pwm, pin);
AnnaBridge 156:ff21514d8981 64 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 65 }
AnnaBridge 156:ff21514d8981 66
AnnaBridge 170:e95d10626187 67 ~PwmOut()
AnnaBridge 170:e95d10626187 68 {
AnnaBridge 156:ff21514d8981 69 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 70 unlock_deep_sleep();
AnnaBridge 156:ff21514d8981 71 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 72 }
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 /** Set the ouput duty-cycle, specified as a percentage (float)
AnnaBridge 156:ff21514d8981 75 *
AnnaBridge 156:ff21514d8981 76 * @param value A floating-point value representing the output duty-cycle,
AnnaBridge 156:ff21514d8981 77 * specified as a percentage. The value should lie between
AnnaBridge 156:ff21514d8981 78 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
AnnaBridge 156:ff21514d8981 79 * Values outside this range will be saturated to 0.0f or 1.0f.
AnnaBridge 156:ff21514d8981 80 */
AnnaBridge 170:e95d10626187 81 void write(float value)
AnnaBridge 170:e95d10626187 82 {
AnnaBridge 156:ff21514d8981 83 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 84 lock_deep_sleep();
AnnaBridge 156:ff21514d8981 85 pwmout_write(&_pwm, value);
AnnaBridge 156:ff21514d8981 86 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 87 }
AnnaBridge 156:ff21514d8981 88
AnnaBridge 156:ff21514d8981 89 /** Return the current output duty-cycle setting, measured as a percentage (float)
AnnaBridge 156:ff21514d8981 90 *
AnnaBridge 156:ff21514d8981 91 * @returns
AnnaBridge 156:ff21514d8981 92 * A floating-point value representing the current duty-cycle being output on the pin,
AnnaBridge 156:ff21514d8981 93 * measured as a percentage. The returned value will lie between
AnnaBridge 156:ff21514d8981 94 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
AnnaBridge 156:ff21514d8981 95 *
AnnaBridge 156:ff21514d8981 96 * @note
AnnaBridge 156:ff21514d8981 97 * This value may not match exactly the value set by a previous write().
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 170:e95d10626187 99 float read()
AnnaBridge 170:e95d10626187 100 {
AnnaBridge 156:ff21514d8981 101 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 102 float val = pwmout_read(&_pwm);
AnnaBridge 156:ff21514d8981 103 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 104 return val;
AnnaBridge 156:ff21514d8981 105 }
AnnaBridge 156:ff21514d8981 106
AnnaBridge 156:ff21514d8981 107 /** Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
AnnaBridge 156:ff21514d8981 108 *
AnnaBridge 156:ff21514d8981 109 * @param seconds Change the period of a PWM signal in seconds (float) without modifying the duty cycle
AnnaBridge 156:ff21514d8981 110 * @note
AnnaBridge 156:ff21514d8981 111 * The resolution is currently in microseconds; periods smaller than this
AnnaBridge 156:ff21514d8981 112 * will be set to zero.
AnnaBridge 156:ff21514d8981 113 */
AnnaBridge 170:e95d10626187 114 void period(float seconds)
AnnaBridge 170:e95d10626187 115 {
AnnaBridge 156:ff21514d8981 116 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 117 pwmout_period(&_pwm, seconds);
AnnaBridge 156:ff21514d8981 118 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 119 }
AnnaBridge 156:ff21514d8981 120
AnnaBridge 156:ff21514d8981 121 /** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
AnnaBridge 156:ff21514d8981 122 * @param ms Change the period of a PWM signal in milli-seconds without modifying the duty cycle
AnnaBridge 156:ff21514d8981 123 */
AnnaBridge 170:e95d10626187 124 void period_ms(int ms)
AnnaBridge 170:e95d10626187 125 {
AnnaBridge 156:ff21514d8981 126 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 127 pwmout_period_ms(&_pwm, ms);
AnnaBridge 156:ff21514d8981 128 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 129 }
AnnaBridge 156:ff21514d8981 130
AnnaBridge 156:ff21514d8981 131 /** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
AnnaBridge 156:ff21514d8981 132 * @param us Change the period of a PWM signal in micro-seconds without modifying the duty cycle
AnnaBridge 156:ff21514d8981 133 */
AnnaBridge 170:e95d10626187 134 void period_us(int us)
AnnaBridge 170:e95d10626187 135 {
AnnaBridge 156:ff21514d8981 136 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 137 pwmout_period_us(&_pwm, us);
AnnaBridge 156:ff21514d8981 138 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 139 }
AnnaBridge 156:ff21514d8981 140
AnnaBridge 156:ff21514d8981 141 /** Set the PWM pulsewidth, specified in seconds (float), keeping the period the same.
AnnaBridge 156:ff21514d8981 142 * @param seconds Change the pulse width of a PWM signal specified in seconds (float)
AnnaBridge 156:ff21514d8981 143 */
AnnaBridge 170:e95d10626187 144 void pulsewidth(float seconds)
AnnaBridge 170:e95d10626187 145 {
AnnaBridge 156:ff21514d8981 146 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 147 pwmout_pulsewidth(&_pwm, seconds);
AnnaBridge 156:ff21514d8981 148 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 149 }
AnnaBridge 156:ff21514d8981 150
AnnaBridge 156:ff21514d8981 151 /** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
AnnaBridge 156:ff21514d8981 152 * @param ms Change the pulse width of a PWM signal specified in milli-seconds
AnnaBridge 156:ff21514d8981 153 */
AnnaBridge 170:e95d10626187 154 void pulsewidth_ms(int ms)
AnnaBridge 170:e95d10626187 155 {
AnnaBridge 156:ff21514d8981 156 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 157 pwmout_pulsewidth_ms(&_pwm, ms);
AnnaBridge 156:ff21514d8981 158 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 159 }
AnnaBridge 156:ff21514d8981 160
AnnaBridge 156:ff21514d8981 161 /** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
AnnaBridge 170:e95d10626187 162 * @param us Change the pulse width of a PWM signal specified in micro-seconds
AnnaBridge 156:ff21514d8981 163 */
AnnaBridge 170:e95d10626187 164 void pulsewidth_us(int us)
AnnaBridge 170:e95d10626187 165 {
AnnaBridge 156:ff21514d8981 166 core_util_critical_section_enter();
AnnaBridge 156:ff21514d8981 167 pwmout_pulsewidth_us(&_pwm, us);
AnnaBridge 156:ff21514d8981 168 core_util_critical_section_exit();
AnnaBridge 156:ff21514d8981 169 }
AnnaBridge 156:ff21514d8981 170
AnnaBridge 156:ff21514d8981 171 /** A operator shorthand for write()
AnnaBridge 156:ff21514d8981 172 * \sa PwmOut::write()
AnnaBridge 156:ff21514d8981 173 */
AnnaBridge 170:e95d10626187 174 PwmOut &operator= (float value)
AnnaBridge 170:e95d10626187 175 {
AnnaBridge 156:ff21514d8981 176 // Underlying call is thread safe
AnnaBridge 156:ff21514d8981 177 write(value);
AnnaBridge 156:ff21514d8981 178 return *this;
AnnaBridge 156:ff21514d8981 179 }
AnnaBridge 156:ff21514d8981 180
AnnaBridge 156:ff21514d8981 181 /** A operator shorthand for write()
AnnaBridge 156:ff21514d8981 182 * \sa PwmOut::write()
AnnaBridge 170:e95d10626187 183 */
AnnaBridge 170:e95d10626187 184 PwmOut &operator= (PwmOut &rhs)
AnnaBridge 170:e95d10626187 185 {
AnnaBridge 156:ff21514d8981 186 // Underlying call is thread safe
AnnaBridge 156:ff21514d8981 187 write(rhs.read());
AnnaBridge 156:ff21514d8981 188 return *this;
AnnaBridge 156:ff21514d8981 189 }
AnnaBridge 156:ff21514d8981 190
AnnaBridge 156:ff21514d8981 191 /** An operator shorthand for read()
AnnaBridge 156:ff21514d8981 192 * \sa PwmOut::read()
AnnaBridge 156:ff21514d8981 193 */
AnnaBridge 170:e95d10626187 194 operator float()
AnnaBridge 170:e95d10626187 195 {
AnnaBridge 156:ff21514d8981 196 // Underlying call is thread safe
AnnaBridge 156:ff21514d8981 197 return read();
AnnaBridge 156:ff21514d8981 198 }
AnnaBridge 156:ff21514d8981 199
AnnaBridge 156:ff21514d8981 200 protected:
AnnaBridge 156:ff21514d8981 201 /** Lock deep sleep only if it is not yet locked */
AnnaBridge 170:e95d10626187 202 void lock_deep_sleep()
AnnaBridge 170:e95d10626187 203 {
AnnaBridge 156:ff21514d8981 204 if (_deep_sleep_locked == false) {
AnnaBridge 156:ff21514d8981 205 sleep_manager_lock_deep_sleep();
AnnaBridge 156:ff21514d8981 206 _deep_sleep_locked = true;
AnnaBridge 156:ff21514d8981 207 }
AnnaBridge 156:ff21514d8981 208 }
AnnaBridge 156:ff21514d8981 209
AnnaBridge 156:ff21514d8981 210 /** Unlock deep sleep in case it is locked */
AnnaBridge 170:e95d10626187 211 void unlock_deep_sleep()
AnnaBridge 170:e95d10626187 212 {
AnnaBridge 156:ff21514d8981 213 if (_deep_sleep_locked == true) {
AnnaBridge 156:ff21514d8981 214 sleep_manager_unlock_deep_sleep();
AnnaBridge 156:ff21514d8981 215 _deep_sleep_locked = false;
AnnaBridge 156:ff21514d8981 216 }
AnnaBridge 156:ff21514d8981 217 }
AnnaBridge 156:ff21514d8981 218
AnnaBridge 156:ff21514d8981 219 pwmout_t _pwm;
AnnaBridge 156:ff21514d8981 220 bool _deep_sleep_locked;
AnnaBridge 156:ff21514d8981 221 };
AnnaBridge 156:ff21514d8981 222
AnnaBridge 156:ff21514d8981 223 } // namespace mbed
AnnaBridge 156:ff21514d8981 224
AnnaBridge 156:ff21514d8981 225 #endif
AnnaBridge 156:ff21514d8981 226
AnnaBridge 156:ff21514d8981 227 #endif