Subversion Repositories HelenOS

Rev

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

Rev 2131 Rev 2456
1
/*
1
/*
2
 * Copyright (c) 2001-2006 Jakub Jermar
2
 * Copyright (c) 2001-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 genarch
29
/** @addtogroup genarch
30
 * @{
30
 * @{
31
 */
31
 */
32
/**
32
/**
33
 * @file
33
 * @file
34
 * @brief   NS 16550 serial port / keyboard driver.
34
 * @brief   NS 16550 serial port / keyboard driver.
35
 */
35
 */
36
 
36
 
37
#include <genarch/kbd/ns16550.h>
37
#include <genarch/kbd/ns16550.h>
38
#include <genarch/kbd/key.h>
38
#include <genarch/kbd/key.h>
39
#include <genarch/kbd/scanc.h>
39
#include <genarch/kbd/scanc.h>
40
#include <genarch/kbd/scanc_sun.h>
40
#include <genarch/kbd/scanc_sun.h>
41
#include <arch/drivers/kbd.h>
41
#include <arch/drivers/kbd.h>
42
#include <arch/drivers/ns16550.h>
42
#include <arch/drivers/ns16550.h>
43
#include <ddi/irq.h>
43
#include <ddi/irq.h>
44
#include <ipc/irq.h>
44
#include <ipc/irq.h>
45
#include <cpu.h>
45
#include <cpu.h>
46
#include <arch/asm.h>
46
#include <arch/asm.h>
47
#include <arch.h>
47
#include <arch.h>
48
#include <console/chardev.h>
48
#include <console/chardev.h>
49
#include <console/console.h>
49
#include <console/console.h>
50
#include <interrupt.h>
50
#include <interrupt.h>
51
#include <arch/interrupt.h>
51
#include <arch/interrupt.h>
52
#include <sysinfo/sysinfo.h>
52
#include <sysinfo/sysinfo.h>
53
#include <synch/spinlock.h>
53
#include <synch/spinlock.h>
-
 
54
#include <synch/rcu.h>
54
 
55
 
55
#define LSR_DATA_READY  0x01
56
#define LSR_DATA_READY  0x01
56
 
57
 
57
/** Structure representing the ns16550. */
58
/** Structure representing the ns16550. */
58
static ns16550_t ns16550;
59
static ns16550_t ns16550;
59
 
60
 
60
/** Structure for ns16550's IRQ. */
61
/** Structure for ns16550's IRQ. */
61
static irq_t ns16550_irq;
62
static irq_t ns16550_irq;
62
 
63
 
63
/*
64
/*
64
 * These codes read from ns16550 data register are silently ignored.
65
 * These codes read from ns16550 data register are silently ignored.
65
 */
66
 */
66
#define IGNORE_CODE 0x7f        /* all keys up */
67
#define IGNORE_CODE 0x7f        /* all keys up */
67
 
68
 
68
static void ns16550_suspend(chardev_t *);
69
static void ns16550_suspend(chardev_t *);
69
static void ns16550_resume(chardev_t *);
70
static void ns16550_resume(chardev_t *);
70
 
71
 
71
static chardev_operations_t ops = {
72
static chardev_operations_t ops = {
72
    .suspend = ns16550_suspend,
73
    .suspend = ns16550_suspend,
73
    .resume = ns16550_resume,
74
    .resume = ns16550_resume,
74
    .read = ns16550_key_read
75
    .read = ns16550_key_read
75
};
76
};
76
 
77
 
77
void ns16550_interrupt(void);
78
void ns16550_interrupt(void);
78
 
79
 
79
/** Initialize keyboard and service interrupts using kernel routine */
80
/** Initialize keyboard and service interrupts using kernel routine */
80
void ns16550_grab(void)
81
void ns16550_grab(void)
81
{
82
{
82
    ipl_t ipl = interrupts_disable();
83
    ipl_t ipl = interrupts_disable();
83
 
84
 
84
    ns16550_ier_write(&ns16550, IER_ERBFI);     /* enable receiver interrupt */
85
    ns16550_ier_write(&ns16550, IER_ERBFI);     /* enable receiver interrupt */
85
   
86
   
86
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
87
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
87
        (void) ns16550_rbr_read(&ns16550);
88
        (void) ns16550_rbr_read(&ns16550);
88
 
89
 
89
    spinlock_lock(&ns16550_irq.lock);
90
    //rcu_read_lock() is not needed, ints are disabled
90
    ns16550_irq.notif_cfg.notify = false;
91
    //rcu: atomic update doesn't need reallocation  
91
    spinlock_unlock(&ns16550_irq.lock);
92
    rcu_dereference_pointer(ns16550_irq.notif_cfg).notify = false;
92
    interrupts_restore(ipl);
93
    interrupts_restore(ipl);
93
}
94
}
94
 
