cc y / mbed

ads1115 only

Fork of mbed by mbed official

hal/pwmout_api.h@128:9bcdf88f62b0, 2016-10-27 (annotated)

Committer:
<>
Date:
Thu Oct 27 16:45:56 2016 +0100
Revision:
128:9bcdf88f62b0
Release 128 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



2966: Add kw24 support https://github.com/ARMmbed/mbed-os/pull/2966

3068: MultiTech mDot - clean up PeripheralPins.c and add new pin names https://github.com/ARMmbed/mbed-os/pull/3068

3089: Kinetis HAL: Remove clock initialization code from serial and ticker  https://github.com/ARMmbed/mbed-os/pull/3089

2943: [NRF5] NVIC_SetVector functionality https://github.com/ARMmbed/mbed-os/pull/2943

2938: InterruptIn changes in NCS36510 HAL. https://github.com/ARMmbed/mbed-os/pull/2938

3108: Fix sleep function for NRF52. https://github.com/ARMmbed/mbed-os/pull/3108

3076: STM32F1: Correct timer master value reading https://github.com/ARMmbed/mbed-os/pull/3076

3085: Add LOWPOWERTIMER capability for NUCLEO_F303ZE https://github.com/ARMmbed/mbed-os/pull/3085

3046: [BEETLE] Update BLE stack on Beetle board https://github.com/ARMmbed/mbed-os/pull/3046

3122: [Silicon Labs] Update of Silicon Labs HAL https://github.com/ARMmbed/mbed-os/pull/3122

3022: OnSemi RAM usage fix https://github.com/ARMmbed/mbed-os/pull/3022

3121: STM32F3: Correct UART4 and UART5 defines when using DEVICE_SERIAL_ASYNCH https://github.com/ARMmbed/mbed-os/pull/3121

3142: Targets- NUMAKER_PFM_NUC47216 remove mbed 2 https://github.com/ARMmbed/mbed-os/pull/3142

Who changed what in which revision?

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