1<?xml version="1.0" encoding="utf-8"?> 2 3 4<!--**************************************************************************** 5* \file dma.cypersonality 6* \version 3.0 7* 8* \brief 9* DMA personality description file. It Supports CAT1A, CAT1B, CAT1C and CAT1D 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="dma" name="DMA" version="3.0" xmlns="http://cypress.com/xsd/cyhwpersonality_v7"> 31 <Dependencies> 32 <IpBlock name="mxdw,m7cpuss,m33syscpuss,m4cpuss,m4cpuss_ver2" /> 33 <Resource name="(cpuss|m33syscpuss)\.dw\d\.chan" /> 34 </Dependencies> 35 <ExposedMembers> 36 <ExposedMember key="block" paramId="block" /> 37 <ExposedMember key="HWbase" paramId="HWbase" /> 38 <ExposedMember key="channel" paramId="channel" /> 39 <ExposedMember key="priority" paramId="CHANNEL_PRIORITY" /> 40 <ExposedMember key="preemptable" paramId="PREEMPTABLE" /> 41 </ExposedMembers> 42 <Parameters> 43 <!-- PDL documentation --> 44 <ParamDoc id="pdlDoc" name="Configuration Help" group="Overview" default="file:///`${cy_libs_path()}`/docs/pdl_api_reference_manual/html/group__group__dma.html" linkText="Open DMA Documentation" visible="true" desc="Opens the Peripheral Driver Library Documentation" /> 45 46 <ParamString id="block" name="block number" group="Internal" default="`${"dw0" eq getBlockType(1) ? 0 : 1}`" visible="false" editable="false" desc="" /> 47 <ParamString id="base" name="base address" group="Internal" default="`${getBlockType(1)}`" visible="false" editable="false" desc="" /> 48 <ParamString id="channel" name="channel number" group="Internal" default="`${getInstNumber("chan")}`" visible="false" editable="false" desc="" /> 49 <ParamString id="version" name="version number" group="Internal" default="`${getVersion()}`" visible="false" editable="false" desc="" /> 50 <!-- M7CPUSS always has DW version 2 --> 51 <ParamBool id="pVerGt1" name="pVerGt1" desc="pVerGt1" group="Internal" default="`${(version > 1) || ("m7cpuss" eq getIpBlockName())}`" visible="false" editable="false" /> 52 53 54 <!--Block--> 55 <ParamBool id="CRC_DATA_REVERSE" name="Data Reverse" group="CRC" default="false" visible="`${pVerGt1}`" editable="true" desc="Specifies the bit order in which a data byte is processed (reversal is performed after XORing): false - MSB first, true - LSB first" /> 56 <ParamRange id="CRC_DATA_XOR" name="Data XOR" group="CRC" default="0" min="0" max="4294967295" resolution="1" visible="`${pVerGt1}`" editable="true" desc="Specifies a byte mask with which each data byte is XOR'd. The XOR is performed before data reversal." /> 57 <ParamBool id="CRC_REMINDER_REVERSE" name="Reminder Reverse" group="CRC" default="false" visible="`${pVerGt1}`" editable="true" desc="Specifies the bit order in which a reminder byte is processed (reversal is performed after XORing): false - MSB first, true - LSB first" /> 58 <ParamRange id="CRC_REMINDER_XOR" name="Reminder XOR" group="CRC" default="0" min="0" max="4294967295" resolution="1" visible="`${pVerGt1}`" editable="true" desc="Specifies a byte mask with which each reminder byte is XOR'd. The XOR is performed before reminder reversal." /> 59 <ParamRange id="CRC_POLYNOMIAL" name="Polynomial" group="CRC" default="79764919" min="0" max="4294967295" resolution="1" visible="`${pVerGt1}`" editable="true" desc="Specifies a byte mask with which each reminder byte is XOR'd. The XOR is performed before reminder reversal." /> 60 61 62 <!--Channel--> 63 <ParamSignal port="tr_in[0]" name="Trigger Input" group="Channel" visible="`${hasVisibleOption("tr_in[0]")}`" desc="Sets up the trigger input signal for the DMA start." canBeEmpty="true" /> 64 <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" /> 65 <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." /> 66 <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." /> 67 <ParamBool id="PREEMPTABLE" name="Preemptable" group="Channel" default="false" visible="true" editable="true" desc="Makes the channel preemptable by another higher priority channel." /> 68 <ParamBool id="BUFFERABLE" name="Bufferable" group="Channel" default="false" visible="true" editable="true" desc="Makes the channel data transactions bufferable." /> 69 70 <ParamChoice id="DESCR_SELECTION" name="Select the descriptor" group="Channel" default="0" visible="true" editable="true" desc="Select the descriptor to configure it."> 71 <Entry name="Descriptor_$idx" value="$idx" visible="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="256" /> 72 </ParamChoice> 73 74 <!--Descriptor--> 75 <Repeat count="256"> 76 <ParamString id="DESCR_NAME_$idx" name="Descriptor_$idx Name" group="Descriptor" default="Descriptor_$idx" visible="false" editable="false" desc="This parameter sets up the instance name for the Descriptor."/> 77 78 <ParamBool id="pDescrSelEqIdx_$idx" name="pDescrSelEqIdx_$idx" desc="" group="Internal" default="`${DESCR_SELECTION eq $idx}`" visible="false" editable="false" /> 79 <ParamBool id="pDescrSelLeqIdx_$idx" name="pDescrSelLeqIdx_$idx" desc="" group="Internal" default="`${NUM_OF_DESCRIPTORS > $idx}`" visible="false" editable="false" /> 80 81 <ParamChoice id="TRIG_OUT_TYPE_$idx" name="Trigger output" group="Descriptor" default="CY_DMA_1ELEMENT" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This is the selection for what event would trigger the DMA output."> 82 <Entry name="Trigger on every element transfer completion" value="CY_DMA_1ELEMENT" visible="true" /> 83 <Entry name="Trigger on every X loop transfer completion" value="CY_DMA_X_LOOP" visible="true" /> 84 <Entry name="Trigger on descriptor completion" value="CY_DMA_DESCR" visible="true" /> 85 <Entry name="Trigger on completion of entire descriptor chain" value="CY_DMA_DESCR_CHAIN" visible="true" /> 86 </ParamChoice> 87 <ParamChoice id="INTR_OUT_$idx" name="Interrupt type" group="Descriptor" default="CY_DMA_1ELEMENT" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This is the selection for what event would trigger the DMA interrupt."> 88 <Entry name="Trigger on every element transfer completion" value="CY_DMA_1ELEMENT" visible="true" /> 89 <Entry name="Trigger on every X loop transfer completion" value="CY_DMA_X_LOOP" visible="true" /> 90 <Entry name="Trigger on descriptor completion" value="CY_DMA_DESCR" visible="true" /> 91 <Entry name="Trigger on completion of entire descriptor chain" value="CY_DMA_DESCR_CHAIN" visible="true" /> 92 </ParamChoice> 93 <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" /> 94 <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." /> 95 96 <ParamChoice id="CHAN_STATE_COMPL_$idx" name="Channel state on completion" group="Descriptor" default="CY_DMA_CHANNEL_ENABLED" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This is the state of the channel when the descriptor is completed."> 97 <Entry name="Disable" value="CY_DMA_CHANNEL_DISABLED" visible="true" /> 98 <Entry name="Enable" value="CY_DMA_CHANNEL_ENABLED" visible="true" /> 99 </ParamChoice> 100 <ParamChoice id="TRIG_IN_TYPE_$idx" name="Trigger input type" group="Descriptor" default="CY_DMA_1ELEMENT" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="Trigger input type will set up the character of each trigger."> 101 <Entry name="One transfer per trigger" value="CY_DMA_1ELEMENT" visible="true" /> 102 <Entry name="One X loop transfer per trigger" value="CY_DMA_X_LOOP" visible="true" /> 103 <Entry name="An entire descriptor transfer per trigger" value="CY_DMA_DESCR" visible="true" /> 104 <Entry name="Entire descriptor chain per trigger" value="CY_DMA_DESCR_CHAIN" visible="true" /> 105 </ParamChoice> 106 <ParamChoice id="TRIG_DEACT_$idx" name="Trigger deactivation and retriggering" group="Descriptor" default="CY_DMA_RETRIG_IM" visible="`${pDescrSelEqIdx_$idx}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="This parameter sets up the trigger deactivation options for the descriptor."> 107 <Entry name="Retrigger immediately (pulse trigger)" value="CY_DMA_RETRIG_IM" visible="true" /> 108 <Entry name="Retrigger after 4 Slow Clock cycles" value="CY_DMA_RETRIG_4CYC" visible="true" /> 109 <Entry name="Retrigger after 16 Slow Clock cycles" value="CY_DMA_RETRIG_16CYC" visible="true" /> 110 <Entry name="Wait for trigger reactivation" value="CY_DMA_WAIT_FOR_REACT" visible="true" /> 111 </ParamChoice> 112 113 <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."> 114 <Entry name="Byte to Byte" value="ByteToByte" visible="true" /> 115 <Entry name="Halfword to Halfword" value="HalfwordToHalfword" visible="true" /> 116 <Entry name="Word to Byte" value="WordToByte" visible="true" /> 117 <Entry name="Word to Halfword" value="WordToHalfword" visible="true" /> 118 <Entry name="Byte to Word" value="ByteToWord" visible="true" /> 119 <Entry name="Halfword to Word" value="HalfwordToWord" visible="true" /> 120 <Entry name="Word to Word (full 32 bit)" value="WordToWord" visible="true" /> 121 <Entry name="Word to Word (16 bit masked)" value="WordToWord16" visible="true" /> 122 <Entry name="Word to Word (8 bit masked)" value="WordToWord8" visible="true" /> 123 </ParamChoice> 124 125 <!--Descriptor X loop settings--> 126 <ParamRange id="X_NUM_OF_ELEMENTS_$idx" name="Number of data elements to transfer" group="Descriptor X loop settings" default="1" min="1" max="256" 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." /> 127 128 <ParamRange id="X_SRC_INCREMENT_$idx" name="Source increment every cycle by" group="Descriptor X loop settings" default="1" min="-2048" max="2047" 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." /> 129 130 <ParamRange id="X_DST_INCREMENT_$idx" name="Destination increment every cycle by" group="Descriptor X loop settings" default="1" min="-2048" max="2047" 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." /> 131 132 <ParamBool id="CRC_$idx" name="CRC" group="Descriptor X loop settings" default="false" visible="`${(pDescrSelEqIdx_$idx) && pVerGt1}`" editable="`${pDescrSelLeqIdx_$idx}`" desc="Specifies the 1D descriptor as a CRC descriptor" /> 133 134 <!--Descriptor Y loop settings--> 135 <ParamRange id="Y_NUM_OF_ELEMENTS_$idx" name="Number of X-loops to execute" group="Descriptor Y loop settings" default="1" min="1" max="256" 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"." /> 136 137 <ParamRange id="Y_SRC_INCREMENT_$idx" name="Source increment every cycle by" group="Descriptor Y loop settings" default="1" min="-2048" max="2047" 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." /> 138 139 <ParamRange id="Y_DST_INCREMENT_$idx" name="Destination increment every cycle by" group="Descriptor Y loop settings" default="1" min="-2048" max="2047" 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." /> 140 141 </Repeat> 142 143 <!--Config--> 144 <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)." /> 145 146 <ParamString id="HWbase" name="base address" group="Internal" default="`${"DW" . block}`" visible="false" editable="false" desc="" /> 147 <ParamString id="descriptor_struct" name="descriptor struct" group="Internal" default="`${("m7cpuss" eq getIpBlockName()) ? "CY_ALIGN(32) cy_stc_dma_descriptor_t" : "cy_stc_dma_descriptor_t" }`" visible="false" editable="false" desc="" /> 148 </Parameters> 149 150 <DRCs> 151 </DRCs> 152 153 <ConfigFirmware> 154 <ConfigInclude value="cy_dma.h" include="true" /> 155 <ConfigInclude value="cyhal_hwmgr.h" include="true" guard="defined (CY_USING_HAL)" /> 156 157 <ConfigDefine name="`${INST_NAME . "_HW"}`" value="`${HWbase}`" public="true" include="true" /> 158 <ConfigDefine name="`${INST_NAME . "_CHANNEL"}`" value="`${channel}`U" public="true" include="true" /> 159 <ConfigDefine name="`${INST_NAME}`_IRQ" value="cpuss_interrupts_dw`${block}`_`${channel}`_IRQn" public="true" include="true" /> 160 161 <ConfigStruct name="`${INST_NAME . "_" . DESCR_NAME_$idx . "_config"}`" type="cy_stc_dma_descriptor_config_t" const="`${inFlash}`" public="true" include="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="256" > 162 <Member name="retrigger" value="`${TRIG_DEACT_$idx}`" /> 163 <Member name="interruptType" value="`${INTR_OUT_$idx}`" /> 164 <Member name="triggerOutType" value="`${TRIG_OUT_TYPE_$idx}`" /> 165 <Member name="channelState" value="`${CHAN_STATE_COMPL_$idx}`" /> 166 <Member name="triggerInType" value="`${TRIG_IN_TYPE_$idx}`" /> 167 168 <Member name="dataSize" value="`${(DATA_TRANSFER_WIDTH_$idx eq WordToWord) ? "CY_DMA_WORD" : 169 ((DATA_TRANSFER_WIDTH_$idx eq ByteToByte) || 170 (DATA_TRANSFER_WIDTH_$idx eq WordToByte) || 171 (DATA_TRANSFER_WIDTH_$idx eq ByteToWord) || 172 (DATA_TRANSFER_WIDTH_$idx eq WordToWord8)) ? "CY_DMA_BYTE" : "CY_DMA_HALFWORD"}`" /> 173 174 <Member name="srcTransferSize" value="`${((DATA_TRANSFER_WIDTH_$idx eq WordToByte) || 175 (DATA_TRANSFER_WIDTH_$idx eq WordToHalfword) || 176 (DATA_TRANSFER_WIDTH_$idx eq WordToWord16) || 177 (DATA_TRANSFER_WIDTH_$idx eq WordToWord8) || 178 (DATA_TRANSFER_WIDTH_$idx eq WordToWord)) ? 179 "CY_DMA_TRANSFER_SIZE_WORD" : "CY_DMA_TRANSFER_SIZE_DATA"}`" /> 180 181 <Member name="dstTransferSize" value="`${((DATA_TRANSFER_WIDTH_$idx eq ByteToWord) || 182 (DATA_TRANSFER_WIDTH_$idx eq HalfwordToWord) || 183 (DATA_TRANSFER_WIDTH_$idx eq WordToWord16) || 184 (DATA_TRANSFER_WIDTH_$idx eq WordToWord8) || 185 (DATA_TRANSFER_WIDTH_$idx eq WordToWord)) ? 186 "CY_DMA_TRANSFER_SIZE_WORD" : "CY_DMA_TRANSFER_SIZE_DATA"}`" /> 187 188 <Member name="descriptorType" value="`${(CRC_$idx eq true) ? "CY_DMA_CRC_TRANSFER" : 189 (X_NUM_OF_ELEMENTS_$idx eq 1) ? "CY_DMA_SINGLE_TRANSFER" : 190 (Y_NUM_OF_ELEMENTS_$idx eq 1) ? "CY_DMA_1D_TRANSFER" : 191 "CY_DMA_2D_TRANSFER"}`" /> 192 <Member name="srcAddress" value="NULL" /> 193 <Member name="dstAddress" value="NULL" /> 194 <Member name="srcXincrement" value="`${X_SRC_INCREMENT_$idx}`" /> 195 <Member name="dstXincrement" value="`${X_DST_INCREMENT_$idx}`" /> 196 <Member name="xCount" value="`${X_NUM_OF_ELEMENTS_$idx}`" /> 197 <Member name="srcYincrement" value="`${Y_SRC_INCREMENT_$idx}`" /> 198 <Member name="dstYincrement" value="`${Y_DST_INCREMENT_$idx}`" /> 199 <Member name="yCount" value="`${Y_NUM_OF_ELEMENTS_$idx}`" /> 200 <Member name="nextDescriptor" value="`${ENABLE_CHAINING_$idx ? "&" . INST_NAME . "_" . getParamValue("DESCR_NAME_" . CHAIN_TO_$idx) : "NULL"}`" /> 201 </ConfigStruct> 202 203 <ConfigStruct name="`${INST_NAME . "_" . DESCR_NAME_$idx}`" type="`${descriptor_struct}`" const="false" public="true" include="`${(NUM_OF_DESCRIPTORS > $idx)}`" repeatCount="256"> 204 <Member name="ctl" value="0UL" /> 205 <Member name="src" value="0UL" /> 206 <Member name="dst" value="0UL" /> 207 <Member name="xCtl" value="0UL" /> 208 <Member name="yCtl" value="0UL" /> 209 <Member name="nextPtr" value="0UL" /> 210 </ConfigStruct> 211 212 <ConfigStruct name="`${INST_NAME . "_channelConfig"}`" type="cy_stc_dma_channel_config_t" const="`${inFlash}`" public="true" include="true" > 213 <Member name="descriptor" value="&`${INST_NAME}`_`${DESCR_NAME_0}`" /> 214 <Member name="preemptable" value="`${PREEMPTABLE}`" /> 215 <Member name="priority" value="`${CHANNEL_PRIORITY}`" /> 216 <Member name="enable" value="false" /> 217 <Member name="bufferable" value="`${BUFFERABLE}`" /> 218 </ConfigStruct> 219 220 <ConfigStruct name="`${INST_NAME . "_crcConfig"}`" type="cy_stc_dma_crc_config_t" const="`${inFlash}`" public="true" include="`${pVerGt1}`" > 221 <Member name="dataReverse" value="`${CRC_DATA_REVERSE}`" /> 222 <Member name="dataXor" value="`${CRC_DATA_XOR}`" /> 223 <Member name="reminderReverse" value="`${CRC_REMINDER_REVERSE}`" /> 224 <Member name="reminderXor" value="`${CRC_REMINDER_XOR}`" /> 225 <Member name="polynomial" value="`${CRC_POLYNOMIAL}`" /> 226 </ConfigStruct> 227 228 <ConfigStruct name="`${INST_NAME}`_obj" type="cyhal_resource_inst_t" const="true" public="true" include="true" guard="defined (CY_USING_HAL)"> 229 <Member name="type" value="CYHAL_RSC_DW" /> 230 <Member name="block_num" value="`${block}`U" /> 231 <Member name="channel_num" value="`${INST_NAME}`_CHANNEL" /> 232 </ConfigStruct> 233 234 <ConfigStruct name="`${INST_NAME}`_hal_config" type="cyhal_dma_configurator_t" const="true" public="true" include="true" guard="defined (CY_USING_HAL)"> 235 <Member name="resource" value="&`${INST_NAME}`_obj" /> 236 <Member name="dw_channel_config" value="&`${INST_NAME . "_channelConfig"}`" /> 237 <Member name="dw_descriptor_config" value="&`${INST_NAME}`_Descriptor_`${DESCR_SELECTION}`_config" /> 238 </ConfigStruct> 239 240 <ConfigInstruction value="cyhal_hwmgr_reserve(&`${INST_NAME}`_obj);" include="true" guard="defined (CY_USING_HAL)" /> 241 </ConfigFirmware> 242</Personality> 243
