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 \r
  34 // === PROTOTYPES ===\r
  35 // Driver\r
  36  int    BGA_Install(char **Arguments);\r
  37 void    BGA_Uninstall();\r
  38 // Internal\r
  39 void    BGA_int_WriteRegister(Uint16 reg, Uint16 value);\r
  40 Uint16  BGA_int_ReadRegister(Uint16 reg);\r
  41 void    BGA_int_SetBank(Uint16 bank);\r
  42 void    BGA_int_SetMode(Uint16 width, Uint16 height, Uint16 bpp);\r
  43  int    BGA_int_UpdateMode(int id);\r
  44  int    BGA_int_FindMode(tVideo_IOCtl_Mode *info);\r
  45  int    BGA_int_ModeInfo(tVideo_IOCtl_Mode *info);\r
  46  int    BGA_int_MapFB(void *Dest);\r
  47 // Filesystem\r
  48 Uint64  BGA_Read(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);\r
  49 Uint64  BGA_Write(tVFS_Node *node, Uint64 off, Uint64 len, void *buffer);\r
  50  int    BGA_Ioctl(tVFS_Node *node, int id, void *data);\r
  51 \r
  52 // === CONSTANTS ===\r
  53 const t_bga_mode        BGA_MODES[] = {\r
  54         {},\r
  55         {640,480,8, 0, 640*480},\r
  56         {640,480,32, 0, 640*480*4},\r
  57         {800,600,8, 0, 800*600},\r
  58         {800,600,32, 0, 800*600*4},\r
  59 };\r
  60 #define BGA_MODE_COUNT  (sizeof(BGA_MODES)/sizeof(BGA_MODES[0]))\r
  61 #define BGA_LFB_MAXSIZE (1024*768*4)\r
  62 #define VBE_DISPI_BANK_ADDRESS  0xA0000\r
  63 #define VBE_DISPI_LFB_PHYSICAL_ADDRESS  0xE0000000\r
  64 #define VBE_DISPI_IOPORT_INDEX  0x01CE\r
  65 #define VBE_DISPI_IOPORT_DATA   0x01CF\r
  66 #define VBE_DISPI_DISABLED      0x00\r
  67 #define VBE_DISPI_ENABLED       0x01\r
  68 #define VBE_DISPI_LFB_ENABLED   0x40\r
  69 #define VBE_DISPI_NOCLEARMEM    0x80\r
  70 enum {\r
  71         VBE_DISPI_INDEX_ID,\r
  72         VBE_DISPI_INDEX_XRES,\r
  73         VBE_DISPI_INDEX_YRES,\r
  74         VBE_DISPI_INDEX_BPP,\r
  75         VBE_DISPI_INDEX_ENABLE,\r
  76         VBE_DISPI_INDEX_BANK,\r
  77         VBE_DISPI_INDEX_VIRT_WIDTH,\r
  78         VBE_DISPI_INDEX_VIRT_HEIGHT,\r
  79         VBE_DISPI_INDEX_X_OFFSET,\r
  80         VBE_DISPI_INDEX_Y_OFFSET\r
  81 };\r
  82 \r
  83 // GLOBALS\r
  84 MODULE_DEFINE(0, 0x0032, BochsVBE, BGA_Install, NULL, NULL);\r
  85 tDevFS_Driver   gBGA_DriverStruct = {\r
  86         NULL, "BochsGA",\r
  87         {\r
  88         .Read = BGA_Read,\r
  89         .Write = BGA_Write,\r
  90         .IOCtl = BGA_Ioctl\r
  91         }\r
  92 };\r
  93  int    giBGA_CurrentMode = -1;\r
  94  int    giBGA_DriverId = -1;\r
  95 Uint    *gBGA_Framebuffer;\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 > BGA_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         Uint8   *destBuf;\r
 160         \r
 161         DEBUGS("BGA_Write: (off=%i, len=0x%x)\n", off, len);\r
 162         \r
 163         // Check Mode\r
 164         if(giBGA_CurrentMode == -1)\r
 165                 return -1;\r
 166         // Check Input against Frambuffer Size\r
 167         if(off+len > BGA_MODES[giBGA_CurrentMode].fbSize)\r
 168                 return -1;\r
 169         \r
 170         destBuf = (Uint8*) ((Uint)gBGA_Framebuffer + (Uint)off);\r
 171         \r
 172         DEBUGS(" BGA_Write: *buffer = 0x%x\n", *(Uint*)buffer);\r
 173         DEBUGS(" BGA_Write: Updating Framebuffer (0x%x - 0x%x bytes)\n", \r
 174                 destBuf, destBuf + (Uint)len);\r
 175         \r
 176         \r
 177         // Copy to Frambuffer\r
 178         memcpy(destBuf, buffer, len);\r
 179         \r
 180         DEBUGS("BGA_Write: BGA Framebuffer updated\n");\r
 181         \r
 182         return len;\r
 183 }\r
 184 \r
 185 /**\r
 186  * \fn INT int BGA_Ioctl(tVFS_Node *node, int id, void *data)\r
 187  * \brief Handle messages to the device\r
 188  */\r
 189 INT int BGA_Ioctl(tVFS_Node *node, int id, void *data)\r
 190 {\r
 191          int    ret = -2;\r
 192         ENTER("pNode iId pData", node, id, data);\r
 193         \r
 194         switch(id)\r
 195         {\r
 196         case DRV_IOCTL_TYPE:\r
 197                 ret = DRV_TYPE_VIDEO;\r
 198                 break;\r
 199         case DRV_IOCTL_IDENT:\r
 200                 memcpy(data, "BGA1", 4);\r
 201                 ret = 1;\r
 202                 break;\r
 203         case DRV_IOCTL_VERSION:\r
 204                 ret = 0x100;\r
 205                 break;\r
 206         case DRV_IOCTL_LOOKUP:  // TODO: Implement\r
 207                 ret = 0;\r
 208                 break;\r
 209                 \r
 210         case VIDEO_IOCTL_SETMODE:\r
 211                 ret = BGA_int_UpdateMode(*(int*)(data));\r
 212                 break;\r
 213                 \r
 214         case VIDEO_IOCTL_GETMODE:\r
 215                 ret = giBGA_CurrentMode;\r
 216                 break;\r
 217         \r
 218         case VIDEO_IOCTL_FINDMODE:\r
 219                 ret = BGA_int_FindMode((tVideo_IOCtl_Mode*)data);\r
 220                 break;\r
 221         \r
 222         case VIDEO_IOCTL_MODEINFO:\r
 223                 ret = BGA_int_ModeInfo((tVideo_IOCtl_Mode*)data);\r
 224                 break;\r
 225         \r
 226         // Request Access to LFB\r
 227         case VIDEO_IOCTL_REQLFB:\r
 228                 ret = BGA_int_MapFB( *(void**)data );\r
 229                 break;\r
 230         \r
 231         default:\r
 232                 LEAVE('i', -2);\r
 233                 return -2;\r
 234         }\r
 235         \r
 236         LEAVE('i', ret);\r
 237         return ret;\r
 238 }\r
 239 \r
 240 //== Internal Functions ==\r
 241 /**\r
 242  * \fn void BGA_int_WriteRegister(Uint16 reg, Uint16 value)\r
 243  * \brief Writes to a BGA register\r
 244  */\r
 245 void BGA_int_WriteRegister(Uint16 reg, Uint16 value)\r
 246 {\r
 247         outw(VBE_DISPI_IOPORT_INDEX, reg);\r
 248         outw(VBE_DISPI_IOPORT_DATA, value);\r
 249 }\r
 250 \r
 251 INT Uint16 BGA_int_ReadRegister(Uint16 reg)\r
 252 {\r
 253         outw(VBE_DISPI_IOPORT_INDEX, reg);\r
 254         return inw(VBE_DISPI_IOPORT_DATA);\r
 255 }\r
 256 \r
 257 #if 0\r
 258 INT void BGA_int_SetBank(Uint16 bank)\r
 259 {\r
 260         BGA_int_WriteRegister(VBE_DISPI_INDEX_BANK, bank);\r
 261 }\r
 262 #endif\r
 263 \r
 264 /**\r
 265  * \fn void BGA_int_SetMode(Uint16 width, Uint16 height, Uint16 bpp)\r
 266  * \brief Sets the video mode from the dimensions and bpp given\r
 267  */\r
 268 void BGA_int_SetMode(Uint16 width, Uint16 height, Uint16 bpp)\r
 269 {\r
 270         DEBUGS("BGA_int_SetMode: (width=%i, height=%i, bpp=%i)\n", width, height, bpp);\r
 271         BGA_int_WriteRegister(VBE_DISPI_INDEX_ENABLE, VBE_DISPI_DISABLED);\r
 272     BGA_int_WriteRegister(VBE_DISPI_INDEX_XRES, width);\r
 273     BGA_int_WriteRegister(VBE_DISPI_INDEX_YRES, height);\r
 274     BGA_int_WriteRegister(VBE_DISPI_INDEX_BPP,  bpp);\r
 275     BGA_int_WriteRegister(VBE_DISPI_INDEX_ENABLE, VBE_DISPI_ENABLED | VBE_DISPI_NOCLEARMEM | VBE_DISPI_LFB_ENABLED);\r
 276     //BGA_int_WriteRegister(VBE_DISPI_INDEX_ENABLE, VBE_DISPI_ENABLED | VBE_DISPI_NOCLEARMEM);\r
 277 }\r
 278 \r
 279 /**\r
 280  * \fn int BGA_int_UpdateMode(int id)\r
 281  * \brief Set current vide mode given a mode id\r
 282  */\r
 283 int BGA_int_UpdateMode(int id)\r
 284 {\r
 285         if(id < 0 || id >= BGA_MODE_COUNT)      return -1;\r
 286         BGA_int_SetMode(BGA_MODES[id].width, BGA_MODES[id].height, BGA_MODES[id].bpp);\r
 287         giBGA_CurrentMode = id;\r
 288         return id;\r
 289 }\r
 290 \r
 291 /**\r
 292  * \fn int BGA_int_FindMode(tVideo_IOCtl_Mode *info)\r
 293  * \brief Find a mode matching the given options\r
 294  */\r
 295 int BGA_int_FindMode(tVideo_IOCtl_Mode *info)\r
 296 {\r
 297          int    i;\r
 298          int    best = -1, bestFactor = 1000;\r
 299          int    factor, tmp;\r
 300          int    rqdProduct = info->width * info->height * info->bpp;\r
 301         \r
 302         DEBUGS("BGA_int_FindMode: (info={width:%i,height:%i,bpp:%i})\n", info->width, info->height, info->bpp);\r
 303         \r
 304         for(i = 0; i < BGA_MODE_COUNT; i++)\r
 305         {\r
 306                 #if DEBUG >= 2\r
 307                 LogF("Mode %i (%ix%ix%i), ", i, BGA_MODES[i].width, BGA_MODES[i].height, BGA_MODES[i].bpp);\r
 308                 #endif\r
 309         \r
 310                 if(BGA_MODES[i].width == info->width\r
 311                 && BGA_MODES[i].height == info->height\r
 312                 && BGA_MODES[i].bpp == info->bpp)\r
 313                 {\r
 314                         #if DEBUG >= 2\r
 315                         LogF("Perfect!\n");\r
 316                         #endif\r
 317                         best = i;\r
 318                         break;\r
 319                 }\r
 320                 \r
 321                 tmp = BGA_MODES[i].width * BGA_MODES[i].height * BGA_MODES[i].bpp;\r
 322                 tmp -= rqdProduct;\r
 323                 tmp = tmp < 0 ? -tmp : tmp;\r
 324                 factor = tmp * 100 / rqdProduct;\r
 325                 \r
 326                 #if DEBUG >= 2\r
 327                 LogF("factor = %i\n", factor);\r
 328                 #endif\r
 329                 \r
 330                 if(factor < bestFactor)\r
 331                 {\r
 332                         bestFactor = factor;\r
 333                         best = i;\r
 334                 }\r
 335         }\r
 336         info->id = best;\r
 337         info->width = BGA_MODES[best].width;\r
 338         info->height = BGA_MODES[best].height;\r
 339         info->bpp = BGA_MODES[best].bpp;\r
 340         return best;\r
 341 }\r
 342 \r
 343 /**\r
 344  * \fn int BGA_int_ModeInfo(tVideo_IOCtl_Mode *info)\r
 345  * \brief Get mode information\r
 346  */\r
 347 int BGA_int_ModeInfo(tVideo_IOCtl_Mode *info)\r
 348 {\r
 349         if(!info)       return -1;\r
 350         if(MM_GetPhysAddr((Uint)info) == 0)\r
 351                 return -1;\r
 352         \r
 353         if(info->id < 0 || info->id >= BGA_MODE_COUNT)  return -1;\r
 354         \r
 355         info->width = BGA_MODES[info->id].width;\r
 356         info->height = BGA_MODES[info->id].height;\r
 357         info->bpp = BGA_MODES[info->id].bpp;\r
 358         \r
 359         return 1;\r
 360 }\r
 361 \r
 362 /**\r
 363  * \fn int BGA_int_MapFB(void *Dest)\r
 364  * \brief Map the framebuffer into a process's space\r
 365  * \param Dest  User address to load to\r
 366  */\r
 367 int BGA_int_MapFB(void *Dest)\r
 368 {\r
 369         Uint    i;\r
 370         Uint    pages;\r
 371         \r
 372         // Sanity Check\r
 373         if((Uint)Dest > 0xC0000000)     return 0;\r
 374         if(BGA_MODES[giBGA_CurrentMode].bpp < 15)       return 0;       // Only non-pallete modes are supported\r
 375         \r
 376         // Count required pages\r
 377         pages = (BGA_MODES[giBGA_CurrentMode].fbSize + 0xFFF) >> 12;\r
 378         \r
 379         // Check if there is space\r
 380         for( i = 0; i < pages; i++ )\r
 381         {\r
 382                 if(MM_GetPhysAddr( (Uint)Dest + (i << 12) ))\r
 383                         return 0;\r
 384         }\r
 385         \r
 386         // Map\r
 387         for( i = 0; i < pages; i++ )\r
 388                 MM_Map( (Uint)Dest + (i<<12), VBE_DISPI_LFB_PHYSICAL_ADDRESS + (i<<12) );\r
 389         \r
 390         return 1;\r
 391 }\r