Difference between revisions of "Component: DMA (CAL) (Misc)"

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_DMA.fcfx FC_Comp_Source_DMA.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DMA.fcfx FC_Comp_Source_DMA.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DMA.fcfx FC_Comp_Source_DMA.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 32: Line 36:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 46: Line 52:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteBuffer32'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Disable'''
 +
|-
 +
| colspan="2" | Disables the DMA channel. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadBuffer16'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadBuffer8'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Enable'''
 +
|-
 +
| colspan="2" | Initialise the DMA channel ready to process data to or from a peripheral. The user must enable the corresponding DMA interrupt after initialising the channel. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteBuffer16'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteBuffer8'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadBuffer32'''
 +
|-
 +
| colspan="2" |  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
 +
 +
==Property reference==
 +
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Enabled
 +
|-
 +
| colspan="2" | Enables or Disables the DMA component from generating code. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | DMA Peripheral Channel Each utilised DMA enabled component should use a unique channel number 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Ping Pong
 +
|-
 +
| colspan="2" | Controls the ping pong mode. True - Ping pong enabled, DMA memory double buffered to allow for seamless data sampling False - Ping pong disabled, DMA memory single buffered   
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Mode
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | DMA Type
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Peripheral
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Size
 +
|-
 +
| colspan="2" |  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:20, 20 January 2023

Author Matrix TSL
Version 1.0
Category Misc


DMA (CAL) component

CAL - Code Abstraction Layer A low level implementation giving direct access to DMA routines.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DMA.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DMA.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Macro reference

Fc9-comp-macro.png WriteBuffer32
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disables the DMA channel. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer16
 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer8
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Initialise the DMA channel ready to process data to or from a peripheral. The user must enable the corresponding DMA interrupt after initialising the channel. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteBuffer16
 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteBuffer8
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer32
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Enables or Disables the DMA component from generating code. 
Fc9-type-16-icon.png Channel
DMA Peripheral Channel Each utilised DMA enabled component should use a unique channel number 
Fc9-type-7-icon.png Ping Pong
Controls the ping pong mode. True - Ping pong enabled, DMA memory double buffered to allow for seamless data sampling False - Ping pong disabled, DMA memory single buffered  
Fc9-type-16-icon.png Mode
 
Fc9-type-16-icon.png DMA Type
 
Fc9-type-16-icon.png Peripheral
 
Fc9-type-21-icon.png Size
 

==Macro reference==

Fc9-comp-macro.png WriteBuffer32
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disables the DMA channel. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer16
 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer8
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Initialise the DMA channel ready to process data to or from a peripheral. The user must enable the corresponding DMA interrupt after initialising the channel. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteBuffer16
 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteBuffer8
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer32
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Enables or Disables the DMA component from generating code. 
Fc9-type-16-icon.png Channel
DMA Peripheral Channel Each utilised DMA enabled component should use a unique channel number 
Fc9-type-7-icon.png Ping Pong
Controls the ping pong mode. True - Ping pong enabled, DMA memory double buffered to allow for seamless data sampling False - Ping pong disabled, DMA memory single buffered  
Fc9-type-16-icon.png Mode
 
Fc9-type-16-icon.png DMA Type
 
Fc9-type-16-icon.png Peripheral
 
Fc9-type-21-icon.png Size
 

==Macro reference==

Fc9-comp-macro.png WriteBuffer32
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disables the DMA channel. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer16
 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer8
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Initialise the DMA channel ready to process data to or from a peripheral. The user must enable the corresponding DMA interrupt after initialising the channel. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteBuffer16
 
Fc9-u16-icon.png - UINT Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteBuffer8
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadBuffer32
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
Enables or Disables the DMA component from generating code. 
Fc9-type-16-icon.png Channel
DMA Peripheral Channel Each utilised DMA enabled component should use a unique channel number 
Fc9-type-7-icon.png Ping Pong
Controls the ping pong mode. True - Ping pong enabled, DMA memory double buffered to allow for seamless data sampling False - Ping pong disabled, DMA memory single buffered  
Fc9-type-16-icon.png Mode
 
Fc9-type-16-icon.png DMA Type
 
Fc9-type-16-icon.png Peripheral
 
Fc9-type-21-icon.png Size
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_DMA_(CAL)_(Misc)&oldid=33198"