Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/pwmout_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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