Subversion Repositories HelenOS

Rev

Rev 3097 | Rev 3844 | 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
 
3097 decky 68
/**< Kernel log spinlock */
69
SPINLOCK_INITIALIZE(klog_lock);
70
 
71
/** Physical memory area used for klog buffer */
72
static parea_t klog_parea;
73
 
74
/*
75
 * For now, we use 0 as INR.
76
 * However, it is therefore desirable to have architecture specific
77
 * definition of KLOG_VIRT_INR in the future.
78
 */
79
#define KLOG_VIRT_INR   0
80
 
81
static irq_t klog_irq;
82
 
1050 palkovsky 83
static chardev_operations_t null_stdout_ops = {
3065 decky 84
    .suspend = NULL,
85
    .resume = NULL,
86
    .write = NULL,
87
    .read = NULL
1050 palkovsky 88
};
2697 decky 89
 
1050 palkovsky 90
chardev_t null_stdout = {
91
    .name = "null",
92
    .op = &null_stdout_ops
93
};
94
 
3097 decky 95
/** Allways refuse IRQ ownership.
96
 *
97
 * This is not a real IRQ, so we always decline.
98
 *
99
 * @return Always returns IRQ_DECLINE.
100
 */
101
static irq_ownership_t klog_claim(void)
102
{
103
    return IRQ_DECLINE;
104
}
105
 
106
/** Standard input character device */
510 jermar 107
chardev_t *stdin = NULL;
1050 palkovsky 108
chardev_t *stdout = &null_stdout;
510 jermar 109
 
3097 decky 110
/** Initialize kernel logging facility
111
 *
112
 * The shared area contains kernel cyclic buffer. Userspace application may
113
 * be notified on new data with indication of position and size
114
 * of the data within the circular buffer.
115
 */
116
void klog_init(void)
117
{
118
    void *faddr = (void *) KA2PA(klog);
119
 
120
    ASSERT((uintptr_t) faddr % FRAME_SIZE == 0);
121
    ASSERT(KLOG_SIZE % FRAME_SIZE == 0);
122
 
123
    devno_t devno = device_assign_devno();
124
 
125
    klog_parea.pbase = (uintptr_t) faddr;
126
    klog_parea.vbase = (uintptr_t) klog;
127
    klog_parea.frames = SIZE2FRAMES(KLOG_SIZE);
128
    klog_parea.cacheable = true;
129
    ddi_parea_register(&klog_parea);
130
 
131
    sysinfo_set_item_val("klog.faddr", NULL, (unative_t) faddr);
132
    sysinfo_set_item_val("klog.pages", NULL, SIZE2FRAMES(KLOG_SIZE));
133
    sysinfo_set_item_val("klog.devno", NULL, devno);
134
    sysinfo_set_item_val("klog.inr", NULL, KLOG_VIRT_INR);
135
 
136
    irq_initialize(&klog_irq);
137
    klog_irq.devno = devno;
138
    klog_irq.inr = KLOG_VIRT_INR;
139
    klog_irq.claim = klog_claim;
140
    irq_register(&klog_irq);
141
 
142
    spinlock_lock(&klog_lock);
143
    klog_inited = true;
144
    spinlock_unlock(&klog_lock);
145
}
146
 
601 palkovsky 147
/** Get character from character device. Do not echo character.
588 palkovsky 148
 *
149
 * @param chardev Character device.
150
 *
151
 * @return Character read.
152
 */
1780 jermar 153
uint8_t _getc(chardev_t *chardev)
588 palkovsky 154
{
1780 jermar 155
    uint8_t ch;
588 palkovsky 156
    ipl_t ipl;
157
 
631 palkovsky 158
    if (atomic_get(&haltstate)) {
607 palkovsky 159
        /* If we are here, we are hopefully on the processor, that
160
         * issued the 'halt' command, so proceed to read the character
161
         * directly from input
162
         */
163
        if (chardev->op->read)
164
            return chardev->op->read(chardev);
165
        /* no other way of interacting with user, halt */
631 palkovsky 166
        if (CPU)
3065 decky 167
            printf("cpu%u: ", CPU->id);
631 palkovsky 168
        else
169
            printf("cpu: ");
170
        printf("halted - no kconsole\n");
607 palkovsky 171
        cpu_halt();
172
    }
173
 
588 palkovsky 174
    waitq_sleep(&chardev->wq);
175
    ipl = interrupts_disable();
176
    spinlock_lock(&chardev->lock);
177
    ch = chardev->buffer[(chardev->index - chardev->counter) % CHARDEV_BUFLEN];
178
    chardev->counter--;
179
    spinlock_unlock(&chardev->lock);
180
    interrupts_restore(ipl);
181
 
182
    chardev->op->resume(chardev);
183
 
184
    return ch;
185
}
186
 
