arch/all-pc/boot/grub2-aros/grub-core/video/efi_gop.c

   1 /*
   2  *  GRUB  --  GRand Unified Bootloader
   3  *  Copyright (C) 2005,2006,2007,2008,2009  Free Software Foundation, Inc.
   4  *
   5  *  GRUB is free software: you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation, either version 3 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  GRUB is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #define grub_video_render_target grub_video_fbrender_target
  20
  21 #include <grub/err.h>
  22 #include <grub/types.h>
  23 #include <grub/dl.h>
  24 #include <grub/misc.h>
  25 #include <grub/mm.h>
  26 #include <grub/video.h>
  27 #include <grub/video_fb.h>
  28 #include <grub/efi/api.h>
  29 #include <grub/efi/efi.h>
  30 #include <grub/efi/edid.h>
  31 #include <grub/efi/graphics_output.h>
  32
  33 GRUB_MOD_LICENSE ("GPLv3+");
  34
  35 static grub_efi_guid_t graphics_output_guid = GRUB_EFI_GOP_GUID;
  36 static grub_efi_guid_t active_edid_guid = GRUB_EFI_EDID_ACTIVE_GUID;
  37 static grub_efi_guid_t discovered_edid_guid = GRUB_EFI_EDID_DISCOVERED_GUID;
  38 static grub_efi_guid_t efi_var_guid = GRUB_EFI_GLOBAL_VARIABLE_GUID;
  39 static struct grub_efi_gop *gop;
  40 static unsigned old_mode;
  41 static int restore_needed;
  42 static grub_efi_handle_t gop_handle;
  43
  44 static int
  45 grub_video_gop_iterate (int (*hook) (const struct grub_video_mode_info *info));
  46
  47 static struct
  48 {
  49   struct grub_video_mode_info mode_info;
  50   struct grub_video_render_target *render_target;
  51   grub_uint8_t *ptr;
  52   grub_uint8_t *offscreen;
  53 } framebuffer;
  54
  55
  56 static int
  57 check_protocol (void)
  58 {
  59   grub_efi_handle_t *handles;
  60   grub_efi_uintn_t num_handles, i;
  61   int have_usable_mode = 0;
  62
  63   auto int hook (const struct grub_video_mode_info *info);
  64   int hook (const struct grub_video_mode_info *info __attribute__ ((unused)))
  65   {
  66     have_usable_mode = 1;
  67     return 1;
  68   }
  69
  70   handles = grub_efi_locate_handle (GRUB_EFI_BY_PROTOCOL,
  71                                     &graphics_output_guid, NULL, &num_handles);
  72   if (!handles || num_handles == 0)
  73     return 0;
  74
  75   for (i = 0; i < num_handles; i++)
  76     {
  77       gop_handle = handles[i];
  78       gop = grub_efi_open_protocol (gop_handle, &graphics_output_guid,
  79                                     GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
  80       grub_video_gop_iterate (hook);
  81       if (have_usable_mode)
  82         {
  83           grub_free (handles);
  84           return 1;
  85         }
  86     }
  87
  88   gop = 0;
  89   gop_handle = 0;
  90
  91   return 0;
  92 }
  93
  94 static grub_err_t
  95 grub_video_gop_init (void)
  96 {
  97   grub_memset (&framebuffer, 0, sizeof(framebuffer));
  98   return grub_video_fb_init ();
  99 }
 100
 101 static grub_err_t
 102 grub_video_gop_fini (void)
 103 {
 104   if (restore_needed)
 105     {
 106       efi_call_2 (gop->set_mode, gop, old_mode);
 107       restore_needed = 0;
 108     }
 109   grub_free (framebuffer.offscreen);
 110   framebuffer.offscreen = 0;
 111   return grub_video_fb_fini ();
 112 }
 113
 114 static int
 115 grub_video_gop_get_bpp (struct grub_efi_gop_mode_info *in)
 116 {
 117   grub_uint32_t total_mask;
 118   int i;
 119   switch (in->pixel_format)
 120     {
 121     case GRUB_EFI_GOT_BGRA8:
 122     case GRUB_EFI_GOT_RGBA8:
 123       return 32;
 124
 125     case GRUB_EFI_GOT_BITMASK:
 126       /* Check overlaps.  */
 127       if ((in->pixel_bitmask.r & in->pixel_bitmask.g)
 128           || (in->pixel_bitmask.r & in->pixel_bitmask.b)
 129           || (in->pixel_bitmask.g & in->pixel_bitmask.b)
 130           || (in->pixel_bitmask.r & in->pixel_bitmask.a)
 131           || (in->pixel_bitmask.g & in->pixel_bitmask.a)
 132           || (in->pixel_bitmask.b & in->pixel_bitmask.a))
 133         return 0;
 134
 135       total_mask = in->pixel_bitmask.r | in->pixel_bitmask.g
 136         | in->pixel_bitmask.b | in->pixel_bitmask.a;
 137
 138       for (i = 31; i >= 0; i--)
 139         if (total_mask & (1 << i))
 140           return i + 1;
 141
 142       /* Fall through.  */
 143     default:
 144       return 0;
 145     }
 146 }
 147
 148 static void
 149 grub_video_gop_get_bitmask (grub_uint32_t mask, unsigned int *mask_size,
 150                             unsigned int *field_pos)
 151 {
 152   int i;
 153   int last_p;
 154   for (i = 31; i >= 0; i--)
 155     if (mask & (1 << i))
 156       break;
 157   if (i == -1)
 158     {
 159       *mask_size = *field_pos = 0;
 160       return;
 161     }
 162   last_p = i;
 163   for (; i >= 0; i--)
 164     if (!(mask & (1 << i)))
 165       break;
 166   *field_pos = i + 1;
 167   *mask_size = last_p - *field_pos + 1;
 168 }
 169
 170 static grub_err_t
 171 grub_video_gop_fill_real_mode_info (unsigned mode,
 172                                     struct grub_efi_gop_mode_info *in,
 173                                     struct grub_video_mode_info *out)
 174 {
 175   out->mode_number = mode;
 176   out->number_of_colors = 256;
 177   out->width = in->width;
 178   out->height = in->height;
 179   out->mode_type = GRUB_VIDEO_MODE_TYPE_RGB;
 180   out->bpp = grub_video_gop_get_bpp (in);
 181   out->bytes_per_pixel = out->bpp >> 3;
 182   if (!out->bpp)
 183     return grub_error (GRUB_ERR_IO, "unsupported video mode");
 184   out->pitch = in->pixels_per_scanline * out->bytes_per_pixel;
 185
 186   switch (in->pixel_format)
 187     {
 188     case GRUB_EFI_GOT_RGBA8:
 189       out->red_mask_size = 8;
 190       out->red_field_pos = 0;
 191       out->green_mask_size = 8;
 192       out->green_field_pos = 8;
 193       out->blue_mask_size = 8;
 194       out->blue_field_pos = 16;
 195       out->reserved_mask_size = 8;
 196       out->reserved_field_pos = 24;
 197       break;
 198
 199     case GRUB_EFI_GOT_BGRA8:
 200       out->red_mask_size = 8;
 201       out->red_field_pos = 16;
 202       out->green_mask_size = 8;
 203       out->green_field_pos = 8;
 204       out->blue_mask_size = 8;
 205       out->blue_field_pos = 0;
 206       out->reserved_mask_size = 8;
 207       out->reserved_field_pos = 24;
 208       break;
 209
 210     case GRUB_EFI_GOT_BITMASK:
 211       grub_video_gop_get_bitmask (in->pixel_bitmask.r, &out->red_mask_size,
 212                                   &out->red_field_pos);
 213       grub_video_gop_get_bitmask (in->pixel_bitmask.g, &out->green_mask_size,
 214                                   &out->green_field_pos);
 215       grub_video_gop_get_bitmask (in->pixel_bitmask.b, &out->blue_mask_size,
 216                                   &out->blue_field_pos);
 217       grub_video_gop_get_bitmask (in->pixel_bitmask.a, &out->reserved_mask_size,
 218                                   &out->reserved_field_pos);
 219       break;
 220
 221     default:
 222       return grub_error (GRUB_ERR_IO, "unsupported video mode");
 223     }
 224
 225   out->blit_format = grub_video_get_blit_format (out);
 226   return GRUB_ERR_NONE;
 227 }
 228
 229 static grub_err_t
 230 grub_video_gop_fill_mode_info (unsigned mode,
 231                                struct grub_efi_gop_mode_info *in,
 232                                struct grub_video_mode_info *out)
 233 {
 234   out->mode_number = mode;
 235   out->number_of_colors = 256;
 236   out->width = in->width;
 237   out->height = in->height;
 238   out->mode_type = GRUB_VIDEO_MODE_TYPE_RGB;
 239   out->bytes_per_pixel = sizeof (struct grub_efi_gop_blt_pixel);
 240   out->bpp = out->bytes_per_pixel << 3;
 241   out->pitch = in->width * out->bytes_per_pixel;
 242   out->red_mask_size = 8;
 243   out->red_field_pos = 16;
 244   out->green_mask_size = 8;
 245   out->green_field_pos = 8;
 246   out->blue_mask_size = 8;
 247   out->blue_field_pos = 0;
 248   out->reserved_mask_size = 8;
 249   out->reserved_field_pos = 24;
 250
 251   out->blit_format = GRUB_VIDEO_BLIT_FORMAT_BGRA_8888;
 252   out->mode_type |= (GRUB_VIDEO_MODE_TYPE_DOUBLE_BUFFERED
 253                      | GRUB_VIDEO_MODE_TYPE_UPDATING_SWAP);
 254
 255   return GRUB_ERR_NONE;
 256 }
 257
 258 static int
 259 grub_video_gop_iterate (int (*hook) (const struct grub_video_mode_info *info))
 260 {
 261   unsigned mode;
 262
 263   for (mode = 0; mode < gop->mode->max_mode; mode++)
 264     {
 265       grub_efi_uintn_t size;
 266       grub_efi_status_t status;
 267       struct grub_efi_gop_mode_info *info = NULL;
 268       grub_err_t err;
 269       struct grub_video_mode_info mode_info;
 270
 271       status = efi_call_4 (gop->query_mode, gop, mode, &size, &info);
 272
 273       if (status)
 274         {
 275           info = 0;
 276           continue;
 277         }
 278
 279       err = grub_video_gop_fill_mode_info (mode, info, &mode_info);
 280       if (err)
 281         {
 282           grub_errno = GRUB_ERR_NONE;
 283           continue;
 284         }
 285       if (hook (&mode_info))
 286         return 1;
 287     }
 288   return 0;
 289 }
 290
 291 static grub_err_t
 292 grub_video_gop_get_edid (struct grub_video_edid_info *edid_info)
 293 {
 294   struct grub_efi_active_edid *edid;
 295   grub_size_t copy_size;
 296
 297   grub_memset (edid_info, 0, sizeof (*edid_info));
 298
 299   edid = grub_efi_open_protocol (gop_handle, &active_edid_guid,
 300                                  GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
 301   if (!edid || edid->size_of_edid == 0)
 302     edid = grub_efi_open_protocol (gop_handle, &discovered_edid_guid,
 303                                    GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL);
 304
 305   if (!edid || edid->size_of_edid == 0)
 306     {
 307       char edidname[] = "agp-internal-edid";
 308       grub_size_t datasize;
 309       grub_uint8_t *data;
 310       data = grub_efi_get_variable (edidname, &efi_var_guid, &datasize);
 311       if (data && datasize > 16)
 312         {
 313           copy_size = datasize - 16;
 314           if (copy_size > sizeof (*edid_info))
 315             copy_size = sizeof (*edid_info);
 316           grub_memcpy (edid_info, data + 16, copy_size);
 317           grub_free (data);
 318           return GRUB_ERR_NONE;
 319         }
 320       return grub_error (GRUB_ERR_BAD_DEVICE, "EDID information not available");
 321     }
 322
 323   copy_size = edid->size_of_edid;
 324   if (copy_size > sizeof (*edid_info))
 325     copy_size = sizeof (*edid_info);
 326   grub_memcpy (edid_info, edid->edid, copy_size);
 327
 328   return GRUB_ERR_NONE;
 329 }
 330
 331 static grub_err_t
 332 grub_gop_get_preferred_mode (unsigned int *width, unsigned int *height)
 333 {
 334   struct grub_video_edid_info edid_info;
 335   grub_err_t err;
 336
 337   err = grub_video_gop_get_edid (&edid_info);
 338   if (err)
 339     return err;
 340   err = grub_video_edid_checksum (&edid_info);
 341   if (err)
 342     return err;
 343   err = grub_video_edid_preferred_mode (&edid_info, width, height);
 344   if (err)
 345     return err;
 346   return GRUB_ERR_NONE;
 347 }
 348
 349 static grub_err_t
 350 grub_video_gop_setup (unsigned int width, unsigned int height,
 351                       unsigned int mode_type,
 352                       unsigned int mode_mask __attribute__ ((unused)))
 353 {
 354   unsigned int depth;
 355   struct grub_efi_gop_mode_info *info = NULL;
 356   unsigned best_mode = 0;
 357   grub_err_t err;
 358   unsigned bpp;
 359   int found = 0;
 360   unsigned long long best_volume = 0;
 361   unsigned int preferred_width = 0, preferred_height = 0;
 362   grub_uint8_t *buffer;
 363
 364   depth = (mode_type & GRUB_VIDEO_MODE_TYPE_DEPTH_MASK)
 365     >> GRUB_VIDEO_MODE_TYPE_DEPTH_POS;
 366
 367   if (width == 0 && height == 0)
 368     {
 369       err = 1;
 370       grub_gop_get_preferred_mode (&preferred_width, &preferred_height);
 371       if (err || preferred_width >= 4096 || preferred_height >= 4096)
 372         {
 373           preferred_width = 800;
 374           preferred_height = 600;
 375           grub_errno = GRUB_ERR_NONE;
 376         }
 377     }
 378
 379   /* Keep current mode if possible.  */
 380   if (gop->mode->info)
 381     {
 382       bpp = grub_video_gop_get_bpp (gop->mode->info);
 383       if (bpp && ((width == gop->mode->info->width
 384                    && height == gop->mode->info->height)
 385                   || (width == 0 && height == 0))
 386           && (depth == bpp || depth == 0))
 387         {
 388           grub_dprintf ("video", "GOP: keeping mode %d\n", gop->mode->mode);
 389           best_mode = gop->mode->mode;
 390           found = 1;
 391         }
 392     }
 393
 394   if (!found)
 395     {
 396       unsigned mode;
 397       grub_dprintf ("video", "GOP: %d modes detected\n", gop->mode->max_mode);
 398       for (mode = 0; mode < gop->mode->max_mode; mode++)
 399         {
 400           grub_efi_uintn_t size;
 401           grub_efi_status_t status;
 402
 403           status = efi_call_4 (gop->query_mode, gop, mode, &size, &info);
 404           if (status)
 405             {
 406               info = 0;
 407               continue;
 408             }
 409
 410           grub_dprintf ("video", "GOP: mode %d: %dx%d\n", mode, info->width,
 411                         info->height);
 412
 413           if (preferred_width && (info->width > preferred_width
 414                                   || info->height > preferred_height))
 415             {
 416               grub_dprintf ("video", "GOP: mode %d: too large\n", mode);
 417               continue;
 418             }
 419
 420           bpp = grub_video_gop_get_bpp (info);
 421           if (!bpp)
 422             {
 423               grub_dprintf ("video", "GOP: mode %d: incompatible pixel mode\n",
 424                             mode);
 425               continue;
 426             }
 427
 428           grub_dprintf ("video", "GOP: mode %d: depth %d\n", mode, bpp);
 429
 430           if (!(((info->width == width && info->height == height)
 431                 || (width == 0 && height == 0))
 432                 && (bpp == depth || depth == 0)))
 433             {
 434               grub_dprintf ("video", "GOP: mode %d: rejected\n", mode);
 435               continue;
 436             }
 437
 438           if (best_volume < ((unsigned long long) info->width)
 439               * ((unsigned long long) info->height)
 440               * ((unsigned long long) bpp))
 441             {
 442               best_volume = ((unsigned long long) info->width)
 443                 * ((unsigned long long) info->height)
 444                 * ((unsigned long long) bpp);
 445               best_mode = mode;
 446             }
 447           found = 1;
 448         }
 449     }
 450
 451   if (!found)
 452     {
 453       grub_dprintf ("video", "GOP: no mode found\n");
 454       return grub_error (GRUB_ERR_UNKNOWN_DEVICE, "no matching mode found");
 455     }
 456
 457   if (best_mode != gop->mode->mode)
 458     {
 459       if (!restore_needed)
 460         {
 461           old_mode = gop->mode->mode;
 462           restore_needed = 1;
 463         }
 464       efi_call_2 (gop->set_mode, gop, best_mode);
 465     }
 466
 467   info = gop->mode->info;
 468
 469   err = grub_video_gop_fill_mode_info (gop->mode->mode, info,
 470                                        &framebuffer.mode_info);
 471   if (err)
 472     {
 473       grub_dprintf ("video", "GOP: couldn't fill mode info\n");
 474       return err;
 475     }
 476
 477   framebuffer.ptr = (void *) (grub_addr_t) gop->mode->fb_base;
 478   framebuffer.offscreen
 479     = grub_malloc (framebuffer.mode_info.height
 480                    * framebuffer.mode_info.width
 481                    * sizeof (struct grub_efi_gop_blt_pixel));
 482
 483   buffer = framebuffer.offscreen;
 484
 485   if (!buffer)
 486     {
 487       grub_dprintf ("video", "GOP: couldn't allocate shadow\n");
 488       grub_errno = 0;
 489       err = grub_video_gop_fill_mode_info (gop->mode->mode, info,
 490                                            &framebuffer.mode_info);
 491       buffer = framebuffer.ptr;
 492     }
 493
 494   grub_dprintf ("video", "GOP: initialising FB @ %p %dx%dx%d\n",
 495                 framebuffer.ptr, framebuffer.mode_info.width,
 496                 framebuffer.mode_info.height, framebuffer.mode_info.bpp);
 497
 498   err = grub_video_fb_create_render_target_from_pointer
 499     (&framebuffer.render_target, &framebuffer.mode_info, buffer);
 500
 501   if (err)
 502     {
 503       grub_dprintf ("video", "GOP: Couldn't create FB target\n");
 504       return err;
 505     }
 506
 507   err = grub_video_fb_set_active_render_target (framebuffer.render_target);
 508
 509   if (err)
 510     {
 511       grub_dprintf ("video", "GOP: Couldn't set FB target\n");
 512       return err;
 513     }
 514
 515   err = grub_video_fb_set_palette (0, GRUB_VIDEO_FBSTD_NUMCOLORS,
 516                                    grub_video_fbstd_colors);
 517
 518   if (err)
 519     grub_dprintf ("video", "GOP: Couldn't set palette\n");
 520   else
 521     grub_dprintf ("video", "GOP: Success\n");
 522
 523   return err;
 524 }
 525
 526 static grub_err_t
 527 grub_video_gop_swap_buffers (void)
 528 {
 529   if (framebuffer.offscreen)
 530     {
 531       efi_call_10 (gop->blt, gop, framebuffer.offscreen,
 532                    GRUB_EFI_BLT_BUFFER_TO_VIDEO, 0, 0, 0, 0,
 533                    framebuffer.mode_info.width, framebuffer.mode_info.height,
 534                    framebuffer.mode_info.width * 4);
 535     }
 536   return GRUB_ERR_NONE;
 537 }
 538
 539 static grub_err_t
 540 grub_video_gop_set_active_render_target (struct grub_video_render_target *target)
 541 {
 542   if (target == GRUB_VIDEO_RENDER_TARGET_DISPLAY)
 543     target = framebuffer.render_target;
 544
 545   return grub_video_fb_set_active_render_target (target);
 546 }
 547
 548 static grub_err_t
 549 grub_video_gop_get_info_and_fini (struct grub_video_mode_info *mode_info,
 550                                   void **framebuf)
 551 {
 552   grub_err_t err;
 553
 554   err = grub_video_gop_fill_real_mode_info (gop->mode->mode, gop->mode->info,
 555                                             mode_info);
 556   if (err)
 557     {
 558       grub_dprintf ("video", "GOP: couldn't fill mode info\n");
 559       return err;
 560     }
 561
 562   *framebuf = (char *) framebuffer.ptr;
 563
 564   grub_video_fb_fini ();
 565
 566   grub_free (framebuffer.offscreen);
 567   framebuffer.offscreen = 0;
 568
 569   return GRUB_ERR_NONE;
 570 }
 571
 572 static struct grub_video_adapter grub_video_gop_adapter =
 573   {
 574     .name = "EFI GOP driver",
 575     .id = GRUB_VIDEO_DRIVER_EFI_GOP,
 576
 577     .prio = GRUB_VIDEO_ADAPTER_PRIO_FIRMWARE,
 578
 579     .init = grub_video_gop_init,
 580     .fini = grub_video_gop_fini,
 581     .setup = grub_video_gop_setup,
 582     .get_info = grub_video_fb_get_info,
 583     .get_info_and_fini = grub_video_gop_get_info_and_fini,
 584     .get_edid = grub_video_gop_get_edid,
 585     .set_palette = grub_video_fb_set_palette,
 586     .get_palette = grub_video_fb_get_palette,
 587     .set_viewport = grub_video_fb_set_viewport,
 588     .get_viewport = grub_video_fb_get_viewport,
 589     .map_color = grub_video_fb_map_color,
 590     .map_rgb = grub_video_fb_map_rgb,
 591     .map_rgba = grub_video_fb_map_rgba,
 592     .unmap_color = grub_video_fb_unmap_color,
 593     .fill_rect = grub_video_fb_fill_rect,
 594     .blit_bitmap = grub_video_fb_blit_bitmap,
 595     .blit_render_target = grub_video_fb_blit_render_target,
 596     .scroll = grub_video_fb_scroll,
 597     .swap_buffers = grub_video_gop_swap_buffers,
 598     .create_render_target = grub_video_fb_create_render_target,
 599     .delete_render_target = grub_video_fb_delete_render_target,
 600     .set_active_render_target = grub_video_gop_set_active_render_target,
 601     .get_active_render_target = grub_video_fb_get_active_render_target,
 602     .iterate = grub_video_gop_iterate,
 603
 604     .next = 0
 605   };
 606
 607 GRUB_MOD_INIT(efi_gop)
 608 {
 609   if (check_protocol ())
 610     grub_video_register (&grub_video_gop_adapter);
 611 }
 612
 613 GRUB_MOD_FINI(efi_gop)
 614 {
 615   if (restore_needed)
 616     {
 617       efi_call_2 (gop->set_mode, gop, old_mode);
 618       restore_needed = 0;
 619     }
 620   if (gop)
 621     grub_video_unregister (&grub_video_gop_adapter);
 622 }