[dragonfly.git] / sys / dev / video / fb / fbreg.h

/*-
 * Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer as
 *    the first lines of this file unmodified.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: src/sys/dev/fb/fbreg.h,v 1.6 1999/12/29 04:35:36 peter Exp $
 * $DragonFly: src/sys/dev/video/fb/fbreg.h,v 1.10 2007/08/15 19:31:11 swildner Exp $
 */

#ifndef _DEV_FB_FBREG_H_
#define _DEV_FB_FBREG_H_

#ifdef _KERNEL

#define V_MAX_ADAPTERS		8		/* XXX */

/* some macros */
#if defined(__i386__) || defined(__x86_64__)
#define bcopy_io(s, d, c)	generic_bcopy((void *)(s), (void *)(d), (c))
#define bcopy_toio(s, d, c)	generic_bcopy((void *)(s), (void *)(d), (c))
#define bcopy_fromio(s, d, c)	generic_bcopy((void *)(s), (void *)(d), (c))
#define bzero_io(d, c)		bzero((void *)(d), (c))
#define fill_io(p, d, c)	fill((p), (void *)(d), (c))
#define fillw_io(p, d, c)	fillw((p), (void *)(d), (c))
void generic_bcopy(const void *s, void *d, size_t c);
#else /* !__i386__ */
#define bcopy_io(s, d, c)	memcpy_io((d), (s), (c))
#define bcopy_toio(s, d, c)	memcpy_toio((d), (void *)(s), (c))
#define bcopy_fromio(s, d, c)	memcpy_fromio((void *)(d), (s), (c))
#define bzero_io(d, c)		memset_io((d), 0, (c))
#define fill_io(p, d, c)	memset_io((d), (p), (c))
#define fillw(p, d, c)		memsetw((d), (p), (c))
#define fillw_io(p, d, c)	memsetw_io((d), (p), (c))
#endif /* !__i386__ */

/* video function table */
typedef int vi_probe_t(int unit, video_adapter_t **adpp, void *arg, int flags);
typedef int vi_init_t(int unit, video_adapter_t *adp, int flags);
typedef int vi_get_info_t(video_adapter_t *adp, int mode, video_info_t *info);
typedef int vi_query_mode_t(video_adapter_t *adp, video_info_t *info);
typedef int vi_set_mode_t(video_adapter_t *adp, int mode);
typedef int vi_save_font_t(video_adapter_t *adp, int page, int size,
			   u_char *data, int c, int count);
typedef int vi_load_font_t(video_adapter_t *adp, int page, int size,
			   u_char *data, int c, int count);
typedef int vi_show_font_t(video_adapter_t *adp, int page);
typedef int vi_save_palette_t(video_adapter_t *adp, u_char *palette);
typedef int vi_load_palette_t(video_adapter_t *adp, const u_char *palette);
typedef int vi_set_border_t(video_adapter_t *adp, int border);
typedef int vi_save_state_t(video_adapter_t *adp, void *p, size_t size);
typedef int vi_load_state_t(video_adapter_t *adp, void *p);
typedef int vi_set_win_org_t(video_adapter_t *adp, off_t offset);
typedef int vi_read_hw_cursor_t(video_adapter_t *adp, int *col, int *row);
typedef int vi_set_hw_cursor_t(video_adapter_t *adp, int col, int row);
typedef int vi_set_hw_cursor_shape_t(video_adapter_t *adp, int base,
				     int height, int celsize, int blink);
typedef int vi_blank_display_t(video_adapter_t *adp, int mode);
#define V_DISPLAY_ON		0
#define V_DISPLAY_STAND_BY	(1<<0)
#define V_DISPLAY_SUSPEND	(1<<1)
#define V_DISPLAY_OFF		(1<<2)
typedef int vi_mmap_t(video_adapter_t *adp, vm_offset_t offset, int prot);
typedef int vi_ioctl_t(video_adapter_t *adp, u_long cmd, caddr_t data);
typedef int vi_clear_t(video_adapter_t *adp);
typedef int vi_fill_rect_t(video_adapter_t *adp, int val, int x, int y,
			   int cx, int cy);
typedef int vi_bitblt_t(video_adapter_t *adp,...);
typedef int vi_diag_t(video_adapter_t *adp, int level);

