1<?xml version="1.0" encoding="utf-8"?>
2
3
4<!--****************************************************************************
5* \file ilo.cypersonality
6* \version 3.0
7*
8* \brief
9* ILO personality description file. It supports CAT1A, CAT1B, CAT1C and
10* CAT1D 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="ilo" name="ILO" version="3.0" xmlns="http://cypress.com/xsd/cyhwpersonality_v7">
32  <Dependencies>
33    <IpBlock name="mxs40srss,mxs40ssrss,mxs40srss_ver2,mxs40srss_ver3" />
34    <Resource name="srss\.clock\.ilo" />
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__ilo.html" linkText="Open ILO Documentation" visible="true" desc="Opens the Peripheral Driver Library Documentation" />
43
44    <ParamRange id="iloInst" name="clockInst" group="Internal" default="`${getInstNumber(&quot;ilo&quot;)}`" min="0" max="1" resolution="1" visible="false" editable="false" desc="" />
45    <ParamRange id="frequency" name="Frequency (kHz)" group="General" default="32768" min="32768" max="32768" resolution="1" visible="false" editable="false" desc="" />
46    <!-- Use HT_VARIANT to determine the accuracy of ILO -->
47    <!-- Reference: 001-98134-RevX-Book2-PartIV-SRSS, Table 5-1 -->
48    <ParamChoice id="accuracy" name="Accuracy" group="General"
49      default="`${(lookupExpression(&quot;HT_VARIANT&quot;, false) ? 7 : 10)}`"
50      visible="false" editable="false" desc="">
51      <Entry name="7%" value="7" visible="true" /> <!-- Accuracy of ILO on MXS40E, trimmed w/o calibration -->
52      <Entry name="10%" value="10" visible="true" /> <!-- Accuracy of all other devices - including the MXS40S - trimmed w/o calibration -->
53    </ParamChoice>
54    <ParamBool id="hibernate" name="Run In Hibernate Mode" group="General" default="true" visible="`${ !iloInst ? true : false }`" editable="true" desc="Enables the ILO working in Hibernate low power mode" />
55    <!-- Field descriptions -->
56    <ParamString id="frequencyInfo" name="Frequency" group="General" default="`${frequency / 1000.0 . &quot; kHz&quot;}`" visible="true" editable="false" desc="The nominal output frequency" />
57    <ParamString id="accuracyInfo"  name="Accuracy"  group="General" default="&#177;`${accuracy . &quot;%&quot;}`" visible="true" editable="false" desc="The expected accuracy of the output frequency" />
58  </Parameters>
59  <ConfigFirmware>
60    <ConfigInclude value="cy_sysclk.h" include="true" />
61    <ConfigDefine name="CY_CFG_SYSCLK_ILO_ENABLED" value="1" public="false" include="`${(&quot;mxs40ssrss&quot; eq getIpBlockName()) || (&quot;mxs40srss&quot; eq getIpBlockName())}`" />
62    <ConfigDefine name="CY_CFG_SYSCLK_ILO_HIBERNATE" value="`${hibernate}`" public="false" include="`${(&quot;mxs40ssrss&quot; eq getIpBlockName()) || (&quot;mxs40srss&quot; eq getIpBlockName())}`" />
63    <ConfigDefine name="CY_CFG_SYSCLK_ILO`${getInstNumber(&quot;ilo&quot;)}`_ENABLED" value="1" public="false" include="`${((&quot;mxs40srss_ver2&quot; eq getIpBlockName()) || (&quot;mxs40srss_ver3&quot; eq getIpBlockName()))}`" />
64    <ConfigDefine name="CY_CFG_SYSCLK_ILO`${getInstNumber(&quot;ilo&quot;)}`_HIBERNATE" value="`${hibernate}`" public="false" include="`${(&quot;mxs40srss_ver2&quot; eq getIpBlockName()) || (&quot;mxs40srss_ver3&quot; eq getIpBlockName())}`" />
65    <ConfigFunction signature="__STATIC_INLINE void Cy_SysClk_IloInit()" body="    /* The WDT is unlocked in the default startup code */&#xA;    Cy_SysClk_IloEnable();&#xA;    Cy_SysClk_IloHibernateOn(`${hibernate}`);" public="false" include="`${(&quot;mxs40ssrss&quot; eq getIpBlockName()) || (&quot;mxs40srss&quot; eq getIpBlockName())}`" guard="(!defined(CY_DEVICE_SECURE))"/>
66    <ConfigFunction signature="__STATIC_INLINE void Cy_SysClk_Ilo`${getInstNumber(&quot;ilo&quot;)}`Init()" body="    /* The WDT is unlocked in the default startup code */&#xA;    Cy_SysClk_IloSrcEnable(`${getInstNumber(&quot;ilo&quot;)}`);&#xA;    Cy_SysClk_IloSrcHibernateOn(`${getInstNumber(&quot;ilo&quot;)}`, `${hibernate}`);" public="false" include="`${(&quot;mxs40srss_ver2&quot; eq getIpBlockName()) || (&quot;mxs40srss_ver3&quot; eq getIpBlockName())}`" guard="(!defined(CY_DEVICE_SECURE))" />
67  </ConfigFirmware>
68</Personality>
69