1<?xml version="1.0" encoding="utf-8"?>
2
3
4<!--****************************************************************************
5* \file memclock.cypersonality
6* \version 1.0
7*
8* \brief
9* CLK_MEM personality description file.
10*
11********************************************************************************
12* \copyright
13* Copyright 2018-2022 Cypress Semiconductor Corporation
14* SPDX-License-Identifier: Apache-2.0
15*
16* Licensed under the Apache License, Version 2.0 (the "License");
17* you may not use this file except in compliance with the License.
18* You may obtain a copy of the License at
19*
20*     http://www.apache.org/licenses/LICENSE-2.0
21*
22* Unless required by applicable law or agreed to in writing, software
23* distributed under the License is distributed on an "AS IS" BASIS,
24* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25* See the License for the specific language governing permissions and
26* limitations under the License.
27*****************************************************************************-->
28
29<Personality id="mxs40memclk" name="CLK_MEM" version="1.0" xmlns="http://cypress.com/xsd/cyhwpersonality_v7">
30  <Dependencies>
31    <IpBlock name="mxs40srss_ver3" />
32    <Resource name="srss\.clock\.memclk" />
33  </Dependencies>
34  <ExposedMembers>
35    <ExposedMember key="frequency" paramId="frequency" />
36    <ExposedMember key="accuracy"  paramId="accuracy" />
37  </ExposedMembers>
38  <Parameters>
39    <!-- PDL documentation -->
40    <ParamDoc id="pdlDoc" name="Configuration Help" group="Overview" default="file:///`${cy_libs_path()}`/docs/pdl_api_reference_manual/html/group__group__sysclk__clk__mem.html" linkText="Open Mem Clock Documentation" visible="true" desc="Opens the Peripheral Driver Library Documentation" />
41
42    <!-- Source clock -->
43    <ParamString id="sourceClockRsc" name="Source Clock" group="Internal" default="srss[0].clock[0].hfclk[0]" visible="false" editable="false" desc="" />
44    <!-- Set an error if the source clock is not enabled -->
45    <ParamBool id="srcNotUsed" name="Clock Source Enabled" group="Internal" default="`${!isBlockUsed(sourceClockRsc)}`" visible="false" editable="false" desc="" />
46    <ParamBool id="error" name="Clock Error" group="Internal" default="`${srcNotUsed || getExposedMember(sourceClockRsc, &quot;error&quot;)}`" visible="false" editable="false" desc="" />
47    <ParamRange  id="sourceFreq" name="sourceFrequency" group="Internal" default="`${!error ? getExposedMember(sourceClockRsc, &quot;frequency&quot;) : 0}`" min="0" max="400000000" resolution="1" visible="false" editable="false" desc="" />
48    <ParamString id="accuracy"  name="Accuracy"  group="Internal" default="`${!error ? getExposedMember(sourceClockRsc, &quot;accuracy&quot;) : 0}`" visible="false" editable="false" desc="" />
49    <ParamString id="sourceFrequencyInfo" name="Source Clock" group="General" default="`${formatFrequency(sourceFreq,accuracy)}`" visible="true" editable="false" desc="Source clock frequency" />
50
51    <!-- Resulted clock -->
52    <ParamRange id="divider" name="Divider" group="General" default="1" min="1" max="256" resolution="1" visible="true" editable="true" desc="" />
53    <ParamRange id="frequency" name="Frequency" group="Internal" default="`${sourceFreq / divider}`" min="0" max="400000000" resolution="1" visible="false" editable="false" desc="" />
54
55    <!-- If the frequency is less than one MHz, display its value in kHz -->
56    <ParamString id="frequencyInfo" name="Frequency" group="General" default="`${formatFrequency(frequency,accuracy)}`" visible="true" editable="false" desc="The resulting CLK_MEM output clock frequency" />
57  </Parameters>
58  <DRCs>
59    <DRC type="ERROR" text="Source clock for CLK_MEM is not enabled" condition="`${srcNotUsed}`" >
60      <FixIt action="ENABLE_BLOCK" target="`${sourceClockRsc}`" value="" valid="true" />
61    </DRC>
62  </DRCs>
63  <ConfigFirmware>
64    <ConfigInclude value="cy_sysclk.h" include="true" />
65    <ConfigDefine name="CY_CFG_SYSCLK_CLKMEM_ENABLED" value="1" public="false" include="true" />
66    <ConfigDefine name="CY_CFG_SYSCLK_CLKMEM_DIVIDER" value="`${divider - 1}`"  public="false" include="true" />
67    <ConfigFunction signature="__STATIC_INLINE void Cy_SysClk_ClkMemInit()" body="    Cy_SysClk_ClkMemSetDivider(`${divider - 1}`U);" public="false" include="true" />
68  </ConfigFirmware>
69</Personality>
70