Commit 7fa2cac9 authored by Vincent Veron's avatar Vincent Veron Committed by Kumar Gala
Browse files

ext: Add official ST library for vl53l0x 

In order to ease the usage of its sensors, STMicroelectronics provides
some generic libraries. The first sensor to use that is vl53l0x time of
flight sensor. I have made the implementation generic enough to add some
more libraries in the future.

All the libraries will be located in ext/hal/st/lib.

The vl53l0X library is made of 2 parts :
    * the core, that is generic to all platforms
    * the platform, contains the adaptation layer. This will be
      implemented in driver as it is Zephyr specific.

Origin: ST Microelectronics
License: BSD-3-Clause
URL: http://www.st.com/en/embedded-software/stsw-img005.html


Commit: 1.0.2
Purpose: API to ease the usage of vl53l0x sensor
Maintained-by: External

Signed-off-by: default avatarVincent Veron <vincent.veron@st.com>
parents

README

0 → 100644
+8 −0
Original line number Diff line number Diff line 


Directory contains all the official libraries provided by STMicroelectronics.



Available libs:

  * sensor/vl53l0x:

      allows to drive the vl53l0x sensor

      full information can be found here : http://www.st.com/en/embedded-software/stsw-img005.html

  * ...

sensor/vl53l0x/README

0 → 100644
+53 −0
Original line number Diff line number Diff line 
VL53L0X

#######



Origin:

   ST Microelectronics

   http://www.st.com/en/embedded-software/stsw-img005.html



Status:

   version 1.0.2



Purpose:

   ST Microelectonics official API to use vl53l0x sensor.



Description:

   This library written by STMicroelectronics is dedicated to vl53l0x time of flight sensor.

   Instead of providing a full description of the registers, ST decided to provide a C library to drive this sensor.



   This library is called from the vl53l0x driver and is kept transparent for user.

   User is calling a standard Zephyr driver and then, the driver makes some calls to this library.



   In order to fit with Zephyr rules and simplify version updates, we have done a minimum of modifications :

      - keep only API directory

        (remove documentation and samples, see ST website for this)

      - rename Api to api

      - customize api/platform to fit in Zephyr (mainly for I2C access)

        vl53l0x_platform.c has been moved to Zephyr drivers directory.



   In order to use this library, you have to :

      * define CONFIG_HAS_STLIB and CONFIG_VL53L0X

      * use NEWLIB_LIBC in prj.conf (needed for abs function)

      * include vl53l0x_api.h and vl53l0x_platform.h in the driver .h



Dependencies:

   This package depends on Zephyr I2C implementation and is linked statically.

   This library will be used by a standard Zephyr driver.



URL:

   http://www.st.com/en/embedded-software/stsw-img005.html



commit:

   version 1.0.2



Maintained-by:

   External



License:

   BSD-3-Clause



License Link:

   http://www.st.com/en/embedded-software/stsw-img005.html

sensor/vl53l0x/api/core/inc/vl53l0x_api.h

0 → 100644
+0 −0

File added.

Preview size limit exceeded, changes collapsed.

sensor/vl53l0x/api/core/inc/vl53l0x_api_calibration.h

0 → 100644
+85 −0
Original line number Diff line number Diff line 
/*******************************************************************************

Copyright © 2016, STMicroelectronics International N.V.

All rights reserved.



Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

	* Redistributions of source code must retain the above copyright

	  notice, this list of conditions and the following disclaimer.

	* Redistributions in binary form must reproduce the above copyright

	  notice, this list of conditions and the following disclaimer in the

	  documentation and/or other materials provided with the distribution.

	* Neither the name of STMicroelectronics nor the

	  names of its contributors may be used to endorse or promote products

	  derived from this software without specific prior written permission.



THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND

NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.

IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY

DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*******************************************************************************/



#ifndef _VL53L0X_API_CALIBRATION_H_

#define _VL53L0X_API_CALIBRATION_H_



#include "vl53l0x_def.h"

#include "vl53l0x_platform.h"





#ifdef __cplusplus

extern "C" {

#endif



VL53L0X_Error VL53L0X_perform_xtalk_calibration(VL53L0X_DEV Dev,

		FixPoint1616_t XTalkCalDistance,

		FixPoint1616_t *pXTalkCompensationRateMegaCps);



VL53L0X_Error VL53L0X_perform_offset_calibration(VL53L0X_DEV Dev,

		FixPoint1616_t CalDistanceMilliMeter,

		int32_t *pOffsetMicroMeter);



VL53L0X_Error VL53L0X_set_offset_calibration_data_micro_meter(VL53L0X_DEV Dev,

		int32_t OffsetCalibrationDataMicroMeter);



VL53L0X_Error VL53L0X_get_offset_calibration_data_micro_meter(VL53L0X_DEV Dev,

		int32_t *pOffsetCalibrationDataMicroMeter);



VL53L0X_Error VL53L0X_apply_offset_adjustment(VL53L0X_DEV Dev);



VL53L0X_Error VL53L0X_perform_ref_spad_management(VL53L0X_DEV Dev,

		uint32_t *refSpadCount, uint8_t *isApertureSpads);



VL53L0X_Error VL53L0X_set_reference_spads(VL53L0X_DEV Dev,

		uint32_t count, uint8_t isApertureSpads);



VL53L0X_Error VL53L0X_get_reference_spads(VL53L0X_DEV Dev,

		uint32_t *pSpadCount, uint8_t *pIsApertureSpads);



VL53L0X_Error VL53L0X_perform_phase_calibration(VL53L0X_DEV Dev,

	uint8_t *pPhaseCal, const uint8_t get_data_enable,

	const uint8_t restore_config);



VL53L0X_Error VL53L0X_perform_ref_calibration(VL53L0X_DEV Dev,

	uint8_t *pVhvSettings, uint8_t *pPhaseCal, uint8_t get_data_enable);



VL53L0X_Error VL53L0X_set_ref_calibration(VL53L0X_DEV Dev,

		uint8_t VhvSettings, uint8_t PhaseCal);



VL53L0X_Error VL53L0X_get_ref_calibration(VL53L0X_DEV Dev,

		uint8_t *pVhvSettings, uint8_t *pPhaseCal);









#ifdef __cplusplus

}

