mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/pwmout_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
149:156823d33999 
mbed library release version 165

Who changed what in which revision?

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