From f526aa2b8f897898074c216f724ce0c7b06e03e7 Mon Sep 17 00:00:00 2001 From: hulk Date: Thu, 8 Aug 2024 19:18:16 +0800 Subject: [PATCH] first commit v2.0.1 --- .gitignore | 8 + CHIRP/board/app_config.h | 194 ++ CHIRP/board/app_version.h | 32 + CHIRP/board/bsp_misc_gd32e230.c | 49 + CHIRP/board/chbsp_chirp_gd32e230f4.c | 781 +++++ CHIRP/board/chirp_board_config.h | 88 + CHIRP/board/chirp_smartsonic.h | 83 + CHIRP/board/i2c.c | 762 +++++ CHIRP/board/i2c.h | 55 + CHIRP/drivers/inc/Doxyfile | 2511 +++++++++++++++++ CHIRP/drivers/inc/README.md | 47 + CHIRP/drivers/inc/ch101.h | 47 + CHIRP/drivers/inc/ch101_finaltest.h | 212 ++ CHIRP/drivers/inc/ch101_floor.h | 71 + CHIRP/drivers/inc/ch101_gppc.h | 99 + CHIRP/drivers/inc/ch101_gpr.h | 73 + CHIRP/drivers/inc/ch101_gpr_narrow.h | 76 + CHIRP/drivers/inc/ch101_gpr_narrow_wd.h | 76 + CHIRP/drivers/inc/ch101_gpr_open.h | 73 + CHIRP/drivers/inc/ch101_gpr_rxopt.h | 72 + CHIRP/drivers/inc/ch101_gpr_rxopt_narrow.h | 72 + CHIRP/drivers/inc/ch101_gpr_rxopt_narrow_wd.h | 72 + CHIRP/drivers/inc/ch101_gpr_rxopt_wd.h | 72 + CHIRP/drivers/inc/ch101_gpr_sr.h | 72 + CHIRP/drivers/inc/ch101_gpr_sr_narrow.h | 72 + CHIRP/drivers/inc/ch101_gpr_sr_narrow_wd.h | 72 + CHIRP/drivers/inc/ch101_gpr_sr_open.h | 74 + CHIRP/drivers/inc/ch101_gpr_sr_wd.h | 72 + CHIRP/drivers/inc/ch101_gpr_wd.h | 73 + CHIRP/drivers/inc/ch101_liquid.h | 71 + CHIRP/drivers/inc/ch101_sonicsync.h | 78 + CHIRP/drivers/inc/ch201.h | 48 + CHIRP/drivers/inc/ch201_finaltest.h | 229 ++ CHIRP/drivers/inc/ch201_gprmt.h | 76 + CHIRP/drivers/inc/ch201_gprmt_wd.h | 74 + CHIRP/drivers/inc/ch201_gprstr.h | 77 + CHIRP/drivers/inc/ch201_gprstr_wd.h | 77 + CHIRP/drivers/inc/ch201_presence.h | 92 + CHIRP/drivers/inc/ch_common.h | 173 ++ CHIRP/drivers/inc/ch_driver.h | 597 ++++ CHIRP/drivers/inc/ch_math_utils.h | 49 + CHIRP/drivers/inc/chirp_bsp.h | 1041 +++++++ CHIRP/drivers/inc/soniclib.h | 1887 +++++++++++++ CHIRP/drivers/src/ch101_finaltest.c | 240 ++ CHIRP/drivers/src/ch101_finaltest_fw.c | 156 + CHIRP/drivers/src/ch101_floor.c | 153 + CHIRP/drivers/src/ch101_floor_fw.c | 153 + CHIRP/drivers/src/ch101_gppc.c | 575 ++++ CHIRP/drivers/src/ch101_gppc_fw.c | 156 + CHIRP/drivers/src/ch101_gpr.c | 93 + CHIRP/drivers/src/ch101_gpr_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_lowpwr_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_narrow.c | 93 + CHIRP/drivers/src/ch101_gpr_narrow_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_narrow_wd.c | 93 + CHIRP/drivers/src/ch101_gpr_narrow_wd_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_open.c | 106 + CHIRP/drivers/src/ch101_gpr_open_fw.c | 157 ++ CHIRP/drivers/src/ch101_gpr_rxopt.c | 92 + CHIRP/drivers/src/ch101_gpr_rxopt_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_rxopt_narrow.c | 92 + CHIRP/drivers/src/ch101_gpr_rxopt_narrow_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_rxopt_narrow_wd.c | 92 + .../src/ch101_gpr_rxopt_narrow_wd_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_rxopt_wd.c | 92 + CHIRP/drivers/src/ch101_gpr_rxopt_wd_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_sr.c | 93 + CHIRP/drivers/src/ch101_gpr_sr_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_sr_narrow.c | 93 + CHIRP/drivers/src/ch101_gpr_sr_narrow_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_sr_narrow_wd.c | 93 + CHIRP/drivers/src/ch101_gpr_sr_narrow_wd_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_sr_open.c | 106 + CHIRP/drivers/src/ch101_gpr_sr_open_fw.c | 157 ++ CHIRP/drivers/src/ch101_gpr_sr_wd.c | 93 + CHIRP/drivers/src/ch101_gpr_sr_wd_fw.c | 156 + CHIRP/drivers/src/ch101_gpr_wd.c | 93 + CHIRP/drivers/src/ch101_gpr_wd_fw.c | 156 + CHIRP/drivers/src/ch101_liquid.c | 94 + CHIRP/drivers/src/ch101_liquid_fw.c | 157 ++ CHIRP/drivers/src/ch101_sonicsync.c | 129 + CHIRP/drivers/src/ch101_sonicsync_master_fw.c | 152 + CHIRP/drivers/src/ch101_sonicsync_slave_fw.c | 152 + CHIRP/drivers/src/ch201_finaltest.c | 244 ++ CHIRP/drivers/src/ch201_finaltest_fw.c | 156 + CHIRP/drivers/src/ch201_gprmt.c | 94 + CHIRP/drivers/src/ch201_gprmt_fw.c | 157 ++ CHIRP/drivers/src/ch201_gprmt_wd.c | 90 + CHIRP/drivers/src/ch201_gprmt_wd_fw.c | 157 ++ CHIRP/drivers/src/ch201_gprstr.c | 426 +++ CHIRP/drivers/src/ch201_gprstr_fw.c | 157 ++ CHIRP/drivers/src/ch201_gprstr_wd.c | 421 +++ CHIRP/drivers/src/ch201_gprstr_wd_fw.c | 157 ++ CHIRP/drivers/src/ch201_presence.c | 140 + CHIRP/drivers/src/ch201_presence_fw.c | 151 + CHIRP/drivers/src/ch_api.c | 846 ++++++ CHIRP/drivers/src/ch_common.c | 1035 +++++++ CHIRP/drivers/src/ch_driver.c | 1304 +++++++++ CHIRP/drivers/src/ch_math_utils.c | 108 + CHIRP/drivers/src/chbsp_dummy.c | 117 + .../inc/ultrasound_display_config_info.h | 44 + .../src/ultrasound_display_config_info.c | 86 + Firmware/CMSIS/GD/GD32E23x/Include/gd32e23x.h | 215 ++ .../GD/GD32E23x/Include/system_gd32e23x.h | 58 + .../GD/GD32E23x/Source/ARM/startup_gd32e23x.s | 254 ++ .../GD/GD32E23x/Source/IAR/startup_gd32e23x.s | 281 ++ .../GD/GD32E23x/Source/system_gd32e23x.c | 384 +++ .../Include/gd32e23x_adc.h | 349 +++ .../Include/gd32e23x_cmp.h | 160 ++ .../Include/gd32e23x_crc.h | 123 + .../Include/gd32e23x_dbg.h | 121 + .../Include/gd32e23x_dma.h | 262 ++ .../Include/gd32e23x_exti.h | 280 ++ .../Include/gd32e23x_fmc.h | 270 ++ .../Include/gd32e23x_fwdgt.h | 124 + .../Include/gd32e23x_gpio.h | 388 +++ .../Include/gd32e23x_i2c.h | 381 +++ .../Include/gd32e23x_misc.h | 84 + .../Include/gd32e23x_pmu.h | 148 + .../Include/gd32e23x_rcu.h | 670 +++++ .../Include/gd32e23x_rtc.h | 559 ++++ .../Include/gd32e23x_spi.h | 424 +++ .../Include/gd32e23x_syscfg.h | 191 ++ .../Include/gd32e23x_timer.h | 758 +++++ .../Include/gd32e23x_usart.h | 591 ++++ .../Include/gd32e23x_wwdgt.h | 93 + .../Source/gd32e23x_adc.c | 842 ++++++ .../Source/gd32e23x_cmp.c | 183 ++ .../Source/gd32e23x_crc.c | 241 ++ .../Source/gd32e23x_dbg.c | 138 + .../Source/gd32e23x_dma.c | 560 ++++ .../Source/gd32e23x_exti.c | 251 ++ .../Source/gd32e23x_fmc.c | 815 ++++++ .../Source/gd32e23x_fwdgt.c | 245 ++ .../Source/gd32e23x_gpio.c | 399 +++ .../Source/gd32e23x_i2c.c | 797 ++++++ .../Source/gd32e23x_misc.c | 141 + .../Source/gd32e23x_pmu.c | 289 ++ .../Source/gd32e23x_rcu.c | 1058 +++++++ .../Source/gd32e23x_rtc.c | 962 +++++++ .../Source/gd32e23x_spi.c | 965 +++++++ .../Source/gd32e23x_syscfg.c | 206 ++ .../Source/gd32e23x_timer.c | 2057 ++++++++++++++ .../Source/gd32e23x_usart.c | 1274 +++++++++ .../Source/gd32e23x_wwdgt.c | 126 + Utilities/gd32e230c_eval.c | 240 ++ Utilities/gd32e230c_eval.h | 141 + XLSW_SONIC/Keil_project/Project.uvoptx | 793 ++++++ XLSW_SONIC/Keil_project/Project.uvprojx | 647 +++++ XLSW_SONIC/board_init.c | 95 + XLSW_SONIC/board_init.h | 10 + XLSW_SONIC/gd32e23x_it.c | 107 + XLSW_SONIC/gd32e23x_it.h | 62 + XLSW_SONIC/gd32e23x_libopt.h | 58 + XLSW_SONIC/main.c | 470 +++ XLSW_SONIC/main.h | 39 + XLSW_SONIC/readme.txt | 36 + XLSW_SONIC/systick.c | 94 + XLSW_SONIC/systick.h | 27 + 159 files changed, 43838 insertions(+) create mode 100644 .gitignore create mode 100644 CHIRP/board/app_config.h create mode 100644 CHIRP/board/app_version.h create mode 100644 CHIRP/board/bsp_misc_gd32e230.c create mode 100644 CHIRP/board/chbsp_chirp_gd32e230f4.c create mode 100644 CHIRP/board/chirp_board_config.h create mode 100644 CHIRP/board/chirp_smartsonic.h create mode 100644 CHIRP/board/i2c.c create mode 100644 CHIRP/board/i2c.h create mode 100644 CHIRP/drivers/inc/Doxyfile create mode 100644 CHIRP/drivers/inc/README.md create mode 100644 CHIRP/drivers/inc/ch101.h create mode 100644 CHIRP/drivers/inc/ch101_finaltest.h create mode 100644 CHIRP/drivers/inc/ch101_floor.h create mode 100644 CHIRP/drivers/inc/ch101_gppc.h create mode 100644 CHIRP/drivers/inc/ch101_gpr.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_narrow.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_narrow_wd.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_open.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_rxopt.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_rxopt_narrow.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_rxopt_narrow_wd.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_rxopt_wd.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_sr.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_sr_narrow.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_sr_narrow_wd.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_sr_open.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_sr_wd.h create mode 100644 CHIRP/drivers/inc/ch101_gpr_wd.h create mode 100644 CHIRP/drivers/inc/ch101_liquid.h create mode 100644 CHIRP/drivers/inc/ch101_sonicsync.h create mode 100644 CHIRP/drivers/inc/ch201.h create mode 100644 CHIRP/drivers/inc/ch201_finaltest.h create mode 100644 CHIRP/drivers/inc/ch201_gprmt.h create mode 100644 CHIRP/drivers/inc/ch201_gprmt_wd.h create mode 100644 CHIRP/drivers/inc/ch201_gprstr.h create mode 100644 CHIRP/drivers/inc/ch201_gprstr_wd.h create mode 100644 CHIRP/drivers/inc/ch201_presence.h create mode 100644 CHIRP/drivers/inc/ch_common.h create mode 100644 CHIRP/drivers/inc/ch_driver.h create mode 100644 CHIRP/drivers/inc/ch_math_utils.h create mode 100644 CHIRP/drivers/inc/chirp_bsp.h create mode 100644 CHIRP/drivers/inc/soniclib.h create mode 100644 CHIRP/drivers/src/ch101_finaltest.c create mode 100644 CHIRP/drivers/src/ch101_finaltest_fw.c create mode 100644 CHIRP/drivers/src/ch101_floor.c create mode 100644 CHIRP/drivers/src/ch101_floor_fw.c create mode 100644 CHIRP/drivers/src/ch101_gppc.c create mode 100644 CHIRP/drivers/src/ch101_gppc_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr.c create mode 100644 CHIRP/drivers/src/ch101_gpr_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_lowpwr_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_narrow.c create mode 100644 CHIRP/drivers/src/ch101_gpr_narrow_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_narrow_wd.c create mode 100644 CHIRP/drivers/src/ch101_gpr_narrow_wd_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_open.c create mode 100644 CHIRP/drivers/src/ch101_gpr_open_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_narrow.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_narrow_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_narrow_wd.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_narrow_wd_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_wd.c create mode 100644 CHIRP/drivers/src/ch101_gpr_rxopt_wd_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_narrow.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_narrow_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_narrow_wd.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_narrow_wd_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_open.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_open_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_wd.c create mode 100644 CHIRP/drivers/src/ch101_gpr_sr_wd_fw.c create mode 100644 CHIRP/drivers/src/ch101_gpr_wd.c create mode 100644 CHIRP/drivers/src/ch101_gpr_wd_fw.c create mode 100644 CHIRP/drivers/src/ch101_liquid.c create mode 100644 CHIRP/drivers/src/ch101_liquid_fw.c create mode 100644 CHIRP/drivers/src/ch101_sonicsync.c create mode 100644 CHIRP/drivers/src/ch101_sonicsync_master_fw.c create mode 100644 CHIRP/drivers/src/ch101_sonicsync_slave_fw.c create mode 100644 CHIRP/drivers/src/ch201_finaltest.c create mode 100644 CHIRP/drivers/src/ch201_finaltest_fw.c create mode 100644 CHIRP/drivers/src/ch201_gprmt.c create mode 100644 CHIRP/drivers/src/ch201_gprmt_fw.c create mode 100644 CHIRP/drivers/src/ch201_gprmt_wd.c create mode 100644 CHIRP/drivers/src/ch201_gprmt_wd_fw.c create mode 100644 CHIRP/drivers/src/ch201_gprstr.c create mode 100644 CHIRP/drivers/src/ch201_gprstr_fw.c create mode 100644 CHIRP/drivers/src/ch201_gprstr_wd.c create mode 100644 CHIRP/drivers/src/ch201_gprstr_wd_fw.c create mode 100644 CHIRP/drivers/src/ch201_presence.c create mode 100644 CHIRP/drivers/src/ch201_presence_fw.c create mode 100644 CHIRP/drivers/src/ch_api.c create mode 100644 CHIRP/drivers/src/ch_common.c create mode 100644 CHIRP/drivers/src/ch_driver.c create mode 100644 CHIRP/drivers/src/ch_math_utils.c create mode 100644 CHIRP/drivers/src/chbsp_dummy.c create mode 100644 CHIRP/ultrasound/inc/ultrasound_display_config_info.h create mode 100644 CHIRP/ultrasound/src/ultrasound_display_config_info.c create mode 100644 Firmware/CMSIS/GD/GD32E23x/Include/gd32e23x.h create mode 100644 Firmware/CMSIS/GD/GD32E23x/Include/system_gd32e23x.h create mode 100644 Firmware/CMSIS/GD/GD32E23x/Source/ARM/startup_gd32e23x.s create mode 100644 Firmware/CMSIS/GD/GD32E23x/Source/IAR/startup_gd32e23x.s create mode 100644 Firmware/CMSIS/GD/GD32E23x/Source/system_gd32e23x.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_adc.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_cmp.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_crc.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_dbg.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_dma.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_exti.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_fmc.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_fwdgt.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_gpio.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_i2c.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_misc.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_pmu.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_rcu.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_rtc.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_spi.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_syscfg.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_timer.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_usart.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Include/gd32e23x_wwdgt.h create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_adc.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_cmp.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_crc.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_dbg.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_dma.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_exti.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_fmc.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_fwdgt.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_gpio.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_i2c.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_misc.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_pmu.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_rcu.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_rtc.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_spi.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_syscfg.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_timer.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_usart.c create mode 100644 Firmware/GD32E23x_standard_peripheral/Source/gd32e23x_wwdgt.c create mode 100644 Utilities/gd32e230c_eval.c create mode 100644 Utilities/gd32e230c_eval.h create mode 100644 XLSW_SONIC/Keil_project/Project.uvoptx create mode 100644 XLSW_SONIC/Keil_project/Project.uvprojx create mode 100644 XLSW_SONIC/board_init.c create mode 100644 XLSW_SONIC/board_init.h create mode 100644 XLSW_SONIC/gd32e23x_it.c create mode 100644 XLSW_SONIC/gd32e23x_it.h create mode 100644 XLSW_SONIC/gd32e23x_libopt.h create mode 100644 XLSW_SONIC/main.c create mode 100644 XLSW_SONIC/main.h create mode 100644 XLSW_SONIC/readme.txt create mode 100644 XLSW_SONIC/systick.c create mode 100644 XLSW_SONIC/systick.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2297989 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +XLSW_SONIC/Keil_project/.vscode/ +XLSW_SONIC/Keil_project/output/ +XLSW_SONIC/Keil_project/list/ +XLSW_SONIC/Keil_project/RTE/ +XLSW_SONIC/Keil_project/EventRecorderStub.scvd +XLSW_SONIC/Keil_project/JLinkLog.txt +XLSW_SONIC/Keil_project/JLinkSettings.ini +XLSW_SONIC/Keil_project/Project.uvguix.Administrator \ No newline at end of file diff --git a/CHIRP/board/app_config.h b/CHIRP/board/app_config.h new file mode 100644 index 0000000..d83e37a --- /dev/null +++ b/CHIRP/board/app_config.h @@ -0,0 +1,194 @@ +/* + * _____________________________________________________________________________ + * Copyright (c) 2020-2021 InvenSense Inc. All rights reserved. + * + * This software, related documentation and any modifications thereto + * (collectively "Software") is subject to InvenSense and its licensors' + * intellectual property rights under U.S. and international copyright + * and other intellectual property rights laws. + * + * InvenSense and its licensors retain all intellectual property and proprietary + * rights in and to the Software and any use, reproduction, disclosure or + * distribution of the Software without an express license agreement from + * InvenSense is strictly prohibited. + * + * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE + * SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. EXCEPT AS OTHERWISE + * PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL + * INVENSENSE BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR + * CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF + * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER + * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THE SOFTWARE. + * _____________________________________________________________________________ + */ + +/*! \file app_config.h */ +#ifndef APP_CONFIG_H +#define APP_CONFIG_H + +#include "soniclib.h" + +/*========================= Sensor Firmware Selection ===========================*/ + +/* Select sensor firmware to use + * The sensor firmware type is specified during the call to ch_init(), by + * giving the name (address) of the firmware initialization function that will + * be called. The CHIRP_SENSOR_FW_INIT_FUNC symbol is used to specify the + * init routine for the sensor firmware to be used. + * + * Uncomment ONE of the following lines to use that sensor firmware type. + * You must choose a firmware type that is appropriate for the sensor model + * you are using (CH101 or CH201). + * + * To use a different sensor firmware type than those listed here (for + * example, a new distribution from Chirp), simply define + * CHIRP_SENSOR_FW_INIT_FUNC to equal the name of the init routine for + * the new firmware. + * + * Short Range Firmware: + * CH101 sensor firmware with "sr" in the name, e.g. ch101_gpr_sr, is + * optimized for short range. The short range firmware has 4 times the + * resolution, but only 1/4 the maximum range. If you use this option, you + * should redefine the CHIRP_SENSOR_MAX_RANGE_MM symbol, below, to 250mm or + * less. + */ + + /* CH101 GPR - general purpose rangefinding, standard range */ +#define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_init + + /* CH101 GPR NARROW - general purpose rangefinding, narrow FoV */ +// #define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_narrow_init + + /* CH101 GPR SR - general purpose rangefinding, short range */ +// #define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_sr_init + + /* CH101 GPR SR NARROW - general purpose rangefinding, short range, narrow FoV */ +// #define CHIRP_SENSOR_FW_INIT_FUNC ch101_gpr_sr_narrow_init + + /* CH201 GPRMT - general purpose rangefinding / multi threshold */ +// #define CHIRP_SENSOR_FW_INIT_FUNC ch201_gprmt_init + + +/*=========================== Sensor Configuration ===========================*/ + +/* Maximum detection range for the sensor + * This value will determine how long the sensor "listens" for an ultrasound + * signal. Note that the maximum possible range will vary depending on sensor + * model (CH101 vs. CH201) and sensor firmware type. If the value specified + * here is greater than the maximum possible range, the maximum possible range + * will be used. + */ +#define CHIRP_SENSOR_MAX_RANGE_MM (750) /* maximum range, in mm */ + +/* Static target rejection range + * This value specifies if static target rejection (STR) will be used. If + * CHIRP_SENSOR_STATIC_RANGE is non-zero, STR will be enabled and will apply + * to the specified number of samples at the beginning of a measurement. + */ +#define CHIRP_SENSOR_STATIC_RANGE (100) /* static target rejection sample + range, in samples (0=disabled) */ + + +/*============================ Application Timing ============================*/ + +/* Define how often the application will get a new sample from the sensor(s) + * This macro defines the sensor measurement interval, in milliseconds. + * + * For sensors in triggered mode (CH_MODE_TRIGGERED_TX_RX or + * CH_MODE_TRIGGERED_RX_ONLY), the application will use a periodic timer to + * trigger a sensor measurement each time this period elapses. + * + * For sensors in free-running mode (CH_MODE_FREERUN), the application will + * set this period as the sensor's internal sample interval. + */ + +#define MEASUREMENT_INTERVAL_MS (200) + + +/*================== Application Storage for Sensor Data ====================*/ + +/* Define how many samples per measurement are expected by this application + * The following macro is used to allocate array storage in the "chirp_data_t" + * structure, defined in main.c. That structure contains arrays for + * individual data values (I/Q or amplitude) that describe the raw samples + * within an ultrasound measurement. + * + * Because a Chirp CH201 sensor has more samples in each measurement than a + * CH101 device, the CH201 sample count is used here by default. If you are + * ONLY using CH101 devices with this application, you may redefine the + * following symbol to CH101_MAX_NUM_SAMPLES to use less memory. + */ + +#define DATA_MAX_NUM_SAMPLES CH101_MAX_NUM_SAMPLES // use CH101 only + + +/*=============== Build Options for Amplitude Data Handling =================*/ + +/* The following build options control if and how the full amplitude data for + * all internal samples within an ultrasound measurement will be read and + * displayed. This data is separate from the standard range and simple target + * amplitude values that are normally output. + * + * Note that reading the full amplitude data is not required for most basic + * sensing applications - the reported range value, possibly combined with the + * simple target amplitude value, is typically all that is required. However, + * the full set of amplitude values may be read and analyzed for more advanced + * sensing or data capture needs. + * + * Comment or un-comment the various definitions, as appropriate. + * + * Define READ_AMPLITUDE_DATA to enable readout of the amplitude data. + * Define OUTPUT_AMPLITUDE_DATA to enable output of the amplitude data via the + * serial port, as ascii values, one per line. + */ + +// #define READ_AMPLITUDE_DATA /* uncomment to readout amplitude data */ + +// #define OUTPUT_AMPLITUDE_DATA /* uncomment to output data in ascii */ + + +/*================== Build Options for I/Q Data Handling ====================*/ + +/* The following build options control if and how the raw I/Q data is read + * from the device after each measurement cycle, in addition to the standard + * range and amplitude. + * + * Note that reading the I/Q data is not required for most basic sensing + * applications - the reported range value is typically all that is required. + * However, the full data set may be read and analyzed for more advanced + * sensing or data capture needs. + * + * Comment or un-comment the various definitions, as appropriate. + * + * Define READ_IQ_DATA to enable readout of the I/Q data. + * + * By default, this application will read the I/Q data in blocking mode + * (i.e. READ_IQ_BLOCKING is defined by default). The data will be read from + * the device and placed in the I/Q data array field in the application's + * chirp_data structure. Because the I/Q data is read in blocking mode, the + * call to ch_get_iq_data() will not return until the data has actually + * been copied from the device. + * + * If, however, READ_IQ_NONBLOCKING is defined instead, the I/Q data will be + * read in non-blocking mode. The ch_get_iq_data() call will return immediately, + * and a separate callback function will be called to notify the application + * when the read operation is complete. + * + * Finally, if OUTPUT_IQ_DATA_CSV is defined, the application will write the + * I/Q data values out through the serial port in ascii form as comma-separated + * numeric value pairs (Q,I). This can make it easier to take the data + * from the application and analyze it in a spreadsheet or other program. + */ + +// #define READ_IQ_DATA /* uncomment this line to readout I/Q data */ + +// #define READ_IQ_BLOCKING /* use blocking mode when reading I/Q */ +// #define READ_IQ_NONBLOCKING /* use non-blocking mode when reading I/Q */ + +// #define OUTPUT_IQ_DATA_CSV /* uncomment to output I/Q data in CSV format */ + + +#endif /* APP_CONFIG_H */ diff --git a/CHIRP/board/app_version.h b/CHIRP/board/app_version.h new file mode 100644 index 0000000..691b20b --- /dev/null +++ b/CHIRP/board/app_version.h @@ -0,0 +1,32 @@ +/* + * ________________________________________________________________________________________________________ + * Copyright (c) 2020-2021 InvenSense Inc. All rights reserved. + * + * This software, related documentation and any modifications thereto (collectively “Software”) is subject + * to InvenSense and its licensors' intellectual property rights under U.S. and international copyright + * and other intellectual property rights laws. + * + * InvenSense and its licensors retain all intellectual property and proprietary rights in and to the Software + * and any use, reproduction, disclosure or distribution of the Software without an express license agreement + * from InvenSense is strictly prohibited. + * + * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE SOFTWARE IS + * PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED + * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. + * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL + * INVENSENSE BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY + * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, + * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THE SOFTWARE. + * ________________________________________________________________________________________________________ + */ + +/*! \file app_version.h */ +#ifndef APP_VERSION_H +#define APP_VERSION_H + +#define APP_VERSION_MAJOR 2 +#define APP_VERSION_MINOR 0 +#define APP_VERSION_REV 1 + +#endif /* APP_VERSION_H */ \ No newline at end of file diff --git a/CHIRP/board/bsp_misc_gd32e230.c b/CHIRP/board/bsp_misc_gd32e230.c new file mode 100644 index 0000000..f1ca8a6 --- /dev/null +++ b/CHIRP/board/bsp_misc_gd32e230.c @@ -0,0 +1,49 @@ +#include +#include +#include +#include +#include + +#include "gd32e23x.h" +#include "systick.h" + +#include "chirp_smartsonic.h" +#include "soniclib.h" +#include "chirp_bsp.h" + +#include "board_init.h" +#include "chirp_board_config.h" + +#include "app_config.h" + + +void sensor_led_on(void) { + gpio_bit_reset(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); // PB1 = Lo LED = On +} + +void sensor_led_off(void) { + gpio_bit_set(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); // PB1 = Hi LED = Off +} + +void sensor_led_toggle(void) +{ + gpio_bit_toggle(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); +} + +/*! + \brief Indicate Board Alive + \param[in] none + \param[out] none + \retval none + \note LED Heart Beat +*/ +void indicate_alive(void){ + gpio_bit_reset(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); // PB1 = Lo LED = On + delay_ms(100); + gpio_bit_set(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); // PB1 = Hi LED = Off + delay_ms(100); + gpio_bit_reset(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); // PB1 = Lo LED = On + delay_ms(100); + gpio_bit_set(CHIRP_PIN_LED_PORT, CHIRP_PIN_LED_PIN); // PB1 = Hi LED = Off + delay_ms(300); +} \ No newline at end of file diff --git a/CHIRP/board/chbsp_chirp_gd32e230f4.c b/CHIRP/board/chbsp_chirp_gd32e230f4.c new file mode 100644 index 0000000..33cf89d --- /dev/null +++ b/CHIRP/board/chbsp_chirp_gd32e230f4.c @@ -0,0 +1,781 @@ +#include +#include +#include +#include "gd32e23x.h" +#include "systick.h" +#include "soniclib.h" +#include "chirp_smartsonic.h" + +#include "board_init.h" +#include "chirp_board_config.h" +#include "i2c.h" + + + +static uint8_t chirp_i2c_addrs[] = CHIRP_I2C_ADDRS; +static uint8_t chirp_i2c_buses[] = CHIRP_I2C_BUSES; + + +/* chirp sensor group pointer */ +ch_group_t *sensor_group_ptr; + +/* Callback function pointers */ +static ch_timer_callback_t periodic_timer_callback_ptr = NULL; + +static uint16_t periodic_timer_interval_ms; + +static uint16_t ultrasound_timer_period_in_tick = 0xFFFF; +static uint16_t ultrasound_prev_period_end_in_tick; + +/* Counter used to decimate call to ultrasound timer callback from TC0 ISR in case decimation + factor is != 1 */ +static uint8_t decimation_counter = 0; + + +#ifdef CHIRP_ADC_NONE +static void measure_idd(uint16_t nb_measure){ + __NOP(); +} +#elif +static void measure_idd(uint16_t nb_measure){ + +} +#endif + +#ifdef CHIRP_ADC_NONE +static void measure_power(void){ + __NOP(); +} +#elif +static void measure_power(void){ + uint32_t sensors_current; + + sensors_current = measure_idd(SENSORS_CURRENT_NB_MEASURE); + printf("Chirp Sensor Idd is %ld uA \n\n", sensors_current); +} +#endif + +/*! + \brief Probe I2C bus to find connected sensor(s) + \param[in] none + \param[out] none + \retval none + \note 1. Pull-High PROG + 2. Read Register From PROG Mode 0x00 + 3. Verify Register Value. + 4. Pull-Low PROG +*/ +static void find_sensors(void) +{ + uint8_t sig_bytes[2]; + uint8_t i; + + /* config RST GPIO : --Output--High-- */ + gpio_mode_set(CHIRP_PIN_RST_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_RST_PIN); + gpio_output_options_set(CHIRP_PIN_RST_PORT, GPIO_OTYPE_PP, GPIO_OSPEED_50MHZ, CHIRP_PIN_RST_PIN); + gpio_bit_set(CHIRP_PIN_RST_PORT, CHIRP_PIN_RST_PIN); + + /* config PROG GPIO : --Output--Low-- */ + gpio_mode_set(CHIRP_PIN_PROG_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_PROG_PIN); + gpio_output_options_set(CHIRP_PIN_PROG_PORT, GPIO_OTYPE_PP, GPIO_OSPEED_50MHZ, CHIRP_PIN_PROG_PIN); + gpio_bit_reset(CHIRP_PIN_PROG_PORT, CHIRP_PIN_PROG_PIN); + + /* check sensor */ + /* pull PROG Pin to high */ + gpio_bit_set(CHIRP_PIN_PROG_PORT, CHIRP_PIN_PROG_PIN); + i2c_master_initialize1(); + sig_bytes[0] = 0; + sig_bytes[1] = 0; + + i2c_master_read_register1(CH_I2C_ADDR_PROG, 0x00, 2, sig_bytes); + + printf("Chirp Sensor "); + if ((sig_bytes[0] = CH_SIG_BYTE_0) && (sig_bytes[1] = CH_SIG_BYTE_1)){ + printf("found!\n"); + } else { + printf("not found!\n"); + } + + gpio_bit_reset(CHIRP_PIN_PROG_PORT, CHIRP_PIN_PROG_PIN); +} + +#ifdef CHIRP_ADC_NONE +static void ADC0_init(void){ + __NOP(); +} +#elif +static void ADC0_init(void){ + adc_enable(); +} +#endif + +/*! + \brief Initialize INT Pin EXTI + \param[in] none + \param[out] none + \retval none +*/ +void ext_int_init(void) +{ + /* enable clock */ + rcu_periph_clock_enable(RCU_GPIOA | RCU_CFGCMP); + // Configure PIOs as input pins & Enable pull-downs on the INT pins + gpio_mode_set(GPIOA, GPIO_MODE_INPUT, GPIO_PUPD_PULLDOWN, GPIO_PIN_7); + /* enable and set INT EXTI interrupt priority */ + nvic_irq_enable(EXTI4_15_IRQn, 2U); + /* connect key EXTI line to key GPIO pin */ + syscfg_exti_line_config(EXTI_SOURCE_GPIOA, EXTI_SOURCE_PIN7); + /* configure key EXTI line Initialize INT interrupt handler, interrupt on rising edge. */ + exti_init(EXTI_7, EXTI_INTERRUPT, EXTI_TRIG_RISING); + exti_interrupt_flag_clear(EXTI_7); + /* Disable all CHx01 interrupts */ + exti_interrupt_disable(EXTI_7); +} + + +/*! + \brief Initialize board HardWare + \param[in] none + \param[out] none + \retval none + \note This function performs all neceassary initialization on the board. +*/ +void chbsp_board_init(ch_group_t *grp_ptr) { + /* make local copy of group pointer */ + sensor_group_ptr = grp_ptr; + + /* Initialize group descriptor */ + grp_ptr->num_ports = CHIRP_MAX_NUM_SENSORS; + grp_ptr->num_i2c_buses = CHIRP_NUM_I2C_BUSES; + grp_ptr->rtc_cal_pulse_ms = CHBSP_RTC_CAL_PULSE_MS; + + /* Initialize the GD32 system. */ + // systick_config(); + board_init_I2C(); + + configure_console(); + + ADC0_init(); + ext_int_init(); + + /* Probe I2C bus to find connected sensor(s) */ + find_sensors(); + measure_power(); + + indicate_alive(); +} + +/*! + * \brief Assert the reset pin + * + * This function drives the sensor reset pin low. + */ +void chbsp_reset_assert(void) { + + gpio_bit_reset(CHIRP_PIN_RST_PORT, CHIRP_PIN_RST_PIN); //reset=L +} + +/*! + * \brief Deassert the reset pin + * + * This function drives the sensor reset pin high. + */ +void chbsp_reset_release(void) { + + gpio_bit_set(CHIRP_PIN_RST_PORT, CHIRP_PIN_RST_PIN); //reset=H +} + +/*! + * \brief Assert the PROG pin + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * + * This function drives the sensor PROG pin high on the specified port. + */ +void chbsp_program_enable(ch_dev_t *dev_ptr) { + uint8_t dev_num = ch_get_dev_num(dev_ptr); + gpio_bit_set(CHIRP_PIN_PROG_PORT, CHIRP_PIN_PROG_PIN); //PROG_0=H + +} + +/*! + * \brief Deassert the PROG pin + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * + * This function drives the sensor PROG pin low on the specified port. + */ +void chbsp_program_disable(ch_dev_t *dev_ptr) { + uint8_t dev_num = ch_get_dev_num(dev_ptr); + gpio_bit_reset(CHIRP_PIN_PROG_PORT, CHIRP_PIN_PROG_PIN); //PROG_0=L +} + +/*! + * \brief Configure the Chirp sensor INT pin as an output for one sensor. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * + * This function configures the Chirp sensor INT pin as an output (from the perspective + * of the host system). + */ +void chbsp_set_io_dir_out(ch_dev_t *dev_ptr) { + uint8_t dev_num = ch_get_dev_num(dev_ptr); + gpio_mode_set(CHIRP_PIN_INT_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_INT_PIN); + gpio_output_options_set(CHIRP_PIN_INT_PORT, GPIO_OTYPE_PP, GPIO_OSPEED_50MHZ, CHIRP_PIN_INT_PIN); +} + + +/*! + * \brief Configure the Chirp sensor INT pin as an input for one sensor. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * + * This function configures the Chirp sensor INT pin as an input (from the perspective of + * the host system). + */ +void chbsp_set_io_dir_in(ch_dev_t *dev_ptr) { + uint8_t dev_num = ch_get_dev_num(dev_ptr); + gpio_mode_set(CHIRP_PIN_INT_PORT, GPIO_MODE_INPUT, GPIO_PUPD_NONE, CHIRP_PIN_INT_PIN); +} + + +/*! + * \brief Configure the Chirp sensor INT pins as outputs for a group of sensors + * + * \param grp_ptr pointer to the ch_group_t config structure for a group of sensors + * + * This function configures each Chirp sensor's INT pin as an output (from the perspective + * of the host system). + */ +void chbsp_group_set_io_dir_out(ch_group_t *grp_ptr) { + uint8_t dev_num; + + for (dev_num = 0; dev_num < ch_get_num_ports(grp_ptr); dev_num++) + { + ch_dev_t *dev_ptr = ch_get_dev_ptr(grp_ptr, dev_num); + + if (ch_sensor_is_connected(dev_ptr)){ + gpio_mode_set(CHIRP_PIN_INT_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_INT_PIN); + gpio_output_options_set(CHIRP_PIN_INT_PORT, GPIO_OTYPE_PP, GPIO_OSPEED_50MHZ, CHIRP_PIN_INT_PIN); + } + } +} + +/*! + * \brief Configure the Chirp sensor INT pins as inputs for a group of sensors + * + * \param grp_ptr pointer to the ch_group_t config structure for a group of sensors + * + * \note This function assumes a bidirectional level shifter is interfacing the ICs. + */ +void chbsp_group_set_io_dir_in(ch_group_t *grp_ptr) { + uint8_t dev_num; + + for (dev_num = 0; dev_num < ch_get_num_ports(grp_ptr); dev_num++) { + ch_dev_t *dev_ptr = ch_get_dev_ptr(grp_ptr, dev_num); + + if (ch_sensor_is_connected(dev_ptr)) { + gpio_mode_set(CHIRP_PIN_INT_PORT, GPIO_MODE_INPUT, GPIO_PUPD_NONE, CHIRP_PIN_INT_PIN); + } + } +} + + +/*! + * \brief Initialize the I/O pins. + * + * \param grp_ptr pointer to the ch_group_t config structure for a group of sensors + * + * Configure reset and program pins as outputs. Assert reset and program. Configure + * sensor INT pin as input. + */ +void chbsp_group_pin_init(ch_group_t *grp_ptr) { + uint8_t dev_num; + uint8_t port_num; + + gpio_mode_set(CHIRP_PIN_PROG_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_PROG_PIN); + gpio_output_options_set(CHIRP_PIN_PROG_PORT, GPIO_OTYPE_PP, GPIO_OSPEED_50MHZ, CHIRP_PIN_PROG_PIN); + gpio_bit_reset(CHIRP_PIN_PROG_PORT, CHIRP_PIN_PROG_PIN); + + // ioport_set_pin_dir(CHIRP_RST, IOPORT_DIR_OUTPUT); //reset=output + gpio_mode_set(CHIRP_PIN_RST_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_RST_PIN); + gpio_output_options_set(CHIRP_PIN_RST_PORT, GPIO_OTYPE_PP, GPIO_OSPEED_50MHZ, CHIRP_PIN_RST_PIN); + chbsp_reset_assert(); + + + for (dev_num = 0; dev_num < grp_ptr->num_ports; dev_num++) { + ch_dev_t *dev_ptr = ch_get_dev_ptr(grp_ptr, dev_num); + chbsp_program_enable(dev_ptr); + } + + /* Initialize IO pins */ + chbsp_group_set_io_dir_in(grp_ptr); + + /* Enable the peripheral clock for the MAG extension board interrupt pin. */ + rcu_periph_clock_enable(CHIRP_PIN_INT_CLK); + rcu_periph_clock_enable(RCU_CFGCMP); + + /* Configure PIOs as input pins. */ + for(port_num = 0; port_num < grp_ptr->num_ports; port_num++ ) { + gpio_mode_set(CHIRP_PIN_INT_PORT, GPIO_MODE_INPUT, GPIO_PUPD_NONE, CHIRP_PIN_INT_PIN); + } + nvic_irq_enable(EXTI4_15_IRQn, 2U); + syscfg_exti_line_config(CHIRP_EXTI_INT_PORT, CHIRP_EXTI_INT_PIN); + exti_init(CHIRP_EXTI_INT_LINE, EXTI_INTERRUPT, EXTI_TRIG_RISING); + exti_interrupt_flag_clear(CHIRP_EXTI_INT_LINE); +} + + +/*! + * \brief Set the INT pins low for a group of sensors. + * + * \param grp_ptr pointer to the ch_group_t config structure for a group of sensors + * + * This function drives the INT line low for each sensor in the group. + */ +void chbsp_group_io_clear(ch_group_t *grp_ptr) { + // ioport_port_mask_t mask = 0; + uint8_t dev_num; + + for (dev_num = 0; dev_num < ch_get_num_ports(grp_ptr); dev_num++) { + ch_dev_t *dev_ptr = ch_get_dev_ptr(grp_ptr, dev_num); + + if (ch_sensor_is_connected(dev_ptr)) { + gpio_bit_reset(CHIRP_PIN_INT_PORT, CHIRP_PIN_INT_PIN); //INT_0=L + } + } +} + + /*! + * \brief Set the INT pins high for a group of sensors. + * + * \param grp_ptr pointer to the ch_group_t config structure for a group of sensors + * + * This function drives the INT line high for each sensor in the group. + */ +void chbsp_group_io_set(ch_group_t *grp_ptr) { + ch_dev_t *dev_ptr = ch_get_dev_ptr(grp_ptr, 0); + if (ch_sensor_is_connected(dev_ptr)) + { + gpio_bit_set(CHIRP_PIN_INT_PORT, CHIRP_PIN_INT_PIN); + } +} + + + + +/*! + * \brief Delay for specified number of microseconds + * + * \param us number of microseconds to delay before returning + * + * This function waits for the specified number of microseconds before returning to + * the caller. + */ +void chbsp_delay_us(uint32_t us) { + + delay_us(us); +} + +/*! + * \brief Delay for specified number of milliseconds. + * + * \param ms number of milliseconds to delay before returning + * + * This function waits for the specified number of milliseconds before returning to + * the caller. + */ +void chbsp_delay_ms(uint32_t ms) { + + delay_ms(ms); +} + +/*! + * \brief Initialize the host's I2C hardware. + * + * \return 0 if successful, 1 on error + * + * This function performs general I2C initialization on the host system. + */ +int chbsp_i2c_init(void) { + + i2c_master_init(); + return 0; + +} + +/*! + * \brief Return I2C information for a sensor port on the board. + * + * \param grp_ptr pointer to the ch_group_t config structure for a group of sensors + * \param dev_num device number within sensor group + * \param info_ptr pointer to structure to be filled with I2C config values + * + * \return 0 if successful, 1 if error + * + * This function returns I2C values in the ch_i2c_info_t structure specified by \a info_ptr. + * The structure includes three fields. + * - The \a address field contains the I2C address for the sensor. + * - The \a bus_num field contains the I2C bus number (index). + * - The \a drv_flags field contains various bit flags through which the BSP can inform + * SonicLib driver functions to perform specific actions during I2C I/O operations. + */ +uint8_t chbsp_i2c_get_info(ch_group_t __attribute__((unused)) *grp_ptr, uint8_t io_index, ch_i2c_info_t *info_ptr) { + uint8_t ret_val = 1; + + if (io_index <= CHBSP_MAX_DEVICES) { + // info_ptr->address = chirp_i2c_addrs[io_index]; + // info_ptr->bus_num = chirp_i2c_buses[io_index]; + + info_ptr->address = chirp_i2c_addrs[io_index]; + info_ptr->bus_num = chirp_i2c_buses[io_index]; + info_ptr->drv_flags = 0; // no special I2C handling by SonicLib driver is needed + + ret_val = 0; + } + return ret_val; +} + + + + +/*! + * \brief Write bytes to an I2C slave. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * \param data data to be transmitted + * \param num_bytes length of data to be transmitted + * + * \return 0 if successful, 1 on error or NACK + * + * This function writes one or more bytes of data to an I2C slave device. + * The I2C interface must have already been initialized using \a chbsp_i2c_init(). + */ +int chbsp_i2c_write(ch_dev_t *dev_ptr, uint8_t *data, uint16_t num_bytes) { + int error = 0; + + if (dev_ptr->i2c_bus_index == 0) { + error = i2c_master_write_register1_raw(dev_ptr->i2c_address, num_bytes, data); //I2C bus 0 (TWI1) + } else { + // error = i2c_master_write_register3_raw(dev_ptr->i2c_address, num_bytes, data); //I2C bus 1 (TWI3) + printf("err 'chbsp_i2c_write' on chbsp, no TWI3"); + } + return error; +} + +/*! + * \brief Write bytes to an I2C slave using memory addressing. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * \param mem_addr internal memory or register address within device + * \param data data to be transmitted + * \param num_bytes length of data to be transmitted + * + * \return 0 if successful, 1 on error or NACK + * + * This function writes one or more bytes of data to an I2C slave device using an internal + * memory or register address. The remote device will write \a num_bytes bytes of + * data starting at internal memory/register address \a mem_addr. + * The I2C interface must have already been initialized using \a chbsp_i2c_init(). + */ +int chbsp_i2c_mem_write(ch_dev_t *dev_ptr, uint16_t mem_addr, uint8_t *data, uint16_t num_bytes) { + int error=0; + if (dev_ptr->i2c_bus_index == 0) { + // I2C bus 0 (TWI1) + error = i2c_master_write_register1(dev_ptr->i2c_address, mem_addr, num_bytes, data); + + } else if (dev_ptr->i2c_bus_index == 1) { + // I2C bus 1 (TWI3) + printf("err 'chbsp_i2c_mem_write' on chbsp, no TWI3"); + } + return error; +} + + + +/*! + * \brief Read bytes from an I2C slave. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * \param data pointer to receive data buffer + * \param num_bytes number of bytes to read + * + * \return 0 if successful, 1 on error or NACK + * + * This function reads the specified number of bytes from an I2C slave device. + * The I2C interface must have already been initialized using \a chbsp_i2c_init(). + */ +int chbsp_i2c_read(ch_dev_t *dev_ptr, uint8_t *data, uint16_t num_bytes) { + int error = 1; // default is error return + uint8_t i2c_addr = ch_get_i2c_address(dev_ptr); + uint8_t bus_num = ch_get_i2c_bus(dev_ptr); + + if (bus_num == 0) { + // I2C bus 0 (TWI1) + error = i2c_master_read_register1_raw(i2c_addr, num_bytes, data); + + } else if (bus_num == 1) { + // I2C bus 1 (TWI3) + error = i2c_master_read_register3_raw(i2c_addr, num_bytes, data); + } + return error; +} + +/*! + * \brief Read bytes from an I2C slave using memory addressing. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * \param mem_addr internal memory or register address within device + * \param data pointer to receive data buffer + * \param num_bytes number of bytes to read + * + * \return 0 if successful, 1 on error or NACK + * + * This function reads the specified number of bytes from an I2C slave device, using + * an internal memory or register address. The remote device will return \a num_bytes bytes + * starting at internal memory/register address \a mem_addr. + * + * The I2C interface must have already been initialized using \a chbsp_i2c_init(). + */ +int chbsp_i2c_mem_read(ch_dev_t *dev_ptr, uint16_t mem_addr, uint8_t *data, uint16_t num_bytes) { + int error = 1; // default is error return + uint8_t i2c_addr = ch_get_i2c_address(dev_ptr); + uint8_t bus_num = ch_get_i2c_bus(dev_ptr); + + if (bus_num == 0) { + // I2C bus 0 (TWI1) + error = i2c_master_read_register1(i2c_addr, mem_addr, num_bytes, data); + + } else if (bus_num == 1) { + // I2C bus 1 (TWI3) + error = i2c_master_read_register3(i2c_addr, mem_addr, num_bytes, data); + #ifdef DEBUG_VERBOES + printf("\n err 'chbsp_i2c_mem_read' on chbsp_chirp_gd32e230f4, no TWI3 \n"); + #endif + } + return error; +} + +/*! + * \brief Reset I2C bus associated with device. + * + * \param dev_ptr pointer to the ch_dev_t config structure for a sensor + * + * This function performs a reset of the I2C interface for the specified device. + */ +void chbsp_i2c_reset(ch_dev_t * dev_ptr) { + uint8_t bus_num = ch_get_i2c_bus(dev_ptr); + + if (bus_num == 0) { // I2C bus 0 (TWI1) + i2c_master_initialize1(); + } else if (bus_num == 1) { // I2C bus 1 (TWI3) + i2c_master_initialize3(); + } +} + +/*! + * \brief Initialize periodic timer. + * + * \param interval_ms timer interval, in milliseconds + * \param callback_func_ptr address of routine to be called every time the timer expires + * + * \return 0 if successful, 1 if error + * + * This function initializes a periodic timer on the board. The timer is programmed + * to generate an interrupt after every \a interval_ms milliseconds. + * + * The \a callback_func_ptr parameter specifies a callback routine that will be called when the + * timer expires (and interrupt occurs). The \a chbsp_periodic_timer_handler function + * will call this function. + */ +// uint8_t chbsp_periodic_timer_init(uint16_t interval_ms, ch_timer_callback_t callback_func_ptr) { +// static bool is_hw_init_done = false; + +// /* Save timer interval and callback function */ +// periodic_timer_interval_ms = interval_ms; +// periodic_timer_callback_ptr = callback_func_ptr; + +// /* Initialize the HW only 1 time at startup. Skip the init on subsequent calls. */ +// if (!is_hw_init_done) { +// /* Configure the PMC to enable the TC module and channels */ +// sysclk_enable_peripheral_clock(ID_TC0); +// sysclk_enable_peripheral_clock(ID_TC1); +// /* Create on PCK3 a 499985 Hz clock from the PLLA clock. */ +// pmc_disable_pck(PMC_PCK_3); +// pmc_switch_pck_to_pllack(PMC_PCK_3, PMC_PCK_PRES(240 - 1)); +// pmc_enable_pck(PMC_PCK_3); + +// /* Reset all TC0 counters */ +// TC0->TC_BCR = TC_BCR_SYNC; + +// /* Enable TC0 - Channel 0 interrupt */ +// NVIC_DisableIRQ(TC0_IRQn); +// NVIC_ClearPendingIRQ(TC0_IRQn); +// NVIC_SetPriority(TC0_IRQn, 1); +// NVIC_EnableIRQ(TC0_IRQn); + +// /* Enable TC0 - Channel 1 interrupt */ +// NVIC_DisableIRQ(TC1_IRQn); +// NVIC_ClearPendingIRQ(TC1_IRQn); +// NVIC_SetPriority(TC1_IRQn, 1); +// NVIC_EnableIRQ(TC1_IRQn); + +// /* Create the lsepoch timer running on PCK3 and start it immediately */ +// tc_init(TC0, TC_CHANNEL_LSEPOCH, +// TC_CMR_TCCLKS_TIMER_CLOCK5 | TC_CMR_WAVE | TC_CMR_WAVSEL_UP); +// tc_enable_interrupt(TC0, TC_CHANNEL_LSEPOCH, TC_IER_COVFS); +// tc_start(TC0, TC_CHANNEL_LSEPOCH); + +// /* Create the ultrasound periodic timer. */ +// tc_init(TC0, TC_CHANNEL_US, +// TC_CMR_TCCLKS_TIMER_CLOCK5 | TC_CMR_WAVE | TC_CMR_WAVSEL_UP); +// } + +// /* Mark the HW init as done */ +// is_hw_init_done = true; + +// /* Convert the ODR in ms to ticks */ +// ultrasound_timer_period_in_tick = get_period_in_tick(interval_ms * 1000); + +// return 0; +// } + +// void chbsp_periodic_timer_change_period(uint32_t new_interval_us) +// { +// uint16_t prev_expiration = ultrasound_prev_period_end_in_tick - ultrasound_timer_period_in_tick; + +// ultrasound_timer_period_in_tick = get_period_in_tick(new_interval_us); + +// ultrasound_prev_period_end_in_tick = prev_expiration; + +// program_next_period(); +// } + +// uint32_t get_period_in_tick(uint32_t interval_us) { +// uint64_t timer_period_in_tick = (uint64_t) ULTRASOUND_TIMER_FREQUENCY * interval_us / 1000000; + +// /* If the ODR is too slow to be handled then program a faster interrupt and decimate it */ +// if (timer_period_in_tick > UINT16_MAX) +// decimation_factor = timer_period_in_tick / UINT16_MAX + 1; +// else +// decimation_factor = 1; + +// /* Calculate the final tick in case a decimation is needed */ +// return (uint32_t) (timer_period_in_tick / decimation_factor); +// } + +// void program_next_period(void) +// { +// uint32_t time = ultrasound_prev_period_end_in_tick + ultrasound_timer_period_in_tick; +// ultrasound_prev_period_end_in_tick = time; +// tc_write_rc(TC0, TC_CHANNEL_US, (uint16_t) (time & 0xFFFF)); +// } + +/*! + * \brief Enable periodic timer interrupt. + * + * This function enables the interrupt associated with the periodic timer initialized by + * \a chbsp_periodic_timer_init(). + */ +// void chbsp_periodic_timer_irq_enable(void) { + +// /* Clear any pending CPCS before enabling it */ +// tc_get_status(TC0, TC_CHANNEL_US); +// tc_enable_interrupt(TC0, TC_CHANNEL_US, TC_IER_CPCS); +// } + +/*! + * \brief Disable periodic timer interrupt. + * + * This function enables the interrupt associated with the periodic timer initialized by + * \a chbsp_periodic_timer_init(). + */ +// void chbsp_periodic_timer_irq_disable(void) { + +// tc_disable_interrupt(TC0, TC_CHANNEL_US, TC_IDR_CPCS); +// } + +/*! + * \brief Start periodic timer. + * + * \return 0 if successful, 1 if error + * + * This function starts the periodic timer initialized by \a chbsp_periodic_timer_init(). + */ +// uint8_t chbsp_periodic_timer_start(void) { + +// decimation_counter = 0; +// /* The timer start done at the very end is resetting the counter */ +// ultrasound_prev_period_end_in_tick = 0; +// program_next_period(); + +// /* Start the HW counter (this resets the counter */ +// tc_start(TC0, TC_CHANNEL_US); + +// return 0; +// } + +/*! + * \brief Turn on an LED on the board. + * + * This function turns on an LED on the board. + * + * The \a dev_num parameter contains the device number of a specific sensor. This routine + * will turn on the LED on the Chirp sensor daughterboard that is next to the specified + * sensor. + */ +void chbsp_led_on(uint8_t led_num) { + + sensor_led_on(); +} + +/*! + * \brief Turn off an LED on the board. + * + * This function turns off an LED on the board. + * + * The \a dev_num parameter contains the device number of a specific sensor. This routine + * will turn off the LED on the Chirp sensor daughterboard that is next to the specified + * sensor. + */ +void chbsp_led_off(uint8_t led_num) { + + sensor_led_off(); +} + +/*! + * \brief Toggles an LED on the board. + * + * This function toggles an LED on the board. + * + * The \a dev_num parameter contains the device number of a specific sensor. This routine + * will toggles the LED on the Chirp sensor daughterboard that is next to the specified + * sensor. + */ +void chbsp_led_toggle(uint8_t led_num) { + + sensor_led_toggle(); +} + +/*! + * \brief Output a text string via serial interface + * + * \param str pointer to a string of characters to be output + * + * This function prints debug information to the console. + */ +void chbsp_print_str(char *str) { + printf("%s", str); +} + +/*! + * \brief Return the current time in ms + * + * This function returns the system current time in ms. + */ +// uint32_t chbsp_timestamp_ms(void) { +// uint32_t time = time_get_in_us(); +// return (time / 1000); +// } + +/************* End of file chbsp_chirp_smartsonic.c -- Copyright 2016-2019 Chirp Microsystems **********/ \ No newline at end of file diff --git a/CHIRP/board/chirp_board_config.h b/CHIRP/board/chirp_board_config.h new file mode 100644 index 0000000..2d2e58d --- /dev/null +++ b/CHIRP/board/chirp_board_config.h @@ -0,0 +1,88 @@ +/* + * ________________________________________________________________________________________________________ + * Copyright (c) 2020 InvenSense Inc. All rights reserved. + * + * This software, related documentation and any modifications thereto (collectively “Software”) is subject + * to InvenSense and its licensors' intellectual property rights under U.S. and international copyright + * and other intellectual property rights laws. + * + * InvenSense and its licensors retain all intellectual property and proprietary rights in and to the Software + * and any use, reproduction, disclosure or distribution of the Software without an express license agreement + * from InvenSense is strictly prohibited. + * + * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, THE SOFTWARE IS + * PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED + * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. + * EXCEPT AS OTHERWISE PROVIDED IN A LICENSE AGREEMENT BETWEEN THE PARTIES, IN NO EVENT SHALL + * INVENSENSE BE LIABLE FOR ANY DIRECT, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY + * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, + * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE + * OF THE SOFTWARE. + * ________________________________________________________________________________________________________ + */ +/** + * \file chirp_board_config.h + * + * This file defines required symbols used to build an application with the Chirp SonicLib + * API and driver. These symbols are used for static array allocations and counters in SonicLib + * (and often applications), and are based on the number of specific resources on the target board. + * + * Two symbols must be defined: + * CHIRP_MAX_NUM_SENSORS - the number of possible sensor devices (i.e. the number of sensor ports) + * CHIRP_NUM_I2C_BUSES - the number of I2C buses on the board that are used for those sensor ports + * + * This file must be in the C pre-processor include path when the application is built with SonicLib + * and this board support package. + */ + +#ifndef CHIRP_BOARD_CONFIG_H +#define CHIRP_BOARD_CONFIG_H + +/* Settings for the Chirp SmartSonic board */ +#define CHIRP_MAX_NUM_SENSORS 1 // maximum possible number of sensor devices +#define CHIRP_NUM_I2C_BUSES 1 // number of I2C buses used by sensors + +#define I2C0_MASTER_ADDRESS7 0xA0 +#define I2C0_SPEED 400000 + +/* PROG_EN GPIO */ +#define CHIRP_PIN_PROG_PORT GPIOA +#define CHIRP_PIN_PROG_PIN GPIO_PIN_5 +#define CHIRP_PIN_PROG_CLK RCU_GPIOA + +/* RST GPIO */ +#define CHIRP_PIN_RST_PORT GPIOA +#define CHIRP_PIN_RST_PIN GPIO_PIN_6 +#define CHIRP_PIN_RST_CLK RCU_GPIOA + +/* INT GPIO */ +#define CHIRP_PIN_INT_PORT GPIOA +#define CHIRP_PIN_INT_PIN GPIO_PIN_7 +#define CHIRP_PIN_INT_CLK RCU_GPIOA + +#define CHIRP_EXTI_INT_PORT EXTI_SOURCE_GPIOA +#define CHIRP_EXTI_INT_PIN EXTI_SOURCE_PIN7 +#define CHIRP_EXTI_INT_LINE EXTI_7 + +/* LED GPIO */ +#define CHIRP_PIN_LED_PORT GPIOB +#define CHIRP_PIN_LED_PIN GPIO_PIN_1 +#define CHIRP_PIN_LED_CLK RCU_GPIOB + +/* IIC Config */ +#define CHIRP_PIN_IIC_BUS I2C0 +#define CHIRP_PIN_IIC_PORT GPIOF +#define CHIRP_PIN_IIC_SDA_PIN GPIO_PIN_0 +#define CHIRP_PIN_IIC_SCL_PIN GPIO_PIN_1 +#define CHIRP_PIN_IIC_PIN_CLK RCU_GPIOF +#define CHIRP_PIN_IIC_CLK RCU_I2C0 +#define CHIRP_PIN_IIC_DMA_CLK RCU_DMA + + +#define CHIRP_ADC_NONE +// #define DEBUG_VERBOES + +/* Deactivate use of debug I2C interface */ +#define USE_STD_I2C_FOR_IQ (1) + +#endif /* CHIRP_BOARD_CONFIG_H */ \ No newline at end of file diff --git a/CHIRP/board/chirp_smartsonic.h b/CHIRP/board/chirp_smartsonic.h new file mode 100644 index 0000000..13fa550 --- /dev/null +++ b/CHIRP/board/chirp_smartsonic.h @@ -0,0 +1,83 @@ +/* +Copyright � 2016-2019, Chirp Microsystems. All rights reserved. +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. IN NO EVENT SHALL CHIRP MICROSYSTEMS 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. + +You can contact the authors of this program by email at support@chirpmicro.com + or by mail at 2560 Ninth Street, Suite 220, Berkeley, CA 94710. +*/ +/** \file chirp_smartsonic.h */ +#ifndef CHIRP_SMARTSONIC_H +#define CHIRP_SMARTSONIC_H + +#include "soniclib.h" +#include "chirp_board_config.h" +#include "app_config.h" + +/* Standard symbols used in board support package - use values from config header */ +#define CHBSP_MAX_DEVICES CHIRP_MAX_NUM_SENSORS +#define CHBSP_NUM_I2C_BUSES CHIRP_NUM_I2C_BUSES + +#if defined(CHIRP_RTC_CAL_PULSE_LEN_MS) + /** Length of real-time clock calibration pulse, in milliseconds : + * length of pulse applied to sensor INT line during clock cal + */ + #define CHBSP_RTC_CAL_PULSE_MS CHIRP_RTC_CAL_PULSE_LEN_MS +#else + /* Default value */ + #define CHBSP_RTC_CAL_PULSE_MS (100) +#endif + +/* I2C Address assignments for each possible device */ +#define CHIRP_I2C_ADDRS {45} +#define CHIRP_I2C_BUSES {0} + +/* IRQ assignments */ +#define TWI1_IRQn FLEXCOM1_IRQn +#define TWI3_IRQn FLEXCOM3_IRQn + +/* Processor sleep mode */ +#define PROC_SLEEP_MODE SAM_PM_SMODE_SLEEP_WFI /* wait for interrupt */ + +/* Structure to track non-blocking I2C transaction data */ +typedef struct { + uint8_t *buf_ptr; /* pointer to data buffer */ + uint16_t num_bytes; /* number of bytes to transfer */ +} i2c_trans_data_t; + +/* TC channel used for the ultrasound timer and lsepoch of the system */ +#define TC_CHANNEL_LSEPOCH (0) +#define TC_CHANNEL_US (1) + +/* Define the HW frequency of the TC used for the ultrasound periodic timer */ +#define ULTRASOUND_TIMER_FREQUENCY (499985) /* = 32768 * 3662 / 240 */ +#define ULTRASOUND_DECIMATION_FACTOR (1) + +extern uint32_t chirp_pin_prog[CHBSP_MAX_DEVICES]; +extern uint32_t chirp_pin_io[CHBSP_MAX_DEVICES]; +extern uint32_t chirp_pin_io_irq[CHBSP_MAX_DEVICES]; + +extern ch_group_t chirp_group; + +extern i2c_trans_data_t i2c_nb_transactions[CHBSP_NUM_I2C_BUSES]; // array of structures to track non-blocking I2C transactions + +void sensor_led_on(void); +void sensor_led_off(void); +void sensor_led_toggle(void); +void indicate_alive(void); + +extern ch_io_int_callback_t io_int_callback_ptr; // pointer to sensor I/O interrupt callback function +extern void periodic_timer_callback(void); + + +#endif /* CHIRP_SMARTSONIC_H */ \ No newline at end of file diff --git a/CHIRP/board/i2c.c b/CHIRP/board/i2c.c new file mode 100644 index 0000000..4cc95de --- /dev/null +++ b/CHIRP/board/i2c.c @@ -0,0 +1,762 @@ +#include +#include +#include "gd32e23x.h" +#include "i2c.h" +#include "gd32e23x.h" +#include "chirp_board_config.h" +#include "board_init.h" + +/*! + \brief Enable IIC0 & NVIC + \param[in] none + \param[out] none + \retval none +*/ +void i2c_master_initialize1(void) +{ + /* IIC config */ + rcu_periph_clock_enable(CHIRP_PIN_IIC_CLK); + i2c_clock_config(CHIRP_PIN_IIC_BUS, I2C0_SPEED, I2C_DTCY_2); + i2c_mode_addr_config(CHIRP_PIN_IIC_BUS, I2C_I2CMODE_ENABLE, I2C_ADDFORMAT_7BITS, I2C0_MASTER_ADDRESS7); + i2c_enable(CHIRP_PIN_IIC_BUS); + i2c_ack_config(CHIRP_PIN_IIC_BUS, I2C_ACK_ENABLE); + + /* enable I2C0 NVIC */ + nvic_irq_enable(I2C0_ER_IRQn, 1); + nvic_irq_enable(I2C0_EV_IRQn, 3); +} + +/*! + \brief No TWI3(IIC3),no operation err log. + \param[in] none + \param[out] none + \retval none +*/ +void i2c_master_initialize3(void) +{ + __NOP(); + #ifdef DEBUG_VERBOES + printf("\n[DebugVerboes]i2c_master_initialize3 @ i2c.c, no TWI3 \n"); + #endif +} + +/*! + \brief Only Init TWI1(IIC1),No TWI3(IIC3),no operation err log. + \param[in] none + \param[out] none + \retval none +*/ +void i2c_master_init(void) +{ + i2c_master_initialize1(); + i2c_master_initialize3(); + gpio_mode_set(CHIRP_PIN_LED_PORT, GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, CHIRP_PIN_LED_PIN); +} + +/*! + \brief Deinit TWI1(IIC1). + \param[in] none + \param[out] none + \retval none +*/ +void i2c_master_deinit1(void) +{ + rcu_periph_clock_disable(CHIRP_PIN_IIC_CLK); + i2c_disable(CHIRP_PIN_IIC_BUS); +} + +/*! + \brief No TWI3(IIC3),no operation err log. + \param[in] none + \param[out] none + \retval none +*/ +void i2c_master_deinit3(void) +{ + __NOP(); + #ifdef DEBUG_VERBOES + printf("\n[DebugVerboes]i2c_master_deinit3 @ i2c.c, no TWI3 Pin \n"); + #endif +} + +/*! + \brief TWI1(IIC0) read data from the IIC Slave Device + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] RegisterAddr: the IIC Slave Device's internal address to start reading from + \param[in] RegisterLen: number of bytes to reads from the IIC Slave Device + \param[in] RegisterValue: pointer to the buffer that receives the data read from the IIC Slave Device + \param[out] RegisterValue: pointer to the buffer that receives the data read from the IIC Slave Device + \retval IIC_SUCCESS +*/ +uint8_t i2c_master_read_register1(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue){ + uint8_t state = I2C_START; + uint8_t read_cycle = 0; + uint16_t timeout = 0; + uint8_t i2c_timeout_flag = 0; + unsigned char IIC_SLAVE_ADDR = (Address << 1); + + i2c_ack_config(I2C0, I2C_ACK_ENABLE); + while (!(i2c_timeout_flag)) + { + switch (state) + { + case I2C_START: + if(RESET == read_cycle) + { + /* i2c master sends start signal only when the bus is idle */ + while (i2c_flag_get(I2C0, I2C_FLAG_I2CBSY) && (timeout < i2c_timeout_flag)) + { + timeout ++; + } + if(timeout < I2C_TIME_OUT) + { + /* whether to send ACK or not for the next byte */ + if(2 == RegisterLen) { + i2c_ackpos_config(I2C0, I2C_ACKPOS_NEXT); + } + } else { + i2c_bus_reset(); + timeout = 0; + state = I2C_START; + printf("i2c bus is busy in READ!\n"); + } + } + /* send the start signal */ + i2c_start_on_bus(I2C0); + timeout = 0; + state = I2C_SEND_ADDR; + break; + + case I2C_SEND_ADDR: + /* i2c master sends START signal successfully */ + while((!i2c_flag_get(I2C0, I2C_FLAG_SBSEND)) && (timeout < I2C_TIME_OUT)) + { + timeout++; + } + if(timeout < I2C_TIME_OUT) + { + if(RESET == read_cycle) + { + i2c_master_addressing(I2C0, IIC_SLAVE_ADDR, I2C_TRANSMITTER); + state = I2C_CLEAR_ADDRESS_FLAG; + } else { + i2c_master_addressing(I2C0, IIC_SLAVE_ADDR, I2C_RECEIVER); + if(RegisterLen < 3) { + /* disable acknowledge */ + i2c_ack_config(I2C0, I2C_ACK_DISABLE); + } + state = I2C_CLEAR_ADDRESS_FLAG; + } + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + read_cycle = 0; + printf("i2c master sends start signal timeout in READ!\n"); + } + break; + + case I2C_CLEAR_ADDRESS_FLAG: + /* address flag set means i2c slave sends ACK */ + while((!i2c_flag_get(I2C0, I2C_FLAG_ADDSEND)) && (timeout < I2C_TIME_OUT)) + { + timeout++; + } + if(timeout < I2C_TIME_OUT) + { + i2c_flag_clear(I2C0, I2C_FLAG_ADDSEND); + if((SET == read_cycle) && (1 == RegisterLen)) { + /* send a stop condition to I2C bus */ + i2c_stop_on_bus(I2C0); + } + timeout = 0; + state = I2C_TRANSMIT_DATA; + } else { + timeout = 0; + state = I2C_START; + read_cycle = 0; + printf("i2c master clears address flag timeout in READ!\n"); + } + break; + + case I2C_TRANSMIT_DATA: + if(RESET == read_cycle) { + /* wait until the transmit data buffer is empty */ + while((!i2c_flag_get(I2C0, I2C_FLAG_TBE)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + /* send the EEPROM's internal address to write to : only one byte address */ + i2c_data_transmit(I2C0, RegisterAddr); + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + read_cycle = 0; + printf("i2c master wait data buffer is empty timeout in READ!\n"); + } + /* wait until BTC bit is set */ + while((!i2c_flag_get(I2C0, I2C_FLAG_BTC)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + state = I2C_START; + read_cycle++; + } else { + timeout = 0; + state = I2C_START; + read_cycle = 0; + printf("i2c master sends i2c_master_read_register1 internal address timeout in READ!\n"); + } + } else { + while(RegisterLen) { + timeout++; + if(3 == RegisterLen) { + /* wait until BTC bit is set */ + while(!i2c_flag_get(I2C0, I2C_FLAG_BTC)); + /* disable acknowledge */ + i2c_ack_config(I2C0, I2C_ACK_DISABLE); + } + if(2 == RegisterLen) { + /* wait until BTC bit is set */ + while(!i2c_flag_get(I2C0, I2C_FLAG_BTC)); + /* send a stop condition to I2C bus */ + i2c_stop_on_bus(I2C0); + } + /* wait until RBNE bit is set */ + if(i2c_flag_get(I2C0, I2C_FLAG_RBNE)) { + /* read a byte from the EEPROM */ + *RegisterValue = i2c_data_receive(I2C0); + /* point to the next location where the byte read will be saved */ + RegisterValue++; + /* decrement the read bytes counter */ + RegisterLen--; + timeout = 0; + } + if(timeout > I2C_TIME_OUT) { + timeout = 0; + state = I2C_START; + read_cycle = 0; + printf("i2c master sends data timeout in READ!\n"); + } + } + timeout = 0; + state = I2C_STOP; + } + break; + + case I2C_STOP: + /* i2c master sends STOP signal successfully */ + while((I2C_CTL0(I2C0) & I2C_CTL0_STOP) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + state = I2C_END; + i2c_timeout_flag = I2C_OK; + } else { + timeout = 0; + state = I2C_START; + read_cycle = 0; + printf("i2c master sends stop signal timeout in READ!\n"); + } + break; + + default: + state = I2C_START; + read_cycle = 0; + i2c_timeout_flag = I2C_OK; + timeout = 0; + printf("i2c master sends start signal in READ.\n"); + break; + } + } + return IIC_SUCCESS; +} + +/*! + \brief TWI3(none) read data from the IIC Slave Device + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] RegisterAddr: the IIC Slave Device's internal address to start reading from + \param[in] RegisterLen: number of bytes to reads from the IIC Slave Device + \param[in] RegisterValue: pointer to the buffer that receives the data read from the IIC Slave Device + \param[out] RegisterValue: pointer to the buffer that receives the data read from the IIC Slave Device + \retval IIC_SUCCESS + \note No TWI3(IIC3) - No operation - Error log. +*/ +uint8_t i2c_master_read_register3(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue){ + __NOP(); + #ifdef DEBUG_VERBOES + printf("\n[DebugVerboes]i2c_master_read_register3 @ i2c.c, no TWI3 \n"); + #endif + return IIC_SUCCESS; +} + +/*! + \brief TWI1(IIC0) read data from the IIC Slave Device + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] len: number of bytes to reads from the IIC Slave Device + \param[in] data: pointer to the buffer that receives the data read from the IIC Slave Device + \param[out] data: pointer to the buffer that receives the data read from the IIC Slave Device + \retval IIC_SUCCESS +*/ +uint8_t i2c_master_read_register1_raw(unsigned char Address, unsigned short len, unsigned char *data){ + uint8_t state = I2C_START; + // uint8_t read_cycle = 0; + uint16_t timeout = 0; + uint8_t i2c_timeout_flag = 0; + unsigned char IIC_SLAVE_ADDR = (Address << 1); + + i2c_ack_config(I2C0, I2C_ACK_ENABLE); + while (!(i2c_timeout_flag)) + { + switch (state) + { + case I2C_START: + /* i2c master sends start signal only when the bus is idle */ + while (i2c_flag_get(I2C0, I2C_FLAG_I2CBSY) && (timeout < i2c_timeout_flag)) + { + timeout ++; + } + if(timeout < I2C_TIME_OUT) + { + /* whether to send ACK or not for the next byte */ + if(2 == len) { + i2c_ackpos_config(I2C0, I2C_ACKPOS_NEXT); + } + } else { + i2c_bus_reset(); + timeout = 0; + state = I2C_START; + printf("i2c bus is busy in READ!\n"); + } + /* send the start signal */ + i2c_start_on_bus(I2C0); + timeout = 0; + state = I2C_SEND_ADDR; + break; + + case I2C_SEND_ADDR: + /* i2c master sends START signal successfully */ + while((!i2c_flag_get(I2C0, I2C_FLAG_SBSEND)) && (timeout < I2C_TIME_OUT)) + { + timeout++; + } + if(timeout < I2C_TIME_OUT) + { + i2c_master_addressing(I2C0, IIC_SLAVE_ADDR, I2C_RECEIVER); + if(len < 3) { + /* disable acknowledge */ + i2c_ack_config(I2C0, I2C_ACK_DISABLE); + } + state = I2C_CLEAR_ADDRESS_FLAG; + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + // read_cycle = 0; + printf("i2c master sends start signal timeout in READ!\n"); + } + break; + + case I2C_CLEAR_ADDRESS_FLAG: + /* address flag set means i2c slave sends ACK */ + while((!i2c_flag_get(I2C0, I2C_FLAG_ADDSEND)) && (timeout < I2C_TIME_OUT)) + { + timeout++; + } + if(timeout < I2C_TIME_OUT) + { + i2c_flag_clear(I2C0, I2C_FLAG_ADDSEND); + timeout = 0; + state = I2C_TRANSMIT_DATA; + } else { + timeout = 0; + state = I2C_START; + // read_cycle = 0; + printf("i2c master clears address flag timeout in READ!\n"); + } + break; + + case I2C_TRANSMIT_DATA: + while(len) { + timeout++; + if(3 == len) { + /* wait until BTC bit is set */ + while(!i2c_flag_get(I2C0, I2C_FLAG_BTC)); + /* disable acknowledge */ + i2c_ack_config(I2C0, I2C_ACK_DISABLE); + } + if(2 == len) { + /* wait until BTC bit is set */ + while(!i2c_flag_get(I2C0, I2C_FLAG_BTC)); + /* send a stop condition to I2C bus */ + i2c_stop_on_bus(I2C0); + } + /* wait until RBNE bit is set */ + if(i2c_flag_get(I2C0, I2C_FLAG_RBNE)) { + /* read a byte from the EEPROM */ + *data = i2c_data_receive(I2C0); + /* point to the next location where the byte read will be saved */ + data++; + /* decrement the read bytes counter */ + len--; + timeout = 0; + } + if(timeout > I2C_TIME_OUT) { + timeout = 0; + state = I2C_START; + // read_cycle = 0; + printf("i2c master sends data timeout in READ!\n"); + } + } + timeout = 0; + state = I2C_STOP; + // } + break; + + case I2C_STOP: + /* i2c master sends STOP signal successfully */ + while((I2C_CTL0(I2C0) & I2C_CTL0_STOP) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + state = I2C_END; + i2c_timeout_flag = I2C_OK; + } else { + timeout = 0; + state = I2C_START; + // read_cycle = 0; + printf("i2c master sends stop signal timeout in READ!\n"); + } + break; + + default: + state = I2C_START; + // read_cycle = 0; + i2c_timeout_flag = I2C_OK; + timeout = 0; + printf("i2c master sends start signal in READ.\n"); + break; + } + } + return IIC_SUCCESS; +} + +/*! + \brief TWI3(none) read data from the IIC Slave Device with no regisiter address + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] len: number of bytes to reads from the IIC Slave Device + \param[in] data: pointer to the buffer that receives the data read from the IIC Slave Device + \param[out] data: pointer to the buffer that receives the data read from the IIC Slave Device + \retval IIC_SUCCESS + \note No TWI3(IIC3) - No operation - Error log. +*/ +uint8_t i2c_master_read_register3_raw(unsigned char Address, unsigned short len, unsigned char *data){ + __NOP(); + #ifdef DEBUG_VERBOES + printf("\n[DebugVerboes]i2c_master_read_register3_raw @ i2c.c, no TWI3 \n"); + #endif + return IIC_SUCCESS; +} + +/*! + \brief TWI1(IIC0) write data to the IIC Slave Device + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] RegisterAddr: the IIC Slave Device's internal address to start writing to + \param[in] RegisterLen: number of bytes to write to the IIC Slave Device + \param[in] RegisterValue: pointer to the buffer that transfer the data write to the IIC Slave Device + \param[out] RegisterValue: pointer to the buffer that transfer the data write to the IIC Slave Device + \retval IIC_SUCCESS +*/ +uint8_t i2c_master_write_register1(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue) +{ + uint8_t state = I2C_START; + uint16_t timeout = 0; + uint8_t i2c_timeout_flag = 0; + unsigned char IIC_SLAVE_ADDR = (Address << 1); + + /* enable acknowledge */ + i2c_ack_config(I2C0, I2C_ACK_ENABLE); + while(!(i2c_timeout_flag)) { + switch(state) { + case I2C_START: + /* i2c master sends start signal only when the bus is idle */ + while(i2c_flag_get(I2C0, I2C_FLAG_I2CBSY) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + i2c_start_on_bus(I2C0); + timeout = 0; + state = I2C_SEND_ADDR; + } else { + i2c_bus_reset(); + timeout = 0; + state = I2C_START; + printf("i2c bus is busy in WRITE!\n"); + } + break; + + case I2C_SEND_ADDR: + /* i2c master sends START signal successfully */ + while((!i2c_flag_get(I2C0, I2C_FLAG_SBSEND)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + i2c_master_addressing(I2C0, IIC_SLAVE_ADDR, I2C_TRANSMITTER); + timeout = 0; + state = I2C_CLEAR_ADDRESS_FLAG; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends start signal timeout in WRITE!\n"); + } + break; + + case I2C_CLEAR_ADDRESS_FLAG: + /* address flag set means i2c slave sends ACK */ + while((!i2c_flag_get(I2C0, I2C_FLAG_ADDSEND)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + i2c_flag_clear(I2C0, I2C_FLAG_ADDSEND); + timeout = 0; + state = I2C_TRANSMIT_DATA; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master clears address flag timeout in WRITE!\n"); + } + break; + + case I2C_TRANSMIT_DATA: + /* wait until the transmit data buffer is empty */ + while((!i2c_flag_get(I2C0, I2C_FLAG_TBE)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + /* send the EEPROM's internal address to write to : only one byte address */ + i2c_data_transmit(I2C0, RegisterAddr); + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends i2c_master_write_register1 internal address timeout in WRITE!\n"); + } + /* wait until BTC bit is set */ + while((!i2c_flag_get(I2C0, I2C_FLAG_BTC)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends data timeout in WRITE!\n"); + } + while(RegisterLen--) { + i2c_data_transmit(I2C0, *RegisterValue); + /* point to the next byte to be written */ + RegisterValue++; + /* wait until BTC bit is set */ + while((!i2c_flag_get(I2C0, I2C_FLAG_BTC)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends data timeout in WRITE!\n"); + } + } + timeout = 0; + state = I2C_STOP; + break; + + case I2C_STOP: + /* send a stop condition to I2C bus */ + i2c_stop_on_bus(I2C0); + /* i2c master sends STOP signal successfully */ + while((I2C_CTL0(I2C0) & I2C_CTL0_STOP) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + state = I2C_END; + i2c_timeout_flag = I2C_OK; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends stop signal timeout in WRITE!\n"); + } + break; + + default: + state = I2C_START; + i2c_timeout_flag = I2C_OK; + timeout = 0; + printf("i2c master sends start signal in WRITE.\n"); + break; + } + } + return IIC_SUCCESS; +} + +/*! + \brief TWI3(none) write data to the IIC Slave Device + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] RegisterAddr: the IIC Slave Device's internal address to start writing to + \param[in] RegisterLen: number of bytes to write to the IIC Slave Device + \param[in] RegisterValue: pointer to the buffer that transfer the data write to the IIC Slave Device + \param[out] RegisterValue: pointer to the buffer that transfer the data write to the IIC Slave Device + \retval IIC_SUCCESS + \note No TWI3(IIC3) - No operation - Error log. +*/ +uint8_t i2c_master_write_register3(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue){ + __NOP(); + #ifdef DEBUG_VERBOES + printf("\n[DebugVerboes]i2c_master_write_register3 @ i2c.c, no TWI3 \n"); + #endif + return IIC_SUCCESS; +} + +/*! + \brief TWI1(IIC0) write data to the IIC Slave Device with no regisiter address + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] len: number of bytes to write to the IIC Slave Device + \param[in] data: pointer to the buffer that transfer the data write to the IIC Slave Device + \param[out] data: pointer to the buffer that transfer the data write to the IIC Slave Device + \retval IIC_SUCCESS +*/ +uint8_t i2c_master_write_register1_raw(unsigned char Address, unsigned short len, unsigned char *data){ + uint8_t state = I2C_START; + uint16_t timeout = 0; + uint8_t i2c_timeout_flag = 0; + unsigned char IIC_SLAVE_ADDR = (Address << 1); + + /* enable acknowledge */ + i2c_ack_config(I2C0, I2C_ACK_ENABLE); + while(!(i2c_timeout_flag)) { + switch(state) { + case I2C_START: + /* i2c master sends start signal only when the bus is idle */ + while(i2c_flag_get(I2C0, I2C_FLAG_I2CBSY) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + i2c_start_on_bus(I2C0); + timeout = 0; + state = I2C_SEND_ADDR; + } else { + i2c_bus_reset(); + timeout = 0; + state = I2C_START; + printf("i2c bus is busy in WRITE!\n"); + } + break; + + case I2C_SEND_ADDR: + /* i2c master sends START signal successfully */ + while((!i2c_flag_get(I2C0, I2C_FLAG_SBSEND)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + i2c_master_addressing(I2C0, IIC_SLAVE_ADDR, I2C_TRANSMITTER); + timeout = 0; + state = I2C_CLEAR_ADDRESS_FLAG; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends start signal timeout in WRITE!\n"); + } + break; + + case I2C_CLEAR_ADDRESS_FLAG: + /* address flag set means i2c slave sends ACK */ + while((!i2c_flag_get(I2C0, I2C_FLAG_ADDSEND)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + i2c_flag_clear(I2C0, I2C_FLAG_ADDSEND); + timeout = 0; + state = I2C_TRANSMIT_DATA; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master clears address flag timeout in WRITE!\n"); + } + break; + + case I2C_TRANSMIT_DATA: + /* wait until the transmit data buffer is empty */ + while((!i2c_flag_get(I2C0, I2C_FLAG_TBE)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + while(len--) { + i2c_data_transmit(I2C0, *data); + /* point to the next byte to be written */ + data++; + /* wait until BTC bit is set */ + while((!i2c_flag_get(I2C0, I2C_FLAG_BTC)) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends data timeout in WRITE!\n"); + } + } + timeout = 0; + state = I2C_STOP; + break; + + case I2C_STOP: + /* send a stop condition to I2C bus */ + i2c_stop_on_bus(I2C0); + /* i2c master sends STOP signal successfully */ + while((I2C_CTL0(I2C0) & I2C_CTL0_STOP) && (timeout < I2C_TIME_OUT)) { + timeout++; + } + if(timeout < I2C_TIME_OUT) { + timeout = 0; + state = I2C_END; + i2c_timeout_flag = I2C_OK; + } else { + timeout = 0; + state = I2C_START; + printf("i2c master sends stop signal timeout in WRITE!\n"); + } + break; + + default: + state = I2C_START; + i2c_timeout_flag = I2C_OK; + timeout = 0; + printf("i2c master sends start signal in WRITE.\n"); + break; + } + } + return IIC_SUCCESS; +} + +/*! + \brief TWI3(none) write data to the IIC Slave Device with no regisiter address + \param[in] Address: the IIC Slave Device's IIC Device Address + \param[in] len: number of bytes to write to the IIC Slave Device + \param[in] data: pointer to the buffer that transfer the data write to the IIC Slave Device + \param[out] data: pointer to the buffer that transfer the data write to the IIC Slave Device + \retval IIC_SUCCESS + \note No TWI3(IIC3) - No operation - Error log. +*/ +uint8_t i2c_master_write_register3_raw(unsigned char Address, unsigned short len, unsigned char *data){ + __NOP(); + #ifdef DEBUG_VERBOES + printf("\n[DebugVerboes]i2c_master_write_register3_raw @ i2c.c, no TWI3 \n"); + #endif + return IIC_SUCCESS; +} \ No newline at end of file diff --git a/CHIRP/board/i2c.h b/CHIRP/board/i2c.h new file mode 100644 index 0000000..96a95f8 --- /dev/null +++ b/CHIRP/board/i2c.h @@ -0,0 +1,55 @@ +#ifndef I2C_H +#define I2C_H + +#define I2C_TIME_OUT (uint16_t)(5000) +#define I2C_OK 1 +#define I2C_FAIL 0 +#define I2C_END 1 + +typedef enum { + I2C_START = 0, + I2C_SEND_ADDR, + I2C_CLEAR_ADDRESS_FLAG, + I2C_TRANSMIT_DATA, + I2C_STOP +} i2c_process_enum; + + +/** + * \brief Return codes for IIC APIs. + * @{ + */ +#define IIC_SUCCESS 0 +#define IIC_INVALID_ARGUMENT 1 +#define IIC_ARBITRATION_LOST 2 +#define IIC_NO_CHIP_FOUND 3 +#define IIC_RECEIVE_OVERRUN 4 +#define IIC_RECEIVE_NACK 5 +#define IIC_SEND_OVERRUN 6 +#define IIC_SEND_NACK 7 +#define IIC_BUSY 8 +#define IIC_ERROR_TIMEOUT 9 +/** + * @} + */ + +void i2c_master_initialize1(void); +void i2c_master_initialize3(void); +void i2c_master_init(void); +void i2c_master_deinit1(void); +void i2c_master_deinit3(void); + +uint8_t i2c_master_read_register1(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue); +uint8_t i2c_master_read_register3(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue); + +uint8_t i2c_master_read_register1_raw(unsigned char Address, unsigned short len, unsigned char *data); +uint8_t i2c_master_read_register3_raw(unsigned char Address, unsigned short len, unsigned char *data); + + +uint8_t i2c_master_write_register1(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue); +uint8_t i2c_master_write_register3(unsigned char Address, unsigned char RegisterAddr, unsigned short RegisterLen, unsigned char *RegisterValue); + +uint8_t i2c_master_write_register1_raw(unsigned char Address, unsigned short len, unsigned char *data); +uint8_t i2c_master_write_register3_raw(unsigned char Address, unsigned short len, unsigned char *data); + +#endif /* I2C_H */ \ No newline at end of file diff --git a/CHIRP/drivers/inc/Doxyfile b/CHIRP/drivers/inc/Doxyfile new file mode 100644 index 0000000..781d77e --- /dev/null +++ b/CHIRP/drivers/inc/Doxyfile @@ -0,0 +1,2511 @@ +# Doxyfile 1.8.14 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Chirp SonicLib" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +# PROJECT_NUMBER = v2.0.4 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = .. + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = YES + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be pased to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: 0. + +CLANG_COMPILATION_DATABASE_PATH= 0 + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://doc.qt.io/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://doc.qt.io/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://doc.qt.io/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://doc.qt.io/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = YES + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /