ch101_gpr.h

Go to the documentation of this file.

 
/*
 Copyright 2016-2023, InvenSense, Inc.  All rights reserved.
 
 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 AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED.
 
 */
 
#ifndef CH101_GPR_H_
#define CH101_GPR_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#include "ch101.h"
#include <invn/soniclib/ch_rangefinder.h>
#include <invn/soniclib/soniclib.h>
 
/* GPR firmware registers */
#define CH101_GPR_REG_OPMODE          0x01
#define CH101_GPR_REG_TICK_INTERVAL   0x02
#define CH101_GPR_REG_IN_RINGDOWN_IDX 0x04
#define CH101_GPR_REG_PERIOD          0x05
#define CH101_GPR_REG_CAL_TRIG        0x06
#define CH101_GPR_REG_CAL_TRIG        0x06
#define CH101_GPR_REG_MAX_RANGE       0x07
#define CH101_GPR_REG_IN_RINGDOWN_THS 0x08
#define CH101_GPR_REG_REV_CYCLES      0x0C
#define CH101_GPR_REG_DCO_PERIOD      0x0E
#define CH101_GPR_REG_ST_RANGE        0x12
#define CH101_GPR_REG_READY           0x14
#define CH101_GPR_REG_IN_RINGDOWN     0x15
#define CH101_GPR_REG_TOF_SF          0x16
#define CH101_GPR_REG_TOF             0x18
#define CH101_GPR_REG_AMPLITUDE       0x1A
#define CH101_GPR_REG_CAL_RESULT      0x0A
#define CH101_GPR_REG_DATA            0x1C
 
#define CH101_GPR_MAX_SAMPLES (225)
 
extern const char *ch101_gpr_version;  // version string in fw .c file
extern const uint8_t ch101_gpr_fw_text[];
extern const uint8_t ch101_gpr_fw_vec[];
extern const uint16_t ch101_gpr_text_size;
extern const uint16_t ch101_gpr_vec_size;
 
uint16_t get_ch101_gpr_fw_ram_init_addr(void);
uint16_t get_ch101_gpr_fw_ram_init_size(void);
 
const unsigned char *get_ram_ch101_gpr_init_ptr(void);
 
uint8_t ch101_gpr_init(ch_dev_t *dev_ptr, fw_info_t **fw_info);
 
uint8_t ch101_gpr_get_target_in_ringdown(ch_dev_t *dev_ptr);
 
uint16_t ch101_gpr_get_in_ringdown_ths(ch_dev_t *dev_ptr);
 
void ch101_gpr_set_in_ringdown_ths(ch_dev_t *dev_ptr, uint16_t in_ringdown_ths);
 
uint8_t ch101_gpr_get_in_ringdown_idx(ch_dev_t *dev_ptr);
 
void ch101_gpr_set_in_ringdown_idx(ch_dev_t *dev_ptr, uint8_t in_ringdown_idx);
 
#ifdef __cplusplus
}
#endif
 
#endif