diff --git a/bsp/k230/.ignore_format.yml b/bsp/k230/.ignore_format.yml deleted file mode 100644 index e68ef237337..00000000000 --- a/bsp/k230/.ignore_format.yml +++ /dev/null @@ -1,6 +0,0 @@ -# files format check exclude path, please follow the instructions below to modify; -# If you need to exclude an entire folder, add the folder path in dir_path; -# If you need to exclude a file, add the path to the file in file_path. - -dir_path: -- opensbi diff --git a/bsp/k230/README.md b/bsp/k230/README.md index b62b7873eaa..66b5f3d5592 100644 --- a/bsp/k230/README.md +++ b/bsp/k230/README.md @@ -31,44 +31,8 @@ sudo ./cromfs-tool-x64 dir crom.img ./ # 将生成的cromfs_data.c放 ## 编译 -### 一步完成 -``` -export RTT_EXEC_PATH=/mnt/e/tools/riscv64gc/bin # 你自己的编译器路径 - -scons -j8 all=1 -``` - -### 分步完成 -* 1. 编译RT-Thread ``` export RTT_EXEC_PATH=/mnt/e/tools/riscv64gc/bin # 你自己的编译器路径 scons -j8 - ``` - -* 2. 编译opensbi & 生成烧录文件 -``` -./mkfm.sh /mnt/e/tools/riscv64gc/bin/riscv64-unknown-linux-musl- # 你自己的编译器 -``` -此处会把`rtthread.bin`编译进opensbi - - -## 烧录rtt_system.bin - -1. 参照 https://github.com/kendryte/k230_sdk 烧入预编译镜像 -2. 通过另一个核上运行的linux烧录rtt -``` -ifconfig eth0 up;ifconfig eth0 192.168.2.2;cd /tmp;tftp -r rtt_system.bin -g 192.168.2.20;dd if=rtt_system.bin of=/dev/mmcblk1p1;reboot - -``` - -## 用uboot从sd卡fat分区加载rtt_system.bin - -在`快起`特性关闭的情况下，从小核控制台进入uboot操作界面，输入如下命令： -``` -fatload mmc 1:4 $ramdisk_addr rtt_system.bin;k230_boot mem $ramdisk_addr 0x$filesize - -``` - -`备注`: 随后RT-Thread启动界面显示在大核控制台。 diff --git a/bsp/k230/opensbi/.clang-format b/bsp/k230/opensbi/.clang-format deleted file mode 100644 index c80c0aa985f..00000000000 --- a/bsp/k230/opensbi/.clang-format +++ /dev/null @@ -1,16 +0,0 @@ -AlignConsecutiveAssignments: true -AlignEscapedNewlines: Left -AlignTrailingComments: true -AllowShortFunctionsOnASingleLine: None -BraceWrapping: - AfterFunction: true -BreakBeforeBraces: Custom -BreakStringLiterals: false -ContinuationIndentWidth: 8 -Cpp11BracedListStyle: false -IndentWidth: 8 -ReflowComments: false -SortIncludes: false -SpacesInContainerLiterals: false -TabWidth: 8 -UseTab: Always diff --git a/bsp/k230/opensbi/.gitignore b/bsp/k230/opensbi/.gitignore deleted file mode 100644 index 534ad6477c7..00000000000 --- a/bsp/k230/opensbi/.gitignore +++ /dev/null @@ -1,11 +0,0 @@ -# Object files -*.o -*.a -*.dep - -#Build & install directories -build/ -install/ - -# Development friendly files -tags diff --git a/bsp/k230/opensbi/CONTRIBUTORS.md b/bsp/k230/opensbi/CONTRIBUTORS.md deleted file mode 100644 index afae1251d00..00000000000 --- a/bsp/k230/opensbi/CONTRIBUTORS.md +++ /dev/null @@ -1,27 +0,0 @@ - -List of OpenSBI Contributors (Alphabetically sorted) -==================================================== - -* **[Western Digital Corporation](https://www.wdc.com/)** - * Project initiator and maintainer - * Copyright (c) 2019 Western Digital Corporation or its affiliates - -* Alistair Francis - -* Andreas Schwab - -* Anup Patel - -* Atish Patra - -* Bin Meng - -* Damien Le Moal - -* Karsten Merker - -* Nick Kossifidis - -* Shawn Chang - -* Xiang Wang diff --git a/bsp/k230/opensbi/COPYING.BSD b/bsp/k230/opensbi/COPYING.BSD deleted file mode 100644 index 26972c8a46f..00000000000 --- a/bsp/k230/opensbi/COPYING.BSD +++ /dev/null @@ -1,25 +0,0 @@ -The 2-Clause BSD License -SPDX short identifier: BSD-2-Clause - -Copyright (c) 2019 Western Digital Corporation or its affiliates and other -contributors. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND -ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/bsp/k230/opensbi/Makefile b/bsp/k230/opensbi/Makefile deleted file mode 100644 index eeffe6bad04..00000000000 --- a/bsp/k230/opensbi/Makefile +++ /dev/null @@ -1,493 +0,0 @@ -# -# SPDX-License-Identifier: BSD-2-Clause -# -# Copyright (c) 2019 Western Digital Corporation or its affiliates. -# -# Authors: -# Anup Patel -# - -# Select Make Options: -# o Do not use make's built-in rules -# o Do not print "Entering directory ..."; -MAKEFLAGS += -r --no-print-directory - -# Readlink -f requires GNU readlink -ifeq ($(shell uname -s),Darwin) -READLINK ?= greadlink -else -READLINK ?= readlink -endif - -# Find out source, build, and install directories -src_dir=$(CURDIR) -ifdef O - build_dir=$(shell $(READLINK) -f $(O)) -else - build_dir=$(CURDIR)/build -endif -ifeq ($(build_dir),$(CURDIR)) -$(error Build directory is same as source directory.) -endif -install_root_dir_default=$(CURDIR)/install -ifdef I - install_root_dir=$(shell $(READLINK) -f $(I)) -else - install_root_dir=$(install_root_dir_default)/usr -endif -ifeq ($(install_root_dir),$(CURDIR)) -$(error Install root directory is same as source directory.) -endif -ifeq ($(install_root_dir),$(build_dir)) -$(error Install root directory is same as build directory.) -endif -ifdef PLATFORM_DIR - platform_dir_path=$(shell $(READLINK) -f $(PLATFORM_DIR)) - ifdef PLATFORM - platform_parent_dir=$(platform_dir_path) - else - PLATFORM=$(shell basename $(platform_dir_path)) - platform_parent_dir=$(subst $(PLATFORM),,$(platform_dir_path)) - endif -else - platform_parent_dir=$(src_dir)/platform -endif - -# Check if verbosity is ON for build process -CMD_PREFIX_DEFAULT := @ -ifeq ($(V), 1) - CMD_PREFIX := -else - CMD_PREFIX := $(CMD_PREFIX_DEFAULT) -endif - -# Setup path of directories -export platform_subdir=$(PLATFORM) -export platform_src_dir=$(platform_parent_dir)/$(platform_subdir) -export platform_build_dir=$(build_dir)/platform/$(platform_subdir) -export include_dir=$(CURDIR)/include -export libsbi_dir=$(CURDIR)/lib/sbi -export libsbiutils_dir=$(CURDIR)/lib/utils -export firmware_dir=$(CURDIR)/firmware - -# Find library version -OPENSBI_VERSION_MAJOR=`grep "define OPENSBI_VERSION_MAJOR" $(include_dir)/sbi/sbi_version.h | sed 's/.*MAJOR.*\([0-9][0-9]*\)/\1/'` -OPENSBI_VERSION_MINOR=`grep "define OPENSBI_VERSION_MINOR" $(include_dir)/sbi/sbi_version.h | sed 's/.*MINOR.*\([0-9][0-9]*\)/\1/'` -OPENSBI_VERSION_GIT=$(shell if [ -d $(src_dir)/.git ]; then git describe 2> /dev/null; fi) - -# Setup compilation commands -ifdef CROSS_COMPILE -CC = $(CROSS_COMPILE)gcc -CPP = $(CROSS_COMPILE)cpp -AR = $(CROSS_COMPILE)ar -LD = $(CROSS_COMPILE)ld -OBJCOPY = $(CROSS_COMPILE)objcopy -else -CC ?= gcc -CPP ?= cpp -AR ?= ar -LD ?= ld -OBJCOPY ?= objcopy -endif -AS = $(CC) -DTC = dtc - -# Guess the compillers xlen -OPENSBI_CC_XLEN := $(shell TMP=`$(CC) -dumpmachine | sed 's/riscv\([0-9][0-9]\).*/\1/'`; echo $${TMP}) -OPENSBI_CC_ABI := $(shell TMP=`$(CC) -v 2>&1 | sed -n 's/.*\(with\-abi=\([a-zA-Z0-9]*\)\).*/\2/p'`; echo $${TMP}) -OPENSBI_CC_ISA := $(shell TMP=`$(CC) -v 2>&1 | sed -n 's/.*\(with\-arch=\([a-zA-Z0-9]*\)\).*/\2/p'`; echo $${TMP}) - -# Setup platform XLEN -ifndef PLATFORM_RISCV_XLEN - ifeq ($(OPENSBI_CC_XLEN), 32) - PLATFORM_RISCV_XLEN = 32 - else - PLATFORM_RISCV_XLEN = 64 - endif -endif - -# Setup list of objects.mk files -ifdef PLATFORM -platform-object-mks=$(shell if [ -d $(platform_src_dir)/ ]; then find $(platform_src_dir) -iname "objects.mk" | sort -r; fi) -endif -libsbi-object-mks=$(shell if [ -d $(libsbi_dir) ]; then find $(libsbi_dir) -iname "objects.mk" | sort -r; fi) -libsbiutils-object-mks=$(shell if [ -d $(libsbiutils_dir) ]; then find $(libsbiutils_dir) -iname "objects.mk" | sort -r; fi) -firmware-object-mks=$(shell if [ -d $(firmware_dir) ]; then find $(firmware_dir) -iname "objects.mk" | sort -r; fi) - -# Include platform specifig config.mk -ifdef PLATFORM -include $(platform_src_dir)/config.mk -endif - -# Include all object.mk files -ifdef PLATFORM -include $(platform-object-mks) -endif -include $(libsbi-object-mks) -include $(libsbiutils-object-mks) -include $(firmware-object-mks) - -# Setup list of objects -libsbi-objs-path-y=$(foreach obj,$(libsbi-objs-y),$(build_dir)/lib/sbi/$(obj)) -libsbiutils-objs-path-y=$(foreach obj,$(libsbiutils-objs-y),$(build_dir)/lib/utils/$(obj)) -ifdef PLATFORM -platform-objs-path-y=$(foreach obj,$(platform-objs-y),$(platform_build_dir)/$(obj)) -firmware-bins-path-y=$(foreach bin,$(firmware-bins-y),$(platform_build_dir)/firmware/$(bin)) -endif -firmware-elfs-path-y=$(firmware-bins-path-y:.bin=.elf) -firmware-objs-path-y=$(firmware-bins-path-y:.bin=.o) - -# Setup list of deps files for objects -deps-y=$(platform-objs-path-y:.o=.dep) -deps-y+=$(libsbi-objs-path-y:.o=.dep) -deps-y+=$(libsbiutils-objs-path-y:.o=.dep) -deps-y+=$(firmware-objs-path-y:.o=.dep) - -# Setup platform ABI, ISA and Code Model -ifndef PLATFORM_RISCV_ABI - ifneq ($(PLATFORM_RISCV_TOOLCHAIN_DEFAULT), 1) - ifeq ($(PLATFORM_RISCV_XLEN), 32) - PLATFORM_RISCV_ABI = ilp$(PLATFORM_RISCV_XLEN) - else - PLATFORM_RISCV_ABI = lp$(PLATFORM_RISCV_XLEN) - endif - else - PLATFORM_RISCV_ABI = $(OPENSBI_CC_ABI) - endif -endif -ifndef PLATFORM_RISCV_ISA - ifneq ($(PLATFORM_RISCV_TOOLCHAIN_DEFAULT), 1) - PLATFORM_RISCV_ISA = rv$(PLATFORM_RISCV_XLEN)imafdc - else - PLATFORM_RISCV_ISA = $(OPENSBI_CC_ISA) - endif -endif -ifndef PLATFORM_RISCV_CODE_MODEL - PLATFORM_RISCV_CODE_MODEL = medany -endif - -# Setup install directories -ifdef INSTALL_INCLUDE_PATH - install_include_path=$(INSTALL_INCLUDE_PATH) -else - install_include_path=include -endif -ifdef INSTALL_LIB_PATH - install_lib_path=$(INSTALL_LIB_PATH) -else - ifneq ($(origin INSTALL_LIB_SUBDIR), undefined) - install_lib_subdir=$(INSTALL_LIB_SUBDIR) - else - install_lib_subdir=$(PLATFORM_RISCV_ABI) - endif - install_lib_path=lib$(subst 32,,$(PLATFORM_RISCV_XLEN))/$(install_lib_subdir) -endif -ifdef INSTALL_FIRMWARE_PATH - install_firmware_path=$(INSTALL_FIRMWARE_PATH) -else - install_firmware_path=share/opensbi/$(PLATFORM_RISCV_ABI) -endif -ifdef INSTALL_DOCS_PATH - install_docs_path=$(INSTALL_DOCS_PATH) -else - install_docs_path=share/opensbi/docs -endif - -# Setup compilation commands flags -GENFLAGS = -I$(platform_src_dir)/include -GENFLAGS += -I$(include_dir) -ifneq ($(OPENSBI_VERSION_GIT),) -GENFLAGS += -DOPENSBI_VERSION_GIT="\"$(OPENSBI_VERSION_GIT)\"" -endif -GENFLAGS += $(libsbiutils-genflags-y) -GENFLAGS += $(platform-genflags-y) -GENFLAGS += $(firmware-genflags-y) - -CFLAGS = -g -Wall -Werror -ffreestanding -nostdlib -fno-strict-aliasing -O2 -CFLAGS += -fno-omit-frame-pointer -fno-optimize-sibling-calls -CFLAGS += -mno-save-restore -mstrict-align -CFLAGS += -mabi=$(PLATFORM_RISCV_ABI) -march=$(PLATFORM_RISCV_ISA) -CFLAGS += -mcmodel=$(PLATFORM_RISCV_CODE_MODEL) -CFLAGS += $(GENFLAGS) -CFLAGS += $(platform-cflags-y) -CFLAGS += -fno-pie -no-pie -CFLAGS += $(firmware-cflags-y) - -CPPFLAGS += $(GENFLAGS) -CPPFLAGS += $(platform-cppflags-y) -CPPFLAGS += $(firmware-cppflags-y) - -ASFLAGS = -g -Wall -nostdlib -ASFLAGS += -fno-omit-frame-pointer -fno-optimize-sibling-calls -ASFLAGS += -mno-save-restore -mstrict-align -ASFLAGS += -mabi=$(PLATFORM_RISCV_ABI) -march=$(PLATFORM_RISCV_ISA) -ASFLAGS += -mcmodel=$(PLATFORM_RISCV_CODE_MODEL) -ASFLAGS += $(GENFLAGS) -ASFLAGS += $(platform-asflags-y) -ASFLAGS += $(firmware-asflags-y) - -ARFLAGS = rcs - -ELFFLAGS += -Wl,--build-id=none -N -static-libgcc -lgcc -ELFFLAGS += $(platform-ldflags-y) -ELFFLAGS += $(firmware-ldflags-y) - -MERGEFLAGS += -r -MERGEFLAGS += -b elf$(PLATFORM_RISCV_XLEN)-littleriscv -MERGEFLAGS += -m elf$(PLATFORM_RISCV_XLEN)lriscv - -DTSCPPFLAGS = $(CPPFLAGS) -nostdinc -nostdlib -fno-builtin -D__DTS__ -x assembler-with-cpp - -# Setup functions for compilation -define dynamic_flags --I$(shell dirname $(2)) -D__OBJNAME__=$(subst -,_,$(shell basename $(1) .o)) -endef -merge_objs = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " MERGE $(subst $(build_dir)/,,$(1))"; \ - $(LD) $(MERGEFLAGS) $(2) -o $(1) -merge_deps = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " MERGE-DEP $(subst $(build_dir)/,,$(1))"; \ - cat $(2) > $(1) -copy_file = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " COPY $(subst $(build_dir)/,,$(1))"; \ - cp -f $(2) $(1) -inst_file = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " INSTALL $(subst $(install_root_dir)/,,$(1))"; \ - cp -f $(2) $(1) -inst_file_list = $(CMD_PREFIX)if [ ! -z "$(4)" ]; then \ - mkdir -p $(1)/$(3); \ - for file in $(4) ; do \ - rel_file=`echo $$file | sed -e 's@$(2)/$(subst $(install_firmware_path),platform,$(3))@@'`; \ - dest_file=$(1)"/"$(3)"/"`echo $$rel_file`; \ - dest_dir=`dirname $$dest_file`; \ - echo " INSTALL "$(3)"/"`echo $$rel_file`; \ - mkdir -p $$dest_dir; \ - cp -f $$file $$dest_file; \ - done \ - fi -inst_header_dir = $(CMD_PREFIX)mkdir -p $(1); \ - echo " INSTALL $(subst $(install_root_dir)/,,$(1))"; \ - cp -rf $(2) $(1) -compile_cpp = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " CPP $(subst $(build_dir)/,,$(1))"; \ - $(CPP) $(CPPFLAGS) -x c $(2) | grep -v "\#" > $(1) -compile_cc_dep = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " CC-DEP $(subst $(build_dir)/,,$(1))"; \ - printf %s `dirname $(1)`/ > $(1) && \ - $(CC) $(CFLAGS) $(call dynamic_flags,$(1),$(2)) \ - -MM $(2) >> $(1) || rm -f $(1) -compile_cc = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " CC $(subst $(build_dir)/,,$(1))"; \ - $(CC) $(CFLAGS) $(call dynamic_flags,$(1),$(2)) -c $(2) -o $(1) -compile_as_dep = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " AS-DEP $(subst $(build_dir)/,,$(1))"; \ - printf %s `dirname $(1)`/ > $(1) && \ - $(AS) $(ASFLAGS) $(call dynamic_flags,$(1),$(2)) \ - -MM $(2) >> $(1) || rm -f $(1) -compile_as = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " AS $(subst $(build_dir)/,,$(1))"; \ - $(AS) $(ASFLAGS) $(call dynamic_flags,$(1),$(2)) -c $(2) -o $(1) -compile_elf = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " ELF $(subst $(build_dir)/,,$(1))"; \ - $(CC) $(CFLAGS) $(3) $(ELFFLAGS) -Wl,-T$(2) -o $(1) -compile_ar = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " AR $(subst $(build_dir)/,,$(1))"; \ - $(AR) $(ARFLAGS) $(1) $(2) -compile_objcopy = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " OBJCOPY $(subst $(build_dir)/,,$(1))"; \ - $(OBJCOPY) -S -O binary $(2) $(1) -compile_dts = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " DTC $(subst $(build_dir)/,,$(1))"; \ - $(CPP) $(DTSCPPFLAGS) $(2) | $(DTC) -O dtb -i `dirname $(2)` -o $(1) -compile_d2c = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " D2C $(subst $(build_dir)/,,$(1))"; \ - $(if $($(2)-varalign-$(3)),$(eval D2C_ALIGN_BYTES := $($(2)-varalign-$(3))),$(eval D2C_ALIGN_BYTES := $(4))) \ - $(if $($(2)-varprefix-$(3)),$(eval D2C_NAME_PREFIX := $($(2)-varprefix-$(3))),$(eval D2C_NAME_PREFIX := $(5))) \ - $(if $($(2)-padding-$(3)),$(eval D2C_PADDING_BYTES := $($(2)-padding-$(3))),$(eval D2C_PADDING_BYTES := 0)) \ - $(src_dir)/scripts/d2c.sh -i $(6) -a $(D2C_ALIGN_BYTES) -p $(D2C_NAME_PREFIX) -t $(D2C_PADDING_BYTES) > $(1) -compile_gen_dep = $(CMD_PREFIX)mkdir -p `dirname $(1)`; \ - echo " GEN-DEP $(subst $(build_dir)/,,$(1))"; \ - echo "$(1:.dep=$(2)): $(3)" >> $(1) - -targets-y = $(build_dir)/lib/libsbi.a -targets-y += $(build_dir)/lib/libsbiutils.a -ifdef PLATFORM -targets-y += $(platform_build_dir)/lib/libplatsbi.a -endif -targets-y += $(firmware-bins-path-y) - -# Default rule "make" should always be first rule -.PHONY: all -all: $(targets-y) - -# Preserve all intermediate files -.SECONDARY: - -$(build_dir)/lib/libsbi.a: $(libsbi-objs-path-y) - $(call compile_ar,$@,$^) - -$(build_dir)/lib/libsbiutils.a: $(libsbi-objs-path-y) $(libsbiutils-objs-path-y) - $(call compile_ar,$@,$^) - -$(platform_build_dir)/lib/libplatsbi.a: $(libsbi-objs-path-y) $(libsbiutils-objs-path-y) $(platform-objs-path-y) - $(call compile_ar,$@,$^) - -$(build_dir)/%.dep: $(src_dir)/%.c - $(call compile_cc_dep,$@,$<) - -$(build_dir)/%.o: $(src_dir)/%.c - $(call compile_cc,$@,$<) - -$(build_dir)/%.dep: $(src_dir)/%.S - $(call compile_as_dep,$@,$<) - -$(build_dir)/%.o: $(src_dir)/%.S - $(call compile_as,$@,$<) - -$(platform_build_dir)/%.bin: $(platform_build_dir)/%.elf - $(call compile_objcopy,$@,$<) - -$(platform_build_dir)/%.elf: $(platform_build_dir)/%.o $(platform_build_dir)/%.elf.ld $(platform_build_dir)/lib/libplatsbi.a - $(call compile_elf,$@,$@.ld,$< $(platform_build_dir)/lib/libplatsbi.a) - -$(platform_build_dir)/%.ld: $(src_dir)/%.ldS - $(call compile_cpp,$@,$<) - -$(platform_build_dir)/%.dep: $(platform_src_dir)/%.c - $(call compile_cc_dep,$@,$<) - -$(platform_build_dir)/%.o: $(platform_src_dir)/%.c - $(call compile_cc,$@,$<) - -$(platform_build_dir)/%.o: $(platform_build_dir)/%.c - $(call compile_cc,$@,$<) - -$(platform_build_dir)/%.dep: $(platform_src_dir)/%.S - $(call compile_as_dep,$@,$<) - -$(platform_build_dir)/%.o: $(platform_src_dir)/%.S - $(call compile_as,$@,$<) - -$(platform_build_dir)/%.dep: $(platform_src_dir)/%.dts - $(call compile_gen_dep,$@,.dtb,$<) - $(call compile_gen_dep,$@,.c,$(@:.dep=.dtb)) - $(call compile_gen_dep,$@,.o,$(@:.dep=.c)) - -$(platform_build_dir)/%.c: $(platform_build_dir)/%.dtb - $(call compile_d2c,$@,platform,$(subst .dtb,.o,$(subst /,-,$(subst $(platform_build_dir)/,,$<))),16,dt,$<) - -$(platform_build_dir)/%.dtb: $(platform_src_dir)/%.dts - $(call compile_dts,$@,$<) - -$(platform_build_dir)/%.dep: $(src_dir)/%.c - $(call compile_cc_dep,$@,$<) - -$(platform_build_dir)/%.o: $(src_dir)/%.c - $(call compile_cc,$@,$<) - -$(platform_build_dir)/%.dep: $(src_dir)/%.S - $(call compile_as_dep,$@,$<) - -$(platform_build_dir)/%.o: $(src_dir)/%.S - $(call compile_as,$@,$<) - -# Rule for "make docs" -$(build_dir)/docs/latex/refman.pdf: $(build_dir)/docs/latex/refman.tex - $(CMD_PREFIX)mkdir -p $(build_dir)/docs - $(CMD_PREFIX)$(MAKE) -C $(build_dir)/docs/latex -$(build_dir)/docs/latex/refman.tex: $(build_dir)/docs/doxygen.cfg - $(CMD_PREFIX)mkdir -p $(build_dir)/docs - $(CMD_PREFIX)doxygen $(build_dir)/docs/doxygen.cfg -$(build_dir)/docs/doxygen.cfg: $(src_dir)/docs/doxygen.cfg - $(CMD_PREFIX)mkdir -p $(build_dir)/docs - $(CMD_PREFIX)cat docs/doxygen.cfg | sed -e "s#@@SRC_DIR@@#$(src_dir)#" -e "s#@@BUILD_DIR@@#$(build_dir)#" -e "s#@@OPENSBI_MAJOR@@#$(OPENSBI_VERSION_MAJOR)#" -e "s#@@OPENSBI_MINOR@@#$(OPENSBI_VERSION_MINOR)#" > $(build_dir)/docs/doxygen.cfg -.PHONY: docs -docs: $(build_dir)/docs/latex/refman.pdf - -# Dependency files should only be included after default Makefile rules -# They should not be included for any "xxxconfig" or "xxxclean" rule -all-deps-1 = $(if $(findstring config,$(MAKECMDGOALS)),,$(deps-y)) -all-deps-2 = $(if $(findstring clean,$(MAKECMDGOALS)),,$(all-deps-1)) --include $(all-deps-2) - -# Include external dependency of firmwares after default Makefile rules -include $(src_dir)/firmware/external_deps.mk - -# Convenient "make run" command for emulated platforms -.PHONY: run -run: all -ifneq ($(platform-runcmd),) - $(platform-runcmd) $(RUN_ARGS) -else -ifdef PLATFORM - @echo "Platform $(PLATFORM) doesn't specify a run command" - @false -else - @echo Run command only available when targeting a platform - @false -endif -endif - -install_targets-y = install_libsbi -install_targets-y += install_libsbiutils -ifdef PLATFORM -install_targets-y += install_libplatsbi -install_targets-y += install_firmwares -endif - -# Rule for "make install" -.PHONY: install -install: $(install_targets-y) - -.PHONY: install_libsbi -install_libsbi: $(build_dir)/lib/libsbi.a - $(call inst_header_dir,$(install_root_dir)/$(install_include_path),$(include_dir)/sbi) - $(call inst_file,$(install_root_dir)/$(install_lib_path)/libsbi.a,$(build_dir)/lib/libsbi.a) - -.PHONY: install_libsbiutils -install_libsbiutils: $(build_dir)/lib/libsbiutils.a - $(call inst_header_dir,$(install_root_dir)/$(install_include_path),$(include_dir)/sbi_utils) - $(call inst_file,$(install_root_dir)/$(install_lib_path)/libsbiutils.a,$(build_dir)/lib/libsbiutils.a) - -.PHONY: install_libplatsbi -install_libplatsbi: $(platform_build_dir)/lib/libplatsbi.a $(build_dir)/lib/libsbi.a $(build_dir)/lib/libsbiutils.a - $(call inst_file,$(install_root_dir)/$(install_lib_path)/opensbi/$(platform_subdir)/lib/libplatsbi.a,$(platform_build_dir)/lib/libplatsbi.a) - -.PHONY: install_firmwares -install_firmwares: $(platform_build_dir)/lib/libplatsbi.a $(build_dir)/lib/libsbi.a $(build_dir)/lib/libsbiutils.a $(firmware-bins-path-y) - $(call inst_file_list,$(install_root_dir),$(build_dir),$(install_firmware_path)/$(platform_subdir)/firmware,$(firmware-elfs-path-y)) - $(call inst_file_list,$(install_root_dir),$(build_dir),$(install_firmware_path)/$(platform_subdir)/firmware,$(firmware-bins-path-y)) - -.PHONY: install_docs -install_docs: $(build_dir)/docs/latex/refman.pdf - $(call inst_file,$(install_root_dir)/$(install_docs_path)/refman.pdf,$(build_dir)/docs/latex/refman.pdf) - -# Rule for "make clean" -.PHONY: clean -clean: - $(CMD_PREFIX)mkdir -p $(build_dir) - $(if $(V), @echo " RM $(build_dir)/*.o") - $(CMD_PREFIX)find $(build_dir) -type f -name "*.o" -exec rm -rf {} + - $(if $(V), @echo " RM $(build_dir)/*.a") - $(CMD_PREFIX)find $(build_dir) -type f -name "*.a" -exec rm -rf {} + - $(if $(V), @echo " RM $(build_dir)/*.elf") - $(CMD_PREFIX)find $(build_dir) -type f -name "*.elf" -exec rm -rf {} + - $(if $(V), @echo " RM $(build_dir)/*.bin") - $(CMD_PREFIX)find $(build_dir) -type f -name "*.bin" -exec rm -rf {} + - $(if $(V), @echo " RM $(build_dir)/*.dtb") - $(CMD_PREFIX)find $(build_dir) -type f -name "*.dtb" -exec rm -rf {} + - -# Rule for "make distclean" -.PHONY: distclean -distclean: clean - $(CMD_PREFIX)mkdir -p $(build_dir) - $(if $(V), @echo " RM $(build_dir)/*.dep") - $(CMD_PREFIX)find $(build_dir) -type f -name "*.dep" -exec rm -rf {} + -ifeq ($(build_dir),$(CURDIR)/build) - $(if $(V), @echo " RM $(build_dir)") - $(CMD_PREFIX)rm -rf $(build_dir) -endif -ifeq ($(install_root_dir),$(install_root_dir_default)/usr) - $(if $(V), @echo " RM $(install_root_dir_default)") - $(CMD_PREFIX)rm -rf $(install_root_dir_default) -endif diff --git a/bsp/k230/opensbi/README.md b/bsp/k230/opensbi/README.md deleted file mode 100644 index 03c02fb1c37..00000000000 --- a/bsp/k230/opensbi/README.md +++ /dev/null @@ -1,286 +0,0 @@ -RISC-V Open Source Supervisor Binary Interface (OpenSBI) -======================================================== - -Copyright and License ---------------------- - -The OpenSBI project is copyright (c) 2019 Western Digital Corporation -or its affiliates and other contributors. - -It is distributed under the terms of the BSD 2-clause license -("Simplified BSD License" or "FreeBSD License", SPDX: *BSD-2-Clause*). -A copy of this license with OpenSBI copyright can be found in the file -[COPYING.BSD]. - -All source files in OpenSBI contain the 2-Clause BSD license SPDX short -identifier in place of the full license text. - -``` -SPDX-License-Identifier: BSD-2-Clause -``` - -This enables machine processing of license information based on the SPDX -License Identifiers that are available on the [SPDX] web site. - -OpenSBI source code also contains code reused from other projects as listed -below. The original license text of these projects is included in the source -files where the reused code is present. - -* The libfdt source code is disjunctively dual licensed - (GPL-2.0+ OR BSD-2-Clause). Some of this project code is used in OpenSBI - under the terms of the BSD 2-Clause license. Any contributions to this - code must be made under the terms of both licenses. - -See also the [third party notices] file for more information. - -Introduction ------------- - -The **RISC-V Supervisor Binary Interface (SBI)** is the recommended interface -between: - -1. A platform-specific firmware running in M-mode and a bootloader, a - hypervisor or a general-purpose OS executing in S-mode or HS-mode. -2. A hypervisor running in HS-mode and a bootloader or a general-purpose OS - executing in VS-mode. - -The *RISC-V SBI specification* is maintained as an independent project by the -RISC-V Foundation on [Github]. - -The goal of the OpenSBI project is to provide an open-source reference -implementation of the RISC-V SBI specifications for platform-specific firmwares -executing in M-mode (case 1 mentioned above). An OpenSBI implementation can be -easily extended by RISC-V platform and system-on-chip vendors to fit a -particular hardware configuration. - -The main component of OpenSBI is provided in the form of a platform-independent -static library **libsbi.a** implementing the SBI interface. A firmware or -bootloader implementation can link against this library to ensure conformance -with the SBI interface specifications. *libsbi.a* also defines an interface for -integrating with platform-specific operations provided by the platform firmware -implementation (e.g. console access functions, inter-processor interrupt -control, etc). - -To illustrate the use of the *libsbi.a* library, OpenSBI also provides a set of -platform-specific support examples. For each example, a platform-specific -static library *libplatsbi.a* can be compiled. This library implements -SBI call processing by integrating *libsbi.a* with the necessary -platform-dependent hardware manipulation functions. For all supported platforms, -OpenSBI also provides several runtime firmware examples built using the platform -*libplatsbi.a*. These example firmwares can be used to replace the legacy -*riscv-pk* bootloader (aka BBL) and enable the use of well-known bootloaders -such as [U-Boot]. - -Supported SBI version ---------------------- -Currently, OpenSBI fully supports SBI specification *v0.2*. OpenSBI also -supports Hart State Management (HSM) SBI extension starting from OpenSBI v0.7. -HSM extension allows S-mode software to boot all the harts a defined order -rather than legacy method of random booting of harts. As a result, many -required features such as CPU hotplug, kexec/kdump can also be supported easily -in S-mode. HSM extension in OpenSBI is implemented in a non-backward compatible -manner to reduce the maintenance burden and avoid confusion. That's why, any -S-mode software using OpenSBI will not be able to boot more than 1 hart if HSM -extension is not supported in S-mode. - -Linux kernel already supports SBI v0.2 and HSM SBI extension starting from -**v5.7-rc1**. If you are using an Linux kernel older than **5.7-rc1** or any -other S-mode software without HSM SBI extension, you should stick to OpenSBI -v0.6 to boot all the harts. For a UMP systems, it doesn't matter. - -N.B. Any S-mode boot loader (i.e. U-Boot) doesn't need to support HSM extension, -as it doesn't need to boot all the harts. The operating system should be -capable enough to bring up all other non-booting harts using HSM extension. - -Required Toolchain ------------------- - -OpenSBI can be compiled natively or cross-compiled on a x86 host. For -cross-compilation, you can build your own toolchain or just download -a prebuilt one from the [Bootlin toolchain repository]. - -Please note that only a 64-bit version of the toolchain is available in -the Bootlin toolchain repository for now. - -Building and Installing the OpenSBI Platform-Independent Library ----------------------------------------------------------------- - -The OpenSBI platform-independent static library *libsbi.a* can be compiled -natively or it can be cross-compiled on a host with a different base -architecture than RISC-V. - -For cross-compiling, the environment variable *CROSS_COMPILE* must be defined -to specify the name prefix of the RISC-V compiler toolchain executables, e.g. -*riscv64-unknown-elf-* if the gcc executable used is *riscv64-unknown-elf-gcc*. - -To build *libsbi.a* simply execute: -``` -make -``` - -All compiled binaries as well as the resulting *libsbi.a* static library file -will be placed in the *build/lib* directory. To specify an alternate build root -directory path, run: -``` -make O= -``` - -To generate files to be installed for using *libsbi.a* in other projects, run: -``` -make install -``` - -This will create the *install* directory with all necessary include files -copied under the *install/include* directory and the library file copied into -the *install/lib* directory. To specify an alternate installation root -directory path, run: -``` -make I= install -``` - -Building and Installing a Reference Platform Static Library and Firmware ------------------------------------------------------------------------- - -When the *PLATFORM=* argument is specified on the make command -line, the platform-specific static library *libplatsbi.a* and firmware examples -are built for the platform ** present in the directory -*platform* in the OpenSBI top directory. For example, to compile the platform -library and the firmware examples for the QEMU RISC-V *virt* machine, -** should be *generic*. - -To build *libsbi.a*, *libplatsbi.a* and the firmware for one of the supported -platforms, run: -``` -make PLATFORM= -``` - -An alternate build directory path can also be specified: -``` -make PLATFORM= O= -``` - -The platform-specific library *libplatsbi.a* will be generated in the -*build/platform//lib* directory. The platform firmware files -will be under the *build/platform//firmware* directory. -The compiled firmwares will be available in two different formats: an ELF file -and an expanded image file. - -To install *libsbi.a*, *libplatsbi.a*, and the compiled firmwares, run: -``` -make PLATFORM= install -``` - -This will copy the compiled platform-specific libraries and firmware files -under the *install/platform//* directory. An alternate -install root directory path can be specified as follows: -``` -make PLATFORM= I= install -``` - -In addition, platform-specific configuration options can be specified with the -top-level make command line. These options, such as *PLATFORM_* or -*FW_*, are platform-specific and described in more details in the -*docs/platform/.md* files and -*docs/firmware/.md* files. - -Building 32-bit / 64-bit OpenSBI Images ---------------------------------------- -By default, building OpenSBI generates 32-bit or 64-bit images based on the -supplied RISC-V cross-compile toolchain. For example if *CROSS_COMPILE* is set -to *riscv64-unknown-elf-*, 64-bit OpenSBI images will be generated. If building -32-bit OpenSBI images, *CROSS_COMPILE* should be set to a toolchain that is -pre-configured to generate 32-bit RISC-V codes, like *riscv32-unknown-elf-*. - -However it's possible to explicitly specify the image bits we want to build with -a given RISC-V toolchain. This can be done by setting the environment variable -*PLATFORM_RISCV_XLEN* to the desired width, for example: - -``` -export CROSS_COMPILE=riscv64-unknown-elf- -export PLATFORM_RISCV_XLEN=32 -``` - -will generate 32-bit OpenSBI images. And vice vesa. - -Contributing to OpenSBI ------------------------ - -The OpenSBI project encourages and welcomes contributions. Contributions should -follow the rules described in the OpenSBI [Contribution Guideline] document. -In particular, all patches sent should contain a Signed-off-by tag. - -The [Contributors List] document provides a list of individuals and -organizations actively contributing to the OpenSBI project. - -Documentation -------------- - -Detailed documentation of various aspects of OpenSBI can be found under the -*docs* directory. The documentation covers the following topics. - -* [Contribution Guideline]: Guideline for contributing code to OpenSBI project -* [Library Usage]: API documentation of OpenSBI static library *libsbi.a* -* [Platform Requirements]: Requirements for using OpenSBI on a platform -* [Platform Support Guide]: Guideline for implementing support for new platforms -* [Platform Documentation]: Documentation of the platforms currently supported. -* [Firmware Documentation]: Documentation for the different types of firmware - examples build supported by OpenSBI. -* [Domain Support]: Documentation for the OpenSBI domain support which helps - users achieve system-level partitioning using OpenSBI. - -OpenSBI source code is also well documented. For source level documentation, -doxygen style is used. Please refer to the [Doxygen manual] for details on this -format. - -Doxygen can be installed on Linux distributions using *.deb* packages using -the following command. -``` -sudo apt-get install doxygen doxygen-latex doxygen-doc doxygen-gui graphviz -``` - -For *.rpm* based Linux distributions, the following commands can be used. -``` -sudo yum install doxygen doxygen-latex doxywizard graphviz -``` -or -``` -sudo yum install doxygen doxygen-latex doxywizard graphviz -``` - -To build a consolidated *refman.pdf* of all documentation, run: -``` -make docs -``` -or -``` -make O= docs -``` - -the resulting *refman.pdf* will be available under the directory -*/docs/latex*. To install this file, run: -``` -make install_docs -``` -or -``` -make I= install_docs -``` - -*refman.pdf* will be installed under */docs*. - -[Github]: https://github.com/riscv/riscv-sbi-doc -[U-Boot]: https://www.denx.de/wiki/U-Boot/SourceCode -[Bootlin toolchain repository]: https://toolchains.bootlin.com/ -[COPYING.BSD]: COPYING.BSD -[SPDX]: http://spdx.org/licenses/ -[Contribution Guideline]: docs/contributing.md -[Contributors List]: CONTRIBUTORS.md -[Library Usage]: docs/library_usage.md -[Platform Requirements]: docs/platform_requirements.md -[Platform Support Guide]: docs/platform_guide.md -[Platform Documentation]: docs/platform/platform.md -[Firmware Documentation]: docs/firmware/fw.md -[Domain Support]: docs/domain_support.md -[Doxygen manual]: http://www.doxygen.nl/manual/index.html -[Kendryte standalone SDK]: https://github.com/kendryte/kendryte-standalone-sdk -[third party notices]: ThirdPartyNotices.md diff --git a/bsp/k230/opensbi/ThirdPartyNotices.md b/bsp/k230/opensbi/ThirdPartyNotices.md deleted file mode 100644 index 1162d43611b..00000000000 --- a/bsp/k230/opensbi/ThirdPartyNotices.md +++ /dev/null @@ -1,18 +0,0 @@ -Copyright (c) 2019 Western Digital Corporation or its affiliates. - -Third Party Notices -=================== - -This project includes or partly uses code from the following open source -software subject to the following open source licenses. - -libfdt ------- - -Copyright (C) 2016 Free Electrons -Copyright (C) 2016 NextThing Co. - -The libfdt source code is disjunctively dual licensed (GPL-2.0+ or -BSD-2-Clause). Some of this project code is used in OpenSBI under the terms of -the BSD 2-Clause license. The full text of this license can be found in the -file [COPYING.BSD](COPYING.BSD). diff --git a/bsp/k230/opensbi/build_env.sh b/bsp/k230/opensbi/build_env.sh deleted file mode 100644 index 746d7e1c709..00000000000 --- a/bsp/k230/opensbi/build_env.sh +++ /dev/null @@ -1,5 +0,0 @@ -#/bin/sh -cp ../kernel/bsp/maix3/rtthread.bin ./ -export CROSS_COMPILE=~/.tools/gnu_gcc/riscv64-linux-musleabi_for_x86_64-pc-linux-gnu/bin/riscv64-unknown-linux-musl- -export PLATFORM=kendryte/fpgac908 -make FW_PAYLOAD_PATH=rtthread.bin FW_FDT_PATH=hw.dtb diff --git a/bsp/k230/opensbi/docs/contributing.md b/bsp/k230/opensbi/docs/contributing.md deleted file mode 100644 index 9c2b3ba2c81..00000000000 --- a/bsp/k230/opensbi/docs/contributing.md +++ /dev/null @@ -1,84 +0,0 @@ -OpenSBI Contribution Guideline -============================== - -All contributions to OpenSBI can be sent in the following ways: -1. Email patches to the OpenSBI mailing list at `opensbi@lists.infradead.org` -2. GitHub Pull Requests (PRs) to the [OpenSBI main repository] - -To join the OpenSBI mailing list, please visit the [OpenSBI infradead page]. - -The OpenSBI maintainers prefer patches via the OpenSBI mailing list -(option 1 above) so that they are visible to a wider audience. All -accepted patches on the OpenSBI mailing list will be taken by any of -the OpenSBI maintainers and merged into the [OpenSBI main repository] -using GitHub PRs. - -All contributed work must follow the following rules: -1. OpenSBI code should be written in accordance to the [Linux coding style]. -2. This project embraces the [Developer Certificate of Origin (DCO)] for -contributions. This means that you must agree to the following prior to -submitting patches: if you agree with this developer certificate you -acknowledge this by adding a Signed-off-by tag to your patch commit log. -Every submitted patch must have this tag. -3. A commit message must have a subject line, followed by a blank line, -followed by a description of the patch content. A blank line and the author -Signed-off-by tag must follow this description. -4. A commit subject line must start with a prefix followed by a ":". Common -prefixes are for example "lib:", "platform:", "firmware:", "docs:", "utils:" -and "top:". -5. Maintainers should use "Rebase and Merge" when using GitHub to merge pull -requests to avoid creating unnecessary merge commits. -6. Maintainers should avoid creating branches directly in the main -riscv/opensbi repository. Instead prefer using a fork of the riscv/opensbi main -repository and branches within that fork to create pull requests. -7. A maintainer cannot merge his own pull requests in the riscv/opensbi main -repository. -8. A pull request must get at least one review from a maintainer. -9. A pull request must spend at least 24 hours in review to allow for other -developers to review. - ------------------------------------------------------------------------ - -Developer Certificate of Origin -Version 1.1 - -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -660 York Street, Suite 102, -San Francisco, CA 94110 USA - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - - -Developer's Certificate of Origin 1.1 - -By making a contribution to this project, I certify that: - -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. - ------------------------------------------------------------------------ - -[OpenSBI main repository]: https://github.com/riscv/opensbi -[OpenSBI infradead page]: http://lists.infradead.org/mailman/listinfo/opensbi -[Linux coding style]: https://www.kernel.org/doc/html/v4.10/process/coding-style.html -[Developer Certificate of Origin (DCO)]: http://developercertificate.org/ diff --git a/bsp/k230/opensbi/docs/domain_support.md b/bsp/k230/opensbi/docs/domain_support.md deleted file mode 100644 index 73931f1da70..00000000000 --- a/bsp/k230/opensbi/docs/domain_support.md +++ /dev/null @@ -1,314 +0,0 @@ -OpenSBI Domain Support -====================== - -An OpenSBI domain is a system-level partition (subset) of underlying hardware -having it's own memory regions (RAM and MMIO devices) and HARTs. The OpenSBI -will try to achieve secure isolation between domains using RISC-V platform -features such as PMP, ePMP, IOPMP, SiFive Shield, etc. - -Important entities which help implement OpenSBI domain support are: - -* **struct sbi_domain_memregion** - Representation of a domain memory region -* **struct sbi_hartmask** - Representation of domain HART set -* **struct sbi_domain** - Representation of a domain instance - -Each HART of a RISC-V platform must have an OpenSBI domain assigned to it. -The OpenSBI platform support is responsible for populating domains and -providing HART id to domain mapping. The OpenSBI domain support will by -default assign **the ROOT domain** to all HARTs of a RISC-V platform so -it is not mandatory for the OpenSBI platform support to populate domains. - -Domain Memory Region --------------------- - -A domain memory region is represented by **struct sbi_domain_memregion** in -OpenSBI and has following details: - -* **order** - The size of a memory region is **2 ^ order** where **order** - must be **3 <= order <= __riscv_xlen** -* **base** - The base address of a memory region is **2 ^ order** - aligned start address -* **flags** - The flags of a memory region represent memory type (i.e. - RAM or MMIO) and allowed accesses (i.e. READ, WRITE, EXECUTE, etc) - -Domain Instance ---------------- - -A domain instance is represented by **struct sbi_domain** in OpenSBI and -has following details: - -* **index** - Logical index of this domain -* **name** - Name of this domain -* **assigned_harts** - HARTs assigned to this domain -* **possible_harts** - HARTs possible in this domain -* **regions** - Array of memory regions terminated by a memory region - with order zero -* **boot_hartid** - HART id of the HART booting this domain. The domain - boot HART will be started at boot-time if boot HART is possible and - assigned for this domain. -* **next_addr** - Address of the next booting stage for this domain -* **next_arg1** - Arg1 (or 'a1' register) of the next booting stage for - this domain -* **next_mode** - Privilege mode of the next booting stage for this - domain. This can be either S-mode or U-mode. -* **system_reset_allowed** - Is domain allowed to reset the system? - -The memory regions represented by **regions** in **struct sbi_domain** have -following additional constraints to align with RISC-V PMP requirements: - -* A memory region to protect OpenSBI firmware from S-mode and U-mode - should always be present -* For two overlapping memory regions, one should be sub-region of another -* Two overlapping memory regions should not be of same size -* Two overlapping memory regions cannot have same flags -* Memory access checks on overlapping address should prefer smallest - overlapping memory region flags. - -ROOT Domain ------------ - -**The ROOT domain** is the default OpenSBI domain which is assigned by -default to all HARTs of a RISC-V platform. The OpenSBI domain support -will hand-craft **the ROOT domain** very early at boot-time in the -following manner: - -* **index** - Logical index of the ROOT domain is always zero -* **name** - Name of the ROOT domain is "root" -* **assigned_harts** - At boot-time all valid HARTs of a RISC-V platform - are assigned the ROOT domain which changes later based on OpenSBI - platform support -* **possible_harts** - All valid HARTs of a RISC-V platform are possible - HARTs of the ROOT domain -* **regions** - Two memory regions available to the ROOT domain: - **A)** A memory region to protect OpenSBI firmware from S-mode and U-mode - **B)** A memory region of **order=__riscv_xlen** allowing S-mode and - U-mode access to full memory address space -* **boot_hartid** - Coldboot HART is the HART booting the ROOT domain -* **next_addr** - Next booting stage address in coldboot HART scratch - space is the next address for the ROOT domain -* **next_arg1** - Next booting stage arg1 in coldboot HART scratch space - is the next arg1 for the ROOT domain -* **next_mode** - Next booting stage mode in coldboot HART scratch space - is the next mode for the ROOT domain -* **system_reset_allowed** - The ROOT domain is allowed to reset the system - -Domain Effects --------------- - -Few noteworthy effects of a system partitioned into domains are as follows: - -* At any point in time, a HART is running in exactly one OpenSBI domain context -* The SBI IPI and RFENCE calls from HART A are restricted to the HARTs in - domain assigned to HART A -* The SBI HSM calls which try to change/read state of HART B from HART A will - only work if both HART A and HART B are assigned same domain -* A HART running in S-mode or U-mode can only access memory based on the - memory regions of the domain assigned to the HART - -Domain Device Tree Bindings ---------------------------- - -The OpenSBI domains can be described in the **device tree (DT) blob** (or -flattened device tree) passed to the OpenSBI firmwares by the previous -booting stage. This allows OpenSBI platform support to parse and populate -OpenSBI domains from the device tree blob (or flattened device tree). - -### Domain Configuration Node - -All OpenSBI domain description related DT nodes should be under the domain -configuration DT node. The **/chosen** DT node is the preferred parent of -the domain configuration DT node. - -The DT properties of a domain configuration DT node are as follows: - -* **compatible** (Mandatory) - The compatible string of the domain - configuration. This DT property should have value *"opensbi,domain,config"* - -### Domain Memory Region Node - -The domain memory region DT node describes details of a memory region and -can be pointed by multiple domain instance DT nodes. The access permissions -of the memory region are specified separately in domain instance node. - -The DT properties of a domain memory region DT node are as follows: - -* **compatible** (Mandatory) - The compatible string of the domain memory - region. This DT property should have value *"opensbi,domain,memregion"* -* **base** (Mandatory) - The base address of the domain memory region. This - DT property should have a **2 ^ order** aligned 64 bit address (i.e. two - DT cells). -* **order** (Mandatory) - The order of the domain memory region. This DT - property should have a 32 bit value (i.e. one DT cell) in the range - **3 <= order <= __riscv_xlen**. -* **mmio** (Optional) - A boolean flag representing whether the domain - memory region is a memory-mapped I/O (MMIO) region. -* **devices** (Optional) - The list of device DT node phandles for devices - which fall under this domain memory region. - -### Domain Instance Node - -The domain instance DT node describes set of possible HARTs, set of memory -regions, and other details of a domain instance. - -The DT properties of a domain instance DT node are as follows: - -* **compatible** (Mandatory) - The compatible string of the domain instance. - This DT property should have value *"opensbi,domain,instance"* -* **possible-harts** (Optional) - The list of CPU DT node phandles for the - the domain instance. This list represents the possible HARTs of the - domain instance. -* **regions** (Optional) - The list of domain memory region DT node phandle - and access permissions for the domain instance. Each list entry is a pair - of DT node phandle and access permissions. The access permissions are - represented as a 32bit bitmask having bits: **readable** (BIT[0]), - **writeable** (BIT[1]), **executable** (BIT[2]), and **m-mode** (BIT[3]). -* **boot-hart** (Optional) - The DT node phandle of the HART booting the - domain instance. If coldboot HART is assigned to the domain instance then - this DT property is ignored and the coldboot HART is assumed to be the - boot HART of the domain instance. -* **next-arg1** (Optional) - The 64 bit next booting stage arg1 for the - domain instance. If this DT property is not available and coldboot HART - is not assigned to the domain instance then **0x0** is used as default - value. If this DT property is not available and coldboot HART is assigned - to the domain instance then **next booting stage arg1 of coldboot HART** - is used as default value. -* **next-addr** (Optional) - The 64 bit next booting stage address for the - domain instance. If this DT property is not available and coldboot HART - is not assigned to the domain instance then **0x0** is used as default - value. If this DT property is not available and coldboot HART is assigned - to the domain instance then **next booting stage address of coldboot HART** - is used as default value. -* **next-mode** (Optional) - The 32 bit next booting stage mode for the - domain instance. The possible values of this DT property are: **0x1** - (s-mode), and **0x0** (u-mode). If this DT property is not available - and coldboot HART is not assigned to the domain instance then **0x1** - is used as default value. If this DT property is not available and - coldboot HART is assigned to the domain instance then **next booting - stage mode of coldboot HART** is used as default value. -* **system-reset-allowed** (Optional) - A boolean flag representing - whether the domain instance is allowed to do system reset. - -### Assigning HART To Domain Instance - -By default, all HARTs are assigned to **the ROOT domain**. The OpenSBI -platform support can provide the HART to domain instance assignment using -platform specific callback. - -The HART to domain instance assignment can be parsed from the device tree -using optional DT property **opensbi,domain** in each CPU DT node. The -value of DT property **opensbi,domain** is the DT phandle of the domain -instance DT node. If **opensbi,domain** DT property is not specified then -corresponding HART is assigned to **the ROOT domain**. - -### Domain Configuration Only Accessible to OpenSBI - -The software running inside a domain instance should only be aware of -devices and hardware resources accessible to itself. - -To hide domain configuration from domain instances, the following should -be done: - -* The previous booting stage should preferably provide a separate device - tree for each domain instance and mention location of device tree in - respective domain instance DT nodes using **next-arg1** DT property. -* If domain assigned to a HART does not have separate device tree then - OpenSBI platform support should remove all domain configuration details - from the device tree passed by previous booting stage before passing it - to the next booting stage. - -### Example - -``` - chosen { - opensbi-domains { - compatible = "opensbi,domain,config"; - - tmem: tmem { - compatible = "opensbi,domain,memregion"; - base = <0x0 0x80100000>; - order = <20>; - }; - - tuart: tuart { - compatible = "opensbi,domain,memregion"; - base = <0x0 0x10011000>; - order = <12>; - mmio; - devices = <&uart1>; - }; - - allmem: allmem { - compatible = "opensbi,domain,memregion"; - base = <0x0 0x0>; - order = <64>; - }; - - tdomain: trusted-domain { - compatible = "opensbi,domain,instance"; - possible-harts = <&cpu0>; - regions = <&tmem 0x7>, <&tuart 0x7>; - boot-hart = <&cpu0>; - next-arg1 = <0x0 0x0>; - next-addr = <0x0 0x80100000>; - next-mode = <0x0>; - system-reset-allowed; - }; - - udomain: untrusted-domain { - compatible = "opensbi,domain,instance"; - possible-harts = <&cpu1 &cpu2 &cpu3 &cpu4>; - regions = <&tmem 0x0>, <&tuart 0x0>, <&allmem 0x7>; - }; - }; - }; - - cpus { - #address-cells = <1>; - #size-cells = <0>; - timebase-frequency = <10000000>; - - cpu0: cpu@0 { - device_type = "cpu"; - reg = <0x00>; - compatible = "riscv"; - opensbi-domain = <&tdomain>; - ... - }; - - cpu1: cpu@1 { - device_type = "cpu"; - reg = <0x01>; - compatible = "riscv"; - opensbi-domain = <&udomain>; - ... - }; - - cpu2: cpu@2 { - device_type = "cpu"; - reg = <0x02>; - compatible = "riscv"; - opensbi-domain = <&udomain>; - ... - }; - - cpu3: cpu@3 { - device_type = "cpu"; - reg = <0x03>; - compatible = "riscv"; - opensbi-domain = <&udomain>; - ... - }; - - cpu4: cpu@4 { - device_type = "cpu"; - reg = <0x04>; - compatible = "riscv"; - opensbi-domain = <&udomain>; - ... - }; - }; - - uart1: serial@10011000 { - ... - }; -``` diff --git a/bsp/k230/opensbi/docs/doxygen.cfg b/bsp/k230/opensbi/docs/doxygen.cfg deleted file mode 100644 index 82f31a7ae6f..00000000000 --- a/bsp/k230/opensbi/docs/doxygen.cfg +++ /dev/null @@ -1,2462 +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 = "RISC-V OpenSBI" - -# 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 = "v@@OPENSBI_MAJOR@@.@@OPENSBI_MINOR@@" - -# 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 = "Open source implemenation of the supervisor binary interface" - -# 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_DIR@@/docs - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES, upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = 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 = @@SRC_DIR@@/README.md \ - @@SRC_DIR@@/docs/contributing.md \ - @@SRC_DIR@@/docs/platform_guide.md \ - @@SRC_DIR@@/docs/platform_requirements.md \ - @@SRC_DIR@@/docs/library_usage.md \ - @@SRC_DIR@@/docs/domain_support.md \ - @@SRC_DIR@@/docs/firmware \ - @@SRC_DIR@@/docs/platform \ - @@SRC_DIR@@/include \ - @@SRC_DIR@@/lib - -# 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 \ - *.h \ - *.md - -# 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 = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = README.md - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see 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 = YES - -# 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 -# , /