module ti.sysbios.family.c64p.Exception

Exception Module

C synopsis
Individual elements
Configuration settings
Individual elements

The Exception module is a basic C64+ exception handler. It is generally considered to be a program endpoint, since an exception usually indicates something fatal to the system. [ more ... ]

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

#include <ti/sysbios/family/c64p/Exception.h>

Functions
Void	Exception_clearLastStatus// clearLastStatus - Clears internal Status structure();
Void	Exception_evtEvtClear// evtEvtClear - Clear a C64+ event from the EVTFLAG register(UInt event);
Void	Exception_evtExpMaskEnable// evtExpMaskEnable - Enable a C64+ event to generate an exception(UInt event);
Void	Exception_getLastStatus// getLastStatus - Fills passed status structure with the Status fields that were recorded by the last invocation of dispatch(), handler() and internalHandler(). The 'excContext' is valid only in the scope of sub-handler "Hook" functions(Exception_Status *status);
Exception_FuncPtr	Exception_setReturnPtr// setReturnPtr - Configures dispatch() to "return" (branch) to the passed ptr(Exception_FuncPtr ptr);
Functions common to all target modules
	Exception_Module_getMask// Returns the diagnostics mask for this module, Exception_Module_hasMask// Test whether this module has a diagnostics mask, Exception_Module_heap// The heap from which this module allocates memory, Exception_Module_id// Get this module's unique id, Exception_Module_setMask// Set the diagnostics mask for this module, Exception_Module_startupDone// Test if this module has completed startup
Defines
#define	Exception_ECREXF// EXCEP flag (Bits32)Exception.EFREXF
#define	Exception_ECRIXF// Internal exception flag (Bits32)Exception.EFRIXF
#define	Exception_ECRNXF// NMI exception flag (Bits32)Exception.EFRNXF
#define	Exception_ECRSXF// Software exception flag (Bits32)Exception.EFRSXF
#define	Exception_EFREXF// EXCEP flag (Bits32)0x40000000
#define	Exception_EFRIXF// Internal exception flag (Bits32)0x00000002
#define	Exception_EFRNXF// NMI exception flag (Bits32)0x80000000
#define	Exception_EFRSXF// Software exception flag (Bits32)0x00000001
#define	Exception_IERREPX// Execute packet exception (Bits32)0x00000004
#define	Exception_IERRFPX// Fetch packet exception (Bits32)0x00000002
#define	Exception_IERRIFX// Instruction fetch exception (Bits32)0x00000001
#define	Exception_IERRLBX// Loop buffer exception (Bits32)0x00000080
#define	Exception_IERRMSX// Missed stall exception (Bits32)0x00000100
#define	Exception_IERROPX// Opcode exception (Bits32)0x00000008
#define	Exception_IERRPRX// Priviledge exception (Bits32)0x00000040
#define	Exception_IERRRAX// Resource access exeption (Bits32)0x00000020
#define	Exception_IERRRCX// Resource conflict exception (Bits32)0x00000010
#define	Exception_sizeContextBuf// (UInt32)320
#define	Exception_TSRCXM// Current execution mode bits (Bits32)0x000000C0
#define	Exception_TSRCXMSHIFT// TSR.CXM left shift value (Bits32)6
#define	Exception_TSRCXMSV// Supervisor mode (Bits32)0x00000000
#define	Exception_TSRCXMUS// User mode (Bits32)0x00000040
#define	Exception_TSREXC// Exception processing (Bits32)0x00000400
#define	Exception_TSRGEE// Global exception enable (Bits32)0x00000004
#define	Exception_TSRXEN// External exception enable (Bits32)0x00000008
Typedefs
typedef Void	(*Exception_FuncPtr// FuncPtr - Hook function type definition)(Void);
typedef struct	Exception_Status// Status - structure filled by getLastStatus() ...
Constants
extern const Bool	Exception_enableExternalMPC// enableExternalMPC - Enable handling of Memory Protection Controller (MPC) exceptions;
extern const Bool	Exception_enablePrint// enablePrint - Enable print of exception details and Register values;
extern const Exception_FuncPtr	Exception_exceptionHook// exceptionHook - Function hook called by handler This is called anytime an exception occurs;
extern const Exception_FuncPtr	Exception_externalHook// externalHook - Function hook called by externalHandler Function is only called when an external exception has occurred;
extern const Error_Id	Exception_E_exceptionMax// Error raised when Exception.enablePrint is true;
extern const Error_Id	Exception_E_exceptionMin// Error raised when Exception.enablePrint is false;
extern const Exception_FuncPtr	Exception_internalHook// internalHook - Function hook called by internalHandler Function is only called when an internal exception has occurred;
extern const Exception_FuncPtr	Exception_nmiHook// nmiHook - Function hook called by nmiHandler Function is called for legacy NMI exceptions only;
extern const Exception_FuncPtr	Exception_returnHook// returnHook - Function hook called at the end of Exception_dispatch;
extern const Bool	Exception_useInternalBuffer// If true, the exception context is saved to an internal buffer. If false, the exception context is saved to the bottom of the isr stack and no memory for the internal buffer is allocated;

DETAILS

The Exception module is a basic C64+ exception handler. It is generally considered to be a program endpoint, since an exception usually indicates something fatal to the system.

During initialization, the Exception module sets TSR.GEE and TSR.XEN to enable the CPU to recognize the EXECP input.

Function hooks are provided to the user for hooking in their own functions at different points of an exception. The hook functions are called in the following order: (1) exceptionHook - called whenever an exception occurs. (2) internalHook - called only when an internal exception occurs. (3) externalHook - called only when an external exception occurs. (4) nmiHook - called only when a legacy NMI occurs. (5) returnHook - called whenever an exception occurs.

Calling Context

Function	Hwi	Swi	Task	Main	Startup
clearLastStatus	Y	Y	Y	Y	Y
evtEvtClear	Y	Y	Y	Y	Y
evtExpMaskEnable	Y	Y	Y	Y	Y
getLastStatus	Y	Y	Y	Y	Y
setReturnPtr	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).

const Exception_ECREXF