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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
|
/*******************************************************************************
* Copyright � 2016, 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.
******************************************************************************/
#include "vl53l0_api.h"
#include "vl53l0_api_core.h"
#include "vl53l0_api_strings.h"
#ifndef __KERNEL__
#include <stdlib.h>
#endif
#define LOG_FUNCTION_START(fmt, ...) \
_LOG_FUNCTION_START(TRACE_MODULE_API, fmt, ##__VA_ARGS__)
#define LOG_FUNCTION_END(status, ...) \
_LOG_FUNCTION_END(TRACE_MODULE_API, status, ##__VA_ARGS__)
#define LOG_FUNCTION_END_FMT(status, fmt, ...) \
_LOG_FUNCTION_END_FMT(TRACE_MODULE_API, status, fmt, ##__VA_ARGS__)
VL53L0_Error VL53L0_check_part_used(VL53L0_DEV Dev,
uint8_t *Revision,
VL53L0_DeviceInfo_t *pVL53L0_DeviceInfo)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
uint8_t ModuleIdInt;
char *ProductId_tmp;
LOG_FUNCTION_START("");
Status = VL53L0_get_info_from_device(Dev, 2);
if (Status == VL53L0_ERROR_NONE) {
ModuleIdInt = VL53L0_GETDEVICESPECIFICPARAMETER(Dev, ModuleId);
if (ModuleIdInt == 0) {
*Revision = 0;
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->ProductId, "");
} else {
*Revision = VL53L0_GETDEVICESPECIFICPARAMETER(Dev, Revision);
ProductId_tmp = VL53L0_GETDEVICESPECIFICPARAMETER(Dev,
ProductId);
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->ProductId, ProductId_tmp);
}
}
LOG_FUNCTION_END(Status);
return Status;
}
VL53L0_Error VL53L0_get_device_info(VL53L0_DEV Dev,
VL53L0_DeviceInfo_t *pVL53L0_DeviceInfo)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
uint8_t revision_id;
uint8_t Revision;
Status = VL53L0_check_part_used(Dev, &Revision, pVL53L0_DeviceInfo);
if (Status == VL53L0_ERROR_NONE) {
if (Revision == 0) {
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->Name,
VL53L0_STRING_DEVICE_INFO_NAME_TS0);
} else if ((Revision <= 34) && (Revision != 32)) {
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->Name,
VL53L0_STRING_DEVICE_INFO_NAME_TS1);
} else if (Revision < 39) {
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->Name,
VL53L0_STRING_DEVICE_INFO_NAME_TS2);
} else {
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->Name,
VL53L0_STRING_DEVICE_INFO_NAME_ES1);
}
VL53L0_COPYSTRING(pVL53L0_DeviceInfo->Type,
VL53L0_STRING_DEVICE_INFO_TYPE);
}
if (Status == VL53L0_ERROR_NONE) {
Status = VL53L0_RdByte(Dev, VL53L0_REG_IDENTIFICATION_MODEL_ID,
&pVL53L0_DeviceInfo->ProductType);
}
if (Status == VL53L0_ERROR_NONE) {
Status = VL53L0_RdByte(Dev,
VL53L0_REG_IDENTIFICATION_REVISION_ID,
&revision_id);
pVL53L0_DeviceInfo->ProductRevisionMajor = 1;
pVL53L0_DeviceInfo->ProductRevisionMinor =
(revision_id & 0xF0) >> 4;
}
return Status;
}
VL53L0_Error VL53L0_get_device_error_string(VL53L0_DeviceError ErrorCode,
char *pDeviceErrorString)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
LOG_FUNCTION_START("");
switch (ErrorCode) {
case VL53L0_DEVICEERROR_NONE:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_NONE);
break;
case VL53L0_DEVICEERROR_VCSELCONTINUITYTESTFAILURE:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_VCSELCONTINUITYTESTFAILURE);
break;
case VL53L0_DEVICEERROR_VCSELWATCHDOGTESTFAILURE:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_VCSELWATCHDOGTESTFAILURE);
break;
case VL53L0_DEVICEERROR_NOVHVVALUEFOUND:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_NOVHVVALUEFOUND);
break;
case VL53L0_DEVICEERROR_MSRCNOTARGET:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_MSRCNOTARGET);
break;
case VL53L0_DEVICEERROR_SNRCHECK:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_SNRCHECK);
break;
case VL53L0_DEVICEERROR_RANGEPHASECHECK:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_RANGEPHASECHECK);
break;
case VL53L0_DEVICEERROR_SIGMATHRESHOLDCHECK:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_SIGMATHRESHOLDCHECK);
break;
case VL53L0_DEVICEERROR_TCC:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_TCC);
break;
case VL53L0_DEVICEERROR_PHASECONSISTENCY:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_PHASECONSISTENCY);
break;
case VL53L0_DEVICEERROR_MINCLIP:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_MINCLIP);
break;
case VL53L0_DEVICEERROR_RANGECOMPLETE:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_RANGECOMPLETE);
break;
case VL53L0_DEVICEERROR_ALGOUNDERFLOW:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_ALGOUNDERFLOW);
break;
case VL53L0_DEVICEERROR_ALGOOVERFLOW:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_ALGOOVERFLOW);
break;
case VL53L0_DEVICEERROR_RANGEIGNORETHRESHOLD:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_DEVICEERROR_RANGEIGNORETHRESHOLD);
break;
default:
VL53L0_COPYSTRING(pDeviceErrorString,
VL53L0_STRING_UNKNOW_ERROR_CODE);
}
LOG_FUNCTION_END(Status);
return Status;
}
VL53L0_Error VL53L0_get_range_status_string(uint8_t RangeStatus,
char *pRangeStatusString)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
LOG_FUNCTION_START("");
switch (RangeStatus) {
case 0:
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_RANGEVALID);
break;
case 1:
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_SIGMA);
break;
case 2:
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_SIGNAL);
break;
case 3:
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_MINRANGE);
break;
case 4:
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_PHASE);
break;
case 5:
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_HW);
break;
default: /**/
VL53L0_COPYSTRING(pRangeStatusString,
VL53L0_STRING_RANGESTATUS_NONE);
}
LOG_FUNCTION_END(Status);
return Status;
}
VL53L0_Error VL53L0_get_pal_error_string(VL53L0_Error PalErrorCode,
char *pPalErrorString)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
LOG_FUNCTION_START("");
switch (PalErrorCode) {
case VL53L0_ERROR_NONE:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_NONE);
break;
case VL53L0_ERROR_CALIBRATION_WARNING:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_CALIBRATION_WARNING);
break;
case VL53L0_ERROR_MIN_CLIPPED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_MIN_CLIPPED);
break;
case VL53L0_ERROR_UNDEFINED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_UNDEFINED);
break;
case VL53L0_ERROR_INVALID_PARAMS:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_INVALID_PARAMS);
break;
case VL53L0_ERROR_NOT_SUPPORTED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_NOT_SUPPORTED);
break;
case VL53L0_ERROR_INTERRUPT_NOT_CLEARED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_INTERRUPT_NOT_CLEARED);
break;
case VL53L0_ERROR_RANGE_ERROR:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_RANGE_ERROR);
break;
case VL53L0_ERROR_TIME_OUT:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_TIME_OUT);
break;
case VL53L0_ERROR_MODE_NOT_SUPPORTED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_MODE_NOT_SUPPORTED);
break;
case VL53L0_ERROR_BUFFER_TOO_SMALL:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_BUFFER_TOO_SMALL);
break;
case VL53L0_ERROR_GPIO_NOT_EXISTING:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_GPIO_NOT_EXISTING);
break;
case VL53L0_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED);
break;
case VL53L0_ERROR_CONTROL_INTERFACE:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_CONTROL_INTERFACE);
break;
case VL53L0_ERROR_INVALID_COMMAND:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_INVALID_COMMAND);
break;
case VL53L0_ERROR_DIVISION_BY_ZERO:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_DIVISION_BY_ZERO);
break;
case VL53L0_ERROR_REF_SPAD_INIT:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_REF_SPAD_INIT);
break;
case VL53L0_ERROR_NOT_IMPLEMENTED:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_ERROR_NOT_IMPLEMENTED);
break;
default:
VL53L0_COPYSTRING(pPalErrorString,
VL53L0_STRING_UNKNOW_ERROR_CODE);
}
LOG_FUNCTION_END(Status);
return Status;
}
VL53L0_Error VL53L0_get_pal_state_string(VL53L0_State PalStateCode,
char *pPalStateString)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
LOG_FUNCTION_START("");
switch (PalStateCode) {
case VL53L0_STATE_POWERDOWN:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_POWERDOWN);
break;
case VL53L0_STATE_WAIT_STATICINIT:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_WAIT_STATICINIT);
break;
case VL53L0_STATE_STANDBY:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_STANDBY);
break;
case VL53L0_STATE_IDLE:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_IDLE);
break;
case VL53L0_STATE_RUNNING:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_RUNNING);
break;
case VL53L0_STATE_UNKNOWN:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_UNKNOWN);
break;
case VL53L0_STATE_ERROR:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_ERROR);
break;
default:
VL53L0_COPYSTRING(pPalStateString,
VL53L0_STRING_STATE_UNKNOWN);
}
LOG_FUNCTION_END(Status);
return Status;
}
VL53L0_Error VL53L0_get_sequence_steps_info(
VL53L0_SequenceStepId SequenceStepId,
char *pSequenceStepsString)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
LOG_FUNCTION_START("");
switch (SequenceStepId) {
case VL53L0_SEQUENCESTEP_TCC:
VL53L0_COPYSTRING(pSequenceStepsString,
VL53L0_STRING_SEQUENCESTEP_TCC);
break;
case VL53L0_SEQUENCESTEP_DSS:
VL53L0_COPYSTRING(pSequenceStepsString,
VL53L0_STRING_SEQUENCESTEP_DSS);
break;
case VL53L0_SEQUENCESTEP_MSRC:
VL53L0_COPYSTRING(pSequenceStepsString,
VL53L0_STRING_SEQUENCESTEP_MSRC);
break;
case VL53L0_SEQUENCESTEP_PRE_RANGE:
VL53L0_COPYSTRING(pSequenceStepsString,
VL53L0_STRING_SEQUENCESTEP_PRE_RANGE);
break;
case VL53L0_SEQUENCESTEP_FINAL_RANGE:
VL53L0_COPYSTRING(pSequenceStepsString,
VL53L0_STRING_SEQUENCESTEP_FINAL_RANGE);
break;
default:
Status = VL53L0_ERROR_INVALID_PARAMS;
}
LOG_FUNCTION_END(Status);
return Status;
}
VL53L0_Error VL53L0_get_limit_check_info(VL53L0_DEV Dev, uint16_t LimitCheckId,
char *pLimitCheckString)
{
VL53L0_Error Status = VL53L0_ERROR_NONE;
LOG_FUNCTION_START("");
switch (LimitCheckId) {
case VL53L0_CHECKENABLE_SIGMA_FINAL_RANGE:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_CHECKENABLE_SIGMA_FINAL_RANGE);
break;
case VL53L0_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_CHECKENABLE_SIGNAL_RATE_FINAL_RANGE);
break;
case VL53L0_CHECKENABLE_SIGNAL_REF_CLIP:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_CHECKENABLE_SIGNAL_REF_CLIP);
break;
case VL53L0_CHECKENABLE_RANGE_IGNORE_THRESHOLD:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_CHECKENABLE_RANGE_IGNORE_THRESHOLD);
break;
case VL53L0_CHECKENABLE_SIGNAL_RATE_MSRC:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_CHECKENABLE_SIGNAL_RATE_MSRC);
break;
case VL53L0_CHECKENABLE_SIGNAL_RATE_PRE_RANGE:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_CHECKENABLE_SIGNAL_RATE_PRE_RANGE);
break;
default:
VL53L0_COPYSTRING(pLimitCheckString,
VL53L0_STRING_UNKNOW_ERROR_CODE);
}
LOG_FUNCTION_END(Status);
return Status;
}
|
