drivers/video/console/sticore.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  linux/drivers/video/console/sticore.c -
   4  *      core code for console driver using HP's STI firmware
   5  *
   6  *      Copyright (C) 2000 Philipp Rumpf <prumpf@tux.org>
   7  *      Copyright (C) 2001-2020 Helge Deller <deller@gmx.de>
   8  *      Copyright (C) 2001-2002 Thomas Bogendoerfer <tsbogend@alpha.franken.de>
   9  *
  10  * TODO:
  11  * - call STI in virtual mode rather than in real mode
  12  * - screen blanking with state_mgmt() in text mode STI ?
  13  * - try to make it work on m68k hp workstations ;)
  14  *
  15  */
  16
  17 #define pr_fmt(fmt) "%s: " fmt, KBUILD_MODNAME
  18
  19 #include <linux/module.h>
  20 #include <linux/types.h>
  21 #include <linux/kernel.h>
  22 #include <linux/slab.h>
  23 #include <linux/init.h>
  24 #include <linux/pci.h>
  25 #include <linux/font.h>
  26
  27 #include <asm/hardware.h>
  28 #include <asm/page.h>
  29 #include <asm/parisc-device.h>
  30 #include <asm/pdc.h>
  31 #include <asm/cacheflush.h>
  32 #include <asm/grfioctl.h>
  33
  34 #include "../fbdev/sticore.h"
  35
  36 #define STI_DRIVERVERSION "Version 0.9b"
  37
  38 static struct sti_struct *default_sti __read_mostly;
  39
  40 /* number of STI ROMS found and their ptrs to each struct */
  41 static int num_sti_roms __read_mostly;
  42 static struct sti_struct *sti_roms[MAX_STI_ROMS] __read_mostly;
  43
  44
  45 /* The colour indices used by STI are
  46  *   0 - Black
  47  *   1 - White
  48  *   2 - Red
  49  *   3 - Yellow/Brown
  50  *   4 - Green
  51  *   5 - Cyan
  52  *   6 - Blue
  53  *   7 - Magenta
  54  *
  55  * So we have the same colours as VGA (basically one bit each for R, G, B),
  56  * but have to translate them, anyway. */
  57
  58 static const u8 col_trans[8] = {
  59         0, 6, 4, 5,
  60         2, 7, 3, 1
  61 };
  62
  63 #define c_fg(sti, c) col_trans[((c>> 8) & 7)]
  64 #define c_bg(sti, c) col_trans[((c>>11) & 7)]
  65 #define c_index(sti, c) ((c) & 0xff)
  66
  67 static const struct sti_init_flags default_init_flags = {
  68         .wait   = STI_WAIT,
  69         .reset  = 1,
  70         .text   = 1,
  71         .nontext = 1,
  72         .no_chg_bet = 1,
  73         .no_chg_bei = 1,
  74         .init_cmap_tx = 1,
  75 };
  76
  77 static int sti_init_graph(struct sti_struct *sti)
  78 {
  79         struct sti_init_inptr *inptr = &sti->sti_data->init_inptr;
  80         struct sti_init_inptr_ext *inptr_ext = &sti->sti_data->init_inptr_ext;
  81         struct sti_init_outptr *outptr = &sti->sti_data->init_outptr;
  82         unsigned long flags;
  83         int ret, err;
  84
  85         spin_lock_irqsave(&sti->lock, flags);
  86
  87         memset(inptr, 0, sizeof(*inptr));
  88         inptr->text_planes = 3; /* # of text planes (max 3 for STI) */
  89         memset(inptr_ext, 0, sizeof(*inptr_ext));
  90         inptr->ext_ptr = STI_PTR(inptr_ext);
  91         outptr->errno = 0;
  92
  93         ret = sti_call(sti, sti->init_graph, &default_init_flags, inptr,
  94                 outptr, sti->glob_cfg);
  95
  96         if (ret >= 0)
  97                 sti->text_planes = outptr->text_planes;
  98         err = outptr->errno;
  99
 100         spin_unlock_irqrestore(&sti->lock, flags);
 101
 102         if (ret < 0) {
 103                 pr_err("STI init_graph failed (ret %d, errno %d)\n", ret, err);
 104                 return -1;
 105         }
 106
 107         return 0;
 108 }
 109
 110 static const struct sti_conf_flags default_conf_flags = {
 111         .wait   = STI_WAIT,
 112 };
 113
 114 static void sti_inq_conf(struct sti_struct *sti)
 115 {
 116         struct sti_conf_inptr *inptr = &sti->sti_data->inq_inptr;
 117         struct sti_conf_outptr *outptr = &sti->sti_data->inq_outptr;
 118         unsigned long flags;
 119         s32 ret;
 120
 121         outptr->ext_ptr = STI_PTR(&sti->sti_data->inq_outptr_ext);
 122
 123         do {
 124                 spin_lock_irqsave(&sti->lock, flags);
 125                 memset(inptr, 0, sizeof(*inptr));
 126                 ret = sti_call(sti, sti->inq_conf, &default_conf_flags,
 127                         inptr, outptr, sti->glob_cfg);
 128                 spin_unlock_irqrestore(&sti->lock, flags);
 129         } while (ret == 1);
 130 }
 131
 132 static const struct sti_font_flags default_font_flags = {
 133         .wait           = STI_WAIT,
 134         .non_text       = 0,
 135 };
 136
 137 void
 138 sti_putc(struct sti_struct *sti, int c, int y, int x,
 139          struct sti_cooked_font *font)
 140 {
 141         struct sti_font_inptr *inptr = &sti->sti_data->font_inptr;
 142         struct sti_font_inptr inptr_default = {
 143                 .font_start_addr = STI_PTR(font->raw),
 144                 .index          = c_index(sti, c),
 145                 .fg_color       = c_fg(sti, c),
 146                 .bg_color       = c_bg(sti, c),
 147                 .dest_x         = x * font->width,
 148                 .dest_y         = y * font->height,
 149         };
 150         struct sti_font_outptr *outptr = &sti->sti_data->font_outptr;
 151         s32 ret;
 152         unsigned long flags;
 153
 154         do {
 155                 spin_lock_irqsave(&sti->lock, flags);
 156                 *inptr = inptr_default;
 157                 ret = sti_call(sti, sti->font_unpmv, &default_font_flags,
 158                         inptr, outptr, sti->glob_cfg);
 159                 spin_unlock_irqrestore(&sti->lock, flags);
 160         } while (ret == 1);
 161 }
 162
 163 static const struct sti_blkmv_flags clear_blkmv_flags = {
 164         .wait   = STI_WAIT,
 165         .color  = 1,
 166         .clear  = 1,
 167 };
 168
 169 void
 170 sti_set(struct sti_struct *sti, int src_y, int src_x,
 171         int height, int width, u8 color)
 172 {
 173         struct sti_blkmv_inptr *inptr = &sti->sti_data->blkmv_inptr;
 174         struct sti_blkmv_inptr inptr_default = {
 175                 .fg_color       = color,
 176                 .bg_color       = color,
 177                 .src_x          = src_x,
 178                 .src_y          = src_y,
 179                 .dest_x         = src_x,
 180                 .dest_y         = src_y,
 181                 .width          = width,
 182                 .height         = height,
 183         };
 184         struct sti_blkmv_outptr *outptr = &sti->sti_data->blkmv_outptr;
 185         s32 ret;
 186         unsigned long flags;
 187
 188         do {
 189                 spin_lock_irqsave(&sti->lock, flags);
 190                 *inptr = inptr_default;
 191                 ret = sti_call(sti, sti->block_move, &clear_blkmv_flags,
 192                         inptr, outptr, sti->glob_cfg);
 193                 spin_unlock_irqrestore(&sti->lock, flags);
 194         } while (ret == 1);
 195 }
 196
 197 void
 198 sti_clear(struct sti_struct *sti, int src_y, int src_x,
 199           int height, int width, int c, struct sti_cooked_font *font)
 200 {
 201         struct sti_blkmv_inptr *inptr = &sti->sti_data->blkmv_inptr;
 202         struct sti_blkmv_inptr inptr_default = {
 203                 .fg_color       = c_fg(sti, c),
 204                 .bg_color       = c_bg(sti, c),
 205                 .src_x          = src_x * font->width,
 206                 .src_y          = src_y * font->height,
 207                 .dest_x         = src_x * font->width,
 208                 .dest_y         = src_y * font->height,
 209                 .width          = width * font->width,
 210                 .height         = height * font->height,
 211         };
 212         struct sti_blkmv_outptr *outptr = &sti->sti_data->blkmv_outptr;
 213         s32 ret;
 214         unsigned long flags;
 215
 216         do {
 217                 spin_lock_irqsave(&sti->lock, flags);
 218                 *inptr = inptr_default;
 219                 ret = sti_call(sti, sti->block_move, &clear_blkmv_flags,
 220                         inptr, outptr, sti->glob_cfg);
 221                 spin_unlock_irqrestore(&sti->lock, flags);
 222         } while (ret == 1);
 223 }
 224
 225 static const struct sti_blkmv_flags default_blkmv_flags = {
 226         .wait = STI_WAIT,
 227 };
 228
 229 void
 230 sti_bmove(struct sti_struct *sti, int src_y, int src_x,
 231           int dst_y, int dst_x, int height, int width,
 232           struct sti_cooked_font *font)
 233 {
 234         struct sti_blkmv_inptr *inptr = &sti->sti_data->blkmv_inptr;
 235         struct sti_blkmv_inptr inptr_default = {
 236                 .src_x          = src_x * font->width,
 237                 .src_y          = src_y * font->height,
 238                 .dest_x         = dst_x * font->width,
 239                 .dest_y         = dst_y * font->height,
 240                 .width          = width * font->width,
 241                 .height         = height * font->height,
 242         };
 243         struct sti_blkmv_outptr *outptr = &sti->sti_data->blkmv_outptr;
 244         s32 ret;
 245         unsigned long flags;
 246
 247         do {
 248                 spin_lock_irqsave(&sti->lock, flags);
 249                 *inptr = inptr_default;
 250                 ret = sti_call(sti, sti->block_move, &default_blkmv_flags,
 251                         inptr, outptr, sti->glob_cfg);
 252                 spin_unlock_irqrestore(&sti->lock, flags);
 253         } while (ret == 1);
 254 }
 255
 256
 257 static void sti_flush(unsigned long start, unsigned long end)
 258 {
 259         flush_icache_range(start, end);
 260 }
 261
 262 static void sti_rom_copy(unsigned long base, unsigned long count, void *dest)
 263 {
 264         unsigned long dest_start = (unsigned long) dest;
 265
 266         /* this still needs to be revisited (see arch/parisc/mm/init.c:246) ! */
 267         while (count >= 4) {
 268                 count -= 4;
 269                 *(u32 *)dest = gsc_readl(base);
 270                 base += 4;
 271                 dest += 4;
 272         }
 273         while (count) {
 274                 count--;
 275                 *(u8 *)dest = gsc_readb(base);
 276                 base++;
 277                 dest++;
 278         }
 279
 280         sti_flush(dest_start, (unsigned long)dest);
 281 }
 282
 283
 284
 285
 286 static char default_sti_path[21] __read_mostly;
 287
 288 #ifndef MODULE
 289 static int __init sti_setup(char *str)
 290 {
 291         if (str)
 292                 strlcpy (default_sti_path, str, sizeof (default_sti_path));
 293
 294         return 1;
 295 }
 296
 297 /*      Assuming the machine has multiple STI consoles (=graphic cards) which
 298  *      all get detected by sticon, the user may define with the linux kernel
 299  *      parameter sti=<x> which of them will be the initial boot-console.
 300  *      <x> is a number between 0 and MAX_STI_ROMS, with 0 as the default
 301  *      STI screen.
 302  */
 303 __setup("sti=", sti_setup);
 304 #endif
 305
 306
 307
 308 static char *font_name;
 309 static int font_index,
 310            font_height,
 311            font_width;
 312 #ifndef MODULE
 313 static int sti_font_setup(char *str)
 314 {
 315         /*
 316          * The default font can be selected in various ways.
 317          * a) sti_font=VGA8x16, sti_font=10x20, sti_font=10*20 selects
 318          *    an built-in Linux framebuffer font.
 319          * b) sti_font=<index>, where index is (1..x) with 1 selecting
 320          *    the first HP STI ROM built-in font..
 321          */
 322
 323         if (*str >= '0' && *str <= '9') {
 324                 char *x;
 325
 326                 if ((x = strchr(str, 'x')) || (x = strchr(str, '*'))) {
 327                         font_height = simple_strtoul(str, NULL, 0);
 328                         font_width = simple_strtoul(x+1, NULL, 0);
 329                 } else {
 330                         font_index = simple_strtoul(str, NULL, 0);
 331                 }
 332         } else {
 333                 font_name = str;        /* fb font name */
 334         }
 335
 336         return 1;
 337 }
 338
 339 /*      The optional linux kernel parameter "sti_font" defines which font
 340  *      should be used by the sticon driver to draw characters to the screen.
 341  *      Possible values are:
 342  *      - sti_font=<fb_fontname>:
 343  *              <fb_fontname> is the name of one of the linux-kernel built-in
 344  *              framebuffer font names (e.g. VGA8x16, SUN22x18).
 345  *              This is only available if the fonts have been statically compiled
 346  *              in with e.g. the CONFIG_FONT_8x16 or CONFIG_FONT_SUN12x22 options.
 347  *      - sti_font=<number>     (<number> = 1,2,3,...)
 348  *              most STI ROMs have built-in HP specific fonts, which can be selected
 349  *              by giving the desired number to the sticon driver.
 350  *              NOTE: This number is machine and STI ROM dependend.
 351  *      - sti_font=<height>x<width>  (e.g. sti_font=16x8)
 352  *              <height> and <width> gives hints to the height and width of the
 353  *              font which the user wants. The sticon driver will try to use
 354  *              a font with this height and width, but if no suitable font is
 355  *              found, sticon will use the default 8x8 font.
 356  */
 357 __setup("sti_font=", sti_font_setup);
 358 #endif
 359
 360
 361
 362 static void sti_dump_globcfg(struct sti_glob_cfg *glob_cfg,
 363                              unsigned int sti_mem_request)
 364 {
 365         struct sti_glob_cfg_ext *cfg;
 366
 367         pr_debug("%d text planes\n"
 368                 "%4d x %4d screen resolution\n"
 369                 "%4d x %4d offscreen\n"
 370                 "%4d x %4d layout\n"
 371                 "regions at %08x %08x %08x %08x\n"
 372                 "regions at %08x %08x %08x %08x\n"
 373                 "reent_lvl %d\n"
 374                 "save_addr %08x\n",
 375                 glob_cfg->text_planes,
 376                 glob_cfg->onscreen_x, glob_cfg->onscreen_y,
 377                 glob_cfg->offscreen_x, glob_cfg->offscreen_y,
 378                 glob_cfg->total_x, glob_cfg->total_y,
 379                 glob_cfg->region_ptrs[0], glob_cfg->region_ptrs[1],
 380                 glob_cfg->region_ptrs[2], glob_cfg->region_ptrs[3],
 381                 glob_cfg->region_ptrs[4], glob_cfg->region_ptrs[5],
 382                 glob_cfg->region_ptrs[6], glob_cfg->region_ptrs[7],
 383                 glob_cfg->reent_lvl,
 384                 glob_cfg->save_addr);
 385
 386         /* dump extended cfg */
 387         cfg = PTR_STI((unsigned long)glob_cfg->ext_ptr);
 388         pr_debug("monitor %d\n"
 389                 "in friendly mode: %d\n"
 390                 "power consumption %d watts\n"
 391                 "freq ref %d\n"
 392                 "sti_mem_addr %08x (size=%d bytes)\n",
 393                 cfg->curr_mon,
 394                 cfg->friendly_boot,
 395                 cfg->power,
 396                 cfg->freq_ref,
 397                 cfg->sti_mem_addr, sti_mem_request);
 398 }
 399
 400 static void sti_dump_outptr(struct sti_struct *sti)
 401 {
 402         pr_debug("%d bits per pixel\n"
 403                 "%d used bits\n"
 404                 "%d planes\n"
 405                 "attributes %08x\n",
 406                  sti->sti_data->inq_outptr.bits_per_pixel,
 407                  sti->sti_data->inq_outptr.bits_used,
 408                  sti->sti_data->inq_outptr.planes,
 409                  sti->sti_data->inq_outptr.attributes);
 410 }
 411
 412 static int sti_init_glob_cfg(struct sti_struct *sti, unsigned long rom_address,
 413                              unsigned long hpa)
 414 {
 415         struct sti_glob_cfg *glob_cfg;
 416         struct sti_glob_cfg_ext *glob_cfg_ext;
 417         void *save_addr;
 418         void *sti_mem_addr;
 419         int i, size;
 420
 421         if (sti->sti_mem_request < 256)
 422                 sti->sti_mem_request = 256; /* STI default */
 423
 424         size = sizeof(struct sti_all_data) + sti->sti_mem_request - 256;
 425
 426         sti->sti_data = kzalloc(size, STI_LOWMEM);
 427         if (!sti->sti_data)
 428                 return -ENOMEM;
 429
 430         glob_cfg        = &sti->sti_data->glob_cfg;
 431         glob_cfg_ext    = &sti->sti_data->glob_cfg_ext;
 432         save_addr       = &sti->sti_data->save_addr;
 433         sti_mem_addr    = &sti->sti_data->sti_mem_addr;
 434
 435         glob_cfg->ext_ptr = STI_PTR(glob_cfg_ext);
 436         glob_cfg->save_addr = STI_PTR(save_addr);
 437         for (i=0; i<8; i++) {
 438                 unsigned long newhpa, len;
 439
 440                 if (sti->pd) {
 441                         unsigned char offs = sti->rm_entry[i];
 442
 443                         if (offs == 0)
 444                                 continue;
 445                         if (offs != PCI_ROM_ADDRESS &&
 446                             (offs < PCI_BASE_ADDRESS_0 ||
 447                              offs > PCI_BASE_ADDRESS_5)) {
 448                                 pr_warn("STI pci region mapping for region %d (%02x) can't be mapped\n",
 449                                         i,sti->rm_entry[i]);
 450                                 continue;
 451                         }
 452                         newhpa = pci_resource_start (sti->pd, (offs - PCI_BASE_ADDRESS_0) / 4);
 453                 } else
 454                         newhpa = (i == 0) ? rom_address : hpa;
 455
 456                 sti->regions_phys[i] =
 457                         REGION_OFFSET_TO_PHYS(sti->regions[i], newhpa);
 458
 459                 len = sti->regions[i].region_desc.length * 4096;
 460                 if (len)
 461                         glob_cfg->region_ptrs[i] = sti->regions_phys[i];
 462
 463                 pr_debug("region #%d: phys %08lx, region_ptr %08x, len=%lukB, "
 464                          "btlb=%d, sysonly=%d, cache=%d, last=%d\n",
 465                         i, sti->regions_phys[i], glob_cfg->region_ptrs[i],
 466                         len/1024,
 467                         sti->regions[i].region_desc.btlb,
 468                         sti->regions[i].region_desc.sys_only,
 469                         sti->regions[i].region_desc.cache,
 470                         sti->regions[i].region_desc.last);
 471
 472                 /* last entry reached ? */
 473                 if (sti->regions[i].region_desc.last)
 474                         break;
 475         }
 476
 477         if (++i<8 && sti->regions[i].region)
 478                 pr_warn("future ptr (0x%8x) not yet supported !\n",
 479                         sti->regions[i].region);
 480
 481         glob_cfg_ext->sti_mem_addr = STI_PTR(sti_mem_addr);
 482
 483         sti->glob_cfg = glob_cfg;
 484
 485         return 0;
 486 }
 487
 488 #ifdef CONFIG_FONT_SUPPORT
 489 static struct sti_cooked_font *
 490 sti_select_fbfont(struct sti_cooked_rom *cooked_rom, const char *fbfont_name)
 491 {
 492         const struct font_desc *fbfont = NULL;
 493         unsigned int size, bpc;
 494         void *dest;
 495         struct sti_rom_font *nf;
 496         struct sti_cooked_font *cooked_font;
 497
 498         if (fbfont_name && strlen(fbfont_name))
 499                 fbfont = find_font(fbfont_name);
 500         if (!fbfont)
 501                 fbfont = get_default_font(1024,768, ~(u32)0, ~(u32)0);
 502         if (!fbfont)
 503                 return NULL;
 504
 505         pr_info("STI selected %ux%u framebuffer font %s for sticon\n",
 506                         fbfont->width, fbfont->height, fbfont->name);
 507
 508         bpc = ((fbfont->width+7)/8) * fbfont->height;
 509         size = bpc * fbfont->charcount;
 510         size += sizeof(struct sti_rom_font);
 511
 512         nf = kzalloc(size, STI_LOWMEM);
 513         if (!nf)
 514                 return NULL;
 515
 516         nf->first_char = 0;
 517         nf->last_char = fbfont->charcount - 1;
 518         nf->width = fbfont->width;
 519         nf->height = fbfont->height;
 520         nf->font_type = STI_FONT_HPROMAN8;
 521         nf->bytes_per_char = bpc;
 522         nf->next_font = 0;
 523         nf->underline_height = 1;
 524         nf->underline_pos = fbfont->height - nf->underline_height;
 525
 526         dest = nf;
 527         dest += sizeof(struct sti_rom_font);
 528         memcpy(dest, fbfont->data, bpc * fbfont->charcount);
 529
 530         cooked_font = kzalloc(sizeof(*cooked_font), GFP_KERNEL);
 531         if (!cooked_font) {
 532                 kfree(nf);
 533                 return NULL;
 534         }
 535
 536         cooked_font->raw = nf;
 537         cooked_font->raw_ptr = nf;
 538         cooked_font->next_font = NULL;
 539
 540         cooked_rom->font_start = cooked_font;
 541
 542         return cooked_font;
 543 }
 544 #else
 545 static struct sti_cooked_font *
 546 sti_select_fbfont(struct sti_cooked_rom *cooked_rom, const char *fbfont_name)
 547 {
 548         return NULL;
 549 }
 550 #endif
 551
 552 static void sti_dump_font(struct sti_cooked_font *font)
 553 {
 554 #ifdef STI_DUMP_FONT
 555         unsigned char *p = (unsigned char *)font->raw;
 556         int n;
 557
 558         p += sizeof(struct sti_rom_font);
 559         pr_debug("  w %d h %d bpc %d\n", font->width, font->height,
 560                                         font->raw->bytes_per_char);
 561
 562         for (n = 0; n < 256 * font->raw->bytes_per_char; n += 16, p += 16) {
 563                 pr_debug("        0x%02x, 0x%02x, 0x%02x, 0x%02x, 0x%02x, 0x%02x,"
 564                         " 0x%02x, 0x%02x, 0x%02x, 0x%02x, 0x%02x, 0x%02x,"
 565                         " 0x%02x, 0x%02x, 0x%02x, 0x%02x,\n",
 566                         p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
 567                         p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
 568         }
 569 #endif
 570 }
 571
 572 static int sti_search_font(struct sti_cooked_rom *rom, int height, int width)
 573 {
 574         struct sti_cooked_font *font;
 575         int i = 0;
 576
 577         for (font = rom->font_start; font; font = font->next_font, i++) {
 578                 if ((font->raw->width == width) &&
 579                     (font->raw->height == height))
 580                         return i;
 581         }
 582         return 0;
 583 }
 584
 585 static struct sti_cooked_font *sti_select_font(struct sti_cooked_rom *rom)
 586 {
 587         struct sti_cooked_font *font;
 588         int i;
 589
 590         /* check for framebuffer-font first */
 591         if (!font_index) {
 592                 font = sti_select_fbfont(rom, font_name);
 593                 if (font)
 594                         return font;
 595         }
 596
 597         if (font_width && font_height)
 598                 font_index = sti_search_font(rom,
 599                                 font_height, font_width);
 600
 601         for (font = rom->font_start, i = font_index - 1;
 602                 font && (i > 0);
 603                 font = font->next_font, i--);
 604
 605         if (font)
 606                 return font;
 607         else
 608                 return rom->font_start;
 609 }
 610
 611
 612 static void sti_dump_rom(struct sti_struct *sti)
 613 {
 614         struct sti_rom *rom = sti->rom->raw;
 615         struct sti_cooked_font *font_start;
 616         int nr;
 617
 618         pr_info("  id %04x-%04x, conforms to spec rev. %d.%02x\n",
 619                 rom->graphics_id[0],
 620                 rom->graphics_id[1],
 621                 rom->revno[0] >> 4,
 622                 rom->revno[0] & 0x0f);
 623         pr_debug("  supports %d monitors\n", rom->num_mons);
 624         pr_debug("  font start %08x\n", rom->font_start);
 625         pr_debug("  region list %08x\n", rom->region_list);
 626         pr_debug("  init_graph %08x\n", rom->init_graph);
 627         pr_debug("  bus support %02x\n", rom->bus_support);
 628         pr_debug("  ext bus support %02x\n", rom->ext_bus_support);
 629         pr_debug("  alternate code type %d\n", rom->alt_code_type);
 630
 631         font_start = sti->rom->font_start;
 632         nr = 0;
 633         while (font_start) {
 634                 struct sti_rom_font *f = font_start->raw;
 635
 636                 pr_info("    built-in font #%d: size %dx%d, chars %d-%d, bpc %d\n", ++nr,
 637                         f->width, f->height,
 638                         f->first_char, f->last_char, f->bytes_per_char);
 639                 font_start = font_start->next_font;
 640         }
 641 }
 642
 643
 644 static int sti_cook_fonts(struct sti_cooked_rom *cooked_rom,
 645                           struct sti_rom *raw_rom)
 646 {
 647         struct sti_rom_font *raw_font, *font_start;
 648         struct sti_cooked_font *cooked_font;
 649
 650         cooked_font = kzalloc(sizeof(*cooked_font), GFP_KERNEL);
 651         if (!cooked_font)
 652                 return 0;
 653
 654         cooked_rom->font_start = cooked_font;
 655
 656         raw_font = ((void *)raw_rom) + (raw_rom->font_start);
 657
 658         font_start = raw_font;
 659         cooked_font->raw = raw_font;
 660
 661         while (raw_font->next_font) {
 662                 raw_font = ((void *)font_start) + (raw_font->next_font);
 663
 664                 cooked_font->next_font = kzalloc(sizeof(*cooked_font), GFP_KERNEL);
 665                 if (!cooked_font->next_font)
 666                         return 1;
 667
 668                 cooked_font = cooked_font->next_font;
 669
 670                 cooked_font->raw = raw_font;
 671         }
 672
 673         cooked_font->next_font = NULL;
 674         return 1;
 675 }
 676
 677 #define BMODE_RELOCATE(offset)          offset = (offset) / 4;
 678 #define BMODE_LAST_ADDR_OFFS            0x50
 679
 680 void sti_font_convert_bytemode(struct sti_struct *sti, struct sti_cooked_font *f)
 681 {
 682         unsigned char *n, *p, *q;
 683         int size = f->raw->bytes_per_char * (f->raw->last_char + 1) + sizeof(struct sti_rom_font);
 684         struct sti_rom_font *old_font;
 685
 686         if (sti->wordmode)
 687                 return;
 688
 689         old_font = f->raw_ptr;
 690         n = kcalloc(4, size, STI_LOWMEM);
 691         f->raw_ptr = n;
 692         if (!n)
 693                 return;
 694         p = n + 3;
 695         q = (unsigned char *) f->raw;
 696         while (size--) {
 697                 *p = *q++;
 698                 p += 4;
 699         }
 700         /* store new ptr to byte-mode font and delete old font */
 701         f->raw = (struct sti_rom_font *) (n + 3);
 702         kfree(old_font);
 703 }
 704 EXPORT_SYMBOL(sti_font_convert_bytemode);
 705
 706 static void sti_bmode_rom_copy(unsigned long base, unsigned long count,
 707                                void *dest)
 708 {
 709         unsigned long dest_start = (unsigned long) dest;
 710
 711         while (count) {
 712                 count--;
 713                 *(u8 *)dest = gsc_readl(base);
 714                 base += 4;
 715                 dest++;
 716         }
 717
 718         sti_flush(dest_start, (unsigned long)dest);
 719 }
 720
 721 static struct sti_rom *sti_get_bmode_rom (unsigned long address)
 722 {
 723         struct sti_rom *raw;
 724         u32 size;
 725         struct sti_rom_font *raw_font, *font_start;
 726
 727         sti_bmode_rom_copy(address + BMODE_LAST_ADDR_OFFS, sizeof(size), &size);
 728
 729         size = (size+3) / 4;
 730         raw = kmalloc(size, STI_LOWMEM);
 731         if (raw) {
 732                 sti_bmode_rom_copy(address, size, raw);
 733                 memmove (&raw->res004, &raw->type[0], 0x3c);
 734                 raw->type[3] = raw->res004;
 735
 736                 BMODE_RELOCATE (raw->region_list);
 737                 BMODE_RELOCATE (raw->font_start);
 738
 739                 BMODE_RELOCATE (raw->init_graph);
 740                 BMODE_RELOCATE (raw->state_mgmt);
 741                 BMODE_RELOCATE (raw->font_unpmv);
 742                 BMODE_RELOCATE (raw->block_move);
 743                 BMODE_RELOCATE (raw->inq_conf);
 744
 745                 raw_font = ((void *)raw) + raw->font_start;
 746                 font_start = raw_font;
 747
 748                 while (raw_font->next_font) {
 749                         BMODE_RELOCATE (raw_font->next_font);
 750                         raw_font = ((void *)font_start) + raw_font->next_font;
 751                 }
 752         }
 753         return raw;
 754 }
 755
 756 static struct sti_rom *sti_get_wmode_rom(unsigned long address)
 757 {
 758         struct sti_rom *raw;
 759         unsigned long size;
 760
 761         /* read the ROM size directly from the struct in ROM */
 762         size = gsc_readl(address + offsetof(struct sti_rom,last_addr));
 763
 764         raw = kmalloc(size, STI_LOWMEM);
 765         if (raw)
 766                 sti_rom_copy(address, size, raw);
 767
 768         return raw;
 769 }
 770
 771 static int sti_read_rom(int wordmode, struct sti_struct *sti,
 772                         unsigned long address)
 773 {
 774         struct sti_cooked_rom *cooked;
 775         struct sti_rom *raw = NULL;
 776         unsigned long revno;
 777
 778         cooked = kmalloc(sizeof *cooked, GFP_KERNEL);
 779         if (!cooked)
 780                 goto out_err;
 781
 782         if (wordmode)
 783                 raw = sti_get_wmode_rom (address);
 784         else
 785                 raw = sti_get_bmode_rom (address);
 786
 787         if (!raw)
 788                 goto out_err;
 789
 790         if (!sti_cook_fonts(cooked, raw)) {
 791                 pr_warn("No font found for STI at %08lx\n", address);
 792                 goto out_err;
 793         }
 794
 795         if (raw->region_list)
 796                 memcpy(sti->regions, ((void *)raw)+raw->region_list, sizeof(sti->regions));
 797
 798         address = (unsigned long) STI_PTR(raw);
 799
 800         pr_info("STI %s ROM supports 32 %sbit firmware functions.\n",
 801                 wordmode ? "word mode" : "byte mode",
 802                 raw->alt_code_type == ALT_CODE_TYPE_PA_RISC_64
 803                 ? "and 64 " : "");
 804
 805         sti->font_unpmv = address + (raw->font_unpmv & 0x03ffffff);
 806         sti->block_move = address + (raw->block_move & 0x03ffffff);
 807         sti->init_graph = address + (raw->init_graph & 0x03ffffff);
 808         sti->inq_conf   = address + (raw->inq_conf   & 0x03ffffff);
 809
 810         sti->rom = cooked;
 811         sti->rom->raw = raw;
 812         sti_dump_rom(sti);
 813
 814         sti->wordmode = wordmode;
 815         sti->font = sti_select_font(sti->rom);
 816         sti->font->width = sti->font->raw->width;
 817         sti->font->height = sti->font->raw->height;
 818         sti_font_convert_bytemode(sti, sti->font);
 819         sti_dump_font(sti->font);
 820
 821         sti->sti_mem_request = raw->sti_mem_req;
 822         sti->graphics_id[0] = raw->graphics_id[0];
 823         sti->graphics_id[1] = raw->graphics_id[1];
 824
 825         /* check if the ROM routines in this card are compatible */
 826         if (wordmode || sti->graphics_id[1] != 0x09A02587)
 827                 goto ok;
 828
 829         revno = (raw->revno[0] << 8) | raw->revno[1];
 830
 831         switch (sti->graphics_id[0]) {
 832         case S9000_ID_HCRX:
 833                 /* HyperA or HyperB ? */
 834                 if (revno == 0x8408 || revno == 0x840b)
 835                         goto msg_not_supported;
 836                 break;
 837         case CRT_ID_THUNDER:
 838                 if (revno == 0x8509)
 839                         goto msg_not_supported;
 840                 break;
 841         case CRT_ID_THUNDER2:
 842                 if (revno == 0x850c)
 843                         goto msg_not_supported;
 844         }
 845 ok:
 846         return 1;
 847
 848 msg_not_supported:
 849         pr_warn("Sorry, this GSC/STI card is not yet supported.\n");
 850         pr_warn("Please see https://parisc.wiki.kernel.org/"
 851                 "index.php/Graphics_howto for more info.\n");
 852         /* fall through */
 853 out_err:
 854         kfree(raw);
 855         kfree(cooked);
 856         return 0;
 857 }
 858
 859 static struct sti_struct *sti_try_rom_generic(unsigned long address,
 860                                               unsigned long hpa,
 861                                               struct pci_dev *pd)
 862 {
 863         struct sti_struct *sti;
 864         int ok;
 865         u32 sig;
 866
 867         if (num_sti_roms >= MAX_STI_ROMS) {
 868                 pr_warn("maximum number of STI ROMS reached !\n");
 869                 return NULL;
 870         }
 871
 872         sti = kzalloc(sizeof(*sti), GFP_KERNEL);
 873         if (!sti)
 874                 return NULL;
 875
 876         spin_lock_init(&sti->lock);
 877
 878 test_rom:
 879         /* if we can't read the ROM, bail out early.  Not being able
 880          * to read the hpa is okay, for romless sti */
 881         if (pdc_add_valid(address))
 882                 goto out_err;
 883
 884         sig = gsc_readl(address);
 885
 886         /* check for a PCI ROM structure */
 887         if ((le32_to_cpu(sig)==0xaa55)) {
 888                 unsigned int i, rm_offset;
 889                 u32 *rm;
 890                 i = gsc_readl(address+0x04);
 891                 if (i != 1) {
 892                         /* The ROM could have multiple architecture
 893                          * dependent images (e.g. i386, parisc,...) */
 894                         pr_warn("PCI ROM is not a STI ROM type image (0x%8x)\n", i);
 895                         goto out_err;
 896                 }
 897
 898                 sti->pd = pd;
 899
 900                 i = gsc_readl(address+0x0c);
 901                 pr_debug("PCI ROM size (from header) = %d kB\n",
 902                         le16_to_cpu(i>>16)*512/1024);
 903                 rm_offset = le16_to_cpu(i & 0xffff);
 904                 if (rm_offset) {
 905                         /* read 16 bytes from the pci region mapper array */
 906                         rm = (u32*) &sti->rm_entry;
 907                         *rm++ = gsc_readl(address+rm_offset+0x00);
 908                         *rm++ = gsc_readl(address+rm_offset+0x04);
 909                         *rm++ = gsc_readl(address+rm_offset+0x08);
 910                         *rm++ = gsc_readl(address+rm_offset+0x0c);
 911                 }
 912
 913                 address += le32_to_cpu(gsc_readl(address+8));
 914                 pr_debug("sig %04x, PCI STI ROM at %08lx\n", sig, address);
 915                 goto test_rom;
 916         }
 917
 918         ok = 0;
 919
 920         if ((sig & 0xff) == 0x01) {
 921                 pr_debug("    byte mode ROM at %08lx, hpa at %08lx\n",
 922                        address, hpa);
 923                 ok = sti_read_rom(0, sti, address);
 924         }
 925
 926         if ((sig & 0xffff) == 0x0303) {
 927                 pr_debug("    word mode ROM at %08lx, hpa at %08lx\n",
 928                        address, hpa);
 929                 ok = sti_read_rom(1, sti, address);
 930         }
 931
 932         if (!ok)
 933                 goto out_err;
 934
 935         if (sti_init_glob_cfg(sti, address, hpa))
 936                 goto out_err; /* not enough memory */
 937
 938         /* disable STI PCI ROM. ROM and card RAM overlap and
 939          * leaving it enabled would force HPMCs
 940          */
 941         if (sti->pd) {
 942                 unsigned long rom_base;
 943                 rom_base = pci_resource_start(sti->pd, PCI_ROM_RESOURCE);
 944                 pci_write_config_dword(sti->pd, PCI_ROM_ADDRESS, rom_base & ~PCI_ROM_ADDRESS_ENABLE);
 945                 pr_debug("STI PCI ROM disabled\n");
 946         }
 947
 948         if (sti_init_graph(sti))
 949                 goto out_err;
 950
 951         sti_inq_conf(sti);
 952         sti_dump_globcfg(sti->glob_cfg, sti->sti_mem_request);
 953         sti_dump_outptr(sti);
 954
 955         pr_info("    graphics card name: %s\n",
 956                 sti->sti_data->inq_outptr.dev_name);
 957
 958         sti_roms[num_sti_roms] = sti;
 959         num_sti_roms++;
 960
 961         return sti;
 962
 963 out_err:
 964         kfree(sti);
 965         return NULL;
 966 }
 967
 968 static void sticore_check_for_default_sti(struct sti_struct *sti, char *path)
 969 {
 970         if (strcmp (path, default_sti_path) == 0)
 971                 default_sti = sti;
 972 }
 973
 974 /*
 975  * on newer systems PDC gives the address of the ROM
 976  * in the additional address field addr[1] while on
 977  * older Systems the PDC stores it in page0->proc_sti
 978  */
 979 static int __init sticore_pa_init(struct parisc_device *dev)
 980 {
 981         char pa_path[21];
 982         struct sti_struct *sti = NULL;
 983         int hpa = dev->hpa.start;
 984
 985         if (dev->num_addrs && dev->addr[0])
 986                 sti = sti_try_rom_generic(dev->addr[0], hpa, NULL);
 987         if (!sti)
 988                 sti = sti_try_rom_generic(hpa, hpa, NULL);
 989         if (!sti)
 990                 sti = sti_try_rom_generic(PAGE0->proc_sti, hpa, NULL);
 991         if (!sti)
 992                 return 1;
 993
 994         print_pa_hwpath(dev, pa_path);
 995         sticore_check_for_default_sti(sti, pa_path);
 996         return 0;
 997 }
 998
 999
1000 static int sticore_pci_init(struct pci_dev *pd, const struct pci_device_id *ent)
1001 {
1002 #ifdef CONFIG_PCI
1003         unsigned long fb_base, rom_base;
1004         unsigned int fb_len, rom_len;
1005         int err;
1006         struct sti_struct *sti;
1007
1008         err = pci_enable_device(pd);
1009         if (err < 0) {
1010                 dev_err(&pd->dev, "Cannot enable PCI device\n");
1011                 return err;
1012         }
1013
1014         fb_base = pci_resource_start(pd, 0);
1015         fb_len = pci_resource_len(pd, 0);
1016         rom_base = pci_resource_start(pd, PCI_ROM_RESOURCE);
1017         rom_len = pci_resource_len(pd, PCI_ROM_RESOURCE);
1018         if (rom_base) {
1019                 pci_write_config_dword(pd, PCI_ROM_ADDRESS, rom_base | PCI_ROM_ADDRESS_ENABLE);
1020                 pr_debug("STI PCI ROM enabled at 0x%08lx\n", rom_base);
1021         }
1022
1023         pr_info("STI PCI graphic ROM found at %08lx (%u kB), fb at %08lx (%u MB)\n",
1024                 rom_base, rom_len/1024, fb_base, fb_len/1024/1024);
1025
1026         pr_debug("Trying PCI STI ROM at %08lx, PCI hpa at %08lx\n",
1027                     rom_base, fb_base);
1028
1029         sti = sti_try_rom_generic(rom_base, fb_base, pd);
1030         if (sti) {
1031                 char pa_path[30];
1032                 print_pci_hwpath(pd, pa_path);
1033                 sticore_check_for_default_sti(sti, pa_path);
1034         }
1035
1036         if (!sti) {
1037                 pr_warn("Unable to handle STI device '%s'\n", pci_name(pd));
1038                 return -ENODEV;
1039         }
1040 #endif /* CONFIG_PCI */
1041
1042         return 0;
1043 }
1044
1045
1046 static void __exit sticore_pci_remove(struct pci_dev *pd)
1047 {
1048         BUG();
1049 }
1050
1051
1052 static struct pci_device_id sti_pci_tbl[] = {
1053         { PCI_DEVICE(PCI_VENDOR_ID_HP, PCI_DEVICE_ID_HP_VISUALIZE_EG) },
1054         { PCI_DEVICE(PCI_VENDOR_ID_HP, PCI_DEVICE_ID_HP_VISUALIZE_FX6) },
1055         { PCI_DEVICE(PCI_VENDOR_ID_HP, PCI_DEVICE_ID_HP_VISUALIZE_FX4) },
1056         { PCI_DEVICE(PCI_VENDOR_ID_HP, PCI_DEVICE_ID_HP_VISUALIZE_FX2) },
1057         { PCI_DEVICE(PCI_VENDOR_ID_HP, PCI_DEVICE_ID_HP_VISUALIZE_FXE) },
1058         { 0, } /* terminate list */
1059 };
1060 MODULE_DEVICE_TABLE(pci, sti_pci_tbl);
1061
1062 static struct pci_driver pci_sti_driver = {
1063         .name           = "sti",
1064         .id_table       = sti_pci_tbl,
1065         .probe          = sticore_pci_init,
1066         .remove         = __exit_p(sticore_pci_remove),
1067 };
1068
1069 static struct parisc_device_id sti_pa_tbl[] = {
1070         { HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x00077 },
1071         { HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x00085 },
1072         { 0, }
1073 };
1074 MODULE_DEVICE_TABLE(parisc, sti_pa_tbl);
1075
1076 static struct parisc_driver pa_sti_driver __refdata = {
1077         .name           = "sti",
1078         .id_table       = sti_pa_tbl,
1079         .probe          = sticore_pa_init,
1080 };
1081
1082
1083 /*
1084  * sti_init_roms() - detects all STI ROMs and stores them in sti_roms[]
1085  */
1086
1087 static int sticore_initialized __read_mostly;
1088
1089 static void sti_init_roms(void)
1090 {
1091         if (sticore_initialized)
1092                 return;
1093
1094         sticore_initialized = 1;
1095
1096         pr_info("STI GSC/PCI core graphics driver "
1097                         STI_DRIVERVERSION "\n");
1098
1099         /* Register drivers for native & PCI cards */
1100         register_parisc_driver(&pa_sti_driver);
1101         WARN_ON(pci_register_driver(&pci_sti_driver));
1102
1103         /* if we didn't find the given default sti, take the first one */
1104         if (!default_sti)
1105                 default_sti = sti_roms[0];
1106
1107 }
1108
1109 /*
1110  * index = 0 gives default sti
1111  * index > 0 gives other stis in detection order
1112  */
1113 struct sti_struct * sti_get_rom(unsigned int index)
1114 {
1115         if (!sticore_initialized)
1116                 sti_init_roms();
1117
1118         if (index == 0)
1119                 return default_sti;
1120
1121         if (index > num_sti_roms)
1122                 return NULL;
1123
1124         return sti_roms[index-1];
1125 }
1126 EXPORT_SYMBOL(sti_get_rom);
1127
1128
1129 int sti_call(const struct sti_struct *sti, unsigned long func,
1130                 const void *flags, void *inptr, void *outptr,
1131                 struct sti_glob_cfg *glob_cfg)
1132 {
1133         unsigned long _flags = STI_PTR(flags);
1134         unsigned long _inptr = STI_PTR(inptr);
1135         unsigned long _outptr = STI_PTR(outptr);
1136         unsigned long _glob_cfg = STI_PTR(glob_cfg);
1137         int ret;
1138
1139 #ifdef CONFIG_64BIT
1140         /* Check for overflow when using 32bit STI on 64bit kernel. */
1141         if (WARN_ONCE(_flags>>32 || _inptr>>32 || _outptr>>32 || _glob_cfg>>32,
1142                         "Out of 32bit-range pointers!"))
1143                 return -1;
1144 #endif
1145
1146         ret = pdc_sti_call(func, _flags, _inptr, _outptr, _glob_cfg);
1147
1148         return ret;
1149 }
1150
1151 MODULE_AUTHOR("Philipp Rumpf, Helge Deller, Thomas Bogendoerfer");
1152 MODULE_DESCRIPTION("Core STI driver for HP's NGLE series graphics cards in HP PARISC machines");
1153 MODULE_LICENSE("GPL v2");
1154