#endif



#endif /* _VL53L0X_API_CALIBRATION_H_ */

sensor/vl53l0x/api/core/inc/vl53l0x_api_core.h

0 → 100644
+108 −0
Original line number Diff line number Diff line 
/*******************************************************************************

Copyright  2016, STMicroelectronics International N.V.

All rights reserved.



Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright

      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright

      notice, this list of conditions and the following disclaimer in the

      documentation and/or other materials provided with the distribution.

    * Neither the name of STMicroelectronics nor the

      names of its contributors may be used to endorse or promote products

      derived from this software without specific prior written permission.



THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND

NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.

IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY

DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*******************************************************************************/



#ifndef _VL53L0X_API_CORE_H_

#define _VL53L0X_API_CORE_H_



#include "vl53l0x_def.h"

#include "vl53l0x_platform.h"





#ifdef __cplusplus

extern "C" {

#endif





VL53L0X_Error VL53L0X_reverse_bytes(uint8_t *data, uint32_t size);



VL53L0X_Error VL53L0X_measurement_poll_for_completion(VL53L0X_DEV Dev);



uint8_t VL53L0X_encode_vcsel_period(uint8_t vcsel_period_pclks);



uint8_t VL53L0X_decode_vcsel_period(uint8_t vcsel_period_reg);



uint32_t VL53L0X_isqrt(uint32_t num);



uint32_t VL53L0X_quadrature_sum(uint32_t a, uint32_t b);



VL53L0X_Error VL53L0X_get_info_from_device(VL53L0X_DEV Dev, uint8_t option);



VL53L0X_Error VL53L0X_set_vcsel_pulse_period(VL53L0X_DEV Dev,

	VL53L0X_VcselPeriod VcselPeriodType, uint8_t VCSELPulsePeriodPCLK);



VL53L0X_Error VL53L0X_get_vcsel_pulse_period(VL53L0X_DEV Dev,

	VL53L0X_VcselPeriod VcselPeriodType, uint8_t *pVCSELPulsePeriodPCLK);



uint32_t VL53L0X_decode_timeout(uint16_t encoded_timeout);



VL53L0X_Error get_sequence_step_timeout(VL53L0X_DEV Dev,

			VL53L0X_SequenceStepId SequenceStepId,

			uint32_t *pTimeOutMicroSecs);



VL53L0X_Error set_sequence_step_timeout(VL53L0X_DEV Dev,

			VL53L0X_SequenceStepId SequenceStepId,

			uint32_t TimeOutMicroSecs);



VL53L0X_Error VL53L0X_set_measurement_timing_budget_micro_seconds(VL53L0X_DEV Dev,

	uint32_t MeasurementTimingBudgetMicroSeconds);



VL53L0X_Error VL53L0X_get_measurement_timing_budget_micro_seconds(VL53L0X_DEV Dev,

		uint32_t *pMeasurementTimingBudgetMicroSeconds);



VL53L0X_Error VL53L0X_load_tuning_settings(VL53L0X_DEV Dev,

		uint8_t *pTuningSettingBuffer);



VL53L0X_Error VL53L0X_calc_sigma_estimate(VL53L0X_DEV Dev,

		VL53L0X_RangingMeasurementData_t *pRangingMeasurementData,

		FixPoint1616_t *pSigmaEstimate, uint32_t *pDmax_mm);



VL53L0X_Error VL53L0X_get_total_xtalk_rate(VL53L0X_DEV Dev,

	VL53L0X_RangingMeasurementData_t *pRangingMeasurementData,

	FixPoint1616_t *ptotal_xtalk_rate_mcps);



VL53L0X_Error VL53L0X_get_total_signal_rate(VL53L0X_DEV Dev,

	VL53L0X_RangingMeasurementData_t *pRangingMeasurementData,

	FixPoint1616_t *ptotal_signal_rate_mcps);



VL53L0X_Error VL53L0X_get_pal_range_status(VL53L0X_DEV Dev,

		 uint8_t DeviceRangeStatus,

		 FixPoint1616_t SignalRate,

		 uint16_t EffectiveSpadRtnCount,

		 VL53L0X_RangingMeasurementData_t *pRangingMeasurementData,

		 uint8_t *pPalRangeStatus);



uint32_t VL53L0X_calc_timeout_mclks(VL53L0X_DEV Dev,

	uint32_t timeout_period_us, uint8_t vcsel_period_pclks);



uint16_t VL53L0X_encode_timeout(uint32_t timeout_macro_clks);



#ifdef __cplusplus

}

#endif



#endif /* _VL53L0X_API_CORE_H_ */

CRA Git | Maintained and supported by SUSTech CRA and CCSE