Subversion Repositories HelenOS

Rev

Rev 2131 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2001-2004 Jakub Jermar
1 jermar 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
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
15
 *   derived from this software without specific prior written permission.
16
 *
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
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1754 jermar 29
/** @addtogroup genarch
1702 cejka 30
 * @{
31
 */
1754 jermar 32
/**
1757 jermar 33
 * @file
1842 jermar 34
 * @brief   Zilog 8530 serial port / keyboard driver.
1702 cejka 35
 */
36
 
1842 jermar 37
#include <genarch/kbd/z8530.h>
1843 jermar 38
#include <genarch/kbd/key.h>
1842 jermar 39
#include <genarch/kbd/scanc.h>
40
#include <genarch/kbd/scanc_sun.h>
41
#include <arch/drivers/z8530.h>
1920 jermar 42
#include <ddi/irq.h>
1923 jermar 43
#include <ipc/irq.h>
1 jermar 44
#include <arch/interrupt.h>
1875 jermar 45
#include <arch/drivers/kbd.h>
1919 jermar 46
#include <arch/drivers/fhc.h>
1 jermar 47
#include <cpu.h>
48
#include <arch/asm.h>
49
#include <arch.h>
511 jermar 50
#include <console/chardev.h>
51
#include <console/console.h>
576 palkovsky 52
#include <interrupt.h>
1875 jermar 53
#include <sysinfo/sysinfo.h>
54
#include <print.h>
2456 hudecek 55
#include <synch/rcu.h>
1 jermar 56
 
670 vana 57
/*
1842 jermar 58
 * These codes read from z8530 data register are silently ignored.
895 jermar 59
 */
1842 jermar 60
#define IGNORE_CODE 0x7f        /* all keys up */
895 jermar 61
 
1921 jermar 62
static z8530_t z8530;       /**< z8530 device structure. */
63
static irq_t z8530_irq;     /**< z8530's IRQ. */
64
 
1842 jermar 65
static void z8530_suspend(chardev_t *);
66
static void z8530_resume(chardev_t *);
511 jermar 67
 
68
static chardev_operations_t ops = {
1842 jermar 69
    .suspend = z8530_suspend,
70
    .resume = z8530_resume,
1896 jermar 71
    .read = z8530_key_read
511 jermar 72
};
73
 
1923 jermar 74
/** Initialize keyboard and service interrupts using kernel routine. */
1842 jermar 75
void z8530_grab(void)
1 jermar 76
{
1944 jermar 77
    ipl_t ipl = interrupts_disable();
78
 
1925 jermar 79
    (void) z8530_read_a(&z8530, RR8);
80
 
81
    /*
82
     * Clear any pending TX interrupts or we never manage
83
     * to set FHC UART interrupt state to idle.
84
     */
85
    z8530_write_a(&z8530, WR0, WR0_TX_IP_RST);
86
 
87
    z8530_write_a(&z8530, WR1, WR1_IARCSC);     /* interrupt on all characters */
88
 
89
    /* 8 bits per character and enable receiver */
90
    z8530_write_a(&z8530, WR3, WR3_RX8BITSCH | WR3_RX_ENABLE);
91
 
92
    z8530_write_a(&z8530, WR9, WR9_MIE);        /* Master Interrupt Enable. */
93
 
2456 hudecek 94
    //rcu_read_lock() is not needed, ints are disabled
95
    //rcu: atomic update doesn't need reallocation
96
    rcu_dereference_pointer(z8530_irq.notif_cfg).notify = false;
1944 jermar 97
    interrupts_restore(ipl);
1474 palkovsky 98
}
1849 jermar 99
 
1923 jermar 100
/** Resume the former IPC notification behavior. */
1842 jermar 101
void z8530_release(void)
1474 palkovsky 102
{
1944 jermar 103
    ipl_t ipl = interrupts_disable();
2456 hudecek 104
    //rcu: atomic update doesn't need reallocation
1944 jermar 105
    spinlock_lock(&z8530_irq.lock);
2456 hudecek 106
    if (rcu_dereference_pointer(z8530_irq.notif_cfg).answerbox)
107
        rcu_dereference_pointer(z8530_irq.notif_cfg).notify = true;
1944 jermar 108
    spinlock_unlock(&z8530_irq.lock);
109
    interrupts_restore(ipl);
1474 palkovsky 110
}
670 vana 111
 
