USB: Fix a bug on appledisplay.c regarding signedness
[linux-2.6.git] / drivers / usb / misc / sisusbvga / sisusb.h
1 /*
2  * sisusb - usb kernel driver for Net2280/SiS315 based USB2VGA dongles
3  *
4  * Copyright (C) 2005 by Thomas Winischhofer, Vienna, Austria
5  *
6  * If distributed as part of the Linux kernel, this code is licensed under the
7  * terms of the GPL v2.
8  *
9  * Otherwise, the following license terms apply:
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1) Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2) Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3) The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESSED OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Author:      Thomas Winischhofer <thomas@winischhofer.net>
34  *
35  */
36
37 #ifndef _SISUSB_H_
38 #define _SISUSB_H_
39
40 #ifdef CONFIG_COMPAT
41 #define SISUSB_NEW_CONFIG_COMPAT
42 #endif
43
44 #include <linux/mutex.h>
45
46 /* For older kernels, support for text consoles is by default
47  * off. To enable text console support, change the following:
48  */
49 /* #define CONFIG_USB_SISUSBVGA_CON */
50
51 /* Version Information */
52
53 #define SISUSB_VERSION          0
54 #define SISUSB_REVISION         0
55 #define SISUSB_PATCHLEVEL       8
56
57 /* Include console and mode switching code? */
58
59 #ifdef CONFIG_USB_SISUSBVGA_CON
60 #define INCL_SISUSB_CON         1
61 #endif
62
63 #include <linux/console.h>
64 #include <linux/vt_kern.h>
65 #include "sisusb_struct.h"
66
67 /* USB related */
68
69 #define SISUSB_MINOR            133     /* official */
70
71 /* Size of the sisusb input/output buffers */
72 #define SISUSB_IBUF_SIZE  0x01000
73 #define SISUSB_OBUF_SIZE  0x10000       /* fixed */
74
75 #define NUMOBUFS 8              /* max number of output buffers/output URBs */
76
77 /* About endianness:
78  *
79  * 1) I/O ports, PCI config registers. The read/write()
80  *    calls emulate inX/outX. Hence, the data is
81  *    expected/delivered in machine endiannes by this
82  *    driver.
83  * 2) Video memory. The data is copied 1:1. There is
84  *    no swapping. Ever. This means for userland that
85  *    the data has to be prepared properly. (Hint:
86  *    think graphics data format, command queue,
87  *    hardware cursor.)
88  * 3) MMIO. Data is copied 1:1. MMIO must be swapped
89  *    properly by userland.
90  *
91  */
92
93 #ifdef __BIG_ENDIAN
94 #define SISUSB_CORRECT_ENDIANNESS_PACKET(p)             \
95         do {                                            \
96                 p->header  = cpu_to_le16(p->header);    \
97                 p->address = cpu_to_le32(p->address);   \
98                 p->data    = cpu_to_le32(p->data);      \
99         } while(0)
100 #else
101 #define SISUSB_CORRECT_ENDIANNESS_PACKET(p)
102 #endif
103
104 struct sisusb_usb_data;
105
106 struct sisusb_urb_context {     /* urb->context for outbound bulk URBs */
107         struct sisusb_usb_data *sisusb;
108         int urbindex;
109         int *actual_length;
110 };
111
112 struct sisusb_usb_data {
113         struct usb_device *sisusb_dev;
114         struct usb_interface *interface;
115         struct kref kref;
116         wait_queue_head_t wait_q;       /* for syncind and timeouts */
117         struct mutex lock;      /* general race avoidance */
118         unsigned int ifnum;     /* interface number of the USB device */
119         int minor;              /* minor (for logging clarity) */
120         int isopen;             /* !=0 if open */
121         int present;            /* !=0 if device is present on the bus */
122         int ready;              /* !=0 if device is ready for userland */
123         int numobufs;           /* number of obufs = number of out urbs */
124         char *obuf[NUMOBUFS], *ibuf;    /* transfer buffers */
125         int obufsize, ibufsize;
126         struct urb *sisurbout[NUMOBUFS];
127         struct urb *sisurbin;
128         unsigned char urbstatus[NUMOBUFS];
129         unsigned char completein;
130         struct sisusb_urb_context urbout_context[NUMOBUFS];
131         unsigned long flagb0;
132         unsigned long vrambase; /* framebuffer base */
133         unsigned int vramsize;  /* framebuffer size (bytes) */
134         unsigned long mmiobase;
135         unsigned int mmiosize;
136         unsigned long ioportbase;
137         unsigned char devinit;  /* device initialized? */
138         unsigned char gfxinit;  /* graphics core initialized? */
139         unsigned short chipid, chipvendor;
140         unsigned short chiprevision;
141 #ifdef INCL_SISUSB_CON
142         struct SiS_Private *SiS_Pr;
143         unsigned long scrbuf;
144         unsigned int scrbuf_size;
145         int haveconsole, con_first, con_last;
146         int havethisconsole[MAX_NR_CONSOLES];
147         int textmodedestroyed;
148         unsigned int sisusb_num_columns;        /* real number, not vt's idea */
149         int cur_start_addr, con_rolled_over;
150         int sisusb_cursor_loc, bad_cursor_pos;
151         int sisusb_cursor_size_from;
152         int sisusb_cursor_size_to;
153         int current_font_height, current_font_512;
154         int font_backup_size, font_backup_height, font_backup_512;
155         char *font_backup;
156         int font_slot;
157         struct vc_data *sisusb_display_fg;
158         int is_gfx;
159         int con_blanked;
160 #endif
161 };
162
163 #define to_sisusb_dev(d) container_of(d, struct sisusb_usb_data, kref)
164
165 /* USB transport related */
166
167 /* urbstatus */
168 #define SU_URB_BUSY   1
169 #define SU_URB_ALLOC  2
170
171 /* Endpoints */
172
173 #define SISUSB_EP_GFX_IN        0x0e    /* gfx std packet out(0e)/in(8e) */
174 #define SISUSB_EP_GFX_OUT       0x0e
175
176 #define SISUSB_EP_GFX_BULK_OUT  0x01    /* gfx mem bulk out/in */
177 #define SISUSB_EP_GFX_BULK_IN   0x02    /* ? 2 is "OUT" ? */
178
179 #define SISUSB_EP_GFX_LBULK_OUT 0x03    /* gfx large mem bulk out */
180
181 #define SISUSB_EP_UNKNOWN_04    0x04    /* ? 4 is "OUT" ? - unused */
182
183 #define SISUSB_EP_BRIDGE_IN     0x0d    /* Net2280 out(0d)/in(8d) */
184 #define SISUSB_EP_BRIDGE_OUT    0x0d
185
186 #define SISUSB_TYPE_MEM         0
187 #define SISUSB_TYPE_IO          1
188
189 struct sisusb_packet {
190         unsigned short header;
191         u32 address;
192         u32 data;
193 } __attribute__ ((__packed__));
194
195 #define CLEARPACKET(packet) memset(packet, 0, 10)
196
197 /* PCI bridge related */
198
199 #define SISUSB_PCI_MEMBASE      0xd0000000
200 #define SISUSB_PCI_MMIOBASE     0xe4000000
201 #define SISUSB_PCI_IOPORTBASE   0x0000d000
202
203 #define SISUSB_PCI_PSEUDO_MEMBASE       0x10000000
204 #define SISUSB_PCI_PSEUDO_MMIOBASE      0x20000000
205 #define SISUSB_PCI_PSEUDO_IOPORTBASE    0x0000d000
206 #define SISUSB_PCI_PSEUDO_PCIBASE       0x00010000
207
208 #define SISUSB_PCI_MMIOSIZE     (128*1024)
209 #define SISUSB_PCI_PCONFSIZE    0x5c
210
211 /* graphics core related */
212
213 #define AROFFSET        0x40
214 #define ARROFFSET       0x41
215 #define GROFFSET        0x4e
216 #define SROFFSET        0x44
217 #define CROFFSET        0x54
218 #define MISCROFFSET     0x4c
219 #define MISCWOFFSET     0x42
220 #define INPUTSTATOFFSET 0x5A
221 #define PART1OFFSET     0x04
222 #define PART2OFFSET     0x10
223 #define PART3OFFSET     0x12
224 #define PART4OFFSET     0x14
225 #define PART5OFFSET     0x16
226 #define CAPTUREOFFSET   0x00
227 #define VIDEOOFFSET     0x02
228 #define COLREGOFFSET    0x48
229 #define PELMASKOFFSET   0x46
230 #define VGAENABLE       0x43
231
232 #define SISAR           SISUSB_PCI_IOPORTBASE + AROFFSET
233 #define SISARR          SISUSB_PCI_IOPORTBASE + ARROFFSET
234 #define SISGR           SISUSB_PCI_IOPORTBASE + GROFFSET
235 #define SISSR           SISUSB_PCI_IOPORTBASE + SROFFSET
236 #define SISCR           SISUSB_PCI_IOPORTBASE + CROFFSET
237 #define SISMISCR        SISUSB_PCI_IOPORTBASE + MISCROFFSET
238 #define SISMISCW        SISUSB_PCI_IOPORTBASE + MISCWOFFSET
239 #define SISINPSTAT      SISUSB_PCI_IOPORTBASE + INPUTSTATOFFSET
240 #define SISPART1        SISUSB_PCI_IOPORTBASE + PART1OFFSET
241 #define SISPART2        SISUSB_PCI_IOPORTBASE + PART2OFFSET
242 #define SISPART3        SISUSB_PCI_IOPORTBASE + PART3OFFSET
243 #define SISPART4        SISUSB_PCI_IOPORTBASE + PART4OFFSET
244 #define SISPART5        SISUSB_PCI_IOPORTBASE + PART5OFFSET
245 #define SISCAP          SISUSB_PCI_IOPORTBASE + CAPTUREOFFSET
246 #define SISVID          SISUSB_PCI_IOPORTBASE + VIDEOOFFSET
247 #define SISCOLIDXR      SISUSB_PCI_IOPORTBASE + COLREGOFFSET - 1
248 #define SISCOLIDX       SISUSB_PCI_IOPORTBASE + COLREGOFFSET
249 #define SISCOLDATA      SISUSB_PCI_IOPORTBASE + COLREGOFFSET + 1
250 #define SISCOL2IDX      SISPART5
251 #define SISCOL2DATA     SISPART5 + 1
252 #define SISPEL          SISUSB_PCI_IOPORTBASE + PELMASKOFFSET
253 #define SISVGAEN        SISUSB_PCI_IOPORTBASE + VGAENABLE
254 #define SISDACA         SISCOLIDX
255 #define SISDACD         SISCOLDATA
256
257 /* ioctl related */
258
259 /* Structure argument for SISUSB_GET_INFO ioctl  */
260 struct sisusb_info {
261         __u32 sisusb_id;        /* for identifying sisusb */
262 #define SISUSB_ID  0x53495355   /* Identify myself with 'SISU' */
263         __u8 sisusb_version;
264         __u8 sisusb_revision;
265         __u8 sisusb_patchlevel;
266         __u8 sisusb_gfxinit;    /* graphics core initialized? */
267
268         __u32 sisusb_vrambase;
269         __u32 sisusb_mmiobase;
270         __u32 sisusb_iobase;
271         __u32 sisusb_pcibase;
272
273         __u32 sisusb_vramsize;  /* framebuffer size in bytes */
274
275         __u32 sisusb_minor;
276
277         __u32 sisusb_fbdevactive;       /* != 0 if framebuffer device active */
278
279         __u32 sisusb_conactive; /* != 0 if console driver active */
280
281         __u8 sisusb_reserved[28];       /* for future use */
282 };
283
284 struct sisusb_command {
285         __u8 operation;         /* see below */
286         __u8 data0;             /* operation dependent */
287         __u8 data1;             /* operation dependent */
288         __u8 data2;             /* operation dependent */
289         __u32 data3;            /* operation dependent */
290         __u32 data4;            /* for future use */
291 };
292
293 #define SUCMD_GET       0x01    /* for all: data0 = index, data3 = port */
294 #define SUCMD_SET       0x02    /* data1 = value */
295 #define SUCMD_SETOR     0x03    /* data1 = or */
296 #define SUCMD_SETAND    0x04    /* data1 = and */
297 #define SUCMD_SETANDOR  0x05    /* data1 = and, data2 = or */
298 #define SUCMD_SETMASK   0x06    /* data1 = data, data2 = mask */
299
300 #define SUCMD_CLRSCR    0x07    /* data0:1:2 = length, data3 = address */
301
302 #define SUCMD_HANDLETEXTMODE 0x08       /* Reset/destroy text mode */
303
304 #define SUCMD_SETMODE   0x09    /* Set a display mode (data3 = SiS mode) */
305 #define SUCMD_SETVESAMODE 0x0a  /* Set a display mode (data3 = VESA mode) */
306
307 #define SISUSB_COMMAND          _IOWR(0xF3,0x3D,struct sisusb_command)
308 #define SISUSB_GET_CONFIG_SIZE  _IOR(0xF3,0x3E,__u32)
309 #define SISUSB_GET_CONFIG       _IOR(0xF3,0x3F,struct sisusb_info)
310
311 #endif /* SISUSB_H */