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

Latest revision as of 17:22, 9 November 2022

Author	Matrix TSL
Version	1.0
Category	Peripheral CAL

DMA (CAL) component

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

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	WriteBuffer32

- ULONG	Data

- VOID	Return

	Disable
Disables the DMA channel.
- VOID	Return

	ReadBuffer16

- UINT	Data

- VOID	Return

	ReadBuffer8

- BYTE	Data

- VOID	Return

	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

	WriteBuffer16

- UINT	Data

- VOID	Return

	WriteBuffer8

- BYTE	Data

- VOID	Return

	ReadBuffer32

- ULONG	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

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

Latest revision as of 17:22, 9 November 2022

Contents

DMA (CAL) component

Component Pack

Detailed description

Examples

Downloadable macro reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | Matrix TSL
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 1.0 (Release)
+| 1.0
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | Category
 | Peripheral CAL
 |}
+==DMA (CAL) component==
+CAL - Code Abstraction Layer A low level implementation giving direct access to DMA routines.
-==[[File:Component Icon 5bc4e362_1d31_4533_b8dd_134a53c5c0d9.png|Image]] DMA (CAL) component==
+==Component Pack==
-CAL - Code Abstraction Layer
-A low level implementation giving direct access to DMA routines.
-==Examples==
+FREE
-''<span style="color:red;">No additional examples</span>''
+==Detailed description==
-==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>WriteBuffer32</tt></u></span>===
-''<span style="color:red;">No additional information</span>''
+''No detailed description exists yet for this component''
+==Examples==
-'''Parameters'''
-:[[Variable Types|ULONG]] ''Data''
-'''Return value'''
+''<span style="color:red;">No additional examples</span>''
-:''This call does not return a value''
+==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>Disable</tt></u></span>===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Disables the DMA channel.
+|-
+| 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" | &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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-'''Parameters'''
-:''This macro has no parameters''
+{| 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.&nbsp;
+|-
+|-
+| 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''
+|}
-'''Return value'''
+{| 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" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Data
+|-
+| colspan="2" | &nbsp;
+|-
+| 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''
+|}
-:''This call does not return a value''
+{| 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" | &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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===<span style="font-weight: normal;"><u><tt>ReadBuffer16</tt></u></span>===
-''<span style="color:red;">No additional information</span>''
+{| 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.&nbsp;
+|-
+|-
+| 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''
+|}
-'''Parameters'''
+{| 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" | &nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Data
+|-
+| colspan="2" | &nbsp;
+|-
+| 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''
+|}
-:[[Variable Types|UINT]] ''Data''
+{| 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" | &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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>ReadBuffer8</tt></u></span>===
-''<span style="color:red;">No additional information</span>''
+{| 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" | &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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Data''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>Enable</tt></u></span>===
-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.
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>WriteBuffer16</tt></u></span>===
-''<span style="color:red;">No additional information</span>''
-'''Parameters'''
-:[[Variable Types|UINT]] ''Data''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>WriteBuffer8</tt></u></span>===
-''<span style="color:red;">No additional information</span>''
-'''Parameters'''
-:[[Variable Types|BYTE]] ''Data''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>ReadBuffer32</tt></u></span>===
-''<span style="color:red;">No additional information</span>''
-'''Parameters'''
-:[[Variable Types|ULONG]] ''Data''
-'''Return value'''
-:''This call does not return a value''
-==Simulation macro reference==
-''This component does not contain any simulation macros''
 ==Property reference==
-<span style="font-weight: normal;"><u>Enabled</u></span>
-This property is of type ''True or false'' and can be referenced with the variable name ''Enabled''.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-Enables or Disables the DMA component from generating code.
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-<span style="font-weight: normal;"><u>Channel</u></span>
+|-
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Channel''.
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Enabled
-DMA Peripheral Channel
+|-
+| colspan="2" | Enables or Disables the DMA component from generating code.&nbsp;
-Each utilised DMA enabled component should use a unique channel number
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-<span style="font-weight: normal;"><u>Ping Pong</u></span>
+| width="90%" | Channel
+|-
-This property is of type ''True or false'' and can be referenced with the variable name ''PingPong''.
+| colspan="2" | DMA Peripheral Channel Each utilised DMA enabled component should use a unique channel number&nbsp;
+|-
-Controls the ping pong mode.
+| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
+| width="90%" | Ping Pong
-True - Ping pong enabled, DMA memory double buffered to allow for seamless data sampling
+|-
+| 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  &nbsp;
-False - Ping pong disabled, DMA memory single buffered
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-<span style="font-weight: normal;"><u>Mode</u></span>
+| width="90%" | Mode
+|-
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Mode''.
+| colspan="2" | &nbsp;
+|-
-''<span style="color:red;">No additional information</span>''
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | DMA Type
+|-
+| colspan="2" | &nbsp;
-<span style="font-weight: normal;"><u>DMA Type</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DMAType''.
+| width="90%" | Peripheral
+|-
-''<span style="color:red;">No additional information</span>''
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
+| width="90%" | Size
-<span style="font-weight: normal;"><u>Peripheral</u></span>
+|-
+| colspan="2" | &nbsp;
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Peripheral''.
+|}
-''<span style="color:red;">No additional information</span>''
-<span style="font-weight: normal;"><u>Size</u></span>
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Size''.
-''<span style="color:red;">No additional information</span>''