Kernel/drv/vterm.c

   1 /*
   2  * Acess2 Virtual Terminal Driver
   3  */
   4 #include <common.h>
   5 #include <fs_devfs.h>
   6 #include <modules.h>
   7 #include <tpl_drv_video.h>
   8
   9 // === CONSTANTS ===
  10 #define NUM_VTS 4
  11 #define MAX_INPUT_CHARS 64
  12 #define VT_SCROLLBACK   4       // 4 Screens of text
  13 #define DEFAULT_OUTPUT  "/Devices/VGA"
  14 #define DEFAULT_INPUT   "/Devices/PS2Keyboard"
  15 #define DEFAULT_WIDTH   80
  16 #define DEFAULT_HEIGHT  25
  17 #define DEFAULT_COLOUR  (VT_COL_BLACK|(VT_COL_WHITE<<16))
  18
  19 enum eVT_Modes {
  20         VT_MODE_TEXT8,  // UTF-8 Text Mode (VT100 Emulation)
  21         VT_MODE_TEXT32, // UTF-32 Text Mode (Acess Native)
  22         VT_MODE_8BPP,   // 256 Colour Mode
  23         VT_MODE_16BPP,  // 16 bit Colour Mode
  24         VT_MODE_24BPP,  // 24 bit Colour Mode
  25         VT_MODE_32BPP,  // 32 bit Colour Mode
  26         NUM_VT_MODES
  27 };
  28
  29 // === TYPES ===
  30 typedef struct {
  31          int    Mode;
  32          int    Width, Height;
  33          int    ViewPos, WritePos;
  34         Uint32  CurColour;
  35         char    Name[2];
  36          int    InputRead;
  37          int    InputWrite;
  38         Uint32  InputBuffer[MAX_INPUT_CHARS];
  39         union {
  40                 tVT_Char        *Text;
  41                 Uint32          *Buffer;
  42         };
  43         tVFS_Node       Node;
  44 } tVTerm;
  45
  46 // === PROTOTYPES ===
  47  int    VT_Install(char **Arguments);
  48 char    *VT_ReadDir(tVFS_Node *Node, int Pos);
  49 tVFS_Node       *VT_FindDir(tVFS_Node *Node, char *Name);
  50 Uint64  VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
  51 Uint64  VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
  52  int    VT_IOCtl(tVFS_Node *Node, int Id, void *Data);
  53 void    VT_KBCallBack(Uint32 Codepoint);
  54 void    VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count);
  55  int    VT_int_ParseEscape(tVTerm *Term, char *Buffer);
  56 void    VT_int_PutChar(tVTerm *Term, Uint32 Ch);
  57 void    VT_int_UpdateScreen( tVTerm *Term, int UpdateAll );
  58
  59 // === CONSTANTS ===
  60 const Uint16    caVT100Colours[] = {
  61                 VT_COL_BLACK, 0, 0, 0, 0, 0, 0, VT_COL_LTGREY,
  62                 VT_COL_GREY, 0, 0, 0, 0, 0, 0, VT_COL_WHITE
  63         };
  64
  65 // === GLOBALS ===
  66 MODULE_DEFINE(0, 0x0032, VTerm, VT_Install, NULL, NULL);
  67 tDevFS_Driver   gVT_DrvInfo = {
  68         NULL, "VTerm",
  69         {
  70         .Flags = VFS_FFLAG_DIRECTORY,
  71         .Inode = -1,
  72         .NumACLs = 0,
  73         .ReadDir = VT_ReadDir,
  74         .FindDir = VT_FindDir
  75         }
  76 };
  77 tVTerm  gVT_Terminals[NUM_VTS];
  78 char    *gsVT_OutputDevice = NULL;
  79 char    *gsVT_InputDevice = NULL;
  80  int    giVT_OutputDevHandle = -2;
  81  int    giVT_InputDevHandle = -2;
  82  int    giVT_CurrentTerminal = 0;
  83
  84 // === CODE ===
  85 /**
  86  * \fn int VT_Install(char **Arguments)
  87  */
  88 int VT_Install(char **Arguments)
  89 {
  90         char    **args = Arguments;
  91         char    *arg;
  92          int    i;
  93
  94         // Scan Arguments
  95         if(Arguments)
  96         {
  97                 for( ; (arg = *args); args++ )
  98                 {
  99                         if(arg[0] != '-')       continue;
 100
 101                         switch(arg[1])
 102                         {
 103                         // Set output device
 104                         case 'o':
 105                                 if(args[1] ==  NULL)    break;
 106                                 if(gsVT_OutputDevice)   free(gsVT_OutputDevice);
 107                                 gsVT_OutputDevice = malloc(strlen(args[1])+1);
 108                                 strcpy(gsVT_OutputDevice, args[1]);
 109                                 args ++;
 110                                 break;
 111
 112                         // Set input device
 113                         case 'i':
 114                                 if(args[1] == NULL)     break;
 115                                 if(gsVT_InputDevice)    free(gsVT_InputDevice);
 116                                 gsVT_InputDevice = malloc(strlen(args[1])+1);
 117                                 strcpy(gsVT_InputDevice, args[1]);
 118                                 args ++;
 119                                 break;
 120
 121                         }
 122                 }
 123         }
 124
 125         // Apply Defaults
 126         if(!gsVT_OutputDevice)  gsVT_OutputDevice = DEFAULT_OUTPUT;
 127         if(!gsVT_InputDevice)   gsVT_InputDevice = DEFAULT_INPUT;
 128
 129         LOG("Using '%s' as output", gsVT_OutputDevice);
 130         LOG("Using '%s' as input", gsVT_InputDevice);
 131
 132         // Create Nodes
 133         for( i = 0; i < NUM_VTS; i++ )
 134         {
 135                 gVT_Terminals[i].Mode = VT_MODE_TEXT8;
 136                 gVT_Terminals[i].Width = DEFAULT_WIDTH;
 137                 gVT_Terminals[i].Height = DEFAULT_HEIGHT;
 138                 gVT_Terminals[i].CurColour = DEFAULT_COLOUR;
 139                 gVT_Terminals[i].WritePos = 0;
 140                 gVT_Terminals[i].ViewPos = 0;
 141
 142                 gVT_Terminals[i].Buffer = malloc( DEFAULT_WIDTH*DEFAULT_HEIGHT*sizeof(tVT_Char) );
 143                 memset( gVT_Terminals[i].Buffer, 0, DEFAULT_WIDTH*DEFAULT_HEIGHT*sizeof(tVT_Char) );
 144
 145                 gVT_Terminals[i].Name[0] = '0'+i;
 146                 gVT_Terminals[i].Name[1] = '\0';
 147                 gVT_Terminals[i].Node.Inode = i;
 148                 gVT_Terminals[i].Node.NumACLs = 0;      // Only root can open virtual terminals
 149
 150                 gVT_Terminals[i].Node.Read = VT_Read;
 151                 gVT_Terminals[i].Node.Write = VT_Write;
 152                 gVT_Terminals[i].Node.IOCtl = VT_IOCtl;
 153         }
 154
 155         // Add to DevFS
 156         DevFS_AddDevice( &gVT_DrvInfo );
 157
 158         return 0;
 159 }
 160
 161 /**
 162  * \fn void VT_InitOutput()
 163  * \brief Initialise Video Output
 164  */
 165 void VT_InitOutput()
 166 {
 167         giVT_OutputDevHandle = VFS_Open(gsVT_OutputDevice, VFS_OPENFLAG_WRITE);
 168         LOG("giVT_OutputDevHandle = %x\n", giVT_OutputDevHandle);
 169 }
 170
 171 /**
 172  * \fn void VT_InitInput()
 173  * \brief Initialises the input
 174  */
 175 void VT_InitInput()
 176 {
 177         giVT_InputDevHandle = VFS_Open(gsVT_InputDevice, VFS_OPENFLAG_READ);
 178         LOG("giVT_InputDevHandle = %x\n", giVT_InputDevHandle);
 179 }
 180
 181 /**
 182  * \fn char *VT_ReadDir(tVFS_Node *Node, int Pos)
 183  * \brief Read from the VTerm Directory
 184  */
 185 char *VT_ReadDir(tVFS_Node *Node, int Pos)
 186 {
 187         if(Pos < 0)     return NULL;
 188         if(Pos >= NUM_VTS)      return NULL;
 189         return gVT_Terminals[Pos].Name;
 190 }
 191
 192 /**
 193  * \fn tVFS_Node *VT_FindDir(tVFS_Node *Node, char *Name)
 194  * \brief Find an item in the VTerm directory
 195  */
 196 tVFS_Node *VT_FindDir(tVFS_Node *Node, char *Name)
 197 {
 198          int    num;
 199
 200         //ENTER("pNode sName", Node, Name);
 201
 202         // Open the input and output files if needed
 203         if(giVT_OutputDevHandle == -2)  VT_InitOutput();
 204         if(giVT_InputDevHandle == -2)   VT_InitInput();
 205
 206         // Sanity check name
 207         if(Name[0] < '0' || Name[0] > '9' || Name[1] != '\0') {
 208                 LEAVE('n');
 209                 return NULL;
 210         }
 211         // Get index
 212         num = Name[0] - '0';
 213         if(num >= NUM_VTS) {
 214                 LEAVE('n');
 215                 return NULL;
 216         }
 217         // Return node
 218         //LEAVE('p', &gVT_Terminals[num].Node);
 219         return &gVT_Terminals[num].Node;
 220 }
 221
 222 /**
 223  * \fn Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 224  * \brief Read from a virtual terminal
 225  */
 226 Uint64 VT_Read(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 227 {
 228          int    pos = 0;
 229         tVTerm  *term = &gVT_Terminals[ Node->Inode ];
 230
 231         // Check current mode
 232         switch(term->Mode)
 233         {
 234         case VT_MODE_TEXT8:
 235                 while(pos < Length)
 236                 {
 237                         while(term->InputRead == term->InputWrite)      Proc_Yield();
 238                         while(term->InputRead != term->InputWrite)
 239                         {
 240                                 pos += WriteUTF8(Buffer+pos, term->InputBuffer[term->InputRead]);
 241                                 term->InputRead ++;
 242                         }
 243                 }
 244                 break;
 245
 246         case VT_MODE_TEXT32:
 247                 while(pos < Length)
 248                 {
 249                         while(term->InputRead == term->InputWrite)      Proc_Yield();
 250                         while(term->InputRead != term->InputWrite)
 251                         {
 252                                 ((Uint32*)Buffer)[pos] = term->InputBuffer[term->InputRead];
 253                                 pos ++;
 254                                 term->InputRead ++;
 255                         }
 256                 }
 257                 break;
 258         }
 259         return 0;
 260 }
 261
 262 /**
 263  * \fn Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 264  * \brief Write to a virtual terminal
 265  */
 266 Uint64 VT_Write(tVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer)
 267 {
 268         tVTerm  *term = &gVT_Terminals[ Node->Inode ];
 269
 270         //ENTER("pNode XOffset XLength pBuffer",  Node, Offset, Length, Buffer);
 271
 272         // Write
 273         switch( term->Mode )
 274         {
 275         case VT_MODE_TEXT8:
 276                 VT_int_PutString(term, Buffer, Length);
 277                 break;
 278         case VT_MODE_TEXT32:
 279                 //VT_int_PutString32(term, Buffer, Length);
 280                 break;
 281         }
 282         //LEAVE('i', 0);
 283         return 0;
 284 }
 285
 286 /**
 287  * \fn int VT_IOCtl(tVFS_Node *Node, int Id, void *Data)
 288  * \brief Call an IO Control on a virtual terminal
 289  */
 290 int VT_IOCtl(tVFS_Node *Node, int Id, void *Data)
 291 {
 292         return 0;
 293 }
 294
 295 /**
 296  * \fn void VT_KBCallBack(Uint32 Codepoint)
 297  * \brief Called on keyboard interrupt
 298  */
 299 void VT_KBCallBack(Uint32 Codepoint)
 300 {
 301         tVTerm  *term = &gVT_Terminals[giVT_CurrentTerminal];
 302
 303         term->InputBuffer[ term->InputWrite ] = Codepoint;
 304         term->InputWrite ++;
 305         term->InputWrite %= MAX_INPUT_CHARS;
 306         if(term->InputRead == term->InputWrite) {
 307                 term->InputRead ++;
 308                 term->InputRead %= MAX_INPUT_CHARS;
 309         }
 310 }
 311
 312 /**
 313  * \fn void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
 314  * \brief Print a string to the Virtual Terminal
 315  */
 316 void VT_int_PutString(tVTerm *Term, Uint8 *Buffer, Uint Count)
 317 {
 318         Uint32  val;
 319          int    i;
 320         for( i = 0; i < Count; i++ )
 321         {
 322                 if( Buffer[i] == 0x1B ) // Escape Sequence
 323                 {
 324                         i += VT_int_ParseEscape(Term, (char*)&Buffer[i]);
 325                         continue;
 326                 }
 327
 328                 if( Buffer[i] < 128 )   // Plain ASCII
 329                         VT_int_PutChar(Term, Buffer[i]);
 330                 else {  // UTF-8
 331                         i += ReadUTF8(&Buffer[i], &val);
 332                         VT_int_PutChar(Term, val);
 333                 }
 334         }
 335 }
 336
 337 /**
 338  * \fn int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
 339  * \brief Parses a VT100 Escape code
 340  */
 341 int VT_int_ParseEscape(tVTerm *Term, char *Buffer)
 342 {
 343         char    c;
 344          int    argc = 0, j = 1;
 345          int    args[4] = {0,0,0,0};
 346
 347         switch(Buffer[0]) {
 348         //Large Code
 349         case '[':
 350                 // Get Arguments
 351                 c = Buffer[1];
 352                 do {
 353                         while('0' <= c && c <= '9') {
 354                                 args[argc] *= 10;
 355                                 args[argc] += c-'0';
 356                                 c = Buffer[++j];
 357                         }
 358                         argc ++;
 359                 } while(c == ';');
 360
 361                 // Get string (what does this do?)
 362                 if(c == '"') {
 363                         c = Buffer[++j];
 364                         while(c != '"')
 365                                 c = Buffer[++j];
 366                 }
 367
 368                 // Get Command
 369                 if(     ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z'))
 370                 {
 371                         switch(c) {
 372                         //Clear By Line
 373                         case 'J':
 374                                 // Clear Screen
 375                                 if(args[0] == 2) {
 376                                         memset(Term->Text, 0, Term->Width*Term->Height*VT_SCROLLBACK*sizeof(tVT_Char));
 377                                         Term->WritePos = 0;
 378                                         Term->ViewPos = 0;
 379                                 }
 380                                 break;
 381                         // Set Font flags
 382                         case 'm':
 383                                 for( ; argc--; )
 384                                 {
 385                                         // Flags
 386                                         if( 0 <= args[argc] && args[argc] <= 8)
 387                                         {
 388                                                 switch(args[argc])
 389                                                 {
 390                                                 case 0: Term->CurColour = DEFAULT_COLOUR;       break;  // Reset
 391                                                 case 1: Term->CurColour |= 0x80000000;  break;  // Bright
 392                                                 case 2: Term->CurColour &= ~0x80000000; break;  // Dim
 393                                                 }
 394                                         }
 395                                         // Foreground Colour
 396                                         else if(30 <= args[argc] && args[argc] <= 37) {
 397                                                 Term->CurColour &= 0xF000FFFF;
 398                                                 Term->CurColour |= (Uint32)caVT100Colours[ args[argc]-30+(Term->CurColour>>28) ] << 16;
 399                                         }
 400                                         // Background Colour
 401                                         else if(40 <= args[argc] && args[argc] <= 47) {
 402                                                 Term->CurColour &= 0xFFFF8000;
 403                                                 Term->CurColour |= caVT100Colours[ args[argc]-40+((Term->CurColour>>12)&15) ];
 404                                         }
 405                                 }
 406                                 break;
 407                         }
 408                 }
 409                 break;
 410
 411         default:
 412                 break;
 413         }
 414
 415         return j + 1;
 416 }
 417
 418 /**
 419  * \fn void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
 420  * \brief Write a single character to a VTerm
 421  */
 422 void VT_int_PutChar(tVTerm *Term, Uint32 Ch)
 423 {
 424          int    i;
 425         //ENTER("pTerm xCh", Term, Ch);
 426         //LOG("Term = {WritePos:%i, ViewPos:%i}\n", Term->WritePos, Term->ViewPos);
 427
 428         switch(Ch)
 429         {
 430         case '\n':
 431                 Term->WritePos += Term->Width;
 432         case '\r':
 433                 Term->WritePos -= Term->WritePos % Term->Width;
 434                 break;
 435
 436         case '\t':
 437                 do {
 438                         Term->Text[ Term->WritePos ].Ch = '\t';
 439                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 440                         Term->WritePos ++;
 441                 } while(Term->WritePos & 7);
 442                 break;
 443
 444         case '\b':
 445                 // Backspace is invalid at Offset 0
 446                 if(Term->WritePos == 0) break;
 447
 448                 Term->WritePos --;
 449                 // Singe Character
 450                 if(Term->Text[ Term->WritePos ].Ch != '\t') {
 451                         Term->Text[ Term->WritePos ].Ch = 0;
 452                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 453                         break;
 454                 }
 455                 // Tab
 456                 i = 7;  // Limit it to 8
 457                 do {
 458                         Term->Text[ Term->WritePos ].Ch = 0;
 459                         Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 460                         Term->WritePos --;
 461                 } while(Term->WritePos && i-- && Term->Text[ Term->WritePos ].Ch == '\t');
 462                 break;
 463
 464         default:
 465                 Term->Text[ Term->WritePos ].Ch = Ch;
 466                 Term->Text[ Term->WritePos ].Colour = Term->CurColour;
 467                 Term->WritePos ++;
 468                 break;
 469         }
 470
 471         if(Term->WritePos >= Term->Width*Term->Height*VT_SCROLLBACK)
 472         {
 473                  int    base, i;
 474                 Term->WritePos -= Term->Width;
 475
 476                 // Update view position
 477                 base = Term->Width*Term->Height*(VT_SCROLLBACK-1);
 478                 if(Term->ViewPos < base)        Term->ViewPos += Term->Width;
 479                 if(Term->ViewPos > base)        Term->ViewPos = base;
 480
 481                 // Scroll terminal cache
 482                 base = Term->Width*(Term->Height*VT_SCROLLBACK-1);
 483
 484                 // Scroll Back
 485                 memcpy( Term->Text, &Term->Text[Term->Width], base*sizeof(tVT_Char) );
 486
 487                 // Clear last row
 488                 for( i = 0; i < Term->Width; i ++ )
 489                 {
 490                         Term->Text[ base + i ].Ch = 0;
 491                         Term->Text[ base + i ].Colour = Term->CurColour;
 492                 }
 493
 494                 VT_int_UpdateScreen( Term, 1 );
 495         }
 496         else
 497                 VT_int_UpdateScreen( Term, 0 );
 498
 499         //LEAVE('-');
 500 }
 501
 502 /**
 503  * \fn void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
 504  * \brief Updates the video framebuffer
 505  */
 506 void VT_int_UpdateScreen( tVTerm *Term, int UpdateAll )
 507 {
 508         if(UpdateAll) {
 509                 VFS_WriteAt(
 510                         giVT_OutputDevHandle,
 511                         0,
 512                         Term->Width*Term->Height*sizeof(tVT_Char),
 513                         &Term->Text[Term->ViewPos]
 514                         );
 515         } else {
 516                  int    pos = Term->WritePos - Term->WritePos % Term->Width;
 517                 VFS_WriteAt(
 518                         giVT_OutputDevHandle,
 519                         (pos - Term->ViewPos)*sizeof(tVT_Char),
 520                         Term->Width*sizeof(tVT_Char),
 521                         &Term->Text[pos]
 522                         );
 523         }
 524 }
 525
 526 // ---
 527 // Font Render
 528 // ---
 529 #define MONOSPACE_FONT  10816
 530
 531 #if MONOSPACE_FONT == 10808     // 8x8
 532 # include "vterm_font_8x8.h"
 533 #elif MONOSPACE_FONT == 10816   // 8x16
 534 # include "vterm_font_8x16.h"
 535 #endif
 536
 537
 538 int VT_Font_GetWidth(Uint32 Codepoint)
 539 {
 540         return FONT_WIDTH;
 541 }
 542 int VT_Font_GetHeight(Uint32 Codepoint)
 543 {
 544         return FONT_HEIGHT;
 545 }
 546
 547 void VT_Font_Render(Uint32 Codepoint, void *Buffer, Uint32 BGC, Uint32 FGC)
 548 {
 549 //      Uint8   *font;
 550
 551 }
 552
 553 /**
 554  * \fn Uint8 *VT_Font_GetChar(Uint32 Codepoint)
 555  * \brief Gets an index into the font array given a Unicode Codepoint
 556  * \note See http://en.wikipedia.org/wiki/CP437
 557  */
 558 Uint8 *VT_Font_GetChar(Uint32 Codepoint)
 559 {
 560          int    index = 0;
 561         if(Codepoint < 128)
 562                 return &VTermFont[Codepoint*FONT_HEIGHT];
 563         switch(Codepoint)
 564         {
 565         case 0xC7:      index = 128;    break;  // Ç
 566         case 0xFC:      index = 129;    break;  // ü
 567         case 0xE9:      index = 130;    break;  // é
 568         case 0xE2:      index = 131;    break;  // â
 569         case 0xE4:      index = 132;    break;  // ä
 570         case 0xE0:      index = 133;    break;  // à
 571         case 0xE5:      index = 134;    break;  // å
 572         case 0xE7:      index = 135;    break;  // ç
 573         case 0xEA:      index = 136;    break;  // ê
 574         case 0xEB:      index = 137;    break;  // ë
 575         case 0xE8:      index = 138;    break;  // è
 576         case 0xEF:      index = 139;    break;  // ï
 577         case 0xEE:      index = 140;    break;  // î
 578         case 0xEC:      index = 141;    break;  // ì
 579         case 0xC4:      index = 142;    break;  // Ä
 580         case 0xC5:      index = 143;    break;  // Å
 581         }
 582
 583         return &VTermFont[index*FONT_HEIGHT];
 584 }