Subversion Repositories HelenOS

Rev

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

Rev 3588 Rev 3674
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
#ifndef ia64
-
 
42
#include <arch/drivers/kbd.h>
41
#include <arch/drivers/kbd.h>
-
 
42
#ifndef ia64
43
#include <arch/drivers/ns16550.h>
43
#include <arch/drivers/ns16550.h>
44
#endif
44
#endif
45
#include <ddi/irq.h>
45
#include <ddi/irq.h>
46
#include <ipc/irq.h>
46
#include <ipc/irq.h>
47
#include <cpu.h>
47
#include <cpu.h>
48
#include <arch/asm.h>
48
#include <arch/asm.h>
49
#include <arch.h>
49
#include <arch.h>
50
#include <console/chardev.h>
50
#include <console/chardev.h>
51
#include <console/console.h>
51
#include <console/console.h>
52
#include <interrupt.h>
52
#include <interrupt.h>
53
#include <arch/interrupt.h>
53
#include <arch/interrupt.h>
54
#include <sysinfo/sysinfo.h>
54
#include <sysinfo/sysinfo.h>
55
#include <synch/spinlock.h>
55
#include <synch/spinlock.h>
56
 
56
 
57
#define LSR_DATA_READY  0x01
57
#define LSR_DATA_READY  0x01
58
 
58
 
59
/** Structure representing the ns16550. */
59
/** Structure representing the ns16550. */
60
static ns16550_t ns16550;
60
static ns16550_t ns16550;
61
 
61
 
62
/** Structure for ns16550's IRQ. */
62
/** Structure for ns16550's IRQ. */
63
static irq_t ns16550_irq;
63
static irq_t ns16550_irq;
64
 
64
 
65
/*
65
/*
66
 * These codes read from ns16550 data register are silently ignored.
66
 * These codes read from ns16550 data register are silently ignored.
67
 */
67
 */
68
#define IGNORE_CODE 0x7f        /* all keys up */
68
#define IGNORE_CODE 0x7f        /* all keys up */
69
 
69
 
70
static void ns16550_suspend(chardev_t *);
70
static void ns16550_suspend(chardev_t *);
71
static void ns16550_resume(chardev_t *);
71
static void ns16550_resume(chardev_t *);
72
 
72
 
73
static chardev_operations_t ops = {
73
static chardev_operations_t ops = {
74
    .suspend = ns16550_suspend,
74
    .suspend = ns16550_suspend,
75
    .resume = ns16550_resume,
75
    .resume = ns16550_resume,
76
    .read = ns16550_key_read
76
    .read = ns16550_key_read
77
};
77
};
78
 
78
 
79
void ns16550_interrupt(void);
79
void ns16550_interrupt(void);
80
 
80
 
81
/** Initialize keyboard and service interrupts using kernel routine */
81
/** Initialize keyboard and service interrupts using kernel routine */
82
void ns16550_grab(void)
82
void ns16550_grab(void)
83
{
83
{
84
    ipl_t ipl = interrupts_disable();
84
    ipl_t ipl = interrupts_disable();
85
 
85
 
86
    ns16550_ier_write(&ns16550, IER_ERBFI);     /* enable receiver interrupt */
86
    ns16550_ier_write(&ns16550, IER_ERBFI);     /* enable receiver interrupt */
87
   
87
   
88
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
88
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
89
        (void) ns16550_rbr_read(&ns16550);
89
        (void) ns16550_rbr_read(&ns16550);
90
 
90
 
91
    spinlock_lock(&ns16550_irq.lock);
91
    spinlock_lock(&ns16550_irq.lock);
92
    ns16550_irq.notif_cfg.notify = false;
92
    ns16550_irq.notif_cfg.notify = false;
93
    spinlock_unlock(&ns16550_irq.lock);
93
    spinlock_unlock(&ns16550_irq.lock);
94
    interrupts_restore(ipl);
94
    interrupts_restore(ipl);
95
}
95
}
96
 
96
 
97
/** Resume the former interrupt vector */
97
/** Resume the former interrupt vector */
98
void ns16550_release(void)
98
void ns16550_release(void)
99
{
99
{
100
    ipl_t ipl = interrupts_disable();
100
    ipl_t ipl = interrupts_disable();
101
    spinlock_lock(&ns16550_irq.lock);
101
    spinlock_lock(&ns16550_irq.lock);
102
    if (ns16550_irq.notif_cfg.answerbox)
102
    if (ns16550_irq.notif_cfg.answerbox)
103
        ns16550_irq.notif_cfg.notify = true;
103
        ns16550_irq.notif_cfg.notify = true;
104
    spinlock_unlock(&ns16550_irq.lock);
104
    spinlock_unlock(&ns16550_irq.lock);
105
    interrupts_restore(ipl);
105
    interrupts_restore(ipl);
106
}
106
}
107
 
107
 