typedef struct video_switch {
    vi_probe_t		*probe;
    vi_init_t		*init;
    vi_get_info_t	*get_info;
    vi_query_mode_t	*query_mode;
    vi_set_mode_t	*set_mode;
    vi_save_font_t	*save_font;
    vi_load_font_t	*load_font;
    vi_show_font_t	*show_font;
    vi_save_palette_t	*save_palette;
    vi_load_palette_t	*load_palette;
    vi_set_border_t	*set_border;
    vi_save_state_t	*save_state;
    vi_load_state_t	*load_state;
    vi_set_win_org_t	*set_win_org;
    vi_read_hw_cursor_t	*read_hw_cursor;
    vi_set_hw_cursor_t	*set_hw_cursor;
    vi_set_hw_cursor_shape_t *set_hw_cursor_shape;
    vi_blank_display_t	*blank_display;
    vi_mmap_t		*mmap;
    vi_ioctl_t		*ioctl;
    vi_clear_t		*clear;
    vi_fill_rect_t	*fill_rect;
    vi_bitblt_t		*bitblt;
    int			(*reserved1)(void);
    int			(*reserved2)(void);
    vi_diag_t		*diag;
} video_switch_t;

#define save_palette(adp, pal)				\
	(*vidsw[(adp)->va_index]->save_palette)((adp), (pal))
#define load_palette(adp, pal)				\
	(*vidsw[(adp)->va_index]->load_palette)((adp), (pal))
#define get_mode_info(adp, mode, buf)			\
	(*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
#define set_video_mode(adp, mode)			\
	(*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
#if 0 /* XXX conflicts with syscons' set_border() */
#define set_border(adp, border)				\
	(*vidsw[(adp)->va_index]->set_border)((adp), (border))
#endif
#define set_origin(adp, o)				\
	(*vidsw[(adp)->va_index]->set_win_org)(adp, o)

/* XXX - add more macros */

/* video driver */
typedef struct video_driver {
    char		*name;
    video_switch_t	*vidsw;
    int			(*configure)(int); /* backdoor for the console driver */
} video_driver_t;

#define VIDEO_DRIVER(name, sw, config)			\
	static struct video_driver name##_driver = {	\
		#name, &sw, config			\
	};						\
	DATA_SET(videodriver_set, name##_driver);

/* global variables */
extern struct video_switch **vidsw;

/* functions for the video card driver */
int		vid_register(video_adapter_t *adp);
int		vid_unregister(video_adapter_t *adp);
video_switch_t	*vid_get_switch(char *name);
void		vid_init_struct(video_adapter_t *adp, char *name, int type,
				int unit);

/* functions for the video card client */
int		vid_allocate(char *driver, int unit, void *id);
int		vid_release(video_adapter_t *adp, void *id);
int		vid_find_adapter(char *driver, int unit);
video_adapter_t	*vid_get_adapter(int index);

/* a backdoor for the console driver to tickle the video driver XXX */
int		vid_configure(int flags);
#define VIO_PROBE_ONLY	(1 << 0)	/* probe only, don't initialize */

#ifdef FB_INSTALL_CDEV

/* virtual frame buffer driver functions */
int		fb_attach(cdev_t dev, video_adapter_t *adp);
int		fb_detach(cdev_t dev, video_adapter_t *adp);

/* generic frame buffer cdev driver functions */

typedef struct genfb_softc {
	int		gfb_flags;	/* flag/status bits */
#define FB_OPEN		(1 << 0)
} genfb_softc_t;

int		genfbopen(genfb_softc_t *sc, video_adapter_t *adp,
			  int flag, int mode, struct ucred *cred);
int		genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
			   int flag, int mode);
int		genfbread(genfb_softc_t *sc, video_adapter_t *adp,
			  struct uio *uio, int flag);
int		genfbwrite(genfb_softc_t *sc, video_adapter_t *adp,
			   struct uio *uio, int flag);
int		genfbioctl(genfb_softc_t *sc, video_adapter_t *adp,
			   u_long cmd, caddr_t arg, int flag,
			   struct ucred *cred);
int		genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
			  vm_offset_t offset, int prot);

#endif /* FB_INSTALL_CDEV */

/* generic low-level driver functions */

void		fb_dump_adp_info(char *driver, video_adapter_t *adp, int level);
void		fb_dump_mode_info(char *driver, video_adapter_t *adp,
				  video_info_t *info, int level);
int		fb_type(int adp_type);
int		fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);

#endif /* _KERNEL */

#endif /* !_DEV_FB_FBREG_H_ */
Commit	Line	Data
984263bc MD	1	/*-
	2	* Copyright (c) 1999 Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer as
	10	* the first lines of this file unmodified.
	11	* 2. Redistributions in binary form must reproduce the above copyright
	12	* notice, this list of conditions and the following disclaimer in the
	13	* documentation and/or other materials provided with the distribution.
	14	*
	15	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
	16	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	17	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
	18	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
	19	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
	20	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	21	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	22	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	23	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
	24	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	25	*
	26	* $FreeBSD: src/sys/dev/fb/fbreg.h,v 1.6 1999/12/29 04:35:36 peter Exp $
38379828	27	* $DragonFly: src/sys/dev/video/fb/fbreg.h,v 1.10 2007/08/15 19:31:11 swildner Exp $
984263bc MD	28	*/
	29
	30	#ifndef _DEV_FB_FBREG_H_
	31	#define _DEV_FB_FBREG_H_
	32
	33	#ifdef _KERNEL
	34
	35	#define V_MAX_ADAPTERS 8 /* XXX */
	36
	37	/* some macros */
