/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* 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$
*/
#ifndef _DEV_FB_FBREG_H_
#define _DEV_FB_FBREG_H_
#ifdef _KERNEL
#define V_MAX_ADAPTERS 8 /* XXX */
/* some macros */
#if defined(__amd64__) || defined(__i386__)
static __inline void
copyw(uint16_t *src, uint16_t *dst, size_t size)
{
size >>= 1;
while (size--)
*dst++ = *src++;
}
#define bcopy_io(s, d, c) copyw((void*)(s), (void*)(d), (c))
#define bcopy_toio(s, d, c) copyw((void*)(s), (void*)(d), (c))
#define bcopy_fromio(s, d, c) copyw((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))
#elif defined(__sparc64__)
static __inline void
fillw(int val, uint16_t *buf, size_t size)
{
while (size--)
*buf++ = val;
}
#elif defined(__powerpc__)
#define bcopy_io(s, d, c) ofwfb_bcopy((void *)(s), (void *)(d), (c))
#define bcopy_toio(s, d, c) ofwfb_bcopy((void *)(s), (void *)(d), (c))
#define bcopy_fromio(s, d, c) ofwfb_bcopy((void *)(s), (void *)(d), (c))
#define bzero_io(d, c) ofwfb_bzero((void *)(d), (c))
#define fillw(p, d, c) ofwfb_fillw((p), (void *)(d), (c))
#define fillw_io(p, d, c) ofwfb_fillw((p), (void *)(d), (c))
#define readw(a) ofwfb_readw((u_int16_t *)(a))
#define writew(a, v) ofwfb_writew((u_int16_t *)(a), (v))
void ofwfb_bcopy(const void *s, void *d, size_t c);
void ofwfb_bzero(void *d, size_t c);
void ofwfb_fillw(int pat, void *base, size_t cnt);
u_int16_t ofwfb_readw(u_int16_t *addr);
void ofwfb_writew(u_int16_t *addr, u_int16_t val);
#elif defined(__mips__) || defined(__arm__)
/*
* Use amd64/i386-like settings under the assumption that MIPS-based display
* drivers will have to add a level of indirection between a syscons-managed
* frame buffer and the actual video hardware. We are forced to do this
* because syscons doesn't carry around required busspace handles and tags to
* use here. This is only really a problem for true VGA devices hooked up to
* MIPS, as others will be performing a translation anyway.
*/
#define bcopy_io(s, d, c) memcpy((void *)(d), (void *)(s), (c))
#define bcopy_toio(s, d, c) memcpy((void *)(d), (void *)(s), (c))
#define bcopy_fromio(s, d, c) memcpy((void *)(d), (void *)(s), (c))
#define bzero_io(d, c) memset((void *)(d), 0, (c))
#define fill_io(p, d, c) memset((void *)(d), (p), (c))
static __inline void
fillw(int val, uint16_t *buf, size_t size)
{
while (size--)
*buf++ = val;
}
#define fillw_io(p, d, c) fillw((p), (void *)(d), (c))
#if defined(__arm__)
#define readw(a) (*(uint16_t*)(a))
#define writew(a, v) (*(uint16_t*)(a) = (v))
#endif
#else /* !__i386__ && !__amd64__ && !__sparc64__ && !__powerpc__ */
#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, int width,
u_char *data, int c, int count);
typedef int vi_load_font_t(video_adapter_t *adp, int page, int size, int width,
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, 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);
/* defined in sys/fbio.h
#define V_DISPLAY_ON 0
#define V_DISPLAY_BLANK 1
#define V_DISPLAY_STAND_BY 2
#define V_DISPLAY_SUSPEND 3
*/
typedef int vi_mmap_t(video_adapter_t *adp, vm_ooffset_t offset,
vm_paddr_t *paddr, int prot, vm_memattr_t *memattr);
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 int vi_save_cursor_palette_t(video_adapter_t *adp, u_char *palette);
typedef int vi_load_cursor_palette_t(video_adapter_t *adp, u_char *palette);
typedef int vi_copy_t(video_adapter_t *adp, vm_offset_t src, vm_offset_t dst,
int n);
typedef int vi_putp_t(video_adapter_t *adp, vm_offset_t off, u_int32_t p,
u_int32_t a, int size, int bpp, int bit_ltor,
int byte_ltor);
typedef int vi_putc_t(video_adapter_t *adp, vm_offset_t off, u_int8_t c,
u_int8_t a);
typedef int vi_puts_t(video_adapter_t *adp, vm_offset_t off, u_int16_t *s,
int len);
typedef int vi_putm_t(video_adapter_t *adp, int x, int y, u_int8_t *pixel_image,
u_int32_t pixel_mask, int size, int width);
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;
vi_save_cursor_palette_t *save_cursor_palette;
vi_load_cursor_palette_t *load_cursor_palette;
vi_copy_t *copy;
vi_putp_t *putp;
vi_putc_t *putc;
vi_puts_t *puts;
vi_putm_t *putm;
} video_switch_t;
#define vidd_probe(unit, adpp, arg, flags) \
(*vidsw[(adp)->va_index]->probe)((unit), (adpp), (arg), (flags))
#define vidd_init(unit, adp, flags) \
(*vidsw[(adp)->va_index]->init)((unit), (adp), (flags))
#define vidd_get_info(adp, mode, info) \
(*vidsw[(adp)->va_index]->get_info)((adp), (mode), (info))
#define vidd_query_mode(adp, mode) \
(*vidsw[(adp)->va_index]->query_mode)((adp), (mode))
#define vidd_set_mode(adp, mode) \
(*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
#define vidd_save_font(adp, page, size, width, data, c, count) \
(*vidsw[(adp)->va_index]->save_font)((adp), (page), (size), \
(width), (data), (c), (count))
#define vidd_load_font(adp, page, size, width, data, c, count) \
(*vidsw[(adp)->va_index]->load_font)((adp), (page), (size), \
(width), (data), (c), (count))
#define vidd_show_font(adp, page) \
(*vidsw[(adp)->va_index]->show_font)((adp), (page))
#define vidd_save_palette(adp, pallete) \
(*vidsw[(adp)->va_index]->save_palette)((adp), (pallete))
#define vidd_load_palette(adp, pallete) \
(*vidsw[(adp)->va_index]->load_palette)((adp), (pallete))
#define vidd_set_border(adp, border) \
(*vidsw[(adp)->va_index]->set_border)((adp), (border))
#define vidd_save_state(adp, p, size) \
(*vidsw[(adp)->va_index]->save_state)((adp), (p), (size))
#define vidd_load_state(adp, p) \
(*vidsw[(adp)->va_index]->load_state)((adp), (p))
#define vidd_set_win_org(adp, offset) \
(*vidsw[(adp)->va_index]->set_win_org)((adp), (offset))
#define vidd_read_hw_cursor(adp, col, row) \
(*vidsw[(adp)->va_index]->read_hw_cursor)((adp), (col), (row))
#define vidd_set_hw_cursor(adp, col, row) \
(*vidsw[(adp)->va_index]->set_hw_cursor)((adp), (col), (row))
#define vidd_set_hw_cursor_shape(adp, base, height, celsize, blink) \
(*vidsw[(adp)->va_index]->set_hw_cursor_shape)((adp), (base), \
(height), (celsize), (blink))
#define vidd_blank_display(adp, mode) \
(*vidsw[(adp)->va_index]->blank_display)((adp), (mode))
#define vidd_mmap(adp, offset, paddr, prot, memattr) \
(*vidsw[(adp)->va_index]->mmap)((adp), (offset), (paddr), \
(prot), (memattr))
#define vidd_ioctl(adp, cmd, data) \
(*vidsw[(adp)->va_index]->ioctl)((adp), (cmd), (data))
#define vidd_clear(adp) \
(*vidsw[(adp)->va_index]->clear)((adp))
#define vidd_fill_rect(adp, val, x, y, cx, cy) \
(*vidsw[(adp)->va_index]->fill_rect)((adp), (val), (x), (y), \
(cx), (cy))
#define vidd_bitblt(adp, ...) \
(*vidsw[(adp)->va_index]->bitblt)(adp, __VA_ARGS__)
#define vidd_diag(adp, level) \
(*vidsw[(adp)->va_index]->diag)((adp), (level))
#define vidd_save_cursor_palette(adp, palette) \
(*vidsw[(adp)->va_index]->save_cursor_palette)((adp), (palette))
#define vidd_load_cursor_palette(adp, palette) \
(*vidsw[(adp)->va_index]->load_cursor_palette)((adp), (palette))
#define vidd_copy(adp, src, dst, n) \
(*vidsw[(adp)->va_index]->copy)((adp), (src), (dst), (n))
#define vidd_putp(adp, offset, p, a, size, bpp, bit_ltor1, byte_ltor2) \
(*vidsw[(adp)->va_index]->putp)((adp), (offset), (p), (a), \
(size), (bpp), (bit_ltor1), (bit_ltor2))
#define vidd_putc(adp, offset, c, a) \
(*vidsw[(adp)->va_index]->putc)((adp), (offset), (c), (a))
#define vidd_puts(adp, offset, s, len) \
(*vidsw[(adp)->va_index]->puts)((adp), (offset), (s), (len))
#define vidd_putm(adp, x, y, pixel_image, pixel_mask, size, width) \
(*vidsw[(adp)->va_index]->putm)((adp), (x), (y), (pixel_image), \
(pixel_mask), (size), (width))
/* 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(int unit, video_adapter_t *adp,
struct cdevsw *cdevsw);
int fb_detach(int unit, video_adapter_t *adp,
struct cdevsw *cdevsw);
/* 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 thread *td);
int genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
int flag, int mode, struct thread *td);
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 thread *td);
int genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
vm_ooffset_t offset, vm_paddr_t *paddr,
int prot, vm_memattr_t *memattr);
#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_ */
