WebSVN – HelenOS – Diff – /branches/dynload/kernel/generic/include/ddi/irq.h


/*
 * Copyright (c) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericddi
 * @{
 */
/** @file
 */
 
#ifndef KERN_IRQ_H_
#define KERN_IRQ_H_
 
typedef enum {
    CMD_MEM_READ_1 = 0,
    CMD_MEM_READ_2,
    CMD_MEM_READ_4,
    CMD_MEM_READ_8,
    CMD_MEM_WRITE_1,
    CMD_MEM_WRITE_2,
    CMD_MEM_WRITE_4,
    CMD_MEM_WRITE_8,
    CMD_PORT_READ_1,
    CMD_PORT_WRITE_1,
    CMD_IA64_GETCHAR,
    CMD_PPC32_GETCHAR,
    CMD_LAST
} irq_cmd_type;
 
typedef struct {
    irq_cmd_type cmd;
    void *addr;
    unsigned long long value;
    int dstarg;
} irq_cmd_t;
 
typedef struct {
    unsigned int cmdcount;
    irq_cmd_t *cmds;
} irq_code_t;
 
#ifdef KERNEL
 
#include <arch/types.h>
#include <adt/list.h>
#include <synch/spinlock.h>
#include <proc/task.h>
 
typedef enum {
    IRQ_DECLINE,        /**< Decline to service. */
    IRQ_ACCEPT      /**< Accept to service. */
} irq_ownership_t;
 
typedef enum {
    IRQ_TRIGGER_LEVEL = 1,
    IRQ_TRIGGER_EDGE
} irq_trigger_t;
 
struct irq;
typedef void (* irq_handler_t)(struct irq *irq, void *arg, ...);
 
/** Type for function used to clear the interrupt. */
typedef void (* cir_t)(void *arg, inr_t inr);
 
/** IPC notification config structure.
 *
 * Primarily, this structure is encapsulated in the irq_t structure.
 * It is protected by irq_t::lock.
 */
typedef struct {
    /** When false, notifications are not sent. */
    bool notify;
    /** Answerbox for notifications. */
    answerbox_t *answerbox;
    /** Method to be used for the notification. */
    unative_t method;
    /** Top-half pseudocode. */
    irq_code_t *code;
    /** Counter. */
    count_t counter;
    /**
     * Link between IRQs that are notifying the same answerbox. The list is
     * protected by the answerbox irq_lock.
     */
    link_t link;
} ipc_notif_cfg_t;
 
/** Structure representing one device IRQ.
 *
 * If one device has multiple interrupts, there will be multiple irq_t
 * instantions with the same devno.
 */
typedef struct irq {
    /** Hash table link. */
    link_t link;
 
    /** Lock protecting everything in this structure
     *  except the link member. When both the IRQ
     *  hash table lock and this lock are to be acquired,
     *  this lock must not be taken first.
     */
    SPINLOCK_DECLARE(lock);
   
    /** Send EOI before processing the interrupt.
     *  This is essential for timer interrupt which
     *  has to be acknowledged before doing preemption
     *  to make sure another timer interrupt will
     *  be eventually generated.
     */
    bool preack;
 
    /** Unique device number. -1 if not yet assigned. */
    devno_t devno;
 
    /** Actual IRQ number. -1 if not yet assigned. */
    inr_t inr;
    /** Trigger level of the IRQ. */
    irq_trigger_t trigger;
    /** Claim ownership of the IRQ. */
    irq_ownership_t (* claim)(void);
    /** Handler for this IRQ and device. */
    irq_handler_t handler;
    /** Argument for the handler. */
    void *arg;
 
    /** Clear interrupt routine. */
    cir_t cir;
    /** First argument to the clear interrupt routine. */
    void *cir_arg;
 
    /** Notification configuration structure. */
    ipc_notif_cfg_t notif_cfg;
} irq_t;
 
extern void irq_init(count_t inrs, count_t chains);
extern void irq_initialize(irq_t *irq);
extern void irq_register(irq_t *irq);
extern irq_t *irq_dispatch_and_lock(inr_t inr);
extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);
 
#endif
 
#endif
 
/** @}
 */
 

