[grub2.git] / grub-core / video / cirrus.c

/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2005,2006,2007,2008,2009,2010  Free Software Foundation, Inc.
 *
 *  GRUB is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#define grub_video_render_target grub_video_fbrender_target

#include <grub/err.h>
#include <grub/types.h>
#include <grub/dl.h>
#include <grub/misc.h>
#include <grub/mm.h>
#include <grub/video.h>
#include <grub/video_fb.h>
#include <grub/pci.h>
#include <grub/vga.h>

static struct
{
  struct grub_video_mode_info mode_info;
  grub_size_t page_size;        /* The size of a page in bytes.  */

  grub_uint8_t *ptr;
  int mapped;
  grub_uint32_t base;
  grub_pci_device_t dev;
} framebuffer;

#define CIRRUS_APERTURE_SIZE 0x1000000

#define CIRRUS_MAX_WIDTH 0x800
#define CIRRUS_MAX_HEIGHT 0x800
#define CIRRUS_MAX_PITCH (0x1ff * GRUB_VGA_CR_PITCH_DIVISOR)

enum
  {
    CIRRUS_CR_EXTENDED_DISPLAY = 0x1b,
    CIRRUS_CR_EXTENDED_OVERLAY = 0x1d,
    CIRRUS_CR_MAX
  };

#define CIRRUS_CR_EXTENDED_DISPLAY_PITCH_MASK 0x10
#define CIRRUS_CR_EXTENDED_DISPLAY_PITCH_SHIFT 4
#define CIRRUS_CR_EXTENDED_DISPLAY_START_MASK1 0x1
#define CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT1 16
#define CIRRUS_CR_EXTENDED_DISPLAY_START_MASK2 0xc
#define CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT2 15

#define CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_MASK 0x80
#define CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_SHIFT 12

enum
  {
    CIRRUS_SR_EXTENDED_MODE = 7,
    CIRRUS_SR_MAX
  };

#define CIRRUS_SR_EXTENDED_MODE_LFB_ENABLE 0xf0
#define CIRRUS_SR_EXTENDED_MODE_ENABLE_EXT 0x01
#define CIRRUS_SR_EXTENDED_MODE_8BPP       0x00
#define CIRRUS_SR_EXTENDED_MODE_16BPP      0x06
#define CIRRUS_SR_EXTENDED_MODE_24BPP      0x04
#define CIRRUS_SR_EXTENDED_MODE_32BPP      0x08

#define CIRRUS_HIDDEN_DAC_ENABLE_EXT 0x80
#define CIRRUS_HIDDEN_DAC_ENABLE_ALL 0x40
#define CIRRUS_HIDDEN_DAC_8BPP 0
#define CIRRUS_HIDDEN_DAC_15BPP (CIRRUS_HIDDEN_DAC_ENABLE_EXT \
				 | CIRRUS_HIDDEN_DAC_ENABLE_ALL | 0)
#define CIRRUS_HIDDEN_DAC_16BPP (CIRRUS_HIDDEN_DAC_ENABLE_EXT \
				 | CIRRUS_HIDDEN_DAC_ENABLE_ALL | 1)
#define CIRRUS_HIDDEN_DAC_888COLOR (CIRRUS_HIDDEN_DAC_ENABLE_EXT \
				    | CIRRUS_HIDDEN_DAC_ENABLE_ALL | 5)

static void
write_hidden_dac (grub_uint8_t data)
{
  grub_inb (GRUB_VGA_IO_PALLETTE_WRITE_INDEX);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_outb (data, GRUB_VGA_IO_PIXEL_MASK);
}

static grub_uint8_t
read_hidden_dac (void)
{
  grub_inb (GRUB_VGA_IO_PALLETTE_WRITE_INDEX);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  grub_inb (GRUB_VGA_IO_PIXEL_MASK);
  return grub_inb (GRUB_VGA_IO_PIXEL_MASK);
}

struct saved_state
{
  grub_uint8_t cr[CIRRUS_CR_MAX];
  grub_uint8_t gr[GRUB_VGA_GR_MAX];
  grub_uint8_t sr[CIRRUS_SR_MAX];
  grub_uint8_t hidden_dac;
  /* We need to preserve VGA font and VGA text. */
  grub_uint8_t vram[32 * 4 * 256];
  grub_uint8_t r[256];
  grub_uint8_t g[256];
  grub_uint8_t b[256];
};

static struct saved_state initial_state;
static int state_saved = 0;

static void
save_state (struct saved_state *st)
{
  unsigned i;
  for (i = 0; i < ARRAY_SIZE (st->cr); i++)
    st->cr[i] = grub_vga_cr_read (i);
  for (i = 0; i < ARRAY_SIZE (st->sr); i++)
    st->sr[i] = grub_vga_sr_read (i);
  for (i = 0; i < ARRAY_SIZE (st->gr); i++)
    st->gr[i] = grub_vga_gr_read (i);
  for (i = 0; i < 256; i++)
    grub_vga_palette_read (i, st->r + i, st->g + i, st->b + i);

  st->hidden_dac = read_hidden_dac ();
  grub_vga_sr_write (GRUB_VGA_SR_MEMORY_MODE_CHAIN4, GRUB_VGA_SR_MEMORY_MODE);
  grub_memcpy (st->vram, framebuffer.ptr, sizeof (st->vram));
}

static void
restore_state (struct saved_state *st)
{
  unsigned i;
  grub_vga_sr_write (GRUB_VGA_SR_MEMORY_MODE_CHAIN4, GRUB_VGA_SR_MEMORY_MODE);
  grub_memcpy (framebuffer.ptr, st->vram, sizeof (st->vram));
  for (i = 0; i < ARRAY_SIZE (st->cr); i++)
    grub_vga_cr_write (st->cr[i], i);
  for (i = 0; i < ARRAY_SIZE (st->sr); i++)
    grub_vga_sr_write (st->sr[i], i);
  for (i = 0; i < ARRAY_SIZE (st->gr); i++)
    grub_vga_gr_write (st->gr[i], i);
  for (i = 0; i < 256; i++)
    grub_vga_palette_write (i, st->r[i], st->g[i], st->b[i]);

  write_hidden_dac (st->hidden_dac);
}

