Kenji Arai / VL53L0X_simple

Fork of X-NUCLEO-53L0A1 Library and deleted the board related files. Just use a VL53L0X chip as a ToF sensor.

Dependents:   Check_VL53L0X_simple_with_three_ToF Check_VL53L0X_simple_ToF_Sensor lidarproj Check_VL53L0X_simple_with_three_ToF ... more

Fork of VL53L0X by ST

Please refer below page.
/users/kenjiArai/notebook/vl53l0x-tof-sensor/

VL53L0X_platform.h@10:c9181a97a64f, 2020-02-26 (annotated)

Committer:
kenjiArai
Date:
Wed Feb 26 09:34:31 2020 +0000
Revision:
10:c9181a97a64f
Parent:
5:ac6604b75d50 
bug fix for XSHUT=NC

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nikapov 0:a1a69d32f310 1 /*******************************************************************************
nikapov 0:a1a69d32f310 2 Copyright © 2015, STMicroelectronics International N.V.
nikapov 0:a1a69d32f310 3 All rights reserved.
nikapov 0:a1a69d32f310 4
nikapov 0:a1a69d32f310 5 Redistribution and use in source and binary forms, with or without
nikapov 0:a1a69d32f310 6 modification, are permitted provided that the following conditions are met:
nikapov 0:a1a69d32f310 7 * Redistributions of source code must retain the above copyright
nikapov 0:a1a69d32f310 8 notice, this list of conditions and the following disclaimer.
nikapov 0:a1a69d32f310 9 * Redistributions in binary form must reproduce the above copyright
nikapov 0:a1a69d32f310 10 notice, this list of conditions and the following disclaimer in the
nikapov 0:a1a69d32f310 11 documentation and/or other materials provided with the distribution.
nikapov 0:a1a69d32f310 12 * Neither the name of STMicroelectronics nor the
nikapov 0:a1a69d32f310 13 names of its contributors may be used to endorse or promote products
nikapov 0:a1a69d32f310 14 derived from this software without specific prior written permission.
nikapov 0:a1a69d32f310 15
nikapov 0:a1a69d32f310 16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
nikapov 0:a1a69d32f310 17 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
nikapov 0:a1a69d32f310 18 WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
nikapov 0:a1a69d32f310 19 NON-INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED.
nikapov 0:a1a69d32f310 20 IN NO EVENT SHALL STMICROELECTRONICS INTERNATIONAL N.V. BE LIABLE FOR ANY
nikapov 0:a1a69d32f310 21 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
nikapov 0:a1a69d32f310 22 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
nikapov 0:a1a69d32f310 23 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
nikapov 0:a1a69d32f310 24 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nikapov 0:a1a69d32f310 25 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
nikapov 0:a1a69d32f310 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nikapov 0:a1a69d32f310 27 ********************************************************************************/
nikapov 0:a1a69d32f310 28
nikapov 0:a1a69d32f310 29
nikapov 0:a1a69d32f310 30 #ifndef _VL53L0X_PLATFORM_H_
nikapov 0:a1a69d32f310 31 #define _VL53L0X_PLATFORM_H_
nikapov 0:a1a69d32f310 32
nikapov 0:a1a69d32f310 33 #include "VL53L0X_def.h"
nikapov 0:a1a69d32f310 34 #include "VL53L0X_platform_log.h"
kenjiArai 5:ac6604b75d50 35 //#include "VL53L0X_i2c_platform.h"
nikapov 0:a1a69d32f310 36
nikapov 0:a1a69d32f310 37 #ifdef __cplusplus
nikapov 0:a1a69d32f310 38 extern "C" {
nikapov 0:a1a69d32f310 39 #endif
nikapov 0:a1a69d32f310 40
nikapov 0:a1a69d32f310 41 /**
nikapov 0:a1a69d32f310 42 * @file vl53l0_platform.h
nikapov 0:a1a69d32f310 43 *
nikapov 0:a1a69d32f310 44 * @brief All end user OS/platform/application porting
nikapov 0:a1a69d32f310 45 */
Davidroid 2:d07edeaff6f1 46
nikapov 0:a1a69d32f310 47 /**
nikapov 0:a1a69d32f310 48 * @defgroup VL53L0X_platform_group VL53L0 Platform Functions
nikapov 0:a1a69d32f310 49 * @brief VL53L0 Platform Functions
nikapov 0:a1a69d32f310 50 * @{
nikapov 0:a1a69d32f310 51 */
nikapov 0:a1a69d32f310 52
nikapov 0:a1a69d32f310 53 /**
nikapov 0:a1a69d32f310 54 * @struct VL53L0X_Dev_t
nikapov 0:a1a69d32f310 55 * @brief Generic PAL device type that does link between API and platform abstraction layer
nikapov 0:a1a69d32f310 56 *
nikapov 0:a1a69d32f310 57 */
nikapov 0:a1a69d32f310 58 typedef struct {
nikapov 0:a1a69d32f310 59 VL53L0X_DevData_t Data; /*!< embed ST Ewok Dev data as "Data"*/
nikapov 0:a1a69d32f310 60
nikapov 0:a1a69d32f310 61 /*!< user specific field */
nikapov 0:a1a69d32f310 62 uint8_t I2cDevAddr; /*!< i2c device address user specific field */
nikapov 0:a1a69d32f310 63 uint8_t comms_type; /*!< Type of comms : VL53L0X_COMMS_I2C or VL53L0X_COMMS_SPI */
nikapov 0:a1a69d32f310 64 uint16_t comms_speed_khz; /*!< Comms speed [kHz] : typically 400kHz for I2C */
nikapov 0:a1a69d32f310 65
nikapov 0:a1a69d32f310 66 } VL53L0X_Dev_t;
nikapov 0:a1a69d32f310 67
nikapov 0:a1a69d32f310 68
nikapov 0:a1a69d32f310 69 /**
nikapov 0:a1a69d32f310 70 * @brief Declare the device Handle as a pointer of the structure @a VL53L0X_Dev_t.
nikapov 0:a1a69d32f310 71 *
nikapov 0:a1a69d32f310 72 */
Davidroid 2:d07edeaff6f1 73 typedef VL53L0X_Dev_t *VL53L0X_DEV;
nikapov 0:a1a69d32f310 74
nikapov 0:a1a69d32f310 75 /**
nikapov 0:a1a69d32f310 76 * @def PALDevDataGet
nikapov 0:a1a69d32f310 77 * @brief Get ST private structure @a VL53L0X_DevData_t data access
nikapov 0:a1a69d32f310 78 *
nikapov 0:a1a69d32f310 79 * @param Dev Device Handle
nikapov 0:a1a69d32f310 80 * @param field ST structure field name
nikapov 0:a1a69d32f310 81 * It maybe used and as real data "ref" not just as "get" for sub-structure item
nikapov 0:a1a69d32f310 82 * like PALDevDataGet(FilterData.field)[i] or PALDevDataGet(FilterData.MeasurementIndex)++
nikapov 0:a1a69d32f310 83 */
nikapov 0:a1a69d32f310 84 #define PALDevDataGet(Dev, field) (Dev->Data.field)
nikapov 0:a1a69d32f310 85
nikapov 0:a1a69d32f310 86 /**
nikapov 0:a1a69d32f310 87 * @def PALDevDataSet(Dev, field, data)
nikapov 0:a1a69d32f310 88 * @brief Set ST private structure @a VL53L0X_DevData_t data field
nikapov 0:a1a69d32f310 89 * @param Dev Device Handle
nikapov 0:a1a69d32f310 90 * @param field ST structure field name
nikapov 0:a1a69d32f310 91 * @param data Data to be set
nikapov 0:a1a69d32f310 92 */
nikapov 0:a1a69d32f310 93 #define PALDevDataSet(Dev, field, data) (Dev->Data.field)=(data)
nikapov 0:a1a69d32f310 94
nikapov 0:a1a69d32f310 95
nikapov 0:a1a69d32f310 96 /**
nikapov 0:a1a69d32f310 97 * @defgroup VL53L0X_registerAccess_group PAL Register Access Functions
nikapov 0:a1a69d32f310 98 * @brief PAL Register Access Functions
nikapov 0:a1a69d32f310 99 * @{
nikapov 0:a1a69d32f310 100 */
nikapov 0:a1a69d32f310 101
nikapov 0:a1a69d32f310 102 /**
nikapov 0:a1a69d32f310 103 * Lock comms interface to serialize all commands to a shared I2C interface for a specific device
nikapov 0:a1a69d32f310 104 * @param Dev Device Handle
nikapov 0:a1a69d32f310 105 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 106 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 107 */
nikapov 0:a1a69d32f310 108 VL53L0X_Error VL53L0X_LockSequenceAccess(VL53L0X_DEV Dev);
nikapov 0:a1a69d32f310 109
nikapov 0:a1a69d32f310 110 /**
nikapov 0:a1a69d32f310 111 * Unlock comms interface to serialize all commands to a shared I2C interface for a specific device
nikapov 0:a1a69d32f310 112 * @param Dev Device Handle
nikapov 0:a1a69d32f310 113 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 114 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 115 */
nikapov 0:a1a69d32f310 116 VL53L0X_Error VL53L0X_UnlockSequenceAccess(VL53L0X_DEV Dev);
nikapov 0:a1a69d32f310 117
nikapov 0:a1a69d32f310 118
nikapov 0:a1a69d32f310 119 /**
nikapov 0:a1a69d32f310 120 * Writes the supplied byte buffer to the device
nikapov 0:a1a69d32f310 121 * @param Dev Device Handle
nikapov 0:a1a69d32f310 122 * @param index The register index
nikapov 0:a1a69d32f310 123 * @param pdata Pointer to uint8_t buffer containing the data to be written
nikapov 0:a1a69d32f310 124 * @param count Number of bytes in the supplied byte buffer
nikapov 0:a1a69d32f310 125 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 126 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 127 */
nikapov 0:a1a69d32f310 128 VL53L0X_Error VL53L0X_WriteMulti(VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count);
nikapov 0:a1a69d32f310 129
nikapov 0:a1a69d32f310 130 /**
nikapov 0:a1a69d32f310 131 * Reads the requested number of bytes from the device
nikapov 0:a1a69d32f310 132 * @param Dev Device Handle
nikapov 0:a1a69d32f310 133 * @param index The register index
nikapov 0:a1a69d32f310 134 * @param pdata Pointer to the uint8_t buffer to store read data
nikapov 0:a1a69d32f310 135 * @param count Number of uint8_t's to read
nikapov 0:a1a69d32f310 136 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 137 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 138 */
nikapov 0:a1a69d32f310 139 VL53L0X_Error VL53L0X_ReadMulti(VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count);
nikapov 0:a1a69d32f310 140
nikapov 0:a1a69d32f310 141 /**
nikapov 0:a1a69d32f310 142 * Write single byte register
nikapov 0:a1a69d32f310 143 * @param Dev Device Handle
nikapov 0:a1a69d32f310 144 * @param index The register index
nikapov 0:a1a69d32f310 145 * @param data 8 bit register data
nikapov 0:a1a69d32f310 146 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 147 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 148 */
nikapov 0:a1a69d32f310 149 VL53L0X_Error VL53L0X_WrByte(VL53L0X_DEV Dev, uint8_t index, uint8_t data);
nikapov 0:a1a69d32f310 150
nikapov 0:a1a69d32f310 151 /**
nikapov 0:a1a69d32f310 152 * Write word register
nikapov 0:a1a69d32f310 153 * @param Dev Device Handle
nikapov 0:a1a69d32f310 154 * @param index The register index
nikapov 0:a1a69d32f310 155 * @param data 16 bit register data
nikapov 0:a1a69d32f310 156 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 157 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 158 */
nikapov 0:a1a69d32f310 159 VL53L0X_Error VL53L0X_WrWord(VL53L0X_DEV Dev, uint8_t index, uint16_t data);
nikapov 0:a1a69d32f310 160
nikapov 0:a1a69d32f310 161 /**
nikapov 0:a1a69d32f310 162 * Write double word (4 byte) register
nikapov 0:a1a69d32f310 163 * @param Dev Device Handle
nikapov 0:a1a69d32f310 164 * @param index The register index
nikapov 0:a1a69d32f310 165 * @param data 32 bit register data
nikapov 0:a1a69d32f310 166 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 167 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 168 */
nikapov 0:a1a69d32f310 169 VL53L0X_Error VL53L0X_WrDWord(VL53L0X_DEV Dev, uint8_t index, uint32_t data);
nikapov 0:a1a69d32f310 170
nikapov 0:a1a69d32f310 171 /**
nikapov 0:a1a69d32f310 172 * Read single byte register
nikapov 0:a1a69d32f310 173 * @param Dev Device Handle
nikapov 0:a1a69d32f310 174 * @param index The register index
nikapov 0:a1a69d32f310 175 * @param data pointer to 8 bit data
nikapov 0:a1a69d32f310 176 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 177 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 178 */
nikapov 0:a1a69d32f310 179 VL53L0X_Error VL53L0X_RdByte(VL53L0X_DEV Dev, uint8_t index, uint8_t *data);
nikapov 0:a1a69d32f310 180
nikapov 0:a1a69d32f310 181 /**
nikapov 0:a1a69d32f310 182 * Read word (2byte) register
nikapov 0:a1a69d32f310 183 * @param Dev Device Handle
nikapov 0:a1a69d32f310 184 * @param index The register index
nikapov 0:a1a69d32f310 185 * @param data pointer to 16 bit data
nikapov 0:a1a69d32f310 186 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 187 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 188 */
nikapov 0:a1a69d32f310 189 VL53L0X_Error VL53L0X_RdWord(VL53L0X_DEV Dev, uint8_t index, uint16_t *data);
nikapov 0:a1a69d32f310 190
nikapov 0:a1a69d32f310 191 /**
nikapov 0:a1a69d32f310 192 * Read dword (4byte) register
nikapov 0:a1a69d32f310 193 * @param Dev Device Handle
nikapov 0:a1a69d32f310 194 * @param index The register index
nikapov 0:a1a69d32f310 195 * @param data pointer to 32 bit data
nikapov 0:a1a69d32f310 196 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 197 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 198 */
nikapov 0:a1a69d32f310 199 VL53L0X_Error VL53L0X_RdDWord(VL53L0X_DEV Dev, uint8_t index, uint32_t *data);
nikapov 0:a1a69d32f310 200
nikapov 0:a1a69d32f310 201 /**
nikapov 0:a1a69d32f310 202 * Threat safe Update (read/modify/write) single byte register
nikapov 0:a1a69d32f310 203 *
nikapov 0:a1a69d32f310 204 * Final_reg = (Initial_reg & and_data) |or_data
nikapov 0:a1a69d32f310 205 *
nikapov 0:a1a69d32f310 206 * @param Dev Device Handle
nikapov 0:a1a69d32f310 207 * @param index The register index
nikapov 0:a1a69d32f310 208 * @param AndData 8 bit and data
nikapov 0:a1a69d32f310 209 * @param OrData 8 bit or data
nikapov 0:a1a69d32f310 210 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 211 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 212 */
nikapov 0:a1a69d32f310 213 VL53L0X_Error VL53L0X_UpdateByte(VL53L0X_DEV Dev, uint8_t index, uint8_t AndData, uint8_t OrData);
nikapov 0:a1a69d32f310 214
nikapov 0:a1a69d32f310 215 /** @} end of VL53L0X_registerAccess_group */
nikapov 0:a1a69d32f310 216
Davidroid 2:d07edeaff6f1 217
nikapov 0:a1a69d32f310 218 /**
nikapov 0:a1a69d32f310 219 * @brief execute delay in all polling API call
nikapov 0:a1a69d32f310 220 *
nikapov 0:a1a69d32f310 221 * A typical multi-thread or RTOs implementation is to sleep the task for some 5ms (with 100Hz max rate faster polling is not needed)
nikapov 0:a1a69d32f310 222 * if nothing specific is need you can define it as an empty/void macro
nikapov 0:a1a69d32f310 223 * @code
nikapov 0:a1a69d32f310 224 * #define VL53L0X_PollingDelay(...) (void)0
nikapov 0:a1a69d32f310 225 * @endcode
nikapov 0:a1a69d32f310 226 * @param Dev Device Handle
nikapov 0:a1a69d32f310 227 * @return VL53L0X_ERROR_NONE Success
nikapov 0:a1a69d32f310 228 * @return "Other error code" See ::VL53L0X_Error
nikapov 0:a1a69d32f310 229 */
nikapov 0:a1a69d32f310 230 VL53L0X_Error VL53L0X_PollingDelay(VL53L0X_DEV Dev); /* usually best implemented as a real function */
nikapov 0:a1a69d32f310 231
nikapov 0:a1a69d32f310 232 /** @} end of VL53L0X_platform_group */
nikapov 0:a1a69d32f310 233
nikapov 0:a1a69d32f310 234 #ifdef __cplusplus
nikapov 0:a1a69d32f310 235 }
nikapov 0:a1a69d32f310 236 #endif
nikapov 0:a1a69d32f310 237
nikapov 0:a1a69d32f310 238 #endif /* _VL53L0X_PLATFORM_H_ */
nikapov 0:a1a69d32f310 239
nikapov 0:a1a69d32f310 240
nikapov 0:a1a69d32f310 241
nikapov 0:a1a69d32f310 242