gyro.h

00001 /**
00002   ******************************************************************************
00003   * @file    gyro.h
00004   * @author  MCD Application Team
00005   * @brief   This header file contains the functions prototypes for the gyroscope driver.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00010   *
00011   * Redistribution and use in source and binary forms, with or without modification,
00012   * are permitted provided that the following conditions are met:
00013   *   1. Redistributions of source code must retain the above copyright notice,
00014   *      this list of conditions and the following disclaimer.
00015   *   2. Redistributions in binary form must reproduce the above copyright notice,
00016   *      this list of conditions and the following disclaimer in the documentation
00017   *      and/or other materials provided with the distribution.
00018   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00019   *      may be used to endorse or promote products derived from this software
00020   *      without specific prior written permission.
00021   *
00022   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00023   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00024   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00025   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00026   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00027   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00028   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00030   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00031   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032   *
00033   ******************************************************************************
00034   */
00035   
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __GYRO_H
00039 #define __GYRO_H
00040 
00041 #ifdef __cplusplus
00042  extern "C" {
00043 #endif
00044 
00045 /* Includes ------------------------------------------------------------------*/
00046 #include <stdint.h>
00047 
00048 /** @addtogroup BSP
00049   * @{
00050   */
00051 
00052 /** @addtogroup Components
00053   * @{
00054   */
00055     
00056 /** @addtogroup GYRO
00057   * @{
00058   */
00059 
00060 /** @defgroup GYRO_Exported_Types
00061   * @{
00062   */
00063 
00064 /** @defgroup GYRO_Driver_structure  Gyroscope Driver structure
00065   * @{
00066   */
00067 typedef struct
00068 {  
00069   void       (*Init)(uint16_t);
00070   void       (*DeInit)(void); 
00071   uint8_t    (*ReadID)(void);
00072   void       (*Reset)(void);
00073   void       (*LowPower)(uint16_t);   
00074   void       (*ConfigIT)(uint16_t); 
00075   void       (*EnableIT)(uint8_t);
00076   void       (*DisableIT)(uint8_t);  
00077   uint8_t    (*ITStatus)(uint16_t, uint16_t);   
00078   void       (*ClearIT)(uint16_t, uint16_t); 
00079   void       (*FilterConfig)(uint8_t);  
00080   void       (*FilterCmd)(uint8_t);  
00081   void       (*GetXYZ)(float *);
00082 }GYRO_DrvTypeDef;
00083 /**
00084   * @}
00085   */
00086 
00087 /** @defgroup GYRO_Config_structure  Gyroscope Configuration structure
00088   * @{
00089   */
00090 
00091 typedef struct
00092 {
00093   uint8_t Power_Mode;                         /* Power-down/Sleep/Normal Mode */
00094   uint8_t Output_DataRate;                    /* OUT data rate */
00095   uint8_t Axes_Enable;                        /* Axes enable */
00096   uint8_t Band_Width;                         /* Bandwidth selection */
00097   uint8_t BlockData_Update;                   /* Block Data Update */
00098   uint8_t Endianness;                         /* Endian Data selection */
00099   uint8_t Full_Scale;                         /* Full Scale selection */
00100 }GYRO_InitTypeDef;
00101 
00102 /* GYRO High Pass Filter struct */
00103 typedef struct
00104 {
00105   uint8_t HighPassFilter_Mode_Selection;      /* Internal filter mode */
00106   uint8_t HighPassFilter_CutOff_Frequency;    /* High pass filter cut-off frequency */
00107 }GYRO_FilterConfigTypeDef;
00108 
00109 /*GYRO Interrupt struct */
00110 typedef struct
00111 {
00112   uint8_t Latch_Request;                      /* Latch interrupt request into CLICK_SRC register */
00113   uint8_t Interrupt_Axes;                     /* X, Y, Z Axes Interrupts */ 
00114   uint8_t Interrupt_ActiveEdge;               /* Interrupt Active edge */
00115 }GYRO_InterruptConfigTypeDef;  
00116 
00117 /**
00118   * @}
00119   */
00120 
00121 /**
00122   * @}
00123   */
00124 
00125 /**
00126   * @}
00127   */
00128 
00129 /**
00130   * @}
00131   */
00132 
00133 /**
00134   * @}
00135   */
00136 
00137 #ifdef __cplusplus
00138 }
00139 #endif
00140 
00141 #endif /* __GYRO_H */
00142 
00143 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/