static grub_err_t
grub_video_cirrus_video_init (void)
{
  /* Reset frame buffer.  */
  grub_memset (&framebuffer, 0, sizeof(framebuffer));

  return grub_video_fb_init ();
}

static grub_err_t
grub_video_cirrus_video_fini (void)
{
  if (framebuffer.mapped)
    grub_pci_device_unmap_range (framebuffer.dev, framebuffer.ptr,
				 CIRRUS_APERTURE_SIZE);

  if (state_saved)
    {
      restore_state (&initial_state);
      state_saved = 0;
    }

  return grub_video_fb_fini ();
}

static grub_err_t
doublebuf_pageflipping_set_page (int page)
{
  int start = framebuffer.page_size * page / 4;
  grub_uint8_t cr_ext, cr_overlay;

  grub_vga_cr_write (start & 0xff, GRUB_VGA_CR_START_ADDR_LOW_REGISTER);
  grub_vga_cr_write ((start & 0xff00) >> 8,
		     GRUB_VGA_CR_START_ADDR_HIGH_REGISTER);

  cr_ext = grub_vga_cr_read (CIRRUS_CR_EXTENDED_DISPLAY);
  cr_ext &= ~(CIRRUS_CR_EXTENDED_DISPLAY_START_MASK1
	      | CIRRUS_CR_EXTENDED_DISPLAY_START_MASK2);
  cr_ext |= ((start >> CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT1)
	     & CIRRUS_CR_EXTENDED_DISPLAY_START_MASK1);
  cr_ext |= ((start >> CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT2)
	     & CIRRUS_CR_EXTENDED_DISPLAY_START_MASK2);
  grub_vga_cr_write (cr_ext, CIRRUS_CR_EXTENDED_DISPLAY);

  cr_overlay = grub_vga_cr_read (CIRRUS_CR_EXTENDED_OVERLAY);
  cr_overlay &= ~(CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_MASK);
  cr_overlay |= ((start >> CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_SHIFT)
		 & CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_MASK);
  grub_vga_cr_write (cr_overlay, CIRRUS_CR_EXTENDED_OVERLAY);

  return GRUB_ERR_NONE;
}

static grub_err_t
grub_video_cirrus_set_palette (unsigned int start, unsigned int count,
			       struct grub_video_palette_data *palette_data)
{
  if (framebuffer.mode_info.mode_type == GRUB_VIDEO_MODE_TYPE_INDEX_COLOR)
    {
      unsigned i;
      if (start >= 0x100)
	return GRUB_ERR_NONE;
      if (start + count >= 0x100)
	count = 0x100 - start;

      for (i = 0; i < count; i++)
	grub_vga_palette_write (start + i, palette_data[i].r, palette_data[i].g,
				palette_data[i].b);
    }

  /* Then set color to emulated palette.  */
  return grub_video_fb_set_palette (start, count, palette_data);
}

