Subversion Repositories HelenOS

Rev

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

Rev 2787 Rev 3424
1
/*
1
/*
2
 * Copyright (c) 2003 Josef Cejka
2
 * Copyright (c) 2003 Josef Cejka
3
 * Copyright (c) 2005 Jakub Jermar
3
 * Copyright (c) 2005 Jakub Jermar
4
 * All rights reserved.
4
 * All rights reserved.
5
 *
5
 *
6
 * Redistribution and use in source and binary forms, with or without
6
 * Redistribution and use in source and binary forms, with or without
7
 * modification, are permitted provided that the following conditions
7
 * modification, are permitted provided that the following conditions
8
 * are met:
8
 * are met:
9
 *
9
 *
10
 * - Redistributions of source code must retain the above copyright
10
 * - Redistributions of source code must retain the above copyright
11
 *   notice, this list of conditions and the following disclaimer.
11
 *   notice, this list of conditions and the following disclaimer.
12
 * - Redistributions in binary form must reproduce the above copyright
12
 * - Redistributions in binary form must reproduce the above copyright
13
 *   notice, this list of conditions and the following disclaimer in the
13
 *   notice, this list of conditions and the following disclaimer in the
14
 *   documentation and/or other materials provided with the distribution.
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
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.
16
 *   derived from this software without specific prior written permission.
17
 *
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
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
19
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
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
24
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
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
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.
27
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
 */
28
 */
29
 
29
 
30
/** @addtogroup genericconsole
30
/** @addtogroup genericconsole
31
 * @{
31
 * @{
32
 */
32
 */
33
/** @file
33
/** @file
34
 */
34
 */
35
 
35
 
36
#include <console/console.h>
36
#include <console/console.h>
37
#include <console/chardev.h>
37
#include <console/chardev.h>
-
 
38
#include <sysinfo/sysinfo.h>
38
#include <synch/waitq.h>
39
#include <synch/waitq.h>
39
#include <synch/spinlock.h>
40
#include <synch/spinlock.h>
40
#include <arch/types.h>
41
#include <arch/types.h>
-
 
42
#include <ddi/device.h>
-
 
43
#include <ddi/irq.h>
-
 
44
#include <ddi/ddi.h>
-
 
45
#include <ipc/irq.h>
41
#include <arch.h>
46
#include <arch.h>
42
#include <func.h>
47
#include <func.h>
43
#include <print.h>
48
#include <print.h>
44
#include <atomic.h>
49
#include <atomic.h>
45
 
50
 
-
 
51
#define KLOG_SIZE PAGE_SIZE
46
#define BUFLEN 2048
52
#define KLOG_LATENCY 8
-
 
53
 
-
 
54
/**< Kernel log cyclic buffer */
-
 
55
static char klog[KLOG_SIZE] __attribute__ ((aligned (PAGE_SIZE)));
-
 
56
 
-
 
57
/**< Kernel log initialized */
47
static char debug_buffer[BUFLEN];
58
static bool klog_inited = false;
-
 
59
/**< First kernel log characters */
-
 
60
static index_t klog_start = 0;
-
 
61
/**< Number of valid kernel log characters */
48
static size_t offset = 0;
62
static size_t klog_len = 0;
-
 
63
/**< Number of stored (not printed) kernel log characters */
-
 
64
static size_t klog_stored = 0;
49
/** Initialize stdout to something that does not print, but does not fail
65
/**< Number of stored kernel log characters for uspace */
-
 
66
static size_t klog_uspace = 0;
-
 
67
 
-
 
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
   
50
 *
74
/*
-
 
75
 * For now, we use 0 as INR.
51
 * Save data in some buffer so that it could be retrieved in the debugger
76
 * However, it is therefore desirable to have architecture specific
-
 
77
 * definition of KLOG_VIRT_INR in the future.
52
 */
78
 */
53
static void null_putchar(chardev_t *d, const char ch)
79
#define KLOG_VIRT_INR   0
54
{
80
 
55
    if (offset >= BUFLEN)
81
static irq_t klog_irq;
56
        offset = 0;
-
 
57
    debug_buffer[offset++] = ch;
-
 
58
}
-
 
59
 
82
 
60
static chardev_operations_t null_stdout_ops = {
83
static chardev_operations_t null_stdout_ops = {
-
 
84
    .suspend = NULL,
-
 
85
    .resume = NULL,
61
    .write = null_putchar
86
    .write = NULL,
-
 
87
    .read = NULL
62
};
88
};
63
 
89
 
64
chardev_t null_stdout = {
90
chardev_t null_stdout = {
65
    .name = "null",
91
    .name = "null",
66
    .op = &null_stdout_ops
92
    .op = &null_stdout_ops
67
};
93
};
68
 
94
 
-
 
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
 
69
/** Standard input character device. */
106
/** Standard input character device */
70
chardev_t *stdin = NULL;
107
chardev_t *stdin = NULL;
71
chardev_t *stdout = &null_stdout;
108
chardev_t *stdout = &null_stdout;
72
 
109
 
-
 
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
 
73
/** Get character from character device. Do not echo character.
147
/** Get character from character device. Do not echo character.
74
 *
148
 *
75
 * @param chardev Character device.
149
 * @param chardev Character device.
76
 *
150
 *
77
 * @return Character read.
151
 * @return Character read.
78
 */
152
 */
