2 * Acess2 Virtual Terminal Driver
8 #include <tpl_drv_video.h>
9 #include <tpl_drv_keyboard.h>
10 #include <tpl_drv_terminal.h>
12 #include <semaphore.h>
14 #define USE_CTRL_ALT 0
17 #define VERSION ((0<<8)|(50))
20 #define MAX_INPUT_CHARS32 64
21 #define MAX_INPUT_CHARS8 (MAX_INPUT_CHARS32*4)
22 //#define DEFAULT_OUTPUT "BochsGA"
23 #define DEFAULT_OUTPUT "Vesa"
24 #define DEFAULT_INPUT "PS2Keyboard"
25 #define DEFAULT_WIDTH 640
26 #define DEFAULT_HEIGHT 480
27 #define DEFAULT_SCROLLBACK 2 // 2 Screens of text + current screen
28 #define DEFAULT_COLOUR (VT_COL_BLACK|(0xAAA<<16))
30 #define VT_FLAG_HIDECSR 0x01
31 #define VT_FLAG_HASFB 0x10 //!< Set if the VTerm has requested the Framebuffer
34 VT_INMODE_TEXT8, // UTF-8 Text Mode (VT100/xterm Emulation)
35 VT_INMODE_TEXT32, // UTF-32 Text Mode (Acess Native)
41 int Mode; //!< Current Mode (see ::eTplTerminal_Modes)
42 int Flags; //!< Flags (see VT_FLAG_*)
44 short NewWidth; //!< Un-applied dimensions (Width)
45 short NewHeight; //!< Un-applied dimensions (Height)
46 short Width; //!< Virtual Width
47 short Height; //!< Virtual Height
48 short TextWidth; //!< Text Virtual Width
49 short TextHeight; //!< Text Virtual Height
51 int ViewPos; //!< View Buffer Offset (Text Only)
52 int WritePos; //!< Write Buffer Offset (Text Only)
53 Uint32 CurColour; //!< Current Text Colour
55 tMutex ReadingLock; //!< Lock the VTerm when a process is reading from it
56 tTID ReadingThread; //!< Owner of the lock
57 int InputRead; //!< Input buffer read position
58 int InputWrite; //!< Input buffer write position
59 char InputBuffer[MAX_INPUT_CHARS8];
60 tSemaphore InputSemaphore;
65 char Name[2]; //!< Name of the terminal
70 extern void Debug_SetKTerminal(const char *File);
73 int VT_Install(char **Arguments);
74 void VT_InitOutput(void);
75 void VT_InitInput(void);
76 char *VT_ReadDir(tVFS_Node *Node, int Pos);
77 tVFS_Node *VT_FindDir(tVFS_Node *Node, const char *Name);
78 int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data);
79 Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
80 Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
81 int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data);
82 void VT_SetResolution(int Width, int Height);
83 void VT_SetMode(int Mode);
84 void VT_SetTerminal(int ID);
85 void VT_KBCallBack(Uint32 Codepoint);
86 void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count);
87 void VT_int_ClearLine(tVTerm *Term, int Num);
88 int VT_int_ParseEscape(tVTerm *Term, char *Buffer);
89 void VT_int_PutChar(tVTerm *Term, Uint32 Ch);
90 void VT_int_ScrollFramebuffer( tVTerm *Term );
91 void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll );
92 void VT_int_ChangeMode(tVTerm *Term, int NewMode, int NewWidth, int NewHeight);
95 const Uint16 caVT100Colours[] = {
96 // Black, Red, Green, Yellow, Blue, Purple, Cyan, Gray
97 // Same again, but bright
98 VT_COL_BLACK, 0x700, 0x070, 0x770, 0x007, 0x707, 0x077, 0xAAA,
99 VT_COL_GREY, 0xF00, 0x0F0, 0xFF0, 0x00F, 0xF0F, 0x0FF, VT_COL_WHITE
103 MODULE_DEFINE(0, VERSION, VTerm, VT_Install, NULL, DEFAULT_OUTPUT, DEFAULT_INPUT, NULL);
104 tDevFS_Driver gVT_DrvInfo = {
107 .Flags = VFS_FFLAG_DIRECTORY,
111 .ReadDir = VT_ReadDir,
112 .FindDir = VT_FindDir,
113 .IOCtl = VT_Root_IOCtl
117 tVTerm gVT_Terminals[NUM_VTS];
118 int giVT_CurrentTerminal = 0;
119 tVTerm *gpVT_CurTerm = &gVT_Terminals[0];
120 // --- Video State ---
121 short giVT_RealWidth = DEFAULT_WIDTH; //!< Screen Width
122 short giVT_RealHeight = DEFAULT_HEIGHT; //!< Screen Height
123 int giVT_Scrollback = DEFAULT_SCROLLBACK;
124 // --- Driver Handles ---
125 char *gsVT_OutputDevice = NULL;
126 char *gsVT_InputDevice = NULL;
127 int giVT_OutputDevHandle = -2;
128 int giVT_InputDevHandle = -2;
129 // --- Key States --- (Used for VT Switching/Magic Combos)
130 int gbVT_CtrlDown = 0;
131 int gbVT_AltDown = 0;
132 int gbVT_SysrqDown = 0;
136 * \fn int VT_Install(char **Arguments)
137 * \brief Installs the Virtual Terminal Driver
139 int VT_Install(char **Arguments)
148 for(args = Arguments; (arg = *args); args++ )
150 char data[strlen(arg)+1];
154 val = strchr(arg, '=');
157 data[ val - arg ] = '\0';
160 Log_Debug("VTerm", "Argument '%s'", arg);
162 if( strcmp(opt, "Video") == 0 ) {
163 gsVT_OutputDevice = strdup(val);
165 else if( strcmp(opt, "Input") == 0 ) {
166 gsVT_InputDevice = strdup(val);
168 else if( strcmp(opt, "Width") == 0 ) {
169 giVT_RealWidth = atoi( val );
171 else if( strcmp(opt, "Height") == 0 ) {
172 giVT_RealHeight = atoi( val );
174 else if( strcmp(opt, "Scrollback") == 0 ) {
175 giVT_Scrollback = atoi( val );
180 if(gsVT_OutputDevice) Modules_InitialiseBuiltin( gsVT_OutputDevice );
181 if(gsVT_InputDevice) Modules_InitialiseBuiltin( gsVT_InputDevice );
184 if(!gsVT_OutputDevice) gsVT_OutputDevice = strdup(DEFAULT_OUTPUT);
185 if(!gsVT_InputDevice) gsVT_InputDevice = strdup(DEFAULT_INPUT);
190 tmp = malloc( 9 + strlen(gsVT_OutputDevice) + 1 );
191 strcpy(tmp, "/Devices/");
192 strcpy(&tmp[9], gsVT_OutputDevice);
193 gsVT_OutputDevice = tmp;
194 tmp = malloc( 9 + strlen(gsVT_InputDevice) + 1 );
195 strcpy(tmp, "/Devices/");
196 strcpy(&tmp[9], gsVT_InputDevice);
197 gsVT_InputDevice = tmp;
200 Log_Log("VTerm", "Using '%s' as output", gsVT_OutputDevice);
201 Log_Log("VTerm", "Using '%s' as input", gsVT_InputDevice);
204 for( i = 0; i < NUM_VTS; i++ )
206 gVT_Terminals[i].Mode = TERM_MODE_TEXT;
207 gVT_Terminals[i].Flags = 0;
208 gVT_Terminals[i].CurColour = DEFAULT_COLOUR;
209 gVT_Terminals[i].WritePos = 0;
210 gVT_Terminals[i].ViewPos = 0;
211 gVT_Terminals[i].ReadingThread = -1;
214 VT_int_ChangeMode( &gVT_Terminals[i],
215 TERM_MODE_TEXT, giVT_RealWidth, giVT_RealHeight );
217 gVT_Terminals[i].Name[0] = '0'+i;
218 gVT_Terminals[i].Name[1] = '\0';
219 gVT_Terminals[i].Node.Inode = i;
220 gVT_Terminals[i].Node.ImplPtr = &gVT_Terminals[i];
221 gVT_Terminals[i].Node.NumACLs = 0; // Only root can open virtual terminals
223 gVT_Terminals[i].Node.Read = VT_Read;
224 gVT_Terminals[i].Node.Write = VT_Write;
225 gVT_Terminals[i].Node.IOCtl = VT_Terminal_IOCtl;
226 Semaphore_Init(&gVT_Terminals[i].InputSemaphore, 0, MAX_INPUT_CHARS8, "VTerm", gVT_Terminals[i].Name);
230 DevFS_AddDevice( &gVT_DrvInfo );
235 // Set kernel output to VT0
236 Debug_SetKTerminal("/Devices/VTerm/0");
238 Log_Log("VTerm", "Returning %i", MODULE_ERR_OK);
239 return MODULE_ERR_OK;
243 * \fn void VT_InitOutput()
244 * \brief Initialise Video Output
248 giVT_OutputDevHandle = VFS_Open(gsVT_OutputDevice, VFS_OPENFLAG_WRITE);
249 if(giVT_OutputDevHandle == -1) {
250 Log_Warning("VTerm", "Oh F**k, I can't open the video device '%s'", gsVT_OutputDevice);
253 VT_SetResolution( giVT_RealWidth, giVT_RealHeight );
255 VT_SetMode( VIDEO_BUFFMT_TEXT );
259 * \fn void VT_InitInput()
260 * \brief Initialises the input
264 giVT_InputDevHandle = VFS_Open(gsVT_InputDevice, VFS_OPENFLAG_READ);
265 if(giVT_InputDevHandle == -1) {
266 Log_Warning("VTerm", "Can't open the input device '%s'", gsVT_InputDevice);
269 VFS_IOCtl(giVT_InputDevHandle, KB_IOCTL_SETCALLBACK, VT_KBCallBack);
273 * \brief Set the video resolution
274 * \param Width New screen width
275 * \param Height New screen height
277 void VT_SetResolution(int Width, int Height)
279 tVideo_IOCtl_Mode mode = {0};
283 // Create the video mode
285 mode.height = Height;
290 VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_FINDMODE, &mode );
292 if( Width != mode.width || Height != mode.height )
295 "Selected resolution (%ix%i is not supported) by the device, using (%ix%i)",
296 giVT_RealWidth, giVT_RealHeight,
297 mode.width, mode.height
300 VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_GETSETMODE, &tmp );
302 // Resize text terminals if needed
303 if( giVT_RealWidth != mode.width || giVT_RealHeight != mode.height )
305 int newBufSize = (giVT_RealWidth/giVT_CharWidth)
306 *(giVT_RealHeight/giVT_CharHeight)
307 *(giVT_Scrollback+1);
309 // Resize the text terminals
310 giVT_RealWidth = mode.width;
311 giVT_RealHeight = mode.height;
312 for( i = 0; i < NUM_VTS; i ++ )
314 if( gVT_Terminals[i].Mode != TERM_MODE_TEXT ) continue;
316 gVT_Terminals[i].Text = realloc(
317 gVT_Terminals[i].Text,
318 newBufSize*sizeof(tVT_Char)
325 * \brief Set video output buffer mode
327 void VT_SetMode(int Mode)
329 VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_SETBUFFORMAT, &Mode );
333 * \fn char *VT_ReadDir(tVFS_Node *Node, int Pos)
334 * \brief Read from the VTerm Directory
336 char *VT_ReadDir(tVFS_Node *Node, int Pos)
338 if(Pos < 0) return NULL;
339 if(Pos >= NUM_VTS) return NULL;
340 return strdup( gVT_Terminals[Pos].Name );
344 * \fn tVFS_Node *VT_FindDir(tVFS_Node *Node, const char *Name)
345 * \brief Find an item in the VTerm directory
346 * \param Node Root node
347 * \param Name Name (number) of the terminal
349 tVFS_Node *VT_FindDir(tVFS_Node *Node, const char *Name)
353 ENTER("pNode sName", Node, Name);
355 // Open the input and output files if needed
356 if(giVT_OutputDevHandle == -2) VT_InitOutput();
357 if(giVT_InputDevHandle == -2) VT_InitInput();
360 if(Name[0] < '0' || Name[0] > '9' || Name[1] != '\0') {
371 LEAVE('p', &gVT_Terminals[num].Node);
372 return &gVT_Terminals[num].Node;
376 * \fn int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data)
377 * \brief Control the VTerm Driver
379 int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data)
384 case DRV_IOCTL_TYPE: return DRV_TYPE_MISC;
385 case DRV_IOCTL_IDENT: memcpy(Data, "VT\0\0", 4); return 0;
386 case DRV_IOCTL_VERSION: return VERSION;
387 case DRV_IOCTL_LOOKUP: return 0;
389 case 4: // Get Video Driver
390 if(Data) strcpy(Data, gsVT_OutputDevice);
391 return strlen(gsVT_OutputDevice);
393 case 5: // Set Video Driver
394 if(!Data) return -EINVAL;
395 if(Threads_GetUID() != 0) return -EACCES;
399 // TODO: Check if the string used is a heap string
401 free(gsVT_OutputDevice);
403 gsVT_OutputDevice = malloc(len+1);
404 strcpy(gsVT_OutputDevice, Data);
406 VFS_Close(giVT_OutputDevHandle);
407 giVT_OutputDevHandle = -1;
416 * \fn Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
417 * \brief Read from a virtual terminal
419 Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
422 tVTerm *term = &gVT_Terminals[ Node->Inode ];
424 Mutex_Acquire( &term->ReadingLock );
426 // Check current mode
434 avail_bytes = Semaphore_Wait( &term->InputSemaphore, Length );
435 if( avail_bytes == -1 ) {
439 while( avail_bytes -- )
441 ((char*)Buffer)[pos] = term->InputBuffer[term->InputRead];
444 term->InputRead %= MAX_INPUT_CHARS8;
455 avail = Semaphore_Wait( &term->InputSemaphore, Length/4 * 4 );
462 ((Uint32*)Buffer)[pos] = ((Uint32*)term->InputBuffer)[term->InputRead];
465 term->InputRead %= MAX_INPUT_CHARS32;
473 term->ReadingThread = -1;
474 Mutex_Release( &term->ReadingLock );
480 * \fn Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
481 * \brief Write to a virtual terminal
483 Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
485 tVTerm *term = &gVT_Terminals[ Node->Inode ];
493 VT_int_PutString(term, Buffer, Length);
499 size = term->Width*term->Height*4;
500 if( Offset > size ) {
501 Log_Notice("VTerm", "VT_Write: Offset (0x%llx) > FBSize (0x%x)",
505 if( Offset + Length > size ) {
506 Log_Notice("VTerm", "VT_Write: Offset+Length (0x%llx) > FBSize (0x%x)",
507 Offset+Length, size);
508 Length = size - Offset;
511 // Copy to the local cache
512 memcpy( (void*)((Uint)term->Buffer + (Uint)Offset), Buffer, Length );
514 // Update screen if needed
515 if( Node->Inode == giVT_CurrentTerminal )
517 // Fill entire screen?
518 if( giVT_RealWidth > term->Width || giVT_RealHeight > term->Height )
520 // No? :( Well, just center it
522 x = Offset/4; y = x / term->Width; x %= term->Width;
523 w = Length/4+x; h = w / term->Width; w %= term->Width;
525 x += (giVT_RealWidth - term->Width) / 2;
526 y += (giVT_RealHeight - term->Height) / 2;
529 VFS_WriteAt( giVT_OutputDevHandle,
530 (x + y * giVT_RealWidth)*4,
534 Buffer = (void*)( (Uint)Buffer + term->Width*4 );
540 return VFS_WriteAt( giVT_OutputDevHandle, Offset, Length, Buffer );
543 // Just pass on (for now)
544 // TODO: Handle locally too to ensure no information is lost on
545 // VT Switch (and to isolate terminals from each other)
546 case TERM_MODE_2DACCEL:
547 //case TERM_MODE_3DACCEL:
548 if( Node->Inode == giVT_CurrentTerminal )
550 VFS_Write( giVT_OutputDevHandle, Length, Buffer );
559 * \fn int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
560 * \brief Call an IO Control on a virtual terminal
562 int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
566 tVTerm *term = Node->ImplPtr;
567 ENTER("pNode iId pData", Node, Id, Data);
569 if(Id >= DRV_IOCTL_LOOKUP) {
570 // Only root can fiddle with graphics modes
571 // TODO: Remove this and replace with user ownership
572 if( Threads_GetUID() != 0 ) return -1;
579 LEAVE('i', DRV_TYPE_TERMINAL);
580 return DRV_TYPE_TERMINAL;
581 case DRV_IOCTL_IDENT:
582 memcpy(Data, "VT\0\0", 4);
585 case DRV_IOCTL_VERSION:
588 case DRV_IOCTL_LOOKUP:
592 // Get/Set the mode (and apply any changes)
593 case TERM_IOCTL_MODETYPE:
596 if( CheckMem(Data, sizeof(int)) == 0 ) {
600 Log_Log("VTerm", "VTerm %i mode set to %i", (int)Node->Inode, *iData);
602 // Update mode if needed
603 if( term->Mode != *iData
607 // Adjust for text mode
608 if( *iData == TERM_MODE_TEXT ) {
609 term->NewHeight *= giVT_CharHeight;
610 term->NewWidth *= giVT_CharWidth;
612 // Fill unchanged dimensions
613 if(term->NewHeight == 0) term->NewHeight = term->Height;
614 if(term->NewWidth == 0) term->NewWidth = term->Width;
616 VT_int_ChangeMode(term, *iData, term->NewWidth, term->NewHeight);
617 // Clear unapplied dimensions
622 // Update the screen dimensions
623 if(Node->Inode == giVT_CurrentTerminal)
624 VT_SetTerminal( giVT_CurrentTerminal );
626 LEAVE('i', term->Mode);
629 // Get/set the terminal width
630 case TERM_IOCTL_WIDTH:
632 if( CheckMem(Data, sizeof(int)) == 0 ) {
636 term->NewWidth = *iData;
639 ret = term->NewWidth;
640 else if( term->Mode == TERM_MODE_TEXT )
641 ret = term->TextWidth;
647 // Get/set the terminal height
648 case TERM_IOCTL_HEIGHT:
650 if( CheckMem(Data, sizeof(int)) == 0 ) {
654 term->NewHeight = *iData;
656 if( term->NewHeight )
657 ret = term->NewHeight;
658 else if( term->Mode == TERM_MODE_TEXT )
659 ret = term->TextHeight;
665 case TERM_IOCTL_FORCESHOW:
666 Log_Log("VTerm", "Thread %i forced VTerm %i to be shown",
667 Threads_GetTID(), (int)Node->Inode);
668 VT_SetTerminal( Node->Inode );
677 * \fn void VT_SetTerminal(int ID)
678 * \brief Set the current terminal
680 void VT_SetTerminal(int ID)
682 // Update current terminal ID
683 Log_Log("VTerm", "Changed terminal from %i to %i", giVT_CurrentTerminal, ID);
684 giVT_CurrentTerminal = ID;
685 gpVT_CurTerm = &gVT_Terminals[ID];
688 if( gpVT_CurTerm->Mode == TERM_MODE_TEXT && !(gpVT_CurTerm->Flags & VT_FLAG_HIDECSR) )
690 tVideo_IOCtl_Pos pos;
691 pos.x = (gpVT_CurTerm->WritePos - gpVT_CurTerm->ViewPos) % gpVT_CurTerm->TextWidth;
692 pos.y = (gpVT_CurTerm->WritePos - gpVT_CurTerm->ViewPos) / gpVT_CurTerm->TextWidth;
693 if( pos.x < gpVT_CurTerm->TextHeight )
694 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSOR, &pos);
697 if( gpVT_CurTerm->Mode == TERM_MODE_TEXT )
698 VT_SetMode( VIDEO_BUFFMT_TEXT );
700 VT_SetMode( VIDEO_BUFFMT_FRAMEBUFFER );
703 VT_int_UpdateScreen( &gVT_Terminals[ ID ], 1 );
707 * \fn void VT_KBCallBack(Uint32 Codepoint)
708 * \brief Called on keyboard interrupt
709 * \param Codepoint Pseudo-UTF32 character
711 * Handles a key press and sends the key code to the user's buffer.
712 * If the code creates a kernel-magic sequence, it is not passed to the
713 * user and is handled in-kernel.
715 void VT_KBCallBack(Uint32 Codepoint)
717 tVTerm *term = gpVT_CurTerm;
719 // How the hell did we get a codepoint of zero?
720 if(Codepoint == 0) return;
723 if( Codepoint & 0x80000000 )
725 Codepoint &= 0x7FFFFFFF;
729 case KEY_RSHIFT: gbVT_CtrlDown = 0; break;
730 case KEY_LSHIFT: gbVT_AltDown = 0; break;
732 case KEY_LALT: gbVT_AltDown &= ~1; break;
733 case KEY_RALT: gbVT_AltDown &= ~2; break;
734 case KEY_LCTRL: gbVT_CtrlDown &= ~1 break;
735 case KEY_RCTRL: gbVT_CtrlDown &= ~2; break;
743 #if !USE_CTRL_ALT // HACK: Use both shifts instead of Ctrl-Alt
744 case KEY_RSHIFT: gbVT_CtrlDown = 1; break;
745 case KEY_LSHIFT: gbVT_AltDown = 1; break;
747 case KEY_LALT: gbVT_AltDown |= 1; break;
748 case KEY_RALT: gbVT_AltDown |= 2; break;
749 case KEY_LCTRL: gbVT_CtrlDown |= 1; break;
750 case KEY_RCTRL: gbVT_CtrlDown |= 2; break;
754 if(!gbVT_AltDown || !gbVT_CtrlDown)
758 case KEY_F1: VT_SetTerminal(0); return;
759 case KEY_F2: VT_SetTerminal(1); return;
760 case KEY_F3: VT_SetTerminal(2); return;
761 case KEY_F4: VT_SetTerminal(3); return;
762 case KEY_F5: VT_SetTerminal(4); return;
763 case KEY_F6: VT_SetTerminal(5); return;
764 case KEY_F7: VT_SetTerminal(6); return;
765 case KEY_F8: VT_SetTerminal(7); return;
766 case KEY_F9: VT_SetTerminal(8); return;
767 case KEY_F10: VT_SetTerminal(9); return;
768 case KEY_F11: VT_SetTerminal(10); return;
769 case KEY_F12: VT_SetTerminal(11); return;
772 if( gpVT_CurTerm->ViewPos > gpVT_CurTerm->Width )
773 gpVT_CurTerm->ViewPos -= gpVT_CurTerm->Width;
775 gpVT_CurTerm->ViewPos = 0;
778 if( gpVT_CurTerm->ViewPos < gpVT_CurTerm->Width*gpVT_CurTerm->Height*(giVT_Scrollback-1) )
779 gpVT_CurTerm->ViewPos += gpVT_CurTerm->Width;
781 gpVT_CurTerm->ViewPos = gpVT_CurTerm->Width*gpVT_CurTerm->Height*(giVT_Scrollback-1);
787 if(term->Mode == TERM_MODE_TEXT)
792 // Ignore Modifer Keys
793 if(Codepoint > KEY_MODIFIERS) return;
795 // Get UTF-8/ANSI Encoding
799 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'D';
803 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'C';
807 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'A';
811 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'B';
816 buf[0] = '\x1B'; buf[1] = '['; buf[2] = '5'; // Some overline also
817 //len = 4; // Commented out until I'm sure
823 // Attempt to encode in UTF-8
825 len = WriteUTF8( buf, Codepoint );
827 Warning("Codepoint (%x) is unrepresentable in UTF-8", Codepoint);
833 // Unprintable / Don't Pass
838 if( MAX_INPUT_CHARS8 - term->InputWrite >= len )
839 memcpy( &term->InputBuffer[term->InputWrite], buf, len );
841 memcpy( &term->InputBuffer[term->InputWrite], buf, MAX_INPUT_CHARS8 - term->InputWrite );
842 memcpy( &term->InputBuffer[0], buf, len - (MAX_INPUT_CHARS8 - term->InputWrite) );
844 // Roll the buffer over
845 term->InputWrite += len;
846 term->InputWrite %= MAX_INPUT_CHARS8;
847 if( (term->InputWrite - term->InputRead + MAX_INPUT_CHARS8)%MAX_INPUT_CHARS8 < len ) {
848 term->InputRead = term->InputWrite + 1;
849 term->InputRead %= MAX_INPUT_CHARS8;
852 Semaphore_Signal(&term->InputSemaphore, 1);
856 // Encode the raw UTF-32 Key
857 ((Uint32*)term->InputBuffer)[ term->InputWrite ] = Codepoint;
859 term->InputWrite %= MAX_INPUT_CHARS32;
860 if(term->InputRead == term->InputWrite) {
862 term->InputRead %= MAX_INPUT_CHARS32;
864 Semaphore_Signal(&term->InputSemaphore, 4);
867 // Wake up the thread waiting on us
868 //if( term->ReadingThread >= 0 ) {
869 // Threads_WakeTID(term->ReadingThread);
874 * \fn void VT_int_ClearLine(tVTerm *Term, int Num)
875 * \brief Clears a line in a virtual terminal
877 void VT_int_ClearLine(tVTerm *Term, int Num)
880 tVT_Char *cell = &Term->Text[ Num*Term->TextWidth ];
881 if( Num < 0 || Num >= Term->TextHeight * (giVT_Scrollback + 1) ) return ;
882 //ENTER("pTerm iNum", Term, Num);
883 for( i = Term->TextWidth; i--; )
886 cell[ i ].Colour = Term->CurColour;
892 * \fn int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
893 * \brief Parses a VT100 Escape code
895 int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
900 int args[6] = {0,0,0,0};
908 if( '0' <= c && c <= '9' )
911 if(c == ';') c = Buffer[j++];
912 while('0' <= c && c <= '9') {
922 if( ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'))
928 if(argc == 1) tmp = args[0];
931 if( Term->WritePos-(tmp-1) % Term->TextWidth == 0 )
932 Term->WritePos -= Term->WritePos % Term->TextWidth;
934 Term->WritePos -= tmp;
939 if(argc == 1) tmp = args[0];
941 if( (Term->WritePos + tmp) % Term->TextWidth == 0 ) {
942 Term->WritePos -= Term->WritePos % Term->TextWidth;
943 Term->WritePos += Term->TextWidth - 1;
945 Term->WritePos += tmp;
955 int i = Term->TextHeight * (giVT_Scrollback + 1);
956 while( i-- ) VT_int_ClearLine(Term, i);
959 VT_int_UpdateScreen(Term, 1);
964 // Set cursor position
966 Term->WritePos = args[0] + args[1]*Term->TextWidth;
967 Log_Debug("VTerm", "args = {%i, %i}", args[0], args[1]);
974 if( 0 <= args[argc] && args[argc] <= 8)
978 case 0: Term->CurColour = DEFAULT_COLOUR; break; // Reset
979 case 1: Term->CurColour |= 0x80000000; break; // Bright
980 case 2: Term->CurColour &= ~0x80000000; break; // Dim
984 else if(30 <= args[argc] && args[argc] <= 37) {
985 Term->CurColour &= 0xF000FFFF;
986 Term->CurColour |= (Uint32)caVT100Colours[ args[argc]-30+(Term->CurColour>>28) ] << 16;
989 else if(40 <= args[argc] && args[argc] <= 47) {
990 Term->CurColour &= 0xFFFF8000;
991 Term->CurColour |= caVT100Colours[ args[argc]-40+((Term->CurColour>>12)&15) ];
996 Log_Warning("VTerm", "Unknown control sequence");
1005 //Log_Debug("VTerm", "j = %i, Buffer = '%s'", j, Buffer);
1010 * \fn void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
1011 * \brief Print a string to the Virtual Terminal
1013 void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
1019 for( i = 0; i < Count; i++ )
1021 // Handle escape sequences
1022 if( Buffer[i] == 0x1B )
1025 i += VT_int_ParseEscape(Term, (char*)&Buffer[i]) - 1;
1029 // Fast check for non UTF-8
1030 if( Buffer[i] < 128 ) // Plain ASCII
1031 VT_int_PutChar(Term, Buffer[i]);
1033 i += ReadUTF8(&Buffer[i], &val) - 1;
1034 VT_int_PutChar(Term, val);
1038 VT_int_UpdateScreen( Term, 0 );
1041 if( Term == gpVT_CurTerm && !(Term->Flags & VT_FLAG_HIDECSR) )
1043 tVideo_IOCtl_Pos pos;
1044 pos.x = (Term->WritePos - Term->ViewPos) % Term->TextWidth;
1045 pos.y = (Term->WritePos - Term->ViewPos) / Term->TextWidth;
1046 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSOR, &pos);
1051 * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
1052 * \brief Write a single character to a VTerm
1054 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
1060 case '\0': return; // Ignore NULL byte
1062 VT_int_UpdateScreen( Term, 0 ); // Update the line before newlining
1063 Term->WritePos += Term->TextWidth;
1065 Term->WritePos -= Term->WritePos % Term->TextWidth;
1070 Term->Text[ Term->WritePos ].Ch = '\0';
1071 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1073 } while(Term->WritePos & 7);
1077 // Backspace is invalid at Offset 0
1078 if(Term->WritePos == 0) break;
1082 if(Term->Text[ Term->WritePos ].Ch != '\0') {
1083 Term->Text[ Term->WritePos ].Ch = 0;
1084 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1088 i = 7; // Limit it to 8
1090 Term->Text[ Term->WritePos ].Ch = 0;
1091 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1093 } while(Term->WritePos && i-- && Term->Text[ Term->WritePos ].Ch == '\0');
1094 if(Term->Text[ Term->WritePos ].Ch != '\0')
1099 Term->Text[ Term->WritePos ].Ch = Ch;
1100 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1106 // - Check if we need to scroll the entire scrollback buffer
1107 if(Term->WritePos >= Term->TextWidth*Term->TextHeight*(giVT_Scrollback+1))
1112 Term->WritePos -= Term->TextWidth;
1114 VT_int_UpdateScreen( Term, 0 );
1116 // Update view position
1117 base = Term->TextWidth*Term->TextHeight*(giVT_Scrollback);
1118 if(Term->ViewPos < base)
1119 Term->ViewPos += Term->Width;
1120 if(Term->ViewPos > base)
1121 Term->ViewPos = base;
1123 // Scroll terminal cache
1124 base = Term->TextWidth*(Term->TextHeight*(giVT_Scrollback+1)-1);
1127 &Term->Text[Term->TextWidth],
1128 base*sizeof(tVT_Char)
1132 for( i = 0; i < Term->TextWidth; i ++ )
1134 Term->Text[ base + i ].Ch = 0;
1135 Term->Text[ base + i ].Colour = Term->CurColour;
1138 VT_int_ScrollFramebuffer( Term );
1139 VT_int_UpdateScreen( Term, 0 );
1141 // Ok, so we only need to scroll the screen
1142 else if(Term->WritePos >= Term->ViewPos + Term->TextWidth*Term->TextHeight)
1144 //Debug("Term->WritePos (%i) >= %i",
1146 // Term->ViewPos + Term->Width*Term->Height
1148 //Debug("Scrolling screen only");
1150 // Update the last line
1151 Term->WritePos -= Term->TextWidth;
1152 VT_int_UpdateScreen( Term, 0 );
1153 Term->WritePos += Term->TextWidth;
1154 VT_int_ClearLine(Term, Term->WritePos / Term->TextWidth);
1157 Term->ViewPos += Term->TextWidth;
1158 //Debug("Term->ViewPos = %i", Term->ViewPos);
1159 VT_int_ScrollFramebuffer( Term );
1160 VT_int_UpdateScreen( Term, 0 );
1167 * \fn void VT_int_ScrollFramebuffer( tVTerm *Term )
1168 * \note Scrolls the framebuffer by 1 text line
1170 void VT_int_ScrollFramebuffer( tVTerm *Term )
1180 // Only update if this is the current terminal
1181 if( Term != gpVT_CurTerm ) return;
1183 // Switch to 2D Command Stream
1184 tmp = VIDEO_BUFFMT_2DSTREAM;
1185 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETBUFFORMAT, &tmp);
1187 // BLIT from 0,0 to 0,giVT_CharHeight
1188 buf.Op = VIDEO_2DOP_BLIT;
1189 buf.DstX = 0; buf.DstY = 0;
1190 buf.SrcX = 0; buf.SrcY = giVT_CharHeight;
1191 buf.W = Term->TextWidth * giVT_CharWidth;
1192 buf.H = (Term->TextHeight-1) * giVT_CharHeight;
1193 VFS_WriteAt(giVT_OutputDevHandle, 0, sizeof(buf), &buf);
1195 // Restore old mode (this function is only called during text mode)
1196 tmp = VIDEO_BUFFMT_TEXT;
1197 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETBUFFORMAT, &tmp);
1201 * \fn void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
1202 * \brief Updates the video framebuffer
1204 void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
1206 // Only update if this is the current terminal
1207 if( Term != gpVT_CurTerm ) return;
1209 switch( Term->Mode )
1211 case TERM_MODE_TEXT:
1212 // Re copy the entire screen?
1215 giVT_OutputDevHandle,
1217 Term->TextWidth*Term->TextHeight*sizeof(tVT_Char),
1218 &Term->Text[Term->ViewPos]
1221 // Only copy the current line
1223 int pos = Term->WritePos - Term->WritePos % Term->TextWidth;
1225 giVT_OutputDevHandle,
1226 (pos - Term->ViewPos)*sizeof(tVT_Char),
1227 Term->TextWidth*sizeof(tVT_Char),
1234 giVT_OutputDevHandle,
1236 Term->Width*Term->Height*sizeof(Uint32),
1244 * \brief Update the screen mode
1245 * \param Term Terminal to update
1246 * \param NewMode New mode to set
1247 * \param NewWidth New framebuffer width
1248 * \param NewHeight New framebuffer height
1250 void VT_int_ChangeMode(tVTerm *Term, int NewMode, int NewWidth, int NewHeight)
1252 int oldW = Term->Width;
1253 int oldTW = oldW / giVT_CharWidth;
1254 int oldH = Term->Height;
1255 int oldTH = oldH / giVT_CharWidth;
1256 tVT_Char *oldTBuf = Term->Text;
1257 Uint32 *oldFB = Term->Buffer;
1260 // TODO: Increase RealWidth/RealHeight when this happens
1261 if(NewWidth > giVT_RealWidth) NewWidth = giVT_RealWidth;
1262 if(NewHeight > giVT_RealHeight) NewHeight = giVT_RealHeight;
1264 // Calculate new dimensions
1265 Term->TextWidth = NewWidth / giVT_CharWidth;
1266 Term->TextHeight = NewHeight / giVT_CharHeight;
1267 Term->Width = NewWidth;
1268 Term->Height = NewHeight;
1269 Term->Mode = NewMode;
1271 // Allocate new buffers
1273 Term->Text = calloc(
1274 Term->TextWidth * Term->TextHeight * (giVT_Scrollback+1),
1280 if( w > Term->TextWidth ) w = Term->TextWidth;
1282 if( h > Term->TextHeight ) h = Term->TextHeight;
1283 h *= giVT_Scrollback + 1;
1284 for( i = 0; i < h; i ++ )
1287 &Term->Text[i*Term->TextWidth],
1296 Term->Buffer = calloc( Term->Width * Term->Height, sizeof(Uint32) );
1300 if( w > Term->Width ) w = Term->Width;
1302 if( h > Term->Height ) h = Term->Height;
1303 for( i = 0; i < h; i ++ )
1306 &Term->Buffer[i*Term->Width],
1317 case TERM_MODE_TEXT:
1318 Log_Log("VTerm", "Set VT %p to text mode (%ix%i)",
1319 Term, Term->TextWidth, Term->TextHeight);
1322 Log_Log("VTerm", "Set VT %p to framebuffer mode (%ix%i)",
1323 Term, Term->Width, Term->Height);
1325 //case TERM_MODE_2DACCEL:
1326 //case TERM_MODE_3DACCEL:
1334 #define MONOSPACE_FONT 10816
1336 #if MONOSPACE_FONT == 10808 // 8x8
1337 # include "vterm_font_8x8.h"
1338 #elif MONOSPACE_FONT == 10816 // 8x16
1339 # include "vterm_font_8x16.h"
1342 // === PROTOTYPES ===
1343 Uint8 *VT_Font_GetChar(Uint32 Codepoint);
1346 int giVT_CharWidth = FONT_WIDTH;
1347 int giVT_CharHeight = FONT_HEIGHT;
1351 * \brief Render a font character
1353 void VT_Font_Render(Uint32 Codepoint, void *Buffer, int Depth, int Pitch, Uint32 BGC, Uint32 FGC)
1361 Uint8 *buf = Buffer;
1363 font = VT_Font_GetChar(Codepoint);
1365 for(y = 0; y < FONT_HEIGHT; y ++)
1367 for(x = 0; x < FONT_WIDTH; x ++)
1369 if(*font & (1 << (FONT_WIDTH-x-1)))
1374 buf = (void*)( (tVAddr)buf + Pitch );
1379 else if( Depth <= 16 )
1381 Uint16 *buf = Buffer;
1383 font = VT_Font_GetChar(Codepoint);
1385 for(y = 0; y < FONT_HEIGHT; y ++)
1387 for(x = 0; x < FONT_WIDTH; x ++)
1389 if(*font & (1 << (FONT_WIDTH-x-1)))
1394 buf = (void*)( (tVAddr)buf + Pitch );
1399 // - Special handling to not overwrite the next pixel
1400 //TODO: Endian issues here
1401 else if( Depth == 24 )
1403 Uint8 *buf = Buffer;
1404 Uint8 bg_r = (BGC >> 16) & 0xFF;
1405 Uint8 bg_g = (BGC >> 8) & 0xFF;
1406 Uint8 bg_b = (BGC >> 0) & 0xFF;
1407 Uint8 fg_r = (FGC >> 16) & 0xFF;
1408 Uint8 fg_g = (FGC >> 8) & 0xFF;
1409 Uint8 fg_b = (FGC >> 0) & 0xFF;
1411 font = VT_Font_GetChar(Codepoint);
1413 for(y = 0; y < FONT_HEIGHT; y ++)
1415 for(x = 0; x < FONT_WIDTH; x ++)
1419 if(*font & (1 << (FONT_WIDTH-x-1))) {
1420 r = fg_r; g = fg_g; b = fg_b;
1423 r = bg_r; g = bg_g; b = bg_b;
1429 buf = (void*)( (tVAddr)buf + Pitch );
1433 // 32-bpp colour (nice and easy)
1434 else if( Depth == 32 )
1436 Uint32 *buf = Buffer;
1438 font = VT_Font_GetChar(Codepoint);
1440 for(y = 0; y < FONT_HEIGHT; y ++)
1442 for(x = 0; x < FONT_WIDTH; x ++)
1444 if(*font & (1 << (FONT_WIDTH-x-1)))
1449 buf = (Uint32*)( (tVAddr)buf + Pitch );
1456 * \fn Uint32 VT_Colour12to24(Uint16 Col12)
1457 * \brief Converts a 12-bit colour into 24 bits
1459 Uint32 VT_Colour12to24(Uint16 Col12)
1464 ret = (tmp << 0) | (tmp << 4);
1465 tmp = (Col12 & 0xF0) >> 4;
1466 ret |= (tmp << 8) | (tmp << 12);
1467 tmp = (Col12 & 0xF00) >> 8;
1468 ret |= (tmp << 16) | (tmp << 20);
1472 * \brief Converts a 12-bit colour into 15 bits
1474 Uint16 VT_Colour12to15(Uint16 Col12)
1479 ret = (tmp << 1) | (tmp & 1);
1480 tmp = (Col12 & 0xF0) >> 4;
1481 ret |= ( (tmp << 1) | (tmp & 1) ) << 5;
1482 tmp = (Col12 & 0xF00) >> 8;
1483 ret |= ( (tmp << 1) | (tmp & 1) ) << 10;
1488 * \brief Converts a 12-bit colour into any other depth
1489 * \param Col12 12-bit source colour
1490 * \param Depth Desired bit deptj
1491 * \note Green then blue get the extra avaliable bits (16:5-6-5, 14:4-5-5)
1493 Uint32 VT_Colour12toN(Uint16 Col12, int Depth)
1497 int rSize, gSize, bSize;
1500 if( Depth == 24 ) return VT_Colour12to24(Col12);
1501 if( Depth == 15 ) return VT_Colour12to15(Col12);
1502 // - 32 is a special case, it's usually 24-bit colour with an unused byte
1503 if( Depth == 32 ) return VT_Colour12to24(Col12);
1506 if( Depth < 8 ) return 0;
1507 if( Depth > 32 ) return 0;
1510 g = (Col12 & 0xF0) >> 4;
1511 b = (Col12 & 0xF00) >> 8;
1513 rSize = gSize = bSize = Depth / 3;
1514 if( rSize + gSize + bSize < Depth ) // Depth % 3 == 1
1516 if( rSize + gSize + bSize < Depth ) // Depth % 3 == 2
1520 r <<= rSize - 4; g <<= gSize - 4; b <<= bSize - 4;
1521 // Fill with the lowest bit
1522 if( Col12 & 0x001 ) r |= (1 << (rSize - 4)) - 1;
1523 if( Col12 & 0x010 ) r |= (1 << (gSize - 4)) - 1;
1524 if( Col12 & 0x100 ) r |= (1 << (bSize - 4)) - 1;
1529 ret |= b << (rSize + gSize);
1535 * \fn Uint8 *VT_Font_GetChar(Uint32 Codepoint)
1536 * \brief Gets an index into the font array given a Unicode Codepoint
1537 * \note See http://en.wikipedia.org/wiki/CP437
1539 Uint8 *VT_Font_GetChar(Uint32 Codepoint)
1543 return &VTermFont[Codepoint*FONT_HEIGHT];
1546 case 0xC7: index = 128; break; // Ç
1547 case 0xFC: index = 129; break; // ü
1548 case 0xE9: index = 130; break; // é
1549 case 0xE2: index = 131; break; // â
1550 case 0xE4: index = 132; break; // ä
1551 case 0xE0: index = 133; break; // à
1552 case 0xE5: index = 134; break; // å
1553 case 0xE7: index = 135; break; // ç
1554 case 0xEA: index = 136; break; // ê
1555 case 0xEB: index = 137; break; // ë
1556 case 0xE8: index = 138; break; // è
1557 case 0xEF: index = 139; break; // ï
1558 case 0xEE: index = 140; break; // î
1559 case 0xEC: index = 141; break; // ì
1560 case 0xC4: index = 142; break; // Ä
1561 case 0xC5: index = 143; break; // Å
1564 return &VTermFont[index*FONT_HEIGHT];
1567 EXPORTAS(&giVT_CharWidth, giVT_CharWidth);
1568 EXPORTAS(&giVT_CharHeight, giVT_CharHeight);
1569 EXPORT(VT_Font_Render);
1570 EXPORT(VT_Colour12to24);