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