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@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
138:093f2bd7b9eb
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

Who changed what in which revision?

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