static grub_err_t
grub_video_cirrus_setup (unsigned int width, unsigned int height,
			 unsigned int mode_type, unsigned int mode_mask)
{
  int depth;
  grub_err_t err;
  int found = 0;
  int pitch, bytes_per_pixel;

  auto int NESTED_FUNC_ATTR find_card (grub_pci_device_t dev, grub_pci_id_t pciid __attribute__ ((unused)));
  int NESTED_FUNC_ATTR find_card (grub_pci_device_t dev, grub_pci_id_t pciid)
    {
      grub_pci_address_t addr;
      grub_uint32_t class;

      addr = grub_pci_make_address (dev, GRUB_PCI_REG_CLASS);
      class = grub_pci_read (addr);

      if (((class >> 16) & 0xffff) != 0x0300 || pciid != 0x00b81013)
	return 0;
      
      found = 1;

      addr = grub_pci_make_address (dev, GRUB_PCI_REG_ADDRESS_REG0);
      framebuffer.base = grub_pci_read (addr) & GRUB_PCI_ADDR_MEM_MASK;
      framebuffer.dev = dev;

      return 1;
    }

  /* Decode depth from mode_type.  If it is zero, then autodetect.  */
  depth = (mode_type & GRUB_VIDEO_MODE_TYPE_DEPTH_MASK)
          >> GRUB_VIDEO_MODE_TYPE_DEPTH_POS;

  if (width == 0 || height == 0)
    {
      width = 800;
      height = 600;
    }

  if (width & (GRUB_VGA_CR_WIDTH_DIVISOR - 1))
    return grub_error (GRUB_ERR_IO,
		       "screen width must be a multiple of %d",
		       GRUB_VGA_CR_WIDTH_DIVISOR);

  if (width > CIRRUS_MAX_WIDTH)
    return grub_error (GRUB_ERR_IO,
		       "screen width must be at most %d", CIRRUS_MAX_WIDTH);

  if (height > CIRRUS_MAX_HEIGHT)
    return grub_error (GRUB_ERR_IO,
		       "screen height must be at most %d", CIRRUS_MAX_HEIGHT);

  if (depth == 0
      && !grub_video_check_mode_flag (mode_type, mode_mask,
				      GRUB_VIDEO_MODE_TYPE_INDEX_COLOR, 0))
    depth = 24;

  if (depth == 0)
    depth = 8;

  if (depth != 32 && depth != 24 && depth != 16 && depth != 15 && depth != 8)
    return grub_error (GRUB_ERR_IO, "only 32, 24, 16, 15 and 8-bit bpp are"
		       " supported by cirrus video");

  bytes_per_pixel = (depth + 7) / 8;
  pitch = width * bytes_per_pixel;

  if (pitch > CIRRUS_MAX_PITCH)
    return grub_error (GRUB_ERR_IO,
		       "screen width must be at most %d at bitdepth %d",
		       CIRRUS_MAX_PITCH / bytes_per_pixel, depth);

  framebuffer.page_size = pitch * height;

  if (framebuffer.page_size > CIRRUS_APERTURE_SIZE)
    return grub_error (GRUB_ERR_IO, "Not enough video memory for this mode");

  grub_pci_iterate (find_card);
  if (!found)
    return grub_error (GRUB_ERR_IO, "Couldn't find graphics card");

  if (found && framebuffer.base == 0)
    {
      /* FIXME: change framebuffer base */
      return grub_error (GRUB_ERR_IO, "PCI BAR not set");
    }

  /* We can safely discard volatile attribute.  */
  framebuffer.ptr = (void *) grub_pci_device_map_range (framebuffer.dev,
							framebuffer.base,
							CIRRUS_APERTURE_SIZE);
  framebuffer.mapped = 1;

  if (!state_saved)
    {
      save_state (&initial_state);
      state_saved = 1;
    }

  {
    struct grub_video_hw_config config = {
      .pitch = pitch / GRUB_VGA_CR_PITCH_DIVISOR,
      .line_compare = 0x3ff,
      .vdisplay_end = height - 1,
      .horizontal_end = width / GRUB_VGA_CR_WIDTH_DIVISOR
    };
    grub_uint8_t sr_ext = 0, hidden_dac = 0;

    grub_vga_set_geometry (&config, grub_vga_cr_write);
    
    grub_vga_gr_write (GRUB_VGA_GR_MODE_256_COLOR | GRUB_VGA_GR_MODE_READ_MODE1,
		       GRUB_VGA_GR_MODE);
    grub_vga_gr_write (GRUB_VGA_GR_GR6_GRAPHICS_MODE, GRUB_VGA_GR_GR6);
    
    grub_vga_sr_write (GRUB_VGA_SR_MEMORY_MODE_NORMAL, GRUB_VGA_SR_MEMORY_MODE);

    grub_vga_cr_write ((config.pitch >> CIRRUS_CR_EXTENDED_DISPLAY_PITCH_SHIFT)
	      & CIRRUS_CR_EXTENDED_DISPLAY_PITCH_MASK,
	      CIRRUS_CR_EXTENDED_DISPLAY);

    grub_vga_cr_write (GRUB_VGA_CR_MODE_TIMING_ENABLE
		       | GRUB_VGA_CR_MODE_BYTE_MODE
		       | GRUB_VGA_CR_MODE_NO_HERCULES | GRUB_VGA_CR_MODE_NO_CGA,
		       GRUB_VGA_CR_MODE);

    doublebuf_pageflipping_set_page (0);

    sr_ext = CIRRUS_SR_EXTENDED_MODE_LFB_ENABLE
      | CIRRUS_SR_EXTENDED_MODE_ENABLE_EXT;
    switch (depth)
      {
	/* FIXME: support 8-bit grayscale and 8-bit RGB.  */
      case 32:
	hidden_dac = CIRRUS_HIDDEN_DAC_888COLOR;
	sr_ext |= CIRRUS_SR_EXTENDED_MODE_32BPP;
	break;
      case 24:
	hidden_dac = CIRRUS_HIDDEN_DAC_888COLOR;
	sr_ext |= CIRRUS_SR_EXTENDED_MODE_24BPP;
	break;
      case 16:
	hidden_dac = CIRRUS_HIDDEN_DAC_16BPP;
	sr_ext |= CIRRUS_SR_EXTENDED_MODE_16BPP;
	break;
      case 15:
	hidden_dac = CIRRUS_HIDDEN_DAC_15BPP;
	sr_ext |= CIRRUS_SR_EXTENDED_MODE_16BPP;
	break;
      case 8:
	hidden_dac = CIRRUS_HIDDEN_DAC_8BPP;
	sr_ext |= CIRRUS_SR_EXTENDED_MODE_8BPP;
	break;
      }
    grub_vga_sr_write (sr_ext, CIRRUS_SR_EXTENDED_MODE);
    write_hidden_dac (hidden_dac);
  }

  /* Fill mode info details.  */
  framebuffer.mode_info.width = width;
  framebuffer.mode_info.height = height;
  framebuffer.mode_info.mode_type = GRUB_VIDEO_MODE_TYPE_RGB;
  framebuffer.mode_info.bpp = depth;
  framebuffer.mode_info.bytes_per_pixel = bytes_per_pixel;
  framebuffer.mode_info.pitch = pitch;
  framebuffer.mode_info.number_of_colors = 256;
  framebuffer.mode_info.reserved_mask_size = 0;
  framebuffer.mode_info.reserved_field_pos = 0;

  switch (depth)
    {
    case 8:
      framebuffer.mode_info.mode_type = GRUB_VIDEO_MODE_TYPE_INDEX_COLOR;
      break;
    case 16:
      framebuffer.mode_info.red_mask_size = 5;
      framebuffer.mode_info.red_field_pos = 11;
      framebuffer.mode_info.green_mask_size = 6;
      framebuffer.mode_info.green_field_pos = 5;
      framebuffer.mode_info.blue_mask_size = 5;
      framebuffer.mode_info.blue_field_pos = 0;
      break;

    case 15:
      framebuffer.mode_info.red_mask_size = 5;
      framebuffer.mode_info.red_field_pos = 10;
      framebuffer.mode_info.green_mask_size = 5;
      framebuffer.mode_info.green_field_pos = 5;
      framebuffer.mode_info.blue_mask_size = 5;
      framebuffer.mode_info.blue_field_pos = 0;
      break;

    case 32:
      framebuffer.mode_info.reserved_mask_size = 8;
      framebuffer.mode_info.reserved_field_pos = 24;

    case 24:
      framebuffer.mode_info.red_mask_size = 8;
      framebuffer.mode_info.red_field_pos = 16;
      framebuffer.mode_info.green_mask_size = 8;
      framebuffer.mode_info.green_field_pos = 8;
      framebuffer.mode_info.blue_mask_size = 8;
      framebuffer.mode_info.blue_field_pos = 0;
      break;
    }

  framebuffer.mode_info.blit_format = grub_video_get_blit_format (&framebuffer.mode_info);

  if (CIRRUS_APERTURE_SIZE >= 2 * framebuffer.page_size)
    err = grub_video_fb_setup (mode_type, mode_mask,
			       &framebuffer.mode_info,
			       framebuffer.ptr,
			       doublebuf_pageflipping_set_page,
			       framebuffer.ptr + framebuffer.page_size);
  else
    err = grub_video_fb_setup (mode_type, mode_mask,
			       &framebuffer.mode_info,
			       framebuffer.ptr, 0, 0);


  /* Copy default palette to initialize emulated palette.  */
  err = grub_video_cirrus_set_palette (0, GRUB_VIDEO_FBSTD_NUMCOLORS,
				       grub_video_fbstd_colors);
  return err;
}

