esos/include/pic24/esos_pic24_irq.h File Reference

This file contains macros, prototypes, and definitions for Microchip PIC24 family specific interrupts on ESOS. More...

#include "esos.h"
#include "esos_irq.h"
#include "esos_pic24.h"

Go to the source code of this file.

Defines

#define ESOS_USER_INTERRUPT(desc)
#define ESOS_USER_IRQ_LEVEL1
#define ESOS_USER_IRQ_LEVEL2
#define ESOS_USER_IRQ_LEVEL3
#define ESOS_USER_IRQ_LEVEL4
#define ESOS_IRQ_PIC24_AD1
#define ESOS_IRQ_PIC24_SPI1
#define ESOS_IRQ_PIC24_SPI1E
#define ESOS_IRQ_PIC24_T3
#define ESOS_IRQ_PIC24_T2
#define ESOS_IRQ_PIC24_OC2
#define ESOS_IRQ_PIC24_IC2
#define ESOS_IRQ_PIC24_OC1
#define ESOS_IRQ_PIC24_IC1
#define ESOS_IRQ_PIC24_INT0
#define ESOS_IRQ_PIC24_INT2
#define ESOS_IRQ_PIC24_IC8
#define ESOS_IRQ_PIC24_IC7
#define ESOS_IRQ_PIC24_INT1
#define ESOS_IRQ_PIC24_CN
#define ESOS_IRQ_PIC24_MI2C1
#define ESOS_IRQ_PIC24_SI2C1
#define ESOS_IRQ_PIC24_U1TX
#define ESOS_IRQ_PIC24_U1RX
#define ESOS_IRQ_PIC24_U1E
#define ESOS_UNREGISTER_PIC24_USER_INTERRUPT(desc)
#define ESOS_REGISTER_PIC24_USER_INTERRUPT(desc, ipl, p2f)
#define ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS()
#define ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS()
#define ESOS_IS_PIC24_USER_INTERRUPT_ENABLED(desc)
#define ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING(desc)
#define ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED(desc)
#define ESOS_ENABLE_PIC24_USER_INTERRUPT(desc)
#define ESOS_DISABLE_PIC24_USER_INTERRUPT(desc)


Detailed Description

This file contains macros, prototypes, and definitions for Microchip PIC24 family specific interrupts on ESOS.

Definition in file esos_pic24_irq.h.


Define Documentation

 
#define ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS (  ) 

#define ESOS_DISABLE_PIC24_USER_INTERRUPT ( desc   ) 

Disables the user interrupt denoted by the interrupt descriptor

Parameters:
desc Descriptor of the hardware interrupt
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 656 of file esos_pic24_irq.h.

#define ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING ( desc   ) 

Queries the "flag" state of user interrupt denoted by the interrupt descriptor

Parameters:
desc Descriptor of the hardware interrupt
Return values:
TRUE If the user interrupt is needs to be serviced
FALSE Otherwise
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 599 of file esos_pic24_irq.h.

 
#define ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS (  ) 

#define ESOS_ENABLE_PIC24_USER_INTERRUPT ( desc   ) 

Enables the user interrupt denoted by the interrupt descriptor

Parameters:
desc Descriptor of the hardware interrupt
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 637 of file esos_pic24_irq.h.

#define ESOS_IRQ_PIC24_AD1

#define ESOS_IRQ_PIC24_CN

#define ESOS_IRQ_PIC24_IC1

#define ESOS_IRQ_PIC24_IC2

#define ESOS_IRQ_PIC24_IC7

#define ESOS_IRQ_PIC24_IC8

#define ESOS_IRQ_PIC24_INT0

#define ESOS_IRQ_PIC24_INT1

#define ESOS_IRQ_PIC24_INT2

#define ESOS_IRQ_PIC24_MI2C1

#define ESOS_IRQ_PIC24_OC1

#define ESOS_IRQ_PIC24_OC2

#define ESOS_IRQ_PIC24_SI2C1

#define ESOS_IRQ_PIC24_SPI1

