Diff: VL53L0X_platform.h

Revision:

5:f16727052990

Parent:

4:d25c4fa216af

Child:

6:aa13392d16bb

--- a/VL53L0X_platform.h	Mon Dec 18 08:27:21 2017 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,242 +0,0 @@
-/*******************************************************************************
-Copyright © 2015, 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_PLATFORM_H_
-#define _VL53L0X_PLATFORM_H_
-
-#include "VL53L0X_def.h"
-#include "VL53L0X_platform_log.h"
-#include "VL53L0X_i2c_platform.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @file vl53l0_platform.h
- *
- * @brief All end user OS/platform/application porting
- */
-
-/**
- * @defgroup VL53L0X_platform_group VL53L0 Platform Functions
- * @brief    VL53L0 Platform Functions
- *  @{
- */
-
-/**
- * @struct  VL53L0X_Dev_t
- * @brief    Generic PAL device type that does link between API and platform abstraction layer
- *
- */
-typedef struct {
-    VL53L0X_DevData_t Data;               /*!< embed ST Ewok Dev  data as "Data"*/
-
-    /*!< user specific field */
-    uint8_t   I2cDevAddr;                /*!< i2c device address user specific field */
-    uint8_t   comms_type;                /*!< Type of comms : VL53L0X_COMMS_I2C or VL53L0X_COMMS_SPI */
-    uint16_t  comms_speed_khz;           /*!< Comms speed [kHz] : typically 400kHz for I2C           */
-
-} VL53L0X_Dev_t;
-
-
-/**
- * @brief   Declare the device Handle as a pointer of the structure @a VL53L0X_Dev_t.
- *
- */
-typedef VL53L0X_Dev_t *VL53L0X_DEV;
-
-/**
- * @def PALDevDataGet
- * @brief Get ST private structure @a VL53L0X_DevData_t data access
- *
- * @param Dev       Device Handle
- * @param field     ST structure field name
- * It maybe used and as real data "ref" not just as "get" for sub-structure item
- * like PALDevDataGet(FilterData.field)[i] or PALDevDataGet(FilterData.MeasurementIndex)++
- */
-#define PALDevDataGet(Dev, field) (Dev->Data.field)
-
-/**
- * @def PALDevDataSet(Dev, field, data)
- * @brief  Set ST private structure @a VL53L0X_DevData_t data field
- * @param Dev       Device Handle
- * @param field     ST structure field name
- * @param data      Data to be set
- */
-#define PALDevDataSet(Dev, field, data) (Dev->Data.field)=(data)
-
-
-/**
- * @defgroup VL53L0X_registerAccess_group PAL Register Access Functions
- * @brief    PAL Register Access Functions
- *  @{
- */
-
-/**
- * Lock comms interface to serialize all commands to a shared I2C interface for a specific device
- * @param   Dev       Device Handle
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_LockSequenceAccess(VL53L0X_DEV Dev);
-
-/**
- * Unlock comms interface to serialize all commands to a shared I2C interface for a specific device
- * @param   Dev       Device Handle
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_UnlockSequenceAccess(VL53L0X_DEV Dev);
-
-
-/**
- * Writes the supplied byte buffer to the device
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   pdata     Pointer to uint8_t buffer containing the data to be written
- * @param   count     Number of bytes in the supplied byte buffer
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_WriteMulti(VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count);
-
-/**
- * Reads the requested number of bytes from the device
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   pdata     Pointer to the uint8_t buffer to store read data
- * @param   count     Number of uint8_t's to read
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_ReadMulti(VL53L0X_DEV Dev, uint8_t index, uint8_t *pdata, uint32_t count);
-
-/**
- * Write single byte register
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   data      8 bit register data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_WrByte(VL53L0X_DEV Dev, uint8_t index, uint8_t data);
-
-/**
- * Write word register
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   data      16 bit register data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_WrWord(VL53L0X_DEV Dev, uint8_t index, uint16_t data);
-
-/**
- * Write double word (4 byte) register
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   data      32 bit register data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_WrDWord(VL53L0X_DEV Dev, uint8_t index, uint32_t data);
-
-/**
- * Read single byte register
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   data      pointer to 8 bit data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_RdByte(VL53L0X_DEV Dev, uint8_t index, uint8_t *data);
-
-/**
- * Read word (2byte) register
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   data      pointer to 16 bit data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_RdWord(VL53L0X_DEV Dev, uint8_t index, uint16_t *data);
-
-/**
- * Read dword (4byte) register
- * @param   Dev       Device Handle
- * @param   index     The register index
- * @param   data      pointer to 32 bit data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_RdDWord(VL53L0X_DEV Dev, uint8_t index, uint32_t *data);
-
-/**
- * Threat safe Update (read/modify/write) single byte register
- *
- * Final_reg = (Initial_reg & and_data) |or_data
- *
- * @param   Dev        Device Handle
- * @param   index      The register index
- * @param   AndData    8 bit and data
- * @param   OrData     8 bit or data
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_UpdateByte(VL53L0X_DEV Dev, uint8_t index, uint8_t AndData, uint8_t OrData);
-
-/** @} end of VL53L0X_registerAccess_group */
-
-
-/**
- * @brief execute delay in all polling API call
- *
- * A typical multi-thread or RTOs implementation is to sleep the task for some 5ms (with 100Hz max rate faster polling is not needed)
- * if nothing specific is need you can define it as an empty/void macro
- * @code
- * #define VL53L0X_PollingDelay(...) (void)0
- * @endcode
- * @param Dev       Device Handle
- * @return  VL53L0X_ERROR_NONE        Success
- * @return  "Other error code"    See ::VL53L0X_Error
- */
-VL53L0X_Error VL53L0X_PollingDelay(VL53L0X_DEV Dev); /* usually best implemented as a real function */
-
-/** @} end of VL53L0X_platform_group */
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif  /* _VL53L0X_PLATFORM_H_ */
-
-
-
-