magneto.h

00001 /**
00002   ******************************************************************************
00003   * @file    magneto.h
00004   * @author  MCD Application Team
00005   * @brief   This header file contains the functions prototypes for the MAGNETO driver.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
00010   * All rights reserved.</center></h2>
00011   *
00012   * This software component is licensed by ST under BSD 3-Clause license,
00013   * the "License"; You may not use this file except in compliance with the
00014   * License. You may obtain a copy of the License at:
00015   *                        opensource.org/licenses/BSD-3-Clause
00016   *
00017   ******************************************************************************
00018   */
00019 
00020 /* Define to prevent recursive inclusion -------------------------------------*/
00021 #ifndef __MAGNETO_H
00022 #define __MAGNETO_H
00023 
00024 #ifdef __cplusplus
00025  extern "C" {
00026 #endif
00027 
00028 /* Includes ------------------------------------------------------------------*/
00029 #include <stdint.h>
00030 
00031 /** @addtogroup BSP
00032   * @{
00033   */
00034 
00035 /** @addtogroup Components
00036   * @{
00037   */
00038     
00039 /** @addtogroup MAGNETO
00040   * @{
00041   */
00042 
00043 /** @defgroup MAGNETO_Exported_Types
00044   * @{
00045   */ 
00046 
00047 /** @defgroup MAGNETO_Config_structure  Magnetometer Configuration structure
00048   * @{
00049   */
00050 typedef struct
00051 {
00052   uint8_t Register1;
00053   uint8_t Register2;
00054   uint8_t Register3;
00055   uint8_t Register4;
00056   uint8_t Register5;
00057 }MAGNETO_InitTypeDef;
00058 /**
00059   * @}
00060   */
00061 
00062 /** @defgroup MAGNETO_Driver_structure  Magnetometer Driver structure
00063   * @{
00064   */
00065 typedef struct
00066 {  
00067   void      (*Init)(MAGNETO_InitTypeDef);
00068   void      (*DeInit)(void); 
00069   uint8_t   (*ReadID)(void);
00070   void      (*Reset)(void);
00071   void      (*LowPower)(uint16_t);
00072   void      (*ConfigIT)(void);
00073   void      (*EnableIT)(uint8_t);
00074   void      (*DisableIT)(uint8_t);
00075   uint8_t   (*ITStatus)(uint16_t);
00076   void      (*ClearIT)(void);
00077   void      (*FilterConfig)(uint8_t);
00078   void      (*FilterCmd)(uint8_t);
00079   void      (*GetXYZ)(int16_t *);
00080 }MAGNETO_DrvTypeDef;
00081 /**
00082   * @}
00083   */
00084 
00085 /**
00086   * @}
00087   */
00088 
00089 /**
00090   * @}
00091   */
00092 
00093 /**
00094   * @}
00095   */
00096 
00097 /**
00098   * @}
00099   */
00100 
00101 #ifdef __cplusplus
00102 }
00103 #endif
00104 
00105 #endif /* __MAGNETO_H */
00106 
00107 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/