console.h File Reference

#include <sys/spinlock.h>

Include dependency graph for console.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Console

Macros
#define	KEY_F1   0xF1
#define	KEY_F2   0xF2
#define	KEY_F3   0XF3
#define	KEY_F4   0xF4
#define	KEY_F5   0xF5
#define	KEY_F6   0xF6
#define	KEY_F7   0xF7
#define	KEY_F8   0xF8
#define	KEY_F9   0xF9
#define	KEY_F10   0xFA
#define	KEY_F11   0xFB
#define	KEY_F12   0XFC
#define	CONSOLE_KEYBUF_MAXLEN   256

Typedefs
typedef struct Console	Console

Functions
void	Console_Init ()
char	Console_Getc ()
void	Console_Gets (char *str, size_t n)
void	Console_Putc (char ch)
void	Console_Puts (const char *str)
void	Console_EnqueueKey (char key)

---

Data Structure Documentation

Console

struct Console

Definition at line 22 of file console.h.

Collaboration diagram for Console:

Data Fields
char	keyBuf[CONSOLE_KEYBUF_MAXLEN]
Spinlock	keyLock
int	lastKey
int	nextKey

Macro Definition Documentation

CONSOLE_KEYBUF_MAXLEN

#define CONSOLE_KEYBUF_MAXLEN   256

Definition at line 20 of file console.h.

KEY_F1

#define KEY_F1   0xF1

Definition at line 7 of file console.h.

KEY_F10

#define KEY_F10   0xFA

Definition at line 16 of file console.h.

KEY_F11

#define KEY_F11   0xFB

Definition at line 17 of file console.h.

KEY_F12

#define KEY_F12   0XFC

Definition at line 18 of file console.h.

KEY_F2

#define KEY_F2   0xF2

Definition at line 8 of file console.h.

KEY_F3

#define KEY_F3   0XF3

Definition at line 9 of file console.h.

KEY_F4

#define KEY_F4   0xF4

Definition at line 10 of file console.h.

KEY_F5

#define KEY_F5   0xF5

Definition at line 11 of file console.h.

KEY_F6

#define KEY_F6   0xF6

Definition at line 12 of file console.h.

KEY_F7

#define KEY_F7   0xF7

Definition at line 13 of file console.h.

KEY_F8

#define KEY_F8   0xF8

Definition at line 14 of file console.h.

KEY_F9

#define KEY_F9   0xF9

Definition at line 15 of file console.h.

Typedef Documentation

Console

typedef struct Console Console

Function Documentation

Console_EnqueueKey()

void Console_EnqueueKey

(

char

key

)

Definition at line 75 of file console.c.

{
    Spinlock_Lock(&consoles.keyLock);
    if (((consoles.lastKey + 1) % CONSOLE_KEYBUF_MAXLEN) == consoles.lastKey) {
        Spinlock_Unlock(&consoles.keyLock);
        return;
    }
    consoles.keyBuf[consoles.lastKey] = key;
    consoles.lastKey = (consoles.lastKey + 1) % CONSOLE_KEYBUF_MAXLEN;
    Spinlock_Unlock(&consoles.keyLock);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Console_Getc()

char Console_Getc

(

)

Definition at line 47 of file console.c.

{
    while (1) {
        Spinlock_Lock(&consoles.keyLock);
        if (consoles.nextKey != consoles.lastKey) {
            char key = consoles.keyBuf[consoles.nextKey];
            consoles.nextKey = (consoles.nextKey + 1) % CONSOLE_KEYBUF_MAXLEN;
            Spinlock_Unlock(&consoles.keyLock);
            return key;
        }
        Spinlock_Unlock(&consoles.keyLock);
 
        // Support serial debugging if interrupts are disabled
        if (Serial_HasData()) {
            char key = Serial_Getc();
            switch (key) {
                case '\r':
                    return '\n';
                case 0x7f:
                    return '\b';
                default:
                    return key;
            }
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Console_Gets()

void Console_Gets	(	char *	str,
		size_t	n
	)

Definition at line 88 of file console.c.

{
    int i;
 
    for (i = 0; i < (n - 1); i++)
    {
        char ch = Console_Getc();
        if (ch == '\b') {
            if (i > 0) {
                Console_Putc(ch);
                i--;
            }
            i--;
            continue;
        }
        if (ch == '\n') {
            Console_Putc('\n');
            str[i] = '\0';
            return;
        }
        if (ch == '\r') {
            Console_Putc('\n');
            str[i] = '\0';
            return;
        }
        if (ch == '\t') {
            Console_Putc('\t');
            str[i] = '\t';
            continue;
        }
        if (ch < 0x20)
        {
            // Unprintable character
            continue;
        }
        Console_Putc(ch);
        str[i] = ch;
    }
 
    str[i+1] = '\0';
}

Here is the call graph for this function:

Here is the caller graph for this function:

Console_Init()

void Console_Init

(

)

Definition at line 22 of file console.c.

{
    VGA_Init();
    Serial_Init();
    DebugConsole_Init();
 
    Console_Puts("Castor Operating System\n");
 
    Spinlock_Init(&consoleLock, "Console Lock", SPINLOCK_TYPE_NORMAL);
 
    Spinlock_Init(&consoles.keyLock, "Console Keyboard Lock", SPINLOCK_TYPE_NORMAL);
    consoles.nextKey = 0;
    consoles.lastKey = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Console_Putc()

void Console_Putc

(

char

ch

)

Definition at line 131 of file console.c.

{
    Spinlock_Lock(&consoleLock);
    VGA_Putc(ch);
    Serial_Putc(ch);
    DebugConsole_Putc(ch);
    Spinlock_Unlock(&consoleLock);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Console_Puts()

void Console_Puts

(

const char *

str

)

Definition at line 141 of file console.c.

{
    Spinlock_Lock(&consoleLock);
    VGA_Puts(str);
    Serial_Puts(str);
    DebugConsole_Puts(str);
    Spinlock_Unlock(&consoleLock);
}

Here is the call graph for this function:

Here is the caller graph for this function: