1<?xml version="1.0" encoding="utf-8"?>
2
3
4<!--****************************************************************************
5* \file imo.cypersonality
6* \version 3.0
7*
8* \brief
9* IMO personality description file.
10* This supports CAT1A, CAT1B and CAT1C devices.
11*
12********************************************************************************
13* \copyright
14* Copyright (c) 2022, Cypress Semiconductor Corporation (an Infineon company) or
15* an affiliate of Cypress Semiconductor Corporation.
16* SPDX-License-Identifier: Apache-2.0
17*
18* Licensed under the Apache License, Version 2.0 (the "License");
19* you may not use this file except in compliance with the License.
20* You may obtain a copy of the License at
21*
22*     http://www.apache.org/licenses/LICENSE-2.0
23*
24* Unless required by applicable law or agreed to in writing, software
25* distributed under the License is distributed on an "AS IS" BASIS,
26* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
27* See the License for the specific language governing permissions and
28* limitations under the License.
29*****************************************************************************-->
30
31<Personality id="imo" name="IMO" version="3.0" xmlns="http://cypress.com/xsd/cyhwpersonality_v7">
32  <Dependencies>
33    <IpBlock name="mxs40srss,mxs40ssrss,mxs40srss_ver3" />
34    <Resource name="srss\.clock\.imo" />
35  </Dependencies>
36  <ExposedMembers>
37    <ExposedMember key="frequency" paramId="frequency" />
38    <ExposedMember key="accuracy"  paramId="accuracy" />
39  </ExposedMembers>
40  <Parameters>
41    <!-- PDL documentation -->
42    <ParamDoc id="pdlDoc" name="Configuration Help" group="Overview" default="file:///`${cy_libs_path()}`/docs/pdl_api_reference_manual/html/group__group__sysclk.html" linkText="Open SysClk Documentation" visible="true" desc="Opens the Peripheral Driver Library Documentation" />
43
44    <ParamRange id="frequency" name="Frequency (MHz)" group="Internal" default="8000000" min="8000000" max="8000000" resolution="1" visible="false" editable="false" desc="The nominal output frequency" />
45    <ParamChoice id="trim" name="Trim with" group="General" default="1" visible="`${hasBlock(&quot;usb[0]&quot;)}`" editable="true" desc="Allows to trim IMO with USB SOF, only for USB-enabled devices and only if USB block itself is enabled.">
46        <Entry name="None" value="1" visible="true" />
47        <Entry name="USB" value="0.25" visible="`${isBlockUsed(&quot;usb[0]&quot;)}`" />
48    </ParamChoice>
49    <ParamChoice id="accuracy" name="Accuracy" group="Internal" default="`${trim}`" visible="false" editable="false" desc="The expected accuracy of the output frequency">
50      <Entry name="1%" value="1" visible="true" />
51      <Entry name="0.25%" value="0.25" visible="true" />
52    </ParamChoice>
53    <!--ParamString id="frequencyInfo" name="Frequency" group="General" default="`${frequency / 1000000 . &quot; MHz&quot;}`" visible="true" editable="false" desc="The nominal output frequency" />
54    <ParamString id="accuracyInfo" name="Accuracy" group="General" default="&#177;`${accuracy . &quot;%&quot;}`" visible="true" editable="false" desc="The expected accuracy of the output frequency" /-->
55
56    <ParamString id="frequencyInfo" name="Frequency" group="General" default="`${formatFrequency(frequency, accuracy)}`" visible="true" editable="false" desc="The nominal output frequency" />
57
58  </Parameters>
59  <DRCs>
60    <DRC type="INFO" text="If the IMO output is used by the PLL to generate CLK_HF3 (USB clock) then it must be trimmed with USB SOF signal to meet USB clock accuracy requirements. Set IMO &quot;Trim with&quot; parameter to &quot;USB&quot;" condition="`${(trim eq 1) &amp;&amp; isBlockUsed(&quot;usb[0]&quot;)}`" />
61  </DRCs>
62  <ConfigFirmware>
63    <ConfigDefine name="CY_CFG_SYSCLK_IMO_ENABLED" value="1" public="false" include="true" />
64  </ConfigFirmware>
65</Personality>
66