diff options
| author | Yuval Adam <yuval@y3xz.com> | 2015-03-13 12:24:52 +0200 |
|---|---|---|
| committer | Yuval Adam <yuval@y3xz.com> | 2015-03-13 12:24:52 +0200 |
| commit | 4085ae3ddfbbf10c8ccbd3dccd43452c40a1fe40 (patch) | |
| tree | ac63581949a49511136e7e9e47d265bfb4119b26 /sensorlib/ak8963.h | |
| parent | 788db64b8642bf31de6930d18a62177c64163ee0 (diff) | |
Add bootloader, nfclib and sensorlib
Diffstat (limited to 'sensorlib/ak8963.h')
| -rw-r--r-- | sensorlib/ak8963.h | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/sensorlib/ak8963.h b/sensorlib/ak8963.h new file mode 100644 index 0000000..4be56dd --- /dev/null +++ b/sensorlib/ak8963.h @@ -0,0 +1,160 @@ +//*****************************************************************************
+//
+// ak8963.h - Prototypes for the AK8963 magnetometer driver.
+//
+// Copyright (c) 2013-2014 Texas Instruments Incorporated. All rights reserved.
+// Software License Agreement
+//
+// Texas Instruments (TI) is supplying this software for use solely and
+// exclusively on TI's microcontroller products. The software is owned by
+// TI and/or its suppliers, and is protected under applicable copyright
+// laws. You may not combine this software with "viral" open-source
+// software in order to form a larger program.
+//
+// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
+// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
+// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
+// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
+// DAMAGES, FOR ANY REASON WHATSOEVER.
+//
+// This is part of revision 2.1.0.12573 of the Tiva Firmware Development Package.
+//
+//*****************************************************************************
+
+#ifndef __SENSORLIB_AK8963_H__
+#define __SENSORLIB_AK8963_H__
+
+//*****************************************************************************
+//
+// If building with a C++ compiler, make all of the definitions in this header
+// have a C binding.
+//
+//*****************************************************************************
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+//*****************************************************************************
+//
+// The structure that defines the internal state of the AK8963 driver.
+//
+//*****************************************************************************
+typedef struct
+{
+ //
+ // The pointer to the I2C master interface instance used to communicate
+ // with the AK8963.
+ //
+ tI2CMInstance *psI2CInst;
+
+ //
+ // The I2C address of the AK8963.
+ //
+ uint8_t ui8Addr;
+
+ //
+ // The state of the state machine used while accessing the AK8963.
+ //
+ uint8_t ui8State;
+
+ //
+ // The data output bit width.
+ //
+ uint8_t ui8BitOutput;
+
+ //
+ // The new data output bit width, which is used when a register write
+ // succeeds.
+ //
+ uint8_t ui8NewBitOutput;
+
+ //
+ // The data buffer used for sending/receiving data to/from the AK8963.
+ //
+ uint8_t pui8Data[8];
+
+ //
+ // The function that is called when the current request has completed
+ // processing.
+ //
+ tSensorCallback *pfnCallback;
+
+ //
+ // The callback data provided to the callback function.
+ //
+ void *pvCallbackData;
+
+ //
+ // A union of structures that are used for read, write and
+ // read-modify-write operations. Since only one operation can be active at
+ // a time, it is safe to re-use the memory in this manner.
+ //
+ union
+ {
+ //
+ // A buffer used to store the write portion of a register read.
+ //
+ uint8_t pui8Buffer[2];
+
+ //
+ // The write state used to write register values.
+ //
+ tI2CMWrite8 sWriteState;
+
+ //
+ // The read-modify-write state used to modify register values.
+ //
+ tI2CMReadModifyWrite8 sReadModifyWriteState;
+ }
+ uCommand;
+}
+tAK8963;
+
+//*****************************************************************************
+//
+// Function prototypes.
+//
+//*****************************************************************************
+extern uint_fast8_t AK8963Init(tAK8963 *psInst, tI2CMInstance *psI2CInst,
+ uint_fast8_t ui8I2CAddr,
+ tSensorCallback *pfnCallback,
+ void *pvCallbackData);
+extern uint_fast8_t AK8963Read(tAK8963 *psInst, uint_fast8_t ui8Reg,
+ uint8_t *pui8Data, uint_fast16_t ui16Count,
+ tSensorCallback *pfnCallback,
+ void *pvCallbackData);
+extern uint_fast8_t AK8963Write(tAK8963 *psInst, uint_fast8_t ui8Reg,
+ const uint8_t *pui8Data,
+ uint_fast16_t ui16Count,
+ tSensorCallback *pfnCallback,
+ void *pvCallbackData);
+extern uint_fast8_t AK8963ReadModifyWrite(tAK8963 *psInst,
+ uint_fast8_t ui8Reg,
+ uint_fast8_t ui8Mask,
+ uint_fast8_t ui8Value,
+ tSensorCallback *pfnCallback,
+ void *pvCallbackData);
+extern uint_fast8_t AK8963DataRead(tAK8963 *psInst,
+ tSensorCallback *pfnCallback,
+ void *pvCallbackData);
+extern void AK8963DataMagnetoGetRaw(tAK8963 *psInst,
+ uint_fast16_t *pui16MagnetoX,
+ uint_fast16_t *pui16MagnetoY,
+ uint_fast16_t *pui16MagnetoZ);
+extern void AK8963DataMagnetoGetFloat(tAK8963 *psInst, float *pfMagnetoX,
+ float *pfMagnetoY, float *pfMagnetoZ);
+extern void AK8963DataGetStatus(tAK8963 *psInst, uint_fast8_t *pui8Status1,
+ uint_fast8_t *pui8Status2);
+
+//*****************************************************************************
+//
+// Mark the end of the C bindings section for C++ compilers.
+//
+//*****************************************************************************
+#ifdef __cplusplus
+}
+#endif
+
+#endif // __SENSORLIB_AK8963_H__
|