vl53l1_silicon_core.c

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 #include "vl53l1_ll_def.h"
00070 #include "vl53l1_platform.h"
00071 #include "vl53l1_register_map.h"
00072 #include "vl53l1_core.h"
00073 #include "vl53l1_silicon_core.h"
00074 
00075 
00076 #define LOG_FUNCTION_START(fmt, ...) \
00077     _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_CORE, fmt, ##__VA_ARGS__)
00078 #define LOG_FUNCTION_END(status, ...) \
00079     _LOG_FUNCTION_END(VL53L1_TRACE_MODULE_CORE, status, ##__VA_ARGS__)
00080 #define LOG_FUNCTION_END_FMT(status, fmt, ...) \
00081     _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_CORE,\
00082             status, fmt, ##__VA_ARGS__)
00083 
00084 
00085 VL53L1_Error VL53L1_is_firmware_ready_silicon(
00086     VL53L1_DEV     Dev,
00087     uint8_t       *pready)
00088 {
00089 
00090 
00091     VL53L1_Error status = VL53L1_ERROR_NONE;
00092     VL53L1_LLDriverData_t *pdev = VL53L1DevStructGetLLDriverHandle(Dev);
00093 
00094     uint8_t  comms_buffer[5];
00095 
00096     LOG_FUNCTION_START("");
00097 
00098 
00099 
00100     status = VL53L1_ReadMulti(
00101                 Dev,
00102                 VL53L1_INTERRUPT_MANAGER__ENABLES,
00103                 comms_buffer,
00104                 5);
00105 
00106     if (status != VL53L1_ERROR_NONE)
00107         goto ENDFUNC;
00108 
00109     pdev->dbg_results.interrupt_manager__enables =
00110             comms_buffer[0];
00111     pdev->dbg_results.interrupt_manager__clear =
00112             comms_buffer[1];
00113     pdev->dbg_results.interrupt_manager__status =
00114             comms_buffer[2];
00115     pdev->dbg_results.mcu_to_host_bank__wr_access_en =
00116             comms_buffer[3];
00117     pdev->dbg_results.power_management__go1_reset_status =
00118             comms_buffer[4];
00119 
00120     if ((pdev->sys_ctrl.power_management__go1_power_force & 0x01)
00121             == 0x01) {
00122 
00123         if (((pdev->dbg_results.interrupt_manager__enables &
00124                 0x1F) == 0x1F) &&
00125             ((pdev->dbg_results.interrupt_manager__clear
00126                     & 0x1F) == 0x1F))
00127             *pready = 0x01;
00128         else
00129             *pready = 0x00;
00130 
00131     } else {
00132 
00133 
00134         if ((pdev->dbg_results.power_management__go1_reset_status
00135                 & 0x01) == 0x00)
00136             *pready = 0x01;
00137         else
00138             *pready = 0x00;
00139     }
00140 
00141 
00142 ENDFUNC:
00143     LOG_FUNCTION_END(status);
00144 
00145     return status;
00146 }
00147 
00148