Modules/BochsVBE/bochsvbe.c

   1 /**\r
   2  * \file drv_bochsvbe.c\r
   3  * \brief BGA (Bochs Graphic Adapter) Driver\r
   4  * \note for Acess2\r
   5  * \warning This driver does NOT support the Bochs PCI VGA driver\r
   6 */\r
   7 #define DEBUG   0\r
   8 #include <common.h>\r
   9 #include <errno.h>\r
  10 #include <modules.h>\r
  11 #include <vfs.h>\r
  12 #include <fs_devfs.h>\r
  13 #include <drv_pci.h>\r
  14 #include <tpl_drv_video.h>\r
  15 \r
  16 //#define INT   static\r
  17 #define INT\r
  18 \r
  19 // === TYPEDEFS ===\r
  20 typedef struct {\r
  21         Uint16  width;\r
  22         Uint16  height;\r
  23         Uint16  bpp;\r
  24         Uint16  flags;\r
  25         Uint32  fbSize;\r
  26 } t_bga_mode;\r
  27 \r
  28 // === CONSTANTS ===\r
  29 enum eMode_Flags {\r
  30         MODEFLAG_TEXT = 1\r
  31 };\r
  32 #define BGA_LFB_MAXSIZE (1024*768*4)\r
  33 #define VBE_DISPI_BANK_ADDRESS  0xA0000\r
  34 #define VBE_DISPI_LFB_PHYSICAL_ADDRESS  0xE0000000\r
  35 #define VBE_DISPI_IOPORT_INDEX  0x01CE\r
  36 #define VBE_DISPI_IOPORT_DATA   0x01CF\r
  37 #define VBE_DISPI_DISABLED      0x00\r
  38 #define VBE_DISPI_ENABLED       0x01\r
  39 #define VBE_DISPI_LFB_ENABLED   0x40\r
  40 #define VBE_DISPI_NOCLEARMEM    0x80\r
  41 enum {\r
  42         VBE_DISPI_INDEX_ID,\r
  43         VBE_DISPI_INDEX_XRES,\r
  44         VBE_DISPI_INDEX_YRES,\r
  45         VBE_DISPI_INDEX_BPP,\r
  46         VBE_DISPI_INDEX_ENABLE,\r
  47         VBE_DISPI_INDEX_BANK,\r
  48         VBE_DISPI_INDEX_VIRT_WIDTH,\r
  49         VBE_DISPI_INDEX_VIRT_HEIGHT,\r
  50         VBE_DISPI_INDEX_X_OFFSET,\r
  51         VBE_DISPI_INDEX_Y_OFFSET\r
  52 };\r
  53 \r
  54 \r
  55 // === PROTOTYPES ===\r
  56 // Driver\r
  57  int    BGA_Install(char **Arguments);\r
  58 void    BGA_Uninstall();\r
  59 // Internal\r
  60 void    BGA_int_WriteRegister(Uint16 reg, Uint16 value);\r
  61 Uint16  BGA_int_ReadRegister(Uint16 reg);\r
  62 void    BGA_int_SetBank(Uint16 bank);\r
  63 void    BGA_int_SetMode(Uint16 width, Uint16 height);\r
  64  int    BGA_int_UpdateMode(int id);\r
  65  int    BGA_int_FindMode(tVideo_IOCtl_Mode *info);\r
  66  int    BGA_int_ModeInfo(tVideo_IOCtl_Mode *info);\r
  67  int    BGA_int_MapFB(void *Dest);\r
  68 // Filesystem\r
  69 Uint64  BGA_Read(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);\r
  70 Uint64  BGA_Write(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);\r
  71  int    BGA_Ioctl(tVFS_Node *node, int id, void *data);\r
  72 \r
  73 // === GLOBALS ===\r
  74 MODULE_DEFINE(0, 0x0032, BochsVBE, BGA_Install, NULL, NULL);\r
  75 tDevFS_Driver   gBGA_DriverStruct = {\r
  76         NULL, "BochsGA",\r
  77         {\r
  78         .Read = BGA_Read,\r
  79         .Write = BGA_Write,\r
  80         .IOCtl = BGA_Ioctl\r
  81         }\r
  82 };\r
  83  int    giBGA_CurrentMode = -1;\r
  84  int    giBGA_DriverId = -1;\r
  85 Uint    *gBGA_Framebuffer;\r
  86 t_bga_mode      gBGA_Modes[] = {\r
  87         {},\r
  88         { 80,25, 12, MODEFLAG_TEXT, 80*25*8},   // 640 x 480\r
  89         {100,37, 12, MODEFLAG_TEXT, 100*37*8},  // 800 x 600\r
  90         {640,480,8, 0, 640*480},\r
  91         {640,480,32, 0, 640*480*4},\r
  92         {800,600,8, 0, 800*600},\r
  93         {800,600,32, 0, 800*600*4},\r
  94 };\r
  95 #define BGA_MODE_COUNT  (sizeof(gBGA_Modes)/sizeof(gBGA_Modes[0]))\r
  96 \r
  97 // === CODE ===\r
  98 /**\r
  99  * \fn int BGA_Install(char **Arguments)\r
 100  */\r
 101 int BGA_Install(char **Arguments)\r
 102 {\r
 103          int    bga_version = 0;\r
 104         \r
 105         // Check BGA Version\r
 106         bga_version = BGA_int_ReadRegister(VBE_DISPI_INDEX_ID);\r
 107         // NOTE: This driver was written for 0xB0C4, but they seem to be backwards compatable\r
 108         if(bga_version < 0xB0C4 || bga_version > 0xB0C5) {\r
 109                 Warning("[BGA ] Bochs Adapter Version is not 0xB0C4 or 0xB0C5, instead 0x%x", bga_version);\r
 110                 return 0;\r
 111         }\r
 112         \r
 113         // Install Device\r
 114         giBGA_DriverId = DevFS_AddDevice( &gBGA_DriverStruct );\r
 115         if(giBGA_DriverId == -1) {\r
 116                 Warning("[BGA ] Unable to register with DevFS, maybe already loaded?");\r
 117                 return 0;\r
 118         }\r
 119         \r
 120         // Map Framebuffer to hardware address\r
 121         gBGA_Framebuffer = (void *) MM_MapHWPage(VBE_DISPI_LFB_PHYSICAL_ADDRESS, 768);  // 768 pages (3Mb)\r
 122         \r
 123         return 1;\r
 124 }\r
 125 \r
 126 /**\r
 127  * \fn void BGA_Uninstall()\r
 128  */\r
 129 void BGA_Uninstall()\r
 130 {\r
 131         //DevFS_DelDevice( giBGA_DriverId );\r
 132         MM_UnmapHWPage( VBE_DISPI_LFB_PHYSICAL_ADDRESS, 768 );\r
 133 }\r
 134 \r
 135 /**\r
 136  * \fn Uint64 BGA_Read(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer)\r
 137  * \brief Read from the framebuffer\r
 138  */\r
 139 Uint64 BGA_Read(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer)\r
 140 {\r
 141         // Check Mode\r
 142         if(giBGA_CurrentMode == -1)     return -1;\r
 143         \r
 144         // Check Offset and Length against Framebuffer Size\r
 145         if(off+len > gBGA_Modes[giBGA_CurrentMode].fbSize)\r
 146                 return -1;\r
 147         \r
 148         // Copy from Framebuffer\r
 149         memcpy(buffer, (void*)((Uint)gBGA_Framebuffer + (Uint)off), len);\r
 150         return len;\r
 151 }\r
 152 \r
 153 /**\r
 154  * \fn Uint64 BGA_Write(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer)\r
 155  * \brief Write to the framebuffer\r
 156  */\r
 157 Uint64 BGA_Write(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer)\r
 158 {       \r
 159         ENTER("xoff xlen", off, len);\r
 160         \r
 161         // Check Mode\r
 162         if(giBGA_CurrentMode == -1) {\r
 163                 LEAVE('i', -1);\r
 164                 return -1;\r
 165         }\r
 166         \r
 167         // Check Input against Frambuffer Size\r
 168         if(off+len > gBGA_Modes[giBGA_CurrentMode].fbSize) {\r
 169                 LEAVE('i', -1);\r
 170                 return -1;\r
 171         }\r
 172         \r
 173         // Text Mode\r
 174         if( gBGA_Modes[giBGA_CurrentMode].flags & MODEFLAG_TEXT )\r
 175         {\r
 176                 tVT_Char        *chars = buffer;\r
 177                  int    pitch = gBGA_Modes[giBGA_CurrentMode].width * giVT_CharWidth;\r
 178                 Uint32  *dest;\r
 179                 off /= sizeof(tVT_Char);\r
 180                 dest = (void*)gBGA_Framebuffer;\r
 181                 dest += (off / gBGA_Modes[giBGA_CurrentMode].width) * giVT_CharHeight * pitch;\r
 182                 dest += (off % gBGA_Modes[giBGA_CurrentMode].width) * giVT_CharWidth;\r
 183                 len /= sizeof(tVT_Char);\r
 184                 while(len--)\r
 185                 {\r
 186                         VT_Font_Render(\r
 187                                 chars->Ch,\r
 188                                 dest, pitch,\r
 189                                 VT_Colour12to24(chars->BGCol),\r
 190                                 VT_Colour12to24(chars->FGCol)\r
 191                                 );\r
 192                         dest += giVT_CharWidth;\r
 193                         chars++;\r
 194                 }\r
 195         }\r
 196         else\r
 197         {\r
 198                 Uint8   *destBuf = (Uint8*) ((Uint)gBGA_Framebuffer + (Uint)off);\r
 199                 \r
 200                 LOG("buffer = %p\n", buffer);\r
 201                 LOG("Updating Framebuffer (%p to %p)\n", \r
 202                         destBuf, destBuf + (Uint)len);\r
 203                 \r
 204                 \r
 205                 // Copy to Frambuffer\r
 206                 memcpy(destBuf, buffer, len);\r
 207                 \r
 208                 LOG("BGA Framebuffer updated\n");\r
 209         }\r
 210         \r
 211         LEAVE('i', len);\r
 212         return len;\r
 213 }\r
 214 \r
 215 /**\r
 216  * \fn INT int BGA_Ioctl(tVFS_Node *node, int id, void *data)\r
 217  * \brief Handle messages to the device\r
 218  */\r
 219 INT int BGA_Ioctl(tVFS_Node *node, int id, void *data)\r
 220 {\r
 221          int    ret = -2;\r
 222         ENTER("pNode iId pData", node, id, data);\r
 223         \r
 224         switch(id)\r
 225         {\r
 226         case DRV_IOCTL_TYPE:\r
 227                 ret = DRV_TYPE_VIDEO;\r
 228                 break;\r
 229         case DRV_IOCTL_IDENT:\r
 230                 memcpy(data, "BGA1", 4);\r
 231                 ret = 1;\r
 232                 break;\r
 233         case DRV_IOCTL_VERSION:\r
 234                 ret = 0x100;\r
 235                 break;\r
 236         case DRV_IOCTL_LOOKUP:  // TODO: Implement\r
 237                 ret = 0;\r
 238                 break;\r
 239                 \r
 240         case VIDEO_IOCTL_SETMODE:\r
 241                 ret = BGA_int_UpdateMode(*(int*)(data));\r
 242                 break;\r
 243                 \r
 244         case VIDEO_IOCTL_GETMODE:\r
 245                 ret = giBGA_CurrentMode;\r
 246                 break;\r
 247         \r
 248         case VIDEO_IOCTL_FINDMODE:\r
 249                 ret = BGA_int_FindMode((tVideo_IOCtl_Mode*)data);\r
 250                 break;\r
 251         \r
 252         case VIDEO_IOCTL_MODEINFO:\r
 253                 ret = BGA_int_ModeInfo((tVideo_IOCtl_Mode*)data);\r
 254                 break;\r
 255         \r
 256         // Request Access to LFB\r
 257         case VIDEO_IOCTL_REQLFB:\r
 258                 ret = BGA_int_MapFB( *(void**)data );\r
 259                 break;\r
 260         \r
 261         default:\r
 262                 LEAVE('i', -2);\r
 263                 return -2;\r
 264         }\r
 265         \r
 266         LEAVE('i', ret);\r
 267         return ret;\r
 268 }\r
 269 \r
 270 //== Internal Functions ==\r
 271 /**\r
 272  * \fn void BGA_int_WriteRegister(Uint16 reg, Uint16 value)\r
 273  * \brief Writes to a BGA register\r
 274  */\r
 275 void BGA_int_WriteRegister(Uint16 reg, Uint16 value)\r
 276 {\r
 277         outw(VBE_DISPI_IOPORT_INDEX, reg);\r
 278         outw(VBE_DISPI_IOPORT_DATA, value);\r
 279 }\r
 280 \r
 281 INT Uint16 BGA_int_ReadRegister(Uint16 reg)\r
 282 {\r
 283         outw(VBE_DISPI_IOPORT_INDEX, reg);\r
 284         return inw(VBE_DISPI_IOPORT_DATA);\r
 285 }\r
 286 \r
 287 #if 0\r
 288 INT void BGA_int_SetBank(Uint16 bank)\r
 289 {\r
 290         BGA_int_WriteRegister(VBE_DISPI_INDEX_BANK, bank);\r
 291 }\r
 292 #endif\r
 293 \r
 294 /**\r
 295  * \fn void BGA_int_SetMode(Uint16 width, Uint16 height, Uint16 bpp)\r
 296  * \brief Sets the video mode from the dimensions and bpp given\r
 297  */\r
 298 void BGA_int_SetMode(Uint16 width, Uint16 height)\r
 299 {\r
 300         ENTER("iwidth iheight ibpp", width, height, bpp);\r
 301         BGA_int_WriteRegister(VBE_DISPI_INDEX_ENABLE, VBE_DISPI_DISABLED);\r
 302     BGA_int_WriteRegister(VBE_DISPI_INDEX_XRES, width);\r
 303     BGA_int_WriteRegister(VBE_DISPI_INDEX_YRES, height);\r
 304     BGA_int_WriteRegister(VBE_DISPI_INDEX_BPP,  32);\r
 305     BGA_int_WriteRegister(VBE_DISPI_INDEX_ENABLE, VBE_DISPI_ENABLED | VBE_DISPI_NOCLEARMEM | VBE_DISPI_LFB_ENABLED);\r
 306     //BGA_int_WriteRegister(VBE_DISPI_INDEX_ENABLE, VBE_DISPI_ENABLED | VBE_DISPI_NOCLEARMEM);\r
 307         LEAVE('-');\r
 308 }\r
 309 \r
 310 /**\r
 311  * \fn int BGA_int_UpdateMode(int id)\r
 312  * \brief Set current vide mode given a mode id\r
 313  */\r
 314 int BGA_int_UpdateMode(int id)\r
 315 {\r
 316         // Sanity Check\r
 317         if(id < 0 || id >= BGA_MODE_COUNT)      return -1;\r
 318         \r
 319         // Check if it is a text mode\r
 320         if( gBGA_Modes[id].flags & MODEFLAG_TEXT )\r
 321                 BGA_int_SetMode(\r
 322                         gBGA_Modes[id].width*giVT_CharWidth,\r
 323                         gBGA_Modes[id].height*giVT_CharHeight);\r
 324         else    // Graphics?\r
 325                 BGA_int_SetMode(\r
 326                         gBGA_Modes[id].width,\r
 327                         gBGA_Modes[id].height);\r
 328         \r
 329         giBGA_CurrentMode = id;\r
 330         return id;\r
 331 }\r
 332 \r
 333 /**\r
 334  * \fn int BGA_int_FindMode(tVideo_IOCtl_Mode *info)\r
 335  * \brief Find a mode matching the given options\r
 336  */\r
 337 int BGA_int_FindMode(tVideo_IOCtl_Mode *info)\r
 338 {\r
 339          int    i;\r
 340          int    best = 0, bestFactor = 1000;\r
 341          int    factor, tmp;\r
 342          int    rqdProduct = info->width * info->height * info->bpp;\r
 343         \r
 344         ENTER("pinfo", info);\r
 345         LOG("info = {width:%i,height:%i,bpp:%i})\n", info->width, info->height, info->bpp);\r
 346         \r
 347         for(i = 0; i < BGA_MODE_COUNT; i++)\r
 348         {\r
 349                 #if DEBUG >= 2\r
 350                 LogF("Mode %i (%ix%ix%i), ", i, gBGA_Modes[i].width, gBGA_Modes[i].height, gBGA_Modes[i].bpp);\r
 351                 #endif\r
 352                 \r
 353                 // Check if this mode is the same type as what we want\r
 354                 if( !(gBGA_Modes[i].flags & MODEFLAG_TEXT) != !(info->flags & VIDEO_FLAG_TEXT) )\r
 355                         continue;\r
 356                 \r
 357                 // Ooh! A perfect match\r
 358                 if(gBGA_Modes[i].width == info->width\r
 359                 && gBGA_Modes[i].height == info->height\r
 360                 && gBGA_Modes[i].bpp == info->bpp)\r
 361                 {\r
 362                         #if DEBUG >= 2\r
 363                         LogF("Perfect!\n");\r
 364                         #endif\r
 365                         best = i;\r
 366                         break;\r
 367                 }\r
 368                 \r
 369                 // If not, how close are we?\r
 370                 tmp = gBGA_Modes[i].width * gBGA_Modes[i].height * gBGA_Modes[i].bpp;\r
 371                 tmp -= rqdProduct;\r
 372                 tmp = tmp < 0 ? -tmp : tmp;     // tmp = ABS(tmp)\r
 373                 factor = tmp * 100 / rqdProduct;\r
 374                 \r
 375                 #if DEBUG >= 2\r
 376                 LogF("factor = %i\n", factor);\r
 377                 #endif\r
 378                 \r
 379                 if(factor < bestFactor)\r
 380                 {\r
 381                         bestFactor = factor;\r
 382                         best = i;\r
 383                 }\r
 384         }\r
 385         \r
 386         info->id = best;\r
 387         info->width = gBGA_Modes[best].width;\r
 388         info->height = gBGA_Modes[best].height;\r
 389         info->bpp = gBGA_Modes[best].bpp;\r
 390         \r
 391         info->flags = 0;\r
 392         if(gBGA_Modes[best].flags & MODEFLAG_TEXT)\r
 393                 info->flags |= VIDEO_FLAG_TEXT;\r
 394         \r
 395         return best;\r
 396 }\r
 397 \r
 398 /**\r
 399  * \fn int BGA_int_ModeInfo(tVideo_IOCtl_Mode *info)\r
 400  * \brief Get mode information\r
 401  */\r
 402 int BGA_int_ModeInfo(tVideo_IOCtl_Mode *info)\r
 403 {\r
 404         // Sanity Check\r
 405         //if( !MM_IsUser( (Uint)info, sizeof(tVideo_IOCtl_Mode) ) ) {\r
 406         //      return -EINVAL;\r
 407         //}\r
 408         \r
 409         if(info->id < 0 || info->id >= BGA_MODE_COUNT)  return -1;\r
 410         \r
 411         info->width = gBGA_Modes[info->id].width;\r
 412         info->height = gBGA_Modes[info->id].height;\r
 413         info->bpp = gBGA_Modes[info->id].bpp;\r
 414         \r
 415         info->flags = 0;\r
 416         if(gBGA_Modes[info->id].flags & MODEFLAG_TEXT)\r
 417                 info->flags |= VIDEO_FLAG_TEXT;\r
 418         \r
 419         return 1;\r
 420 }\r
 421 \r
 422 /**\r
 423  * \fn int BGA_int_MapFB(void *Dest)\r
 424  * \brief Map the framebuffer into a process's space\r
 425  * \param Dest  User address to load to\r
 426  */\r
 427 int BGA_int_MapFB(void *Dest)\r
 428 {\r
 429         Uint    i;\r
 430         Uint    pages;\r
 431         \r
 432         // Sanity Check\r
 433         if((Uint)Dest > 0xC0000000)     return 0;\r
 434         if(gBGA_Modes[giBGA_CurrentMode].bpp < 15)      return 0;       // Only non-pallete modes are supported\r
 435         \r
 436         // Count required pages\r
 437         pages = (gBGA_Modes[giBGA_CurrentMode].fbSize + 0xFFF) >> 12;\r
 438         \r
 439         // Check if there is space\r
 440         for( i = 0; i < pages; i++ )\r
 441         {\r
 442                 if(MM_GetPhysAddr( (Uint)Dest + (i << 12) ))\r
 443                         return 0;\r
 444         }\r
 445         \r
 446         // Map\r
 447         for( i = 0; i < pages; i++ )\r
 448                 MM_Map( (Uint)Dest + (i<<12), VBE_DISPI_LFB_PHYSICAL_ADDRESS + (i<<12) );\r
 449         \r
 450         return 1;\r
 451 }\r