Chirp sensor device descriptor structure. More...

#include <soniclib.h>

Public Attributes
void *	algo_cfg_ptr

ICU_ALGO_SHASTA_INFO	algo_info

uint16_t	amp_scale_factor

uint8_t	app_i2c_address

ch_asic_gen_t	asic_gen

uint8_t	asic_ready

uint16_t	bandwidth

uint16_t	buf_addr

uint8_t	bus_index

uint32_t	cpu_frequency

uint8_t	cpu_trim

fw_info_t *	current_fw

int16_t	data_validation_counter

uint16_t	fcount_cycles

uint32_t	freerun_intvl_us

ch_group_t *	group

uint8_t	i2c_address

uint16_t	i2c_drv_flags

char	id_string [CH_SENSOR_ID_LENGTH]

fw_info_t *	init_fw_info

ch_interrupt_drive_t	int_drive

ch_interrupt_mode_t	int_mode

uint8_t	io_index

uint8_t	iq_output_format

uint8_t	is_continuous

uint8_t	last_measurement

fw_info_t *	main_fw_info

uint8_t	main_fw_init_done

uint16_t	max_range

uint16_t	meas_max_range_mm [CH_MEAS_MAX_MEAS]

uint32_t	meas_num_cycles [CH_MEAS_MAX_MEAS]

uint16_t	meas_num_rx_samples [CH_MEAS_MAX_MEAS]

uint8_t	meas_num_segments [CH_MEAS_MAX_MEAS]

uint16_t	meas_num_tx_segments [CH_MEAS_MAX_MEAS]

uint16_t	meas_pre_rx_cycles [CH_MEAS_MAX_MEAS]

measurement_queue_t	meas_queue

ch_meas_status_t	meas_status

ch_mode_t	mode

int16_t	mq_sanitize_enabled

uint16_t	num_iq_bytes

uint16_t	num_rx_samples

uint16_t	num_win_samples

uint8_t	odr_out

uint32_t	op_frequency

uint32_t	orig_pmut_freq

uint16_t	part_number

ch_pmut_clk_cfg_t	pmut_clk_cfg

uint16_t	pmut_clock_fcount

uint16_t	pmut_trim

uint8_t	reg_fmt_ver_major

uint8_t	reg_fmt_ver_minor

uint16_t	rtc_cal_result

uint16_t	rtc_frequency

ch_rtc_status_t	rtc_status

ICU_ALGO_SHASTA_INFO *	sens_algo_info_addr

shasta_config_t *	sens_cfg_addr

uint8_t	sensor_connected

uint16_t	static_range

ch_clock_cal_t	test_clock_cal

ch_tgt_int_filter_t	tgt_int_filter

uint16_t	tof_scale_factor

ch_trigger_type_t	trig_type

uint16_t	win_start_sample

Detailed Description

Chirp sensor device descriptor structure.

Member Data Documentation

◆ algo_cfg_ptr

void* ch_dev_t::algo_cfg_ptr

Sensor algorithm config pointer (might be initialized by some fw interfaces)

◆ algo_info

ICU_ALGO_SHASTA_INFO ch_dev_t::algo_info

Sensor algorithm information (copy)

◆ amp_scale_factor

uint16_t ch_dev_t::amp_scale_factor

Amplitude scale factor.

◆ app_i2c_address

uint8_t ch_dev_t::app_i2c_address

Assigned application I2C address for device in normal operation

◆ asic_gen

ch_asic_gen_t ch_dev_t::asic_gen

Sensor asic design generation.

◆ asic_ready

uint8_t ch_dev_t::asic_ready

Indicates ASIC is ready for commands

◆ bandwidth

uint16_t ch_dev_t::bandwidth

Bandwidth for the sensor.

◆ buf_addr

uint16_t ch_dev_t::buf_addr

Address of buffer containing the raw data

◆ bus_index

uint8_t ch_dev_t::bus_index

Index value identifying which SPI/I2C bus is used for this device.

◆ cpu_frequency

uint32_t ch_dev_t::cpu_frequency

CPU frequency for the sensor.

◆ cpu_trim

uint8_t ch_dev_t::cpu_trim

CPU clock freq trim value

◆ current_fw

fw_info_t* ch_dev_t::current_fw

Pointer on firmware currently used by sensor

◆ data_validation_counter

int16_t ch_dev_t::data_validation_counter

Counter value for data validation

◆ fcount_cycles

uint16_t ch_dev_t::fcount_cycles

freq count cycles

◆ freerun_intvl_us

uint32_t ch_dev_t::freerun_intvl_us

Measurement interval (in microsec), if in free-running mode

◆ group

ch_group_t* ch_dev_t::group

Pointer to parent group structure.

◆ i2c_address

uint8_t ch_dev_t::i2c_address

