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