[mirror_ubuntu-kernels.git] / drivers / video / fbdev / sticore.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef STICORE_H
#define STICORE_H

/* generic STI structures & functions */

#if 0
#define DPRINTK(x)	printk x
#else
#define DPRINTK(x) 
#endif

#define MAX_STI_ROMS 4		/* max no. of ROMs which this driver handles */

#define STI_REGION_MAX 8	/* hardcoded STI constants */
#define STI_DEV_NAME_LENGTH 32
#define STI_MONITOR_MAX 256

#define STI_FONT_HPROMAN8 1
#define STI_FONT_KANA8 2

#define ALT_CODE_TYPE_UNKNOWN 0x00	/* alt code type values */
#define ALT_CODE_TYPE_PA_RISC_64 0x01

/* The latency of the STI functions cannot really be reduced by setting
 * this to 0;  STI doesn't seem to be designed to allow calling a different
 * function (or the same function with different arguments) after a
 * function exited with 1 as return value.
 *
 * As all of the functions below could be called from interrupt context,
 * we have to spin_lock_irqsave around the do { ret = bla(); } while(ret==1)
 * block.  Really bad latency there.
 *
 * Probably the best solution to all this is have the generic code manage
 * the screen buffer and a kernel thread to call STI occasionally.
 * 
 * Luckily, the frame buffer guys have the same problem so we can just wait
 * for them to fix it and steal their solution.   prumpf
 */
 
#include <asm/io.h>

#define STI_WAIT 1

#define STI_PTR(p)	( virt_to_phys(p) )
#define PTR_STI(p)	( phys_to_virt((unsigned long)p) )

#define sti_onscreen_x(sti) (sti->glob_cfg->onscreen_x)
#define sti_onscreen_y(sti) (sti->glob_cfg->onscreen_y)

/* sti_font_xy() use the native font ROM ! */
#define sti_font_x(sti) (PTR_STI(sti->font)->width)
#define sti_font_y(sti) (PTR_STI(sti->font)->height)

#ifdef CONFIG_64BIT
#define STI_LOWMEM	(GFP_KERNEL | GFP_DMA)
#else
#define STI_LOWMEM	(GFP_KERNEL)
#endif


/* STI function configuration structs */

typedef union region {
	struct { 
		u32 offset	: 14;	/* offset in 4kbyte page */
		u32 sys_only	: 1;	/* don't map to user space */
		u32 cache	: 1;	/* map to data cache */
		u32 btlb	: 1;	/* map to block tlb */
		u32 last	: 1;	/* last region in list */
		u32 length	: 14;	/* length in 4kbyte page */
	} region_desc;

	u32 region;			/* complete region value */
} region_t;

#define REGION_OFFSET_TO_PHYS( rt, hpa ) \
	(((rt).region_desc.offset << 12) + (hpa))

struct sti_glob_cfg_ext {
	 u8 curr_mon;			/* current monitor configured */
	 u8 friendly_boot;		/* in friendly boot mode */
	s16 power;			/* power calculation (in Watts) */
	s32 freq_ref;			/* frequency reference */
	u32 sti_mem_addr;		/* pointer to global sti memory (size=sti_mem_request) */
	u32 future_ptr; 		/* pointer to future data */
};

struct sti_glob_cfg {
	s32 text_planes;		/* number of planes used for text */
	s16 onscreen_x;			/* screen width in pixels */
	s16 onscreen_y;			/* screen height in pixels */
	s16 offscreen_x;		/* offset width in pixels */
	s16 offscreen_y;		/* offset height in pixels */
	s16 total_x;			/* frame buffer width in pixels */
	s16 total_y;			/* frame buffer height in pixels */
	u32 region_ptrs[STI_REGION_MAX]; /* region pointers */
	s32 reent_lvl;			/* storage for reentry level value */
	u32 save_addr;			/* where to save or restore reentrant state */
	u32 ext_ptr;			/* pointer to extended glob_cfg data structure */
};


/* STI init function structs */