static struct grub_video_adapter grub_video_cirrus_adapter =
  {
    .name = "Cirrus CLGD 5446 PCI Video Driver",
    .id = GRUB_VIDEO_DRIVER_CIRRUS,

    .prio = GRUB_VIDEO_ADAPTER_PRIO_NATIVE,

    .init = grub_video_cirrus_video_init,
    .fini = grub_video_cirrus_video_fini,
    .setup = grub_video_cirrus_setup,
    .get_info = grub_video_fb_get_info,
    .get_info_and_fini = grub_video_fb_get_info_and_fini,
    .set_palette = grub_video_cirrus_set_palette,
    .get_palette = grub_video_fb_get_palette,
    .set_viewport = grub_video_fb_set_viewport,
    .get_viewport = grub_video_fb_get_viewport,
    .map_color = grub_video_fb_map_color,
    .map_rgb = grub_video_fb_map_rgb,
    .map_rgba = grub_video_fb_map_rgba,
    .unmap_color = grub_video_fb_unmap_color,
    .fill_rect = grub_video_fb_fill_rect,
    .blit_bitmap = grub_video_fb_blit_bitmap,
    .blit_render_target = grub_video_fb_blit_render_target,
    .scroll = grub_video_fb_scroll,
    .swap_buffers = grub_video_fb_swap_buffers,
    .create_render_target = grub_video_fb_create_render_target,
    .delete_render_target = grub_video_fb_delete_render_target,
    .set_active_render_target = grub_video_fb_set_active_render_target,
    .get_active_render_target = grub_video_fb_get_active_render_target,

    .next = 0
  };

GRUB_MOD_INIT(video_cirrus)
{
  grub_video_register (&grub_video_cirrus_adapter);
}

GRUB_MOD_FINI(video_cirrus)
{
  grub_video_unregister (&grub_video_cirrus_adapter);
}
Commit	Line	Data
94bf3dd5 VS	1	/*
	2	* GRUB -- GRand Unified Bootloader
	3	* Copyright (C) 2005,2006,2007,2008,2009,2010 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/pci.h>
967828eb	29	#include <grub/vga.h>
94bf3dd5 VS	30
	31	static struct
	32	{
	33	struct grub_video_mode_info mode_info;
d00b0b3f	34	grub_size_t page_size; /* The size of a page in bytes. */
94bf3dd5 VS	35
	36	grub_uint8_t *ptr;
	37	int mapped;
	38	grub_uint32_t base;
	39	grub_pci_device_t dev;
	40	} framebuffer;
	41
9a3e298a	42	#define CIRRUS_APERTURE_SIZE 0x1000000
94bf3dd5	43
94bf3dd5	44	#define CIRRUS_MAX_WIDTH 0x800
94bf3dd5	45	#define CIRRUS_MAX_HEIGHT 0x800
967828eb	46	#define CIRRUS_MAX_PITCH (0x1ff * GRUB_VGA_CR_PITCH_DIVISOR)
94bf3dd5 VS	47
	48	enum
	49	{
94bf3dd5	50	CIRRUS_CR_EXTENDED_DISPLAY = 0x1b,
d00b0b3f	51	CIRRUS_CR_EXTENDED_OVERLAY = 0x1d,
94bf3dd5 VS	52	CIRRUS_CR_MAX
	53	};
	54
d00b0b3f VS	55	#define CIRRUS_CR_EXTENDED_DISPLAY_PITCH_MASK 0x10
	56	#define CIRRUS_CR_EXTENDED_DISPLAY_PITCH_SHIFT 4
	57	#define CIRRUS_CR_EXTENDED_DISPLAY_START_MASK1 0x1
	58	#define CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT1 16
	59	#define CIRRUS_CR_EXTENDED_DISPLAY_START_MASK2 0xc
	60	#define CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT2 15
	61
	62	#define CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_MASK 0x80
	63	#define CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_SHIFT 12
	64
94bf3dd5 VS	65	enum
94bf3dd5 VS	66	{
94bf3dd5 VS	67	CIRRUS_SR_EXTENDED_MODE = 7,
	68	CIRRUS_SR_MAX
	69	};