Current I2C addresses.

◆ i2c_drv_flags

uint16_t ch_dev_t::i2c_drv_flags

Flags for special I2C handling by Chirp driver

◆ init_fw_info

fw_info_t* ch_dev_t::init_fw_info

Pointer to firmware infos for initialization firmware (if necessary)

◆ int_drive

ch_interrupt_drive_t ch_dev_t::int_drive

Sensor interrupt drive type (open drain or push pull)

◆ int_mode

ch_interrupt_mode_t ch_dev_t::int_mode

Sensor interrupt mode (pulse or latching)

◆ io_index

uint8_t ch_dev_t::io_index

Index value (device number) identifying device within group

◆ iq_output_format

uint8_t ch_dev_t::iq_output_format

I/Q output format in last measurement

◆ is_continuous

uint8_t ch_dev_t::is_continuous

1 if last meas was continuous mode

◆ last_measurement

uint8_t ch_dev_t::last_measurement

Number of last completed measurement

◆ main_fw_info

fw_info_t* ch_dev_t::main_fw_info

Pointer to firmware infos for main/application firmware

◆ main_fw_init_done

uint8_t ch_dev_t::main_fw_init_done

Flag to indicate if main/application firmware have been initialized

◆ max_range

uint16_t ch_dev_t::max_range

Maximum range, in mm

◆ meas_queue

measurement_queue_t ch_dev_t::meas_queue

Sensor measurement queue (local copy)

◆ meas_status

ch_meas_status_t ch_dev_t::meas_status

Sensor measurement status

◆ mode

ch_mode_t ch_dev_t::mode

Sensor operating mode.

◆ num_iq_bytes

uint16_t ch_dev_t::num_iq_bytes

Number of valid I/Q bytes in last measurement

◆ num_rx_samples

uint16_t ch_dev_t::num_rx_samples

Number of receiver samples for the current max range setting.

◆ num_win_samples

uint16_t ch_dev_t::num_win_samples

Number of samples in sample window, if supported

◆ odr_out

uint8_t ch_dev_t::odr_out

Output ODR used in last measurement

◆ op_frequency

uint32_t ch_dev_t::op_frequency

Operating acoustic frequency for the sensor.

◆ orig_pmut_freq

uint32_t ch_dev_t::orig_pmut_freq

Starting PMUT frequency

◆ part_number

uint16_t ch_dev_t::part_number

Integer part number (e.g. 101 for a CH101 device).

◆ pmut_clk_cfg

ch_pmut_clk_cfg_t ch_dev_t::pmut_clk_cfg

PMUT clock input/output configuration

◆ pmut_clock_fcount

uint16_t ch_dev_t::pmut_clock_fcount

raw PMUT count from freq calculation

◆ pmut_trim

uint16_t ch_dev_t::pmut_trim

PMUT freq trim value

◆ reg_fmt_ver_major

uint8_t ch_dev_t::reg_fmt_ver_major

SW defined register format major version

◆ reg_fmt_ver_minor

uint8_t ch_dev_t::reg_fmt_ver_minor

SW defined register format minor version

◆ rtc_cal_result

uint16_t ch_dev_t::rtc_cal_result

Real-time clock calibration result for the sensor.

◆ rtc_frequency

uint16_t ch_dev_t::rtc_frequency

Internal real-time-clock frequency for the sensor.

◆ rtc_status

ch_rtc_status_t ch_dev_t::rtc_status

Sensor real-time clock status

◆ sens_algo_info_addr

ICU_ALGO_SHASTA_INFO* ch_dev_t::sens_algo_info_addr

Algorithm info addr on sensor

◆ sens_cfg_addr

shasta_config_t* ch_dev_t::sens_cfg_addr

Sensor ID string: 3 byte lot + 4 byte serial num + null Address of sensor shared config mem

◆ sensor_connected

uint8_t ch_dev_t::sensor_connected

Sensor connection status: 1 if discovered and successfully initialized, 0 otherwise.

◆ static_range

uint16_t ch_dev_t::static_range

Static target rejection range, in samples (0 if unused)

◆ test_clock_cal

ch_clock_cal_t ch_dev_t::test_clock_cal

Clock calibration values from factory test

◆ tgt_int_filter

ch_tgt_int_filter_t ch_dev_t::tgt_int_filter

Target interrupt filter mode

◆ tof_scale_factor

uint16_t ch_dev_t::tof_scale_factor

Time-of-flight scale factor.

◆ trig_type

ch_trigger_type_t ch_dev_t::trig_type

Sensor triggering type (hardware or software)

◆ win_start_sample

uint16_t ch_dev_t::win_start_sample

Starting sample of sample window, if supported

The documentation for this struct was generated from the following file:

invn/soniclib/soniclib.h

Public Attributes