struct sti_init_flags {
	u32 wait : 1;		/* should routine idle wait or not */
	u32 reset : 1;		/* hard reset the device? */
	u32 text : 1;		/* turn on text display planes? */
	u32 nontext : 1;	/* turn on non-text display planes? */
	u32 clear : 1;		/* clear text display planes? */
	u32 cmap_blk : 1;	/* non-text planes cmap black? */
	u32 enable_be_timer : 1; /* enable bus error timer */
	u32 enable_be_int : 1;	/* enable bus error timer interrupt */
	u32 no_chg_tx : 1;	/* don't change text settings */
	u32 no_chg_ntx : 1;	/* don't change non-text settings */
	u32 no_chg_bet : 1;	/* don't change berr timer settings */
	u32 no_chg_bei : 1;	/* don't change berr int settings */
	u32 init_cmap_tx : 1;	/* initialize cmap for text planes */
	u32 cmt_chg : 1;	/* change current monitor type */
	u32 retain_ie : 1;	/* don't allow reset to clear int enables */
	u32 caller_bootrom : 1;	/* set only by bootrom for each call */
	u32 caller_kernel : 1;	/* set only by kernel for each call */
	u32 caller_other : 1;	/* set only by non-[BR/K] caller */
	u32 pad	: 14;		/* pad to word boundary */
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_init_inptr_ext {
	u8  config_mon_type;	/* configure to monitor type */
	u8  pad[1];		/* pad to word boundary */
	u16 inflight_data;	/* inflight data possible on PCI */
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_init_inptr {
	s32 text_planes;	/* number of planes to use for text */
	u32 ext_ptr;		/* pointer to extended init_graph inptr data structure*/
};


struct sti_init_outptr {
	s32 errno;		/* error number on failure */
	s32 text_planes;	/* number of planes used for text */
	u32 future_ptr; 	/* pointer to future data */
};


/* STI configuration function structs */

struct sti_conf_flags {
	u32 wait : 1;		/* should routine idle wait or not */
	u32 pad : 31;		/* pad to word boundary */
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_conf_inptr {
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_conf_outptr_ext {
	u32 crt_config[3];	/* hardware specific X11/OGL information */	
	u32 crt_hdw[3];
	u32 future_ptr;
};

struct sti_conf_outptr {
	s32 errno;		/* error number on failure */
	s16 onscreen_x;		/* screen width in pixels */
	s16 onscreen_y;		/* screen height in pixels */
	s16 offscreen_x;	/* offscreen width in pixels */
	s16 offscreen_y;	/* offscreen height in pixels */
	s16 total_x;		/* frame buffer width in pixels */
	s16 total_y;		/* frame buffer height in pixels */
	s32 bits_per_pixel;	/* bits/pixel device has configured */
	s32 bits_used;		/* bits which can be accessed */
	s32 planes;		/* number of fb planes in system */
	 u8 dev_name[STI_DEV_NAME_LENGTH]; /* null terminated product name */
	u32 attributes;		/* flags denoting attributes */
	u32 ext_ptr;		/* pointer to future data */
};

struct sti_rom {
	 u8 type[4];
	 u8 res004;
	 u8 num_mons;
	 u8 revno[2];
	u32 graphics_id[2];

	u32 font_start;
	u32 statesize;
	u32 last_addr;
	u32 region_list;

	u16 reentsize;
	u16 maxtime;
	u32 mon_tbl_addr;
	u32 user_data_addr;
	u32 sti_mem_req;

	u32 user_data_size;
	u16 power;
	 u8 bus_support;
	 u8 ext_bus_support;
	 u8 alt_code_type;
	 u8 ext_dd_struct[3];
	u32 cfb_addr;

	u32 init_graph;
	u32 state_mgmt;
	u32 font_unpmv;
	u32 block_move;
	u32 self_test;
	u32 excep_hdlr;
	u32 inq_conf;
	u32 set_cm_entry;
	u32 dma_ctrl;
	 u8 res040[7 * 4];
	
	u32 init_graph_addr;
	u32 state_mgmt_addr;
	u32 font_unp_addr;
	u32 block_move_addr;
	u32 self_test_addr;
	u32 excep_hdlr_addr;
	u32 inq_conf_addr;
	u32 set_cm_entry_addr;
	u32 image_unpack_addr;
	u32 pa_risx_addrs[7];
};

struct sti_rom_font {
	u16 first_char;
	u16 last_char;
	 u8 width;
	 u8 height;
	 u8 font_type;		/* language type */
	 u8 bytes_per_char;
	u32 next_font;
	 u8 underline_height;
	 u8 underline_pos;
	 u8 res008[2];
};

/* sticore internal font handling */

struct sti_cooked_font {
        struct sti_rom_font *raw;
	struct sti_cooked_font *next_font;
};

struct sti_cooked_rom {
        struct sti_rom *raw;
	struct sti_cooked_font *font_start;
};

/* STI font printing function structs */

struct sti_font_inptr {
	u32 font_start_addr;	/* address of font start */
	s16 index;		/* index into font table of character */
	u8 fg_color;		/* foreground color of character */
	u8 bg_color;		/* background color of character */
	s16 dest_x;		/* X location of character upper left */
	s16 dest_y;		/* Y location of character upper left */
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_font_flags {
	u32 wait : 1;		/* should routine idle wait or not */
	u32 non_text : 1;	/* font unpack/move in non_text planes =1, text =0 */
	u32 pad : 30;		/* pad to word boundary */
	u32 future_ptr; 	/* pointer to future data */
};
	
struct sti_font_outptr {
	s32 errno;		/* error number on failure */
	u32 future_ptr; 	/* pointer to future data */
};

/* STI blockmove structs */

struct sti_blkmv_flags {
	u32 wait : 1;		/* should routine idle wait or not */
	u32 color : 1;		/* change color during move? */
	u32 clear : 1;		/* clear during move? */
	u32 non_text : 1;	/* block move in non_text planes =1, text =0 */
	u32 pad : 28;		/* pad to word boundary */
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_blkmv_inptr {
	u8 fg_color;		/* foreground color after move */
	u8 bg_color;		/* background color after move */
	s16 src_x;		/* source upper left pixel x location */
	s16 src_y;		/* source upper left pixel y location */
	s16 dest_x;		/* dest upper left pixel x location */
	s16 dest_y;		/* dest upper left pixel y location */
	s16 width;		/* block width in pixels */
	s16 height;		/* block height in pixels */
	u32 future_ptr; 	/* pointer to future data */
};

struct sti_blkmv_outptr {
	s32 errno;		/* error number on failure */
	u32 future_ptr; 	/* pointer to future data */
};


/* sti_all_data is an internal struct which needs to be allocated in
 * low memory (< 4GB) if STI is used with 32bit STI on a 64bit kernel */

struct sti_all_data {
	struct sti_glob_cfg glob_cfg;
	struct sti_glob_cfg_ext glob_cfg_ext;

	struct sti_conf_inptr		inq_inptr;
	struct sti_conf_outptr		inq_outptr; /* configuration */
	struct sti_conf_outptr_ext	inq_outptr_ext;

	struct sti_init_inptr_ext	init_inptr_ext;
	struct sti_init_inptr		init_inptr;
	struct sti_init_outptr		init_outptr;

	struct sti_blkmv_inptr		blkmv_inptr;
	struct sti_blkmv_outptr		blkmv_outptr;

	struct sti_font_inptr		font_inptr;
	struct sti_font_outptr		font_outptr;

	/* leave as last entries */
	unsigned long save_addr[1024 / sizeof(unsigned long)];
	   /* min 256 bytes which is STI default, max sti->sti_mem_request */
	unsigned long sti_mem_addr[256 / sizeof(unsigned long)];
	/* do not add something below here ! */
};

/* internal generic STI struct */

struct sti_struct {
	spinlock_t lock;
		
	/* the following fields needs to be filled in by the word/byte routines */
	int font_width;	
	int font_height;
	/* char **mon_strings; */
	int sti_mem_request;
	u32 graphics_id[2];

	struct sti_cooked_rom *rom;

	unsigned long font_unpmv;
	unsigned long block_move;
	unsigned long init_graph;
	unsigned long inq_conf;

	/* all following fields are initialized by the generic routines */
	int text_planes;
	region_t regions[STI_REGION_MAX];
	unsigned long regions_phys[STI_REGION_MAX];

	struct sti_glob_cfg *glob_cfg;	/* points into sti_all_data */

	struct sti_cooked_font *font;	/* ptr to selected font (cooked) */

	struct pci_dev *pd;

	/* PCI data structures (pg. 17ff from sti.pdf) */
	u8 rm_entry[16]; /* pci region mapper array == pci config space offset */

	/* pointer to the fb_info where this STI device is used */
	struct fb_info *info;

	/* pointer to all internal data */
	struct sti_all_data *sti_data;
};


/* sticore interface functions */

struct sti_struct *sti_get_rom(unsigned int index); /* 0: default sti */


/* sticore main function to call STI firmware */

int sti_call(const struct sti_struct *sti, unsigned long func,
		const void *flags, void *inptr, void *outptr,
		struct sti_glob_cfg *glob_cfg);


/* functions to call the STI ROM directly */

void sti_putc(struct sti_struct *sti, int c, int y, int x);
void sti_set(struct sti_struct *sti, int src_y, int src_x,
	     int height, int width, u8 color);
void sti_clear(struct sti_struct *sti, int src_y, int src_x,
	       int height, int width, int c);
void sti_bmove(struct sti_struct *sti, int src_y, int src_x,
	       int dst_y, int dst_x, int height, int width);

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