2N/A/*
2N/A * GRUB -- GRand Unified Bootloader
2N/A * Copyright (C) 2006,2007,2008,2009 Free Software Foundation, Inc.
2N/A *
2N/A * GRUB is free software: you can redistribute it and/or modify
2N/A * it under the terms of the GNU General Public License as published by
2N/A * the Free Software Foundation, either version 3 of the License, or
2N/A * (at your option) any later version.
2N/A *
2N/A * GRUB is distributed in the hope that it will be useful,
2N/A * but WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2N/A * GNU General Public License for more details.
2N/A *
2N/A * You should have received a copy of the GNU General Public License
2N/A * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
2N/A */
2N/A
2N/A#ifndef GRUB_VIDEO_HEADER
2N/A#define GRUB_VIDEO_HEADER 1
2N/A
2N/A#include <grub/err.h>
2N/A#include <grub/types.h>
2N/A#include <grub/list.h>
2N/A
2N/A/* Video color in hardware dependent format. Users should not assume any
2N/A specific coding format. */
2N/Atypedef grub_uint32_t grub_video_color_t;
2N/A
2N/A/* Video color in hardware independent format. */
2N/Atypedef struct grub_video_rgba_color
2N/A{
2N/A grub_uint8_t red;
2N/A grub_uint8_t green;
2N/A grub_uint8_t blue;
2N/A grub_uint8_t alpha;
2N/A} grub_video_rgba_color_t;
2N/A
2N/A/* This structure is driver specific and should not be accessed directly by
2N/A outside code. */
2N/Astruct grub_video_render_target;
2N/A
2N/A/* Forward declarations for used data structures. */
2N/Astruct grub_video_bitmap;
2N/A
2N/A/* Defines used to describe video mode or rendering target. */
2N/A/* If following is set render target contains currenly displayed image
2N/A after swapping buffers (otherwise it contains previously displayed image).
2N/A */
2N/Atypedef enum grub_video_mode_type
2N/A {
2N/A GRUB_VIDEO_MODE_TYPE_RGB = 0x00000001,
2N/A GRUB_VIDEO_MODE_TYPE_INDEX_COLOR = 0x00000002,
2N/A GRUB_VIDEO_MODE_TYPE_1BIT_BITMAP = 0x00000004,
2N/A GRUB_VIDEO_MODE_TYPE_YUV = 0x00000008,
2N/A
2N/A /* Defines used to mask flags. */
2N/A GRUB_VIDEO_MODE_TYPE_COLOR_MASK = 0x0000000F,
2N/A
2N/A GRUB_VIDEO_MODE_TYPE_DOUBLE_BUFFERED = 0x00000010,
2N/A GRUB_VIDEO_MODE_TYPE_ALPHA = 0x00000020,
2N/A GRUB_VIDEO_MODE_TYPE_PURE_TEXT = 0x00000040,
2N/A GRUB_VIDEO_MODE_TYPE_UPDATING_SWAP = 0x00000080,
2N/A GRUB_VIDEO_MODE_TYPE_OPERATIONAL_MASK = 0x000000F0,
2N/A
2N/A /* Defines used to specify requested bit depth. */
2N/A GRUB_VIDEO_MODE_TYPE_DEPTH_MASK = 0x0000FF00,
2N/A#define GRUB_VIDEO_MODE_TYPE_DEPTH_POS 8
2N/A
2N/A GRUB_VIDEO_MODE_TYPE_UNKNOWN = 0x00010000,
2N/A GRUB_VIDEO_MODE_TYPE_HERCULES = 0x00020000,
2N/A GRUB_VIDEO_MODE_TYPE_PLANAR = 0x00040000,
2N/A GRUB_VIDEO_MODE_TYPE_NONCHAIN4 = 0x00080000,
2N/A GRUB_VIDEO_MODE_TYPE_CGA = 0x00100000,
2N/A GRUB_VIDEO_MODE_TYPE_INFO_MASK = 0x00FF0000,
2N/A } grub_video_mode_type_t;
2N/A
2N/A/* The basic render target representing the whole display. This always
2N/A renders to the back buffer when double-buffering is in use. */
2N/A#define GRUB_VIDEO_RENDER_TARGET_DISPLAY \
2N/A ((struct grub_video_render_target *) 0)
2N/A
2N/A/* Defined blitting formats. */
2N/Aenum grub_video_blit_format
2N/A {
2N/A /* Generic RGBA, use fields & masks. */
2N/A GRUB_VIDEO_BLIT_FORMAT_RGBA,
2N/A
2N/A /* Optimized RGBA's. */
2N/A GRUB_VIDEO_BLIT_FORMAT_RGBA_8888,
2N/A GRUB_VIDEO_BLIT_FORMAT_BGRA_8888,
2N/A
2N/A /* Generic RGB, use fields & masks. */
2N/A GRUB_VIDEO_BLIT_FORMAT_RGB,
2N/A
2N/A /* Optimized RGB's. */
2N/A GRUB_VIDEO_BLIT_FORMAT_RGB_888,
2N/A GRUB_VIDEO_BLIT_FORMAT_BGR_888,
2N/A GRUB_VIDEO_BLIT_FORMAT_RGB_565,
2N/A GRUB_VIDEO_BLIT_FORMAT_BGR_565,
2N/A
2N/A /* When needed, decode color or just use value as is. */
2N/A GRUB_VIDEO_BLIT_FORMAT_INDEXCOLOR,
2N/A
2N/A /* Two color bitmap; bits packed: rows are not padded to byte boundary. */
2N/A GRUB_VIDEO_BLIT_FORMAT_1BIT_PACKED
2N/A };
2N/A
2N/A/* Define blitting operators. */
2N/Aenum grub_video_blit_operators
2N/A {
2N/A /* Replace target bitmap data with source. */
2N/A GRUB_VIDEO_BLIT_REPLACE,
2N/A /* Blend target and source based on source's alpha value. */
2N/A GRUB_VIDEO_BLIT_BLEND
2N/A };
2N/A
2N/Astruct grub_video_mode_info
2N/A{
2N/A /* Width of the screen. */
2N/A unsigned int width;
2N/A
2N/A /* Height of the screen. */
2N/A unsigned int height;
2N/A
2N/A /* Mode type bitmask. Contains information like is it Index color or
2N/A RGB mode. */
2N/A grub_video_mode_type_t mode_type;
2N/A
2N/A /* Bits per pixel. */
2N/A unsigned int bpp;
2N/A
2N/A /* Bytes per pixel. */
2N/A unsigned int bytes_per_pixel;
2N/A
2N/A /* Pitch of one scanline. How many bytes there are for scanline. */
2N/A unsigned int pitch;
2N/A
2N/A /* In index color mode, number of colors. In RGB mode this is 256. */
2N/A unsigned int number_of_colors;
2N/A
2N/A unsigned int mode_number;
2N/A#define GRUB_VIDEO_MODE_NUMBER_INVALID 0xffffffff
2N/A
2N/A /* Optimization hint how binary data is coded. */
2N/A enum grub_video_blit_format blit_format;
2N/A
2N/A /* How many bits are reserved for red color. */
2N/A unsigned int red_mask_size;
2N/A
2N/A /* What is location of red color bits. In Index Color mode, this is 0. */
2N/A unsigned int red_field_pos;
2N/A
2N/A /* How many bits are reserved for green color. */
2N/A unsigned int green_mask_size;
2N/A
2N/A /* What is location of green color bits. In Index Color mode, this is 0. */
2N/A unsigned int green_field_pos;
2N/A
2N/A /* How many bits are reserved for blue color. */
2N/A unsigned int blue_mask_size;
2N/A
2N/A /* What is location of blue color bits. In Index Color mode, this is 0. */
2N/A unsigned int blue_field_pos;
2N/A
2N/A /* How many bits are reserved in color. */
2N/A unsigned int reserved_mask_size;
2N/A
2N/A /* What is location of reserved color bits. In Index Color mode,
2N/A this is 0. */
2N/A unsigned int reserved_field_pos;
2N/A
2N/A /* For 1-bit bitmaps, the background color. Used for bits = 0. */
2N/A grub_uint8_t bg_red;
2N/A grub_uint8_t bg_green;
2N/A grub_uint8_t bg_blue;
2N/A grub_uint8_t bg_alpha;
2N/A
2N/A /* For 1-bit bitmaps, the foreground color. Used for bits = 1. */
2N/A grub_uint8_t fg_red;
2N/A grub_uint8_t fg_green;
2N/A grub_uint8_t fg_blue;
2N/A grub_uint8_t fg_alpha;
2N/A};
2N/A
2N/A/* A 2D rectangle type. */
2N/Astruct grub_video_rect
2N/A{
2N/A unsigned x;
2N/A unsigned y;
2N/A unsigned width;
2N/A unsigned height;
2N/A};
2N/Atypedef struct grub_video_rect grub_video_rect_t;
2N/A
2N/Astruct grub_video_signed_rect
2N/A{
2N/A signed x;
2N/A signed y;
2N/A unsigned width;
2N/A unsigned height;
2N/A};
2N/Atypedef struct grub_video_signed_rect grub_video_signed_rect_t;
2N/A
2N/Astruct grub_video_palette_data
2N/A{
2N/A grub_uint8_t r; /* Red color value (0-255). */
2N/A grub_uint8_t g; /* Green color value (0-255). */
2N/A grub_uint8_t b; /* Blue color value (0-255). */
2N/A grub_uint8_t a; /* Reserved bits value (0-255). */
2N/A};
2N/A
2N/Astruct grub_video_edid_info
2N/A{
2N/A grub_uint8_t header[8];
2N/A grub_uint16_t manufacturer_id;
2N/A grub_uint16_t product_id;
2N/A grub_uint32_t serial_number;
2N/A grub_uint8_t week_of_manufacture;
2N/A grub_uint8_t year_of_manufacture;
2N/A grub_uint8_t version;
2N/A grub_uint8_t revision;
2N/A
2N/A grub_uint8_t video_input_definition;
2N/A grub_uint8_t max_horizontal_image_size;
2N/A grub_uint8_t max_vertical_image_size;
2N/A grub_uint8_t display_gamma;
2N/A grub_uint8_t feature_support;
2N/A#define GRUB_VIDEO_EDID_FEATURE_PREFERRED_TIMING_MODE (1 << 1)
2N/A
2N/A grub_uint8_t red_green_lo;
2N/A grub_uint8_t blue_white_lo;
2N/A grub_uint8_t red_x_hi;
2N/A grub_uint8_t red_y_hi;
2N/A grub_uint8_t green_x_hi;
2N/A grub_uint8_t green_y_hi;
2N/A grub_uint8_t blue_x_hi;
2N/A grub_uint8_t blue_y_hi;
2N/A grub_uint8_t white_x_hi;
2N/A grub_uint8_t white_y_hi;
2N/A
2N/A grub_uint8_t established_timings_1;
2N/A grub_uint8_t established_timings_2;
2N/A grub_uint8_t manufacturer_reserved_timings;
2N/A
2N/A grub_uint16_t standard_timings[8];
2N/A
2N/A struct {
2N/A grub_uint16_t pixel_clock;
2N/A /* Only valid if the pixel clock is non-null. */
2N/A grub_uint8_t horizontal_active_lo;
2N/A grub_uint8_t horizontal_blanking_lo;
2N/A grub_uint8_t horizontal_hi;
2N/A grub_uint8_t vertical_active_lo;
2N/A grub_uint8_t vertical_blanking_lo;
2N/A grub_uint8_t vertical_hi;
2N/A grub_uint8_t horizontal_sync_offset_lo;
2N/A grub_uint8_t horizontal_sync_pulse_width_lo;
2N/A grub_uint8_t vertical_sync_lo;
2N/A grub_uint8_t sync_hi;
2N/A grub_uint8_t horizontal_image_size_lo;
2N/A grub_uint8_t vertical_image_size_lo;
2N/A grub_uint8_t image_size_hi;
2N/A grub_uint8_t horizontal_border;
2N/A grub_uint8_t vertical_border;
2N/A grub_uint8_t flags;
2N/A } detailed_timings[4];
2N/A
2N/A grub_uint8_t extension_flag;
2N/A grub_uint8_t checksum;
2N/A} __attribute__ ((packed));
2N/A
2N/Atypedef enum grub_video_driver_id
2N/A {
2N/A GRUB_VIDEO_DRIVER_NONE,
2N/A GRUB_VIDEO_DRIVER_VBE,
2N/A GRUB_VIDEO_DRIVER_EFI_UGA,
2N/A GRUB_VIDEO_DRIVER_EFI_GOP,
2N/A GRUB_VIDEO_DRIVER_SM712,
2N/A GRUB_VIDEO_DRIVER_VGA,
2N/A GRUB_VIDEO_DRIVER_CIRRUS,
2N/A GRUB_VIDEO_DRIVER_BOCHS,
2N/A GRUB_VIDEO_DRIVER_SDL,
2N/A GRUB_VIDEO_DRIVER_SIS315PRO,
2N/A GRUB_VIDEO_DRIVER_RADEON_FULOONG2E,
2N/A } grub_video_driver_id_t;
2N/A
2N/Atypedef enum grub_video_adapter_prio
2N/A {
2N/A GRUB_VIDEO_ADAPTER_PRIO_FALLBACK = 60,
2N/A GRUB_VIDEO_ADAPTER_PRIO_FIRMWARE_DIRTY = 70,
2N/A GRUB_VIDEO_ADAPTER_PRIO_FIRMWARE = 80,
2N/A GRUB_VIDEO_ADAPTER_PRIO_NATIVE = 100
2N/A } grub_video_adapter_prio_t;
2N/A
2N/A
2N/Astruct grub_video_adapter
2N/A{
2N/A /* The next video adapter. */
2N/A struct grub_video_adapter *next;
2N/A
2N/A /* The video adapter name. */
2N/A const char *name;
2N/A grub_video_driver_id_t id;
2N/A
2N/A grub_video_adapter_prio_t prio;
2N/A
2N/A /* Initialize the video adapter. */
2N/A grub_err_t (*init) (void);
2N/A
2N/A /* Clean up the video adapter. */
2N/A grub_err_t (*fini) (void);
2N/A
2N/A grub_err_t (*setup) (unsigned int width, unsigned int height,
2N/A grub_video_mode_type_t mode_type,
2N/A grub_video_mode_type_t mode_mask);
2N/A
2N/A grub_err_t (*get_info) (struct grub_video_mode_info *mode_info);
2N/A
2N/A grub_err_t (*get_info_and_fini) (struct grub_video_mode_info *mode_info,
2N/A void **framebuffer);
2N/A
2N/A grub_err_t (*set_palette) (unsigned int start, unsigned int count,
2N/A struct grub_video_palette_data *palette_data);
2N/A
2N/A grub_err_t (*get_palette) (unsigned int start, unsigned int count,
2N/A struct grub_video_palette_data *palette_data);
2N/A
2N/A grub_err_t (*set_viewport) (unsigned int x, unsigned int y,
2N/A unsigned int width, unsigned int height);
2N/A
2N/A grub_err_t (*get_viewport) (unsigned int *x, unsigned int *y,
2N/A unsigned int *width, unsigned int *height);
2N/A
2N/A grub_video_color_t (*map_color) (grub_uint32_t color_name);
2N/A
2N/A grub_video_color_t (*map_rgb) (grub_uint8_t red, grub_uint8_t green,
2N/A grub_uint8_t blue);
2N/A
2N/A grub_video_color_t (*map_rgba) (grub_uint8_t red, grub_uint8_t green,
2N/A grub_uint8_t blue, grub_uint8_t alpha);
2N/A
2N/A grub_err_t (*unmap_color) (grub_video_color_t color,
2N/A grub_uint8_t *red, grub_uint8_t *green,
2N/A grub_uint8_t *blue, grub_uint8_t *alpha);
2N/A
2N/A grub_err_t (*fill_rect) (grub_video_color_t color, int x, int y,
2N/A unsigned int width, unsigned int height);
2N/A
2N/A grub_err_t (*blit_bitmap) (struct grub_video_bitmap *bitmap,
2N/A enum grub_video_blit_operators oper,
2N/A int x, int y, int offset_x, int offset_y,
2N/A unsigned int width, unsigned int height);
2N/A
2N/A grub_err_t (*blit_render_target) (struct grub_video_render_target *source,
2N/A enum grub_video_blit_operators oper,
2N/A int x, int y, int offset_x, int offset_y,
2N/A unsigned int width, unsigned int height);
2N/A
2N/A grub_err_t (*scroll) (grub_video_color_t color, int dx, int dy);
2N/A
2N/A grub_err_t (*swap_buffers) (void);
2N/A
2N/A grub_err_t (*create_render_target) (struct grub_video_render_target **result,
2N/A unsigned int width, unsigned int height,
2N/A unsigned int mode_type);
2N/A
2N/A grub_err_t (*delete_render_target) (struct grub_video_render_target *target);
2N/A
2N/A grub_err_t (*set_active_render_target) (struct grub_video_render_target *target);
2N/A
2N/A grub_err_t (*get_active_render_target) (struct grub_video_render_target **target);
2N/A
2N/A int (*iterate) (int (*hook) (const struct grub_video_mode_info *info));
2N/A
2N/A grub_err_t (*get_edid) (struct grub_video_edid_info *edid_info);
2N/A
2N/A void (*print_adapter_specific_info) (void);
2N/A};
2N/Atypedef struct grub_video_adapter *grub_video_adapter_t;
2N/A
2N/Aextern grub_video_adapter_t EXPORT_VAR(grub_video_adapter_list);
2N/A
2N/A#ifndef GRUB_LST_GENERATOR
2N/A/* Register video driver. */
2N/Astatic inline void
2N/Agrub_video_register (grub_video_adapter_t adapter)
2N/A{
2N/A grub_video_adapter_t *p;
2N/A for (p = &grub_video_adapter_list; *p && (*p)->prio > adapter->prio;
2N/A p = &((*p)->next));
2N/A adapter->next = *p;
2N/A *p = adapter;
2N/A}
2N/A#endif
2N/A
2N/A/* Unregister video driver. */
2N/Astatic inline void
2N/Agrub_video_unregister (grub_video_adapter_t adapter)
2N/A{
2N/A grub_list_remove (GRUB_AS_LIST_P (&grub_video_adapter_list),
2N/A GRUB_AS_LIST (adapter));
2N/A}
2N/A
2N/A#define FOR_VIDEO_ADAPTERS(var) FOR_LIST_ELEMENTS((var), (grub_video_adapter_list))
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_restore) (void);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_get_info) (struct grub_video_mode_info *mode_info);
2N/A
2N/A/* Framebuffer address may change as a part of normal operation
2N/A (e.g. double buffering). That's why you need to stop video subsystem to be
2N/A sure that framebuffer address doesn't change. To ensure this abstraction
2N/A grub_video_get_info_and_fini is the only function supplying framebuffer
2N/A address. */
2N/Agrub_err_t EXPORT_FUNC (grub_video_get_info_and_fini) (struct grub_video_mode_info *mode_info,
2N/A void **framebuffer);
2N/A
2N/Aenum grub_video_blit_format grub_video_get_blit_format (struct grub_video_mode_info *mode_info);
2N/A
2N/Agrub_err_t grub_video_set_palette (unsigned int start, unsigned int count,
2N/A struct grub_video_palette_data *palette_data);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_get_palette) (unsigned int start,
2N/A unsigned int count,
2N/A struct grub_video_palette_data *palette_data);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_set_viewport) (unsigned int x,
2N/A unsigned int y,
2N/A unsigned int width,
2N/A unsigned int height);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_get_viewport) (unsigned int *x,
2N/A unsigned int *y,
2N/A unsigned int *width,
2N/A unsigned int *height);
2N/A
2N/Agrub_video_color_t EXPORT_FUNC (grub_video_map_color) (grub_uint32_t color_name);
2N/A
2N/Agrub_video_color_t EXPORT_FUNC (grub_video_map_rgb) (grub_uint8_t red,
2N/A grub_uint8_t green,
2N/A grub_uint8_t blue);
2N/A
2N/Agrub_video_color_t EXPORT_FUNC (grub_video_map_rgba) (grub_uint8_t red,
2N/A grub_uint8_t green,
2N/A grub_uint8_t blue,
2N/A grub_uint8_t alpha);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_unmap_color) (grub_video_color_t color,
2N/A grub_uint8_t *red,
2N/A grub_uint8_t *green,
2N/A grub_uint8_t *blue,
2N/A grub_uint8_t *alpha);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_fill_rect) (grub_video_color_t color,
2N/A int x, int y,
2N/A unsigned int width,
2N/A unsigned int height);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_blit_bitmap) (struct grub_video_bitmap *bitmap,
2N/A enum grub_video_blit_operators oper,
2N/A int x, int y,
2N/A int offset_x, int offset_y,
2N/A unsigned int width,
2N/A unsigned int height);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_blit_render_target) (struct grub_video_render_target *source,
2N/A enum grub_video_blit_operators oper,
2N/A int x, int y,
2N/A int offset_x,
2N/A int offset_y,
2N/A unsigned int width,
2N/A unsigned int height);
2N/A
2N/Agrub_err_t grub_video_scroll (grub_video_color_t color, int dx, int dy);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_swap_buffers) (void);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_create_render_target) (struct grub_video_render_target **result,
2N/A unsigned int width,
2N/A unsigned int height,
2N/A unsigned int mode_type);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_delete_render_target) (struct grub_video_render_target *target);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_set_active_render_target) (struct grub_video_render_target *target);
2N/A
2N/Agrub_err_t grub_video_get_active_render_target (struct grub_video_render_target **target);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_edid_checksum) (struct grub_video_edid_info *edid_info);
2N/Agrub_err_t EXPORT_FUNC (grub_video_edid_preferred_mode) (struct grub_video_edid_info *edid_info,
2N/A unsigned int *width,
2N/A unsigned int *height);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_set_mode) (const char *modestring,
2N/A unsigned int modemask,
2N/A unsigned int modevalue);
2N/A
2N/Astatic inline int
2N/Agrub_video_check_mode_flag (grub_video_mode_type_t flags,
2N/A grub_video_mode_type_t mask,
2N/A grub_video_mode_type_t flag, int def)
2N/A{
2N/A return (flag & mask) ? !! (flags & flag) : def;
2N/A}
2N/A
2N/Agrub_video_driver_id_t EXPORT_FUNC (grub_video_get_driver_id) (void);
2N/A
2N/Astatic __inline grub_video_rgba_color_t
2N/Agrub_video_rgba_color_rgb (int r, int g, int b)
2N/A{
2N/A grub_video_rgba_color_t c;
2N/A c.red = r;
2N/A c.green = g;
2N/A c.blue = b;
2N/A c.alpha = 255;
2N/A return c;
2N/A}
2N/A
2N/Astatic __inline grub_video_color_t
2N/Agrub_video_map_rgba_color (grub_video_rgba_color_t c)
2N/A{
2N/A return grub_video_map_rgba (c.red, c.green, c.blue, c.alpha);
2N/A}
2N/A
2N/Aint EXPORT_FUNC (grub_video_get_named_color) (const char *name,
2N/A grub_video_rgba_color_t *color);
2N/A
2N/Agrub_err_t EXPORT_FUNC (grub_video_parse_color) (const char *s,
2N/A grub_video_rgba_color_t *color);
2N/A
2N/A#endif /* ! GRUB_VIDEO_HEADER */