From 8e8eca9a66fc5c0dad9c935ba17a68a3cc1e1324 Mon Sep 17 00:00:00 2001 From: Christopher Seidl Date: Tue, 25 Feb 2025 11:39:35 +0100 Subject: [PATCH 1/3] Update for doxygen 1.13.2 --- .github/workflows/pack.yaml | 2 +- Documentation/Doxygen/driver.dxy.in | 1059 ++++-- Documentation/Doxygen/gen_doc.sh | 4 +- Documentation/Doxygen/style_template/bdwn.png | Bin 0 -> 147 bytes .../Doxygen/style_template/extra_search.css | 49 + .../style_template/extra_stylesheet.css | 3152 +++++++++-------- .../Doxygen/style_template/layout.xml | 2 +- .../Doxygen/style_template/search.css | 216 +- 8 files changed, 2603 insertions(+), 1881 deletions(-) create mode 100644 Documentation/Doxygen/style_template/bdwn.png create mode 100644 Documentation/Doxygen/style_template/extra_search.css diff --git a/.github/workflows/pack.yaml b/.github/workflows/pack.yaml index 0ee6b33..0c91ba8 100644 --- a/.github/workflows/pack.yaml +++ b/.github/workflows/pack.yaml @@ -27,7 +27,7 @@ jobs: - uses: Open-CMSIS-Pack/gen-pack-action@main with: - doxygen-version: 1.9.6 + doxygen-version: 1.13.2 packchk-version: 1.4.1 gen-doc-script: ./Documentation/Doxygen/gen_doc.sh doc-path: ./Documentation/html diff --git a/Documentation/Doxygen/driver.dxy.in b/Documentation/Doxygen/driver.dxy.in index 0e1ff2b..5fe4d9c 100644 --- a/Documentation/Doxygen/driver.dxy.in +++ b/Documentation/Doxygen/driver.dxy.in @@ -1,7 +1,7 @@ -# Doxyfile 1.9.2 +# Doxyfile 1.13.2 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. +# 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. @@ -12,6 +12,16 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use Doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use Doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options @@ -41,7 +51,7 @@ PROJECT_NAME = "CMSIS-Driver Implementations" PROJECT_NUMBER = "Version {projectNumber}" # 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 +# for a project that appears at the top of each page and should give viewers a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "MCU independent CMSIS-Driver implementations" @@ -53,24 +63,42 @@ PROJECT_BRIEF = "MCU independent CMSIS-Driver implementations" PROJECT_LOGO = style_template/cmsis_logo_white_small.png +# With the PROJECT_ICON tag one can specify an icon that is included in the tabs +# when the HTML document is shown. Doxygen will copy the logo to the output +# directory. + +PROJECT_ICON = + # 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 +# entered, it will be relative to the location where Doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = ../ -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 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 cause +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# 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. @@ -79,28 +107,28 @@ CREATE_SUBDIRS = 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 +# 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. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, 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 +# 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 +# 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 @@ -131,13 +159,13 @@ ABBREVIATE_BRIEF = "The $name class" \ 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 +# 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 +# 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. @@ -145,7 +173,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# 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. @@ -155,14 +183,14 @@ FULL_PATH_NAMES = NO # 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 +# 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. +# 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 = +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 @@ -171,43 +199,44 @@ STRIP_FROM_PATH = # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = +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 +# If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but +# less readable) file names. This can be useful if your file system 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.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the +# first line (until the first dot, question mark or exclamation mark) 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 JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# If the JAVADOC_BANNER tag is set to YES then Doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. +# interpreted by Doxygen. # The default value is: NO. JAVADOC_BANNER = 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.) +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first +# line (until the first dot, question mark or exclamation mark) 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 +# 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 @@ -219,10 +248,10 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO -# By default Python docstrings are displayed as preformatted text and doxygen's +# By default Python docstrings are displayed as preformatted text and Doxygen's # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. +# Doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as Doxygen documentation. # The default value is: YES. PYTHON_DOCSTRING = NO @@ -233,7 +262,7 @@ PYTHON_DOCSTRING = NO INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# 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. @@ -261,7 +290,7 @@ TAB_SIZE = 2 # with the commands \{ and \} for these it is advised to use the version @{ and # @} or use a double escape (\\{ and \\}) -ALIASES = +ALIASES = # 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 @@ -303,30 +332,30 @@ OPTIMIZE_OUTPUT_SLICE = NO # 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, +# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, # VHDL, 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). For instance to make doxygen treat .inc files +# default for Fortran type files). 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. When specifying no_extension you should add +# the files are not read by Doxygen. When specifying no_extension you should add # * to the FILE_PATTERNS. # # Note see also the list of default file extension mappings. EXTENSION_MAPPING = -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# 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 https://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 +# 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. @@ -336,25 +365,45 @@ MARKDOWN_SUPPORT = YES # 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: 5. +# Minimum value: 0, maximum value: 99, default value: 6. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 5 -# When enabled doxygen tries to link words that correspond to documented +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + +# 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. +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. # The default value is: YES. AUTOLINK_SUPPORT = YES +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect affect links explicitly created +# using \# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + # 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 +# 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. +# versus func(std::string) {}). This also makes the inheritance and +# collaboration diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO @@ -366,16 +415,16 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. +# https://www.riverbankcomputing.com/software) 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. +# 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. @@ -384,7 +433,7 @@ SIP_SUPPORT = NO 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 +# 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. @@ -442,18 +491,18 @@ TYPEDEF_HIDES_STRUCT = YES # 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 +# 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 +# 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 -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of +# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use +# during processing. When set to 0 Doxygen will based this on the number of # cores available in the system. You can set it explicitly to a value larger # than 0 to get more control over the balance between CPU load and processing # speed. At this moment only the input processing can be done using multiple @@ -465,11 +514,19 @@ LOOKUP_CACHE_SIZE = 0 NUM_PROC_THREADS = 1 +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = YES + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# 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. @@ -535,7 +592,7 @@ EXTRACT_ANON_NSPACES = NO RESOLVE_UNNAMED_PARAMS = YES -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# 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. @@ -543,22 +600,31 @@ RESOLVE_UNNAMED_PARAMS = YES HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# 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. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# 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. @@ -572,30 +638,31 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be # able to match the capabilities of the underlying filesystem. In case the # filesystem is case sensitive (i.e. it supports files in the same directory # whose names only differ in casing), the option must be set to YES to properly # deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with +# are not case sensitive the option should be set to NO to properly deal with # output files written for symbols that only differ in casing, such as for two # classes, one named CLASS and the other named Class, and to also support # references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option +# Windows (including Cygwin) and macOS, users should typically set this option # to NO, whereas on Linux or other Unix flavors it should typically be set to # YES. -# The default value is: system dependent. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# 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 +# 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. @@ -608,7 +675,7 @@ HIDE_COMPOUND_REFERENCE= NO SHOW_HEADERFILE = YES -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# 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. @@ -621,7 +688,7 @@ SHOW_INCLUDE_FILES = NO SHOW_GROUPED_MEMB_INC = NO -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# 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. @@ -633,14 +700,14 @@ FORCE_LOCAL_INCLUDES = NO INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# 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 +# 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. @@ -648,7 +715,7 @@ SORT_MEMBER_DOCS = YES SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# 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. @@ -660,7 +727,7 @@ SORT_BRIEF_DOCS = NO SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# 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. @@ -677,11 +744,11 @@ SORT_GROUP_NAMES = NO SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# 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 +# 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. @@ -716,7 +783,7 @@ GENERATE_DEPRECATEDLIST= YES # sections, marked by \if ... \endif and \cond # ... \endcond blocks. -ENABLED_SECTIONS = +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 @@ -751,25 +818,25 @@ SHOW_FILES = NO SHOW_NAMESPACES = NO # 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 +# 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 +# by Doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. -FILE_VERSION_FILTER = +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 +# 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 +# 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. See also section "Changing the # layout of pages" for information. # -# 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 +# 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 = style_template/layout.xml @@ -782,21 +849,37 @@ LAYOUT_FILE = style_template/layout.xml # 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 = +CITE_BIB_FILES = + +# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH +# environment variable) so that external tools such as latex and gs can be +# found. +# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the +# path already specified by the PATH variable, and are added in the order +# specified. +# Note: This option is particularly useful for macOS version 14 (Sonoma) and +# higher, when running Doxygen from Doxywizard, because in this case any user- +# defined changes to the PATH are ignored. A typical example on macOS is to set +# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin +# together with the standard path, the full search path used by doxygen when +# launching external tools will then become +# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin + +EXTERNAL_TOOL_PATH = #--------------------------------------------------------------------------- # 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 +# standard output by Doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = YES # 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 +# 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. @@ -804,14 +887,14 @@ QUIET = YES WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# 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 +# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for # potential errors in the documentation, such as documenting some parameters in # a documented function twice, or documenting parameters that don't exist or # using markup commands wrongly. @@ -819,8 +902,8 @@ WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES -# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete -# function parameter documentation. If set to NO, doxygen will accept that some +# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete +# function parameter documentation. If set to NO, Doxygen will accept that some # parameters have no documentation without warning. # The default value is: YES. @@ -828,7 +911,7 @@ WARN_IF_INCOMPLETE_DOC = 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 parameter +# value. If set to NO, Doxygen will only warn about wrong parameter # documentation, but not about the absence of documentation. If EXTRACT_ALL is # set to YES then this flag will automatically be disabled. See also # WARN_IF_INCOMPLETE_DOC @@ -836,30 +919,67 @@ WARN_IF_INCOMPLETE_DOC = YES WARN_NO_PARAMDOC = NO -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about +# undocumented enumeration values. If set to NO, Doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found +# while parsing the user defined layout file, such as missing or wrong elements. +# See also LAYOUT_FILE for details. If set to NO, problems with the layout file +# will be suppressed. +# The default value is: YES. + +WARN_LAYOUT_FILE = YES + +# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the Doxygen process Doxygen will return with a non-zero status. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # The default value is: NO. WARN_AS_ERROR = NO -# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# 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) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of Doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # 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). +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -875,31 +995,42 @@ INPUT = ./src/introduction.txt \ ./src/history.txt # 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 +# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). +# See also: INPUT_ENCODING for further information on supported encodings. + +INPUT_FILE_ENCODING = + # 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. +# read by Doxygen. # # Note the list of default checked file patterns might differ from the list of # default file extension mappings. # -# 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++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, -# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C -# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, +# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, +# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, +# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to +# be provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ @@ -958,7 +1089,7 @@ RECURSIVE = YES # 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 +# Note that relative paths are relative to the directory from which Doxygen is # run. EXCLUDE = @@ -977,24 +1108,21 @@ EXCLUDE_SYMLINKS = NO # 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 = +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/* +# ANamespace::AClass, ANamespace::*Test -EXCLUDE_SYMBOLS = +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 = +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 @@ -1016,7 +1144,7 @@ EXAMPLE_RECURSIVE = NO IMAGE_PATH = src/images -# The INPUT_FILTER tag can be used to specify a program that doxygen should +# 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: # @@ -1031,11 +1159,16 @@ IMAGE_PATH = src/images # 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 Doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# # 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. +# properly processed by Doxygen. -INPUT_FILTER = +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 @@ -1046,9 +1179,9 @@ INPUT_FILTER = # # 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. +# properly processed by Doxygen. -FILTER_PATTERNS = +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 @@ -1063,14 +1196,32 @@ FILTER_SOURCE_FILES = NO # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. -FILTER_SOURCE_PATTERNS = +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. +# and want to reuse the introduction page also for the Doxygen output. + +USE_MDFILE_AS_MAINPAGE = -USE_MDFILE_AS_MAINPAGE = +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1086,12 +1237,13 @@ USE_MDFILE_AS_MAINPAGE = SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. +# multi-line macros, enums or list initialized variables 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 +# 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. @@ -1129,7 +1281,7 @@ REFERENCES_LINK_SOURCE = NO 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 +# point to the HTML generated by the htags(1) tool instead of Doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. @@ -1143,14 +1295,14 @@ SOURCE_TOOLTIPS = YES # 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 +# 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 +# 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. @@ -1158,19 +1310,19 @@ USE_HTAGS = NO VERBATIM_HEADERS = NO -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# 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 +# 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 the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS -# tag is set to YES then doxygen will add the directory of each input to the +# tag is set to YES then Doxygen will add the directory of each input to the # include path. # The default value is: YES. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. @@ -1179,11 +1331,11 @@ CLANG_ADD_INC_PATHS = YES # 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 +# 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 = +CLANG_OPTIONS = # If clang assisted parsing is enabled you can provide the clang parser with the # path to the directory containing a file called compile_commands.json. This @@ -1193,7 +1345,7 @@ CLANG_OPTIONS = # specifying the -p option to a clang tool, such as clang-check. These options # will then be passed to the parser. Any options specified with CLANG_OPTIONS # will be added as well. -# Note: The availability of this option depends on whether or not doxygen was +# Note: The availability of this option depends on whether or not Doxygen was # generated with the -Duse_libclang=ON option for CMake. CLANG_DATABASE_PATH = @@ -1209,19 +1361,20 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = NO -# 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. +# 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. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1242,59 +1395,65 @@ HTML_OUTPUT = html 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 +# 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. +# 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 +# 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 +# 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 = style_template/header.html # 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 +# 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. +# that Doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = style_template/footer.html # 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. +# 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. +# 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 = +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. +# 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. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = style_template/extra_stylesheet.css +HTML_EXTRA_STYLESHEET = style_template/extra_stylesheet.css \ + style_template/extra_search.css # 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 @@ -1311,8 +1470,22 @@ HTML_EXTRA_FILES = style_template/tabs.css \ style_template/navtree.js \ style_template/version.css \ style_template/dropdown.png \ + style_template/bdwn.png \ ../../LICENSE +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generates light mode output, DARK always +# generates dark mode output, AUTO_LIGHT automatically sets the mode according +# to the user preference, uses light mode if no preference is set (the default), +# AUTO_DARK automatically sets the mode according to the user preference, uses +# dark mode if no preference is set and TOGGLE allows a user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_LIGHT + # 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 color-wheel, see @@ -1343,15 +1516,6 @@ HTML_COLORSTYLE_SAT = 100 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 = YES - # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will @@ -1371,6 +1535,33 @@ HTML_DYNAMIC_MENUS = NO HTML_DYNAMIC_SECTIONS = NO +# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be +# dynamically folded and expanded in the generated HTML source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + +# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in +# the top right corner of code and text fragments that allows the user to copy +# its content to the clipboard. Note this only works if supported by the browser +# and the web page is served via a secure context (see: +# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: +# protocol. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COPY_CLIPBOARD = YES + +# Doxygen stores a couple of settings persistently in the browser (via e.g. +# cookies). By default these settings apply to all HTML pages generated by +# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store +# the settings under a project specific key, such that the user preferences will +# be stored separately. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_PROJECT_COOKIE = + # 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 @@ -1388,7 +1579,7 @@ HTML_INDEX_NUM_ENTRIES = 100 # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML +# 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 @@ -1407,6 +1598,13 @@ GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" +# This tag determines the URL 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. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + # 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. @@ -1429,18 +1627,18 @@ DOCSET_PUBLISHER_ID = org.doxygen.Publisher DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# 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 # on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # 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 +# 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 @@ -1456,15 +1654,15 @@ GENERATE_HTMLHELP = NO # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_FILE = +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. +# 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 = +HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the main .chm file (NO). @@ -1477,7 +1675,7 @@ GENERATE_CHI = NO # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_INDEX_ENCODING = +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 @@ -1494,6 +1692,16 @@ BINARY_TOC = NO TOC_EXPAND = NO +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + # 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 @@ -1508,7 +1716,7 @@ GENERATE_QHP = NO # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = +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 @@ -1534,7 +1742,7 @@ QHP_VIRTUAL_FOLDER = doc # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_NAME = +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 @@ -1542,21 +1750,21 @@ QHP_CUST_FILTER_NAME = # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_ATTRS = +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: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# including file name) 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 = +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 @@ -1584,7 +1792,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # 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. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = YES @@ -1597,11 +1805,11 @@ DISABLE_INDEX = YES # (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 (see "Fine-tuning the output"). As an -# example, the default style sheet generated by doxygen has an example that +# 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. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES @@ -1611,7 +1819,7 @@ GENERATE_TREEVIEW = YES # area (value NO) or if it should extend to the full height of the window (value # YES). Setting this to YES gives a layout similar to # https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATOR_TREEVIEW or +# project logo, title, and description. If either GENERATE_TREEVIEW or # DISABLE_INDEX is set to NO, this option has no effect. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1619,7 +1827,7 @@ GENERATE_TREEVIEW = YES FULL_SIDEBAR = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. +# 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. @@ -1628,6 +1836,12 @@ FULL_SIDEBAR = NO ENUM_VALUES_PER_LINE = 1 +# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified +# enumeration values besides the enumeration mnemonics. +# The default value is: NO. + +SHOW_ENUM_VALUES = NO + # 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. @@ -1635,14 +1849,21 @@ ENUM_VALUES_PER_LINE = 1 TREEVIEW_WIDTH = 250 -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# 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 -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see # https://inkscape.org) to generate formulas as SVG images instead of PNGs for # the HTML output. These images will generally look nicer at scaled resolutions. @@ -1655,24 +1876,13 @@ HTML_FORMULA_FORMAT = png # 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 +# Doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. @@ -1710,7 +1920,7 @@ MATHJAX_VERSION = MathJax_2 # Possible values are: HTML-CSS (which is slower, but has the best # compatibility. This is the name for Mathjax version 2, for MathJax version 3 # this will be translated into chtml), NativeMML (i.e. MathML. Only supported -# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This # is the name for Mathjax version 3, for MathJax version 2 this will be # translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. @@ -1742,23 +1952,23 @@ MATHJAX_RELPATH = # MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_EXTENSIONS = +MATHJAX_EXTENSIONS = -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# 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/v2.7-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 = +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 +# 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 +# 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 @@ -1777,7 +1987,7 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH -# setting. When disabled, doxygen will generate a PHP script for searching and +# setting. When disabled, Doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing # and searching needs to be provided by external tools. See the section # "External Indexing and Searching" for details. @@ -1786,7 +1996,7 @@ SEARCHENGINE = YES SERVER_BASED_SEARCH = NO -# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file # which needs to be processed by an external indexer. Doxygen will invoke an # external search engine pointed to by the SEARCHENGINE_URL option to obtain the @@ -1813,7 +2023,7 @@ EXTERNAL_SEARCH = NO # details. # This tag requires that the tag SEARCHENGINE is set to YES. -SEARCHENGINE_URL = +SEARCHENGINE_URL = # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # search data is written to a file for indexing by an external tool. With the @@ -1829,9 +2039,9 @@ SEARCHDATA_FILE = searchdata.xml # projects and redirect the results back to the right project. # This tag requires that the tag SEARCHENGINE is set to YES. -EXTERNAL_SEARCH_ID = +EXTERNAL_SEARCH_ID = -# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen # projects other than the one defined by this configuration file, but that are # all added to the same external search index. Each project needs to have a # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of @@ -1839,13 +2049,13 @@ EXTERNAL_SEARCH_ID = # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... # This tag requires that the tag SEARCHENGINE is set to YES. -EXTRA_SEARCH_MAPPINGS = +EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1890,7 +2100,7 @@ MAKEINDEX_CMD_NAME = makeindex LATEX_MAKEINDEX_CMD = makeindex -# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1917,40 +2127,40 @@ PAPER_TYPE = a4 # If left blank no extra packages will be included. # This tag requires that the tag GENERATE_LATEX is set to YES. -EXTRA_PACKAGES = +EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for # the generated LaTeX document. The header should contain everything until the -# first chapter. If it is left blank doxygen will generate a standard header. It +# first chapter. If it is left blank Doxygen will generate a standard header. It # is highly recommended to start with a default header using # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty # and then modify the file new_header.tex. See also section "Doxygen usage" for -# information on how to generate the default header that doxygen normally uses. +# information on how to generate the default header that Doxygen normally uses. # # Note: Only use a user-defined header if you know what you are doing! # Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. The following +# default header when upgrading to a newer version of Doxygen. The following # commands have a special meaning inside the header (and footer): For a # description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_HEADER = +LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for # the generated LaTeX document. The footer should contain everything after the -# last chapter. If it is left blank doxygen will generate a standard footer. See +# last chapter. If it is left blank Doxygen will generate a standard footer. See # LATEX_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 +# usage" for information on how to generate the default footer that Doxygen # normally uses. Note: Only use a user-defined footer if you know what you are # doing! # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_FOOTER = +LATEX_FOOTER = # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined # LaTeX style sheets that are included after the standard style sheets created -# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# by Doxygen. Using this option one can overrule certain style aspects. 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 @@ -1965,7 +2175,7 @@ LATEX_EXTRA_STYLESHEET = # markers available. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_EXTRA_FILES = +LATEX_EXTRA_FILES = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will @@ -1976,7 +2186,7 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX # files. Set this option to YES, to get a higher quality PDF documentation. # @@ -1986,15 +2196,22 @@ PDF_HYPERLINKS = YES USE_PDFLATEX = YES -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. +# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BATCHMODE = NO -# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the # index chapters (such as File Index, Compound Index, etc.) in the output. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2004,19 +2221,11 @@ LATEX_HIDE_INDICES = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. +# The default value is: plainnat. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -2029,7 +2238,7 @@ LATEX_EMOJI_DIRECTORY = # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -2044,7 +2253,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -2064,28 +2273,36 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's +# Load stylesheet definitions from file. Syntax is similar to Doxygen's # configuration file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the -# default style sheet that doxygen normally uses. +# default style sheet that Doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's configuration file. A template extensions file can be +# similar to Doxygen's configuration file. A template extensions file can be # generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = + +# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the RTF_OUTPUT output directory. +# Note that the files will be copied as-is; there are no commands or markers +# available. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTRA_FILES = #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -2116,7 +2333,7 @@ MAN_EXTENSION = .3 MAN_SUBDIR = -# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without # them the man command would be unable to find the correct page. @@ -2129,7 +2346,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -2143,7 +2360,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -2152,7 +2369,7 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES -# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include # namespace members in file scope as well, matching the HTML output. # The default value is: NO. # This tag requires that the tag GENERATE_XML is set to YES. @@ -2163,7 +2380,7 @@ XML_NS_MEMB_FILE_SCOPE = NO # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -2181,19 +2398,45 @@ DOCBOOK_OUTPUT = docbook # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures # the structure of the code including all documentation. Note that this feature # is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to Sqlite3 output +#--------------------------------------------------------------------------- + +# If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3 +# database with symbols found by Doxygen stored in tables. +# The default value is: NO. + +GENERATE_SQLITE3 = NO + +# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database 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: sqlite3. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_OUTPUT = sqlite3 + +# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db +# database file will be recreated with each Doxygen run. If set to NO, Doxygen +# will warn if a database file is already found and not modify it. +# The default value is: YES. +# This tag requires that the tag GENERATE_SQLITE3 is set to YES. + +SQLITE3_RECREATE_DB = YES + #--------------------------------------------------------------------------- # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -2201,7 +2444,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -2225,19 +2468,19 @@ PERLMOD_PRETTY = YES # overwrite each other's variables. # This tag requires that the tag GENERATE_PERLMOD is set to YES. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names # in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. @@ -2263,10 +2506,11 @@ SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the -# preprocessor. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = +INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the @@ -2274,7 +2518,7 @@ INCLUDE_PATH = # used. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that are # defined before the preprocessor is started (similar to the -D option of e.g. @@ -2284,7 +2528,7 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = +PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The @@ -2293,9 +2537,9 @@ PREDEFINED = # definition found in the source code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have # an all uppercase name, and do not end with a semicolon. Such function macros # are typically used for boiler-plate code, and will confuse the parser if not @@ -2319,26 +2563,26 @@ SKIP_FUNCTION_MACROS = NO # section "Linking to external documentation" for more information about the use # of tag files. # Note: Each tag file must have a unique name (where the name does NOT include -# the path). If a tag file is not located in the directory in which doxygen is +# the path). If a tag file is not located in the directory in which Doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# When a file name is specified after GENERATE_TAGFILE, Doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES, all external class will be listed in -# the class index. If set to NO, only the inherited external classes will be -# listed. +# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces +# will be listed in the class and namespace index. If set to NO, only the +# inherited external classes will be listed. # The default value is: NO. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will be +# in the topic index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. @@ -2352,42 +2596,26 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram -# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to -# NO turns the diagrams off. Note that this option also works with HAVE_DOT -# disabled, but it is recommended to install and use dot, since it yields more -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. HIDE_UNDOC_RELATIONS = YES -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is # set to NO # The default value is: NO. HAVE_DOT = NO -# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed -# to run in parallel. When set to 0 doxygen will base this on the number of +# The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed +# to run in parallel. When set to 0 Doxygen will base this on the number of # processors available in the system. You can set it explicitly to a value # larger than 0 to get control over the balance between CPU load and processing # speed. @@ -2396,55 +2624,83 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font in the dot files that doxygen -# generates you can specify the font name using DOT_FONTNAME. You need to make -# sure dot is able to find the font, which can be done by putting it in a -# standard location or by setting the DOTFONTPATH environment variable or by -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# Doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification You need to make sure dot is able +# to find the font, which can be done by putting it in a standard location or by +# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTPATH = +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. -# The default value is: YES. +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. Explicit enabling an inheritance +# graph or choosing a different representation for an inheritance graph of a +# specific class, can be accomplished by means of the command \inheritancegraph. +# Disabling an inheritance graph can be accomplished by means of the command +# \hideinheritancegraph. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. +# The default value is: YES. + CLASS_GRAPH = NO -# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a # graph for each documented class showing the direct and indirect implementation # dependencies (inheritance, containment, and class references variables) of the -# class with other documented classes. +# class with other documented classes. Explicit enabling a collaboration graph, +# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the +# command \collaborationgraph. Disabling a collaboration graph can be +# accomplished by means of the command \hidecollaborationgraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = NO -# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for +# groups, showing the direct groups dependencies. Explicit enabling a group +# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means +# of the command \groupgraph. Disabling a directory graph can be accomplished by +# means of the command \hidegroupgraph. See also the chapter Grouping in the +# manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GROUP_GRAPHS = NO -# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2465,10 +2721,10 @@ UML_LOOK = NO UML_LIMIT_NUM_FIELDS = 10 -# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS -# tag is set to YES, doxygen will add type and arguments for attributes and -# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# tag is set to YES, Doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen # will not generate fields with class member information in the UML graphs. The # class diagrams will look similar to the default class diagrams but using UML # notation for the relationships. @@ -2480,8 +2736,8 @@ DOT_UML_DETAILS = NO # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters # to display on a single line. If the actual line length exceeds this threshold -# significantly it will wrapped across multiple lines. Some heuristics are apply -# to avoid ugly line breaks. +# significantly it will be wrapped across multiple lines. Some heuristics are +# applied to avoid ugly line breaks. # Minimum value: 0, maximum value: 1000, default value: 17. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2496,24 +2752,29 @@ DOT_WRAP_THRESHOLD = 17 TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to -# YES then doxygen will generate a graph for each documented file showing the +# YES then Doxygen will generate a graph for each documented file showing the # direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, +# can be accomplished by means of the command \includegraph. Disabling an +# include graph can be accomplished by means of the command \hideincludegraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are -# set to YES then doxygen will generate a graph for each documented file showing +# set to YES then Doxygen will generate a graph for each documented file showing # the direct and indirect include dependencies of the file with other documented -# files. +# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set +# to NO, can be accomplished by means of the command \includedbygraph. Disabling +# an included by graph can be accomplished by means of the command +# \hideincludedbygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# If the CALL_GRAPH tag is set to YES then Doxygen will generate a call # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2525,7 +2786,7 @@ INCLUDED_BY_GRAPH = YES CALL_GRAPH = NO -# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller # dependency graph for every global function or class method. # # Note that enabling this option will significantly increase the time of a run. @@ -2537,44 +2798,59 @@ CALL_GRAPH = NO CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical # hierarchy of all classes instead of a textual one. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the # dependencies a directory has on other directories in a graphical way. The # dependency relations are determined by the #include relations between the -# files in the directories. +# files in the directories. Explicit enabling a directory graph, when +# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command +# \directorygraph. Disabling a directory graph can be accomplished by means of +# the command \hidedirectorygraph. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: -# http://www.graphviz.org/)). -# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order -# to make the SVG files visible in IE 9+ (other browsers do not have this -# requirement). +# https://www.graphviz.org/)). +# +# Note the formats svg:cairo and svg:cairo:cairo cannot be used in combination +# with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to NO). # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, -# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and -# png:gdiplus:gdiplus. +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus, +# png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core, +# gif:cairo, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus, +# gif:gd, gif:gd:gd, jpg:cairo, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd, +# jpg:gd:gd, jpg:gdiplus and jpg:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. DOT_IMAGE_FORMAT = png -# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to -# enable generation of interactive SVG images that allow zooming and panning. +# If DOT_IMAGE_FORMAT is set to svg or svg:svg or svg:svg:core, then this option +# can be set to YES to enable generation of interactive SVG images that allow +# zooming and panning. # # Note that this requires a modern browser other than Internet Explorer. Tested # and working are Firefox, Chrome, Safari, and Opera. -# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make -# the SVG files visible. Older versions of IE do not have SVG support. +# +# Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set +# to svg:cairo or svg:cairo:cairo. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2584,49 +2860,56 @@ INTERACTIVE_SVG = NO # found. If left blank, it is assumed the dot tool can be found in the path. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_PATH = +DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the \dotfile # command). # This tag requires that the tag HAVE_DOT is set to YES. -DOTFILE_DIRS = +DOTFILE_DIRS = -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). +# You can include diagrams made with dia in Doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. -MSCFILE_DIRS = +DIA_PATH = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile # command). -DIAFILE_DIRS = +DIAFILE_DIRS = -# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the -# path where java can find the plantuml.jar file. If left blank, it is assumed -# PlantUML is not used or called during a preprocessing step. Doxygen will -# generate a warning when it encounters a \startuml command in this case and -# will not generate output for the diagram. +# When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. If left blank, it is assumed PlantUML is not used or called during +# a preprocessing step. Doxygen will generate a warning when it encounters a +# \startuml command in this case and will not generate output for the diagram. PLANTUML_JAR_PATH = -# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a -# configuration file for plantuml. +# When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for PlantUML. PLANTUML_CFG_FILE = -# When using plantuml, the specified paths are searched for files specified by -# the !include statement in a plantuml block. +# When using PlantUML, the specified paths are searched for files specified by +# the !include statement in a PlantUML block. PLANTUML_INCLUDE_PATH = +# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that +# contain PlantUml files that are included in the documentation (see the +# \plantumlfile command). + +PLANTUMLFILE_DIRS = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes -# larger than this value, doxygen will truncate the graph, which is visualized -# by representing a node as a red box. Note that doxygen if the number of direct +# larger than this value, Doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that if the number of direct # children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that # the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. @@ -2647,18 +2930,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support @@ -2668,15 +2939,17 @@ DOT_TRANSPARENT = NO DOT_MULTI_TARGETS = NO -# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate +# If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate # files that are used to generate the various graphs. # # Note: This setting is not only used for dot files but also for msc temporary @@ -2684,3 +2957,19 @@ GENERATE_LEGEND = YES # The default value is: YES. DOT_CLEANUP = YES + +# You can define message sequence charts within Doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, Doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = diff --git a/Documentation/Doxygen/gen_doc.sh b/Documentation/Doxygen/gen_doc.sh index 501b738..975b733 100755 --- a/Documentation/Doxygen/gen_doc.sh +++ b/Documentation/Doxygen/gen_doc.sh @@ -14,11 +14,11 @@ set -o pipefail # Set version of gen pack library # For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags. # Use the tag name without the prefix "v", e.g., 0.7.0 -REQUIRED_GEN_PACK_LIB="0.11.1" +REQUIRED_GEN_PACK_LIB="0.11.2" DIRNAME=$(dirname "$(readlink -f "$0")") GENDIR=../html -REQ_DXY_VERSION="1.9.6" +REQ_DXY_VERSION="1.13.2" RUN_LINKCHECKER=1 diff --git a/Documentation/Doxygen/style_template/bdwn.png b/Documentation/Doxygen/style_template/bdwn.png new file mode 100644 index 0000000000000000000000000000000000000000..940a0b950443a0bb1b216ac03c45b8a16c955452 GIT binary patch literal 147 zcmeAS@N?(olHy`uVBq!ia0vp^>_E)H!3HEvS)PKZC{Gv1kP61Pb5HX&C2wk~_T div > div.contents, + .PageDoc > div.contents { + display: block; + flex-direction: row-reverse; + flex-wrap: nowrap; + align-items: flex-start; + } + + div.contents .textblock, div.contents .memberdecls, div.contents .memitem, div.contents .directory{ + min-width: 200px; + max-width: var(--max_textblock_width); + flex-grow: 1; + } + + div.contents p, div.contents ul, div.contents .image, div.contents .markdownTable, div.contents .fragment, div.contents hr, div.contents h1 { + max-width: var(--max_textblock_width); + } + + div.contents hr { + margin-left: 0; + } + + div.content .toc { + overflow-x: overlay; + overflow-wrap: normal; + } + + div.toc { + max-height: var(--toc-max-height); + max-width: var(--toc-width); + border: 0; + border-left: 1px solid var(--nav-splitbar-color); + border-radius: 0; + background-color: transparent; + box-shadow: none; + float: right; + position: sticky; + top: var(--toc-sticky-top); + padding: 0 0 0 var(--spacing-large); + margin: 0 0 0 var(--spacing-large); + } + } + + @media screen and (max-width:1510px) { + #doc-content > div > div.contents, + .PageDoc > div.contents { + display: block; + flex-direction: row-reverse; + flex-wrap: nowrap; + align-items: flex-start; + } + + div.contents .textblock, div.contents .memberdecls, div.contents .memitem, div.contents .directory{ + min-width: 200px; + max-width: var(--max_textblock_width); + flex-grow: 1; + } + + div.contents p, div.contents ul, div.contents .image, div.contents .markdownTable, div.contents .fragment{ + max-width: var(--max_textblock_width); + } + + div.toc { + max-height: 0px; + line-height: 0px; + overflow-y: hidden; + min-width: var(--toc-width); + border: 0; + border-radius: 0; + background-color: transparent; + box-shadow: none; + padding: 0;; + margin: 0; + } + } + + + .memberdecls heading { + font-weight: bold; + } + + div.contents, div.header .headertitle, div.header .summary { + max-width: var(--max_content_width); + } + + div.contents, div.header .headertitle { + margin-left: 3%; + margin-right: auto; + } + + /* @group Heading Levels */ + + h1 { + font-size: 150%; + border-top-color: var(--group-header-separator-color); + border-top-width: 2px; + border-top-style: solid; + padding: 1em 0 0; + margin-top: 0.5em; + margin-bottom: 0.75em; + } + /* + h1:before { + margin-bottom: 1em; + content: ""; + background-color: var(--arm_light_gray3); + height: 2px; + display: block; + width: 100%; + } + */ + .title { + font-size: 150%; + font-weight: bold; + margin: 10px 0px; + } + + h2, h2.groupheader { + border: 0px; + font-size: 120%; + font-weight: bold; + margin-top: 1.25em; + margin-bottom: 0.25em; + } + + h3 { + font-size: 100%; + margin-top: 1.25em; + margin-bottom: 0.25em; + } + + h4 { + font-size: 100%; + color: #505050; + } + + + div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; + } + + p { + margin-block-start: 1em; + margin-block-end: 0.5em; + } + + p.startli, p.startdd, p.starttd { + margin-top: 2px; + } + + + div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A2B4D8; + text-align: center; + } + + div.qindex, div.navpath { + width: 100%; + line-height: 140%; + } + + div.navtab { + margin-right: 15px; + } + + /* @group Link Styling */ + + + a.qindex { + font-weight: bold; + } + + a.qindexHL { + font-weight: bold; + background-color: #9AAED5; + color: #ffffff; + border: 1px double #849CCC; + } + + .contents a.qindexHL:visited { + color: #ffffff; + } + + pre.fragment { + font-family: monospace; + background-color: var(--fragment-background-color); + border-radius: 6px; + padding: 0.2em 0.4em; + font-size: 85%; + line-height: 1.45; + margin: 0.5em 0px; + } + + div.fragment { + font-family: monospace; + background-color: var(--fragment-background-color); + border-radius: 6px; + padding: 0.2em 0.4em; + font-size: 85%; + line-height: 1.45; + } + + div.line { + font-family: monospace; + font-size: 100%; + line-height: 1.45; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + } + + span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; + } + + span.lineno a { + background-color: #D8D8D8; + } + + span.lineno a:hover { + background-color: #C8C8C8; + } + + div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + } + + body { + color: var(--page-foreground-color); + background-color: var(--page-background-color); + margin: 0; + } + + body a:hover{ + text-decoration: underline; + } + + td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C3CFE6; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; + } + + td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C3CFE6; + padding: 2px 10px; + margin: 2px 0px; + } + + tr.memlist { + background-color: #EDF1F7; + } + + /* + .search { + color: #003399; + font-weight: bold; + } + + form.search { + margin-bottom: 0px; + margin-top: 0px; + } + + input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; + } + */ + + td.tiny { + font-size: 75%; + } + + img.footer { + border: 0px; + vertical-align: middle; + } + + .memSeparator { + line-height: 22px; + } + + .memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid var(--arm_light_gray);/*#C3CFE6;*/ + } + + a:-webkit-any-link { + color: var(--page-link-color); + cursor: pointer; + text-decoration: none; + } + + .a:hover { + text-decoration: underline; + } + + + /* @group Member Details */ + + /* Styles for detailed member documentation */ + + .memtitle { + display: inline-block; + padding: 8px; + padding-bottom: 12px; + padding-right: 12px; + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-color: var(--memdef-title-background-color); + line-height: 1.25; + font-weight: 600; + float: none; + } + + .permalink + { + color: var(--arm_blue); + font-size: 100%; + display: inline-block; + vertical-align: middle; + padding-bottom:6px; + } + + .memtemplate { + font-size: 80%; + color: #4464A5; + font-weight: normal; + margin-left: 9px; + } + + .memnav { + background-color: #EBEFF6; + border: 1px solid #A2B4D8; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; + } + + .mempage { + width: 100%; + } + + .memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + } + + .memitem.glow { + /*box-shadow: 0 0 15px cyan; */ + } + + .memname { + font-weight: bold; + margin-left: 6px; + } + + .memname td { + vertical-align: bottom; + } + .memproto, dl.reflist dt { + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + padding: 6px 0px 6px 0px; + color: var(--memdef-proto-text-color); + font-weight: bold; + background-color: var(--memdef-proto-background-color); + border-top-right-radius: 4px; + border-top-left-radius: 0px; + /* firefox specific markup */ + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 0px; + /* webkit specific markup */ + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 0px; + } + + .memdoc, dl.reflist dd { + border: 1px solid var(--memdef-border-color); + padding: 6px 10px 2px 10px; + } + + dl.reflist dt { + padding: 5px; + } + + dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; + } + + .paramkey { + text-align: right; + } + + .paramtype { + white-space: nowrap; + } + + .paramname { + color: var(--memdef-param-name-color); + white-space: nowrap; + } + .paramname em { + font-style: normal; + } + + .params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; + } + + .params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; + } + + .params .paramtype { + font-style: italic; + vertical-align: top; + } + + .params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; + } + + table.mlabels { + border-spacing: 0px; + } + + td.mlabels-left { + width: 100%; + padding: 0px; + } + + td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; + } + + span.mlabels { + margin-left: 8px; + } + + span.mlabel { + background-color: #708CC4; + border-top:1px solid #5072B7; + border-left:1px solid #5072B7; + border-right:1px solid #C3CFE6; + border-bottom:1px solid #C3CFE6; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + } + + + + /* @end */ + + /* these are for tree view when not used as main index */ + + div.directory { + margin: 10px 0px; + border-top: 1px solid var(--arm_dark_gray); + border-bottom: 1px solid var(--arm_dark_gray); + width: 100%; + } + + .directory table { + border-collapse:collapse; + } + + .directory td { + padding: 0px 10px 10px 0px; + vertical-align: middle; + } + + .directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top:10px; + } + + .directory td.entry a { + outline:none; + padding-left: 6px; + padding-top:10px; + } + + .directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top:10px; + border-left: 0px solid rgba(0,0,0,0.05); + } + + .directory img { + vertical-align: -30%; + } + + .directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; + } + + .directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3A568E; + } + + div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + + address { + font-style: normal; + color: #293C63; + } + + blockquote.doxtable { + margin-left:-7px; + margin-bottom: 6px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; + background-color: var(--page-background-color); + } + + table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; + } + + table.doxtable td, table.doxtable th { + border: 1px solid var(--table-cell-border-color); + padding: 7px 10px 5px; + text-align:left; + } + + table.doxtable th { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); + } + + table.doxtable tr:nth-child(odd) { + background-color: var(--table-odd-cell-color); + } + + table.doxtable tr:nth-child(even) { + background-color: var(--table-even-cell-color); + } + + table.fieldtable { + width: 100%; + margin-bottom: 10px; + border: 1px solid var(--arm_dark_gray); + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + } + + .fieldtable td, .fieldtable th { + padding: 3px 7px 2px; + } + + .fieldtable td.fieldtype, .fieldtable td.fieldname, td.fieldoc{ + white-space: nowrap; + border-right: 1px solid var(--arm_dark_gray); + border-bottom: 1px solid var(--arm_dark_gray); + vertical-align: top; + } + + .fieldtable td.fielddoc { + border-bottom: 1px solid var(--arm_dark_gray); + width: 100%; + } + + .fieldtable td.fielddoc p { + margin-top: 0px; + } + + .fieldtable tr:last-child td { + border-bottom: none; + } + + .fieldtable th { + background-color: var(--memdef-table-header-background-color); + font-size: 100%; + font-weight: bold; + } + + + /* @group Markdown */ + + + table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; + } + + table.markdownTable td, table.markdownTable th { + border: 1px solid var(--table-cell-border-color); + padding: 7px 10px 5px; + text-align:left; + } + + table.markdownTable th { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); + } + + table.markdownTable tr:nth-child(odd) { + background-color: var(--table-odd-cell-color); + } + + table.markdownTable tr:nth-child(even) { + background-color: var(--table-even-cell-color); + } + + /* for hyperlinks in table head rows */ + table.markdownTable th a{ + color: var(--table-header-foreground-color); + text-decoration: underline; + } + + table.markdownTable th a:visited{ + color: var(--table-header-foreground-color); + } + + table.markdownTable th a:hover{ + color: var(--arm_yellow); + } + + table.markdownTable th.markdownTableHeadLeft, table.markdownTable td.markdownTableBodyLeft { + text-align: left + } + + table.markdownTable th.markdownTableHeadRight, table.markdownTable td.markdownTableBodyRight { + text-align: right + } + + table.markdownTable th.markdownTableHeadCenter, table.markdownTable td.markdownTableBodyCenter { + text-align: center + } + + + th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + font-size: 100%; + } + + /* @end */ + + + .tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; + } + + .navpath ul + { + font-size: 11px; + background-color:var(--arm_black); + height:30px; + line-height:30px; + color:white; + border:solid 1px #C1CDE5; + overflow:hidden; + margin:0px; + padding:0px; + } + + .navpath li + { + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + color:#344D7E; + } + + .navpath li.navelem a + { + height:32px; + display:block; + text-decoration: none; + outline: none; + } + + .navpath li.navelem a:hover + { + color:#6583BF; + } + + .navpath li.footer + { + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + color:var(--arm_white); + font-size: 8pt; + } + + div.summary + { + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; + } + + div.summary a + { + white-space: nowrap; + } + + div.ingroups + { + margin-left: 5px; + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; + } + + div.ingroups a + { + white-space: nowrap; + } + + div.header + { + margin: 0px; + } + + div.headertitle + { + padding: 5px 5px 5px 0px; + margin-top: 10px; + } + + dl + { + padding: 0 0 0 10px; + } + + /* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ + dl.section + { + margin-left: 0px; + padding-left: 0px; + } + + dl.note + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; + } + + dl.warning, dl.attention + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #FF0000; + } + + dl.pre, dl.post, dl.invariant + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; + } + + dl.deprecated + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #505050; + } + + dl.todo + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00C0E0; + } + + dl.test { - margin-left:0 !important; - height:auto !important; - width:auto !important; - overflow:inherit; - display:inline; - } -} - + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #3030E0; + } + + dl.bug + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #C08050; + } + + dl.safety + { + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #008000; + } + + + dl.section dd { + margin-bottom: 6px; + } + + + #projectlogo + { + text-align: center; + vertical-align: middle; + border-collapse: separate; + } + + #projectlogo img + { + border: 0px none; + } + + #projectname + { + font: 270% 'Lato Lite', Lato, Caibri, sans-serif; + font-weight: 600; + margin: 0px; + color: white; + padding: 2px 0px; + } + + #projectbrief + { + font: 140% "Lato Lite", Lato, Caibri, sans-serif; + margin: 0px; + color: white; + padding: 4px 0px 4px; + } + + #projectnumber + { + font: 50% "Lato Lite", Lato, Caibri, sans-serif; + margin: 0px; + color: white; + padding: 0px; + } + + #top + { + border-bottom: 1px solid var(--arm_dark_gray); + } + + #titlearea + { + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid var(--arm_dark_gray); + background-color: var(--arm_black); + } + + .image + { + text-align: left; + display: grid; + justify-content: center; + align-items: center; + justify-items: center; + } + + .dotgraph + { + text-align: center; + } + + .mscgraph + { + text-align: center; + } + + .caption + { + font-weight: bold; + font-size: 80%; + } + + div.zoom + { + border: 1px solid #8EA4D0; + } + + dl.citelist { + margin-bottom:50px; + } + + dl.citelist dt { + color:#314877; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; + } + + dl.citelist dd { + margin:2px 0; + padding:5px 0; + } + + + div.toc li { + background: none; + font-family: var(--font-family-toc); + font-size: var(--toc-font-size); + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; + } + + div.toc h3 { + color: var(--toc-foreground); + font-size: var(--toc-header-font-size); + font-weight: normal; + margin: var(--spacing-large) 0 var(--spacing-medium) 0; + } + + div.toc li { + padding: 0; + background: none; + line-height: var(--toc-font-size); + margin: var(--toc-font-size) 0 0 0; + } + + div.toc ul { + margin-top: 0 + } + + div.toc li a.active { + font-weight: bold; + color: var(--toc-active-color) !important; + } + + div.toc li a:hover { + color: var(--nav-text-hover-color) !important; + } + + div.toc li a { + font-size: var(--toc-font-size); + color: var(--nav-foreground-color) !important; + text-decoration: none; + } + + .inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + + .inherit_header td { + padding: 6px 0px 2px 5px; + } + + .inherit { + display: none; + } + + tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; + } + + @media print + { + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } + } + \ No newline at end of file diff --git a/Documentation/Doxygen/style_template/layout.xml b/Documentation/Doxygen/style_template/layout.xml index d21455c..a1dc92a 100644 --- a/Documentation/Doxygen/style_template/layout.xml +++ b/Documentation/Doxygen/style_template/layout.xml @@ -4,7 +4,7 @@ - + diff --git a/Documentation/Doxygen/style_template/search.css b/Documentation/Doxygen/style_template/search.css index da3b509..566ba29 100644 --- a/Documentation/Doxygen/style_template/search.css +++ b/Documentation/Doxygen/style_template/search.css @@ -1,114 +1,131 @@ /*---------------- Search Box */ -#FSearchBox { - float: left; +.titlearea table { + width: 100%; } -#searchli { +dark-mode-toggle { + position: absolute; + right: 5px; + padding-top: 3px; +} + +#MSearchBox { + position: absolute; + right: 34px; +} + +/*---------------- Search box styling */ + +.SRPage * { + font-weight: normal; + line-height: normal; +} + +dark-mode-toggle { + margin-left: 5px; + display: flex; float: right; - display: block; - width: 170px; - height: 24px; } #MSearchBox { + display: inline-block; white-space : nowrap; - position: absolute; - float: none; - display: inline; - margin-top: 3px; - right: 0px; - width: 170px; + background: var(--search-background-color); + border-radius: 0.65em; + box-shadow: var(--search-box-shadow); z-index: 102; } -#MSearchBox .left -{ - display:block; - position:absolute; - left:10px; - width:20px; - height:19px; - background:url('search_l.png') no-repeat; - background-position:right; +#MSearchBox .left { + display: inline-block; + vertical-align: middle; + height: 1.4em; } #MSearchSelect { - display:block; - position:absolute; - width:20px; - height:19px; + display: inline-block; + vertical-align: middle; + width: 20px; + height: 19px; + background-image: var(--search-magnification-select-image); + margin: 0 0 0 0.3em; + padding: 0; } -.left #MSearchSelect { - left:4px; +#MSearchSelectExt { + display: inline-block; + vertical-align: middle; + width: 10px; + height: 19px; + background-image: var(--search-magnification-image); + margin: 0 0 0 0.5em; + padding: 0; } -.right #MSearchSelect { - right:5px; -} #MSearchField { - display:block; - position:absolute; - height:19px; - background:url('search_m.png') repeat-x; + display: inline-block; + vertical-align: middle; + width: 7.5em; + height: 19px; + margin: 0 0.15em; + padding: 0; + line-height: 1em; border:none; - width:116px; - margin-left:20px; - padding-left:4px; - color: #909090; + color: var(--search-foreground-color); outline: none; - font: 9pt Arial, Verdana, sans-serif; + font-family: var(--font-family-search); + -webkit-border-radius: 0px; + border-radius: 0px; + background: none; } -#FSearchBox #MSearchField { - margin-left:15px; +@media(hover: none) { + /* to avoid zooming on iOS */ + #MSearchField { + font-size: 16px; + } } #MSearchBox .right { - display:block; - position:absolute; - right:10px; - top:0px; - width:20px; - height:19px; - background:url('search_r.png') no-repeat; - background-position:left; + display: inline-block; + vertical-align: middle; + width: 1.4em; + height: 1.4em; } #MSearchClose { display: none; - position: absolute; - top: 4px; + font-size: inherit; background : none; border: none; - margin: 0px 4px 0px 0px; - padding: 0px 0px; + margin: 0; + padding: 0; outline: none; -} -.left #MSearchClose { - left: 6px; } -.right #MSearchClose { - right: 2px; +#MSearchCloseImg { + padding: 0.3em; + margin: 0; } .MSearchBoxActive #MSearchField { - color: #000000; + color: var(--search-active-color); } + + /*---------------- Search filter selection */ #MSearchSelectWindow { display: none; position: absolute; left: 0; top: 0; - border: 1px solid #90A5CE; - background-color: #F9FAFC; - z-index: 1; + border: 1px solid var(--search-filter-border-color); + background-color: var(--search-filter-background-color); + z-index: 10001; padding-top: 4px; padding-bottom: 4px; -moz-border-radius: 4px; @@ -120,7 +137,7 @@ } .SelectItem { - font: 8pt Arial, Verdana, sans-serif; + font: 8pt var(--font-family-search); padding-left: 2px; padding-right: 12px; border: 0px; @@ -128,7 +145,7 @@ span.SelectionMark { margin-right: 4px; - font-family: monospace; + font-family: var(--font-family-monospace); outline-style: none; text-decoration: none; } @@ -136,7 +153,7 @@ span.SelectionMark { a.SelectItem { display: block; outline-style: none; - color: #000000; + color: var(--search-filter-foreground-color); text-decoration: none; padding-left: 6px; padding-right: 12px; @@ -144,14 +161,14 @@ a.SelectItem { a.SelectItem:focus, a.SelectItem:active { - color: #000000; + color: var(--search-filter-foreground-color); outline-style: none; text-decoration: none; } a.SelectItem:hover { - color: #FFFFFF; - background-color: #3D578C; + color: var(--search-filter-highlight-text-color); + background-color: var(--search-filter-highlight-bg-color); outline-style: none; text-decoration: none; cursor: pointer; @@ -161,7 +178,7 @@ a.SelectItem:hover { /*---------------- Search results window */ iframe#MSearchResults { - width: 60ex; + /*width: 60ex;*/ height: 15em; } @@ -169,16 +186,19 @@ iframe#MSearchResults { display: none; position: absolute; left: 0; top: 0; - border: 1px solid #000; - background-color: #EEF1F7; + border: 1px solid var(--search-results-border-color); + background-color: var(--search-results-background-color); + z-index:10000; + width: 300px; + height: 400px; + overflow: auto; } /* ----------------------------------- */ #SRIndex { - clear:both; - padding-bottom: 15px; + clear:both; } .SREntry { @@ -191,12 +211,13 @@ iframe#MSearchResults { padding: 1px 5px; } -body.SRPage { +div.SRPage { margin: 5px 2px; + background-color: var(--search-results-background-color); } .SRChildren { - padding-left: 3ex; padding-bottom: .5em + padding-left: 3ex; padding-bottom: .5em } .SRPage .SRChildren { @@ -205,16 +226,17 @@ body.SRPage { .SRSymbol { font-weight: bold; - color: #425E97; - font-family: Arial, Verdana, sans-serif; + color: var(--search-results-foreground-color); + font-family: var(--font-family-search); text-decoration: none; outline: none; } a.SRScope { display: block; - color: #425E97; - font-family: Arial, Verdana, sans-serif; + color: var(--search-results-foreground-color); + font-family: var(--font-family-search); + font-size: 8pt; text-decoration: none; outline: none; } @@ -224,17 +246,51 @@ a.SRScope:focus, a.SRScope:active { text-decoration: underline; } +span.SRScope { + padding-left: 4px; + font-family: var(--font-family-search); +} + .SRPage .SRStatus { padding: 2px 5px; font-size: 8pt; font-style: italic; + font-family: var(--font-family-search); } .SRResult { display: none; } -DIV.searchresults { +div.searchresults { margin-left: 10px; margin-right: 10px; } + +/*---------------- External search page results */ + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: var(--nav-gradient-active-image-parent); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} From 457dffff4a4928603874498543b2f6366d572863 Mon Sep 17 00:00:00 2001 From: Vladimir Umek Date: Tue, 1 Apr 2025 12:23:01 +0200 Subject: [PATCH 2/3] Convert documentation to markdown --- Documentation/Doxygen/driver.dxy.in | 13 +- Documentation/Doxygen/src/ethernet.md | 49 ++ Documentation/Doxygen/src/flash.md | 39 + Documentation/Doxygen/src/history.md | 5 + Documentation/Doxygen/src/i2c.md | 129 +++ Documentation/Doxygen/src/introduction.txt | 904 --------------------- Documentation/Doxygen/src/mainpage.md | 34 + Documentation/Doxygen/src/nand.md | 14 + Documentation/Doxygen/src/shield_layer.md | 126 +++ Documentation/Doxygen/src/spi.md | 163 ++++ Documentation/Doxygen/src/usb.md | 64 ++ Documentation/Doxygen/src/wifi.md | 51 ++ 12 files changed, 685 insertions(+), 906 deletions(-) create mode 100644 Documentation/Doxygen/src/ethernet.md create mode 100644 Documentation/Doxygen/src/flash.md create mode 100644 Documentation/Doxygen/src/history.md create mode 100644 Documentation/Doxygen/src/i2c.md delete mode 100644 Documentation/Doxygen/src/introduction.txt create mode 100644 Documentation/Doxygen/src/mainpage.md create mode 100644 Documentation/Doxygen/src/nand.md create mode 100644 Documentation/Doxygen/src/shield_layer.md create mode 100644 Documentation/Doxygen/src/spi.md create mode 100644 Documentation/Doxygen/src/usb.md create mode 100644 Documentation/Doxygen/src/wifi.md diff --git a/Documentation/Doxygen/driver.dxy.in b/Documentation/Doxygen/driver.dxy.in index 5fe4d9c..9350123 100644 --- a/Documentation/Doxygen/driver.dxy.in +++ b/Documentation/Doxygen/driver.dxy.in @@ -991,8 +991,17 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ./src/introduction.txt \ - ./src/history.txt +INPUT = ./src/mainpage.md \ + ./src/history.md \ + ./src/history.txt \ + ./src/ethernet.md \ + ./src/usb.md \ + ./src/wifi.md \ + ./src/flash.md \ + ./src/i2c.md \ + ./src/nand.md \ + ./src/spi.md \ + ./src/shield_layer.md # 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 diff --git a/Documentation/Doxygen/src/ethernet.md b/Documentation/Doxygen/src/ethernet.md new file mode 100644 index 0000000..33d9ace --- /dev/null +++ b/Documentation/Doxygen/src/ethernet.md @@ -0,0 +1,49 @@ +# Ethernet {#page_driver_eth} + +## Driver Implementations + +The \ref pack_content provides implementations of **[CMSIS-Ethernet drivers](https://arm-software.github.io/CMSIS_6/latest/Driver/group__eth__interface__gr.html)** for the following devices: + +| Driver | Description | +|----------------|-----------------------------------------------------------------------------------------------------| +| **KSZ8851SNL** | Ethernet PHY and MAC interfaces for the Microchip **[KSZ8851](https://www.microchip.com/KSZ8851)**. | +| **LAN9220** | Ethernet PHY and MAC interfaces for the Microchip **[LAN9220](https://www.microchip.com/LAN9220)**. | +| **DP83848C** | Ethernet PHY interface for the Texas Instruments **[DP83848C](http://www.ti.com/product/DP83848C)**.| +| **KSZ8061RNB** | Ethernet PHY interface for the Microchip **[KSZ8061](https://www.microchip.com/KSZ8061)**. | +| **KSZ8081RNA** | Ethernet PHY interface for the Microchip **[KSZ8081](https://www.microchip.com/KSZ8081)**. | +| **LAN8710A** | Ethernet PHY interface for the Microchip **[LAN8710A](https://www.microchip.com/LAN8710A)**. | +| **LAN8720** | Ethernet PHY interface for the Microchip **[LAN8720A](https://www.microchip.com/LAN8720A)**. | +| **LAN8740A** | Ethernet PHY interface for the Microchip **[LAN8740A](https://www.microchip.com/LAN8740A)**. | +| **LAN8742A** | Ethernet PHY interface for the Microchip **[LAN8742A](https://www.microchip.com/LAN8742A)**. | +| **ST802RT1** | Ethernet PHY interface for the STMicroelectronics **[ST802RT1](http://www.st.com/content/ccc/resource/technical/document/data_brief/37/8e/14/c7/84/39/4d/61/CD00263138.pdf/files/CD00263138.pdf/jcr:content/translations/en.CD00263138.pdf)**. | + +## Multiple Driver Instances + +CMSIS-Driver API supports multiple driver instances. The Ethernet drivers are implemented within a single C module and several driver instances of the same type can be used in a project as follows: + +1. Add the first driver instance to the project. In IDEs with CMSIS-pack management support this can be done from the Run-Time Environment (RTE). +2. Create a copy of the driver's .c file with a different file name and add it to the project. This will be the second driver instance. For example, copy `ETH_LAN9220.c` file as `ETH2_LAN9220.c`. +3. Copy the driver's .h file to the project or add the driver's folder to the compiler include search path. +4. Specify the driver parameters for the second instance. For example, in `ETH2_LAN9220.c` new values to the following parameters are needed instead of default ones: + ```c + #define ETH_MAC_NUM 1 + #define ETH_PHY_NUM 1 + #define LAN9220_BASE (0x53000000UL) + ``` +5. Now both Ethernet instances can be accessed from the application. For example: + ```c + #include "Driver_ETH_MAC.h" + #include "Driver_ETH_PHY.h" + + extern ARM_DRIVER_ETH_MAC Driver_ETH_MAC0; + extern ARM_DRIVER_ETH_MAC Driver_ETH_MAC1; + + extern ARM_DRIVER_ETH_PHY Driver_ETH_PHY0; + extern ARM_DRIVER_ETH_PHY Driver_ETH_PHY1; + + #define eth0 (&Driver_ETH_MAC0) + #define eth1 (&Driver_ETH_MAC1) + + #define phy0 (&Driver_ETH_PHY0) + #define phy1 (&Driver_ETH_PHY1) + ``` diff --git a/Documentation/Doxygen/src/flash.md b/Documentation/Doxygen/src/flash.md new file mode 100644 index 0000000..6039bba --- /dev/null +++ b/Documentation/Doxygen/src/flash.md @@ -0,0 +1,39 @@ +# Flash {#page_driver_flash} + +## Driver Implementations + +The \ref pack_content contains implementations of **[CMSIS-Flash drivers](https://arm-software.github.io/CMSIS_6/latest/Driver/group__flash__interface__gr.html)** for the following devices: + +| Driver | Description | +|----------------|-----------------------------------------------------------------------------| +| **AM29x800BB** | Flash interface for Parallel NOR Flash **AM29x800BB**. This product is discontinued. | +| **AT45DB641E** | Flash interface for SPI Serial DataFlash **[AT45DB641E](https://www.renesas.com/br/en/document/dst/at45db641e-datasheet)**. | +| **AT45DB642D** | Flash interface for SPI Serial DataFlash **AT45DB642D**. | +| **M29EW28F128**| Flash interface for Parallel NOR Flash **M29EW28F128**. | +| **M29W640FB** | Flash interface for Parallel NOR Flash **M29W640FB**. | +| **N25Q032A** | Flash interface for Serial NOR Flash **N25Q032A**. | +| **S29GL064Nx2**| Flash interface for Parallel NOR Flash **[S29GL064N](http://www.cypress.com/documentation/datasheets/s29gl064n-s29gl032n-64-mbit-32-mbit-3-v-page-mode-mirrorbit-flash)**. | + +## Multiple Driver Instances + +CMSIS-Driver API supports multiple driver instances. The Flash drivers are implemented within a single C module and several driver instances of the same type can be used in a project as follows: + +1. Add the first driver instance to the project. In IDEs with CMSIS-pack management support this can be done from the Run-Time Environment (RTE). +2. Create a copy of the driver's .c file with a different file name and add it to the project. This will be the second driver instance. For example, copy `AT45DB641E.c` file as `AT45DB641E_2.c`. +3. Copy the driver's .h file to the project or add the driver's folder to the compiler include search path. +4. Specify the driver parameters for the second instance based on the hardware design. For example, in `AT45DB641E_2.c` the values for the flash driver number and SPI driver number need to be configured as shown below: + ```c + #define DRIVER_FLASH_NUM 1 + #define DRIVER_SPI_NUM 1 + ``` +5. Now both Flash instances can be accessed from the application. For example: + ```c + #include "Driver_Flash.h" + + /* Flash driver instances */ + extern ARM_DRIVER_FLASH Driver_Flash0; + extern ARM_DRIVER_FLASH Driver_Flash1; + + #define flash0 (&Driver_Flash0) + #define flash1 (&Driver_Flash1) + ``` diff --git a/Documentation/Doxygen/src/history.md b/Documentation/Doxygen/src/history.md new file mode 100644 index 0000000..86db091 --- /dev/null +++ b/Documentation/Doxygen/src/history.md @@ -0,0 +1,5 @@ +# Revision History {#rev_hist} + +CMSIS-Driver version is officially updated upon releases of the [CMSIS-Driver pack](https://www.keil.arm.com/packs/cmsis-driver-arm/versions/). + +The table below provides information about the changes delivered with specific versions of CMSIS-Driver. diff --git a/Documentation/Doxygen/src/i2c.md b/Documentation/Doxygen/src/i2c.md new file mode 100644 index 0000000..5748f24 --- /dev/null +++ b/Documentation/Doxygen/src/i2c.md @@ -0,0 +1,129 @@ +# I2C {#page_driver_i2c} + +The I2C MultiSlave wrapper [I2C_MultiSlave.c](https://github.com/ARM-software/CMSIS-Driver/blob/main/I2C/I2C_MultiSlave.c) resides on top of an arbitrary I2C CMSIS-Driver and exports maximum of eight I2C CMSIS-Drivers (with I2C Master functionality only). Slave functionalities are disabled and calling slave functions will return with an error. An I2C slave device connects to one of the exported driver and uses it as any other CMSIS I2C driver (in master mode only). The wrapper provides multi-thread protection. + +Each slave can use its own bus speed configuration, but the MultiSlave wrapper will limit the bus speed to the lowest requested frequency (assuming that three slaves are present and if two slaves configure bus speed `ARM_I2C_BUS_SPEED_FAST` (400 KHz) and one slave `ARM_I2C_BUS_SPEED_STANDARD` (100 kHz), then the actual bus speed will be `ARM_I2C_BUS_SPEED_STANDARD`). + +The wrapper is configured using the [I2C_MultiSlave_Config.h](https://github.com/ARM-software/CMSIS-Driver/blob/main/Config/I2C_MultiSlave_Config.h) file, which contains the following options: + +- `#define I2C_DRIVER` specifies the underlying I2C CMSIS-Driver, which controls the I2C peripheral and accesses the bus. The wrapper connects to that driver. +- `#define I2C_ENABLE_SLAVE_x` enables each connected slave on the I2C bus. This basically means that the driver control block `Driver_I2Cn` will be exported by the wrapper for each particular slave. +- `#define I2C_DRIVER_SLAVE_x` sets the exported control block number n, for example `Driver_I2Cn`. The user application connects to this driver. + +**Code example** + +This is a demo application which demonstrates the usage of the I2C MultiSlave driver wrapper. It consists of two threads that periodically access two I2C slave devices. + +```c +#include +#include "cmsis_os2.h" + +#include "RTE_Components.h" +#include CMSIS_device_header + +#include "Driver_I2C.h" // ::CMSIS Driver:I2C + +/* Thread prototypes */ +static void Thread_A (void *argument); +static void Thread_B (void *argument); +static void app_main (void *argument); + +/* A and B Thread IDs */ +static osThreadId_t ThreadId_A; +static osThreadId_t ThreadId_B; + +/* I2C A Driver, controls Slave Device 0, uses underlying Driver_I2C1 (see I2C_MultiSlave_Config.h) */ +extern ARM_DRIVER_I2C Driver_I2C10; +#define I2C_A (&Driver_I2C10) + +/* I2C B Driver, controls Slave Device 1, uses underlying Driver_I2C1 (see I2C_MultiSlave_Config.h) */ +extern ARM_DRIVER_I2C Driver_I2C11; +#define I2C_B (&Driver_I2C11) + +/*---------------------------------------------------------------------------- + * I2C Thread A + *---------------------------------------------------------------------------*/ +__NO_RETURN static void Thread_A (void *argument) { + uint8_t addr; + uint8_t reg; + uint8_t val; + (void)argument; + + /* Initialize and configure I2C */ + I2C_A->Initialize (NULL); + I2C_A->PowerControl(ARM_POWER_FULL); + I2C_A->Control (ARM_I2C_BUS_SPEED, ARM_I2C_BUS_SPEED_FAST); + I2C_A->Control (ARM_I2C_BUS_CLEAR, 0); + + /* Periodically read device register at address 0x0F */ + addr = 0x68; + reg = 0x0F; + + while(1) { + I2C_A->MasterTransmit(addr, ®, 1, true); + while (I2C_A->GetStatus().busy); + + I2C_A->MasterReceive (addr, &val, 1, false); + while (I2C_B->GetStatus().busy); + + osDelay(10); + } +} + +/*---------------------------------------------------------------------------- + * I2C Thread B + *---------------------------------------------------------------------------*/ +__NO_RETURN static void Thread_B (void *argument) { + uint8_t addr; + uint8_t reg; + uint8_t val; + (void)argument; + + /* Initialize and configure I2C */ + I2C_B->Initialize (NULL); + I2C_B->PowerControl(ARM_POWER_FULL); + I2C_B->Control (ARM_I2C_BUS_SPEED, ARM_I2C_BUS_SPEED_STANDARD); + I2C_B->Control (ARM_I2C_BUS_CLEAR, 0); + + /* Periodically write device register at address 0x02 */ + addr = 0x44; + reg = 0x02; + val = 0xA5; + + while(1) { + I2C_A->MasterTransmit(addr, ®, 1, true); + while (I2C_A->GetStatus().busy); + + I2C_A->MasterTransmit(addr, &val, 1, false); + while (I2C_B->GetStatus().busy); + + osDelay(10); + } +} + +/*---------------------------------------------------------------------------- + * Application main thread + *---------------------------------------------------------------------------*/ +__NO_RETURN static void app_main (void *argument) { + (void)argument; + + /* Create SPI threads */ + ThreadId_A = osThreadNew(Thread_A, NULL, NULL); + ThreadId_B = osThreadNew(Thread_B, NULL, NULL); + + osDelay(osWaitForever); + + for (;;) {} +} + +int main (void) { + + // System Initialization + SystemCoreClockUpdate(); + + osKernelInitialize(); // Initialize CMSIS-RTOS + osThreadNew(app_main, NULL, NULL); // Create application main thread + osKernelStart(); // Start thread execution + for (;;) {} +} +``` diff --git a/Documentation/Doxygen/src/introduction.txt b/Documentation/Doxygen/src/introduction.txt deleted file mode 100644 index 8baa681..0000000 --- a/Documentation/Doxygen/src/introduction.txt +++ /dev/null @@ -1,904 +0,0 @@ -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\mainpage Overview - -The **[CMSIS-Driver specification](http://arm-software.github.io/CMSIS_6/latest/Driver/index.html)** defines a uniform software API for peripheral driver interfaces that can be used by middleware stacks and user applications. - -This documentation covers a set of reference CMSIS-Driver implementations for external peripheral devices. - -The implementations are maintained in a public **[GitHub repository](https://github.com/arm-software/CMSIS-Driver)**. Their releases in **[CMSIS Pack format](https://www.open-cmsis-pack.org/)** are also available on **[CMSIS Packs page](https://developer.arm.com/tools-and-software/embedded/cmsis/cmsis-packs)** under *Arm* - *CMSIS Drivers for external devices* category and can be used in environments supporting the CMSIS-Pack concept. - -Interested parties are welcome to contribute their drivers to the referenced repository. - -\section driver_pack_content Pack Content - -The ARM::CMSIS-Driver Pack contains the following items: - -File/Directory | Content -:-------------------------|:--------------------------------------------------------------------------------- -\b ARM.CMSIS-Driver.pdsc | Package description file in CMSIS-Pack format. -\b LICENSE | CMSIS license agreement (Apache 2.0) -\b Config/ | Configuration files for \ref driver_I2C, \ref driver_NAND, and \ref driver_SPI bus implementations -\b Documentation/ | This documentation -\b Ethernet/ | \ref driver_eth driver implementations -\b Ethernet_PHY/ | \ref driver_eth PHY driver implementations -\b Flash/ | \ref driver_Flash memory driver implementations -\b I2C/ | \ref driver_I2C driver implementations -\b NAND/ | \ref driver_NAND driver implementations -\b Shield/ | \ref shield_layer implementations -\b SPI/ | \ref driver_SPI driver implementations -\b USB/ | \ref driver_USB driver implementations -\b WiFi/ | \ref driver_WiFi driver implementations - -\section License License - -The CMSIS Driver example implementations are provided free of charge under Apache 2.0 license. -See the Apache 2.0 License. - -\subpage rev_hist - -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_eth Ethernet - -\section driver_eth_devices Driver Implementations - -The \ref driver_pack_content provides implementations of CMSIS-Ethernet drivers for the following devices: - - - - - - - \anchor driver_KSZ8851SNL - - - - - \anchor driver_LAN9220 - - - - - \anchor driver_DP83848C - - - - - \anchor driver_KSZ8061RNB - - - - - \anchor driver_KSZ8081RNA - - - - - \anchor driver_LAN8710A - - - - - \anchor driver_LAN8720 - - - - - \anchor driver_LAN8740A - - - - - \anchor driver_LAN8742A - - - - - \anchor driver_ST802RT1 - - - - -
DriverDescription
\b KSZ8851SNL/SNLI - Ethernet PHY and MAC interfaces for the Microchip KSZ8851. -
\b LAN9220 - Ethernet PHY and MAC interfaces for the Microchip LAN9220. -
\b DP83848C - Ethernet PHY interface for the Texas Instruments DP83848C. -
\b KSZ8061RNB - Ethernet PHY interface for the Microchip KSZ8061. -
\b KSZ8081RNA - Ethernet PHY interface for the Microchip KSZ8081. -
\b LAN8710A - Ethernet PHY interface for the Microchip LAN8710A. -
\b LAN8720 - Ethernet PHY interface for the Microchip LAN8720. -
\b LAN8740A - Ethernet PHY interface for the Microchip LAN8740A. -
\b LAN8742A - Ethernet PHY interface for the Microchip LAN8742A. -
\b ST802RT1 - Ethernet PHY interface for the STMicroelectronics ST802RT1. -
- -\section driver_eth_multiple Multiple Driver Instances - -CMSIS-Driver API supports multiple driver instances. The Ethernet drivers are implemented within a single C module and several driver instances of the same type can be used in a project as follows: -
    -
  • Add the first driver instance to the project. In IDEs with CMSIS-pack management support this can be done from the Run-Time Environment (RTE).
    • -
  • Create a copy of the driver's .c file with a different file name and add it to the project. This will be the second driver instance. For example, copy \c ETH_LAN9220.c file as \c ETH2_LAN9220.c.
    • -
  • Copy the driver's .h file to the project or add the driver's folder to the compiler include search path.
    • -
  • Specify the driver parameters for the second instance. For example, in \c ETH2_LAN9220.c new values to the following parameters are needed instead of default ones: - \code - #define ETH_MAC_NUM 1 - #define ETH_PHY_NUM 1 - #define LAN9220_BASE (0x53000000UL) - \endcode -
    • -
  • Now both Ethernet instances can be accessed from the application. For example: -\code -#include "Driver_ETH_MAC.h" -#include "Driver_ETH_PHY.h" - -extern ARM_DRIVER_ETH_MAC Driver_ETH_MAC0; -extern ARM_DRIVER_ETH_MAC Driver_ETH_MAC1; - -extern ARM_DRIVER_ETH_PHY Driver_ETH_PHY0; -extern ARM_DRIVER_ETH_PHY Driver_ETH_PHY1; - -#define eth0 (&Driver_ETH_MAC0) -#define eth1 (&Driver_ETH_MAC1) - -#define phy0 (&Driver_ETH_PHY0) -#define phy1 (&Driver_ETH_PHY1) -\endcode -
    • -
