Diff: modules/vl53lx_wait.c

Revision:

5:89031b2f5316

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/modules/vl53lx_wait.c	Wed Jul 14 12:45:49 2021 +0100
@@ -0,0 +1,466 @@
+
+// SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
+/******************************************************************************
+ * Copyright (c) 2020, STMicroelectronics - All Rights Reserved
+
+ This file is part of VL53LX and is dual licensed,
+ either GPL-2.0+
+ or 'BSD 3-clause "New" or "Revised" License' , at your option.
+ ******************************************************************************
+ */
+
+
+
+
+
+#include "vl53lx_platform.h"
+#include "vl53lx_ll_def.h"
+#include "vl53lx_ll_device.h"
+#include "vl53lx_core.h"
+#include "vl53lx_silicon_core.h"
+#include "vl53lx_wait.h"
+#include "vl53lx_register_settings.h"
+
+
+#define LOG_FUNCTION_START(fmt, ...) \
+	_LOG_FUNCTION_START(VL53LX_TRACE_MODULE_CORE, fmt, ##__VA_ARGS__)
+#define LOG_FUNCTION_END(status, ...) \
+	_LOG_FUNCTION_END(VL53LX_TRACE_MODULE_CORE, status, ##__VA_ARGS__)
+#define LOG_FUNCTION_END_FMT(status, fmt, ...) \
+	_LOG_FUNCTION_END_FMT(VL53LX_TRACE_MODULE_CORE, status, \
+		fmt, ##__VA_ARGS__)
+
+
+VL53LX_Error VL53LX_wait_for_boot_completion(
+	VL53LX_DEV     Dev)
+{
+
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint8_t      fw_ready  = 0;
+
+	LOG_FUNCTION_START("");
+
+	if (pdev->wait_method == VL53LX_WAIT_METHOD_BLOCKING) {
+
+
+
+		status =
+			VL53LX_poll_for_boot_completion(
+				Dev,
+				VL53LX_BOOT_COMPLETION_POLLING_TIMEOUT_MS);
+
+	} else {
+
+
+
+		fw_ready = 0;
+		while (fw_ready == 0x00 && status == VL53LX_ERROR_NONE) {
+			status = VL53LX_is_boot_complete(
+				Dev,
+				&fw_ready);
+
+			if (status == VL53LX_ERROR_NONE) {
+				status = VL53LX_WaitMs(
+					Dev,
+					VL53LX_POLLING_DELAY_MS);
+			}
+		}
+	}
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+
+}
+
+
+VL53LX_Error VL53LX_wait_for_firmware_ready(
+	VL53LX_DEV     Dev)
+{
+
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint8_t      fw_ready  = 0;
+	uint8_t      mode_start  = 0;
+
+	LOG_FUNCTION_START("");
+
+
+	mode_start =
+		pdev->sys_ctrl.system__mode_start &
+		VL53LX_DEVICEMEASUREMENTMODE_MODE_MASK;
+
+
+
+	if ((mode_start == VL53LX_DEVICEMEASUREMENTMODE_TIMED) ||
+		(mode_start == VL53LX_DEVICEMEASUREMENTMODE_SINGLESHOT)) {
+
+		if (pdev->wait_method == VL53LX_WAIT_METHOD_BLOCKING) {
+
+
+
+			status =
+			VL53LX_poll_for_firmware_ready(
+				Dev,
+				VL53LX_RANGE_COMPLETION_POLLING_TIMEOUT_MS);
+
+		} else {
+
+
+
+			fw_ready = 0;
+			while (fw_ready == 0x00 && status ==
+					VL53LX_ERROR_NONE) {
+				status = VL53LX_is_firmware_ready(
+					Dev,
+					&fw_ready);
+
+				if (status == VL53LX_ERROR_NONE) {
+					status = VL53LX_WaitMs(
+						Dev,
+						VL53LX_POLLING_DELAY_MS);
+				}
+			}
+		}
+	}
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+VL53LX_Error VL53LX_wait_for_range_completion(
+	VL53LX_DEV     Dev)
+{
+
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint8_t      data_ready  = 0;
+
+	LOG_FUNCTION_START("");
+
+	if (pdev->wait_method == VL53LX_WAIT_METHOD_BLOCKING) {
+
+
+
+		status =
+			VL53LX_poll_for_range_completion(
+				Dev,
+				VL53LX_RANGE_COMPLETION_POLLING_TIMEOUT_MS);
+
+	} else {
+
+
+
+		data_ready = 0;
+		while (data_ready == 0x00 && status == VL53LX_ERROR_NONE) {
+			status = VL53LX_is_new_data_ready(
+				Dev,
+				&data_ready);
+
+			if (status == VL53LX_ERROR_NONE) {
+				status = VL53LX_WaitMs(
+					Dev,
+					VL53LX_POLLING_DELAY_MS);
+			}
+		}
+	}
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+VL53LX_Error VL53LX_wait_for_test_completion(
+	VL53LX_DEV     Dev)
+{
+
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint8_t      data_ready  = 0;
+
+	LOG_FUNCTION_START("");
+
+	if (pdev->wait_method == VL53LX_WAIT_METHOD_BLOCKING) {
+
+
+
+		status =
+			VL53LX_poll_for_range_completion(
+				Dev,
+				VL53LX_TEST_COMPLETION_POLLING_TIMEOUT_MS);
+
+	} else {
+
+
+
+		data_ready = 0;
+		while (data_ready == 0x00 && status == VL53LX_ERROR_NONE) {
+			status = VL53LX_is_new_data_ready(
+				Dev,
+				&data_ready);
+
+			if (status == VL53LX_ERROR_NONE) {
+				status = VL53LX_WaitMs(
+					Dev,
+					VL53LX_POLLING_DELAY_MS);
+			}
+		}
+	}
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+
+
+VL53LX_Error VL53LX_is_boot_complete(
+	VL53LX_DEV     Dev,
+	uint8_t       *pready)
+{
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	uint8_t  firmware__system_status = 0;
+
+	LOG_FUNCTION_START("");
+
+
+
+	status =
+		VL53LX_RdByte(
+			Dev,
+			VL53LX_FIRMWARE__SYSTEM_STATUS,
+			&firmware__system_status);
+
+
+
+	if ((firmware__system_status & 0x01) == 0x01) {
+		*pready = 0x01;
+		VL53LX_init_ll_driver_state(
+			Dev,
+			VL53LX_DEVICESTATE_SW_STANDBY);
+	} else {
+		*pready = 0x00;
+		VL53LX_init_ll_driver_state(
+			Dev,
+			VL53LX_DEVICESTATE_FW_COLDBOOT);
+	}
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+VL53LX_Error VL53LX_is_firmware_ready(
+	VL53LX_DEV     Dev,
+	uint8_t       *pready)
+{
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	LOG_FUNCTION_START("");
+
+	status = VL53LX_is_firmware_ready_silicon(
+				Dev,
+				pready);
+
+	pdev->fw_ready = *pready;
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+VL53LX_Error VL53LX_is_new_data_ready(
+	VL53LX_DEV     Dev,
+	uint8_t       *pready)
+{
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint8_t  gpio__mux_active_high_hv = 0;
+	uint8_t  gpio__tio_hv_status      = 0;
+	uint8_t  interrupt_ready          = 0;
+
+	LOG_FUNCTION_START("");
+
+	gpio__mux_active_high_hv =
+			pdev->stat_cfg.gpio_hv_mux__ctrl &
+			VL53LX_DEVICEINTERRUPTLEVEL_ACTIVE_MASK;
+
+	if (gpio__mux_active_high_hv == VL53LX_DEVICEINTERRUPTLEVEL_ACTIVE_HIGH)
+		interrupt_ready = 0x01;
+	else
+		interrupt_ready = 0x00;
+
+
+
+	status = VL53LX_RdByte(
+					Dev,
+					VL53LX_GPIO__TIO_HV_STATUS,
+					&gpio__tio_hv_status);
+
+
+
+	if ((gpio__tio_hv_status & 0x01) == interrupt_ready)
+		*pready = 0x01;
+	else
+		*pready = 0x00;
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+
+
+VL53LX_Error VL53LX_poll_for_boot_completion(
+	VL53LX_DEV    Dev,
+	uint32_t      timeout_ms)
+{
+
+
+	VL53LX_Error status       = VL53LX_ERROR_NONE;
+
+	LOG_FUNCTION_START("");
+
+
+
+	status = VL53LX_WaitUs(
+			Dev,
+			VL53LX_FIRMWARE_BOOT_TIME_US);
+
+	if (status == VL53LX_ERROR_NONE)
+		status =
+			VL53LX_WaitValueMaskEx(
+				Dev,
+				timeout_ms,
+				VL53LX_FIRMWARE__SYSTEM_STATUS,
+				0x01,
+				0x01,
+				VL53LX_POLLING_DELAY_MS);
+
+	if (status == VL53LX_ERROR_NONE)
+		VL53LX_init_ll_driver_state(Dev, VL53LX_DEVICESTATE_SW_STANDBY);
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+VL53LX_Error VL53LX_poll_for_firmware_ready(
+	VL53LX_DEV    Dev,
+	uint32_t      timeout_ms)
+{
+
+
+	VL53LX_Error status          = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint32_t     start_time_ms   = 0;
+	uint32_t     current_time_ms = 0;
+	int32_t      poll_delay_ms   = VL53LX_POLLING_DELAY_MS;
+	uint8_t      fw_ready        = 0;
+
+
+
+	VL53LX_GetTickCount(Dev, &start_time_ms);
+	pdev->fw_ready_poll_duration_ms = 0;
+
+
+
+	while ((status == VL53LX_ERROR_NONE) &&
+		   (pdev->fw_ready_poll_duration_ms < timeout_ms) &&
+		   (fw_ready == 0)) {
+
+		status = VL53LX_is_firmware_ready(
+			Dev,
+			&fw_ready);
+
+		if (status == VL53LX_ERROR_NONE &&
+			fw_ready == 0 &&
+			poll_delay_ms > 0) {
+			status = VL53LX_WaitMs(
+				Dev,
+				poll_delay_ms);
+		}
+
+
+		VL53LX_GetTickCount(Dev, &current_time_ms);
+		pdev->fw_ready_poll_duration_ms =
+				current_time_ms - start_time_ms;
+	}
+
+	if (fw_ready == 0 && status == VL53LX_ERROR_NONE)
+		status = VL53LX_ERROR_TIME_OUT;
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+
+VL53LX_Error VL53LX_poll_for_range_completion(
+	VL53LX_DEV     Dev,
+	uint32_t       timeout_ms)
+{
+
+
+	VL53LX_Error status = VL53LX_ERROR_NONE;
+	VL53LX_LLDriverData_t *pdev = VL53LXDevStructGetLLDriverHandle(Dev);
+
+	uint8_t  gpio__mux_active_high_hv = 0;
+	uint8_t  interrupt_ready          = 0;
+
+	LOG_FUNCTION_START("");
+
+	gpio__mux_active_high_hv =
+			pdev->stat_cfg.gpio_hv_mux__ctrl &
+			VL53LX_DEVICEINTERRUPTLEVEL_ACTIVE_MASK;
+
+	if (gpio__mux_active_high_hv == VL53LX_DEVICEINTERRUPTLEVEL_ACTIVE_HIGH)
+		interrupt_ready = 0x01;
+	else
+		interrupt_ready = 0x00;
+
+	status =
+		VL53LX_WaitValueMaskEx(
+			Dev,
+			timeout_ms,
+			VL53LX_GPIO__TIO_HV_STATUS,
+			interrupt_ready,
+			0x01,
+			VL53LX_POLLING_DELAY_MS);
+
+	LOG_FUNCTION_END(status);
+
+	return status;
+}
+
+