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 ensable text console support, change the following: 48 */ 49 50/* Version Information */ 51 52#define SISUSB_VERSION 0 53#define SISUSB_REVISION 0 54#define SISUSB_PATCHLEVEL 8 55 56/* Include console and mode switching code? */ 57 58#ifdef CONFIG_USB_SISUSBVGA_CON 59#define INCL_SISUSB_CON 1 60#endif 61 62#include <linux/console.h> 63#include <linux/vt_kern.h> 64#include "sisusb_struct.h" 65 66/* USB related */ 67 68#define SISUSB_MINOR 133 /* official */ 69 70/* Size of the sisusb input/output buffers */ 71#define SISUSB_IBUF_SIZE 0x01000 72#define SISUSB_OBUF_SIZE 0x10000 /* fixed */ 73 74#define NUMOBUFS 8 /* max number of output buffers/output URBs */ 75 76/* About endianness: 77 * 78 * 1) I/O ports, PCI config registers. The read/write() 79 * calls emulate inX/outX. Hence, the data is 80 * expected/delivered in machine endiannes by this 81 * driver. 82 * 2) Video memory. The data is copied 1:1. There is 83 * no swapping. Ever. This means for userland that 84 * the data has to be prepared properly. (Hint: 85 * think graphics data format, command queue, 86 * hardware cursor.) 87 * 3) MMIO. Data is copied 1:1. MMIO must be swapped 88 * properly by userland. 89 * 90 */ 91 92#ifdef __BIG_ENDIAN 93#define SISUSB_CORRECT_ENDIANNESS_PACKET(p) \ 94 do { \ 95 p->header = cpu_to_le16(p->header); \ 96 p->address = cpu_to_le32(p->address); \ 97 p->data = cpu_to_le32(p->data); \ 98 } while(0) 99#else 100#define SISUSB_CORRECT_ENDIANNESS_PACKET(p) 101#endif 102 103struct sisusb_usb_data; 104 105struct sisusb_urb_context { /* urb->context for outbound bulk URBs */ 106 struct sisusb_usb_data *sisusb; 107 int urbindex; 108 int *actual_length; 109}; 110 111struct sisusb_usb_data { 112 struct usb_device *sisusb_dev; 113 struct usb_interface *interface; 114 struct kref kref; 115 wait_queue_head_t wait_q; /* for syncind and timeouts */ 116 struct mutex lock; /* general race avoidance */ 117 unsigned int ifnum; /* interface number of the USB device */ 118 int minor; /* minor (for logging clarity) */ 119 int isopen; /* !=0 if open */ 120 int present; /* !=0 if device is present on the bus */ 121 int ready; /* !=0 if device is ready for userland */ 122#ifdef SISUSB_OLD_CONFIG_COMPAT 123 int ioctl32registered; 124#endif 125 int numobufs; /* number of obufs = number of out urbs */ 126 char *obuf[NUMOBUFS], *ibuf; /* transfer buffers */ 127 int obufsize, ibufsize; 128 dma_addr_t transfer_dma_out[NUMOBUFS]; 129 dma_addr_t transfer_dma_in; 130 struct urb *sisurbout[NUMOBUFS]; 131 struct urb *sisurbin; 132 unsigned char urbstatus[NUMOBUFS]; 133 unsigned char completein; 134 struct sisusb_urb_context urbout_context[NUMOBUFS]; 135 unsigned long flagb0; 136 unsigned long vrambase; /* framebuffer base */ 137 unsigned int vramsize; /* framebuffer size (bytes) */ 138 unsigned long mmiobase; 139 unsigned int mmiosize; 140 unsigned long ioportbase; 141 unsigned char devinit; /* device initialized? */ 142 unsigned char gfxinit; /* graphics core initialized? */ 143 unsigned short chipid, chipvendor; 144 unsigned short chiprevision; 145#ifdef INCL_SISUSB_CON 146 struct SiS_Private *SiS_Pr; 147 unsigned long scrbuf; 148 unsigned int scrbuf_size; 149 int haveconsole, con_first, con_last; 150 int havethisconsole[MAX_NR_CONSOLES]; 151 int textmodedestroyed; 152 unsigned int sisusb_num_columns; /* real number, not vt's idea */ 153 int cur_start_addr, con_rolled_over; 154 int sisusb_cursor_loc, bad_cursor_pos; 155 int sisusb_cursor_size_from; 156 int sisusb_cursor_size_to; 157 int current_font_height, current_font_512; 158 int font_backup_size, font_backup_height, font_backup_512; 159 char *font_backup; 160 int font_slot; 161 struct vc_data *sisusb_display_fg; 162 int is_gfx; 163 int con_blanked; 164#endif 165}; 166 167#define to_sisusb_dev(d) container_of(d, struct sisusb_usb_data, kref) 168 169/* USB transport related */ 170 171/* urbstatus */ 172#define SU_URB_BUSY 1 173#define SU_URB_ALLOC 2 174 175/* Endpoints */ 176 177#define SISUSB_EP_GFX_IN 0x0e /* gfx std packet out(0e)/in(8e) */ 178#define SISUSB_EP_GFX_OUT 0x0e 179 180#define SISUSB_EP_GFX_BULK_OUT 0x01 /* gfx mem bulk out/in */ 181#define SISUSB_EP_GFX_BULK_IN 0x02 /* ? 2 is "OUT" ? */ 182 183#define SISUSB_EP_GFX_LBULK_OUT 0x03 /* gfx large mem bulk out */ 184 185#define SISUSB_EP_UNKNOWN_04 0x04 /* ? 4 is "OUT" ? - unused */ 186 187#define SISUSB_EP_BRIDGE_IN 0x0d /* Net2280 out(0d)/in(8d) */ 188#define SISUSB_EP_BRIDGE_OUT 0x0d 189 190#define SISUSB_TYPE_MEM 0 191#define SISUSB_TYPE_IO 1 192 193struct sisusb_packet { 194 unsigned short header; 195 u32 address; 196 u32 data; 197} __attribute__((__packed__)); 198 199#define CLEARPACKET(packet) memset(packet, 0, 10) 200 201/* PCI bridge related */ 202 203#define SISUSB_PCI_MEMBASE 0xd0000000 204#define SISUSB_PCI_MMIOBASE 0xe4000000 205#define SISUSB_PCI_IOPORTBASE 0x0000d000 206 207#define SISUSB_PCI_PSEUDO_MEMBASE 0x10000000 208#define SISUSB_PCI_PSEUDO_MMIOBASE 0x20000000 209#define SISUSB_PCI_PSEUDO_IOPORTBASE 0x0000d000 210#define SISUSB_PCI_PSEUDO_PCIBASE 0x00010000 211 212#define SISUSB_PCI_MMIOSIZE (128*1024) 213#define SISUSB_PCI_PCONFSIZE 0x5c 214 215/* graphics core related */ 216 217#define AROFFSET 0x40 218#define ARROFFSET 0x41 219#define GROFFSET 0x4e 220#define SROFFSET 0x44 221#define CROFFSET 0x54 222#define MISCROFFSET 0x4c 223#define MISCWOFFSET 0x42 224#define INPUTSTATOFFSET 0x5A 225#define PART1OFFSET 0x04 226#define PART2OFFSET 0x10 227#define PART3OFFSET 0x12 228#define PART4OFFSET 0x14 229#define PART5OFFSET 0x16 230#define CAPTUREOFFSET 0x00 231#define VIDEOOFFSET 0x02 232#define COLREGOFFSET 0x48 233#define PELMASKOFFSET 0x46 234#define VGAENABLE 0x43 235 236#define SISAR SISUSB_PCI_IOPORTBASE + AROFFSET 237#define SISARR SISUSB_PCI_IOPORTBASE + ARROFFSET 238#define SISGR SISUSB_PCI_IOPORTBASE + GROFFSET 239#define SISSR SISUSB_PCI_IOPORTBASE + SROFFSET 240#define SISCR SISUSB_PCI_IOPORTBASE + CROFFSET 241#define SISMISCR SISUSB_PCI_IOPORTBASE + MISCROFFSET 242#define SISMISCW SISUSB_PCI_IOPORTBASE + MISCWOFFSET 243#define SISINPSTAT SISUSB_PCI_IOPORTBASE + INPUTSTATOFFSET 244#define SISPART1 SISUSB_PCI_IOPORTBASE + PART1OFFSET 245#define SISPART2 SISUSB_PCI_IOPORTBASE + PART2OFFSET 246#define SISPART3 SISUSB_PCI_IOPORTBASE + PART3OFFSET 247#define SISPART4 SISUSB_PCI_IOPORTBASE + PART4OFFSET 248#define SISPART5 SISUSB_PCI_IOPORTBASE + PART5OFFSET 249#define SISCAP SISUSB_PCI_IOPORTBASE + CAPTUREOFFSET 250#define SISVID SISUSB_PCI_IOPORTBASE + VIDEOOFFSET 251#define SISCOLIDXR SISUSB_PCI_IOPORTBASE + COLREGOFFSET - 1 252#define SISCOLIDX SISUSB_PCI_IOPORTBASE + COLREGOFFSET 253#define SISCOLDATA SISUSB_PCI_IOPORTBASE + COLREGOFFSET + 1 254#define SISCOL2IDX SISPART5 255#define SISCOL2DATA SISPART5 + 1 256#define SISPEL SISUSB_PCI_IOPORTBASE + PELMASKOFFSET 257#define SISVGAEN SISUSB_PCI_IOPORTBASE + VGAENABLE 258#define SISDACA SISCOLIDX 259#define SISDACD SISCOLDATA 260 261/* ioctl related */ 262 263/* Structure argument for SISUSB_GET_INFO ioctl */ 264struct sisusb_info { 265 __u32 sisusb_id; /* for identifying sisusb */ 266#define SISUSB_ID 0x53495355 /* Identify myself with 'SISU' */ 267 __u8 sisusb_version; 268 __u8 sisusb_revision; 269 __u8 sisusb_patchlevel; 270 __u8 sisusb_gfxinit; /* graphics core initialized? */ 271 272 __u32 sisusb_vrambase; 273 __u32 sisusb_mmiobase; 274 __u32 sisusb_iobase; 275 __u32 sisusb_pcibase; 276 277 __u32 sisusb_vramsize; /* framebuffer size in bytes */ 278 279 __u32 sisusb_minor; 280 281 __u32 sisusb_fbdevactive; /* != 0 if framebuffer device active */ 282 283 __u32 sisusb_conactive; /* != 0 if console driver active */ 284 285 __u8 sisusb_reserved[28]; /* for future use */ 286}; 287 288struct sisusb_command { 289 __u8 operation; /* see below */ 290 __u8 data0; /* operation dependent */ 291 __u8 data1; /* operation dependent */ 292 __u8 data2; /* operation dependent */ 293 __u32 data3; /* operation dependent */ 294 __u32 data4; /* for future use */ 295}; 296 297#define SUCMD_GET 0x01 /* for all: data0 = index, data3 = port */ 298#define SUCMD_SET 0x02 /* data1 = value */ 299#define SUCMD_SETOR 0x03 /* data1 = or */ 300#define SUCMD_SETAND 0x04 /* data1 = and */ 301#define SUCMD_SETANDOR 0x05 /* data1 = and, data2 = or */ 302#define SUCMD_SETMASK 0x06 /* data1 = data, data2 = mask */ 303 304#define SUCMD_CLRSCR 0x07 /* data0:1:2 = length, data3 = address */ 305 306#define SUCMD_HANDLETEXTMODE 0x08 /* Reset/destroy text mode */ 307 308#define SUCMD_SETMODE 0x09 /* Set a display mode (data3 = SiS mode) */ 309#define SUCMD_SETVESAMODE 0x0a /* Set a display mode (data3 = VESA mode) */ 310 311#define SISUSB_COMMAND _IOWR(0xF3,0x3D,struct sisusb_command) 312#define SISUSB_GET_CONFIG_SIZE _IOR(0xF3,0x3E,__u32) 313#define SISUSB_GET_CONFIG _IOR(0xF3,0x3F,struct sisusb_info) 314 315 316#endif /* SISUSB_H */ 317