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_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 *);
 
/** Type for function used to clear the interrupt. */
typedef void (* cir_t)(void *, inr_t);
 
/** 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;
    /** Instance argument for the handler and the claim function. */
    void *instance;
 
    /** 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, count_t);
extern void irq_initialize(irq_t *);
extern void irq_register(irq_t *);
extern irq_t *irq_dispatch_and_lock(inr_t);
extern irq_t *irq_find_and_lock(inr_t, devno_t);
 
#endif
 
#endif
 
/** @}
 */
 

Rev 4342	Rev 4343
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_LAST	49	CMD_LAST
50	} irq_cmd_type;	50	} irq_cmd_type;
51		51
52	typedef struct {	52	typedef struct {
53	irq_cmd_type cmd;	53	irq_cmd_type cmd;
54	void *addr;	54	void *addr;
55	unsigned long long value;	55	unsigned long long value;
56	int dstarg;	56	int dstarg;
57	} irq_cmd_t;	57	} irq_cmd_t;
58		58
59	typedef struct {	59	typedef struct {
60	unsigned int cmdcount;	60	unsigned int cmdcount;
61	irq_cmd_t *cmds;	61	irq_cmd_t *cmds;
62	} irq_code_t;	62	} irq_code_t;
63		63
64	#ifdef KERNEL	64	#ifdef KERNEL
65		65
66	#include <arch/types.h>	66	#include <arch/types.h>
67	#include <adt/list.h>	67	#include <adt/list.h>
68	#include <synch/spinlock.h>	68	#include <synch/spinlock.h>
69	#include <proc/task.h>	69	#include <proc/task.h>
70		70
71	typedef enum {	71	typedef enum {
72	IRQ_DECLINE, /*< Decline to service. /	72	IRQ_DECLINE, /*< Decline to service. /
73	IRQ_ACCEPT /*< Accept to service. /	73	IRQ_ACCEPT /*< Accept to service. /
74	} irq_ownership_t;	74	} irq_ownership_t;
75		75
76	typedef enum {	76	typedef enum {
77	IRQ_TRIGGER_LEVEL = 1,	77	IRQ_TRIGGER_LEVEL = 1,
78	IRQ_TRIGGER_EDGE	78	IRQ_TRIGGER_EDGE
79	} irq_trigger_t;	79	} irq_trigger_t;
80		80
81	struct irq;	81	struct irq;
82	typedef void (* irq_handler_t)(struct irq irq, void arg, ...);	82	typedef void (* irq_handler_t)(struct irq *);
83		83
84	/** Type for function used to clear the interrupt. */	84	/** Type for function used to clear the interrupt. */
85	typedef void (* cir_t)(void *arg, inr_t inr);	85	typedef void (* cir_t)(void *, inr_t);
86		86
87	/** IPC notification config structure.	87	/** IPC notification config structure.
88	*	88	*
89	* Primarily, this structure is encapsulated in the irq_t structure.	89	* Primarily, this structure is encapsulated in the irq_t structure.
90	* It is protected by irq_t::lock.	90	* It is protected by irq_t::lock.
91	*/	91	*/
92	typedef struct {	92	typedef struct {
93	/** When false, notifications are not sent. */	93	/** When false, notifications are not sent. */
94	bool notify;	94	bool notify;
95	/** Answerbox for notifications. */	95	/** Answerbox for notifications. */
96	answerbox_t *answerbox;	96	answerbox_t *answerbox;
97	/** Method to be used for the notification. */	97	/** Method to be used for the notification. */
98	unative_t method;	98	unative_t method;
99	/** Top-half pseudocode. */	99	/** Top-half pseudocode. */
100	irq_code_t *code;	100	irq_code_t *code;
101	/** Counter. */	101	/** Counter. */
102	count_t counter;	102	count_t counter;
103	/**	103	/**
104	* Link between IRQs that are notifying the same answerbox. The list is	104	* Link between IRQs that are notifying the same answerbox. The list is
105	* protected by the answerbox irq_lock.	105	* protected by the answerbox irq_lock.
106	*/	106	*/
107	link_t link;	107	link_t link;
108	} ipc_notif_cfg_t;	108	} ipc_notif_cfg_t;
109		109
110	/** Structure representing one device IRQ.	110	/** Structure representing one device IRQ.
111	*	111	*
112	* If one device has multiple interrupts, there will be multiple irq_t	112	* If one device has multiple interrupts, there will be multiple irq_t
113	* instantions with the same devno.	113	* instantions with the same devno.
114	*/	114	*/
115	typedef struct irq {	115	typedef struct irq {
116	/** Hash table link. */	116	/** Hash table link. */
117	link_t link;	117	link_t link;
118		118
119	/** Lock protecting everything in this structure	119	/** Lock protecting everything in this structure
120	* except the link member. When both the IRQ	120	* except the link member. When both the IRQ
121	* hash table lock and this lock are to be acquired,	121	* hash table lock and this lock are to be acquired,
122	* this lock must not be taken first.	122	* this lock must not be taken first.
123	*/	123	*/
124	SPINLOCK_DECLARE(lock);	124	SPINLOCK_DECLARE(lock);
125		125
126	/** Send EOI before processing the interrupt.	126	/** Send EOI before processing the interrupt.
127	* This is essential for timer interrupt which	127	* This is essential for timer interrupt which
128	* has to be acknowledged before doing preemption	128	* has to be acknowledged before doing preemption
129	* to make sure another timer interrupt will	129	* to make sure another timer interrupt will
130	* be eventually generated.	130	* be eventually generated.
131	*/	131	*/
132	bool preack;	132	bool preack;
133		133
134	/** Unique device number. -1 if not yet assigned. */	134	/** Unique device number. -1 if not yet assigned. */
135	devno_t devno;	135	devno_t devno;
136		136
137	/** Actual IRQ number. -1 if not yet assigned. */	137	/** Actual IRQ number. -1 if not yet assigned. */
138	inr_t inr;	138	inr_t inr;
139	/** Trigger level of the IRQ. */	139	/** Trigger level of the IRQ. */
140	irq_trigger_t trigger;	140	irq_trigger_t trigger;
141	/** Claim ownership of the IRQ. */	141	/** Claim ownership of the IRQ. */
142	irq_ownership_t (* claim)(void);	142	irq_ownership_t (* claim)(void *);
143	/** Handler for this IRQ and device. */	143	/** Handler for this IRQ and device. */
144	irq_handler_t handler;	144	irq_handler_t handler;
145	/** Argument for the handler. */	145	/** Instance argument for the handler and the claim function. */
146	void *arg;	146	void *instance;
147		147
148	/** Clear interrupt routine. */	148	/** Clear interrupt routine. */
149	cir_t cir;	149	cir_t cir;
150	/** First argument to the clear interrupt routine. */	150	/** First argument to the clear interrupt routine. */
151	void *cir_arg;	151	void *cir_arg;
152		152
153	/** Notification configuration structure. */	153	/** Notification configuration structure. */
154	ipc_notif_cfg_t notif_cfg;	154	ipc_notif_cfg_t notif_cfg;
155	} irq_t;	155	} irq_t;
156		156
157	extern void irq_init(count_t inrs, count_t chains);	157	extern void irq_init(count_t, count_t);
158	extern void irq_initialize(irq_t *irq);	158	extern void irq_initialize(irq_t *);
159	extern void irq_register(irq_t *irq);	159	extern void irq_register(irq_t *);
160	extern irq_t *irq_dispatch_and_lock(inr_t inr);	160	extern irq_t *irq_dispatch_and_lock(inr_t);
161	extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);	161	extern irq_t *irq_find_and_lock(inr_t, devno_t);
162		162
163	#endif	163	#endif
164		164
165	#endif	165	#endif
166		166
167	/** @}	167	/** @}
168	*/	168	*/
169		169

Subversion Repositories HelenOS

(root)/branches/dynload/kernel/generic/include/ddi/irq.h @ 4344 – Rev 4342 → 4343