WebSVN – HelenOS – Blame – /trunk/kernel/generic/include/ddi/irq.h

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

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ddi/irq.h – Rev 3941