2010-08-10 03:11:02 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
< html > < head > < meta http-equiv = "Content-Type" content = "text/html;charset=UTF-8" >
< title > ChibiOS/RT: pwm.h Source File< / title >
< link href = "custom.css" rel = "stylesheet" type = "text/css" >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" >
< / head > < body >
< table style = "text-align: center; width: 100%;" border = "0"
cellpadding="2" cellspacing="2">
< tbody >
< tr >
< td style = "width: 80px;" > < img alt = "ChibiOS/RT Logo" src = "logo_small.png" > < / td >
< td > < big > < big > ChibiOS/RT< / big > < / big > < br > < br > Architecture - Reference Manual - Guides< / td >
< td style = "width: 80px;" > < / td >
< / tr >
< / tbody >
< / table >
< hr size = "1" >
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
< div class = "navigation" id = "top" >
< div class = "tabs" >
2010-11-22 05:53:37 +00:00
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "main.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > Modules< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Data Structures< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "tabs2" >
< ul class = "tablist" >
2010-08-10 03:11:02 +00:00
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > Globals< / span > < / a > < / li >
< / ul >
< / div >
2010-11-22 05:53:37 +00:00
< div class = "header" >
< div class = "headertitle" >
< h1 > pwm.h< / h1 > < / div >
< / div >
< div class = "contents" >
< a href = "pwm_8h.html" > Go to the documentation of this file.< / a > < div class = "fragment" > < pre class = "fragment" > < a name = "l00001" > < / a > 00001 < span class = "comment" > /*< / span >
2010-08-10 03:11:02 +00:00
< a name = "l00002" > < / a > 00002 < span class = "comment" > ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.< / span >
< a name = "l00003" > < / a > 00003 < span class = "comment" > < / span >
< a name = "l00004" > < / a > 00004 < span class = "comment" > This file is part of ChibiOS/RT.< / span >
< a name = "l00005" > < / a > 00005 < span class = "comment" > < / span >
< a name = "l00006" > < / a > 00006 < span class = "comment" > ChibiOS/RT is free software; you can redistribute it and/or modify< / span >
< a name = "l00007" > < / a > 00007 < span class = "comment" > it under the terms of the GNU General Public License as published by< / span >
< a name = "l00008" > < / a > 00008 < span class = "comment" > the Free Software Foundation; either version 3 of the License, or< / span >
< a name = "l00009" > < / a > 00009 < span class = "comment" > (at your option) any later version.< / span >
< a name = "l00010" > < / a > 00010 < span class = "comment" > < / span >
< a name = "l00011" > < / a > 00011 < span class = "comment" > ChibiOS/RT is distributed in the hope that it will be useful,< / span >
< a name = "l00012" > < / a > 00012 < span class = "comment" > but WITHOUT ANY WARRANTY; without even the implied warranty of< / span >
< a name = "l00013" > < / a > 00013 < span class = "comment" > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the< / span >
< a name = "l00014" > < / a > 00014 < span class = "comment" > GNU General Public License for more details.< / span >
< a name = "l00015" > < / a > 00015 < span class = "comment" > < / span >
< a name = "l00016" > < / a > 00016 < span class = "comment" > You should have received a copy of the GNU General Public License< / span >
< a name = "l00017" > < / a > 00017 < span class = "comment" > along with this program. If not, see < http://www.gnu.org/licenses/> .< / span >
< a name = "l00018" > < / a > 00018 < span class = "comment" > < / span >
< a name = "l00019" > < / a > 00019 < span class = "comment" > ---< / span >
< a name = "l00020" > < / a > 00020 < span class = "comment" > < / span >
< a name = "l00021" > < / a > 00021 < span class = "comment" > A special exception to the GPL can be applied should you wish to distribute< / span >
< a name = "l00022" > < / a > 00022 < span class = "comment" > a combined work that includes ChibiOS/RT, without being obliged to provide< / span >
< a name = "l00023" > < / a > 00023 < span class = "comment" > the source code for any proprietary components. See the file exception.txt< / span >
< a name = "l00024" > < / a > 00024 < span class = "comment" > for full details of how and when the exception can be applied.< / span >
< a name = "l00025" > < / a > 00025 < span class = "comment" > */< / span >
< a name = "l00026" > < / a > 00026 < span class = "comment" > < / span >
< a name = "l00027" > < / a > 00027 < span class = "comment" > /**< / span >
< a name = "l00028" > < / a > 00028 < span class = "comment" > * @file pwm.h< / span >
< a name = "l00029" > < / a > 00029 < span class = "comment" > * @brief PWM Driver macros and structures.< / span >
< a name = "l00030" > < / a > 00030 < span class = "comment" > *< / span >
< a name = "l00031" > < / a > 00031 < span class = "comment" > * @addtogroup PWM< / span >
< a name = "l00032" > < / a > 00032 < span class = "comment" > * @{< / span >
< a name = "l00033" > < / a > 00033 < span class = "comment" > */< / span >
< a name = "l00034" > < / a > 00034
< a name = "l00035" > < / a > 00035 < span class = "preprocessor" > #ifndef _PWM_H_< / span >
< a name = "l00036" > < / a > 00036 < span class = "preprocessor" > < / span > < span class = "preprocessor" > #define _PWM_H_< / span >
< a name = "l00037" > < / a > 00037 < span class = "preprocessor" > < / span >
< a name = "l00038" > < / a > 00038 < span class = "preprocessor" > #if CH_HAL_USE_PWM || defined(__DOXYGEN__)< / span >
< a name = "l00039" > < / a > 00039 < span class = "preprocessor" > < / span >
< a name = "l00040" > < / a > 00040 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00041" > < / a > 00041 < span class = "comment" > /* Driver constants. */< / span >
< a name = "l00042" > < / a > 00042 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00043" > < / a > 00043
< a name = "l00044" > < / a > 00044 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00045" > < / a > 00045 < span class = "comment" > /* Driver pre-compile time settings. */< / span >
< a name = "l00046" > < / a > 00046 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00047" > < / a > 00047
< a name = "l00048" > < / a > 00048 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00049" > < / a > 00049 < span class = "comment" > /* Derived constants and error checks. */< / span >
< a name = "l00050" > < / a > 00050 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00051" > < / a > 00051
< a name = "l00052" > < / a > 00052 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00053" > < / a > 00053 < span class = "comment" > /* Driver data structures and types. */< / span >
< a name = "l00054" > < / a > 00054 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00055" > < / a > 00055 < span class = "comment" > < / span >
< a name = "l00056" > < / a > 00056 < span class = "comment" > /**< / span >
< a name = "l00057" > < / a > 00057 < span class = "comment" > * @brief Driver state machine possible states.< / span >
< a name = "l00058" > < / a > 00058 < span class = "comment" > */< / span >
< a name = "l00059" > < / a > < a class = "code" href = "group___p_w_m.html#ga9b63d6f4d51e8ca9ee1fce2a1bc86bc5" > 00059< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > enum< / span > {
2010-11-30 04:54:43 +00:00
< a name = "l00060" > < / a > < a class = "code" href = "group___p_w_m.html#gga9b63d6f4d51e8ca9ee1fce2a1bc86bc5abff5b42e5ab002433b66a8910548b48c" > 00060< / a > < a class = "code" href = "group___p_w_m.html#gga9b63d6f4d51e8ca9ee1fce2a1bc86bc5abff5b42e5ab002433b66a8910548b48c" > PWM_UNINIT< / a > = 0, < span class = "comment" > /**< Not initialized. */< / span >
< a name = "l00061" > < / a > < a class = "code" href = "group___p_w_m.html#gga9b63d6f4d51e8ca9ee1fce2a1bc86bc5a4da638211112ff017325e9472592a151" > 00061< / a > < a class = "code" href = "group___p_w_m.html#gga9b63d6f4d51e8ca9ee1fce2a1bc86bc5a4da638211112ff017325e9472592a151" > PWM_STOP< / a > = 1, < span class = "comment" > /**< Stopped. */< / span >
< a name = "l00062" > < / a > < a class = "code" href = "group___p_w_m.html#gga9b63d6f4d51e8ca9ee1fce2a1bc86bc5a1bb17b80878c81e8a0e4671a44bc7086" > 00062< / a > < a class = "code" href = "group___p_w_m.html#gga9b63d6f4d51e8ca9ee1fce2a1bc86bc5a1bb17b80878c81e8a0e4671a44bc7086" > PWM_READY< / a > = 2, < span class = "comment" > /**< Ready. */< / span >
2010-11-22 05:53:37 +00:00
< a name = "l00063" > < / a > 00063 } pwmstate_t;
2010-08-10 03:11:02 +00:00
< a name = "l00064" > < / a > 00064 < span class = "comment" > < / span >
< a name = "l00065" > < / a > 00065 < span class = "comment" > /**< / span >
< a name = "l00066" > < / a > 00066 < span class = "comment" > * @brief PWM logic mode.< / span >
< a name = "l00067" > < / a > 00067 < span class = "comment" > */< / span >
< a name = "l00068" > < / a > < a class = "code" href = "group___p_w_m.html#gaaa2db6a7be396595dcf16da3f94634a0" > 00068< / a > < span class = "keyword" > typedef< / span > < span class = "keyword" > enum< / span > {
2010-11-30 04:54:43 +00:00
< a name = "l00069" > < / a > < a class = "code" href = "group___p_w_m.html#ggaaa2db6a7be396595dcf16da3f94634a0a36ed95007c3ef01cab4254f099e57b4d" > 00069< / a > < a class = "code" href = "group___p_w_m.html#ggaaa2db6a7be396595dcf16da3f94634a0a36ed95007c3ef01cab4254f099e57b4d" > PWM_OUTPUT_DISABLED< / a > = 0, < span class = "comment" > /**< Output not driven, callback only. */< / span >
< a name = "l00070" > < / a > < a class = "code" href = "group___p_w_m.html#ggaaa2db6a7be396595dcf16da3f94634a0aebf0e802a4bab8825b697f2f7e8346f1" > 00070< / a > < a class = "code" href = "group___p_w_m.html#ggaaa2db6a7be396595dcf16da3f94634a0aebf0e802a4bab8825b697f2f7e8346f1" > PWM_OUTPUT_ACTIVE_HIGH< / a > = 1, < span class = "comment" > /**< Idle is logic level 0. */< / span >
< a name = "l00071" > < / a > < a class = "code" href = "group___p_w_m.html#ggaaa2db6a7be396595dcf16da3f94634a0a7a1e4472427e3a352e4837ba5146fcba" > 00071< / a > < a class = "code" href = "group___p_w_m.html#ggaaa2db6a7be396595dcf16da3f94634a0a7a1e4472427e3a352e4837ba5146fcba" > PWM_OUTPUT_ACTIVE_LOW< / a > = 2 < span class = "comment" > /**< Idle is logic level 1. */< / span >
< a name = "l00072" > < / a > 00072 } pwmmode_t;
< a name = "l00073" > < / a > 00073
< a name = "l00074" > < / a > 00074 < span class = "preprocessor" > #include " < a class = "code" href = "platforms_2_s_t_m32_2pwm__lld_8h.html" title = "STM32 PWM subsystem low level driver header." > pwm_lld.h< / a > " < / span >
< a name = "l00075" > < / a > 00075
< a name = "l00076" > < / a > 00076 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00077" > < / a > 00077 < span class = "comment" > /* Driver macros. */< / span >
< a name = "l00078" > < / a > 00078 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00079" > < / a > 00079 < span class = "comment" > < / span >
< a name = "l00080" > < / a > 00080 < span class = "comment" > /**< / span >
< a name = "l00081" > < / a > 00081 < span class = "comment" > * @brief Enables a PWM channel.< / span >
< a name = "l00082" > < / a > 00082 < span class = "comment" > * @details Programs (or reprograms) a PWM channel.< / span >
< a name = "l00083" > < / a > 00083 < span class = "comment" > * @note This function has to be invoked from a lock zone.< / span >
< a name = "l00084" > < / a > 00084 < span class = "comment" > *< / span >
< a name = "l00085" > < / a > 00085 < span class = "comment" > * @param[in] pwmp pointer to a @p PWMDriver object< / span >
< a name = "l00086" > < / a > 00086 < span class = "comment" > * @param[in] channel PWM channel identifier< / span >
< a name = "l00087" > < / a > 00087 < span class = "comment" > * @param[in] width PWM pulse width as clock pulses number< / span >
< a name = "l00088" > < / a > 00088 < span class = "comment" > */< / span >
< a name = "l00089" > < / a > < a class = "code" href = "group___p_w_m.html#gabe1aa3e76c63f687d918628c57def482" > 00089< / a > < span class = "preprocessor" > #define pwmEnableChannelI(pwmp, channel, width) \< / span >
< a name = "l00090" > < / a > 00090 < span class = "preprocessor" > pwm_lld_enable_channel(pwmp, channel, width)< / span >
< a name = "l00091" > < / a > 00091 < span class = "preprocessor" > < / span > < span class = "comment" > < / span >
< a name = "l00092" > < / a > 00092 < span class = "comment" > /**< / span >
< a name = "l00093" > < / a > 00093 < span class = "comment" > * @brief Disables a PWM channel.< / span >
< a name = "l00094" > < / a > 00094 < span class = "comment" > * @details The channel is disabled and its output line returned to the< / span >
< a name = "l00095" > < / a > 00095 < span class = "comment" > * idle state.< / span >
< a name = "l00096" > < / a > 00096 < span class = "comment" > * @note This function has to be invoked from a lock zone.< / span >
< a name = "l00097" > < / a > 00097 < span class = "comment" > *< / span >
< a name = "l00098" > < / a > 00098 < span class = "comment" > * @param[in] pwmp pointer to a @p PWMDriver object< / span >
< a name = "l00099" > < / a > 00099 < span class = "comment" > * @param[in] channel PWM channel identifier< / span >
< a name = "l00100" > < / a > 00100 < span class = "comment" > */< / span >
< a name = "l00101" > < / a > < a class = "code" href = "group___p_w_m.html#gaa15ffc7b909d46929ea3ef8cc903eea3" > 00101< / a > < span class = "preprocessor" > #define pwmDisableChannelI(pwmp, channel) \< / span >
< a name = "l00102" > < / a > 00102 < span class = "preprocessor" > pwm_lld_disable_channel(pwmp, channel)< / span >
< a name = "l00103" > < / a > 00103 < span class = "preprocessor" > < / span >
< a name = "l00104" > < / a > 00104 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00105" > < / a > 00105 < span class = "comment" > /* External declarations. */< / span >
< a name = "l00106" > < / a > 00106 < span class = "comment" > /*===========================================================================*/< / span >
< a name = "l00107" > < / a > 00107
< a name = "l00108" > < / a > 00108 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00109" > < / a > 00109 < span class = "preprocessor" > < / span > < span class = "keyword" > extern< / span > < span class = "stringliteral" > " C" < / span > {
< a name = "l00110" > < / a > 00110 < span class = "preprocessor" > #endif< / span >
< a name = "l00111" > < / a > 00111 < span class = "preprocessor" > < / span > < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_w_m.html#ga1c8ae46921c4ae7d57bd44dd994e10bd" title = "PWM Driver initialization." > pwmInit< / a > (< span class = "keywordtype" > void< / span > );
< a name = "l00112" > < / a > 00112 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_w_m.html#ga4dbf1fded2984ff6dc240afd2e1fcd74" title = "Initializes the standard part of a PWMDriver structure." > pwmObjectInit< / a > (< a class = "code" href = "struct_p_w_m_driver.html" title = "Structure representing an PWM driver." > PWMDriver< / a > *pwmp);
< a name = "l00113" > < / a > 00113 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_w_m.html#ga9c14dc1b026c78809440281786aceda3" title = "Configures and activates the PWM peripheral." > pwmStart< / a > (< a class = "code" href = "struct_p_w_m_driver.html" title = "Structure representing an PWM driver." > PWMDriver< / a > *pwmp, < span class = "keyword" > const< / span > < a class = "code" href = "struct_p_w_m_config.html" title = "Driver configuration structure." > PWMConfig< / a > *config);
< a name = "l00114" > < / a > 00114 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_w_m.html#ga8a4d0d8a47883efe286a332cade14080" title = "Deactivates the PWM peripheral." > pwmStop< / a > (< a class = "code" href = "struct_p_w_m_driver.html" title = "Structure representing an PWM driver." > PWMDriver< / a > *pwmp);
< a name = "l00115" > < / a > 00115 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_w_m.html#gafd6c45693467da77ab13edca8420620d" title = "Enables a PWM channel." > pwmEnableChannel< / a > (< a class = "code" href = "struct_p_w_m_driver.html" title = "Structure representing an PWM driver." > PWMDriver< / a > *pwmp,
< a name = "l00116" > < / a > 00116 < a class = "code" href = "group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5" title = "PWM channel type." > pwmchannel_t< / a > channel,
< a name = "l00117" > < / a > 00117 < a class = "code" href = "group___p_w_m___l_l_d.html#gaef1826611f5a65369e9e02d04e81ed61" title = "PWM counter type." > pwmcnt_t< / a > width);
< a name = "l00118" > < / a > 00118 < span class = "keywordtype" > void< / span > < a class = "code" href = "group___p_w_m.html#gac2679d11833a4ea9df5a9ed2e4a2c2e7" title = "Disables a PWM channel." > pwmDisableChannel< / a > (< a class = "code" href = "struct_p_w_m_driver.html" title = "Structure representing an PWM driver." > PWMDriver< / a > *pwmp, < a class = "code" href = "group___p_w_m___l_l_d.html#ga605a8a67c0f1cf38cecfcfada45b28b5" title = "PWM channel type." > pwmchannel_t< / a > channel);
< a name = "l00119" > < / a > 00119 < span class = "preprocessor" > #ifdef __cplusplus< / span >
< a name = "l00120" > < / a > 00120 < span class = "preprocessor" > < / span > }
< a name = "l00121" > < / a > 00121 < span class = "preprocessor" > #endif< / span >
< a name = "l00122" > < / a > 00122 < span class = "preprocessor" > < / span >
< a name = "l00123" > < / a > 00123 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CH_HAL_USE_PWM */< / span >
< a name = "l00124" > < / a > 00124
< a name = "l00125" > < / a > 00125 < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* _PWM_H_ */< / span >
< a name = "l00126" > < / a > 00126 < span class = "comment" > < / span >
< a name = "l00127" > < / a > 00127 < span class = "comment" > /** @} */< / span >
2010-08-10 03:11:02 +00:00
< / pre > < / div > < / div >
2010-11-22 05:53:37 +00:00
< / div >
2010-08-10 03:11:02 +00:00
< hr size = "1" > < address style = "text-align: right;" > < small >
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:49 for ChibiOS/RT by < a href = "http://www.doxygen.org/index.html" > < img src = "doxygen.png" alt = "doxygen" align = "middle" border = "0" > < / a > 1.7.1< / small > < / address >
2010-08-10 03:11:02 +00:00
< / body >
< / html >