Subversion Repositories HelenOS

Rev

Rev 3941 | Rev 3965 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
510 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2003 Josef Cejka
3
 * Copyright (c) 2005 Jakub Jermar
510 jermar 4
 * All rights reserved.
5
 *
6
 * Redistribution and use in source and binary forms, with or without
7
 * modification, are permitted provided that the following conditions
8
 * are met:
9
 *
10
 * - Redistributions of source code must retain the above copyright
11
 *   notice, this list of conditions and the following disclaimer.
12
 * - Redistributions in binary form must reproduce the above copyright
13
 *   notice, this list of conditions and the following disclaimer in the
14
 *   documentation and/or other materials provided with the distribution.
15
 * - The name of the author may not be used to endorse or promote products
16
 *   derived from this software without specific prior written permission.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
 */
29
 
1888 jermar 30
/** @addtogroup genericconsole
1702 cejka 31
 * @{
32
 */
33
/** @file
34
 */
35
 
510 jermar 36
#include <console/console.h>
37
#include <console/chardev.h>
3097 decky 38
#include <sysinfo/sysinfo.h>
510 jermar 39
#include <synch/waitq.h>
40
#include <synch/spinlock.h>
41
#include <arch/types.h>
3097 decky 42
#include <ddi/device.h>
43
#include <ddi/irq.h>
44
#include <ddi/ddi.h>
45
#include <ipc/irq.h>
510 jermar 46
#include <arch.h>
607 palkovsky 47
#include <func.h>
48
#include <print.h>
1104 jermar 49
#include <atomic.h>
510 jermar 50
 
3097 decky 51
#define KLOG_SIZE PAGE_SIZE
3113 decky 52
#define KLOG_LATENCY 8
1050 palkovsky 53
 
3065 decky 54
/**< Kernel log cyclic buffer */
3097 decky 55
static char klog[KLOG_SIZE] __attribute__ ((aligned (PAGE_SIZE)));
3065 decky 56
 
3097 decky 57
/**< Kernel log initialized */
58
static bool klog_inited = false;
3065 decky 59
/**< First kernel log characters */
60
static index_t klog_start = 0;
61
/**< Number of valid kernel log characters */
62
static size_t klog_len = 0;
63
/**< Number of stored (not printed) kernel log characters */
64
static size_t klog_stored = 0;
3097 decky 65
/**< Number of stored kernel log characters for uspace */
66
static size_t klog_uspace = 0;
3065 decky 67
 
3964 decky 68
/**< Silence output */
69
bool silent = false;
3844 decky 70
 
3097 decky 71
/**< Kernel log spinlock */
72
SPINLOCK_INITIALIZE(klog_lock);
73
 
74
/** Physical memory area used for klog buffer */
75
static parea_t klog_parea;
3844 decky 76
 
3097 decky 77
/*
78
 * For now, we use 0 as INR.
79
 * However, it is therefore desirable to have architecture specific
80
 * definition of KLOG_VIRT_INR in the future.
81
 */
82
#define KLOG_VIRT_INR   0
83
 
84
static irq_t klog_irq;
85
 
1050 palkovsky 86
static chardev_operations_t null_stdout_ops = {
3065 decky 87
    .suspend = NULL,
88
    .resume = NULL,
89
    .write = NULL,
90
    .read = NULL
1050 palkovsky 91
};
2697 decky 92
 
1050 palkovsky 93
chardev_t null_stdout = {
94
    .name = "null",
95
    .op = &null_stdout_ops
96
};
97
 
3097 decky 98
/** Allways refuse IRQ ownership.
99
 *
100
 * This is not a real IRQ, so we always decline.
101
 *
102
 * @return Always returns IRQ_DECLINE.
103
 */
3941 jermar 104
static irq_ownership_t klog_claim(irq_t *irq)
3097 decky 105
{
106
    return IRQ_DECLINE;
107
}
108
 
109
/** Standard input character device */
510 jermar 110
chardev_t *stdin = NULL;
1050 palkovsky 111
chardev_t *stdout = &null_stdout;
510 jermar 112
 
3097 decky 113
/** Initialize kernel logging facility
114
 *
115
 * The shared area contains kernel cyclic buffer. Userspace application may
116
 * be notified on new data with indication of position and size
117
 * of the data within the circular buffer.
118
 */
119
void klog_init(void)
120
{
121
    void *faddr = (void *) KA2PA(klog);
122
 
123
    ASSERT((uintptr_t) faddr % FRAME_SIZE == 0);
124
    ASSERT(KLOG_SIZE % FRAME_SIZE == 0);
125
 
126
    devno_t devno = device_assign_devno();
127
 
128
    klog_parea.pbase = (uintptr_t) faddr;
129
    klog_parea.frames = SIZE2FRAMES(KLOG_SIZE);
130
    ddi_parea_register(&klog_parea);
131
 
132
    sysinfo_set_item_val("klog.faddr", NULL, (unative_t) faddr);
133
    sysinfo_set_item_val("klog.pages", NULL, SIZE2FRAMES(KLOG_SIZE));
134
    sysinfo_set_item_val("klog.devno", NULL, devno);
135
    sysinfo_set_item_val("klog.inr", NULL, KLOG_VIRT_INR);
136
 
137
    irq_initialize(&klog_irq);
138
    klog_irq.devno = devno;
139
    klog_irq.inr = KLOG_VIRT_INR;
140
    klog_irq.claim = klog_claim;
141
    irq_register(&klog_irq);
142
 
143
    spinlock_lock(&klog_lock);
144
    klog_inited = true;
145
    spinlock_unlock(&klog_lock);
146
}
147
 
3844 decky 148
void grab_console(void)
149
{
150
    silent = false;
151
    arch_grab_console();
152
}
153
 
