vl53l1_error_strings.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 
00069 #ifndef VL53L1_ERROR_STRINGS_H_
00070 #define VL53L1_ERROR_STRINGS_H_
00071 
00072 #include "vl53l1_error_codes.h"
00073 
00074 #ifdef __cplusplus
00075 extern "C" {
00076 #endif
00077 
00078 
00079 
00080 
00081 VL53L1_Error VL53L1_get_pal_error_string(
00082     VL53L1_Error   PalErrorCode,
00083     char         *pPalErrorString);
00084 
00085 
00086 #ifndef VL53L1_USE_EMPTY_STRING
00087 
00088 
00089     #define  VL53L1_STRING_ERROR_NONE \
00090             "No Error"
00091     #define  VL53L1_STRING_ERROR_CALIBRATION_WARNING \
00092             "Calibration Warning Error"
00093     #define  VL53L1_STRING_ERROR_MIN_CLIPPED \
00094             "Min clipped error"
00095     #define  VL53L1_STRING_ERROR_UNDEFINED \
00096             "Undefined error"
00097     #define  VL53L1_STRING_ERROR_INVALID_PARAMS \
00098             "Invalid parameters error"
00099     #define  VL53L1_STRING_ERROR_NOT_SUPPORTED \
00100             "Not supported error"
00101     #define  VL53L1_STRING_ERROR_RANGE_ERROR \
00102             "Range error"
00103     #define  VL53L1_STRING_ERROR_TIME_OUT \
00104             "Time out error"
00105     #define  VL53L1_STRING_ERROR_MODE_NOT_SUPPORTED \
00106             "Mode not supported error"
00107     #define  VL53L1_STRING_ERROR_BUFFER_TOO_SMALL \
00108             "Buffer too small"
00109     #define  VL53L1_STRING_ERROR_COMMS_BUFFER_TOO_SMALL \
00110             "Comms Buffer too small"
00111     #define  VL53L1_STRING_ERROR_GPIO_NOT_EXISTING \
00112             "GPIO not existing"
00113     #define  VL53L1_STRING_ERROR_GPIO_FUNCTIONALITY_NOT_SUPPORTED \
00114             "GPIO funct not supported"
00115     #define  VL53L1_STRING_ERROR_CONTROL_INTERFACE \
00116             "Control Interface Error"
00117     #define  VL53L1_STRING_ERROR_INVALID_COMMAND \
00118             "Invalid Command Error"
00119     #define  VL53L1_STRING_ERROR_DIVISION_BY_ZERO \
00120             "Division by zero Error"
00121     #define  VL53L1_STRING_ERROR_REF_SPAD_INIT \
00122             "Reference Spad Init Error"
00123     #define  VL53L1_STRING_ERROR_GPH_SYNC_CHECK_FAIL \
00124             "GPH Sync Check Fail - API out of sync"
00125     #define  VL53L1_STRING_ERROR_STREAM_COUNT_CHECK_FAIL \
00126             "Stream Count Check Fail - API out of sync"
00127     #define  VL53L1_STRING_ERROR_GPH_ID_CHECK_FAIL \
00128             "GPH ID Check Fail - API out of sync"
00129     #define  VL53L1_STRING_ERROR_ZONE_STREAM_COUNT_CHECK_FAIL \
00130             "Zone Stream Count Check Fail - API out of sync"
00131     #define  VL53L1_STRING_ERROR_ZONE_GPH_ID_CHECK_FAIL \
00132             "Zone GPH ID Check Fail - API out of sync"
00133 
00134     #define  VL53L1_STRING_ERROR_XTALK_EXTRACTION_NO_SAMPLES_FAIL \
00135             "No Xtalk using full array - Xtalk Extract Fail"
00136     #define  VL53L1_STRING_ERROR_XTALK_EXTRACTION_SIGMA_LIMIT_FAIL \
00137             "Xtalk does not meet required VL53L1_p_011 limit - Xtalk Extract Fail"
00138 
00139     #define  VL53L1_STRING_ERROR_OFFSET_CAL_NO_SAMPLE_FAIL \
00140         "Offset Cal - one of more stages with no valid samples - fatal"
00141     #define  VL53L1_STRING_ERROR_OFFSET_CAL_NO_SPADS_ENABLED_FAIL \
00142         "Offset Cal - one of more stages with no SPADS enables - fatal"
00143     #define  VL53L1_STRING_ERROR_ZONE_CAL_NO_SAMPLE_FAIL \
00144         "Zone Cal - one of more zones with no valid samples - fatal"
00145 
00146     #define  VL53L1_STRING_WARNING_REF_SPAD_CHAR_NOT_ENOUGH_SPADS \
00147         "Ref SPAD Char - Not Enough Good SPADs"
00148     #define  VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_HIGH \
00149         "Ref SPAD Char - Final Ref Rate too high"
00150     #define  VL53L1_STRING_WARNING_REF_SPAD_CHAR_RATE_TOO_LOW \
00151         "Ref SPAD Char - Final Ref Rate too low"
00152 
00153     #define  VL53L1_STRING_WARNING_OFFSET_CAL_MISSING_SAMPLES \
00154         "Offset Cal - Less than the requested number of valid samples"
00155     #define  VL53L1_STRING_WARNING_OFFSET_CAL_SIGMA_TOO_HIGH \
00156         "Offset Cal - Sigma estimate value too high - offset not stable"
00157     #define  VL53L1_STRING_WARNING_OFFSET_CAL_RATE_TOO_HIGH \
00158         "Offset Cal - Rate too high - in pile up"
00159     #define  VL53L1_STRING_WARNING_OFFSET_CAL_SPAD_COUNT_TOO_LOW \
00160         "Offset Cal - Insufficient SPADs - offset may not be stable"
00161 
00162     #define  VL53L1_STRING_WARNING_ZONE_CAL_MISSING_SAMPLES \
00163         "Zone Cal - One or more zone with less than requested valid samples"
00164     #define  VL53L1_STRING_WARNING_ZONE_CAL_SIGMA_TOO_HIGH \
00165         "Zone Cal - One of more zones the VL53L1_p_011 estimate too high"
00166     #define  VL53L1_STRING_WARNING_ZONE_CAL_RATE_TOO_HIGH \
00167         "Zone Cal - One of more zones with rate too high - in pile up"
00168 
00169     #define  VL53L1_STRING_WARNING_XTALK_NO_SAMPLES_FOR_GRADIENT \
00170             "Xtalk - Gradient sample num = 0"
00171     #define  VL53L1_STRING_WARNING_XTALK_SIGMA_LIMIT_FOR_GRADIENT \
00172             "Xtalk - Gradient Sigma > Limit"
00173     #define  VL53L1_STRING_WARNING_XTALK_MISSING_SAMPLES \
00174             "Xtalk - Some missing and invalid samples"
00175 
00176     #define  VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_OLD \
00177             "Device Firmware too old"
00178     #define  VL53L1_STRING_ERROR_DEVICE_FIRMWARE_TOO_NEW \
00179             "Device Firmware too new"
00180     #define  VL53L1_STRING_ERROR_UNIT_TEST_FAIL \
00181             "Unit Test Fail"
00182     #define  VL53L1_STRING_ERROR_FILE_READ_FAIL \
00183             "File Read Fail"
00184     #define  VL53L1_STRING_ERROR_FILE_WRITE_FAIL \
00185             "File Write Fail"
00186 
00187     #define  VL53L1_STRING_ERROR_NOT_IMPLEMENTED \
00188             "Not implemented error"
00189     #define  VL53L1_STRING_UNKNOW_ERROR_CODE \
00190             "Unknown Error Code"
00191 
00192 #endif
00193 
00194 
00195 #ifdef __cplusplus
00196 }
00197 #endif
00198 
00199 #endif
00200 
00201 
00202