1842 jermar 112
/** Initialize z8530. */
1921 jermar 113
void z8530_init(devno_t devno, inr_t inr, uintptr_t vaddr)
1474 palkovsky 114
{
1842 jermar 115
    chardev_initialize("z8530_kbd", &kbrd, &ops);
511 jermar 116
    stdin = &kbrd;
1195 jermar 117
 
1921 jermar 118
    z8530.devno = devno;
119
    z8530.reg = (uint8_t *) vaddr;
120
 
121
    irq_initialize(&z8530_irq);
122
    z8530_irq.devno = devno;
123
    z8530_irq.inr = inr;
124
    z8530_irq.claim = z8530_claim;
125
    z8530_irq.handler = z8530_irq_handler;
126
    irq_register(&z8530_irq);
127
 
1875 jermar 128
    sysinfo_set_item_val("kbd", NULL, true);
1931 jermar 129
    sysinfo_set_item_val("kbd.type", NULL, KBD_Z8530);
1921 jermar 130
    sysinfo_set_item_val("kbd.devno", NULL, devno);
131
    sysinfo_set_item_val("kbd.inr", NULL, inr);
132
    sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);
1875 jermar 133
 
1925 jermar 134
    z8530_grab();
1 jermar 135
}
136
 
1842 jermar 137
/** Process z8530 interrupt.
508 jermar 138
 *
139
 * @param n Interrupt vector.
1708 jermar 140
 * @param istate Interrupted state.
508 jermar 141
 */
1849 jermar 142
void z8530_interrupt(void)
1 jermar 143
{
1849 jermar 144
    z8530_poll();
1 jermar 145
}
508 jermar 146
 
511 jermar 147
/* Called from getc(). */
1842 jermar 148
void z8530_resume(chardev_t *d)
511 jermar 149
{
150
}
151
 
152
/* Called from getc(). */
1842 jermar 153
void z8530_suspend(chardev_t *d)
511 jermar 154
{
155
}
878 vana 156
 
1896 jermar 157
char z8530_key_read(chardev_t *d)
878 vana 158
{
159
    char ch;   
160
 
894 jermar 161
    while(!(ch = active_read_buff_read())) {
1780 jermar 162
        uint8_t x;
1921 jermar 163
        while (!(z8530_read_a(&z8530, RR0) & RR0_RCA))
894 jermar 164
            ;
1921 jermar 165
        x = z8530_read_a(&z8530, RR8);
895 jermar 166
        if (x != IGNORE_CODE) {
167
            if (x & KEY_RELEASE)
168
                key_released(x ^ KEY_RELEASE);
169
            else
170
                active_read_key_pressed(x);
171
        }
878 vana 172
    }
173
    return ch;
174
}
895 jermar 175
 
176
/** Poll for key press and release events.
177
 *
178
 * This function can be used to implement keyboard polling.
179
 */
1842 jermar 180
void z8530_poll(void)
895 jermar 181
{
1780 jermar 182
    uint8_t x;
895 jermar 183
 
1921 jermar 184
    while (z8530_read_a(&z8530, RR0) & RR0_RCA) {
185
        x = z8530_read_a(&z8530, RR8);
895 jermar 186
        if (x != IGNORE_CODE) {
187
            if (x & KEY_RELEASE)
188
                key_released(x ^ KEY_RELEASE);
189
            else
190
                key_pressed(x);
191
        }
192
    }
193
}
1702 cejka 194
 
1919 jermar 195
irq_ownership_t z8530_claim(void)
196
{
1921 jermar 197
    return (z8530_read_a(&z8530, RR0) & RR0_RCA);
1919 jermar 198
}
199
 
200
void z8530_irq_handler(irq_t *irq, void *arg, ...)
201
{
202
    /*
203
     * So far, we know we got this interrupt through the FHC.
1923 jermar 204
     * Since we don't have enough documentation about the FHC
205
     * and because the interrupt looks like level sensitive,
1919 jermar 206
     * we cannot handle it by scheduling one of the level
207
     * interrupt traps. Process the interrupt directly.
208
     */
2456 hudecek 209
    if (rcu_dereference_pointer(irq->notif_cfg).notify && rcu_dereference_pointer(irq->notif_cfg).answerbox)
1923 jermar 210
        ipc_irq_send_notif(irq);
211
    else
1919 jermar 212
        z8530_interrupt();
213
    fhc_clear_interrupt(central_fhc, irq->inr);
214
}
215
 
1754 jermar 216
/** @}
1702 cejka 217
 */