vl53l1_api_debug.h

00001 
00002 /*******************************************************************************
00003  * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
00004 
00005  This file is part of VL53L1 Core and is dual licensed,
00006  either 'STMicroelectronics
00007  Proprietary license'
00008  or 'BSD 3-clause "New" or "Revised" License' , at your option.
00009 
00010 ********************************************************************************
00011 
00012  'STMicroelectronics Proprietary license'
00013 
00014 ********************************************************************************
00015 
00016  License terms: STMicroelectronics Proprietary in accordance with licensing
00017  terms at www.st.com/sla0081
00018 
00019  STMicroelectronics confidential
00020  Reproduction and Communication of this document is strictly prohibited unless
00021  specifically authorized in writing by STMicroelectronics.
00022 
00023 
00024 ********************************************************************************
00025 
00026  Alternatively, VL53L1 Core may be distributed under the terms of
00027  'BSD 3-clause "New" or "Revised" License', in which case the following
00028  provisions apply instead of the ones
00029  mentioned above :
00030 
00031 ********************************************************************************
00032 
00033  License terms: BSD 3-clause "New" or "Revised" License.
00034 
00035  Redistribution and use in source and binary forms, with or without
00036  modification, are permitted provided that the following conditions are met:
00037 
00038  1. Redistributions of source code must retain the above copyright notice, this
00039  list of conditions and the following disclaimer.
00040 
00041  2. Redistributions in binary form must reproduce the above copyright notice,
00042  this list of conditions and the following disclaimer in the documentation
00043  and/or other materials provided with the distribution.
00044 
00045  3. Neither the name of the copyright holder nor the names of its contributors
00046  may be used to endorse or promote products derived from this software
00047  without specific prior written permission.
00048 
00049  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00050  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00051  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00052  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00053  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00054  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00055  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00056  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00057  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00058  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00059 
00060 
00061 ********************************************************************************
00062 
00063 */
00064 
00065 
00066 
00067 
00068 #ifndef _VL53L1_API_DEBUG_H_
00069 #define _VL53L1_API_DEBUG_H_
00070 
00071 #include "vl53l1_platform.h"
00072 #include "vl53l1_nvm_structs.h"
00073 
00074 #ifdef __cplusplus
00075 extern "C" {
00076 #endif
00077 
00078 
00079 
00080 
00081 
00082 VL53L1_Error VL53L1_decode_calibration_data_buffer(
00083     uint16_t                   buf_size,
00084     uint8_t                   *pbuffer,
00085     VL53L1_calibration_data_t *pdata);
00086 
00087 
00088 
00089 
00090 
00091 
00092 VL53L1_Error VL53L1_get_nvm_debug_data(
00093     VL53L1_DEV                 Dev,
00094     VL53L1_decoded_nvm_data_t *pdata);
00095 
00096 
00097 
00098 VL53L1_Error VL53L1_get_histogram_debug_data(
00099     VL53L1_DEV                   Dev,
00100     VL53L1_histogram_bin_data_t *pdata);
00101 
00102 
00103 
00104 
00105 
00106 
00107 VL53L1_Error VL53L1_get_additional_data(
00108     VL53L1_DEV                Dev,
00109     VL53L1_additional_data_t *pdata);
00110 
00111 
00112 
00113 
00114 
00115 
00116 VL53L1_Error VL53L1_get_xtalk_debug_data(
00117     VL53L1_DEV                 Dev,
00118     VL53L1_xtalk_debug_data_t *pdata);
00119 
00120 
00121 
00122 
00123 VL53L1_Error VL53L1_get_offset_debug_data(
00124     VL53L1_DEV                 Dev,
00125     VL53L1_offset_debug_data_t *pdata);
00126 
00127 #ifdef VL53L1_LOG_ENABLE
00128 
00129 
00130 
00131 void  VL53L1_signed_fixed_point_sprintf(
00132     int32_t    fp_value,
00133     uint8_t    frac_bits,
00134     uint16_t   buf_size,
00135     char      *pbuffer);
00136 
00137 
00138 
00139 
00140 void VL53L1_print_static_nvm_managed(
00141     VL53L1_static_nvm_managed_t   *pdata,
00142     char                          *pprefix,
00143     uint32_t                       trace_flags);
00144 
00145 
00146 
00147 
00148 void VL53L1_print_customer_nvm_managed(
00149     VL53L1_customer_nvm_managed_t *pdata,
00150     char                          *pprefix,
00151     uint32_t                       trace_flags);
00152 
00153 
00154 
00155 
00156 void VL53L1_print_nvm_copy_data(
00157     VL53L1_nvm_copy_data_t        *pdata,
00158     char                          *pprefix,
00159     uint32_t                       trace_flags);
00160 
00161 
00162 
00163 
00164 void VL53L1_print_histogram_bin_data(
00165     VL53L1_histogram_bin_data_t *pdata,
00166     char                        *pprefix,
00167     uint32_t                     trace_flags);
00168 
00169 
00170 
00171 
00172 void VL53L1_print_xtalk_histogram_data(
00173     VL53L1_xtalk_histogram_data_t *pdata,
00174     char                          *pprefix,
00175     uint32_t                       trace_flags);
00176 
00177 
00178 
00179 
00180 void VL53L1_print_xtalk_histogram_shape_data(
00181     VL53L1_xtalk_histogram_shape_t *pdata,
00182     char                           *pprefix,
00183     uint32_t                        trace_flags);
00184 
00185 
00186 
00187 
00188 void VL53L1_print_range_results(
00189     VL53L1_range_results_t *pdata,
00190     char                   *pprefix,
00191     uint32_t                trace_flags);
00192 
00193 
00194 
00195 void VL53L1_print_range_data(
00196     VL53L1_range_data_t *pdata,
00197     char                *pprefix,
00198     uint32_t             trace_flags);
00199 
00200 
00201 
00202 
00203 void VL53L1_print_offset_range_results(
00204     VL53L1_offset_range_results_t *pdata,
00205     char                          *pprefix,
00206     uint32_t                       trace_flags);
00207 
00208 
00209 
00210 
00211 void VL53L1_print_offset_range_data(
00212     VL53L1_offset_range_data_t *pdata,
00213     char                       *pprefix,
00214     uint32_t                    trace_flags);
00215 
00216 
00217 
00218 
00219 void VL53L1_print_cal_peak_rate_map(
00220     VL53L1_cal_peak_rate_map_t *pdata,
00221     char                       *pprefix,
00222     uint32_t                    trace_flags);
00223 
00224 
00225 
00226 
00227 void VL53L1_print_additional_offset_cal_data(
00228     VL53L1_additional_offset_cal_data_t *pdata,
00229     char                                *pprefix,
00230     uint32_t                             trace_flags);
00231 
00232 
00233 
00234 void VL53L1_print_additional_data(
00235     VL53L1_additional_data_t *pdata,
00236     char                     *pprefix,
00237     uint32_t                 trace_flags);
00238 
00239 
00240 
00241 
00242 void VL53L1_print_gain_calibration_data(
00243     VL53L1_gain_calibration_data_t *pdata,
00244     char                           *pprefix,
00245     uint32_t                        trace_flags);
00246 
00247 
00248 
00249 
00250 void VL53L1_print_zone_calibration_data(
00251     VL53L1_zone_calibration_data_t *pdata,
00252     char                           *pprefix,
00253     uint32_t                        trace_flags);
00254 
00255 
00256 
00257 
00258 void VL53L1_print_zone_calibration_results(
00259     VL53L1_zone_calibration_results_t *pdata,
00260     char                              *pprefix,
00261     uint32_t                           trace_flags);
00262 
00263 
00264 
00265 
00266 void VL53L1_print_xtalk_range_results(
00267     VL53L1_xtalk_range_results_t *pdata,
00268     char                         *pprefix,
00269     uint32_t                      trace_flags);
00270 
00271 
00272 
00273 
00274 void VL53L1_print_xtalk_range_data(
00275     VL53L1_xtalk_range_data_t *pdata,
00276     char                      *pprefix,
00277     uint32_t                   trace_flags);
00278 
00279 
00280 
00281 
00282 void VL53L1_print_xtalk_calibration_results(
00283     VL53L1_xtalk_calibration_results_t *pdata,
00284     char                               *pprefix,
00285     uint32_t                            trace_flags);
00286 
00287 
00288 
00289 
00290 void VL53L1_print_xtalk_config(
00291     VL53L1_xtalk_config_t *pdata,
00292     char                  *pprefix,
00293     uint32_t               trace_flags);
00294 
00295 
00296 
00297 void VL53L1_print_xtalk_extract_config(
00298     VL53L1_xtalkextract_config_t *pdata,
00299     char                         *pprefix,
00300     uint32_t                      trace_flags);
00301 
00302 
00303 
00304 void VL53L1_print_zone_cal_config(
00305     VL53L1_zonecal_config_t *pdata,
00306     char                    *pprefix,
00307     uint32_t                 trace_flags);
00308 
00309 
00310 
00311 void VL53L1_print_offset_cal_config(
00312     VL53L1_offsetcal_config_t *pdata,
00313     char                      *pprefix,
00314     uint32_t                   trace_flags);
00315 
00316 
00317 
00318 
00319 void VL53L1_print_dmax_calibration_data(
00320     VL53L1_dmax_calibration_data_t *pdata,
00321     char                           *pprefix,
00322     uint32_t                        trace_flags);
00323 
00324 
00325 
00326 
00327 void VL53L1_print_calibration_data(
00328     VL53L1_calibration_data_t *pdata,
00329     char                      *pprefix,
00330     uint32_t                   trace_flags);
00331 
00332 
00333 
00334 
00335 void VL53L1_print_xtalk_debug_data(
00336     VL53L1_xtalk_debug_data_t *pdata,
00337     char                      *pprefix,
00338     uint32_t                   trace_flags);
00339 
00340 
00341 
00342 void VL53L1_print_offset_debug_data(
00343     VL53L1_offset_debug_data_t *pdata,
00344     char                       *pprefix,
00345     uint32_t                    trace_flags);
00346 
00347 
00348 
00349 
00350 void VL53L1_print_optical_centre(
00351     VL53L1_optical_centre_t   *pdata,
00352     char                      *pprefix,
00353     uint32_t                   trace_flags);
00354 
00355 
00356 
00357 
00358 void VL53L1_print_user_zone(
00359     VL53L1_user_zone_t   *pdata,
00360     char                 *pprefix,
00361     uint32_t              trace_flags);
00362 
00363 
00364 
00365 void VL53L1_print_zone_config(
00366     VL53L1_zone_config_t *pdata,
00367     char                 *pprefix,
00368     uint32_t              trace_flags);
00369 
00370 
00371 
00372 
00373 void VL53L1_print_spad_rate_data(
00374     VL53L1_spad_rate_data_t  *pspad_rates,
00375     char                     *pprefix,
00376     uint32_t                  trace_flags);
00377 
00378 
00379 
00380 
00381 void VL53L1_print_spad_rate_map(
00382     VL53L1_spad_rate_data_t  *pspad_rates,
00383     char                     *pprefix,
00384     uint32_t                  trace_flags);
00385 
00386 
00387 #endif
00388 
00389 #ifdef __cplusplus
00390 }
00391 #endif
00392 
00393 #endif
00394 
00395