Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/pwmout_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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