Kernel/drv/bochsvbe.c

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