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

Latest revision as of 10:24, 24 February 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

Disable

	Disable
Disables the DMA channel.
- VOID	Return

Enable

	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.
- VOID	Return

ReadBuffer16

	ReadBuffer16

- UINT	Data

- VOID	Return

ReadBuffer32

	ReadBuffer32

- ULONG	Data

- VOID	Return

ReadBuffer8

	ReadBuffer8

- BYTE	Data

- VOID	Return

WriteBuffer16

	WriteBuffer16

- UINT	Data

- VOID	Return

WriteBuffer32

	WriteBuffer32

- ULONG	Data

- VOID	Return

WriteBuffer8

	WriteBuffer8

- BYTE	Data

- VOID	Return

Property reference

	Properties
	Enabled
Enables or Disables the DMA component from generating code.
	Channel
DMA Peripheral Channel Each utilised DMA enabled component should use a unique channel number
	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
	Mode

	DMA Type

	Peripheral

	Size

@@ Line 57: / Line 57: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 65: / Line 75: @@
 ==Macro reference==
-===WriteBuffer32===
+===Disable===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Disable'''
-|-
-| colspan="2" | &nbsp;
 |-
+| colspan="2" | Disables the DMA channel.&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Data
-|-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 84: / Line 89: @@
-===Disable===
+===Enable===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Enable'''
 |-
-| colspan="2" | Disables the DMA channel.&nbsp;
+| 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.&nbsp;
 |-
 |-
@@ Line 117: / Line 122: @@
-===ReadBuffer8===
+===ReadBuffer32===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadBuffer32'''
 |-
 | colspan="2" | &nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | Data
 |-
@@ Line 136: / Line 141: @@
-===Enable===
+===ReadBuffer8===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadBuffer8'''
+|-
+| colspan="2" | &nbsp;
+|-
 |-
-| 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.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 169: / Line 179: @@
-===WriteBuffer8===
+===WriteBuffer32===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteBuffer32'''
 |-
 | colspan="2" | &nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 | width="90%" | Data
 |-
@@ Line 188: / Line 198: @@
-===ReadBuffer32===
+===WriteBuffer8===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteBuffer8'''
 |-
 | colspan="2" | &nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" | Data
 |-
@@ Line 205: / Line 215: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}