Rev 2927	Rev 3674
1	/*	1	/*
2	* Copyright (c) 2006 Jakub Jermar	2	* Copyright (c) 2006 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genericddi	29	/** @addtogroup genericddi
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_IRQ_H_	35	#ifndef KERN_IRQ_H_
36	#define KERN_IRQ_H_	36	#define KERN_IRQ_H_
37		37
38	typedef enum {	38	typedef enum {
39	CMD_MEM_READ_1 = 0,	39	CMD_MEM_READ_1 = 0,
40	CMD_MEM_READ_2,	40	CMD_MEM_READ_2,
41	CMD_MEM_READ_4,	41	CMD_MEM_READ_4,
42	CMD_MEM_READ_8,	42	CMD_MEM_READ_8,
43	CMD_MEM_WRITE_1,	43	CMD_MEM_WRITE_1,
44	CMD_MEM_WRITE_2,	44	CMD_MEM_WRITE_2,
45	CMD_MEM_WRITE_4,	45	CMD_MEM_WRITE_4,
46	CMD_MEM_WRITE_8,	46	CMD_MEM_WRITE_8,
47	CMD_PORT_READ_1,	47	CMD_PORT_READ_1,
48	CMD_PORT_WRITE_1,	48	CMD_PORT_WRITE_1,
49	CMD_IA64_GETCHAR,	49	CMD_IA64_GETCHAR,
50	CMD_PPC32_GETCHAR,	50	CMD_PPC32_GETCHAR,
51	CMD_LAST	51	CMD_LAST
52	} irq_cmd_type;	52	} irq_cmd_type;
53		53
54	typedef struct {	54	typedef struct {
55	irq_cmd_type cmd;	55	irq_cmd_type cmd;
56	void *addr;	56	void *addr;
57	unsigned long long value;	57	unsigned long long value;
58	int dstarg;	58	int dstarg;
59	} irq_cmd_t;	59	} irq_cmd_t;
60		60
61	typedef struct {	61	typedef struct {
62	unsigned int cmdcount;	62	unsigned int cmdcount;
63	irq_cmd_t *cmds;	63	irq_cmd_t *cmds;
64	} irq_code_t;	64	} irq_code_t;
65		65
66	#ifdef KERNEL	66	#ifdef KERNEL
67		67
68	#include <arch/types.h>	68	#include <arch/types.h>
69	#include <adt/list.h>	69	#include <adt/list.h>
70	#include <synch/spinlock.h>	70	#include <synch/spinlock.h>
71	#include <proc/task.h>	71	#include <proc/task.h>
72		72
73	typedef enum {	73	typedef enum {
74	IRQ_DECLINE, /*< Decline to service. /	74	IRQ_DECLINE, /*< Decline to service. /
75	IRQ_ACCEPT /*< Accept to service. /	75	IRQ_ACCEPT /*< Accept to service. /
76	} irq_ownership_t;	76	} irq_ownership_t;
77		77
78	typedef enum {	78	typedef enum {
79	IRQ_TRIGGER_LEVEL = 1,	79	IRQ_TRIGGER_LEVEL = 1,
80	IRQ_TRIGGER_EDGE	80	IRQ_TRIGGER_EDGE
81	} irq_trigger_t;	81	} irq_trigger_t;
82		82
83	struct irq;	83	struct irq;
84	typedef void (* irq_handler_t)(struct irq irq, void arg, ...);	84	typedef void (* irq_handler_t)(struct irq irq, void arg, ...);
85		85
-		86	/** Type for function used to clear the interrupt. */
-		87	typedef void (* cir_t)(void *arg, inr_t inr);
-		88
86	/** IPC notification config structure.	89	/** IPC notification config structure.
87	*	90	*
88	* Primarily, this structure is encapsulated in the irq_t structure.	91	* Primarily, this structure is encapsulated in the irq_t structure.
89	* It is protected by irq_t::lock.	92	* It is protected by irq_t::lock.
90	*/	93	*/
91	typedef struct {	94	typedef struct {
92	/** When false, notifications are not sent. */	95	/** When false, notifications are not sent. */
93	bool notify;	96	bool notify;
94	/** Answerbox for notifications. */	97	/** Answerbox for notifications. */
95	answerbox_t *answerbox;	98	answerbox_t *answerbox;
96	/** Method to be used for the notification. */	99	/** Method to be used for the notification. */
97	unative_t method;	100	unative_t method;
98	/** Top-half pseudocode. */	101	/** Top-half pseudocode. */
99	irq_code_t *code;	102	irq_code_t *code;
100	/** Counter. */	103	/** Counter. */
101	count_t counter;	104	count_t counter;
102	/**	105	/**
103	* Link between IRQs that are notifying the same answerbox. The list is	106	* Link between IRQs that are notifying the same answerbox. The list is
104	* protected by the answerbox irq_lock.	107	* protected by the answerbox irq_lock.
105	*/	108	*/
106	link_t link;	109	link_t link;
107	} ipc_notif_cfg_t;	110	} ipc_notif_cfg_t;
108		111
109	/** Structure representing one device IRQ.	112	/** Structure representing one device IRQ.
110	*	113	*
111	* If one device has multiple interrupts, there will be multiple irq_t	114	* If one device has multiple interrupts, there will be multiple irq_t
112	* instantions with the same devno.	115	* instantions with the same devno.
113	*/	116	*/
114	typedef struct irq {	117	typedef struct irq {
115	/** Hash table link. */	118	/** Hash table link. */
116	link_t link;	119	link_t link;
117		120
118	/** Lock protecting everything in this structure	121	/** Lock protecting everything in this structure
119	* except the link member. When both the IRQ	122	* except the link member. When both the IRQ
120	* hash table lock and this lock are to be acquired,	123	* hash table lock and this lock are to be acquired,
121	* this lock must not be taken first.	124	* this lock must not be taken first.
122	*/	125	*/
123	SPINLOCK_DECLARE(lock);	126	SPINLOCK_DECLARE(lock);
124		127
125	/** Send EOI before processing the interrupt.	128	/** Send EOI before processing the interrupt.
126	* This is essential for timer interrupt which	129	* This is essential for timer interrupt which
127	* has to be acknowledged before doing preemption	130	* has to be acknowledged before doing preemption
128	* to make sure another timer interrupt will	131	* to make sure another timer interrupt will
129	* be eventually generated.	132	* be eventually generated.
130	*/	133	*/
131	bool preack;	134	bool preack;
132		135
133	/** Unique device number. -1 if not yet assigned. */	136	/** Unique device number. -1 if not yet assigned. */
134	devno_t devno;	137	devno_t devno;
135		138
136	/** Actual IRQ number. -1 if not yet assigned. */	139	/** Actual IRQ number. -1 if not yet assigned. */
137	inr_t inr;	140	inr_t inr;
138	/** Trigger level of the IRQ. */	141	/** Trigger level of the IRQ. */
139	irq_trigger_t trigger;	142	irq_trigger_t trigger;
140	/** Claim ownership of the IRQ. */	143	/** Claim ownership of the IRQ. */
141	irq_ownership_t (* claim)(void);	144	irq_ownership_t (* claim)(void);
142	/** Handler for this IRQ and device. */	145	/** Handler for this IRQ and device. */
143	irq_handler_t handler;	146	irq_handler_t handler;
144	/** Argument for the handler. */	147	/** Argument for the handler. */
145	void *arg;	148	void *arg;
146		149
-		150	/** Clear interrupt routine. */
-		151	cir_t cir;
-		152	/** First argument to the clear interrupt routine. */
-		153	void *cir_arg;
-		154
147	/** Notification configuration structure. */	155	/** Notification configuration structure. */
148	ipc_notif_cfg_t notif_cfg;	156	ipc_notif_cfg_t notif_cfg;
149	} irq_t;	157	} irq_t;
150		158
151	extern void irq_init(count_t inrs, count_t chains);	159	extern void irq_init(count_t inrs, count_t chains);
152	extern void irq_initialize(irq_t *irq);	160	extern void irq_initialize(irq_t *irq);
153	extern void irq_register(irq_t *irq);	161	extern void irq_register(irq_t *irq);
154	extern irq_t *irq_dispatch_and_lock(inr_t inr);	162	extern irq_t *irq_dispatch_and_lock(inr_t inr);
155	extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);	163	extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);
156		164
157	#endif	165	#endif
158		166
159	#endif	167	#endif
160		168
161	/** @}	169	/** @}
162	*/	170	*/
163		171

Subversion Repositories HelenOS

(root)/branches/dynload/kernel/generic/include/ddi/irq.h – Rev 2927 → 3674