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