module ti.sysbios.family.c64p.EventCombiner
index URL

Event Combiner Manager module

The event combiner allows the user to combine up to 32 system events into a single combined event. The events 0, 1, 2, and 3 are the events associated with the event combiner. Using the EventCombiner module along with the Hwi module, allows the user to route a combined event to any of the 12 maskable CPU interrupts available on GEM. The EventCombiner supports up to 128 system events. Users can specify a function and an argument for each system event and can choose to enable which ever system events they want. [ more ... ]
XDCspec summary sourced in ti/sysbios/family/c64p/EventCombiner.xdc
@ModuleStartup
module EventCombiner {  ...
// inherits xdc.runtime.IModule
C synopsis target-domain
#include <ti/sysbios/family/c64p/EventCombiner.h>
module-wide constants & types
    #define EventCombiner_NUM_EVENTS// C64+ supports 128 events (Int)128
 
    typedef Void (*EventCombiner_FuncPtr// Event Combiner dispatcher function type definition)(UArg);
module-wide config parameters
    extern const Bits32 EventCombiner_EVTMASK// Holds the initialization values for the C64+ EVTMASK registers (0-3)[4];
    extern const Error_Id EventCombiner_E_unpluggedEvent// Error raised when an unplug Event is executed;
module-wide functions
    Void EventCombiner_disableEvent// Disables 'evt' from contributing to its combined event group( UInt evt );
    Void EventCombiner_dispatch// The Event Combiner dispatcher( UInt evt );
    Void EventCombiner_dispatchPlug// Used to configure a dispatcher entry for 'evt'( UInt evt, EventCombiner_FuncPtr fxn, UArg arg, Bool unmask );
    Void EventCombiner_enableEvent// Enables 'evt' to contribute to its combined event group( UInt evt );
module-wide built-ins
    Types_ModuleId EventCombiner_Module_id// Get this module's unique id( );
    Bool EventCombiner_Module_startupDone// Test if this module has completed startup( );
    IHeap_Handle EventCombiner_Module_heap// The heap from which this module allocates memory( );
    Bool EventCombiner_Module_hasMask// Test whether this module has a diagnostics mask( );
    Bits16 EventCombiner_Module_getMask// Returns the diagnostics mask for this module( );
    Void EventCombiner_Module_setMask// Set the diagnostics mask for this module( Bits16 mask );
 
XDCscript usage meta-domain
var EventCombiner = xdc.useModule('ti.sysbios.family.c64p.EventCombiner');
module-wide constants & types
    const EventCombiner.NUM_EVENTS// C64+ supports 128 events = 128;
 
    var obj = new EventCombiner.EventObj// Event Configuration Object;
        obj.unmask = Bool  ...
        obj.fxn = Void(*)(UArg)  ...
        obj.arg = UArg  ...
module-wide config parameters
    EventCombiner.EVTMASK// Holds the initialization values for the C64+ EVTMASK registers (0-3) = Bits32[4] undefined;
    EventCombiner.E_unpluggedEvent// Error raised when an unplug Event is executed = Error.Desc {
        msg: "E_unpluggedEvent: Event# %d is unplugged"
    };
 
    EventCombiner.common$// Common module configuration parameters = Types.Common$ undefined;
    EventCombiner.eventGroupHwiNum// Configures the mapping of a C64+ combined event group to an interrupt = Int[4] undefined;
    EventCombiner.events// For holding configuration values for all C64+ events = EventCombiner.EventObj[EventCombiner.NUM_EVENTS] undefined;
module-wide functions
    EventCombiner.dispatchEventGroup// Configuration method for assigning the eventGroupHwiNum array( UInt evt, UInt hwiVec ) returns Void
 
XDCspec declarations sourced in ti/sysbios/family/c64p/EventCombiner.xdc
package ti.sysbios.family.c64p;
 
@ModuleStartup
module EventCombiner {
module-wide constants & types
    const Int NUM_EVENTS// C64+ supports 128 events = 128;
 
    typedef Void (*FuncPtr// Event Combiner dispatcher function type definition)(UArg);
 
    metaonly struct EventObj// Event Configuration Object {
        Bool unmask;
        EventCombiner.FuncPtr fxn;
        UArg arg;
    };
module-wide config parameters
    config Bits32 EVTMASK// Holds the initialization values for the C64+ EVTMASK registers (0-3)[4];
    config Error.Id E_unpluggedEvent// Error raised when an unplug Event is executed = {
        msg: "E_unpluggedEvent: Event# %d is unplugged"
    };
 
    metaonly config Types.Common$ common$// Common module configuration parameters;
    metaonly config Int eventGroupHwiNum// Configures the mapping of a C64+ combined event group to an interrupt[4];
    metaonly config EventCombiner.EventObj events// For holding configuration values for all C64+ events[EventCombiner.NUM_EVENTS];
module-wide functions
    Void disableEvent// Disables 'evt' from contributing to its combined event group( UInt evt );
    Void dispatch// The Event Combiner dispatcher( UInt evt );
    Void dispatchPlug// Used to configure a dispatcher entry for 'evt'( UInt evt, EventCombiner.FuncPtr fxn, UArg arg, Bool unmask );
    Void enableEvent// Enables 'evt' to contribute to its combined event group( UInt evt );
 
