Mac Developer Library

Developer

IOFilterInterruptEventSource Class Reference

Options
Deployment Target:

On This Page
Language:

IOFilterInterruptEventSource

Filtering varient of the $link IOInterruptEventSource. More...

Inheritance


Not Applicable

Conforms To


Not Applicable

Import Statement


Not Applicable @import Kernel;

Availability


Available in OS X v10.0 and later.
  • Override $link IOInterruptEventSource::disableInterruptOccurred to make a filter callout.

    Declaration

    C++

    virtual void disableInterruptOccurred( void *self, IOService *prov, int ind);

    Import Statement

  • Factor method to create and initialise an IOFilterInterruptEventSource. See $link init.

    Declaration

    C++

    static IOFilterInterruptEventSource * filterInterruptEventSource( OSObject *owner, IOInterruptEventSource::Action action, Filter filter, IOService *provider, int intIndex = 0);

    Parameters

    owner

    Owner/client of this event source.

    action

    'C' Function to call when something happens.

    filter

    'C' Function to call when interrupt occurs.

    provider

    Service that provides interrupts.

    intIndex

    Defaults to 0.

    Return Value

    a new event source if succesful, 0 otherwise.

    Import Statement

  • Get'ter for filterAction variable.

    Declaration

    C++

    virtual Filter getFilterAction() const;

    Return Value

    value of filterAction.

    Import Statement

  • Primary initialiser for the IOFilterInterruptEventSource class.

    Declaration

    C++

    virtual bool init( OSObject *owner, IOInterruptEventSource::Action action, Filter filter, IOService *provider, int intIndex = 0);

    Parameters

    owner

    Owner/client of this event source.

    action

    'C' Function to call when something happens.

    filter

    'C' Function to call in primary interrupt context.

    provider

    Service that provides interrupts.

    intIndex

    Interrupt source within provider. Defaults to 0.

    Return Value

    true if the inherited classes and this instance initialise successfully.

    Import Statement

  • Override $link IOInterruptEventSource::normalInterruptOccured to make a filter callout.

    Declaration

    C++

    virtual void normalInterruptOccurred( void *self, IOService *prov, int ind);

    Import Statement

  • Cause the work loop to schedule the action.

    Declaration

    C++

    virtual void signalInterrupt();

    Discussion

    Cause the work loop to schedule the interrupt action even if the filter routine returns 'false'. Note well the interrupting condition MUST be cleared from the hardware otherwise an infinite process interrupt loop will occur. Use this function when SoftDMA is desired. See $link IOFilterInterruptSource::Filter

    Import Statement

Callbacks

  • Declaration

    C++

    typedef bool ( * Filter )( OSObject *, IOFilterInterruptEventSource *);

    Parameters

    owner

    Pointer to the owning/client instance.

    sender

    Where is the interrupt comming from.

    Return Value

    false if this interrupt can be ignored.

    Discussion

    C Function pointer to a routine to call when an interrupt occurs.

    Import Statement

    Availability

    Available in OS X v10.0 through OS X v10.5.

Constants

  • Declaration

    CPlusPlus

    #define IOFilterInterruptAction IOFilterInterruptEventSource::Filter

    Constants

    • IOFilterInterruptAction

      IOFilterInterruptAction

      Backward compatibilty define for the old non-class scoped type definition. See $link IOFilterInterruptSource::Filter

      Available in OS X v10.0 and later.

    Import Statement

  • Data Types

    • Declaration

      C++

      struct ExpansionData { };

      Discussion

      This structure will be used to expand the capablilties of the IOWorkLoop in the future.

    Instance Variables

    • Reserved for future use. (Internal use only)

      Declaration

      C++

      ExpansionData *reserved;

    • Filter callout

      Declaration

      C++

      Filter filterAction;