1<?xml version="1.0" encoding="utf-8"?> 2 3 4<!--**************************************************************************** 5* \file dmac.cypersonality 6* \version 2.0 7* 8* \brief 9* DMAC personality description file. It Supports CAT1A and CAT1C family of devices. 10* 11******************************************************************************** 12* \copyright 13* Copyright (c) (2022), Cypress Semiconductor Corporation (an Infineon company) or 14* an affiliate of Cypress Semiconductor Corporation. 15* SPDX-License-Identifier: Apache-2.0 16* 17* Licensed under the Apache License, Version 2.0 (the "License"); 18* you may not use this file except in compliance with the License. 19* You may obtain a copy of the License at 20* 21* http://www.apache.org/licenses/LICENSE-2.0 22* 23* Unless required by applicable law or agreed to in writing, software 24* distributed under the License is distributed on an "AS IS" BASIS, 25* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 26* See the License for the specific language governing permissions and 27* limitations under the License. 28*****************************************************************************--> 29 30<Personality id="dmac" name="DMAC" version="2.0" xmlns="http://cypress.com/xsd/cyhwpersonality_v7"> 31 <Dependencies> 32 <IpBlock name="m4cpuss,m7cpuss,m4cpuss_ver2" /> 33 <Resource name="cpuss\.dmac\.chan" /> 34 </Dependencies> 35 <ExposedMembers> 36 <ExposedMember key="block" paramId="block" /> 37 <ExposedMember key="channel" paramId="channel" /> 38 </ExposedMembers> 39 <Parameters> 40 <!-- PDL documentation --> 41 <ParamDoc id="pdlDoc" name="Configuration Help" group="Overview" default="file:///`${cy_libs_path()}`/docs/pdl_api_reference_manual/html/group__group__dmac.html" linkText="Open DMAC Documentation" visible="true" desc="Opens the Peripheral Driver Library Documentation" /> 42 43 <ParamString id="block" name="block number" group="Internal" default="`${"dw0" eq getBlockType(1) ? 0 : 1}`" visible="false" editable="false" desc="" /> 44 <ParamString id="base" name="base address" group="Internal" default="`${getBlockType(1)}`" visible="false" editable="false" desc="" /> 45 <ParamString id="channel" name="channel number" group="Internal" default="`${getInstNumber("chan")}`" visible="false" editable="false" desc="" /> 46 <ParamString id="version" name="version number" group="Internal" default="`${getVersion()}`" visible="false" editable="false" desc="" /> 47 48 <!--Channel--> 49 <ParamSignal port="tr_in[0]" name="Trigger Input" group="Channel" visible="true" desc="Sets up the trigger input signal for the DMA start." canBeEmpty="true" /> 50 <ParamSignal port="tr_out[0]" name="Trigger Output" group="Channel" visible="true" desc="Sets up the trigger output signal for the DMA completion." canBeEmpty="true" /> 51 <ParamRange id="CHANNEL_PRIORITY" name="Channel Priority" group="Channel" default="3" min="0" max="3" resolution="1" visible="true" editable="true" desc="Priority of the channel in the DMA block. Lower number takes precedence." /> 52 <ParamRange id="NUM_OF_DESCRIPTORS" name="Number of Descriptors" group="Channel" default="4" min="1" max="256" resolution="1" visible="true" editable="true" desc="The number of descriptors sets up rest of the customizer. Based on the number set in this parameter as many instances of Descriptors are created in the customizer." /> 53 <ParamBool id="BUFFERABLE" name="Bufferable" group="Channel" default="false" visible="true" editable="true" desc="Makes the channel data transactions bufferable." /> 54 55 <ParamChoice id="DESCR_SELECTION" name="Select the descriptor" group="Channel" default="0" visible="true" editable="true" desc="Select the descriptor to configure it."> 56 <Entry name="Descriptor_$idx" value="$idx" visible="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="256" /> 57 </ParamChoice> 58 59 <!--Descriptor--> 60 <Repeat count="256"> 61 <ParamString id="DESCR_NAME_$idx" name="Descriptor_$idx Name" group="Descriptor" default="Descriptor_$idx" visible="false" editable="true" desc="This parameter sets up the instance name for the Descriptor."/> 62 63 <ParamBool id="pDescrSelEqIdx_$idx" name="pDescrSelEqIdx_$idx" desc="pDescrSelEqIdx_$idx" group="Internal" default="`${DESCR_SELECTION eq $idx}`" visible="false" editable="false" /> 64 <ParamBool id="pDescrSelLeqIdx_$idx" name="pDescrSelLeqIdx_$idx" desc="" group="Internal" default="`${NUM_OF_DESCRIPTORS > $idx}`" visible="false" editable="false" /> 65 66 <ParamChoice id="TRIG_OUT_TYPE_$idx" name="Trigger output" group="Descriptor" default="CY_DMAC_1ELEMENT" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This is the selection for what event would trigger the DMA output."> 67 <Entry name="Trigger on every element transfer completion" value="CY_DMAC_1ELEMENT" visible="true" /> 68 <Entry name="Trigger on every X loop transfer completion" value="CY_DMAC_X_LOOP" visible="true" /> 69 <Entry name="Trigger on descriptor completion" value="CY_DMAC_DESCR" visible="true" /> 70 <Entry name="Trigger on completion of entire descriptor chain" value="CY_DMAC_DESCR_CHAIN" visible="true" /> 71 </ParamChoice> 72 <ParamChoice id="INTR_OUT_$idx" name="Interrupt type" group="Descriptor" default="CY_DMAC_1ELEMENT" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This is the selection for what event would trigger the DMA interrupt."> 73 <Entry name="Trigger on every element transfer completion" value="CY_DMAC_1ELEMENT" visible="true" /> 74 <Entry name="Trigger on every X loop transfer completion" value="CY_DMAC_X_LOOP" visible="true" /> 75 <Entry name="Trigger on descriptor completion" value="CY_DMAC_DESCR" visible="true" /> 76 <Entry name="Trigger on completion of entire descriptor chain" value="CY_DMAC_DESCR_CHAIN" visible="true" /> 77 </ParamChoice> 78 <ParamBool id="ENABLE_CHAINING_$idx" name="Enable Chaining" group="Descriptor" default="false" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="Specifies whether or not the descriptor chains to another" /> 79 <ParamRange id="CHAIN_TO_$idx" name="Chain to descriptor" group="Descriptor" default="0" min="0" max="`${NUM_OF_DESCRIPTORS - 1}`" resolution="1" visible="`${pDescrSelEqIdx_$idx && ENABLE_CHAINING_$idx}`" editable="`${pDescrSelLeqIdx_$idx && ENABLE_CHAINING_$idx}`" desc="Defines the descriptor which is chained to this descriptor." /> 80 81 <ParamChoice id="CHAN_STATE_COMPL_$idx" name="Channel state on completion" group="Descriptor" default="CY_DMAC_CHANNEL_ENABLED" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This is the state of the channel when the descriptor is completed."> 82 <Entry name="Disable" value="CY_DMAC_CHANNEL_DISABLED" visible="true" /> 83 <Entry name="Enable" value="CY_DMAC_CHANNEL_ENABLED" visible="true" /> 84 </ParamChoice> 85 <ParamChoice id="TRIG_IN_TYPE_$idx" name="Trigger input type" group="Descriptor" default="CY_DMAC_1ELEMENT" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="Trigger input type will set up the character of each trigger."> 86 <Entry name="One transfer per trigger" value="CY_DMAC_1ELEMENT" visible="true" /> 87 <Entry name="One X loop transfer per trigger" value="CY_DMAC_X_LOOP" visible="true" /> 88 <Entry name="An entire descriptor transfer per trigger" value="CY_DMAC_DESCR" visible="true" /> 89 <Entry name="Entire descriptor chain per trigger" value="CY_DMAC_DESCR_CHAIN" visible="true" /> 90 </ParamChoice> 91 <ParamChoice id="TRIG_DEACT_$idx" name="Trigger deactivation and retriggering" group="Descriptor" default="CY_DMAC_RETRIG_IM" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This parameter sets up the trigger deactivation options for the descriptor."> 92 <Entry name="Retrigger immediately (pulse trigger)" value="CY_DMAC_RETRIG_IM" visible="true" /> 93 <Entry name="Retrigger after 4 Slow Clock cycles" value="CY_DMAC_RETRIG_4CYC" visible="true" /> 94 <Entry name="Retrigger after 16 Slow Clock cycles" value="CY_DMAC_RETRIG_16CYC" visible="true" /> 95 <Entry name="Wait for trigger reactivation" value="CY_DMAC_WAIT_FOR_REACT" visible="true" /> 96 </ParamChoice> 97 98 <ParamBool id="DATA_PREFETCH_$idx" name="Data prefetch" group="Descriptor" default="false" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="Source data transfers are initiated as soon as the channel is enabled, the current descriptor pointer is NOT "0" and there is space available in the channel's data FIFO." /> 99 100 <ParamChoice id="DATA_TRANSFER_WIDTH_$idx" name="Data transfer width" group="Descriptor" default="WordToWord" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This sets up the source and destination transfer size parameters."> 101 <Entry name="Byte to Byte" value="ByteToByte" visible="true" /> 102 <Entry name="Halfword to Halfword" value="HalfwordToHalfword" visible="true" /> 103 <Entry name="Word to Byte" value="WordToByte" visible="true" /> 104 <Entry name="Word to Halfword" value="WordToHalfword" visible="true" /> 105 <Entry name="Byte to Word" value="ByteToWord" visible="true" /> 106 <Entry name="Halfword to Word" value="HalfwordToWord" visible="true" /> 107 <Entry name="Word to Word (full 32 bit)" value="WordToWord" visible="true" /> 108 <Entry name="Word to Word (16 bit masked)" value="WordToWord16" visible="true" /> 109 <Entry name="Word to Word (8 bit masked)" value="WordToWord8" visible="true" /> 110 </ParamChoice> 111 112 <!--Descriptor X loop settings--> 113 <ParamRange id="X_NUM_OF_ELEMENTS_$idx" name="Number of data elements to transfer" group="Descriptor X loop settings" default="1" min="1" max="65536" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This parameter configures how many transfers are effected in the X loops. If this number equals 1 – the descriptor is determined as "single transfer", otherwise as "1D" or "2D" – dependent on "Number of X-loops to execute" parameter." /> 114 115 <ParamRange id="X_SRC_INCREMENT_$idx" name="Source increment every cycle by" group="Descriptor X loop settings" default="1" min="-32768" max="32767" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This integer determines the source address increment after each data transfer. When this value is set to zero, it is equivalent to disabling the source increment feature." /> 116 117 <ParamRange id="X_DST_INCREMENT_$idx" name="Destination increment every cycle by" group="Descriptor X loop settings" default="1" min="-32768" max="32767" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This integer determines the destination address increment after each transfer. When this value is set to zero, it is equivalent to disabling the destination increment feature." /> 118 119 <ParamBool id="SCATTER_$idx" name="Scatter transfer" group="Descriptor X loop settings" default="false" visible="`${(pDescrSelEqIdx_$idx)}`" editable="`${(pDescrSelLeqIdx_$idx)}`" desc="Specifies the 1D descriptor as a scatter transfer descriptor" /> 120 121 <!--Descriptor Y loop settings--> 122 <ParamRange id="Y_NUM_OF_ELEMENTS_$idx" name="Number of X-loops to execute" group="Descriptor Y loop settings" default="1" min="1" max="65536" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This parameter configures how many X-loops are executed in each Y loop. If this number equals 1 – the descriptor is determined as "1D", otherwise - "2D"." /> 123 124 <ParamRange id="Y_SRC_INCREMENT_$idx" name="Source increment every cycle by" group="Descriptor Y loop settings" default="1" min="-32768" max="32767" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This integer determines the source address increment after each X loop execution. When this value is set to zero, it is equivalent to disabling the source increment feature in Y loop." /> 125 126 <ParamRange id="Y_DST_INCREMENT_$idx" name="Destination increment every cycle by" group="Descriptor Y loop settings" default="1" min="-32768" max="32767" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This integer determines the destination address increment after each transfer. When this value is set to zero, it is equivalent to disabling the destination increment feature in Y loop." /> 127 128 </Repeat> 129 130 131 <!--Config--> 132 <ParamBool id="inFlash" name="Store Config in Flash" group="Advanced" default="true" visible="true" editable="true" desc="Controls whether the configuration structure is stored in flash (const, true) or SRAM (not const, false)." /> 133 134 <ParamString id="HWbase" name="base address" group="Internal" default="`${"DMAC"}`" visible="false" editable="false" desc="" /> 135 <ParamString id="descriptor_struct" name="descriptor struct" group="Internal" default="`${("m7cpuss" eq getIpBlockName()) ? "CY_ALIGN(32) cy_stc_dmac_descriptor_t" : "cy_stc_dmac_descriptor_t" }`" visible="false" editable="false" desc="" /> 136 </Parameters> 137 138 <DRCs> 139 </DRCs> 140 141 <ConfigFirmware> 142 <ConfigInclude value="cy_dmac.h" include="true" /> 143 <ConfigInclude value="cyhal_hwmgr.h" include="true" guard="defined (CY_USING_HAL)" /> 144 <ConfigInclude value="cyhal_dma.h" include="true" guard="defined (CY_USING_HAL) || defined (CY_USING_HAL_LITE)" /> 145 146 <ConfigDefine name="`${INST_NAME . "_HW"}`" value="`${HWbase}`" public="true" include="true" /> 147 <ConfigDefine name="`${INST_NAME . "_CHANNEL"}`" value="`${channel}`U" public="true" include="true" /> 148 <ConfigDefine name="`${INST_NAME}`_IRQ" value="cpuss_interrupts_dmac_`${channel}`_IRQn" public="true" include="true" /> 149 150 <ConfigStruct name="`${INST_NAME . "_" . DESCR_NAME_$idx . "_config"}`" type="cy_stc_dmac_descriptor_config_t" const="`${inFlash}`" public="true" include="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="8" > 151 <Member name="retrigger" value="`${TRIG_DEACT_$idx}`" /> 152 <Member name="interruptType" value="`${INTR_OUT_$idx}`" /> 153 <Member name="triggerOutType" value="`${TRIG_OUT_TYPE_$idx}`" /> 154 <Member name="channelState" value="`${CHAN_STATE_COMPL_$idx}`" /> 155 <Member name="triggerInType" value="`${TRIG_IN_TYPE_$idx}`" /> 156 <Member name="dataPrefetch" value="`${DATA_PREFETCH_$idx}`" /> 157 <Member name="dataSize" value="`${(DATA_TRANSFER_WIDTH_$idx eq WordToWord) ? "CY_DMAC_WORD" : 158 ((DATA_TRANSFER_WIDTH_$idx eq ByteToByte) || 159 (DATA_TRANSFER_WIDTH_$idx eq WordToByte) || 160 (DATA_TRANSFER_WIDTH_$idx eq ByteToWord) || 161 (DATA_TRANSFER_WIDTH_$idx eq WordToWord8)) ? "CY_DMAC_BYTE" : "CY_DMAC_HALFWORD"}`" /> 162 163 <Member name="srcTransferSize" value="`${((DATA_TRANSFER_WIDTH_$idx eq WordToByte) || 164 (DATA_TRANSFER_WIDTH_$idx eq WordToHalfword) || 165 (DATA_TRANSFER_WIDTH_$idx eq WordToWord16) || 166 (DATA_TRANSFER_WIDTH_$idx eq WordToWord8) || 167 (DATA_TRANSFER_WIDTH_$idx eq WordToWord)) ? 168 "CY_DMAC_TRANSFER_SIZE_WORD" : "CY_DMAC_TRANSFER_SIZE_DATA"}`" /> 169 170 <Member name="dstTransferSize" value="`${((DATA_TRANSFER_WIDTH_$idx eq ByteToWord) || 171 (DATA_TRANSFER_WIDTH_$idx eq HalfwordToWord) || 172 (DATA_TRANSFER_WIDTH_$idx eq WordToWord16) || 173 (DATA_TRANSFER_WIDTH_$idx eq WordToWord8) || 174 (DATA_TRANSFER_WIDTH_$idx eq WordToWord)) ? 175 "CY_DMAC_TRANSFER_SIZE_WORD" : "CY_DMAC_TRANSFER_SIZE_DATA"}`" /> 176 177 <Member name="descriptorType" value="`${(SCATTER_$idx eq true) ? "CY_DMAC_SCATTER_TRANSFER" : 178 (X_NUM_OF_ELEMENTS_$idx eq 1) ? "CY_DMAC_SINGLE_TRANSFER" : 179 (Y_NUM_OF_ELEMENTS_$idx ne 1) ? "CY_DMAC_2D_TRANSFER" : 180 ((X_SRC_INCREMENT_$idx eq 1) && (X_DST_INCREMENT_$idx eq 1)) ? "CY_DMAC_MEMORY_COPY" : 181 "CY_DMAC_1D_TRANSFER"}`" /> 182 183 <Member name="srcAddress" value="NULL" /> 184 <Member name="dstAddress" value="NULL" /> 185 <Member name="srcXincrement" value="`${X_SRC_INCREMENT_$idx}`" /> 186 <Member name="dstXincrement" value="`${X_DST_INCREMENT_$idx}`" /> 187 <Member name="xCount" value="`${X_NUM_OF_ELEMENTS_$idx}`" /> 188 <Member name="srcYincrement" value="`${Y_SRC_INCREMENT_$idx}`" /> 189 <Member name="dstYincrement" value="`${Y_DST_INCREMENT_$idx}`" /> 190 <Member name="yCount" value="`${Y_NUM_OF_ELEMENTS_$idx}`" /> 191 <Member name="nextDescriptor" value="`${ENABLE_CHAINING_$idx ? "&" . INST_NAME . "_" . getParamValue("DESCR_NAME_" . CHAIN_TO_$idx) : "NULL"}`" /> 192 </ConfigStruct> 193 194 <ConfigStruct name="`${INST_NAME . "_" . DESCR_NAME_$idx}`" type="`${descriptor_struct}`" const="false" public="true" include="`${(NUM_OF_DESCRIPTORS > $idx)}`" repeatCount="256"> 195 <Member name="ctl" value="0UL" /> 196 <Member name="src" value="0UL" /> 197 <Member name="dst" value="0UL" /> 198 <Member name="xSize" value="0UL" /> 199 <Member name="xIncr" value="0UL" /> 200 <Member name="ySize" value="0UL" /> 201 <Member name="yIncr" value="0UL" /> 202 <Member name="nextPtr" value="0UL" /> 203 </ConfigStruct> 204 205 <ConfigStruct name="`${INST_NAME . "_channelConfig"}`" type="cy_stc_dmac_channel_config_t" const="`${inFlash}`" public="true" include="true" > 206 <Member name="descriptor" value="&`${INST_NAME}`_`${DESCR_NAME_0}`" /> 207 <Member name="priority" value="`${CHANNEL_PRIORITY}`" /> 208 <Member name="enable" value="false" /> 209 <Member name="bufferable" value="`${BUFFERABLE}`" /> 210 </ConfigStruct> 211 212 <ConfigStruct name="`${INST_NAME}`_obj" type="cyhal_resource_inst_t" const="true" public="true" include="true" guard="defined (CY_USING_HAL) || defined (CY_USING_HAL_LITE)"> 213 <Member name="type" value="CYHAL_RSC_DMA" /> 214 <Member name="block_num" value="2U" /> 215 <Member name="channel_num" value="`${INST_NAME}`_CHANNEL" /> 216 </ConfigStruct> 217 218 <ConfigStruct name="`${INST_NAME}`_hal_config" type="cyhal_dma_configurator_t" const="true" public="true" include="true" guard="defined (CY_USING_HAL) || defined (CY_USING_HAL_LITE)"> 219 <Member name="resource" value="&`${INST_NAME}`_obj" /> 220 <Member name="dmac_channel_config" value="&`${INST_NAME . "_channelConfig"}`" /> 221 <Member name="dmac_descriptor_config" value="&`${INST_NAME}`_Descriptor_`${DESCR_SELECTION}`_config" /> 222 </ConfigStruct> 223 224 <ConfigInstruction value="cyhal_hwmgr_reserve(&`${INST_NAME}`_obj);" include="true" guard="defined (CY_USING_HAL)" /> 225 </ConfigFirmware> 226</Personality> 227
