<?xml version="1.0" encoding="UTF-8"?>
<!--

 File Name          : OPENAMP_M4.xml
 Description        : Contextual documentation of the OPENAMP
                      for H7 series M4 core

 COPYRIGHT(c) 2016 STMicroelectronics

====================================================================
| version 0.1  |  G. Hallet          | Creation                      |
====================================================================

Contextual help database for OPENAMP MiddleWare, it contains:
    - peripheral generic information under <peripheral> node
    - information about peripheral mode under <mode> node
    - details about the peripheral configuration under <config> node

-->
<ctx_pinout_help xsi:noNamespaceSchemaLocation="../../../../../../../doc/V4/Development/Specifications/contextualDocumentation/pinout.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <!-- serie "ref" is the MCU series you want to document e.g. STM32F0, STM32F1... -->
    <serie ref="Default">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>OPENAMP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Open Asymetric Multi Processing</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The OpenAMP framework provides conventions and standards to facilitate Asymmetric Multiprocessing (AMP) development for embedded systems.&lt;br/&gt;
                       The framework provides the following key capabilities:&lt;br/&gt;
                       1.Provides Life Cycle Management of remote processors (remoteproc) and Inter Processor Communication capabilities (RPMsg) between software contexts&lt;br/&gt;
                       2.Provides libraries usable with RTOS and Baremetal software environments&lt;br/&gt;
                       3.Compatibility with generic Linux remoteproc and rpmsg components&lt;br/&gt;
                       4.Running on a master processor and/or the remote coprocessor. For instance following configurations are supported:&lt;br/&gt;
                       - 4a. Linux master/Generic(Baremetal) remote&lt;br/&gt;
                       - 4b. RTOS master/RTOS remote&lt;br/&gt;
                       5.BSD license
            </help_text>
            <!-- Links that will be displayed on the help widgets:
            - filter: In case a selection needs to be made, use it as regexp on mcu name (STM32F042T6x)
            - display: string that will be displayed in front of the hyperlink
            - type: the type of file you want to display ("txt" "pdf", "chm", "html", "dynamic")
            dynamic stands for the document that have to be retrieved from the JSON database
            - reference: path to the document to be displayed (http or local path)
              If the file is dynamic, indicate the kind of file you want to display:
                * dataSheet => for datasheet document type
                * appNote => for application note document type
                * refMan => for reference manual document type
                * usrMan => for user Manual document type
                * prgMan => for Programming Manual document type
                * errSheet => for Errata Sheet document type
            - index: for pdf,html and chm type it specifies the chapter where the viewer will point
            for dynamic file it can specify a chapter except for application notes where it specifies
            the document display name (e.g. AN1015). This field may be left blank, then the full document
            is displayed -->
            <link display="Tutorial Video" type="tutorialbrowser" reference="Open Asymetric Multi Processing (OPENAMP)" index="">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <!-- serie "ref" is the MCU series you want to document e.g. STM32F0, STM32F1... -->
    <serie ref="STM32H7">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>OPENAMP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Open Asymetric Multi Processing</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The OpenAMP framework provides conventions and standards to facilitate Asymmetric Multiprocessing (AMP) development for embedded systems.&lt;br/&gt;
                       The framework provides the following key capabilities:&lt;br/&gt;
                       1.Provides Life Cycle Management of remote processors (remoteproc) and Inter Processor Communication capabilities (RPMsg) between software contexts&lt;br/&gt;
                       2.Provides libraries usable with RTOS and Baremetal software environments&lt;br/&gt;
                       3.Compatibility with generic Linux remoteproc and rpmsg components&lt;br/&gt;
                       4.Running on a master processor and/or the remote coprocessor. For instance following configurations are supported:&lt;br/&gt;
                       - 4a. Linux master/Generic(Baremetal) remote&lt;br/&gt;
                       - 4b. RTOS master/RTOS remote&lt;br/&gt;
                       5.BSD license
            </help_text>
            <!-- Links that will be displayed on the help widgets:
            - filter: In case a selection needs to be made, use it as regexp on mcu name (STM32F042T6x)
            - display: string that will be displayed in front of the hyperlink
            - type: the type of file you want to display ("txt" "pdf", "chm", "html", "dynamic")
            dynamic stands for the document that have to be retrieved from the JSON database
            - reference: path to the document to be displayed (http or local path)
              If the file is dynamic, indicate the kind of file you want to display:
                * dataSheet => for datasheet document type
                * appNote => for application note document type
                * refMan => for reference manual document type
                * usrMan => for user Manual document type
                * prgMan => for Programming Manual document type
                * errSheet => for Errata Sheet document type
            - index: for pdf,html and chm type it specifies the chapter where the viewer will point
            for dynamic file it can specify a chapter except for application notes where it specifies
            the document display name (e.g. AN1015). This field may be left blank, then the full document
            is displayed -->
            <link display="Tutorial Video" type="tutorialbrowser" reference="Open Asymetric Multi Processing (OPENAMP)" index="">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
</ctx_pinout_help>