967828eb	70
94bf3dd5 VS	71	#define CIRRUS_SR_EXTENDED_MODE_LFB_ENABLE 0xf0
94bf3dd5 VS	72	#define CIRRUS_SR_EXTENDED_MODE_ENABLE_EXT 0x01
31e0ce4d	73	#define CIRRUS_SR_EXTENDED_MODE_8BPP 0x00
94bf3dd5	74	#define CIRRUS_SR_EXTENDED_MODE_16BPP 0x06
31e0ce4d	75	#define CIRRUS_SR_EXTENDED_MODE_24BPP 0x04
94bf3dd5 VS	76	#define CIRRUS_SR_EXTENDED_MODE_32BPP 0x08
94bf3dd5 VS	77
63c1b71c VS	78	#define CIRRUS_HIDDEN_DAC_ENABLE_EXT 0x80
63c1b71c VS	79	#define CIRRUS_HIDDEN_DAC_ENABLE_ALL 0x40
31e0ce4d	80	#define CIRRUS_HIDDEN_DAC_8BPP 0
63c1b71c VS	81	#define CIRRUS_HIDDEN_DAC_15BPP (CIRRUS_HIDDEN_DAC_ENABLE_EXT \
	82	\| CIRRUS_HIDDEN_DAC_ENABLE_ALL \| 0)
	83	#define CIRRUS_HIDDEN_DAC_16BPP (CIRRUS_HIDDEN_DAC_ENABLE_EXT \
	84	\| CIRRUS_HIDDEN_DAC_ENABLE_ALL \| 1)
	85	#define CIRRUS_HIDDEN_DAC_888COLOR (CIRRUS_HIDDEN_DAC_ENABLE_EXT \
	86	\| CIRRUS_HIDDEN_DAC_ENABLE_ALL \| 5)
	87
94bf3dd5 VS	88	static void
	89	write_hidden_dac (grub_uint8_t data)
	90	{
967828eb VS	91	grub_inb (GRUB_VGA_IO_PALLETTE_WRITE_INDEX);
	92	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	93	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	94	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	95	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	96	grub_outb (data, GRUB_VGA_IO_PIXEL_MASK);
94bf3dd5 VS	97	}
	98
	99	static grub_uint8_t
	100	read_hidden_dac (void)
	101	{
967828eb VS	102	grub_inb (GRUB_VGA_IO_PALLETTE_WRITE_INDEX);
	103	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	104	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	105	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	106	grub_inb (GRUB_VGA_IO_PIXEL_MASK);
	107	return grub_inb (GRUB_VGA_IO_PIXEL_MASK);
94bf3dd5 VS	108	}
	109
	110	struct saved_state
	111	{
	112	grub_uint8_t cr[CIRRUS_CR_MAX];
967828eb	113	grub_uint8_t gr[GRUB_VGA_GR_MAX];
94bf3dd5 VS	114	grub_uint8_t sr[CIRRUS_SR_MAX];
	115	grub_uint8_t hidden_dac;
	116	/* We need to preserve VGA font and VGA text. */
	117	grub_uint8_t vram[32 * 4 * 256];
31e0ce4d VS	118	grub_uint8_t r[256];
	119	grub_uint8_t g[256];
	120	grub_uint8_t b[256];
94bf3dd5 VS	121	};
	122
	123	static struct saved_state initial_state;
	124	static int state_saved = 0;
	125
	126	static void
	127	save_state (struct saved_state *st)
	128	{
	129	unsigned i;
	130	for (i = 0; i < ARRAY_SIZE (st->cr); i++)
967828eb	131	st->cr[i] = grub_vga_cr_read (i);
94bf3dd5	132	for (i = 0; i < ARRAY_SIZE (st->sr); i++)
967828eb	133	st->sr[i] = grub_vga_sr_read (i);
94bf3dd5	134	for (i = 0; i < ARRAY_SIZE (st->gr); i++)
967828eb	135	st->gr[i] = grub_vga_gr_read (i);
31e0ce4d	136	for (i = 0; i < 256; i++)
967828eb	137	grub_vga_palette_read (i, st->r + i, st->g + i, st->b + i);
31e0ce4d	138
94bf3dd5	139	st->hidden_dac = read_hidden_dac ();
967828eb	140	grub_vga_sr_write (GRUB_VGA_SR_MEMORY_MODE_CHAIN4, GRUB_VGA_SR_MEMORY_MODE);
94bf3dd5 VS	141	grub_memcpy (st->vram, framebuffer.ptr, sizeof (st->vram));
	142	}
	143
	144	static void
	145	restore_state (struct saved_state *st)
	146	{
	147	unsigned i;
967828eb	148	grub_vga_sr_write (GRUB_VGA_SR_MEMORY_MODE_CHAIN4, GRUB_VGA_SR_MEMORY_MODE);
94bf3dd5 VS	149	grub_memcpy (framebuffer.ptr, st->vram, sizeof (st->vram));
94bf3dd5 VS	150	for (i = 0; i < ARRAY_SIZE (st->cr); i++)
967828eb	151	grub_vga_cr_write (st->cr[i], i);
94bf3dd5	152	for (i = 0; i < ARRAY_SIZE (st->sr); i++)
967828eb	153	grub_vga_sr_write (st->sr[i], i);
94bf3dd5	154	for (i = 0; i < ARRAY_SIZE (st->gr); i++)
967828eb	155	grub_vga_gr_write (st->gr[i], i);
31e0ce4d	156	for (i = 0; i < 256; i++)
967828eb	157	grub_vga_palette_write (i, st->r[i], st->g[i], st->b[i]);
31e0ce4d	158
94bf3dd5 VS	159	write_hidden_dac (st->hidden_dac);
	160	}
	161
	162	static grub_err_t
	163	grub_video_cirrus_video_init (void)
	164	{
	165	/* Reset frame buffer. */
	166	grub_memset (&framebuffer, 0, sizeof(framebuffer));
	167
	168	return grub_video_fb_init ();
	169	}
	170
	171	static grub_err_t
	172	grub_video_cirrus_video_fini (void)
	173	{
	174	if (framebuffer.mapped)
	175	grub_pci_device_unmap_range (framebuffer.dev, framebuffer.ptr,
	176	CIRRUS_APERTURE_SIZE);
	177
	178	if (state_saved)
	179	{
	180	restore_state (&initial_state);
	181	state_saved = 0;
	182	}
	183
	184	return grub_video_fb_fini ();
	185	}
	186
