STM32F401-Discovery BSP User Manual: stm32f401_discovery_gyroscope.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f401_discovery_gyroscope.h
00004   * @author  MCD Application Team
00005   * @version V2.2.2
00006   * @date    31-January-2017
00007   * @brief   This file contains definitions for stm32f401_discovery_gyroscope.c 
00008   *          firmware driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */
00038   
00039 
00040 /* Define to prevent recursive inclusion -------------------------------------*/
00041 #ifndef __STM32F401_DISCOVERY_GYROSCOPE_H
00042 #define __STM32F401_DISCOVERY_GYROSCOPE_H
00043 
00044 #ifdef __cplusplus
00045  extern "C" {
00046 #endif
00047 
00048 /* Includes ------------------------------------------------------------------*/
00049 #include "stm32f401_discovery.h"
00050 
00051  /* Include Gyroscope component driver */
00052 #include "../Components/l3gd20/l3gd20.h"   
00053 
00054 /** @addtogroup BSP
00055   * @{
00056   */
00057   
00058 /** @addtogroup STM32F401_DISCOVERY
00059   * @{
00060   */ 
00061 
00062 /** @defgroup STM32F401_DISCOVERY_GYROSCOPE STM32F401 DISCOVERY GYROSCOPE
00063   * @{
00064   */
00065   
00066 /** @defgroup STM32F401_DISCOVERY_GYROSCOPE_Exported_Types STM32F401 DISCOVERY GYROSCOPE Exported Types
00067   * @{
00068   */
00069 typedef enum 
00070 {
00071   GYRO_OK = 0,
00072   GYRO_ERROR = 1,
00073   GYRO_TIMEOUT = 2
00074 }GYRO_StatusTypeDef;
00075 /**
00076   * @}
00077   */
00078   
00079 /** @defgroup STM32F401_DISCOVERY_GYROSCOPE_Exported_Constants STM32F401 DISCOVERY GYROSCOPE Exported Constants
00080   * @{
00081   */
00082 /**
00083   * @}
00084   */
00085   
00086 /** @defgroup STM32F401_DISCOVERY_GYROSCOPE_Exported_Macros STM32F401 DISCOVERY GYROSCOPE Exported Macros
00087   * @{
00088   */
00089 /**
00090   * @}
00091   */
00092  
00093 /** @defgroup STM32F401_DISCOVERY_GYROSCOPE_Exported_Functions STM32F401 DISCOVERY GYROSCOPE Exported Functions
00094   * @{
00095   */
00096 /* Gyroscope Functions */ 
00097 uint8_t BSP_GYRO_Init(void);
00098 void    BSP_GYRO_Reset(void);
00099 uint8_t BSP_GYRO_ReadID(void);
00100 void    BSP_GYRO_ITConfig(GYRO_InterruptConfigTypeDef *pIntConfigStruct);
00101 void    BSP_GYRO_EnableIT(uint8_t IntPin);
00102 void    BSP_GYRO_DisableIT(uint8_t IntPin);
00103 void    BSP_GYRO_GetXYZ(float *pfData);
00104 
00105 /**
00106   * @}
00107   */
00108 
00109 /**
00110   * @}
00111   */
00112 
00113 /**
00114   * @}
00115   */
00116   
00117 /**
00118   * @}
00119   */  
00120 
00121 #ifdef __cplusplus
00122   }
00123 #endif
00124   
00125 #endif /* __STM32F401_DISCOVERY_GYROSCOPE_H */
00126 
00127 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/