include/grub/video.h

   1 /*
   2  *  GRUB  --  GRand Unified Bootloader
   3  *  Copyright (C) 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 #ifndef GRUB_VIDEO_HEADER
  20 #define GRUB_VIDEO_HEADER       1
  21
  22 #include <grub/err.h>
  23 #include <grub/types.h>
  24
  25 /* Video color in hardware dependent format.  Users should not assume any
  26    specific coding format.  */
  27 typedef grub_uint32_t grub_video_color_t;
  28
  29 /* This structure is driver specific and should not be accessed directly by
  30    outside code.  */
  31 struct grub_video_render_target;
  32
  33 /* Forward declarations for used data structures.  */
  34 struct grub_video_bitmap;
  35
  36 /* Defines used to describe video mode or rendering target.  */
  37 /* If following is set render target contains currenly displayed image
  38    after swapping buffers (otherwise it contains previously displayed image).
  39  */
  40 #define GRUB_VIDEO_MODE_TYPE_UPDATING_SWAP      0x00000080
  41 #define GRUB_VIDEO_MODE_TYPE_PURE_TEXT          0x00000040
  42 #define GRUB_VIDEO_MODE_TYPE_ALPHA              0x00000020
  43 #define GRUB_VIDEO_MODE_TYPE_DOUBLE_BUFFERED    0x00000010
  44 #define GRUB_VIDEO_MODE_TYPE_1BIT_BITMAP        0x00000004
  45 #define GRUB_VIDEO_MODE_TYPE_INDEX_COLOR        0x00000002
  46 #define GRUB_VIDEO_MODE_TYPE_RGB                0x00000001
  47
  48 /* Defines used to mask flags.  */
  49 #define GRUB_VIDEO_MODE_TYPE_COLOR_MASK         0x0000000F
  50
  51 /* Defines used to specify requested bit depth.  */
  52 #define GRUB_VIDEO_MODE_TYPE_DEPTH_MASK         0x0000ff00
  53 #define GRUB_VIDEO_MODE_TYPE_DEPTH_POS          8
  54
  55 /* The basic render target representing the whole display.  This always
  56    renders to the back buffer when double-buffering is in use.  */
  57 #define GRUB_VIDEO_RENDER_TARGET_DISPLAY \
  58   ((struct grub_video_render_target *) 0)
  59
  60 /* Defined blitting formats.  */
  61 enum grub_video_blit_format
  62   {
  63     /* Generic RGBA, use fields & masks.  */
  64     GRUB_VIDEO_BLIT_FORMAT_RGBA,
  65
  66     /* Optimized RGBA's.  */
  67     GRUB_VIDEO_BLIT_FORMAT_RGBA_8888,
  68     GRUB_VIDEO_BLIT_FORMAT_BGRA_8888,
  69
  70     /* Generic RGB, use fields & masks.  */
  71     GRUB_VIDEO_BLIT_FORMAT_RGB,
  72
  73     /* Optimized RGB's.  */
  74     GRUB_VIDEO_BLIT_FORMAT_RGB_888,
  75     GRUB_VIDEO_BLIT_FORMAT_BGR_888,
  76     GRUB_VIDEO_BLIT_FORMAT_RGB_565,
  77     GRUB_VIDEO_BLIT_FORMAT_BGR_565,
  78
  79     /* When needed, decode color or just use value as is.  */
  80     GRUB_VIDEO_BLIT_FORMAT_INDEXCOLOR,
  81
  82     /* Two color bitmap; bits packed: rows are not padded to byte boundary.  */
  83     GRUB_VIDEO_BLIT_FORMAT_1BIT_PACKED
  84   };
  85
  86 /* Define blitting operators.  */
  87 enum grub_video_blit_operators
  88   {
  89     /* Replace target bitmap data with source.  */
  90     GRUB_VIDEO_BLIT_REPLACE,
  91     /* Blend target and source based on source's alpha value.  */
  92     GRUB_VIDEO_BLIT_BLEND
  93   };
  94
  95 struct grub_video_mode_info
  96 {
  97   /* Width of the screen.  */
  98   unsigned int width;
  99
 100   /* Height of the screen.  */
 101   unsigned int height;
 102
 103   /* Mode type bitmask.  Contains information like is it Index color or
 104      RGB mode.  */
 105   unsigned int mode_type;
 106
 107   /* Bits per pixel.  */
 108   unsigned int bpp;
 109
 110   /* Bytes per pixel.  */
 111   unsigned int bytes_per_pixel;
 112
 113   /* Pitch of one scanline.  How many bytes there are for scanline.  */
 114   unsigned int pitch;
 115
 116   /* In index color mode, number of colors.  In RGB mode this is 256.  */
 117   unsigned int number_of_colors;
 118
 119   /* Optimization hint how binary data is coded.  */
 120   enum grub_video_blit_format blit_format;
 121
 122   /* How many bits are reserved for red color.  */
 123   unsigned int red_mask_size;
 124
 125   /* What is location of red color bits.  In Index Color mode, this is 0.  */
 126   unsigned int red_field_pos;
 127
 128   /* How many bits are reserved for green color.  */
 129   unsigned int green_mask_size;
 130
 131   /* What is location of green color bits.  In Index Color mode, this is 0.  */
 132   unsigned int green_field_pos;
 133
 134   /* How many bits are reserved for blue color.  */
 135   unsigned int blue_mask_size;
 136
 137   /* What is location of blue color bits.  In Index Color mode, this is 0.  */
 138   unsigned int blue_field_pos;
 139
 140   /* How many bits are reserved in color.  */
 141   unsigned int reserved_mask_size;
 142
 143   /* What is location of reserved color bits.  In Index Color mode,
 144      this is 0.  */
 145   unsigned int reserved_field_pos;
 146
 147   /* For 1-bit bitmaps, the background color.  Used for bits = 0.  */
 148   grub_uint8_t bg_red;
 149   grub_uint8_t bg_green;
 150   grub_uint8_t bg_blue;
 151   grub_uint8_t bg_alpha;
 152
 153   /* For 1-bit bitmaps, the foreground color.  Used for bits = 1.  */
 154   grub_uint8_t fg_red;
 155   grub_uint8_t fg_green;
 156   grub_uint8_t fg_blue;
 157   grub_uint8_t fg_alpha;
 158 };
 159
 160 /* A 2D rectangle type.  */
 161 struct grub_video_rect
 162 {
 163   unsigned x;
 164   unsigned y;
 165   unsigned width;
 166   unsigned height;
 167 };
 168 typedef struct grub_video_rect grub_video_rect_t;
 169
 170 struct grub_video_palette_data
 171 {
 172   grub_uint8_t r; /* Red color value (0-255).  */
 173   grub_uint8_t g; /* Green color value (0-255).  */
 174   grub_uint8_t b; /* Blue color value (0-255).  */
 175   grub_uint8_t a; /* Reserved bits value (0-255).  */
 176 };
 177
 178 typedef enum grub_video_driver_id
 179   {
 180     GRUB_VIDEO_DRIVER_NONE,
 181     GRUB_VIDEO_DRIVER_VBE,
 182     GRUB_VIDEO_DRIVER_EFI_UGA,
 183     GRUB_VIDEO_DRIVER_EFI_GOP
 184   } grub_video_driver_id_t;
 185
 186 struct grub_video_adapter
 187 {
 188   /* The video adapter name.  */
 189   const char *name;
 190   grub_video_driver_id_t id;
 191
 192   /* Initialize the video adapter.  */
 193   grub_err_t (*init) (void);
 194
 195   /* Clean up the video adapter.  */
 196   grub_err_t (*fini) (void);
 197
 198   grub_err_t (*setup) (unsigned int width,  unsigned int height,
 199                        unsigned int mode_type, unsigned int mode_mask);
 200
 201   grub_err_t (*get_info) (struct grub_video_mode_info *mode_info);
 202
 203   grub_err_t (*get_info_and_fini) (struct grub_video_mode_info *mode_info,
 204                                    void **framebuffer);
 205
 206   grub_err_t (*set_palette) (unsigned int start, unsigned int count,
 207                              struct grub_video_palette_data *palette_data);
 208
 209   grub_err_t (*get_palette) (unsigned int start, unsigned int count,
 210                              struct grub_video_palette_data *palette_data);
 211
 212   grub_err_t (*set_viewport) (unsigned int x, unsigned int y,
 213                               unsigned int width, unsigned int height);
 214
 215   grub_err_t (*get_viewport) (unsigned int *x, unsigned int *y,
 216                               unsigned int *width, unsigned int *height);
 217
 218   grub_video_color_t (*map_color) (grub_uint32_t color_name);
 219
 220   grub_video_color_t (*map_rgb) (grub_uint8_t red, grub_uint8_t green,
 221                                  grub_uint8_t blue);
 222
 223   grub_video_color_t (*map_rgba) (grub_uint8_t red, grub_uint8_t green,
 224                                   grub_uint8_t blue, grub_uint8_t alpha);
 225
 226   grub_err_t (*unmap_color) (grub_video_color_t color,
 227                              grub_uint8_t *red, grub_uint8_t *green,
 228                              grub_uint8_t *blue, grub_uint8_t *alpha);
 229
 230   grub_err_t (*fill_rect) (grub_video_color_t color, int x, int y,
 231                            unsigned int width, unsigned int height);
 232
 233   grub_err_t (*blit_bitmap) (struct grub_video_bitmap *bitmap,
 234                              enum grub_video_blit_operators oper,
 235                              int x, int y, int offset_x, int offset_y,
 236                              unsigned int width, unsigned int height);
 237
 238   grub_err_t (*blit_render_target) (struct grub_video_render_target *source,
 239                                     enum grub_video_blit_operators oper,
 240                                     int x, int y, int offset_x, int offset_y,
 241                                     unsigned int width, unsigned int height);
 242
 243   grub_err_t (*scroll) (grub_video_color_t color, int dx, int dy);
 244
 245   grub_err_t (*swap_buffers) (void);
 246
 247   grub_err_t (*create_render_target) (struct grub_video_render_target **result,
 248                                       unsigned int width, unsigned int height,
 249                                       unsigned int mode_type);
 250
 251   grub_err_t (*delete_render_target) (struct grub_video_render_target *target);
 252
 253   grub_err_t (*set_active_render_target) (struct grub_video_render_target *target);
 254
 255   grub_err_t (*get_active_render_target) (struct grub_video_render_target **target);
 256
 257   /* The next video adapter.  */
 258   struct grub_video_adapter *next;
 259 };
 260 typedef struct grub_video_adapter *grub_video_adapter_t;
 261
 262 void EXPORT_FUNC (grub_video_register) (grub_video_adapter_t adapter);
 263 void grub_video_unregister (grub_video_adapter_t adapter);
 264 void grub_video_iterate (int (*hook) (grub_video_adapter_t adapter));
 265
 266 grub_err_t EXPORT_FUNC (grub_video_restore) (void);
 267
 268 grub_err_t EXPORT_FUNC (grub_video_get_info) (struct grub_video_mode_info *mode_info);
 269
 270 /* Framebuffer address may change as a part of normal operation
 271    (e.g. double buffering). That's why you need to stop video subsystem to be
 272    sure that framebuffer address doesn't change. To ensure this abstraction
 273    grub_video_get_info_and_fini is the only function supplying framebuffer
 274    address. */
 275 grub_err_t grub_video_get_info_and_fini (struct grub_video_mode_info *mode_info,
 276                                          void **framebuffer);
 277
 278 enum grub_video_blit_format grub_video_get_blit_format (struct grub_video_mode_info *mode_info);
 279
 280 grub_err_t grub_video_set_palette (unsigned int start, unsigned int count,
 281                                    struct grub_video_palette_data *palette_data);
 282
 283 grub_err_t grub_video_get_palette (unsigned int start, unsigned int count,
 284                                    struct grub_video_palette_data *palette_data);
 285
 286 grub_err_t EXPORT_FUNC (grub_video_set_viewport) (unsigned int x,
 287                                                   unsigned int y,
 288                                                   unsigned int width,
 289                                                   unsigned int height);
 290
 291 grub_err_t EXPORT_FUNC (grub_video_get_viewport) (unsigned int *x,
 292                                                   unsigned int *y,
 293                                                   unsigned int *width,
 294                                                   unsigned int *height);
 295
 296 grub_video_color_t EXPORT_FUNC (grub_video_map_color) (grub_uint32_t color_name);
 297
 298 grub_video_color_t EXPORT_FUNC (grub_video_map_rgb) (grub_uint8_t red,
 299                                                      grub_uint8_t green,
 300                                                      grub_uint8_t blue);
 301
 302 grub_video_color_t EXPORT_FUNC (grub_video_map_rgba) (grub_uint8_t red,
 303                                                       grub_uint8_t green,
 304                                                       grub_uint8_t blue,
 305                                                       grub_uint8_t alpha);
 306
 307 grub_err_t EXPORT_FUNC (grub_video_unmap_color) (grub_video_color_t color,
 308                                                  grub_uint8_t *red,
 309                                                  grub_uint8_t *green,
 310                                                  grub_uint8_t *blue,
 311                                                  grub_uint8_t *alpha);
 312
 313 grub_err_t EXPORT_FUNC (grub_video_fill_rect) (grub_video_color_t color,
 314                                                int x, int y,
 315                                                unsigned int width,
 316                                                unsigned int height);
 317
 318 grub_err_t EXPORT_FUNC (grub_video_blit_bitmap) (struct grub_video_bitmap *bitmap,
 319                                                  enum grub_video_blit_operators oper,
 320                                                  int x, int y,
 321                                                  int offset_x, int offset_y,
 322                                                  unsigned int width,
 323                                                  unsigned int height);
 324
 325 grub_err_t EXPORT_FUNC (grub_video_blit_render_target) (struct grub_video_render_target *source,
 326                                                         enum grub_video_blit_operators oper,
 327                                                         int x, int y,
 328                                                         int offset_x,
 329                                                         int offset_y,
 330                                                         unsigned int width,
 331                                                         unsigned int height);
 332
 333 grub_err_t grub_video_scroll (grub_video_color_t color, int dx, int dy);
 334
 335 grub_err_t EXPORT_FUNC (grub_video_swap_buffers) (void);
 336
 337 grub_err_t EXPORT_FUNC (grub_video_create_render_target) (struct grub_video_render_target **result,
 338                                                           unsigned int width,
 339                                                           unsigned int height,
 340                                                           unsigned int mode_type);
 341
 342 grub_err_t EXPORT_FUNC (grub_video_delete_render_target) (struct grub_video_render_target *target);
 343
 344 grub_err_t EXPORT_FUNC (grub_video_set_active_render_target) (struct grub_video_render_target *target);
 345
 346 grub_err_t grub_video_get_active_render_target (struct grub_video_render_target **target);
 347
 348 grub_err_t EXPORT_FUNC (grub_video_set_mode) (const char *modestring,
 349                                               unsigned int modemask,
 350                                               unsigned int modevalue);
 351
 352 static inline int
 353 grub_video_check_mode_flag (unsigned int flags, unsigned int mask,
 354                             unsigned int flag, int def)
 355 {
 356   return (flag & mask) ? !! (flags & flag) : def;
 357 }
 358
 359 grub_video_driver_id_t
 360 grub_video_get_driver_id (void);
 361
 362 #endif /* ! GRUB_VIDEO_HEADER */