x_nucleo_iks01a1_magneto.c

00001 /**
00002  ******************************************************************************
00003  * @file    x_nucleo_iks01a1_magneto.c
00004  * @author  MEMS Application Team
00005  * @version V1.0.0
00006  * @date    30-July-2014
00007  * @brief   This file provides a set of functions needed to manage the lis3mdl sensor.
00008  ******************************************************************************
00009  * @attention
00010  *
00011  * <h2><center>&copy; COPYRIGHT(c) 2014 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 /* Includes ------------------------------------------------------------------*/
00038 #include "x_nucleo_iks01a1_magneto.h"
00039 
00040 /** @addtogroup BSP
00041  * @{
00042  */
00043 
00044 /** @addtogroup X_NUCLEO_IKS01A1
00045  * @{
00046  */
00047 
00048 /** @addtogroup X_NUCLEO_IKS01A1_MAGNETO
00049  * @{
00050  */
00051 
00052 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Private_TypesDefinitions
00053  * @{
00054  */
00055 
00056 /**
00057  * @}
00058  */
00059 
00060 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Private_Defines
00061  * @{
00062  */
00063 
00064 /**
00065  * @}
00066  */
00067 
00068 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Private_Macros
00069  * @{
00070  */
00071 
00072 /**
00073  * @}
00074  */
00075 
00076 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Private_Variables
00077  * @{
00078  */
00079 static MAGNETO_DrvTypeDef *MagnetoDrv;
00080 static uint8_t MagnetoInitialized = 0;
00081 
00082 /**
00083  * @}
00084  */
00085 
00086 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Private_FunctionPrototypes
00087  * @{
00088  */
00089 
00090 /**
00091  * @}
00092  */
00093 
00094 /** @defgroup X_NUCLEO_IKS01A1_MAGNETO_Private_Functions
00095  * @{
00096  */
00097 
00098 /**
00099  * @brief  Initialization magneto sensor.
00100  * @param  None
00101  * @retval MAGNETO_OK if no problem during initialization
00102  */
00103 MAGNETO_StatusTypeDef BSP_MAGNETO_Init(void)
00104 {
00105     MAGNETO_StatusTypeDef ret = MAGNETO_ERROR;
00106     MAGNETO_InitTypeDef LIS3MDL_InitStructure;
00107 
00108     /* Initialize the magneto driver structure */
00109     MagnetoDrv = &LIS3MDLDrv;
00110 
00111     /* Configure sensor */
00112     LIS3MDL_InitStructure.M_FullScale = LIS3MDL_M_FS_4;
00113     LIS3MDL_InitStructure.M_OperatingMode = LIS3MDL_M_MD_CONTINUOUS;
00114     LIS3MDL_InitStructure.M_XYOperativeMode = LIS3MDL_M_OM_HP;
00115     LIS3MDL_InitStructure.M_OutputDataRate = LIS3MDL_M_DO_80;
00116 
00117     /* magneto sensor init */
00118     MagnetoDrv->Init(&LIS3MDL_InitStructure);
00119 
00120     if(MagnetoDrv->Read_M_ID() == I_AM_LIS3MDL_M)
00121     {
00122         MagnetoInitialized = 1;
00123         ret = MAGNETO_OK;
00124     }
00125 
00126     return ret;
00127 }
00128 
00129 
00130 uint8_t BSP_MAGNETO_isInitialized(void)
00131 {
00132     return MagnetoInitialized;
00133 }
00134 
00135 
00136 /**
00137  * @brief  Read ID of LIS3MDL Magnetic sensor
00138  * @param  None
00139  * @retval ID
00140  */
00141 uint8_t BSP_MAGNETO_Read_M_ID(void)
00142 {
00143     uint8_t id = 0x00;
00144 
00145     if(MagnetoDrv->Read_M_ID != NULL)
00146     {
00147         id = MagnetoDrv->Read_M_ID();
00148     }
00149     return id;
00150 }
00151 
00152 
00153 /**
00154  * @brief  Check ID of LIS3MDL Magnetic sensor
00155  * @param  None
00156  * @retval Test status
00157  */
00158 MAGNETO_StatusTypeDef BSP_MAGNETO_Check_M_ID(void) {
00159     if (BSP_MAGNETO_Read_M_ID() == I_AM_LIS3MDL_M) {
00160         return MAGNETO_OK;
00161     } else {
00162         return MAGNETO_ERROR;
00163     }
00164 }
00165 
00166 
00167 /**
00168  * @brief  Get Magnetic sensor raw axes
00169  * @param pData: pointer on AxesRaw_TypeDef data
00170  * @retval None
00171  */
00172 void BSP_MAGNETO_M_GetAxesRaw(AxesRaw_TypeDef *pData)
00173 {
00174     if(MagnetoDrv->Get_M_Axes!= NULL)
00175     {
00176       MagnetoDrv->Get_M_Axes((int32_t *)pData);
00177     }
00178 }
00179 
00180 /**
00181  * @}
00182  */
00183 
00184 /**
00185  * @}
00186  */
00187 
00188 /**
00189  * @}
00190  */
00191 
00192 /**
00193  * @}
00194  */
00195 
00196 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
00197