Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/PwmOut.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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