95
 
95
/** Resume the former interrupt vector */
96
/** Resume the former interrupt vector */
96
void ns16550_release(void)
97
void ns16550_release(void)
97
{
98
{
98
    ipl_t ipl = interrupts_disable();
99
    ipl_t ipl = interrupts_disable();
-
 
100
    //rcu: atomic update doesn't need reallocation
99
    spinlock_lock(&ns16550_irq.lock);
101
    spinlock_lock(&ns16550_irq.lock);
100
    if (ns16550_irq.notif_cfg.answerbox)
102
    if (rcu_dereference_pointer(ns16550_irq.notif_cfg).answerbox)
101
        ns16550_irq.notif_cfg.notify = true;
103
        rcu_dereference_pointer(ns16550_irq.notif_cfg).notify = true;
102
    spinlock_unlock(&ns16550_irq.lock);
104
    spinlock_unlock(&ns16550_irq.lock);
103
    interrupts_restore(ipl);
105
    interrupts_restore(ipl);
104
}
106
}
105
 
107
 
106
/** Initialize ns16550.
108
/** Initialize ns16550.
107
 *
109
 *
108
 * @param devno Device number.
110
 * @param devno Device number.
109
 * @param inr Interrupt number.
111
 * @param inr Interrupt number.
110
 * @param vaddr Virtual address of device's registers.
112
 * @param vaddr Virtual address of device's registers.
111
 */
113
 */
112
void ns16550_init(devno_t devno, inr_t inr, uintptr_t vaddr)
114
void ns16550_init(devno_t devno, inr_t inr, uintptr_t vaddr)
113
{
115
{
114
    chardev_initialize("ns16550_kbd", &kbrd, &ops);
116
    chardev_initialize("ns16550_kbd", &kbrd, &ops);
115
    stdin = &kbrd;
117
    stdin = &kbrd;
116
   
118
   
117
    ns16550.devno = devno;
119
    ns16550.devno = devno;
118
    ns16550.reg = (uint8_t *) vaddr;
120
    ns16550.reg = (uint8_t *) vaddr;
119
   
121
   
120
    irq_initialize(&ns16550_irq);
122
    irq_initialize(&ns16550_irq);
121
    ns16550_irq.devno = devno;
123
    ns16550_irq.devno = devno;
122
    ns16550_irq.inr = inr;
124
    ns16550_irq.inr = inr;
123
    ns16550_irq.claim = ns16550_claim;
125
    ns16550_irq.claim = ns16550_claim;
124
    ns16550_irq.handler = ns16550_irq_handler;
126
    ns16550_irq.handler = ns16550_irq_handler;
125
    irq_register(&ns16550_irq);
127
    irq_register(&ns16550_irq);
126
   
128
   
127
    sysinfo_set_item_val("kbd", NULL, true);
129
    sysinfo_set_item_val("kbd", NULL, true);
128
    sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
130
    sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
129
    sysinfo_set_item_val("kbd.devno", NULL, devno);
131
    sysinfo_set_item_val("kbd.devno", NULL, devno);
130
    sysinfo_set_item_val("kbd.inr", NULL, inr);
132
    sysinfo_set_item_val("kbd.inr", NULL, inr);
131
    sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);
133
    sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);
132
   
134
   
133
    ns16550_grab();
135
    ns16550_grab();
134
}
136
}
135
 
137
 
136
/** Process ns16550 interrupt. */
138
/** Process ns16550 interrupt. */
137
void ns16550_interrupt(void)
139
void ns16550_interrupt(void)
138
{
140
{
139
    /* TODO
141
    /* TODO
140
     *
142
     *
141
     * ns16550 works in the polled mode so far.
143
     * ns16550 works in the polled mode so far.
142
     */
144
     */
143
}
145
}
144
 
146
 
145
/* Called from getc(). */
147
/* Called from getc(). */
146
void ns16550_resume(chardev_t *d)
148
void ns16550_resume(chardev_t *d)
147
{
149
{
148
}
150
}
149
 
