module ti.sysbios.family.c64p.omap3430.Wugen

Wugen Module

C synopsis
Individual elements
Configuration settings
Individual elements

Unconstrained Functions All functions [ more ... ]

C synopsis target-domain sourced in ti/sysbios/family/c64p/omap3430/Wugen.xdc

#include <ti/sysbios/family/c64p/omap3430/Wugen.h>

Functions
Void	Wugen_applyMasks// This function takes an array of 3 integers and applies the specified mask to the WUGEN interrupt mask registers. If the bit in the mask is enabled, the corresponding interrupt in the WUGEN will be blocked(UInt32 mask[]);
Void	Wugen_disableDma// Disables the specified DMA source in the WUGEN(UInt dmaid);
Void	Wugen_disableEvent// Disables the specified interrupt event source in the WUGEN(UInt eventid);
Void	Wugen_enableDma// Enables the specified DMA source in the WUGEN(UInt dmaid);
Void	Wugen_enableEvent// Enables the specified interrupt event source in the WUGEN(UInt eventid);
Void	Wugen_getMasks// This function returns the WUGEN interrupt mask registers(UInt32 mask[]);
Void	Wugen_ierToMasks// Compute the WUGEN masks needed to allow the interrupts set in the IER register to propagate through the WUGEN. This function does not enable external DMA requests. You must set these explicitly to configure a DMA request as a wakeup event(UInt32 mask[]);
Functions common to all target modules
	Wugen_Module_getMask// Returns the diagnostics mask for this module, Wugen_Module_hasMask// Test whether this module has a diagnostics mask, Wugen_Module_heap// The heap from which this module allocates memory, Wugen_Module_id// Get this module's unique id, Wugen_Module_setMask// Set the diagnostics mask for this module, Wugen_Module_startupDone// Test if this module has completed startup

DETAILS

Unconstrained Functions All functions

Calling Context

Function	Hwi	Swi	Task	Main	Startup
applyMasks	Y	Y	Y	Y	Y
disableDma	Y	Y	Y	Y	Y
disableEvent	Y	Y	Y	Y	Y
enableDma	Y	Y	Y	Y	Y
enableEvent	Y	Y	Y	Y	Y
getMasks	Y	Y	Y	Y	Y
ierToMasks	Y	Y	Y	Y	Y
Definitions: Hwi: API is callable from a Hwi thread. Swi: API is callable from a Swi thread. Task: API is callable from a Task thread. Main: API is callable during any of these phases: In your module startup after this module is started (e.g. Mod_Module_startupDone() returns TRUE). During xdc.runtime.Startup.lastFxns. During main(). During BIOS.startupFxns. Startup: API is callable during any of these phases: During xdc.runtime.Startup.firstFxns. In your module startup before this module is started (e.g. Mod_Module_startupDone() returns FALSE).

Wugen_applyMasks() // module-wide

index URL

This function takes an array of 3 integers and applies the specified mask to the WUGEN interrupt mask registers. If the bit in the mask is enabled, the corresponding interrupt in the WUGEN will be blocked

C synopsis target-domain

Void Wugen_applyMasks(UInt32 mask[]);

ARGUMENTS

mask — array of three integers for applying to the WUGEN interrupt mask register. First mask consists of IRQ 0-31 Second mask consists of IRQ 32-47 Third mask consists of DMA requests

Wugen_disableDma() // module-wide

index URL

Disables the specified DMA source in the WUGEN

C synopsis target-domain

Void Wugen_disableDma(UInt dmaid);

ARGUMENTS

dmaid — the DMA id for a particular EDMA source.

Wugen_disableEvent() // module-wide

index URL

Disables the specified interrupt event source in the WUGEN

C synopsis target-domain

Void Wugen_disableEvent(UInt eventid);

ARGUMENTS

eventid — the event number of an interrupt source

Wugen_enableDma() // module-wide

index URL

Enables the specified DMA source in the WUGEN

C synopsis target-domain

Void Wugen_enableDma(UInt dmaid);

ARGUMENTS

dmaid — the DMA id for a particular EDMA source.

Wugen_enableEvent() // module-wide

index URL

Enables the specified interrupt event source in the WUGEN

C synopsis target-domain

Void Wugen_enableEvent(UInt eventid);

ARGUMENTS

eventid — the event number of an interrupt source

Wugen_getMasks() // module-wide

index URL

This function returns the WUGEN interrupt mask registers

C synopsis target-domain

Void Wugen_getMasks(UInt32 mask[]);

ARGUMENTS

mask — array of three integers used to return the WUGEN interrupt mask registers First mask consists of IRQ 0-31 Second mask consists of IRQ 32-47 Third mask consists of DMA requests

Wugen_ierToMasks() // module-wide

index URL

Compute the WUGEN masks needed to allow the interrupts set in the IER register to propagate through the WUGEN. This function does not enable external DMA requests. You must set these explicitly to configure a DMA request as a wakeup event

C synopsis target-domain

Void Wugen_ierToMasks(UInt32 mask[]);

ARGUMENTS

mask — array of three integers for returning WUGEN masks. First mask consists of IRQ 0-31 Second mask consists of IRQ 32-47 Third mask consists of DMA requests

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId Wugen_Module_id();

// Get this module's unique id

Bool Wugen_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle Wugen_Module_heap();

// The heap from which this module allocates memory

Bool Wugen_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 Wugen_Module_getMask();

// Returns the diagnostics mask for this module

Void Wugen_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

Configuration settings sourced in ti/sysbios/family/c64p/omap3430/Wugen.xdc

var Wugen = xdc.useModule('ti.sysbios.family.c64p.omap3430.Wugen');

module-wide config parameters

Wugen.common$// Common module configuration parameters = Types.Common$ undefined;

metaonly config Wugen.common$ // module-wide

index URL

Common module configuration parameters

Configuration settings

Wugen.common$ = Types.Common$ undefined;

DETAILS

All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.

generated on Tue, 09 Oct 2018 20:57:44 GMT