BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/hal/pwmout_api.h@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

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