Added CMSIS-RTOS API documentation
diff --git a/CMSIS/DoxyGen/RTOS/doxygen_rtos.bat b/CMSIS/DoxyGen/RTOS/doxygen_rtos.bat
new file mode 100644
index 0000000..ef7d284
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/doxygen_rtos.bat
@@ -0,0 +1,2 @@
+REM Generates Documentation Part for CMSIS-RTOS
+doxygen rtos.dxy
diff --git a/CMSIS/DoxyGen/RTOS/rtos.dxy b/CMSIS/DoxyGen/RTOS/rtos.dxy
new file mode 100644
index 0000000..7321e9b
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/rtos.dxy
@@ -0,0 +1,1848 @@
+# Doxyfile 1.8.2
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or sequence of words) that should
+# identify the project. Note that if you do not use Doxywizard you need
+# to put quotes around the project name if it contains spaces.
+
+PROJECT_NAME = CMSIS-RTOS
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = "Version 2.00"
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer
+# a quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF = "CMSIS-RTOS API: Generic RTOS interface for Cortex-M processor-based devices."
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is
+# included in the documentation. The maximum height of the logo should not
+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
+# Doxygen will copy the logo to the output directory.
+
+PROJECT_LOGO = ../Doxygen_Templates/CMSIS_Logo_Final.png
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = ../../Documentation/RTOS
+
+# 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 cause performance problems for the file system.
+
+CREATE_SUBDIRS = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = NO
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then 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.
+
+FULL_PATH_NAMES = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip. Note that you specify absolute paths here, but also
+# relative paths, which will be relative from the directory where doxygen is
+# started.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful if your file system
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+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
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = YES
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS = NO
+
+# 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.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding
+# "class=itcl::class" will allow you to use the command class in the
+# itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension,
+# and language is one of the parsers supported by doxygen: IDL, Java,
+# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
+# C++. 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
+# that for custom extensions you also need to set FILE_PATTERNS otherwise the
+# files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you
+# can mix doxygen, HTML, and XML commands with Markdown formatting.
+# Disable only in case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT = YES
+
+# 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 by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also makes the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip 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.
+
+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 (the
+# default) will make doxygen 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.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
+# unions are shown inside the group in which they are included (e.g. using
+# @ingroup) instead of on a separate page (for HTML and Man pages) or
+# section (for LaTeX and RTF).
+
+INLINE_GROUPED_CLASSES = YES
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
+# unions with only public data fields will be shown inline in the documentation
+# of the scope in which they are defined (i.e. file, namespace, or group
+# documentation), provided this scope is documented. If set to NO (the default),
+# structs, classes, and unions are shown on a separate page (for HTML and Man
+# pages) or section (for LaTeX and RTF).
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT = YES
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penalty.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will roughly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+SYMBOL_CACHE_SIZE = 0
+
+# Similar to the SYMBOL_CACHE_SIZE 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 appear multiple times in the code, doxygen keeps a cache of
+# pre-resolved symbols. If the cache is too small doxygen will become slower.
+# If the cache is too large, memory is wasted. The cache size is given by this
+# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = YES
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
+# scope will be included in the documentation.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespaces are hidden.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) 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.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = YES
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) 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.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
+# do proper type resolution of all parameters of a function it will reject a
+# match between the prototype and the implementation of a member function even
+# if there is only one candidate or it is obvious which candidate to choose
+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
+# will still accept a match between prototype and implementation in such cases.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or macro consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and macros in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 1
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page. This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option.
+# You can optionally specify a file name after the option, if omitted
+# DoxygenLayout.xml will be used as the name of the layout file.
+
+LAYOUT_FILE = ../Doxygen_Templates/DoxygenLayout_forUser.xml
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files
+# containing the references data. This must be a list of .bib files. The
+# .bib extension is automatically appended if omitted. Using this command
+# requires the bibtex tool to be installed. See also
+# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
+# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
+# feature you need bibtex and perl available in the search path.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED 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.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# The 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 (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC = YES
+
+# 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)
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = . \
+ ../../RTOS/Template/cmsis_os.h
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
+# *.f90 *.f *.for *.vhd *.vhdl
+
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.idl \
+ *.odl \
+ *.cs \
+ *.php \
+ *.php3 \
+ *.inc \
+ *.m \
+ *.mm \
+ *.dox \
+ *.py \
+ *.f90 \
+ *.f \
+ *.for \
+ *.vhd \
+ *.vhdl \
+ *.txt
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE = system*.c \
+ startup*.s
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS = YES
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+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 = ..\..\RTOS
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH = src/images
+
+# 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 <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output. If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty or if
+# non of the patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
+# and it is also possible to disable source filtering for a specific pattern
+# using *.ext= (so without naming a filter). This option only has effect when
+# FILTER_SOURCE_FILES is enabled.
+
+FILTER_SOURCE_PATTERNS =
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C, C++ and Fortran comments will always remain visible.
+
+STRIP_CODE_COMMENTS = NO
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code. Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = NO
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) 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.
+
+VERBATIM_HEADERS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header. Note that when using a custom header you are responsible
+# for the proper inclusion of any scripts and style sheets that doxygen
+# needs, which is dependent on the configuration options used.
+# It is advised to generate a default header using "doxygen -w html
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
+# that header. Note that the header is subject to change so you typically
+# have to redo this when upgrading to a newer version of doxygen or when
+# changing the value of configuration settings such as GENERATE_TREEVIEW!
+
+HTML_HEADER = ../Doxygen_Templates/cmsis_header.html
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER = ../Doxygen_Templates/cmsis_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. Note that it is recommended to use
+# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
+# tag will in the future become obsolete.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
+# user-defined cascading style sheet that is included after the standard
+# style sheets created by doxygen. Using this option one can overrule
+# certain style aspects. This is preferred over using HTML_STYLESHEET
+# since it does not replace the standard style sheet and is therefor more
+# robust against future updates. Doxygen will copy the style sheet file to
+# the output directory.
+
+HTML_EXTRA_STYLESHEET = ../Doxygen_Templates/cmsis.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
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
+# the files will be copied as-is; there are no commands or markers available.
+
+HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \
+ ../Doxygen_Templates/tab_topnav.png \
+ ../Doxygen_Templates/printComponentTabs.js
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the style sheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+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 NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
+# entries shown in the various tree structured indices initially; the user
+# can expand and collapse entries dynamically later on. Doxygen will expand
+# the tree to such a level that at most the specified number of entries are
+# visible (unless a fully collapsed tree already exceeds this amount).
+# So setting the number of entries 1 will produce a full collapsed tree by
+# default. 0 is a special value representing an infinite number of entries
+# and will result in a full expanded tree by default.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+
+GENERATE_DOCSET = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# 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.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, 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.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
+# identify the documentation publisher. This should be a reverse domain-name
+# style string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING =
+
+# If the GENERATE_HTMLHELP tag is set to YES, 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.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
+# that can be used as input for Qt's qhelpgenerator to generate a
+# Qt Compressed Help (.qch) of the generated HTML documentation.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
+# at top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it. Since the tabs have the same information as the
+# navigation tree you can set this option to NO if you already set
+# GENERATE_TREEVIEW to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to YES, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+# Since the tree basically has the same information as the tab index you
+# could consider to set DISABLE_INDEX to NO when enabling this option.
+
+GENERATE_TREEVIEW = YES
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
+# documentation. Note that a value of 0 will completely suppress the enum
+# values from appearing in the overview section.
+
+ENUM_VALUES_PER_LINE = 1
+
+# 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.
+
+TREEVIEW_WIDTH = 250
+
+# When 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.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
+# (see http://www.mathjax.org) which uses client side Javascript for the
+# rendering instead of using prerendered bitmaps. Use this if you do not
+# have LaTeX installed or if you want to formulas look prettier in the HTML
+# output. When enabled you may also need to install MathJax separately and
+# configure the path to it using the MATHJAX_RELPATH option.
+
+USE_MATHJAX = NO
+
+# When MathJax is enabled you need to specify the location relative to the
+# HTML output directory using the MATHJAX_RELPATH option. The destination
+# directory should contain the MathJax.js script. For instance, if the mathjax
+# directory is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to
+# the MathJax Content Delivery Network so you can quickly see the result without
+# installing MathJax. However, it is strongly recommended to install a local
+# copy of MathJax from http://www.mathjax.org before deployment.
+
+MATHJAX_RELPATH = http://www.mathjax.org/mathjax
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
+# names that should be enabled during MathJax rendering.
+
+MATHJAX_EXTENSIONS =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvantages are that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# 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.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal 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. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal 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. Notice: only use this tag if you know what you are doing!
+
+LATEX_FOOTER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+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.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
+# http://en.wikipedia.org/wiki/BibTeX for more info.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# 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 very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = 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.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load style sheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# 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. The default is NO.
+
+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 captures the structure of
+# the code including all documentation.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+# 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.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# 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.
+
+GENERATE_PERLMOD = NO
+
+# 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.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
+
+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.
+
+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
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+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
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+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 macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition that
+# overrules the definition found in the source code.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) 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, because these will confuse the parser if not removed.
+
+SKIP_FUNCTION_MACROS = NO
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles. For each
+# tag file the location of the external documentation should be added. The
+# format of a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths
+# or URLs. Note that 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 run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+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 listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF 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.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_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.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# 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, 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)
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) 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.
+
+DOT_NUM_THREADS = 0
+
+# By default doxygen will use the Helvetica font for all dot files that
+# doxygen generates. When you want a differently looking font 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.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the Helvetica font.
+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
+# set the path where dot can find it.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are 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.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are 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.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS = YES
+
+# 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.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# managable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are 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.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are 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. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are 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. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will generate a graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH and HAVE_DOT tags are 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.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are svg, png, jpg, or gif.
+# If left blank png will be used. 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).
+
+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.
+# Note that this requires a modern browser other than Internet Explorer.
+# Tested and working are Firefox, Chrome, Safari, and Opera. 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.
+
+INTERACTIVE_SVG = NO
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the 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).
+
+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).
+
+MSCFILE_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 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.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+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).
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES 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 this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
diff --git a/CMSIS/DoxyGen/RTOS/src/cmsis_os.txt b/CMSIS/DoxyGen/RTOS/src/cmsis_os.txt
new file mode 100644
index 0000000..08253f1
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/cmsis_os.txt
@@ -0,0 +1,2862 @@
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\mainpage Overview
+
+The CMSIS-RTOS API is a generic RTOS interface for ARM® Cortex®-M processor-based devices. CMSIS-RTOS provides a
+standardized API for software components that require RTOS functionality and gives therefore serious benefits to the users
+and the software industry.
+ - CMSIS-RTOS provides basic features that are required in many applications or technologies such as UML or Java (JVM).
+ - The unified feature set of the CMSIS-RTOS API simplifies sharing of software components and reduces learning efforts.
+ - Middleware components that use the CMSIS-RTOS API are RTOS agnostic. CMSIS-RTOS compliant middleware is easier to adapt.
+ - Standard project templates (such as motor control) of the CMSIS-RTOS API may be shipped with freely available CMSIS-RTOS
+ implementations.
+
+
+\note The CMSIS-RTOS API defines a minimum feature set. Implementations with extended features may be provided by RTOS
+ vendors.
+
+\image html "API_Structure.png" "CMSIS-RTOS API Structure"
+
+A typical CMSIS-RTOS API implementation interfaces to an existing real-time Kernel. The CMSIS-RTOS API provides the following
+attributes and functionalities:
+ - Function names, identifiers, and parameters are descriptive and easy to understand. The functions are powerful and
+ flexible which reduces the number of functions exposed to the user.
+ - \ref CMSIS_RTOS_ThreadMgmt allows you to define, create, and control threads.
+ - Interrupt Service Routines (ISR) can \ref CMSIS_RTOS_ISR_Calls "call some CMSIS-RTOS functions". When a CMSIS-RTOS
+ function cannot be called from ISR context, it rejects the invocation.
+ - Different thread event types support communication between multiple threads and/or ISR:
+ - \ref CMSIS_RTOS_SignalMgmt "Signal": is a flag that may be used to indicate specific conditions to a thread. Signals can
+ be modified in an ISR or set from other threads.
+ - \ref CMSIS_RTOS_FlagMgmt "Flag":
+ - \ref CMSIS_RTOS_Message "Message": is a 32-bit value that can be sent to a thread or an ISR. Messages are buffered in a
+ queue. The message type and queue size is defined in a descriptor.
+ - \ref CMSIS_RTOS_Mail "Mail": is a fixed-size memory block that can be sent to a thread or an ISR. Mails are buffered in
+ a queue and memory allocation is provided. The mail type and queue size is defined in a descriptor.
+ - \ref CMSIS_RTOS_MutexMgmt and \ref CMSIS_RTOS_SemaphoreMgmt are incorporated.
+ - CPU time can be scheduled with the following functionalities:
+ - A \ref CMSIS_RTOS_TimeOutValue "timeout" parameter is incorporated in many CMSIS-RTOS functions to avoid system lockup.
+ When a timeout is specified, the system waits until a resource is available or an event occurs. While waiting, other
+ threads are scheduled.
+ - The \ref osDelay function puts a thread into the state \b WAITING for a specified period of time.
+ - The generic \ref osWait function waits for events that are assigned to a thread.
+ - The \ref osThreadYield provides co-operative thread switching and passes execution to another thread of the same
+ priority.
+
+The CMSIS-RTOS API is designed to optionally incorporate multi-processor systems and/or access protection via the
+ARM Cortex-M Memory Protection Unit (MPU).
+
+In some RTOS implementations threads may execute on different processors and \b Mail and \b Message queues can therefore
+reside in shared memory resources.
+
+The CMSIS-RTOS API encourages the software industry to evolve existing RTOS implementations. Kernel objects are defined and
+accessed using macros. This allows differentiation. RTOS implementations can be different and optimized in various aspects
+towards the Cortex-M processors. Optional features may be for example
+ - Generic \b wait function; i.e. with support of time intervals.
+ - Support of the Cortex-M Memory Protection Unit (MPU).
+ - Zero-copy mail queue.
+ - Support of multi-processor systems.
+ - Support of a DMA controller.
+ - Deterministic context switching.
+ - Round-robin context switching.
+ - Deadlock avoidance, for example with priority inversion.
+ - Zero interrupt latency by using the ARMv7-M instructions LDREX and STREX.
+
+<hr>
+
+CMSIS-RTOS in ARM::CMSIS Pack
+-----------------------------
+
+The following files relevant to CMSIS-RTOS are present in the <b>ARM::CMSIS</b> Pack directories:
+|File/Folder |Content |
+|------------------------------|------------------------------------------------------------------------|
+|\b CMSIS\\Documentation\\RTOS | This documentation |
+|\b CMSIS\\RTOS\\Template | \ref cmsis_os_h |
+
+<hr>
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\page rtos_revisionHistory Revision History
+
+<table class="cmtable" summary="Revision History">
+ <tr>
+ <th>Version</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>V2.00</td>
+ <td>
+ Extended number of thread priorities.\n
+ Added: osXxxxDefInit macros for initializing osXxxxDef definitions.\n
+ Added: osXxxxDefM macros for defining objects with multiple instances (Mutex and Semaphore).\n
+ Added: osXxxxExt macros for external reference to an object definition.\n
+ Added: osKernelTime, osKernelStop.\n
+ Added: osThreadState, osThreadGetState, osThreadSuspend, osThreadResume.\n
+ Added: osTimerRunning.\n
+ Added: osPoolDelete.\n
+ Added: osMessageCount, osMessageReset, osMessageDelete.\n
+ Added: osMailCount, osMailReset, osMailDelete.\n
+ Added: osFlag object.\n
+ </td>
+ </tr>
+ <tr>
+ <td>V1.02 - only documentation changes</td>
+ <td>
+ Added: Overview of the \ref RtosValidation "CMSIS-RTOS Validation" Software Pack.\n
+ Clarified: Behavior of \ref CMSIS_RTOS_TimeOutValue.
+ </td>
+ </tr>
+ <tr>
+ <td>V1.02</td>
+ <td>Added: New control functions for short timeouts in microsecond resolution \ref osKernelSysTick,
+ \ref osKernelSysTickFrequency, \ref osKernelSysTickMicroSec.\n
+ Removed: osSignalGet.
+ </td>
+ </tr>
+ <tr>
+ <td>V1.01</td>
+ <td>Added capabilities for C++, kernel initialization and object deletion.\n
+ Prepared for C++ class interface. In this context to \em const attribute has been moved from osXxxxDef_t typedefs to
+ the osXxxxDef macros.\n
+ Added: \ref osTimerDelete, \ref osMutexDelete, \ref osSemaphoreDelete.\n
+ Added: \ref osKernelInitialize that prepares the Kernel for object creation.\n
+ </td>
+ </tr>
+ <tr>
+ <td>
+ V1.00</td>
+ <td>First official Release.\n
+ Added: \ref osKernelStart; starting 'main' as a thread is now an optional feature.\n
+ Semaphores have now the standard behavior.\n
+ \ref osTimerCreate does no longer start the timer. Added: \ref osTimerStart (replaces osTimerRestart).\n
+ Changed: osThreadPass is renamed to \ref osThreadYield.
+ </td>
+ </tr>
+ <tr>
+ <td>V0.02</td>
+ <td>Preview Release.</td>
+ </tr>
+</table>
+*/
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\page UsingOS Using a CMSIS-RTOS Implementation
+
+A CMSIS-RTOS implementation is typically provided as a library. To add the RTOS functionality to an existing CMSIS-based
+application, the RTOS library (and typically a configuration file) needs to be added. The available functionality of the
+RTOS library is defined in the header file \b cmsis_os.h that is specific for each CMSIS-RTOS implementation.
+
+\image html "CMSIS_RTOS_Files.png" "CMSIS-RTOS File Structure"
+
+Depending on the CMSIS-RTOS implementation, execution may start with the \b main function as the first thread. This has the
+benefit that an application programmer may use other middleware libraries that create threads internally, but the remaining
+part of the user application just uses the \b main thread. Therefore, the usage of the RTOS can be invisible to the
+application programmer, but libraries can use CMSIS-RTOS features.
+
+Once the files are added to a project, the user can start working with the CMSIS-RTOS functions. A code example is provided
+below:
+
+<b>Code Example</b>
+\code
+#include "cmsis_os.h" // CMSIS-RTOS header file
+
+void job1 (void const *argument) { // thread function 'job1'
+ while (1) {
+ : // execute some code
+ osDelay (10); // delay execution for 10 milliseconds
+ }
+}
+
+osThreadDef(job1, osPriorityAboveNormal, 1, 0); // define job1 as thread function
+
+void job2 (void const *argument) { // thread function 'job2'
+ osThreadCreate(osThread(job1),NULL); // create job1 thread
+ while (1) {
+ : // execute some code
+ }
+}
+
+osThreadDef(job2, osPriorityNormal, 1, 0); // define job2 as thread function
+
+void job3 (void const *argument) { // thread function 'job3'
+ while (1) {
+ : // execute some code
+ osDelay (20); // delay execution for 20 milliseconds
+ }
+}
+
+osThreadDef(job3, osPriorityNormal, 1, 0); // define job3 as thread function
+
+int main (void) { // program execution starts here
+ osKernelInitialize (); // initialize RTOS kernel
+ : // setup and initialize peripherals
+ osThreadCreate (osThread(job2));
+ osThreadCreate (osThread(job3));
+ osKernelStart (); // start kernel with job2 execution
+}
+\endcode
+*/
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\page FunctionOverview Function Overview
+
+The following list provides a brief overview of all CMSIS-RTOS functions. Functions marked with $ are optional.
+A specific CMSIS-RTOS implementation may not provide all functions, but this is clearly indicated with \b osFeatureXXXX
+defines.
+
+ - \ref CMSIS_RTOS_KernelCtrl
+ - \ref osKernelInitialize : Initialize the RTOS kernel.
+ - \ref osKernelStart : Start the RTOS kernel.
+ - \ref osKernelStop : Stop the RTOS kernel.
+ - \ref osKernelRunning : Query if the RTOS kernel is running.
+ - \ref osKernelTime : Get the current time of the running kernel.
+ - \ref osKernelSysTick : Get RTOS kernel system timer counter.
+ - \ref osKernelSysTickFrequency : RTOS kernel system timer frequency in Hz.
+ - \ref osKernelSysTickMicroSec : Convert microseconds value to RTOS kernel system timer value.
+
+ - \ref CMSIS_RTOS_ThreadMgmt
+ - \ref osThreadCreate : Start execution of a thread function.
+ - \ref osThreadTerminate : Stop execution of a thread function.
+ - \ref osThreadYield : Pass execution to next ready thread function.
+ - \ref osThreadGetId : Get the thread identifier to reference this thread.
+ - \ref osThreadSetPriority : Change the execution priority of a thread function.
+ - \ref osThreadGetPriority : Obtain the current execution priority of a thread function.
+ - \ref osThreadGetState : Get the state of a thread.
+ - \ref osThreadSuspend : Suspend the execution of a thread.
+ - \ref osThreadResume : Resume the execution of a thread.
+
+ - \ref CMSIS_RTOS_Wait
+ - \ref osDelay : Wait for a specified time.
+ - \ref osWait : Wait for any event of the type Signal, Message, or Mail.
+
+ - \ref CMSIS_RTOS_TimerMgmt
+ - \ref osTimerCreate : Define attributes of the timer callback function.
+ - \ref osTimerStart : Start or restart the timer with a time value.
+ - \ref osTimerStop : Stop the timer.
+ - \ref osTimerDelete : Delete a timer that was created by \ref osTimerCreate.
+ - \ref osTimerRunning : Check if a timer is running.
+
+ - \ref CMSIS_RTOS_SignalMgmt
+ - \ref osSignalSet : Set signal flags of a thread.
+ - \ref osSignalClear : Reset signal flags of a thread.
+ - \ref osSignalWait : Suspend execution until specific signal flags are set.
+
+ - \ref CMSIS_RTOS_FlagMgmt
+ - \ref osFlagCreate : Create and initialize a Flag object.
+ - \ref osFlagGet : Get the current flags of a Flag object.
+ - \ref osFlagSet : Set flags of a Flag object.
+ - \ref osFlagClear : Clear flags of a Flag object.
+ - \ref osFlagWait : Wait for a flag to be set for the current \b RUNNING thread.
+ - \ref osFlagDelete : Delete a Flag object that was created by \ref osFlagCreate.
+
+ - \ref CMSIS_RTOS_MutexMgmt
+ - \ref osMutexCreate : Define and initialize a mutex.
+ - \ref osMutexWait : Obtain a mutex or Wait until it becomes available.
+ - \ref osMutexRelease : Release a mutex.
+ - \ref osMutexDelete : Delete a mutex that was created by \ref osMutexCreate.
+
+ - \ref CMSIS_RTOS_SemaphoreMgmt
+ - \ref osSemaphoreCreate : Define and initialize a semaphore.
+ - \ref osSemaphoreWait : Obtain a semaphore token or Wait until it becomes available.
+ - \ref osSemaphoreRelease : Release a semaphore token.
+ - \ref osSemaphoreDelete : Delete a semaphore.
+
+ - \ref CMSIS_RTOS_PoolMgmt
+ - \ref osPoolCreate : Define and initialize a fix-size memory pool.
+ - \ref osPoolAlloc : Allocate a memory block.
+ - \ref osPoolCAlloc : Allocate a memory block and zero-set this block.
+ - \ref osPoolFree : Return a memory block to the memory pool.
+ - \ref osPoolDelete : Delete a memory pool that was created by \ref osPoolCreate.
+
+ - \ref CMSIS_RTOS_Message
+ - \ref osMessageCreate : Define and initialize a message queue.
+ - \ref osMessagePut : Put a message into a message queue.
+ - \ref osMessageGet : Get a message or suspend thread execution until message arrives.
+ - \ref osMessageCount : Retrieve the number of messages available in the message queue.
+ - \ref osMessageReset : Reset a message queue to its original empty state (purge all outstanding messages).
+ - \ref osMessageDelete : Delete a message queue that was created by \ref osMessageCreate.
+
+ - \ref CMSIS_RTOS_Mail
+ - \ref osMailCreate : Define and initialize a mail queue with fix-size memory blocks.
+ - \ref osMailAlloc : Allocate a memory block.
+ - \ref osMailCAlloc : Allocate a memory block and zero-set this block.
+ - \ref osMailPut : Put a memory block into a mail queue.
+ - \ref osMailGet : Get a mail or suspend thread execution until mail arrives.
+ - \ref osMailFree : Return a memory block to the mail queue.
+ - \ref osMailCount : Retrieve the number of mails available in the mail queue.
+ - \ref osMailReset : Reset a mail queue to its original empty state (purge all outstanding mails).
+ - \ref osMailDelete : Delete a mail queue that was created by \ref osMailCreate.
+
+\section CMSIS_RTOS_TimeOutValue Timeout Value
+
+The timeout value specifies the number of timer ticks until a timeout or time delay elapses. The value is an upper bound and
+depends on the actual time elapsed since the last timer tick.
+
+For a value of \b 1 the system waits until the next timer tick occurs. That means that the actual timeout value can be one
+timer tick less than the specified timeout value.
+
+\image html TimerValues.png "Timer Values"
+
+\section CMSIS_RTOS_ISR_Calls Calls from Interrupt Service Routines
+
+\todo Can any of the new functions be called from ISRs?
+
+The following CMSIS-RTOS functions can be called from threads and Interrupt Service Routines (ISR):
+ - \ref osKernelRunning
+ - \ref osSignalSet
+ - \ref osSemaphoreRelease
+ - \ref osPoolAlloc, \ref osPoolCAlloc, \ref osPoolFree
+ - \ref osMessagePut, \ref osMessageGet
+ - \ref osMailAlloc, \ref osMailCAlloc, \ref osMailGet, \ref osMailPut, \ref osMailFree
+
+Functions that cannot be called from an ISR are verifying the interrupt status and return, in case they are called
+from an ISR context, the status code \b osErrorISR. In some implementations, this condition might be caught using the HARD
+FAULT vector.
+
+Some CMSIS-RTOS implementations support CMSIS-RTOS function calls from multiple ISRs at the same time.
+If this is impossible, the CMSIS-RTOS rejects calls by nested ISR functions with the status code \b osErrorISRRecursive.
+*/
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\page cmsis_os_h Header File Template: cmsis_os.h
+
+The file \b cmsis_os.h is a template header file for a CMSIS-RTOS compliant Real-Time Operating System (RTOS).
+Each RTOS that is compliant with CMSIS-RTOS shall provide a specific \b cmsis_os.h header file that represents
+its implementation.
+
+The file cmsis_os.h contains:
+ - CMSIS-RTOS API function definitions
+ - struct definitions for parameters and return types
+ - status and priority values used by CMSIS-RTOS API functions
+ - macros for defining threads and other kernel objects
+
+
+<b>Name conventions and header file modifications</b>
+
+All definitions are prefixed with \b os to give an unique name space for CMSIS-RTOS functions.
+Definitions that are prefixed \b os_ are not used in the application code but local to this header file.
+All definitions and functions that belong to a module are grouped and have a common prefix, i.e. \b osThread.
+
+Definitions that are marked with <b>CAN BE CHANGED</b> can be adapted towards the needs of the actual CMSIS-RTOS
+implementation. These definitions can be specific to the underlying RTOS kernel.
+
+Definitions that are marked with <b>MUST REMAIN UNCHANGED</b> cannot be altered. Otherwise the CMSIS-RTOS implementation is
+no longer compliant to the standard. Note that some functions are optional and need not to be provided by every CMSIS-RTOS
+implementation.
+
+<b>Define and reference object definitions</b>
+
+With <b>\#define osObjectsExternal</b> objects are defined as external symbols. This allows to create a consistent header
+file that is used throughout a project as shown below:
+
+<i>Header File</i>
+\code
+#include <cmsis_os.h> // CMSIS RTOS header file
+
+// Thread definition
+extern void thread_sample (void const *argument); // function prototype
+osThreadDef (thread_sample, osPriorityBelowNormal, 1, 100);
+
+// Pool definition
+osPoolDef(MyPool, 10, long);
+\endcode
+
+
+This header file defines all objects when included in a C/C++ source file. When <b>\#define osObjectsExternal</b> is
+present before the header file, the objects are defined as external symbols. A single consistent header file can therefore be
+used throughout the whole project.
+
+<i>Example</i>
+\code
+#include "osObjects.h" // Definition of the CMSIS-RTOS objects
+\endcode
+
+\code
+#define osObjectsExternal // Objects will be defined as external symbols
+#include "osObjects.h" // Reference to the CMSIS-RTOS objects
+\endcode
+
+<b>Header file %cmsis_os.h</b>
+
+\include Template/cmsis_os.h
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\page RtosValidation RTOS Validation
+
+ARM offers a <a class=el href="http://www.keil.com/pack" target="_blank">Software Pack</a> for the CMSIS-RTOS Validation.
+The <b>ARM::CMSIS-RTOS_Validation</b> Pack contains the following:
+
+ - Source code of a CMSIS-RTOS Validation Suite along with configuration file.
+ - Documentation of the CMSIS-RTOS Validation Suite.
+ - Example that shows the usage of the CMSIS-RTOS Validation Suite using simulation.
+
+The CMSIS-RTOS Validation Suite is currently available in beta release and performs generic validation of various
+RTOS features. The test cases verify the functional behavior, test invalid parameters and call management
+functions from ISR.
+
+The following CMSIS-RTOS features can be tested with the current release:
+ - Thread : Create multiple threads, terminate, restart, yield, change priority
+ - Timer : Create periodic and one-shot timers
+ - GenWait : Call generic wait functions (osDelay and osWait)
+ - WaitFunc : Measure wait ticks (delay, mail, message, mutex, semaphore, signal)
+
+Moreover the following inter-thread communication functions can be tested:
+ - Signal : Verify signal events
+ - Memory Pool : Verify memory allocation
+ - Message Queue : Exchange messages between threads
+ - Mail Queue : Exchange data between threads
+ - Mutex : Synchronize resource access
+ - Semaphore : Access shared resources
+
+The RTOS Validation output can be printed to a console, output via ITM printf, or output to a memory buffer.
+
+\section test_output Sample Test Output
+\verbatim
+CMSIS-RTOS Test Suite Oct 21 2015 16:39:16
+
+TEST 01: TC_ThreadCreate PASSED
+TEST 02: TC_ThreadMultiInstance PASSED
+TEST 03: TC_ThreadTerminate PASSED
+ :
+ :
+TEST 08: TC_ThreadChainedCreate PASSED
+TEST 09: TC_ThreadYield NOT EXECUTED
+TEST 10: TC_ThreadParam PASSED
+ :
+ :
+TEST 60: TC_MailFromISRToThread PASSED
+
+Test Summary: 60 Tests, 59 Executed, 59 Passed, 0 Failed, 0 Warnings.
+Test Result: PASSED
+\endverbatim
+*/
+
+
+/* ========================================================================================================================== */
+// Reference
+/**
+ * \addtogroup CMSIS_RTOS CMSIS-RTOS API
+ * \brief This section describes the CMSIS-RTOS API.
+ * \details The CMSIS-RTOS is a generic API layer that interfaces to an existing RTOS kernel.
+ * @{
+ */
+
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Kernel Control Functions ====
+/**
+\addtogroup CMSIS_RTOS_KernelCtrl Kernel Information and Control
+\ingroup CMSIS_RTOS
+\brief Provide version/system information and start the RTOS Kernel.
+\details
+The Kernel Information and Control function group allows to:
+ - obtain information about the system and the underlying kernel.
+ - obtain version information about the CMSIS-RTOS API.
+ - initialize of the RTOS kernel for creating objects.
+ - start the RTOS kernel and thread switching.
+ - check the execution status of the RTOS kernel.
+
+The function \b main is a special thread function that may be started at system initialization. In this case it has the
+initial priority \a osPriorityNormal.
+
+When reaching \b main, it is necessary to:
+-# Call osKernelInitialize() to initialize the CMSIS-RTOS Kernel
+-# Setup device peripherals and create other RTOS objects using the \b os*Create functions.
+-# Start the Kernel and begin thread switching by calling osKernelStart().
+
+<b>Code Example</b>
+\code
+int main (void) {
+ osKernelInitialize (); // initialize CMSIS-RTOS
+
+ // initialize peripherals here
+
+ // create 'thread' functions that start executing,
+ // example: tid_name = osThreadCreate (osThread(name), NULL);
+
+ osKernelStart (); // start thread execution
+}
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_MainThread
+A CMSIS-RTOS implementation may support to start thread execution with the function 'main'.
+ - When \ref osFeature_MainThread is 1 the RTOS offers to start with 'main'. The RTOS kernel is in this case already started.
+ - When \ref osFeature_MainThread is 0 the RTOS requires explicit start with \ref osKernelStart.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_SysTick
+A CMSIS-RTOS implementation may provide access to the RTOS kernel system timer.
+ - When \ref osFeature_SysTick is 1 access to the RTOS kernel system timer is provided with \ref osKernelSysTick,
+ \ref osKernelSysTickFrequency, and \ref osKernelSysTickMicroSec.
+ - When \ref osFeature_SysTick is 0 access to the RTOS kernel system timer is not implemented.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osCMSIS
+Version information of the CMSIS-RTOS API whereby major version is in bits [31:16] and sub version in bits [15:0].
+The value 0x10000 represents version 1.00.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osCMSIS_KERNEL
+Identifies the underlying RTOS kernel and version number. The actual name of that define depends on the RTOS Kernel used in
+the implementation. For example, \b osCMSIS_FreeRTOS identifies the FreeRTOS kernel and the value indicates the version
+number of that kernel whereby the major version is in bits [31:16] and sub version in bits [15:0]. The value 0x10000
+represents version 1.00.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osKernelSystemId
+Defines a string that identifies the underlying RTOS Kernel and provides version information. The length of that string is
+limited to 21 bytes. A valid identification string is for example, <b>"FreeRTOS V1.00"</b>.
+*/
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osKernelInitialize (void)
+Initialize of the RTOS Kernel to allow peripheral setup and creation of other RTOS objects with the functions:
+ - \ref osThreadCreate : Create a thread function.
+ - \ref osTimerCreate : Define attributes of the timer callback function.
+ - \ref osMutexCreate : Define and initialize a mutex.
+ - \ref osSemaphoreCreate : Define and initialize a semaphore.
+ - \ref osPoolCreate : Define and initialize a fix-size memory pool.
+ - \ref osMessageCreate : Define and initialize a message queue.
+ - \ref osMailCreate : Define and initialize a mail queue with fix-size memory blocks.
+
+The RTOS kernel does not start thread switching until the function \ref osKernelStart is called.
+
+\note
+In case that the RTOS Kernel starts thread execution with the function \em main the function osKernelInitialize stops thread switching.
+This allows you to setup the system to a defined state before thread switching is resumed with \ref osKernelStart.
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+int main (void) {
+ if (!osKernelRunning ()) { // if kernel is not running, initialize the kernel
+ if (osKernelInitialize () != osOK) { // check osStatus for other possible valid values
+ // exit with an error message
+ }
+ }
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osKernelStart (void)
+Start the RTOS Kernel and begin thread switching.
+
+\note
+When the CMSIS-RTOS starts thread execution with the function \em main this function resumes thread switching. The \em main
+thread will continue executing after \ref osKernelStart.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the RTOS kernel has been successfully started.
+ - \em osErrorISR: \ref osKernelStart cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+int main (void) {
+ if (osKernelInitialize () != osOK) { // check osStatus for other possible valid values
+ // exit with an error message
+ }
+
+ if (!osKernelRunning ()) { // is the kernel running ?
+ if (osKernelStart () != osOK) { // start the kernel
+ // kernel could not be started
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osKernelRunning (void)
+Identifies if the RTOS kernel is started. For systems with the option to start the \em main function as a thread this allows you to identify
+that the RTOS kernel is already running.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+int main (void) { // program execution starts here
+ if (osKernelRunning ()) {
+ : // main is already a thread function
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osKernelStop (void)
+Stops the RTOS kernel and ceases thread switching.
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+int main (void) {
+ if (osKernelInitialize () != osOK) { // check osStatus for other possible valid values
+ // exit with an error message
+ }
+
+ if (osKernelRunning ()) { // is the kernel running ?
+ if (osKernelStop () != osOK) { // stop the kernel
+ // kernel could not be stopped
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn uint32_t osKernelTime (void)
+Returns the current kernel time in milliseconds.
+
+\todo add code example for osKernelTime
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn uint32_t osKernelSysTick (void)
+
+Get the value of the Kernel SysTick timer for time comparison. The value is a rolling
+32-bit counter that is typically composed of the kernel system interrupt timer value
+and an counter that counts these interrupts.
+
+This function allows the implementation of timeout checks. These are for example
+required when checking for a busy status in a device or peripheral initialization routine.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void SetupDevice (void) {
+ uint32_t tick;
+
+ tick = osKernelSysTick(); // get start value of the Kernel system tick
+ Device.Setup (); // initialize a device or peripheral
+ do { // poll device busy status for 100 microseconds
+ if (!Device.Busy) break; // check if device is correctly initialized
+ } while ((osKernelSysTick() - tick) < osKernelSysTickMicroSec(100));
+ if (Device.Busy) {
+ ; // in case device still busy, signal error
+ }
+ // start interacting with device
+}
+
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\def osKernelSysTickFrequency
+
+Specifies the frequency of the Kernel SysTick timer in Hz. The value is typically
+use to scale a time value and is for example used in \ref osKernelSysTickMicroSec.
+
+\sa osKernelSysTick
+
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osKernelSysTickMicroSec
+
+Allows you to scale a microsecond value to the frequency of the Kernel SysTick timer.
+This macro is typically used to check for short timeouts in polling loops.
+
+\sa osKernelSysTick
+*/
+/// @}
+
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Thread Management Functions ====
+/**
+@addtogroup CMSIS_RTOS_ThreadMgmt Thread Management
+@ingroup CMSIS_RTOS
+@brief Define, create, and control thread functions.
+@details
+The Thread Management function group allows defining, creating, and controlling thread functions in the system. The function
+\b main is a special thread function that is started at system initialization and has the initial priority
+\a osPriorityNormal.
+
+\anchor ThreadStates
+Threads can be in the following states:
+ - \b RUNNING: The thread that is currently running is in the \b RUNNING state. Only one thread at a time can be in this
+ state.
+ - \b READY: Threads which are ready to run are in the \b READY state. Once the \b RUNNING thread has terminated or is
+ \b WAITING, the next \b READY thread with the highest priority becomes the \b RUNNING thread.
+ - \b WAITING: Threads that are waiting for an event to occur are in the \b WAITING state.
+ - \b INACTIVE: Threads that are not created or terminated are in the \b INACTIVE state. These threads typically consume no
+ system resources.
+
+\image html "ThreadStatus.png" "Thread State and State Transitions"
+
+A CMSIS-RTOS assumes that threads are scheduled as shown in the figure <b>Thread State and State Transitions</b>. The thread
+states change as follows:
+ - A thread is created using the function \ref osThreadCreate. This puts the thread into the \b READY or \b RUNNING state
+ (depending on the thread priority).
+ - CMSIS-RTOS is pre-emptive. The active thread with the highest priority becomes the \b RUNNING thread provided it does not
+ wait for any event. The initial priority of a thread is defined with the \ref osThreadDef but may be changed during
+ execution using the function \ref osThreadSetPriority.
+ - The \b RUNNING thread transfers into the \b WAITING state when it is waiting for an event.
+ - Active threads can be terminated any time using the function \ref osThreadTerminate. Threads can terminate also by just
+ returning from the thread function. Threads that are terminated are in the \b INACTIVE state and typically do not consume
+ any dynamic memory resources.
+
+@{
+*/
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osThreadDefInit(thread, priority, instances, stacksz)
+Initialize the thread definition of a dynamically created thread function.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osThreadExt(name)
+External reference to a thread definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osThreadDef(name, priority, stacksz)
+Define the attributes of a thread functions that can be created by the function \ref osThreadCreate using \ref osThread.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osThread(name)
+Access to the thread definition for the function \ref osThreadCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\note MUST REMAIN UNCHANGED: \b osPriority shall be consistent in every CMSIS-RTOS.
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+The \ref osPriority value specifies the priority for a thread. The default thread priority should be \a osPriorityNormal.
+If a Thread is active that has a higher priority than the currently executing thread, then a thread switch occurs immediately
+to execute the new task.
+
+To prevent from a priority inversion, a CMSIS-RTOS compliant OS may optionally implement a <b>priority inheritance</b> method.
+A priority inversion occurs when a high priority thread is waiting for a resource or event that is controlled by a thread
+with a lower priority.
+*/
+typedef enum {} osPriority;
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osThreadId osThreadCreate (const osThreadDef_t *thread_def, void *argument)
+Start a thread function by adding it to the Active Threads list and set it to state \b READY.
+The thread function receives the \a argument pointer as function argument when the function is started.
+When the priority of the created thread function is higher than the current \b RUNNING thread,
+the created thread function starts instantly and becomes the new \b RUNNING thread.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg); // function prototype for Thread_1
+osThreadDef (Thread_1, osPriorityNormal, 1, 0); // define Thread_1
+
+void ThreadCreate_example (void) {
+ osThreadId id;
+
+ id = osThreadCreate (osThread (Thread_1), NULL); // create the thread
+ if (id == NULL) { // handle thread creation
+ // Failed to create a thread
+ }
+ :
+ osThreadTerminate (id); // stop the thread
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osThreadId osThreadGetId (void)
+Get the thread ID of the current running thread.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+void ThreadGetId_example (void) {
+ osThreadId id; // id for the currently running thread
+
+ id = osThreadGetId ();
+ if (id == NULL) {
+ // Failed to get the id; not in a thread
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osThreadSuspend (osThreadId thread_id)
+Suspends the execution of a thread. If the thread is currently RUNNING the execution will stop.
+
+\todo add code example for osThreadSuspend
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osThreadResume (osThreadId thread_id)
+Resumes the execution of a thread.
+
+\todo add code example for osThreadResume
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osThreadTerminate (osThreadId thread_id)
+Remove the thread function from the active thread list. If the thread is currently RUNNING the execution will stop.
+
+\note In case that \ref osThreadTerminate terminates the currently running task, the function never returns and other threads
+that are in the READY state are started.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the specified thread has been successfully terminated.
+ - \em osErrorParameter: thread_id is incorrect.
+ - \em osErrorResource: thread_id refers to a thread that is not an active thread.
+ - \em osErrorISR: \ref osThreadTerminate cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg); // function prototype for Thread_1
+osThreadDef (Thread_1, osPriorityNormal, 1, 0); // define Thread_1
+
+void ThreadTerminate_example (void) {
+ osStatus status;
+ osThreadId id;
+
+ id = osThreadCreate (osThread (Thread_1), NULL); // create the thread
+ :
+ status = osThreadTerminate (id); // stop the thread
+ if (status == osOK) {
+ // Thread was terminated successfully
+ }
+ else {
+ // Failed to terminate a thread
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osThreadSetPriority (osThreadId thread_id, osPriority priority)
+Change the priority of an active thread.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the priority of the specified thread has been successfully changed.
+ - \em osErrorParameter: thread_id is incorrect.
+ - \em osErrorValue: incorrect priority value.
+ - \em osErrorResource: thread_id refers to a thread that is not an active thread.
+ - \em osErrorISR: \ref osThreadSetPriority cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg) { // Thread function
+ osThreadId id; // id for the currently running thread
+ osPriority pr; // thread priority
+ osStatus status; // status of the executed function
+
+ :
+ id = osThreadGetId (); // Obtain ID of current running thread
+
+ if (id != NULL) {
+ status = osThreadSetPriority (id, osPriorityBelowNormal);
+ if (status == osOK) {
+ // Thread priority changed to BelowNormal
+ }
+ else {
+ // Failed to set the priority
+ }
+ }
+ else {
+ // Failed to get the id
+ }
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osPriority osThreadGetPriority (osThreadId thread_id)
+Get the priority of an active thread. In case of a failure the value \b osPriorityError is returned.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg) { // Thread function
+ osThreadId id; // id for the currently running thread
+ osPriority priority; // thread priority
+
+ id = osThreadGetId (); // Obtain ID of current running thread
+
+ if (id != NULL) {
+ priority = osThreadGetPriority (id);
+ }
+ else {
+ // Failed to get the id
+ }
+}
+\endcode
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osThreadState osThreadGetState (osThreadId thread_id)
+Get the state of a thread. In case of a failure the value \b osPriorityError is returned.
+
+\todo add code example for osThreadGetState
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osThreadYield (void)
+Pass control to the next thread that is in state \b READY. If there is no other thread in the state \b READY,
+the current thread continues execution and no thread switching occurs.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the function has been correctly executed.
+ - \em osErrorISR: \ref osThreadYield cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg) { // Thread function
+ osStatus status; // status of the executed function
+ :
+ while (1) {
+ status = osThreadYield(); //
+ if (status != osOK) {
+ // thread switch not occurred, not in a thread function
+ }
+ }
+}
+\endcode
+*/
+
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Generic Wait Functions ====
+/**
+\addtogroup CMSIS_RTOS_Wait Generic Wait Functions
+\ingroup CMSIS_RTOS
+\brief Wait for a time period or unspecified events.
+\details
+The Generic Wait function group provides means for a time delay and allow to wait for unspecified events.
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_Wait
+A CMSIS-RTOS implementation may support the generic wait function \ref osWait.
+ - When \ref osFeature_Wait is 1 a generic wait function \ref osWait is available.
+ - When \ref osFeature_Wait is 0 no generic wait function \ref osWait is available.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osDelay (uint32_t millisec)
+Wait for a specified time period in \a millisec.
+
+The \ref CMSIS_RTOS_TimeOutValue "millisec" value specifies the number of timer ticks and is therefore an upper bound. The
+exact time delay depends on the actual time elapsed since the last timer tick.
+
+For a value of <b>1</b>, the system waits until the next timer tick occurs. That means that the actual time delay may be up
+to one timer tick less.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osEventTimeout: the time delay is executed.
+ - \em osErrorISR: \ref osDelay cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg) { // Thread function
+ osStatus status; // capture the return status
+ uint32_t delayTime; // delay time in milliseconds
+
+ delayTime = 1000; // delay 1 second
+ :
+ status = osDelay (delayTime); // suspend thread execution
+ // handle error code
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osEvent osWait (uint32_t millisec)
+
+Wait for any event of the type Signal, Message, Mail for a specified time period in \a millisec.
+While the system waits, the thread that is calling this function is put into the state \b WAITING.
+When \a millisec is set to \b osWaitForever, the function will wait for an infinite time until an event occurs.
+
+The osWait function puts a thread into the state \b WAITING and waits for any of the following events:
+ - A \b signal sent to that thread explicitly
+ - A \b message from a message object that is registered to that thread
+ - A \b mail from a mail object that is registered to that thread
+
+\note This function is optional and may not be provided by all CMSIS-RTOS implementations.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osEventSignal: a signal event occurred and is returned.
+ - \em osEventMessage: a message event occurred and is returned.
+ - \em osEventMail: a mail event occurred and is returned.
+ - \em osEventTimeout: the time delay is executed.
+ - \em osErrorISR: \ref osDelay cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Thread_1 (void const *arg) { // Thread function
+ osEvent Event; // capture the event
+ uint32_t waitTime; // wait time in milliseconds
+
+ :
+ waitTime = osWaitForever; // special "wait" value
+ Event = osWait (waitTime); // wait forever and until an event occurred
+ switch (Event.status) {
+ case osEventSignal: // Signal arrived
+ : // Event.value.signals contains the signal flags
+ break;
+
+ case osEventMessage: // Message arrived
+ : // Event.value.p contains the message pointer
+ : // Event.def.message_id contains the message Id
+ break;
+
+ case osEventMail: // Mail arrived
+ : // Event.value.p contains the mail pointer
+ : // Event.def.mail_id contains the mail Id
+ break;
+
+ case osEventTimeout: // Timeout occurred
+ break;
+
+ default: // Error occurred
+ break;
+ }
+ :
+}
+\endcode
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Timer Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_TimerMgmt Timer Management
+\ingroup CMSIS_RTOS
+\brief Create and control timer and timer callback functions.
+\details
+In addition to the \ref CMSIS_RTOS_Wait CMSIS-RTOS also supports virtual timer objects. These timer objects can
+trigger the execution of a function (not threads). When a timer expires, a callback function is executed to run associated
+code with the timer. The timer number is passed as a parameter to the callback function. Each timer can be configured as a
+one-shot or a periodic timer. A periodic timer repeats its operation until it is \ref osTimerDelete "deleted" or
+\ref osTimerStop "stopped". All timers can be \ref osTimerStart "started, restarted", or \ref osTimerStop "stopped".
+
+Timers are handled in the thread \b osTimerThread. Callback functions run under control of this thread and may use other
+CMSIS-RTOS API calls.
+
+The figure below shows the behavior of a periodic timer. For one-shot timers, the timer stops after execution of the
+callback function.
+
+\image html "Timer.png" "Behavior of a Periodic Timer"
+
+Working with Timers
+--------------------
+The following steps are required to use a timer:
+-# Define the timers:
+\code
+osTimerDef(one_shot, start_machine); // when the timer expires, the function start_machine is called
+osTimerDef(periodic, toggle_power); // when the timer expires, the function toggle_power is called
+osTimerId one_shot_id, periodic_id;
+\endcode
+-# Instantiate and start the timers in an RTOS thread:
+\code
+one_shot_id = osTimerCreate(osTimer(one_shot), osTimerOnce, (void *)0); // creates a one-shot timer;
+ // (void*)0 is passed as an argument
+ // to the callback function
+periodic_id = osTimerCreate(osTimer(periodic), osTimerPeriodic, (void *)5); // creates a periodic timer;
+ // (void*)5 is passed as an argument
+ // to the callback function
+osTimerStart(one_shot_id, 500);
+osTimerStart(periodic, 1500);
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osTimerDefInit(function)
+Initialize the timer definition dynamically.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osTimerExt(name)
+External reference to a timer definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osTimerDef(name, function)
+Define the attributes of a timer.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osTimer(name)
+Access to the timer definition for the function \ref osTimerCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\note MUST REMAIN UNCHANGED: \b os_timer_type shall be consistent in every CMSIS-RTOS.
+The \ref os_timer_type specifies the a repeating (periodic) or one-shot timer for the function \ref osTimerCreate.
+*/
+typedef enum {} os_timer_type;
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osTimerId osTimerCreate (const osTimerDef_t *timer_def, os_timer_type type, void *argument)
+Create a one-shot or periodic timer and associate it with a callback function argument.
+The timer is in stopped until it is started with \ref osTimerStart.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Timer1_Callback (void const *arg); // prototypes for timer callback function
+void Timer2_Callback (void const *arg);
+
+osTimerDef (Timer1, Timer1_Callback); // define timers
+osTimerDef (Timer2, Timer2_Callback);
+
+uint32_t exec1; // argument for the timer call back function
+uint32_t exec2; // argument for the timer call back function
+
+void TimerCreate_example (void) {
+ osTimerId id1; // timer id
+ osTimerId id2; // timer id
+
+ // Create one-shoot timer
+ exec1 = 1;
+ id1 = osTimerCreate (osTimer(Timer1), osTimerOnce, &exec1);
+ if (id1 != NULL) {
+ // One-shoot timer created
+ }
+
+ // Create periodic timer
+ exec2 = 2;
+ id2 = osTimerCreate (osTimer(Timer2), osTimerPeriodic, &exec2);
+ if (id2 != NULL) {
+ // Periodic timer created
+ }
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osTimerStart (osTimerId timer_id, uint32_t millisec)
+Start or restart the timer.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the specified timer has been started or restarted.
+ - \em osErrorISR: \ref osTimerStart cannot be called from interrupt service routines.
+ - \em osErrorParameter: \a timer_id is incorrect.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Time_Callback (void const *arg) { // timer callback function
+ // arg contains &exec
+ // called every second after osTimerStart
+}
+
+osTimerDef (Timer, Time_Callback); // define timer
+uint32_t exec; // argument for the timer call back function
+
+void TimerStart_example (void) {
+ osTimerId id; // timer id
+ uint32_t timerDelay; // timer value
+ osStatus status; // function return status
+
+ // Create periodic timer
+ exec = 1;
+ id = osTimerCreate (osTimer(Timer), osTimerPeriodic, &exec);
+ if (id) {
+ timerDelay = 1000;
+ status = osTimerStart (id, timerDelay); // start timer
+ if (status != osOK) {
+ // Timer could not be started
+ }
+ }
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osTimerStop (osTimerId timer_id)
+Stop the timer.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the specified timer has been stopped.
+ - \em osErrorISR: \ref osTimerStop cannot be called from interrupt service routines.
+ - \em osErrorParameter: \a timer_id is incorrect.
+ - \em osErrorResource: the timer is not started.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Timer_Callback (void const *arg); // prototype for timer callback function
+osTimerDef (Timer, Timer_Callback); // define timer
+
+void TimerStop_example (void) {
+ osTimerId id; // timer id
+ osStatus status; // function return status
+
+ // Create periodic timer
+ exec = 1;
+ id = osTimerCreate (osTimer(Timer2), osTimerPeriodic, NULL);
+ osTimerStart (id, 1000); // start timer
+ :
+ status = osTimerStop (id); // stop timer
+ if (status != osOK) {
+ // Timer could not be stopped
+ }
+ :
+ osTimerStart (id, 1000); // start timer again
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osTimerRunning (osTimerId timer_id)
+Check whether the timer is running.
+
+\todo add code example for osTimerRunning
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osTimerDelete (osTimerId timer_id)
+Delete the timer object.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the specified timer has been deleted.
+ - \em osErrorISR: \ref osTimerDelete cannot be called from interrupt service routines.
+ - \em osErrorParameter: \a timer_id is incorrect.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+void Timer_Callback (void const *arg); // prototype for timer callback function
+osTimerDef (Timer, Timer_Callback); // define timer
+
+void TimerDelete_example (void) {
+ osTimerId id; // timer id
+ osStatus status; // function return status
+
+ // Create periodic timer
+ exec = 1;
+ id = osTimerCreate (osTimer(Timer2), osTimerPeriodic, NULL);
+ osTimerStart (id, 1000UL); // start timer
+ :
+ status = osTimerDelete (id); // stop and delete timer
+ if (status != osOK) {
+ // Timer could not be deleted
+ }
+ :
+}
+\endcode
+*/
+/// @}
+
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Inter-Thread Communication Functions ====
+/**
+\addtogroup CMSIS_RTOS_InterThread Inter-Thread Communication and Resource Sharing
+\ingroup CMSIS_RTOS
+\brief Functions for inter-thread communication.
+\details
+In most applications, threads need to \b communicate \b with \b each \b other or \b access \b shared \b resources together.
+There are many ways to exchange data between threads, for example using shared data, polling loops and message passing.
+
+Many resources in a microcontroller can be considered as \b serially-reusable. This means that they can be used repeatedly by
+different threads, but only by \b one \b thread \b at \b a \b time (for example communication peripherals such as \b UARTs,
+\b memory, and \b files that need to be modified).
+
+
+The CMSIS-RTOS API provides different means to pass messages between threads to make inter-thread communication more
+efficient. Also, resource sharing is inherently supported. The following methods are available to the user:
+Inter-Thread Communication
+--------------------------
+- \ref CMSIS_RTOS_SignalMgmt
+- \ref CMSIS_RTOS_FlagMgmt
+- \ref CMSIS_RTOS_Message
+- \ref CMSIS_RTOS_PoolMgmt
+- \ref CMSIS_RTOS_Mail
+
+Resource Sharing
+----------------
+- \ref CMSIS_RTOS_MutexMgmt
+- \ref CMSIS_RTOS_SemaphoreMgmt
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Signal Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_SignalMgmt Signal Events
+\ingroup CMSIS_RTOS_InterThread
+\brief Synchronize threads using signals.
+\details
+Signals are used to trigger execution states between threads. The signal management functions in CMSIS-RTOS allow you to
+control or wait for signal flags. Each thread has up to 31 assigned signal flags. The maximum number of signal flags is
+defined in the cmsis_os.h file (<b>\#define osFeature_Signals</b>).
+
+A thread
+- can wait for signals to be set (using \ref osSignalWait). Using this function, it enters the
+ \ref ThreadStates "WAITING" state. The \ref osSignalWait parameter \a signals defines the signals that are required to put
+ the thread back into \b READY state.
+- may set one or more flags in any other given thread (using \ref osSignalSet).
+- may clear its own signals or the signals of other threads (using \ref osSignalClear).
+
+When a thread wakes up and resumes execution, its signal flags are automatically cleared.
+
+Working with Signals
+--------------------
+Here is a simple example that shows how two thread can communicate with each others using signals:
+
+\image html simple_signal.png "Simple signal event communication"
+
+The following steps are required to use signals:
+-# In the thread (for example thread ID \c tid_thread1) that is supposed to wait for a signal, call the wait function:
+\code
+osSignalWait (0x0001, osWaitForever); // wait forever for the signal 0x0001
+\endcode
+-# In another thread (or threads) that are supposed to wake the waiting thread up call:
+\code
+osSignalSet (tid_thread1, 0x0001); // set the signal 0x0001 for thread tid_thread1
+osDelay (1000); // wait for 1 second
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_Signals
+The CMSIS-RTOS API may support a variable number of signal flags. This define specifies the number of signal flags available
+per thread. The maximum value is 32 signal flags per thread.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osSignalSet (osThreadId thread_id, int32_t signals)
+Set the signal flags of an active thread. This function may be used also within interrupt service routines.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>Code Example</b>
+\code{.c}
+void Thread_2 (void const *arg);
+
+osThreadDef (Thread_2, osPriorityHigh, 1, 0);
+
+static void EX_Signal_1 (void) {
+ int32_t signals;
+ uint32_t exec;
+ osThreadId thread_id;
+
+ thread_id = osThreadCreate (osThread(Thread_2), NULL);
+ if (thread_id == NULL) {
+ // Failed to create a thread.
+ }
+ else {
+ signals = osSignalSet (thread_id, 0x00000005); // Send signals to the created thread
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osSignalClear (osThreadId thread_id, int32_t signals)
+Clear the signal flags of an active thread.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+void Thread_2 (void const *arg);
+
+osThreadDef (Thread_2, osPriorityHigh, 1, 0);
+
+static void EX_Signal_1 (void) {
+ int32_t signals;
+ osThreadId thread_id;
+
+ thread_id = osThreadCreate (osThread(Thread_2), NULL);
+ if (thread_id == NULL) {
+ // Failed to create a thread.
+ }
+ else {
+f :
+ signals = osSignalClear (thread_id, 0x01);
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osEvent osSignalWait (int32_t signals, uint32_t millisec)
+Suspend the execution of the current \b RUNNING thread until all specified signal flags with the parameter \a signals are set.
+When the parameter \a signals is 0 the current \b RUNNING thread is suspended until any signal is set.
+When these signal flags are already set, the function returns instantly. Otherwise the thread is put into the state \b WAITING.
+Signal flags that are reported as event are automatically cleared.
+
+The argument \a millisec specifies how long the system waits for the specified signal flags.
+While the system waits the tread calling this function is put into the state \b WAITING.
+The timeout value can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until a specified signal is set.
+ - all other values specify a time in millisecond for a timeout.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: no signal received when the timeout value \em millisec was 0.
+ - \em osEventTimeout: signal not occurred within timeout
+ - \em osEventSignal: signal occurred, \em value.signals contains the signal flags; these signal flags are cleared.
+ - \em osErrorValue: the value \a signals is outside of the permitted range.
+ - \em osErrorISR: \ref osSignalWait cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+void Thread_2 (void const *arg);
+
+osThreadDef (Thread_2, osPriorityHigh, 1, 0);
+
+static void EX_Signal_1 (void) {
+ osThreadId thread_id;
+ osEvent evt;
+
+ thread_id = osThreadCreate (osThread(Thread_2), NULL);
+ if (thread_id == NULL) {
+ // Failed to create a thread.
+ }
+ else {
+ :
+ // wait for a signal
+ evt = osSignalWait (0x01, 100);
+ if (evt.status == osEventSignal) {
+ // handle event status
+ }
+ }
+}
+\endcode
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Flag Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_FlagMgmt Flag Objects
+\ingroup CMSIS_RTOS_InterThread
+\brief Synchronize threads using flags.
+\details
+
+\todo Add more information here
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_Flags
+The CMSIS-RTOS API may support a variable number of Flag objects. This define specifies the number of Flag bits available.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFlagDef(name)
+Define a Flag object.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFlagExt(name)
+External reference to a Flag object definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFlag(name)
+Access a Flag object definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osFlagSet (osFlagId flag_id, int32_t flags)
+
+\todo add code example for osFlagSet
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osFlagClear (osFlagId flag_id, int32_t flags)
+
+\todo add code example for osFlagClear
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osFlagId osFlagCreate (const osFlagDef_t *flag_def)
+
+\todo add code example for osFlagCreate
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osFlagGet (osFlagId flag_id)
+
+\todo add code example for osFlagGet
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osEvent osFlagWait (osFlagId flag_id, int32_t flags, uint32_t attributes, uint32_t millisec)
+
+\todo add code example for osFlagWait
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osFlagDelete (osFlagId flag_id)
+
+\todo add code example for osFlagDelete
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Message Queue Management Functions ====
+/**
+@addtogroup CMSIS_RTOS_Message Message Queue
+@ingroup CMSIS_RTOS_InterThread
+@brief Exchange messages between threads in a FIFO-like operation.
+@details
+\b Message \b passing is another basic communication model between threads. In the message passing model, one thread sends
+data explicitly, while another thread receives it. The operation is more like some kind of I/O rather than a direct access to
+information to be shared. In CMSIS-RTOS, this mechanism is called s \b message \b queue. The data is passed from one thread
+to another in a FIFO-like operation. Using message queue functions, you can control, send, receive, or wait for messages. The
+data to be passed can be of integer or pointer type:
+
+\image html "MessageQueue.png" "CMSIS-RTOS Message Queue"
+
+Compared to a \ref CMSIS_RTOS_PoolMgmt, message queues are less efficient in general, but solve a broader range of problems.
+Sometimes, threads do not have a common address space or the use of shared memory raises problems, such as mutual exclusion.
+
+Working with Message Queues
+---------------------------
+Follow these steps to create and use a message queue:
+-# Setup the message queue:
+\code
+osMessageQDef(message_q, 5, uint32_t); // Declare a message queue
+osMessageQId (message_q_id); // Declare an ID for the message queue
+\endcode
+-# Then, create the message queue in a thread:
+\code
+message_q_id = osMessageCreate(osMessageQ(message_q), NULL);
+\endcode
+-# Fill the message queue with data:
+\code
+uint32_t data = 512;
+
+osMailPut(message_q_id, data, osWaitForever);
+\endcode
+-# From the receiving thread access the data using:
+\code
+osEvent event = osMessageGet(message_q_id, osWaitForever);
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_MessageQ
+A CMSIS-RTOS implementation may support message queues.
+ - When \ref osFeature_MailQ is 1 message queues are supported.
+ - When \ref osFeature_MailQ is 0 no message queues are supported.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMessageQDefInit(queue_sz, type)
+Initialize the message queue definition dynamically.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMessageQExt(name)
+External reference to a message queue definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMessageQDef(name, queue_sz, type, thread)
+Define the attributes of a message queue created by the function \ref osMessageCreate using \ref osMessageQ.
+
+\note
+The parameter \em thread registers the receiving thread for a message and is
+needed for the general \ref osWait function to deliver the message.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMessageQ(name)
+Access to the message queue definition for the function \ref osMessageCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osMessageQId osMessageCreate (const osMessageQDef_t *queue_def, osThreadId thread_id);
+Create and initialize a message queue.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osThreadId tid_thread1; // ID for thread 1
+osThreadId tid_thread2; // for thread 2
+
+typedef struct { // Message object structure
+ float voltage; // AD result of measured voltage
+ float current; // AD result of measured current
+ int counter; // A counter value
+} T_MEAS;
+
+osPoolDef(mpool, 16, T_MEAS); // Define memory pool
+osPoolId mpool;
+osMessageQDef(MsgBox, 16, T_MEAS); // Define message queue
+osMessageQId MsgBox;
+
+void send_thread (void const *argument); // forward reference
+void recv_thread (void const *argument); // forward reference
+ // Thread definitions
+osThreadDef(send_thread, osPriorityNormal, 1, 0);
+osThreadDef(recv_thread, osPriorityNormal, 1, 2000);
+
+//
+// Thread 1: Send thread
+//
+void send_thread (void const *argument) {
+ T_MEAS *mptr;
+
+ mptr = osPoolAlloc(mpool); // Allocate memory for the message
+ mptr->voltage = 223.72; // Set the message content
+ mptr->current = 17.54;
+ mptr->counter = 120786;
+ osMessagePut(MsgBox, (uint32_t)mptr, osWaitForever); // Send Message
+ osDelay(100);
+
+ mptr = osPoolAlloc(mpool); // Allocate memory for the message
+ mptr->voltage = 227.23; // Prepare a 2nd message
+ mptr->current = 12.41;
+ mptr->counter = 170823;
+ osMessagePut(MsgBox, (uint32_t)mptr, osWaitForever); // Send Message
+ osThreadYield(); // Cooperative multitasking
+ // We are done here, exit this thread
+}
+
+//
+// Thread 2: Receive thread
+//
+void recv_thread (void const *argument) {
+ T_MEAS *rptr;
+ osEvent evt;
+
+ for (;;) {
+ evt = osMessageGet(MsgBox, osWaitForever); // wait for message
+ if (evt.status == osEventMessage) {
+ rptr = evt.value.p;
+ printf ("\nVoltage: %.2f V\n", rptr->voltage);
+ printf ("Current: %.2f A\n", rptr->current);
+ printf ("Number of cycles: %d\n", rptr->counter);
+ osPoolFree(mpool, rptr); // free memory allocated for message
+ }
+ }
+}
+
+void StartApplication (void) {
+ mpool = osPoolCreate(osPool(mpool)); // create memory pool
+ MsgBox = osMessageCreate(osMessageQ(MsgBox), NULL); // create msg queue
+
+ tid_thread1 = osThreadCreate(osThread(send_thread), NULL);
+ tid_thread2 = osThreadCreate(osThread(recv_thread), NULL);
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMessagePut (osMessageQId queue_id, uint32_t info, uint32_t millisec)
+Put the message \a info in a message queue specified by \a queue_id.
+
+When the message queue is full, the system retries for a specified time with \a millisec.
+While the system retries the thread that is calling this function is put into the state \b WAITING.
+The \a millisec timeout can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until a message queue slot becomes
+ available.
+ - all other values specify a time in millisecond for a timeout.
+
+\note The parameter \a millisec must be 0 for using this function in an ISR.
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the message is put into the queue.
+ - \em osErrorResource: no memory in the queue was available.
+ - \em osErrorTimeoutResource: no memory in the queue was available during the given time limit.
+ - \em osErrorParameter: a parameter is invalid or outside of a permitted range.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osEvent osMessageGet (osMessageQId queue_id, uint32_t millisec)
+Suspend the execution of the current \b RUNNING thread until a message arrives. When a message is already in the queue,
+the function returns instantly with the message information.
+
+The argument \a millisec specifies how long the system waits for a message to become available.
+While the system waits the thread that is calling this function is put into the state \b WAITING.
+The \a millisec timeout value can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until a message arrives.
+ - all other values specify a time in millisecond for a timeout.
+
+\note The parameter \a millisec must be 0 for using this function in an ISR.
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: no message is available in the queue and no timeout was specified.
+ - \em osEventTimeout: no message has arrived during the given timeout period.
+ - \em osEventMessage: message received, \em value.p contains the pointer to message.
+ - \em osErrorParameter: a parameter is invalid or outside of a permitted range.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn uint32_t osMessageCount (osMessageQId queue_id)
+Retrieve the number of messages available in the message queue.
+
+\todo add code example for osMessageCount
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMessageReset (osMessageQId queue_id)
+Reset a message queue to its original empty state (purge all outstanding messages).
+
+\todo add code example for osMessageReset
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMessageDelete (osMessageQId queue_id)
+Delete a message queue that was created by \ref osMessageCreate.
+
+\todo add code example for osMessageDelete
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Memory Pool Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_PoolMgmt Memory Pool
+\ingroup CMSIS_RTOS_InterThread
+\brief Manage thread-safe fixed-size blocks of dynamic memory.
+\details
+\b Memory \b pools are fixed-size blocks of memory that are thread-safe. They operate much faster than the dynamically
+allocated heap and do not suffer from fragmentation. Being thread-safe, they can be accessed from threads and ISRs alike.
+
+\b Shared \b memory is one of the basic models to exchange information between threads. Using memory pools for exchanging
+data, you can share more complex objects between threads if compared to a \ref CMSIS_RTOS_Message. Memory pool management
+functions are used to define and manage such fixed-sized memory pools.
+
+Working with Memory Pools
+-------------------------
+Follow these steps to create and use a memory pool:
+-# Declare a data structure that combines a number of elements:
+\code
+typedef struct {
+ uint32_t length;
+ uint32_t width;
+ uint32_t height;
+ uint32_t weight;
+} properties_t;
+\endcode
+-# Declare a memory pool of these objects as a block of memory:
+\code
+osPoolDef (object_pool, 10, properties_t); // Declare memory pool
+osPoolId (object_pool_id); // Memory pool ID
+\endcode
+-# Then, create the memory pool in a thread:
+\code
+object_pool_id = osPoolCreate(osPool(object_pool));
+\endcode
+-# Allocate the pool within a thread and fill it with data:
+\code
+properties_t *object_data;
+*object_data = (properties_t *) osPoolAlloc(object_pool_id);
+
+object_data->length = 100;
+object_data->width = 10;
+object_data->height = 23;
+object_data->weight = 1000;
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_Pool
+A CMSIS-RTOS implementation may support fixed-size memory pools.
+ - When \ref osFeature_Pool is 1 memory pools are supported.
+ - When \ref osFeature_Pool is 0 no memory pools are supported.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osPoolDefInit(no, type)
+Initialize the memory pool definition dynamically.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osPoolExt(name)
+External reference to a memory pool definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osPoolDef(name)
+Define a memory pool that is referenced by \ref osPool.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osPool(name)
+Access a memory pool for the functions \ref osPoolCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osPoolId osPoolCreate (const osPoolDef_t *pool_def);
+Create and initialize a memory pool.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+typedef struct {
+ uint8_t Buf[32];
+ uint8_t Idx;
+} MEM_BLOCK;
+
+osPoolDef (MemPool, 8, MEM_BLOCK);
+
+void CreateMemoryPool (void) {
+osPoolId MemPool_Id;
+
+ MemPool_Id = osPoolCreate (osPool (MemPool));
+ if (MemPool_Id != NULL) {
+ // memory pool created
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn void *osPoolAlloc (osPoolId pool_id)
+Allocate a memory block from the memory pool.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+typedef struct {
+ uint8_t Buf[32];
+ uint8_t Idx;
+} MEM_BLOCK;
+
+osPoolDef (MemPool, 8, MEM_BLOCK);
+
+void AlocMemoryPoolBlock (void) {
+ osPoolId MemPool_Id;
+ MEM_BLOCK *addr;
+
+ MemPool_Id = osPoolCreate (osPool (MemPool));
+ if (MemPool_Id != NULL) {
+ :
+ // allocate a memory block
+ addr = (MEM_BLOCK *)osPoolAlloc (MemPool_Id);
+
+ if (addr != NULL) {
+ // memory block was allocated
+ :
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn void *osPoolCAlloc (osPoolId pool_id)
+Allocate a memory block from the memory pool. The block is initialized to zero.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+typedef struct {
+ uint8_t Buf[32];
+ uint8_t Idx;
+} MEM_BLOCK;
+
+osPoolDef (MemPool, 8, MEM_BLOCK);
+
+void CAlocMemoryPoolBlock (void) {
+ osPoolId MemPool_Id;
+ MEM_BLOCK *addr;
+
+ MemPool_Id = osPoolCreate (osPool (MemPool));
+ if (MemPool_Id != NULL) {
+ :
+ // allocate a memory block
+ addr = (MEM_BLOCK *)osPoolCAlloc (MemPool_Id);
+
+ if (addr != NULL) {
+ // memory block was allocated
+ :
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osPoolFree (osPoolId pool_id, void *block)
+Return a memory block to a memory pool.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the memory block is released.
+ - \em osErrorValue: \a block does not belong to the memory pool.
+ - \em osErrorParameter: a parameter is invalid or outside of a permitted range.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+typedef struct {
+ uint8_t Buf[32];
+ uint8_t Idx;
+} MEM_BLOCK;
+
+osPoolDef (MemPool, 8, MEM_BLOCK);
+
+void CAlocMemoryPoolBlock (void) {
+ osPoolId MemPool_Id;
+ MEM_BLOCK *addr;
+ osStatus status;
+
+ MemPool_Id = osPoolCreate (osPool (MemPool));
+ if (MemPool_Id != NULL) {
+ addr = (MEM_BLOCK *)osPoolCAlloc (MemPool_Id);
+ if (addr != NULL) {
+ :
+ // return a memory block back to pool
+ status = osPoolFree (MemPool_Id, addr);
+ if (status==osOK) {
+ // handle status code
+ }
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osPoolDelete (osPoolId pool_id)
+Delete a memory pool that was created by \ref osPoolCreate.
+
+\todo add code example for osPoolDelete
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Mail Queue Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_Mail Mail Queue
+\ingroup CMSIS_RTOS_InterThread
+\brief Exchange data between threads using a queue of memory blocks.
+\details
+
+A \b mail \b queue resembles a \ref CMSIS_RTOS_Message, but the data that is being transferred consists of memory blocks that
+need to be allocated (before putting data in) and freed (after taking data out). The mail queue uses a
+\ref CMSIS_RTOS_PoolMgmt to create formatted memory blocks and passes pointers to these blocks in a message queue. This
+allows the data to stay in an allocated memory block while only a pointer is moved between the separate threads. This is an
+advantage over \ref CMSIS_RTOS_Message "messages" that can transfer only a 32-bit value or a pointer. Using the mail queue
+functions, you can control, send, receive, or wait for mail.
+
+\image html "MailQueue.png" "CMSIS-RTOS Mail Queue"
+
+Working with Mail Queues
+---------------------------
+Follow these steps to create and use a mail queue:
+-# Declare a data structure that combines a number of elements:
+\code
+typedef struct {
+ uint32_t length;
+ uint32_t width;
+ uint32_t height;
+ uint32_t weight;
+} properties_t;
+\endcode
+-# Declare a mail queue made up of these objects:
+\code
+osMailQDef (object_pool_q, 10, properties_t); // Declare mail queue
+osMailQId (object_pool_q_id); // Mail queue ID
+\endcode
+-# Then, create the mail pool in a thread:
+\code
+object_pool_q_id = osMailCreate(osMailQ(object_pool_q), NULL);
+\endcode
+-# Allocate the mail queue within a thread and fill it with data:
+\code
+properties_t *object_data;
+*object_data = (properties_t *) osMailAlloc(object_pool_q_id, osWaitForever);
+
+object_data->length = 100;
+object_data->width = 10;
+object_data->height = 23;
+object_data->weight = 1000;
+\endcode
+-# Pass the pointer to the mail queue to another thread:
+\code
+osMailPut(object_pool_q_id, object_data);
+\endcode
+-# Access the data in another thread:
+\code
+osEvent event = osMailGet(properties_q_id, osWaitForever);
+properties_t *received = (properties_t *)event.value.p; // ".p" indicates that the message is a pointer
+my_length(received->length);
+\endcode
+-# Once the data has been used, the memory block must be freed so that the memory pool can be reused
+\code
+osMailFree(object_pool_q_id, received);
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_MailQ
+A CMSIS-RTOS implementation may support mail queues.
+ - When \ref osFeature_MailQ is 1 mail queues are supported.
+ - When \ref osFeature_MailQ is 0 no mail queues are supported.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMailQDefInit(queue_sz, type)
+Initialize the mail queue definition dynamically.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMailQExt(name)
+External reference to a mail queue definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMailQDef(name, queue_sz, type, thread)
+Define the attributes of a mail queue that can by the function \ref osMailCreate using \ref osMailQ.
+
+\note
+The parameter \em thread registers the receiving thread for a mail and is
+needed for the general \ref osWait function to deliver the mail.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMailQ(name)
+Access to the mail queue definition for the function \ref osMailCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osMailQId osMailCreate (const osMailQDef_t *queue_def, osThreadId thread_id)
+Initialize and create a mail queue.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osThreadId tid_thread1; // ID for thread 1
+osThreadId tid_thread2; // ID for thread 2
+
+typedef struct { // Mail object structure
+ float voltage; // AD result of measured voltage
+ float current; // AD result of measured current
+ int counter; // A counter value
+} T_MEAS;
+
+osMailQDef(mail, 16, T_MEAS); // Define mail queue
+osMailQId mail;
+
+void send_thread (void const *argument); // forward reference
+void recv_thread (void const *argument);
+
+osThreadDef(send_thread, osPriorityNormal, 1, 0); // thread definitions
+osThreadDef(recv_thread, osPriorityNormal, 1, 2000);
+
+//
+// Thread 1: Send thread
+//
+void send_thread (void const *argument) {
+ T_MEAS *mptr;
+
+ mptr = osMailAlloc(mail, osWaitForever); // Allocate memory
+ mptr->voltage = 223.72; // Set the mail content
+ mptr->current = 17.54;
+ mptr->counter = 120786;
+ osMailPut(mail, mptr); // Send Mail
+ osDelay(100);
+
+ mptr = osMailAlloc(mail, osWaitForever); // Allocate memory
+ mptr->voltage = 227.23; // Prepare 2nd mail
+ mptr->current = 12.41;
+ mptr->counter = 170823;
+ osMailPut(mail, mptr); // Send Mail
+ osThreadYield(); // Cooperative multitasking
+ // We are done here, exit this thread
+}
+
+//
+// Thread 2: Receive thread
+//
+void recv_thread (void const *argument) {
+ T_MEAS *rptr;
+ osEvent evt;
+
+ for (;;) {
+ evt = osMailGet(mail, osWaitForever); // wait for mail
+ if (evt.status == osEventMail) {
+ rptr = evt.value.p;
+ printf ("\nVoltage: %.2f V\n", rptr->voltage);
+ printf ("Current: %.2f A\n", rptr->current);
+ printf ("Number of cycles: %d\n", rptr->counter);
+ osMailFree(mail, rptr); // free memory allocated for mail
+ }
+ }
+}
+
+void StartApplication (void) {
+ mail = osMailCreate(osMailQ(mail), NULL); // create mail queue
+
+ tid_thread1 = osThreadCreate(osThread(send_thread), NULL);
+ tid_thread2 = osThreadCreate(osThread(recv_thread), NULL);
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn void *osMailAlloc (osMailQId queue_id, uint32_t millisec)
+Allocate a memory block from the mail queue that is filled with the mail information.
+
+The argument \a queue_id specifies a mail queue identifier that is obtain with \ref osMailCreate.
+
+The argument \a millisec specifies how long the system waits for a mail slot to become available.
+While the system waits the tread calling this function is put into the state \b WAITING.
+The \a millisec timeout can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until a mail slot can be allocated.
+ - all other values specify a time in millisecond for a timeout.
+
+\note The parameter \a millisec must be 0 for using this function in an ISR.
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+A NULL pointer is returned when no memory slot can be obtained or \a queue specifies an illegal parameter.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn void *osMailCAlloc (osMailQId queue_id, uint32_t millisec)
+Allocate a memory block from the mail queue that is filled with the mail information. The memory block returned is cleared.
+
+The argument \a queue_id specifies a mail queue identifier that is obtain with \ref osMailCreate.
+
+The argument \a millisec specifies how long the system waits for a mail slot to become available.
+While the system waits the thread that is calling this function is put into the state \b WAITING.
+The \a millisec timeout can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until a mail slot can be allocated.
+ - all other values specify a time in millisecond for a timeout.
+
+\note The parameter \a millisec must be 0 for using this function in an ISR.
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+A NULL pointer is returned when no memory block can be obtained or \a queue specifies an illegal parameter.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMailPut (osMailQId queue_id, void *mail)
+Put the memory block specified with \a mail into the mail queue specified by \a queue.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the message is put into the queue.
+ - \em osErrorValue: \a mail was previously not allocated as memory slot.
+ - \em osErrorParameter: a parameter is invalid or outside of a permitted range.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osEvent osMailGet (osMailQId queue_id, uint32_t millisec)
+Suspend the execution of the current \b RUNNING thread until a mail arrives. When a mail is already in the queue,
+the function returns instantly with the mail information.
+
+The argument \a millisec specifies how long the system waits for a mail to arrive.
+While the system waits the thread that is calling this function is put into the state \b WAITING.
+The \a millisec timeout can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until a mail arrives.
+ - all other values specify a time in millisecond for a timeout.
+
+\note The parameter \a millisec must be 0 for using this function in an ISR.
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: no mail is available in the queue and no timeout was specified
+ - \em osEventTimeout: no mail has arrived during the given timeout period.
+ - \em osEventMail: mail received, \em value.p contains the pointer to mail content.
+ - \em osErrorParameter: a parameter is invalid or outside of a permitted range.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMailFree (osMailQId queue_id, void *mail)
+Free the memory block specified by \a mail and return it to the mail queue.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the \a mail block is released.
+ - \em osErrorValue: \a mail block does not belong to the mail queue pool.
+ - \em osErrorParameter: the value to the parameter \a queue_id is incorrect.
+
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn uint32_t osMailCount (osMailQId queue_id)
+Retrieve the number of mails available in the mail queue.
+
+\todo add code example for osMailCount
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMailReset (osMailQId queue_id)
+Reset a mail queue to its original empty state (purge all outstanding mails).
+
+\todo add code example for osMailReset
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMailDelete (osMailQId queue_id)
+Delete a mail queue that was created by \ref osMailCreate.
+
+\todo add code example for osMailDelete
+
+<b>Code Example</b>
+\code
+\endcode
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Mutex Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_MutexMgmt Mutexes
+\ingroup CMSIS_RTOS_InterThread
+\brief Synchronize resource access using Mutual Exclusion (Mutex).
+\details
+<b>Mutual exclusion</b> (widely known as \b Mutex) is used in various operating systems for resource management. Many
+resources in a microcontroller device can be used repeatedly, but only by one thread at a time (for example communication
+channels, memory, and files). Mutexes are used to protect access to a shared resource. A mutex is created and then passed
+between the threads (they can acquire and release the mutex).
+
+\image html "Mutex.png" "CMSIS-RTOS Mutex"
+
+A mutex is a special version of a \ref CMSIS_RTOS_SemaphoreMgmt "semaphore". Like the semaphore, it is a container for
+tokens. But instead of being able to have multiple tokens, a mutex can only carry one (representing the resource). Thus, a
+mutex token is binary and bounded. The advantage of a mutex is that it introduces thread ownership. When a thread acquires a
+mutex and becomes its owner, subsequent mutex acquires from that thread will succeed immediately without any latency. Thus,
+mutex acquires/releases can be nested.
+
+\note
+- Mutex management functions cannot be called from interrupt service routines (ISR), unlike a binary semaphore that can be
+ released from an ISR.
+
+Working with Mutexes
+--------------------
+To use mutexes, you need to follow these steps for creating and using them:
+-# Declare the mutex container and initialize the mutex:
+\code
+osMutexDef (uart_mutex); // Declare mutex
+osMutexId (uart_mutex_id); // Mutex ID
+\endcode
+-# Create the mutex in a thread:
+\code
+uart_mutex_id = osMutexCreate(osMutex(uart_mutex));
+\endcode
+-# Acquire the mutex when peripheral access is required:
+\code
+osMutexWait(uart_mutex_id, osWaitForever);
+\endcode
+-# When finished with the peripheral access, release the mutex:
+\code
+osMutexRelease(uart_mutex_id);
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMutexDefM(name, instances)
+Define a Mutex object with multiple instances.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMutexExt(name)
+External reference to a Mutex definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMutexDef(name)
+Define a mutex object that is referenced by \ref osMutex.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osMutex(name)
+Access to mutex object for the functions \ref osMutexCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osMutexId osMutexCreate (const osMutexDef_t *mutex_def)
+Create and initialize a Mutex object.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osMutexDef (MutexIsr); // Mutex name definition
+
+void CreateMutex (void) {
+osMutexId mutex_id;
+
+ mutex_id = osMutexCreate (osMutex (MutexIsr));
+ if (mutex_id != NULL) {
+ // Mutex object created
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMutexWait (osMutexId mutex_id, uint32_t millisec)
+Wait until a Mutex becomes available. If no other thread has obtained the Mutex, the function instantly returns and blocks
+the mutex object.
+
+The argument \a millisec specifies how long the system waits for a mutex.
+While the system waits the thread that is calling this function is put into the state \b WAITING.
+The \a millisec timeout can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until the mutex becomes available.
+ - all other values specify a time in millisecond for a timeout.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the mutex has been obtained.
+ - \em osErrorTimeoutResource: the mutex could not be obtained in the given time.
+ - \em osErrorResource: the mutex could not be obtained when no timeout was specified.
+ - \em osErrorParameter: the parameter \a mutex_id is incorrect.
+ - \em osErrorISR: \ref osMutexWait cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osMutexDef (MutexIsr);
+
+void WaitMutex (void) {
+osMutexId mutex_id;
+osStatus status;
+
+ mutex_id = osMutexCreate (osMutex (MutexIsr));
+ if (mutex_id != NULL) {
+ status = osMutexWait (mutex_id, 0);
+ if (status != osOK) {
+ // handle failure code
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMutexRelease (osMutexId mutex_id)
+Release a Mutex that was obtained with \ref osMutexWait. Other threads that currently wait for the same mutex will be now put
+into the state \b READY.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the mutex has been correctly released.
+ - \em osErrorResource: the mutex was not obtained before.
+ - \em osErrorParameter: the parameter \a mutex_id is incorrect.
+ - \em osErrorISR: \ref osMutexRelease cannot be called from interrupt service routines.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osMutexDef (MutexIsr); // Mutex name definition
+osMutexId mutex_id; // Mutex id populated by the function CreateMutex()
+osMutexId CreateMutex (void); // function prototype that creates the Mutex
+
+void ReleaseMutex (osMutexId mutex_id) {
+osStatus status;
+
+ if (mutex_id != NULL) {
+ status = osMutexRelease(mutex_id);
+ if (status != osOK) {
+ // handle failure code
+ }
+ }
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osMutexDelete (osMutexId mutex_id)
+Delete a Mutex object. The function releases internal memory obtained for Mutex handling. After this call the \a mutex_id is
+no longer valid and cannot be used. The Mutex may be created again using the function \ref osMutexCreate.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the mutex object has been deleted.
+ - \em osErrorISR: \ref osMutexDelete cannot be called from interrupt service routines.
+ - \em osErrorResource: all tokens have already been released.
+ - \em osErrorParameter: the parameter \a mutex_id is incorrect.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osMutexDef (MutexIsr); // Mutex name definition
+osMutexId mutex_id; // Mutex id populated by the function CreateMutex()
+osMutexId CreateMutex (void); // function prototype that creates the Mutex
+
+void DeleteMutex (osMutexId mutex_id) {
+osStatus status;
+
+ if (mutex_id != NULL) {
+ status = osMutexDelete(mutex_id);
+ if (status != osOK) {
+ // handle failure code
+ }
+ }
+}
+\endcode
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Semaphore Management Functions ====
+/**
+\addtogroup CMSIS_RTOS_SemaphoreMgmt Semaphores
+\ingroup CMSIS_RTOS_InterThread
+\brief Access shared resources simultaneously from different threads.
+\details
+Semaphores are used to manage and protect access to shared resources. Semaphores are very similar to
+\ref CMSIS_RTOS_MutexMgmt "Mutexes". Whereas a Mutex permits just one thread to access a shared resource at a
+time, a semaphore can be used to permit a fixed number of threads to access a pool of shared resources. Using semaphores,
+access to a group of identical peripherals can be managed (for example multiple DMA channels).
+
+\image html "Semaphore.png" "CMSIS-RTOS Semaphore"
+
+A semaphore object should be initialized to the maximum number of available tokens. This number of available resources is
+specified as parameter of the \ref osSemaphoreCreate function. Each time a semaphore token is obtained with
+\ref osSemaphoreWait, the semaphore count is decremented. When the semaphore count is 0, no semaphore token can be obtained.
+The thread that tries to obtain the semaphore token needs to wait until the next token is free. Semaphores are released with
+\ref osSemaphoreRelease incrementing the semaphore count.
+
+\note Semaphore tokens can be acquired from threads and released from threads and ISRs.
+
+Working with Semaphores
+--------------------
+Follow these steps to create and use a semaphore:
+-# Declare the semaphore container and initialize the semaphore:
+\code
+osSemaphoreDef (my_semaphore); // Declare semaphore
+osSemaphoreId (my_semaphore_id); // Semaphore ID
+\endcode
+-# Initialize the semaphore container with a number of tokens within a thread:
+\code
+my_semaphore_id = osSemaphoreCreate(osSemaphore(my_semaphore), 4); // Create semaphore with 4 tokens
+\endcode
+\b Important: semaphore tokens can be created and destroyed as threads run. This means that can initialize a semaphore with
+zero tokens and then use one thread to add/create tokens to the semaphore while a second thread removes them. In this way you
+can distinguish between producer and consumer threads.
+-# Acquire a token from the semaphore container:
+\code
+osSemaphoreWait(my_semaphore_id, osWaitForever);
+\endcode
+-# When finished using the semaphore resource, send the token back to the semaphore container:
+\code
+osSemaphoreRelease(my_semaphore_id);
+\endcode
+
+Semaphore Use Cases
+-------------------
+Due to their flexibility, semaphores cover a wide range of synchronizing applications. At the same time, they are perhaps the
+most challenging RTOS object to understand. The following explains a use case for semaphores, taken from the book
+<a href="http://www.greenteapress.com/semaphores/" target="_blank">The Little Book Of Semaphores</a> by Allen B. Downey which
+is available for free download.
+
+<b>Non-binary Semaphore (Multiplex)</b>
+
+A multiplex limits the number of threads that can access a critical section of code. For example, this could be a function
+accessing DMA resources which can only support a limited number of calls.
+
+To allow multiple threads to run the function, initialize a semaphore to the maximum number of threads that can be allowed.
+The number of tokens in the semaphore represents the number of additional threads that may enter. If this number is zero,
+then the next thread trying to access the function will have to wait until one of the other threads exits and releases its
+token. When all threads have exited the token number is back to n. Ths following example shows the code for one of the
+threads that might access the resource:
+
+\code
+osSemaphoreDef(multiplex);
+osSemaphoreId (multiplex_id);
+
+void thread_n (void)
+ {
+ multiplex_id = osSemaphoreCreate(osSemaphore(multiplex), 3);
+ while(1)
+ {
+ osSemaphoreWait(multiplex_id, osWaitForever);
+ // do something
+ osSemaphoreRelease(multiplex_id);
+ }
+ }
+\endcode
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osFeature_Semaphore
+A CMSIS-RTOS implementation may support semaphores. The value \ref osFeature_Semaphore indicates the maximum index count for
+a semaphore.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osSemaphoreDefM(name, instances)
+Define a Semaphore object with multiple instances.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osSemaphoreExt(name)
+External reference to a Semaphore definition.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osSemaphoreDef(name)
+Define a semaphore object that is referenced by \ref osSemaphore.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \def osSemaphore(name)
+Access to semaphore object for the functions \ref osSemaphoreCreate.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osSemaphoreId osSemaphoreCreate (const osSemaphoreDef_t *semaphore_def, int32_t count)
+Create and initialize a Semaphore object that is used to manage access to shared resources. The parameter \em count specifies
+the number of available resources. The \em count value 1 creates a binary semaphore.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+
+<b>Code Example</b>
+\code{.c}
+#include "cmsis_os.h"
+
+osThreadId tid_thread1; // ID for thread 1
+osThreadId tid_thread2; // ID for thread 2
+
+osSemaphoreId semaphore; // Semaphore ID
+osSemaphoreDef(semaphore); // Semaphore definition
+
+//
+// Thread 1 - High Priority - Active every 3ms
+//
+void thread1 (void const *argument) {
+ int32_t value;
+
+ while (1) {
+ osDelay(3); // Pass control to other tasks for 3ms
+ val = osSemaphoreWait (semaphore, 1); // Wait 1ms for the free semaphore
+ if (val > 0) {
+ // If there was no time-out the semaphore was acquired
+ : // OK, the interface is free now, use it.
+ osSemaphoreRelease (semaphore); // Return a token back to a semaphore
+ }
+ }
+}
+
+//
+// Thread 2 - Normal Priority - looks for a free semaphore and uses
+// the resource whenever it is available
+//
+void thread2 (void const *argument) {
+ while (1) {
+ osSemaphoreWait (semaphore, osWaitForever); // Wait indefinitely for a free semaphore
+ // OK, the interface is free now, use it.
+ :
+ osSemaphoreRelease (semaphore); // Return a token back to a semaphore.
+ }
+}
+
+// Thread definitions
+osThreadDef(thread1, osPriorityHigh, 1, 0);
+osThreadDef(thread2, osPriorityNormal, 1, 0);
+
+void StartApplication (void) {
+ semaphore = osSemaphoreCreate(osSemaphore(semaphore), 1);
+
+ tid_thread1 = osThreadCreate(osThread(thread1), NULL);
+ tid_thread2 = osThreadCreate(osThread(thread2), NULL);
+ :
+}
+\endcode
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn int32_t osSemaphoreWait (osSemaphoreId semaphore_id, uint32_t millisec)
+Wait until a Semaphore token becomes available. When no Semaphore token is available, the function waits for the time
+specified with the parameter \em millisec.
+
+The argument \a millisec specifies how long the system waits for a Semaphore token to become available.
+While the system waits the thread that is calling this function is put into the state \b WAITING.
+The \a millisec timeout can have the following values:
+ - when \a millisec is 0, the function returns instantly.
+ - when \a millisec is set to \b osWaitForever the function will wait for an infinite time until the Semaphore token becomes
+ available.
+ - all other values specify a time in millisecond for a timeout.
+
+The return value indicates the number of available tokens (the semaphore count value). If 0 is returned, then no semaphore
+was available.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osSemaphoreRelease (osSemaphoreId semaphore_id)
+Release a Semaphore token. This increments the count of available semaphore tokens.
+
+\note \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines" can call this function.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the semaphore has been released.
+ - \em osErrorResource: all tokens have already been released.
+ - \em osErrorParameter: the parameter \a semaphore_id is incorrect.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/** \fn osStatus osSemaphoreDelete (osSemaphoreId semaphore_id)
+Delete a Semaphore object. The function releases internal memory obtained for Semaphore handling. After this call the
+\a semaphore_id is no longer valid and cannot be used. The Semaphore may be created again using the function
+\ref osSemaphoreCreate.
+
+<b>\ref CMSIS_RTOS_Status</b>\n
+ - \em osOK: the semaphore object has been deleted.
+ - \em osErrorISR: \ref osSemaphoreDelete cannot be called from interrupt service routines.
+ - \em osErrorResource: the semaphore object could not be deleted.
+ - \em osErrorParameter: the parameter \a semaphore_id is incorrect.
+
+\note Cannot be called from \ref CMSIS_RTOS_ISR_Calls "Interrupt Service Routines".
+*/
+/// @}
+
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+// ==== Enumeration, structures, defines ====
+/**
+\addtogroup CMSIS_RTOS_Definitions Generic Data Types and Definitions
+\ingroup CMSIS_RTOS
+\brief Data Type Definitions used by the CMSIS-RTOS API functions.
+\details The Data Type section lists all data types that are used to exchange information with CMSIS-RTOS functions.
+
+@{
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\struct osEvent
+\details The \b osEvent structure describes the events returned by CMSIS-RTOS functions.
+*/
+
+/*=======0=========1=========2=========3=========4=========5=========6=========7=========8=========9=========0=========1====*/
+/**
+\struct os_mailQ
+\details The \b osEvent structure describes the events returned by CMSIS-RTOS functions.
+*/
+/// @}
+
+
+// ==== Status and Error Codes ====
+/** @addtogroup CMSIS_RTOS_Status Status and Error Codes
+ * @brief Status and Error Codes returned by CMSIS-RTOS API functions.
+ * @details The Status and Error Codes section lists all the return values that the CMSIS-RTOS functions will return.
+ *
+ *
+ * @ingroup CMSIS_RTOS
+ * @{
+ */
+
+/**
+\note MUST REMAIN UNCHANGED: \b osStatus shall be consistent in every CMSIS-RTOS.
+\details The \ref osStatus enumeration defines the event status and error codes that are returned by the CMSIS-RTOS functions.
+*/
+typedef enum {} osStatus;
+
+
+/// @}
diff --git a/CMSIS/DoxyGen/RTOS/src/images/API_Structure.png b/CMSIS/DoxyGen/RTOS/src/images/API_Structure.png
new file mode 100644
index 0000000..832753b
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/API_Structure.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/CMSIS_RTOS_Files.png b/CMSIS/DoxyGen/RTOS/src/images/CMSIS_RTOS_Files.png
new file mode 100644
index 0000000..136bc6d
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/CMSIS_RTOS_Files.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/MailQueue.png b/CMSIS/DoxyGen/RTOS/src/images/MailQueue.png
new file mode 100644
index 0000000..9e75ff4
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/MailQueue.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/MessageQueue.png b/CMSIS/DoxyGen/RTOS/src/images/MessageQueue.png
new file mode 100644
index 0000000..712eeac
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/MessageQueue.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/Mutex.png b/CMSIS/DoxyGen/RTOS/src/images/Mutex.png
new file mode 100644
index 0000000..7eec93b
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/Mutex.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/Semaphore.png b/CMSIS/DoxyGen/RTOS/src/images/Semaphore.png
new file mode 100644
index 0000000..f1939c0
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/Semaphore.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/ThreadStatus.png b/CMSIS/DoxyGen/RTOS/src/images/ThreadStatus.png
new file mode 100644
index 0000000..45a0564
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/ThreadStatus.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/Timer.png b/CMSIS/DoxyGen/RTOS/src/images/Timer.png
new file mode 100644
index 0000000..63c666b
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/Timer.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/TimerValues.png b/CMSIS/DoxyGen/RTOS/src/images/TimerValues.png
new file mode 100644
index 0000000..08add5d
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/TimerValues.png
Binary files differ
diff --git a/CMSIS/DoxyGen/RTOS/src/images/simple_signal.png b/CMSIS/DoxyGen/RTOS/src/images/simple_signal.png
new file mode 100644
index 0000000..a0305e4
--- /dev/null
+++ b/CMSIS/DoxyGen/RTOS/src/images/simple_signal.png
Binary files differ
