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