From 45e19e5bf783bf874b8c9825b76c4c5befa8bcba Mon Sep 17 00:00:00 2001 From: lbm-team Date: Thu, 27 Jul 2023 11:16:40 +0200 Subject: [PATCH] Release v4.1.0-feature-fuota --- CHANGELOG.md | 83 +- LICENSE.txt | 2 +- LICENSES.txt | 2 +- Makefile | 144 +- README.md | 338 +- lora_basics_modem_version.h | 6 +- makefiles/common.mk | 439 +-- makefiles/lr11xx.mk | 30 +- makefiles/options.mk | 85 + makefiles/printing.mk | 6 +- makefiles/regions.mk | 4 +- makefiles/sx126x.mk | 16 +- makefiles/sx127x.mk | 52 + makefiles/sx128x.mk | 2 + smtc_modem_api/CHANGELOG.md | 83 +- smtc_modem_api/doxygen.config | 2494 ------------- smtc_modem_api/smtc_modem_api.h | 1886 ++++------ .../smtc_modem_middleware_advanced_api.h | 303 -- smtc_modem_api/smtc_modem_test_api.h | 11 - smtc_modem_api/smtc_modem_utilities.h | 24 +- smtc_modem_core/README.md | 17 - .../device_management_defs.h | 388 -- .../device_management/dm_downlink.c | 559 --- .../device_management/modem_context.c | 2122 ----------- .../device_management/modem_context.h | 1177 ------ smtc_modem_core/lorawan_api/lorawan_api.c | 975 +++-- smtc_modem_core/lorawan_api/lorawan_api.h | 590 +-- .../lorawan_cid_request_management.c | 229 ++ .../lorawan_cid_request_management.h} | 114 +- .../lorawan_class_b_management.c | 346 ++ .../lorawan_class_b_management.h | 113 + .../lorawan_dwn_ack_management.c | 182 + .../lorawan_dwn_ack_management.h} | 73 +- .../lorawan_manager/lorawan_join_management.c | 220 ++ .../lorawan_join_management.h} | 94 +- .../lorawan_management_defs.h} | 23 +- .../lorawan_manager/lorawan_send_management.c | 265 ++ .../lorawan_manager/lorawan_send_management.h | 106 + .../fuota_packages/fragmentation_helper.c | 683 ++++ .../fuota_packages/fragmentation_helper.h | 171 + .../fuota_packages/lorawan_alcsync.c | 855 +++++ .../fuota_packages/lorawan_alcsync.h | 113 +- .../fuota_packages/lorawan_fmp_package.c | 780 ++++ .../fuota_packages/lorawan_fmp_package.h | 123 + .../lorawan_fragmentation_package.c | 629 ++++ .../lorawan_fragmentation_package.h | 154 + .../fuota_packages/lorawan_mpa_package.c | 462 +++ .../fuota_packages/lorawan_mpa_package.h | 121 + .../lorawan_remote_multicast_setup_package.c | 930 +++++ .../lorawan_remote_multicast_setup_package.h | 123 + .../fuota_packages_v2/fragmentation_helper.c | 688 ++++ .../fuota_packages_v2/fragmentation_helper.h | 172 + .../fuota_packages_v2/lorawan_alcsync.c | 863 +++++ .../fuota_packages_v2/lorawan_alcsync.h | 151 + .../fuota_packages_v2/lorawan_fmp_package.c | 780 ++++ .../fuota_packages_v2/lorawan_fmp_package.h | 123 + .../lorawan_fragmentation_package.c | 772 ++++ .../lorawan_fragmentation_package.h | 154 + .../fuota_packages_v2/lorawan_mpa_package.c | 462 +++ .../fuota_packages_v2/lorawan_mpa_package.h | 121 + .../lorawan_remote_multicast_setup_package.c | 943 +++++ .../lorawan_remote_multicast_setup_package.h | 123 + .../lorawan_beacon_tx_service_example.c | 275 ++ .../lorawan_beacon_tx_service_example.h | 135 + .../lorawan_packages/lorawan_certification.c | 842 +++++ .../lorawan_certification.h | 198 +- .../lorawan_packages/lorawan_template.c | 156 + .../lorawan_packages/lorawan_template.h | 135 + smtc_modem_core/lr1mac/license.md | 25 - smtc_modem_core/lr1mac/lr1mac_config.h | 3 - .../lr1mac/src/lr1_stack_mac_layer.c | 1069 +++--- .../lr1mac/src/lr1_stack_mac_layer.h | 150 +- .../src/lr1mac_class_b/smtc_beacon_sniff.c | 247 +- .../src/lr1mac_class_b/smtc_beacon_sniff.h | 72 +- .../lr1mac/src/lr1mac_class_b/smtc_d2d.c | 603 --- .../lr1mac/src/lr1mac_class_b/smtc_d2d.h | 117 - .../src/lr1mac_class_b/smtc_ping_slot.c | 401 +- .../src/lr1mac_class_b/smtc_ping_slot.h | 73 +- .../src/lr1mac_class_c/lr1mac_class_c.c | 231 +- .../src/lr1mac_class_c/lr1mac_class_c.h | 59 +- smtc_modem_core/lr1mac/src/lr1mac_core.c | 798 ++-- smtc_modem_core/lr1mac/src/lr1mac_core.h | 182 +- smtc_modem_core/lr1mac/src/lr1mac_defs.h | 46 +- smtc_modem_core/lr1mac/src/lr1mac_utilities.c | 43 +- smtc_modem_core/lr1mac/src/lr1mac_utilities.h | 44 +- .../lr1mac/src/services/smtc_duty_cycle.c | 228 +- .../lr1mac/src/services/smtc_duty_cycle.h | 43 +- .../lr1mac/src/services/smtc_lbt.c | 45 +- .../lr1mac/src/services/smtc_lora_cad_bt.c | 427 +++ .../lr1mac/src/services/smtc_lora_cad_bt.h | 193 + .../{ => smtc_multicast}/smtc_multicast.c | 85 +- .../{ => smtc_multicast}/smtc_multicast.h | 43 +- .../lr1mac/src/smtc_real/src/region_as_923.c | 276 +- .../lr1mac/src/smtc_real/src/region_as_923.h | 29 +- .../src/smtc_real/src/region_as_923_defs.h | 55 +- .../lr1mac/src/smtc_real/src/region_au_915.c | 388 +- .../lr1mac/src/smtc_real/src/region_au_915.h | 41 +- .../src/smtc_real/src/region_au_915_defs.h | 7 +- .../lr1mac/src/smtc_real/src/region_cn_470.c | 368 +- .../lr1mac/src/smtc_real/src/region_cn_470.h | 51 +- .../src/smtc_real/src/region_cn_470_defs.h | 4 +- .../src/smtc_real/src/region_cn_470_rp_1_0.c | 301 +- .../src/smtc_real/src/region_cn_470_rp_1_0.h | 47 +- .../smtc_real/src/region_cn_470_rp_1_0_defs.h | 4 +- .../lr1mac/src/smtc_real/src/region_eu_868.c | 257 +- .../lr1mac/src/smtc_real/src/region_eu_868.h | 44 +- .../src/smtc_real/src/region_eu_868_defs.h | 4 +- .../lr1mac/src/smtc_real/src/region_in_865.c | 224 +- .../lr1mac/src/smtc_real/src/region_in_865.h | 31 +- .../src/smtc_real/src/region_in_865_defs.h | 4 +- .../lr1mac/src/smtc_real/src/region_kr_920.c | 232 +- .../lr1mac/src/smtc_real/src/region_kr_920.h | 33 +- .../src/smtc_real/src/region_kr_920_defs.h | 4 +- .../lr1mac/src/smtc_real/src/region_ru_864.c | 243 +- .../lr1mac/src/smtc_real/src/region_ru_864.h | 35 +- .../src/smtc_real/src/region_ru_864_defs.h | 4 +- .../lr1mac/src/smtc_real/src/region_us_915.c | 387 +- .../lr1mac/src/smtc_real/src/region_us_915.h | 48 +- .../src/smtc_real/src/region_us_915_defs.h | 5 +- .../lr1mac/src/smtc_real/src/region_ww2g4.c | 231 +- .../lr1mac/src/smtc_real/src/region_ww2g4.h | 37 +- .../src/smtc_real/src/region_ww2g4_defs.h | 4 +- .../lr1mac/src/smtc_real/src/smtc_real.c | 1269 ++++--- .../lr1mac/src/smtc_real/src/smtc_real.h | 252 +- .../lr1mac/src/smtc_real/src/smtc_real_defs.h | 59 +- smtc_modem_core/modem_core/smtc_modem.c | 3218 ----------------- .../fragmentation/frag_decoder.c | 915 ----- .../fragmentation/frag_decoder.h | 218 -- .../fragmentation/fragmented_data_block.c | 1423 -------- .../fragmentation/fragmented_data_block.h | 188 - .../modem_services/fragmentation/patch_upd.c | 315 -- .../modem_services/fragmentation/patch_upd.h | 90 - .../modem_services/lorawan_certification.c | 574 --- .../modem_services/modem_utilities.c | 61 - .../modem_services/smtc_clock_sync.c | 551 --- .../modem_services/smtc_clock_sync.h | 316 -- .../smtc_modem_services_config.h | 86 - .../modem_supervisor/modem_supervisor.c | 1587 -------- .../modem_supervisor/modem_supervisor.h | 251 -- .../modem_supervisor/modem_supervisor_light.c | 471 +++ .../modem_supervisor/modem_supervisor_light.h | 236 ++ .../fifo_ctrl.c | 0 .../fifo_ctrl.h | 0 smtc_modem_core/modem_utilities/modem_core.c | 355 ++ smtc_modem_core/modem_utilities/modem_core.h | 200 + .../modem_utilities/modem_event_utilities.c | 184 + .../modem_utilities/modem_event_utilities.h | 123 + .../modem_utilities/modem_services_config.h | 101 + .../radio_drivers/lr11xx_driver/CHANGELOG.md | 32 +- .../radio_drivers/lr11xx_driver/README.md | 48 +- .../lr11xx_driver/src/lr11xx_crypto_engine.c | 124 +- .../lr11xx_driver/src/lr11xx_crypto_engine.h | 94 +- .../src/lr11xx_driver_module.cmake | 1 + .../lr11xx_driver/src/lr11xx_driver_version.h | 4 +- .../lr11xx_driver/src/lr11xx_gnss.c | 206 +- .../lr11xx_driver/src/lr11xx_gnss.h | 92 +- .../lr11xx_driver/src/lr11xx_gnss_types.h | 10 + .../lr11xx_driver/src/lr11xx_lr_fhss.c | 108 +- .../lr11xx_driver/src/lr11xx_lr_fhss.h | 12 +- .../lr11xx_driver/src/lr11xx_radio.c | 156 +- .../lr11xx_driver/src/lr11xx_radio.h | 183 +- .../lr11xx_driver/src/lr11xx_radio_types.h | 75 +- .../lr11xx_driver/src/lr11xx_ranging.c | 340 ++ .../lr11xx_driver/src/lr11xx_ranging.h | 234 ++ .../lr11xx_driver/src/lr11xx_ranging_types.h} | 160 +- .../lr11xx_driver/src/lr11xx_regmem.c | 10 + .../lr11xx_driver/src/lr11xx_regmem.h | 9 +- .../lr11xx_driver/src/lr11xx_system.c | 2 +- .../lr11xx_driver/src/lr11xx_system_types.h | 30 +- .../lr11xx_driver/src/lr11xx_wifi.h | 4 +- .../radio_drivers/sx126x_driver/CHANGELOG.md | 8 + .../src/sx126x_driver_version.c} | 51 +- .../sx126x_driver/src/sx126x_driver_version.h | 57 +- .../sx126x_driver/src/sx126x_lr_fhss.c | 11 + .../sx126x_driver/src/sx126x_lr_fhss.h | 10 + .../radio_drivers/sx127x_driver/CHANGELOG.md | 11 + .../radio_drivers/sx127x_driver/LICENSE.md | 27 + .../radio_drivers/sx127x_driver/README.md | 29 + .../radio_drivers/sx127x_driver/src/sx127x.c | 3028 ++++++++++++++++ .../radio_drivers/sx127x_driver/src/sx127x.h | 1115 ++++++ .../sx127x_driver/src/sx127x_hal.h | 186 + .../sx127x_driver/src/sx127x_regs.h} | 46 +- .../src/sx127x_regs_common_defs.h | 576 +++ .../sx127x_driver/src/sx127x_regs_gfsk_defs.h | 925 +++++ .../sx127x_driver/src/sx127x_regs_lora_defs.h | 516 +++ smtc_modem_core/radio_planner/license.md | 25 - .../radio_planner/src/radio_planner.c | 580 +-- .../radio_planner/src/radio_planner.h | 37 +- .../src/radio_planner_hook_id_defs.h | 49 +- .../radio_planner/src/radio_planner_types.h | 9 +- smtc_modem_core/smtc_modem.c | 1781 +++++++++ .../lr11xx_crypto_engine/lr11xx_ce.c | 152 +- .../smtc_modem_crypto/smtc_modem_crypto.c | 87 +- .../smtc_modem_crypto/smtc_modem_crypto.h | 22 +- .../smtc_secure_element/smtc_secure_element.h | 28 +- .../soft_secure_element/soft_se.c | 108 +- .../smtc_modem_hal_dbg_trace.h | 0 .../smtc_modem_services/headers/alc_sync.h | 322 -- .../smtc_modem_services/headers/file_upload.h | 177 - .../smtc_modem_services/headers/stream.h | 200 - .../smtc_modem_services_config.template.h | 84 - .../smtc_modem_services_hal.h | 152 - .../src/alc_sync/alc_sync.c | 553 --- .../src/file_upload/file_upload.c | 438 --- .../src/stream/lmic_defines.h | 53 - .../smtc_modem_services/src/stream/rose.c | 659 ---- .../smtc_modem_services/src/stream/rose.h | 127 - .../smtc_modem_services/src/stream/rose.rst | 493 --- .../src/stream/rose_defs.h | 71 - .../smtc_modem_services/src/stream/stream.c | 232 -- .../{modem_core => }/smtc_modem_test.c | 239 +- smtc_modem_core/smtc_ral/README.md | 22 + smtc_modem_core/smtc_ral/src/ral.h | 57 +- smtc_modem_core/smtc_ral/src/ral_defs.h | 15 +- smtc_modem_core/smtc_ral/src/ral_drv.h | 19 +- smtc_modem_core/smtc_ral/src/ral_llcc68.c | 128 +- smtc_modem_core/smtc_ral/src/ral_llcc68.h | 33 +- smtc_modem_core/smtc_ral/src/ral_llcc68_bsp.h | 16 +- smtc_modem_core/smtc_ral/src/ral_lr11xx.c | 140 +- smtc_modem_core/smtc_ral/src/ral_lr11xx.h | 33 +- smtc_modem_core/smtc_ral/src/ral_lr11xx_bsp.h | 29 +- smtc_modem_core/smtc_ral/src/ral_sx126x.c | 261 +- smtc_modem_core/smtc_ral/src/ral_sx126x.h | 54 +- smtc_modem_core/smtc_ral/src/ral_sx126x_bsp.h | 23 +- smtc_modem_core/smtc_ral/src/ral_sx127x.c | 1100 ++++++ smtc_modem_core/smtc_ral/src/ral_sx127x.h | 458 +++ smtc_modem_core/smtc_ral/src/ral_sx127x_bsp.h | 114 + smtc_modem_core/smtc_ral/src/ral_sx128x.c | 37 +- smtc_modem_core/smtc_ral/src/ral_sx128x.h | 34 +- smtc_modem_core/smtc_ral/src/ral_sx128x_bsp.h | 17 +- smtc_modem_core/smtc_ralf/src/ralf.h | 13 + smtc_modem_core/smtc_ralf/src/ralf_defs.h | 10 +- smtc_modem_core/smtc_ralf/src/ralf_drv.h | 8 +- smtc_modem_core/smtc_ralf/src/ralf_lr11xx.c | 40 +- smtc_modem_core/smtc_ralf/src/ralf_lr11xx.h | 13 +- smtc_modem_core/smtc_ralf/src/ralf_sx126x.c | 41 +- smtc_modem_core/smtc_ralf/src/ralf_sx126x.h | 13 +- smtc_modem_core/smtc_ralf/src/ralf_sx127x.c | 205 ++ smtc_modem_core/smtc_ralf/src/ralf_sx127x.h | 110 + .../smtc_ralf/src/ralf_sx127x_bsp.h | 73 + smtc_modem_core/smtc_ralf/src/ralf_sx128x.c | 7 +- smtc_modem_core/smtc_ralf/src/ralf_sx128x.h | 13 +- smtc_modem_hal/CHANGELOG.md | 51 +- smtc_modem_hal/smtc_modem_hal.h | 201 +- utilities/Makefile | 237 +- utilities/README.md | 81 +- .../common.mk => app_makefiles/app_common.mk} | 287 +- .../lr11xx.mk => app_makefiles/app_lr11xx.mk} | 30 +- utilities/app_makefiles/app_options.mk | 75 + utilities/app_makefiles/app_printing.mk | 60 + .../sx126x.mk => app_makefiles/app_sx126x.mk} | 18 +- utilities/app_makefiles/app_sx127x.mk | 49 + .../sx128x.mk => app_makefiles/app_sx128x.mk} | 7 +- .../board_L476.mk | 15 +- utilities/user_app/hw_modem/cmd_parser.c | 1728 +++++++++ utilities/user_app/hw_modem/cmd_parser.h | 269 ++ utilities/user_app/hw_modem/hw_modem.c | 296 ++ utilities/user_app/hw_modem/hw_modem.h | 95 + .../user_app/hw_modem/main_hw_modem.c | 125 +- utilities/user_app/main.c | 5 + utilities/user_app/main.h | 4 + .../user_app/main_examples/example_options.h | 41 +- utilities/user_app/main_examples/main_exti.c | 350 +- .../main_examples/main_porting_tests.c | 1556 ++++++++ .../mcu_drivers/core/stm32l476rgtx_flash.ld | 479 ++- utilities/user_app/modem_pinout.h | 17 +- .../user_app/radio_hal/radio_utilities.c | 72 +- .../user_app/radio_hal/radio_utilities.h | 88 + utilities/user_app/radio_hal/ral_lr11xx_bsp.c | 41 +- utilities/user_app/radio_hal/ral_sx126x_bsp.c | 35 +- utilities/user_app/radio_hal/ral_sx127x_bsp.c | 183 + utilities/user_app/radio_hal/ral_sx128x_bsp.c | 21 +- utilities/user_app/radio_hal/sx127x_hal.c | 207 ++ utilities/user_app/smtc_hal_l4/smtc_hal_adc.c | 204 -- .../user_app/smtc_hal_l4/smtc_hal_flash.c | 20 +- .../user_app/smtc_hal_l4/smtc_hal_flash.h | 213 +- .../user_app/smtc_hal_l4/smtc_hal_lp_timer.c | 89 +- .../user_app/smtc_hal_l4/smtc_hal_lp_timer.h | 44 +- utilities/user_app/smtc_hal_l4/smtc_hal_mcu.c | 238 +- utilities/user_app/smtc_hal_l4/smtc_hal_mcu.h | 5 - utilities/user_app/smtc_hal_l4/smtc_hal_rtc.c | 112 +- utilities/user_app/smtc_hal_l4/smtc_hal_rtc.h | 7 - .../user_app/smtc_hal_l4/smtc_hal_watchdog.c | 2 +- .../user_app/smtc_hal_l4/smtc_hal_watchdog.h | 2 +- .../user_app/smtc_modem_hal/smtc_modem_hal.c | 237 +- 285 files changed, 42672 insertions(+), 31076 deletions(-) create mode 100644 makefiles/options.mk create mode 100644 makefiles/sx127x.mk delete mode 100644 smtc_modem_api/doxygen.config delete mode 100644 smtc_modem_api/smtc_modem_middleware_advanced_api.h delete mode 100644 smtc_modem_core/README.md delete mode 100644 smtc_modem_core/device_management/device_management_defs.h delete mode 100644 smtc_modem_core/device_management/dm_downlink.c delete mode 100644 smtc_modem_core/device_management/modem_context.c delete mode 100644 smtc_modem_core/device_management/modem_context.h create mode 100644 smtc_modem_core/lorawan_manager/lorawan_cid_request_management.c rename smtc_modem_core/{smtc_modem_services/src/modem_services_common.h => lorawan_manager/lorawan_cid_request_management.h} (65%) create mode 100644 smtc_modem_core/lorawan_manager/lorawan_class_b_management.c create mode 100644 smtc_modem_core/lorawan_manager/lorawan_class_b_management.h create mode 100644 smtc_modem_core/lorawan_manager/lorawan_dwn_ack_management.c rename smtc_modem_core/{smtc_modem_services/headers/almanac_update.h => lorawan_manager/lorawan_dwn_ack_management.h} (65%) create mode 100644 smtc_modem_core/lorawan_manager/lorawan_join_management.c rename smtc_modem_core/{radio_planner/src/radio_planner_hal.h => lorawan_manager/lorawan_join_management.h} (65%) rename smtc_modem_core/{smtc_modem_services/src/file_upload/file_upload_defs.h => lorawan_manager/lorawan_management_defs.h} (87%) create mode 100644 smtc_modem_core/lorawan_manager/lorawan_send_management.c create mode 100644 smtc_modem_core/lorawan_manager/lorawan_send_management.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/fragmentation_helper.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/fragmentation_helper.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_alcsync.c rename smtc_modem_api/smtc_basic_modem_lr11xx_api_extension.h => smtc_modem_core/lorawan_packages/fuota_packages/lorawan_alcsync.h (52%) create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_fmp_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_fmp_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_fragmentation_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_fragmentation_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_mpa_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_mpa_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_remote_multicast_setup_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages/lorawan_remote_multicast_setup_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/fragmentation_helper.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/fragmentation_helper.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_alcsync.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_alcsync.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_fmp_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_fmp_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_fragmentation_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_fragmentation_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_mpa_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_mpa_package.h create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_remote_multicast_setup_package.c create mode 100644 smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_remote_multicast_setup_package.h create mode 100644 smtc_modem_core/lorawan_packages/lorawan_beacon_tx_service_example.c create mode 100644 smtc_modem_core/lorawan_packages/lorawan_beacon_tx_service_example.h create mode 100644 smtc_modem_core/lorawan_packages/lorawan_certification.c rename smtc_modem_core/{modem_services => lorawan_packages}/lorawan_certification.h (64%) create mode 100644 smtc_modem_core/lorawan_packages/lorawan_template.c create mode 100644 smtc_modem_core/lorawan_packages/lorawan_template.h delete mode 100644 smtc_modem_core/lr1mac/license.md delete mode 100644 smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_d2d.c delete mode 100644 smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_d2d.h create mode 100644 smtc_modem_core/lr1mac/src/services/smtc_lora_cad_bt.c create mode 100644 smtc_modem_core/lr1mac/src/services/smtc_lora_cad_bt.h rename smtc_modem_core/lr1mac/src/services/{ => smtc_multicast}/smtc_multicast.c (69%) rename smtc_modem_core/lr1mac/src/services/{ => smtc_multicast}/smtc_multicast.h (73%) delete mode 100644 smtc_modem_core/modem_core/smtc_modem.c delete mode 100644 smtc_modem_core/modem_services/fragmentation/frag_decoder.c delete mode 100644 smtc_modem_core/modem_services/fragmentation/frag_decoder.h delete mode 100644 smtc_modem_core/modem_services/fragmentation/fragmented_data_block.c delete mode 100644 smtc_modem_core/modem_services/fragmentation/fragmented_data_block.h delete mode 100644 smtc_modem_core/modem_services/fragmentation/patch_upd.c delete mode 100644 smtc_modem_core/modem_services/fragmentation/patch_upd.h delete mode 100644 smtc_modem_core/modem_services/lorawan_certification.c delete mode 100644 smtc_modem_core/modem_services/modem_utilities.c delete mode 100644 smtc_modem_core/modem_services/smtc_clock_sync.c delete mode 100644 smtc_modem_core/modem_services/smtc_clock_sync.h delete mode 100644 smtc_modem_core/modem_services/smtc_modem_services_config.h delete mode 100644 smtc_modem_core/modem_supervisor/modem_supervisor.c delete mode 100644 smtc_modem_core/modem_supervisor/modem_supervisor.h create mode 100644 smtc_modem_core/modem_supervisor/modem_supervisor_light.c create mode 100644 smtc_modem_core/modem_supervisor/modem_supervisor_light.h rename smtc_modem_core/{modem_services => modem_utilities}/fifo_ctrl.c (100%) rename smtc_modem_core/{modem_services => modem_utilities}/fifo_ctrl.h (100%) create mode 100644 smtc_modem_core/modem_utilities/modem_core.c create mode 100644 smtc_modem_core/modem_utilities/modem_core.h create mode 100644 smtc_modem_core/modem_utilities/modem_event_utilities.c create mode 100644 smtc_modem_core/modem_utilities/modem_event_utilities.h create mode 100644 smtc_modem_core/modem_utilities/modem_services_config.h create mode 100644 smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_ranging.c create mode 100644 smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_ranging.h rename smtc_modem_core/{modem_services/modem_utilities.h => radio_drivers/lr11xx_driver/src/lr11xx_ranging_types.h} (67%) rename smtc_modem_core/{smtc_modem_services/src/almanac_update/almanac_update.c => radio_drivers/sx126x_driver/src/sx126x_driver_version.c} (68%) rename utilities/user_app/smtc_hal_l4/smtc_hal_adc.h => smtc_modem_core/radio_drivers/sx126x_driver/src/sx126x_driver_version.h (75%) create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/CHANGELOG.md create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/LICENSE.md create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/README.md create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x.c create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x.h create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x_hal.h rename smtc_modem_core/{device_management/dm_downlink.h => radio_drivers/sx127x_driver/src/sx127x_regs.h} (73%) create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x_regs_common_defs.h create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x_regs_gfsk_defs.h create mode 100644 smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x_regs_lora_defs.h delete mode 100644 smtc_modem_core/radio_planner/license.md create mode 100644 smtc_modem_core/smtc_modem.c rename smtc_modem_core/{modem_config => }/smtc_modem_hal_dbg_trace.h (100%) delete mode 100644 smtc_modem_core/smtc_modem_services/headers/alc_sync.h delete mode 100644 smtc_modem_core/smtc_modem_services/headers/file_upload.h delete mode 100755 smtc_modem_core/smtc_modem_services/headers/stream.h delete mode 100644 smtc_modem_core/smtc_modem_services/smtc_modem_services_config.template.h delete mode 100644 smtc_modem_core/smtc_modem_services/smtc_modem_services_hal.h delete mode 100644 smtc_modem_core/smtc_modem_services/src/alc_sync/alc_sync.c delete mode 100644 smtc_modem_core/smtc_modem_services/src/file_upload/file_upload.c delete mode 100644 smtc_modem_core/smtc_modem_services/src/stream/lmic_defines.h delete mode 100755 smtc_modem_core/smtc_modem_services/src/stream/rose.c delete mode 100755 smtc_modem_core/smtc_modem_services/src/stream/rose.h delete mode 100644 smtc_modem_core/smtc_modem_services/src/stream/rose.rst delete mode 100644 smtc_modem_core/smtc_modem_services/src/stream/rose_defs.h delete mode 100755 smtc_modem_core/smtc_modem_services/src/stream/stream.c rename smtc_modem_core/{modem_core => }/smtc_modem_test.c (82%) create mode 100644 smtc_modem_core/smtc_ral/README.md create mode 100644 smtc_modem_core/smtc_ral/src/ral_sx127x.c create mode 100644 smtc_modem_core/smtc_ral/src/ral_sx127x.h create mode 100644 smtc_modem_core/smtc_ral/src/ral_sx127x_bsp.h create mode 100644 smtc_modem_core/smtc_ralf/src/ralf_sx127x.c create mode 100644 smtc_modem_core/smtc_ralf/src/ralf_sx127x.h create mode 100644 smtc_modem_core/smtc_ralf/src/ralf_sx127x_bsp.h rename utilities/{makefiles/common.mk => app_makefiles/app_common.mk} (51%) rename utilities/{makefiles/lr11xx.mk => app_makefiles/app_lr11xx.mk} (78%) create mode 100644 utilities/app_makefiles/app_options.mk create mode 100644 utilities/app_makefiles/app_printing.mk rename utilities/{makefiles/sx126x.mk => app_makefiles/app_sx126x.mk} (80%) create mode 100644 utilities/app_makefiles/app_sx127x.mk rename utilities/{makefiles/sx128x.mk => app_makefiles/app_sx128x.mk} (88%) rename utilities/{makefiles => app_makefiles}/board_L476.mk (78%) create mode 100644 utilities/user_app/hw_modem/cmd_parser.c create mode 100644 utilities/user_app/hw_modem/cmd_parser.h create mode 100644 utilities/user_app/hw_modem/hw_modem.c create mode 100644 utilities/user_app/hw_modem/hw_modem.h rename smtc_modem_core/radio_planner/src/radio_planner_hal.c => utilities/user_app/hw_modem/main_hw_modem.c (62%) create mode 100644 utilities/user_app/main_examples/main_porting_tests.c rename smtc_modem_core/modem_services/smtc_modem_services_hal.c => utilities/user_app/radio_hal/radio_utilities.c (57%) create mode 100644 utilities/user_app/radio_hal/radio_utilities.h create mode 100644 utilities/user_app/radio_hal/ral_sx127x_bsp.c create mode 100644 utilities/user_app/radio_hal/sx127x_hal.c delete mode 100644 utilities/user_app/smtc_hal_l4/smtc_hal_adc.c diff --git a/CHANGELOG.md b/CHANGELOG.md index c6fb7f4..c86af3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,85 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v4.1.0] 2023-07-27 + +This version is based on feature branch v4.0.1 of the LoRa Basics Modem. + +Detailed Modem API changelog can be found [here](smtc_modem_api/CHANGELOG.md) +Detailed Modem HAL changelog can be found [here](smtc_modem_hal/CHANGELOG.md) + +### Added + +* [lorawan-stack] Add CSMA feature support, corresponding api functions and hw modem commands +* [lorawan-package] Add support of Firmware Management Protocol package that follows LoRaWAN® Specification TS006-1.0.0 +* [lorawan-package] Add support of Multi-Package Access Protocol package that follows LoRaWAN® Specification TS007-1.0.0 +* [lorawan-package] Add support of Remote Multicast Setup package that follows LoRaWAN® Specification TS005-2.0.0 +* [lorawan-package] Add support of Application Layer Clock Synchronization that follows LoRaWAN® Specification TS003-2.0.0 +* [lorawan-package] Add support of Fragmented Data Block Transport that follows LoRaWAN® Specification TS004-2.0.0 +* [radio] Add support for sx1272 and sx1276 radios for experimental use only +* [lbm makefile] Add RADIO in options.mk to choose which LoRaWAN regions should be built. +* [lbm makefile] Add missing options in `make help` output +* [utilities] Add an makefile option in `app_options.mk` `LBM_BUILD_OPTIONS` to allow updating any LBM lib build options +* [ral_lr11xx_bsp] Add lr11xx new bsp functions `ral_lr11xx_bsp_get_lora_cad_det_peak` and `ral_lr11xx_bsp_get_rx_boost_cfg` +* [ral_sx126x_bsp] Add sx126x new bsp functions `ral_sx126x_bsp_get_lora_cad_det_peak`, `ral_sx126x_bsp_get_rx_boost_cfg` and `ral_sx126x_bsp_get_trim_cap` +* [ral_sx128x_bsp] Add sx128x new bsp function `ral_sx128x_bsp_get_lora_cad_det_peak` + +### Fixed + +* [AU915/US915] Fix LoRaWAN Link Adr Request channel mask control case 5 missing impact of 500MHz bank +* [class b multicast] Avoid opening multicast ping slots when the session is stopped +* [LRFHSS] Correct tx done timestamp with known bit padding delay to avoid issue with following rx windows (principally seen on US and AU regions) +* [porting tool] Correct porting tool test test_get_time_in_ms to avoid mis-alignment in radio symbol timeout +* [exti example] In `modem_event_callback`, use stack_id value given by `smtc_modem_get_event` instead of fixed defined one +* [ALCSync] Fix ALCsync periodic request timing issue + +### Changed + +* [lr11xx-driver] Update lr11xx radio driver to v2.3.0 version +* [sx126x-driver] Update sx126x radio driver to v2.2.0 version +* [radio-ral] Update ral to get cad specific features +* [Return codes] `smtc_modem_get_pin` and `smtc_modem_derive_keys` now return `SMTC_MODEM_RC_BUSY` in case modem is joining or joined (instead of SMTC_MODEM_RC_FAIL) + +## [v4.0.1] 2023-03-16 + +### Fixed + +* [utilities] fix incorrect location of `smtc_modem_is_irq_flag_pending()` check in exti example (shall be done before entering sleep) + +## [v4.0.0] 2023-03-10 + +### General + +This version is forked of the master branch v3.2.4 and proposes a major update of the LoRa Basics Modem. +The purpose is to have a complete and simple LoRaWAN stack implementation, including additional LoRaWAN packages (Application Layer Clock Synchronization, Fragmented Data Block Transport, Remote Multicast Setup). +Detailed Modem API changelog can be found [here](smtc_modem_api/CHANGELOG.md) +Detailed Modem HAL changelog can be found [here](smtc_modem_hal/CHANGELOG.md) + +### Added + +* [makefile]: add `options.mk` file that gathers all lbm build options + +### Changed + +* [behavior]: Under modem interruption (radio or timer), only the timestamp of the interruption is done (no radio or external peripheral access is done under irq). As a consequence the `smtc_modem_run_engine()` shall be called as soon as possible after any modem interruption (radio or timer) +* [makefile]: default Regional Parameters option is now RP2_103 (previous was RP2_101) +* [utilities]: + * add `app_options.mk` file that gathers all application build options + * [exti-example]: + * update example to send periodical uplinks + * in case compilation is done using `LR11XX_WITH_CREDENTIALS`, internal credentials won't be overridden + * add hardware modem example (folder [hw_modem](utilities/user_app/hw_modem) ) + * add porting tool example + * update smtc_hal_l4 code + * update radio_hal code + * update smtc_modem_hal.c code to be compliant with latest version of lbm + +### Fixed + +* Correct size error in `smtc_secure_element_get_pin` +* [makefile] Remove ARM-specific flag from compilation flag +* [makefile] Correct `MCU_FLAGS` issue + ## [v3.2.4] 2022-08-23 ### Added @@ -38,8 +117,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), * [LBT] Moved log print after enqueued the sniffing task in Radio Planer to avoid to add a delays * [ADR] In case a MAC command `link_adr_req` with a new channel mask is received, it is now accepted if the custom datarate profile is enabled and configured with the highest datarate of the corresponding region * [LFU/Stream] In case of reception of rejoin request from DAS, reset LFU and stream services properly -*[ClockSyncService/MAC] Fixed an issue where the Clock Synchronization Service was not reloaded when DeviceTimeAns was not received -*[DeviceTimeReq/MAC] Fixed an issue where the GPS epoch time became invalid if DeviceTimeAns not received +* [ClockSyncService/MAC] Fixed an issue where the Clock Synchronization Service was not reloaded when DeviceTimeAns was not received +* [DeviceTimeReq/MAC] Fixed an issue where the GPS epoch time became invalid if DeviceTimeAns not received ## [v3.1.7] 2022-04-22 diff --git a/LICENSE.txt b/LICENSE.txt index 7ef65c5..e0df88e 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,5 +1,5 @@ The Clear BSD License -Copyright Semtech Corporation 2022. All rights reserved. +Copyright Semtech Corporation 2023. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer diff --git a/LICENSES.txt b/LICENSES.txt index ef0aefc..81dd6f2 100644 --- a/LICENSES.txt +++ b/LICENSES.txt @@ -13,7 +13,7 @@ Semtech Corporation ------------------- The Clear BSD License -Copyright Semtech Corporation 2022. All rights reserved. +Copyright Semtech Corporation 2023. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer diff --git a/Makefile b/Makefile index 37f8bec..a626b6e 100644 --- a/Makefile +++ b/Makefile @@ -3,76 +3,14 @@ ############################################################################## -include makefiles/printing.mk - -#----------------------------------------------------------------------------- -# Global configuration options -#----------------------------------------------------------------------------- -# Prefix for all build directories -BUILD_ROOT = build - -# Prefix for all binaries names -TARGET_ROOT = basic_modem - -BYPASS=no - -PERF_TEST?=no - -# Compile with coverage analysis support -COVERAGE ?= no - -# Use multithreaded build (make -j) -MULTITHREAD ?= yes - -# Print each object file size -SIZE ?= no - -# Save memory usage to log file -LOG_MEM ?= yes - -# Tranceiver -RADIO ?= nc - -#MCU - Must be provided by user -MCU_FLAGS =? nc - -#----------------------------------------------------------------------------- -# Internal LBM features management -#----------------------------------------------------------------------------- - -# Middleware advanced access -MIDDLEWARE?= no - -# Crypto management -CRYPTO ?= SOFT - -# D2D feature -ADD_D2D ?= no - -# Multicast feature -ADD_MULTICAST ?= yes - -# Stream feature -ADD_SMTC_STREAM ?= yes - -# File Upload feature -ADD_SMTC_FILE_UPLOAD ?= yes - -# ALCSYNC feature -ADD_SMTC_ALC_SYNC ?= yes - -# Trace prints -MODEM_TRACE ?= yes -MODEM_DEEP_TRACE ?= no - -# GNSS -USE_GNSS ?= yes +-include makefiles/options.mk #----------------------------------------------------------------------------- # default action: print help #----------------------------------------------------------------------------- help: - $(call echo_help_b, "Available TARGETs: sx128x lr1110 lr1120 sx1261 sx1262 sx1268") + $(call echo_help_b, "Available TARGETs: sx128x lr1110 lr1120 sx1261 sx1262 sx1268 sx1272 sx1276") $(call echo_help, "") $(call echo_help_b, "-------------------------------- Clean -------------------------------------") $(call echo_help, " * make clean_ : clean basic_modem for a given target") @@ -81,7 +19,7 @@ help: $(call echo_help_b, "----------------------------- Compilation ----------------------------------") $(call echo_help, " * make basic_modem_ MCU_FLAGS=xxx : build basic_modem on a given target with chosen mcu flags") $(call echo_help, " * MCU_FLAGS are mandatory. Ex for stm32l4:") - $(call echo_help, " * MCU_FLAGS=\"-mcpu=cortex-m4 -mthumb -mfpu=fpv4-sp-d16 -mfloat-abi=hard\"") + $(call echo_help, " * MCU_FLAGS=\"-mcpu=cortex-m4 -mthumb -mabi=aapcs -mfpu=fpv4-sp-d16 -mfloat-abi=hard\"") $(call echo_help, "") $(call echo_help_b, "---------------------- Optional build parameters ---------------------------") $(call echo_help, " * REGION=xxx : choose which region should be compiled (default: all)") @@ -96,21 +34,33 @@ help: $(call echo_help, " * - RU_864") $(call echo_help, " * - US_915") $(call echo_help, " * - WW_2G4 (to be used only for lr1120 and sx128x targets)") - $(call echo_help, " * RP_VERSION=xxx : choose wich regional paramerter version should be compiled (default: RP2_101) ") - $(call echo_help, " * - RP2_101") - $(call echo_help, " * - RP2_103 (LR-FHSS support)") + $(call echo_help, " * - ALL (to build all possible regions according to the radio target) ") $(call echo_help, " * CRYPTO=xxx : choose which crypto should be compiled (default: SOFT)") $(call echo_help, " * - SOFT") $(call echo_help, " * - LR11XX (only for lr1110 and lr1120 targets)") $(call echo_help, " * - LR11XX_WITH_CREDENTIALS (only for lr1110 and lr1120 targets)") $(call echo_help, " * MODEM_TRACE=yes/no : choose to enable or disable modem trace print (default: yes)") - $(call echo_help, " * USE_GNSS=yes/no : only for lr1110 and lr1120 targets: choose to enable or disable use of gnss (default: yes)") - $(call echo_help, " * MIDDLEWARE=yes/no : build target for middleware advanced access (default: no)") + $(call echo_help, " * LBM_CLASS_B=yes/no : choose to build class B code (default: no)") + $(call echo_help, " * LBM_CLASS_C=yes/no : choose to build class C code (default: no)") + $(call echo_help, " * LBM_MULTICAST=yes/no : choose to build multicast specifc code (default: no)") + $(call echo_help, " * LBM_ALC_SYNC=yes/no : choose to build ALCSync service (default: no)") + $(call echo_help, " * LBM_ALC_SYNC_VERSION=x : choose which version of ALCSync package should be compiled (default: 1)") + $(call echo_help, " * LBM_FUOTA=yes/no : choose to build LoRaWAN Packages for FUOTA (default: no)") + $(call echo_help, " * LBM_FUOTA_VERSION=x : choose which version of FUOTA packageq should be compiled (default: 1)") + $(call echo_help, " * LBM_FUOTA_ENABLE_FMP=yes/no : in case FUOTA is enabled choose to build LoRaWAN Firmware Management Package (default: no)") + $(call echo_help, " * LBM_FUOTA_ENABLE_MPA=yes/no : in case FUOTA is enabled choose to build LoRaWAN Multi-Package Access Package (default: no)") + $(call echo_help, " * LBM_CSMA=yes/no : choose to build CSMA Feature (default: yes)") + $(call echo_help, " * USE_CSMA_BY_DEFAULT=yes/no : in case CSMA is built choose to enable CSMA Feature at start (default: no)") + $(call echo_help, "") $(call echo_help_b, "-------------------- Optional makefile parameters --------------------------") - $(call echo_help, " * DEBUG=yes/no : Change opt to O0 and add -g* options for debugging (default: no)") + $(call echo_help, " * DEBUG=yes/no : -g options for debugging (default: no)") + $(call echo_help, " * OPT=xxx : Choose compilation optimization (default: -Os)") $(call echo_help, " * MULTITHREAD=yes/no : Multithreaded build (default: yes)") $(call echo_help, " * VERBOSE=yes/no : Increase build verbosity (default: no)") $(call echo_help, " * SIZE=yes/no : Display size for all objects (default: no)") + $(call echo_help, "") + $(call echo_help_b, "---------------------------------------------------------------------------") + $(call echo_help_b, "All options can also be directly updated in makefiles/options.mk file") @@ -141,14 +91,20 @@ ifeq ($(RADIO),sx128x) -include makefiles/sx128x.mk endif +ifeq ($(RADIO),sx1272) +-include makefiles/sx127x.mk +endif + +ifeq ($(RADIO),sx1276) +-include makefiles/sx127x.mk +endif + #----------------------------------------------------------------------------- -include makefiles/common.mk .PHONY: clean_all all help -.PHONY: FORCE -FORCE: -all: basic_modem_sx128x basic_modem_lr1110 basic_modem_lr1120 basic_modem_sx1261 basic_modem_sx1262 +all: basic_modem_sx128x basic_modem_lr1110 basic_modem_lr1120 basic_modem_sx1261 basic_modem_sx1262 basic_modem_sx1272 basic_modem_sx1276 #----------------------------------------------------------------------------- # Clean @@ -174,9 +130,43 @@ clean_sx1262: clean_sx1268: $(MAKE) clean_target RADIO=sx1268 +clean_sx1272: + $(MAKE) clean_target RADIO=sx1272 + +clean_sx1276: + $(MAKE) clean_target RADIO=sx1276 + +clean: + $(MAKE) clean_target + #----------------------------------------------------------------------------- # Compilation #----------------------------------------------------------------------------- +basic_modem: +ifeq ($(RADIO),nc) + $(call echo_error,"No radio selected! Please specified the target radio using RADIO=radio_name option") +else +ifneq ($(CRYPTO),SOFT) +ifneq ($(NB_OF_STACK),1) + $(call echo_error, "----------------------------------------------------------") + $(call echo_error, "More than one stack compiled: only soft crypto can be used") + $(call echo_error, "Please use CRYPTO=SOFT option") + $(call echo_error, "----------------------------------------------------------") + exit 1 +endif +ifneq ($(RADIO),lr1110) +ifneq ($(RADIO),lr1120) + $(call echo_error, "------------------------------------------------------------") + $(call echo_error, "sx126x sx127x and sx128x radio tagets: only soft crypto can be used") + $(call echo_error, "Please use CRYPTO=SOFT option") + $(call echo_error, "------------------------------------------------------------") + exit 1 +endif +endif +endif + $(MAKE) basic_modem_build +endif + basic_modem_sx128x: $(MAKE) basic_modem RADIO=sx128x $(MTHREAD_FLAG) @@ -194,3 +184,9 @@ basic_modem_sx1262: basic_modem_sx1268: $(MAKE) basic_modem RADIO=sx1268 $(MTHREAD_FLAG) + +basic_modem_sx1272: + $(MAKE) basic_modem RADIO=sx1272 $(MTHREAD_FLAG) + +basic_modem_sx1276: + $(MAKE) basic_modem RADIO=sx1276 $(MTHREAD_FLAG) diff --git a/README.md b/README.md index 9f8ae55..434a113 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,314 @@ -# LoRa Basics Modem +# LoRa Basic Modem -## LoRaWAN parameters +**LoRa Basic Modem** proposes an implementation of the [TS001-LoRaWAN L2 1.0.4](https://resources.lora-alliance.org/technical-specifications/ts001-1-0-4-lorawan-l2-1-0-4-specification) and [Regional Parameters RP2-1.0.3](https://resources.lora-alliance.org/technical-specifications/rp2-1-0-3-lorawan-regional-parameters) specifications. -### LoRaWAN version +The proposed stack implementation: -The LoRaWAN version that is currently implemented in LoRa Basics Modem is v1.0.4. +- Supports Class A operation +- Supports Class B operation (with up to 4 multicast sessions) +- Supports Class C operation (with up to 4 multicast sessions) +- Supports following regions: -### LoRaWAN region + - AS_923 (AS923-1, AS923-2, AS923-3, AS923-4) + - AU_915 + - CN_470 + - CN_470_RP_1_0 + - EU_868 + - IN_865 + - KR_920 + - RU_864 + - US_915 -LoRa Basics Modem supports the following LoRaWAN regions: + **Note**: In addition the proposed implementation also provides a 2.4 GHz global ISM band (WW2G4) region support. -* AS_923 (AS923-1, AS923-2, AS923-3) -* AU_915 -* CN_470 -* CN_470_RP_1_0 -* EU_868 -* IN_865 -* KR_920 -* RU_864 -* US_915 +- Supports Semtech radios: + - LR1110 with firmware 0x0308. + - LR1120 with firmware 0x0102 + - SX1261 + - SX1262 + - SX1280 + - SX1281 + - SX1272 (experimental) + - SX1276 (experimental) -LoRa Basics Modem supports an emulation of LoRaWAN protocol for the 2.4GHz global ISM band (WW2G4) +- Provides the support for software emulated and hardware secure-elements. + Such secure-elements provide all required cryptographic operations necessary to operate the LoRaWAN protocol. +- Provides an MCU abstraction layer to ease the porting process. + The following lists the required MCU hardware resources: + - 1 HW timer + - 1 SPI interface + - 40KB of FLASH memory minimum allowing to run an end-device in Class A mode for a single region and each additional region adds 1.5KB. + - 6KB of RAM memory minimum. + - 36B of non-volatile memory to store LoRaWAN activation session context. + Up to 512B of non-volatile memory if software emulated secure-element is used. + - 1 Watchdog (Optional) +- Supports OTAA activation by default +- ABP activation is implemented only for debugging purposes. + **Note:** No stack context is saved in non-volatile memory. Therefore, it is strongly discouraged to use this mode for any other purpose than debugging. +- Bare Metal or RTOS based projects porting options. -### LoRaWAN regional parameters +## Examples -Default regional parameters version supported by LoRa Basics Modem is rp2-1.0.1. It is possible to switch to rp2-1.0.3 at compile time. +Under `utilities` folder, one will find a few examples on how to use the LoRa Basics Modem stack. -### LoRaWAN class +- Hardware Modem (Implements a hardware modem controlled by a serial interface) +- Exti (joins the network and then sends uplinks each time the button is pushed) +- Porting tests (Allows to verify if the project porting process is correct) -LoRa Basics Modem supports the following LoRaWAN classes: +The examples are targeted for the NucleoL476 kit featuring an STM32L476 micro-controller. +For further details please refer to `utilities` directory [README](utilities/README.md) file. -* Class A -* Class B (with up to 4 multicast sessions) -* Class C (with up to 4 multicast sessions) +To build the Exti example targeting the LR1110 Semtech radio the following should be executed on the command line: -## LoRa Basics Modem services +```bash +cd utilities +make full_lr1110 MODEM_APP=EXAMPLE_EXTI +``` -LoRa Basics Modem supports the following services: +## SX1272/SX1276 (experimental - read disclaimer note at the bottom) -* Large files upload -* ROSE Streaming -* Application-Layer Clock synchronization -* Almanac Update +This version of Lora Basics Modem provides only an experimental support of sx1272 and sx1276 radios. +The driver provided is not yet fully aligned with the required architecture of LBM V4 because it performs radio access in an interrupt context (this is no longer done on other radios). +It also requires the use of an additional low-power timer to handle some reception timeout, especially for gfsk reception. +In provided example on STM32L4 mcu (under utilities folder), the LPTIM2 is used with the disadvantage of preventing the use of STOP2 low power mode. -## LoRa Basics Modem API +## Build process -The Application Programming Interface of LoRa Basics Modem is defined in `smtc_modem_api/smtc_modem_api.h` header file. +The build process using makefile allows flexibility on the choice of different compile time options. +To know all the available make process options run: -## LoRa Basics Modem engine +```bash +make help +``` -LoRa Basics Modem has to be initialized first by calling `smtc_modem_init()`. Then, calling periodically `smtc_modem_run_engine()` is required to make the state machine move forward. +The build process options can be provided either using the command line or by editing [options.mk](makefiles/options.mk) -These functions can be found in `smtc_modem_api/smtc_modem_utilities.h` +## User application -## LoRa Basics Modem HAL +The stack must be first initialized by calling the `smtc_modem_init()` API. +Once initialized the `smtc_modem_run_engine()` API has to be periodically called to make the stack internal state machine move forward. +The `smtc_modem_run_engine()` API returned value is an indication of when the next task will be handled. +Each time a stack related interruption happens, the `smtc_modem_run_engine()` API shall be called to process it and take the required actions. +Special care must take place before entering a low power wait mode. The application developer must ensure that no stack pending actions exist by calling `smtc_modem_is_irq_flag_pending()` API. -The Hardware Abstraction Layer of LoRa Basics Modem is defined in the `smtc_modem_hal/smtc_modem_hal.h` header file. Porting LoRa Basics Modem to a new architecture requires one to implement the functions described by the prototypes in it. +These API definitions can be found in [smtc_modem_utilities.h](smtc_modem_api/smtc_modem_utilities.h) -## Transceiver +## Modem API -LoRa Basics Modem supports the following transceivers: +The Application Programming Interface is defined in [smtc_modem_api.h](smtc_modem_api/smtc_modem_api.h) file. -* LR1110 with firmware 0x0307. -* LR1120 with firmware 0x0101 -* SX1261 -* SX1262 -* SX1280 -* SX1281 +## Modem HAL -## Known Limitations +The Hardware Abstraction Layer is defined in [smtc_modem_hal.h](smtc_modem_hal/smtc_modem_hal.h) file. -* [LFU] In case LoRa Basics Modem is acting in US915 region with datarate DR0, files smaller than 13 bytes are not properly sent and cannot be reconstructed on LoRa Cloud side -* [charge] Values returned by `smtc_modem_get_charge()` for regions CN470 and CN470_RP1 are not accurate -* [charge] Values returned by `smtc_modem_get_charge()` for the LR-FHSS based datarate are not accurate -* [multicast_class_b] Starting a class B multicast session with frequency equal to 0 will always return SMTC_MODEM_RC_INVALID even in the case lbm is acting in regions with frequency hopping beacon -* [LBT] In case LBT is used (by user's choice or imposed by regional parameters) and if TCXO start time is greater than default RP_MARGIN_DELAY value (8ms), uplinks will never be sent. - Workaround: At makefile level define RP_MARGIN_DELAY value to `TCXO start time + 3ms`. The consequence is that before rx1 and rx2 windows opening the mcu will be running and waiting during extra time. +Porting LoRa Basics Modem to a new architecture/platform requires to implement the functions defined under [smtc_modem_hal.h](smtc_modem_hal/smtc_modem_hal.h) file. -## Disclaimer +## Radio BSP (Board Specific Package) and HAL + +Semtech radio drivers and Radio Abstraction Layer (RAL) architecture requires the user to implement the radio HAL and BSP functions. + +Radio BSP functions are defined for each transceiver and can be found in [smtc_modem_core/smtc_ral/src](smtc_modem_core/smtc_ral/src) folder. (Files named `ral_xxx_bsp.h`). + +Radio HAL functions are defined for each transceiver in [smtc_modem_core/radio_drivers](smtc_modem_core/radio_drivers) folder. + +## Provided Features + +### LoRaWAN Certification Protocol handling + +The LoRaWAN Certification package is used when going through the LoRaWAN certification process. + +1. To use it, you have to set the LoRaWAN keys: + +```c +smtc_modem_return_code_t smtc_modem_set_deveui( uint8_t stack_id, const uint8_t deveui[SMTC_MODEM_EUI_LENGTH] ); +smtc_modem_return_code_t smtc_modem_set_nwkkey( uint8_t stack_id, const uint8_t nwkkey[SMTC_MODEM_KEY_LENGTH] ); +smtc_modem_return_code_t smtc_modem_set_joineui( uint8_t stack_id, const uint8_t joineui[SMTC_MODEM_EUI_LENGTH] ); +``` + +2. Connect to the network: + +```c +smtc_modem_return_code_t smtc_modem_join_network( uint8_t stack_id ); +``` + +3. Launch the certification service: This command save in nvm a flag to allow the certification to reset the mcu when required and continue the certification process at boot. + +```c +smtc_modem_return_code_t smtc_modem_set_certification_mode( uint8_t stack_id, bool enable ); +``` + +### Application Layer Clock Synchronization (ALCSync) + +This application may be used when a Network Server does not support the DeviveTimeReq commands. +When started the application will trig a time synchronization to the application server every `periodicity_s` configured by the ALCSync server package. +The default value is 36h. +Each time a valid time sync answer is received by the modem, it will generate an event of type `SMTC_MODEM_EVENT_ALCSYNC_TIME` + +#### Makefile option + +To support this feature in the modem the file `options.mk` must contains the LBM_ALC_SYNC flag to yes: `LBM_ALC_SYNC ?= yes` + +#### C Example + +- Start the service: + +```c +smtc_modem_return_code_t smtc_modem_start_alcsync_service( uint8_t stack_id ); +``` + +- Stop the service: + +```c +smtc_modem_return_code_t smtc_modem_stop_alcsync_service( uint8_t stack_id ); +``` + +- Get GPS epoch time, number of seconds elapsed since GPS epoch (00:00:00, Sunday 6th of January 1980). + +```c +smtc_modem_return_code_t smtc_modem_get_alcsync_time( uint8_t stack_id, uint32_t* gps_time_s ); +``` + +- Trigger a single uplink requesting time on Application Layer Clock Synchronization (ALCSync) service, the service must be start first + +```c +smtc_modem_return_code_t smtc_modem_trigger_alcsync_request( uint8_t stack_id ); +``` + +### Class B Support in LoRa Basic Modem + +LoRa Basic Modem does not support Class B by default. To use this feature, it must be activated during project compilation. + +#### Activating Class B Support + +To activate Class B support, add the Class B service to the compilation by setting the flag `LBM_CLASS_B` to `yes` in the `options.mk` file. This will enable the Class B functionality in the LoRa Basic Modem. + +#### Starting Class B + +Class B starts after a successful join, so it is recommended to start Class B after receiving the `"SMTC_MODEM_EVENT_JOINED"` event. To start Class B, call the following function available in the LoRa Basic Modem API: `smtc_modem_set_class` with the parameter `SMTC_MODEM_CLASS_B`. + +LoRa Basic Modem autonomously handles all the prerequisites inherent in Class B in LoRaWAN (ping slot info request, time search, acquisition of the first beacon, sending an uplink to signal the network about the activation of Class B). Once Class B is active, the user is informed via the `"SMTC_MODEM_EVENT_CLASS_B_STATUS"` event with the state `"SMTC_MODEM_EVENT_CLASS_B_READY"`. + +To change the ping slot periodicity (default value is 7, which means a ping slot every 128 seconds), call the function `smtc_modem_class_b_set_ping_slot_periodicity` before calling `smtc_modem_set_class`. + +#### Special Cases + +- If your network server does not support time synchronization via a network command, you must activate the clk sync package to set the GPS time before starting Class B (refer to the clk sync package chapter in this readme). +- In case you are no longer connected to the LoRaWAN network, Class B will automatically stop after 2 hours without receiving a beacon. The user will then receive the `"SMTC_MODEM_EVENT_CLASS_B_STATUS"` event with the state `"SMTC_MODEM_EVENT_CLASS_B_NOT_READY"`. + +## FUOTA (experimental - read disclaimer note at the bottom) + +The FUOTA service available in LoRa Basic Modem corresponds to the firmware update service described in the standard defined by the LoRa Alliance. Among the following 5 Applicative Packages described by the LoRaWan standard: + +- +- +- +- +- + +The proposed implementation supports both Class B or Class C modes and supports up to 4 simultaneous multicast sessions. -This software has been extensively tested when targeting LR1110 / LR1120 / SX1261 / SX1262 / SX1280 / SX1281 for LoRaWAN regions mentioned in [this paragraph](#lorawan-region). For all other combinations of features this software shall be considered an Engineering Sample. +### FUOTA Activation -Modem trace prints can only be used for debug purpose and shall be deactivated for production release. +FUOTA is not supported in the default mode of LoRa Basic Modem, this functionality must be activated during the project compilation. -### Disclaimer for Engineering Samples +To activate FUOTA: add the FUOTA service to the compilation by setting the `LBM_FUOTA` flag to "yes" , `LBM_FUOTA_VERSION` flag to "1" in the `options.mk` file. + +You will also need to provide the following fields at compilation: + +- `FUOTA_MAXIMUM_NB_OF_FRAGMENTS` +- `FUOTA_MAXIMUM_SIZE_OF_FRAGMENTS` +- `FUOTA_MAXIMUM_FRAG_REDUNDANCY` + +Class B, Class C, multicast, and the previously mentioned packages are automatically built by activating this compilation flag. + +#### Prerequisites before starting a FUOTA session + +The user must implement the following two functions for the FUOTA service to be functional: + +- `smtc_modem_hal_context_store` for the `CONTEXT_FUOTA` parameter +- `smtc_modem_hal_context_restore` function + +These two functions allow the received firmware update file to be stored in non-volatile memory during the FUOTA session. + +#### Starting a Class C FUOTA session + +There is nothing specific to do to start a multicast session in class C, it will be done transparently depending on the requests of the fuota server. + +In the particular case where your Network server does not support the network time cmd, you will also need to activate the clk sync service (refer to the specific chapter of this service). + +#### End of Class C FUOTA session + +The implemented service only takes care of the transfer/reconstruction of the file and its storage in non-volatile memory. Everything related to the implementation of the new firmware itself (reboot, dual bank, etc.) is not implemented in this service and is left to the implementation of the end user. + +Once the session is completed, the user receives an event: `SMTC_MODEM_EVENT_LORAWAN_FUOTA_DONE` with the status "true" if the transfer is completed without error. + +#### Remark + +The fragmentation session for FUOTA may be terminated, but not the Class C multicast session. The latter remains active until the session timeout. Of course, the user can end the session themselves when they receive the SMTC_MODEM_EVENT_LORAWAN_FUOTA_DONE event. They can also leave the multicast session active until the session timeout. At this point, they will be notified by the event `"SMTC_MODEM_EVENT_NO_MORE_MULTICAST_SESSION_CLASS_C,"` and they will receive an event `"SMTC_MODEM_EVENT_NEW_MULTICAST_SESSION_CLASS_C"` at the start of the session, with the associated group_id present in the status of this event. + +#### Special case + +when all Class C multicast sessions are completed, the stack remains in Class C Unicast. It is therefore up to the user to switch back to Class A if they wish (on the event `"SMTC_MODEM_EVENT_NO_MORE_MULTICAST_SESSION_CLASS_C"`). + +#### To start a Class B multicast FUOTA session + + the mechanism is very similar to that described for Class C, with the exception that Class B must be launched beforehand. Please refer to the relevant chapter for information on starting Class B. Otherwise, the general principles are the same as for Class C. In normal operation, the user should therefore receive the following events successively: + +- `SMTC_MODEM_EVENT_NEW_MULTICAST_SESSION_CLASS_B` +- `SMTC_MODEM_EVENT_LORAWAN_FUOTA_DONE` +- `SMTC_MODEM_EVENT_NO_MORE_MULTICAST_SESSION_CLASS_B` + +#### Fuota package V2 + +This library also offers the implementation of LoRaWAN Alliance's V2 Fuota packages. This implementation is provided on an experimental basis and will primarily serve as a testing framework for NS (Network Server) implementations of the Fuota version 2 packages. This implementation is currently undergoing validation against the certification test developed by the alliance. For all these reasons, we emphasize that this version of Fuota V2 should not be used on a production device. + +To activate FUOTA: add the FUOTA service to the compilation by setting the `LBM_FUOTA` flag to "yes" , `LBM_FUOTA_VERSION` flag to "2" in the `options.mk` file. +ou will also need to provide the following fields at compilation: + +- `FUOTA_MAXIMUM_NB_OF_FRAGMENTS` +- `FUOTA_MAXIMUM_SIZE_OF_FRAGMENTS` +- `FUOTA_MAXIMUM_FRAG_REDUNDANCY` + +Class B, Class C, multicast, and the previously mentioned packages are automatically built by activating this compilation flag. + +## CSMA for LoRaWAN (experimental - read disclaimer note at the bottom) + +The modem provides an experimental implementation of CSMA feature to avoid LoRa packet collision. + +The compilation option `LBM_CSMA=yes` must set in Makefile to be build. + +The compilation option `USE_CSMA_BY_DEFAULT=yes` enable the CSMA by default at modem startup. + +The implementation will not allow to enable the CSMA when the LBT is mandatory by the current region. + +1. To use it, you can enable or disable the CSMA feature with : + +```c +smtc_modem_return_code_t smtc_modem_csma_set_state( uint8_t stack_id, bool enable ); +``` + +2. Configuration + +The CSMA could be configured to be optimized to your use cases + +```c +smtc_modem_return_code_t smtc_modem_csma_set_parameters( uint8_t stack_id, uint8_t nb_bo_max, bool bo_enabled, uint8_t max_ch_change ); +``` + +**Note**: This feature is only supported on lr11xx and sx126x radios, activation of this feature on other targets can lead to unwanted behavior or modem panic + +## LoRa Basic Modem known limitations + +- [test-mode-cw] Using cw test mode will end up with a radio planner failsafe and a reset after 2 minutes +- [charge] Values returned by smtc_modem_get_charge() for regions CN470 and CN470_RP1 are not accurate +- [charge] Values returned by smtc_modem_get_charge() for the LR-FHSS based datarates are not accurate +- [charge] Values returned by smtc_modem_get_charge() for sx127x radios are not accurate +- [sx127x] On sx127x radios test mode CW does not generate any continuous wave signal + +## Disclaimer -Information relating to this product and the application or design described herein is believed to be reliable, however such information is provided as a guide only and Semtech assumes no liability for any errors related to the product, documentation, or for the application or design described herein. Semtech reserves the right to make changes to the product or this document at any time without notice. +**EXAMPLE ONLY** +This code is being released by Semtech as a feature branch including experimental features. +This code has not been subjected to the same validation procedure applied to Semtech’s master branch releases. +This code is released under the Clear BSD license LICENSE.txt. +Consistent with the terms of the Clear BSD license, it is not warrantied in anyway. diff --git a/lora_basics_modem_version.h b/lora_basics_modem_version.h index 7fd50ff..03f5cf3 100644 --- a/lora_basics_modem_version.h +++ b/lora_basics_modem_version.h @@ -55,9 +55,9 @@ extern "C" { * ----------------------------------------------------------------------------- * --- PUBLIC TYPES ------------------------------------------------------------ */ -#define LORA_BASICS_MODEM_FW_VERSION_MAJOR 3 -#define LORA_BASICS_MODEM_FW_VERSION_MINOR 2 -#define LORA_BASICS_MODEM_FW_VERSION_PATCH 4 +#define LORA_BASICS_MODEM_FW_VERSION_MAJOR 4 +#define LORA_BASICS_MODEM_FW_VERSION_MINOR 1 +#define LORA_BASICS_MODEM_FW_VERSION_PATCH 0 /* * ----------------------------------------------------------------------------- diff --git a/makefiles/common.mk b/makefiles/common.mk index 15bb2c5..c41dca9 100644 --- a/makefiles/common.mk +++ b/makefiles/common.mk @@ -2,6 +2,8 @@ # Common rules and definitions ############################################################################## +-include makefiles/options.mk + #----------------------------------------------------------------------------- # Build system binaries #----------------------------------------------------------------------------- @@ -15,7 +17,6 @@ CPP = $(GCC_PATH)/$(PREFIX)g++ AS = $(GCC_PATH)/$(PREFIX)gcc -x assembler-with-cpp CP = $(GCC_PATH)/$(PREFIX)objcopy SZ = $(GCC_PATH)/$(PREFIX)size -GCOV = $(GCC_PATH)/$(PREFIX)gcov else AR = $(PREFIX)ar CC = $(PREFIX)gcc @@ -23,11 +24,9 @@ CPP = $(PREFIX)g++ AS = $(PREFIX)g++ -x assembler-with-cpp CP = $(PREFIX)objcopy SZ = $(PREFIX)size -GCOV = $(PREFIX)gcov endif HEX = $(CP) -O ihex BIN = $(CP) -O binary -S -GCOVR = gcovr #----------------------------------------------------------------------------- @@ -64,31 +63,7 @@ endif #----------------------------------------------------------------------------- # Update target name wrt. compilation options #----------------------------------------------------------------------------- -ifdef REGION -TARGET_MODEM := $(TARGET_MODEM)_$(REGION) -endif - -ifeq ($(COVERAGE), RADIO) -BUILD_DIR_MODEM = $(BUILD_ROOT)/$(TARGET)/cov_radio -TARGET_MODEM := $(TARGET_MODEM)_cov_radio -endif -ifeq ($(COVERAGE), MODEM) -BUILD_DIR_MODEM = $(BUILD_ROOT)/$(TARGET)/cov_modem -TARGET_MODEM := $(TARGET_MODEM)_cov_modem -endif - -ifeq ($(RADIO),lr1110) -ifeq ($(CRYPTO),LR11XX) -TARGET_MODEM := $(TARGET_MODEM)_lr11xx_crypto -BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto -endif # LR11XX -ifeq ($(CRYPTO),LR11XX_WITH_CREDENTIALS) -TARGET_MODEM := $(TARGET_MODEM)_lr11xx_crypto_with_cred -BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto_with_cred -endif # LR11XX_WITH_CREDENTIALS -endif # lr1110 -ifeq ($(RADIO),lr1120) ifeq ($(CRYPTO),LR11XX) TARGET_MODEM := $(TARGET_MODEM)_lr11xx_crypto BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto @@ -97,12 +72,6 @@ ifeq ($(CRYPTO),LR11XX_WITH_CREDENTIALS) TARGET_MODEM := $(TARGET_MODEM)_lr11xx_crypto_with_cred BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_lr11xx_crypto_with_cred endif # LR11XX_WITH_CREDENTIALS -endif # lr1120 - -ifeq ($(MIDDLEWARE),yes) -TARGET_MODEM := $(TARGET_MODEM)_middleware -BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)_middleware -endif ifeq ($(MODEM_TRACE), yes) TARGET_MODEM := $(TARGET_MODEM)_trace @@ -112,60 +81,11 @@ TARGET_MODEM := $(TARGET_MODEM)_notrace BUILD_DIR_MODEM := $(BUILD_DIR_MODEM)/notrace endif -# Clean up commas -COMMA := , -TARGET_MODEM := $(subst $(COMMA),_,$(TARGET_MODEM)) - -#----------------------------------------------------------------------------- -# Coverage -#----------------------------------------------------------------------------- -COVERAGE_OUTPUT_DIR = $(BUILD_DIR_MODEM)/gcov - -COVERAGE_ARCHIVE = $(BUILD_ROOT)/$(TARGET_MODEM)_gcov.tar.gz - -#COVERAGE_PREFIX_STRIP = $(words $(subst /, ,$(realpath $(shell pwd)))) -COVERAGE_PREFIX_STRIP = $(words $(subst /, ,$(realpath $(COVERAGE_OUTPUT_DIR)))) - -# Compilation flags needed for coverage support -COVERAGE_CFLAGS = -fprofile-arcs -ftest-coverage - -# When compiling with coverage we should disable optimizations -ifneq ($(COVERAGE),no) -#OPT = -O0 -g -DEBUG = yes -COVERAGE_LDFLAGS = -fprofile-arcs -LIBS += -lgcov -else -#OPT = -Os -g -COVERAGE_LDFLAGS = -endif - #----------------------------------------------------------------------------- # Debug #----------------------------------------------------------------------------- ifeq ($(DEBUG),yes) -OPT = -O0 -ggdb3 -gdwarf -else -OPT = -Os -endif - -#----------------------------------------------------------------------------- -# Dump memory usage to a log file -#----------------------------------------------------------------------------- -ifeq ($(LOG_MEM), yes) -MEMLOG_FILE := $(BUILD_DIR_MODEM)/mem_usage.log -MEMLOG = | tee $(MEMLOG_FILE) -else -MEMLOG = -endif - -#----------------------------------------------------------------------------- -# Bypass LoRaWAN network and use testbench to uplink/downlink frames -#----------------------------------------------------------------------------- -ifeq ($(BYPASS),yes) -BYPASS_FLAGS := '-DLORAWAN_BYPASS_ENABLED' -else -BYPASS_FLAGS := +OPT += -g endif #----------------------------------------------------------------------------- @@ -178,11 +98,9 @@ WFLAG += \ -Wno-unused-parameter \ -Wpedantic \ -fomit-frame-pointer \ - -mabi=aapcs \ -fno-unroll-loops \ -ffast-math \ - -ftree-vectorize \ - $(BYPASS_FLAGS) + -ftree-vectorize # Allow linker to not link unused functions WFLAG += \ @@ -205,11 +123,13 @@ AS_DEFS = # Assembly flags ASFLAGS += -fno-builtin $(MCU) $(AS_DEFS) $(AS_INCLUDES) $(OPT) $(WFLAG) + COMMON_C_DEFS += \ -DGIT_VERSION=\"$(GIT_VERSION)\" \ -DGIT_COMMIT=\"$(GIT_COMMIT)\" \ -DGIT_DATE=\"$(GIT_DATE)\" \ - -DBUILD_DATE=\"$(BUILD_DATE)\" + -DBUILD_DATE=\"$(BUILD_DATE)\"\ + -DNUMBER_OF_STACKS=$(NB_OF_STACK) ifeq ($(MODEM_TRACE),yes) COMMON_C_DEFS += \ @@ -234,46 +154,71 @@ COMMON_C_DEFS += \ -DPERF_TEST_ENABLED endif -ifeq ($(MIDDLEWARE),yes) +ifeq ($(LBM_CLASS_B),yes) COMMON_C_DEFS += \ - -DTASK_EXTENDED_1 \ - -DTASK_EXTENDED_2 \ - -DENABLE_FAST_CLOCK_SYNC + -DADD_CLASS_B endif - -ifeq ($(ADD_D2D),yes) +ifeq ($(LBM_CLASS_C),yes) COMMON_C_DEFS += \ - -DSMTC_D2D + -DADD_CLASS_C endif -ifeq ($(ADD_MULTICAST),yes) +ifeq ($(LBM_MULTICAST),yes) COMMON_C_DEFS += \ -DSMTC_MULTICAST endif -ifeq ($(ADD_SMTC_STREAM),yes) +ifeq ($(LBM_FUOTA),yes) COMMON_C_DEFS += \ - -DADD_SMTC_STREAM + -DADD_FUOTA \ + -DADD_CLASS_B \ + -DADD_CLASS_C \ + -DADD_SMTC_ALC_SYNC \ + -DSMTC_MULTICAST + ifneq ($(FUOTA_MAXIMUM_NB_OF_FRAGMENTS),nc) + COMMON_C_DEFS += \ + -DFRAG_MAX_NB=$(FUOTA_MAXIMUM_NB_OF_FRAGMENTS) + endif + ifneq ($(FUOTA_MAXIMUM_SIZE_OF_FRAGMENTS),nc) + COMMON_C_DEFS += \ + -DFRAG_MAX_SIZE=$(FUOTA_MAXIMUM_SIZE_OF_FRAGMENTS) + endif + ifneq ($(FUOTA_MAXIMUM_FRAG_REDUNDANCY),nc) + COMMON_C_DEFS += \ + -DFRAG_MAX_REDUNDANCY=$(FUOTA_MAXIMUM_FRAG_REDUNDANCY) + endif + ifeq ($(LBM_FUOTA_ENABLE_FMP),yes) + COMMON_C_DEFS += \ + -DENABLE_FUOTA_FMP + endif + ifeq ($(LBM_FUOTA_ENABLE_MPA),yes) + COMMON_C_DEFS += \ + -DENABLE_FUOTA_MPA + endif +else + ifeq ($(LBM_ALC_SYNC),yes) + COMMON_C_DEFS += \ + -DADD_SMTC_ALC_SYNC + endif endif -ifeq ($(ADD_SMTC_FILE_UPLOAD),yes) +ifeq ($(ALLOW_CSMA_BUILD),yes) +ifeq ($(LBM_CSMA),yes) COMMON_C_DEFS += \ - -DADD_SMTC_FILE_UPLOAD -endif - -ifeq ($(ADD_SMTC_ALC_SYNC),yes) + -DADD_CSMA +ifeq ($(USE_CSMA_BY_DEFAULT),yes) COMMON_C_DEFS += \ - -DADD_SMTC_ALC_SYNC + -DENABLE_CSMA_BY_DEFAULT +endif +endif endif - -CFLAGS += -fno-builtin $(MCU_FLAGS) $(BOARD_C_DEFS) $(COMMON_C_DEFS) $(MODEM_C_DEFS) $(BOARD_C_INCLUDES) $(COMMON_C_INCLUDES) $(MODEM_C_INCLUDES) $(OPT) $(WFLAG) -MMD -MP -MF"$(@:%.o=%.d)" +CFLAGS += $(BOARD_C_DEFS) $(COMMON_C_DEFS) $(MODEM_C_DEFS) +CFLAGS += $(BOARD_C_INCLUDES) $(COMMON_C_INCLUDES) $(MODEM_C_INCLUDES) +CFLAGS += -fno-builtin $(MCU_FLAGS) $(EXTRAFLAGS) $(OPT) $(WFLAG) -MMD -MP -MF"$(@:%.o=%.d)" CFLAGS += -falign-functions=4 CFLAGS += -std=c17 -ifneq ($(COVERAGE),no) -CFLAGS += -DCOVERAGE_ENABLED -endif #----------------------------------------------------------------------------- # Link flags #----------------------------------------------------------------------------- @@ -285,37 +230,17 @@ LIBS += -lstdc++ -lsupc++ -lm -lc -lnosys #----------------------------------------------------------------------------- SMTC_MODEM_CORE_C_SOURCES += \ smtc_modem_core/lorawan_api/lorawan_api.c \ - smtc_modem_core/device_management/dm_downlink.c \ - smtc_modem_core/device_management/modem_context.c\ - smtc_modem_core/modem_core/smtc_modem.c\ - smtc_modem_core/modem_core/smtc_modem_test.c\ - smtc_modem_core/modem_services/fifo_ctrl.c\ - smtc_modem_core/modem_services/modem_utilities.c \ - smtc_modem_core/modem_services/smtc_modem_services_hal.c\ - smtc_modem_core/modem_services/lorawan_certification.c\ - smtc_modem_core/modem_supervisor/modem_supervisor.c - -ifeq ($(ADD_SMTC_ALC_SYNC),yes) -SMTC_MODEM_CORE_C_SOURCES += \ - smtc_modem_core/modem_services/smtc_clock_sync.c -endif - -ifeq ($(ADD_SMTC_STREAM),yes) -SMTC_MODEM_SERVICES_C_SOURCES += \ - smtc_modem_core/smtc_modem_services/src/stream/stream.c\ - smtc_modem_core/smtc_modem_services/src/stream/rose.c -endif - -ifeq ($(ADD_SMTC_FILE_UPLOAD),yes) -SMTC_MODEM_SERVICES_C_SOURCES += \ - smtc_modem_core/smtc_modem_services/src/file_upload/file_upload.c -endif - -ifeq ($(ADD_SMTC_ALC_SYNC),yes) -SMTC_MODEM_SERVICES_C_SOURCES += \ - smtc_modem_core/smtc_modem_services/src/alc_sync/alc_sync.c -endif - + smtc_modem_core/smtc_modem.c\ + smtc_modem_core/smtc_modem_test.c\ + smtc_modem_core/modem_utilities/modem_event_utilities.c\ + smtc_modem_core/modem_utilities/fifo_ctrl.c\ + smtc_modem_core/modem_utilities/modem_core.c \ + smtc_modem_core/modem_supervisor/modem_supervisor_light.c\ + smtc_modem_core/lorawan_packages/lorawan_certification.c\ + smtc_modem_core/lorawan_manager/lorawan_join_management.c\ + smtc_modem_core/lorawan_manager/lorawan_send_management.c\ + smtc_modem_core/lorawan_manager/lorawan_cid_request_management.c\ + smtc_modem_core/lorawan_manager/lorawan_dwn_ack_management.c LR1MAC_C_SOURCES += \ smtc_modem_core/lr1mac/src/lr1_stack_mac_layer.c\ @@ -323,51 +248,103 @@ LR1MAC_C_SOURCES += \ smtc_modem_core/lr1mac/src/lr1mac_utilities.c\ smtc_modem_core/lr1mac/src/smtc_real/src/smtc_real.c\ smtc_modem_core/lr1mac/src/services/smtc_duty_cycle.c\ - smtc_modem_core/lr1mac/src/services/smtc_lbt.c\ - smtc_modem_core/lr1mac/src/lr1mac_class_c/lr1mac_class_c.c\ - smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_beacon_sniff.c\ - smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_ping_slot.c + smtc_modem_core/lr1mac/src/services/smtc_lbt.c + -ifeq ($(ADD_D2D),yes) +ifeq ($(LBM_CLASS_C),yes) LR1MAC_C_SOURCES += \ - smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_d2d.c + smtc_modem_core/lr1mac/src/lr1mac_class_c/lr1mac_class_c.c endif -ifeq ($(ADD_MULTICAST),yes) +ifeq ($(LBM_CLASS_B),yes) +LR1MAC_C_SOURCES += \ + smtc_modem_core/lorawan_packages/lorawan_beacon_tx_service_example.c\ + smtc_modem_core/lorawan_manager/lorawan_class_b_management.c\ + smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_beacon_sniff.c\ + smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_ping_slot.c +endif + +ifeq ($(LBM_MULTICAST),yes) +LR1MAC_C_SOURCES += \ + smtc_modem_core/lr1mac/src/services/smtc_multicast/smtc_multicast.c +endif + +ifeq ($(LBM_FUOTA),yes) + ifeq ($(LBM_FUOTA_VERSION),1) + SMTC_MODEM_CORE_C_SOURCES += \ + smtc_modem_core/lorawan_packages/fuota_packages/fragmentation_helper.c\ + smtc_modem_core/lorawan_packages/fuota_packages/lorawan_fragmentation_package.c\ + smtc_modem_core/lorawan_packages/fuota_packages/lorawan_alcsync.c\ + smtc_modem_core/lorawan_packages/fuota_packages/lorawan_remote_multicast_setup_package.c + ifeq ($(LBM_FUOTA_ENABLE_FMP),yes) + SMTC_MODEM_CORE_C_SOURCES += \ + smtc_modem_core/lorawan_packages/fuota_packages/lorawan_fmp_package.c + endif + ifeq ($(LBM_FUOTA_ENABLE_MPA),yes) + SMTC_MODEM_CORE_C_SOURCES += \ + lora_basics_modem/smtc_modem_core/lorawan_packages/fuota_packages/lorawan_mpa_package.c + endif + endif + ifeq ($(LBM_FUOTA_VERSION),2) + SMTC_MODEM_CORE_C_SOURCES += \ + smtc_modem_core/lorawan_packages/fuota_packages_v2/fragmentation_helper.c\ + smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_fragmentation_package.c\ + smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_alcsync.c\ + smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_remote_multicast_setup_package.c + ifeq ($(LBM_FUOTA_ENABLE_FMP),yes) + SMTC_MODEM_CORE_C_SOURCES += \ + smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_fmp_package.c + endif + ifeq ($(LBM_FUOTA_ENABLE_MPA),yes) + SMTC_MODEM_CORE_C_SOURCES += \ + lora_basics_modem/smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_mpa_package.c + endif + endif LR1MAC_C_SOURCES += \ - smtc_modem_core/lr1mac/src/services/smtc_multicast.c + smtc_modem_core/lr1mac/src/lr1mac_class_c/lr1mac_class_c.c\ + smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_beacon_sniff.c\ + smtc_modem_core/lr1mac/src/lr1mac_class_b/smtc_ping_slot.c \ + smtc_modem_core/lr1mac/src/services/smtc_multicast/smtc_multicast.c +else + ifeq ($(LBM_ALC_SYNC),yes) + ifeq ($(LBM_ALC_SYNC_VERSION),1) + SMTC_MODEM_CORE_C_SOURCES += \ + smtc_modem_core/lorawan_packages/fuota_packages/lorawan_alcsync.c + endif + ifeq ($(LBM_ALC_SYNC_VERSION),2) + SMTC_MODEM_CORE_C_SOURCES += \ + smtc_modem_core/lorawan_packages/fuota_packages_v2/lorawan_alcsync.c + endif + endif +endif + +ifeq ($(ALLOW_CSMA_BUILD),yes) +ifeq ($(LBM_CSMA),yes) +LR1MAC_C_SOURCES += \ + smtc_modem_core/lr1mac/src/services/smtc_lora_cad_bt.c +endif endif SMTC_MODEM_CRYPTO_C_SOURCES += \ smtc_modem_core/smtc_modem_crypto/smtc_modem_crypto.c RADIO_PLANNER_C_SOURCES += \ - smtc_modem_core/radio_planner/src/radio_planner.c\ - smtc_modem_core/radio_planner/src/radio_planner_hal.c + smtc_modem_core/radio_planner/src/radio_planner.c COMMON_C_INCLUDES += \ -I.\ -Ismtc_modem_api\ -Ismtc_modem_core\ - -Ismtc_modem_core/modem_config\ - -Ismtc_modem_core/modem_core\ -Ismtc_modem_core/modem_supervisor\ - -Ismtc_modem_core/device_management\ - -Ismtc_modem_core/modem_services\ + -Ismtc_modem_core/modem_utilities\ + -Ismtc_modem_core/lorawan_packages\ + -Ismtc_modem_core/lorawan_manager\ -Ismtc_modem_core/lorawan_api\ - -Ismtc_modem_core/smtc_modem_services/headers\ - -Ismtc_modem_core/smtc_modem_services/src\ - -Ismtc_modem_core/smtc_modem_services/src/stream\ - -Ismtc_modem_core/smtc_modem_services/src/file_upload\ - -Ismtc_modem_core/smtc_modem_services/src/alc_sync\ - -Ismtc_modem_core/smtc_modem_services\ -Ismtc_modem_core/smtc_ral/src\ -Ismtc_modem_core/smtc_ralf/src\ -Ismtc_modem_core/lr1mac\ -Ismtc_modem_core/lr1mac/src\ -Ismtc_modem_core/lr1mac/src/services\ - -Ismtc_modem_core/lr1mac/src/lr1mac_class_c\ - -Ismtc_modem_core/lr1mac/src/lr1mac_class_b\ -Ismtc_modem_core/radio_planner/src\ -Ismtc_modem_core/smtc_modem_crypto\ -Ismtc_modem_core/smtc_modem_crypto/smtc_secure_element\ @@ -375,72 +352,69 @@ COMMON_C_INCLUDES += \ -Ismtc_modem_core/lr1mac/src/smtc_real/src\ -Ismtc_modem_hal +ifeq ($(LBM_CLASS_B),yes) +COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lr1mac/src/lr1mac_class_b +endif - -#----------------------------------------------------------------------------- -# Gather everything -#----------------------------------------------------------------------------- -ifeq ($(COVERAGE),RADIO) -C_SOURCES_COVERAGE = \ - $(RADIO_DRIVER_C_SOURCES) \ - $(SMTC_RAL_C_SOURCES) \ - $(SMTC_RALF_C_SOURCES) \ - $(LR1MAC_C_SOURCES) \ - $(RADIO_PLANNER_C_SOURCES) - -C_SOURCES = \ - $(SMTC_MODEM_CORE_C_SOURCES) \ - $(SMTC_MODEM_SERVICES_C_SOURCES) \ - $(SMTC_MODEM_CRYPTO_C_SOURCES) +ifeq ($(LBM_CLASS_C),yes) +COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lr1mac/src/lr1mac_class_c endif -ifeq ($(COVERAGE),MODEM) -C_SOURCES_COVERAGE = \ - $(SMTC_MODEM_CORE_C_SOURCES) \ - $(SMTC_MODEM_SERVICES_C_SOURCES) \ - $(SMTC_MODEM_CRYPTO_C_SOURCES) -C_SOURCES = \ - $(RADIO_DRIVER_C_SOURCES) \ - $(SMTC_RAL_C_SOURCES) \ - $(SMTC_RALF_C_SOURCES) \ - $(LR1MAC_C_SOURCES) \ - $(RADIO_PLANNER_C_SOURCES) +ifeq ($(LBM_MULTICAST),yes) +COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lr1mac/src/services/smtc_multicast +endif + +ifeq ($(LBM_FUOTA),yes) + ifeq ($(LBM_FUOTA_VERSION),1) + COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lorawan_packages/fuota_packages + endif + ifeq ($(LBM_FUOTA_VERSION),2) + COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lorawan_packages/fuota_packages_v2 + endif +COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lr1mac/src/lr1mac_class_b \ + -Ismtc_modem_core/lr1mac/src/lr1mac_class_c \ + -Ismtc_modem_core/lr1mac/src/services/smtc_multicast +else + ifeq ($(LBM_ALC_SYNC),yes) + ifeq ($(LBM_ALC_SYNC_VERSION),1) + COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lorawan_packages/fuota_packages + endif + ifeq ($(LBM_ALC_SYNC_VERSION),2) + COMMON_C_INCLUDES += \ + -Ismtc_modem_core/lorawan_packages/fuota_packages_v2 + endif + endif endif -ifeq ($(COVERAGE),no) -C_SOURCES_COVERAGE = +#----------------------------------------------------------------------------- +# Gather everything +#----------------------------------------------------------------------------- C_SOURCES = \ $(RADIO_DRIVER_C_SOURCES) \ $(SMTC_RAL_C_SOURCES) \ $(SMTC_RALF_C_SOURCES) \ $(RADIO_PLANNER_C_SOURCES) \ $(SMTC_MODEM_CORE_C_SOURCES) \ - $(SMTC_MODEM_SERVICES_C_SOURCES) \ $(SMTC_MODEM_CRYPTO_C_SOURCES) \ $(LR1MAC_C_SOURCES) -endif ASM_SOURCES = $(BOARD_ASM_SOURCES) -vpath %.c $(sort $(dir $(C_SOURCES_COVERAGE))) vpath %.c $(sort $(dir $(C_SOURCES))) vpath %.cpp $(sort $(dir $(CPP_SOURCES))) #----------------------------------------------------------------------------- -basic_modem: -ifeq ($(RADIO),nc) - $(call echo_error,"No radio selected! Please specified the target radio using RADIO=radio_name option") -else - $(MAKE) basic_modem_build -endif - .PHONY: basic_modem_build basic_modem_build: $(BUILD_ROOT)/$(TARGET_MODEM).a $(SILENT) cp $< $(BUILD_ROOT)/$(TARGET_ROOT).a -ifneq ($(COVERAGE),no) - $(MAKE) $(COVERAGE_ARCHIVE) -endif $(SILENT) rm -rf $(BUILD_ROOT)/latest $(SILENT) ln -s $(realpath $(BUILD_DIR_MODEM)) $(BUILD_ROOT)/latest $(call success,$@ $<) @@ -448,8 +422,6 @@ endif #----------------------------------------------------------------------------- # list of C objects -COVERAGE_OBJECTS = $(addprefix $(COVERAGE_OUTPUT_DIR)/, $(notdir $(C_SOURCES_COVERAGE:.c=.o))) -vpath %.c $(sort $(dir $(C_SOURCES_COVERAGE))) OBJECTS = $(addprefix $(BUILD_DIR_MODEM)/,$(notdir $(C_SOURCES:.c=.o))) vpath %.c $(sort $(dir $(C_SOURCES))) @@ -460,16 +432,8 @@ vpath %.s $(sort $(dir $(ASM_SOURCES))) # Mark .o intermediate files as secondary target (or precious) # Without this, $(MAKE) will remove intermediate files and slow down rebuilds -.SECONDARY: $(COVERAGE_OBJECTS) .SECONDARY: $(OBJECTS) -$(COVERAGE_OUTPUT_DIR)/%.o: %.c Makefile | $(COVERAGE_OUTPUT_DIR) - $(call build,'CC-GCOV',$<) - $(SILENT)$(CC) -c $(CFLAGS) $(COVERAGE_CFLAGS) -Wa,-a,-ad,-alms=$(BUILD_DIR_MODEM)/$(notdir $(<:.c=.lst)) $< -o $@ -ifeq ($(SIZE),yes) - $(SZ) $@ -endif - $(BUILD_DIR_MODEM)/%.o: %.c Makefile | $(BUILD_DIR_MODEM) $(call build,'CC',$<) $(SILENT)$(CC) -c $(CFLAGS) -Wa,-a,-ad,-alms=$(BUILD_DIR_MODEM)/$(notdir $(<:.c=.lst)) $< -o $@ @@ -485,9 +449,9 @@ ifeq ($(SIZE),yes) endif -$(BUILD_DIR_MODEM)/%.a: $(OBJECTS) $(COVERAGE_OBJECTS) Makefile | $(BUILD_DIR_MODEM) +$(BUILD_DIR_MODEM)/%.a: $(OBJECTS) Makefile | $(BUILD_DIR_MODEM) $(call build,'LIB',$@) - $(SILENT)$(AR) rcs $@ $(OBJECTS) $(COVERAGE_OBJECTS) + $(SILENT)$(AR) rcs $@ $(OBJECTS) $(SZ) -t $@ $(BUILD_ROOT)/$(TARGET_MODEM).a: $(BUILD_DIR_MODEM)/$(TARGET_MODEM).a @@ -497,50 +461,6 @@ $(BUILD_ROOT)/$(TARGET_MODEM).a: $(BUILD_DIR_MODEM)/$(TARGET_MODEM).a $(BUILD_DIR_MODEM): $(SILENT)mkdir -p $@ -$(COVERAGE_ARCHIVE): $(COVERAGE_OBJECTS) - $(call build,'TAR',$@) - $(SILENT) tar czf $@ -C $(BUILD_DIR_MODEM) gcov - -$(COVERAGE_OUTPUT_DIR): - $(SILENT)mkdir -p $@ - -#----------------------------------------------------------------------------- -# Debug print rules -#----------------------------------------------------------------------------- -debug_region: - $(call echo,"Region $(REGION)") - $(call echo," REGION_AS_923 $(REGION_AS_923)") - $(call echo," REGION_AU_915 $(REGION_AU_915)") - $(call echo," REGION_CN_470 $(REGION_CN_470)") - $(call echo," REGION_CN_470_RP_1_0 $(REGION_CN_470_RP_1_0)") - $(call echo," REGION_EU_868 $(REGION_EU_868)") - $(call echo," REGION_IN_865 $(REGION_IN_865)") - $(call echo," REGION_KR_920 $(REGION_KR_920)") - $(call echo," REGION_RU_864 $(REGION_RU_864)") - $(call echo," REGION_US_915 $(REGION_US_915)") - -debug_target: - $(call echo,"Target $(TARGET)") - $(call echo,"Build directory $(BUILD_DIR_MODEM)") - $(call echo,"Binary $(TARGET_MODEM)") - -debug_sources: - $(call echo,"RADIO_DRIVER_C_SOURCES $(RADIO_DRIVER_C_SOURCES)") - $(call echo,"SMTC_RAL_C_SOURCES $(SMTC_RAL_C_SOURCES)") - $(call echo,"SMTC_RALF_C_SOURCES $(SMTC_RALF_C_SOURCES)") - $(call echo,"RADIO_HAL_C_SOURCES $(RADIO_HAL_C_SOURCES)") - $(call echo,"RADIO_PLANNER_C_SOURCES $(RADIO_PLANNER_C_SOURCES)") - $(call echo,"SMTC_MODEM_CORE_C_SOURCES $(SMTC_MODEM_CORE_C_SOURCES)") - $(call echo,"SMTC_MODEM_SERVICES_C_SOURCES $(SMTC_MODEM_SERVICES_C_SOURCES)") - $(call echo,"SMTC_MODEM_CRYPTO_C_SOURCES $(SMTC_MODEM_CRYPTO_C_SOURCES)") - $(call echo,"LR1MAC_C_SOURCES $(LR1MAC_C_SOURCES)") - $(call echo,"COMMON_C_INCLUDES $(COMMON_C_INCLUDES)") - -debug_flags: - $(call echo,"MODEM_C_DEFS $(MODEM_C_DEFS)") - -debug: debug_target debug_region debug_sources debug_flags - #----------------------------------------------------------------------------- # Clean #----------------------------------------------------------------------------- @@ -548,4 +468,3 @@ clean_target: -rm -fR $(BUILD_DIR_MODEM) -rm -fR $(BUILD_ROOT)/$(TARGET_MODEM).a -rm -fR $(BUILD_ROOT)/$(TARGET_ROOT).a - -rm -fR *_gcov.tar.gz diff --git a/makefiles/lr11xx.mk b/makefiles/lr11xx.mk index 23a702f..35ab138 100644 --- a/makefiles/lr11xx.mk +++ b/makefiles/lr11xx.mk @@ -1,6 +1,8 @@ ############################################################################## # Definitions for the LR11XX tranceiver ############################################################################## +-include makefiles/options.mk + ifeq ($(RADIO),lr1110) TARGET = lr1110 endif @@ -8,16 +10,13 @@ ifeq ($(RADIO),lr1120) TARGET = lr1120 endif +# Allow modem options +ALLOW_CSMA_BUILD = yes #----------------------------------------------------------------------------- -# Common sources +# Radio specific sources #----------------------------------------------------------------------------- -ifeq ($(USE_GNSS),yes) -SMTC_MODEM_SERVICES_C_SOURCES += \ - smtc_modem_core/smtc_modem_services/src/almanac_update/almanac_update.c -endif - RADIO_DRIVER_C_SOURCES += \ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_bootloader.c\ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_crypto_engine.c\ @@ -26,11 +25,8 @@ RADIO_DRIVER_C_SOURCES += \ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_regmem.c\ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_system.c\ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_wifi.c\ - smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_lr_fhss.c -ifeq ($(USE_GNSS),yes) -RADIO_DRIVER_C_SOURCES += \ + smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_lr_fhss.c\ smtc_modem_core/radio_drivers/lr11xx_driver/src/lr11xx_gnss.c -endif SMTC_RAL_C_SOURCES += \ smtc_modem_core/smtc_ral/src/ral_lr11xx.c @@ -82,12 +78,8 @@ endif # soft_crypto #----------------------------------------------------------------------------- MODEM_C_DEFS += \ -DLR11XX\ - -DLR11XX_TRANSCEIVER - -ifeq ($(RADIO),lr1120) -MODEM_C_DEFS += \ - -DLR1120 -endif + -DLR11XX_TRANSCEIVER\ + -DLR11XX_DISABLE_WARNINGS ifeq ($(CRYPTO),LR11XX) MODEM_C_DEFS += \ @@ -99,9 +91,3 @@ MODEM_C_DEFS += \ -DUSE_LR11XX_CE \ -DUSE_PRE_PROVISIONED_FEATURES endif # LR11XX_WITH_CREDENTIALS - -# GNSS USE -ifeq ($(USE_GNSS),yes) -MODEM_C_DEFS += \ - -DENABLE_MODEM_GNSS_FEATURE -endif diff --git a/makefiles/options.mk b/makefiles/options.mk new file mode 100644 index 0000000..b4abf48 --- /dev/null +++ b/makefiles/options.mk @@ -0,0 +1,85 @@ +#----------------------------------------------------------------------------- +# Global configuration options +#----------------------------------------------------------------------------- + +# Tranceiver +RADIO ?= nc + +# MCU - Must be provided by user +MCU_FLAGS =? nc + +# Prefix for all build directories +BUILD_ROOT = build + +# Prefix for all binaries names +TARGET_ROOT = basic_modem + +# External flags if needed +EXTRAFLAGS ?= + +#----------------------------------------------------------------------------- +# Optimization and Debug +#----------------------------------------------------------------------------- +OPT ?= -Os + +DEBUG ?= no + +#----------------------------------------------------------------------------- +# Makefile Configuration options +#----------------------------------------------------------------------------- + +# Use multithreaded build (make -j) +MULTITHREAD ?= yes + +# Print each object file size +SIZE ?= no + +# Verbosity +VERBOSE ?= no + +#----------------------------------------------------------------------------- +# Internal LBM features management +#----------------------------------------------------------------------------- + +# Trace prints +MODEM_TRACE ?= yes +MODEM_DEEP_TRACE ?= no + +# LoRaWAN regions: ALL to build all available regions, otherwise regions can be added with a comma separator (ex EU_868,US_915) +# If radio target is sx128x WW_2G4 is forced +REGION ?= ALL + +# Crypto management only for lr11xx targets (SOFT, LR11XX, LR11XX_WITH_CREDENTIALS ) +CRYPTO ?= SOFT + +# class b feature +LBM_CLASS_B ?= yes + +# class c feature +LBM_CLASS_C ?= yes + +# Multicast feature (at leastclass B or class C shall be activated) +LBM_MULTICAST ?= yes + +# ALCSYNC feature (these options are only taken in count if LBM_FUOTA is disabled) +LBM_ALC_SYNC ?= yes +# ALCSYNC Package version: 1 for v1.0.0 and 2 for v2.0.0 +LBM_ALC_SYNC_VERSION ?= 1 + +# Fuota feature (this will automatically enable class b, class c, multicast and ALCSync) +LBM_FUOTA ?= no +LBM_FUOTA_VERSION ?= 1 +FUOTA_MAXIMUM_NB_OF_FRAGMENTS ?= nc +FUOTA_MAXIMUM_SIZE_OF_FRAGMENTS ?= nc +FUOTA_MAXIMUM_FRAG_REDUNDANCY ?= nc +# In case FUOTA is allowed, allow the use of Firmware Management Package +LBM_FUOTA_ENABLE_FMP ?= no +# In case FUOTA is allowed, llow the use of Multi-Package Access Package +LBM_FUOTA_ENABLE_MPA ?= no + +# CSMA Feature ( only usable for lr11xx and sx126x targets) +LBM_CSMA ?= yes +USE_CSMA_BY_DEFAULT ?= no + +# Multistack +NB_OF_STACK ?= 1 \ No newline at end of file diff --git a/makefiles/printing.mk b/makefiles/printing.mk index 770a49c..653dbfb 100644 --- a/makefiles/printing.mk +++ b/makefiles/printing.mk @@ -1,11 +1,12 @@ ###################################### # Some pretty colors and printing ###################################### +-include makefiles/options.mk ###################################### # Verbose build ###################################### -ifdef VERBOSE +ifeq ($(VERBOSE),yes) SILENT = else SILENT = @ @@ -17,6 +18,7 @@ BOLD_CYAN := '\033[1;36m' BOLD_GREEN := '\033[1;32m' BOLD_PURPLE := '\033[1;35m' BOLD_YELLOW:= '\033[1;33m' +YELLOW:= '\033[0;33m' IPURPLE:= '\033[0;95m' BIPURPLE:= '\033[1;95m' @@ -42,7 +44,7 @@ define success endef define warn - @$(ECHO_CMD) -e $(BOLD_PURPLE)'! '$(1)$(NC) + @$(ECHO_CMD) -e $(YELLOW)'! '$(1)$(NC) endef define echo_help diff --git a/makefiles/regions.mk b/makefiles/regions.mk index b4db64e..e8a412b 100644 --- a/makefiles/regions.mk +++ b/makefiles/regions.mk @@ -13,7 +13,7 @@ REGION_RU_864 = no REGION_US_915 = no REGION_WW_2G4 = no -ifndef REGION +ifeq ($(REGION),ALL) ifneq ($(RADIO),sx128x) REGION_AS_923 = yes REGION_AU_915 = yes @@ -37,7 +37,7 @@ endif # REGION #----------------------------------------------------------------------------- ifndef RP_VERSION -MODEM_C_DEFS += -DRP2_101 +MODEM_C_DEFS += -DRP2_103 endif ifeq ($(RP_VERSION),RP2_103) diff --git a/makefiles/sx126x.mk b/makefiles/sx126x.mk index a82cd46..1ec1c6d 100644 --- a/makefiles/sx126x.mk +++ b/makefiles/sx126x.mk @@ -1,6 +1,8 @@ ############################################################################## -# Definitions for the SX128x tranceiver +# Definitions for the SX126x tranceiver ############################################################################## +-include makefiles/options.mk + ifeq ($(RADIO),sx1261) TARGET = sx1261 endif @@ -11,6 +13,15 @@ ifeq ($(RADIO),sx1268) TARGET = sx1268 endif +# Allow modem options +ALLOW_CSMA_BUILD = yes + + +#----------------------------------------------------------------------------- +# Radio specific sources +#----------------------------------------------------------------------------- + + RADIO_DRIVER_C_SOURCES += \ smtc_modem_core/radio_drivers/sx126x_driver/src/sx126x.c\ smtc_modem_core/radio_drivers/sx126x_driver/src/sx126x_lr_fhss.c\ @@ -34,9 +45,6 @@ MODEM_C_INCLUDES = \ -Ismtc_modem_core/radio_drivers/sx126x_driver/src\ -Ismtc_modem_core/smtc_modem_crypto/soft_secure_element -#----------------------------------------------------------------------------- -# Region -#----------------------------------------------------------------------------- #----------------------------------------------------------------------------- # Radio specific compilation flags diff --git a/makefiles/sx127x.mk b/makefiles/sx127x.mk new file mode 100644 index 0000000..f13f401 --- /dev/null +++ b/makefiles/sx127x.mk @@ -0,0 +1,52 @@ +############################################################################## +# Definitions for the SX126x tranceiver +############################################################################## +-include makefiles/options.mk + +ifeq ($(RADIO),sx1272) +TARGET = sx1272 +endif +ifeq ($(RADIO),sx1276) +TARGET = sx1276 +endif + +RADIO_DRIVER_C_SOURCES += \ + smtc_modem_core/radio_drivers/sx127x_driver/src/sx127x.c\ + +SMTC_RAL_C_SOURCES += \ + smtc_modem_core/smtc_ral/src/ral_sx127x.c + +SMTC_RALF_C_SOURCES += \ + smtc_modem_core/smtc_ralf/src/ralf_sx127x.c + +SMTC_MODEM_CRYPTO_C_SOURCES += \ + smtc_modem_core/smtc_modem_crypto/soft_secure_element/aes.c\ + smtc_modem_core/smtc_modem_crypto/soft_secure_element/cmac.c\ + smtc_modem_core/smtc_modem_crypto/soft_secure_element/soft_se.c + +#----------------------------------------------------------------------------- +# Includes +#----------------------------------------------------------------------------- +MODEM_C_INCLUDES = \ + -Ismtc_modem_core/radio_drivers/sx127x_driver/src\ + -Ismtc_modem_core/smtc_modem_crypto/soft_secure_element + +#----------------------------------------------------------------------------- +# Region +#----------------------------------------------------------------------------- + +#----------------------------------------------------------------------------- +# Radio specific compilation flags +#----------------------------------------------------------------------------- +MODEM_C_DEFS += \ + -DSX127X + +ifeq ($(RADIO),sx1272) +MODEM_C_DEFS += \ + -DSX1272 +endif + +ifeq ($(RADIO),sx1276) +MODEM_C_DEFS += \ + -DSX1276 +endif diff --git a/makefiles/sx128x.mk b/makefiles/sx128x.mk index 3ef5fb7..7200177 100644 --- a/makefiles/sx128x.mk +++ b/makefiles/sx128x.mk @@ -1,6 +1,8 @@ ############################################################################## # Definitions for the SX128x tranceiver ############################################################################## +-include makefiles/options.mk + TARGET = sx128x RADIO_DRIVER_C_SOURCES += \ diff --git a/smtc_modem_api/CHANGELOG.md b/smtc_modem_api/CHANGELOG.md index d70a8f4..91918af 100644 --- a/smtc_modem_api/CHANGELOG.md +++ b/smtc_modem_api/CHANGELOG.md @@ -4,7 +4,87 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [v3.0.0] Unreleased +## [v4.1.0] 2023-07-07 + +### Added + +* Event `SMTC_MODEM_EVENT_FIRMWARE_MANAGEMENT` and associated status structure used by LoRaWAN Firmware Management Package +* CSMA functions: + * `smtc_modem_csma_set_state` to enable/disable the feature + * `smtc_modem_csma_get_state` to get the current status of the csma feature + * `smtc_modem_csma_set_parameters` to set optional parameters for csma + * `smtc_modem_csma_get_parameters` to get the current parameters used by the csma feature +* smtc_modem_utilities: `smtc_modem_get_radio_context` to get previously set radio context (mandatory for sx127x support as the driver implements and uses an internal context) + +## [v4.0.0] 2023-03-10 + +This version propose a major update of the LoRa Basics Modem. +The purpose is to have a complete and simple LoRaWAN stack implementation, including additional LoRaWAN packages (Application Layer Clock Synchronization, Fragmented Data Block Transport, Remote Multicast Setup). + +### Added + +* smtc_modem_utilities: + * `smtc_modem_is_irq_flag_pending` function to allow checking if some modem flags are pending + * `smtc_modem_set_radio_context` function to set optional radio context if needed +* `SMTC_MODEM_RC_NO_EVENT` return code in case `smtc_modem_get_event()` is called and there is no pending event +* `smtc_modem_get_downlink_data` to get received data +* `smtc_modem_get_lorawan_link_check_data` to get link check data +* `smtc_modem_debug_connect_with_abp` for debug purpose +* Fuota related events type + * `SMTC_MODEM_EVENT_LORAWAN_FUOTA_DONE` + * `SMTC_MODEM_EVENT_NO_MORE_MULTICAST_SESSION_CLASS_C` + * `SMTC_MODEM_EVENT_NO_MORE_MULTICAST_SESSION_CLASS_B` + * `SMTC_MODEM_EVENT_NEW_MULTICAST_SESSION_CLASS_C` + * `SMTC_MODEM_EVENT_NEW_MULTICAST_SESSION_CLASS_B` +* Fuota related events status in `smtc_modem_event_t`: + * `fuota_status` + * `new_multicast_class_c` + * `new_multicast_class_b` + +### Changed + +* lr11xx specific crypto features are now in main api file (`smtc_basic_modem_lr11xx_api_extension.h` removed) +* `smtc_modem_return_code_t` Modem return codes are now generic enum (no values specified) +* Events: + * Events are now generic enum (no values specified): `smtc_modem_event_type_t` + * Event structure `smtc_modem_event_t` does not contain downlink data anymore. Use `smtc_modem_get_downlink_data` to get received data + * Event structure `smtc_modem_event_t` does not contain link_check data anymore. Use `smtc_modem_get_lorawan_link_check_data` to get link check data + * In event structure: `class_b_ping_slot_info`, `lorawan_mac_time` and `link_check` share the same status type `smtc_modem_event_mac_request_status_t` +* Time services is now split in 2 standalone features: + * LoRaWAN ALCSync package: + * `smtc_modem_start_alcsync_service` to start the service + * `smtc_modem_stop_alcsync_service` to stop the service + * `smtc_modem_get_alcsync_time` to get the time from the service + * `smtc_modem_trigger_alcsync_request` to trig a manual time request + * New event `SMTC_MODEM_EVENT_ALCSYNC_TIME` for the service + * LoRaWAN Device Time Request: + * Request shall be done using `smtc_modem_trig_lorawan_mac_request` + * `smtc_modem_get_lorawan_mac_time` to get the time from stack + * New event `SMTC_MODEM_EVENT_LORAWAN_MAC_TIME` +* `smtc_modem_test_duty_cycle_app_activate` rename into `smtc_modem_debug_set_duty_cycle_state` +* `smtc_modem_lorawan_request_link_check` is now handled in `smtc_modem_trig_lorawan_mac_request` +* `smtc_modem_lorawan_class_b_request_ping_slot_info` is now handled in `smtc_modem_trig_lorawan_mac_request` + +### Removed + +* [**GENERAL**] Support of LoRaCloud services: Large File Upload (LFU), Stream, Device Management, Almanac update (All features, functions and events removed) +* All user radio direct access features, functions and events +* `smtc_modem_get_network_type` function +* `smtc_modem_suspend_radio_communications` function +* `smtc_modem_get_stack_state` function +* `smtc_modem_get_network_frame_pending_status` function +* Connection timeout features: + * `smtc_modem_connection_timeout_set_thresholds` function + * `smtc_modem_connection_timeout_get_current_values` function + * Event `SMTC_MODEM_EVENT_TIMEOUT_ADR_CHANGED` +* Event `SMTC_MODEM_EVENT_NEW_LINK_ADR` +* Return core `SMTC_MODEM_RC_MODEM_E_FRAME_ERROR` + +## [v3.2.4] 2022-08-23 + +No changes + +## [v3.1.7] 2022-04-13 ### Added @@ -28,7 +108,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Removed - ## [v2.1.0] 2021-09-24 ### Added diff --git a/smtc_modem_api/doxygen.config b/smtc_modem_api/doxygen.config deleted file mode 100644 index 85fc6dc..0000000 --- a/smtc_modem_api/doxygen.config +++ /dev/null @@ -1,2494 +0,0 @@ -# Doxyfile 1.8.13 - -# 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 http://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 = "SMTC Modem API" - -# 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 = - -# 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 = "Generic Modem API description" - -# 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 = build_doc - -# 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 = YES - -# 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: -# http://www.riverbankcomputing.co.uk/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 = YES - -# 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 = NO - -# 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 http://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: http://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 = - -#--------------------------------------------------------------------------- -# 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 http://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 = - -#--------------------------------------------------------------------------- -# 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 -# http://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_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: http://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 http://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://qt-project.org/doc/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://qt-project.org/doc/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://qt-project.org/doc/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://qt-project.org/doc/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://qt-project.org/doc/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_TRANPARENT 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 -# http://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 = NO - -# 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 http://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 -# , /