79
uint8_t _getc(chardev_t *chardev)
153
uint8_t _getc(chardev_t *chardev)
80
{
154
{
81
    uint8_t ch;
155
    uint8_t ch;
82
    ipl_t ipl;
156
    ipl_t ipl;
83
 
157
 
84
    if (atomic_get(&haltstate)) {
158
    if (atomic_get(&haltstate)) {
85
        /* If we are here, we are hopefully on the processor, that
159
        /* If we are here, we are hopefully on the processor, that
86
         * issued the 'halt' command, so proceed to read the character
160
         * issued the 'halt' command, so proceed to read the character
87
         * directly from input
161
         * directly from input
88
         */
162
         */
89
        if (chardev->op->read)
163
        if (chardev->op->read)
90
            return chardev->op->read(chardev);
164
            return chardev->op->read(chardev);
91
        /* no other way of interacting with user, halt */
165
        /* no other way of interacting with user, halt */
92
        if (CPU)
166
        if (CPU)
93
            printf("cpu%d: ", CPU->id);
167
            printf("cpu%u: ", CPU->id);
94
        else
168
        else
95
            printf("cpu: ");
169
            printf("cpu: ");
96
        printf("halted - no kconsole\n");
170
        printf("halted - no kconsole\n");
97
        cpu_halt();
171
        cpu_halt();
98
    }
172
    }
99
 
173
 
100
    waitq_sleep(&chardev->wq);
174
    waitq_sleep(&chardev->wq);
101
    ipl = interrupts_disable();
175
    ipl = interrupts_disable();
102
    spinlock_lock(&chardev->lock);
176
    spinlock_lock(&chardev->lock);
103
    ch = chardev->buffer[(chardev->index - chardev->counter) % CHARDEV_BUFLEN];
177
    ch = chardev->buffer[(chardev->index - chardev->counter) % CHARDEV_BUFLEN];
104
    chardev->counter--;
178
    chardev->counter--;
105
    spinlock_unlock(&chardev->lock);
179
    spinlock_unlock(&chardev->lock);
106
    interrupts_restore(ipl);
180
    interrupts_restore(ipl);
107
 
181
 
108
    chardev->op->resume(chardev);
182
    chardev->op->resume(chardev);
109
 
183
 
110
    return ch;
184
    return ch;
111
}
185
}
112
 
186
 
113
/** Get string from character device.
187
/** Get string from character device.
114
 *
188
 *
115
 * Read characters from character device until first occurrence
189
 * Read characters from character device until first occurrence
116
 * of newline character.
190
 * of newline character.
117
 *
191
 *
118
 * @param chardev Character device.
192
 * @param chardev Character device.
119
 * @param buf Buffer where to store string terminated by '\0'.
193
 * @param buf Buffer where to store string terminated by '\0'.
120
 * @param buflen Size of the buffer.
194
 * @param buflen Size of the buffer.
121
 *
195
 *
122
 * @return Number of characters read.
196
 * @return Number of characters read.
123
 */
197
 */
124
count_t gets(chardev_t *chardev, char *buf, size_t buflen)
198
count_t gets(chardev_t *chardev, char *buf, size_t buflen)
125
{
199
{
126
    index_t index = 0;
200
    index_t index = 0;
127
    char ch;
201
    char ch;
128
 
202
 
129
    while (index < buflen) {
203
    while (index < buflen) {
130
        ch = _getc(chardev);
204
        ch = _getc(chardev);
131
        if (ch == '\b') {
205
        if (ch == '\b') {
132
            if (index > 0) {
206
            if (index > 0) {
133
                index--;
207
                index--;
134
                /* Space backspace, space */
208
                /* Space backspace, space */
135
                putchar('\b');
209
                putchar('\b');
136
                putchar(' ');
210
                putchar(' ');
137
                putchar('\b');
211
                putchar('\b');
138
            }
212
            }
139
            continue;
213
            continue;
140
        }
214
        }
141
        putchar(ch);
215
        putchar(ch);
142
 
216
 
143
        if (ch == '\n') { /* end of string => write 0, return */
217
        if (ch == '\n') { /* end of string => write 0, return */
144
            buf[index] = '\0';
218
            buf[index] = '\0';
145
            return (count_t) index;
219
            return (count_t) index;
146
        }
220
        }
147
        buf[index++] = ch;
221
        buf[index++] = ch;
148
    }
222
    }
149
    return (count_t) index;
223
    return (count_t) index;
150
}
224
}
151
 
225
 
152
/** Get character from device & echo it to screen */
226
/** Get character from device & echo it to screen */
153
uint8_t getc(chardev_t *chardev)
227
uint8_t getc(chardev_t *chardev)
154
{
228
{
155
    uint8_t ch;
229
    uint8_t ch;
156
 
230
 
157
    ch = _getc(chardev);
231
    ch = _getc(chardev);
158
    putchar(ch);
232
    putchar(ch);
159
    return ch;
233
    return ch;
160
}
234
}
161
 
235
 
-
 
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
 
162
void putchar(char c)
248
void putchar(char c)
163
{
249
{
-
 
250
    spinlock_lock(&klog_lock);
-
 
251
   
-
 
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
   
164
    if (stdout->op->write)
267
    if (stdout->op->write)
165
        stdout->op->write(stdout, c);
268
        stdout->op->write(stdout, c);
-
 
269
    else {
-
 
270
        /* The character is just in the kernel log */
-
 
271
        if (klog_stored < klog_len)
-
 
272
            klog_stored++;
-
 
273
    }
-
 
274
   
-
 
275
    /* The character is stored for uspace */
-
 
276
    if (klog_uspace < klog_len)
-
 
277
        klog_uspace++;
-
 
278
   
-
 
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
   
-
 
286
    spinlock_unlock(&klog_lock);
-
 
287
   
-
 
288
    if (update)
-
 
289
        klog_update();
166
}
290
}
167
 
291
 
168
/** @}
292
/** @}
169
 */
293
 */
170
 
294