STM32F3-Discovery BSP User Manual: stm32f3_discovery_gyroscope.h Source File

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