WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/ipc/irq.h


/*
 * Copyright (c) 2006 Ondrej Palkovsky
 * 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 genericipc
 * @{
 */
/** @file
 */
 
#ifndef KERN_IPC_IRQ_H_
#define KERN_IPC_IRQ_H_
 
/** Maximum length of IPC IRQ program */
#define IRQ_MAX_PROG_SIZE 10
 
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 <ipc/ipc.h>
#include <typedefs.h>
#include <arch/types.h>
#include <adt/list.h>
 
/** IPC notification config structure.
 *
 * Primarily, this structure is encapsulated in the irq_t structure.
 * It is protected by irq_t::lock.
 */
struct ipc_notif_cfg {
    bool notify;            /**< When false, notifications are not sent. */
    answerbox_t *answerbox;     /**< Answerbox for notifications. */
    unative_t method;       /**< Method to be used for the notification. */
    irq_code_t *code;       /**< Top-half pseudocode. */
    count_t counter;        /**< Counter. */
    link_t link;            /**< Link between IRQs that are notifying the
                         same answerbox. The list is protected by
                         the answerbox irq_lock. */
};
 
extern int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno, unative_t method,
    irq_code_t *ucode);
extern void ipc_irq_send_notif(irq_t *irq);
extern void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3);
extern void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno);
extern void ipc_irq_cleanup(answerbox_t *box);
 
#endif
 
#endif
 
/** @}
 */
 

Rev 1933	Rev 2071
1	/*	1	/*
2	* Copyright (C) 2006 Ondrej Palkovsky	2	* Copyright (c) 2006 Ondrej Palkovsky
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 genericipc	29	/** @addtogroup genericipc
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_IPC_IRQ_H_	35	#ifndef KERN_IPC_IRQ_H_
36	#define KERN_IPC_IRQ_H_	36	#define KERN_IPC_IRQ_H_
37		37
38	/** Maximum length of IPC IRQ program */	38	/** Maximum length of IPC IRQ program */
39	#define IRQ_MAX_PROG_SIZE 10	39	#define IRQ_MAX_PROG_SIZE 10
40		40
41	typedef enum {	41	typedef enum {
42	CMD_MEM_READ_1 = 0,	42	CMD_MEM_READ_1 = 0,
43	CMD_MEM_READ_2,	43	CMD_MEM_READ_2,
44	CMD_MEM_READ_4,	44	CMD_MEM_READ_4,
45	CMD_MEM_READ_8,	45	CMD_MEM_READ_8,
46	CMD_MEM_WRITE_1,	46	CMD_MEM_WRITE_1,
47	CMD_MEM_WRITE_2,	47	CMD_MEM_WRITE_2,
48	CMD_MEM_WRITE_4,	48	CMD_MEM_WRITE_4,
49	CMD_MEM_WRITE_8,	49	CMD_MEM_WRITE_8,
50	CMD_PORT_READ_1,	50	CMD_PORT_READ_1,
51	CMD_PORT_WRITE_1,	51	CMD_PORT_WRITE_1,
52	CMD_IA64_GETCHAR,	52	CMD_IA64_GETCHAR,
53	CMD_PPC32_GETCHAR,	53	CMD_PPC32_GETCHAR,
54	CMD_LAST	54	CMD_LAST
55	} irq_cmd_type;	55	} irq_cmd_type;
56		56
57	typedef struct {	57	typedef struct {
58	irq_cmd_type cmd;	58	irq_cmd_type cmd;
59	void *addr;	59	void *addr;
60	unsigned long long value;	60	unsigned long long value;
61	int dstarg;	61	int dstarg;
62	} irq_cmd_t;	62	} irq_cmd_t;
63		63
64	typedef struct {	64	typedef struct {
65	unsigned int cmdcount;	65	unsigned int cmdcount;
66	irq_cmd_t *cmds;	66	irq_cmd_t *cmds;
67	} irq_code_t;	67	} irq_code_t;
68		68
69	#ifdef KERNEL	69	#ifdef KERNEL
70		70
71	#include <ipc/ipc.h>	71	#include <ipc/ipc.h>
72	#include <typedefs.h>	72	#include <typedefs.h>
73	#include <arch/types.h>	73	#include <arch/types.h>
74	#include <adt/list.h>	74	#include <adt/list.h>
75		75
76	/** IPC notification config structure.	76	/** IPC notification config structure.
77	*	77	*
78	* Primarily, this structure is encapsulated in the irq_t structure.	78	* Primarily, this structure is encapsulated in the irq_t structure.
79	* It is protected by irq_t::lock.	79	* It is protected by irq_t::lock.
80	*/	80	*/
81	struct ipc_notif_cfg {	81	struct ipc_notif_cfg {
82	bool notify; /*< When false, notifications are not sent. /	82	bool notify; /*< When false, notifications are not sent. /
83	answerbox_t answerbox; /< Answerbox for notifications. /	83	answerbox_t answerbox; /< Answerbox for notifications. /
84	unative_t method; /*< Method to be used for the notification. /	84	unative_t method; /*< Method to be used for the notification. /
85	irq_code_t code; /< Top-half pseudocode. /	85	irq_code_t code; /< Top-half pseudocode. /
86	count_t counter; /*< Counter. /	86	count_t counter; /*< Counter. /
87	link_t link; /**< Link between IRQs that are notifying the	87	link_t link; /**< Link between IRQs that are notifying the
88	same answerbox. The list is protected by	88	same answerbox. The list is protected by
89	the answerbox irq_lock. */	89	the answerbox irq_lock. */
90	};	90	};
91		91
92	extern int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno, unative_t method,	92	extern int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno, unative_t method,
93	irq_code_t *ucode);	93	irq_code_t *ucode);
94	extern void ipc_irq_send_notif(irq_t *irq);	94	extern void ipc_irq_send_notif(irq_t *irq);
95	extern void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3);	95	extern void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3);
96	extern void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno);	96	extern void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno);
97	extern void ipc_irq_cleanup(answerbox_t *box);	97	extern void ipc_irq_cleanup(answerbox_t *box);
98		98
99	#endif	99	#endif
100		100
101	#endif	101	#endif
102		102
103	/** @}	103	/** @}
104	*/	104	*/
105		105

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/ipc/irq.h – Rev 1933 → 2071