Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/pwmout_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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