1 /* SPDX-License-Identifier: GPL-2.0 */
5 /* generic STI structures & functions */
7 #define MAX_STI_ROMS 4 /* max no. of ROMs which this driver handles */
9 #define STI_REGION_MAX 8 /* hardcoded STI constants */
10 #define STI_DEV_NAME_LENGTH 32
11 #define STI_MONITOR_MAX 256
13 #define STI_FONT_HPROMAN8 1
14 #define STI_FONT_KANA8 2
16 #define ALT_CODE_TYPE_UNKNOWN 0x00 /* alt code type values */
17 #define ALT_CODE_TYPE_PA_RISC_64 0x01
19 /* The latency of the STI functions cannot really be reduced by setting
20 * this to 0; STI doesn't seem to be designed to allow calling a different
21 * function (or the same function with different arguments) after a
22 * function exited with 1 as return value.
24 * As all of the functions below could be called from interrupt context,
25 * we have to spin_lock_irqsave around the do { ret = bla(); } while(ret==1)
26 * block. Really bad latency there.
28 * Probably the best solution to all this is have the generic code manage
29 * the screen buffer and a kernel thread to call STI occasionally.
31 * Luckily, the frame buffer guys have the same problem so we can just wait
32 * for them to fix it and steal their solution. prumpf
39 #define STI_PTR(p) ( virt_to_phys(p) )
40 #define PTR_STI(p) ( phys_to_virt((unsigned long)p) )
42 #define sti_onscreen_x(sti) (sti->glob_cfg->onscreen_x)
43 #define sti_onscreen_y(sti) (sti->glob_cfg->onscreen_y)
45 /* sti_font_xy() use the native font ROM ! */
46 #define sti_font_x(sti) (PTR_STI(sti->font)->width)
47 #define sti_font_y(sti) (PTR_STI(sti->font)->height)
50 #define STI_LOWMEM (GFP_KERNEL | GFP_DMA)
52 #define STI_LOWMEM (GFP_KERNEL)
56 /* STI function configuration structs */
58 typedef union region {
60 u32 offset : 14; /* offset in 4kbyte page */
61 u32 sys_only : 1; /* don't map to user space */
62 u32 cache : 1; /* map to data cache */
63 u32 btlb : 1; /* map to block tlb */
64 u32 last : 1; /* last region in list */
65 u32 length : 14; /* length in 4kbyte page */
68 u32 region; /* complete region value */
71 #define REGION_OFFSET_TO_PHYS( rt, hpa ) \
72 (((rt).region_desc.offset << 12) + (hpa))
74 struct sti_glob_cfg_ext {
75 u8 curr_mon; /* current monitor configured */
76 u8 friendly_boot; /* in friendly boot mode */
77 s16 power; /* power calculation (in Watts) */
78 s32 freq_ref; /* frequency reference */
79 u32 sti_mem_addr; /* pointer to global sti memory (size=sti_mem_request) */
80 u32 future_ptr; /* pointer to future data */
84 s32 text_planes; /* number of planes used for text */
85 s16 onscreen_x; /* screen width in pixels */
86 s16 onscreen_y; /* screen height in pixels */
87 s16 offscreen_x; /* offset width in pixels */
88 s16 offscreen_y; /* offset height in pixels */
89 s16 total_x; /* frame buffer width in pixels */
90 s16 total_y; /* frame buffer height in pixels */
91 u32 region_ptrs[STI_REGION_MAX]; /* region pointers */
92 s32 reent_lvl; /* storage for reentry level value */
93 u32 save_addr; /* where to save or restore reentrant state */
94 u32 ext_ptr; /* pointer to extended glob_cfg data structure */
98 /* STI init function structs */
100 struct sti_init_flags {
101 u32 wait : 1; /* should routine idle wait or not */
102 u32 reset : 1; /* hard reset the device? */
103 u32 text : 1; /* turn on text display planes? */
104 u32 nontext : 1; /* turn on non-text display planes? */
105 u32 clear : 1; /* clear text display planes? */
106 u32 cmap_blk : 1; /* non-text planes cmap black? */
107 u32 enable_be_timer : 1; /* enable bus error timer */
108 u32 enable_be_int : 1; /* enable bus error timer interrupt */
109 u32 no_chg_tx : 1; /* don't change text settings */
110 u32 no_chg_ntx : 1; /* don't change non-text settings */
111 u32 no_chg_bet : 1; /* don't change berr timer settings */
112 u32 no_chg_bei : 1; /* don't change berr int settings */
113 u32 init_cmap_tx : 1; /* initialize cmap for text planes */
114 u32 cmt_chg : 1; /* change current monitor type */
115 u32 retain_ie : 1; /* don't allow reset to clear int enables */
116 u32 caller_bootrom : 1; /* set only by bootrom for each call */
117 u32 caller_kernel : 1; /* set only by kernel for each call */
118 u32 caller_other : 1; /* set only by non-[BR/K] caller */
119 u32 pad : 14; /* pad to word boundary */
120 u32 future_ptr; /* pointer to future data */
123 struct sti_init_inptr_ext {
124 u8 config_mon_type; /* configure to monitor type */
125 u8 pad[1]; /* pad to word boundary */
126 u16 inflight_data; /* inflight data possible on PCI */
127 u32 future_ptr; /* pointer to future data */
130 struct sti_init_inptr {
131 s32 text_planes; /* number of planes to use for text */
132 u32 ext_ptr; /* pointer to extended init_graph inptr data structure*/
136 struct sti_init_outptr {
137 s32 errno; /* error number on failure */
138 s32 text_planes; /* number of planes used for text */
139 u32 future_ptr; /* pointer to future data */
144 /* STI configuration function structs */
146 struct sti_conf_flags {
147 u32 wait : 1; /* should routine idle wait or not */
148 u32 pad : 31; /* pad to word boundary */
149 u32 future_ptr; /* pointer to future data */
152 struct sti_conf_inptr {
153 u32 future_ptr; /* pointer to future data */
156 struct sti_conf_outptr_ext {
157 u32 crt_config[3]; /* hardware specific X11/OGL information */
162 struct sti_conf_outptr {
163 s32 errno; /* error number on failure */
164 s16 onscreen_x; /* screen width in pixels */
165 s16 onscreen_y; /* screen height in pixels */
166 s16 offscreen_x; /* offscreen width in pixels */
167 s16 offscreen_y; /* offscreen height in pixels */
168 s16 total_x; /* frame buffer width in pixels */
169 s16 total_y; /* frame buffer height in pixels */
170 s32 bits_per_pixel; /* bits/pixel device has configured */
171 s32 bits_used; /* bits which can be accessed */
172 s32 planes; /* number of fb planes in system */
173 u8 dev_name[STI_DEV_NAME_LENGTH]; /* null terminated product name */
174 u32 attributes; /* flags denoting attributes */
175 u32 ext_ptr; /* pointer to future data */
222 u32 set_cm_entry_addr;
223 u32 image_unpack_addr;
224 u32 pa_risx_addrs[7];
227 struct sti_rom_font {
232 u8 font_type; /* language type */
234 s32 next_font; /* note: signed int */
240 /* sticore internal font handling */
242 struct sti_cooked_font {
243 struct sti_rom_font *raw; /* native ptr for STI functions */
244 void *raw_ptr; /* kmalloc'ed font data */
245 struct sti_cooked_font *next_font;
251 struct sti_cooked_rom {
253 struct sti_cooked_font *font_start;
256 /* STI font printing function structs */
258 struct sti_font_inptr {
259 u32 font_start_addr; /* address of font start */
260 s16 index; /* index into font table of character */
261 u8 fg_color; /* foreground color of character */
262 u8 bg_color; /* background color of character */
263 s16 dest_x; /* X location of character upper left */
264 s16 dest_y; /* Y location of character upper left */
265 u32 future_ptr; /* pointer to future data */
268 struct sti_font_flags {
269 u32 wait : 1; /* should routine idle wait or not */
270 u32 non_text : 1; /* font unpack/move in non_text planes =1, text =0 */
271 u32 pad : 30; /* pad to word boundary */
272 u32 future_ptr; /* pointer to future data */
275 struct sti_font_outptr {
276 s32 errno; /* error number on failure */
277 u32 future_ptr; /* pointer to future data */
280 /* STI blockmove structs */
282 struct sti_blkmv_flags {
283 u32 wait : 1; /* should routine idle wait or not */
284 u32 color : 1; /* change color during move? */
285 u32 clear : 1; /* clear during move? */
286 u32 non_text : 1; /* block move in non_text planes =1, text =0 */
287 u32 pad : 28; /* pad to word boundary */
288 u32 future_ptr; /* pointer to future data */
291 struct sti_blkmv_inptr {
292 u8 fg_color; /* foreground color after move */
293 u8 bg_color; /* background color after move */
294 s16 src_x; /* source upper left pixel x location */
295 s16 src_y; /* source upper left pixel y location */
296 s16 dest_x; /* dest upper left pixel x location */
297 s16 dest_y; /* dest upper left pixel y location */
298 s16 width; /* block width in pixels */
299 s16 height; /* block height in pixels */
300 u32 future_ptr; /* pointer to future data */
303 struct sti_blkmv_outptr {
304 s32 errno; /* error number on failure */
305 u32 future_ptr; /* pointer to future data */
309 /* sti_all_data is an internal struct which needs to be allocated in
310 * low memory (< 4GB) if STI is used with 32bit STI on a 64bit kernel */
312 struct sti_all_data {
313 struct sti_glob_cfg glob_cfg;
314 struct sti_glob_cfg_ext glob_cfg_ext;
316 struct sti_conf_inptr inq_inptr;
317 struct sti_conf_outptr inq_outptr; /* configuration */
318 struct sti_conf_outptr_ext inq_outptr_ext;
320 struct sti_init_inptr_ext init_inptr_ext;
321 struct sti_init_inptr init_inptr;
322 struct sti_init_outptr init_outptr;
324 struct sti_blkmv_inptr blkmv_inptr;
325 struct sti_blkmv_outptr blkmv_outptr;
327 struct sti_font_inptr font_inptr;
328 struct sti_font_outptr font_outptr;
330 /* leave as last entries */
331 unsigned long save_addr[1024 / sizeof(unsigned long)];
332 /* min 256 bytes which is STI default, max sti->sti_mem_request */
333 unsigned long sti_mem_addr[256 / sizeof(unsigned long)];
334 /* do not add something below here ! */
337 /* internal generic STI struct */
342 /* char **mon_strings; */
346 struct sti_cooked_rom *rom;
348 unsigned long font_unpmv;
349 unsigned long block_move;
350 unsigned long init_graph;
351 unsigned long inq_conf;
353 /* all following fields are initialized by the generic routines */
355 region_t regions[STI_REGION_MAX];
356 unsigned long regions_phys[STI_REGION_MAX];
358 struct sti_glob_cfg *glob_cfg; /* points into sti_all_data */
361 struct sti_cooked_font *font; /* ptr to selected font (cooked) */
365 /* PCI data structures (pg. 17ff from sti.pdf) */
366 u8 rm_entry[16]; /* pci region mapper array == pci config space offset */
368 /* pointer to the fb_info where this STI device is used */
369 struct fb_info *info;
371 /* pointer to all internal data */
372 struct sti_all_data *sti_data;
374 /* pa_path of this device */
379 /* sticore interface functions */
381 struct sti_struct *sti_get_rom(unsigned int index); /* 0: default sti */
382 void sti_font_convert_bytemode(struct sti_struct *sti, struct sti_cooked_font *f);
385 /* sticore main function to call STI firmware */
387 int sti_call(const struct sti_struct *sti, unsigned long func,
388 const void *flags, void *inptr, void *outptr,
389 struct sti_glob_cfg *glob_cfg);
392 /* functions to call the STI ROM directly */
394 void sti_putc(struct sti_struct *sti, int c, int y, int x,
395 struct sti_cooked_font *font);
396 void sti_set(struct sti_struct *sti, int src_y, int src_x,
397 int height, int width, u8 color);
398 void sti_clear(struct sti_struct *sti, int src_y, int src_x,
399 int height, int width, int c, struct sti_cooked_font *font);
400 void sti_bmove(struct sti_struct *sti, int src_y, int src_x,
401 int dst_y, int dst_x, int height, int width,
402 struct sti_cooked_font *font);
404 #endif /* STICORE_H */