- -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_USB USB - -\section driver_usb Driver Implementations - -The \ref driver_pack_content provides implementations of CMSIS-USB drivers for the following controllers: - - - - - - - - - - - - - -
DriverDescription
\ref driver_EHCI - USB Host Driver for the EHCI with Transaction Translator (TT) host controller. -
\ref driver_OHCI - USB Host Driver for the OHCI host controller. -
- -\subsection driver_EHCI EHCI - -Enhanced Host Controller Interface (EHCI) with TT is EHCI controller with integrated Transaction Translator that supports high/full/low-speed devices. - -It is usually used in embedded devices to remove the requirement of having additional host controller (OHCI) for handling full/low-speed devices separately. - -This driver exports up to 2 driver instances thus it can support 2 EHCI with TT host controllers. - -It requires hardware-specific functions implementation that are available in the template module USBH_EHCI_HW.c. - -It is configured via define values in the USBH_EHCI_Config.h configuration file. - -Configuration - - - USB Host Controller 0: - - Export control block Driver_USBH#: Specifies the exported driver control block number. - - EHCI Registers base address: Specifies the absolute address at which EHCI controller registers are located. - - Locate EHCI Communication Area: Specifies if the communication area is located in a specific memory (via the linker script): - - Section name: Specifies the section name for the EHCI communication area (for positioning via the linker script). - - - USB Host Controller 1 (can be enabled/disabled): - - Export control block Driver_USBH#: Specifies the exported driver control block number. - - EHCI Registers base address: Specifies the absolute address at which EHCI controller registers are located. - - Locate EHCI Communication Area: Specifies if the communication area is located in a specific memory (via the linker script): - - Section name: Specifies the section name for the EHCI communication area (for positioning via the linker script). - - - Maximum number of Pipes (per controller): Specifies the maximum number of pipes that the driver will support (per controller). - -\subsection driver_OHCI OHCI - -Open Host Controller Interface (OHCI) is a host controller interface that supports full/low-speed devices. - -This driver exports up to 2 driver instances thus it can support 2 OHCI host controllers. - -It requires hardware-specific functions implementation that are available in the template module USBH_OHCI_HW.c. - -It is configured via define values in the USBH_OHCI_Config.h configuration file. - -Configuration - - - USB Host Controller 0: - - Export control block Driver_USBH#: Specifies the exported driver control block number. - - OHCI Registers base address: Specifies the absolute address at which OHCI controller registers are located. - - Locate OHCI Communication Area (HCCA): Specifies if the communication area is located in a specific memory (via the linker script): - - Section name: Specifies the section name for the OHCI communication area (for positioning via the linker script). - - - USB Host Controller 1 (can be enabled/disabled): - - Export control block Driver_USBH#: Specifies the exported driver control block number. - - OHCI Registers base address: Specifies the absolute address at which OHCI controller registers are located. - - Locate OHCI Communication Area (HCCA): Specifies if the communication area is located in a specific memory (via the linker script): - - Section name: Specifies the section name for the OHCI communication area (for positioning via the linker script). - - - Maximum number of Pipes (per controller): Specifies the maximum number of pipes that the driver will support (per controller). -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_WiFi WiFi - -\section driver_wifi_devices Driver Implementations - -The \ref driver_pack_content provides implementations of CMSIS-WiFi drivers for the following devices: - - - - - - - - - - - - - - - - - - - - - - - - - -
DriverDescription
\ref driver_DA16200 - WiFi Driver for the Renesas DA16200. -
\ref driver_ESP32 - WiFi Driver for the Espressif ESP32. -
\ref driver_ESP8266 - WiFi Driver for the Espressif ESP8266. -
\ref driver_ISM43362 - WiFi Driver for the Inventek ISM43362. -
\ref driver_WizFi360 - WiFi Driver for the WizNet WizFi360.
- -\subsection driver_DA16200 DA16200 - -The documentation for the Renesas DA16200 can be found here: https://www.renesas.com/eu/en/products/interface-connectivity/wireless-communications/wi-fi/da16200-ultra-low-power-wi-fi-soc-battery-powered-iot-devices - -__Required Firmware__ : **DA16200 FreeRTOS SDK Firmware Image v3.2.3.0 (or newer)** - -Firmware image and programming instructions **DA16200 DA16600 FreeRTOS Getting Started Guide** are also available on the above web site. - -\subsection driver_ESP32 ESP32 - -The documentation for the Espressif ESP32 can be found here: https://www.espressif.com/en/products/hardware/esp-wroom-32/overview - -\subsection driver_ESP8266 ESP8266 - -The documentation for the Espressif ESP8266 can be found here: https://www.espressif.com/en/products/hardware/esp8266ex/overview/ - -\subsection driver_ISM43362 ISM43362 - -The documentation for the Inventek ISM43362 can be found here: https://www.inventeksys.com/ism4336-m3g-l44-e-embedded-serial-to-wifi-module/ - -__Required Firmware__ : **SPI v6.2.1.7** - -For firmware update procedure see \ref shield_Inventek_ISMART43362-E_fw "Inventek ISMART43362-E Shield Firmware" section. - -\subsection driver_WizFi360 WizFi360 - -The documentation for the WIZnet WizFi360 can be found here: https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360 -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_Flash Flash - -\section driver_Flash_devices Driver Implementations - -The \ref driver_pack_content contains implementations of CMSIS-Flash drivers for the following devices: - - - - - - - \anchor driver_AM29x800BB - - - - - \anchor driver_AT45DB641E - - - - - \anchor driver_AT45DB642D - - - - - \anchor driver_M29EW28F128 - - - - - \anchor driver_M29W640FB - - - - - \anchor driver_N25Q032A - - - - - \anchor driver_S29GL064Nx2 - - - -
DriverDescription
\b AM29x800BBFlash interface for Parallel NOR Flash AM29x800BB. This product is discontinued.
\b AT45DB641EFlash interface for SPI Serial DataFlash AT45DB641E. -
\b AT45DB642DFlash interface for SPI Serial DataFlash AT45DB642D. -
\b M29EW28F128Flash interface for Parallel NOR Flash M29EW28F128. -
\b M29W640FBFlash interface for Parallel NOR Flash M29W640FB. -
\b N25Q032AFlash interface for Serial NOR Flash N25Q032A. -
\b S29GL064Nx2Flash interface for Parallel NOR Flash S29GL064N. -
- -\section driver_Flash_multiple Multiple Driver Instances - -CMSIS-Driver API supports multiple driver instances. The Flash drivers are implemented within a single C module and several driver instances of the same type can be used in a project as follows: -
    -
  • Add the first driver instance to the project. In IDEs with CMSIS-pack management support this can be done from the Run-Time Environment (RTE).
    • -
  • Create a copy of the driver's .c file with a different file name and add it to the project. This will be the second driver instance. For example, copy \c AT45DB641E.c file as \c AT45DB641E_2.c.
    • -
  • Copy the driver's .h file to the project or add the driver's folder to the compiler include search path.
    • -
  • Specify the driver parameters for the second instance based on the hardware design. For example, in \c AT45DB641E_2.c the values for the flash driver number and SPI driver number need to be configured as shown below: - \code - #define DRIVER_FLASH_NUM 1 - #define DRIVER_SPI_NUM 1 - \endcode -
    • -
  • Now both Flash instances can be accessed from the application. For example: -\code -#include "Driver_Flash.h" - -/* Flash driver instances */ -extern ARM_DRIVER_FLASH Driver_Flash0; -extern ARM_DRIVER_FLASH Driver_Flash1; - -#define flash0 (&Driver_Flash0) -#define flash1 (&Driver_Flash1) -\endcode -
    • -
