accelero.h

00001 /**
00002   ******************************************************************************
00003   * @file    accelero.h
00004   * @author  MCD Application Team
00005   * @version V4.0.1
00006   * @date    21-July-2015
00007   * @brief   This header file contains the functions prototypes for the Accelerometer driver.
00008   ******************************************************************************
00009   * @attention
00010   *
00011   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00012   *
00013   * Redistribution and use in source and binary forms, with or without modification,
00014   * are permitted provided that the following conditions are met:
00015   *   1. Redistributions of source code must retain the above copyright notice,
00016   *      this list of conditions and the following disclaimer.
00017   *   2. Redistributions in binary form must reproduce the above copyright notice,
00018   *      this list of conditions and the following disclaimer in the documentation
00019   *      and/or other materials provided with the distribution.
00020   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021   *      may be used to endorse or promote products derived from this software
00022   *      without specific prior written permission.
00023   *
00024   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034   *
00035   ******************************************************************************
00036   */
00037 
00038 /* Define to prevent recursive inclusion -------------------------------------*/
00039 #ifndef __ACCELERO_H
00040 #define __ACCELERO_H
00041 
00042 #ifdef __cplusplus
00043  extern "C" {
00044 #endif
00045 
00046 /* Includes ------------------------------------------------------------------*/
00047 #include <stdint.h>
00048 
00049 /** @addtogroup BSP
00050   * @{
00051   */
00052 
00053 /** @addtogroup Components
00054   * @{
00055   */
00056     
00057 /** @addtogroup ACCELERO
00058   * @{
00059   */
00060 
00061 /** @defgroup ACCELERO_Exported_Types
00062   * @{
00063   */ 
00064 
00065 /** @defgroup ACCELERO_Driver_structure  Accelerometer Driver structure
00066   * @{
00067   */
00068 typedef struct
00069 {  
00070   void      (*Init)(uint16_t);
00071   void      (*DeInit)(void); 
00072   uint8_t   (*ReadID)(void);
00073   void      (*Reset)(void);
00074   void      (*LowPower)(void);
00075   void      (*ConfigIT)(void);
00076   void      (*EnableIT)(uint8_t);
00077   void      (*DisableIT)(uint8_t);
00078   uint8_t   (*ITStatus)(uint16_t);
00079   void      (*ClearIT)(void);
00080   void      (*FilterConfig)(uint8_t);
00081   void      (*FilterCmd)(uint8_t);
00082   void      (*GetXYZ)(int16_t *);
00083 }ACCELERO_DrvTypeDef;
00084 /**
00085   * @}
00086   */
00087 
00088 /** @defgroup ACCELERO_Configuration_structure  Accelerometer Configuration structure
00089   * @{
00090   */
00091 
00092 /* ACCELERO struct */
00093 typedef struct
00094 {
00095   uint8_t Power_Mode;                         /* Power-down/Normal Mode */
00096   uint8_t AccOutput_DataRate;                 /* OUT data rate */
00097   uint8_t Axes_Enable;                        /* Axes enable */
00098   uint8_t High_Resolution;                    /* High Resolution enabling/disabling */
00099   uint8_t BlockData_Update;                   /* Block Data Update */
00100   uint8_t Endianness;                         /* Endian Data selection */
00101   uint8_t AccFull_Scale;                      /* Full Scale selection */
00102   uint8_t Communication_Mode;
00103 }ACCELERO_InitTypeDef;
00104 
00105 /* ACCELERO High Pass Filter struct */
00106 typedef struct
00107 {
00108   uint8_t HighPassFilter_Mode_Selection;      /* Internal filter mode */
00109   uint8_t HighPassFilter_CutOff_Frequency;    /* High pass filter cut-off frequency */
00110   uint8_t HighPassFilter_AOI1;                /* HPF_enabling/disabling for AOI function on interrupt 1 */
00111   uint8_t HighPassFilter_AOI2;                /* HPF_enabling/disabling for AOI function on interrupt 2 */
00112   uint8_t HighPassFilter_Data_Sel;
00113   uint8_t HighPassFilter_Stat;
00114 }ACCELERO_FilterConfigTypeDef;
00115 
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 /* __ACCELERO_H */
00142 
00143 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/