c1543a89	38	#if defined(__i386__) \|\| defined(__x86_64__)
984263bc MD	39	#define bcopy_io(s, d, c) generic_bcopy((void )(s), (void )(d), (c))
	40	#define bcopy_toio(s, d, c) generic_bcopy((void )(s), (void )(d), (c))
	41	#define bcopy_fromio(s, d, c) generic_bcopy((void )(s), (void )(d), (c))
afaa1d56	42	#define bzero_io(d, c) bzero((void *)(d), (c))
984263bc MD	43	#define fill_io(p, d, c) fill((p), (void *)(d), (c))
	44	#define fillw_io(p, d, c) fillw((p), (void *)(d), (c))
	45	void generic_bcopy(const void s, void d, size_t c);
984263bc MD	46	#else /* !__i386__ */
	47	#define bcopy_io(s, d, c) memcpy_io((d), (s), (c))
	48	#define bcopy_toio(s, d, c) memcpy_toio((d), (void *)(s), (c))
	49	#define bcopy_fromio(s, d, c) memcpy_fromio((void *)(d), (s), (c))
	50	#define bzero_io(d, c) memset_io((d), 0, (c))
	51	#define fill_io(p, d, c) memset_io((d), (p), (c))
	52	#define fillw(p, d, c) memsetw((d), (p), (c))
	53	#define fillw_io(p, d, c) memsetw_io((d), (p), (c))
	54	#endif /* !__i386__ */
	55
	56	/* video function table */
	57	typedef int vi_probe_t(int unit, video_adapter_t *adpp, void arg, int flags);
	58	typedef int vi_init_t(int unit, video_adapter_t *adp, int flags);
	59	typedef int vi_get_info_t(video_adapter_t adp, int mode, video_info_t info);
	60	typedef int vi_query_mode_t(video_adapter_t adp, video_info_t info);
	61	typedef int vi_set_mode_t(video_adapter_t *adp, int mode);
	62	typedef int vi_save_font_t(video_adapter_t *adp, int page, int size,
	63	u_char *data, int c, int count);
	64	typedef int vi_load_font_t(video_adapter_t *adp, int page, int size,
	65	u_char *data, int c, int count);
	66	typedef int vi_show_font_t(video_adapter_t *adp, int page);
	67	typedef int vi_save_palette_t(video_adapter_t adp, u_char palette);
736a05b5	68	typedef int vi_load_palette_t(video_adapter_t adp, const u_char palette);
984263bc MD	69	typedef int vi_set_border_t(video_adapter_t *adp, int border);
	70	typedef int vi_save_state_t(video_adapter_t adp, void p, size_t size);
	71	typedef int vi_load_state_t(video_adapter_t adp, void p);
	72	typedef int vi_set_win_org_t(video_adapter_t *adp, off_t offset);
	73	typedef int vi_read_hw_cursor_t(video_adapter_t adp, int col, int *row);
	74	typedef int vi_set_hw_cursor_t(video_adapter_t *adp, int col, int row);
	75	typedef int vi_set_hw_cursor_shape_t(video_adapter_t *adp, int base,
	76	int height, int celsize, int blink);
	77	typedef int vi_blank_display_t(video_adapter_t *adp, int mode);
	78	#define V_DISPLAY_ON 0
38379828 SW	79	#define V_DISPLAY_STAND_BY (1<<0)
	80	#define V_DISPLAY_SUSPEND (1<<1)
	81	#define V_DISPLAY_OFF (1<<2)
