vl53l1_wait.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_WAIT_H_
00069 #define _VL53L1_WAIT_H_
00070 
00071 #include "vl53l1_platform.h"
00072 
00073 #ifdef __cplusplus
00074 extern "C" {
00075 #endif
00076 
00077 
00078 
00079 
00080 VL53L1_Error VL53L1_wait_for_boot_completion(
00081     VL53L1_DEV      Dev);
00082 
00083 
00084 
00085 
00086 VL53L1_Error VL53L1_wait_for_firmware_ready(
00087     VL53L1_DEV      Dev);
00088 
00089 
00090 
00091 
00092 VL53L1_Error VL53L1_wait_for_range_completion(
00093     VL53L1_DEV   Dev);
00094 
00095 
00096 
00097 
00098 VL53L1_Error VL53L1_wait_for_test_completion(
00099     VL53L1_DEV   Dev);
00100 
00101 
00102 
00103 
00104 
00105 
00106 VL53L1_Error VL53L1_is_boot_complete(
00107     VL53L1_DEV      Dev,
00108     uint8_t        *pready);
00109 
00110 
00111 
00112 VL53L1_Error VL53L1_is_firmware_ready(
00113     VL53L1_DEV      Dev,
00114     uint8_t        *pready);
00115 
00116 
00117 
00118 
00119 VL53L1_Error VL53L1_is_new_data_ready(
00120     VL53L1_DEV      Dev,
00121     uint8_t        *pready);
00122 
00123 
00124 
00125 
00126 
00127 
00128 VL53L1_Error VL53L1_poll_for_boot_completion(
00129     VL53L1_DEV      Dev,
00130     uint32_t        timeout_ms);
00131 
00132 
00133 
00134 
00135 VL53L1_Error VL53L1_poll_for_firmware_ready(
00136     VL53L1_DEV      Dev,
00137     uint32_t        timeout_ms);
00138 
00139 
00140 
00141 
00142 VL53L1_Error VL53L1_poll_for_range_completion(
00143     VL53L1_DEV   Dev,
00144     uint32_t     timeout_ms);
00145 
00146 
00147 
00148 #ifdef __cplusplus
00149 }
00150 #endif
00151 
00152 #endif
00153 
00154