magneto.h

00001 /**
00002  ******************************************************************************
00003  * @file    magneto.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  *          magneto 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 __MAGNETO_H
00042 #define __MAGNETO_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 MAGNETO
00060   * @{
00061   */
00062 
00063 /** @defgroup MAGNETO_Exported_Types
00064   * @{
00065   */
00066 
00067 /**
00068 * @brief  MAGNETO init structure definition
00069 */
00070 typedef struct
00071 {
00072   uint8_t M_OutputDataRate;
00073   uint8_t M_OperatingMode;
00074   uint8_t M_FullScale;
00075   uint8_t M_XYOperativeMode;
00076 } MAGNETO_InitTypeDef;
00077 
00078 /**
00079 * @brief  MAGNETO status enumerator definition
00080 */
00081 typedef enum
00082 {
00083   MAGNETO_OK = 0,
00084   MAGNETO_ERROR = 1,
00085   MAGNETO_TIMEOUT = 2,
00086   MAGNETO_NOT_IMPLEMENTED = 3
00087 } MAGNETO_StatusTypeDef;
00088 
00089 /**
00090  * @brief  MAGNETO component id enumerator definition
00091  */
00092 typedef enum
00093 {
00094   MAGNETO_NONE_COMPONENT = 0,
00095   MAGNETO_LIS3MDL_COMPONENT = 1
00096 } MAGNETO_ComponentTypeDef;
00097 
00098 /**
00099  * @brief  MAGNETO driver extended structure definition
00100  */
00101 typedef struct
00102 {
00103   MAGNETO_ComponentTypeDef
00104   id; /* This id must be unique for each component belonging to this class that wants to extend common class */
00105   void *pData; /* This pointer is specific for each component */
00106 } MAGNETO_DrvExtTypeDef;
00107 
00108 /**
00109 * @brief  MAGNETO driver structure definition
00110 */
00111 typedef struct
00112 {
00113   MAGNETO_StatusTypeDef       (*Init)(MAGNETO_InitTypeDef *);
00114   MAGNETO_StatusTypeDef       (*Read_M_ID)(uint8_t *);
00115   MAGNETO_StatusTypeDef       (*Get_M_Axes)(int32_t *);
00116   MAGNETO_StatusTypeDef       (*Get_M_AxesRaw)(int16_t *);
00117   MAGNETO_DrvExtTypeDef       *extData;
00118 } MAGNETO_DrvTypeDef;
00119 
00120 /**
00121  * @}
00122  */
00123 
00124 /**
00125  * @}
00126  */
00127 
00128 /**
00129  * @}
00130  */
00131 
00132 /**
00133  * @}
00134  */
00135 
00136 #ifdef __cplusplus
00137 }
00138 #endif
00139 
00140 #endif /* __MAGNETO_H */
00141 
00142 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/