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</center></h2>
00010   *
00011   * Redistribution and use in source and binary forms, with or without modification,
00012   * are permitted provided that the following conditions are met:
00013   *   1. Redistributions of source code must retain the above copyright notice,
00014   *      this list of conditions and the following disclaimer.
00015   *   2. Redistributions in binary form must reproduce the above copyright notice,
00016   *      this list of conditions and the following disclaimer in the documentation
00017   *      and/or other materials provided with the distribution.
00018   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00019   *      may be used to endorse or promote products derived from this software
00020   *      without specific prior written permission.
00021   *
00022   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00023   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00024   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00025   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00026   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00027   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00028   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00029   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00030   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00031   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00032   *
00033   ******************************************************************************
00034   */
00035 
00036 /* Define to prevent recursive inclusion -------------------------------------*/
00037 #ifndef __MAGNETO_H
00038 #define __MAGNETO_H
00039 
00040 #ifdef __cplusplus
00041  extern "C" {
00042 #endif
00043 
00044 /* Includes ------------------------------------------------------------------*/
00045 #include <stdint.h>
00046 
00047 /** @addtogroup BSP
00048   * @{
00049   */
00050 
00051 /** @addtogroup Components
00052   * @{
00053   */
00054     
00055 /** @addtogroup MAGNETO
00056   * @{
00057   */
00058 
00059 /** @defgroup MAGNETO_Exported_Types
00060   * @{
00061   */ 
00062 
00063 /** @defgroup MAGNETO_Config_structure  Magnetometer Configuration structure
00064   * @{
00065   */
00066 typedef struct
00067 {
00068   uint8_t Register1;
00069   uint8_t Register2;
00070   uint8_t Register3;
00071   uint8_t Register4;
00072   uint8_t Register5;
00073 }MAGNETO_InitTypeDef;
00074 /**
00075   * @}
00076   */
00077 
00078 /** @defgroup MAGNETO_Driver_structure  Magnetometer Driver structure
00079   * @{
00080   */
00081 typedef struct
00082 {  
00083   void      (*Init)(MAGNETO_InitTypeDef);
00084   void      (*DeInit)(void); 
00085   uint8_t   (*ReadID)(void);
00086   void      (*Reset)(void);
00087   void      (*LowPower)(uint16_t);
00088   void      (*ConfigIT)(void);
00089   void      (*EnableIT)(uint8_t);
00090   void      (*DisableIT)(uint8_t);
00091   uint8_t   (*ITStatus)(uint16_t);
00092   void      (*ClearIT)(void);
00093   void      (*FilterConfig)(uint8_t);
00094   void      (*FilterCmd)(uint8_t);
00095   void      (*GetXYZ)(int16_t *);
00096 }MAGNETO_DrvTypeDef;
00097 /**
00098   * @}
00099   */
00100 
00101 /**
00102   * @}
00103   */
00104 
00105 /**
00106   * @}
00107   */
00108 
00109 /**
00110   * @}
00111   */
00112 
00113 /**
00114   * @}
00115   */
00116 
00117 #ifdef __cplusplus
00118 }
00119 #endif
00120 
00121 #endif /* __MAGNETO_H */
00122 
00123 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/