magneto.h

00001 /**
00002   ******************************************************************************
00003   * @file    magneto.h
00004   * @author  MCD Application Team
00005   * @version V4.0.0
00006   * @date    22-June-2015
00007   * @brief   This header file contains the functions prototypes for the MAGNETO 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 __MAGNETO_H
00040 #define __MAGNETO_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 MAGNETO
00058   * @{
00059   */
00060 
00061 /** @defgroup MAGNETO_Exported_Types
00062   * @{
00063   */ 
00064 
00065 /** @defgroup MAGNETO_Config_structure  Magnetometer Configuration structure
00066   * @{
00067   */
00068 typedef struct
00069 {
00070   uint8_t Register1;
00071   uint8_t Register2;
00072   uint8_t Register3;
00073   uint8_t Register4;
00074   uint8_t Register5;
00075 }MAGNETO_InitTypeDef;
00076 /**
00077   * @}
00078   */
00079 
00080 /** @defgroup MAGNETO_Driver_structure  Magnetometer Driver structure
00081   * @{
00082   */
00083 typedef struct
00084 {  
00085   void      (*Init)(MAGNETO_InitTypeDef);
00086   void      (*DeInit)(void); 
00087   uint8_t   (*ReadID)(void);
00088   void      (*Reset)(void);
00089   void      (*LowPower)(void);
00090   void      (*ConfigIT)(void);
00091   void      (*EnableIT)(uint8_t);
00092   void      (*DisableIT)(uint8_t);
00093   uint8_t   (*ITStatus)(uint16_t);
00094   void      (*ClearIT)(void);
00095   void      (*FilterConfig)(uint8_t);
00096   void      (*FilterCmd)(uint8_t);
00097   void      (*GetXYZ)(int16_t *);
00098 }MAGNETO_DrvTypeDef;
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 /* __MAGNETO_H */
00124 
00125 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/