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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
$License:
Copyright (C) 2011 InvenSense Corporation, All Rights Reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
$
*/
#ifndef __MLSL_H__
#define __MLSL_H__
/**
* @defgroup MLSL
* @brief Motion Library - Serial Layer.
* The Motion Library System Layer provides the Motion Library
* with the communication interface to the hardware.
*
* The communication interface is assumed to support serial
* transfers in burst of variable length up to
* SERIAL_MAX_TRANSFER_SIZE.
* The default value for SERIAL_MAX_TRANSFER_SIZE is 128 bytes.
* Transfers of length greater than SERIAL_MAX_TRANSFER_SIZE, will
* be subdivided in smaller transfers of length <=
* SERIAL_MAX_TRANSFER_SIZE.
* The SERIAL_MAX_TRANSFER_SIZE definition can be modified to
* overcome any host processor transfer size limitation down to
* 1 B, the minimum.
* An higher value for SERIAL_MAX_TRANSFER_SIZE will favor
* performance and efficiency while requiring higher resource usage
* (mostly buffering). A smaller value will increase overhead and
* decrease efficiency but allows to operate with more resource
* constrained processor and master serial controllers.
* The SERIAL_MAX_TRANSFER_SIZE definition can be found in the
* mlsl.h header file and master serial controllers.
* The SERIAL_MAX_TRANSFER_SIZE definition can be found in the
* mlsl.h header file.
*
* @{
* @file mlsl.h
* @brief The Motion Library System Layer.
*
*/
#include "mltypes.h"
#include <linux/mpu.h>
/*
* NOTE : to properly support Yamaha compass reads,
* the max transfer size should be at least 9 B.
* Length in bytes, typically a power of 2 >= 2
*/
#define SERIAL_MAX_TRANSFER_SIZE 128
/**
* inv_serial_single_write() - used to write a single byte of data.
* @sl_handle pointer to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @register_addr Register address to write.
* @data Single byte of data to write.
*
* It is called by the MPL to write a single byte of data to the MPU.
*
* returns INV_SUCCESS if successful, a non-zero error code otherwise.
*/
int inv_serial_single_write(
void *sl_handle,
unsigned char slave_addr,
unsigned char register_addr,
unsigned char data);
/**
* inv_serial_write() - used to write multiple bytes of data to registers.
* @sl_handle a file handle to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @register_addr Register address to write.
* @length Length of burst of data.
* @data Pointer to block of data.
*
* returns INV_SUCCESS if successful, a non-zero error code otherwise.
*/
int inv_serial_write(
void *sl_handle,
unsigned char slave_addr,
unsigned short length,
unsigned char const *data);
/**
* inv_serial_read() - used to read multiple bytes of data from registers.
* @sl_handle a file handle to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @register_addr Register address to read.
* @length Length of burst of data.
* @data Pointer to block of data.
*
* returns INV_SUCCESS == 0 if successful; a non-zero error code otherwise.
*/
int inv_serial_read(
void *sl_handle,
unsigned char slave_addr,
unsigned char register_addr,
unsigned short length,
unsigned char *data);
/**
* inv_serial_read_mem() - used to read multiple bytes of data from the memory.
* This should be sent by I2C or SPI.
*
* @sl_handle a file handle to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @mem_addr The location in the memory to read from.
* @length Length of burst data.
* @data Pointer to block of data.
*
* returns INV_SUCCESS == 0 if successful; a non-zero error code otherwise.
*/
int inv_serial_read_mem(
void *sl_handle,
unsigned char slave_addr,
unsigned short mem_addr,
unsigned short length,
unsigned char *data);
/**
* inv_serial_write_mem() - used to write multiple bytes of data to the memory.
* @sl_handle a file handle to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @mem_addr The location in the memory to write to.
* @length Length of burst data.
* @data Pointer to block of data.
*
* returns INV_SUCCESS == 0 if successful; a non-zero error code otherwise.
*/
int inv_serial_write_mem(
void *sl_handle,
unsigned char slave_addr,
unsigned short mem_addr,
unsigned short length,
unsigned char const *data);
/**
* inv_serial_read_fifo() - used to read multiple bytes of data from the fifo.
* @sl_handle a file handle to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @length Length of burst of data.
* @data Pointer to block of data.
*
* returns INV_SUCCESS == 0 if successful; a non-zero error code otherwise.
*/
int inv_serial_read_fifo(
void *sl_handle,
unsigned char slave_addr,
unsigned short length,
unsigned char *data);
/**
* inv_serial_write_fifo() - used to write multiple bytes of data to the fifo.
* @sl_handle a file handle to the serial device used for the communication.
* @slave_addr I2C slave address of device.
* @length Length of burst of data.
* @data Pointer to block of data.
*
* returns INV_SUCCESS == 0 if successful; a non-zero error code otherwise.
*/
int inv_serial_write_fifo(
void *sl_handle,
unsigned char slave_addr,
unsigned short length,
unsigned char const *data);
/**
* @}
*/
#endif /* __MLSL_H__ */
|
