/*	$NetBSD: fbvar.h,v 1.12 2008/12/12 18:39:55 macallan Exp $ */

/*
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This software was developed by the Computer Systems Engineering group
 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
 * contributed to Berkeley.
 *
 * All advertising materials mentioning features or use of this software
 * must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Lawrence Berkeley Laboratory.
 *
 * 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.
 * 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.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
 *
 *	@(#)fbvar.h	8.1 (Berkeley) 6/11/93
 */

/*
 * Frame buffer variables.  All frame buffer drivers must provide the
 * following in order to participate.
 */

#include <sys/event.h>

#include <dev/rcons/rcons.h>
#include <dev/wscons/wsdisplayvar.h>
#include <dev/rasops/rasops.h>

struct fbdriver {
	/* device unblank function (force kernel output to display) */
	void	(*fbd_unblank)(device_t);
	int	(*fbd_open)(dev_t, int, int, struct lwp *);
	int	(*fbd_close)(dev_t, int, int, struct lwp *);
	int	(*fbd_ioctl)(dev_t, u_long, void *, int, struct lwp *);
	int	(*fbd_poll)(dev_t, int, struct lwp *);
	paddr_t	(*fbd_mmap)(dev_t, off_t, int);
	int	(*fbd_kqfilter)(dev_t, struct knote *);
#ifdef notyet
	/*
	 * XXX redundant idea? these can hook into rasops on a per-device
	 * basis like: fb_rinfo.ri_ops.copycols = ....;
	 */
	void	(*fbd_wrrop)();		/* `write region' rasterop */
	void	(*fbd_cprop)();		/* `copy region' rasterop */
	void	(*fbd_clrop)();		/* `clear region' rasterop */
#endif
};

struct fbdevice {
	int	fb_major;		/* XXX */
	struct	fbtype fb_type;		/* what it says */
	void *	fb_pixels;		/* display RAM */
	int	fb_linebytes;		/* bytes per display line */

	struct	fbdriver *fb_driver;	/* pointer to driver */
	device_t	fb_device;	/* parameter for fbd_unblank */

	int	fb_flags;		/* misc. flags */
#define	FB_FORCE	0x00000001	/* force device into /dev/fb */
#define	FB_PFOUR	0x00010000	/* indicates fb is a pfour fb */
#define FB_USERMASK	(FB_FORCE)	/* flags that the user can set */

	volatile u_int32_t *fb_pfour;	/* pointer to pfour register */

#ifdef RASTERCONSOLE
	/* Raster console emulator state */
	struct	rconsole fb_rcons;
#endif
	/* for wsdisplay we always need rasops_info */
	struct	rasops_info fb_rinfo;
};

void	fb_attach(struct fbdevice *, int);
void	fb_setsize_obp(struct fbdevice *, int, int, int, int);
void	fb_setsize_eeprom(struct fbdevice *, int, int, int);
void	fb_setsize_pfour(struct fbdevice *);
int	fb_is_console(int);
#ifdef RASTERCONSOLE
void	fbrcons_init(struct fbdevice *);
int	fbrcons_rows(void);
int	fbrcons_cols(void);
#endif

int	fb_pfour_id(volatile void *);
int	fb_pfour_get_video(struct fbdevice *);
void	fb_pfour_set_video(struct fbdevice *, int);
