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.
hal/pwmout_api.h@172:65be27845400, 2019-02-20 (annotated)
- Committer:
- AnnaBridge
- Date:
- Wed Feb 20 20:53:29 2019 +0000
- Revision:
- 172:65be27845400
- Parent:
- 128:9bcdf88f62b0
mbed library release version 165
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 128:9bcdf88f62b0 | 1 | |
<> | 128:9bcdf88f62b0 | 2 | /** \addtogroup hal */ |
<> | 128:9bcdf88f62b0 | 3 | /** @{*/ |
<> | 128:9bcdf88f62b0 | 4 | /* mbed Microcontroller Library |
<> | 128:9bcdf88f62b0 | 5 | * Copyright (c) 2006-2013 ARM Limited |
AnnaBridge | 172:65be27845400 | 6 | * SPDX-License-Identifier: Apache-2.0 |
<> | 128:9bcdf88f62b0 | 7 | * |
<> | 128:9bcdf88f62b0 | 8 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 128:9bcdf88f62b0 | 9 | * you may not use this file except in compliance with the License. |
<> | 128:9bcdf88f62b0 | 10 | * You may obtain a copy of the License at |
<> | 128:9bcdf88f62b0 | 11 | * |
<> | 128:9bcdf88f62b0 | 12 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 128:9bcdf88f62b0 | 13 | * |
<> | 128:9bcdf88f62b0 | 14 | * Unless required by applicable law or agreed to in writing, software |
<> | 128:9bcdf88f62b0 | 15 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 128:9bcdf88f62b0 | 16 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 128:9bcdf88f62b0 | 17 | * See the License for the specific language governing permissions and |
<> | 128:9bcdf88f62b0 | 18 | * limitations under the License. |
<> | 128:9bcdf88f62b0 | 19 | */ |
<> | 128:9bcdf88f62b0 | 20 | #ifndef MBED_PWMOUT_API_H |
<> | 128:9bcdf88f62b0 | 21 | #define MBED_PWMOUT_API_H |
<> | 128:9bcdf88f62b0 | 22 | |
<> | 128:9bcdf88f62b0 | 23 | #include "device.h" |
<> | 128:9bcdf88f62b0 | 24 | |
<> | 128:9bcdf88f62b0 | 25 | #if DEVICE_PWMOUT |
<> | 128:9bcdf88f62b0 | 26 | |
<> | 128:9bcdf88f62b0 | 27 | #ifdef __cplusplus |
<> | 128:9bcdf88f62b0 | 28 | extern "C" { |
<> | 128:9bcdf88f62b0 | 29 | #endif |
<> | 128:9bcdf88f62b0 | 30 | |
<> | 128:9bcdf88f62b0 | 31 | /** Pwmout hal structure. pwmout_s is declared in the target's hal |
<> | 128:9bcdf88f62b0 | 32 | */ |
<> | 128:9bcdf88f62b0 | 33 | typedef struct pwmout_s pwmout_t; |
<> | 128:9bcdf88f62b0 | 34 | |
<> | 128:9bcdf88f62b0 | 35 | /** |
<> | 128:9bcdf88f62b0 | 36 | * \defgroup hal_pwmout Pwmout hal functions |
<> | 128:9bcdf88f62b0 | 37 | * @{ |
<> | 128:9bcdf88f62b0 | 38 | */ |
<> | 128:9bcdf88f62b0 | 39 | |
<> | 128:9bcdf88f62b0 | 40 | /** Initialize the pwm out peripheral and configure the pin |
<> | 128:9bcdf88f62b0 | 41 | * |
<> | 128:9bcdf88f62b0 | 42 | * @param obj The pwmout object to initialize |
<> | 128:9bcdf88f62b0 | 43 | * @param pin The pwmout pin to initialize |
<> | 128:9bcdf88f62b0 | 44 | */ |
<> | 128:9bcdf88f62b0 | 45 | void pwmout_init(pwmout_t *obj, PinName pin); |
<> | 128:9bcdf88f62b0 | 46 | |
<> | 128:9bcdf88f62b0 | 47 | /** Deinitialize the pwmout object |
<> | 128:9bcdf88f62b0 | 48 | * |
<> | 128:9bcdf88f62b0 | 49 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 50 | */ |
<> | 128:9bcdf88f62b0 | 51 | void pwmout_free(pwmout_t *obj); |
<> | 128:9bcdf88f62b0 | 52 | |
<> | 128:9bcdf88f62b0 | 53 | /** Set the output duty-cycle in range <0.0f, 1.0f> |
<> | 128:9bcdf88f62b0 | 54 | * |
<> | 128:9bcdf88f62b0 | 55 | * Value 0.0f represents 0 percentage, 1.0f represents 100 percent. |
<> | 128:9bcdf88f62b0 | 56 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 57 | * @param percent The floating-point percentage number |
<> | 128:9bcdf88f62b0 | 58 | */ |
<> | 128:9bcdf88f62b0 | 59 | void pwmout_write(pwmout_t *obj, float percent); |
<> | 128:9bcdf88f62b0 | 60 | |
<> | 128:9bcdf88f62b0 | 61 | /** Read the current float-point output duty-cycle |
<> | 128:9bcdf88f62b0 | 62 | * |
<> | 128:9bcdf88f62b0 | 63 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 64 | * @return A floating-point output duty-cycle |
<> | 128:9bcdf88f62b0 | 65 | */ |
<> | 128:9bcdf88f62b0 | 66 | float pwmout_read(pwmout_t *obj); |
<> | 128:9bcdf88f62b0 | 67 | |
<> | 128:9bcdf88f62b0 | 68 | /** Set the PWM period specified in seconds, keeping the duty cycle the same |
<> | 128:9bcdf88f62b0 | 69 | * |
<> | 128:9bcdf88f62b0 | 70 | * Periods smaller than microseconds (the lowest resolution) are set to zero. |
<> | 128:9bcdf88f62b0 | 71 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 72 | * @param seconds The floating-point seconds period |
<> | 128:9bcdf88f62b0 | 73 | */ |
<> | 128:9bcdf88f62b0 | 74 | void pwmout_period(pwmout_t *obj, float seconds); |
<> | 128:9bcdf88f62b0 | 75 | |
<> | 128:9bcdf88f62b0 | 76 | /** Set the PWM period specified in miliseconds, keeping the duty cycle the same |
<> | 128:9bcdf88f62b0 | 77 | * |
<> | 128:9bcdf88f62b0 | 78 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 79 | * @param ms The milisecond period |
<> | 128:9bcdf88f62b0 | 80 | */ |
<> | 128:9bcdf88f62b0 | 81 | void pwmout_period_ms(pwmout_t *obj, int ms); |
<> | 128:9bcdf88f62b0 | 82 | |
<> | 128:9bcdf88f62b0 | 83 | /** Set the PWM period specified in microseconds, keeping the duty cycle the same |
<> | 128:9bcdf88f62b0 | 84 | * |
<> | 128:9bcdf88f62b0 | 85 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 86 | * @param us The microsecond period |
<> | 128:9bcdf88f62b0 | 87 | */ |
<> | 128:9bcdf88f62b0 | 88 | void pwmout_period_us(pwmout_t *obj, int us); |
<> | 128:9bcdf88f62b0 | 89 | |
<> | 128:9bcdf88f62b0 | 90 | /** Set the PWM pulsewidth specified in seconds, keeping the period the same. |
<> | 128:9bcdf88f62b0 | 91 | * |
<> | 128:9bcdf88f62b0 | 92 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 93 | * @param seconds The floating-point pulsewidth in seconds |
<> | 128:9bcdf88f62b0 | 94 | */ |
<> | 128:9bcdf88f62b0 | 95 | void pwmout_pulsewidth(pwmout_t *obj, float seconds); |
<> | 128:9bcdf88f62b0 | 96 | |
<> | 128:9bcdf88f62b0 | 97 | /** Set the PWM pulsewidth specified in miliseconds, keeping the period the same. |
<> | 128:9bcdf88f62b0 | 98 | * |
<> | 128:9bcdf88f62b0 | 99 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 100 | * @param ms The floating-point pulsewidth in miliseconds |
<> | 128:9bcdf88f62b0 | 101 | */ |
<> | 128:9bcdf88f62b0 | 102 | void pwmout_pulsewidth_ms(pwmout_t *obj, int ms); |
<> | 128:9bcdf88f62b0 | 103 | |
<> | 128:9bcdf88f62b0 | 104 | /** Set the PWM pulsewidth specified in microseconds, keeping the period the same. |
<> | 128:9bcdf88f62b0 | 105 | * |
<> | 128:9bcdf88f62b0 | 106 | * @param obj The pwmout object |
<> | 128:9bcdf88f62b0 | 107 | * @param us The floating-point pulsewidth in microseconds |
<> | 128:9bcdf88f62b0 | 108 | */ |
<> | 128:9bcdf88f62b0 | 109 | void pwmout_pulsewidth_us(pwmout_t *obj, int us); |
<> | 128:9bcdf88f62b0 | 110 | |
<> | 128:9bcdf88f62b0 | 111 | /**@}*/ |
<> | 128:9bcdf88f62b0 | 112 | |
<> | 128:9bcdf88f62b0 | 113 | #ifdef __cplusplus |
<> | 128:9bcdf88f62b0 | 114 | } |
<> | 128:9bcdf88f62b0 | 115 | #endif |
<> | 128:9bcdf88f62b0 | 116 | |
<> | 128:9bcdf88f62b0 | 117 | #endif |
<> | 128:9bcdf88f62b0 | 118 | |
<> | 128:9bcdf88f62b0 | 119 | #endif |
<> | 128:9bcdf88f62b0 | 120 | |
<> | 128:9bcdf88f62b0 | 121 | /** @}*/ |