d00b0b3f VS	187	static grub_err_t
	188	doublebuf_pageflipping_set_page (int page)
	189	{
	190	int start = framebuffer.page_size * page / 4;
	191	grub_uint8_t cr_ext, cr_overlay;
	192
967828eb VS	193	grub_vga_cr_write (start & 0xff, GRUB_VGA_CR_START_ADDR_LOW_REGISTER);
	194	grub_vga_cr_write ((start & 0xff00) >> 8,
	195	GRUB_VGA_CR_START_ADDR_HIGH_REGISTER);
d00b0b3f	196
967828eb	197	cr_ext = grub_vga_cr_read (CIRRUS_CR_EXTENDED_DISPLAY);
d00b0b3f VS	198	cr_ext &= ~(CIRRUS_CR_EXTENDED_DISPLAY_START_MASK1
	199	\| CIRRUS_CR_EXTENDED_DISPLAY_START_MASK2);
	200	cr_ext \|= ((start >> CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT1)
	201	& CIRRUS_CR_EXTENDED_DISPLAY_START_MASK1);
	202	cr_ext \|= ((start >> CIRRUS_CR_EXTENDED_DISPLAY_START_SHIFT2)
	203	& CIRRUS_CR_EXTENDED_DISPLAY_START_MASK2);
967828eb	204	grub_vga_cr_write (cr_ext, CIRRUS_CR_EXTENDED_DISPLAY);
d00b0b3f	205
967828eb	206	cr_overlay = grub_vga_cr_read (CIRRUS_CR_EXTENDED_OVERLAY);
d00b0b3f VS	207	cr_overlay &= ~(CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_MASK);
	208	cr_overlay \|= ((start >> CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_SHIFT)
	209	& CIRRUS_CR_EXTENDED_OVERLAY_DISPLAY_START_MASK);
967828eb	210	grub_vga_cr_write (cr_overlay, CIRRUS_CR_EXTENDED_OVERLAY);
d00b0b3f VS	211
	212	return GRUB_ERR_NONE;
	213	}
	214
31e0ce4d VS	215	static grub_err_t
	216	grub_video_cirrus_set_palette (unsigned int start, unsigned int count,
	217	struct grub_video_palette_data *palette_data)
	218	{
	219	if (framebuffer.mode_info.mode_type == GRUB_VIDEO_MODE_TYPE_INDEX_COLOR)
	220	{
	221	unsigned i;
	222	if (start >= 0x100)
	223	return GRUB_ERR_NONE;
	224	if (start + count >= 0x100)
	225	count = 0x100 - start;
	226
	227	for (i = 0; i < count; i++)
967828eb VS	228	grub_vga_palette_write (start + i, palette_data[i].r, palette_data[i].g,
967828eb VS	229	palette_data[i].b);
31e0ce4d VS	230	}
	231
	232	/* Then set color to emulated palette. */
	233	return grub_video_fb_set_palette (start, count, palette_data);
	234	}
	235
