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