John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

hal/pwmout_api.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff
Child:
149:156823d33999
This updates the lib to the mbed lib v125

Who changed what in which revision?

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