94bf3dd5 VS	236	static grub_err_t
94bf3dd5 VS	237	grub_video_cirrus_setup (unsigned int width, unsigned int height,
31e0ce4d	238	unsigned int mode_type, unsigned int mode_mask)
94bf3dd5 VS	239	{
	240	int depth;
	241	grub_err_t err;
	242	int found = 0;
	243	int pitch, bytes_per_pixel;
	244
	245	auto int NESTED_FUNC_ATTR find_card (grub_pci_device_t dev, grub_pci_id_t pciid __attribute__ ((unused)));
	246	int NESTED_FUNC_ATTR find_card (grub_pci_device_t dev, grub_pci_id_t pciid)
	247	{
	248	grub_pci_address_t addr;
	249	grub_uint32_t class;
	250
	251	addr = grub_pci_make_address (dev, GRUB_PCI_REG_CLASS);
	252	class = grub_pci_read (addr);
	253
	254	if (((class >> 16) & 0xffff) != 0x0300 \|\| pciid != 0x00b81013)
	255	return 0;
	256
	257	found = 1;
	258
	259	addr = grub_pci_make_address (dev, GRUB_PCI_REG_ADDRESS_REG0);
	260	framebuffer.base = grub_pci_read (addr) & GRUB_PCI_ADDR_MEM_MASK;
	261	framebuffer.dev = dev;
	262
	263	return 1;
	264	}
	265
	266	/* Decode depth from mode_type. If it is zero, then autodetect. */
	267	depth = (mode_type & GRUB_VIDEO_MODE_TYPE_DEPTH_MASK)
	268	>> GRUB_VIDEO_MODE_TYPE_DEPTH_POS;
	269
	270	if (width == 0 \|\| height == 0)
	271	{
	272	width = 800;
	273	height = 600;
	274	}
	275
967828eb	276	if (width & (GRUB_VGA_CR_WIDTH_DIVISOR - 1))
94bf3dd5 VS	277	return grub_error (GRUB_ERR_IO,
94bf3dd5 VS	278	"screen width must be a multiple of %d",
967828eb	279	GRUB_VGA_CR_WIDTH_DIVISOR);
94bf3dd5 VS	280
	281	if (width > CIRRUS_MAX_WIDTH)
	282	return grub_error (GRUB_ERR_IO,
	283	"screen width must be at most %d", CIRRUS_MAX_WIDTH);
	284
	285	if (height > CIRRUS_MAX_HEIGHT)
	286	return grub_error (GRUB_ERR_IO,
	287	"screen height must be at most %d", CIRRUS_MAX_HEIGHT);
	288
31e0ce4d VS	289	if (depth == 0
	290	&& !grub_video_check_mode_flag (mode_type, mode_mask,
	291	GRUB_VIDEO_MODE_TYPE_INDEX_COLOR, 0))
94bf3dd5 VS	292	depth = 24;
94bf3dd5 VS	293
31e0ce4d VS	294	if (depth == 0)
	295	depth = 8;
	296
	297	if (depth != 32 && depth != 24 && depth != 16 && depth != 15 && depth != 8)
	298	return grub_error (GRUB_ERR_IO, "only 32, 24, 16, 15 and 8-bit bpp are"
	299	" supported by cirrus video");
94bf3dd5 VS	300
	301	bytes_per_pixel = (depth + 7) / 8;
	302	pitch = width * bytes_per_pixel;
	303
	304	if (pitch > CIRRUS_MAX_PITCH)
	305	return grub_error (GRUB_ERR_IO,
	306	"screen width must be at most %d at bitdepth %d",
	307	CIRRUS_MAX_PITCH / bytes_per_pixel, depth);
	308
d00b0b3f VS	309	framebuffer.page_size = pitch * height;
	310
	311	if (framebuffer.page_size > CIRRUS_APERTURE_SIZE)
	312	return grub_error (GRUB_ERR_IO, "Not enough video memory for this mode");
	313
94bf3dd5 VS	314	grub_pci_iterate (find_card);
	315	if (!found)
	316	return grub_error (GRUB_ERR_IO, "Couldn't find graphics card");
	317
	318	if (found && framebuffer.base == 0)
	319	{
	320	/* FIXME: change framebuffer base */
d00b0b3f	321	return grub_error (GRUB_ERR_IO, "PCI BAR not set");
94bf3dd5 VS	322	}
	323
	324	/* We can safely discard volatile attribute. */
	325	framebuffer.ptr = (void *) grub_pci_device_map_range (framebuffer.dev,
	326	framebuffer.base,
	327	CIRRUS_APERTURE_SIZE);
	328	framebuffer.mapped = 1;
	329
	330	if (!state_saved)
	331	{
	332	save_state (&initial_state);
	333	state_saved = 1;
	334	}
	335
	336	{
f947ab49 VS	337	struct grub_video_hw_config config = {
	338	.pitch = pitch / GRUB_VGA_CR_PITCH_DIVISOR,
	339	.line_compare = 0x3ff,
	340	.vdisplay_end = height - 1,
	341	.horizontal_end = width / GRUB_VGA_CR_WIDTH_DIVISOR
	342	};
63c1b71c	343	grub_uint8_t sr_ext = 0, hidden_dac = 0;
94bf3dd5	344
f947ab49 VS	345	grub_vga_set_geometry (&config, grub_vga_cr_write);
f947ab49 VS	346
967828eb VS	347	grub_vga_gr_write (GRUB_VGA_GR_MODE_256_COLOR \| GRUB_VGA_GR_MODE_READ_MODE1,
	348	GRUB_VGA_GR_MODE);
	349	grub_vga_gr_write (GRUB_VGA_GR_GR6_GRAPHICS_MODE, GRUB_VGA_GR_GR6);
94bf3dd5	350
967828eb	351	grub_vga_sr_write (GRUB_VGA_SR_MEMORY_MODE_NORMAL, GRUB_VGA_SR_MEMORY_MODE);
94bf3dd5	352
f947ab49	353	grub_vga_cr_write ((config.pitch >> CIRRUS_CR_EXTENDED_DISPLAY_PITCH_SHIFT)
94bf3dd5 VS	354	& CIRRUS_CR_EXTENDED_DISPLAY_PITCH_MASK,
	355	CIRRUS_CR_EXTENDED_DISPLAY);
	356
967828eb VS	357	grub_vga_cr_write (GRUB_VGA_CR_MODE_TIMING_ENABLE
	358	\| GRUB_VGA_CR_MODE_BYTE_MODE
	359	\| GRUB_VGA_CR_MODE_NO_HERCULES \| GRUB_VGA_CR_MODE_NO_CGA,
	360	GRUB_VGA_CR_MODE);
94bf3dd5	361
d00b0b3f VS	362	doublebuf_pageflipping_set_page (0);
d00b0b3f VS	363
94bf3dd5 VS	364	sr_ext = CIRRUS_SR_EXTENDED_MODE_LFB_ENABLE
	365	\| CIRRUS_SR_EXTENDED_MODE_ENABLE_EXT;
	366	switch (depth)
	367	{
63c1b71c	368	/* FIXME: support 8-bit grayscale and 8-bit RGB. */
94bf3dd5	369	case 32:
63c1b71c	370	hidden_dac = CIRRUS_HIDDEN_DAC_888COLOR;
94bf3dd5 VS	371	sr_ext \|= CIRRUS_SR_EXTENDED_MODE_32BPP;
	372	break;
	373	case 24:
63c1b71c	374	hidden_dac = CIRRUS_HIDDEN_DAC_888COLOR;
94bf3dd5 VS	375	sr_ext \|= CIRRUS_SR_EXTENDED_MODE_24BPP;
	376	break;
	377	case 16:
63c1b71c VS	378	hidden_dac = CIRRUS_HIDDEN_DAC_16BPP;
	379	sr_ext \|= CIRRUS_SR_EXTENDED_MODE_16BPP;
	380	break;
94bf3dd5	381	case 15:
63c1b71c	382	hidden_dac = CIRRUS_HIDDEN_DAC_15BPP;
94bf3dd5 VS	383	sr_ext \|= CIRRUS_SR_EXTENDED_MODE_16BPP;
94bf3dd5 VS	384	break;
31e0ce4d VS	385	case 8:
	386	hidden_dac = CIRRUS_HIDDEN_DAC_8BPP;
	387	sr_ext \|= CIRRUS_SR_EXTENDED_MODE_8BPP;
	388	break;
94bf3dd5	389	}
967828eb	390	grub_vga_sr_write (sr_ext, CIRRUS_SR_EXTENDED_MODE);
63c1b71c	391	write_hidden_dac (hidden_dac);
94bf3dd5 VS	392	}
	393
	394	/* Fill mode info details. */
	395	framebuffer.mode_info.width = width;
	396	framebuffer.mode_info.height = height;
	397	framebuffer.mode_info.mode_type = GRUB_VIDEO_MODE_TYPE_RGB;
	398	framebuffer.mode_info.bpp = depth;
	399	framebuffer.mode_info.bytes_per_pixel = bytes_per_pixel;
	400	framebuffer.mode_info.pitch = pitch;
	401	framebuffer.mode_info.number_of_colors = 256;
	402	framebuffer.mode_info.reserved_mask_size = 0;
	403	framebuffer.mode_info.reserved_field_pos = 0;
	404
	405	switch (depth)
	406	{
31e0ce4d VS	407	case 8:
	408	framebuffer.mode_info.mode_type = GRUB_VIDEO_MODE_TYPE_INDEX_COLOR;
	409	break;
94bf3dd5 VS	410	case 16:
	411	framebuffer.mode_info.red_mask_size = 5;
	412	framebuffer.mode_info.red_field_pos = 11;
	413	framebuffer.mode_info.green_mask_size = 6;
	414	framebuffer.mode_info.green_field_pos = 5;
	415	framebuffer.mode_info.blue_mask_size = 5;
	416	framebuffer.mode_info.blue_field_pos = 0;
	417	break;
	418
	419	case 15:
	420	framebuffer.mode_info.red_mask_size = 5;
	421	framebuffer.mode_info.red_field_pos = 10;
	422	framebuffer.mode_info.green_mask_size = 5;
	423	framebuffer.mode_info.green_field_pos = 5;
	424	framebuffer.mode_info.blue_mask_size = 5;
	425	framebuffer.mode_info.blue_field_pos = 0;
	426	break;
	427
	428	case 32:
	429	framebuffer.mode_info.reserved_mask_size = 8;
	430	framebuffer.mode_info.reserved_field_pos = 24;
	431
	432	case 24:
	433	framebuffer.mode_info.red_mask_size = 8;
	434	framebuffer.mode_info.red_field_pos = 16;
	435	framebuffer.mode_info.green_mask_size = 8;
	436	framebuffer.mode_info.green_field_pos = 8;
	437	framebuffer.mode_info.blue_mask_size = 8;
	438	framebuffer.mode_info.blue_field_pos = 0;
	439	break;
	440	}
	441
	442	framebuffer.mode_info.blit_format = grub_video_get_blit_format (&framebuffer.mode_info);
	443
d00b0b3f VS	444	if (CIRRUS_APERTURE_SIZE >= 2 * framebuffer.page_size)
	445	err = grub_video_fb_setup (mode_type, mode_mask,
	446	&framebuffer.mode_info,
	447	framebuffer.ptr,
	448	doublebuf_pageflipping_set_page,
	449	framebuffer.ptr + framebuffer.page_size);
	450	else
	451	err = grub_video_fb_setup (mode_type, mode_mask,
	452	&framebuffer.mode_info,
	453	framebuffer.ptr, 0, 0);
94bf3dd5	454
94bf3dd5 VS	455
94bf3dd5 VS	456	/* Copy default palette to initialize emulated palette. */
31e0ce4d VS	457	err = grub_video_cirrus_set_palette (0, GRUB_VIDEO_FBSTD_NUMCOLORS,
31e0ce4d VS	458	grub_video_fbstd_colors);
94bf3dd5 VS	459	return err;
	460	}
	461
