Kernel/drv/vterm.c

   1 /*
   2  * Acess2 Virtual Terminal Driver
   3  */
   4 #define DEBUG   1
   5 #include <acess.h>
   6 #include <fs_devfs.h>
   7 #include <modules.h>
   8 #include <tpl_drv_video.h>
   9 #include <tpl_drv_keyboard.h>
  10 #include <tpl_drv_terminal.h>
  11 #include <errno.h>
  12
  13 #define USE_CTRL_ALT    0
  14
  15 // === CONSTANTS ===
  16 #define VERSION ((0<<8)|(50))
  17
  18 #define NUM_VTS 8
  19 #define MAX_INPUT_CHARS32       64
  20 #define MAX_INPUT_CHARS8        (MAX_INPUT_CHARS32*4)
  21 #define VT_SCROLLBACK   1       // 2 Screens of text
  22 #define DEFAULT_OUTPUT  "VGA"
  23 //#define DEFAULT_OUTPUT        "BochsGA"
  24 //#define DEFAULT_OUTPUT        "Vesa"
  25 #define DEFAULT_INPUT   "PS2Keyboard"
  26 #define DEFAULT_WIDTH   80
  27 #define DEFAULT_HEIGHT  25
  28 #define DEFAULT_COLOUR  (VT_COL_BLACK|(0xAAA<<16))
  29
  30 #define VT_FLAG_HIDECSR 0x01
  31 #define VT_FLAG_HASFB   0x10    //!< Set if the VTerm has requested the Framebuffer
  32
  33 enum eVT_InModes {
  34         VT_INMODE_TEXT8,        // UTF-8 Text Mode (VT100 Emulation)
  35         VT_INMODE_TEXT32,       // UTF-32 Text Mode (Acess Native)
  36         NUM_VT_INMODES
  37 };
  38
  39 // === TYPES ===
  40 typedef struct {
  41          int    Mode;   //!< Current Mode (see ::eTplTerminal_Modes)
  42          int    Flags;  //!< Flags (see VT_FLAG_*)
  43         short   Width;  //!< Virtual Width
  44         short   Height; //!< Virtual Height
  45
  46          int    ViewPos;        //!< View Buffer Offset (Text Only)
  47          int    WritePos;       //!< Write Buffer Offset (Text Only)
  48         Uint32  CurColour;      //!< Current Text Colour
  49
  50          int    InputRead;      //!< Input buffer read position
  51          int    InputWrite;     //!< Input buffer write position
  52         char    InputBuffer[MAX_INPUT_CHARS8];
  53         union {
  54                 tVT_Char        *Text;
  55                 Uint32          *Buffer;
  56         };
  57         char    Name[2];        //!< Name of the terminal
  58         tVFS_Node       Node;
  59 } tVTerm;
  60
  61 // === IMPORTS ===
  62 extern void     Debug_SetKTerminal(char *File);
  63
  64 // === PROTOTYPES ===
  65  int    VT_Install(char **Arguments);
  66 char    *VT_ReadDir(tVFS_Node *Node, int Pos);
  67 tVFS_Node       *VT_FindDir(tVFS_Node *Node, char *Name);
  68  int    VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data);
  69 Uint64  VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
  70 Uint64  VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
  71  int    VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data);
  72 void    VT_SetTerminal(int ID);
  73 void    VT_KBCallBack(Uint32 Codepoint);
  74 void    VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count);
  75  int    VT_int_ParseEscape(tVTerm *Term, char *Buffer);
  76 void    VT_int_PutChar(tVTerm *Term, Uint32 Ch);
  77 void    VT_int_UpdateScreen( tVTerm *Term, int UpdateAll );
  78 void    VT_int_ChangeMode(tVTerm *Term, int NewMode);
  79
  80 // === CONSTANTS ===
  81 const Uint16    caVT100Colours[] = {
  82                 VT_COL_BLACK, 0x700, 0x070, 0x770, 0x007, 0x707, 0x077, 0xAAA,
  83                 VT_COL_GREY, 0xF00, 0x0F0, 0xFF0, 0x00F, 0xF0F, 0x0FF, VT_COL_WHITE
  84         };
  85
  86 // === GLOBALS ===
  87 MODULE_DEFINE(0, VERSION, VTerm, VT_Install, NULL, DEFAULT_OUTPUT, DEFAULT_INPUT, NULL);
  88 tDevFS_Driver   gVT_DrvInfo = {
  89         NULL, "VTerm",
  90         {
  91         .Flags = VFS_FFLAG_DIRECTORY,
  92         .Size = NUM_VTS,
  93         .Inode = -1,
  94         .NumACLs = 0,
  95         .ReadDir = VT_ReadDir,
  96         .FindDir = VT_FindDir,
  97         .IOCtl = VT_Root_IOCtl
  98         }
  99 };
 100 // --- Terminals ---
 101 tVTerm  gVT_Terminals[NUM_VTS];
 102  int    giVT_CurrentTerminal = 0;
 103 // --- Video State ---
 104 short   giVT_RealWidth; //!< Real Width
 105 short   giVT_RealHeight;        //!< Real Height
 106  int    gbVT_TextMode = 1;
 107 // --- Driver Handles ---
 108 char    *gsVT_OutputDevice = NULL;
 109 char    *gsVT_InputDevice = NULL;
 110  int    giVT_OutputDevHandle = -2;
 111  int    giVT_InputDevHandle = -2;
 112 // --- Key States --- (Used for VT Switching/Magic Combos)
 113  int    gbVT_CtrlDown = 0;
 114  int    gbVT_AltDown = 0;
 115  int    gbVT_SysrqDown = 0;
 116
 117 // === CODE ===
 118 /**
 119  * \fn int VT_Install(char **Arguments)
 120  * \brief Installs the Virtual Terminal Driver
 121  */
 122 int VT_Install(char **Arguments)
 123 {
 124         char    **args = Arguments;
 125         char    *arg;
 126          int    i;
 127
 128         // Scan Arguments
 129         if(Arguments)
 130         {
 131                 for( ; (arg = *args); args++ )
 132                 {
 133                         if(arg[0] != '-')       continue;
 134
 135                         switch(arg[1])
 136                         {
 137                         // Set output device
 138                         case 'o':
 139                                 if(args[1] ==  NULL)    break;
 140                                 if(gsVT_OutputDevice)   free(gsVT_OutputDevice);
 141                                 gsVT_OutputDevice = malloc(strlen(args[1])+1);
 142                                 strcpy(gsVT_OutputDevice, args[1]);
 143                                 args ++;
 144                                 break;
 145
 146                         // Set input device
 147                         case 'i':
 148                                 if(args[1] == NULL)     break;
 149                                 if(gsVT_InputDevice)    free(gsVT_InputDevice);
 150                                 gsVT_InputDevice = malloc(strlen(args[1])+1);
 151                                 strcpy(gsVT_InputDevice, args[1]);
 152                                 args ++;
 153                                 break;
 154
 155                         }
 156                 }
 157         }
 158
 159         // Apply Defaults
 160         if(!gsVT_OutputDevice)  gsVT_OutputDevice = "/Devices/"DEFAULT_OUTPUT;
 161         if(!gsVT_InputDevice)   gsVT_InputDevice = "/Devices/"DEFAULT_INPUT;
 162
 163         Log_Log("VTerm", "Using '%s' as output", gsVT_OutputDevice);
 164         Log_Log("VTerm", "Using '%s' as input", gsVT_InputDevice);
 165
 166         // Create Nodes
 167         for( i = 0; i < NUM_VTS; i++ )
 168         {
 169                 gVT_Terminals[i].Mode = TERM_MODE_TEXT;
 170                 gVT_Terminals[i].Flags = 0;
 171                 gVT_Terminals[i].Width = DEFAULT_WIDTH;
 172                 gVT_Terminals[i].Height = DEFAULT_HEIGHT;
 173                 gVT_Terminals[i].CurColour = DEFAULT_COLOUR;
 174                 gVT_Terminals[i].WritePos = 0;
 175                 gVT_Terminals[i].ViewPos = 0;
 176
 177                 gVT_Terminals[i].Buffer = calloc( DEFAULT_WIDTH*DEFAULT_HEIGHT*VT_SCROLLBACK, sizeof(tVT_Char) );
 178
 179                 gVT_Terminals[i].Name[0] = '0'+i;
 180                 gVT_Terminals[i].Name[1] = '\0';
 181                 gVT_Terminals[i].Node.Inode = i;
 182                 gVT_Terminals[i].Node.ImplPtr = &gVT_Terminals[i];
 183                 gVT_Terminals[i].Node.NumACLs = 0;      // Only root can open virtual terminals
 184
 185                 gVT_Terminals[i].Node.Read = VT_Read;
 186                 gVT_Terminals[i].Node.Write = VT_Write;
 187                 gVT_Terminals[i].Node.IOCtl = VT_Terminal_IOCtl;
 188         }
 189
 190         // Add to DevFS
 191         DevFS_AddDevice( &gVT_DrvInfo );
 192
 193         // Set kernel output to VT0
 194         Debug_SetKTerminal("/Devices/VTerm/0");
 195
 196         return MODULE_ERR_OK;
 197 }
 198
 199 /**
 200  * \fn void VT_InitOutput()
 201  * \brief Initialise Video Output
 202  */
 203 void VT_InitOutput()
 204 {
 205         giVT_OutputDevHandle = VFS_Open(gsVT_OutputDevice, VFS_OPENFLAG_WRITE);
 206         VT_SetTerminal( 0 );
 207 }
 208
 209 /**
 210  * \fn void VT_InitInput()
 211  * \brief Initialises the input
 212  */
 213 void VT_InitInput()
 214 {
 215         giVT_InputDevHandle = VFS_Open(gsVT_InputDevice, VFS_OPENFLAG_READ);
 216         if(giVT_InputDevHandle == -1)   return ;
 217         VFS_IOCtl(giVT_InputDevHandle, KB_IOCTL_SETCALLBACK, VT_KBCallBack);
 218 }
 219
 220 /**
 221  * \fn char *VT_ReadDir(tVFS_Node *Node, int Pos)
 222  * \brief Read from the VTerm Directory
 223  */
 224 char *VT_ReadDir(tVFS_Node *Node, int Pos)
 225 {
 226         if(Pos < 0)     return NULL;
 227         if(Pos >= NUM_VTS)      return NULL;
 228         return strdup( gVT_Terminals[Pos].Name );
 229 }
 230
 231 /**
 232  * \fn tVFS_Node *VT_FindDir(tVFS_Node *Node, char *Name)
 233  * \brief Find an item in the VTerm directory
 234  */
 235 tVFS_Node *VT_FindDir(tVFS_Node *Node, char *Name)
 236 {
 237          int    num;
 238
 239         //ENTER("pNode sName", Node, Name);
 240
 241         // Open the input and output files if needed
 242         if(giVT_OutputDevHandle == -2)  VT_InitOutput();
 243         if(giVT_InputDevHandle == -2)   VT_InitInput();
 244
 245         // Sanity check name
 246         if(Name[0] < '0' || Name[0] > '9' || Name[1] != '\0') {
 247                 LEAVE('n');
 248                 return NULL;
 249         }
 250         // Get index
 251         num = Name[0] - '0';
 252         if(num >= NUM_VTS) {
 253                 LEAVE('n');
 254                 return NULL;
 255         }
 256         // Return node
 257         //LEAVE('p', &gVT_Terminals[num].Node);
 258         return &gVT_Terminals[num].Node;
 259 }
 260
 261 /**
 262  * \fn int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data)
 263  * \brief Control the VTerm Driver
 264  */
 265 int VT_Root_IOCtl(tVFS_Node *Node, int Id, void *Data)
 266 {
 267          int    len;
 268         switch(Id)
 269         {
 270         case DRV_IOCTL_TYPE:    return DRV_TYPE_MISC;
 271         case DRV_IOCTL_IDENT:   memcpy(Data, "VT\0\0", 4);      return 0;
 272         case DRV_IOCTL_VERSION: return VERSION;
 273         case DRV_IOCTL_LOOKUP:  return 0;
 274
 275         case 4: // Get Video Driver
 276                 if(Data)        strcpy(Data, gsVT_OutputDevice);
 277                 return strlen(gsVT_OutputDevice);
 278
 279         case 5: // Set Video Driver
 280                 if(!Data)       return -EINVAL;
 281                 if(Threads_GetUID() != 0)       return -EACCES;
 282
 283                 len = strlen(Data);
 284
 285                 free(gsVT_OutputDevice);
 286
 287                 gsVT_OutputDevice = malloc(len+1);
 288                 strcpy(gsVT_OutputDevice, Data);
 289
 290                 VFS_Close(giVT_OutputDevHandle);
 291                 giVT_OutputDevHandle = -1;
 292
 293                 VT_InitOutput();
 294                 return 1;
 295         }
 296         return 0;
 297 }
 298
 299 /**
 300  * \fn Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 301  * \brief Read from a virtual terminal
 302  */
 303 Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 304 {
 305          int    pos = 0;
 306         tVTerm  *term = &gVT_Terminals[ Node->Inode ];
 307
 308         // Check current mode
 309         switch(term->Mode)
 310         {
 311         case TERM_MODE_TEXT:
 312                 while(pos < Length)
 313                 {
 314                         while(term->InputRead == term->InputWrite)      Threads_Yield();
 315
 316                         ((char*)Buffer)[pos] = term->InputBuffer[term->InputRead];
 317                         pos ++;
 318                         term->InputRead ++;
 319                         term->InputRead %= MAX_INPUT_CHARS8;
 320                 }
 321                 break;
 322
 323         case TERM_MODE_FB:
 324         //case TERM_MODE_:
 325                 while(pos < Length)
 326                 {
 327                         while(term->InputRead == term->InputWrite)      Threads_Yield();
 328                         ((Uint32*)Buffer)[pos] = ((Uint32*)term->InputBuffer)[term->InputRead];
 329                         pos ++;
 330                         term->InputRead ++;
 331                         term->InputRead %= MAX_INPUT_CHARS32;
 332                 }
 333                 break;
 334         }
 335         return 0;
 336 }
 337
 338 /**
 339  * \fn Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 340  * \brief Write to a virtual terminal
 341  */
 342 Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 343 {
 344         tVTerm  *term = &gVT_Terminals[ Node->Inode ];
 345
 346         //ENTER("pNode XOffset XLength pBuffer",  Node, Offset, Length, Buffer);
 347
 348         // Write
 349         switch( term->Mode )
 350         {
 351         case TERM_MODE_TEXT:
 352                 VT_int_PutString(term, Buffer, Length);
 353                 break;
 354         case TERM_MODE_FB:
 355                 if( giVT_RealWidth > term->Width || giVT_RealHeight > term->Height )
 356                 {
 357                         #if 0
 358                          int    x, y, h;
 359                         x = Offset/4;   y = x / term->Width;    x %= term->Width;
 360                         w = Length/4+x; h = w / term->Width;    w %= term->Width;
 361                         while(h--)
 362                         {
 363                                 VFS_WriteAt( giVT_OutputDevHandle,
 364                                         (x+y*term->RealWidth)*4,
 365                                         term->Width * 4,
 366                                         Buffer
 367                                         );
 368                                 Buffer = (void*)( (Uint)Buffer + term->Width*term->Height*4 );
 369                         }
 370                         #endif
 371                         return 0;
 372                 }
 373                 else {
 374                         return VFS_WriteAt( giVT_OutputDevHandle, Offset, Length, Buffer );
 375                 }
 376         }
 377
 378         //LEAVE('i', 0);
 379         return 0;
 380 }
 381
 382 /**
 383  * \fn int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
 384  * \brief Call an IO Control on a virtual terminal
 385  */
 386 int VT_Terminal_IOCtl(tVFS_Node *Node, int Id, void *Data)
 387 {
 388          int    *iData = Data;
 389         tVTerm  *term = Node->ImplPtr;
 390         ENTER("pNode iId pData", Node, Id, Data);
 391
 392         if(Id >= DRV_IOCTL_LOOKUP) {
 393                 if( Threads_GetUID() != 0 )     return -1;
 394         }
 395
 396         switch(Id)
 397         {
 398         case DRV_IOCTL_TYPE:
 399                 LEAVE('i', DRV_TYPE_TERMINAL);
 400                 return DRV_TYPE_TERMINAL;
 401         case DRV_IOCTL_IDENT:
 402                 memcpy(Data, "VT\0\0", 4);
 403                 LEAVE('i', 0);
 404                 return 0;
 405         case DRV_IOCTL_VERSION:
 406                 LEAVE('x', VERSION);
 407                 return VERSION;
 408         case DRV_IOCTL_LOOKUP:
 409                 LEAVE('i', 0);
 410                 return 0;
 411
 412         // Get/Set the mode (and apply any changes)
 413         case TERM_IOCTL_MODETYPE:
 414                 if(Data != NULL)
 415                 {
 416                         if(term->Mode != *iData)
 417                                 VT_int_ChangeMode(term, *iData);
 418
 419                         // Update the screen dimensions
 420                         if(giVT_CurrentTerminal == Node->Inode)
 421                                 VT_SetTerminal( giVT_CurrentTerminal );
 422                 }
 423                 LEAVE('i', term->Mode);
 424                 return term->Mode;
 425
 426         // Get/set the terminal width
 427         case TERM_IOCTL_WIDTH:
 428                 if(Data != NULL)        term->Width = *iData;
 429                 Log("VT_Terminal_IOCtl - RETURN term->Width = %i", term->Width);
 430                 LEAVE('i', term->Width);
 431                 return term->Width;
 432
 433         // Get/set the terminal height
 434         case TERM_IOCTL_HEIGHT:
 435                 if(Data != NULL)        term->Height = *iData;
 436                 Log("VT_Terminal_IOCtl - RETURN term->Height = %i", term->Height);
 437                 LEAVE('i', term->Height);
 438                 return term->Height;
 439
 440         case TERM_IOCTL_FORCESHOW:
 441                 VT_SetTerminal( Node->Inode );
 442                 LEAVE('i', 1);
 443                 return 1;
 444         }
 445         LEAVE('i', -1);
 446         return -1;
 447 }
 448
 449 void VT_SetResolution(int IsTextMode, int Width, int Height)
 450 {
 451         tVideo_IOCtl_Mode       mode = {0};
 452          int    tmp;
 453
 454         // Create the video mode
 455         mode.width = Width;
 456         mode.height = Height;
 457         mode.bpp = 32;
 458         mode.flags = 0;
 459
 460         // Set video mode
 461         VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_FINDMODE, &mode );
 462         tmp = mode.id;
 463         giVT_RealWidth = mode.width;
 464         giVT_RealHeight = mode.height;
 465         VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_GETSETMODE, &tmp );
 466
 467
 468
 469         if(IsTextMode)
 470                 tmp = VIDEO_BUFFMT_TEXT;
 471         else
 472                 tmp = VIDEO_BUFFMT_FRAMEBUFFER;
 473         VFS_IOCtl( giVT_OutputDevHandle, VIDEO_IOCTL_SETBUFFORMAT, &tmp );
 474 }
 475
 476 /**
 477  * \fn void VT_SetTerminal(int ID)
 478  * \brief Set the current terminal
 479  */
 480 void VT_SetTerminal(int ID)
 481 {
 482         // Update current terminal ID
 483         Log_Log("VTerm", "Changed terminal from %i to %i", giVT_CurrentTerminal, ID);
 484         giVT_CurrentTerminal = ID;
 485
 486         // Update the screen
 487         VT_int_UpdateScreen( &gVT_Terminals[ ID ], 1 );
 488 }
 489
 490 /**
 491  * \fn void VT_KBCallBack(Uint32 Codepoint)
 492  * \brief Called on keyboard interrupt
 493  * \param Codepoint     Pseudo-UTF32 character
 494  *
 495  * Handles a key press and sends the key code to the user's buffer.
 496  * If the code creates a kernel-magic sequence, it is not passed to the
 497  * user and is handled in-kernel.
 498  */
 499 void VT_KBCallBack(Uint32 Codepoint)
 500 {
 501         tVTerm  *term = &gVT_Terminals[giVT_CurrentTerminal];
 502
 503         // How the hell did we get a Codepoint of zero?
 504         if(Codepoint == 0)      return;
 505
 506         // Key Up
 507         if( Codepoint & 0x80000000 )
 508         {
 509                 Codepoint &= 0x7FFFFFFF;
 510                 switch(Codepoint)
 511                 {
 512                 #if !USE_CTRL_ALT
 513                 case KEY_RSHIFT:        gbVT_CtrlDown = 0;      break;
 514                 case KEY_LSHIFT:        gbVT_AltDown = 0;       break;
 515                 #else
 516                 case KEY_LALT:
 517                 case KEY_RALT:
 518                         gbVT_AltDown = 0;
 519                         break;
 520                 case KEY_LCTRL:
 521                 case KEY_RCTRL:
 522                         gbVT_CtrlDown = 0;
 523                         break;
 524                 #endif
 525                 }
 526                 return;
 527         }
 528
 529         switch(Codepoint)
 530         {
 531         #if !USE_CTRL_ALT
 532         case KEY_RSHIFT:        gbVT_CtrlDown = 1;      break;
 533         case KEY_LSHIFT:        gbVT_AltDown = 1;       break;
 534         #else
 535         case KEY_LALT:
 536         case KEY_RALT:
 537                 gbVT_AltDown = 1;
 538                 break;
 539         case KEY_LCTRL:
 540         case KEY_RCTRL:
 541                 gbVT_CtrlDown = 1;
 542                 break;
 543         #endif
 544
 545         default:
 546                 #if USE_CTRL_ALT
 547                 if(!gbVT_AltDown || !gbVT_CtrlDown)
 548                         break;
 549                 #endif
 550                 switch(Codepoint)
 551                 {
 552                 case KEY_F1:    VT_SetTerminal(0);      return;
 553                 case KEY_F2:    VT_SetTerminal(1);      return;
 554                 case KEY_F3:    VT_SetTerminal(2);      return;
 555                 case KEY_F4:    VT_SetTerminal(3);      return;
 556                 case KEY_F5:    VT_SetTerminal(4);      return;
 557                 case KEY_F6:    VT_SetTerminal(5);      return;
 558                 case KEY_F7:    VT_SetTerminal(6);      return;
 559                 case KEY_F8:    VT_SetTerminal(7);      return;
 560                 case KEY_F9:    VT_SetTerminal(8);      return;
 561                 case KEY_F10:   VT_SetTerminal(9);      return;
 562                 case KEY_F11:   VT_SetTerminal(10);     return;
 563                 case KEY_F12:   VT_SetTerminal(11);     return;
 564                 case KEY_PGUP:
 565                         return;
 566                 case KEY_PGDOWN:
 567                         return;
 568                 }
 569         }
 570
 571         // Encode key
 572         if(term->Mode == TERM_MODE_TEXT)
 573         {
 574                 Uint8   buf[6] = {0};
 575                  int    len = 0;
 576
 577                 // Ignore Modifer Keys
 578                 if(Codepoint > KEY_MODIFIERS)   return;
 579
 580                 // Get UTF-8/ANSI Encoding
 581                 switch(Codepoint)
 582                 {
 583                 case KEY_LEFT:
 584                         buf[0] = '\x1B';        buf[1] = '[';   buf[2] = 'D';
 585                         len = 3;
 586                         break;
 587                 case KEY_RIGHT:
 588                         buf[0] = '\x1B';        buf[1] = '[';   buf[2] = 'C';
 589                         len = 3;
 590                         break;
 591                 case KEY_UP:
 592                         buf[0] = '\x1B';        buf[1] = '[';   buf[2] = 'A';
 593                         len = 3;
 594                         break;
 595                 case KEY_DOWN:
 596                         buf[0] = '\x1B';        buf[1] = '[';   buf[2] = 'B';
 597                         len = 3;
 598                         break;
 599
 600                 case KEY_PGUP:
 601                         buf[0] = '\x1B';        buf[1] = '[';   buf[2] = '5';   // Some overline also
 602                         //len = 4;      // Commented out until I'm sure
 603                         break;
 604                 case KEY_PGDOWN:
 605                         len = 0;
 606                         break;
 607
 608                 // Attempt to encode in UTF-8
 609                 default:
 610                         len = WriteUTF8( buf, Codepoint );
 611                         if(len == 0) {
 612                                 Warning("Codepoint (%x) is unrepresentable in UTF-8", Codepoint);
 613                         }
 614                         break;
 615                 }
 616
 617                 if(len == 0) {
 618                         // Unprintable / Don't Pass
 619                         return;
 620                 }
 621
 622                 // Write
 623                 if( MAX_INPUT_CHARS8 - term->InputWrite >= len )
 624                         memcpy( &term->InputBuffer[term->InputWrite], buf, len );
 625                 else {
 626                         memcpy( &term->InputBuffer[term->InputWrite], buf, MAX_INPUT_CHARS8 - term->InputWrite );
 627                         memcpy( &term->InputBuffer[0], buf, len - (MAX_INPUT_CHARS8 - term->InputWrite) );
 628                 }
 629                 // Roll the buffer over
 630                 term->InputWrite += len;
 631                 term->InputWrite %= MAX_INPUT_CHARS8;
 632                 if( (term->InputWrite - term->InputRead + MAX_INPUT_CHARS8)%MAX_INPUT_CHARS8 < len ) {
 633                         term->InputRead = term->InputWrite + 1;
 634                         term->InputRead %= MAX_INPUT_CHARS8;
 635                 }
 636
 637         }
 638         else
 639         {
 640                 // Encode the raw UTF-32 Key
 641                 ((Uint32*)term->InputBuffer)[ term->InputWrite ] = Codepoint;
 642                 term->InputWrite ++;
 643                 term->InputWrite %= MAX_INPUT_CHARS32;
 644                 if(term->InputRead == term->InputWrite) {
 645                         term->InputRead ++;
 646                         term->InputRead %= MAX_INPUT_CHARS32;
 647                 }
 648         }
 649 }
 650
 651 /**
 652  * \fn void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
 653  * \brief Print a string to the Virtual Terminal
 654  */
 655 void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
 656 {
 657         Uint32  val;
 658          int    i;
 659         for( i = 0; i < Count; i++ )
 660         {
 661                 if( Buffer[i] == 0x1B ) // Escape Sequence
 662                 {
 663                         i ++;
 664                         i += VT_int_ParseEscape(Term, (char*)&Buffer[i]);
 665                         continue;
 666                 }
 667
 668                 if( Buffer[i] < 128 )   // Plain ASCII
 669                         VT_int_PutChar(Term, Buffer[i]);
 670                 else {  // UTF-8
 671                         i += ReadUTF8(&Buffer[i], &val);
 672                         VT_int_PutChar(Term, val);
 673                 }
 674         }
 675
 676         // Update cursor
 677         if( !(Term->Flags & VT_FLAG_HIDECSR) )
 678         {
 679                 tVideo_IOCtl_Pos        pos;
 680                 pos.x = Term->WritePos % Term->Width;
 681                 pos.y = Term->WritePos / Term->Width;
 682                 VFS_IOCtl(giVT_OutputDevHandle, VIDEO_IOCTL_SETCURSOR, &pos);
 683         }
 684 }
 685
 686 /**
 687  * \fn void VT_int_ClearLine(tVTerm *Term, int Num)
 688  * \brief Clears a line in a virtual terminal
 689  */
 690 void VT_int_ClearLine(tVTerm *Term, int Num)
 691 {
 692          int    i;
 693         //ENTER("pTerm iNum", Term, Num);
 694         for( i = Term->Width; i--; )
 695         {
 696                 Term->Text[ Num*Term->Width + i ].Ch = 0;
 697                 Term->Text[ Num*Term->Width + i ].Colour = Term->CurColour;
 698         }
 699         //LEAVE('-');
 700 }
 701
 702 /**
 703  * \fn int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
 704  * \brief Parses a VT100 Escape code
 705  */
 706 int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
 707 {
 708         char    c;
 709          int    argc = 0, j = 1;
 710          int    tmp;
 711          int    args[4] = {0,0,0,0};
 712
 713         switch(Buffer[0]) {
 714         //Large Code
 715         case '[':
 716                 // Get Arguments
 717                 c = Buffer[1];
 718                 do {
 719                         while('0' <= c && c <= '9') {
 720                                 args[argc] *= 10;
 721                                 args[argc] += c-'0';
 722                                 c = Buffer[++j];
 723                         }
 724                         if( j != 1 )    argc ++;
 725                 } while(c == ';');
 726
 727                 // Get string (what does this do?)
 728                 if(c == '"') {
 729                         c = Buffer[++j];
 730                         while(c != '"')
 731                                 c = Buffer[++j];
 732                 }
 733
 734                 // Get Command
 735                 if(     ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'))
 736                 {
 737                         switch(c)
 738                         {
 739                         // Left
 740                         case 'D':
 741                                 if(argc == 1)   tmp = args[0];
 742                                 else    tmp = 1;
 743
 744                                 if( Term->WritePos-(tmp-1) % Term->Width == 0 )
 745                                         Term->WritePos -= Term->WritePos % Term->Width;
 746                                 else
 747                                         Term->WritePos -= tmp;
 748                                 break;
 749
 750                         // Right
 751                         case 'C':
 752                                 if(argc == 1)   tmp = args[0];
 753                                 else    tmp = 1;
 754                                 if( (Term->WritePos + tmp) % Term->Width == 0 ) {
 755                                         Term->WritePos -= Term->WritePos % Term->Width;
 756                                         Term->WritePos += Term->Width - 1;
 757                                 } else
 758                                         Term->WritePos += tmp;
 759                                 break;
 760
 761                         // Clear By Line
 762                         case 'J':
 763                                 // Clear Screen
 764                                 switch(args[0])
 765                                 {
 766                                 case 2:
 767                                         {
 768                                          int    i = Term->Height * VT_SCROLLBACK;
 769                                         while( i-- )    VT_int_ClearLine(Term, i);
 770                                         Term->WritePos = 0;
 771                                         Term->ViewPos = 0;
 772                                         VT_int_UpdateScreen(Term, 1);
 773                                         }
 774                                         break;
 775                                 }
 776                                 break;
 777                         // Set Font flags
 778                         case 'm':
 779                                 for( ; argc--; )
 780                                 {
 781                                         // Flags
 782                                         if( 0 <= args[argc] && args[argc] <= 8)
 783                                         {
 784                                                 switch(args[argc])
 785                                                 {
 786                                                 case 0: Term->CurColour = DEFAULT_COLOUR;       break;  // Reset
 787                                                 case 1: Term->CurColour |= 0x80000000;  break;  // Bright
 788                                                 case 2: Term->CurColour &= ~0x80000000; break;  // Dim
 789                                                 }
 790                                         }
 791                                         // Foreground Colour
 792                                         else if(30 <= args[argc] && args[argc] <= 37) {
 793                                                 Term->CurColour &= 0xF000FFFF;
 794                                                 Term->CurColour |= (Uint32)caVT100Colours[ args[argc]-30+(Term->CurColour>>28) ] << 16;
 795                                         }
 796                                         // Background Colour
 797                                         else if(40 <= args[argc] && args[argc] <= 47) {
 798                                                 Term->CurColour &= 0xFFFF8000;
 799                                                 Term->CurColour |= caVT100Colours[ args[argc]-40+((Term->CurColour>>12)&15) ];
 800                                         }
 801                                 }
 802                                 break;
 803                         }
 804                 }
 805                 break;
 806
 807         default:
 808                 break;
 809         }
 810
 811         return j + 1;
 812 }
 813
 814 /**
 815  * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
 816  * \brief Write a single character to a VTerm
 817  */
 818 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
 819 {
 820          int    i;
 821         //ENTER("pTerm xCh", Term, Ch);
 822         //LOG("Term = {WritePos:%i, ViewPos:%i}", Term->WritePos, Term->ViewPos);
 823
 824         switch(Ch)
 825         {
 826         case '\0':      return; // Ignore NULL byte
 827         case '\n':
 828                 Term->WritePos += Term->Width;
 829         case '\r':
 830                 Term->WritePos -= Term->WritePos % Term->Width;
 831                 break;
 832
 833         case '\t':
 834                 do {
 835                         Term->Text[ Term->WritePos ].Ch = '\0';
 836                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 837                         Term->WritePos ++;
 838                 } while(Term->WritePos & 7);
 839                 break;
 840
 841         case '\b':
 842                 // Backspace is invalid at Offset 0
 843                 if(Term->WritePos == 0) break;
 844
 845                 Term->WritePos --;
 846                 // Singe Character
 847                 if(Term->Text[ Term->WritePos ].Ch != '\0') {
 848                         Term->Text[ Term->WritePos ].Ch = 0;
 849                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 850                         break;
 851                 }
 852                 // Tab
 853                 i = 7;  // Limit it to 8
 854                 do {
 855                         Term->Text[ Term->WritePos ].Ch = 0;
 856                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 857                         Term->WritePos --;
 858                 } while(Term->WritePos && i-- && Term->Text[ Term->WritePos ].Ch == '\0');
 859                 if(Term->Text[ Term->WritePos ].Ch != '\0')
 860                         Term->WritePos ++;
 861                 break;
 862
 863         default:
 864                 Term->Text[ Term->WritePos ].Ch = Ch;
 865                 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 866                 Term->WritePos ++;
 867                 break;
 868         }
 869
 870
 871         // Move Screen
 872         if(Term->WritePos >= Term->Width*Term->Height*VT_SCROLLBACK)
 873         {
 874                  int    base, i;
 875                 Term->WritePos -= Term->Width;
 876
 877                 // Update view position
 878                 base = Term->Width*Term->Height*(VT_SCROLLBACK-1);
 879                 if(Term->ViewPos < base)        Term->ViewPos += Term->Width;
 880                 if(Term->ViewPos > base)        Term->ViewPos = base;
 881
 882                 // Scroll terminal cache
 883                 base = Term->Width*(Term->Height*VT_SCROLLBACK-1);
 884
 885                 // Scroll Back
 886                 memcpy(
 887                         Term->Text,
 888                         &Term->Text[Term->Width],
 889                         Term->Width*(Term->Height-1)*VT_SCROLLBACK*sizeof(tVT_Char)
 890                         );
 891
 892                 // Clear last row
 893                 for( i = 0; i < Term->Width; i ++ )
 894                 {
 895                         Term->Text[ base + i ].Ch = 0;
 896                         Term->Text[ base + i ].Colour = Term->CurColour;
 897                 }
 898
 899                 VT_int_UpdateScreen( Term, 1 );
 900         }
 901         else if(Term->WritePos > Term->Width*Term->Height+Term->ViewPos)
 902         {
 903                 Term->ViewPos += Term->Width;
 904                 VT_int_UpdateScreen( Term, 1 );
 905         }
 906         else
 907                 VT_int_UpdateScreen( Term, 0 );
 908
 909         //LEAVE('-');
 910 }
 911
 912 /**
 913  * \fn void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
 914  * \brief Updates the video framebuffer
 915  */
 916 void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
 917 {
 918         // Only update if this is the current terminal
 919         if( Term != &gVT_Terminals[giVT_CurrentTerminal] )      return;
 920
 921         if( Term->Mode == TERM_MODE_TEXT )
 922         {
 923                 if(gbVT_TextMode)
 924                 {
 925                         if(UpdateAll) {
 926                                 VFS_WriteAt(
 927                                         giVT_OutputDevHandle,
 928                                         0,
 929                                         Term->Width*Term->Height*sizeof(tVT_Char),
 930                                         &Term->Text[Term->ViewPos]
 931                                         );
 932                         } else {
 933                                  int    pos = Term->WritePos - Term->WritePos % Term->Width;
 934                                 VFS_WriteAt(
 935                                         giVT_OutputDevHandle,
 936                                         (pos - Term->ViewPos)*sizeof(tVT_Char),
 937                                         Term->Width*sizeof(tVT_Char),
 938                                         &Term->Text[pos]
 939                                         );
 940                         }
 941                 }
 942                 else
 943                 {
 944                         //TODO: Do VT Rendered Text
 945                         #if 0
 946                         if( UpdateAll ) {
 947                                 VT_RenderText(0, Term->Width*Term->Height, &Term->Text[Term->ViewPos]);
 948                         }
 949                         else {
 950                                  int    pos = Term->WritePos - Term->WritePos % Term->Width;
 951                                 VT_RenderText(
 952                                         pos - Term->ViewPos,
 953                                         Term->Width,
 954                                         &Term->Text[pos]
 955                                         );
 956                         }
 957                         #endif
 958                 }
 959         }
 960         else
 961         {
 962                 VFS_WriteAt(
 963                         giVT_OutputDevHandle,
 964                         0,
 965                         Term->Width*Term->Height*sizeof(Uint32),
 966                         &Term->Buffer
 967                         );
 968         }
 969 }
 970
 971 /**
 972  * \fn void VT_int_ChangeMode(tVTerm *Term, int NewMode)
 973  * \brief Change the mode of a VTerm
 974  */
 975 void VT_int_ChangeMode(tVTerm *Term, int NewMode)
 976 {
 977         switch(NewMode)
 978         {
 979         case TERM_MODE_TEXT:
 980                 free(Term->Buffer);
 981                 Term->Text = calloc( Term->Width*Term->Height*VT_SCROLLBACK, sizeof(tVT_Char) );
 982                 break;
 983         case TERM_MODE_FB:
 984                 free(Term->Text);
 985                 Term->Buffer = calloc( Term->Width*Term->Height, sizeof(Uint32) );
 986                 break;
 987         //case TERM_MODE_OPENGL:
 988         //      return;
 989         }
 990
 991         Term->Mode = NewMode;
 992 }
 993
 994 // ---
 995 // Font Render
 996 // ---
 997 #define MONOSPACE_FONT  10816
 998
 999 #if MONOSPACE_FONT == 10808     // 8x8
1000 # include "vterm_font_8x8.h"
1001 #elif MONOSPACE_FONT == 10816   // 8x16
1002 # include "vterm_font_8x16.h"
1003 #endif
1004
1005 // === PROTOTYPES ===
1006 Uint8   *VT_Font_GetChar(Uint32 Codepoint);
1007
1008 // === GLOBALS ===
1009 int     giVT_CharWidth = FONT_WIDTH+1;
1010 int     giVT_CharHeight = FONT_HEIGHT;
1011
1012 // === CODE ===
1013 /**
1014  * \fn void VT_Font_Render(Uint32 Codepoint, void *Buffer, int Pitch, Uint32 BGC, Uint32 FGC)
1015  * \brief Render a font character
1016  */
1017 void VT_Font_Render(Uint32 Codepoint, void *Buffer, int Pitch, Uint32 BGC, Uint32 FGC)
1018 {
1019         Uint8   *font;
1020         Uint32  *buf = Buffer;
1021          int    x, y;
1022
1023         font = VT_Font_GetChar(Codepoint);
1024
1025         for(y = 0; y < FONT_HEIGHT; y ++)
1026         {
1027                 for(x = 0; x < FONT_WIDTH; x ++)
1028                 {
1029                         if(*font & (1 << (FONT_WIDTH-x-1)))
1030                                 buf[x] = FGC;
1031                         else
1032                                 buf[x] = BGC;
1033                 }
1034                 buf += Pitch;
1035                 font ++;
1036         }
1037 }
1038
1039 /**
1040  * \fn Uint32 VT_Colour12to24(Uint16 Col12)
1041  * \brief Converts a
1042  */
1043 Uint32 VT_Colour12to24(Uint16 Col12)
1044 {
1045         Uint32  ret;
1046          int    tmp;
1047         tmp = Col12 & 0xF;
1048         ret  = (tmp << 0) | (tmp << 4);
1049         tmp = (Col12 & 0xF0) >> 4;
1050         ret |= (tmp << 8) | (tmp << 12);
1051         tmp = (Col12 & 0xF00) >> 8;
1052         ret |= (tmp << 16) | (tmp << 20);
1053         return ret;
1054 }
1055
1056 /**
1057  * \fn Uint8 *VT_Font_GetChar(Uint32 Codepoint)
1058  * \brief Gets an index into the font array given a Unicode Codepoint
1059  * \note See http://en.wikipedia.org/wiki/CP437
1060  */
1061 Uint8 *VT_Font_GetChar(Uint32 Codepoint)
1062 {
1063          int    index = 0;
1064         if(Codepoint < 128)
1065                 return &VTermFont[Codepoint*FONT_HEIGHT];
1066         switch(Codepoint)
1067         {
1068         case 0xC7:      index = 128;    break;  // Ç
1069         case 0xFC:      index = 129;    break;  // ü
1070         case 0xE9:      index = 130;    break;  // é
1071         case 0xE2:      index = 131;    break;  // â
1072         case 0xE4:      index = 132;    break;  // ä
1073         case 0xE0:      index = 133;    break;  // à
1074         case 0xE5:      index = 134;    break;  // å
1075         case 0xE7:      index = 135;    break;  // ç
1076         case 0xEA:      index = 136;    break;  // ê
1077         case 0xEB:      index = 137;    break;  // ë
1078         case 0xE8:      index = 138;    break;  // è
1079         case 0xEF:      index = 139;    break;  // ï
1080         case 0xEE:      index = 140;    break;  // î
1081         case 0xEC:      index = 141;    break;  // ì
1082         case 0xC4:      index = 142;    break;  // Ä
1083         case 0xC5:      index = 143;    break;  // Å
1084         }
1085
1086         return &VTermFont[index*FONT_HEIGHT];
1087 }
1088
1089 EXPORTAS(&giVT_CharWidth, giVT_CharWidth);
1090 EXPORTAS(&giVT_CharHeight, giVT_CharHeight);
1091 EXPORT(VT_Font_Render);
1092 EXPORT(VT_Colour12to24);