154
void release_console(void)
155
{
156
    silent = true;
157
    arch_release_console();
158
}
159
 
601 palkovsky 160
/** Get character from character device. Do not echo character.
588 palkovsky 161
 *
162
 * @param chardev Character device.
163
 *
164
 * @return Character read.
165
 */
1780 jermar 166
uint8_t _getc(chardev_t *chardev)
588 palkovsky 167
{
1780 jermar 168
    uint8_t ch;
588 palkovsky 169
    ipl_t ipl;
170
 
631 palkovsky 171
    if (atomic_get(&haltstate)) {
607 palkovsky 172
        /* If we are here, we are hopefully on the processor, that
173
         * issued the 'halt' command, so proceed to read the character
174
         * directly from input
175
         */
176
        if (chardev->op->read)
177
            return chardev->op->read(chardev);
178
        /* no other way of interacting with user, halt */
631 palkovsky 179
        if (CPU)
3065 decky 180
            printf("cpu%u: ", CPU->id);
631 palkovsky 181
        else
182
            printf("cpu: ");
3707 decky 183
        printf("halted (no kconsole)\n");
607 palkovsky 184
        cpu_halt();
185
    }
186
 
588 palkovsky 187
    waitq_sleep(&chardev->wq);
188
    ipl = interrupts_disable();
189
    spinlock_lock(&chardev->lock);
190
    ch = chardev->buffer[(chardev->index - chardev->counter) % CHARDEV_BUFLEN];
191
    chardev->counter--;
192
    spinlock_unlock(&chardev->lock);
193
    interrupts_restore(ipl);
194
 
195
    chardev->op->resume(chardev);
196
 
197
    return ch;
198
}
199
 
510 jermar 200
/** Get string from character device.
201
 *
202
 * Read characters from character device until first occurrence
203
 * of newline character.
204
 *
205
 * @param chardev Character device.
517 jermar 206
 * @param buf Buffer where to store string terminated by '\0'.
1708 jermar 207
 * @param buflen Size of the buffer.
517 jermar 208
 *
209
 * @return Number of characters read.
510 jermar 210
 */
517 jermar 211
count_t gets(chardev_t *chardev, char *buf, size_t buflen)
510 jermar 212
{
213
    index_t index = 0;
214
    char ch;
3844 decky 215
 
510 jermar 216
    while (index < buflen) {
588 palkovsky 217
        ch = _getc(chardev);
218
        if (ch == '\b') {
219
            if (index > 0) {
220
                index--;
221
                /* Space backspace, space */
222
                putchar('\b');
223
                putchar(' ');
224
                putchar('\b');
225
            }
226
            continue;
227
        }
228
        putchar(ch);
3844 decky 229
 
510 jermar 230
        if (ch == '\n') { /* end of string => write 0, return */
517 jermar 231
            buf[index] = '\0';
232
            return (count_t) index;
510 jermar 233
        }
517 jermar 234
        buf[index++] = ch;
510 jermar 235
    }
517 jermar 236
    return (count_t) index;
510 jermar 237
}
238
 
588 palkovsky 239
/** Get character from device & echo it to screen */
1780 jermar 240
uint8_t getc(chardev_t *chardev)
510 jermar 241
{
1780 jermar 242
    uint8_t ch;
510 jermar 243
 
588 palkovsky 244
    ch = _getc(chardev);
245
    putchar(ch);
510 jermar 246
    return ch;
247
}
575 palkovsky 248
 
3097 decky 249
void klog_update(void)
250
{
251
    spinlock_lock(&klog_lock);
252
 
253
    if ((klog_inited) && (klog_irq.notif_cfg.notify) && (klog_uspace > 0)) {
254
        ipc_irq_send_msg_3(&klog_irq, klog_start, klog_len, klog_uspace);
255
        klog_uspace = 0;
256
    }
257
 
258
    spinlock_unlock(&klog_lock);
259
}
260
 
575 palkovsky 261
void putchar(char c)
262
{
3097 decky 263
    spinlock_lock(&klog_lock);
264
 
3065 decky 265
    if ((klog_stored > 0) && (stdout->op->write)) {
266
        /* Print charaters stored in kernel log */
267
        index_t i;
268
        for (i = klog_len - klog_stored; i < klog_len; i++)
3844 decky 269
            stdout->op->write(stdout, klog[(klog_start + i) % KLOG_SIZE], silent);
3065 decky 270
        klog_stored = 0;
271
    }
272
 
273
    /* Store character in the cyclic kernel log */
274
    klog[(klog_start + klog_len) % KLOG_SIZE] = c;
275
    if (klog_len < KLOG_SIZE)
276
        klog_len++;
277
    else
278
        klog_start = (klog_start + 1) % KLOG_SIZE;
279
 
607 palkovsky 280
    if (stdout->op->write)
3844 decky 281
        stdout->op->write(stdout, c, silent);
3065 decky 282
    else {
283
        /* The character is just in the kernel log */
284
        if (klog_stored < klog_len)
285
            klog_stored++;
286
    }
3097 decky 287
 
288
    /* The character is stored for uspace */
289
    if (klog_uspace < klog_len)
290
        klog_uspace++;
291
 
3113 decky 292
    /* Check notify uspace to update */
293
    bool update;
294
    if ((klog_uspace > KLOG_LATENCY) || (c == '\n'))
295
        update = true;
296
    else
297
        update = false;
298
 
3097 decky 299
    spinlock_unlock(&klog_lock);
300
 
3113 decky 301
    if (update)
302
        klog_update();
575 palkovsky 303
}
1702 cejka 304
 
1888 jermar 305
/** @}
1702 cejka 306
 */