git.sur5r.net Git - freertos/blob

   1 /**\r
   2   ******************************************************************************\r
   3   * @file    stm32l1xx_comp.c\r
   4   * @author  MCD Application Team\r
   5   * @version V1.1.1\r
   6   * @date    05-March-2012\r
   7   * @brief   This file provides firmware functions to manage the following \r
   8   *          functionalities of the comparators (COMP1 and COMP2) peripheral: \r
   9   *           + Comparators configuration\r
  10   *           + Window mode control\r
  11   *           + Internal Reference Voltage (VREFINT) output\r
  12   *\r
  13   *  @verbatim\r
  14  ===============================================================================\r
  15                      ##### How to use this driver #####\r
  16  ===============================================================================\r
  17     [..] The device integrates two analog comparators COMP1 and COMP2:\r
  18          (+) COMP1 is a fixed threshold (VREFINT) that shares the non inverting\r
  19              input with the ADC channels.\r
  20          (+) COMP2 is a rail-to-rail comparator whose the inverting input can be \r
  21              selected among: DAC_OUT1, DAC_OUT2, 1/4 VREFINT, 1/2 VERFINT, 3/4 \r
  22              VREFINT, VREFINT, PB3 and whose the output can be redirected to \r
  23              embedded timers: TIM2, TIM3, TIM4, TIM10.\r
  24   \r
  25          (+) The two comparators COMP1 and COMP2 can be combined in window mode.\r
  26 \r
  27          -@-\r
  28             (#@) Comparator APB clock must be enabled to get write access\r
  29                  to comparator register using\r
  30                  RCC_APB1PeriphClockCmd(RCC_APB1Periph_COMP, ENABLE).\r
  31   \r
  32             (#@) COMP1 comparator and ADC can't be used at the same time since\r
  33                  they share the same ADC switch matrix (analog switches).\r
  34   \r
  35             (#@) When an I/O is used as comparator input, the corresponding GPIO \r
  36                  registers should be configured in analog mode.\r
  37   \r
  38             (#@) Comparators outputs (CMP1OUT and CMP2OUT) are not mapped on\r
  39                  GPIO pin. They are only internal.\r
  40                  To get the comparator output level, use COMP_GetOutputLevel().\r
  41   \r
  42             (#@) COMP1 and COMP2 outputs are internally connected to EXTI Line 21\r
  43                  and EXTI Line 22 respectively.\r
  44                  Interrupts can be used by configuring the EXTI Line using the \r
  45                  EXTI peripheral driver.\r
  46   \r
  47             (#@) After enabling the comparator (COMP1 or COMP2), user should wait\r
  48                  for start-up time (tSTART) to get right output levels.\r
  49                  Please refer to product datasheet for more information on tSTART.\r
  50   \r
  51             (#@) Comparators cannot be used to exit the device from Sleep or Stop \r
  52                  mode when the internal reference voltage is switched off using \r
  53                  the PWR_UltraLowPowerCmd() function (ULP bit in the PWR_CR register).\r
  54   \r
  55     @endverbatim\r
  56   ******************************************************************************\r
  57   * @attention\r
  58   *\r
  59   * <h2><center>&copy; COPYRIGHT 2012 STMicroelectronics</center></h2>\r
  60   *\r
  61   * Licensed under MCD-ST Liberty SW License Agreement V2, (the "License");\r
  62   * You may not use this file except in compliance with the License.\r
  63   * You may obtain a copy of the License at:\r
  64   *\r
  65   *        http://www.st.com/software_license_agreement_liberty_v2\r
  66   *\r
  67   * Unless required by applicable law or agreed to in writing, software \r
  68   * distributed under the License is distributed on an "AS IS" BASIS, \r
  69   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  70   * See the License for the specific language governing permissions and\r
  71   * limitations under the License.\r
  72   *\r
  73   ******************************************************************************\r
  74   */\r
  75 \r
  76 /* Includes ------------------------------------------------------------------*/\r
  77 #include "stm32l1xx_comp.h"\r
  78 \r
  79 /** @addtogroup STM32L1xx_StdPeriph_Driver\r
  80   * @{\r
  81   */\r
  82 \r
  83 /** @defgroup COMP \r
  84   * @brief COMP driver modules.\r
  85   * @{\r
  86   */ \r
  87 \r
  88 /* Private typedef -----------------------------------------------------------*/\r
  89 /* Private define ------------------------------------------------------------*/\r
  90 /* Private macro -------------------------------------------------------------*/\r
  91 /* Private variables ---------------------------------------------------------*/\r
  92 /* Private function prototypes -----------------------------------------------*/\r
  93 /* Private functions ---------------------------------------------------------*/\r
  94 \r
  95 /** @defgroup COMP_Private_Functions\r
  96   * @{\r
  97   */\r
  98 \r
  99 /** @defgroup COMP_Group1 Initialization and Configuration functions\r
 100  *  @brief   Initialization and Configuration functions.\r
 101  *\r
 102 @verbatim\r
 103  ===============================================================================\r
 104               ##### Initialization and Configuration functions #####\r
 105  ===============================================================================\r
 106 \r
 107 @endverbatim\r
 108   * @{\r
 109   */\r
 110    \r
 111 /**\r
 112   * @brief  Deinitializes COMP peripheral registers to their default reset values.\r
 113   * @param  None\r
 114   * @retval None\r
 115   */\r
 116 void COMP_DeInit(void)\r
 117 {\r
 118   COMP->CSR = ((uint32_t)0x00000000);    /*!< Set COMP->CSR to reset value */\r
 119 }\r
 120 \r
 121 /**\r
 122   * @brief  Initializes the COMP2 peripheral according to the specified parameters\r
 123   *         in the COMP_InitStruct.\r
 124   * @note   This function configures only COMP2.\r
 125   * @note   COMP2 comparator is enabled as soon as the INSEL[2:0] bits are \r
 126   *         different from "000".\r
 127   * @param  COMP_InitStruct: pointer to an COMP_InitTypeDef structure that contains \r
 128   *         the configuration information for the specified COMP peripheral.  \r
 129   * @retval None\r
 130   */\r
 131 void COMP_Init(COMP_InitTypeDef* COMP_InitStruct)\r
 132 {\r
 133   uint32_t tmpreg = 0;\r
 134   \r
 135   /* Check the parameters */\r
 136   assert_param(IS_COMP_INVERTING_INPUT(COMP_InitStruct->COMP_InvertingInput));\r
 137   assert_param(IS_COMP_OUTPUT(COMP_InitStruct->COMP_OutputSelect));\r
 138   assert_param(IS_COMP_SPEED(COMP_InitStruct->COMP_Speed));\r
 139 \r
 140   /*!< Get the COMP CSR value */\r
 141   tmpreg = COMP->CSR;\r
 142 \r
 143   /*!< Clear the  INSEL[2:0], OUTSEL[1:0] and SPEED bits */ \r
 144   tmpreg &= (uint32_t) (~(uint32_t) (COMP_CSR_OUTSEL | COMP_CSR_INSEL | COMP_CSR_SPEED));\r
 145   \r
 146   /*!< Configure COMP: speed, inversion input selection and output redirection */\r
 147   /*!< Set SPEED bit according to COMP_InitStruct->COMP_Speed value */\r
 148   /*!< Set INSEL bits according to COMP_InitStruct->COMP_InvertingInput value */ \r
 149   /*!< Set OUTSEL bits according to COMP_InitStruct->COMP_OutputSelect value */  \r
 150   tmpreg |= (uint32_t)((COMP_InitStruct->COMP_Speed | COMP_InitStruct->COMP_InvertingInput \r
 151                         | COMP_InitStruct->COMP_OutputSelect));\r
 152 \r
 153   /*!< The COMP2 comparator is enabled as soon as the INSEL[2:0] bits value are \r
 154      different from "000" */\r
 155   /*!< Write to COMP_CSR register */\r
 156   COMP->CSR = tmpreg;  \r
 157 }\r
 158 \r
 159 /**\r
 160   * @brief  Enable or disable the COMP1 peripheral.\r
 161   * @note   After enabling COMP1, the following functions should be called to \r
 162   *         connect the selected GPIO input to COMP1 non inverting input:\r
 163   * @note   Enable switch control mode using SYSCFG_RISwitchControlModeCmd()\r
 164   * @note   Close VCOMP switch using SYSCFG_RIIOSwitchConfig()\r
 165   * @note   Close the I/O switch number n corresponding to the I/O \r
 166   *         using SYSCFG_RIIOSwitchConfig()\r
 167   * @param  NewState: new state of the COMP1 peripheral.\r
 168   *         This parameter can be: ENABLE or DISABLE.\r
 169   * @note   This function enables/disables only the COMP1.\r
 170   * @retval None\r
 171   */\r
 172 void COMP_Cmd(FunctionalState NewState)\r
 173 {\r
 174   /* Check the parameter */\r
 175   assert_param(IS_FUNCTIONAL_STATE(NewState));\r
 176 \r
 177   if (NewState != DISABLE)\r
 178   {\r
 179     /* Enable the COMP1 */\r
 180     COMP->CSR |= (uint32_t) COMP_CSR_CMP1EN;\r
 181   }\r
 182   else\r
 183   {\r
 184     /* Disable the COMP1  */\r
 185     COMP->CSR &= (uint32_t)(~COMP_CSR_CMP1EN);\r
 186   }\r
 187 }\r
 188 \r
 189 /**\r
 190   * @brief  Return the output level (high or low) of the selected comparator.\r
 191   * @note   Comparator output is low when the noninverting input is at a lower\r
 192   *         voltage than the inverting input.\r
 193   * @note   Comparator output is high when the noninverting input is at a higher\r
 194   *         voltage than the inverting input.\r
 195   * @note   Comparators outputs aren't available on GPIO (outputs levels are \r
 196   *         only internal). The COMP1 and COMP2 outputs are connected internally \r
 197   *         to the EXTI Line 21 and Line 22 respectively.\r
 198   * @param  COMP_Selection: the selected comparator.\r
 199   *   This parameter can be one of the following values:\r
 200   *     @arg COMP_Selection_COMP1: COMP1 selected\r
 201   *     @arg COMP_Selection_COMP2: COMP2 selected\r
 202   * @retval Returns the selected comparator output level.\r
 203   */\r
 204 uint8_t COMP_GetOutputLevel(uint32_t COMP_Selection)\r
 205 {\r
 206   uint8_t compout = 0x0;\r
 207 \r
 208   /* Check the parameters */\r
 209   assert_param(IS_COMP_ALL_PERIPH(COMP_Selection));\r
 210 \r
 211   /* Check if Comparator 1 is selected */\r
 212   if(COMP_Selection == COMP_Selection_COMP1)\r
 213   {\r
 214     /* Check if comparator 1 output level is high */\r
 215     if((COMP->CSR & COMP_CSR_CMP1OUT) != (uint8_t) RESET)\r
 216     {\r
 217       /* Get Comparator 1 output level */\r
 218       compout = (uint8_t) COMP_OutputLevel_High;\r
 219     }\r
 220     /* comparator 1 output level is low */\r
 221     else\r
 222     {\r
 223       /* Get Comparator 1 output level */\r
 224       compout = (uint8_t) COMP_OutputLevel_Low;\r
 225     }\r
 226   }\r
 227   /* Comparator 2 is selected */\r
 228   else\r
 229   {\r
 230     /* Check if comparator 2 output level is high */\r
 231     if((COMP->CSR & COMP_CSR_CMP2OUT) != (uint8_t) RESET)\r
 232     {\r
 233       /* Get Comparator output level */\r
 234       compout = (uint8_t) COMP_OutputLevel_High;\r
 235     }\r
 236     /* comparator 2 output level is low */\r
 237     else\r
 238     {\r
 239       /* Get Comparator 2 output level */\r
 240       compout = (uint8_t) COMP_OutputLevel_Low;\r
 241     }\r
 242   }\r
 243   /* Return the comparator output level */\r
 244   return (uint8_t)(compout);\r
 245 }\r
 246 \r
 247 /**\r
 248   * @brief  Close or Open the SW1 switch.\r
 249   * @param  NewState: new state of the SW1 switch.\r
 250   *         This parameter can be: ENABLE or DISABLE.\r
 251   * @note   ENABLE to close the SW1 switch\r
 252   * @note   DISABLE to open the SW1 switch\r
 253   * @retval None.\r
 254   */\r
 255 void COMP_SW1SwitchConfig(FunctionalState NewState)\r
 256 {\r
 257   /* Check the parameters */\r
 258   assert_param(IS_FUNCTIONAL_STATE(NewState));\r
 259 \r
 260   if (NewState != DISABLE)\r
 261   {\r
 262     /* Close SW1 switch */\r
 263     COMP->CSR |= (uint32_t) COMP_CSR_SW1;\r
 264   }\r
 265   else\r
 266   {\r
 267     /* Open SW1 switch */\r
 268     COMP->CSR &= (uint32_t)(~COMP_CSR_SW1);\r
 269   }\r
 270 }\r
 271 \r
 272 /**\r
 273   * @}\r
 274   */\r
 275 \r
 276 /** @defgroup COMP_Group2 Window mode control function\r
 277  *  @brief   Window mode control function.\r
 278  *\r
 279 @verbatim\r
 280  ===============================================================================\r
 281                   ##### Window mode control function #####\r
 282  ===============================================================================\r
 283 \r
 284 @endverbatim\r
 285   * @{\r
 286   */\r
 287 \r
 288 /**\r
 289   * @brief  Enables or disables the window mode.\r
 290   *         In window mode:\r
 291   * @note   COMP1 inverting input is fixed to VREFINT defining the first\r
 292   *         threshold.\r
 293   * @note   COMP2 inverting input is configurable (DAC_OUT1, DAC_OUT2, VREFINT\r
 294   *         sub-multiples, PB3) defining the second threshold.\r
 295   * @note   COMP1 and COMP2 non inverting inputs are connected together.\r
 296   * @note   In window mode, only the Group 6 (PB4 or PB5) can be used as\r
 297   *         noninverting inputs.\r
 298   * @param   NewState: new state of the window mode. \r
 299   *   This parameter can be ENABLE or DISABLE.\r
 300   * @retval None\r
 301   */\r
 302 void COMP_WindowCmd(FunctionalState NewState)\r
 303 {\r
 304   /* Check the parameters */\r
 305   assert_param(IS_FUNCTIONAL_STATE(NewState));\r
 306   \r
 307   if (NewState != DISABLE)\r
 308   {\r
 309     /* Enable the window mode */\r
 310     COMP->CSR |= (uint32_t) COMP_CSR_WNDWE;\r
 311   }\r
 312   else\r
 313   {\r
 314     /* Disable the window mode */\r
 315     COMP->CSR &= (uint32_t)(~COMP_CSR_WNDWE);\r
 316   }\r
 317 }\r
 318 \r
 319 /**\r
 320   * @}\r
 321   */\r
 322 \r
 323 /** @defgroup COMP_Group3 Internal Reference Voltage output function\r
 324  *  @brief   Internal Reference Voltage (VREFINT) output function.\r
 325  *\r
 326 @verbatim\r
 327  ===============================================================================\r
 328       ##### Internal Reference Voltage (VREFINT) output function #####\r
 329  ===============================================================================\r
 330 \r
 331 @endverbatim\r
 332   * @{\r
 333   */\r
 334 \r
 335 /**\r
 336   * @brief  Enables or disables the output of internal reference voltage (VREFINT).\r
 337   *         The VREFINT output can be routed to any I/O in group 3: CH8 (PB0) or\r
 338   *         CH9 (PB1).\r
 339   *         To correctly use this function, the SYSCFG_RIIOSwitchConfig() function\r
 340   *         should be called after.\r
 341   * @param  NewState: new state of the Vrefint output.\r
 342   *         This parameter can be: ENABLE or DISABLE.\r
 343   * @retval None\r
 344   */\r
 345 void COMP_VrefintOutputCmd(FunctionalState NewState)\r
 346 {\r
 347   /* Check the parameters */\r
 348   assert_param(IS_FUNCTIONAL_STATE(NewState));\r
 349 \r
 350   if (NewState != DISABLE)\r
 351   {\r
 352     /* Enable the output of internal reference voltage */\r
 353     COMP->CSR |= (uint32_t) COMP_CSR_VREFOUTEN;\r
 354   }\r
 355   else\r
 356   {\r
 357     /* Disable the output of internal reference voltage */\r
 358     COMP->CSR &= (uint32_t) (~COMP_CSR_VREFOUTEN);\r
 359   }\r
 360 }\r
 361 \r
 362 /**\r
 363   * @}\r
 364   */\r
 365 \r
 366 /**\r
 367   * @}\r
 368   */\r
 369 \r
 370 /**\r
 371   * @}\r
 372   */\r
 373 \r
 374 /**\r
 375   * @}\r
 376   */\r
 377 \r
 378 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/\r