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 VFS_SelectNode(Node, VFS_SELECT_READ, NULL);
435 avail_bytes = term->InputRead - term->InputWrite;
438 avail_bytes += MAX_INPUT_CHARS8;
439 if(avail_bytes > Length - pos)
440 avail_bytes = Length - pos;
442 while( avail_bytes -- )
444 ((char*)Buffer)[pos] = term->InputBuffer[term->InputRead];
447 term->InputRead %= MAX_INPUT_CHARS8;
458 VFS_SelectNode(Node, VFS_SELECT_READ, NULL);
460 avail = term->InputRead - term->InputWrite;
462 avail += MAX_INPUT_CHARS32;
463 if(avail > Length - pos)
464 avail = Length/4 - pos;
469 ((Uint32*)Buffer)[pos] = ((Uint32*)term->InputBuffer)[term->InputRead];
472 term->InputRead %= MAX_INPUT_CHARS32;
479 // Mark none avaliable if buffer empty
480 if( term->InputRead == term->InputWrite )
481 VFS_MarkAvaliable(&term->Node, 0);
483 term->ReadingThread = -1;
485 Mutex_Release( &term->ReadingLock );
491 * \fn Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
492 * \brief Write to a virtual terminal
494 Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
496 tVTerm *term = &gVT_Terminals[ Node->Inode ];
504 VT_int_PutString(term, Buffer, Length);
510 size = term->Width*term->Height*4;
511 if( Offset > size ) {
512 Log_Notice("VTerm", "VT_Write: Offset (0x%llx) > FBSize (0x%x)",
516 if( Offset + Length > size ) {
517 Log_Notice("VTerm", "VT_Write: Offset+Length (0x%llx) > FBSize (0x%x)",
518 Offset+Length, size);
519 Length = size - Offset;
522 // Copy to the local cache
523 memcpy( (void*)((Uint)term->Buffer + (Uint)Offset), Buffer, Length );
525 // Update screen if needed
526 if( Node->Inode == giVT_CurrentTerminal )
528 // Fill entire screen?
529 if( giVT_RealWidth > term->Width || giVT_RealHeight > term->Height )
531 // No? :( Well, just center it
533 x = Offset/4; y = x / term->Width; x %= term->Width;
534 w = Length/4+x; h = w / term->Width; w %= term->Width;
536 x += (giVT_RealWidth - term->Width) / 2;
537 y += (giVT_RealHeight - term->Height) / 2;
540 VFS_WriteAt( giVT_OutputDevHandle,
541 (x + y * giVT_RealWidth)*4,
545 Buffer = (void*)( (Uint)Buffer + term->Width*4 );
551 return VFS_WriteAt( giVT_OutputDevHandle, Offset, Length, Buffer );
554 // Just pass on (for now)
555 // TODO: Handle locally too to ensure no information is lost on
556 // VT Switch (and to isolate terminals from each other)
557 case TERM_MODE_2DACCEL:
558 //case TERM_MODE_3DACCEL:
559 if( Node->Inode == giVT_CurrentTerminal )
561 VFS_Write( giVT_OutputDevHandle, Length, Buffer );
570 * \fn int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
571 * \brief Call an IO Control on a virtual terminal
573 int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
577 tVTerm *term = Node->ImplPtr;
578 ENTER("pNode iId pData", Node, Id, Data);
580 if(Id >= DRV_IOCTL_LOOKUP) {
581 // Only root can fiddle with graphics modes
582 // TODO: Remove this and replace with user ownership
583 if( Threads_GetUID() != 0 ) return -1;
590 LEAVE('i', DRV_TYPE_TERMINAL);
591 return DRV_TYPE_TERMINAL;
592 case DRV_IOCTL_IDENT:
593 memcpy(Data, "VT\0\0", 4);
596 case DRV_IOCTL_VERSION:
599 case DRV_IOCTL_LOOKUP:
603 // Get/Set the mode (and apply any changes)
604 case TERM_IOCTL_MODETYPE:
607 if( CheckMem(Data, sizeof(int)) == 0 ) {
611 Log_Log("VTerm", "VTerm %i mode set to %i", (int)Node->Inode, *iData);
613 // Update mode if needed
614 if( term->Mode != *iData
618 // Adjust for text mode
619 if( *iData == TERM_MODE_TEXT ) {
620 term->NewHeight *= giVT_CharHeight;
621 term->NewWidth *= giVT_CharWidth;
623 // Fill unchanged dimensions
624 if(term->NewHeight == 0) term->NewHeight = term->Height;
625 if(term->NewWidth == 0) term->NewWidth = term->Width;
627 VT_int_ChangeMode(term, *iData, term->NewWidth, term->NewHeight);
628 // Clear unapplied dimensions
633 // Update the screen dimensions
634 if(Node->Inode == giVT_CurrentTerminal)
635 VT_SetTerminal( giVT_CurrentTerminal );
637 LEAVE('i', term->Mode);
640 // Get/set the terminal width
641 case TERM_IOCTL_WIDTH:
643 if( CheckMem(Data, sizeof(int)) == 0 ) {
647 term->NewWidth = *iData;
650 ret = term->NewWidth;
651 else if( term->Mode == TERM_MODE_TEXT )
652 ret = term->TextWidth;
658 // Get/set the terminal height
659 case TERM_IOCTL_HEIGHT:
661 if( CheckMem(Data, sizeof(int)) == 0 ) {
665 term->NewHeight = *iData;
667 if( term->NewHeight )
668 ret = term->NewHeight;
669 else if( term->Mode == TERM_MODE_TEXT )
670 ret = term->TextHeight;
676 case TERM_IOCTL_FORCESHOW:
677 Log_Log("VTerm", "Thread %i forced VTerm %i to be shown",
678 Threads_GetTID(), (int)Node->Inode);
679 VT_SetTerminal( Node->Inode );
688 * \fn void VT_SetTerminal(int ID)
689 * \brief Set the current terminal
691 void VT_SetTerminal(int ID)
693 // Update current terminal ID
694 Log_Log("VTerm", "Changed terminal from %i to %i", giVT_CurrentTerminal, ID);
695 giVT_CurrentTerminal = ID;
696 gpVT_CurTerm = &gVT_Terminals[ID];
699 if( gpVT_CurTerm->Mode == TERM_MODE_TEXT && !(gpVT_CurTerm->Flags & VT_FLAG_HIDECSR) )
701 tVideo_IOCtl_Pos pos;
702 pos.x = (gpVT_CurTerm->WritePos - gpVT_CurTerm->ViewPos) % gpVT_CurTerm->TextWidth;
703 pos.y = (gpVT_CurTerm->WritePos - gpVT_CurTerm->ViewPos) / gpVT_CurTerm->TextWidth;
704 if( pos.x < gpVT_CurTerm->TextHeight )
705 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSOR, &pos);
708 if( gpVT_CurTerm->Mode == TERM_MODE_TEXT )
709 VT_SetMode( VIDEO_BUFFMT_TEXT );
711 VT_SetMode( VIDEO_BUFFMT_FRAMEBUFFER );
714 VT_int_UpdateScreen( &gVT_Terminals[ ID ], 1 );
718 * \fn void VT_KBCallBack(Uint32 Codepoint)
719 * \brief Called on keyboard interrupt
720 * \param Codepoint Pseudo-UTF32 character
722 * Handles a key press and sends the key code to the user's buffer.
723 * If the code creates a kernel-magic sequence, it is not passed to the
724 * user and is handled in-kernel.
726 void VT_KBCallBack(Uint32 Codepoint)
728 tVTerm *term = gpVT_CurTerm;
730 // How the hell did we get a codepoint of zero?
731 if(Codepoint == 0) return;
734 if( Codepoint & 0x80000000 )
736 Codepoint &= 0x7FFFFFFF;
740 case KEY_RSHIFT: gbVT_CtrlDown = 0; break;
741 case KEY_LSHIFT: gbVT_AltDown = 0; break;
743 case KEY_LALT: gbVT_AltDown &= ~1; break;
744 case KEY_RALT: gbVT_AltDown &= ~2; break;
745 case KEY_LCTRL: gbVT_CtrlDown &= ~1 break;
746 case KEY_RCTRL: gbVT_CtrlDown &= ~2; break;
754 #if !USE_CTRL_ALT // HACK: Use both shifts instead of Ctrl-Alt
755 case KEY_RSHIFT: gbVT_CtrlDown = 1; break;
756 case KEY_LSHIFT: gbVT_AltDown = 1; break;
758 case KEY_LALT: gbVT_AltDown |= 1; break;
759 case KEY_RALT: gbVT_AltDown |= 2; break;
760 case KEY_LCTRL: gbVT_CtrlDown |= 1; break;
761 case KEY_RCTRL: gbVT_CtrlDown |= 2; break;
765 if(!gbVT_AltDown || !gbVT_CtrlDown)
769 case KEY_F1: VT_SetTerminal(0); return;
770 case KEY_F2: VT_SetTerminal(1); return;
771 case KEY_F3: VT_SetTerminal(2); return;
772 case KEY_F4: VT_SetTerminal(3); return;
773 case KEY_F5: VT_SetTerminal(4); return;
774 case KEY_F6: VT_SetTerminal(5); return;
775 case KEY_F7: VT_SetTerminal(6); return;
776 case KEY_F8: VT_SetTerminal(7); return;
777 case KEY_F9: VT_SetTerminal(8); return;
778 case KEY_F10: VT_SetTerminal(9); return;
779 case KEY_F11: VT_SetTerminal(10); return;
780 case KEY_F12: VT_SetTerminal(11); return;
783 if( gpVT_CurTerm->ViewPos > gpVT_CurTerm->Width )
784 gpVT_CurTerm->ViewPos -= gpVT_CurTerm->Width;
786 gpVT_CurTerm->ViewPos = 0;
789 if( gpVT_CurTerm->ViewPos < gpVT_CurTerm->Width*gpVT_CurTerm->Height*(giVT_Scrollback-1) )
790 gpVT_CurTerm->ViewPos += gpVT_CurTerm->Width;
792 gpVT_CurTerm->ViewPos = gpVT_CurTerm->Width*gpVT_CurTerm->Height*(giVT_Scrollback-1);
798 if(term->Mode == TERM_MODE_TEXT)
803 // Ignore Modifer Keys
804 if(Codepoint > KEY_MODIFIERS) return;
806 // Get UTF-8/ANSI Encoding
810 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'D';
814 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'C';
818 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'A';
822 buf[0] = '\x1B'; buf[1] = '['; buf[2] = 'B';
827 buf[0] = '\x1B'; buf[1] = '['; buf[2] = '5'; // Some overline also
828 //len = 4; // Commented out until I'm sure
834 // Attempt to encode in UTF-8
836 len = WriteUTF8( buf, Codepoint );
838 Warning("Codepoint (%x) is unrepresentable in UTF-8", Codepoint);
844 // Unprintable / Don't Pass
849 if( MAX_INPUT_CHARS8 - term->InputWrite >= len )
850 memcpy( &term->InputBuffer[term->InputWrite], buf, len );
852 memcpy( &term->InputBuffer[term->InputWrite], buf, MAX_INPUT_CHARS8 - term->InputWrite );
853 memcpy( &term->InputBuffer[0], buf, len - (MAX_INPUT_CHARS8 - term->InputWrite) );
855 // Roll the buffer over
856 term->InputWrite += len;
857 term->InputWrite %= MAX_INPUT_CHARS8;
858 if( (term->InputWrite - term->InputRead + MAX_INPUT_CHARS8)%MAX_INPUT_CHARS8 < len ) {
859 term->InputRead = term->InputWrite + 1;
860 term->InputRead %= MAX_INPUT_CHARS8;
865 // Encode the raw UTF-32 Key
866 ((Uint32*)term->InputBuffer)[ term->InputWrite ] = Codepoint;
868 term->InputWrite %= MAX_INPUT_CHARS32;
869 if(term->InputRead == term->InputWrite) {
871 term->InputRead %= MAX_INPUT_CHARS32;
875 VFS_MarkAvaliable(&term->Node, 1);
877 // Wake up the thread waiting on us
878 //if( term->ReadingThread >= 0 ) {
879 // Threads_WakeTID(term->ReadingThread);
884 * \fn void VT_int_ClearLine(tVTerm *Term, int Num)
885 * \brief Clears a line in a virtual terminal
887 void VT_int_ClearLine(tVTerm *Term, int Num)
890 tVT_Char *cell = &Term->Text[ Num*Term->TextWidth ];
891 if( Num < 0 || Num >= Term->TextHeight * (giVT_Scrollback + 1) ) return ;
892 //ENTER("pTerm iNum", Term, Num);
893 for( i = Term->TextWidth; i--; )
896 cell[ i ].Colour = Term->CurColour;
902 * \fn int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
903 * \brief Parses a VT100 Escape code
905 int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
910 int args[6] = {0,0,0,0};
918 if( '0' <= c && c <= '9' )
921 if(c == ';') c = Buffer[j++];
922 while('0' <= c && c <= '9') {
932 if( ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'))
938 if(argc == 1) tmp = args[0];
941 if( Term->WritePos-(tmp-1) % Term->TextWidth == 0 )
942 Term->WritePos -= Term->WritePos % Term->TextWidth;
944 Term->WritePos -= tmp;
949 if(argc == 1) tmp = args[0];
951 if( (Term->WritePos + tmp) % Term->TextWidth == 0 ) {
952 Term->WritePos -= Term->WritePos % Term->TextWidth;
953 Term->WritePos += Term->TextWidth - 1;
955 Term->WritePos += tmp;
965 int i = Term->TextHeight * (giVT_Scrollback + 1);
966 while( i-- ) VT_int_ClearLine(Term, i);
969 VT_int_UpdateScreen(Term, 1);
974 // Set cursor position
976 Term->WritePos = args[0] + args[1]*Term->TextWidth;
977 Log_Debug("VTerm", "args = {%i, %i}", args[0], args[1]);
984 if( 0 <= args[argc] && args[argc] <= 8)
988 case 0: Term->CurColour = DEFAULT_COLOUR; break; // Reset
989 case 1: Term->CurColour |= 0x80000000; break; // Bright
990 case 2: Term->CurColour &= ~0x80000000; break; // Dim
994 else if(30 <= args[argc] && args[argc] <= 37) {
995 Term->CurColour &= 0xF000FFFF;
996 Term->CurColour |= (Uint32)caVT100Colours[ args[argc]-30+(Term->CurColour>>28) ] << 16;
999 else if(40 <= args[argc] && args[argc] <= 47) {
1000 Term->CurColour &= 0xFFFF8000;
1001 Term->CurColour |= caVT100Colours[ args[argc]-40+((Term->CurColour>>12)&15) ];
1006 Log_Warning("VTerm", "Unknown control sequence");
1015 //Log_Debug("VTerm", "j = %i, Buffer = '%s'", j, Buffer);
1020 * \fn void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
1021 * \brief Print a string to the Virtual Terminal
1023 void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
1029 for( i = 0; i < Count; i++ )
1031 // Handle escape sequences
1032 if( Buffer[i] == 0x1B )
1035 i += VT_int_ParseEscape(Term, (char*)&Buffer[i]) - 1;
1039 // Fast check for non UTF-8
1040 if( Buffer[i] < 128 ) // Plain ASCII
1041 VT_int_PutChar(Term, Buffer[i]);
1043 i += ReadUTF8(&Buffer[i], &val) - 1;
1044 VT_int_PutChar(Term, val);
1048 VT_int_UpdateScreen( Term, 0 );
1051 if( Term == gpVT_CurTerm && !(Term->Flags & VT_FLAG_HIDECSR) )
1053 tVideo_IOCtl_Pos pos;
1054 pos.x = (Term->WritePos - Term->ViewPos) % Term->TextWidth;
1055 pos.y = (Term->WritePos - Term->ViewPos) / Term->TextWidth;
1056 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSOR, &pos);
1061 * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
1062 * \brief Write a single character to a VTerm
1064 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
1070 case '\0': return; // Ignore NULL byte
1072 VT_int_UpdateScreen( Term, 0 ); // Update the line before newlining
1073 Term->WritePos += Term->TextWidth;
1075 Term->WritePos -= Term->WritePos % Term->TextWidth;
1080 Term->Text[ Term->WritePos ].Ch = '\0';
1081 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1083 } while(Term->WritePos & 7);
1087 // Backspace is invalid at Offset 0
1088 if(Term->WritePos == 0) break;
1092 if(Term->Text[ Term->WritePos ].Ch != '\0') {
1093 Term->Text[ Term->WritePos ].Ch = 0;
1094 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1098 i = 7; // Limit it to 8
1100 Term->Text[ Term->WritePos ].Ch = 0;
1101 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1103 } while(Term->WritePos && i-- && Term->Text[ Term->WritePos ].Ch == '\0');
1104 if(Term->Text[ Term->WritePos ].Ch != '\0')
1109 Term->Text[ Term->WritePos ].Ch = Ch;
1110 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
1116 // - Check if we need to scroll the entire scrollback buffer
1117 if(Term->WritePos >= Term->TextWidth*Term->TextHeight*(giVT_Scrollback+1))
1122 Term->WritePos -= Term->TextWidth;
1124 VT_int_UpdateScreen( Term, 0 );
1126 // Update view position
1127 base = Term->TextWidth*Term->TextHeight*(giVT_Scrollback);
1128 if(Term->ViewPos < base)
1129 Term->ViewPos += Term->Width;
1130 if(Term->ViewPos > base)
1131 Term->ViewPos = base;
1133 // Scroll terminal cache
1134 base = Term->TextWidth*(Term->TextHeight*(giVT_Scrollback+1)-1);
1137 &Term->Text[Term->TextWidth],
1138 base*sizeof(tVT_Char)
1142 for( i = 0; i < Term->TextWidth; i ++ )
1144 Term->Text[ base + i ].Ch = 0;
1145 Term->Text[ base + i ].Colour = Term->CurColour;
1148 VT_int_ScrollFramebuffer( Term );
1149 VT_int_UpdateScreen( Term, 0 );
1151 // Ok, so we only need to scroll the screen
1152 else if(Term->WritePos >= Term->ViewPos + Term->TextWidth*Term->TextHeight)
1154 //Debug("Term->WritePos (%i) >= %i",
1156 // Term->ViewPos + Term->Width*Term->Height
1158 //Debug("Scrolling screen only");
1160 // Update the last line
1161 Term->WritePos -= Term->TextWidth;
1162 VT_int_UpdateScreen( Term, 0 );
1163 Term->WritePos += Term->TextWidth;
1164 VT_int_ClearLine(Term, Term->WritePos / Term->TextWidth);
1167 Term->ViewPos += Term->TextWidth;
1168 //Debug("Term->ViewPos = %i", Term->ViewPos);
1169 VT_int_ScrollFramebuffer( Term );
1170 VT_int_UpdateScreen( Term, 0 );
1177 * \fn void VT_int_ScrollFramebuffer( tVTerm *Term )
1178 * \note Scrolls the framebuffer by 1 text line
1180 void VT_int_ScrollFramebuffer( tVTerm *Term )
1190 // Only update if this is the current terminal
1191 if( Term != gpVT_CurTerm ) return;
1193 // Switch to 2D Command Stream
1194 tmp = VIDEO_BUFFMT_2DSTREAM;
1195 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETBUFFORMAT, &tmp);
1197 // BLIT from 0,0 to 0,giVT_CharHeight
1198 buf.Op = VIDEO_2DOP_BLIT;
1199 buf.DstX = 0; buf.DstY = 0;
1200 buf.SrcX = 0; buf.SrcY = giVT_CharHeight;
1201 buf.W = Term->TextWidth * giVT_CharWidth;
1202 buf.H = (Term->TextHeight-1) * giVT_CharHeight;
1203 VFS_WriteAt(giVT_OutputDevHandle, 0, sizeof(buf), &buf);
1205 // Restore old mode (this function is only called during text mode)
1206 tmp = VIDEO_BUFFMT_TEXT;
1207 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETBUFFORMAT, &tmp);
1211 * \fn void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
1212 * \brief Updates the video framebuffer
1214 void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
1216 // Only update if this is the current terminal
1217 if( Term != gpVT_CurTerm ) return;
1219 switch( Term->Mode )
1221 case TERM_MODE_TEXT:
1222 // Re copy the entire screen?
1225 giVT_OutputDevHandle,
1227 Term->TextWidth*Term->TextHeight*sizeof(tVT_Char),
1228 &Term->Text[Term->ViewPos]
1231 // Only copy the current line
1233 int pos = Term->WritePos - Term->WritePos % Term->TextWidth;
1235 giVT_OutputDevHandle,
1236 (pos - Term->ViewPos)*sizeof(tVT_Char),
1237 Term->TextWidth*sizeof(tVT_Char),
1244 giVT_OutputDevHandle,
1246 Term->Width*Term->Height*sizeof(Uint32),
1254 * \brief Update the screen mode
1255 * \param Term Terminal to update
1256 * \param NewMode New mode to set
1257 * \param NewWidth New framebuffer width
1258 * \param NewHeight New framebuffer height
1260 void VT_int_ChangeMode(tVTerm *Term, int NewMode, int NewWidth, int NewHeight)
1262 int oldW = Term->Width;
1263 int oldTW = oldW / giVT_CharWidth;
1264 int oldH = Term->Height;
1265 int oldTH = oldH / giVT_CharWidth;
1266 tVT_Char *oldTBuf = Term->Text;
1267 Uint32 *oldFB = Term->Buffer;
1270 // TODO: Increase RealWidth/RealHeight when this happens
1271 if(NewWidth > giVT_RealWidth) NewWidth = giVT_RealWidth;
1272 if(NewHeight > giVT_RealHeight) NewHeight = giVT_RealHeight;
1274 // Calculate new dimensions
1275 Term->TextWidth = NewWidth / giVT_CharWidth;
1276 Term->TextHeight = NewHeight / giVT_CharHeight;
1277 Term->Width = NewWidth;
1278 Term->Height = NewHeight;
1279 Term->Mode = NewMode;
1281 // Allocate new buffers
1283 Term->Text = calloc(
1284 Term->TextWidth * Term->TextHeight * (giVT_Scrollback+1),
1290 if( w > Term->TextWidth ) w = Term->TextWidth;
1292 if( h > Term->TextHeight ) h = Term->TextHeight;
1293 h *= giVT_Scrollback + 1;
1294 for( i = 0; i < h; i ++ )
1297 &Term->Text[i*Term->TextWidth],
1306 Term->Buffer = calloc( Term->Width * Term->Height, sizeof(Uint32) );
1310 if( w > Term->Width ) w = Term->Width;
1312 if( h > Term->Height ) h = Term->Height;
1313 for( i = 0; i < h; i ++ )
1316 &Term->Buffer[i*Term->Width],
1327 case TERM_MODE_TEXT:
1328 Log_Log("VTerm", "Set VT %p to text mode (%ix%i)",
1329 Term, Term->TextWidth, Term->TextHeight);
1332 Log_Log("VTerm", "Set VT %p to framebuffer mode (%ix%i)",
1333 Term, Term->Width, Term->Height);
1335 //case TERM_MODE_2DACCEL:
1336 //case TERM_MODE_3DACCEL:
1344 #define MONOSPACE_FONT 10816
1346 #if MONOSPACE_FONT == 10808 // 8x8
1347 # include "vterm_font_8x8.h"
1348 #elif MONOSPACE_FONT == 10816 // 8x16
1349 # include "vterm_font_8x16.h"
1352 // === PROTOTYPES ===
1353 Uint8 *VT_Font_GetChar(Uint32 Codepoint);
1356 int giVT_CharWidth = FONT_WIDTH;
1357 int giVT_CharHeight = FONT_HEIGHT;
1361 * \brief Render a font character
1363 void VT_Font_Render(Uint32 Codepoint, void *Buffer, int Depth, int Pitch, Uint32 BGC, Uint32 FGC)
1371 Uint8 *buf = Buffer;
1373 font = VT_Font_GetChar(Codepoint);
1375 for(y = 0; y < FONT_HEIGHT; y ++)
1377 for(x = 0; x < FONT_WIDTH; x ++)
1379 if(*font & (1 << (FONT_WIDTH-x-1)))
1384 buf = (void*)( (tVAddr)buf + Pitch );
1389 else if( Depth <= 16 )
1391 Uint16 *buf = Buffer;
1393 font = VT_Font_GetChar(Codepoint);
1395 for(y = 0; y < FONT_HEIGHT; y ++)
1397 for(x = 0; x < FONT_WIDTH; x ++)
1399 if(*font & (1 << (FONT_WIDTH-x-1)))
1404 buf = (void*)( (tVAddr)buf + Pitch );
1409 // - Special handling to not overwrite the next pixel
1410 //TODO: Endian issues here
1411 else if( Depth == 24 )
1413 Uint8 *buf = Buffer;
1414 Uint8 bg_r = (BGC >> 16) & 0xFF;
1415 Uint8 bg_g = (BGC >> 8) & 0xFF;
1416 Uint8 bg_b = (BGC >> 0) & 0xFF;
1417 Uint8 fg_r = (FGC >> 16) & 0xFF;
1418 Uint8 fg_g = (FGC >> 8) & 0xFF;
1419 Uint8 fg_b = (FGC >> 0) & 0xFF;
1421 font = VT_Font_GetChar(Codepoint);
1423 for(y = 0; y < FONT_HEIGHT; y ++)
1425 for(x = 0; x < FONT_WIDTH; x ++)
1429 if(*font & (1 << (FONT_WIDTH-x-1))) {
1430 r = fg_r; g = fg_g; b = fg_b;
1433 r = bg_r; g = bg_g; b = bg_b;
1439 buf = (void*)( (tVAddr)buf + Pitch );
1443 // 32-bpp colour (nice and easy)
1444 else if( Depth == 32 )
1446 Uint32 *buf = Buffer;
1448 font = VT_Font_GetChar(Codepoint);
1450 for(y = 0; y < FONT_HEIGHT; y ++)
1452 for(x = 0; x < FONT_WIDTH; x ++)
1454 if(*font & (1 << (FONT_WIDTH-x-1)))
1459 buf = (Uint32*)( (tVAddr)buf + Pitch );
1466 * \fn Uint32 VT_Colour12to24(Uint16 Col12)
1467 * \brief Converts a 12-bit colour into 24 bits
1469 Uint32 VT_Colour12to24(Uint16 Col12)
1474 ret = (tmp << 0) | (tmp << 4);
1475 tmp = (Col12 & 0xF0) >> 4;
1476 ret |= (tmp << 8) | (tmp << 12);
1477 tmp = (Col12 & 0xF00) >> 8;
1478 ret |= (tmp << 16) | (tmp << 20);
1482 * \brief Converts a 12-bit colour into 15 bits
1484 Uint16 VT_Colour12to15(Uint16 Col12)
1489 ret = (tmp << 1) | (tmp & 1);
1490 tmp = (Col12 & 0xF0) >> 4;
1491 ret |= ( (tmp << 1) | (tmp & 1) ) << 5;
1492 tmp = (Col12 & 0xF00) >> 8;
1493 ret |= ( (tmp << 1) | (tmp & 1) ) << 10;
1498 * \brief Converts a 12-bit colour into any other depth
1499 * \param Col12 12-bit source colour
1500 * \param Depth Desired bit deptj
1501 * \note Green then blue get the extra avaliable bits (16:5-6-5, 14:4-5-5)
1503 Uint32 VT_Colour12toN(Uint16 Col12, int Depth)
1507 int rSize, gSize, bSize;
1510 if( Depth == 24 ) return VT_Colour12to24(Col12);
1511 if( Depth == 15 ) return VT_Colour12to15(Col12);
1512 // - 32 is a special case, it's usually 24-bit colour with an unused byte
1513 if( Depth == 32 ) return VT_Colour12to24(Col12);
1516 if( Depth < 8 ) return 0;
1517 if( Depth > 32 ) return 0;
1520 g = (Col12 & 0xF0) >> 4;
1521 b = (Col12 & 0xF00) >> 8;
1523 rSize = gSize = bSize = Depth / 3;
1524 if( rSize + gSize + bSize < Depth ) // Depth % 3 == 1
1526 if( rSize + gSize + bSize < Depth ) // Depth % 3 == 2
1530 r <<= rSize - 4; g <<= gSize - 4; b <<= bSize - 4;
1531 // Fill with the lowest bit
1532 if( Col12 & 0x001 ) r |= (1 << (rSize - 4)) - 1;
1533 if( Col12 & 0x010 ) r |= (1 << (gSize - 4)) - 1;
1534 if( Col12 & 0x100 ) r |= (1 << (bSize - 4)) - 1;
1539 ret |= b << (rSize + gSize);
1545 * \fn Uint8 *VT_Font_GetChar(Uint32 Codepoint)
1546 * \brief Gets an index into the font array given a Unicode Codepoint
1547 * \note See http://en.wikipedia.org/wiki/CP437
1549 Uint8 *VT_Font_GetChar(Uint32 Codepoint)
1553 return &VTermFont[Codepoint*FONT_HEIGHT];
1556 case 0xC7: index = 128; break; // Ç
1557 case 0xFC: index = 129; break; // ü
1558 case 0xE9: index = 130; break; // é
1559 case 0xE2: index = 131; break; // â
1560 case 0xE4: index = 132; break; // ä
1561 case 0xE0: index = 133; break; // à
1562 case 0xE5: index = 134; break; // å
1563 case 0xE7: index = 135; break; // ç
1564 case 0xEA: index = 136; break; // ê
1565 case 0xEB: index = 137; break; // ë
1566 case 0xE8: index = 138; break; // è
1567 case 0xEF: index = 139; break; // ï
1568 case 0xEE: index = 140; break; // î
1569 case 0xEC: index = 141; break; // ì
1570 case 0xC4: index = 142; break; // Ä
1571 case 0xC5: index = 143; break; // Å
1574 return &VTermFont[index*FONT_HEIGHT];
1577 EXPORTAS(&giVT_CharWidth, giVT_CharWidth);
1578 EXPORTAS(&giVT_CharHeight, giVT_CharHeight);
1579 EXPORT(VT_Font_Render);
1580 EXPORT(VT_Colour12to24);