407 lines · c
1/* SPDX-License-Identifier: GPL-2.0 */2#ifndef STICORE_H3#define STICORE_H4 5struct device;6 7/* generic STI structures & functions */8 9#define MAX_STI_ROMS 4 /* max no. of ROMs which this driver handles */10 11#define STI_REGION_MAX 8 /* hardcoded STI constants */12#define STI_DEV_NAME_LENGTH 3213#define STI_MONITOR_MAX 25614 15#define STI_FONT_HPROMAN8 116#define STI_FONT_KANA8 217 18#define ALT_CODE_TYPE_UNKNOWN 0x00 /* alt code type values */19#define ALT_CODE_TYPE_PA_RISC_64 0x0120 21/* The latency of the STI functions cannot really be reduced by setting22 * this to 0; STI doesn't seem to be designed to allow calling a different23 * function (or the same function with different arguments) after a24 * function exited with 1 as return value.25 *26 * As all of the functions below could be called from interrupt context,27 * we have to spin_lock_irqsave around the do { ret = bla(); } while(ret==1)28 * block. Really bad latency there.29 *30 * Probably the best solution to all this is have the generic code manage31 * the screen buffer and a kernel thread to call STI occasionally.32 *33 * Luckily, the frame buffer guys have the same problem so we can just wait34 * for them to fix it and steal their solution. prumpf35 */36 37#include <asm/io.h>38 39#define STI_WAIT 140 41#define STI_PTR(p) ( virt_to_phys(p) )42 43#define sti_onscreen_x(sti) (sti->glob_cfg->onscreen_x)44#define sti_onscreen_y(sti) (sti->glob_cfg->onscreen_y)45 46/* sti_font_xy() use the native font ROM ! */47#define sti_font_x(sti) (PTR_STI(sti->font)->width)48#define sti_font_y(sti) (PTR_STI(sti->font)->height)49 50#ifdef CONFIG_64BIT51#define STI_LOWMEM (GFP_KERNEL | GFP_DMA)52#else53#define STI_LOWMEM (GFP_KERNEL)54#endif55 56 57/* STI function configuration structs */58 59typedef union region {60 struct {61 u32 offset : 14; /* offset in 4kbyte page */62 u32 sys_only : 1; /* don't map to user space */63 u32 cache : 1; /* map to data cache */64 u32 btlb : 1; /* map to block tlb */65 u32 last : 1; /* last region in list */66 u32 length : 14; /* length in 4kbyte page */67 } region_desc;68 69 u32 region; /* complete region value */70} region_t;71 72#define REGION_OFFSET_TO_PHYS( rt, hpa ) \73 (((rt).region_desc.offset << 12) + (hpa))74 75struct sti_glob_cfg_ext {76 u8 curr_mon; /* current monitor configured */77 u8 friendly_boot; /* in friendly boot mode */78 s16 power; /* power calculation (in Watts) */79 s32 freq_ref; /* frequency reference */80 u32 *sti_mem_addr; /* pointer to global sti memory (size=sti_mem_request) */81 u32 *future_ptr; /* pointer to future data */82};83 84struct sti_glob_cfg {85 s32 text_planes; /* number of planes used for text */86 s16 onscreen_x; /* screen width in pixels */87 s16 onscreen_y; /* screen height in pixels */88 s16 offscreen_x; /* offset width in pixels */89 s16 offscreen_y; /* offset height in pixels */90 s16 total_x; /* frame buffer width in pixels */91 s16 total_y; /* frame buffer height in pixels */92 u32 *region_ptrs[STI_REGION_MAX]; /* region pointers */93 s32 reent_lvl; /* storage for reentry level value */94 u32 *save_addr; /* where to save or restore reentrant state */95 u32 *ext_ptr; /* pointer to extended glob_cfg data structure */96};97 98 99/* STI init function structs */100 101struct sti_init_flags {102 u32 wait : 1; /* should routine idle wait or not */103 u32 reset : 1; /* hard reset the device? */104 u32 text : 1; /* turn on text display planes? */105 u32 nontext : 1; /* turn on non-text display planes? */106 u32 clear : 1; /* clear text display planes? */107 u32 cmap_blk : 1; /* non-text planes cmap black? */108 u32 enable_be_timer : 1; /* enable bus error timer */109 u32 enable_be_int : 1; /* enable bus error timer interrupt */110 u32 no_chg_tx : 1; /* don't change text settings */111 u32 no_chg_ntx : 1; /* don't change non-text settings */112 u32 no_chg_bet : 1; /* don't change berr timer settings */113 u32 no_chg_bei : 1; /* don't change berr int settings */114 u32 init_cmap_tx : 1; /* initialize cmap for text planes */115 u32 cmt_chg : 1; /* change current monitor type */116 u32 retain_ie : 1; /* don't allow reset to clear int enables */117 u32 caller_bootrom : 1; /* set only by bootrom for each call */118 u32 caller_kernel : 1; /* set only by kernel for each call */119 u32 caller_other : 1; /* set only by non-[BR/K] caller */120 u32 pad : 14; /* pad to word boundary */121 u32 *future_ptr; /* pointer to future data */122};123 124struct sti_init_inptr_ext {125 u8 config_mon_type; /* configure to monitor type */126 u8 pad[1]; /* pad to word boundary */127 u16 inflight_data; /* inflight data possible on PCI */128 u32 *future_ptr; /* pointer to future data */129};130 131struct sti_init_inptr {132 s32 text_planes; /* number of planes to use for text */133 u32 *ext_ptr; /* pointer to extended init_graph inptr data structure*/134};135 136 137struct sti_init_outptr {138 s32 errno; /* error number on failure */139 s32 text_planes; /* number of planes used for text */140 u32 *future_ptr; /* pointer to future data */141};142 143 144 145/* STI configuration function structs */146 147struct sti_conf_flags {148 u32 wait : 1; /* should routine idle wait or not */149 u32 pad : 31; /* pad to word boundary */150 u32 *future_ptr; /* pointer to future data */151};152 153struct sti_conf_inptr {154 u32 *future_ptr; /* pointer to future data */155};156 157struct sti_conf_outptr_ext {158 u32 crt_config[3]; /* hardware specific X11/OGL information */159 u32 crt_hdw[3];160 u32 *future_ptr;161};162 163struct sti_conf_outptr {164 s32 errno; /* error number on failure */165 s16 onscreen_x; /* screen width in pixels */166 s16 onscreen_y; /* screen height in pixels */167 s16 offscreen_x; /* offscreen width in pixels */168 s16 offscreen_y; /* offscreen height in pixels */169 s16 total_x; /* frame buffer width in pixels */170 s16 total_y; /* frame buffer height in pixels */171 s32 bits_per_pixel; /* bits/pixel device has configured */172 s32 bits_used; /* bits which can be accessed */173 s32 planes; /* number of fb planes in system */174 u8 dev_name[STI_DEV_NAME_LENGTH]; /* null terminated product name */175 u32 attributes; /* flags denoting attributes */176 u32 *ext_ptr; /* pointer to future data */177};178 179struct sti_rom {180 u8 type[4];181 u8 res004;182 u8 num_mons;183 u8 revno[2];184 u32 graphics_id[2];185 186 u32 font_start;187 u32 statesize;188 u32 last_addr;189 u32 region_list;190 191 u16 reentsize;192 u16 maxtime;193 u32 mon_tbl_addr;194 u32 user_data_addr;195 u32 sti_mem_req;196 197 u32 user_data_size;198 u16 power;199 u8 bus_support;200 u8 ext_bus_support;201 u8 alt_code_type;202 u8 ext_dd_struct[3];203 u32 cfb_addr;204 205 u32 init_graph;206 u32 state_mgmt;207 u32 font_unpmv;208 u32 block_move;209 u32 self_test;210 u32 excep_hdlr;211 u32 inq_conf;212 u32 set_cm_entry;213 u32 dma_ctrl;214 u8 res040[7 * 4];215 216 u32 init_graph_addr;217 u32 state_mgmt_addr;218 u32 font_unp_addr;219 u32 block_move_addr;220 u32 self_test_addr;221 u32 excep_hdlr_addr;222 u32 inq_conf_addr;223 u32 set_cm_entry_addr;224 u32 image_unpack_addr;225 u32 pa_risx_addrs[7];226};227 228struct sti_rom_font {229 u16 first_char;230 u16 last_char;231 u8 width;232 u8 height;233 u8 font_type; /* language type */234 u8 bytes_per_char;235 s32 next_font; /* note: signed int */236 u8 underline_height;237 u8 underline_pos;238 u8 res008[2];239};240 241/* sticore internal font handling */242 243struct sti_cooked_font {244 struct sti_rom_font *raw; /* native ptr for STI functions */245 void *raw_ptr; /* kmalloc'ed font data */246 struct sti_cooked_font *next_font;247 int height, width;248 int refcount;249 u32 crc;250};251 252struct sti_cooked_rom {253 struct sti_rom *raw;254 struct sti_cooked_font *font_start;255};256 257/* STI font printing function structs */258 259struct sti_font_inptr {260 u32 *font_start_addr; /* address of font start */261 s16 index; /* index into font table of character */262 u8 fg_color; /* foreground color of character */263 u8 bg_color; /* background color of character */264 s16 dest_x; /* X location of character upper left */265 s16 dest_y; /* Y location of character upper left */266 u32 *future_ptr; /* pointer to future data */267};268 269struct sti_font_flags {270 u32 wait : 1; /* should routine idle wait or not */271 u32 non_text : 1; /* font unpack/move in non_text planes =1, text =0 */272 u32 pad : 30; /* pad to word boundary */273 u32 *future_ptr; /* pointer to future data */274};275 276struct sti_font_outptr {277 s32 errno; /* error number on failure */278 u32 *future_ptr; /* pointer to future data */279};280 281/* STI blockmove structs */282 283struct sti_blkmv_flags {284 u32 wait : 1; /* should routine idle wait or not */285 u32 color : 1; /* change color during move? */286 u32 clear : 1; /* clear during move? */287 u32 non_text : 1; /* block move in non_text planes =1, text =0 */288 u32 pad : 28; /* pad to word boundary */289 u32 *future_ptr; /* pointer to future data */290};291 292struct sti_blkmv_inptr {293 u8 fg_color; /* foreground color after move */294 u8 bg_color; /* background color after move */295 s16 src_x; /* source upper left pixel x location */296 s16 src_y; /* source upper left pixel y location */297 s16 dest_x; /* dest upper left pixel x location */298 s16 dest_y; /* dest upper left pixel y location */299 s16 width; /* block width in pixels */300 s16 height; /* block height in pixels */301 u32 *future_ptr; /* pointer to future data */302};303 304struct sti_blkmv_outptr {305 s32 errno; /* error number on failure */306 u32 *future_ptr; /* pointer to future data */307};308 309 310/* sti_all_data is an internal struct which needs to be allocated in311 * low memory (< 4GB) if STI is used with 32bit STI on a 64bit kernel */312 313struct sti_all_data {314 struct sti_glob_cfg glob_cfg;315 struct sti_glob_cfg_ext glob_cfg_ext;316 317 struct sti_conf_inptr inq_inptr;318 struct sti_conf_outptr inq_outptr; /* configuration */319 struct sti_conf_outptr_ext inq_outptr_ext;320 321 struct sti_init_inptr_ext init_inptr_ext;322 struct sti_init_inptr init_inptr;323 struct sti_init_outptr init_outptr;324 325 struct sti_blkmv_inptr blkmv_inptr;326 struct sti_blkmv_outptr blkmv_outptr;327 328 struct sti_font_inptr font_inptr;329 struct sti_font_outptr font_outptr;330 331 /* leave as last entries */332 unsigned long save_addr[1024 / sizeof(unsigned long)];333 /* min 256 bytes which is STI default, max sti->sti_mem_request */334 unsigned long sti_mem_addr[256 / sizeof(unsigned long)];335 /* do not add something below here ! */336};337 338/* internal generic STI struct */339 340struct sti_struct {341 spinlock_t lock;342 343 /* char **mon_strings; */344 int sti_mem_request;345 u32 graphics_id[2];346 347 struct sti_cooked_rom *rom;348 349 unsigned long font_unpmv;350 unsigned long block_move;351 unsigned long init_graph;352 unsigned long inq_conf;353 int do_call64; /* call 64-bit code */354 355 /* all following fields are initialized by the generic routines */356 int text_planes;357 region_t regions[STI_REGION_MAX];358 unsigned long regions_phys[STI_REGION_MAX];359 360 struct sti_glob_cfg *glob_cfg; /* points into sti_all_data */361 362 int wordmode;363 struct sti_cooked_font *font; /* ptr to selected font (cooked) */364 365 struct pci_dev *pd;366 367 /* PCI data structures (pg. 17ff from sti.pdf) */368 u8 rm_entry[16]; /* pci region mapper array == pci config space offset */369 370 /* pointer to the parent device */371 struct device *dev;372 373 /* pointer to all internal data */374 struct sti_all_data *sti_data;375 376 /* pa_path of this device */377 char pa_path[24];378};379 380 381/* sticore interface functions */382 383struct sti_struct *sti_get_rom(unsigned int index); /* 0: default sti */384void sti_font_convert_bytemode(struct sti_struct *sti, struct sti_cooked_font *f);385 386 387/* sticore main function to call STI firmware */388 389int sti_call(const struct sti_struct *sti, unsigned long func,390 const void *flags, void *inptr, void *outptr,391 struct sti_glob_cfg *glob_cfg);392 393 394/* functions to call the STI ROM directly */395 396void sti_putc(struct sti_struct *sti, int c, int y, int x,397 struct sti_cooked_font *font);398void sti_set(struct sti_struct *sti, int src_y, int src_x,399 int height, int width, u8 color);400void sti_clear(struct sti_struct *sti, int src_y, int src_x,401 int height, int width, int c, struct sti_cooked_font *font);402void sti_bmove(struct sti_struct *sti, int src_y, int src_x,403 int dst_y, int dst_x, int height, int width,404 struct sti_cooked_font *font);405 406#endif /* STICORE_H */407