2 * CORTEX-I Frame Grabber driver V1.0
4 * Copyright (C) 1994, Paul S. LaFollette, Jr. This software may be used,
5 * modified, copied, distributed, and sold, in both source and binary form
6 * provided that the above copyright and these terms are retained. Under
7 * no circumstances is the author responsible for the proper functioning
8 * of this software, nor does the author assume any responsibility
9 * for damages incurred with its use.
11 * $FreeBSD: src/sys/i386/isa/ctx.c,v 1.36 2000/01/29 16:17:31 peter Exp $
12 * $DragonFly: src/sys/dev/video/ctx/ctx.c,v 1.8 2004/05/19 22:52:53 dillon Exp $
19 * Device Driver for CORTEX-I Frame Grabber
20 * Made by ImageNation Corporation
21 * 1200 N.E. Keyues Road
22 * Vancouver, WA 98684 (206) 944-9131
23 * (I have no ties to this company, just thought you might want
24 * to know how to get in touch with them.)
26 * In order to understand this device, you really need to consult the
27 * manual which ImageNation provides when you buy the board. (And
28 * what a pleasure it is to buy something for a PC and actually get
29 * programming information along with it.) I will limit myself here to
30 * a few comments which are specific to this driver. See also the file
31 * ctxreg.h for definitions of registers and control bits.
33 * 1. Although the hardware supports low resolution (256 x 256)
34 * acqusition and display, I have not implemented access to
35 * these modes in this driver. There are some fairly quirky
36 * aspects to the way this board works in low resolution mode,
37 * and I don't want to deal with them. Maybe later.
39 * 2. Choosing the base address for the video memory: This is set
40 * using a combination of hardware and software, using the left
41 * most dip switch on the board, and the AB_SELECT bit of control
42 * port 1, according to the chart below:
44 * Left DIP switch || DOWN | UP |
45 * =================================================
46 * AB_SELECT = 0 || 0xA0000 | 0xB0000 |
47 * -------------------------------------------------
48 * AB_SELECT = 1 || 0xD0000 | 0xE0000 |
49 * ------------------------------------------------
51 * When the RAM_ENABLE bit of control port 1 is clear (0), the
52 * video ram is disconnected from the computer bus. This makes
53 * it possible, in principle, to share memory space with other
54 * devices (such as VGA) which can also disconnect themselves
55 * from the bus. It also means that multiple CORTEX-I boards
56 * can share the same video memory space. Disconnecting from the
57 * bus does not affect the video display of the video ram contents,
58 * so that one needs only set the RAM_ENABLE bit when actually
59 * reading or writing to memory. The cost of this is low,
60 * the benefits to me are great (I need more than one board
61 * in my machine, and 0xE0000 is the only address choice that
62 * doesn't conflict with anything) so I adopt this strategy here.
64 * XXX-Note... this driver has only been tested for the
65 * XXX base = 0xE0000 case!
67 * 3) There is a deficiency in the documentation from ImageNation, I
68 * think. In order to successfully load the lookup table, it is
69 * necessary to clear SEE_STORED_VIDEO in control port 0 as well as
70 * setting LUT_LOAD_ENABLE in control port 1.
72 * 4) This driver accesses video memory through read or write operations.
73 * Other functionality is provided through ioctl's, manifest
74 * constants for which are defined in ioctl_ctx.h. The ioctl's
76 * CTX_LIVE Display live video
77 * CTX_GRAB Grab a frame of video data
78 * CTX_H_ORGANIZE Set things up so that sequential read
79 * operations access horizontal lines of
81 * CTX_V_ORGANIZE Set things up so that sequential read
82 * operations access vertical lines of
84 * CTX_SET_LUT Set the lookup table from an array
85 * of 256 unsigned chars passed as the
86 * third parameter to ioctl.
87 * CTX_GET_LUT Return the current lookup table to
88 * the application as an array of 256
89 * unsigned chars. Again the third
90 * parameter to the ioctl call.
93 * ioctl(fi, CTX_H_ORGANIZE, 0);
94 * lseek(fi, y*512, SEEK_SET);
95 * read(fi, buffer, 512);
97 * will fill buffer with 512 pixels (unsigned chars) which represent
98 * the y-th horizontal line of the image.
100 * ioctl(fi, CTX_V_ORGANIZE, 0:
101 * lseek(fi, x*512+y, SEEK_SET);
102 * read(fi, buffer, 10);
104 * will read 10 a vertical line of 10 pixels starting at (x,y).
106 * Obviously, this sort of ugliness needs to be hidden away from
107 * the casual user, with an appropriate set of higher level
114 #include <sys/param.h>
115 #include <sys/systm.h>
116 #include <sys/conf.h>
118 #include <sys/kernel.h>
119 #include <sys/malloc.h>
120 #include <bus/isa/i386/isa_device.h>
122 #include <machine/ioctl_ctx.h>
123 #include <machine/md_var.h>
125 static int waitvb(int port);
128 #define OPEN (0x01) /* device is open */
130 #define UNIT(x) ((x) & 0x07)
132 static int ctxprobe (struct isa_device *devp);
133 static int ctxattach (struct isa_device *devp);
134 struct isa_driver ctxdriver = {ctxprobe, ctxattach, "ctx"};
136 static d_open_t ctxopen;
137 static d_close_t ctxclose;
138 static d_read_t ctxread;
139 static d_write_t ctxwrite;
140 static d_ioctl_t ctxioctl;
141 #define CDEV_MAJOR 40
143 static struct cdevsw ctx_cdevsw = {
145 /* maj */ CDEV_MAJOR,
151 /* close */ ctxclose,
153 /* write */ ctxwrite,
154 /* ioctl */ ctxioctl,
157 /* strategy */ nostrategy,
163 #define LUTSIZE 256 /* buffer size for Look Up Table (LUT) */
164 #define PAGESIZE 65536 /* size of one video page, 1/4 of the screen */
167 * Per unit shadow registers (because the dumb hardware is RO)
170 static struct ctx_soft_registers {
182 ctxprobe(struct isa_device * devp)
186 if (inb(devp->id_iobase) == 0xff) /* 0xff only if board absent */
189 status = 1; /*XXX uses only one port? */
194 ctxattach(struct isa_device * devp)
196 struct ctx_soft_registers *sr;
198 sr = &(ctx_sr[devp->id_unit]);
199 sr->cp0 = 0; /* zero out the shadow registers */
200 sr->cp1 = 0; /* and the open flag. wait for */
201 sr->flag = 0; /* open to malloc the LUT space */
202 sr->iobase = devp->id_iobase;
203 sr->maddr = devp->id_maddr;
204 sr->msize = devp->id_msize;
205 cdevsw_add(&ctx_cdevsw, -1, devp->id_unit);
206 make_dev(&ctx_cdevsw, devp->id_unit, 0, 0, 0600,
207 "ctx%d", devp->id_unit);
212 ctxopen(dev_t dev, int flags, int fmt, struct thread *td)
214 struct ctx_soft_registers *sr;
218 unit = UNIT(minor(dev));
220 /* minor number out of range? */
224 sr = &(ctx_sr[unit]);
226 if (sr->flag != 0) /* someone has already opened us */
229 /* get space for the LUT buffer */
231 sr->lutp = malloc(LUTSIZE, M_DEVBUF, M_WAITOK);
232 if (sr->lutp == NULL)
238 Set up the shadow registers. We don't actually write these
239 values to the control ports until after we finish loading the
242 sr->cp0 |= SEE_STORED_VIDEO;
243 if ((kvtop(sr->maddr) == 0xB0000) || (kvtop(sr->maddr) == 0xE0000))
244 sr->cp1 |= AB_SELECT; /* map to B or E if necessary */
245 /* but don't enable RAM */
247 Set up the lookup table initially so that it is transparent.
250 outb(sr->iobase + ctx_cp0, (u_char) 0);
251 outb(sr->iobase + ctx_cp1, (u_char) (LUT_LOAD_ENABLE | BLANK_DISPLAY));
252 for (i = 0; i < LUTSIZE; i++) {
253 outb(sr->iobase + ctx_lutaddr, (u_char) i);
254 sr->lutp[i] = (u_char) i;
255 outb(sr->iobase + ctx_lutdata, (u_char) sr->lutp[i]);
258 Disable LUT loading, and push the data in the shadow
259 registers into the control ports.
261 outb(sr->iobase + ctx_cp0, sr->cp0);
262 outb(sr->iobase + ctx_cp1, sr->cp1);
263 return (0); /* successful open. All ready to go. */
267 ctxclose(dev_t dev, int flags, int fmt, struct thread *td)
271 unit = UNIT(minor(dev));
272 ctx_sr[unit].flag = 0;
273 free(ctx_sr[unit].lutp, M_DEVBUF);
274 ctx_sr[unit].lutp = NULL;
279 ctxwrite(dev_t dev, struct uio * uio, int ioflag)
281 int unit, status = 0;
282 int page, count, offset;
283 struct ctx_soft_registers *sr;
286 unit = UNIT(minor(dev));
287 sr = &(ctx_sr[unit]);
289 if (uio->uio_offset < 0)
291 if (uio->uio_offset >= 4 * PAGESIZE)
294 page = (u_int)uio->uio_offset / PAGESIZE;
295 offset = (u_int)uio->uio_offset % PAGESIZE;
296 count = min(uio->uio_resid, PAGESIZE - offset);
297 while ((page >= 0) && (page <= 3) && (count > 0)) {
300 outb(sr->iobase + ctx_cp0, sr->cp0);
303 Before doing the uiomove, we need to "connect" the frame buffer
304 ram to the machine bus. This is done here so that we can have
305 several different boards installed, all sharing the same memory
306 space... each board is only "connected" to the bus when its memory
307 is actually being read or written. All my instincts tell me that
308 I should disable interrupts here, so I have done so.
313 sr->cp1 |= RAM_ENABLE;
314 outb(sr->iobase + ctx_cp1, sr->cp1);
315 status = uiomove(sr->maddr + offset, count, uio);
316 sr->cp1 &= ~RAM_ENABLE;
317 outb(sr->iobase + ctx_cp1, sr->cp1);
320 page = (u_int)uio->uio_offset / PAGESIZE;
321 offset = (u_int)uio->uio_offset % PAGESIZE;
322 count = min(uio->uio_resid, PAGESIZE - offset);
324 if (uio->uio_resid > 0)
331 ctxread(dev_t dev, struct uio * uio, int ioflag)
333 int unit, status = 0;
334 int page, count, offset;
335 struct ctx_soft_registers *sr;
338 unit = UNIT(minor(dev));
339 sr = &(ctx_sr[unit]);
341 if (uio->uio_offset < 0)
343 if (uio->uio_offset >= 4 * PAGESIZE)
346 page = (u_int)uio->uio_offset / PAGESIZE;
347 offset = (u_int)uio->uio_offset % PAGESIZE;
348 count = min(uio->uio_resid, PAGESIZE - offset);
349 while ((page >= 0) && (page <= 3) && (count > 0)) {
352 outb(sr->iobase + ctx_cp0, sr->cp0);
354 Before doing the uiomove, we need to "connect" the frame buffer
355 ram to the machine bus. This is done here so that we can have
356 several different boards installed, all sharing the same memory
357 space... each board is only "connected" to the bus when its memory
358 is actually being read or written. All my instincts tell me that
359 I should disable interrupts here, so I have done so.
363 sr->cp1 |= RAM_ENABLE;
364 outb(sr->iobase + ctx_cp1, sr->cp1);
365 status = uiomove(sr->maddr + offset, count, uio);
366 sr->cp1 &= ~RAM_ENABLE;
367 outb(sr->iobase + ctx_cp1, sr->cp1);
370 page = (u_int)uio->uio_offset / PAGESIZE;
371 offset = (u_int)uio->uio_offset % PAGESIZE;
372 count = min(uio->uio_resid, PAGESIZE - offset);
374 if (uio->uio_resid > 0)
381 ctxioctl(dev_t dev, u_long cmd, caddr_t data, int flags, struct thread *td)
385 struct ctx_soft_registers *sr;
388 unit = UNIT(minor(dev));
389 sr = &(ctx_sr[unit]);
393 sr->cp0 &= ~SEE_STORED_VIDEO;
394 outb(sr->iobase + ctx_cp0, sr->cp0);
397 sr->cp0 &= ~SEE_STORED_VIDEO;
398 outb(sr->iobase + ctx_cp0, sr->cp0);
400 if (waitvb(sr->iobase)) /* wait for vert blank to start
403 outb(sr->iobase + ctx_cp0, sr->cp0);
404 if (waitvb(sr->iobase)) /* wait for two more to finish acquire */
406 if (waitvb(sr->iobase))
408 sr->cp0 &= ~ACQUIRE; /* turn off acquire and turn on
410 sr->cp0 |= SEE_STORED_VIDEO;
411 outb(sr->iobase + ctx_cp0, sr->cp0);
414 sr->cp0 &= ~PAGE_ROTATE;
415 outb(sr->iobase + ctx_cp0, sr->cp0);
418 sr->cp0 |= PAGE_ROTATE;
419 outb(sr->iobase + ctx_cp0, sr->cp0);
422 bcopy((u_char *) data, sr->lutp, LUTSIZE);
423 outb(sr->iobase + ctx_cp0, (u_char) 0);
424 outb(sr->iobase + ctx_cp1, (u_char) (LUT_LOAD_ENABLE | BLANK_DISPLAY));
425 for (i = 0; i < LUTSIZE; i++) {
426 outb(sr->iobase + ctx_lutaddr, i);
427 outb(sr->iobase + ctx_lutdata, sr->lutp[i]);
429 outb(sr->iobase + ctx_cp0, sr->cp0); /* restore control
431 outb(sr->iobase + ctx_cp1, sr->cp1);
434 bcopy(sr->lutp, (u_char *) data, LUTSIZE);
445 { /* wait for a vertical blank, */
446 if (inb(port) == 0xff) /* 0xff means no board present */
449 while ((inb(port) & VERTICAL_BLANK) != 0) {
451 while ((inb(port) & VERTICAL_BLANK) == 0) {