diff options
Diffstat (limited to 'library/doxygen')
| -rw-r--r-- | library/doxygen/Adapting.md | 71 | ||||
| -rw-r--r-- | library/doxygen/ApiOverview.md | 172 | ||||
| -rw-r--r-- | library/doxygen/Building.md | 122 | ||||
| -rw-r--r-- | library/doxygen/CMakeLists.txt | 27 | ||||
| -rw-r--r-- | library/doxygen/Catgen.md | 250 | ||||
| -rw-r--r-- | library/doxygen/Doxyfile.in | 1893 | ||||
| -rw-r--r-- | library/doxygen/DoxygenLayout.xml | 207 | ||||
| -rw-r--r-- | library/doxygen/Example.md | 68 | ||||
| -rw-r--r-- | library/doxygen/License.md | 34 | ||||
| -rw-r--r-- | library/doxygen/Printer.md | 103 | ||||
| -rw-r--r-- | library/doxygen/Protocol.md | 318 | ||||
| -rw-r--r-- | library/doxygen/Reference.md | 347 | ||||
| -rw-r--r-- | library/doxygen/mainpage.md | 57 | ||||
| -rw-r--r-- | library/doxygen/mipi_sys_t_event_header.png | bin | 0 -> 7210 bytes | |||
| -rw-r--r-- | library/doxygen/mipi_sys_t_library_flow.png | bin | 0 -> 45058 bytes | |||
| -rw-r--r-- | library/doxygen/mipi_sys_t_library_flow.vsd | bin | 0 -> 135168 bytes | |||
| -rw-r--r-- | library/doxygen/mipi_sys_t_message_anatomy.png | bin | 0 -> 10801 bytes | |||
| -rw-r--r-- | library/doxygen/mipi_sys_t_overview.png | bin | 0 -> 58002 bytes |
18 files changed, 3669 insertions, 0 deletions
diff --git a/library/doxygen/Adapting.md b/library/doxygen/Adapting.md new file mode 100644 index 0000000..3a6e546 --- /dev/null +++ b/library/doxygen/Adapting.md @@ -0,0 +1,71 @@ +\page mipi_syst_adapting_page Adapting the SyS-T Library + +[TOC] + +SyS-T Platform Code {#mipi_syst_adapting_platform} +============================================================================== +The SyS-T library uses a platform concept for integrating it into a system. +A platform is responsible for the following: + + * Providing the low level trace output code that interfaces with the + underlying trace transport system. This is typically trace aggregating + hardware or a protocol driver. The ``example`` platform code + simply prints the SyS-T protocol output to stdout. + + * Providing platform hook functions for SyS-T global and handle state + manipulations. This is platform specific code that allows efficient + processing of SyS-T. + +SyS-T ships with the following example platforms: + +Platform Directory| Description +------------|-------------------------------------------- +example | Simple trace output driver that prints all IOs as hexadecimal data strings to ``stdout``. The [printer](@ref mipi_syst_printer_page) project can consume this output and decode it into human readable text using comma separated value format (CSV). +mipi_stp_sim| [MIPI System Trace Protocol](https://mipi.org/specifications/stp) format file writer. It shows how to connect the library with an STP generator. In this example code, a software encoder is used to produce the STP data. +nop | A minimal boilerplate platform implementation that allows the library to compile but doesn't produce any output. + +Adapting SyS-T means providing your own platform code. The recommended procedure +is to clone an existing platform folder and adapt it as needed. The following +chapter shows an example of how this can be done. + +Copy an Existing Platform {#mipi_syst_adapting_copy} +============================================================================== + +Example: + + $ cd platform + $ cp -rv example myplatform + +Adapting the Platform {#mipi_syst_adapting_adapt} +============================================================================== + +Modify the copied platfrom code to interface with the system by performing +the following changes + + * Implement the hook functions for state and handle initialisation and + destruction. + * Interface the data output writer code with the trace transport. + The writer routine in the library assumes a MIPI STP protocol style + output processor and calls a set of STP tailored macros named + ```MIPI_SYST_OUTPUT_*``` for the actual write operations. These macros + are defined in ```platform.h```. See #MIPI_SYST_OUTPUT_D32TS for an example + macro definition to emit a SyS-T message header which will turn into a MIPI + STP D32TS packet when using STP output. Alternatively replace the entire + writer code in a case where the MIPI STP writer cannot be efficently + interfaced with the transport. + +Edit the Build Configuration {#mipi_syst_adapting_build} +============================================================================== +Define the CMake symbol ```SYST_BUILD_PLATFORM_NAME``` to point to the new +platform directory name. See the page @ref mipi_syst_building_page +for further information on building SyS-T. + +Specify the API conformance level by setting the CMAKE symbol +```SYST_CFG_CONFORMANCE_LEVEL``` to one of the following: + +| Conformance level | Data Size | +| ------------------|--------------------------------------------------------| +| 10 | Minimal - only Short and Compact Messages | +| 20 | Low overhead - excluding printf and crc32 | +| 30 | complete - All messages and options | + diff --git a/library/doxygen/ApiOverview.md b/library/doxygen/ApiOverview.md new file mode 100644 index 0000000..5ab5161 --- /dev/null +++ b/library/doxygen/ApiOverview.md @@ -0,0 +1,172 @@ +\page mipi_syst_api_overview Instrumentation API Overview + +[TOC] + +Overview {#mipi_syst_api} +============================================================================== +The SyS-T instrumentation API is exposed as a set of CPP Macros with the +prefix `MIPI_SYST_`. The definitions for the instrumentation API are provided by +the C-Language header file `mipi_syst.h`. This is the only header needed for +adding instrumentation calls to your software. + +See the @ref mipi_syst_example_page for a `hello world` style example that uses +the instrumentation API. + +SyS-T Library States {#mipi_syst_api_state} +============================================================================== + +The SyS-T library has 2 levels of data states to store information. These are: + +1. global state (mipi_syst_header structure) +2. per handle state (mipi_syst_handle structure) + +The global state contains data for the operation of the library itself and +is shared between SyS-T handles. The global state is initialized and +destroyed using the #MIPI_SYST_INIT and #MIPI_SYST_SHUTDOWN functions. + +SyS-T can operate with multiple global state structures. In this case the +initialization functions with the "_STATE" suffix in their names must be used +to specify the intended state (See #MIPI_SYST_INIT_STATE, +#MIPI_SYST_SHUTDOWN_STATE, #MIPI_SYST_INIT_HANDLE_STATE and #MIPI_SYST_ALLOC_HANDLE_STATE). + +The handle state is unique for each SyS-T +handle and allows sending trace data without causing data races with other +SyS-T handles. + +SyS-T Handles {#mipi_syst_api_handles} +============================================================================== +Each message generating instrumentation API expects a pointer to a `SyS-T handle` +as the first parameter. This handle builds the connection between the +Software API and trace emitting hardware or driver code. It can best be seen +as something similar to a FILE * in traditional C/C++ file IO. + +A SyS-T handle is obtained by using one of the #MIPI_SYST_ALLOC_HANDLE, +#MIPI_SYST_ALLOC_HANDLE_STATE, #MIPI_SYST_INIT_HANDLE, or +#MIPI_SYST_INIT_HANDLE_STATE macros. A handle is destroyed by calling +#MIPI_SYST_DELETE_HANDLE on it. + +SyS-T and Multi-threading {#mipi_syst_api_threading} +============================================================================== +The SyS-T library provides a thread safe usage model that, for performance +reasons, does not use any data locking techniques. It is important to +understand this model to avoid incorrect usage that would result in hard to +analyze data races or corrupted message data output. The threading model is +defined by the following rules: + +- SyS-T operates thread safe, as long as __SyS-T handles are not shared + between simultaneously executing threads__. +- Sharing a SyS-T handle between threads requires locking around each + instrumentation API call in the code using SyS-T. +- Platform adaption code that modifies the global library mipi_syst_header + state may need locking inside its hook functions to protect state data + members. See the mipi_stp_sim platform code in + platform/mipi_stp_sim/src/mipi_syst_platform.c for an example where locking + is required. + +The recommended SyS-T usage is to create a SyS-T handle exclusively for each +thread and to store it in thread local storage. This usage provides low +software overhead, as no locking is required while utilizing trace arbiter +hardware or trace creating drivers that are capable of supporting multiple +data channels in parallel. + +API Name Conventions {#mipi_syst_api_conventions} +============================================================================== +All API functions are provided as CPP macros with the prefix `MIPI_SYST_`. + +The data transmitting instrumentation calls exist in up to 4 variants for +generating additional location information. Location information describes +the instrumentation position of the API as either an instruction pointer +address, or a source "file:line" ID pair. This information is used during +trace decoding to map message data back to source locations. The name +conventions for the variants are: + +- **MIPI_SYST_<API-NAME>(...)**<BR> + API without location information generation + +- **MIPI_SYST_<API-NAME>_LOC16(..,f, ...)**<BR> + API variant that includes the instrumentation source position as a + "file:line" id pair of 16-bit width each. The file id is user defined + and passed as an additional parameter. This API requires the SyS-T platform + feature define #MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD. + +- **MIPI_SYST_<API-NAME>_LOC32(..,f, ...)**<BR> + API variant that includes the instrumentation source position as a + "file:line" id pair of 32-bit width each. The file id is user defined + and passed as an additional parameter. This API requires the SyS-T platform + feature define #MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD. + +- **MIPI_SYST_<API-NAME>_LOCADDR(...)**<BR> + API variant that includes the instrumentation instruction address as + location. This API requires the SyS-T platform feature defines + #MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD and #MIPI_SYST_PCFG_ENABLE_LOCATION_ADDRESS. + +See description of the #MIPI_SYST_DEBUG API call as an example showing all +variants. + +SyS-T Message Attributes {#mipi_syst_api_attributes} +============================================================================== +The SyS-T message produced by an API call contains mandatory and optional +data attributes. This chapter describes the attributes and how they are +defined when adding instrumentation calls.The message attributes are: + +- A 32-bit header describing the message type and content +- An optional 128-bit wide GUID identifying the message originating software + module. +- An optional location record +- An optional payload length +- API specific payload data of up to 64 Kbytes +- An optional CRC-32C checksum. + + + +SyS-T Message Header {#mipi_syst_api_header} +------------------------------------------------------------------------------ +Each SyS-T message starts with a 32-bit header, which is defined by the data +structure mipi_syst_msg_tag. The header contains the following information: + +- __Type and Subtype__ fields identifying the Message Type.<BR> + These fields are set internally by the API call. + +- Software __Module__ and __Unit__ IDs<BR> + These fields identify the software module that originated the message. They + are taken from the SyS-T handle used in the call. See the API calls + #MIPI_SYST_SET_HANDLE_GUID_UNIT and #MIPI_SYST_SET_HANDLE_MODULE_UNIT for an + example how the origin fields are used. + +- __Message Severity__<BR> + Each message contains a 3-bit severity level defined by the mipi_syst_severity + enumeration. + +- __Content__ Bits<BR> + These bits define what other optional attributes are present in the message. + +Message Origin GUID {#mipi_syst_api_guid} +------------------------------------------------------------------------------ +A message can contain a 128-bit wide GUID to identify the instrumented SW +module in a unique way. The GUID is emitted directly after the header if +the handle was initialized using the #MIPI_SYST_SET_HANDLE_GUID_UNIT API. The +GUID structure follows the RFC 4122 conventions and can be obtained +using various tools. One example is the `uuidgen` command on Linux. + +Message Location Information {#mipi_syst_api_loc} +------------------------------------------------------------------------------ +A message can contain location information describing the position of its +instrumentation call either as an instruction pointer address or as a +"file:line" ID pair. This location information is generated if one of the +API variants with the `_LOCADDR`, `_LOC16` or `_LOC32` suffix in the name is +used. + +Message Payload {#mipi_syst_api_payload} +------------------------------------------------------------------------------ +A message contains type-specific payload of up to 64 Kbytes, which is +generated internally by the API function from its parameters. These functions +also insert a 16-bit payload length field when when enabled by +the MIPI_SYST_ENABLE_HANDLE_LENGTH API. + +Message Checksum {#mipi_syst_api_chkssum} +------------------------------------------------------------------------------ +A message can end with a 32-bit CRC32C checksum calculated over all of the +message bytes, excluding the checksum value itself. The CRC generation is a +per SyS-T handle choice. It is enabled or disabled by the +#MIPI_SYST_ENABLE_HANDLE_CHECKSUM API. The default is disabled. + diff --git a/library/doxygen/Building.md b/library/doxygen/Building.md new file mode 100644 index 0000000..5f8f459 --- /dev/null +++ b/library/doxygen/Building.md @@ -0,0 +1,122 @@ +\page mipi_syst_building_page Building SyS-T + +[TOC] + +Building the SyS-T Library {#mipi_syst_building} +========================================================================= + +The SyS-T library includes CMake build support scripts. CMake is an +open-source, cross-platform build environment that is available for all major +platforms. The CMake tooling is available from https://cmake.org. + +Requirements for building SyS-T {#mipi_syst_build_req} +========================================================================= +The SyS-T Library requires the following tooling for building + +Component |Description +-----------------------|-------------------------- +CMake (https://cmake.org)|Build and packaging system +C-Compiler | Needed to build library from its C-Source code +C++-Compiler | Needed for building the unit test suite +Google Test (https://github.com/google/googletest)|Needed for building the unit test suite +Doxygen(www.doxygen.org)| Needed for building the HTML documentaion + +Configuring the build {#mipi_syst_build_conf} +========================================================================= +CMake based projects require configuration for generating the platform native +build support files from the CMake scripts. Configuring the SyS-T CMake scripts +follows CMake standard methodologies. Use the CMake documentation to familiarize +yourself with the CMake build environment. + +The SyS-T project uses the following configuration options: + +Configuration |Description +--------------------------|-------------------------------- +SYST_CFG_CONFORMANCE_LEVEL| The library conformance level setting (10=minimal, 20=cpu low overhead, 30=complete). +SYST_BUILD_PLATFORM_NAME | The name of the platform adaptation code directory (see also: @ref mipi_syst_adapting_platform). +SYST_BUILD_GTEST_DIR | File system location of the Google Test framework source code. This code is needed for the library unit tests only. +SYST_BUILD_TEST | Option to enable/disable generation of unit tests. +SYST_BUILD_DOC | Option to enable/disable generation of the HTML documentation (requires Doxygen) +CMAKE_INSTALL_PREFIX | File System location for installing the SyS-T build. + +Configuring using the CMake Gui +------------------------------------------------------------------------------ +The CMake distribution includs a GUI front end for setting up a configuration. +The GUI front end is started using the cmake-gui command. + +Perform the following steps inside the CMake Gui: + +- Point the "Where is the source code:" field to the library directory inside + the SyS-T distribution. +- Point the "Where to build the binaries:" field to a temporary location. This + directory will hold build artifacts like object files. Note: This is not the + installation location for the build result. +- Press "Configure". + A new dialog appears for selecting the desired native platform build tooling. + Select the desired tooling and press "Finish". CMake now parses the build + scripts and populates the variable table with build configuration options. +- Update the path for the variable ``CMAKE_INSTALL_PREFIX`` to point to your + desired install location. +- To build the unit tests, update the ``SYST_BUILD_GTEST_DIR`` variable to point + to the Google Test sources and check the ``SYST_BUILD_TEST`` field. +- To build the HTML documentation, verify that doxygen was found by CMake and + check the ``SYST_BUILD_DOC`` option. +- Press "Configure" again to activate the changed settings. +- Press "Generate" to generate the native build configuration files. + +Configuring using the CMake command line +------------------------------------------------------------------------------ +The SyS-T project can be configured with command line option, following +CMake standard methodologies. Follow these steps to setup a project using the +command line. + +- Create a new directory for holding the build artifact files and enter this + directory + + $ mkdir syst_build + $ cd syst_build + +- Run the configuration using the cmake tool. The following call shows an + example with all options set: + + ``` + $ cmake \ + -DSYST_BUILD_GTEST_DIR=/home/username/googletest \ + -DSYST_BUILD_TEST=ON \ + -DSYST_BUILD_DOC=ON \ + -DSYST_BUILD_PLATFORM=example \ + -DCMAKE_INSTALL_PREFIX=/opt/mipi_syst \ + /home/jdoe/src/sys_t +``` + +Building and Installing {#mipi_syst_building_deploy} +========================================================================= +The build system provides various targets for building and installing the +SyS-T library, header files and documentation. The following table shows which +targets exist: + +Target Name |Description +----------------|-------------------------------- +all | Build binaries and, if enabled, the unit tests +doc | Build HTML documentation +syst_unittest | Build unit tests +install | Install to CMAKE_INSTALL_PREFIX location, implies 'all' +clean | Remove build artifacts +RUN_TEST | Run the tests (not showing test output) +RUN_TEST_VERBOSE| Run the tests (showing test output) + +Integration Build and Test Script +========================================================================= +A bash script in ``examples/scripts/bldall.sh`` can be used to run an +integration test using the different projects. The script builds all projects +sequentially using the example library platform. It then runs their components +tests and finally calls the printer tool to format the output of +the ``hello`` example application. The following transcript shows how to +run execute the script. The BLD_ROOT variable sets the location of the build +folder. If unset, the script creates a local build folder inside the scripts +folder. + +``` +$ cd sys-t/examples/scripts +$ BLD_ROOT=/tmp/sys_t_test_bld ./bldall.sh +``` diff --git a/library/doxygen/CMakeLists.txt b/library/doxygen/CMakeLists.txt new file mode 100644 index 0000000..bad16b3 --- /dev/null +++ b/library/doxygen/CMakeLists.txt @@ -0,0 +1,27 @@ + +if (SYST_BUILD_DOC) + if (NOT DOXYGEN_FOUND) + message( + WARNING + "SYST_BUILD_DOC variable set, but Doxygen was not found -skipping documentation" + ) + else() + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/../include/mipi_syst.h.in + ${CMAKE_CURRENT_BINARY_DIR}/gensrc/mipi_syst.h @ONLY + ) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY + ) + + add_custom_target(doc + ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + COMMENT "Generating Doxygen manual for ${CMAKE_PROJECT_NAME} in ${CMAKE_CURRENT_BINARY_DIR}" + SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${DOXYGEN_IDE_FILES} + ) + + set_target_properties(doc PROPERTIES + FOLDER "Instrumentation Library" + ) + endif() +endif(SYST_BUILD_DOC) diff --git a/library/doxygen/Catgen.md b/library/doxygen/Catgen.md new file mode 100644 index 0000000..c9fdfe5 --- /dev/null +++ b/library/doxygen/Catgen.md @@ -0,0 +1,250 @@ +\page mipi_syst_catgen_page Automated Catalog Generation + +[TOC] + +Catalog Example {#mipi_syst_catgen_sample} +============================================================================== +The distribution includes an example application that uses catalog +messages generated by the [MIPI_SYST_CATPRINTF](@ref PrintfApi), +[MIPI_SYST_CATALOG64](@ref CatAPI64) or [MIPI_SYST_CATALOG32](@ref CatAPI32) +families of instrumentation API calls. The example also includes the necessary +configuration to support the automated decode collateral generation tool. This +tool scans the source code and extracts the catalog decode information into +collateral needed by SyS-T decoders. + +The example is stored under `examples/client` in the source code distribution. + +Decode Collateral Creation Tool {#mipi_syst_catgen_tool} +============================================================================== +The project includes a PERL based collateral generator that automates the +creation and updating of SyS-T decode collateral in XML format. This +generator parses the catalog instrumentation points by scanning the +client source code. The tool can be embedded into a software build process to +keep software builds and decode collateral updated at the same time. The tool +is stored in the ```collateral/generator``` directory of the project with the +name ```syst_cgen.pl```. + +Dependencies {#mipi_syst_catgen_deps} +------------------------------------------------------------------------------ +The generator is written in PERL and requires a PERL installation with the +following optional modules installed. + * String::Escape + * Xml::Simple + +Refer to the documentation for your PERL installation on module installation. +On Linux, the following commands can be used: + +``` +$ perl -MCPAN -e 'install XML::Simple' +$ perl -MCPAN -e 'install String::Escape' +``` + +Collateral Generation Process {#mipi_syst_catgen_process} +------------------------------------------------------------------------------ +The collateral generator takes a SyS-T collateral template and +a configuration file as input. The configuration file defines the locations +and file extensions of the source files to be scanned and how the catalog +message calls +inside the source code are named. The tool can then detect the catalog +calls, and extract the format strings, source locations, and +catalog IDs to update the collateral template file. The result is a +new collateral file that matches the actual state of the source code. + +Catalog Generation Example {#mipi_syst_catgen_example_generation} +------------------------------------------------------------------------------ +The client application in ```example/client``` uses various catalog calls. +It provides a configuration file for ```syst_cgen.pl``` to detect +the SyS-T catalog message calls, and a collateral template file that is +updated by the generator. It is executed in the following way: + +``` +$ perl ../../collateral/generator/syst_cgen.pl -config collateral_config.xml +syst_cgen.pl: Parsing: ./othersource.c +syst_cgen.pl: Add ./othersource.c with file id 1 to file catalog +syst_cgen.pl: Parsing finished: ./othersource.c, found 127 call(s) +syst_cgen.pl: Parsing: ./systclient.c +syst_cgen.pl: Add ./systclient.c with file id 2 to file catalog +syst_cgen.pl: Parsing finished: ./systclient.c, found 4 call(s) +syst_cgen.pl: Generating XML structure +syst_cgen.pl: Loaded template collateral file template.xml +syst_cgen.pl: Generating XML structure finished +syst_cgen.pl: Writing XML file: generated_catalog.xml +syst_cgen.pl: Writing XML file finished +``` +Catalog Generator Configuration Example {#mipi_syst_catgen_example_config} +------------------------------------------------------------------------------ +The following XML file shows the example configuration file from the client +example. The file lists the SyS-T catalog instrumentation call patterns and +can be reused for other clients. Only the options at the beginning may require +adaptations. + +```{.xml} +<CatalogGenerator> + <CatalogConfigs> + <CatalogConfig option="catalog" value="generated_catalog.xml" /> + <CatalogConfig option="template" value="template.xml" /> + <CatalogConfig option="indentation" value="4" /> + <CatalogConfig option="nolocation" value="false"/> + <CatalogConfig option="src" value="." /> + </CatalogConfigs> + <SrcFilePatterns> + <SrcFilePattern Pattern="*.{cpp,c,h}" /> + </SrcFilePatterns> + <CatalogCalls> + <Catalog32> + <CatalogCall Name="MIPI_SYST_HASH" Algorithm="hash65599" IdParamIdx="2" StringParamIdx="1" /> + + <CatalogCall Name="MIPI_SYST_CATPRINTF32" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_0" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_1" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_2" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_3" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_4" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_5" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF32_6" IdParamIdx="3" StringParamIdx="4" /> + </Catalog32> + + <Catalog64> + <CatalogCall Name="MIPI_SYST_CATPRINTF64" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_0" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_1" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_2" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_3" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_4" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_5" IdParamIdx="3" StringParamIdx="4" /> + <CatalogCall Name="MIPI_SYST_CATPRINTF64_6" IdParamIdx="3" StringParamIdx="4" /> + </Catalog64> + </CatalogCalls> +</CatalogGenerator> +``` + +Catalog Generator Template File {#mipi_syst_catgen_example_template} +------------------------------------------------------------------------------ +The following XML file shows the template collateral file that is updated by +the generator tool with the source code information. Note the empty XML +elements called ``<syst:SourceFiles/>``, ``<syst:Catalog32/>``, and +``<syst:Catalog64/>``. The generator replaces these empty elements with the +collected information. The remaining contents are kept unchanged. +```{.xml} +<?xml version="1.0" encoding="utf-8"?> +<syst:Collateral xmlns:syst="http://www.mipi.org/1.0/sys-t" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.mipi.org/1.0/sys-t + https://www.mipi.org/schema/sys-t/sys-t_1-0.xsd"> + + <!-- + A SyS-T collateral file starts with one syst:Collateral element + and contains at least one syst:Client child node. + --> + <syst:Client Name="example"> + + <!-- + List of message GUIDs for this client: + A GUID is a 128bit numeric UUID following RFC 4122. + Clients that are identified by transport layer properties + can use pseudo GUID values to identify their messages. A + pseudo GUID is defined as a GUID with bit 71 set to zero. + The following encoding might be used for clients identified + by MIPI System Trace Protocol (STP) master/channel pairs: + + {00000000-<MasterID>-<ChannelID>-<Origin>00-000000000000} + + A Mask attribute can be added to define which bits of the GUID are + used for comparison. Without a mask, all bits need to match. + The example below makes the catalog valid for all channels from the + STP master value 0x644, or messages with the "494E..." GUID in their + payload. + --> + <syst:Guids> + <syst:Guid ID= "{00000000-0644-0000-0000-000000000000}" + Mask="{00000000-FFFF-0000-8000-000000000000}"><![CDATA[kernel]]></syst:Guid> + <syst:Guid ID="{494E5443-6F64-43D1-93F0-F3D49D92670C}"><![CDATA[user]]></syst:Guid> + </syst:Guids> + + <!-- + Define for which client build versions this collateral is valid. + Builds are expressed as values up to 64 bits in size, and can include a + mask that defines which bits need to match with a client build version + message. + --> + <syst:Builds> + <syst:Build ID="0x00010000" Mask="0xFFFF0000" ><![CDATA[SW Build 1.x]]></syst:Build> + <syst:Build ID="0x00020000" Mask="0xFFFF0000" ><![CDATA[SW Build 2.x]]></syst:Build> + </syst:Builds> + + <!-- + Settings to guide decoding tools what to do in cases + where several options are possible. The example below tells + a decoder to interprete SyS-T message timstamps only as an + informal field, but not the message creation time. + --> + <syst:Options> + <syst:Option Name="syst:timestamp">displayAsField</syst:Option> + </syst:Options> + + <!-- + Provide ID to name mapping for Origin header field values. + --> + <syst:Modules> + <syst:Module ID="0x1"><![CDATA[kernel]]></syst:Module> + <syst:Module ID="0x2"><![CDATA[user]]></syst:Module> + </syst:Modules> + + <!-- + Define the mapping of the numeric File-ID to source files. + This table is optional and only needed if source references are used + by the Catalog32 or Catalog64 elements. + --> + <syst:SourceFiles> + <syst:File ID="0x00000001"><![CDATA[example/src/main.c]]></syst:File> + <syst:File ID="0x00000002"><![CDATA[example/h/example.h]]></syst:File> + </syst:SourceFiles> + + <!-- + Define the mapping of catalog message ID to human-readable strings. + This table is optional and only needed if catalog messages are used. + A message can have optional "File" and "Line" attributes to specify the + source position of the instrumentation call. A decoder uses the + information from these attributes if the message payload doesn't provide + explicit location information. + --> + <syst:Catalog32> + <syst:Format ID="0x00000001" File="0x00000001" Line="23"><![CDATA[This is example %d.%d]]></syst:Format> + <syst:Format ID="0x00000002" File="0x00000002" Line="72"><![CDATA[task switch %x->%x]]></syst:Format> + </syst:Catalog32> + + <syst:Catalog64> + <syst:Format ID="0x0000000000000001"><![CDATA[error %d]]></syst:Format> + </syst:Catalog64> + + <!-- + Define short message mapping from 28-Bit ID to user visible string. + --> + <syst:Short32> + <syst:Format ID="0x0000000" Mask="0xFFFFFF0"><![CDATA[Fatal Error code]]></syst:Format> + <syst:Format ID="0x0000013"><![CDATA[state ready]]></syst:Format> + <syst:Format ID="0x000001A"><![CDATA[state halt]]></syst:Format> + </syst:Short32> + + <!-- + Define short message mapping from 60-Bit ID to user visible string. + --> + <syst:Short64> + <syst:Format ID="0x123456700000000" Mask="0xFFFFFFF00000000"><![CDATA[warning state]]></syst:Format> + + </syst:Short64> + + <!-- + Specify raw message protocol id assignment + --> + <syst:Write> + <syst:Protocol ID="0x01"><![CDATA[console]]></syst:Protocol> + <syst:Protocol ID="0x02"><![CDATA[console]]></syst:Protocol> + <syst:Protocol ID="0x03"><![CDATA[ftrace]]></syst:Protocol> + <syst:Protocol ID="0x20" Mask="0x30"><![CDATA[reserved]]></syst:Protocol> + </syst:Write> + +</syst:Client> + +</syst:Collateral> +```
\ No newline at end of file diff --git a/library/doxygen/Doxyfile.in b/library/doxygen/Doxyfile.in new file mode 100644 index 0000000..8998cd2 --- /dev/null +++ b/library/doxygen/Doxyfile.in @@ -0,0 +1,1893 @@ +# Doxyfile 1.8.3.1 + +# 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 = "MIPI System Software Trace Library" + +# 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 = "1.0" + +# 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 = "Instrumentation Library for MIPI SyS-T" + +# 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 = + +# 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 = . + +# 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 = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# 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 = @CMAKE_CURRENT_SOURCE_DIR@ + +# 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 = YES + +# 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 = YES + +# 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 = NO + +# 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 = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +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 = NO + +# 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 = NO + +# 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 = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +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 = YES + +# 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 section-label ... \endif +# and \cond section-label ... \endcond blocks. + +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 = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default 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 = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.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. Do not use +# file names with spaces, bibtex cannot handle them. + +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 = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +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 = @CMAKE_CURRENT_SOURCE_DIR@ \ + @CMAKE_CURRENT_SOURCE_DIR@/../src \ + @CMAKE_CURRENT_BINARY_DIR@/gensrc \ + @CMAKE_CURRENT_SOURCE_DIR@/../include \ + @CMAKE_CURRENT_SOURCE_DIR@/../platform/example + + +# 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++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl + +# 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 = @CMAKE_CURRENT_SOURCE_DIR@/test \ + @CMAKE_CURRENT_SOURCE_DIR@/examples \ + @CMAKE_CURRENT_SOURCE_DIR@/obj \ + @CMAKE_CURRENT_SOURCE_DIR@/platform/mipi_stp_sim \ + @CMAKE_CURRENT_SOURCE_DIR@/platform/linux \ + @CMAKE_CURRENT_SOURCE_DIR@/sdk \ + @CMAKE_CURRENT_SOURCE_DIR@/example.c + +# 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 = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# 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 = + +# 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 = + +# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page (index.html). +# This can be useful if you have a project on for instance GitHub and want reuse +# the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = mainpage.md + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = YES + +# 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 = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +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 = YES + +#--------------------------------------------------------------------------- +# 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 = @CMAKE_CURRENT_BINARY_DIR@/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 = + +# 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 = + +# 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 = + +# 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 = @CMAKE_CURRENT_SOURCE_DIR@/mipi_sys_t_message_anatomy.png \ + @CMAKE_CURRENT_SOURCE_DIR@/mipi_sys_t_library_flow.png \ + @CMAKE_CURRENT_SOURCE_DIR@/mipi_sys_t_event_header.png + +# 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 = "C:\Program Files (x86)\HTML Help Workshop\hhc.exe" + +# 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 = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +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 can set the default output format to be used for +# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and +# SVG. The default value is HTML-CSS, which is slower, but has the best +# compatibility. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# 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 = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. +# There are two flavours of web server based search depending on the +# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for +# searching and an index file used by the script. When EXTERNAL_SEARCH is +# enabled the indexing and searching needs to be provided by external tools. +# See the manual for details. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain +# the search results. Doxygen ships with an example indexer (doxyindexer) and +# search engine (doxysearch.cgi) which are based on the open source search engine +# library Xapian. See the manual for configuration details. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will returned the search results when EXTERNAL_SEARCH is enabled. +# Doxygen ships with an example search engine (doxysearch) which is based on +# the open source search engine library Xapian. See the manual for configuration +# details. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id +# of to a relative location where the documentation can be found. +# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# 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 + + +# 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 = @CMAKE_CURRENT_SOURCE_DIR@/../include \ + @CMAKE_CURRENT_BINARY_DIR@/gensrc \ + @CMAKE_CURRENT_SOURCE_DIR@/../platform/example/include + +# 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 = *.h + +# 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 = MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD \ + MIPI_SYST_PCFG_ENABLE_LOCATION_ADDRESS \ + MIPI_SYST_PCFG_ENABLE_PLATFORM_STATE_DATA \ + MIPI_SYST_PCFG_ENABLE_CATID64_API \ + MIPI_SYST_PCFG_ENABLE_CATID32_API \ + MIPI_SYST_PCFG_ENABLE_WRITE_API \ + MIPI_SYST_PCFG_ENABLE_BUILD_API \ + MIPI_SYST_PCFG_ENABLE_STRING_API \ + MIPI_SYST_PCFG_ENABLE_64BIT_IO \ + MIPI_SYST_PCFG_ENABLE_HEAP_MEMORY \ + MIPI_SYST_PCFG_ENABLE_TIMESTAMP \ + __GNUC__ \ + __x86_64__ \ + _DOXYGEN_ + +# 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 = YES + +#--------------------------------------------------------------------------- +# 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/library/doxygen/DoxygenLayout.xml b/library/doxygen/DoxygenLayout.xml new file mode 100644 index 0000000..b1040f1 --- /dev/null +++ b/library/doxygen/DoxygenLayout.xml @@ -0,0 +1,207 @@ +<doxygenlayout version="1.0"> + <!-- Generated by doxygen 1.8.5 --> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title="Title Page"/> + <tab type="usergroup" title="Licensing"> + <tab type="user" url="@ref mipi_syst_license_page" visible="yes" title="SyS-T Source Code License"/> + </tab> + <tab type="usergroup" title="User Manual"> + <tab type="user" url="@ref mipi_syst_api_page" visible="yes" title="API Quick-Reference"/> + <tab type="user" url="@ref mipi_syst_api_overview" visible="yes" title="API Overview"/> + <tab type="user" url="@ref mipi_syst_building_page" visible="yes" title="Building SyS-T"/> + <tab type="user" url="@ref mipi_syst_adapting_page" visible="yes" title="Adapting SyS-T"/> + <tab type="user" url="@ref mipi_syst_decoder_protocol" visible="yes" title="Data Protocol"/> + <tab type="user" url="@ref mipi_syst_example_page" visible="yes" title="Instrumentation API Examples"/> + <tab type="user" url="@ref mipi_syst_catgen_page" visible="yes" title="Automated Catalog Generation"/> + <tab type="user" url="@ref mipi_syst_printer_page" visible="yes" title="Decoding and Printing the Data Protocol"/> + </tab> + <tab type="pages" visible="no" title="" intro=""/> + <tab type="modules" visible="yes" title="API Reference" intro="SyS-T API reference and configuration details:"/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespacelist" visible="yes" title="" intro=""/> + <tab type="namespacemembers" visible="yes" title="" intro=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classlist" visible="yes" title="" intro=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title="" intro=""/> + <tab type="classmembers" visible="yes" title="" intro=""/> + </tab> + <tab type="files" visible="yes" title="Source Cross Reference"> + <tab type="filelist" visible="yes" title="" intro=""/> + <tab type="globals" visible="yes" title="" intro=""/> + </tab> + <tab type="examples" visible="yes" title="" intro=""/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <services title=""/> + <interfaces title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <typedefs title=""/> + <enums title=""/> + <services title=""/> + <interfaces title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <allmemberslink visible="yes"/> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="yes"/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <constantgroups visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="yes"/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <constantgroups visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <inlineclasses title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="yes"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <memberdecl> + <nestedgroups visible="yes" title=""/> + <dirs visible="yes" title=""/> + <files visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + <membergroups visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + <memberdef> + <pagedocs/> + <inlineclasses title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <functions title=""/> + <variables title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="yes"/> + <directorygraph visible="yes"/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + <detaileddescription title=""/> + </directory> +</doxygenlayout> diff --git a/library/doxygen/Example.md b/library/doxygen/Example.md new file mode 100644 index 0000000..ac32783 --- /dev/null +++ b/library/doxygen/Example.md @@ -0,0 +1,68 @@ +\page mipi_syst_example_page Instrumentation API Examples + +[TOC] + +SyS-T ships with various example applications that show how to use +instrumentation calls. The examples are stored inside the examples +directory of the distribution file set. A CMake script is provided for +building the examples on CMake supported platforms. To build the +examples without CMake, add the SyS-T include directory to the list of +include directories for the compiler being used and tell the linker +to link against the SyS-T library. + +Example for building a SyS-T example on Linux: + + $ export MIPI_SYST_SDK=<enter path to SyS-T-SDK here> + $ gcc -o hello hello.c -I$MIPI_SYST_SDK/include -L$MIPI_SYST_SDK/lib -lmipi_syst + + +SyS-T "hello world" Style Application +=========================================================================== +This example is stored in the examples/hello directory of the SyS-T +distribution. + +Example source code: + +\code{.c} +#include "mipi_syst.h" /* SyS-T definitions */ + + +/* Define origin used by this example as the message client ID + */ +static const struct mipi_syst_origin origin = +MIPI_SYST_GEN_ORIGIN_GUID(0x494E5443, 0xA2AE, 0x4C70, 0xABB5, 0xD1A79E9CEA35, 1); + +int main(int argc, char* argv[]) +{ + struct mipi_syst_handle* systh; + + /* Initialize a SyS-T output handle structure + */ + systh = MIPI_SYST_ALLOC_HANDLE( &origin ); + + /* Send a string message with payload "Hello World!" + */ + MIPI_SYST_DEBUG(systh, MIPI_SYST_SEVERITY_INFO, "Hello world!" , /*length*/ 12); + + /* Release any resources associated with this SyS-T handle. + */ + MIPI_SYST_DELETE_HANDLE(systh); + + return 0; +} +\endcode + +The example will produce output like that below if the ``example`` platform is used. +It shows which MIPI STP protocol packets are created to transport the +SYS-T message data. + +``` +STP Protocol Output: + 0 <D32TS> 01800242 // SyS-T header + 1 <D64> 704caea243544e49 // GUID part #1 + 2 <D64> 35ea9c9ea7d1b5ab // GUID part #2 + 3 <D64> 6f77206f6c6c6548 // Payload part #1 + 4 <D32> 21646c72 // Payload part #2 + 5 <FLAG> // end of record +SYS-T RAW DATA: 42108001494E5443A2AE4C70ABB5D1A79E9CEA3548656C6C6F20776F726C6421 +``` diff --git a/library/doxygen/License.md b/library/doxygen/License.md new file mode 100644 index 0000000..4856f60 --- /dev/null +++ b/library/doxygen/License.md @@ -0,0 +1,34 @@ +SyS-T Source Code License {#mipi_syst_license_page} +========================================================================= + + Copyright (c) 2018, MIPI Alliance, Inc. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + + * Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/library/doxygen/Printer.md b/library/doxygen/Printer.md new file mode 100644 index 0000000..647ca7f --- /dev/null +++ b/library/doxygen/Printer.md @@ -0,0 +1,103 @@ +\page mipi_syst_printer_page Instrumentation API Examples + +[TOC] + +SyS-T Protocol Printer {#mipi_syst_printer} +============================================================================== +The project includes a SyS-T data protocol pretty printer tool +in the printer subdirectory. The printer is a standalone application +written in C++11. It supports reading the output from instrumented +applications using the example platform from the SyS-T +instrumentation library. +The tool scans the output for lines starting with ``SYS-T RAW DATA:`` and +converts the hex dumps into binary data for decoding. The printer can +be easily adapted to real trace data transports by replacing the code +in ``printer/src/mipi_syst_main.cpp`` with an appropriate data reader. + +Building the Printer +------------------------------------------------------------------------------ +The following transcript shows how to build the printer on a Linux console. +The printer is a standalone application and independent from the +instrumentation library or example projects. + +``` +$ cmake ../../sys-t/printer +-- The C compiler identification is GNU 5.4.0 +-- The CXX compiler identification is GNU 5.4.0 +-- Check for working C compiler: /usr/bin/cc +-- Check for working C compiler: /usr/bin/cc -- works +-- Detecting C compiler ABI info +-- Detecting C compiler ABI info - done +-- Detecting C compile features +-- Detecting C compile features - done +-- Check for working CXX compiler: /usr/bin/c++ +-- Check for working CXX compiler: /usr/bin/c++ -- works +-- Detecting CXX compiler ABI info +-- Detecting CXX compiler ABI info - done +-- Detecting CXX compile features +-- Detecting CXX compile features - done +-- Configuring done +-- Generating done +-- Build files have been written to: /users/mipi/prj/syst_build/printer + +$ make +Scanning dependencies of target systprint +[ 14%] Building CXX object CMakeFiles/systprint.dir/src/mipi_syst_main.cpp.o +[ 28%] Building CXX object CMakeFiles/systprint.dir/src/mipi_syst_collateral.cpp.o +[ 42%] Building CXX object CMakeFiles/systprint.dir/src/mipi_syst_printf.cpp.o +[ 57%] Building CXX object CMakeFiles/systprint.dir/src/mipi_syst_decode.cpp.o +[ 71%] Building CXX object CMakeFiles/systprint.dir/src/mipi_syst_message.cpp.o +[100%] Linking CXX executable systprint +[100%] Built target systprint +``` + +Testing the Printer +------------------------------------------------------------------------------ +The printer project comes with a self test feature. The ``printer/test`` +directory contains reference input and output files collected using the +``example/client`` example application. To run the printer test use the +following command (or the cmake test driver command ``ctest``) in the +printer build directory: + +``` +$ make test +Running tests... +Test project /users/mipi/prj/syst_build/printer + Start 1: print_client_example +1/3 Test #1: print_client_example ............... Passed 0.01 sec + Start 2: diff_output_with_32bit_reference +2/3 Test #2: diff_output_with_32bit_reference ... Passed 0.04 sec + Start 3: diff_output_with_64bit_reference +3/3 Test #3: diff_output_with_64bit_reference ... Passed 0.03 sec + +100% tests passed, 0 tests failed out of 3 + +Total Test time (real) = 0.11 sec +``` + +To actually see the printer output, run the printer directly using command +line arguments, or indirectly through the test driver in verbose mode +(```ctest --verbose```). The following transcript shows how to call the +printer directly: + +``` +$systprint --short_guid {494E5443-8A9C-4014-A65A-2F36A36D96E4} --collateral ../../sys-t/printer/test/collateral.xml ../../sys-t/printer/test/input_client64.txt + +Decode Status,Payload,Type,Severity,Origin,Unit,Message TimeStamp,Context TimeStamp,Location,Raw Length,Checksum,Collateral +OK,"0x0000000000010000 version banner string",BUILD:LONG,MAX,example,1,0x00054A4B376A70E9,0x0000000000000000,,62,0x4DDEF5B9,../../sys-t/printer/test/collateral.xml +OK,"SyS-T Library version 1.0.0",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000001,./systclient.c:64,48,0x7A34B527,../../sys-t/printer/test/collateral.xml +OK,"+-------------------------------------------------------+",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000002,./othersource.c:40,36,0x7CBB44B6,../../sys-t/printer/test/collateral.xml +OK,"| ____ _____ _______ |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000003,./othersource.c:41,36,0x2761EBF4,../../sys-t/printer/test/collateral.xml +OK,"| / ___| / ____| |__ __| |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000004,./othersource.c:42,36,0x55C63EAB,../../sys-t/printer/test/collateral.xml +OK,"| | |___ __ _| |___ _____| | |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000005,./othersource.c:43,36,0xE3885FB4,../../sys-t/printer/test/collateral.xml +OK,"| \___ \| | | |\___ \_____| | |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000006,./othersource.c:44,36,0x4C13A7F5,../../sys-t/printer/test/collateral.xml +OK,"| ____| | |_| |____| | | | |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000007,./othersource.c:45,36,0xE2C8BDC2,../../sys-t/printer/test/collateral.xml +OK,"| |_____/ \__| |_____/ |_| |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000008,./othersource.c:46,36,0xD0734297,../../sys-t/printer/test/collateral.xml +OK,"| _/ / |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x0000000000000009,./othersource.c:47,36,0x6D704426,../../sys-t/printer/test/collateral.xml +OK,"| |__/ |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x000000000000000A,./othersource.c:48,36,0x0A8FD609,../../sys-t/printer/test/collateral.xml +OK,"+-------------------------------------------------------+",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x000000000000000B,./othersource.c:49,36,0x1E99CD8F,../../sys-t/printer/test/collateral.xml +OK,"| catalog Format | Printed Result |",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A70E9,0x000000000000000C,./othersource.c:231,36,0xA17B5C1C,../../sys-t/printer/test/collateral.xml +OK,"|---------------------------------strings---------------|",CATALOG:ID32P64,INFO,example,1,0x00054A4B376A74D1,0x000000000000000D,./othersource.c:232,36,0x11A215E6,../../sys-t/printer/test +(...) +$ +```
\ No newline at end of file diff --git a/library/doxygen/Protocol.md b/library/doxygen/Protocol.md new file mode 100644 index 0000000..498e9e9 --- /dev/null +++ b/library/doxygen/Protocol.md @@ -0,0 +1,318 @@ +\page mipi_syst_decoder_protocol SyS-T Data Protocol + +[TOC] + +Overview {#syst_decoder_prot_overview} +============================================================================== +The SyS-T Data Protocol is a byte sequence that represents a list of variable +length SyS-T Messages without additional padding bytes between them. The +SyS-T Data Protocol is intended for transmission over a lower level transport +protocol. The lower level protocol is expected to provide indicators that +identify the start and end of a SyS-T Message. One example of a lower level +transport protocol is the +[MIPI System Trace Protocol](http://mipi.org/specifications/debug#STP) (STP). +SyS-T includes message frame definitions that provides time stamping +and framing of a SyS-T Message based on STP packet types. The usage of +other lower level transports protocols is possible by adapting the message +writer or low level trace output functions from the platform level code. + +The SyS-T Data Protocol includes various optional fields for ensuring data +integrity or time stamping. Depending on the capabilities of the lower level +protocol, these SyS-T Message fields may be redundant and so be omitted to +save trace bandwidth. + + +Data Field Byte Ordering {#syst_decoder_prot_byteorder} +------------------------------------------------------------------------------ +All numeric data fields of the SyS-T Data Protocol follow little-endian byte +ordering where less significant bytes precede more significant ones. Only the +optional 128-bit Guid field is an exception to this rule. Its byte odering +follows RFC 4122 which defines Guid fields following big-endian ordering. + +MIPI STPv2 Protocol Encoding {#syst_decoder_prot_format} +------------------------------------------------------------------------------ +In order to timestamp packets and to give an indication of a valid SyS-T +Message beginning and end, each SyS-T Message starts with a +TIMESTAMPED STP data packet and ends with either a FLAG packet or a +MARKED data packet. +For environments that can only afford light weight value style traces, a +short message encoding is also available. This encoding uses a single IO to +generate an STP packet that is both MARKED and TIMESTAMPED. The following +table shows the supported STP packet sequences for a SyS-T Message. Dn means +either a D8, D16, D32 or D64 data packet. +The Dn* stands for a sequence of 0-x repeated Dn packets (of any sizes). Dn +packets with a smaller payload size can be combined into a Dn with a larger +size to reduce the number of IO's. For example, two D16 IO's can be combined +into a single D32 as long as the resulting binary payload data produces the +same result when being copied into memory. + + MIPI STPv2 Sequences | Description +---------------------------|-------------------------------------------- +DnMTS |Single IO short message with Dn sized payload. This message is intended for numeric value only tracing. +DnTS-Dn*-DnM |Arbitrary length sequence starting with a time stamped data value and followed by a sequence of zero or more payload data values. The last data value is MARKED to indicate the end of the sequence. +DnTS-Dn*-FLAG |Arbitrary length sequence starting with time stamped data value and followed by a sequence of zero or more payload data values. The sequence is terminated with a FLAG packet. + +The reason for supporting sequences terminated with either a MARKED or a +FLAG packet is to simplify the implementation for SW and HW trace generators. +HW based generates may prefer the MARKED method to save additional logic for +issuing a FLAG. SW trace generators may prefer the FLAG variant as it +avoids special handling for the last Dn. + + + +Message Anatomy {#syst_decoder_prot_anatomy} +------------------------------------------------------------------------------ +A SyS-T Message is a byte sequence that starts with a 32-bit header, followed by +mandatory and optional data attributes. The following picture shows the layout +of a SyS-T Message with all fields present. + + + + +The message fields are: + - A 32-bit [header] (#syst_decoder_prot_header) describing the message type and content + - An optional 128-bit wide [GUID] (#syst_decoder_prot_guid) identifying the message originating software module. + - An optional [location record] (#syst_decoder_prot_location) + - An optional [payload length] (#syst_decoder_prot_length) + - An optional [SyS-T timestamp] (#syst_prot_timestamp) + - API specific [payload data] (#syst_decoder_prot_payload) from zero up to 64 Kbytes. + - An optional CRC-32C [checksum] (#syst_decoder_prot_checksum) + +Attributes are stored one after the other without any additional alignment bytes. + +SyS-T Protocol Overhead {#syst_decoder_prot_overhead} +------------------------------------------------------------------------------ +The typical data overhead of the SyS-T Data Protocol is 4 bytes (32 bits) per +message unless optional elements like CRC32 checksums are enabled. +These 4 bytes come from the 32-bit message header at the beginning +of each message. + +In addition to the typical usage as a message trace, SyS-T protocol offers also +the following protocol types for small value or bulk data transfer support: + + - Single value onle traces can utilize SHORT messages. These provide a + zero data overhead method on STP hardware using single DnMTS + packets to hold the data. + - SyS-T raw messages can be used to stream up to 64 Kbytes of payload data + in a single SyS-T Message to tunnel another Data Protocol through SyS-T. + + +Data Protocol Details {#syst_decoder_prot_details} +============================================================================== + +Header {#syst_decoder_prot_header} +------------------------------------------------------------------------------ +A SyS-T header is 32-bit value using the following layout: + + + +The meaning of the individual fields is explained in the table below. + +Field |Bits |Description +--------|------|----------------------------------------------------- +RES31 |31..31|Reserved, Must be set to zero. +RES30 |30..30|Reserved, Must be set to zero. +SUBTYPE |24..29|Additional message type information that depends on TYPE. +GUID |23..23|Indicates whether the optional GUID is present +ORIGIN |12..22|message origin and/or unit information +TS |11..11|Indicates whether the optional message time stamp is present. +CHK |10..10|Indicates whether the optional Checksum is present at the end. +LEN |9..9 |Indicates whether the optional Payload length is present. +LOC |8..8 |Indicates whether the optional Location Record field is present. +RES7 |7..7 |Reserved, Must be set to zero. +SEVERITY|4..6 |Severity level of the message. +TYPE |0..3 |Message type + +C-Definition (struct mipi_syst_msg_tag): +\code{.cpp} +struct mipi_syst_msg_tag { + mipi_syst_u32 et_type:4; /**< SyS-T message type ID */ + mipi_syst_u32 et_severity:3; /**< severity level of message */ + mipi_syst_u32 et_res7:1; /**< reserved for future use */ + mipi_syst_u32 et_location:1; /**< indicate location information */ + mipi_syst_u32 et_length:1; /**< indicate variable length message */ + mipi_syst_u32 et_chksum:1; /**< indicate 32bit CRC */ + mipi_syst_u32 et_timestamp:1;/**< indicate 64 bit timestamp */ + mipi_syst_u32 et_modunit:11; /**< unit for GUID or module:unit */ + mipi_syst_u32 et_guid:1; /**< 128 bit GUID present */ + mipi_syst_u32 et_subtype:6; /**< type dependent sub category */ + mipi_syst_u32 et_res30:1; /**< reserved for future use */ + mipi_syst_u32 et_res31:1; /**< reserved for future use */ +}; +\endcode + +Severity {#syst_decoder_prot_header_severity} +------------------------------------------------------------------------------ + +An optional severity level is assigned to a SyS-T Message to distinguish +informational messages from warnings and errors. Severity levels are used +for message classification and filtering. The severity levels are ordered +by ascending numerical values. + +Severity |Value | Description +---------------------------|:-----:|---------------------------------------------- +MIPI_SYST_SEVERITY_MAX | 0 |No assigned severity. This is used for messages that should bypass filtering. This is typically used with RAW message that tunnel other protocols over SyS-T Messages. +MIPI_SYST_SEVERITY_FATAL | 1 |Indicates a fatal level message. Such messages provide information about a failure condition from which the system cannot recover or cannot continue to function properly. +MIPI_SYST_SEVERITY_ERROR | 2 |Indicates an error level message. Such messages provide information about an operation failure or inappropriate action that the system is not designed to handle. Errors may or may not cause a feature or system to subsequently fail. +MIPI_SYST_SEVERITY_WARNING | 3 |Indicates a warning level message. Such messages provide information about an undesirable, but recoverable situation that may result in problems if no actions are taken. Warning message information can be utilized to adaptively adjust system operations to avoid failures or to improve performance based on the use case. +MIPI_SYST_SEVERITY_INFO | 4 |Indicates an information level message. Such messages provide component specific information about operational actions and progress. They are intended for component specialists to analyze system behavior. +MIPI_SYST_SEVERITY_USER1 | 5 |Indicates a first user-defined message level for information with a higher verbosity than MIPI_SYST_SEVERITY_INFO. They are intended for component specialists to analyze system behavior in greater detail. +MIPI_SYST_SEVERITY_USER2 | 6 |Indicates a second user-defined level for informational messages with a higher verbosity than MIPI_SYST_SEVERITY_USER1. They are intended for component specialists to analyze system behavior in even greater detail. +MIPI_SYST_SEVERITY_DEBUG | 7 |Indicate a debug level message. Such messages provide information that is intended for system developers for detailed analysis and debug of system behavior. It provides the finest granularity of trace information and is typically used during verification and debug phases. + + +Message Origin or GUID {#syst_decoder_prot_guid} +------------------------------------------------------------------------------ +A SyS-T Message may contain a 128-bit wide GUID to identify the instrumented +software module in a unique way. A GUID is used if the guid bit in the header +is set. Otherwise the header origin field defines the message origin, +saving the bandwidth and space that would be used for the additional GUID bits. + +Omitting the GUID is possible when the origin field or transport layer +information sufficiently identifies the trace emitting source. An example +for transport layer information are the Master and Channel pairs for transports +using MIPI System Trace Protocol. If the message was sent from a dynamically +assigned master and channel pool, then these values are not sufficient and a +GUID must be used to describe the origin. If the handle got initialized using +the #MIPI_SYST_SET_HANDLE_GUID_UNIT API then the GUID is emitted directly after +the header in each message. +Note: +The GUID structure follows https://www.ietf.org/rfc/rfc4122.txt. + +Location {#syst_decoder_prot_location} +------------------------------------------------------------------------------ + +A SyS-T Message can contain location information describing the position of +its instrumentation call either as an instruction pointer address or as a +"file:line" ID pair. This location information is generated if one of the +API variants with the `_LOCADDR`, `_LOC16` or `_LOC32` suffix in the name is +used. + +### C Definition of Location ### + +\code{.cpp} +/** + * Specify format of used message location information that is added to the + * message data if tag.et_location == 1 + */ +struct mipi_syst_msglocation { + /** Message format + * 0 = 16-Bit file and 16-Bit line (total: 32-bit) + * 1 = 32-Bit file and 32-Bit line (total: 64-bit) + * 2 = 32-bit code address + * 3 = 64-bit code address + */ + mipi_syst_u8 el_format; + union { + union mipi_syst_msglocation32 loc32; /**< data for 32-bit variant */ + union mipi_syst_msglocation64 loc64; /**< data for 64-bit variant */ + } el_u; +}; + + +/** + * Location information inside a message (32-bit format) + * Location is either the source position of the instrumentation call, or + * the call instruction pointer value. + */ +union mipi_syst_msglocation32 { + struct { + mipi_syst_u16 etls_fileID; /**< ID of instrumented file */ + mipi_syst_u16 etls_lineNo; /**< line number in file */ + } etls_source_location; + mipi_syst_u32 etls_code_location:32; + /**< instruction pointer value */ +}; + +/** + * Location information inside a message (64-bit format) + * Location is either the source position of the instrumentation call, or + * the call instruction pointer value. + */ +union mipi_syst_msglocation64 { + struct { + mipi_syst_u32 etls_fileID; /**< ID of instrumented file */ + mipi_syst_u32 etls_lineNo; /**< line number in file */ + } etls_source_location; + mipi_syst_u64 etls_code_location:64; + /**< instruction pointer value */ +}; + +\endcode + +Length {#syst_decoder_prot_length} +------------------------------------------------------------------------------ + +The location information is followed by a 16-bit length field if the header bit +et_length is set. This length indicates the number of message payload bytes that +follow. + +### C Definition of Length ### + +\code{.cpp} + syst_u16_t ed_len; +\endcode + + +Message Payload {#syst_decoder_prot_payload} +------------------------------------------------------------------------------ +A SyS-T Message can contain a type specific payload of up to 64 Kbytes. The payload +appears after the optional message fields, but before the optional checksum. + +Checksum {#syst_decoder_prot_checksum} +------------------------------------------------------------------------------ +A SyS-T Message can end with a 32-bit CRC-32C checksum calculated over all of +the message bytes, excluding the checksum value itself. The CRC generation is +a per SyS-T handle choice. It is enabled or disabled by the +#MIPI_SYST_ENABLE_HANDLE_CHECKSUM API. The default is disabled. + +Protocol Timestamp Handling {#syst_prot_timestamp} +============================================================================== +The default usage for the SyS-T protocol is to rely on a transport timestamp +generated by, for example, trace arbiter hardware or a trace creating driver. +In this case, a SyS-T Message does not carry its own timestamp information. In +scenarios where no hardware time stamp exists, or this timestamp is not +accurate, SyS-T Messages can include their own time stamp. An example scenario +for this is when messages are buffered by a trace source before they are sent. +In this case, the hardware time stamp will reflect a later message submission +time, not the message creation time, which is typically what is desired. + +Clock Synchronization {#syst_prot_timestamp_sync} +------------------------------------------------------------------------------ +The SyS-T protocol facilitates correlating messages that use a time stamp of +their own with the trace timestamp of the underlying transport protocol. This +correlation is done using a synchronisation message, which contains both the +transport protocol timestamp and the source clock value and frequency from +the SyS-T message clock. + +These data values build a time correlation point between the transport +clock and the SyS-T message clock. If MIPI STP is the transport protocol then +the D32TS header time stamp will define the transport time stamp. The message +is expected to be sent periodically from any source that requires time +synchronisation with the transport protocol. Host side tooling needs at least +one of these records in a trace stream to do the time correlation. Typically +these synchronization messages are sent either periodically, such as once +every second, or at the beginning of trace emitting phases. + + +SyS-T Messages Types {#syst_decoder_prot_msg_types} +============================================================================== +This chapter shows the major SyS-T message types. +The type can be one of the following (See [C Definition] (@ref mipi_syst_msgtype) ): + + + +Value |SyS-T Name |Description +--------|-------------------------|------------------------------------- +0 |MIPI_SYST_TYPE_BUILD |SyS-T client build version information +1 |MIPI_SYST_TYPE_SHORT32 |32 Bit message with user defined payload value +2 |MIPI_SYST_TYPE_STRING |Text message output for UTF-8 encoded strings +3 |MIPI_SYST_TYPE_CATALOG |Catalog message output support formatting string with parameters +4,5 |RESERVED-FOR-FUTURE-USE |Reserved +6 |MIPI_SYST_TYPE_RAW |Raw binary payload +7 |MIPI_SYST_TYPE_SHORT64 |64 Bit message with user defined payload value +8 |MIPI_SYST_TYPE_CLOCK |Timing synchronization +9..15 |RESERVED-FOR-FUTURE-USE |Reserved + +For further information on the different message type contents, read chapter 8 +in the MIPI Alliance Specification for System Software-Trace (SyS-T). diff --git a/library/doxygen/Reference.md b/library/doxygen/Reference.md new file mode 100644 index 0000000..f6d02e1 --- /dev/null +++ b/library/doxygen/Reference.md @@ -0,0 +1,347 @@ +API Quick-Reference {#mipi_syst_api_page} +====================================== +This page provides a quick reference for the SyS-T API macros. A +detailed description of these APIs and their their parameter +definitions is available by clicking on the individual API names. + +## State lifetime handling macros ## +<table border=1 cols="3" align="left" width="100%"> + <tr> + <td width="30%"><b>API Define</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_INIT(f,p) + </td> + <td>SyS-T global platform initialization using an internal shared state header + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_INIT_STATE(s, f,p) + </td> + <td>SyS-T platform initialization using a provided state header structure + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SHUTDOWN() + </td> + <td>SyS-T global platform shutdown + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SHUTDOWN_STATE(s) + </td> + <td>SyS-T platform shutdown using a provided state header structure + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_INIT_HANDLE(h,p) + </td> + <td>Initialize a static (not heap allocated) SyS-T handle. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_INIT_HANDLE_STATE(s, h,p) + </td> + <td>Initialize a static (not heap allocated) SyS-T handle using a provided state header structure. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_ALLOC_HANDLE(p) + </td> + <td>Initialize heap allocated SyS-T handle. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_ALLOC_HANDLE_STATE(s, p) + </td> + <td>Initialize heap allocated SyS-T handle using a provided state header structure. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_DELETE_HANDLE(p) + </td> + <td>Delete a SyS-T handle. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SET_HANDLE_ORIGIN(h, o) + </td> + <td>Set the client origin for the given SyS-T handle based on a mipi_syst_origin structure. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SET_HANDLE_MODULE_UNIT(h,m,u) + </td> + <td>Specify module and unit ID of the given SyS-T handle. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SET_HANDLE_GUID_UNIT(h, g, u) + </td> + <td>Specify GUID and unit ID of the given SyS-T handle. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_ENABLE_HANDLE_LENGTH(h, v) + </td> + <td>Enable or disable length field generation over the given SyS-T handle. + </td> + </tr> + + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_ENABLE_HANDLE_CHECKSUM(h,v) + </td> + <td>Enable or disable checksum generation over the given SyS-T handle. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_ENABLE_HANDLE_TIMESTAMP(h, v) + </td> + <td>Enable or disable additional protocol times tamps over the + given SyS-T handle. + </td> + </tr> +</table> +The availability of the macros #MIPI_SYST_ALLOC_HANDLE, #MIPI_SYST_SET_HANDLE_GUID_UNIT, +and #MIPI_SYST_ENABLE_HANDLE_CHECKSUM depend on +platform feature enable defines. Attempting to use an unsupported API will result +in a compile error. +<BR> + +## String emitting macros ## +<table border=1 cols="3" align="left" width="100%"> + <tr> + <td width="30%"><b>API Define</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_DEBUG(svh,sev,str,len)<BR> + MIPI_SYST_DEBUG_LOC16(svh,sev,file,str,len)<BR> + MIPI_SYST_DEBUG_LOC32(svh,sev,file,str,len)<BR> + MIPI_SYST_DEBUG_LOCADDR(svh,sev,str,len) + </td> + <td>Send A UTF-8 character string with given severity and length<BR> + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + \link MIPI_SYST_PRINTF MIPI_SYST_PRINTF(svh,sev,str, ...)\endlink<BR> + \link MIPI_SYST_PRINTF_LOC16 MIPI_SYST_PRINTF_LOC16(svh,sev,file,str, ...)\endlink<BR> + \link MIPI_SYST_PRINTF_LOC32 MIPI_SYST_PRINTF_LOC32(svh,sev,file,str, ...)\endlink<BR> + \link MIPI_SYST_PRINTF_LOCADDR MIPI_SYST_PRINTF_LOCADDR(svh,sev,str, ...)\endlink + </td> + <td>Send a C-language style *printf()* API format string and its + arguments. This API follows the calling convention of + printf() as defined by the C99 C-Language standard.<BR> + <B>Notes:</B> This API is enabled by the SyS-T platform + define @ref MIPI_SYST_PCFG_ENABLE_PRINTF_API that must be set in + addition to @ref MIPI_SYST_PCFG_ENABLE_STRING_API.<BR> + Enabling this API implies the availability of the C-Language + standard header files stdarg.h and stddef.h. These are needed + due to the variable argument support of the *printf()* calling + convention. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_FUNC_ENTER(svh,sev)<BR> + MIPI_SYST_FUNC_ENTER_LOC16(svh,sev,file)<BR> + MIPI_SYST_FUNC_ENTER_LOC32(svh,sev,file)<BR> + MIPI_SYST_FUNC_ENTER_LOCADDR(svh,sev) + </td> + <td>Send function enter string message. The payload is the + UTF-8 name of the surrounding function. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_FUNC_EXIT(svh,sev)<BR> + MIPI_SYST_FUNC_EXIT_LOC16(svh,sev,file)<BR> + MIPI_SYST_FUNC_EXIT_LOC32(svh,sev,file)<BR> + MIPI_SYST_FUNC_EXIT_LOCADDR(svh,sev) + </td> + <td>Send function exit string message. The payload is the + UTF-8 name of the surrounding function. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_ASSERT(svh,sev,cond)<BR> + MIPI_SYST_ASSERT_LOC16(svh,sev,file,cond)<BR> + MIPI_SYST_ASSERT_LOC32(svh,sev,file,cond)<BR> + MIPI_SYST_ASSERT_LOCADDR(svh,sev,cond) + </td> + <td>Send [file]:[line] assertion notice string message if the passed + condition is false + </td> + </tr> +</table> +The string emitting macros must be enabled by the SyS-T platform +define #MIPI_SYST_PCFG_ENABLE_STRING_API, otherwise they expand to nothing +inside the code. +<BR> +## Catalog message macros ## +<table border=1 cols="3" align="left" width="100%"> + <tr> + <td width="30%"><b>API Define</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td style="white-space:nowrap"> + \link MIPI_SYST_CATALOG64(svh,sev,id, ...)\endlink<BR> + </td> + <td> Send catalog message with variable number of parameters defined + by the format string that matches the 64-bit catalog ID.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_CATALOG64_0(svh,sev,id)<BR> + ...<BR> + MIPI_SYST_CATALOG64_6(svh, sev, id,p1,p2,p3,p4,p5,p6) + </td> + <td> Send catalog message with 0-6 parameters.The MIPI_SYST_CATALOG64* + defines build a family of macros that are used to send 64-bit wide + user defined catalog message IDs with up to six 32-bit wide + parameters into the trace stream.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_CATPRINTF64_0(svh, sev, id, fmt)<BR> + ...<BR> + MIPI_SYST_CATPRINTF64_6(svh, sev, id, fmt, p1,p2,p3,p4,p5,p6) + </td> + <td> Printf style wrapper for the catalog functions that support an + additional fmt string parameter. The functions directly map to + their matching catalog call by dropping the fmt parameter. + Their purpose is to use printf style instrumentation in source + code together with catalog messages. The format strings are not + part of the message but can be extracted from source code to + pretty print catalog messages during trace decode.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + \link MIPI_SYST_CATALOG32(svh,sev,id, ...)\endlink<BR> + </td> + <td> Send catalog message with variable number of parameters defined + by the format string that matches the 32-bit catalog ID.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_CATALOG32_0(svh, sev, id)<BR> + ...<BR> + MIPI_SYST_CATALOG32_6(svh, sev, id,p1,p2,p3,p4,p5,p6) + </td> + <td> Send catalog message with 0-6 parameters. The MIPI_SYST_CATALOG32* + defines build a family of macros that are used to send 32-bit wide + user defined catalog message IDs with up to six 32-bit wide + parameters into the trace stream.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_CATPRINTF32_0(svh, sev, id, fmt)<BR> + ...<BR> + MIPI_SYST_CATPRINTF32_6(svh, sev, id, fmt, p1,p2,p3,p4,p5,p6) + </td> + <td> Printf style wrapper for the catalog functions that support an + additional fmt string parameter. The functions directly map to + their matching catalog call by dropping the fmt parameter. Their purpose is + to use printf style instrumentation in source code together with + catalog messages. The format strings are not part of the message + but can be extracted from source code to pretty print catalog + messages during trace decode.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_HASH(fmt, offset)<BR> + </td> + <td> The MIPI_SYST_HASH macro computes a 32-bit hash value for the fmt + string constant that is usable as a numeric CatalogID parameter. + The offset parameter is used to change the result in case of hash + value collisions with other strings. It is initially set to zero + and is only changed to a different value if a collision occurs. + It is used together with automated catalog ID generation + decribed here: \link mipi_syst_catgen_page\endlink.</td> + </tr> +</table> +The catalog message macros must be enabled by the SyS-T platform +defines #MIPI_SYST_PCFG_ENABLE_CATID32_API or #MIPI_SYST_PCFG_ENABLE_CATID64_API, +otherwise they expand to nothing inside the code. + + +## Raw data message macros ## +<table border=1 cols="3" align="left" width="100%"> + <tr> + <td width="30%"><b>API Define</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SHORT32(h, v) + </td> + <td> Send short data message with 28-bit user defined payload. + This API is intended for space and cpu restricted environments + that cannot support more complex message types.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_SHORT64(h, v) + </td> + <td> Send short data message with 60-bit user defined payload. + This API is intended for space and cpu restricted environments + that cannot support more complex message types.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_WRITE(h, sev, id, p, len) + </td> + <td> Send raw data message with user defined payload.</td> + </tr> +</table> +The #MIPI_SYST_WRITE API message macro must be enabled by the SyS-T platform +define #MIPI_SYST_PCFG_ENABLE_WRITE_API, otherwise it expands to nothing inside +the code. The #MIPI_SYST_SHORT32 and MIPI_SYST_SHORT64 APIs are always available. + +## Client software build ID message macros ## +<table border=1 cols="3" align="left" width="100%"> + <tr> + <td width="30%"><b>API Define</b></td> + <td><b>Description</b></td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_BUILD(h, sev, ver, text, len) + </td> + <td> Send 64-bit client software build ID number and optional version text.</td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_BUILD_COMPACT32(h, v) + </td> + <td> Send a 32-bit compact client software build ID message with 22-bit wide build number. + </td> + </tr> + <tr> + <td style="white-space:nowrap"> + MIPI_SYST_BUILD_COMPACT64(h, v) + </td> + <td> Send a 64-bit compact client software build ID message value with a 54-bit wide build number. + </td> + </tr> +</table>
\ No newline at end of file diff --git a/library/doxygen/mainpage.md b/library/doxygen/mainpage.md new file mode 100644 index 0000000..d2a3501 --- /dev/null +++ b/library/doxygen/mainpage.md @@ -0,0 +1,57 @@ +MIPI SyS-T Instrumentation Library {#mipi_syst_mainpage} +============================================================================== + +About the SyS-T instrumentation library +============================================================================== +The MIPI System Software Trace (SyS-T) library is a customizable, low +overhead example implementation of the SyS-T API and data protocol described +here: +https://www.mipi.org/specifications/sys-t + +The library is written as a self-contained C-language module and does not +depend on other runtime library or system include files. The SyS-T library is +usable in very different software environments, including OS user mode code, OS +kernel mode code, or controller firmware. + +This library provides the SyS-T instrumentation API to other software +components. The SyS-T API calls generate the @ref mipi_syst_decoder_protocol +and typically write it to a trace aggregator for bundling the data with other +trace sources. The SyS-T API offers advanced trace capabilities, such as: + +* String formatting in C-language printf style +* Catalog messages to save data size and trace I/O bandwidth +* Tunnelling of other data protocols +* Hardware and Software provided message time stamping and synchronisation + +The following picture shows the library execution flow left to +right. The SyS-T API is a set of preprocessor macros that are calling library +functions for generating trace messages based on the API input parameters. +These parameters are encoded into an internal format and written out by +platform specific code to the systems trace transport layer. + + + + +Documentation for using SyS-T to instrument software +============================================================================== + - [Instrumentation API Overview](@ref mipi_syst_api_overview) + - [API Quick Reference](@ref mipi_syst_api_page) + - [API Sets](@ref ApiSets) + +Click here for a minimal "Hello World" style example of +a SyS-T instrumented application: @ref mipi_syst_example_page + + +Documentation for building and integrating SyS-T +============================================================================== +- [Building the SyS-T Library](@ref mipi_syst_building_page) +- [Adapting the SyS-T Library](@ref mipi_syst_adapting_page) +- [Automated Collateral Generation](@ref mipi_syst_catgen_page) +- [Decoding and printing the SyS-T data protocol] (@ref mipi_syst_printer_page) + + +SyS-T License +============================================================================== +The SyS-T library code is Copyright (c) MIPI Alliance, Inc. and distributed +under a permissive open source license. The detailed license information can +be found [here](@ref mipi_syst_license_page). diff --git a/library/doxygen/mipi_sys_t_event_header.png b/library/doxygen/mipi_sys_t_event_header.png Binary files differnew file mode 100644 index 0000000..18135af --- /dev/null +++ b/library/doxygen/mipi_sys_t_event_header.png diff --git a/library/doxygen/mipi_sys_t_library_flow.png b/library/doxygen/mipi_sys_t_library_flow.png Binary files differnew file mode 100644 index 0000000..e279768 --- /dev/null +++ b/library/doxygen/mipi_sys_t_library_flow.png diff --git a/library/doxygen/mipi_sys_t_library_flow.vsd b/library/doxygen/mipi_sys_t_library_flow.vsd Binary files differnew file mode 100644 index 0000000..2241e80 --- /dev/null +++ b/library/doxygen/mipi_sys_t_library_flow.vsd diff --git a/library/doxygen/mipi_sys_t_message_anatomy.png b/library/doxygen/mipi_sys_t_message_anatomy.png Binary files differnew file mode 100644 index 0000000..e69736c --- /dev/null +++ b/library/doxygen/mipi_sys_t_message_anatomy.png diff --git a/library/doxygen/mipi_sys_t_overview.png b/library/doxygen/mipi_sys_t_overview.png Binary files differnew file mode 100644 index 0000000..ec7a9bd --- /dev/null +++ b/library/doxygen/mipi_sys_t_overview.png |
