<?xml version="1.0" encoding="UTF-8"?>
<!--

 File Name          : CRYP.xml
 Description        : Contextual documentation of CRYP
                      for all MCU series

 COPYRIGHT(c) 2016 STMicroelectronics

====================================================================
| version 0.1  |  A.Morin          | Creation                      |
====================================================================
| version 0.2  |  A.Morin          | BZ36828 correction            |
====================================================================

Contextual help database for CRYP 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>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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 -->
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <serie ref="STM32F2">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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 filter="STM32F21.*" display="Datasheet" type="dynamic" reference="dataSheet" index="Cryptographic acceleration">
            </link>
            <link display="Reference manual" type="dynamic" reference="refMan" index="Cryptographic processor (CRYP)">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <serie ref="STM32F4">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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 filter="STM32F4(1[57]|3[79]).*" display="Datasheet" type="dynamic" reference="dataSheet" index="Cryptographic acceleration">
            </link>
            <link filter="STM32F479.*" display="Datasheet" type="dynamic" reference="dataSheet" index="Cryptographic accelerator">
            </link>
            <link display="Reference manual" type="dynamic" reference="refMan" index="Cryptographic processor (CRYP)">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <serie ref="STM32F7">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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 filter="STM32F7([57]).*" display="Datasheet" type="dynamic" reference="dataSheet" index="Cryptographic acceleration">
            </link>
            <link display="Reference manual" type="dynamic" reference="refMan" index="Cryptographic processor (CRYP)">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <serie ref="STM32G0">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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="Cryptographic acceleration">
            </link>
            <link display="Reference Manual" type="dynamic" reference="refMan" index="Cryptographic processor (CRYP)">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
    <serie ref="STM32H7">
        <peripheral>
            <!-- Title of the contextual widget -->
            <title>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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="Cryptographic acceleration">
            </link>
            <link display="Reference manual" type="dynamic" reference="refMan" index="Cryptographic processor (CRYP)">
            </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>CRYP</title>
            <!-- Generic description displayed in the first panel of the tooltip -->
            <extract>Cryptographic processor</extract>
            <!-- Detailed information displayed in the expandable panel when no MCU series has been selected -->
            <help_text>The cryptographic processor can be used to both encipher and decipher data using the&lt;br/&gt;
                DES, Triple-DES or AES (128, 192, or 256) algorithms. It is a fully compliant implementation&lt;br/&gt;
                of the following standards:
                &lt;p style="text-indent:20px;"&gt;- The data encryption standard (DES) and Triple-DES (TDES) as defined&lt;br/&gt;
                by Federal Information Processing Standards Publication (FIPS PUB 46-3, 1999 October 25).&lt;br/&gt;
                It follows the American National Standards Institute (ANSI) X9.52 standard.&lt;/p&gt;
                &lt;p style="text-indent:20px;"&gt;- The advanced encryption standard (AES) as defined by Federal&lt;br/&gt;
                Information Processing Standards Publication (FIPS PUB 197, 2001 November 26)&lt;/p&gt;&lt;br/&gt;
                The CRYP processor performs data encryption and decryption using DES and TDES&lt;br/&gt;
                algorithms in Electronic codebook (ECB) or Cipher block chaining (CBC) mode.&lt;br/&gt;
                The CRYP peripheral is a 32-bit AHB2 peripheral. It supports DMA transfer for incoming and&lt;br/&gt;
                processed data, and has input and output FIFOs (each 8 words deep).
            </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="Cryptographic and hash processors (CRYP1, CRYP2 and HASH1, HASH2)">
            </link>
            <link display="Reference manual" type="dynamic" reference="refMan" index="Cryptographic processor (CRYP)">
            </link>
        </peripheral>
        <mode>
            <!-- @TODO Describe the mode TBD for CubeMX -->
        </mode>
        <config>
            <!-- @TODO configuration panel TBD for CubeMX -->
        </config>
    </serie>
</ctx_periph_help>