94bf3dd5 VS	462	static struct grub_video_adapter grub_video_cirrus_adapter =
	463	{
	464	.name = "Cirrus CLGD 5446 PCI Video Driver",
	465	.id = GRUB_VIDEO_DRIVER_CIRRUS,
	466
05e51879 VS	467	.prio = GRUB_VIDEO_ADAPTER_PRIO_NATIVE,
05e51879 VS	468
94bf3dd5 VS	469	.init = grub_video_cirrus_video_init,
	470	.fini = grub_video_cirrus_video_fini,
	471	.setup = grub_video_cirrus_setup,
	472	.get_info = grub_video_fb_get_info,
d00b0b3f	473	.get_info_and_fini = grub_video_fb_get_info_and_fini,
94bf3dd5 VS	474	.set_palette = grub_video_cirrus_set_palette,
	475	.get_palette = grub_video_fb_get_palette,
	476	.set_viewport = grub_video_fb_set_viewport,
	477	.get_viewport = grub_video_fb_get_viewport,
	478	.map_color = grub_video_fb_map_color,
	479	.map_rgb = grub_video_fb_map_rgb,
	480	.map_rgba = grub_video_fb_map_rgba,
	481	.unmap_color = grub_video_fb_unmap_color,
	482	.fill_rect = grub_video_fb_fill_rect,
	483	.blit_bitmap = grub_video_fb_blit_bitmap,
	484	.blit_render_target = grub_video_fb_blit_render_target,
	485	.scroll = grub_video_fb_scroll,
d00b0b3f	486	.swap_buffers = grub_video_fb_swap_buffers,
94bf3dd5 VS	487	.create_render_target = grub_video_fb_create_render_target,
94bf3dd5 VS	488	.delete_render_target = grub_video_fb_delete_render_target,
d00b0b3f	489	.set_active_render_target = grub_video_fb_set_active_render_target,
94bf3dd5 VS	490	.get_active_render_target = grub_video_fb_get_active_render_target,
	491
	492	.next = 0
	493	};
	494
	495	GRUB_MOD_INIT(video_cirrus)
	496	{
	497	grub_video_register (&grub_video_cirrus_adapter);
	498	}
	499
	500	GRUB_MOD_FINI(video_cirrus)
	501	{
	502	grub_video_unregister (&grub_video_cirrus_adapter);
	503	}