accelero.h

00001 /**
00002   ******************************************************************************
00003   * @file    accelero.h
00004   * @author  MCD Application Team
00005   * @brief   This header file contains the functions prototypes for the Accelerometer 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 /* Define to prevent recursive inclusion -------------------------------------*/
00037 #ifndef __ACCELERO_H
00038 #define __ACCELERO_H
00039 
00040 #ifdef __cplusplus
00041  extern "C" {
00042 #endif
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 #include <stdint.h>
00046 
00047 /** @addtogroup BSP
00048   * @{
00049   */
00050 
00051 /** @addtogroup Components
00052   * @{
00053   */
00054     
00055 /** @addtogroup ACCELERO
00056   * @{
00057   */
00058 
00059 /** @defgroup ACCELERO_Exported_Types
00060   * @{
00061   */ 
00062 
00063 /** @defgroup ACCELERO_Driver_structure  Accelerometer Driver structure
00064   * @{
00065   */
00066 typedef struct
00067 {  
00068   void      (*Init)(uint16_t);
00069   void      (*DeInit)(void); 
00070   uint8_t   (*ReadID)(void);
00071   void      (*Reset)(void);
00072   void      (*LowPower)(uint16_t);
00073   void      (*ConfigIT)(void);
00074   void      (*EnableIT)(uint8_t);
00075   void      (*DisableIT)(uint8_t);
00076   uint8_t   (*ITStatus)(uint16_t);
00077   void      (*ClearIT)(void);
00078   void      (*FilterConfig)(uint8_t);
00079   void      (*FilterCmd)(uint8_t);
00080   void      (*GetXYZ)(int16_t *);
00081 }ACCELERO_DrvTypeDef;
00082 /**
00083   * @}
00084   */
00085 
00086 /** @defgroup ACCELERO_Configuration_structure  Accelerometer Configuration structure
00087   * @{
00088   */
00089 
00090 /* ACCELERO struct */
00091 typedef struct
00092 {
00093   uint8_t Power_Mode;                         /* Power-down/Normal Mode */
00094   uint8_t AccOutput_DataRate;                 /* OUT data rate */
00095   uint8_t Axes_Enable;                        /* Axes enable */
00096   uint8_t High_Resolution;                    /* High Resolution enabling/disabling */
00097   uint8_t BlockData_Update;                   /* Block Data Update */
00098   uint8_t Endianness;                         /* Endian Data selection */
00099   uint8_t AccFull_Scale;                      /* Full Scale selection */
00100   uint8_t Communication_Mode;
00101 }ACCELERO_InitTypeDef;
00102 
00103 /* ACCELERO High Pass Filter struct */
00104 typedef struct
00105 {
00106   uint8_t HighPassFilter_Mode_Selection;      /* Internal filter mode */
00107   uint8_t HighPassFilter_CutOff_Frequency;    /* High pass filter cut-off frequency */
00108   uint8_t HighPassFilter_AOI1;                /* HPF_enabling/disabling for AOI function on interrupt 1 */
00109   uint8_t HighPassFilter_AOI2;                /* HPF_enabling/disabling for AOI function on interrupt 2 */
00110   uint8_t HighPassFilter_Data_Sel;
00111   uint8_t HighPassFilter_Stat;
00112 }ACCELERO_FilterConfigTypeDef;
00113 
00114 /**
00115   * @}
00116   */
00117 
00118 
00119 /**
00120   * @}
00121   */
00122 
00123 /**
00124   * @}
00125   */
00126 
00127 /**
00128   * @}
00129   */
00130 
00131 /**
00132   * @}
00133   */
00134 
00135 #ifdef __cplusplus
00136 }
00137 #endif
00138 
00139 #endif /* __ACCELERO_H */
00140 
00141 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/