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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*******************************************************************************
* Copyright � 2015, STMicroelectronics International N.V.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of STMicroelectronics nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
#ifndef _VL53L0_PLATFORM_H_
#define _VL53L0_PLATFORM_H_
#include <linux/delay.h>
#include "vl53l0_def.h"
#include "vl53l0_platform_log.h"
#include "stmvl53l0-i2c.h"
#include "stmvl53l0-cci.h"
#include "stmvl53l0.h"
/**
* @file vl53l0_platform.h
*
* @brief All end user OS/platform/application porting
*/
/**
* @defgroup VL53L0_platform_group VL53L0 Platform Functions
* @brief VL53L0 Platform Functions
* @{
*/
/**
* @struct VL53L0_Dev_t
* @brief Generic PAL device type that does link between API and platform
* abstraction layer
*
*/
typedef struct stmvl53l0_data *VL53L0_DEV;
/**
* @def PALDevDataGet
* @brief Get ST private structure @a VL53L0_DevData_t data access
*
* @param Dev Device Handle
* @param field ST structure field name
* It maybe used and as real data "ref" not just as "get" for sub-structure item
* like PALDevDataGet(FilterData.field)[i] or
* PALDevDataGet(FilterData.MeasurementIndex)++
*/
#define PALDevDataGet(Dev, field) (Dev->Data.field)
/**
* @def PALDevDataSet(Dev, field, data)
* @brief Set ST private structure @a VL53L0_DevData_t data field
* @param Dev Device Handle
* @param field ST structure field na*me
* @param data Data to be set
*/
#define PALDevDataSet(Dev, field, data) ((Dev->Data.field) = (data))
/**
* @defgroup VL53L0_registerAccess_group PAL Register Access Functions
* @brief PAL Register Access Functions
* @{
*/
/**
* Lock comms interface to serialize all commands to a shared I2C interface
* for a specific device
* @param Dev Device Handle
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_LockSequenceAccess(VL53L0_DEV Dev);
/**
* Unlock comms interface to serialize all commands to a shared I2C interface
* for a specific device
* @param Dev Device Handle
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_UnlockSequenceAccess(VL53L0_DEV Dev);
/**
* Writes the supplied byte buffer to the device
* @param Dev Device Handle
* @param index The register index
* @param pdata Pointer to uint8_t buffer containing the data to be written
* @param count Number of bytes in the supplied byte buffer
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_WriteMulti(VL53L0_DEV Dev, uint8_t index,
uint8_t *pdata, uint32_t count);
/**
* Reads the requested number of bytes from the device
* @param Dev Device Handle
* @param index The register index
* @param pdata Pointer to the uint8_t buffer to store read data
* @param count Number of uint8_t's to read
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_ReadMulti(VL53L0_DEV Dev, uint8_t index,
uint8_t *pdata, uint32_t count);
/**
* Write single byte register
* @param Dev Device Handle
* @param index The register index
* @param data 8 bit register data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_WrByte(VL53L0_DEV Dev, uint8_t index, uint8_t data);
/**
* Write word register
* @param Dev Device Handle
* @param index The register index
* @param data 16 bit register data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_WrWord(VL53L0_DEV Dev, uint8_t index, uint16_t data);
/**
* Write double word (4 byte) register
* @param Dev Device Handle
* @param index The register index
* @param data 32 bit register data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_WrDWord(VL53L0_DEV Dev, uint8_t index, uint32_t data);
/**
* Read single byte register
* @param Dev Device Handle
* @param index The register index
* @param data pointer to 8 bit data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_RdByte(VL53L0_DEV Dev, uint8_t index, uint8_t *data);
/**
* Read word (2byte) register
* @param Dev Device Handle
* @param index The register index
* @param data pointer to 16 bit data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_RdWord(VL53L0_DEV Dev, uint8_t index, uint16_t *data);
/**
* Read dword (4byte) register
* @param Dev Device Handle
* @param index The register index
* @param data pointer to 32 bit data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_RdDWord(VL53L0_DEV Dev, uint8_t index, uint32_t *data);
/**
* Threat safe Update (read/modify/write) single byte register
*
* Final_reg = (Initial_reg & and_data) |or_data
*
* @param Dev Device Handle
* @param index The register index
* @param AndData 8 bit and data
* @param OrData 8 bit or data
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_UpdateByte(VL53L0_DEV Dev, uint8_t index,
uint8_t AndData, uint8_t OrData);
/** @} end of VL53L0_registerAccess_group */
/**
* @brief execute delay in all polling API call
*
* A typical multi-thread or RTOs implementation is to sleep the task for
* some 5ms (with 100Hz max rate faster polling is not needed)
* if nothing specific is need you can define it as an empty/void macro
* @code
* #define VL53L0_PollingDelay(...) (void)0
* @endcode
* @param Dev Device Handle
* @return VL53L0_ERROR_NONE Success
* @return "Other error code" See ::VL53L0_Error
*/
VL53L0_Error VL53L0_PollingDelay(VL53L0_DEV Dev);
/* usually best implemented as a real function */
/** @} end of VL53L0_platform_group */
#endif /* _VL53L0_PLATFORM_H_ */
|
