ST Expansion SW Team / VL53L1CB

The VL53L1CB proximity sensor, based on ST’s FlightSense™, Time-of-Flight technology.

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

Dependents:   VL53L1CB_noshield_1sensor_polls_auton VL53L1CB_noshield_1sensor_interrupt_auton X_NUCLEO_53L1A2

Based on VL53L1 library, this is a library for the VL53L1CB ToF chip.

src/vl53l1_silicon_core.c@0:3ac96e360672, 2020-11-06 (annotated)

Committer:
charlesmn
Date:
Fri Nov 06 10:06:37 2020 +0000
Revision:
0:3ac96e360672
Child:
7:1add29d51e72
Library for ST Vl53L1A1 time of flight sensor.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
charlesmn 0:3ac96e360672 1
charlesmn 0:3ac96e360672 2 /*******************************************************************************
charlesmn 0:3ac96e360672 3 * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
charlesmn 0:3ac96e360672 4
charlesmn 0:3ac96e360672 5 This file is part of VL53L1 Core and is dual licensed,
charlesmn 0:3ac96e360672 6 either 'STMicroelectronics
charlesmn 0:3ac96e360672 7 Proprietary license'
charlesmn 0:3ac96e360672 8 or 'BSD 3-clause "New" or "Revised" License' , at your option.
charlesmn 0:3ac96e360672 9
charlesmn 0:3ac96e360672 10 ********************************************************************************
charlesmn 0:3ac96e360672 11
charlesmn 0:3ac96e360672 12 'STMicroelectronics Proprietary license'
charlesmn 0:3ac96e360672 13
charlesmn 0:3ac96e360672 14 ********************************************************************************
charlesmn 0:3ac96e360672 15
charlesmn 0:3ac96e360672 16 License terms: STMicroelectronics Proprietary in accordance with licensing
charlesmn 0:3ac96e360672 17 terms at www.st.com/sla0081
charlesmn 0:3ac96e360672 18
charlesmn 0:3ac96e360672 19 STMicroelectronics confidential
charlesmn 0:3ac96e360672 20 Reproduction and Communication of this document is strictly prohibited unless
charlesmn 0:3ac96e360672 21 specifically authorized in writing by STMicroelectronics.
charlesmn 0:3ac96e360672 22
charlesmn 0:3ac96e360672 23
charlesmn 0:3ac96e360672 24 ********************************************************************************
charlesmn 0:3ac96e360672 25
charlesmn 0:3ac96e360672 26 Alternatively, VL53L1 Core may be distributed under the terms of
charlesmn 0:3ac96e360672 27 'BSD 3-clause "New" or "Revised" License', in which case the following
charlesmn 0:3ac96e360672 28 provisions apply instead of the ones
charlesmn 0:3ac96e360672 29 mentioned above :
charlesmn 0:3ac96e360672 30
charlesmn 0:3ac96e360672 31 ********************************************************************************
charlesmn 0:3ac96e360672 32
charlesmn 0:3ac96e360672 33 License terms: BSD 3-clause "New" or "Revised" License.
charlesmn 0:3ac96e360672 34
charlesmn 0:3ac96e360672 35 Redistribution and use in source and binary forms, with or without
charlesmn 0:3ac96e360672 36 modification, are permitted provided that the following conditions are met:
charlesmn 0:3ac96e360672 37
charlesmn 0:3ac96e360672 38 1. Redistributions of source code must retain the above copyright notice, this
charlesmn 0:3ac96e360672 39 list of conditions and the following disclaimer.
charlesmn 0:3ac96e360672 40
charlesmn 0:3ac96e360672 41 2. Redistributions in binary form must reproduce the above copyright notice,
charlesmn 0:3ac96e360672 42 this list of conditions and the following disclaimer in the documentation
charlesmn 0:3ac96e360672 43 and/or other materials provided with the distribution.
charlesmn 0:3ac96e360672 44
charlesmn 0:3ac96e360672 45 3. Neither the name of the copyright holder nor the names of its contributors
charlesmn 0:3ac96e360672 46 may be used to endorse or promote products derived from this software
charlesmn 0:3ac96e360672 47 without specific prior written permission.
charlesmn 0:3ac96e360672 48
charlesmn 0:3ac96e360672 49 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
charlesmn 0:3ac96e360672 50 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
charlesmn 0:3ac96e360672 51 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
charlesmn 0:3ac96e360672 52 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
charlesmn 0:3ac96e360672 53 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
charlesmn 0:3ac96e360672 54 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
charlesmn 0:3ac96e360672 55 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
charlesmn 0:3ac96e360672 56 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
charlesmn 0:3ac96e360672 57 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
charlesmn 0:3ac96e360672 58 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
charlesmn 0:3ac96e360672 59
charlesmn 0:3ac96e360672 60
charlesmn 0:3ac96e360672 61 ********************************************************************************
charlesmn 0:3ac96e360672 62
charlesmn 0:3ac96e360672 63 */
charlesmn 0:3ac96e360672 64
charlesmn 0:3ac96e360672 65
charlesmn 0:3ac96e360672 66
charlesmn 0:3ac96e360672 67
charlesmn 0:3ac96e360672 68
charlesmn 0:3ac96e360672 69 #include "vl53l1_ll_def.h"
charlesmn 0:3ac96e360672 70 #include "vl53l1_platform.h"
charlesmn 0:3ac96e360672 71 #include "vl53l1_register_map.h"
charlesmn 0:3ac96e360672 72 #include "vl53l1_core.h"
charlesmn 0:3ac96e360672 73 #include "vl53l1_silicon_core.h"
charlesmn 0:3ac96e360672 74
charlesmn 0:3ac96e360672 75
charlesmn 0:3ac96e360672 76 #define LOG_FUNCTION_START(fmt, ...) \
charlesmn 0:3ac96e360672 77 _LOG_FUNCTION_START(VL53L1_TRACE_MODULE_CORE, fmt, ##__VA_ARGS__)
charlesmn 0:3ac96e360672 78 #define LOG_FUNCTION_END(status, ...) \
charlesmn 0:3ac96e360672 79 _LOG_FUNCTION_END(VL53L1_TRACE_MODULE_CORE, status, ##__VA_ARGS__)
charlesmn 0:3ac96e360672 80 #define LOG_FUNCTION_END_FMT(status, fmt, ...) \
charlesmn 0:3ac96e360672 81 _LOG_FUNCTION_END_FMT(VL53L1_TRACE_MODULE_CORE,\
charlesmn 0:3ac96e360672 82 status, fmt, ##__VA_ARGS__)
charlesmn 0:3ac96e360672 83
charlesmn 0:3ac96e360672 84
charlesmn 0:3ac96e360672 85 VL53L1_Error VL53L1_is_firmware_ready_silicon(
charlesmn 0:3ac96e360672 86 VL53L1_DEV Dev,
charlesmn 0:3ac96e360672 87 uint8_t *pready)
charlesmn 0:3ac96e360672 88 {
charlesmn 0:3ac96e360672 89
charlesmn 0:3ac96e360672 90
charlesmn 0:3ac96e360672 91 VL53L1_Error status = VL53L1_ERROR_NONE;
charlesmn 0:3ac96e360672 92 VL53L1_LLDriverData_t *pdev = VL53L1DevStructGetLLDriverHandle(Dev);
charlesmn 0:3ac96e360672 93
charlesmn 0:3ac96e360672 94 uint8_t comms_buffer[5];
charlesmn 0:3ac96e360672 95
charlesmn 0:3ac96e360672 96 LOG_FUNCTION_START("");
charlesmn 0:3ac96e360672 97
charlesmn 0:3ac96e360672 98
charlesmn 0:3ac96e360672 99
charlesmn 0:3ac96e360672 100 status = VL53L1_ReadMulti(
charlesmn 0:3ac96e360672 101 Dev,
charlesmn 0:3ac96e360672 102 VL53L1_INTERRUPT_MANAGER__ENABLES,
charlesmn 0:3ac96e360672 103 comms_buffer,
charlesmn 0:3ac96e360672 104 5);
charlesmn 0:3ac96e360672 105
charlesmn 0:3ac96e360672 106 if (status != VL53L1_ERROR_NONE)
charlesmn 0:3ac96e360672 107 goto ENDFUNC;
charlesmn 0:3ac96e360672 108
charlesmn 0:3ac96e360672 109 pdev->dbg_results.interrupt_manager__enables =
charlesmn 0:3ac96e360672 110 comms_buffer[0];
charlesmn 0:3ac96e360672 111 pdev->dbg_results.interrupt_manager__clear =
charlesmn 0:3ac96e360672 112 comms_buffer[1];
charlesmn 0:3ac96e360672 113 pdev->dbg_results.interrupt_manager__status =
charlesmn 0:3ac96e360672 114 comms_buffer[2];
charlesmn 0:3ac96e360672 115 pdev->dbg_results.mcu_to_host_bank__wr_access_en =
charlesmn 0:3ac96e360672 116 comms_buffer[3];
charlesmn 0:3ac96e360672 117 pdev->dbg_results.power_management__go1_reset_status =
charlesmn 0:3ac96e360672 118 comms_buffer[4];
charlesmn 0:3ac96e360672 119
charlesmn 0:3ac96e360672 120 if ((pdev->sys_ctrl.power_management__go1_power_force & 0x01)
charlesmn 0:3ac96e360672 121 == 0x01) {
charlesmn 0:3ac96e360672 122
charlesmn 0:3ac96e360672 123 if (((pdev->dbg_results.interrupt_manager__enables &
charlesmn 0:3ac96e360672 124 0x1F) == 0x1F) &&
charlesmn 0:3ac96e360672 125 ((pdev->dbg_results.interrupt_manager__clear
charlesmn 0:3ac96e360672 126 & 0x1F) == 0x1F))
charlesmn 0:3ac96e360672 127 *pready = 0x01;
charlesmn 0:3ac96e360672 128 else
charlesmn 0:3ac96e360672 129 *pready = 0x00;
charlesmn 0:3ac96e360672 130
charlesmn 0:3ac96e360672 131 } else {
charlesmn 0:3ac96e360672 132
charlesmn 0:3ac96e360672 133
charlesmn 0:3ac96e360672 134 if ((pdev->dbg_results.power_management__go1_reset_status
charlesmn 0:3ac96e360672 135 & 0x01) == 0x00)
charlesmn 0:3ac96e360672 136 *pready = 0x01;
charlesmn 0:3ac96e360672 137 else
charlesmn 0:3ac96e360672 138 *pready = 0x00;
charlesmn 0:3ac96e360672 139 }
charlesmn 0:3ac96e360672 140
charlesmn 0:3ac96e360672 141
charlesmn 0:3ac96e360672 142 ENDFUNC:
charlesmn 0:3ac96e360672 143 LOG_FUNCTION_END(status);
charlesmn 0:3ac96e360672 144
charlesmn 0:3ac96e360672 145 return status;
charlesmn 0:3ac96e360672 146 }
charlesmn 0:3ac96e360672 147
charlesmn 0:3ac96e360672 148