pressure.h

00001 /**
00002  ******************************************************************************
00003  * @file    pressure.h
00004  * @author  MEMS Application Team
00005  * @brief   This header file contains the functions prototypes for the
00006  *          pressure driver
00007  ******************************************************************************
00008  * @attention
00009  *
00010  * <h2><center>&copy; COPYRIGHT(c) 2018 STMicroelectronics</center></h2>
00011  *
00012  * Redistribution and use in source and binary forms, with or without modification,
00013  * are permitted provided that the following conditions are met:
00014  *   1. Redistributions of source code must retain the above copyright notice,
00015  *      this list of conditions and the following disclaimer.
00016  *   2. Redistributions in binary form must reproduce the above copyright notice,
00017  *      this list of conditions and the following disclaimer in the documentation
00018  *      and/or other materials provided with the distribution.
00019  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020  *      may be used to endorse or promote products derived from this software
00021  *      without specific prior written permission.
00022  *
00023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033  *
00034  ******************************************************************************
00035  */
00036 
00037 /* Define to prevent recursive inclusion -------------------------------------*/
00038 #ifndef __PRESSURE_H
00039 #define __PRESSURE_H
00040 
00041 #ifdef __cplusplus
00042 extern "C" {
00043 #endif
00044 
00045 
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "sensor.h"
00049 
00050 /** @addtogroup BSP BSP
00051  * @{
00052  */
00053 
00054 /** @addtogroup COMPONENTS COMPONENTS
00055  * @{
00056  */
00057 
00058 /** @addtogroup COMMON COMMON
00059  * @{
00060  */
00061 
00062 /** @addtogroup PRESSURE PRESSURE
00063  * @{
00064  */
00065 
00066 /** @addtogroup PRESSURE_Public_Types PRESSURE Public types
00067  * @{
00068  */
00069 
00070 /**
00071  * @brief  PRESSURE driver structure definition
00072  */
00073 typedef struct
00074 {
00075   DrvStatusTypeDef(*Init)(DrvContextTypeDef *);
00076   DrvStatusTypeDef(*DeInit)(DrvContextTypeDef *);
00077   DrvStatusTypeDef(*Sensor_Enable)(DrvContextTypeDef *);
00078   DrvStatusTypeDef(*Sensor_Disable)(DrvContextTypeDef *);
00079   DrvStatusTypeDef(*Get_WhoAmI)(DrvContextTypeDef *, uint8_t *);
00080   DrvStatusTypeDef(*Check_WhoAmI)(DrvContextTypeDef *);
00081   DrvStatusTypeDef(*Get_Press)(DrvContextTypeDef *, float *);
00082   DrvStatusTypeDef(*Get_ODR)(DrvContextTypeDef *, float *);
00083   DrvStatusTypeDef(*Set_ODR)(DrvContextTypeDef *, SensorOdr_t);
00084   DrvStatusTypeDef(*Set_ODR_Value)(DrvContextTypeDef *, float);
00085   DrvStatusTypeDef(*Read_Reg)(DrvContextTypeDef *, uint8_t, uint8_t *);
00086   DrvStatusTypeDef(*Write_Reg)(DrvContextTypeDef *, uint8_t, uint8_t);
00087   DrvStatusTypeDef(*Get_DRDY_Status)(DrvContextTypeDef *, uint8_t *);
00088 } PRESSURE_Drv_t;
00089 
00090 /**
00091  * @brief  PRESSURE data structure definition
00092  */
00093 typedef struct
00094 {
00095   void *pComponentData; /* Component specific data. */
00096   void *pExtData;       /* Other data. */
00097 } PRESSURE_Data_t;
00098 
00099 /**
00100  * @}
00101  */
00102 
00103 /**
00104  * @}
00105  */
00106 
00107 /**
00108  * @}
00109  */
00110 
00111 /**
00112  * @}
00113  */
00114 
00115 /**
00116  * @}
00117  */
00118 
00119 #ifdef __cplusplus
00120 }
00121 #endif
00122 
00123 #endif /* __PRESSURE_H */
00124 
00125 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/