Kernel/drv/vterm.c

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