magneto.h

00001 /**
00002  ******************************************************************************
00003  * @file    magneto.h
00004  * @author  MEMS Application Team
00005  * @version V1.0.0
00006  * @date    30-July-2014
00007  * @brief   This header file contains the functions prototypes for the 
00008  *          magneto driver.
00009  ******************************************************************************
00010  * @attention
00011  *
00012  * <h2><center>&copy; COPYRIGHT(c) 2014 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 
00052 /**
00053 * @brief  MAGNETO init structure definition
00054 */
00055 typedef struct
00056 {
00057     uint8_t M_OutputDataRate;
00058     uint8_t M_OperatingMode;
00059     uint8_t M_FullScale;
00060     uint8_t M_XYOperativeMode;
00061 }MAGNETO_InitTypeDef;
00062 
00063 /**
00064 * @brief  MAGNETO status enumerator definition
00065 */
00066 typedef enum {
00067     MAGNETO_OK = 0,
00068     MAGNETO_ERROR = 1,
00069     MAGNETO_TIMEOUT = 2
00070 } MAGNETO_StatusTypeDef;
00071 
00072 /**
00073 * @brief  MAGNETO driver structure definition
00074 */
00075 typedef struct
00076 {
00077     void                   (*Init)(MAGNETO_InitTypeDef *);
00078     uint8_t                (*Read_M_ID)(void);
00079     void                   (*Get_M_Axes)(int32_t *);
00080 }MAGNETO_DrvTypeDef;
00081 
00082 
00083 #ifdef __cplusplus
00084 }
00085 #endif
00086 
00087 #endif /* __MAGNETO_H */
00088 
00089 /**
00090  * @}
00091  */
00092 
00093 /**
00094  * @}
00095  */
00096 
00097 /**
00098  * @}
00099  */
00100 
00101 
00102 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 
00103