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 <linux/smp_lock.h>
156 #include <asm/uaccess.h>
158 static DEFINE_SPINLOCK(pf_spin_lock);
160 module_param(verbose, bool, 0644);
161 module_param(major, int, 0);
162 module_param(name, charp, 0);
163 module_param(cluster, int, 0);
164 module_param(nice, int, 0);
165 module_param_array(drive0, int, NULL, 0);
166 module_param_array(drive1, int, NULL, 0);
167 module_param_array(drive2, int, NULL, 0);
168 module_param_array(drive3, int, NULL, 0);
173 /* constants for faking geometry numbers */
175 #define PF_FD_MAX 8192 /* use FD geometry under this size */
181 #define PF_MAX_RETRIES 5
182 #define PF_TMO 800 /* interrupt timeout in jiffies */
183 #define PF_SPIN_DEL 50 /* spin delay in micro-seconds */
185 #define PF_SPIN (1000000*PF_TMO)/(HZ*PF_SPIN_DEL)
187 #define STAT_ERR 0x00001
188 #define STAT_INDEX 0x00002
189 #define STAT_ECC 0x00004
190 #define STAT_DRQ 0x00008
191 #define STAT_SEEK 0x00010
192 #define STAT_WRERR 0x00020
193 #define STAT_READY 0x00040
194 #define STAT_BUSY 0x00080
196 #define ATAPI_REQ_SENSE 0x03
197 #define ATAPI_LOCK 0x1e
198 #define ATAPI_DOOR 0x1b
199 #define ATAPI_MODE_SENSE 0x5a
200 #define ATAPI_CAPACITY 0x25
201 #define ATAPI_IDENTIFY 0x12
202 #define ATAPI_READ_10 0x28
203 #define ATAPI_WRITE_10 0x2a
205 static int pf_open(struct block_device *bdev, fmode_t mode);
206 static void do_pf_request(struct request_queue * q);
207 static int pf_ioctl(struct block_device *bdev, fmode_t mode,
208 unsigned int cmd, unsigned long arg);
209 static int pf_getgeo(struct block_device *bdev, struct hd_geometry *geo);
211 static int pf_release(struct gendisk *disk, fmode_t mode);
213 static int pf_detect(void);
214 static void do_pf_read(void);
215 static void do_pf_read_start(void);
216 static void do_pf_write(void);
217 static void do_pf_write_start(void);
218 static void do_pf_read_drq(void);
219 static void do_pf_write_done(void);
228 struct pi_adapter pia; /* interface to paride layer */
229 struct pi_adapter *pi;
230 int removable; /* removable media device ? */
231 int media_status; /* media present ? WP ? */
232 int drive; /* drive */
234 int access; /* count of active opens ... */
235 int present; /* device present ? */
236 char name[PF_NAMELEN]; /* pf0, pf1, ... */
237 struct gendisk *disk;
240 static struct pf_unit units[PF_UNITS];
242 static int pf_identify(struct pf_unit *pf);
243 static void pf_lock(struct pf_unit *pf, int func);
244 static void pf_eject(struct pf_unit *pf);
245 static int pf_check_media(struct gendisk *disk);
247 static char pf_scratch[512]; /* scratch block buffer */
249 /* the variables below are used mainly in the I/O request engine, which
250 processes only one request at a time.
253 static int pf_retries = 0; /* i/o error retry count */
254 static int pf_busy = 0; /* request being processed ? */
255 static struct request *pf_req; /* current request */
256 static int pf_block; /* address of next requested block */
257 static int pf_count; /* number of blocks still to do */
258 static int pf_run; /* sectors in current cluster */
259 static int pf_cmd; /* current command READ/WRITE */
260 static struct pf_unit *pf_current;/* unit of current request */
261 static int pf_mask; /* stopper for pseudo-int */
262 static char *pf_buf; /* buffer for request in progress */
264 /* kernel glue structures */
266 static const struct block_device_operations pf_fops = {
267 .owner = THIS_MODULE,
269 .release = pf_release,
272 .media_changed = pf_check_media,
275 static void __init pf_init_units(void)
281 for (unit = 0, pf = units; unit < PF_UNITS; unit++, pf++) {
282 struct gendisk *disk = alloc_disk(1);
287 pf->media_status = PF_NM;
288 pf->drive = (*drives[unit])[D_SLV];
289 pf->lun = (*drives[unit])[D_LUN];
290 snprintf(pf->name, PF_NAMELEN, "%s%d", name, unit);
292 disk->first_minor = unit;
293 strcpy(disk->disk_name, pf->name);
294 disk->fops = &pf_fops;
295 if (!(*drives[unit])[D_PRT])
300 static int pf_open(struct block_device *bdev, fmode_t mode)
302 struct pf_unit *pf = bdev->bd_disk->private_data;
306 if (pf->media_status == PF_NM)
309 if ((pf->media_status == PF_RO) && (mode & FMODE_WRITE))
319 static int pf_getgeo(struct block_device *bdev, struct hd_geometry *geo)
321 struct pf_unit *pf = bdev->bd_disk->private_data;
322 sector_t capacity = get_capacity(pf->disk);
324 if (capacity < PF_FD_MAX) {
325 geo->cylinders = sector_div(capacity, PF_FD_HDS * PF_FD_SPT);
326 geo->heads = PF_FD_HDS;
327 geo->sectors = PF_FD_SPT;
329 geo->cylinders = sector_div(capacity, PF_HD_HDS * PF_HD_SPT);
330 geo->heads = PF_HD_HDS;
331 geo->sectors = PF_HD_SPT;
337 static int pf_ioctl(struct block_device *bdev, fmode_t mode, unsigned int cmd, unsigned long arg)
339 struct pf_unit *pf = bdev->bd_disk->private_data;
341 if (cmd != CDROMEJECT)
353 static int pf_release(struct gendisk *disk, fmode_t mode)
355 struct pf_unit *pf = disk->private_data;
362 if (!pf->access && pf->removable)
369 static int pf_check_media(struct gendisk *disk)
374 static inline int status_reg(struct pf_unit *pf)
376 return pi_read_regr(pf->pi, 1, 6);
379 static inline int read_reg(struct pf_unit *pf, int reg)
381 return pi_read_regr(pf->pi, 0, reg);
384 static inline void write_reg(struct pf_unit *pf, int reg, int val)
386 pi_write_regr(pf->pi, 0, reg, val);
389 static int pf_wait(struct pf_unit *pf, int go, int stop, char *fun, char *msg)
394 while ((((r = status_reg(pf)) & go) || (stop && (!(r & stop))))
398 if ((r & (STAT_ERR & stop)) || (j > PF_SPIN)) {
405 printk("%s: %s %s: alt=0x%x stat=0x%x err=0x%x"
406 " loop=%d phase=%d\n",
407 pf->name, fun, msg, r, s, e, j, p);
413 static int pf_command(struct pf_unit *pf, char *cmd, int dlen, char *fun)
417 write_reg(pf, 6, 0xa0+0x10*pf->drive);
419 if (pf_wait(pf, STAT_BUSY | STAT_DRQ, 0, fun, "before command")) {
420 pi_disconnect(pf->pi);
424 write_reg(pf, 4, dlen % 256);
425 write_reg(pf, 5, dlen / 256);
426 write_reg(pf, 7, 0xa0); /* ATAPI packet command */
428 if (pf_wait(pf, STAT_BUSY, STAT_DRQ, fun, "command DRQ")) {
429 pi_disconnect(pf->pi);
433 if (read_reg(pf, 2) != 1) {
434 printk("%s: %s: command phase error\n", pf->name, fun);
435 pi_disconnect(pf->pi);
439 pi_write_block(pf->pi, cmd, 12);
444 static int pf_completion(struct pf_unit *pf, char *buf, char *fun)
448 r = pf_wait(pf, STAT_BUSY, STAT_DRQ | STAT_READY | STAT_ERR,
451 if ((read_reg(pf, 2) & 2) && (read_reg(pf, 7) & STAT_DRQ)) {
452 n = (((read_reg(pf, 4) + 256 * read_reg(pf, 5)) +
454 pi_read_block(pf->pi, buf, n);
457 s = pf_wait(pf, STAT_BUSY, STAT_READY | STAT_ERR, fun, "data done");
459 pi_disconnect(pf->pi);
464 static void pf_req_sense(struct pf_unit *pf, int quiet)
467 { ATAPI_REQ_SENSE, pf->lun << 5, 0, 0, 16, 0, 0, 0, 0, 0, 0, 0 };
471 r = pf_command(pf, rs_cmd, 16, "Request sense");
474 pf_completion(pf, buf, "Request sense");
476 if ((!r) && (!quiet))
477 printk("%s: Sense key: %x, ASC: %x, ASQ: %x\n",
478 pf->name, buf[2] & 0xf, buf[12], buf[13]);
481 static int pf_atapi(struct pf_unit *pf, char *cmd, int dlen, char *buf, char *fun)
485 r = pf_command(pf, cmd, dlen, fun);
488 r = pf_completion(pf, buf, fun);
490 pf_req_sense(pf, !fun);
495 static void pf_lock(struct pf_unit *pf, int func)
497 char lo_cmd[12] = { ATAPI_LOCK, pf->lun << 5, 0, 0, func, 0, 0, 0, 0, 0, 0, 0 };
499 pf_atapi(pf, lo_cmd, 0, pf_scratch, func ? "lock" : "unlock");
502 static void pf_eject(struct pf_unit *pf)
504 char ej_cmd[12] = { ATAPI_DOOR, pf->lun << 5, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0 };
507 pf_atapi(pf, ej_cmd, 0, pf_scratch, "eject");
510 #define PF_RESET_TMO 30 /* in tenths of a second */
512 static void pf_sleep(int cs)
514 schedule_timeout_interruptible(cs);
517 /* the ATAPI standard actually specifies the contents of all 7 registers
518 after a reset, but the specification is ambiguous concerning the last
519 two bytes, and different drives interpret the standard differently.
522 static int pf_reset(struct pf_unit *pf)
525 int expect[5] = { 1, 1, 1, 0x14, 0xeb };
528 write_reg(pf, 6, 0xa0+0x10*pf->drive);
531 pf_sleep(20 * HZ / 1000);
534 while ((k++ < PF_RESET_TMO) && (status_reg(pf) & STAT_BUSY))
538 for (i = 0; i < 5; i++)
539 flg &= (read_reg(pf, i + 1) == expect[i]);
542 printk("%s: Reset (%d) signature = ", pf->name, k);
543 for (i = 0; i < 5; i++)
544 printk("%3x", read_reg(pf, i + 1));
546 printk(" (incorrect)");
550 pi_disconnect(pf->pi);
554 static void pf_mode_sense(struct pf_unit *pf)
557 { ATAPI_MODE_SENSE, pf->lun << 5, 0, 0, 0, 0, 0, 0, 8, 0, 0, 0 };
560 pf_atapi(pf, ms_cmd, 8, buf, "mode sense");
561 pf->media_status = PF_RW;
563 pf->media_status = PF_RO;
566 static void xs(char *buf, char *targ, int offs, int len)
572 for (k = 0; k < len; k++)
573 if ((buf[k + offs] != 0x20) || (buf[k + offs] != l))
574 l = targ[j++] = buf[k + offs];
580 static int xl(char *buf, int offs)
585 for (k = 0; k < 4; k++)
586 v = v * 256 + (buf[k + offs] & 0xff);
590 static void pf_get_capacity(struct pf_unit *pf)
592 char rc_cmd[12] = { ATAPI_CAPACITY, pf->lun << 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
596 if (pf_atapi(pf, rc_cmd, 8, buf, "get capacity")) {
597 pf->media_status = PF_NM;
600 set_capacity(pf->disk, xl(buf, 0) + 1);
603 set_capacity(pf->disk, 0);
605 printk("%s: Drive %d, LUN %d,"
606 " unsupported block size %d\n",
607 pf->name, pf->drive, pf->lun, bs);
611 static int pf_identify(struct pf_unit *pf)
614 char *ms[2] = { "master", "slave" };
617 { ATAPI_IDENTIFY, pf->lun << 5, 0, 0, 36, 0, 0, 0, 0, 0, 0, 0 };
620 s = pf_atapi(pf, id_cmd, 36, buf, "identify");
625 if ((dt != 0) && (dt != 7)) {
627 printk("%s: Drive %d, LUN %d, unsupported type %d\n",
628 pf->name, pf->drive, pf->lun, dt);
635 pf->removable = (buf[1] & 0x80);
643 printk("%s: %s %s, %s LUN %d, type %d",
644 pf->name, mf, id, ms[pf->drive], pf->lun, dt);
646 printk(", removable");
647 if (pf->media_status == PF_NM)
648 printk(", no media\n");
650 if (pf->media_status == PF_RO)
652 printk(", %llu blocks\n",
653 (unsigned long long)get_capacity(pf->disk));
658 /* returns 0, with id set if drive is detected
659 -1, if drive detection failed
661 static int pf_probe(struct pf_unit *pf)
663 if (pf->drive == -1) {
664 for (pf->drive = 0; pf->drive <= 1; pf->drive++)
667 return pf_identify(pf);
669 for (pf->lun = 0; pf->lun < 8; pf->lun++)
670 if (!pf_identify(pf))
677 return pf_identify(pf);
678 for (pf->lun = 0; pf->lun < 8; pf->lun++)
679 if (!pf_identify(pf))
685 static int pf_detect(void)
687 struct pf_unit *pf = units;
690 printk("%s: %s version %s, major %d, cluster %d, nice %d\n",
691 name, name, PF_VERSION, major, cluster, nice);
694 if (pf_drive_count == 0) {
695 if (pi_init(pf->pi, 1, -1, -1, -1, -1, -1, pf_scratch, PI_PF,
696 verbose, pf->name)) {
697 if (!pf_probe(pf) && pf->disk) {
705 for (unit = 0; unit < PF_UNITS; unit++, pf++) {
706 int *conf = *drives[unit];
709 if (pi_init(pf->pi, 0, conf[D_PRT], conf[D_MOD],
710 conf[D_UNI], conf[D_PRO], conf[D_DLY],
711 pf_scratch, PI_PF, verbose, pf->name)) {
712 if (pf->disk && !pf_probe(pf)) {
722 printk("%s: No ATAPI disk detected\n", name);
723 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
728 /* The i/o request engine */
730 static int pf_start(struct pf_unit *pf, int cmd, int b, int c)
733 char io_cmd[12] = { cmd, pf->lun << 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
735 for (i = 0; i < 4; i++) {
736 io_cmd[5 - i] = b & 0xff;
740 io_cmd[8] = c & 0xff;
741 io_cmd[7] = (c >> 8) & 0xff;
743 i = pf_command(pf, io_cmd, c * 512, "start i/o");
750 static int pf_ready(void)
752 return (((status_reg(pf_current) & (STAT_BUSY | pf_mask)) == pf_mask));
755 static struct request_queue *pf_queue;
757 static void pf_end_request(int err)
759 if (pf_req && !__blk_end_request_cur(pf_req, err))
763 static void do_pf_request(struct request_queue * q)
769 pf_req = blk_fetch_request(q);
774 pf_current = pf_req->rq_disk->private_data;
775 pf_block = blk_rq_pos(pf_req);
776 pf_run = blk_rq_sectors(pf_req);
777 pf_count = blk_rq_cur_sectors(pf_req);
779 if (pf_block + pf_count > get_capacity(pf_req->rq_disk)) {
780 pf_end_request(-EIO);
784 pf_cmd = rq_data_dir(pf_req);
785 pf_buf = pf_req->buffer;
790 pi_do_claimed(pf_current->pi, do_pf_read);
791 else if (pf_cmd == WRITE)
792 pi_do_claimed(pf_current->pi, do_pf_write);
795 pf_end_request(-EIO);
800 static int pf_next_buf(void)
802 unsigned long saved_flags;
811 spin_lock_irqsave(&pf_spin_lock, saved_flags);
813 spin_unlock_irqrestore(&pf_spin_lock, saved_flags);
816 pf_count = blk_rq_cur_sectors(pf_req);
817 pf_buf = pf_req->buffer;
822 static inline void next_request(int err)
824 unsigned long saved_flags;
826 spin_lock_irqsave(&pf_spin_lock, saved_flags);
829 do_pf_request(pf_queue);
830 spin_unlock_irqrestore(&pf_spin_lock, saved_flags);
833 /* detach from the calling context - in case the spinlock is held */
834 static void do_pf_read(void)
836 ps_set_intr(do_pf_read_start, NULL, 0, nice);
839 static void do_pf_read_start(void)
843 if (pf_start(pf_current, ATAPI_READ_10, pf_block, pf_run)) {
844 pi_disconnect(pf_current->pi);
845 if (pf_retries < PF_MAX_RETRIES) {
847 pi_do_claimed(pf_current->pi, do_pf_read_start);
854 ps_set_intr(do_pf_read_drq, pf_ready, PF_TMO, nice);
857 static void do_pf_read_drq(void)
860 if (pf_wait(pf_current, STAT_BUSY, STAT_DRQ | STAT_ERR,
861 "read block", "completion") & STAT_ERR) {
862 pi_disconnect(pf_current->pi);
863 if (pf_retries < PF_MAX_RETRIES) {
864 pf_req_sense(pf_current, 0);
866 pi_do_claimed(pf_current->pi, do_pf_read_start);
872 pi_read_block(pf_current->pi, pf_buf, 512);
876 pi_disconnect(pf_current->pi);
880 static void do_pf_write(void)
882 ps_set_intr(do_pf_write_start, NULL, 0, nice);
885 static void do_pf_write_start(void)
889 if (pf_start(pf_current, ATAPI_WRITE_10, pf_block, pf_run)) {
890 pi_disconnect(pf_current->pi);
891 if (pf_retries < PF_MAX_RETRIES) {
893 pi_do_claimed(pf_current->pi, do_pf_write_start);
901 if (pf_wait(pf_current, STAT_BUSY, STAT_DRQ | STAT_ERR,
902 "write block", "data wait") & STAT_ERR) {
903 pi_disconnect(pf_current->pi);
904 if (pf_retries < PF_MAX_RETRIES) {
906 pi_do_claimed(pf_current->pi, do_pf_write_start);
912 pi_write_block(pf_current->pi, pf_buf, 512);
917 ps_set_intr(do_pf_write_done, pf_ready, PF_TMO, nice);
920 static void do_pf_write_done(void)
922 if (pf_wait(pf_current, STAT_BUSY, 0, "write block", "done") & STAT_ERR) {
923 pi_disconnect(pf_current->pi);
924 if (pf_retries < PF_MAX_RETRIES) {
926 pi_do_claimed(pf_current->pi, do_pf_write_start);
932 pi_disconnect(pf_current->pi);
936 static int __init pf_init(void)
937 { /* preliminary initialisation */
950 if (register_blkdev(major, name)) {
951 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
955 pf_queue = blk_init_queue(do_pf_request, &pf_spin_lock);
957 unregister_blkdev(major, name);
958 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
963 blk_queue_max_segments(pf_queue, cluster);
965 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++) {
966 struct gendisk *disk = pf->disk;
970 disk->private_data = pf;
971 disk->queue = pf_queue;
977 static void __exit pf_exit(void)
981 unregister_blkdev(major, name);
982 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++) {
985 del_gendisk(pf->disk);
989 blk_cleanup_queue(pf_queue);
992 MODULE_LICENSE("GPL");