92 lines
4.1 KiB
C
92 lines
4.1 KiB
C
|
/**************************************************************************************************
|
|||
|
|
Filename: hal_mag.h
|
|||
|
|
Revised: $Date: 2012-08-15 16:58:46 -0700 (Wed, 15 Aug 2012) $
|
|||
|
|
Revision: $Revision: 31257 $
|
|||
|
|
|
|||
|
|
Description: Interface to the magnometer driver
|
|||
|
|
|
|||
|
|
Copyright 2012 Texas Instruments Incorporated. All rights reserved.
|
|||
|
|
|
|||
|
|
IMPORTANT: Your use of this Software is limited to those specific rights
|
|||
|
|
granted under the terms of a software license agreement between the user
|
|||
|
|
who downloaded the software, his/her employer (which must be your employer)
|
|||
|
|
and Texas Instruments Incorporated (the "License"). You may not use this
|
|||
|
|
Software unless you agree to abide by the terms of the License. The License
|
|||
|
|
limits your use, and you acknowledge, that the Software may not be modified,
|
|||
|
|
copied or distributed unless embedded on a Texas Instruments microcontroller
|
|||
|
|
or used solely and exclusively in conjunction with a Texas Instruments radio
|
|||
|
|
frequency transceiver, which is integrated into your product. Other than for
|
|||
|
|
the foregoing purpose, you may not use, reproduce, copy, prepare derivative
|
|||
|
|
works of, modify, distribute, perform, display or sell this Software and/or
|
|||
|
|
its documentation for any purpose.
|
|||
|
|
|
|||
|
|
YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
|
|||
|
|
PROVIDED <EFBFBD>AS IS<EFBFBD> WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
|||
|
|
INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
|
|||
|
|
NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
|
|||
|
|
TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
|
|||
|
|
NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
|
|||
|
|
LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
|
|||
|
|
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
|
|||
|
|
OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
|
|||
|
|
OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
|
|||
|
|
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
|
|||
|
|
|
|||
|
|
Should you have any questions regarding your right to use this Software,
|
|||
|
|
contact Texas Instruments Incorporated at www.TI.com.
|
|||
|
|
**************************************************************************************************/
|
|||
|
|
#ifndef HAL_MAG_H
|
|||
|
|
#define HAL_MAG_H
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
extern "C" {
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Includes
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
#include "comdef.h"
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Constants
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
#define HAL_MAG3110_I2C_ADDRESS 0x0E
|
|||
|
|
#define HAL_MAG3110_PERIOD_MASK 0x10
|
|||
|
|
#define HAL_MAG3110_ENABLE_MASK 0x01
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Typedefs
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
typedef enum
|
|||
|
|
{
|
|||
|
|
MAG3110_OFF, // Magnetometer Sleeping
|
|||
|
|
MAG3110_IDLE, // Magnetometer On and Configured
|
|||
|
|
MAG3110_DATA_READY, // Magnetometer On, Configured and Data is Ready
|
|||
|
|
} Magnetometer_States_t;
|
|||
|
|
|
|||
|
|
/* ------------------------------------------------------------------------------------------------
|
|||
|
|
* Functions
|
|||
|
|
* ------------------------------------------------------------------------------------------------
|
|||
|
|
*/
|
|||
|
|
void HalMagInit(void);
|
|||
|
|
void HalMagTurnOn(void);
|
|||
|
|
void HalMagTurnOff(void);
|
|||
|
|
bool HalMagRead(uint8 *pBuf);
|
|||
|
|
bool HalMagTest(void);
|
|||
|
|
Magnetometer_States_t HalMagStatus( void );
|
|||
|
|
|
|||
|
|
/**************************************************************************************************
|
|||
|
|
*/
|
|||
|
|
|
|||
|
|
#ifdef __cplusplus
|
|||
|
|
};
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
#endif
|
|||
|
|
|
|||
|
|
/**************************************************************************************************
|
|||
|
|
*/
|