STM32L476G-Discovery BSP User Manual: stm32l476g_discovery_gyroscope.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l476g_discovery_gyroscope.h
00004   * @author  MCD Application Team
00005   * @version $VERSION$
00006   * @date    $DATE$
00007   * @brief   This file contains definitions for stm32l476g_discovery_gyroscope.c 
00008   *          firmware driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 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 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM32L476G_DISCOVERY_GYROSCOPE_H
00041 #define __STM32L476G_DISCOVERY_GYROSCOPE_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32l476g_discovery.h"
00049 /* Include Gyroscope component driver */
00050 #include "../Components/l3gd20/l3gd20.h"
00051 
00052 /** @addtogroup BSP
00053   * @{
00054   */
00055 
00056 /** @addtogroup STM32L476G_DISCOVERY
00057   * @{
00058   */
00059 
00060 /** @addtogroup STM32L476G_DISCOVERY_GYROSCOPE
00061   * @{
00062   */
00063 
00064 /** @defgroup STM32L476G_DISCOVERY_GYROSCOPE_Exported_Types Exported Types
00065   * @{
00066   */
00067 typedef enum 
00068 {
00069   GYRO_OK = 0,
00070   GYRO_ERROR = 1,
00071   GYRO_TIMEOUT = 2
00072 } 
00073 GYRO_StatusTypeDef;
00074 
00075 /**
00076   * @}
00077   */
00078 
00079 /** @defgroup STM32L476G_DISCOVERY_GYROSCOPE_Exported_Constants Exported Constants
00080   * @{
00081   */
00082 
00083 /**
00084   * @}
00085   */
00086 
00087 /** @defgroup STM32L476G_DISCOVERY_GYROSCOPE_Exported_Macros Exported Macros
00088   * @{
00089   */
00090 
00091 /**
00092   * @}
00093   */
00094 
00095 /** @defgroup STM32L476G_DISCOVERY_GYROSCOPE_Exported_Functions  Exported Functions
00096   * @{
00097   */
00098 /* Sensor Configuration Functions */ 
00099 uint8_t BSP_GYRO_Init(void);
00100 void    BSP_GYRO_DeInit(void);
00101 void    BSP_GYRO_LowPower(void);
00102 void    BSP_GYRO_Reset(void);
00103 uint8_t BSP_GYRO_ReadID(void);
00104 void    BSP_GYRO_ITConfig(GYRO_InterruptConfigTypeDef *pIntConfigStruct);
00105 void    BSP_GYRO_EnableIT(uint8_t IntPin);
00106 void    BSP_GYRO_DisableIT(uint8_t IntPin);
00107 void    BSP_GYRO_GetXYZ(float* pfData);
00108 
00109 /**
00110   * @}
00111   */
00112 
00113 /**
00114   * @}
00115   */
00116 
00117 /**
00118   * @}
00119   */
00120 
00121 /**
00122   * @}
00123   */
00124 
00125 #ifdef __cplusplus
00126 }
00127 #endif
00128 
00129 #endif /* __STM32L476G_DISCOVERY_GYROSCOPE_H */
00130 
00131 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/