vl53l1_api_debug.h

00001 
00002 /* SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause */
00003 /******************************************************************************
00004  * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
00005 
00006  This file is part of VL53L1 and is dual licensed,
00007  either GPL-2.0+
00008  or 'BSD 3-clause "New" or "Revised" License' , at your option.
00009  ******************************************************************************
00010  */
00011 
00012 
00013 
00014 
00015 #ifndef _VL53L1_API_DEBUG_H_
00016 #define _VL53L1_API_DEBUG_H_
00017 
00018 #include "vl53l1_platform.h"
00019 #include "vl53l1_nvm_structs.h"
00020 
00021 #ifdef __cplusplus
00022 extern "C" {
00023 #endif
00024 
00025 
00026 
00027 
00028 
00029 VL53L1_Error VL53L1_decode_calibration_data_buffer(
00030     uint16_t                   buf_size,
00031     uint8_t                   *pbuffer,
00032     VL53L1_calibration_data_t *pdata);
00033 
00034 
00035 
00036 
00037 
00038 
00039 VL53L1_Error VL53L1_get_nvm_debug_data(
00040     VL53L1_DEV                 Dev,
00041     VL53L1_decoded_nvm_data_t *pdata);
00042 
00043 
00044 
00045 VL53L1_Error VL53L1_get_histogram_debug_data(
00046     VL53L1_DEV                   Dev,
00047     VL53L1_histogram_bin_data_t *pdata);
00048 
00049 
00050 
00051 
00052 
00053 
00054 VL53L1_Error VL53L1_get_additional_data(
00055     VL53L1_DEV                Dev,
00056     VL53L1_additional_data_t *pdata);
00057 
00058 
00059 
00060 
00061 
00062 
00063 VL53L1_Error VL53L1_get_xtalk_debug_data(
00064     VL53L1_DEV                 Dev,
00065     VL53L1_xtalk_debug_data_t *pdata);
00066 
00067 
00068 
00069 
00070 VL53L1_Error VL53L1_get_offset_debug_data(
00071     VL53L1_DEV                 Dev,
00072     VL53L1_offset_debug_data_t *pdata);
00073 
00074 #ifdef VL53L1_LOG_ENABLE
00075 
00076 
00077 
00078 void  VL53L1_signed_fixed_point_sprintf(
00079     int32_t    fp_value,
00080     uint8_t    frac_bits,
00081     uint16_t   buf_size,
00082     char      *pbuffer);
00083 
00084 
00085 
00086 
00087 void VL53L1_print_static_nvm_managed(
00088     VL53L1_static_nvm_managed_t   *pdata,
00089     char                          *pprefix,
00090     uint32_t                       trace_flags);
00091 
00092 
00093 
00094 
00095 void VL53L1_print_customer_nvm_managed(
00096     VL53L1_customer_nvm_managed_t *pdata,
00097     char                          *pprefix,
00098     uint32_t                       trace_flags);
00099 
00100 
00101 
00102 
00103 void VL53L1_print_nvm_copy_data(
00104     VL53L1_nvm_copy_data_t        *pdata,
00105     char                          *pprefix,
00106     uint32_t                       trace_flags);
00107 
00108 
00109 
00110 
00111 void VL53L1_print_histogram_bin_data(
00112     VL53L1_histogram_bin_data_t *pdata,
00113     char                        *pprefix,
00114     uint32_t                     trace_flags);
00115 
00116 
00117 
00118 
00119 void VL53L1_print_xtalk_histogram_data(
00120     VL53L1_xtalk_histogram_data_t *pdata,
00121     char                          *pprefix,
00122     uint32_t                       trace_flags);
00123 
00124 
00125 
00126 
00127 void VL53L1_print_xtalk_histogram_shape_data(
00128     VL53L1_xtalk_histogram_shape_t *pdata,
00129     char                           *pprefix,
00130     uint32_t                        trace_flags);
00131 
00132 
00133 
00134 
00135 void VL53L1_print_range_results(
00136     VL53L1_range_results_t *pdata,
00137     char                   *pprefix,
00138     uint32_t                trace_flags);
00139 
00140 
00141 
00142 void VL53L1_print_range_data(
00143     VL53L1_range_data_t *pdata,
00144     char                *pprefix,
00145     uint32_t             trace_flags);
00146 
00147 
00148 
00149 
00150 void VL53L1_print_offset_range_results(
00151     VL53L1_offset_range_results_t *pdata,
00152     char                          *pprefix,
00153     uint32_t                       trace_flags);
00154 
00155 
00156 
00157 
00158 void VL53L1_print_offset_range_data(
00159     VL53L1_offset_range_data_t *pdata,
00160     char                       *pprefix,
00161     uint32_t                    trace_flags);
00162 
00163 
00164 
00165 
00166 void VL53L1_print_cal_peak_rate_map(
00167     VL53L1_cal_peak_rate_map_t *pdata,
00168     char                       *pprefix,
00169     uint32_t                    trace_flags);
00170 
00171 
00172 
00173 
00174 void VL53L1_print_additional_offset_cal_data(
00175     VL53L1_additional_offset_cal_data_t *pdata,
00176     char                                *pprefix,
00177     uint32_t                             trace_flags);
00178 
00179 
00180 
00181 void VL53L1_print_additional_data(
00182     VL53L1_additional_data_t *pdata,
00183     char                     *pprefix,
00184     uint32_t                 trace_flags);
00185 
00186 
00187 
00188 
00189 void VL53L1_print_gain_calibration_data(
00190     VL53L1_gain_calibration_data_t *pdata,
00191     char                           *pprefix,
00192     uint32_t                        trace_flags);
00193 
00194 
00195 
00196 
00197 void VL53L1_print_zone_calibration_data(
00198     VL53L1_zone_calibration_data_t *pdata,
00199     char                           *pprefix,
00200     uint32_t                        trace_flags);
00201 
00202 
00203 
00204 
00205 void VL53L1_print_zone_calibration_results(
00206     VL53L1_zone_calibration_results_t *pdata,
00207     char                              *pprefix,
00208     uint32_t                           trace_flags);
00209 
00210 
00211 
00212 
00213 void VL53L1_print_xtalk_range_results(
00214     VL53L1_xtalk_range_results_t *pdata,
00215     char                         *pprefix,
00216     uint32_t                      trace_flags);
00217 
00218 
00219 
00220 
00221 void VL53L1_print_xtalk_range_data(
00222     VL53L1_xtalk_range_data_t *pdata,
00223     char                      *pprefix,
00224     uint32_t                   trace_flags);
00225 
00226 
00227 
00228 
00229 void VL53L1_print_xtalk_calibration_results(
00230     VL53L1_xtalk_calibration_results_t *pdata,
00231     char                               *pprefix,
00232     uint32_t                            trace_flags);
00233 
00234 
00235 
00236 
00237 void VL53L1_print_xtalk_config(
00238     VL53L1_xtalk_config_t *pdata,
00239     char                  *pprefix,
00240     uint32_t               trace_flags);
00241 
00242 
00243 
00244 void VL53L1_print_xtalk_extract_config(
00245     VL53L1_xtalkextract_config_t *pdata,
00246     char                         *pprefix,
00247     uint32_t                      trace_flags);
00248 
00249 
00250 
00251 void VL53L1_print_zone_cal_config(
00252     VL53L1_zonecal_config_t *pdata,
00253     char                    *pprefix,
00254     uint32_t                 trace_flags);
00255 
00256 
00257 
00258 void VL53L1_print_offset_cal_config(
00259     VL53L1_offsetcal_config_t *pdata,
00260     char                      *pprefix,
00261     uint32_t                   trace_flags);
00262 
00263 
00264 
00265 
00266 void VL53L1_print_dmax_calibration_data(
00267     VL53L1_dmax_calibration_data_t *pdata,
00268     char                           *pprefix,
00269     uint32_t                        trace_flags);
00270 
00271 
00272 
00273 
00274 void VL53L1_print_calibration_data(
00275     VL53L1_calibration_data_t *pdata,
00276     char                      *pprefix,
00277     uint32_t                   trace_flags);
00278 
00279 
00280 
00281 
00282 void VL53L1_print_xtalk_debug_data(
00283     VL53L1_xtalk_debug_data_t *pdata,
00284     char                      *pprefix,
00285     uint32_t                   trace_flags);
00286 
00287 
00288 
00289 void VL53L1_print_offset_debug_data(
00290     VL53L1_offset_debug_data_t *pdata,
00291     char                       *pprefix,
00292     uint32_t                    trace_flags);
00293 
00294 
00295 
00296 
00297 void VL53L1_print_optical_centre(
00298     VL53L1_optical_centre_t   *pdata,
00299     char                      *pprefix,
00300     uint32_t                   trace_flags);
00301 
00302 
00303 
00304 
00305 void VL53L1_print_user_zone(
00306     VL53L1_user_zone_t   *pdata,
00307     char                 *pprefix,
00308     uint32_t              trace_flags);
00309 
00310 
00311 
00312 void VL53L1_print_zone_config(
00313     VL53L1_zone_config_t *pdata,
00314     char                 *pprefix,
00315     uint32_t              trace_flags);
00316 
00317 
00318 
00319 
00320 void VL53L1_print_spad_rate_data(
00321     VL53L1_spad_rate_data_t  *pspad_rates,
00322     char                     *pprefix,
00323     uint32_t                  trace_flags);
00324 
00325 
00326 
00327 
00328 void VL53L1_print_spad_rate_map(
00329     VL53L1_spad_rate_data_t  *pspad_rates,
00330     char                     *pprefix,
00331     uint32_t                  trace_flags);
00332 
00333 
00334 #endif
00335 
00336 #ifdef __cplusplus
00337 }
00338 #endif
00339 
00340 #endif
00341