vl53l1_register_funcs.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_REGISTER_FUNCS_H_
00069 #define _VL53L1_REGISTER_FUNCS_H_
00070 
00071 #include "vl53l1_platform.h"
00072 
00073 #ifdef __cplusplus
00074 extern "C"
00075 {
00076 #endif
00077 
00078 
00079 
00080 
00081 VL53L1_Error VL53L1_i2c_encode_static_nvm_managed(
00082     VL53L1_static_nvm_managed_t  *pdata,
00083     uint16_t                   buf_size,
00084     uint8_t                   *pbuffer);
00085 
00086 
00087 
00088 
00089 VL53L1_Error VL53L1_i2c_decode_static_nvm_managed(
00090     uint16_t                   buf_size,
00091     uint8_t                   *pbuffer,
00092     VL53L1_static_nvm_managed_t  *pdata);
00093 
00094 
00095 
00096 
00097 VL53L1_Error VL53L1_set_static_nvm_managed(
00098     VL53L1_DEV                 Dev,
00099     VL53L1_static_nvm_managed_t  *pdata);
00100 
00101 
00102 
00103 
00104 VL53L1_Error VL53L1_get_static_nvm_managed(
00105     VL53L1_DEV                 Dev,
00106     VL53L1_static_nvm_managed_t  *pdata);
00107 
00108 
00109 
00110 
00111 VL53L1_Error VL53L1_i2c_encode_customer_nvm_managed(
00112     VL53L1_customer_nvm_managed_t  *pdata,
00113     uint16_t                   buf_size,
00114     uint8_t                   *pbuffer);
00115 
00116 
00117 
00118 
00119 VL53L1_Error VL53L1_i2c_decode_customer_nvm_managed(
00120     uint16_t                   buf_size,
00121     uint8_t                   *pbuffer,
00122     VL53L1_customer_nvm_managed_t  *pdata);
00123 
00124 
00125 
00126 
00127 VL53L1_Error VL53L1_set_customer_nvm_managed(
00128     VL53L1_DEV                 Dev,
00129     VL53L1_customer_nvm_managed_t  *pdata);
00130 
00131 
00132 
00133 
00134 VL53L1_Error VL53L1_get_customer_nvm_managed(
00135     VL53L1_DEV                 Dev,
00136     VL53L1_customer_nvm_managed_t  *pdata);
00137 
00138 
00139 
00140 
00141 VL53L1_Error VL53L1_i2c_encode_static_config(
00142     VL53L1_static_config_t    *pdata,
00143     uint16_t                   buf_size,
00144     uint8_t                   *pbuffer);
00145 
00146 
00147 
00148 
00149 VL53L1_Error VL53L1_i2c_decode_static_config(
00150     uint16_t                   buf_size,
00151     uint8_t                   *pbuffer,
00152     VL53L1_static_config_t    *pdata);
00153 
00154 
00155 
00156 
00157 VL53L1_Error VL53L1_set_static_config(
00158     VL53L1_DEV                 Dev,
00159     VL53L1_static_config_t    *pdata);
00160 
00161 
00162 
00163 
00164 VL53L1_Error VL53L1_get_static_config(
00165     VL53L1_DEV                 Dev,
00166     VL53L1_static_config_t    *pdata);
00167 
00168 
00169 
00170 
00171 VL53L1_Error VL53L1_i2c_encode_general_config(
00172     VL53L1_general_config_t   *pdata,
00173     uint16_t                   buf_size,
00174     uint8_t                   *pbuffer);
00175 
00176 
00177 
00178 
00179 VL53L1_Error VL53L1_i2c_decode_general_config(
00180     uint16_t                   buf_size,
00181     uint8_t                   *pbuffer,
00182     VL53L1_general_config_t   *pdata);
00183 
00184 
00185 
00186 
00187 VL53L1_Error VL53L1_set_general_config(
00188     VL53L1_DEV                 Dev,
00189     VL53L1_general_config_t   *pdata);
00190 
00191 
00192 
00193 
00194 VL53L1_Error VL53L1_get_general_config(
00195     VL53L1_DEV                 Dev,
00196     VL53L1_general_config_t   *pdata);
00197 
00198 
00199 
00200 
00201 VL53L1_Error VL53L1_i2c_encode_timing_config(
00202     VL53L1_timing_config_t    *pdata,
00203     uint16_t                   buf_size,
00204     uint8_t                   *pbuffer);
00205 
00206 
00207 
00208 
00209 VL53L1_Error VL53L1_i2c_decode_timing_config(
00210     uint16_t                   buf_size,
00211     uint8_t                   *pbuffer,
00212     VL53L1_timing_config_t    *pdata);
00213 
00214 
00215 
00216 
00217 VL53L1_Error VL53L1_set_timing_config(
00218     VL53L1_DEV                 Dev,
00219     VL53L1_timing_config_t    *pdata);
00220 
00221 
00222 
00223 
00224 VL53L1_Error VL53L1_get_timing_config(
00225     VL53L1_DEV                 Dev,
00226     VL53L1_timing_config_t    *pdata);
00227 
00228 
00229 
00230 
00231 VL53L1_Error VL53L1_i2c_encode_dynamic_config(
00232     VL53L1_dynamic_config_t   *pdata,
00233     uint16_t                   buf_size,
00234     uint8_t                   *pbuffer);
00235 
00236 
00237 
00238 
00239 VL53L1_Error VL53L1_i2c_decode_dynamic_config(
00240     uint16_t                   buf_size,
00241     uint8_t                   *pbuffer,
00242     VL53L1_dynamic_config_t   *pdata);
00243 
00244 
00245 
00246 
00247 VL53L1_Error VL53L1_set_dynamic_config(
00248     VL53L1_DEV                 Dev,
00249     VL53L1_dynamic_config_t   *pdata);
00250 
00251 
00252 
00253 
00254 VL53L1_Error VL53L1_get_dynamic_config(
00255     VL53L1_DEV                 Dev,
00256     VL53L1_dynamic_config_t   *pdata);
00257 
00258 
00259 
00260 
00261 VL53L1_Error VL53L1_i2c_encode_system_control(
00262     VL53L1_system_control_t   *pdata,
00263     uint16_t                   buf_size,
00264     uint8_t                   *pbuffer);
00265 
00266 
00267 
00268 
00269 VL53L1_Error VL53L1_i2c_decode_system_control(
00270     uint16_t                   buf_size,
00271     uint8_t                   *pbuffer,
00272     VL53L1_system_control_t   *pdata);
00273 
00274 
00275 
00276 
00277 VL53L1_Error VL53L1_set_system_control(
00278     VL53L1_DEV                 Dev,
00279     VL53L1_system_control_t   *pdata);
00280 
00281 
00282 
00283 
00284 VL53L1_Error VL53L1_get_system_control(
00285     VL53L1_DEV                 Dev,
00286     VL53L1_system_control_t   *pdata);
00287 
00288 
00289 
00290 
00291 VL53L1_Error VL53L1_i2c_encode_system_results(
00292     VL53L1_system_results_t   *pdata,
00293     uint16_t                   buf_size,
00294     uint8_t                   *pbuffer);
00295 
00296 
00297 
00298 
00299 VL53L1_Error VL53L1_i2c_decode_system_results(
00300     uint16_t                   buf_size,
00301     uint8_t                   *pbuffer,
00302     VL53L1_system_results_t   *pdata);
00303 
00304 
00305 
00306 
00307 VL53L1_Error VL53L1_set_system_results(
00308     VL53L1_DEV                 Dev,
00309     VL53L1_system_results_t   *pdata);
00310 
00311 
00312 
00313 
00314 VL53L1_Error VL53L1_get_system_results(
00315     VL53L1_DEV                 Dev,
00316     VL53L1_system_results_t   *pdata);
00317 
00318 
00319 
00320 
00321 VL53L1_Error VL53L1_i2c_encode_core_results(
00322     VL53L1_core_results_t     *pdata,
00323     uint16_t                   buf_size,
00324     uint8_t                   *pbuffer);
00325 
00326 
00327 
00328 
00329 VL53L1_Error VL53L1_i2c_decode_core_results(
00330     uint16_t                   buf_size,
00331     uint8_t                   *pbuffer,
00332     VL53L1_core_results_t     *pdata);
00333 
00334 
00335 
00336 
00337 VL53L1_Error VL53L1_set_core_results(
00338     VL53L1_DEV                 Dev,
00339     VL53L1_core_results_t     *pdata);
00340 
00341 
00342 
00343 
00344 VL53L1_Error VL53L1_get_core_results(
00345     VL53L1_DEV                 Dev,
00346     VL53L1_core_results_t     *pdata);
00347 
00348 
00349 
00350 
00351 VL53L1_Error VL53L1_i2c_encode_debug_results(
00352     VL53L1_debug_results_t    *pdata,
00353     uint16_t                   buf_size,
00354     uint8_t                   *pbuffer);
00355 
00356 
00357 
00358 
00359 VL53L1_Error VL53L1_i2c_decode_debug_results(
00360     uint16_t                   buf_size,
00361     uint8_t                   *pbuffer,
00362     VL53L1_debug_results_t    *pdata);
00363 
00364 
00365 
00366 
00367 VL53L1_Error VL53L1_set_debug_results(
00368     VL53L1_DEV                 Dev,
00369     VL53L1_debug_results_t    *pdata);
00370 
00371 
00372 
00373 
00374 VL53L1_Error VL53L1_get_debug_results(
00375     VL53L1_DEV                 Dev,
00376     VL53L1_debug_results_t    *pdata);
00377 
00378 
00379 
00380 
00381 VL53L1_Error VL53L1_i2c_encode_nvm_copy_data(
00382     VL53L1_nvm_copy_data_t    *pdata,
00383     uint16_t                   buf_size,
00384     uint8_t                   *pbuffer);
00385 
00386 
00387 
00388 
00389 VL53L1_Error VL53L1_i2c_decode_nvm_copy_data(
00390     uint16_t                   buf_size,
00391     uint8_t                   *pbuffer,
00392     VL53L1_nvm_copy_data_t    *pdata);
00393 
00394 
00395 
00396 
00397 VL53L1_Error VL53L1_set_nvm_copy_data(
00398     VL53L1_DEV                 Dev,
00399     VL53L1_nvm_copy_data_t    *pdata);
00400 
00401 
00402 
00403 
00404 VL53L1_Error VL53L1_get_nvm_copy_data(
00405     VL53L1_DEV                 Dev,
00406     VL53L1_nvm_copy_data_t    *pdata);
00407 
00408 
00409 
00410 
00411 VL53L1_Error VL53L1_i2c_encode_prev_shadow_system_results(
00412     VL53L1_prev_shadow_system_results_t  *pdata,
00413     uint16_t                   buf_size,
00414     uint8_t                   *pbuffer);
00415 
00416 
00417 
00418 
00419 VL53L1_Error VL53L1_i2c_decode_prev_shadow_system_results(
00420     uint16_t                   buf_size,
00421     uint8_t                   *pbuffer,
00422     VL53L1_prev_shadow_system_results_t  *pdata);
00423 
00424 
00425 
00426 
00427 VL53L1_Error VL53L1_set_prev_shadow_system_results(
00428     VL53L1_DEV                 Dev,
00429     VL53L1_prev_shadow_system_results_t  *pdata);
00430 
00431 
00432 
00433 
00434 VL53L1_Error VL53L1_get_prev_shadow_system_results(
00435     VL53L1_DEV                 Dev,
00436     VL53L1_prev_shadow_system_results_t  *pdata);
00437 
00438 
00439 
00440 
00441 VL53L1_Error VL53L1_i2c_encode_prev_shadow_core_results(
00442     VL53L1_prev_shadow_core_results_t  *pdata,
00443     uint16_t                   buf_size,
00444     uint8_t                   *pbuffer);
00445 
00446 
00447 
00448 
00449 VL53L1_Error VL53L1_i2c_decode_prev_shadow_core_results(
00450     uint16_t                   buf_size,
00451     uint8_t                   *pbuffer,
00452     VL53L1_prev_shadow_core_results_t  *pdata);
00453 
00454 
00455 
00456 
00457 VL53L1_Error VL53L1_set_prev_shadow_core_results(
00458     VL53L1_DEV                 Dev,
00459     VL53L1_prev_shadow_core_results_t  *pdata);
00460 
00461 
00462 
00463 
00464 VL53L1_Error VL53L1_get_prev_shadow_core_results(
00465     VL53L1_DEV                 Dev,
00466     VL53L1_prev_shadow_core_results_t  *pdata);
00467 
00468 
00469 
00470 
00471 VL53L1_Error VL53L1_i2c_encode_patch_debug(
00472     VL53L1_patch_debug_t      *pdata,
00473     uint16_t                   buf_size,
00474     uint8_t                   *pbuffer);
00475 
00476 
00477 
00478 
00479 VL53L1_Error VL53L1_i2c_decode_patch_debug(
00480     uint16_t                   buf_size,
00481     uint8_t                   *pbuffer,
00482     VL53L1_patch_debug_t      *pdata);
00483 
00484 
00485 
00486 
00487 VL53L1_Error VL53L1_set_patch_debug(
00488     VL53L1_DEV                 Dev,
00489     VL53L1_patch_debug_t      *pdata);
00490 
00491 
00492 
00493 
00494 VL53L1_Error VL53L1_get_patch_debug(
00495     VL53L1_DEV                 Dev,
00496     VL53L1_patch_debug_t      *pdata);
00497 
00498 
00499 
00500 
00501 VL53L1_Error VL53L1_i2c_encode_gph_general_config(
00502     VL53L1_gph_general_config_t  *pdata,
00503     uint16_t                   buf_size,
00504     uint8_t                   *pbuffer);
00505 
00506 
00507 
00508 
00509 VL53L1_Error VL53L1_i2c_decode_gph_general_config(
00510     uint16_t                   buf_size,
00511     uint8_t                   *pbuffer,
00512     VL53L1_gph_general_config_t  *pdata);
00513 
00514 
00515 
00516 
00517 VL53L1_Error VL53L1_set_gph_general_config(
00518     VL53L1_DEV                 Dev,
00519     VL53L1_gph_general_config_t  *pdata);
00520 
00521 
00522 
00523 
00524 VL53L1_Error VL53L1_get_gph_general_config(
00525     VL53L1_DEV                 Dev,
00526     VL53L1_gph_general_config_t  *pdata);
00527 
00528 
00529 
00530 
00531 VL53L1_Error VL53L1_i2c_encode_gph_static_config(
00532     VL53L1_gph_static_config_t  *pdata,
00533     uint16_t                   buf_size,
00534     uint8_t                   *pbuffer);
00535 
00536 
00537 
00538 
00539 VL53L1_Error VL53L1_i2c_decode_gph_static_config(
00540     uint16_t                   buf_size,
00541     uint8_t                   *pbuffer,
00542     VL53L1_gph_static_config_t  *pdata);
00543 
00544 
00545 
00546 
00547 VL53L1_Error VL53L1_set_gph_static_config(
00548     VL53L1_DEV                 Dev,
00549     VL53L1_gph_static_config_t  *pdata);
00550 
00551 
00552 
00553 
00554 VL53L1_Error VL53L1_get_gph_static_config(
00555     VL53L1_DEV                 Dev,
00556     VL53L1_gph_static_config_t  *pdata);
00557 
00558 
00559 
00560 
00561 VL53L1_Error VL53L1_i2c_encode_gph_timing_config(
00562     VL53L1_gph_timing_config_t  *pdata,
00563     uint16_t                   buf_size,
00564     uint8_t                   *pbuffer);
00565 
00566 
00567 
00568 
00569 VL53L1_Error VL53L1_i2c_decode_gph_timing_config(
00570     uint16_t                   buf_size,
00571     uint8_t                   *pbuffer,
00572     VL53L1_gph_timing_config_t  *pdata);
00573 
00574 
00575 
00576 
00577 VL53L1_Error VL53L1_set_gph_timing_config(
00578     VL53L1_DEV                 Dev,
00579     VL53L1_gph_timing_config_t  *pdata);
00580 
00581 
00582 
00583 
00584 VL53L1_Error VL53L1_get_gph_timing_config(
00585     VL53L1_DEV                 Dev,
00586     VL53L1_gph_timing_config_t  *pdata);
00587 
00588 
00589 
00590 
00591 VL53L1_Error VL53L1_i2c_encode_fw_internal(
00592     VL53L1_fw_internal_t      *pdata,
00593     uint16_t                   buf_size,
00594     uint8_t                   *pbuffer);
00595 
00596 
00597 
00598 
00599 VL53L1_Error VL53L1_i2c_decode_fw_internal(
00600     uint16_t                   buf_size,
00601     uint8_t                   *pbuffer,
00602     VL53L1_fw_internal_t      *pdata);
00603 
00604 
00605 
00606 
00607 VL53L1_Error VL53L1_set_fw_internal(
00608     VL53L1_DEV                 Dev,
00609     VL53L1_fw_internal_t      *pdata);
00610 
00611 
00612 
00613 
00614 VL53L1_Error VL53L1_get_fw_internal(
00615     VL53L1_DEV                 Dev,
00616     VL53L1_fw_internal_t      *pdata);
00617 
00618 
00619 
00620 
00621 VL53L1_Error VL53L1_i2c_encode_patch_results(
00622     VL53L1_patch_results_t    *pdata,
00623     uint16_t                   buf_size,
00624     uint8_t                   *pbuffer);
00625 
00626 
00627 
00628 
00629 VL53L1_Error VL53L1_i2c_decode_patch_results(
00630     uint16_t                   buf_size,
00631     uint8_t                   *pbuffer,
00632     VL53L1_patch_results_t    *pdata);
00633 
00634 
00635 
00636 
00637 VL53L1_Error VL53L1_set_patch_results(
00638     VL53L1_DEV                 Dev,
00639     VL53L1_patch_results_t    *pdata);
00640 
00641 
00642 
00643 
00644 VL53L1_Error VL53L1_get_patch_results(
00645     VL53L1_DEV                 Dev,
00646     VL53L1_patch_results_t    *pdata);
00647 
00648 
00649 
00650 
00651 VL53L1_Error VL53L1_i2c_encode_shadow_system_results(
00652     VL53L1_shadow_system_results_t  *pdata,
00653     uint16_t                   buf_size,
00654     uint8_t                   *pbuffer);
00655 
00656 
00657 
00658 
00659 VL53L1_Error VL53L1_i2c_decode_shadow_system_results(
00660     uint16_t                   buf_size,
00661     uint8_t                   *pbuffer,
00662     VL53L1_shadow_system_results_t  *pdata);
00663 
00664 
00665 
00666 
00667 VL53L1_Error VL53L1_set_shadow_system_results(
00668     VL53L1_DEV                 Dev,
00669     VL53L1_shadow_system_results_t  *pdata);
00670 
00671 
00672 
00673 
00674 VL53L1_Error VL53L1_get_shadow_system_results(
00675     VL53L1_DEV                 Dev,
00676     VL53L1_shadow_system_results_t  *pdata);
00677 
00678 
00679 
00680 
00681 VL53L1_Error VL53L1_i2c_encode_shadow_core_results(
00682     VL53L1_shadow_core_results_t  *pdata,
00683     uint16_t                   buf_size,
00684     uint8_t                   *pbuffer);
00685 
00686 
00687 
00688 
00689 VL53L1_Error VL53L1_i2c_decode_shadow_core_results(
00690     uint16_t                   buf_size,
00691     uint8_t                   *pbuffer,
00692     VL53L1_shadow_core_results_t  *pdata);
00693 
00694 
00695 
00696 
00697 VL53L1_Error VL53L1_set_shadow_core_results(
00698     VL53L1_DEV                 Dev,
00699     VL53L1_shadow_core_results_t  *pdata);
00700 
00701 
00702 
00703 
00704 VL53L1_Error VL53L1_get_shadow_core_results(
00705     VL53L1_DEV                 Dev,
00706     VL53L1_shadow_core_results_t  *pdata);
00707 
00708 
00709 #ifdef __cplusplus
00710 }
00711 #endif
00712 
00713 #endif
00714 
00715 
00716