1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
//*****************************************************************************
//
// ak8975.h - Prototypes for the AK8975 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_AK8975_H__
#define __SENSORLIB_AK8975_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 AK8975 driver.
//
//*****************************************************************************
typedef struct
{
//
// The pointer to the I2C master interface instance used to communicate
// with the AK8975.
//
tI2CMInstance *psI2CInst;
//
// The I2C address of the AK8975.
//
uint8_t ui8Addr;
//
// The state of the state machine used while accessing the AK8975.
//
uint8_t ui8State;
//
// The data buffer used for sending/receiving data to/from the AK8975.
//
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;
}
tAK8975;
//*****************************************************************************
//
// Function prototypes.
//
//*****************************************************************************
extern uint_fast8_t AK8975Init(tAK8975 *psInst, tI2CMInstance *psI2CInst,
uint_fast8_t ui8I2CAddr,
tSensorCallback *pfnCallback,
void *pvCallbackData);
extern uint_fast8_t AK8975Read(tAK8975 *psInst, uint_fast8_t ui8Reg,
uint8_t *pui8Data, uint_fast16_t ui16Count,
tSensorCallback *pfnCallback,
void *pvCallbackData);
extern uint_fast8_t AK8975Write(tAK8975 *psInst, uint_fast8_t ui8Reg,
uint8_t *pui8Data, uint_fast16_t ui16Count,
tSensorCallback *pfnCallback,
void *pvCallbackData);
extern uint_fast8_t AK8975ReadModifyWrite(tAK8975 *psInst,
uint_fast8_t ui8Reg,
uint_fast8_t ui8Mask,
uint_fast8_t ui8Value,
tSensorCallback *pfnCallback,
void *pvCallbackData);
extern uint_fast8_t AK8975DataRead(tAK8975 *psInst,
tSensorCallback *pfnCallback,
void *pvCallbackData);
extern void AK8975DataMagnetoGetRaw(tAK8975 *psInst,
uint_fast16_t *pui16MagnetoX,
uint_fast16_t *pui16MagnetoY,
uint_fast16_t *pui16MagnetoZ);
extern void AK8975DataMagnetoGetFloat(tAK8975 *psInst, float *pfMagnetoX,
float *pfMagnetoY, float *pfMagnetoZ);
extern void AK8975DataGetStatus(tAK8975 *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_AK8975_H__
|
