<?xml version="1.0" encoding="UTF-8"?>
<!--

 File Name          : IPCC.xml
 Description        : Contextual documentation of the IPCC
                      for all MCU series

 COPYRIGHT(c) 2016 STMicroelectronics

====================================================================
| version 0.1  |  G.Hallet          | Creation                      |
====================================================================

Contextual help database for IPCC peripheral, it contains:
    - peripheral generic information under <peripheral> node
    - information about peripheral mode under <mode> node
    - details about the peripheral configuration under <config> node

-->
<ctx_periph_help xsi:noNamespaceSchemaLocation="../../../../../../../doc/V4/Development/Specifications/contextualDocumentation/peripherals.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>IPCC</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Inter-Processor Communication Controller</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The IPCC is used to exchange data between two processors. It provides a non blocking signaling mechanism to post and retrieve information in an atomic way.&lt;br/&gt;
                Notice that shared memory buffers are allocated in the MCU SRAM, which is not part of the IPCC block.
            </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="Inter-Processor Communication Controller (IPCC)" index="">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <serie ref="STM32MP1">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>IPCC</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Inter-Processor Communication Controller</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The IPCC is used to exchange data between two processors. It provides a non blocking signaling mechanism to post and retrieve information in an atomic way.&lt;br/&gt;
                Notice that shared memory buffers are allocated in the MCU SRAM, which is not part of the IPCC block.
            </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="Datasheet" type="dynamic" reference="dataSheet" index="Inter-processor communication controller (IPCC)">
            </link>
            <link display="Reference manual" type="dynamic" reference="refMan" index="Inter-Processor communication controller (IPCC)">
            </link>
            <link display="Tutorial Video" type="tutorialbrowser" reference="Inter-Processor Communication Controller (IPCC)" index="">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
</ctx_periph_help>
