vl53l0x_i2c_platform.h

Go to the documentation of this file.

/*
 * COPYRIGHT (C) STMicroelectronics 2014. All rights reserved.
 *
 * This software is the confidential and proprietary information of
 * STMicroelectronics ("Confidential Information").  You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with STMicroelectronics
 *
 * Programming Golden Rule: Keep it Simple!
 *
 */

#ifndef _VL53L0X_I2C_PLATFORM_H_
#define _VL53L0X_I2C_PLATFORM_H_

#include "vl53l0x_def.h"

#ifdef __cplusplus
extern "C" {
#endif

// Include uint8_t, unit16_t  etc definitions

#include <stdint.h>
#include <stdarg.h>


// enum  {TRUE = true, FALSE = false};

#ifndef bool_t
typedef unsigned char bool_t;
#endif


#define    I2C                0x01
#define    SPI                0x00

#define    COMMS_BUFFER_SIZE    64  // MUST be the same size as the SV task buffer

#define    BYTES_PER_WORD        2
#define    BYTES_PER_DWORD       4

#define    VL53L0X_MAX_STRING_LENGTH_PLT       256

int32_t VL53L0X_comms_initialise(uint8_t  comms_type,
                                          uint16_t comms_speed_khz);

int32_t VL53L0X_comms_close(void);

int32_t VL53L0X_cycle_power(void);


int32_t VL53L0X_write_multi(uint8_t address, uint8_t index, uint8_t  *pdata, int32_t count);


int32_t VL53L0X_read_multi(uint8_t address,  uint8_t index, uint8_t  *pdata, int32_t count);


int32_t VL53L0X_write_byte(uint8_t address,  uint8_t index, uint8_t   data);


int32_t VL53L0X_write_word(uint8_t address,  uint8_t index, uint16_t  data);


int32_t VL53L0X_write_dword(uint8_t address, uint8_t index, uint32_t  data);



int32_t VL53L0X_read_byte(uint8_t address,  uint8_t index, uint8_t  *pdata);


int32_t VL53L0X_read_word(uint8_t address,  uint8_t index, uint16_t *pdata);


int32_t VL53L0X_read_dword(uint8_t address, uint8_t index, uint32_t *pdata);


int32_t VL53L0X_platform_wait_us(int32_t wait_us);


int32_t VL53L0X_wait_ms(int32_t wait_ms);


int32_t VL53L0X_set_gpio(uint8_t  level);


int32_t VL53L0X_get_gpio(uint8_t *plevel);

int32_t VL53L0X_release_gpio(void);


int32_t VL53L0X_get_timer_frequency(int32_t *ptimer_freq_hz);

int32_t VL53L0X_get_timer_value(int32_t *ptimer_count);





#ifdef __cplusplus
}
#endif

#endif //_VL53L0X_I2C_PLATFORM_H_