Subversion Repositories HelenOS

Rev

Rev 2071 | Rev 2106 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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