#define ESOS_IRQ_PIC24_SPI1E

#define ESOS_IRQ_PIC24_T2

#define ESOS_IRQ_PIC24_T3

#define ESOS_IRQ_PIC24_U1E

#define ESOS_IRQ_PIC24_U1RX

#define ESOS_IRQ_PIC24_U1TX

#define ESOS_IS_PIC24_USER_INTERRUPT_ENABLED ( desc   ) 

Queries the enabled state of user interrupt denoted by the interrupt descriptor

Parameters:
desc Descriptor of the hardware interrupt
Return values:
TRUE If the user interrupt is currently enabled
FALSE If the user interrupt is currently disabled
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 578 of file esos_pic24_irq.h.

#define ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED ( desc   ) 

Tells ESOS to mark the user interrupt denoted by the interrupt descriptor as being serviced

Parameters:
desc Descriptor of the hardware interrupt
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 618 of file esos_pic24_irq.h.

#define ESOS_REGISTER_PIC24_USER_INTERRUPT ( desc,
ipl,
p2f   ) 

Registers the user interrupt denoted by the interrupt descriptor

Parameters:
desc Descriptor of the hardware interrupt
ipl Interrupt Priority Level (IPL) for the interrupt being registered
p2f Pointer to function to serve as the ISR. Function must have void arguments and return void
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 520 of file esos_pic24_irq.h.

#define ESOS_UNREGISTER_PIC24_USER_INTERRUPT ( desc   ) 

Unregisters the user interrupt denoted by the interrupt descriptor

Parameters:
desc Descriptor of the hardware interrupt
Note:
Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.
See also:
ESOS_USER_INTERRUPT

ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 493 of file esos_pic24_irq.h.

#define ESOS_USER_INTERRUPT ( desc   ) 

Declaration of an ESOS interrupt.

This macro is used to declare an ESOS user inerrupt. All ESOS user interrupt tasks must be declared with this macro.

Parameters:
desc Descriptor of the hardware interrupt
Note:
ESOS user interrupts have no arguments passed in and cannot return values.

Hardware interrupt descriptors are found in the file esos_hw_irq.h where hw is the name of the chip for the ESOS port has been written.

See also:
ESOS_REGISTER_PIC24_USER_INTERRUPT

ESOS_UNREGISTER_PIC24_USER_INTERRUPT

ESOS_ENABLE_PIC24_USER_INTERRUPT

ESOS_DISABLE_PIC24_USER_INTERRUPT

ESOS_ENABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_DISABLE_ALL_PIC24_USER_INTERRUPTS

ESOS_IS_PIC24_USER_INTERRUPT_ENABLED

ESOS_DOES_PIC24_USER_INTERRUPT_NEED_SERVICING

ESOS_MARK_PIC24_USER_INTERRUPT_SERVICED

Definition at line 75 of file esos_pic24_irq.h.

#define ESOS_USER_IRQ_LEVEL1

Highest priority user interrupt level on PIC24 Family

See also:
ESOS_REGISTER_PIC24_USER_INTERRUPT

Definition at line 93 of file esos_pic24_irq.h.

#define ESOS_USER_IRQ_LEVEL2

Second-highest priority user interrupt level on PIC24 Family

See also:
ESOS_REGISTER_PIC24_USER_INTERRUPT

Definition at line 99 of file esos_pic24_irq.h.

#define ESOS_USER_IRQ_LEVEL3

Third-highest priority user interrupt level on PIC24 Family

See also:
ESOS_REGISTER_PIC24_USER_INTERRUPT

Definition at line 105 of file esos_pic24_irq.h.

#define ESOS_USER_IRQ_LEVEL4

Lowest priority user interrupt level on PIC24 Family

See also:
ESOS_REGISTER_PIC24_USER_INTERRUPT

Definition at line 111 of file esos_pic24_irq.h.


Generated on Sun Mar 15 11:14:22 2009 for PIC24 Support Libraries by  doxygen 1.5.8