ST Expansion SW Team / VL53L1

Fork, renaming of VL53L1CB-2

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   X_NUCLEO_53L1CB

inc/vl53l1_api_debug.h@13:3f1b341901dd, 2021-06-11 (annotated)

Committer:
Charles MacNeill
Date:
Fri Jun 11 17:08:27 2021 +0100
Revision:
13:3f1b341901dd
Parent:
7:1add29d51e72 
changing case of vl53l1cb.* so it works in linux

Who changed what in which revision?

UserRevisionLine numberNew contents of line
charlesmn 0:3ac96e360672 1
Charles MacNeill 7:1add29d51e72 2 /* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
Charles MacNeill 7:1add29d51e72 3 /******************************************************************************
charlesmn 0:3ac96e360672 4 * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
charlesmn 0:3ac96e360672 5
Charles MacNeill 7:1add29d51e72 6 This file is part of VL53L1 and is dual licensed,
Charles MacNeill 7:1add29d51e72 7 either GPL-2.0+
charlesmn 0:3ac96e360672 8 or 'BSD 3-clause "New" or "Revised" License' , at your option.
Charles MacNeill 7:1add29d51e72 9 ******************************************************************************
Charles MacNeill 7:1add29d51e72 10 */
charlesmn 0:3ac96e360672 11
charlesmn 0:3ac96e360672 12
charlesmn 0:3ac96e360672 13
charlesmn 0:3ac96e360672 14
charlesmn 0:3ac96e360672 15 #ifndef _VL53L1_API_DEBUG_H_
charlesmn 0:3ac96e360672 16 #define _VL53L1_API_DEBUG_H_
charlesmn 0:3ac96e360672 17
charlesmn 0:3ac96e360672 18 #include "vl53l1_platform.h"
charlesmn 0:3ac96e360672 19 #include "vl53l1_nvm_structs.h"
charlesmn 0:3ac96e360672 20
charlesmn 0:3ac96e360672 21 #ifdef __cplusplus
charlesmn 0:3ac96e360672 22 extern "C" {
charlesmn 0:3ac96e360672 23 #endif
charlesmn 0:3ac96e360672 24
charlesmn 0:3ac96e360672 25
charlesmn 0:3ac96e360672 26
charlesmn 0:3ac96e360672 27
charlesmn 0:3ac96e360672 28
charlesmn 0:3ac96e360672 29 VL53L1_Error VL53L1_decode_calibration_data_buffer(
charlesmn 0:3ac96e360672 30 uint16_t buf_size,
charlesmn 0:3ac96e360672 31 uint8_t *pbuffer,
charlesmn 0:3ac96e360672 32 VL53L1_calibration_data_t *pdata);
charlesmn 0:3ac96e360672 33
charlesmn 0:3ac96e360672 34
charlesmn 0:3ac96e360672 35
charlesmn 0:3ac96e360672 36
charlesmn 0:3ac96e360672 37
charlesmn 0:3ac96e360672 38
charlesmn 0:3ac96e360672 39 VL53L1_Error VL53L1_get_nvm_debug_data(
charlesmn 0:3ac96e360672 40 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 41 VL53L1_decoded_nvm_data_t *pdata);
charlesmn 0:3ac96e360672 42
charlesmn 0:3ac96e360672 43
charlesmn 0:3ac96e360672 44
charlesmn 0:3ac96e360672 45 VL53L1_Error VL53L1_get_histogram_debug_data(
charlesmn 0:3ac96e360672 46 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 47 VL53L1_histogram_bin_data_t *pdata);
charlesmn 0:3ac96e360672 48
charlesmn 0:3ac96e360672 49
charlesmn 0:3ac96e360672 50
charlesmn 0:3ac96e360672 51
charlesmn 0:3ac96e360672 52
charlesmn 0:3ac96e360672 53
charlesmn 0:3ac96e360672 54 VL53L1_Error VL53L1_get_additional_data(
charlesmn 0:3ac96e360672 55 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 56 VL53L1_additional_data_t *pdata);
charlesmn 0:3ac96e360672 57
charlesmn 0:3ac96e360672 58
charlesmn 0:3ac96e360672 59
charlesmn 0:3ac96e360672 60
charlesmn 0:3ac96e360672 61
charlesmn 0:3ac96e360672 62
charlesmn 0:3ac96e360672 63 VL53L1_Error VL53L1_get_xtalk_debug_data(
charlesmn 0:3ac96e360672 64 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 65 VL53L1_xtalk_debug_data_t *pdata);
charlesmn 0:3ac96e360672 66
charlesmn 0:3ac96e360672 67
charlesmn 0:3ac96e360672 68
charlesmn 0:3ac96e360672 69
charlesmn 0:3ac96e360672 70 VL53L1_Error VL53L1_get_offset_debug_data(
charlesmn 0:3ac96e360672 71 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 72 VL53L1_offset_debug_data_t *pdata);
charlesmn 0:3ac96e360672 73
charlesmn 0:3ac96e360672 74 #ifdef VL53L1_LOG_ENABLE
charlesmn 0:3ac96e360672 75
charlesmn 0:3ac96e360672 76
charlesmn 0:3ac96e360672 77
charlesmn 0:3ac96e360672 78 void VL53L1_signed_fixed_point_sprintf(
charlesmn 0:3ac96e360672 79 int32_t fp_value,
charlesmn 0:3ac96e360672 80 uint8_t frac_bits,
charlesmn 0:3ac96e360672 81 uint16_t buf_size,
charlesmn 0:3ac96e360672 82 char *pbuffer);
charlesmn 0:3ac96e360672 83
charlesmn 0:3ac96e360672 84
charlesmn 0:3ac96e360672 85
charlesmn 0:3ac96e360672 86
charlesmn 0:3ac96e360672 87 void VL53L1_print_static_nvm_managed(
charlesmn 0:3ac96e360672 88 VL53L1_static_nvm_managed_t *pdata,
charlesmn 0:3ac96e360672 89 char *pprefix,
charlesmn 0:3ac96e360672 90 uint32_t trace_flags);
charlesmn 0:3ac96e360672 91
charlesmn 0:3ac96e360672 92
charlesmn 0:3ac96e360672 93
charlesmn 0:3ac96e360672 94
charlesmn 0:3ac96e360672 95 void VL53L1_print_customer_nvm_managed(
charlesmn 0:3ac96e360672 96 VL53L1_customer_nvm_managed_t *pdata,
charlesmn 0:3ac96e360672 97 char *pprefix,
charlesmn 0:3ac96e360672 98 uint32_t trace_flags);
charlesmn 0:3ac96e360672 99
charlesmn 0:3ac96e360672 100
charlesmn 0:3ac96e360672 101
charlesmn 0:3ac96e360672 102
charlesmn 0:3ac96e360672 103 void VL53L1_print_nvm_copy_data(
charlesmn 0:3ac96e360672 104 VL53L1_nvm_copy_data_t *pdata,
charlesmn 0:3ac96e360672 105 char *pprefix,
charlesmn 0:3ac96e360672 106 uint32_t trace_flags);
charlesmn 0:3ac96e360672 107
charlesmn 0:3ac96e360672 108
charlesmn 0:3ac96e360672 109
charlesmn 0:3ac96e360672 110
charlesmn 0:3ac96e360672 111 void VL53L1_print_histogram_bin_data(
charlesmn 0:3ac96e360672 112 VL53L1_histogram_bin_data_t *pdata,
charlesmn 0:3ac96e360672 113 char *pprefix,
charlesmn 0:3ac96e360672 114 uint32_t trace_flags);
charlesmn 0:3ac96e360672 115
charlesmn 0:3ac96e360672 116
charlesmn 0:3ac96e360672 117
charlesmn 0:3ac96e360672 118
charlesmn 0:3ac96e360672 119 void VL53L1_print_xtalk_histogram_data(
charlesmn 0:3ac96e360672 120 VL53L1_xtalk_histogram_data_t *pdata,
charlesmn 0:3ac96e360672 121 char *pprefix,
charlesmn 0:3ac96e360672 122 uint32_t trace_flags);
charlesmn 0:3ac96e360672 123
charlesmn 0:3ac96e360672 124
charlesmn 0:3ac96e360672 125
charlesmn 0:3ac96e360672 126
charlesmn 0:3ac96e360672 127 void VL53L1_print_xtalk_histogram_shape_data(
charlesmn 0:3ac96e360672 128 VL53L1_xtalk_histogram_shape_t *pdata,
charlesmn 0:3ac96e360672 129 char *pprefix,
charlesmn 0:3ac96e360672 130 uint32_t trace_flags);
charlesmn 0:3ac96e360672 131
charlesmn 0:3ac96e360672 132
charlesmn 0:3ac96e360672 133
charlesmn 0:3ac96e360672 134
charlesmn 0:3ac96e360672 135 void VL53L1_print_range_results(
charlesmn 0:3ac96e360672 136 VL53L1_range_results_t *pdata,
charlesmn 0:3ac96e360672 137 char *pprefix,
charlesmn 0:3ac96e360672 138 uint32_t trace_flags);
charlesmn 0:3ac96e360672 139
charlesmn 0:3ac96e360672 140
charlesmn 0:3ac96e360672 141
charlesmn 0:3ac96e360672 142 void VL53L1_print_range_data(
charlesmn 0:3ac96e360672 143 VL53L1_range_data_t *pdata,
charlesmn 0:3ac96e360672 144 char *pprefix,
charlesmn 0:3ac96e360672 145 uint32_t trace_flags);
charlesmn 0:3ac96e360672 146
charlesmn 0:3ac96e360672 147
charlesmn 0:3ac96e360672 148
charlesmn 0:3ac96e360672 149
charlesmn 0:3ac96e360672 150 void VL53L1_print_offset_range_results(
charlesmn 0:3ac96e360672 151 VL53L1_offset_range_results_t *pdata,
charlesmn 0:3ac96e360672 152 char *pprefix,
charlesmn 0:3ac96e360672 153 uint32_t trace_flags);
charlesmn 0:3ac96e360672 154
charlesmn 0:3ac96e360672 155
charlesmn 0:3ac96e360672 156
charlesmn 0:3ac96e360672 157
charlesmn 0:3ac96e360672 158 void VL53L1_print_offset_range_data(
charlesmn 0:3ac96e360672 159 VL53L1_offset_range_data_t *pdata,
charlesmn 0:3ac96e360672 160 char *pprefix,
charlesmn 0:3ac96e360672 161 uint32_t trace_flags);
charlesmn 0:3ac96e360672 162
charlesmn 0:3ac96e360672 163
charlesmn 0:3ac96e360672 164
charlesmn 0:3ac96e360672 165
charlesmn 0:3ac96e360672 166 void VL53L1_print_cal_peak_rate_map(
charlesmn 0:3ac96e360672 167 VL53L1_cal_peak_rate_map_t *pdata,
charlesmn 0:3ac96e360672 168 char *pprefix,
charlesmn 0:3ac96e360672 169 uint32_t trace_flags);
charlesmn 0:3ac96e360672 170
charlesmn 0:3ac96e360672 171
charlesmn 0:3ac96e360672 172
charlesmn 0:3ac96e360672 173
charlesmn 0:3ac96e360672 174 void VL53L1_print_additional_offset_cal_data(
charlesmn 0:3ac96e360672 175 VL53L1_additional_offset_cal_data_t *pdata,
charlesmn 0:3ac96e360672 176 char *pprefix,
charlesmn 0:3ac96e360672 177 uint32_t trace_flags);
charlesmn 0:3ac96e360672 178
charlesmn 0:3ac96e360672 179
charlesmn 0:3ac96e360672 180
charlesmn 0:3ac96e360672 181 void VL53L1_print_additional_data(
charlesmn 0:3ac96e360672 182 VL53L1_additional_data_t *pdata,
charlesmn 0:3ac96e360672 183 char *pprefix,
charlesmn 0:3ac96e360672 184 uint32_t trace_flags);
charlesmn 0:3ac96e360672 185
charlesmn 0:3ac96e360672 186
charlesmn 0:3ac96e360672 187
charlesmn 0:3ac96e360672 188
charlesmn 0:3ac96e360672 189 void VL53L1_print_gain_calibration_data(
charlesmn 0:3ac96e360672 190 VL53L1_gain_calibration_data_t *pdata,
charlesmn 0:3ac96e360672 191 char *pprefix,
charlesmn 0:3ac96e360672 192 uint32_t trace_flags);
charlesmn 0:3ac96e360672 193
charlesmn 0:3ac96e360672 194
charlesmn 0:3ac96e360672 195
charlesmn 0:3ac96e360672 196
charlesmn 0:3ac96e360672 197 void VL53L1_print_zone_calibration_data(
charlesmn 0:3ac96e360672 198 VL53L1_zone_calibration_data_t *pdata,
charlesmn 0:3ac96e360672 199 char *pprefix,
charlesmn 0:3ac96e360672 200 uint32_t trace_flags);
charlesmn 0:3ac96e360672 201
charlesmn 0:3ac96e360672 202
charlesmn 0:3ac96e360672 203
charlesmn 0:3ac96e360672 204
charlesmn 0:3ac96e360672 205 void VL53L1_print_zone_calibration_results(
charlesmn 0:3ac96e360672 206 VL53L1_zone_calibration_results_t *pdata,
charlesmn 0:3ac96e360672 207 char *pprefix,
charlesmn 0:3ac96e360672 208 uint32_t trace_flags);
charlesmn 0:3ac96e360672 209
charlesmn 0:3ac96e360672 210
charlesmn 0:3ac96e360672 211
charlesmn 0:3ac96e360672 212
charlesmn 0:3ac96e360672 213 void VL53L1_print_xtalk_range_results(
charlesmn 0:3ac96e360672 214 VL53L1_xtalk_range_results_t *pdata,
charlesmn 0:3ac96e360672 215 char *pprefix,
charlesmn 0:3ac96e360672 216 uint32_t trace_flags);
charlesmn 0:3ac96e360672 217
charlesmn 0:3ac96e360672 218
charlesmn 0:3ac96e360672 219
charlesmn 0:3ac96e360672 220
charlesmn 0:3ac96e360672 221 void VL53L1_print_xtalk_range_data(
charlesmn 0:3ac96e360672 222 VL53L1_xtalk_range_data_t *pdata,
charlesmn 0:3ac96e360672 223 char *pprefix,
charlesmn 0:3ac96e360672 224 uint32_t trace_flags);
charlesmn 0:3ac96e360672 225
charlesmn 0:3ac96e360672 226
charlesmn 0:3ac96e360672 227
charlesmn 0:3ac96e360672 228
charlesmn 0:3ac96e360672 229 void VL53L1_print_xtalk_calibration_results(
charlesmn 0:3ac96e360672 230 VL53L1_xtalk_calibration_results_t *pdata,
charlesmn 0:3ac96e360672 231 char *pprefix,
charlesmn 0:3ac96e360672 232 uint32_t trace_flags);
charlesmn 0:3ac96e360672 233
charlesmn 0:3ac96e360672 234
charlesmn 0:3ac96e360672 235
charlesmn 0:3ac96e360672 236
charlesmn 0:3ac96e360672 237 void VL53L1_print_xtalk_config(
charlesmn 0:3ac96e360672 238 VL53L1_xtalk_config_t *pdata,
charlesmn 0:3ac96e360672 239 char *pprefix,
charlesmn 0:3ac96e360672 240 uint32_t trace_flags);
charlesmn 0:3ac96e360672 241
charlesmn 0:3ac96e360672 242
charlesmn 0:3ac96e360672 243
charlesmn 0:3ac96e360672 244 void VL53L1_print_xtalk_extract_config(
charlesmn 0:3ac96e360672 245 VL53L1_xtalkextract_config_t *pdata,
charlesmn 0:3ac96e360672 246 char *pprefix,
charlesmn 0:3ac96e360672 247 uint32_t trace_flags);
charlesmn 0:3ac96e360672 248
charlesmn 0:3ac96e360672 249
charlesmn 0:3ac96e360672 250
charlesmn 0:3ac96e360672 251 void VL53L1_print_zone_cal_config(
charlesmn 0:3ac96e360672 252 VL53L1_zonecal_config_t *pdata,
charlesmn 0:3ac96e360672 253 char *pprefix,
charlesmn 0:3ac96e360672 254 uint32_t trace_flags);
charlesmn 0:3ac96e360672 255
charlesmn 0:3ac96e360672 256
charlesmn 0:3ac96e360672 257
charlesmn 0:3ac96e360672 258 void VL53L1_print_offset_cal_config(
charlesmn 0:3ac96e360672 259 VL53L1_offsetcal_config_t *pdata,
charlesmn 0:3ac96e360672 260 char *pprefix,
charlesmn 0:3ac96e360672 261 uint32_t trace_flags);
charlesmn 0:3ac96e360672 262
charlesmn 0:3ac96e360672 263
charlesmn 0:3ac96e360672 264
charlesmn 0:3ac96e360672 265
charlesmn 0:3ac96e360672 266 void VL53L1_print_dmax_calibration_data(
charlesmn 0:3ac96e360672 267 VL53L1_dmax_calibration_data_t *pdata,
charlesmn 0:3ac96e360672 268 char *pprefix,
charlesmn 0:3ac96e360672 269 uint32_t trace_flags);
charlesmn 0:3ac96e360672 270
charlesmn 0:3ac96e360672 271
charlesmn 0:3ac96e360672 272
charlesmn 0:3ac96e360672 273
charlesmn 0:3ac96e360672 274 void VL53L1_print_calibration_data(
charlesmn 0:3ac96e360672 275 VL53L1_calibration_data_t *pdata,
charlesmn 0:3ac96e360672 276 char *pprefix,
charlesmn 0:3ac96e360672 277 uint32_t trace_flags);
charlesmn 0:3ac96e360672 278
charlesmn 0:3ac96e360672 279
charlesmn 0:3ac96e360672 280
charlesmn 0:3ac96e360672 281
charlesmn 0:3ac96e360672 282 void VL53L1_print_xtalk_debug_data(
charlesmn 0:3ac96e360672 283 VL53L1_xtalk_debug_data_t *pdata,
charlesmn 0:3ac96e360672 284 char *pprefix,
charlesmn 0:3ac96e360672 285 uint32_t trace_flags);
charlesmn 0:3ac96e360672 286
charlesmn 0:3ac96e360672 287
charlesmn 0:3ac96e360672 288
charlesmn 0:3ac96e360672 289 void VL53L1_print_offset_debug_data(
charlesmn 0:3ac96e360672 290 VL53L1_offset_debug_data_t *pdata,
charlesmn 0:3ac96e360672 291 char *pprefix,
charlesmn 0:3ac96e360672 292 uint32_t trace_flags);
charlesmn 0:3ac96e360672 293
charlesmn 0:3ac96e360672 294
charlesmn 0:3ac96e360672 295
charlesmn 0:3ac96e360672 296
charlesmn 0:3ac96e360672 297 void VL53L1_print_optical_centre(
charlesmn 0:3ac96e360672 298 VL53L1_optical_centre_t *pdata,
charlesmn 0:3ac96e360672 299 char *pprefix,
charlesmn 0:3ac96e360672 300 uint32_t trace_flags);
charlesmn 0:3ac96e360672 301
charlesmn 0:3ac96e360672 302
charlesmn 0:3ac96e360672 303
charlesmn 0:3ac96e360672 304
charlesmn 0:3ac96e360672 305 void VL53L1_print_user_zone(
charlesmn 0:3ac96e360672 306 VL53L1_user_zone_t *pdata,
charlesmn 0:3ac96e360672 307 char *pprefix,
charlesmn 0:3ac96e360672 308 uint32_t trace_flags);
charlesmn 0:3ac96e360672 309
charlesmn 0:3ac96e360672 310
charlesmn 0:3ac96e360672 311
charlesmn 0:3ac96e360672 312 void VL53L1_print_zone_config(
charlesmn 0:3ac96e360672 313 VL53L1_zone_config_t *pdata,
charlesmn 0:3ac96e360672 314 char *pprefix,
charlesmn 0:3ac96e360672 315 uint32_t trace_flags);
charlesmn 0:3ac96e360672 316
charlesmn 0:3ac96e360672 317
charlesmn 0:3ac96e360672 318
charlesmn 0:3ac96e360672 319
charlesmn 0:3ac96e360672 320 void VL53L1_print_spad_rate_data(
charlesmn 0:3ac96e360672 321 VL53L1_spad_rate_data_t *pspad_rates,
charlesmn 0:3ac96e360672 322 char *pprefix,
charlesmn 0:3ac96e360672 323 uint32_t trace_flags);
charlesmn 0:3ac96e360672 324
charlesmn 0:3ac96e360672 325
charlesmn 0:3ac96e360672 326
charlesmn 0:3ac96e360672 327
charlesmn 0:3ac96e360672 328 void VL53L1_print_spad_rate_map(
charlesmn 0:3ac96e360672 329 VL53L1_spad_rate_data_t *pspad_rates,
charlesmn 0:3ac96e360672 330 char *pprefix,
charlesmn 0:3ac96e360672 331 uint32_t trace_flags);
charlesmn 0:3ac96e360672 332
charlesmn 0:3ac96e360672 333
charlesmn 0:3ac96e360672 334 #endif
charlesmn 0:3ac96e360672 335
charlesmn 0:3ac96e360672 336 #ifdef __cplusplus
charlesmn 0:3ac96e360672 337 }
charlesmn 0:3ac96e360672 338 #endif
charlesmn 0:3ac96e360672 339
charlesmn 0:3ac96e360672 340 #endif
charlesmn 0:3ac96e360672 341