sys/dev/video/fb/fbreg.h

   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 $
  27  */
  28
  29 #ifndef _DEV_FB_FBREG_H_
  30 #define _DEV_FB_FBREG_H_
  31
  32 #ifdef _KERNEL
  33
  34 #define V_MAX_ADAPTERS          8               /* XXX */
  35
  36 /* some macros */
  37 #define bcopy_io(s, d, c)       bcopy((void *)(s), (void *)(d), (c))
  38 #define bcopy_toio(s, d, c)     bcopy((void *)(s), (void *)(d), (c))
  39 #define bcopy_fromio(s, d, c)   bcopy((void *)(s), (void *)(d), (c))
  40 #define bzero_io(d, c)          bzero((void *)(d), (c))
  41 #define fill_io(p, d, c)        fill((p), (void *)(d), (c))
  42 #define fillw_io(p, d, c)       fillw((p), (void *)(d), (c))
  43
  44 /* video function table */
  45 typedef int vi_probe_t(int unit, video_adapter_t **adpp, void *arg, int flags);
  46 typedef int vi_init_t(int unit, video_adapter_t *adp, int flags);
  47 typedef int vi_get_info_t(video_adapter_t *adp, int mode, video_info_t *info);
  48 typedef int vi_query_mode_t(video_adapter_t *adp, video_info_t *info);
  49 typedef int vi_set_mode_t(video_adapter_t *adp, int mode);
  50 typedef int vi_save_font_t(video_adapter_t *adp, int page, int size,
  51                            u_char *data, int c, int count);
  52 typedef int vi_load_font_t(video_adapter_t *adp, int page, int size,
  53                            u_char *data, int c, int count);
  54 typedef int vi_show_font_t(video_adapter_t *adp, int page);
  55 typedef int vi_save_palette_t(video_adapter_t *adp, u_char *palette);
  56 typedef int vi_load_palette_t(video_adapter_t *adp, const u_char *palette);
  57 typedef int vi_set_border_t(video_adapter_t *adp, int border);
  58 typedef int vi_save_state_t(video_adapter_t *adp, void *p, size_t size);
  59 typedef int vi_load_state_t(video_adapter_t *adp, void *p);
  60 typedef int vi_set_win_org_t(video_adapter_t *adp, off_t offset);
  61 typedef int vi_read_hw_cursor_t(video_adapter_t *adp, int *col, int *row);
  62 typedef int vi_set_hw_cursor_t(video_adapter_t *adp, int col, int row);
  63 typedef int vi_set_hw_cursor_shape_t(video_adapter_t *adp, int base,
  64                                      int height, int celsize, int blink);
  65 typedef int vi_blank_display_t(video_adapter_t *adp, int mode);
  66 #define V_DISPLAY_ON            0
  67 #define V_DISPLAY_STAND_BY      (1<<0)
  68 #define V_DISPLAY_SUSPEND       (1<<1)
  69 #define V_DISPLAY_OFF           (1<<2)
  70 typedef int vi_mmap_t(video_adapter_t *adp, vm_offset_t offset, int prot);
  71 typedef int vi_ioctl_t(video_adapter_t *adp, u_long cmd, caddr_t data);
  72 typedef int vi_clear_t(video_adapter_t *adp);
  73 typedef int vi_fill_rect_t(video_adapter_t *adp, int val, int x, int y,
  74                            int cx, int cy);
  75 typedef int vi_bitblt_t(video_adapter_t *adp,...);
  76 typedef int vi_diag_t(video_adapter_t *adp, int level);
  77
  78 typedef struct video_switch {
  79     vi_probe_t          *probe;
  80     vi_init_t           *init;
  81     vi_get_info_t       *get_info;
  82     vi_query_mode_t     *query_mode;
  83     vi_set_mode_t       *set_mode;
  84     vi_save_font_t      *save_font;
  85     vi_load_font_t      *load_font;
  86     vi_show_font_t      *show_font;
  87     vi_save_palette_t   *save_palette;
  88     vi_load_palette_t   *load_palette;
  89     vi_set_border_t     *set_border;
  90     vi_save_state_t     *save_state;
  91     vi_load_state_t     *load_state;
  92     vi_set_win_org_t    *set_win_org;
  93     vi_read_hw_cursor_t *read_hw_cursor;
  94     vi_set_hw_cursor_t  *set_hw_cursor;
  95     vi_set_hw_cursor_shape_t *set_hw_cursor_shape;
  96     vi_blank_display_t  *blank_display;
  97     vi_mmap_t           *mmap;
  98     vi_ioctl_t          *ioctl;
  99     vi_clear_t          *clear;
 100     vi_fill_rect_t      *fill_rect;
 101     vi_bitblt_t         *bitblt;
 102     int                 (*reserved1)(void);
 103     int                 (*reserved2)(void);
 104     vi_diag_t           *diag;
 105 } video_switch_t;
 106
 107 #define save_palette(adp, pal)                          \
 108         do {                                            \
 109                 lwkt_gettoken(&tty_token);              \
 110                 (*vidsw[(adp)->va_index]->save_palette)((adp), (pal)); \
 111                 lwkt_reltoken(&tty_token);              \
 112         } while (0)
 113
 114 #define load_palette(adp, pal)                          \
 115         do {                                            \
 116                 lwkt_gettoken(&tty_token);              \
 117                 (*vidsw[(adp)->va_index]->load_palette)((adp), (pal)); \
 118                 lwkt_reltoken(&tty_token);              \
 119         } while (0)
 120
 121 #define get_mode_info(adp, mode, buf)                   \
 122         (*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
 123
 124 #define set_video_mode(adp, mode)                       \
 125         (*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
 126
 127 #if 0 /* XXX conflicts with syscons' set_border() */
 128 #define set_border(adp, border)                         \
 129         do {                                            \
 130                 lwkt_gettoken(&tty_token);              \
 131                 (*vidsw[(adp)->va_index]->set_border)((adp), (border)); \
 132                 lwkt_reltoken(&tty_token);              \
 133         } while (0)
 134 #endif
 135
 136 #define set_origin(adp, o)                              \
 137         do {                                            \
 138                 lwkt_gettoken(&tty_token);              \
 139                 (*vidsw[(adp)->va_index]->set_win_org)(adp, o); \
 140                 lwkt_reltoken(&tty_token);              \
 141         } while (0)
 142
 143 /* XXX - add more macros */
 144
 145 /* video driver */
 146 typedef struct video_driver {
 147     char                *name;
 148     video_switch_t      *vidsw;
 149     int                 (*configure)(int); /* backdoor for the console driver */
 150 } video_driver_t;
 151
 152 #define VIDEO_DRIVER(name, sw, config)                  \
 153         static struct video_driver name##_driver = {    \
 154                 #name, &sw, config                      \
 155         };                                              \
 156         DATA_SET(videodriver_set, name##_driver);
 157
 158 /* global variables */
 159 extern struct video_switch **vidsw;
 160
 161 /* functions for the video card driver */
 162 int             vid_register(video_adapter_t *adp);
 163 int             vid_unregister(video_adapter_t *adp);
 164 video_switch_t  *vid_get_switch(char *name);
 165 void            vid_init_struct(video_adapter_t *adp, char *name, int type,
 166                                 int unit);
 167
 168 /* functions for the video card client */
 169 int             vid_allocate(char *driver, int unit, void *id);
 170 int             vid_release(video_adapter_t *adp, void *id);
 171 int             vid_find_adapter(char *driver, int unit);
 172 video_adapter_t *vid_get_adapter(int index);
 173
 174 /* a backdoor for the console driver to tickle the video driver XXX */
 175 int             vid_configure(int flags);
 176 #define VIO_PROBE_ONLY  (1 << 0)        /* probe only, don't initialize */
 177
 178 #ifdef FB_INSTALL_CDEV
 179
 180 /* virtual frame buffer driver functions */
 181 int             fb_attach(cdev_t dev, video_adapter_t *adp);
 182 int             fb_detach(cdev_t dev, video_adapter_t *adp);
 183
 184 /* generic frame buffer cdev driver functions */
 185
 186 typedef struct genfb_softc {
 187         int             gfb_flags;      /* flag/status bits */
 188 #define FB_OPEN         (1 << 0)
 189 } genfb_softc_t;
 190
 191 int             genfbopen(genfb_softc_t *sc, video_adapter_t *adp,
 192                           int flag, int mode, struct ucred *cred);
 193 int             genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
 194                            int flag, int mode);
 195 int             genfbread(genfb_softc_t *sc, video_adapter_t *adp,
 196                           struct uio *uio, int flag);
 197 int             genfbwrite(genfb_softc_t *sc, video_adapter_t *adp,
 198                            struct uio *uio, int flag);
 199 int             genfbioctl(genfb_softc_t *sc, video_adapter_t *adp,
 200                            u_long cmd, caddr_t arg, int flag,
 201                            struct ucred *cred);
 202 int             genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
 203                           vm_offset_t offset, int prot);
 204
 205 #endif /* FB_INSTALL_CDEV */
 206
 207 /* generic low-level driver functions */
 208
 209 void            fb_dump_adp_info(char *driver, video_adapter_t *adp, int level);
 210 void            fb_dump_mode_info(char *driver, video_adapter_t *adp,
 211                                   video_info_t *info, int level);
 212 int             fb_type(int adp_type);
 213 int             fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);
 214
 215 #endif /* _KERNEL */
 216
 217 #endif /* !_DEV_FB_FBREG_H_ */