2 pf.c (c) 1997-8 Grant R. Guenther <grant@torque.net>
3 Under the terms of the GNU General Public License.
5 This is the high-level driver for parallel port ATAPI disk
6 drives based on chips supported by the paride module.
8 By default, the driver will autoprobe for a single parallel
9 port ATAPI disk drive, but if their individual parameters are
10 specified, the driver can handle up to 4 drives.
12 The behaviour of the pf driver can be altered by setting
13 some parameters from the insmod command line. The following
14 parameters are adjustable:
16 drive0 These four arguments can be arrays of
17 drive1 1-7 integers as follows:
19 drive3 <prt>,<pro>,<uni>,<mod>,<slv>,<lun>,<dly>
23 <prt> is the base of the parallel port address for
24 the corresponding drive. (required)
26 <pro> is the protocol number for the adapter that
27 supports this drive. These numbers are
28 logged by 'paride' when the protocol modules
29 are initialised. (0 if not given)
31 <uni> for those adapters that support chained
32 devices, this is the unit selector for the
33 chain of devices on the given port. It should
34 be zero for devices that don't support chaining.
37 <mod> this can be -1 to choose the best mode, or one
38 of the mode numbers supported by the adapter.
41 <slv> ATAPI CDroms can be jumpered to master or slave.
42 Set this to 0 to choose the master drive, 1 to
43 choose the slave, -1 (the default) to choose the
46 <lun> Some ATAPI devices support multiple LUNs.
47 One example is the ATAPI PD/CD drive from
48 Matshita/Panasonic. This device has a
49 CD drive on LUN 0 and a PD drive on LUN 1.
50 By default, the driver will search for the
51 first LUN with a supported device. Set
52 this parameter to force it to use a specific
55 <dly> some parallel ports require the driver to
56 go more slowly. -1 sets a default value that
57 should work with the chosen protocol. Otherwise,
58 set this to a small integer, the larger it is
59 the slower the port i/o. In some cases, setting
60 this to zero will speed up the device. (default -1)
62 major You may use this parameter to overide the
63 default major number (47) that this driver
64 will use. Be sure to change the device
67 name This parameter is a character string that
68 contains the name the kernel will use for this
69 device (in /proc output, for instance).
72 cluster The driver will attempt to aggregate requests
73 for adjacent blocks into larger multi-block
74 clusters. The maximum cluster size (in 512
75 byte sectors) is set with this parameter.
78 verbose This parameter controls the amount of logging
79 that the driver will do. Set it to 0 for
80 normal operation, 1 to see autoprobe progress
81 messages, or 2 to see additional debugging
84 nice This parameter controls the driver's use of
85 idle CPU time, at the expense of some speed.
87 If this driver is built into the kernel, you can use the
88 following command line parameters, with the same values
89 as the corresponding module parameters listed above:
98 In addition, you can use the parameter pf.disable to disable
105 1.01 GRG 1998.05.03 Changes for SMP. Eliminate sti().
106 Fix for drives that don't clear STAT_ERR
107 until after next CDB delivered.
108 Small change in pf_completion to round
110 1.02 GRG 1998.06.16 Eliminated an Ugh
111 1.03 GRG 1998.08.16 Use HZ in loop timings, extra debugging
112 1.04 GRG 1998.09.24 Added jumbo support
116 #define PF_VERSION "1.04"
121 /* Here are things one can override from the insmod command.
122 Most are autoprobed by paride unless set here. Verbose is off
127 static int verbose = 0;
128 static int major = PF_MAJOR;
129 static char *name = PF_NAME;
130 static int cluster = 64;
132 static int disable = 0;
134 static int drive0[7] = { 0, 0, 0, -1, -1, -1, -1 };
135 static int drive1[7] = { 0, 0, 0, -1, -1, -1, -1 };
136 static int drive2[7] = { 0, 0, 0, -1, -1, -1, -1 };
137 static int drive3[7] = { 0, 0, 0, -1, -1, -1, -1 };
139 static int (*drives[4])[7] = {&drive0, &drive1, &drive2, &drive3};
140 static int pf_drive_count;
142 enum {D_PRT, D_PRO, D_UNI, D_MOD, D_SLV, D_LUN, D_DLY};
144 /* end of parameters */
146 #include <linux/module.h>
147 #include <linux/init.h>
148 #include <linux/fs.h>
149 #include <linux/delay.h>
150 #include <linux/hdreg.h>
151 #include <linux/cdrom.h>
152 #include <linux/spinlock.h>
153 #include <linux/blkdev.h>
154 #include <linux/blkpg.h>
155 #include <asm/uaccess.h>
157 static spinlock_t pf_spin_lock;
159 module_param(verbose, bool, 0644);
160 module_param(major, int, 0);
161 module_param(name, charp, 0);
162 module_param(cluster, int, 0);
163 module_param(nice, int, 0);
164 module_param_array(drive0, int, NULL, 0);
165 module_param_array(drive1, int, NULL, 0);
166 module_param_array(drive2, int, NULL, 0);
167 module_param_array(drive3, int, NULL, 0);
172 /* constants for faking geometry numbers */
174 #define PF_FD_MAX 8192 /* use FD geometry under this size */
180 #define PF_MAX_RETRIES 5
181 #define PF_TMO 800 /* interrupt timeout in jiffies */
182 #define PF_SPIN_DEL 50 /* spin delay in micro-seconds */
184 #define PF_SPIN (1000000*PF_TMO)/(HZ*PF_SPIN_DEL)
186 #define STAT_ERR 0x00001
187 #define STAT_INDEX 0x00002
188 #define STAT_ECC 0x00004
189 #define STAT_DRQ 0x00008
190 #define STAT_SEEK 0x00010
191 #define STAT_WRERR 0x00020
192 #define STAT_READY 0x00040
193 #define STAT_BUSY 0x00080
195 #define ATAPI_REQ_SENSE 0x03
196 #define ATAPI_LOCK 0x1e
197 #define ATAPI_DOOR 0x1b
198 #define ATAPI_MODE_SENSE 0x5a
199 #define ATAPI_CAPACITY 0x25
200 #define ATAPI_IDENTIFY 0x12
201 #define ATAPI_READ_10 0x28
202 #define ATAPI_WRITE_10 0x2a
204 static int pf_open(struct inode *inode, struct file *file);
205 static void do_pf_request(request_queue_t * q);
206 static int pf_ioctl(struct inode *inode, struct file *file,
207 unsigned int cmd, unsigned long arg);
209 static int pf_release(struct inode *inode, struct file *file);
211 static int pf_detect(void);
212 static void do_pf_read(void);
213 static void do_pf_read_start(void);
214 static void do_pf_write(void);
215 static void do_pf_write_start(void);
216 static void do_pf_read_drq(void);
217 static void do_pf_write_done(void);
226 struct pi_adapter pia; /* interface to paride layer */
227 struct pi_adapter *pi;
228 int removable; /* removable media device ? */
229 int media_status; /* media present ? WP ? */
230 int drive; /* drive */
232 int access; /* count of active opens ... */
233 int present; /* device present ? */
234 char name[PF_NAMELEN]; /* pf0, pf1, ... */
235 struct gendisk *disk;
238 static struct pf_unit units[PF_UNITS];
240 static int pf_identify(struct pf_unit *pf);
241 static void pf_lock(struct pf_unit *pf, int func);
242 static void pf_eject(struct pf_unit *pf);
243 static int pf_check_media(struct gendisk *disk);
245 static char pf_scratch[512]; /* scratch block buffer */
247 /* the variables below are used mainly in the I/O request engine, which
248 processes only one request at a time.
251 static int pf_retries = 0; /* i/o error retry count */
252 static int pf_busy = 0; /* request being processed ? */
253 static struct request *pf_req; /* current request */
254 static int pf_block; /* address of next requested block */
255 static int pf_count; /* number of blocks still to do */
256 static int pf_run; /* sectors in current cluster */
257 static int pf_cmd; /* current command READ/WRITE */
258 static struct pf_unit *pf_current;/* unit of current request */
259 static int pf_mask; /* stopper for pseudo-int */
260 static char *pf_buf; /* buffer for request in progress */
262 /* kernel glue structures */
264 static struct block_device_operations pf_fops = {
265 .owner = THIS_MODULE,
267 .release = pf_release,
269 .media_changed = pf_check_media,
272 static void __init pf_init_units(void)
278 for (unit = 0, pf = units; unit < PF_UNITS; unit++, pf++) {
279 struct gendisk *disk = alloc_disk(1);
284 pf->media_status = PF_NM;
285 pf->drive = (*drives[unit])[D_SLV];
286 pf->lun = (*drives[unit])[D_LUN];
287 snprintf(pf->name, PF_NAMELEN, "%s%d", name, unit);
289 disk->first_minor = unit;
290 strcpy(disk->disk_name, pf->name);
291 disk->fops = &pf_fops;
292 if (!(*drives[unit])[D_PRT])
297 static int pf_open(struct inode *inode, struct file *file)
299 struct pf_unit *pf = inode->i_bdev->bd_disk->private_data;
303 if (pf->media_status == PF_NM)
306 if ((pf->media_status == PF_RO) && (file->f_mode & 2))
316 static int pf_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
318 struct pf_unit *pf = inode->i_bdev->bd_disk->private_data;
319 struct hd_geometry __user *geo = (struct hd_geometry __user *) arg;
320 struct hd_geometry g;
323 if (cmd == CDROMEJECT) {
324 if (pf->access == 1) {
330 if (cmd != HDIO_GETGEO)
332 capacity = get_capacity(pf->disk);
333 if (capacity < PF_FD_MAX) {
334 g.cylinders = sector_div(capacity, PF_FD_HDS * PF_FD_SPT);
336 g.sectors = PF_FD_SPT;
338 g.cylinders = sector_div(capacity, PF_HD_HDS * PF_HD_SPT);
340 g.sectors = PF_HD_SPT;
342 if (copy_to_user(geo, &g, sizeof(g)))
347 static int pf_release(struct inode *inode, struct file *file)
349 struct pf_unit *pf = inode->i_bdev->bd_disk->private_data;
356 if (!pf->access && pf->removable)
363 static int pf_check_media(struct gendisk *disk)
368 static inline int status_reg(struct pf_unit *pf)
370 return pi_read_regr(pf->pi, 1, 6);
373 static inline int read_reg(struct pf_unit *pf, int reg)
375 return pi_read_regr(pf->pi, 0, reg);
378 static inline void write_reg(struct pf_unit *pf, int reg, int val)
380 pi_write_regr(pf->pi, 0, reg, val);
383 static int pf_wait(struct pf_unit *pf, int go, int stop, char *fun, char *msg)
388 while ((((r = status_reg(pf)) & go) || (stop && (!(r & stop))))
392 if ((r & (STAT_ERR & stop)) || (j >= PF_SPIN)) {
399 printk("%s: %s %s: alt=0x%x stat=0x%x err=0x%x"
400 " loop=%d phase=%d\n",
401 pf->name, fun, msg, r, s, e, j, p);
407 static int pf_command(struct pf_unit *pf, char *cmd, int dlen, char *fun)
411 write_reg(pf, 6, 0xa0+0x10*pf->drive);
413 if (pf_wait(pf, STAT_BUSY | STAT_DRQ, 0, fun, "before command")) {
414 pi_disconnect(pf->pi);
418 write_reg(pf, 4, dlen % 256);
419 write_reg(pf, 5, dlen / 256);
420 write_reg(pf, 7, 0xa0); /* ATAPI packet command */
422 if (pf_wait(pf, STAT_BUSY, STAT_DRQ, fun, "command DRQ")) {
423 pi_disconnect(pf->pi);
427 if (read_reg(pf, 2) != 1) {
428 printk("%s: %s: command phase error\n", pf->name, fun);
429 pi_disconnect(pf->pi);
433 pi_write_block(pf->pi, cmd, 12);
438 static int pf_completion(struct pf_unit *pf, char *buf, char *fun)
442 r = pf_wait(pf, STAT_BUSY, STAT_DRQ | STAT_READY | STAT_ERR,
445 if ((read_reg(pf, 2) & 2) && (read_reg(pf, 7) & STAT_DRQ)) {
446 n = (((read_reg(pf, 4) + 256 * read_reg(pf, 5)) +
448 pi_read_block(pf->pi, buf, n);
451 s = pf_wait(pf, STAT_BUSY, STAT_READY | STAT_ERR, fun, "data done");
453 pi_disconnect(pf->pi);
458 static void pf_req_sense(struct pf_unit *pf, int quiet)
461 { ATAPI_REQ_SENSE, pf->lun << 5, 0, 0, 16, 0, 0, 0, 0, 0, 0, 0 };
465 r = pf_command(pf, rs_cmd, 16, "Request sense");
468 pf_completion(pf, buf, "Request sense");
470 if ((!r) && (!quiet))
471 printk("%s: Sense key: %x, ASC: %x, ASQ: %x\n",
472 pf->name, buf[2] & 0xf, buf[12], buf[13]);
475 static int pf_atapi(struct pf_unit *pf, char *cmd, int dlen, char *buf, char *fun)
479 r = pf_command(pf, cmd, dlen, fun);
482 r = pf_completion(pf, buf, fun);
484 pf_req_sense(pf, !fun);
489 #define DBMSG(msg) ((verbose>1)?(msg):NULL)
491 static void pf_lock(struct pf_unit *pf, int func)
493 char lo_cmd[12] = { ATAPI_LOCK, pf->lun << 5, 0, 0, func, 0, 0, 0, 0, 0, 0, 0 };
495 pf_atapi(pf, lo_cmd, 0, pf_scratch, func ? "unlock" : "lock");
498 static void pf_eject(struct pf_unit *pf)
500 char ej_cmd[12] = { ATAPI_DOOR, pf->lun << 5, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0 };
503 pf_atapi(pf, ej_cmd, 0, pf_scratch, "eject");
506 #define PF_RESET_TMO 30 /* in tenths of a second */
508 static void pf_sleep(int cs)
510 schedule_timeout_interruptible(cs);
513 /* the ATAPI standard actually specifies the contents of all 7 registers
514 after a reset, but the specification is ambiguous concerning the last
515 two bytes, and different drives interpret the standard differently.
518 static int pf_reset(struct pf_unit *pf)
521 int expect[5] = { 1, 1, 1, 0x14, 0xeb };
524 write_reg(pf, 6, 0xa0+0x10*pf->drive);
527 pf_sleep(20 * HZ / 1000);
530 while ((k++ < PF_RESET_TMO) && (status_reg(pf) & STAT_BUSY))
534 for (i = 0; i < 5; i++)
535 flg &= (read_reg(pf, i + 1) == expect[i]);
538 printk("%s: Reset (%d) signature = ", pf->name, k);
539 for (i = 0; i < 5; i++)
540 printk("%3x", read_reg(pf, i + 1));
542 printk(" (incorrect)");
546 pi_disconnect(pf->pi);
550 static void pf_mode_sense(struct pf_unit *pf)
553 { ATAPI_MODE_SENSE, pf->lun << 5, 0, 0, 0, 0, 0, 0, 8, 0, 0, 0 };
556 pf_atapi(pf, ms_cmd, 8, buf, DBMSG("mode sense"));
557 pf->media_status = PF_RW;
559 pf->media_status = PF_RO;
562 static void xs(char *buf, char *targ, int offs, int len)
568 for (k = 0; k < len; k++)
569 if ((buf[k + offs] != 0x20) || (buf[k + offs] != l))
570 l = targ[j++] = buf[k + offs];
576 static int xl(char *buf, int offs)
581 for (k = 0; k < 4; k++)
582 v = v * 256 + (buf[k + offs] & 0xff);
586 static void pf_get_capacity(struct pf_unit *pf)
588 char rc_cmd[12] = { ATAPI_CAPACITY, pf->lun << 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
592 if (pf_atapi(pf, rc_cmd, 8, buf, DBMSG("get capacity"))) {
593 pf->media_status = PF_NM;
596 set_capacity(pf->disk, xl(buf, 0) + 1);
599 set_capacity(pf->disk, 0);
601 printk("%s: Drive %d, LUN %d,"
602 " unsupported block size %d\n",
603 pf->name, pf->drive, pf->lun, bs);
607 static int pf_identify(struct pf_unit *pf)
610 char *ms[2] = { "master", "slave" };
613 { ATAPI_IDENTIFY, pf->lun << 5, 0, 0, 36, 0, 0, 0, 0, 0, 0, 0 };
616 s = pf_atapi(pf, id_cmd, 36, buf, "identify");
621 if ((dt != 0) && (dt != 7)) {
623 printk("%s: Drive %d, LUN %d, unsupported type %d\n",
624 pf->name, pf->drive, pf->lun, dt);
631 pf->removable = (buf[1] & 0x80);
639 printk("%s: %s %s, %s LUN %d, type %d",
640 pf->name, mf, id, ms[pf->drive], pf->lun, dt);
642 printk(", removable");
643 if (pf->media_status == PF_NM)
644 printk(", no media\n");
646 if (pf->media_status == PF_RO)
648 printk(", %llu blocks\n",
649 (unsigned long long)get_capacity(pf->disk));
654 /* returns 0, with id set if drive is detected
655 -1, if drive detection failed
657 static int pf_probe(struct pf_unit *pf)
659 if (pf->drive == -1) {
660 for (pf->drive = 0; pf->drive <= 1; pf->drive++)
663 return pf_identify(pf);
665 for (pf->lun = 0; pf->lun < 8; pf->lun++)
666 if (!pf_identify(pf))
673 return pf_identify(pf);
674 for (pf->lun = 0; pf->lun < 8; pf->lun++)
675 if (!pf_identify(pf))
681 static int pf_detect(void)
683 struct pf_unit *pf = units;
686 printk("%s: %s version %s, major %d, cluster %d, nice %d\n",
687 name, name, PF_VERSION, major, cluster, nice);
690 if (pf_drive_count == 0) {
691 if (pi_init(pf->pi, 1, -1, -1, -1, -1, -1, pf_scratch, PI_PF,
692 verbose, pf->name)) {
693 if (!pf_probe(pf) && pf->disk) {
701 for (unit = 0; unit < PF_UNITS; unit++, pf++) {
702 int *conf = *drives[unit];
705 if (pi_init(pf->pi, 0, conf[D_PRT], conf[D_MOD],
706 conf[D_UNI], conf[D_PRO], conf[D_DLY],
707 pf_scratch, PI_PF, verbose, pf->name)) {
708 if (!pf_probe(pf) && pf->disk) {
718 printk("%s: No ATAPI disk detected\n", name);
719 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
724 /* The i/o request engine */
726 static int pf_start(struct pf_unit *pf, int cmd, int b, int c)
729 char io_cmd[12] = { cmd, pf->lun << 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
731 for (i = 0; i < 4; i++) {
732 io_cmd[5 - i] = b & 0xff;
736 io_cmd[8] = c & 0xff;
737 io_cmd[7] = (c >> 8) & 0xff;
739 i = pf_command(pf, io_cmd, c * 512, "start i/o");
746 static int pf_ready(void)
748 return (((status_reg(pf_current) & (STAT_BUSY | pf_mask)) == pf_mask));
751 static struct request_queue *pf_queue;
753 static void pf_end_request(int uptodate)
756 end_request(pf_req, uptodate);
761 static void do_pf_request(request_queue_t * q)
766 pf_req = elv_next_request(q);
770 pf_current = pf_req->rq_disk->private_data;
771 pf_block = pf_req->sector;
772 pf_run = pf_req->nr_sectors;
773 pf_count = pf_req->current_nr_sectors;
775 if (pf_block + pf_count > get_capacity(pf_req->rq_disk)) {
780 pf_cmd = rq_data_dir(pf_req);
781 pf_buf = pf_req->buffer;
786 pi_do_claimed(pf_current->pi, do_pf_read);
787 else if (pf_cmd == WRITE)
788 pi_do_claimed(pf_current->pi, do_pf_write);
796 static int pf_next_buf(void)
798 unsigned long saved_flags;
808 spin_lock_irqsave(&pf_spin_lock, saved_flags);
811 pf_count = pf_req->current_nr_sectors;
812 pf_buf = pf_req->buffer;
814 spin_unlock_irqrestore(&pf_spin_lock, saved_flags);
818 static inline void next_request(int success)
820 unsigned long saved_flags;
822 spin_lock_irqsave(&pf_spin_lock, saved_flags);
823 pf_end_request(success);
825 do_pf_request(pf_queue);
826 spin_unlock_irqrestore(&pf_spin_lock, saved_flags);
829 /* detach from the calling context - in case the spinlock is held */
830 static void do_pf_read(void)
832 ps_set_intr(do_pf_read_start, NULL, 0, nice);
835 static void do_pf_read_start(void)
839 if (pf_start(pf_current, ATAPI_READ_10, pf_block, pf_run)) {
840 pi_disconnect(pf_current->pi);
841 if (pf_retries < PF_MAX_RETRIES) {
843 pi_do_claimed(pf_current->pi, do_pf_read_start);
850 ps_set_intr(do_pf_read_drq, pf_ready, PF_TMO, nice);
853 static void do_pf_read_drq(void)
856 if (pf_wait(pf_current, STAT_BUSY, STAT_DRQ | STAT_ERR,
857 "read block", "completion") & STAT_ERR) {
858 pi_disconnect(pf_current->pi);
859 if (pf_retries < PF_MAX_RETRIES) {
860 pf_req_sense(pf_current, 0);
862 pi_do_claimed(pf_current->pi, do_pf_read_start);
868 pi_read_block(pf_current->pi, pf_buf, 512);
872 pi_disconnect(pf_current->pi);
876 static void do_pf_write(void)
878 ps_set_intr(do_pf_write_start, NULL, 0, nice);
881 static void do_pf_write_start(void)
885 if (pf_start(pf_current, ATAPI_WRITE_10, pf_block, pf_run)) {
886 pi_disconnect(pf_current->pi);
887 if (pf_retries < PF_MAX_RETRIES) {
889 pi_do_claimed(pf_current->pi, do_pf_write_start);
897 if (pf_wait(pf_current, STAT_BUSY, STAT_DRQ | STAT_ERR,
898 "write block", "data wait") & STAT_ERR) {
899 pi_disconnect(pf_current->pi);
900 if (pf_retries < PF_MAX_RETRIES) {
902 pi_do_claimed(pf_current->pi, do_pf_write_start);
908 pi_write_block(pf_current->pi, pf_buf, 512);
913 ps_set_intr(do_pf_write_done, pf_ready, PF_TMO, nice);
916 static void do_pf_write_done(void)
918 if (pf_wait(pf_current, STAT_BUSY, 0, "write block", "done") & STAT_ERR) {
919 pi_disconnect(pf_current->pi);
920 if (pf_retries < PF_MAX_RETRIES) {
922 pi_do_claimed(pf_current->pi, do_pf_write_start);
928 pi_disconnect(pf_current->pi);
932 static int __init pf_init(void)
933 { /* preliminary initialisation */
946 if (register_blkdev(major, name)) {
947 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
951 pf_queue = blk_init_queue(do_pf_request, &pf_spin_lock);
953 unregister_blkdev(major, name);
954 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
959 blk_queue_max_phys_segments(pf_queue, cluster);
960 blk_queue_max_hw_segments(pf_queue, cluster);
962 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++) {
963 struct gendisk *disk = pf->disk;
967 disk->private_data = pf;
968 disk->queue = pf_queue;
974 static void __exit pf_exit(void)
978 unregister_blkdev(major, name);
979 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++) {
982 del_gendisk(pf->disk);
986 blk_cleanup_queue(pf_queue);
989 MODULE_LICENSE("GPL");