3 * - By John Hodge (thePowersGang)
6 * - Virtual Terminal - Initialisation and VFS Interface
12 #include <api_drv_keyboard.h>
13 #include <api_drv_video.h>
15 #include <semaphore.h>
18 #define VERSION ((0<<8)|(50))
21 //#define DEFAULT_OUTPUT "BochsGA"
22 #define DEFAULT_OUTPUT "Vesa"
23 #define FALLBACK_OUTPUT "x86_VGAText"
24 #define DEFAULT_INPUT "Keyboard"
25 #define DEFAULT_WIDTH 640
26 #define DEFAULT_HEIGHT 480
27 #define DEFAULT_SCROLLBACK 4 // 2 Screens of text + current screen
28 //#define DEFAULT_SCROLLBACK 0
33 extern void Debug_SetKTerminal(const char *File);
36 int VT_Install(char **Arguments);
37 char *VT_ReadDir(tVFS_Node *Node, int Pos);
38 tVFS_Node *VT_FindDir(tVFS_Node *Node, const char *Name);
39 int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data);
40 size_t VT_Read(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer);
41 size_t VT_Write(tVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer);
42 int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data);
43 void VT_Terminal_Reference(tVFS_Node *Node);
44 void VT_Terminal_Close(tVFS_Node *Node);
45 //void VT_SetTerminal(int Term);
50 MODULE_DEFINE(0, VERSION, VTerm, VT_Install, NULL, NULL);
51 tVFS_NodeType gVT_RootNodeType = {
52 .TypeName = "VTerm Root",
53 .ReadDir = VT_ReadDir,
54 .FindDir = VT_FindDir,
55 .IOCtl = VT_Root_IOCtl
57 tVFS_NodeType gVT_TermNodeType = {
61 .IOCtl = VT_Terminal_IOCtl
63 tDevFS_Driver gVT_DrvInfo = {
66 .Flags = VFS_FFLAG_DIRECTORY,
70 .Type = &gVT_RootNodeType
74 tVTerm gVT_Terminals[NUM_VTS];
75 int giVT_CurrentTerminal = 0;
76 tVTerm *gpVT_CurTerm = &gVT_Terminals[0];
77 // --- Video State ---
78 short giVT_RealWidth = DEFAULT_WIDTH; //!< Screen Width
79 short giVT_RealHeight = DEFAULT_HEIGHT; //!< Screen Height
80 int giVT_Scrollback = DEFAULT_SCROLLBACK;
81 // --- Driver Handles ---
82 char *gsVT_OutputDevice = NULL;
83 char *gsVT_InputDevice = NULL;
84 int giVT_OutputDevHandle = -2;
85 int giVT_InputDevHandle = -2;
89 * \fn int VT_Install(char **Arguments)
90 * \brief Installs the Virtual Terminal Driver
92 int VT_Install(char **Arguments)
101 for(args = Arguments; (arg = *args); args++ )
103 char data[strlen(arg)+1];
107 val = strchr(arg, '=');
110 data[ val - arg ] = '\0';
113 Log_Debug("VTerm", "Argument '%s'", arg);
115 if( strcmp(opt, "Video") == 0 ) {
116 if( !gsVT_OutputDevice )
117 gsVT_OutputDevice = strdup(val);
119 else if( strcmp(opt, "Input") == 0 ) {
120 if( !gsVT_InputDevice )
121 gsVT_InputDevice = strdup(val);
123 else if( strcmp(opt, "Width") == 0 ) {
124 giVT_RealWidth = atoi( val );
126 else if( strcmp(opt, "Height") == 0 ) {
127 giVT_RealHeight = atoi( val );
129 else if( strcmp(opt, "Scrollback") == 0 ) {
130 giVT_Scrollback = atoi( val );
136 if(!gsVT_OutputDevice) gsVT_OutputDevice = (char*)DEFAULT_OUTPUT;
137 else if( Module_EnsureLoaded( gsVT_OutputDevice ) ) gsVT_OutputDevice = (char*)DEFAULT_OUTPUT;
138 if( Module_EnsureLoaded( gsVT_OutputDevice ) ) gsVT_OutputDevice = (char*)FALLBACK_OUTPUT;
139 if( Module_EnsureLoaded( gsVT_OutputDevice ) ) {
140 Log_Error("VTerm", "Fallback video '%s' is not avaliable, giving up", FALLBACK_OUTPUT);
141 return MODULE_ERR_MISC;
144 if(!gsVT_InputDevice) gsVT_InputDevice = (char*)DEFAULT_INPUT;
145 else if( Module_EnsureLoaded( gsVT_InputDevice ) ) gsVT_InputDevice = (char*)DEFAULT_INPUT;
146 if( Module_EnsureLoaded( gsVT_InputDevice ) ) {
147 Log_Error("VTerm", "Fallback input '%s' is not avaliable, input will not be avaliable", DEFAULT_INPUT);
150 // Create device paths
153 tmp = malloc( 9 + strlen(gsVT_OutputDevice) + 1 );
154 strcpy(tmp, "/Devices/");
155 strcpy(&tmp[9], gsVT_OutputDevice);
156 gsVT_OutputDevice = tmp;
158 tmp = malloc( 9 + strlen(gsVT_InputDevice) + 1 );
159 strcpy(tmp, "/Devices/");
160 strcpy(&tmp[9], gsVT_InputDevice);
161 gsVT_InputDevice = tmp;
164 Log_Log("VTerm", "Using '%s' as output", gsVT_OutputDevice);
165 Log_Log("VTerm", "Using '%s' as input", gsVT_InputDevice);
172 Log_Debug("VTerm", "Initialising nodes (and creating buffers)");
173 for( i = 0; i < NUM_VTS; i++ )
175 gVT_Terminals[i].Mode = TERM_MODE_TEXT;
176 gVT_Terminals[i].Flags = 0;
177 // gVT_Terminals[i].Flags = VT_FLAG_HIDECSR; //HACK - Stop all those memcpy calls
178 gVT_Terminals[i].CurColour = DEFAULT_COLOUR;
179 gVT_Terminals[i].WritePos = 0;
180 gVT_Terminals[i].AltWritePos = 0;
181 gVT_Terminals[i].ViewPos = 0;
182 gVT_Terminals[i].ReadingThread = -1;
183 gVT_Terminals[i].ScrollHeight = 0;
186 VT_int_ChangeMode( &gVT_Terminals[i],
187 TERM_MODE_TEXT, giVT_RealWidth, giVT_RealHeight );
189 gVT_Terminals[i].Name[0] = '0'+i;
190 gVT_Terminals[i].Name[1] = '\0';
191 gVT_Terminals[i].Node.Inode = i;
192 gVT_Terminals[i].Node.ImplPtr = &gVT_Terminals[i];
193 gVT_Terminals[i].Node.NumACLs = 0; // Only root can open virtual terminals
195 gVT_Terminals[i].Node.Type = &gVT_TermNodeType;
196 // Semaphore_Init(&gVT_Terminals[i].InputSemaphore, 0, MAX_INPUT_CHARS8, "VTerm", gVT_Terminals[i].Name);
199 Log_Debug("VTerm", "Registering with DevFS");
201 DevFS_AddDevice( &gVT_DrvInfo );
203 // Set kernel output to VT0
204 Log_Debug("VTerm", "Setting kernel output to VT#0");
205 Debug_SetKTerminal("/Devices/VTerm/0");
207 return MODULE_ERR_OK;
211 * \brief Set the video resolution
212 * \param Width New screen width
213 * \param Height New screen height
215 void VT_SetResolution(int Width, int Height)
217 tVideo_IOCtl_Mode mode = {0};
221 // Create the video mode
223 mode.height = Height;
228 VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_FINDMODE, &mode );
230 if( Width != mode.width || Height != mode.height )
233 "Selected resolution (%ix%i) is not supported by the device, using (%ix%i)",
234 giVT_RealWidth, giVT_RealHeight,
235 mode.width, mode.height
237 giVT_RealWidth = mode.width;
238 giVT_RealHeight = mode.height;
240 VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_GETSETMODE, &tmp );
242 // Resize text terminals if needed
243 if( gVT_Terminals[0].Text && (giVT_RealWidth != mode.width || giVT_RealHeight != mode.height) )
245 int newBufSize = (giVT_RealWidth/giVT_CharWidth)
246 *(giVT_RealHeight/giVT_CharHeight)
247 *(giVT_Scrollback+1);
249 // Resize the text terminals
250 Log_Debug("VTerm", "Resizing terminals to %ix%i",
251 giVT_RealWidth/giVT_CharWidth, giVT_RealHeight/giVT_CharHeight);
252 for( i = 0; i < NUM_VTS; i ++ )
254 if( gVT_Terminals[i].Mode != TERM_MODE_TEXT ) continue;
256 gVT_Terminals[i].TextWidth = giVT_RealWidth/giVT_CharWidth;
257 gVT_Terminals[i].TextHeight = giVT_RealHeight/giVT_CharHeight;
258 gVT_Terminals[i].ScrollHeight = gVT_Terminals[i].TextHeight;
260 gVT_Terminals[i].Text = realloc(
261 gVT_Terminals[i].Text,
262 newBufSize*sizeof(tVT_Char)
269 * \fn char *VT_ReadDir(tVFS_Node *Node, int Pos)
270 * \brief Read from the VTerm Directory
272 char *VT_ReadDir(tVFS_Node *Node, int Pos)
274 if(Pos < 0) return NULL;
275 if(Pos >= NUM_VTS) return NULL;
276 return strdup( gVT_Terminals[Pos].Name );
280 * \fn tVFS_Node *VT_FindDir(tVFS_Node *Node, const char *Name)
281 * \brief Find an item in the VTerm directory
282 * \param Node Root node
283 * \param Name Name (number) of the terminal
285 tVFS_Node *VT_FindDir(tVFS_Node *Node, const char *Name)
289 ENTER("pNode sName", Node, Name);
291 // Open the input and output files if needed
292 if(giVT_OutputDevHandle == -2) VT_InitOutput();
293 if(giVT_InputDevHandle == -2) VT_InitInput();
296 if(Name[0] < '0' || Name[0] > '9' || Name[1] != '\0') {
307 LEAVE('p', &gVT_Terminals[num].Node);
308 return &gVT_Terminals[num].Node;
312 * \fn int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data)
313 * \brief Control the VTerm Driver
315 int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data)
320 case DRV_IOCTL_TYPE: return DRV_TYPE_MISC;
321 case DRV_IOCTL_IDENT: memcpy(Data, "VT\0\0", 4); return 0;
322 case DRV_IOCTL_VERSION: return VERSION;
323 case DRV_IOCTL_LOOKUP: return 0;
325 case 4: // Get Video Driver
326 if(Data) strcpy(Data, gsVT_OutputDevice);
327 return strlen(gsVT_OutputDevice);
329 case 5: // Set Video Driver
330 if(!Data) return -EINVAL;
331 if(Threads_GetUID() != 0) return -EACCES;
335 // TODO: Check if the string used is a heap string
337 free(gsVT_OutputDevice);
339 gsVT_OutputDevice = malloc(len+1);
340 strcpy(gsVT_OutputDevice, Data);
342 VFS_Close(giVT_OutputDevHandle);
343 giVT_OutputDevHandle = -1;
352 * \brief Read from a virtual terminal
354 size_t VT_Read(tVFS_Node *Node, off_t Offset, size_t Length, void *Buffer)
357 tVTerm *term = &gVT_Terminals[ Node->Inode ];
358 Uint32 *codepoint_buf = Buffer;
359 Uint32 *codepoint_in;
361 Mutex_Acquire( &term->ReadingLock );
363 // Check current mode
368 VT_int_UpdateCursor(term, 1);
370 VFS_SelectNode(Node, VFS_SELECT_READ, NULL, "VT_Read (UTF-8)");
372 avail = term->InputWrite - term->InputRead;
374 avail += MAX_INPUT_CHARS8;
381 ((char*)Buffer)[pos] = term->InputBuffer[term->InputRead];
384 while(term->InputRead >= MAX_INPUT_CHARS8)
385 term->InputRead -= MAX_INPUT_CHARS8;
392 VFS_SelectNode(Node, VFS_SELECT_READ, NULL, "VT_Read (UCS-4)");
394 avail = term->InputWrite - term->InputRead;
396 avail += MAX_INPUT_CHARS32;
401 codepoint_in = (void*)term->InputBuffer;
402 codepoint_buf = Buffer;
407 codepoint_buf[pos] = codepoint_in[term->InputRead];
410 while(term->InputRead >= MAX_INPUT_CHARS32)
411 term->InputRead -= MAX_INPUT_CHARS32;
417 // Mark none avaliable if buffer empty
418 if( term->InputRead == term->InputWrite )
419 VFS_MarkAvaliable(&term->Node, 0);
421 term->ReadingThread = -1;
423 // VT_int_UpdateCursor(term, term->Mode == TERM_MODE_TEXT);
425 Mutex_Release( &term->ReadingLock );
431 * \brief Write to a virtual terminal
433 size_t VT_Write(tVFS_Node *Node, off_t Offset, size_t Length, const void *Buffer)
435 tVTerm *term = &gVT_Terminals[ Node->Inode ];
443 VT_int_PutString(term, Buffer, Length);
449 size = term->Width*term->Height*4;
450 if( Offset > size ) {
451 Log_Notice("VTerm", "VT_Write: Offset (0x%llx) > FBSize (0x%x)",
455 if( Offset + Length > size ) {
456 Log_Notice("VTerm", "VT_Write: Offset+Length (0x%llx) > FBSize (0x%x)",
457 Offset+Length, size);
458 Length = size - Offset;
461 // Update screen if needed
462 if( Node->Inode == giVT_CurrentTerminal )
464 if( giVT_RealHeight > term->Height )
465 Offset += (giVT_RealHeight - term->Height) / 2 * term->Width * 4;
466 // Handle undersized virtual terminals
467 if( giVT_RealWidth > term->Width )
469 // No? :( Well, just center it
472 // TODO: Fix to handle the final line correctly?
473 x = Offset/4; y = x / term->Width; x %= term->Width;
474 w = Length/4+x; h = w / term->Width; w %= term->Width;
477 x += (giVT_RealWidth - term->Width) / 2;
478 dst_ofs = (x + y * giVT_RealWidth) * 4;
481 VFS_WriteAt( giVT_OutputDevHandle,
486 Buffer = (void*)( (Uint)Buffer + term->Width*4 );
487 dst_ofs += giVT_RealWidth * 4;
493 return VFS_WriteAt( giVT_OutputDevHandle, Offset, Length, Buffer );
499 term->Buffer = malloc( term->Width * term->Height * 4 );
500 // Copy to the local cache
501 memcpy( (char*)term->Buffer + (Uint)Offset, Buffer, Length );
504 // Just pass on (for now)
505 // TODO: Handle locally too to ensure no information is lost on
506 // VT Switch (and to isolate terminals from each other)
507 case TERM_MODE_2DACCEL:
508 //case TERM_MODE_3DACCEL:
509 if( Node->Inode == giVT_CurrentTerminal )
511 VFS_Write( giVT_OutputDevHandle, Length, Buffer );
520 * \fn int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
521 * \brief Call an IO Control on a virtual terminal
523 int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
527 tVTerm *term = Node->ImplPtr;
528 ENTER("pNode iId pData", Node, Id, Data);
530 if(Id >= DRV_IOCTL_LOOKUP) {
531 // Only root can fiddle with graphics modes
532 // TODO: Remove this and replace with user ownership
533 if( Threads_GetUID() != 0 ) return -1;
540 LEAVE('i', DRV_TYPE_TERMINAL);
541 return DRV_TYPE_TERMINAL;
542 case DRV_IOCTL_IDENT:
543 memcpy(Data, "VT\0\0", 4);
546 case DRV_IOCTL_VERSION:
549 case DRV_IOCTL_LOOKUP:
553 // Get/Set the mode (and apply any changes)
554 case TERM_IOCTL_MODETYPE:
557 if( CheckMem(Data, sizeof(int)) == 0 ) {
561 Log_Log("VTerm", "VTerm %i mode set to %i", (int)Node->Inode, *iData);
563 // Update mode if needed
564 if( term->Mode != *iData || term->NewWidth || term->NewHeight)
566 // Adjust for text mode
567 if( *iData == TERM_MODE_TEXT ) {
568 term->NewHeight *= giVT_CharHeight;
569 term->NewWidth *= giVT_CharWidth;
571 // Fill unchanged dimensions
572 if(term->NewHeight == 0) term->NewHeight = term->Height;
573 if(term->NewWidth == 0) term->NewWidth = term->Width;
575 VT_int_ChangeMode(term, *iData, term->NewWidth, term->NewHeight);
576 // Clear unapplied dimensions
581 // Update the screen dimensions
582 if(Node->Inode == giVT_CurrentTerminal)
583 VT_SetTerminal( giVT_CurrentTerminal );
585 LEAVE('i', term->Mode);
588 // Get/set the terminal width
589 case TERM_IOCTL_WIDTH:
591 if( CheckMem(Data, sizeof(int)) == 0 ) {
595 term->NewWidth = *iData;
598 ret = term->NewWidth;
599 else if( term->Mode == TERM_MODE_TEXT )
600 ret = term->TextWidth;
606 // Get/set the terminal height
607 case TERM_IOCTL_HEIGHT:
609 if( CheckMem(Data, sizeof(int)) == 0 ) {
613 term->NewHeight = *iData;
615 if( term->NewHeight )
616 ret = term->NewHeight;
617 else if( term->Mode == TERM_MODE_TEXT )
618 ret = term->TextHeight;
624 case TERM_IOCTL_FORCESHOW:
625 Log_Log("VTerm", "Thread %i forced VTerm %i to be shown",
626 Threads_GetTID(), (int)Node->Inode);
627 VT_SetTerminal( Node->Inode );
631 case TERM_IOCTL_GETSETCURSOR:
634 tVideo_IOCtl_Pos *pos = Data;
635 if( !CheckMem(Data, sizeof(*pos)) ) {
641 if( term->Mode == TERM_MODE_TEXT )
643 if(term->Flags & VT_FLAG_ALTBUF)
644 term->AltWritePos = pos->x + pos->y * term->TextWidth;
646 term->WritePos = pos->x + pos->y * term->TextWidth + term->ViewPos;
647 VT_int_UpdateCursor(term, 0);
651 term->VideoCursorX = pos->x;
652 term->VideoCursorY = pos->y;
653 VT_int_UpdateCursor(term, 1);
656 ret = (term->Flags & VT_FLAG_ALTBUF) ? term->AltWritePos : term->WritePos-term->ViewPos;
660 case TERM_IOCTL_SETCURSORBITMAP: {
661 tVideo_IOCtl_Bitmap *bmp = Data;
664 free( term->VideoCursor );
665 term->VideoCursor = NULL;
670 // Sanity check bitmap
671 if( !CheckMem(bmp, sizeof(tVideo_IOCtl_Bitmap)) ) {
672 Log_Notice("VTerm", "%p in TERM_IOCTL_SETCURSORBITMAP invalid", bmp);
676 if( !CheckMem(bmp->Data, bmp->W*bmp->H*sizeof(Uint32)) ) {
677 Log_Notice("VTerm", "%p in TERM_IOCTL_SETCURSORBITMAP invalid", bmp);
682 // Reallocate if needed
683 if(term->VideoCursor)
685 if(bmp->W * bmp->H != term->VideoCursor->W * term->VideoCursor->H) {
686 free(term->VideoCursor);
687 term->VideoCursor = NULL;
690 if(!term->VideoCursor) {
691 term->VideoCursor = malloc(sizeof(tVideo_IOCtl_Pos) + bmp->W*bmp->H*sizeof(Uint32));
692 if(!term->VideoCursor) {
693 Log_Error("VTerm", "Unable to allocate memory for cursor");
699 memcpy(term->VideoCursor, bmp, sizeof(tVideo_IOCtl_Pos) + bmp->W*bmp->H*sizeof(Uint32));
701 Log_Debug("VTerm", "Set VT%i's cursor to %p %ix%i",
702 (int)term->Node.Inode, bmp, bmp->W, bmp->H);
704 if(gpVT_CurTerm == term)
705 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSORBITMAP, term->VideoCursor);
714 void VT_Terminal_Reference(tVFS_Node *Node)
716 // Append PID to list
719 void VT_Terminal_Close(tVFS_Node *Node)
721 // Remove PID from list
725 * \fn void VT_SetTerminal(int ID)
726 * \brief Set the current terminal
728 void VT_SetTerminal(int ID)
730 // Copy the screen state
731 if( ID != giVT_CurrentTerminal && gpVT_CurTerm->Mode != TERM_MODE_TEXT )
733 if( !gpVT_CurTerm->Buffer )
734 gpVT_CurTerm->Buffer = malloc( gpVT_CurTerm->Width*gpVT_CurTerm->Height*4 );
735 if( gpVT_CurTerm->Width < giVT_RealWidth )
739 Uint32 *dest = gpVT_CurTerm->Buffer;
740 // Slower scanline copy
741 for( line = 0; line < gpVT_CurTerm->Height; line ++ )
743 VFS_ReadAt(giVT_OutputDevHandle, ofs, gpVT_CurTerm->Width*4, dest);
744 ofs += giVT_RealWidth * 4;
745 dest += gpVT_CurTerm->Width;
750 VFS_ReadAt(giVT_OutputDevHandle,
751 0, gpVT_CurTerm->Height*giVT_RealWidth*4,
757 // Update current terminal ID
758 Log_Log("VTerm", "Changed terminal from %i to %i", giVT_CurrentTerminal, ID);
759 giVT_CurrentTerminal = ID;
760 gpVT_CurTerm = &gVT_Terminals[ID];
762 LOG("Attempting VT_SetMode");
764 if( gpVT_CurTerm->Mode == TERM_MODE_TEXT )
766 VT_SetMode( VIDEO_BUFFMT_TEXT );
770 // Update the cursor image
771 if(gpVT_CurTerm->VideoCursor)
772 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSORBITMAP, gpVT_CurTerm->VideoCursor);
773 VT_SetMode( VIDEO_BUFFMT_FRAMEBUFFER );
778 if(gpVT_CurTerm->Buffer)
780 // TODO: Handle non equal sized
782 giVT_OutputDevHandle,
784 gpVT_CurTerm->Width*gpVT_CurTerm->Height*sizeof(Uint32),
787 LOG("Updated screen contents");
790 VT_int_UpdateCursor(gpVT_CurTerm, 1);
792 VT_int_UpdateScreen(gpVT_CurTerm, 1);