    metaonly Void dispatchEventGroup// Configuration method for assigning the eventGroupHwiNum array( UInt evt, UInt hwiVec );
}
DETAILS
The event combiner allows the user to combine up to 32 system events into a single combined event. The events 0, 1, 2, and 3 are the events associated with the event combiner. Using the EventCombiner module along with the Hwi module, allows the user to route a combined event to any of the 12 maskable CPU interrupts available on GEM. The EventCombiner supports up to 128 system events. Users can specify a function and an argument for each system event and can choose to enable which ever system events they want.

Calling Context

Function Hwi Swi Task Main Startup
disableEvent Y Y Y Y Y
dispatch Y N N N N
dispatchPlug Y Y Y Y Y
enableEvent 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. EventCombiner_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. EventCombiner_Module_startupDone() returns FALSE).
 
const EventCombiner.NUM_EVENTS
index URL

C64+ supports 128 events

XDCscript usage meta-domain
const EventCombiner.NUM_EVENTS = 128;
C synopsis target-domain
#define EventCombiner_NUM_EVENTS (Int)128
 
 
typedef EventCombiner.FuncPtr
index URL

Event Combiner dispatcher function type definition

C synopsis target-domain
typedef Void (*EventCombiner_FuncPtr)(UArg);
 
 
metaonly struct EventCombiner.EventObj
index URL

Event Configuration Object

XDCscript usage meta-domain
var obj = new EventCombiner.EventObj;
 
    obj.unmask = Bool  ...
    obj.fxn = Void(*)(UArg)  ...
    obj.arg = UArg  ...
 
DETAILS
unmask - Boolean value that specifies if an event should be unmasked in the C64+ EVTMASK registers. fxn - function to call when this event occurs. arg - arg to fxn.
 
config EventCombiner.EVTMASK  // module-wide
index URL

Holds the initialization values for the C64+ EVTMASK registers (0-3)

XDCscript usage meta-domain
EventCombiner.EVTMASK = Bits32[4] undefined;
C synopsis target-domain
extern const Bits32 EventCombiner_EVTMASK[4];
 
DETAILS
It is assigned values based on the 'unmask' member of the 'events' configuration array. It can also be assigned manually in the program configuration script.
 
config EventCombiner.E_unpluggedEvent  // module-wide
index URL

Error raised when an unplug Event is executed

XDCscript usage meta-domain
EventCombiner.E_unpluggedEvent = Error.Desc {
    msg: "E_unpluggedEvent: Event# %d is unplugged"
};
C synopsis target-domain
extern const Error_Id EventCombiner_E_unpluggedEvent;
 
 
metaonly config EventCombiner.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
EventCombiner.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.
 
metaonly config EventCombiner.eventGroupHwiNum  // module-wide
index URL

Configures the mapping of a C64+ combined event group to an interrupt

XDCscript usage meta-domain
EventCombiner.eventGroupHwiNum = Int[4] undefined;
 
DETAILS
There is one element per combined event group (0-3).
 
metaonly config EventCombiner.events  // module-wide
index URL

For holding configuration values for all C64+ events

XDCscript usage meta-domain
EventCombiner.events = EventCombiner.EventObj[EventCombiner.NUM_EVENTS] undefined;
 
DETAILS
Array elements can be configured in the program configuration script.
 
EventCombiner.disableEvent( )  // module-wide
index URL

Disables 'evt' from contributing to its combined event group

C synopsis target-domain
Void EventCombiner_disableEvent( UInt evt );
 
DETAILS
It accomplishes this by setting the corresponding bit in the C64+ EVTMASK array to 1 (to mask it).
 
EventCombiner.dispatch( )  // module-wide
index URL

The Event Combiner dispatcher

C synopsis target-domain
Void EventCombiner_dispatch( UInt evt );
 
DETAILS
It is mostly used internally, but can be used directly by the user.
 
EventCombiner.dispatchPlug( )  // module-wide
index URL

Used to configure a dispatcher entry for 'evt'

C synopsis target-domain
Void EventCombiner_dispatchPlug( UInt evt, EventCombiner_FuncPtr fxn, UArg arg, Bool unmask );
 
DETAILS
The parameters correspond to the same ones for static configuration in EventObj. dispatchPlug does not map the corresonding combined event group to an Hwi interrupt - such an action needs to be performed either using the event combiner configuration or using the Hwi module.
 
EventCombiner.enableEvent( )  // module-wide
index URL

Enables 'evt' to contribute to its combined event group

C synopsis target-domain
Void EventCombiner_enableEvent( UInt evt );
 
DETAILS
It accomplishes this by setting the corresponding bit in the C64+ EVTMASK array to 0 (to unmask it).
 
metaonly EventCombiner.dispatchEventGroup( )  // module-wide
index URL

Configuration method for assigning the eventGroupHwiNum array

XDCscript usage meta-domain
EventCombiner.dispatchEventGroup( UInt evt, UInt hwiVec ) returns Void
 
DETAILS
It accomplishes the same thing as directly setting eventGroupHwiNum[0-3].
 
module-wide built-ins
index URL

C synopsis target-domain
Types_ModuleId EventCombiner_Module_id( );
// Get this module's unique id
 
Bool EventCombiner_Module_startupDone( );
// Test if this module has completed startup
 
IHeap_Handle EventCombiner_Module_heap( );
// The heap from which this module allocates memory
 
Bool EventCombiner_Module_hasMask( );
// Test whether this module has a diagnostics mask
 
Bits16 EventCombiner_Module_getMask( );
// Returns the diagnostics mask for this module
 
Void EventCombiner_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module
generated on Fri, 16 Oct 2009 20:56:15 GMT