151
 
150
/* Called from getc(). */
152
/* Called from getc(). */
151
void ns16550_suspend(chardev_t *d)
153
void ns16550_suspend(chardev_t *d)
152
{
154
{
153
}
155
}
154
 
156
 
155
char ns16550_key_read(chardev_t *d)
157
char ns16550_key_read(chardev_t *d)
156
{
158
{
157
    char ch;   
159
    char ch;   
158
 
160
 
159
    while(!(ch = active_read_buff_read())) {
161
    while(!(ch = active_read_buff_read())) {
160
        uint8_t x;
162
        uint8_t x;
161
        while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
163
        while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
162
            ;
164
            ;
163
        x = ns16550_rbr_read(&ns16550);
165
        x = ns16550_rbr_read(&ns16550);
164
        if (x != IGNORE_CODE) {
166
        if (x != IGNORE_CODE) {
165
            if (x & KEY_RELEASE)
167
            if (x & KEY_RELEASE)
166
                key_released(x ^ KEY_RELEASE);
168
                key_released(x ^ KEY_RELEASE);
167
            else
169
            else
168
                active_read_key_pressed(x);
170
                active_read_key_pressed(x);
169
        }
171
        }
170
    }
172
    }
171
    return ch;
173
    return ch;
172
}
174
}
173
 
175
 
174
/** Poll for key press and release events.
176
/** Poll for key press and release events.
175
 *
177
 *
176
 * This function can be used to implement keyboard polling.
178
 * This function can be used to implement keyboard polling.
177
 */
179
 */
178
void ns16550_poll(void)
180
void ns16550_poll(void)
179
{
181
{
180
    ipl_t ipl;
182
    ipl_t ipl;
181
 
183
 
182
    ipl = interrupts_disable();
184
    ipl = interrupts_disable();
183
    spinlock_lock(&ns16550_irq.lock);
185
    spinlock_lock(&ns16550_irq.lock);
184
 
186
 
185
    if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
187
    if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
186
        if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {
188
        if (rcu_dereference_pointer(ns16550_irq.notif_cfg).notify && rcu_dereference_pointer(ns16550_irq.notif_cfg).answerbox) {
187
            /*
189
            /*
188
             * Send IPC notification.
190
             * Send IPC notification.
189
             */
191
             */
190
            ipc_irq_send_notif(&ns16550_irq);
192
            ipc_irq_send_notif(&ns16550_irq);
191
            spinlock_unlock(&ns16550_irq.lock);
193
            spinlock_unlock(&ns16550_irq.lock);
192
            interrupts_restore(ipl);
194
            interrupts_restore(ipl);
193
            return;
195
            return;
194
        }
196
        }
195
    }
197
    }
196
 
198
 
197
    spinlock_unlock(&ns16550_irq.lock);
199
    spinlock_unlock(&ns16550_irq.lock);
198
    interrupts_restore(ipl);
200
    interrupts_restore(ipl);
199
 
201
 
200
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
202
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
201
        uint8_t x;
203
        uint8_t x;
202
       
204
       
203
        x = ns16550_rbr_read(&ns16550);
205
        x = ns16550_rbr_read(&ns16550);
204
        if (x != IGNORE_CODE) {
206
        if (x != IGNORE_CODE) {
205
            if (x & KEY_RELEASE)
207
            if (x & KEY_RELEASE)
206
                key_released(x ^ KEY_RELEASE);
208
                key_released(x ^ KEY_RELEASE);
207
            else
209
            else
208
                key_pressed(x);
210
                key_pressed(x);
209
        }
211
        }
210
    }
212
    }
211
}
213
}
212
 
214
 
213
irq_ownership_t ns16550_claim(void)
215
irq_ownership_t ns16550_claim(void)
214
{
216
{
215
    return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
217
    return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
216
}
218
}
217
 
219
 
218
void ns16550_irq_handler(irq_t *irq, void *arg, ...)
220
void ns16550_irq_handler(irq_t *irq, void *arg, ...)
219
{
221
{
220
    panic("Not yet implemented, ns16550 works in polled mode.\n");
222
    panic("Not yet implemented, ns16550 works in polled mode.\n");
221
}
223
}
222
 
224
 
223
/** @}
225
/** @}
224
 */
226
 */
225
 
227