Files
QDAC-firmware/libraries/zf_device/zf_device_dl1a.h
2023-12-11 21:45:06 +08:00

209 lines
11 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*********************************************************************************************************************
* CH32V307VCT6 Opensourec Library 即CH32V307VCT6 开源库)是一个基于官方 SDK 接口的第三方开源库
* Copyright (c) 2022 SEEKFREE 逐飞科技
*
* 本文件是CH32V307VCT6 开源库的一部分
*
* CH32V307VCT6 开源库 是免费软件
* 您可以根据自由软件基金会发布的 GPLGNU General Public License即 GNU通用公共许可证的条款
* 即 GPL 的第3版即 GPL3.0)或(您选择的)任何后来的版本,重新发布和/或修改它
*
* 本开源库的发布是希望它能发挥作用,但并未对其作任何的保证
* 甚至没有隐含的适销性或适合特定用途的保证
* 更多细节请参见 GPL
*
* 您应该在收到本开源库的同时收到一份 GPL 的副本
* 如果没有,请参阅<https://www.gnu.org/licenses/>
*
* 额外注明:
* 本开源库使用 GPL3.0 开源许可证协议 以上许可申明为译文版本
* 许可申明英文版在 libraries/doc 文件夹下的 GPL3_permission_statement.txt 文件中
* 许可证副本在 libraries 文件夹下 即该文件夹下的 LICENSE 文件
* 欢迎各位使用并传播本程序 但修改内容时必须保留逐飞科技的版权声明(即本声明)
*
* 文件名称 zf_device_dl1a
* 公司名称 成都逐飞科技有限公司
* 版本信息 查看 libraries/doc 文件夹内 version 文件 版本说明
* 开发环境 MounRiver Studio V1.8.1
* 适用平台 CH32V307VCT6
* 店铺链接 https://seekfree.taobao.com/
*
* 修改记录
* 日期 作者 备注
* 2023-03-18 大W first version
********************************************************************************************************************/
/*********************************************************************************************************************
* 接线定义:
* ------------------------------------
* 模块管脚 单片机管脚
* SCL 查看 zf_device_dl1a.h 中 DL1A_SCL_PIN 宏定义
* SDA 查看 zf_device_dl1a.h 中 DL1A_SDA_PIN 宏定义
* XS 查看 zf_device_dl1a.h 中 DL1A_XS_PIN 宏定义
* VCC 5V 电源
* GND 电源地
* ------------------------------------
* ------------------------------------
********************************************************************************************************************/
#ifndef _ZF_DEVICE_DL1A_H_
#define _ZF_DEVICE_DL1A_H_
#include "zf_common_typedef.h"
// 需要注意的是 DL1A 最高支持 400KHz 的 IIC 通信速率
// 需要注意的是 DL1A 最高支持 400KHz 的 IIC 通信速率
// 需要注意的是 DL1A 最高支持 400KHz 的 IIC 通信速率
#define DL1A_USE_SOFT_IIC ( 1 ) // 默认使用软件 IIC 方式驱动 建议使用软件 IIC 方式
#if DL1A_USE_SOFT_IIC // 这两段 颜色正常的才是正确的 颜色灰的就是没有用的
//====================================================软件 IIC 驱动====================================================
#define DL1A_SOFT_IIC_DELAY ( 10 ) // 软件 IIC 的时钟延时周期 数值越小 IIC 通信速率越快
#define DL1A_SCL_PIN ( D6 ) // 软件 IIC SCL 引脚 连接 DL1A 的 SCL 引脚
#define DL1A_SDA_PIN ( D5 ) // 软件 IIC SDA 引脚 连接 DL1A 的 SDA 引脚
//====================================================软件 IIC 驱动====================================================
#else
//====================================================硬件 IIC 驱动====================================================
#define DL1A_IIC_SPEED ( 40*1000 ) // 硬件 IIC 通信速率 最高 400KHz 不建议低于 40KHz
#define DL1A_IIC ( 暂不支持 ) // 硬件 IIC SCL 引脚 连接 DL1A 的 SCL 引脚
#define DL1A_SCL_PIN ( 暂不支持 ) // 硬件 IIC SCL 引脚 连接 DL1A 的 SCL 引脚
#define DL1A_SDA_PIN ( 暂不支持 ) // 硬件 IIC SDA 引脚 连接 DL1A 的 SDA 引脚
//====================================================硬件 IIC 驱动====================================================
#endif
#define DL1A_XS_PIN ( E10 )
#define DL1A_INT_ENABLE ( 0 ) // 是否启用 INT 引脚 启用则会自动更新数据
#if DL1A_INT_ENABLE
#define DL1A_INT_PIN ( C13 ) // 未定义引脚,可以不接。
#endif
#define DL1A_TIMEOUT_COUNT (0x00FF) // DL1A 超时计数
//================================================定义 DL1A 内部地址================================================
#define DL1A_DEV_ADDR ( 0x52 >> 1 ) // 0b0101001
#define DL1A_SYSRANGE_START ( 0x00 )
#define DL1A_SYSTEM_SEQUENCE_CONFIG ( 0x01 )
#define DL1A_SYSTEM_INTERMEASUREMENT_PERIOD ( 0x04 )
#define DL1A_SYSTEM_RANGE_CONFIG ( 0x09 )
#define DL1A_SYSTEM_INTERRUPT_GPIO_CONFIG ( 0x0A )
#define DL1A_SYSTEM_INTERRUPT_CLEAR ( 0x0B )
#define DL1A_SYSTEM_THRESH_HIGH ( 0x0C )
#define DL1A_SYSTEM_THRESH_LOW ( 0x0E )
#define DL1A_SYSTEM_HISTOGRAM_BIN ( 0x81 )
#define DL1A_RESULT_INTERRUPT_STATUS ( 0x13 )
#define DL1A_RESULT_RANGE_STATUS ( 0x14 )
#define DL1A_RESULT_PEAK_SIGNAL_RATE_REF ( 0xB6 )
#define DL1A_RESULT_CORE_AMBIENT_WINDOW_EVENTS_RTN ( 0xBC )
#define DL1A_RESULT_CORE_RANGING_TOTAL_EVENTS_RTN ( 0xC0 )
#define DL1A_RESULT_CORE_AMBIENT_WINDOW_EVENTS_REF ( 0xD0 )
#define DL1A_RESULT_CORE_RANGING_TOTAL_EVENTS_REF ( 0xD4 )
#define DL1A_PRE_RANGE_CONFIG_MIN_SNR ( 0x27 )
#define DL1A_PRE_RANGE_CONFIG_VCSEL_PERIOD ( 0x50 )
#define DL1A_PRE_RANGE_CONFIG_TIMEOUT_MACROP_HI ( 0x51 )
#define DL1A_PRE_RANGE_CONFIG_TIMEOUT_MACROP_LO ( 0x52 )
#define DL1A_PRE_RANGE_CONFIG_VALID_PHASE_LOW ( 0x56 )
#define DL1A_PRE_RANGE_CONFIG_VALID_PHASE_HIGH ( 0x57 )
#define DL1A_PRE_RANGE_CONFIG_SIGMA_THRESH_HI ( 0x61 )
#define DL1A_PRE_RANGE_CONFIG_SIGMA_THRESH_LO ( 0x62 )
#define DL1A_PRE_RANGE_MIN_COUNT_RATE_RTN_LIMIT ( 0x64 )
#define DL1A_FINAL_RANGE_CONFIG_VALID_PHASE_LOW ( 0x47 )
#define DL1A_FINAL_RANGE_CONFIG_VALID_PHASE_HIGH ( 0x48 )
#define DL1A_FINAL_RANGE_CONFIG_MIN_COUNT_RATE_RTN_LIMIT ( 0x44 )
#define DL1A_FINAL_RANGE_CONFIG_MIN_SNR ( 0x67 )
#define DL1A_FINAL_RANGE_CONFIG_VCSEL_PERIOD ( 0x70 )
#define DL1A_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_HI ( 0x71 )
#define DL1A_FINAL_RANGE_CONFIG_TIMEOUT_MACROP_LO ( 0x72 )
#define DL1A_GLOBAL_CONFIG_VCSEL_WIDTH ( 0x32 )
#define DL1A_GLOBAL_CONFIG_SPAD_ENABLES_REF_0 ( 0xB0 )
#define DL1A_GLOBAL_CONFIG_SPAD_ENABLES_REF_1 ( 0xB1 )
#define DL1A_GLOBAL_CONFIG_SPAD_ENABLES_REF_2 ( 0xB2 )
#define DL1A_GLOBAL_CONFIG_SPAD_ENABLES_REF_3 ( 0xB3 )
#define DL1A_GLOBAL_CONFIG_SPAD_ENABLES_REF_4 ( 0xB4 )
#define DL1A_GLOBAL_CONFIG_SPAD_ENABLES_REF_5 ( 0xB5 )
#define DL1A_GLOBAL_CONFIG_REF_EN_START_SELECT ( 0xB6 )
#define DL1A_ALGO_PART_TO_PART_RANGE_OFFSET_MM ( 0x28 )
#define DL1A_ALGO_PHASECAL_LIM ( 0x30 )
#define DL1A_ALGO_PHASECAL_CONFIG_TIMEOUT ( 0x30 )
#define DL1A_HISTOGRAM_CONFIG_INITIAL_PHASE_SELECT ( 0x33 )
#define DL1A_HISTOGRAM_CONFIG_READOUT_CTRL ( 0x55 )
#define DL1A_DYNAMIC_SPAD_NUM_REQUESTED_REF_SPAD ( 0x4E )
#define DL1A_DYNAMIC_SPAD_REF_EN_START_OFFSET ( 0x4F )
#define DL1A_MSRC_CONFIG_TIMEOUT_MACROP ( 0x46 )
#define DL1A_MSRC_CONFIG ( 0x60 )
#define DL1A_IDENTIFICATION_MODEL_ID ( 0xC0 )
#define DL1A_IDENTIFICATION_REVISION_ID ( 0xC2 )
#define DL1A_CROSSTALK_COMPENSATION_PEAK_RATE_MCPS ( 0x20 )
#define DL1A_POWER_MANAGEMENT_GO1_POWER_FORCE ( 0x80 )
#define DL1A_GPIO_HV_MUX_ACTIVE_HIGH ( 0x84 )
#define DL1A_I2C_SLAVE_DEVICE_ADDRESS ( 0x8A )
#define DL1A_SOFT_RESET_GO2_SOFT_RESET_N ( 0xBF )
#define DL1A_OSC_CALIBRATE_VAL ( 0xF8 )
#define DL1A_IO_VOLTAGE_CONFIG ( 0x89 ) // IO 电压设置寄存器地址 默认 1V8 使用修改为 2V8
//================================================定义 DL1A 内部地址================================================
#define DL1A_MIN_TIMING_BUDGET ( 20000 )
#define DL1A_GET_START_OVERHEAD ( 1910 )
#define DL1A_SET_START_OVERHEAD ( 1320 )
#define DL1A_END_OVERHEAD ( 960 )
#define DL1A_TCC_OVERHEAD ( 590 )
#define DL1A_DSS_OVERHEAD ( 690 )
#define DL1A_MSRC_OVERHEAD ( 660 )
#define DL1A_PRERANGE_OVERHEAD ( 660 )
#define DL1A_FINALlRANGE_OVERHEAD ( 550 )
typedef enum
{
DL1A_VCSEL_PERIOD_PER_RANGE,
DL1A_VCSEL_PERIOD_FINAL_RANGE,
}dl1a_vcsel_period_type_enum;
typedef struct
{
uint8 tcc;
uint8 msrc;
uint8 dss;
uint8 pre_range;
uint8 final_range;
}dl1a_sequence_enables_step_struct;
typedef struct
{
uint16 pre_range_vcsel_period_pclks;
uint16 final_range_vcsel_period_pclks;
uint16 msrc_dss_tcc_mclks;
uint16 pre_range_mclks;
uint16 final_range_mclks;
uint32 msrc_dss_tcc_us;
uint32 pre_range_us;
uint32 final_range_us;
}dl1a_sequence_timeout_step_struct;
extern uint8 dl1a_finsh_flag;
extern uint16 dl1a_distance_mm;
void dl1a_get_distance (void);
uint8 dl1a_init (void);
#endif