984263bc MD	82	typedef int vi_mmap_t(video_adapter_t *adp, vm_offset_t offset, int prot);
	83	typedef int vi_ioctl_t(video_adapter_t *adp, u_long cmd, caddr_t data);
	84	typedef int vi_clear_t(video_adapter_t *adp);
	85	typedef int vi_fill_rect_t(video_adapter_t *adp, int val, int x, int y,
	86	int cx, int cy);
	87	typedef int vi_bitblt_t(video_adapter_t *adp,...);
	88	typedef int vi_diag_t(video_adapter_t *adp, int level);
	89
	90	typedef struct video_switch {
	91	vi_probe_t *probe;
	92	vi_init_t *init;
	93	vi_get_info_t *get_info;
	94	vi_query_mode_t *query_mode;
	95	vi_set_mode_t *set_mode;
	96	vi_save_font_t *save_font;
	97	vi_load_font_t *load_font;
	98	vi_show_font_t *show_font;
	99	vi_save_palette_t *save_palette;
	100	vi_load_palette_t *load_palette;
	101	vi_set_border_t *set_border;
	102	vi_save_state_t *save_state;
	103	vi_load_state_t *load_state;
	104	vi_set_win_org_t *set_win_org;
	105	vi_read_hw_cursor_t *read_hw_cursor;
	106	vi_set_hw_cursor_t *set_hw_cursor;
	107	vi_set_hw_cursor_shape_t *set_hw_cursor_shape;
	108	vi_blank_display_t *blank_display;
	109	vi_mmap_t *mmap;
	110	vi_ioctl_t *ioctl;
	111	vi_clear_t *clear;
	112	vi_fill_rect_t *fill_rect;
	113	vi_bitblt_t *bitblt;
	114	int (*reserved1)(void);
	115	int (*reserved2)(void);
	116	vi_diag_t *diag;
	117	} video_switch_t;
	118
	119	#define save_palette(adp, pal) \
	120	(*vidsw[(adp)->va_index]->save_palette)((adp), (pal))
	121	#define load_palette(adp, pal) \
	122	(*vidsw[(adp)->va_index]->load_palette)((adp), (pal))
	123	#define get_mode_info(adp, mode, buf) \
	124	(*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
	125	#define set_video_mode(adp, mode) \
	126	(*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
	127	#if 0 /* XXX conflicts with syscons' set_border() */
	128	#define set_border(adp, border) \
	129	(*vidsw[(adp)->va_index]->set_border)((adp), (border))
	130	#endif
	131	#define set_origin(adp, o) \
	132	(*vidsw[(adp)->va_index]->set_win_org)(adp, o)
	133
	134	/* XXX - add more macros */
	135
	136	/* video driver */
	137	typedef struct video_driver {
	138	char *name;
	139	video_switch_t *vidsw;
	140	int (configure)(int); / backdoor for the console driver */
	141	} video_driver_t;
	142
	143	#define VIDEO_DRIVER(name, sw, config) \
	144	static struct video_driver name##_driver = { \
	145	#name, &sw, config \
146	}; \
147	DATA_SET(videodriver_set, name##_driver);
148
149	/* global variables */
150	extern struct video_switch **vidsw;
984263bc MD	151
	152	/* functions for the video card driver */
	153	int vid_register(video_adapter_t *adp);
	154	int vid_unregister(video_adapter_t *adp);
	155	video_switch_t vid_get_switch(char name);
	156	void vid_init_struct(video_adapter_t adp, char name, int type,
	157	int unit);
	158
	159	/* functions for the video card client */
	160	int vid_allocate(char driver, int unit, void id);
	161	int vid_release(video_adapter_t adp, void id);
	162	int vid_find_adapter(char *driver, int unit);
	163	video_adapter_t *vid_get_adapter(int index);
	164
	165	/* a backdoor for the console driver to tickle the video driver XXX */
	166	int vid_configure(int flags);
	167	#define VIO_PROBE_ONLY (1 << 0) /* probe only, don't initialize */
	168
	169	#ifdef FB_INSTALL_CDEV
	170
	171	/* virtual frame buffer driver functions */
b13267a5 MD	172	int fb_attach(cdev_t dev, video_adapter_t *adp);
b13267a5 MD	173	int fb_detach(cdev_t dev, video_adapter_t *adp);
984263bc MD	174
	175	/* generic frame buffer cdev driver functions */
	176
	177	typedef struct genfb_softc {
	178	int gfb_flags; /* flag/status bits */
	179	#define FB_OPEN (1 << 0)
	180	} genfb_softc_t;
	181
	182	int genfbopen(genfb_softc_t sc, video_adapter_t adp,
fef8985e	183	int flag, int mode, struct ucred *cred);
984263bc	184	int genfbclose(genfb_softc_t sc, video_adapter_t adp,
fef8985e	185	int flag, int mode);
984263bc MD	186	int genfbread(genfb_softc_t sc, video_adapter_t adp,
	187	struct uio *uio, int flag);
	188	int genfbwrite(genfb_softc_t sc, video_adapter_t adp,
	189	struct uio *uio, int flag);
	190	int genfbioctl(genfb_softc_t sc, video_adapter_t adp,
fef8985e MD	191	u_long cmd, caddr_t arg, int flag,
fef8985e MD	192	struct ucred *cred);
984263bc MD	193	int genfbmmap(genfb_softc_t sc, video_adapter_t adp,
	194	vm_offset_t offset, int prot);
	195
	196	#endif /* FB_INSTALL_CDEV */
	197
	198	/* generic low-level driver functions */
	199
	200	void fb_dump_adp_info(char driver, video_adapter_t adp, int level);
	201	void fb_dump_mode_info(char driver, video_adapter_t adp,
	202	video_info_t *info, int level);
	203	int fb_type(int adp_type);
	204	int fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);
	205
	206	#endif /* _KERNEL */
	207
	208	#endif /* !_DEV_FB_FBREG_H_ */