Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/hal/pwmout_api.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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