144b3a4e9e5f06f1e7bd06d0046cb3e6730b6f01
[dragonfly.git] / 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  * $DragonFly: src/sys/dev/video/fb/fbreg.h,v 1.10 2007/08/15 19:31:11 swildner Exp $
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 */
38 #if defined(__i386__) || defined(__x86_64__)
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))
42 #define bzero_io(d, c)          bzero((void *)(d), (c))
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);
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);
68 typedef int vi_load_palette_t(video_adapter_t *adp, const u_char *palette);
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
79 #define V_DISPLAY_STAND_BY      (1<<0)
80 #define V_DISPLAY_SUSPEND       (1<<1)
81 #define V_DISPLAY_OFF           (1<<2)
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         lwkt_gettoken(&tty_token);                      \
121         (*vidsw[(adp)->va_index]->save_palette)((adp), (pal)); \
122         lwkt_reltoken(&tty_token)
123 #define load_palette(adp, pal)                          \
124         lwkt_gettoken(&tty_token);                      \
125         (*vidsw[(adp)->va_index]->load_palette)((adp), (pal)); \
126         lwkt_reltoken(&tty_token)
127 #define get_mode_info(adp, mode, buf)                   \
128         (*vidsw[(adp)->va_index]->get_info)((adp), (mode), (buf))
129 #define set_video_mode(adp, mode)                       \
130         (*vidsw[(adp)->va_index]->set_mode)((adp), (mode))
131 #if 0 /* XXX conflicts with syscons' set_border() */
132 #define set_border(adp, border)                         \
133         lwkt_gettoken(&tty_token);                      \
134         (*vidsw[(adp)->va_index]->set_border)((adp), (border)); \
135         lwkt_reltoken(&tty_token)
136 #endif
137 #define set_origin(adp, o)                              \
138         lwkt_gettoken(&tty_token);                      \
139         (*vidsw[(adp)->va_index]->set_win_org)(adp, o); \
140         lwkt_reltoken(&tty_token)
141
142 /* XXX - add more macros */
143
144 /* video driver */
145 typedef struct video_driver {
146     char                *name;
147     video_switch_t      *vidsw;
148     int                 (*configure)(int); /* backdoor for the console driver */
149 } video_driver_t;
150
151 #define VIDEO_DRIVER(name, sw, config)                  \
152         static struct video_driver name##_driver = {    \
153                 #name, &sw, config                      \
154         };                                              \
155         DATA_SET(videodriver_set, name##_driver);
156
157 /* global variables */
158 extern struct video_switch **vidsw;
159
160 /* functions for the video card driver */
161 int             vid_register(video_adapter_t *adp);
162 int             vid_unregister(video_adapter_t *adp);
163 video_switch_t  *vid_get_switch(char *name);
164 void            vid_init_struct(video_adapter_t *adp, char *name, int type,
165                                 int unit);
166
167 /* functions for the video card client */
168 int             vid_allocate(char *driver, int unit, void *id);
169 int             vid_release(video_adapter_t *adp, void *id);
170 int             vid_find_adapter(char *driver, int unit);
171 video_adapter_t *vid_get_adapter(int index);
172
173 /* a backdoor for the console driver to tickle the video driver XXX */
174 int             vid_configure(int flags);
175 #define VIO_PROBE_ONLY  (1 << 0)        /* probe only, don't initialize */
176
177 #ifdef FB_INSTALL_CDEV
178
179 /* virtual frame buffer driver functions */
180 int             fb_attach(cdev_t dev, video_adapter_t *adp);
181 int             fb_detach(cdev_t dev, video_adapter_t *adp);
182
183 /* generic frame buffer cdev driver functions */
184
185 typedef struct genfb_softc {
186         int             gfb_flags;      /* flag/status bits */
187 #define FB_OPEN         (1 << 0)
188 } genfb_softc_t;
189
190 int             genfbopen(genfb_softc_t *sc, video_adapter_t *adp,
191                           int flag, int mode, struct ucred *cred);
192 int             genfbclose(genfb_softc_t *sc, video_adapter_t *adp,
193                            int flag, int mode);
194 int             genfbread(genfb_softc_t *sc, video_adapter_t *adp,
195                           struct uio *uio, int flag);
196 int             genfbwrite(genfb_softc_t *sc, video_adapter_t *adp,
197                            struct uio *uio, int flag);
198 int             genfbioctl(genfb_softc_t *sc, video_adapter_t *adp,
199                            u_long cmd, caddr_t arg, int flag,
200                            struct ucred *cred);
201 int             genfbmmap(genfb_softc_t *sc, video_adapter_t *adp,
202                           vm_offset_t offset, int prot);
203
204 #endif /* FB_INSTALL_CDEV */
205
206 /* generic low-level driver functions */
207
208 void            fb_dump_adp_info(char *driver, video_adapter_t *adp, int level);
209 void            fb_dump_mode_info(char *driver, video_adapter_t *adp,
210                                   video_info_t *info, int level);
211 int             fb_type(int adp_type);
212 int             fb_commonioctl(video_adapter_t *adp, u_long cmd, caddr_t arg);
213
214 #endif /* _KERNEL */
215
216 #endif /* !_DEV_FB_FBREG_H_ */