WebSVN – HelenOS – Diff – /trunk/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_
 
#include <arch/types.h>
#include <adt/list.h>
#include <ipc/ipc.h>
#include <ipc/irq.h>
#include <atomic.h>
#include <synch/spinlock.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;
 
typedef struct irq irq_t;
 
typedef void (* irq_handler_t)(irq_t *irq, void *arg, ...);
 
/** Structure representing one device IRQ.
 *
 * If one device has multiple interrupts, there will
 * be multiple irq_t instantions with the same
 * devno.
 */
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);
 
    /** 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;
 
    /** Answerbox of the task that wanted to be notified. */
    answerbox_t *notif_answerbox;
    /** Pseudo-code to be performed by the top-half
     *  before a notification is sent. */
    irq_code_t *code;
    /** Method of the notification. */
    unative_t method;
    /** Counter of IRQ notifications. */
    atomic_t counter;
};
 
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
 
/** @}
 */
 

Rev 1921	Rev 1922
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	#include <arch/types.h>	38	#include <arch/types.h>
39	#include <adt/list.h>	39	#include <adt/list.h>
40	#include <ipc/ipc.h>	40	#include <ipc/ipc.h>
41	#include <ipc/irq.h>	41	#include <ipc/irq.h>
42	#include <atomic.h>	42	#include <atomic.h>
43	#include <synch/spinlock.h>	43	#include <synch/spinlock.h>
44		44
45	typedef enum {	45	typedef enum {
46	IRQ_DECLINE, /*< Decline to service. /	46	IRQ_DECLINE, /*< Decline to service. /
47	IRQ_ACCEPT /*< Accept to service. /	47	IRQ_ACCEPT /*< Accept to service. /
48	} irq_ownership_t;	48	} irq_ownership_t;
49		49
50	typedef enum {	50	typedef enum {
51	IRQ_TRIGGER_LEVEL = 1,	51	IRQ_TRIGGER_LEVEL = 1,
52	IRQ_TRIGGER_EDGE	52	IRQ_TRIGGER_EDGE
53	} irq_trigger_t;	53	} irq_trigger_t;
54		54
55	typedef struct irq irq_t;	55	typedef struct irq irq_t;
56		56
57	typedef void (* irq_handler_t)(irq_t irq, void arg, ...);	57	typedef void (* irq_handler_t)(irq_t irq, void arg, ...);
58		58
59	/** Structure representing one device IRQ.	59	/** Structure representing one device IRQ.
60	*	60	*
61	* If one device has multiple interrupts, there will	61	* If one device has multiple interrupts, there will
62	* be multiple irq_t instantions with the same	62	* be multiple irq_t instantions with the same
63	* devno.	63	* devno.
64	*/	64	*/
65	struct irq {	65	struct irq {
66	/** Hash table link. */	66	/** Hash table link. */
67	link_t link;	67	link_t link;
68		68
69	/** Lock protecting everything in this structure	69	/** Lock protecting everything in this structure
70	* except the link member. When both the IRQ	70	* except the link member. When both the IRQ
71	* hash table lock and this lock are to be acquired,	71	* hash table lock and this lock are to be acquired,
72	* this lock must not be taken first.	72	* this lock must not be taken first.
73	*/	73	*/
74	SPINLOCK_DECLARE(lock);	74	SPINLOCK_DECLARE(lock);
75		75
76	/** Unique device number. -1 if not yet assigned. */	76	/** Unique device number. -1 if not yet assigned. */
77	devno_t devno;	77	devno_t devno;
78		78
79	/** Actual IRQ number. -1 if not yet assigned. */	79	/** Actual IRQ number. -1 if not yet assigned. */
80	inr_t inr;	80	inr_t inr;
81	/** Trigger level of the IRQ.*/	81	/** Trigger level of the IRQ.*/
82	irq_trigger_t trigger;	82	irq_trigger_t trigger;
83	/** Claim ownership of the IRQ. */	83	/** Claim ownership of the IRQ. */
84	irq_ownership_t (* claim)(void);	84	irq_ownership_t (* claim)(void);
85	/** Handler for this IRQ and device. */	85	/** Handler for this IRQ and device. */
86	irq_handler_t handler;	86	irq_handler_t handler;
87	/** Argument for the handler. */	87	/** Argument for the handler. */
88	void *arg;	88	void *arg;
89		89
90	/** Answerbox of the task that wanted to be notified. */	90	/** Answerbox of the task that wanted to be notified. */
91	answerbox_t *notif_answerbox;	91	answerbox_t *notif_answerbox;
92	/** Pseudo-code to be performed by the top-half	92	/** Pseudo-code to be performed by the top-half
93	* before a notification is sent. */	93	* before a notification is sent. */
94	irq_code_t *code;	94	irq_code_t *code;
-		95	/** Method of the notification. */
-		96	unative_t method;
95	/** Counter of IRQ notifications. */	97	/** Counter of IRQ notifications. */
96	atomic_t counter;	98	atomic_t counter;
97	};	99	};
98		100
99	extern void irq_init(count_t inrs, count_t chains);	101	extern void irq_init(count_t inrs, count_t chains);
100	extern void irq_initialize(irq_t *irq);	102	extern void irq_initialize(irq_t *irq);
101	extern void irq_register(irq_t *irq);	103	extern void irq_register(irq_t *irq);
102	extern irq_t *irq_dispatch(inr_t inr);	104	extern irq_t *irq_dispatch_and_lock(inr_t inr);
-		105	extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);
103		106
104	#endif	107	#endif
105		108
106	/** @}	109	/** @}
107	*/	110	*/
108		111

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ddi/irq.h – Rev 1921 → 1922