Subversion Repositories HelenOS

Rev

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

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