pressure.h

00001 /**
00002  ******************************************************************************
00003  * @file    pressure.h
00004  * @author  MEMS Application Team
00005  * @version V1.2.0
00006  * @date    28-January-2015
00007  * @brief   This header file contains the functions prototypes for the
00008  *          pressure 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 
00040 /* Define to prevent recursive inclusion -------------------------------------*/
00041 #ifndef __PRESSURE_H
00042 #define __PRESSURE_H
00043 
00044 #ifdef __cplusplus
00045 extern "C" {
00046 #endif
00047 
00048 /* Includes ------------------------------------------------------------------*/
00049 #include <stdint.h>
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054 
00055 /** @addtogroup Components
00056   * @{
00057   */
00058 
00059 /** @addtogroup PRESSURE
00060   * @{
00061   */
00062 
00063 /** @defgroup PRESSURE_Exported_Types
00064   * @{
00065   */
00066 
00067 /**
00068  * @brief  PRESSURE init structure definition
00069  */
00070 typedef struct
00071 {
00072   uint8_t OutputDataRate;
00073   uint8_t PressureResolution;
00074   uint8_t TemperatureResolution;
00075   uint8_t DiffEnable;
00076   uint8_t BlockDataUpdate;
00077   uint8_t SPIMode;
00078 } PRESSURE_InitTypeDef;
00079 
00080 /**
00081  * @brief  PRESSURE status enumerator definition
00082  */
00083 typedef enum
00084 {
00085   PRESSURE_OK = 0,
00086   PRESSURE_ERROR = 1,
00087   PRESSURE_TIMEOUT = 2,
00088   PRESSURE_NOT_IMPLEMENTED = 3
00089 } PRESSURE_StatusTypeDef;
00090 
00091 /**
00092  * @brief  PRESSURE component id enumerator definition
00093  */
00094 typedef enum
00095 {
00096   PRESSURE_NONE_COMPONENT = 0,
00097   PRESSURE_LPS25H_COMPONENT = 1,
00098   PRESSURE_LPS25HB_DIL24_COMPONENT = 2
00099 } PRESSURE_ComponentTypeDef;
00100 
00101 /**
00102  * @brief  PRESSURE driver extended structure definition
00103  */
00104 typedef struct
00105 {
00106   PRESSURE_ComponentTypeDef
00107   id; /* This id must be unique for each component belonging to this class that wants to extend common class */
00108   void *pData; /* This pointer is specific for each component */
00109 } PRESSURE_DrvExtTypeDef;
00110 
00111 /**
00112  * @brief  PRESSURE driver structure definition
00113  */
00114 typedef struct
00115 {
00116   PRESSURE_StatusTypeDef       (*Init)(PRESSURE_InitTypeDef *);
00117   PRESSURE_StatusTypeDef       (*PowerOff)(void);
00118   PRESSURE_StatusTypeDef       (*ReadID)(uint8_t *);
00119   PRESSURE_StatusTypeDef       (*Reset)(void);
00120   void                         (*ConfigIT)(uint16_t);
00121   void                         (*EnableIT)(uint8_t);
00122   void                         (*DisableIT)(uint8_t);
00123   uint8_t                      (*ITStatus)(uint16_t, uint16_t);
00124   void                         (*ClearIT)(uint16_t, uint16_t);
00125   PRESSURE_StatusTypeDef       (*GetPressure)(float *);
00126   PRESSURE_StatusTypeDef       (*GetTemperature)(float *);
00127   void                         (*SlaveAddrRemap)(uint8_t);
00128   PRESSURE_DrvExtTypeDef       *extData;
00129 } PRESSURE_DrvTypeDef;
00130 
00131 /**
00132  * @}
00133  */
00134 
00135 /**
00136  * @}
00137  */
00138 
00139 /**
00140  * @}
00141  */
00142 
00143 /**
00144  * @}
00145  */
00146 
00147 #ifdef __cplusplus
00148 }
00149 #endif
00150 
00151 #endif /* __PRESSURE_H */
00152 
00153 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/