510 jermar 187
/** Get string from character device.
188
 *
189
 * Read characters from character device until first occurrence
190
 * of newline character.
191
 *
192
 * @param chardev Character device.
517 jermar 193
 * @param buf Buffer where to store string terminated by '\0'.
1708 jermar 194
 * @param buflen Size of the buffer.
517 jermar 195
 *
196
 * @return Number of characters read.
510 jermar 197
 */
517 jermar 198
count_t gets(chardev_t *chardev, char *buf, size_t buflen)
510 jermar 199
{
200
    index_t index = 0;
201
    char ch;
202
 
203
    while (index < buflen) {
588 palkovsky 204
        ch = _getc(chardev);
205
        if (ch == '\b') {
206
            if (index > 0) {
207
                index--;
208
                /* Space backspace, space */
209
                putchar('\b');
210
                putchar(' ');
211
                putchar('\b');
212
            }
213
            continue;
214
        }
215
        putchar(ch);
216
 
510 jermar 217
        if (ch == '\n') { /* end of string => write 0, return */
517 jermar 218
            buf[index] = '\0';
219
            return (count_t) index;
510 jermar 220
        }
517 jermar 221
        buf[index++] = ch;
510 jermar 222
    }
517 jermar 223
    return (count_t) index;
510 jermar 224
}
225
 
588 palkovsky 226
/** Get character from device & echo it to screen */
1780 jermar 227
uint8_t getc(chardev_t *chardev)
510 jermar 228
{
1780 jermar 229
    uint8_t ch;
510 jermar 230
 
588 palkovsky 231
    ch = _getc(chardev);
232
    putchar(ch);
510 jermar 233
    return ch;
234
}
575 palkovsky 235
 
3097 decky 236
void klog_update(void)
237
{
238
    spinlock_lock(&klog_lock);
239
 
240
    if ((klog_inited) && (klog_irq.notif_cfg.notify) && (klog_uspace > 0)) {
241
        ipc_irq_send_msg_3(&klog_irq, klog_start, klog_len, klog_uspace);
242
        klog_uspace = 0;
243
    }
244
 
245
    spinlock_unlock(&klog_lock);
246
}
247
 
575 palkovsky 248
void putchar(char c)
249
{
3097 decky 250
    spinlock_lock(&klog_lock);
251
 
3065 decky 252
    if ((klog_stored > 0) && (stdout->op->write)) {
253
        /* Print charaters stored in kernel log */
254
        index_t i;
255
        for (i = klog_len - klog_stored; i < klog_len; i++)
256
            stdout->op->write(stdout, klog[(klog_start + i) % KLOG_SIZE]);
257
        klog_stored = 0;
258
    }
259
 
260
    /* Store character in the cyclic kernel log */
261
    klog[(klog_start + klog_len) % KLOG_SIZE] = c;
262
    if (klog_len < KLOG_SIZE)
263
        klog_len++;
264
    else
265
        klog_start = (klog_start + 1) % KLOG_SIZE;
266
 
607 palkovsky 267
    if (stdout->op->write)
268
        stdout->op->write(stdout, c);
3065 decky 269
    else {
270
        /* The character is just in the kernel log */
271
        if (klog_stored < klog_len)
272
            klog_stored++;
273
    }
3097 decky 274
 
275
    /* The character is stored for uspace */
276
    if (klog_uspace < klog_len)
277
        klog_uspace++;
278
 
3113 decky 279
    /* Check notify uspace to update */
280
    bool update;
281
    if ((klog_uspace > KLOG_LATENCY) || (c == '\n'))
282
        update = true;
283
    else
284
        update = false;
285
 
3097 decky 286
    spinlock_unlock(&klog_lock);
287
 
3113 decky 288
    if (update)
289
        klog_update();
575 palkovsky 290
}
1702 cejka 291
 
1888 jermar 292
/** @}
1702 cejka 293
 */