- -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_I2C I2C - -The I2C MultiSlave wrapper (I2C_MultiSlave.c) resides on top of an arbitrary I2C CMSIS-Driver and exports maximum of -eight I2C CMSIS-Drivers (with I2C Master functionality only). Slave functionalities are disabled and calling slave functions -will return with an error. An I2C slave device connects to one of the exported driver and uses it as any other CMSIS I2C -driver (in master mode only). The wrapper provides multi-thread protection. - -Each slave can use its own bus speed configuration, but the MultiSlave wrapper will limit the bus speed to the lowest -requested frequency (assuming that three slaves are present and if two slaves configure bus speed \c ARM_I2C_BUS_SPEED_FAST -(400 KHz) and one slave \c ARM_I2C_BUS_SPEED_STANDARD (100 kHz), then the actual bus speed will be -\c ARM_I2C_BUS_SPEED_STANDARD). - -The wrapper is configured using the I2C_MultiSlave_Config.h file, which contains the following options: -- \c \#define \c I2C_DRIVER specifies the underlying I2C CMSIS-Driver, which controls the I2C peripheral and accesses the - bus. The wrapper connects to that driver. -- \c \#define \c I2C_ENABLE_SLAVE_x enables each connected slave on the I2C bus. This basically means that the driver control - block \c Driver_I2Cn will be exported by the wrapper for each particular slave. -- \c \#define \c I2C_DRIVER_SLAVE_x sets the exported control block number n, for example \c Driver_I2Cn. The user - application connects to this driver. - -Code example - -This is a demo application which demonstrates the usage of the I2C MultiSlave driver wrapper. It consists of two threads that -periodically access two I2C slave devices. - -\code -#include -#include "cmsis_os2.h" - -#include "RTE_Components.h" -#include CMSIS_device_header - -#include "Driver_I2C.h" // ::CMSIS Driver:I2C - -/* Thread prototypes */ -static void Thread_A (void *argument); -static void Thread_B (void *argument); -static void app_main (void *argument); - -/* A and B Thread IDs */ -static osThreadId_t ThreadId_A; -static osThreadId_t ThreadId_B; - -/* I2C A Driver, controls Slave Device 0, uses underlying Driver_I2C1 (see I2C_MultiSlave_Config.h) */ -extern ARM_DRIVER_I2C Driver_I2C10; -#define I2C_A (&Driver_I2C10) - -/* I2C B Driver, controls Slave Device 1, uses underlying Driver_I2C1 (see I2C_MultiSlave_Config.h) */ -extern ARM_DRIVER_I2C Driver_I2C11; -#define I2C_B (&Driver_I2C11) - -/*---------------------------------------------------------------------------- - * I2C Thread A - *---------------------------------------------------------------------------*/ -__NO_RETURN static void Thread_A (void *argument) { - uint8_t addr; - uint8_t reg; - uint8_t val; - (void)argument; - - /* Initialize and configure I2C */ - I2C_A->Initialize (NULL); - I2C_A->PowerControl(ARM_POWER_FULL); - I2C_A->Control (ARM_I2C_BUS_SPEED, ARM_I2C_BUS_SPEED_FAST); - I2C_A->Control (ARM_I2C_BUS_CLEAR, 0); - - /* Periodically read device register at address 0x0F */ - addr = 0x68; - reg = 0x0F; - - while(1) { - I2C_A->MasterTransmit(addr, ®, 1, true); - while (I2C_A->GetStatus().busy); - - I2C_A->MasterReceive (addr, &val, 1, false); - while (I2C_B->GetStatus().busy); - - osDelay(10); - } -} - -/*---------------------------------------------------------------------------- - * I2C Thread B - *---------------------------------------------------------------------------*/ -__NO_RETURN static void Thread_B (void *argument) { - uint8_t addr; - uint8_t reg; - uint8_t val; - (void)argument; - - /* Initialize and configure I2C */ - I2C_B->Initialize (NULL); - I2C_B->PowerControl(ARM_POWER_FULL); - I2C_B->Control (ARM_I2C_BUS_SPEED, ARM_I2C_BUS_SPEED_STANDARD); - I2C_B->Control (ARM_I2C_BUS_CLEAR, 0); - - /* Periodically write device register at address 0x02 */ - addr = 0x44; - reg = 0x02; - val = 0xA5; - - while(1) { - I2C_A->MasterTransmit(addr, ®, 1, true); - while (I2C_A->GetStatus().busy); - - I2C_A->MasterTransmit(addr, &val, 1, false); - while (I2C_B->GetStatus().busy); - - osDelay(10); - } -} - -/*---------------------------------------------------------------------------- - * Application main thread - *---------------------------------------------------------------------------*/ -__NO_RETURN static void app_main (void *argument) { - (void)argument; - - /* Create SPI threads */ - ThreadId_A = osThreadNew(Thread_A, NULL, NULL); - ThreadId_B = osThreadNew(Thread_B, NULL, NULL); - - osDelay(osWaitForever); - - for (;;) {} -} - -int main (void) { - - // System Initialization - SystemCoreClockUpdate(); - - osKernelInitialize(); // Initialize CMSIS-RTOS - osThreadNew(app_main, NULL, NULL); // Create application main thread - osKernelStart(); // Start thread execution - for (;;) {} -} -\endcode -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_NAND NAND - -This is a CMSIS compliant driver for NAND Flash devices that are connected to the microcontroller's memory bus. -It implements a [CMSIS-Driver NAND Interface](https://arm-software.github.io/CMSIS_6/latest/Driver/group__nand__interface__gr.html) -with up to four memory mapped NAND Flash devices. - -The driver is configured using the NAND_MemBus_Config.h configuration file, which contains the following options: -- \c \#define \c NAND_DRIVER exports the NAND CMSIS-Driver instance, which can be used to access the memory mapped NAND Flash devices. -- \c \#define \c NAND_DEVx enables the memory mapped NAND Flash device. -- \c \#define \c NAND_DEVx_ADDR_BASE specifies the base address of the Flash device, which is used to control the data/address lines and nCE, nRE, nWE lines. -- \c \#define \c NAND_DEVx_ADDR_ALE specifies the ALE address of the Flash device, which is used to control the ALE line. -- \c \#define \c NAND_DEVx_ADDR_CLE specifies the CLE address of the Flash device, which is used to control the CLE line. -- \c \#define \c NAND_DEVx_DATA_WIDTH specifies the data bus width of the Flash device. -- \c \#define \c NAND_DEVx_RB_PIN specifies if Ready/Busy line of the Flash device is available (used for Ready/Busy monitoring). -- \c \#define \c NAND_DEVx_RB_PIN_IRQ specifies if Ready/Busy line of the Flash device can trigger an interrupt. -*/ - - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page driver_SPI SPI - -The SPI MultiSlave wrapper (SPI_MultiSlave.c) resides on top of an arbitrary SPI CMSIS-Driver and exports a maximum of four -SPI CMSIS-Drivers with SPI Master functionality only. Slave functionalities are disabled and calling the slave functions will -return with an error. An SPI slave device connects to one of the exported drivers and uses it as any other SPI CMSIS-Driver -(in master mode only). The wrapper provides multi thread protection. - -Each slave can use a different bus configuration. The MultiSlave wrapper will detect which slave device is addressed by a -particular function call and reconfigure the SPI bus accordingly. When using the SPI MultiSlave wrapper, the slave select -mode must always be configured as \c ARM_SPI_SS_MASTER_SW. Since the underlying bus controlling SPI driver can only control -one slave select line at the time, the slave select line for each particular slave device is instead controlled by -the MultiSlave wrapper using the function SPI_Control_SlaveSelect that must be implemented in the user application. A -function prototype can be found in the SPI_Multislave.h header file and must be included in the project. - -When called from different threads, the MultiSlave wrapper can be busy (if any data transfer is in progress). In such a case, -transfer operation will be queued and executed immediately after the busy slave is deselected. The transfer queue operates -as a FIFO, so transfers will be executed in the same call order as expected by the application. - -The wrapper is configured using the SPI_MultiSlave_Config.h file, which contains the following options: -- \c \#define \c SPI_DRIVER specifies the underlying SPI CMSIS-Driver, which actually controls the SPI peripheral and the - accesses the bus. The wrapper will connect to that driver. -- \c \#define \c SPI_ENABLE_SLAVE_x enables each SPI bus connected slave. This basically means that the driver control block - Driver_SPIn will be exported by the wrapper for each particular slave. -- \c \#define \c SPI_DRIVER_SLAVE_x sets the exported control block number n, for example Driver_SPIn. The application - connects to this driver. - -Code example - -This is a demo application which demonstrates the usage of the SPI MultiSlave driver wrapper. It consists of two threads that -periodically access two SPI slave devices. - -\code -#include -#include "cmsis_os2.h" - -#include "RTE_Components.h" -#include CMSIS_device_header -#include "stm32f2xx_hal.h" - -#include "SPI_MultiSlave.h" // Keil::CMSIS Driver:SPI:Multi-Slave - -/* Thread prototypes */ -__NO_RETURN static void Thread_A (void *argument); -__NO_RETURN static void Thread_B (void *argument); -__NO_RETURN static void app_main (void *argument); - -/* A and B Thread IDs */ -static osThreadId_t ThreadId_A; -static osThreadId_t ThreadId_B; - -/* SPI A Driver, controls Slave Device 0, uses underlying Driver_SPI1 (see SPI_MultiSlaveConfig.h) */ -extern ARM_DRIVER_SPI Driver_SPI10; -#define SPI_A (&Driver_SPI10) - -/* SPI B Driver, controls Slave Device 1, uses underlying Driver_SPI1 (see SPI_MultiSlaveConfig.h) */ -extern ARM_DRIVER_SPI Driver_SPI11; -#define SPI_B (&Driver_SPI11) - -/* - Slave select pin control function. - - \param[in] driver SPI Driver Instance - \param[in] ss_state Slave Select signal state (ARM_SPI_SS_INACTIVE | ARM_SPI_SS_ACTIVE) -*/ -void SPI_Control_SlaveSelect (uint32_t device, uint32_t ss_state) { - GPIO_TypeDef* GPIOx; - uint16_t pin; - - if (device == 0) { - /* Select Device 0 SS pin (SPI_A) */ - GPIOx = GPIOE; - pin = GPIO_PIN_0; - } - else { - /* Select Device 1 SS pin (SPI_B) */ - GPIOx = GPIOE; - pin = GPIO_PIN_15; - } - - if (ss_state == ARM_SPI_SS_INACTIVE) { - /* Set GPIO pin high */ - HAL_GPIO_WritePin(GPIOx, pin, GPIO_PIN_SET); - } else { - /* Set GPIO pin low */ - HAL_GPIO_WritePin(GPIOx, pin, GPIO_PIN_RESET); - } -} - -/*---------------------------------------------------------------------------- - * SPI Thread A - *---------------------------------------------------------------------------*/ -static void Thread_A (void *argument) { - char *p = "Sending data to Slave Device 0"; - (void)argument; - - /* Initialize and configure SPI A */ - SPI_A->Initialize(NULL); - SPI_A->PowerControl(ARM_POWER_FULL); - SPI_A->Control(ARM_SPI_MODE_MASTER | ARM_SPI_CPOL0_CPHA0 \ - | ARM_SPI_DATA_BITS(8) \ - | ARM_SPI_MSB_LSB \ - | ARM_SPI_SS_MASTER_SW, - 10000000); - - SPI_A->Control(ARM_SPI_SET_DEFAULT_TX_VALUE, 0xFF); - - while(1) { - /* Send to Slave Device 0 */ - SPI_A->Control(ARM_SPI_CONTROL_SS, ARM_SPI_SS_ACTIVE); - SPI_A->Send(p, strlen(p)); - - /* Wait until SPI A busy (or alternatively, wait for SPI event) */ - while (SPI_A->GetStatus().busy); - SPI_A->Control (ARM_SPI_CONTROL_SS, ARM_SPI_SS_INACTIVE); - - osDelay(10); - } -} - -/*---------------------------------------------------------------------------- - * SPI Thread B - *---------------------------------------------------------------------------*/ -static void Thread_B (void *argument) { - char *p = "Sending data to Slave Device 1"; - (void)argument; - - /* Initialize and configure SPI B */ - SPI_B->Initialize(NULL); - SPI_B->PowerControl(ARM_POWER_FULL); - SPI_B->Control(ARM_SPI_MODE_MASTER | ARM_SPI_CPOL1_CPHA1 \ - | ARM_SPI_DATA_BITS(8) \ - | ARM_SPI_MSB_LSB \ - | ARM_SPI_SS_MASTER_SW, - 15000000); - - SPI_B->Control(ARM_SPI_SET_DEFAULT_TX_VALUE, 0xFF); - - while(1) { - /* Send to Slave Device 1 */ - SPI_B->Control(ARM_SPI_CONTROL_SS, ARM_SPI_SS_ACTIVE); - SPI_B->Send(p, strlen(p)); - - /* Wait until SPI B busy (or alternatively, wait for SPI event) */ - while (SPI_B->GetStatus().busy); - SPI_B->Control (ARM_SPI_CONTROL_SS, ARM_SPI_SS_INACTIVE); - - osDelay(10); - } -} - -/*---------------------------------------------------------------------------- - * Application main thread - *---------------------------------------------------------------------------*/ -static void app_main (void *argument) { - (void)argument; - - /* Create SPI threads */ - ThreadId_A = osThreadNew(Thread_A, NULL, NULL); - ThreadId_B = osThreadNew(Thread_B, NULL, NULL); - - osDelay(osWaitForever); - - for (;;) {} -} - -int main (void) { - - // System Initialization - SystemCoreClockUpdate(); - - osKernelInitialize(); // Initialize CMSIS-RTOS - osThreadNew(app_main, NULL, NULL); // Create application main thread - osKernelStart(); // Start thread execution - for (;;) {} -} -\endcode -*/ - -/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/ -/** -\page shield_layer Shield layer - -The **[Shield layer](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#shield-layer)** -adds support for additional hardware via plugin shields. - -\section shield_WiFi WiFi Shields - -The \ref driver_pack_content provides implementations of **Shield layers** for the following Arduino Uno WiFi shields: - - - - - - - - - - - - - - - - - - - - - -
Shield layerDescription
\ref shield_Inventek_ISMART43362-E - Shield layer for Inventek ISMART43362-E WiFi Shield. -
\ref shield_Sparkfun_DA16200 - Shield layer for Sparkfun DA16200WiFi Shield. -
\ref shield_Sparkfun_ESP8266 - Shield layer for Sparkfun ESP8266 WiFi Shield. -
\ref shield_WizNet_WizFi360-EVB - Shield layer for WizNet WizFi360-EVB WiFi Shield. -
- -\subsection shield_Inventek_ISMART43362-E Inventek ISMART43362-E - -Shield layer for [Inventek ISMART43362-E](https://www.inventeksys.com/ismart43362-arduino-shields-wi-fi) Arduino Uno WiFi Shield. -The shield is connected via an Arduino header using an SPI interface. - -| Provided API Interface | Description | -|---------------------------|--------------------------------| -| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | - -| Consumed API Interface | Description | -|---------------------------|----------------------------------------------------------------| -| ARDUINO_UNO_SPI | CMSIS-Driver SPI connected to Arduino SPI pins D11..D13 | -| ARDUINO_UNO_D9,D10 | CMSIS-Driver GPIO connected to Arduino digital I/O pins D9,D10 | -| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | - -\subsubsection shield_Inventek_ISMART43362-E_fw Firmware - -The ISMART43362-E Shield has two options to communicate with the underlying target hardware: UART and SPI. -By default, the module is flashed with the firmware for UART communication. -To enable SPI communication, follow these steps to flash the module: - -\b Prepare \b the \b hardware -- Set the power supply jumper on ISMART43362-E to connect 5V_USB and 5V_BOARD. -- Set the SW3 switch to position 1 (factory default position). - -\b Prepare \b the \b software -- Download - [ISM43362_M3G_L44_SPI_C6.2.1.7.zip](https://www.inventeksys.com/iwin/wp-content/uploads/ISM43362_M3G_L44_SPI_C6.2.1.7.zip) - and extract it locally. -- Download [eS-WIFi_Demo](https://www.inventeksys.com/iwin/wp-content/uploads/eS-WIFi_Demo.zip) -- Unzip the file and install the application on your PC. -- Start es-WiFi Demo and select Menu - Install Drivers and install both, CYW9WCD1EVAL1 and BCM9WCD1EVAL1: - \image html ISM43362_install_drivers.png -- Connect the ISMART43362-E to the PC using the Mini-USB connector. In Device Manager, you should see WICED USB Serial Port - (COMx). -- If not already done, assign a low COM port number. -- In the es-WiFi Demo application, execute: - - Go to Setup - Serial Port - Configure/Open: - \image html ISM43362_set_COM_port_conf.png - - Check the following settings (Serial Port being the one added just now): - \image html ISM43362_set_COM_port.png - - Go to Menu - Firmware - Update: - \image html ISM43362_update_firmware.png - - Select the binary image file extracted in the first step (ISM43362_M3G_L44_SPI_C6.2.1.7.bin). Make sure it is an SPI - firmware variant: - \image html ISM43362_module_detected.png -- After the firmware is updated, the console will show the message "Resetting...": - \image html ISM43362_update_firmware_resetting.png - You can now disconnect the module from the PC as it contains the new SPI firmware. - - If you want to flash a different firmware later, please visit - [Inventek's Firmware page](https://www.inventeksys.com/iwin/firmware/) for the latest binary files. - -\note Firmware version ISM43362_M3G_L44_SPI_C6.2.1.8 is not supported! - -\subsection shield_Sparkfun_DA16200 Sparkfun DA16200 - -Shield layer for [Sparkfun DA16200](https://www.sparkfun.com/products/18567) Arduino Uno WiFi Shield. -The shield is connected via an Arduino header using an UART interface. - -| Provided API Interface | Description | -|---------------------------|--------------------------------| -| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | - -| Consumed API Interface | Description | -|---------------------------|----------------------------------------------------------------| -| ARDUINO_UNO_UART | CMSIS-Driver USART connected to Arduino UART pins D0..D1 | -| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | - -\subsection shield_Sparkfun_ESP8266 Sparkfun ESP8266 - -Shield layer for [Sparkfun ESP8266](https://www.sparkfun.com/products/13287) Arduino Uno WiFi Shield. -The shield is connected via an Arduino header using an UART interface. - -| Provided API Interface | Description | -|---------------------------|--------------------------------| -| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | - -| Consumed API Interface | Description | -|---------------------------|----------------------------------------------------------------| -| ARDUINO_UNO_UART | CMSIS-Driver USART connected to Arduino UART pins D0..D1 | -| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | - -\subsubsection shield_Sparkfun_ESP8266_important Important considerations - -For correct operation of the Sparkfun ESP8266 WiFi Shield using the **Arduino R3** header, make sure that the jumpers are fitted as described in the table below: - -| Jumper | Setting | -|:------:|:-------:| -| J26 | closed | -| J27 | 1-2 | - -For correct operation, the Sparkfun ESP8266 WiFi Shield requires a proper reset functionality ensured by connecting together -the **RESET** pin on the Arduino connector with the **RST** pin in the area marked as **ESP8266 GPIO**, see the picture below: - -![Connection on the Sparkfun ESP8266 WiFi Shield](./images/Sparkfun_ESP8266_Reset_Connection.png) - -For stable operation, make sure that you are using an external **DC 5V** power supply (connected to **J2**). -Also, fit a jumper **J1** to **1-2** closed and set the switch **SW1** to position **2-3**. - -\subsection shield_WizNet_WizFi360-EVB WizNet WizFi360-EVB - -Shield layer for [WizNet WizFi360-EVB](https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/wizfi360_evb_shield) Arduino Uno WiFi Shield. -The shield is connected via an Arduino header using an UART interface. - -| Provided API Interface | Description | -|---------------------------|--------------------------------| -| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | - -| Consumed API Interface | Description | -|---------------------------|----------------------------------------------------------------| -| ARDUINO_UNO_UART | CMSIS-Driver USART connected to Arduino UART pins D0..D1 | -| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | - -\subsubsection shield_WizNet_WizFi360-EVB_fw Firmware - -The latest firmware images are available on the GitHub: https://github.com/wizfi/Release. - -Instructions on how to flash the firmware onto the device can be found on the WIZnet Documents page: -https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/documents#firmware-update-guide. - -*/ diff --git a/Documentation/Doxygen/src/mainpage.md b/Documentation/Doxygen/src/mainpage.md new file mode 100644 index 0000000..31ebbc1 --- /dev/null +++ b/Documentation/Doxygen/src/mainpage.md @@ -0,0 +1,34 @@ +# Overview {#mainpage} + +The **[CMSIS-Driver specification](http://arm-software.github.io/CMSIS_6/latest/Driver/index.html)** defines a uniform software API for peripheral driver interfaces that can be used by middleware stacks and user applications. + +This documentation covers a set of reference CMSIS-Driver implementations for external peripheral devices. + +The implementations are maintained in a public **[GitHub repository](https://github.com/arm-software/CMSIS-Driver)**. Their releases in **[CMSIS Pack format](https://www.open-cmsis-pack.org/)** are also available on **[CMSIS Packs page](https://developer.arm.com/tools-and-software/embedded/cmsis/cmsis-packs)** under *Arm* - *CMSIS Drivers for external devices* category and can be used in environments supporting the CMSIS-Pack concept. + +Interested parties are welcome to contribute their drivers to the referenced repository. + +## Pack Content {#pack_content} + +The **ARM::CMSIS-Driver** Pack contains the following items: + +| File/Directory | Content | +|-----------------------------|-----------------------------------------------------------------| +|📄 **ARM.CMSIS-Driver.pdsc** | Package description file in CMSIS-Pack format. | +|📄 **LICENSE** | CMSIS license agreement (Apache 2.0). | +|📂 **Config/** | Configuration files for I2C, NAND, and SPI bus implementations. | +|📂 **Documentation/** | This documentation. | +|📂 **Ethernet/** | [Ethernet](#page_driver_eth) driver implementations. | +|📂 **Ethernet_PHY/** | [Ethernet](#page_driver_eth) PHY driver implementations. | +|📂 **Flash/** | [Flash](#page_driver_flash) memory driver implementations. | +|📂 **I2C/** | [I2C](#page_driver_i2c) driver implementations. | +|📂 **NAND/** | [NAND](#page_driver_nand) driver implementations. | +|📂 **Shield/** | [Shield layer](#page_shield_layer) implementations. | +|📂 **SPI/** | [SPI](#page_driver_spi) driver implementations. | +|📂 **USB/** | [USB](#page_driver_usb) driver implementations. | +|📂 **WiFi/** | [WiFi](#page_driver_wifi) driver implementations. | + +## License + +The CMSIS Driver example implementations are provided free of charge under the Apache 2.0 license. +See the [Apache 2.0 License](https://raw.githubusercontent.com/ARM-software/CMSIS-Driver/main/LICENSE) diff --git a/Documentation/Doxygen/src/nand.md b/Documentation/Doxygen/src/nand.md new file mode 100644 index 0000000..385b6de --- /dev/null +++ b/Documentation/Doxygen/src/nand.md @@ -0,0 +1,14 @@ +# NAND {#page_driver_nand} + +This is a CMSIS compliant driver for NAND Flash devices that are connected to the microcontroller's memory bus. It implements a [CMSIS-Driver NAND Interface](https://arm-software.github.io/CMSIS_6/latest/Driver/group__nand__interface__gr.html) with up to four memory mapped NAND Flash devices. + +The driver is configured using the NAND_MemBus_Config.h configuration file, which contains the following options: + +- `#define NAND_DRIVER` exports the NAND CMSIS-Driver instance, which can be used to access the memory mapped NAND Flash devices. +- `#define NAND_DEVx` enables the memory mapped NAND Flash device. +- `#define NAND_DEVx_ADDR_BASE` specifies the base address of the Flash device, which is used to control the data/address lines and nCE, nRE, nWE lines. +- `#define NAND_DEVx_ADDR_ALE` specifies the ALE address of the Flash device, which is used to control the ALE line. +- `#define NAND_DEVx_ADDR_CLE` specifies the CLE address of the Flash device, which is used to control the CLE line. +- `#define NAND_DEVx_DATA_WIDTH` specifies the data bus width of the Flash device. +- `#define NAND_DEVx_RB_PIN` specifies if Ready/Busy line of the Flash device is available (used for Ready/Busy monitoring). +- `#define NAND_DEVx_RB_PIN_IRQ` specifies if Ready/Busy line of the Flash device can trigger an interrupt. diff --git a/Documentation/Doxygen/src/shield_layer.md b/Documentation/Doxygen/src/shield_layer.md new file mode 100644 index 0000000..e59fcc6 --- /dev/null +++ b/Documentation/Doxygen/src/shield_layer.md @@ -0,0 +1,126 @@ +# Shield layer {#page_shield_layer} + +The **[Shield layer](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#shield-layer)** adds support for additional hardware via plugin shields. + +## WiFi Shields + +The \ref pack_content provides implementations of **Shield layers** for the following Arduino Uno WiFi shields: + +| Shield layer | Description | +|----------------------------------------------------|------------------------------------------------------| +| **[Inventek_ISMART43362-E](#layer_ismart43362_e)** | Shield layer for Inventek ISMART43362-E WiFi Shield. | +| **[Sparkfun_DA16200](#layer_da16200)** | Shield layer for Sparkfun DA16200WiFi Shield. | +| **[Sparkfun_ESP8266](#layer_esp8266)** | Shield layer for Sparkfun ESP8266 WiFi Shield. | +| **[WizNet_WizFi360-EVB](#layer_wizfi360_evb)** | Shield layer for WizNet WizFi360-EVB WiFi Shield. | + +### Inventek ISMART43362-E {#layer_ismart43362_e} + +Shield layer for [Inventek ISMART43362-E](https://www.inventeksys.com/ismart43362-arduino-shields-wi-fi) Arduino Uno WiFi Shield. The shield is connected via an Arduino header using an SPI interface. + +| Provided API Interface | Description | +|---------------------------|--------------------------------| +| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | + +| Consumed API Interface | Description | +|---------------------------|----------------------------------------------------------------| +| ARDUINO_UNO_SPI | CMSIS-Driver SPI connected to Arduino SPI pins D11..D13 | +| ARDUINO_UNO_D9,D10 | CMSIS-Driver GPIO connected to Arduino digital I/O pins D9,D10 | +| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | + +#### Firmware {#inventek_ismart43362-e_firmware} + +The ISMART43362-E Shield has two options to communicate with the underlying target hardware: UART and SPI. +By default, the module is flashed with the firmware for UART communication. +To enable SPI communication, follow these steps to flash the module: + +**Prepare the hardware** + +- Set the power supply jumper on ISMART43362-E to connect 5V_USB and 5V_BOARD. +- Set the SW3 switch to position 1 (factory default position). + +**Prepare the software** + +- Download [ISM43362_M3G_L44_SPI_C6.2.1.7.zip](https://www.inventeksys.com/iwin/wp-content/uploads/ISM43362_M3G_L44_SPI_C6.2.1.7.zip) and extract it locally. +- Download [eS-WIFi_Demo](https://www.inventeksys.com/iwin/wp-content/uploads/eS-WIFi_Demo.zip) +- Unzip the file and install the application on your PC. +- Start es-WiFi Demo and select **Menu - Install Drivers** and install both, CYW9WCD1EVAL1 and BCM9WCD1EVAL1: + ![Install Drivers](./images/ISM43362_install_drivers.png) +- Connect the ISMART43362-E to the PC using the Mini-USB connector. In Device Manager, you should see WICED USB Serial Port (COMx). +- If not already done, assign a low COM port number. +- In the es-WiFi Demo application, execute: + - Go to **Setup - Serial Port - Configure/Open**: + ![Set COM Port](./images/ISM43362_set_COM_port_conf.png) + - Check the following settings (Serial Port being the one added just now): + ![Set COM Port](./images/ISM43362_set_COM_port.png) + - Go to **Menu - Firmware - Update**: + ![Update Firmware](./images/ISM43362_update_firmware.png) + - Select the binary image file extracted in the first step (ISM43362_M3G_L44_SPI_C6.2.1.7.bin). Make sure it is an SPI firmware variant: + ![Module Detected](./images/ISM43362_module_detected.png) +- After the firmware is updated, the console will show the message "Resetting...": + ![Resetting](./images/ISM43362_update_firmware_resetting.png) + You can now disconnect the module from the PC as it contains the new SPI firmware. + + If you want to flash a different firmware later, please visit [Inventek's Firmware page](https://www.inventeksys.com/iwin/firmware/) for the latest binary files. + +**Note:** Firmware version ISM43362_M3G_L44_SPI_C6.2.1.8 is not supported! + +### Sparkfun DA16200 {#layer_da16200} + +Shield layer for [Sparkfun DA16200](https://www.sparkfun.com/products/18567) Arduino Uno WiFi Shield. The shield is connected via an Arduino header using an UART interface. + +| Provided API Interface | Description | +|---------------------------|--------------------------------| +| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | + +| Consumed API Interface | Description | +|---------------------------|----------------------------------------------------------| +| ARDUINO_UNO_UART | CMSIS-Driver USART connected to Arduino UART pins D0..D1 | +| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | + +### Sparkfun ESP8266 {#layer_esp8266} + +Shield layer for [Sparkfun ESP8266](https://www.sparkfun.com/products/13287) Arduino Uno WiFi Shield. The shield is connected via an Arduino header using an UART interface. + +| Provided API Interface | Description | +|---------------------------|--------------------------------| +| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | + +| Consumed API Interface | Description | +|---------------------------|----------------------------------------------------------| +| ARDUINO_UNO_UART | CMSIS-Driver USART connected to Arduino UART pins D0..D1 | +| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | + +#### Important considerations + +For correct operation of the Sparkfun ESP8266 WiFi Shield using the **Arduino R3** header, make sure that the jumpers are fitted as described in the table below: + +| Jumper | Setting | +|:------:|:-------:| +| J26 | closed | +| J27 | 1-2 | + +For correct operation, the Sparkfun ESP8266 WiFi Shield requires a proper reset functionality ensured by connecting together the **RESET** pin on the Arduino connector with the **RST** pin in the area marked as **ESP8266 GPIO**, see the picture below: + +![Connection on the Sparkfun ESP8266 WiFi Shield](./images/Sparkfun_ESP8266_Reset_Connection.png) + +For stable operation, make sure that you are using an external **DC 5V** power supply (connected to **J2**). +Also, fit a jumper **J1** to **1-2** closed and set the switch **SW1** to position **2-3**. + +### WizNet WizFi360-EVB {#layer_wizfi360_evb} + +Shield layer for [WizNet WizFi360-EVB](https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/wizfi360_evb_shield) Arduino Uno WiFi Shield. The shield is connected via an Arduino header using an UART interface. + +| Provided API Interface | Description | +|---------------------------|--------------------------------| +| CMSIS_WIFI | CMSIS-Driver WIFI (instance 0) | + +| Consumed API Interface | Description | +|---------------------------|----------------------------------------------------------| +| ARDUINO_UNO_UART | CMSIS-Driver USART connected to Arduino UART pins D0..D1 | +| CMSIS-RTOS2 | CMSIS-RTOS2 compliant RTOS | + +#### Firmware + +The latest firmware images are available on the GitHub: https://github.com/wizfi/Release. + +Instructions on how to flash the firmware onto the device can be found on the WIZnet Documents page: https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360/documents#firmware-update-guide. diff --git a/Documentation/Doxygen/src/spi.md b/Documentation/Doxygen/src/spi.md new file mode 100644 index 0000000..8ab4bd6 --- /dev/null +++ b/Documentation/Doxygen/src/spi.md @@ -0,0 +1,163 @@ +# SPI {#page_driver_spi} + +The SPI MultiSlave wrapper [SPI_MultiSlave.c](https://github.com/ARM-software/CMSIS-Driver/blob/main/SPI/SPI_MultiSlave.c) resides on top of an arbitrary SPI CMSIS-Driver and exports a maximum of four SPI CMSIS-Drivers with SPI Master functionality only. Slave functionalities are disabled and calling the slave functions will return with an error. An SPI slave device connects to one of the exported drivers and uses it as any other SPI CMSIS-Driver (in master mode only). The wrapper provides multi thread protection. + +Each slave can use a different bus configuration. The MultiSlave wrapper will detect which slave device is addressed by a particular function call and reconfigure the SPI bus accordingly. When using the SPI MultiSlave wrapper, the slave select mode must always be configured as `ARM_SPI_SS_MASTER_SW`. Since the underlying bus controlling SPI driver can only control one slave select line at the time, the slave select line for each particular slave device is instead controlled by the MultiSlave wrapper using the function SPI_Control_SlaveSelect that must be implemented in the user application. A function prototype can be found in the [SPI_Multislave.h](https://github.com/ARM-software/CMSIS-Driver/blob/main/SPI/SPI_MultiSlave.h) header file and must be included in the project. + +When called from different threads, the MultiSlave wrapper can be busy (if any data transfer is in progress). In such a case, transfer operation will be queued and executed immediately after the busy slave is deselected. The transfer queue operates as a FIFO, so transfers will be executed in the same call order as expected by the application. + +The wrapper is configured using the [SPI_MultiSlave_Config.h](https://github.com/ARM-software/CMSIS-Driver/blob/main/Config/SPI_MultiSlave_Config.h) file, which contains the following options: + +- `#define SPI_DRIVER` specifies the underlying SPI CMSIS-Driver, which actually controls the SPI peripheral and the accesses the bus. The wrapper will connect to that driver. +- `#define SPI_ENABLE_SLAVE_x` enables each SPI bus connected slave. This basically means that the driver control block `Driver_SPIn` will be exported by the wrapper for each particular slave. +- `#define SPI_DRIVER_SLAVE_x` sets the exported control block number n, for example `Driver_SPIn`. The application connects to this driver. + +**Code example** + +This is a demo application which demonstrates the usage of the SPI MultiSlave driver wrapper. It consists of two threads that periodically access two SPI slave devices. + +```c +#include +#include "cmsis_os2.h" + +#include "RTE_Components.h" +#include CMSIS_device_header +#include "stm32f2xx_hal.h" + +#include "SPI_MultiSlave.h" // Keil::CMSIS Driver:SPI:Multi-Slave + +/* Thread prototypes */ +__NO_RETURN static void Thread_A (void *argument); +__NO_RETURN static void Thread_B (void *argument); +__NO_RETURN static void app_main (void *argument); + +/* A and B Thread IDs */ +static osThreadId_t ThreadId_A; +static osThreadId_t ThreadId_B; + +/* SPI A Driver, controls Slave Device 0, uses underlying Driver_SPI1 (see SPI_MultiSlaveConfig.h) */ +extern ARM_DRIVER_SPI Driver_SPI10; +#define SPI_A (&Driver_SPI10) + +/* SPI B Driver, controls Slave Device 1, uses underlying Driver_SPI1 (see SPI_MultiSlaveConfig.h) */ +extern ARM_DRIVER_SPI Driver_SPI11; +#define SPI_B (&Driver_SPI11) + +/* + Slave select pin control function. + + \param[in] driver SPI Driver Instance + \param[in] ss_state Slave Select signal state (ARM_SPI_SS_INACTIVE | ARM_SPI_SS_ACTIVE) +*/ +void SPI_Control_SlaveSelect (uint32_t device, uint32_t ss_state) { + GPIO_TypeDef* GPIOx; + uint16_t pin; + + if (device == 0) { + /* Select Device 0 SS pin (SPI_A) */ + GPIOx = GPIOE; + pin = GPIO_PIN_0; + } + else { + /* Select Device 1 SS pin (SPI_B) */ + GPIOx = GPIOE; + pin = GPIO_PIN_15; + } + + if (ss_state == ARM_SPI_SS_INACTIVE) { + /* Set GPIO pin high */ + HAL_GPIO_WritePin(GPIOx, pin, GPIO_PIN_SET); + } else { + /* Set GPIO pin low */ + HAL_GPIO_WritePin(GPIOx, pin, GPIO_PIN_RESET); + } +} + +/*---------------------------------------------------------------------------- + * SPI Thread A + *---------------------------------------------------------------------------*/ +static void Thread_A (void *argument) { + char *p = "Sending data to Slave Device 0"; + (void)argument; + + /* Initialize and configure SPI A */ + SPI_A->Initialize(NULL); + SPI_A->PowerControl(ARM_POWER_FULL); + SPI_A->Control(ARM_SPI_MODE_MASTER | ARM_SPI_CPOL0_CPHA0 \ + | ARM_SPI_DATA_BITS(8) \ + | ARM_SPI_MSB_LSB \ + | ARM_SPI_SS_MASTER_SW, + 10000000); + + SPI_A->Control(ARM_SPI_SET_DEFAULT_TX_VALUE, 0xFF); + + while(1) { + /* Send to Slave Device 0 */ + SPI_A->Control(ARM_SPI_CONTROL_SS, ARM_SPI_SS_ACTIVE); + SPI_A->Send(p, strlen(p)); + + /* Wait until SPI A busy (or alternatively, wait for SPI event) */ + while (SPI_A->GetStatus().busy); + SPI_A->Control (ARM_SPI_CONTROL_SS, ARM_SPI_SS_INACTIVE); + + osDelay(10); + } +} + +/*---------------------------------------------------------------------------- + * SPI Thread B + *---------------------------------------------------------------------------*/ +static void Thread_B (void *argument) { + char *p = "Sending data to Slave Device 1"; + (void)argument; + + /* Initialize and configure SPI B */ + SPI_B->Initialize(NULL); + SPI_B->PowerControl(ARM_POWER_FULL); + SPI_B->Control(ARM_SPI_MODE_MASTER | ARM_SPI_CPOL1_CPHA1 \ + | ARM_SPI_DATA_BITS(8) \ + | ARM_SPI_MSB_LSB \ + | ARM_SPI_SS_MASTER_SW, + 15000000); + + SPI_B->Control(ARM_SPI_SET_DEFAULT_TX_VALUE, 0xFF); + + while(1) { + /* Send to Slave Device 1 */ + SPI_B->Control(ARM_SPI_CONTROL_SS, ARM_SPI_SS_ACTIVE); + SPI_B->Send(p, strlen(p)); + + /* Wait until SPI B busy (or alternatively, wait for SPI event) */ + while (SPI_B->GetStatus().busy); + SPI_B->Control (ARM_SPI_CONTROL_SS, ARM_SPI_SS_INACTIVE); + + osDelay(10); + } +} + +/*---------------------------------------------------------------------------- + * Application main thread + *---------------------------------------------------------------------------*/ +static void app_main (void *argument) { + (void)argument; + + /* Create SPI threads */ + ThreadId_A = osThreadNew(Thread_A, NULL, NULL); + ThreadId_B = osThreadNew(Thread_B, NULL, NULL); + + osDelay(osWaitForever); + + for (;;) {} +} + +int main (void) { + + // System Initialization + SystemCoreClockUpdate(); + + osKernelInitialize(); // Initialize CMSIS-RTOS + osThreadNew(app_main, NULL, NULL); // Create application main thread + osKernelStart(); // Start thread execution + for (;;) {} +} +``` diff --git a/Documentation/Doxygen/src/usb.md b/Documentation/Doxygen/src/usb.md new file mode 100644 index 0000000..9e77b38 --- /dev/null +++ b/Documentation/Doxygen/src/usb.md @@ -0,0 +1,64 @@ +# USB {#page_driver_usb} + +## Driver Implementations + +The \ref pack_content provides implementations of **[CMSIS-USB drivers](https://arm-software.github.io/CMSIS_6/latest/Driver/group__usb__interface__gr.html)** for the following controllers: + +| Driver | Description | +|----------------|--------------------------------------------------------------------------------| +| **EHCI** | USB Host Driver for the EHCI with Transaction Translator (TT) host controller. | +| **OHCI** | USB Host Driver for the OHCI host controller. | + +### EHCI + +Enhanced Host Controller Interface (EHCI) with TT is EHCI controller with integrated Transaction Translator that supports high/full/low-speed devices. + +It is usually used in embedded devices to remove the requirement of having additional host controller (OHCI) for handling full/low-speed devices separately. + +This driver exports up to 2 driver instances thus it can support 2 EHCI with TT host controllers. + +It requires hardware-specific functions implementation that are available in the template module **USBH_EHCI_HW.c**. + +It is configured via define values in the **USBH_EHCI_Config.h** configuration file. + +**Configuration** + +- **USB Host Controller 0**: + - **Export control block Driver_USBH#**: Specifies the exported driver control block number. + - **EHCI Registers base address**: Specifies the absolute address at which EHCI controller registers are located. + - **Locate EHCI Communication Area**: Specifies if the communication area is located in a specific memory (via the linker script): + - **Section name**: Specifies the section name for the EHCI communication area (for positioning via the linker script). + +- **USB Host Controller 1** (can be enabled/disabled): + - **Export control block Driver_USBH#**: Specifies the exported driver control block number. + - **EHCI Registers base address**: Specifies the absolute address at which EHCI controller registers are located. + - **Locate EHCI Communication Area**: Specifies if the communication area is located in a specific memory (via the linker script): + - **Section name**: Specifies the section name for the EHCI communication area (for positioning via the linker script). + +- **Maximum number of Pipes (per controller)**: Specifies the maximum number of pipes that the driver will support (per controller). + +### OHCI + +Open Host Controller Interface (OHCI) is a host controller interface that supports full/low-speed devices. + +This driver exports up to 2 driver instances thus it can support 2 OHCI host controllers. + +It requires hardware-specific functions implementation that are available in the template module **USBH_OHCI_HW.c**. + +It is configured via define values in the **USBH_OHCI_Config.h** configuration file. + +**Configuration** + +- **USB Host Controller 0**: + - **Export control block Driver_USBH#**: Specifies the exported driver control block number. + - **OHCI Registers base address**: Specifies the absolute address at which OHCI controller registers are located. + - **Locate OHCI Communication Area (HCCA)**: Specifies if the communication area is located in a specific memory (via the linker script): + - **Section name**: Specifies the section name for the OHCI communication area (for positioning via the linker script). + +- **USB Host Controller 1** (can be enabled/disabled): + - **Export control block Driver_USBH#**: Specifies the exported driver control block number. + - **OHCI Registers base address**: Specifies the absolute address at which OHCI controller registers are located. + - **Locate OHCI Communication Area (HCCA)**: Specifies if the communication area is located in a specific memory (via the linker script): + - **Section name**: Specifies the section name for the OHCI communication area (for positioning via the linker script). + +- **Maximum number of Pipes (per controller)**: Specifies the maximum number of pipes that the driver will support (per controller). diff --git a/Documentation/Doxygen/src/wifi.md b/Documentation/Doxygen/src/wifi.md new file mode 100644 index 0000000..ba48c5b --- /dev/null +++ b/Documentation/Doxygen/src/wifi.md @@ -0,0 +1,51 @@ +# WiFi {#page_driver_wifi} + +## Driver Implementations + +The \ref pack_content provides implementations of **[CMSIS-WiFi drivers](https://arm-software.github.io/CMSIS_6/latest/Driver/group__wifi__interface__gr.html)** for the following devices: + +| Driver | Description | +|--------------------------------|----------------------------------------| +| **[DA16200](#wifi_da16200)** | WiFi Driver for the Renesas DA16200. | +| **[ESP32](#wifi_esp32)** | WiFi Driver for the Espressif ESP32. | +| **[ESP8266](#wifi_esp8266)** | WiFi Driver for the Espressif ESP8266. | +| **[ISM43362](#wifi_ism43362)** | WiFi Driver for the Inventek ISM43362. | +| **[WizFi360](#wifi_wizfi360)** | WiFi Driver for the WizNet WizFi360. | + +### DA16200 {#wifi_da16200} + +The documentation for the Renesas DA16200 can be found here: + +- https://www.renesas.com/eu/en/products/interface-connectivity/wireless-communications/wi-fi/da16200-ultra-low-power-wi-fi-soc-battery-powered-iot-devices + +**Required Firmware** : **DA16200 FreeRTOS SDK Firmware Image v3.2.3.0 (or newer)** + +Firmware image and programming instructions **DA16200 DA16600 FreeRTOS Getting Started Guide** are also available on the above web site. + +### ESP32 {#wifi_esp32} + +The documentation for the Espressif ESP32 can be found here: + +- https://www.espressif.com/en/products/hardware/esp-wroom-32/overview + +### ESP8266 {#wifi_esp8266} + +The documentation for the Espressif ESP8266 can be found here: + +- https://www.espressif.com/en/products/hardware/esp8266ex/overview/ + +### ISM43362 {#wifi_ism43362} + +The documentation for the Inventek ISM43362 can be found here: + +- https://www.inventeksys.com/ism4336-m3g-l44-e-embedded-serial-to-wifi-module/ + +**Required Firmware** : **SPI v6.2.1.7** + +For firmware update procedure see [Inventek ISMART43362-E Shield Firmware](#inventek_ismart43362-e_firmware) section. + +### WizFi360 {#wifi_wizfi360} + +The documentation for the WIZnet WizFi360 can be found here: + +- https://docs.wiznet.io/Product/Wi-Fi-Module/WizFi360 From a6e885aa5a574a4e6563889d80e211730a079d15 Mon Sep 17 00:00:00 2001 From: Vladimir Umek Date: Tue, 1 Apr 2025 14:23:12 +0200 Subject: [PATCH 3/3] Update links in the pack description file --- ARM.CMSIS-Driver.pdsc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ARM.CMSIS-Driver.pdsc b/ARM.CMSIS-Driver.pdsc index d508885..357f85a 100644 --- a/ARM.CMSIS-Driver.pdsc +++ b/ARM.CMSIS-Driver.pdsc @@ -130,7 +130,7 @@ #define RTE_Drivers_PHY_DP83848C /* Driver PHY DP83848C */ - + @@ -226,7 +226,7 @@ #define RTE_Drivers_PHY_ST802RT1 /* Driver PHY ST802RT1 */ - + @@ -311,7 +311,7 @@ #define RTE_Drivers_Flash_S29GL064Nx2 /* Driver Flash S29GL064Nx2 */ - + @@ -337,7 +337,7 @@ #define RTE_Drivers_I2C_MultiSlave /* Driver I2C Multi-Slave */ - + @@ -351,7 +351,7 @@ #define RTE_Drivers_SPI_MultiSlave /* Driver SPI Multi-Slave */ - +