BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/pwmout_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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