1<?xml version="1.0" encoding="utf-8"?> 2 3 4<!--**************************************************************************** 5* \file axidmac.cypersonality 6* \version 1.0 7* 8* \brief 9* AXI DMAC 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="axidmac" name="AXI DMAC" version="1.0" xmlns="http://cypress.com/xsd/cyhwpersonality_v7"> 30 <Dependencies> 31 <IpBlock name="m55appcpuss,mxaxidmac" /> 32 <Resource name="m55appcpuss\.axidmac\d\.chan|axi_dmac\.chan" /> 33 </Dependencies> 34 <ExposedMembers> 35 <ExposedMember key="block" paramId="block" /> 36 <ExposedMember key="channel" paramId="channel" /> 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__axidmac.html" linkText="Open AXI DMAC Documentation" visible="true" desc="Opens the Peripheral Driver Library Documentation" /> 41 42 <ParamString id="block" name="block number" group="Internal" default="`${"dw0" eq getBlockType(1) ? 0 : 1}`" visible="false" editable="false" desc="" /> 43 <ParamString id="channel" name="channel number" group="Internal" default="`${getInstNumber("chan")}`" visible="false" editable="false" desc="" /> 44 45 <!--Channel--> 46 <ParamSignal port="tr_in[0]" name="Trigger Input" group="Channel" visible="true" desc="Sets up the trigger input signal for the AXI DMA start." canBeEmpty="true" /> 47 <ParamSignal port="tr_out[0]" name="Trigger Output" group="Channel" visible="true" desc="Sets up the trigger output signal for the AXI DMA completion." canBeEmpty="true" /> 48 <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 AXI DMA block. Lower number takes precedence." /> 49 <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." /> 50 <ParamBool id="BUFFERABLE" name="Bufferable" group="Channel" default="false" visible="true" editable="true" desc="Makes the channel data transactions bufferable." /> 51 52 <ParamChoice id="DESCR_SELECTION" name="Select the descriptor" group="Channel" default="0" visible="true" editable="true" desc="Select the descriptor to configure it."> 53 <Entry name="Descriptor_$idx" value="$idx" visible="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="256" /> 54 </ParamChoice> 55 56 <!--Descriptor--> 57 <Repeat count="256"> 58 <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."/> 59 60 <ParamBool id="pDescrSelEqIdx_$idx" name="pDescrSelEqIdx_$idx" desc="pDescrSelEqIdx_$idx" group="Internal" default="`${DESCR_SELECTION eq $idx}`" visible="false" editable="false" /> 61 62 <ParamChoice id="TRIG_OUT_TYPE_$idx" name="Trigger output" group="Descriptor" default="CY_AXIDMAC_M_LOOP" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="This is the selection for what event would trigger the AXI DMA output."> 63 <Entry name="Trigger on every element transfer completion" value="CY_AXIDMAC_M_LOOP" visible="true" /> 64 <Entry name="Trigger on every X loop transfer completion" value="CY_AXIDMAC_X_LOOP" visible="true" /> 65 <Entry name="Trigger on descriptor completion" value="CY_AXIDMAC_DESCR" visible="true" /> 66 <Entry name="Trigger on completion of entire descriptor chain" value="CY_AXIDMAC_DESCR_CHAIN" visible="true" /> 67 </ParamChoice> 68 <ParamChoice id="INTR_OUT_$idx" name="Interrupt type" group="Descriptor" default="CY_AXIDMAC_M_LOOP" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="This is the selection for what event would trigger the AXI DMA interrupt."> 69 <Entry name="Trigger on every element transfer completion" value="CY_AXIDMAC_M_LOOP" visible="true" /> 70 <Entry name="Trigger on every X loop transfer completion" value="CY_AXIDMAC_X_LOOP" visible="true" /> 71 <Entry name="Trigger on descriptor completion" value="CY_AXIDMAC_DESCR" visible="true" /> 72 <Entry name="Trigger on completion of entire descriptor chain" value="CY_AXIDMAC_DESCR_CHAIN" visible="true" /> 73 </ParamChoice> 74 <ParamBool id="ENABLE_CHAINING_$idx" name="Enable Chaining" group="Descriptor" default="false" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="Specifies whether or not the descriptor chains to another" /> 75 <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="true" desc="Defines the descriptor which is chained to this descriptor." /> 76 77 <ParamChoice id="CHAN_STATE_COMPL_$idx" name="Channel state on completion" group="Descriptor" default="CY_AXIDMAC_CHANNEL_ENABLED" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="This is the state of the channel when the descriptor is completed."> 78 <Entry name="Disable" value="CY_AXIDMAC_CHANNEL_DISABLED" visible="true" /> 79 <Entry name="Enable" value="CY_AXIDMAC_CHANNEL_ENABLED" visible="true" /> 80 </ParamChoice> 81 <ParamChoice id="TRIG_IN_TYPE_$idx" name="Trigger input type" group="Descriptor" default="CY_AXIDMAC_M_LOOP" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="Trigger input type will set up the character of each trigger."> 82 <Entry name="One transfer per trigger" value="CY_AXIDMAC_M_LOOP" visible="true" /> 83 <Entry name="One X loop transfer per trigger" value="CY_AXIDMAC_X_LOOP" visible="true" /> 84 <Entry name="An entire descriptor transfer per trigger" value="CY_AXIDMAC_DESCR" visible="true" /> 85 <Entry name="Entire descriptor chain per trigger" value="CY_AXIDMAC_DESCR_CHAIN" visible="true" /> 86 </ParamChoice> 87 <ParamChoice id="TRIG_DEACT_$idx" name="Trigger deactivation and retriggering" group="Descriptor" default="CY_AXIDMAC_RETRIG_IM" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="This parameter sets up the trigger deactivation options for the descriptor."> 88 <Entry name="Retrigger immediately (pulse trigger)" value="CY_AXIDMAC_RETRIG_IM" visible="true" /> 89 <Entry name="Retrigger after 4 Slow Clock cycles" value="CY_AXIDMAC_RETRIG_4CYC" visible="true" /> 90 <Entry name="Retrigger after 16 Slow Clock cycles" value="CY_AXIDMAC_RETRIG_16CYC" visible="true" /> 91 <Entry name="Wait for trigger reactivation" value="CY_AXIDMAC_WAIT_FOR_REACT" visible="true" /> 92 </ParamChoice> 93 94 <ParamBool id="DATA_PREFETCH_$idx" name="Data prefetch" group="Descriptor" default="false" visible="`${pDescrSelEqIdx_$idx}`" editable="true" 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." /> 95 96 <!--Descriptor M loop settings--> 97 <ParamRange id="M_NUM_OF_ELEMENTS_$idx" name="Number of data elements to transfer" group="Descriptor M loop settings" default="1" min="1" max="65536" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="This parameter configures how many transfers are effected in the M loop. " /> 98 99 <!--Descriptor X loop settings--> 100 <ParamRange id="X_NUM_OF_ELEMENTS_$idx" name="Number of M-loops to execute" group="Descriptor X loop settings" default="1" min="1" max="65536" resolution="1" visible="`${pDescrSelEqIdx_$idx}`" editable="true" desc="This parameter configures how many M-loops are executed in each X loop." /> 101 102 <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="true" 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." /> 103 104 <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="true" 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." /> 105 106 107 <!--Descriptor Y loop settings--> 108 <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="true" desc="This parameter configures how many X-loops are executed in each Y loop." /> 109 110 <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="true" 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." /> 111 112 <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="true" 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." /> 113 114 </Repeat> 115 116 117 <!--Config--> 118 <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)." /> 119 120 <ParamString id="HWbase" name="base address" group="Internal" default="`${"SAXI_DMAC"}`" visible="false" editable="false" desc="" /> 121 <ParamString id="descriptor_struct" name="descriptor struct" group="Internal" default="CY_ALIGN(8) CY_SECTION(".cy_socmem_data") cy_stc_axidmac_descriptor_t" visible="false" editable="false" desc="" /> 122 123 <ParamString id="m7cpussAxiDmacIrq" name="M7 AXI DMAC IRQ" group="Internal" default="axi_dmac_0_interrupts_`${channel}`_IRQn" visible="false" editable="false" desc="" /> 124 <ParamString id="m55cpussAxiDmacIrq" name="M55 AXI DMAC IRQ" group="Internal" default="m55appcpuss_interrupts_axidmac_`${channel}`_IRQn" visible="false" editable="false" desc="" /> 125 </Parameters> 126 127 <DRCs> 128 </DRCs> 129 130 <ConfigFirmware> 131 <ConfigInclude value="cy_axidmac.h" include="true" /> 132 <ConfigInclude value="cyhal_hwmgr.h" include="true" guard="defined (CY_USING_HAL)" /> 133 134 <ConfigDefine name="`${INST_NAME . "_HW"}`" value="`${HWbase}`" public="true" include="true" /> 135 <ConfigDefine name="`${INST_NAME . "_CHANNEL"}`" value="`${channel}`U" public="true" include="true" /> 136 <ConfigDefine name="`${INST_NAME}`_IRQ" value="`${("m7cpuss" eq getIpBlockName()) ? (m7cpussAxiDmacIrq) : (m55cpussAxiDmacIrq)}`" public="true" include="true" /> 137 138 <ConfigStruct name="`${INST_NAME . "_" . DESCR_NAME_$idx . "_config"}`" type="cy_stc_axidmac_descriptor_config_t" const="`${inFlash}`" public="true" include="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="8" > 139 <Member name="retrigger" value="`${TRIG_DEACT_$idx}`" /> 140 <Member name="interruptType" value="`${INTR_OUT_$idx}`" /> 141 <Member name="triggerOutType" value="`${TRIG_OUT_TYPE_$idx}`" /> 142 <Member name="channelState" value="`${CHAN_STATE_COMPL_$idx}`" /> 143 <Member name="triggerInType" value="`${TRIG_IN_TYPE_$idx}`" /> 144 <Member name="dataPrefetch" value="`${DATA_PREFETCH_$idx}`" /> 145 146 <Member name="descriptorType" value="`${(X_NUM_OF_ELEMENTS_$idx eq 1) ? "CY_AXIDMAC_1D_MEMORY_COPY" : 147 (Y_NUM_OF_ELEMENTS_$idx ne 1) ? "CY_AXIDMAC_3D_MEMORY_COPY" : 148 "CY_AXIDMAC_2D_MEMORY_COPY"}`" /> 149 150 <Member name="srcAddress" value="NULL" /> 151 <Member name="dstAddress" value="NULL" /> 152 <Member name="mCount" value="`${M_NUM_OF_ELEMENTS_$idx}`" /> 153 <Member name="srcXincrement" value="`${X_SRC_INCREMENT_$idx}`" /> 154 <Member name="dstXincrement" value="`${X_DST_INCREMENT_$idx}`" /> 155 <Member name="xCount" value="`${X_NUM_OF_ELEMENTS_$idx}`" /> 156 <Member name="srcYincrement" value="`${Y_SRC_INCREMENT_$idx}`" /> 157 <Member name="dstYincrement" value="`${Y_DST_INCREMENT_$idx}`" /> 158 <Member name="yCount" value="`${Y_NUM_OF_ELEMENTS_$idx}`" /> 159 <Member name="nextDescriptor" value="`${ENABLE_CHAINING_$idx ? "&" . INST_NAME . "_" . getParamValue("DESCR_NAME_" . CHAIN_TO_$idx) : "NULL"}`" /> 160 </ConfigStruct> 161 162 <ConfigStruct name="`${INST_NAME . "_" . DESCR_NAME_$idx}`" type="`${descriptor_struct}`" const="false" public="true" include="`${NUM_OF_DESCRIPTORS > $idx}`" repeatCount="256" > 163 <Member name="ctl" value="0UL" /> 164 <Member name="src" value="0UL" /> 165 <Member name="dst" value="0UL" /> 166 <Member name="mSize" value="0UL" /> 167 <Member name="xSize" value="0UL" /> 168 <Member name="xIncr" value="0UL" /> 169 <Member name="ySize" value="0UL" /> 170 <Member name="yIncr" value="0UL" /> 171 <Member name="nextPtr" value="0UL" /> 172 </ConfigStruct> 173 174 <ConfigStruct name="`${INST_NAME . "_channelConfig"}`" type="cy_stc_axidmac_channel_config_t" const="`${inFlash}`" public="true" include="true" > 175 <Member name="descriptor" value="&`${INST_NAME}`_`${DESCR_NAME_0}`" /> 176 <Member name="priority" value="`${CHANNEL_PRIORITY}`" /> 177 <Member name="enable" value="false" /> 178 <Member name="bufferable" value="`${BUFFERABLE}`" /> 179 </ConfigStruct> 180 181 <ConfigStruct name="`${INST_NAME}`_obj" type="cyhal_resource_inst_t" const="true" public="true" include="true" guard="defined (CY_USING_HAL)"> 182 <Member name="type" value="CYHAL_RSC_DMA" /> 183 <Member name="block_num" value="2U" /> 184 <Member name="channel_num" value="`${INST_NAME}`_CHANNEL" /> 185 </ConfigStruct> 186 187 <ConfigInstruction value="cyhal_hwmgr_reserve(&`${INST_NAME}`_obj);" include="true" guard="defined (CY_USING_HAL)" /> 188 </ConfigFirmware> 189</Personality> 190