108
/** Initialize ns16550.
108
/** Initialize ns16550.
109
 *
109
 *
110
 * @param devno Device number.
110
 * @param devno     Device number.
-
 
111
 * @param port      Virtual/IO address of device's registers.
111
 * @param inr Interrupt number.
112
 * @param inr       Interrupt number.
-
 
113
 * @param cir       Clear interrupt function.
112
 * @param vaddr Virtual address of device's registers.
114
 * @param cir_arg   First argument to cir.
113
 */
115
 */
-
 
116
void
114
void ns16550_init(devno_t devno, inr_t inr, ioport_t port)
117
ns16550_init(devno_t devno, ioport_t port, inr_t inr, cir_t cir, void *cir_arg)
115
{
118
{
116
    chardev_initialize("ns16550_kbd", &kbrd, &ops);
119
    chardev_initialize("ns16550_kbd", &kbrd, &ops);
117
    stdin = &kbrd;
120
    stdin = &kbrd;
118
   
121
   
119
    ns16550.devno = devno;
122
    ns16550.devno = devno;
120
    ns16550.io_port = port;
123
    ns16550.io_port = port;
121
   
124
   
122
    irq_initialize(&ns16550_irq);
125
    irq_initialize(&ns16550_irq);
123
    ns16550_irq.devno = devno;
126
    ns16550_irq.devno = devno;
124
    ns16550_irq.inr = inr;
127
    ns16550_irq.inr = inr;
125
    ns16550_irq.claim = ns16550_claim;
128
    ns16550_irq.claim = ns16550_claim;
126
    ns16550_irq.handler = ns16550_irq_handler;
129
    ns16550_irq.handler = ns16550_irq_handler;
-
 
130
    ns16550_irq.cir = cir;
-
 
131
    ns16550_irq.cir_arg = cir_arg;
127
    irq_register(&ns16550_irq);
132
    irq_register(&ns16550_irq);
-
 
133
 
-
 
134
 
-
 
135
    while ((ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
-
 
136
        ns16550_rbr_read(&ns16550);
-
 
137
 
128
   
138
   
129
    sysinfo_set_item_val("kbd", NULL, true);
139
    sysinfo_set_item_val("kbd", NULL, true);
130
#ifndef ia64
-
 
131
    sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
140
    sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
132
#endif
-
 
133
    sysinfo_set_item_val("kbd.devno", NULL, devno);
141
    sysinfo_set_item_val("kbd.devno", NULL, devno);
134
    sysinfo_set_item_val("kbd.inr", NULL, inr);
142
    sysinfo_set_item_val("kbd.inr", NULL, inr);
135
    sysinfo_set_item_val("kbd.address.virtual", NULL, port);
143
    sysinfo_set_item_val("kbd.address.virtual", NULL, port);
-
 
144
    sysinfo_set_item_val("kbd.port", NULL, port);
-
 
145
 
-
 
146
#ifdef CONFIG_NS16550_INTERRUPT_DRIVEN
-
 
147
    /* Enable interrupts */
-
 
148
        ns16550_ier_write(&ns16550, IER_ERBFI);
-
 
149
    ns16550_mcr_write(&ns16550, MCR_OUT2);
-
 
150
#endif
136
 
151
 
137
#ifdef ia64
152
#ifdef ia64
138
        uint8_t c;
153
        uint8_t c;
-
 
154
        // This switches rbr & ier to mode when accept baudrate constant
139
        c = ns16550_lcr_read(&ns16550);
155
        c = ns16550_lcr_read(&ns16550);
140
        ns16550_lcr_write(&ns16550, 0x80 | c);
156
        ns16550_lcr_write(&ns16550, 0x80 | c);
141
        ns16550_rbr_write(&ns16550, 0x0c);
157
        ns16550_rbr_write(&ns16550, 0x0c);
142
        ns16550_ier_write(&ns16550, 0x00);
158
        ns16550_ier_write(&ns16550, 0x00);
143
        ns16550_lcr_write(&ns16550, c);
159
        ns16550_lcr_write(&ns16550, c);
144
#endif
160
#endif
145
   
161
   
146
    ns16550_grab();
162
    ns16550_grab();
147
}
163
}
148
 
164
 
149
/** Process ns16550 interrupt. */
165
/** Process ns16550 interrupt. */
150
void ns16550_interrupt(void)
166
void ns16550_interrupt(void)
151
{
167
{
152
    /* TODO
-
 
153
     *
-
 
154
     * ns16550 works in the polled mode so far.
168
    ns16550_poll();
155
     */
-
 
156
}
169
}
157
 
170
 
158
/* Called from getc(). */
171
/* Called from getc(). */
159
void ns16550_resume(chardev_t *d)
172
void ns16550_resume(chardev_t *d)
160
{
173
{
161
}
174
}
162
 
175
 
163
/* Called from getc(). */
176
/* Called from getc(). */
164
void ns16550_suspend(chardev_t *d)
177
void ns16550_suspend(chardev_t *d)
165
{
178
{
166
}
179
}
167
 
180
 
168
 
181
 
169
char ns16550_key_read(chardev_t *d)
182
char ns16550_key_read(chardev_t *d)
170
{
183
{
171
    char ch;   
184
    char ch;   
172
 
185
 
173
    while(!(ch = active_read_buff_read())) {
186
    while(!(ch = active_read_buff_read())) {
174
        uint8_t x;
187
        uint8_t x;
175
        while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
188
        while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
176
            ;
189
            ;
177
        x = ns16550_rbr_read(&ns16550);
190
        x = ns16550_rbr_read(&ns16550);
178
#ifndef ia64
191
#ifndef ia64
179
        if (x != IGNORE_CODE) {
192
        if (x != IGNORE_CODE) {
180
            if (x & KEY_RELEASE)
193
            if (x & KEY_RELEASE)
181
                key_released(x ^ KEY_RELEASE);
194
                key_released(x ^ KEY_RELEASE);
182
            else
195
            else
183
                active_read_key_pressed(x);
196
                active_read_key_pressed(x);
184
        }
197
        }
185
#else
198
#else
186
        extern chardev_t kbrd;
199
        extern chardev_t kbrd;
187
        if(x != 0x0d) {
200
        if(x != 0x0d) {
188
            if(x == 0x7f)
201
            if(x == 0x7f)
189
                x = '\b';
202
                x = '\b';
190
             chardev_push_character(&kbrd, x);
203
             chardev_push_character(&kbrd, x);
191
        }    
204
        }    
192
#endif      
205
#endif      
193
 
206
 
194
    }
207
    }
195
    return ch;
208
    return ch;
196
}
209
}
197
 
210
 
198
/** Poll for key press and release events.
211
/** Poll for key press and release events.
199
 *
212
 *
200
 * This function can be used to implement keyboard polling.
213
 * This function can be used to implement keyboard polling.
201
 */
214
 */
202
void ns16550_poll(void)
215
void ns16550_poll(void)
203
{
216
{
-
 
217
#ifndef CONFIG_NS16550_INTERRUPT_DRIVEN 
204
    ipl_t ipl;
218
    ipl_t ipl;
205
 
219
 
206
    ipl = interrupts_disable();
220
    ipl = interrupts_disable();
207
    spinlock_lock(&ns16550_irq.lock);
221
    spinlock_lock(&ns16550_irq.lock);
208
 
222
 
209
    if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
223
    if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
210
        if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {
224
        if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {
211
            /*
225
            /*
212
             * Send IPC notification.
226
             * Send IPC notification.
213
             */
227
             */
214
            ipc_irq_send_notif(&ns16550_irq);
228
            ipc_irq_send_notif(&ns16550_irq);
215
            spinlock_unlock(&ns16550_irq.lock);
229
            spinlock_unlock(&ns16550_irq.lock);
216
            interrupts_restore(ipl);
230
            interrupts_restore(ipl);
217
            return;
231
            return;
218
        }
232
        }
219
    }
233
    }
220
 
234
 
221
    spinlock_unlock(&ns16550_irq.lock);
235
    spinlock_unlock(&ns16550_irq.lock);
222
    interrupts_restore(ipl);
236
    interrupts_restore(ipl);
-
 
237
#endif
223
 
238
 
224
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
239
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
225
        uint8_t x;
240
        uint8_t x;
226
       
241
       
227
        x = ns16550_rbr_read(&ns16550);
242
        x = ns16550_rbr_read(&ns16550);
228
#ifndef ia64
243
#ifndef ia64
229
        if (x != IGNORE_CODE) {
244
        if (x != IGNORE_CODE) {
230
            if (x & KEY_RELEASE)
245
            if (x & KEY_RELEASE)
231
                key_released(x ^ KEY_RELEASE);
246
                key_released(x ^ KEY_RELEASE);
232
            else
247
            else
233
                key_pressed(x);
248
                key_pressed(x);
234
        }
249
        }
235
#else
250
#else
236
        extern chardev_t kbrd;
251
        extern chardev_t kbrd;
237
        if(x != 0x0d) {
252
        if(x != 0x0d) {
238
            if (x == 0x7f)
253
            if (x == 0x7f)
239
                x = '\b';
254
                x = '\b';
240
            chardev_push_character(&kbrd, x);
255
            chardev_push_character(&kbrd, x);
241
        }    
256
        }    
242
#endif      
257
#endif      
243
 
258
 
244
    }
259
    }
245
}
260
}
246
 
261
 
247
irq_ownership_t ns16550_claim(void)
262
irq_ownership_t ns16550_claim(void)
248
{
263
{
249
    return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
264
    return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
250
}
265
}
251
 
266
 
252
void ns16550_irq_handler(irq_t *irq, void *arg, ...)
267
void ns16550_irq_handler(irq_t *irq, void *arg, ...)
253
{
268
{
254
    panic("Not yet implemented, ns16550 works in polled mode.\n");
269
    if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
-
 
270
        ipc_irq_send_notif(irq);
-
 
271
    else
-
 
272
        ns16550_interrupt();
255
}
273
}
256
 
274
 
257
/** @}
275
/** @}
258
 */
276
 */
259
 
277