pwmout_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_PWMOUT_API_H
00017 #define MBED_PWMOUT_API_H
00018 
00019 #include "device.h"
00020 
00021 #if DEVICE_PWMOUT
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 typedef struct pwmout_s pwmout_t;
00028 
00029 void pwmout_init         (pwmout_t* obj, PinName pin);
00030 void pwmout_free         (pwmout_t* obj);
00031 
00032 void  pwmout_write       (pwmout_t* obj, float percent);
00033 float pwmout_read        (pwmout_t* obj);
00034 
00035 void pwmout_period       (pwmout_t* obj, float seconds);
00036 void pwmout_period_ms    (pwmout_t* obj, int ms);
00037 void pwmout_period_us    (pwmout_t* obj, int us);
00038 
00039 void pwmout_pulsewidth   (pwmout_t* obj, float seconds);
00040 void pwmout_pulsewidth_ms(pwmout_t* obj, int ms);
00041 void pwmout_pulsewidth_us(pwmout_t* obj, int us);
00042 
00043 #ifdef __cplusplus
00044 }
00045 #endif
00046 
00047 #endif
00048 
00049 #endif