Interrupt Functions

Functions


Detailed Description

Some Interrupt Functions require an Interrupt-Type to function.

Here is a list of all Interrupt-Types available:


Function Documentation

void hel_IntrAcknowledge ( u32  InterruptType  ) 

Acknowledge interrupt.

This function acknowledges an interrupt by writing 1<<InterruptType value to the IF register and also logically OR the same value to 0x3007FF8. The latter is required in order to use the BIOS Halt (Low-Power-Consumption) functions.

Parameters:
[in] InterruptType Type of interrupt to acknowledge. Please see the detailed description at the top of this document for a list with all available interrupt-types (Interrupt Functions).
void VBLInterruptHandler(void)
{
    hel_IntrAcknowledge(INT_TYPE_VBL);
}

u32 hel_IntrGetType ( void *  pInterruptProc  ) 

Get type of a started interrupt function.

Parameters:
[in] pInterruptProc Pointer to interrupt function to get type from.
Returns:
On success it returns the Interrupt-Type, otherwise 0xffff;

u32 hel_IntrIsEnabled ( u32  InterruptType  ) 

Check if an interrupt is enabled or disabled.

Use this function to check if the interrupt specified by InterruptType is whether enabled or disabled.

Parameters:
[in] InterruptType Interrupt-Type you want to check. Please see the detailed description at the top of this document for a list with all available interrupt-types (Interrupt Functions).
Returns:
This function returns TRUE when the interrupt specified by InterruptType is enabled, otherwise it returns FALSE.

void hel_IntrStartHandler ( u32  InterruptType,
void *  pInterruptHandler 
)

Start an interrupt.

The hel_IntrStartHandler function starts the interrupt specified by InterruptType.

Parameters:
[in] InterruptType The Interrupt-Type you want to start. Please see the detailed description at the top of this document for a list with all available interrupt-types (Interrupt Functions).
pInterruptHandler An Interrupt-Handler function, it is triggered when an interrupt with InterruptType occurs.
See also:
hel_IntrStopHandler

void hel_IntrStopAll ( void   ) 

Stop all interrupts.

This function stops all enabled/started interrupts.

See also:
hel_IntrStopHandler

void hel_IntrStopHandler ( u32  InterruptType  ) 

Stop an interrupt.

The hel_IntrStopHandler function stops the interrupt specified by InterruptType.

Parameters:
[in] InterruptType The Interrupt-Type you want to stop. Please see the detailed description at the top of this document for a list with all available interrupt-types (Interrupt Functions).
See also:
hel_IntrStartHandler

void hel_IntrUpdateHandler ( u32  InterruptType,
void *  pInterruptHandler 
)

Update interrupt handler function.

The hel_IntrUpdateHandler function can be used to assign a new interrupt handler for an already started interrupt. You don't need to stop and start an interrupt if you just want to replace the handler function. You can use this function instead, which is much faster because it only needs to replace an entry in the interrupt table.

Parameters:
[in] InterruptType Type of Interrupt. Please see the detailed description at the top of this document for a list with all available interrupt-types (Interrupt Functions).
[in] pInterruptHandler Pointer to new interrupt handler function.


Generated on Fri Aug 17 12:12:38 2007 for HEL Library by  doxygen 1.5.3