blob: f24ca7315ddc91e24e2cfa6ca62c7f3a5578a296 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 pf.c (c) 1997-8 Grant R. Guenther <grant@torque.net>
3 Under the terms of the GNU General Public License.
4
5 This is the high-level driver for parallel port ATAPI disk
6 drives based on chips supported by the paride module.
7
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.
11
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:
15
16 drive0 These four arguments can be arrays of
17 drive1 1-7 integers as follows:
18 drive2
19 drive3 <prt>,<pro>,<uni>,<mod>,<slv>,<lun>,<dly>
20
21 Where,
22
23 <prt> is the base of the parallel port address for
24 the corresponding drive. (required)
25
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)
30
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.
35 (0 if not given)
36
37 <mod> this can be -1 to choose the best mode, or one
38 of the mode numbers supported by the adapter.
39 (-1 if not given)
40
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
44 first drive found.
45
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
53 LUN. (default -1)
54
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)
61
Masahiro Yamada505d3082017-03-09 16:16:33 -080062 major You may use this parameter to override the
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 default major number (47) that this driver
64 will use. Be sure to change the device
65 name as well.
66
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).
70 (default "pf").
71
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.
76 (default 64)
77
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
82 output. (default 0)
83
84 nice This parameter controls the driver's use of
85 idle CPU time, at the expense of some speed.
86
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:
90
91 pf.drive0
92 pf.drive1
93 pf.drive2
94 pf.drive3
95 pf.cluster
96 pf.nice
97
98 In addition, you can use the parameter pf.disable to disable
99 the driver entirely.
100
101*/
102
103/* Changes:
104
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
109 up transfer size.
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
113
114*/
115
116#define PF_VERSION "1.04"
117#define PF_MAJOR 47
118#define PF_NAME "pf"
119#define PF_UNITS 4
120
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030121#include <linux/types.h>
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/* Here are things one can override from the insmod command.
124 Most are autoprobed by paride unless set here. Verbose is off
125 by default.
126
127*/
128
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030129static bool verbose = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130static int major = PF_MAJOR;
131static char *name = PF_NAME;
132static int cluster = 64;
133static int nice = 0;
134static int disable = 0;
135
136static int drive0[7] = { 0, 0, 0, -1, -1, -1, -1 };
137static int drive1[7] = { 0, 0, 0, -1, -1, -1, -1 };
138static int drive2[7] = { 0, 0, 0, -1, -1, -1, -1 };
139static int drive3[7] = { 0, 0, 0, -1, -1, -1, -1 };
140
141static int (*drives[4])[7] = {&drive0, &drive1, &drive2, &drive3};
142static int pf_drive_count;
143
144enum {D_PRT, D_PRO, D_UNI, D_MOD, D_SLV, D_LUN, D_DLY};
145
146/* end of parameters */
147
148#include <linux/module.h>
149#include <linux/init.h>
150#include <linux/fs.h>
151#include <linux/delay.h>
152#include <linux/hdreg.h>
153#include <linux/cdrom.h>
154#include <linux/spinlock.h>
155#include <linux/blkdev.h>
156#include <linux/blkpg.h>
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200157#include <linux/mutex.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -0800158#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200160static DEFINE_MUTEX(pf_mutex);
Alexey Dobriyan671d40f2007-04-23 14:41:07 -0700161static DEFINE_SPINLOCK(pf_spin_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163module_param(verbose, bool, 0644);
164module_param(major, int, 0);
165module_param(name, charp, 0);
166module_param(cluster, int, 0);
167module_param(nice, int, 0);
168module_param_array(drive0, int, NULL, 0);
169module_param_array(drive1, int, NULL, 0);
170module_param_array(drive2, int, NULL, 0);
171module_param_array(drive3, int, NULL, 0);
172
173#include "paride.h"
174#include "pseudo.h"
175
176/* constants for faking geometry numbers */
177
178#define PF_FD_MAX 8192 /* use FD geometry under this size */
179#define PF_FD_HDS 2
180#define PF_FD_SPT 18
181#define PF_HD_HDS 64
182#define PF_HD_SPT 32
183
184#define PF_MAX_RETRIES 5
185#define PF_TMO 800 /* interrupt timeout in jiffies */
186#define PF_SPIN_DEL 50 /* spin delay in micro-seconds */
187
188#define PF_SPIN (1000000*PF_TMO)/(HZ*PF_SPIN_DEL)
189
190#define STAT_ERR 0x00001
191#define STAT_INDEX 0x00002
192#define STAT_ECC 0x00004
193#define STAT_DRQ 0x00008
194#define STAT_SEEK 0x00010
195#define STAT_WRERR 0x00020
196#define STAT_READY 0x00040
197#define STAT_BUSY 0x00080
198
199#define ATAPI_REQ_SENSE 0x03
200#define ATAPI_LOCK 0x1e
201#define ATAPI_DOOR 0x1b
202#define ATAPI_MODE_SENSE 0x5a
203#define ATAPI_CAPACITY 0x25
204#define ATAPI_IDENTIFY 0x12
205#define ATAPI_READ_10 0x28
206#define ATAPI_WRITE_10 0x2a
207
Al Viro8cfc7ca2008-03-02 09:36:16 -0500208static int pf_open(struct block_device *bdev, fmode_t mode);
Jens Axboe165125e2007-07-24 09:28:11 +0200209static void do_pf_request(struct request_queue * q);
Al Viro8cfc7ca2008-03-02 09:36:16 -0500210static int pf_ioctl(struct block_device *bdev, fmode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 unsigned int cmd, unsigned long arg);
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800212static int pf_getgeo(struct block_device *bdev, struct hd_geometry *geo);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Al Virodb2a1442013-05-05 21:52:57 -0400214static void pf_release(struct gendisk *disk, fmode_t mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215
216static int pf_detect(void);
217static void do_pf_read(void);
218static void do_pf_read_start(void);
219static void do_pf_write(void);
220static void do_pf_write_start(void);
221static void do_pf_read_drq(void);
222static void do_pf_write_done(void);
223
224#define PF_NM 0
225#define PF_RO 1
226#define PF_RW 2
227
228#define PF_NAMELEN 8
229
230struct pf_unit {
231 struct pi_adapter pia; /* interface to paride layer */
232 struct pi_adapter *pi;
233 int removable; /* removable media device ? */
234 int media_status; /* media present ? WP ? */
235 int drive; /* drive */
236 int lun;
237 int access; /* count of active opens ... */
238 int present; /* device present ? */
239 char name[PF_NAMELEN]; /* pf0, pf1, ... */
240 struct gendisk *disk;
241};
242
243static struct pf_unit units[PF_UNITS];
244
245static int pf_identify(struct pf_unit *pf);
246static void pf_lock(struct pf_unit *pf, int func);
247static void pf_eject(struct pf_unit *pf);
Tejun Heob1b56b92011-03-09 19:54:28 +0100248static unsigned int pf_check_events(struct gendisk *disk,
249 unsigned int clearing);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
251static char pf_scratch[512]; /* scratch block buffer */
252
253/* the variables below are used mainly in the I/O request engine, which
254 processes only one request at a time.
255*/
256
257static int pf_retries = 0; /* i/o error retry count */
258static int pf_busy = 0; /* request being processed ? */
259static struct request *pf_req; /* current request */
260static int pf_block; /* address of next requested block */
261static int pf_count; /* number of blocks still to do */
262static int pf_run; /* sectors in current cluster */
263static int pf_cmd; /* current command READ/WRITE */
264static struct pf_unit *pf_current;/* unit of current request */
265static int pf_mask; /* stopper for pseudo-int */
266static char *pf_buf; /* buffer for request in progress */
Sudip Mukherjee9f4ba6b2015-05-20 20:57:01 +0530267static void *par_drv; /* reference of parport driver */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269/* kernel glue structures */
270
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -0700271static const struct block_device_operations pf_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 .owner = THIS_MODULE,
Al Viro8cfc7ca2008-03-02 09:36:16 -0500273 .open = pf_open,
274 .release = pf_release,
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +0200275 .ioctl = pf_ioctl,
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800276 .getgeo = pf_getgeo,
Tejun Heob1b56b92011-03-09 19:54:28 +0100277 .check_events = pf_check_events,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278};
279
280static void __init pf_init_units(void)
281{
282 struct pf_unit *pf;
283 int unit;
284
285 pf_drive_count = 0;
286 for (unit = 0, pf = units; unit < PF_UNITS; unit++, pf++) {
287 struct gendisk *disk = alloc_disk(1);
288 if (!disk)
289 continue;
Omar Sandoval3a644142017-03-27 23:28:45 -0700290 disk->queue = blk_init_queue(do_pf_request, &pf_spin_lock);
291 if (!disk->queue) {
292 put_disk(disk);
293 return;
294 }
295 blk_queue_max_segments(disk->queue, cluster);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 pf->disk = disk;
297 pf->pi = &pf->pia;
298 pf->media_status = PF_NM;
299 pf->drive = (*drives[unit])[D_SLV];
300 pf->lun = (*drives[unit])[D_LUN];
301 snprintf(pf->name, PF_NAMELEN, "%s%d", name, unit);
302 disk->major = major;
303 disk->first_minor = unit;
304 strcpy(disk->disk_name, pf->name);
305 disk->fops = &pf_fops;
306 if (!(*drives[unit])[D_PRT])
307 pf_drive_count++;
308 }
309}
310
Al Viro8cfc7ca2008-03-02 09:36:16 -0500311static int pf_open(struct block_device *bdev, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
Al Viro8cfc7ca2008-03-02 09:36:16 -0500313 struct pf_unit *pf = bdev->bd_disk->private_data;
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200314 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200316 mutex_lock(&pf_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 pf_identify(pf);
318
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200319 ret = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 if (pf->media_status == PF_NM)
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200321 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200323 ret = -EROFS;
Al Viro8cfc7ca2008-03-02 09:36:16 -0500324 if ((pf->media_status == PF_RO) && (mode & FMODE_WRITE))
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200325 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200327 ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 pf->access++;
329 if (pf->removable)
330 pf_lock(pf, 1);
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200331out:
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200332 mutex_unlock(&pf_mutex);
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200333 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334}
335
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800336static int pf_getgeo(struct block_device *bdev, struct hd_geometry *geo)
337{
338 struct pf_unit *pf = bdev->bd_disk->private_data;
339 sector_t capacity = get_capacity(pf->disk);
340
341 if (capacity < PF_FD_MAX) {
342 geo->cylinders = sector_div(capacity, PF_FD_HDS * PF_FD_SPT);
343 geo->heads = PF_FD_HDS;
344 geo->sectors = PF_FD_SPT;
345 } else {
346 geo->cylinders = sector_div(capacity, PF_HD_HDS * PF_HD_SPT);
347 geo->heads = PF_HD_HDS;
348 geo->sectors = PF_HD_SPT;
349 }
350
351 return 0;
352}
353
Al Viro8cfc7ca2008-03-02 09:36:16 -0500354static int pf_ioctl(struct block_device *bdev, fmode_t mode, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355{
Al Viro8cfc7ca2008-03-02 09:36:16 -0500356 struct pf_unit *pf = bdev->bd_disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800358 if (cmd != CDROMEJECT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 return -EINVAL;
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800360
361 if (pf->access != 1)
362 return -EBUSY;
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200363 mutex_lock(&pf_mutex);
Christoph Hellwiga885c8c2006-01-08 01:02:50 -0800364 pf_eject(pf);
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200365 mutex_unlock(&pf_mutex);
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +0200366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 return 0;
368}
369
Al Virodb2a1442013-05-05 21:52:57 -0400370static void pf_release(struct gendisk *disk, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
Al Viro8cfc7ca2008-03-02 09:36:16 -0500372 struct pf_unit *pf = disk->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200374 mutex_lock(&pf_mutex);
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200375 if (pf->access <= 0) {
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200376 mutex_unlock(&pf_mutex);
Al Virodb2a1442013-05-05 21:52:57 -0400377 WARN_ON(1);
378 return;
Arnd Bergmann6e9624b2010-08-07 18:25:34 +0200379 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 pf->access--;
382
383 if (!pf->access && pf->removable)
384 pf_lock(pf, 0);
385
Arnd Bergmann2a48fc02010-06-02 14:28:52 +0200386 mutex_unlock(&pf_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387}
388
Tejun Heob1b56b92011-03-09 19:54:28 +0100389static unsigned int pf_check_events(struct gendisk *disk, unsigned int clearing)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390{
Tejun Heob1b56b92011-03-09 19:54:28 +0100391 return DISK_EVENT_MEDIA_CHANGE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392}
393
394static inline int status_reg(struct pf_unit *pf)
395{
396 return pi_read_regr(pf->pi, 1, 6);
397}
398
399static inline int read_reg(struct pf_unit *pf, int reg)
400{
401 return pi_read_regr(pf->pi, 0, reg);
402}
403
404static inline void write_reg(struct pf_unit *pf, int reg, int val)
405{
406 pi_write_regr(pf->pi, 0, reg, val);
407}
408
409static int pf_wait(struct pf_unit *pf, int go, int stop, char *fun, char *msg)
410{
411 int j, r, e, s, p;
412
413 j = 0;
414 while ((((r = status_reg(pf)) & go) || (stop && (!(r & stop))))
415 && (j++ < PF_SPIN))
416 udelay(PF_SPIN_DEL);
417
Roel Kluinc12ec0a2010-03-11 14:09:47 -0800418 if ((r & (STAT_ERR & stop)) || (j > PF_SPIN)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 s = read_reg(pf, 7);
420 e = read_reg(pf, 1);
421 p = read_reg(pf, 2);
Roel Kluinc12ec0a2010-03-11 14:09:47 -0800422 if (j > PF_SPIN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 e |= 0x100;
424 if (fun)
425 printk("%s: %s %s: alt=0x%x stat=0x%x err=0x%x"
426 " loop=%d phase=%d\n",
427 pf->name, fun, msg, r, s, e, j, p);
428 return (e << 8) + s;
429 }
430 return 0;
431}
432
433static int pf_command(struct pf_unit *pf, char *cmd, int dlen, char *fun)
434{
435 pi_connect(pf->pi);
436
437 write_reg(pf, 6, 0xa0+0x10*pf->drive);
438
439 if (pf_wait(pf, STAT_BUSY | STAT_DRQ, 0, fun, "before command")) {
440 pi_disconnect(pf->pi);
441 return -1;
442 }
443
444 write_reg(pf, 4, dlen % 256);
445 write_reg(pf, 5, dlen / 256);
446 write_reg(pf, 7, 0xa0); /* ATAPI packet command */
447
448 if (pf_wait(pf, STAT_BUSY, STAT_DRQ, fun, "command DRQ")) {
449 pi_disconnect(pf->pi);
450 return -1;
451 }
452
453 if (read_reg(pf, 2) != 1) {
454 printk("%s: %s: command phase error\n", pf->name, fun);
455 pi_disconnect(pf->pi);
456 return -1;
457 }
458
459 pi_write_block(pf->pi, cmd, 12);
460
461 return 0;
462}
463
464static int pf_completion(struct pf_unit *pf, char *buf, char *fun)
465{
466 int r, s, n;
467
468 r = pf_wait(pf, STAT_BUSY, STAT_DRQ | STAT_READY | STAT_ERR,
469 fun, "completion");
470
471 if ((read_reg(pf, 2) & 2) && (read_reg(pf, 7) & STAT_DRQ)) {
472 n = (((read_reg(pf, 4) + 256 * read_reg(pf, 5)) +
473 3) & 0xfffc);
474 pi_read_block(pf->pi, buf, n);
475 }
476
477 s = pf_wait(pf, STAT_BUSY, STAT_READY | STAT_ERR, fun, "data done");
478
479 pi_disconnect(pf->pi);
480
481 return (r ? r : s);
482}
483
484static void pf_req_sense(struct pf_unit *pf, int quiet)
485{
486 char rs_cmd[12] =
487 { ATAPI_REQ_SENSE, pf->lun << 5, 0, 0, 16, 0, 0, 0, 0, 0, 0, 0 };
488 char buf[16];
489 int r;
490
491 r = pf_command(pf, rs_cmd, 16, "Request sense");
492 mdelay(1);
493 if (!r)
494 pf_completion(pf, buf, "Request sense");
495
496 if ((!r) && (!quiet))
497 printk("%s: Sense key: %x, ASC: %x, ASQ: %x\n",
498 pf->name, buf[2] & 0xf, buf[12], buf[13]);
499}
500
501static int pf_atapi(struct pf_unit *pf, char *cmd, int dlen, char *buf, char *fun)
502{
503 int r;
504
505 r = pf_command(pf, cmd, dlen, fun);
506 mdelay(1);
507 if (!r)
508 r = pf_completion(pf, buf, fun);
509 if (r)
510 pf_req_sense(pf, !fun);
511
512 return r;
513}
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515static void pf_lock(struct pf_unit *pf, int func)
516{
517 char lo_cmd[12] = { ATAPI_LOCK, pf->lun << 5, 0, 0, func, 0, 0, 0, 0, 0, 0, 0 };
518
Ondrej Zarye62aa042007-11-14 16:59:24 -0800519 pf_atapi(pf, lo_cmd, 0, pf_scratch, func ? "lock" : "unlock");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520}
521
522static void pf_eject(struct pf_unit *pf)
523{
524 char ej_cmd[12] = { ATAPI_DOOR, pf->lun << 5, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0 };
525
526 pf_lock(pf, 0);
527 pf_atapi(pf, ej_cmd, 0, pf_scratch, "eject");
528}
529
530#define PF_RESET_TMO 30 /* in tenths of a second */
531
532static void pf_sleep(int cs)
533{
Nishanth Aravamudan86e84862005-09-10 00:27:28 -0700534 schedule_timeout_interruptible(cs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535}
536
537/* the ATAPI standard actually specifies the contents of all 7 registers
538 after a reset, but the specification is ambiguous concerning the last
539 two bytes, and different drives interpret the standard differently.
540 */
541
542static int pf_reset(struct pf_unit *pf)
543{
544 int i, k, flg;
545 int expect[5] = { 1, 1, 1, 0x14, 0xeb };
546
547 pi_connect(pf->pi);
548 write_reg(pf, 6, 0xa0+0x10*pf->drive);
549 write_reg(pf, 7, 8);
550
551 pf_sleep(20 * HZ / 1000);
552
553 k = 0;
554 while ((k++ < PF_RESET_TMO) && (status_reg(pf) & STAT_BUSY))
555 pf_sleep(HZ / 10);
556
557 flg = 1;
558 for (i = 0; i < 5; i++)
559 flg &= (read_reg(pf, i + 1) == expect[i]);
560
561 if (verbose) {
562 printk("%s: Reset (%d) signature = ", pf->name, k);
563 for (i = 0; i < 5; i++)
564 printk("%3x", read_reg(pf, i + 1));
565 if (!flg)
566 printk(" (incorrect)");
567 printk("\n");
568 }
569
570 pi_disconnect(pf->pi);
571 return flg - 1;
572}
573
574static void pf_mode_sense(struct pf_unit *pf)
575{
576 char ms_cmd[12] =
577 { ATAPI_MODE_SENSE, pf->lun << 5, 0, 0, 0, 0, 0, 0, 8, 0, 0, 0 };
578 char buf[8];
579
Ondrej Zarye62aa042007-11-14 16:59:24 -0800580 pf_atapi(pf, ms_cmd, 8, buf, "mode sense");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 pf->media_status = PF_RW;
582 if (buf[3] & 0x80)
583 pf->media_status = PF_RO;
584}
585
586static void xs(char *buf, char *targ, int offs, int len)
587{
588 int j, k, l;
589
590 j = 0;
591 l = 0;
592 for (k = 0; k < len; k++)
593 if ((buf[k + offs] != 0x20) || (buf[k + offs] != l))
594 l = targ[j++] = buf[k + offs];
595 if (l == 0x20)
596 j--;
597 targ[j] = 0;
598}
599
600static int xl(char *buf, int offs)
601{
602 int v, k;
603
604 v = 0;
605 for (k = 0; k < 4; k++)
606 v = v * 256 + (buf[k + offs] & 0xff);
607 return v;
608}
609
610static void pf_get_capacity(struct pf_unit *pf)
611{
612 char rc_cmd[12] = { ATAPI_CAPACITY, pf->lun << 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
613 char buf[8];
614 int bs;
615
Ondrej Zarye62aa042007-11-14 16:59:24 -0800616 if (pf_atapi(pf, rc_cmd, 8, buf, "get capacity")) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 pf->media_status = PF_NM;
618 return;
619 }
620 set_capacity(pf->disk, xl(buf, 0) + 1);
621 bs = xl(buf, 4);
622 if (bs != 512) {
623 set_capacity(pf->disk, 0);
624 if (verbose)
625 printk("%s: Drive %d, LUN %d,"
626 " unsupported block size %d\n",
627 pf->name, pf->drive, pf->lun, bs);
628 }
629}
630
631static int pf_identify(struct pf_unit *pf)
632{
633 int dt, s;
634 char *ms[2] = { "master", "slave" };
635 char mf[10], id[18];
636 char id_cmd[12] =
637 { ATAPI_IDENTIFY, pf->lun << 5, 0, 0, 36, 0, 0, 0, 0, 0, 0, 0 };
638 char buf[36];
639
640 s = pf_atapi(pf, id_cmd, 36, buf, "identify");
641 if (s)
642 return -1;
643
644 dt = buf[0] & 0x1f;
645 if ((dt != 0) && (dt != 7)) {
646 if (verbose)
647 printk("%s: Drive %d, LUN %d, unsupported type %d\n",
648 pf->name, pf->drive, pf->lun, dt);
649 return -1;
650 }
651
652 xs(buf, mf, 8, 8);
653 xs(buf, id, 16, 16);
654
655 pf->removable = (buf[1] & 0x80);
656
657 pf_mode_sense(pf);
658 pf_mode_sense(pf);
659 pf_mode_sense(pf);
660
661 pf_get_capacity(pf);
662
663 printk("%s: %s %s, %s LUN %d, type %d",
664 pf->name, mf, id, ms[pf->drive], pf->lun, dt);
665 if (pf->removable)
666 printk(", removable");
667 if (pf->media_status == PF_NM)
668 printk(", no media\n");
669 else {
670 if (pf->media_status == PF_RO)
671 printk(", RO");
672 printk(", %llu blocks\n",
673 (unsigned long long)get_capacity(pf->disk));
674 }
675 return 0;
676}
677
678/* returns 0, with id set if drive is detected
679 -1, if drive detection failed
680*/
681static int pf_probe(struct pf_unit *pf)
682{
683 if (pf->drive == -1) {
684 for (pf->drive = 0; pf->drive <= 1; pf->drive++)
685 if (!pf_reset(pf)) {
686 if (pf->lun != -1)
687 return pf_identify(pf);
688 else
689 for (pf->lun = 0; pf->lun < 8; pf->lun++)
690 if (!pf_identify(pf))
691 return 0;
692 }
693 } else {
694 if (pf_reset(pf))
695 return -1;
696 if (pf->lun != -1)
697 return pf_identify(pf);
698 for (pf->lun = 0; pf->lun < 8; pf->lun++)
699 if (!pf_identify(pf))
700 return 0;
701 }
702 return -1;
703}
704
705static int pf_detect(void)
706{
707 struct pf_unit *pf = units;
708 int k, unit;
709
710 printk("%s: %s version %s, major %d, cluster %d, nice %d\n",
711 name, name, PF_VERSION, major, cluster, nice);
712
Sudip Mukherjee9f4ba6b2015-05-20 20:57:01 +0530713 par_drv = pi_register_driver(name);
714 if (!par_drv) {
715 pr_err("failed to register %s driver\n", name);
716 return -1;
717 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 k = 0;
719 if (pf_drive_count == 0) {
720 if (pi_init(pf->pi, 1, -1, -1, -1, -1, -1, pf_scratch, PI_PF,
721 verbose, pf->name)) {
722 if (!pf_probe(pf) && pf->disk) {
723 pf->present = 1;
724 k++;
725 } else
726 pi_release(pf->pi);
727 }
728
729 } else
730 for (unit = 0; unit < PF_UNITS; unit++, pf++) {
731 int *conf = *drives[unit];
732 if (!conf[D_PRT])
733 continue;
734 if (pi_init(pf->pi, 0, conf[D_PRT], conf[D_MOD],
735 conf[D_UNI], conf[D_PRO], conf[D_DLY],
736 pf_scratch, PI_PF, verbose, pf->name)) {
Eric Sesterhenn8e53cfc2006-06-29 02:24:32 -0700737 if (pf->disk && !pf_probe(pf)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 pf->present = 1;
739 k++;
740 } else
741 pi_release(pf->pi);
742 }
743 }
744 if (k)
745 return 0;
746
747 printk("%s: No ATAPI disk detected\n", name);
748 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
749 put_disk(pf->disk);
Sudip Mukherjee9f4ba6b2015-05-20 20:57:01 +0530750 pi_unregister_driver(par_drv);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 return -1;
752}
753
754/* The i/o request engine */
755
756static int pf_start(struct pf_unit *pf, int cmd, int b, int c)
757{
758 int i;
759 char io_cmd[12] = { cmd, pf->lun << 5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
760
761 for (i = 0; i < 4; i++) {
762 io_cmd[5 - i] = b & 0xff;
763 b = b >> 8;
764 }
765
766 io_cmd[8] = c & 0xff;
767 io_cmd[7] = (c >> 8) & 0xff;
768
769 i = pf_command(pf, io_cmd, c * 512, "start i/o");
770
771 mdelay(1);
772
773 return i;
774}
775
776static int pf_ready(void)
777{
778 return (((status_reg(pf_current) & (STAT_BUSY | pf_mask)) == pf_mask));
779}
780
Omar Sandoval3a644142017-03-27 23:28:45 -0700781static int pf_queue;
782
783static int set_next_request(void)
784{
785 struct pf_unit *pf;
786 struct request_queue *q;
787 int old_pos = pf_queue;
788
789 do {
790 pf = &units[pf_queue];
791 q = pf->present ? pf->disk->queue : NULL;
792 if (++pf_queue == PF_UNITS)
793 pf_queue = 0;
794 if (q) {
795 pf_req = blk_fetch_request(q);
796 if (pf_req)
797 break;
798 }
799 } while (pf_queue != old_pos);
800
801 return pf_req != NULL;
802}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Tejun Heof06d9a22009-04-23 11:05:19 +0900804static void pf_end_request(int err)
Jens Axboe9564df12005-09-16 19:28:15 -0700805{
Tejun Heob12d4f82009-05-08 11:54:06 +0900806 if (pf_req && !__blk_end_request_cur(pf_req, err))
Jens Axboe9564df12005-09-16 19:28:15 -0700807 pf_req = NULL;
Jens Axboe9564df12005-09-16 19:28:15 -0700808}
809
Omar Sandoval3a644142017-03-27 23:28:45 -0700810static void pf_request(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
812 if (pf_busy)
813 return;
814repeat:
Omar Sandoval3a644142017-03-27 23:28:45 -0700815 if (!pf_req && !set_next_request())
816 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
818 pf_current = pf_req->rq_disk->private_data;
Tejun Heo83096eb2009-05-07 22:24:39 +0900819 pf_block = blk_rq_pos(pf_req);
820 pf_run = blk_rq_sectors(pf_req);
821 pf_count = blk_rq_cur_sectors(pf_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 if (pf_block + pf_count > get_capacity(pf_req->rq_disk)) {
Tejun Heof06d9a22009-04-23 11:05:19 +0900824 pf_end_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 goto repeat;
826 }
827
828 pf_cmd = rq_data_dir(pf_req);
Jens Axboeb4f42e22014-04-10 09:46:28 -0600829 pf_buf = bio_data(pf_req->bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 pf_retries = 0;
831
832 pf_busy = 1;
833 if (pf_cmd == READ)
834 pi_do_claimed(pf_current->pi, do_pf_read);
835 else if (pf_cmd == WRITE)
836 pi_do_claimed(pf_current->pi, do_pf_write);
837 else {
838 pf_busy = 0;
Tejun Heof06d9a22009-04-23 11:05:19 +0900839 pf_end_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 goto repeat;
841 }
842}
843
Omar Sandoval3a644142017-03-27 23:28:45 -0700844static void do_pf_request(struct request_queue *q)
845{
846 pf_request();
847}
848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849static int pf_next_buf(void)
850{
851 unsigned long saved_flags;
852
853 pf_count--;
854 pf_run--;
855 pf_buf += 512;
856 pf_block++;
857 if (!pf_run)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 return 1;
Ondrej Zarye62aa042007-11-14 16:59:24 -0800859 if (!pf_count) {
860 spin_lock_irqsave(&pf_spin_lock, saved_flags);
Tejun Heof06d9a22009-04-23 11:05:19 +0900861 pf_end_request(0);
Ondrej Zarye62aa042007-11-14 16:59:24 -0800862 spin_unlock_irqrestore(&pf_spin_lock, saved_flags);
863 if (!pf_req)
864 return 1;
Tejun Heo83096eb2009-05-07 22:24:39 +0900865 pf_count = blk_rq_cur_sectors(pf_req);
Jens Axboeb4f42e22014-04-10 09:46:28 -0600866 pf_buf = bio_data(pf_req->bio);
Ondrej Zarye62aa042007-11-14 16:59:24 -0800867 }
868 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869}
870
Tejun Heof06d9a22009-04-23 11:05:19 +0900871static inline void next_request(int err)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872{
873 unsigned long saved_flags;
874
875 spin_lock_irqsave(&pf_spin_lock, saved_flags);
Tejun Heof06d9a22009-04-23 11:05:19 +0900876 pf_end_request(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 pf_busy = 0;
Omar Sandoval3a644142017-03-27 23:28:45 -0700878 pf_request();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 spin_unlock_irqrestore(&pf_spin_lock, saved_flags);
880}
881
882/* detach from the calling context - in case the spinlock is held */
883static void do_pf_read(void)
884{
885 ps_set_intr(do_pf_read_start, NULL, 0, nice);
886}
887
888static void do_pf_read_start(void)
889{
890 pf_busy = 1;
891
892 if (pf_start(pf_current, ATAPI_READ_10, pf_block, pf_run)) {
893 pi_disconnect(pf_current->pi);
894 if (pf_retries < PF_MAX_RETRIES) {
895 pf_retries++;
896 pi_do_claimed(pf_current->pi, do_pf_read_start);
897 return;
898 }
Tejun Heof06d9a22009-04-23 11:05:19 +0900899 next_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 return;
901 }
902 pf_mask = STAT_DRQ;
903 ps_set_intr(do_pf_read_drq, pf_ready, PF_TMO, nice);
904}
905
906static void do_pf_read_drq(void)
907{
908 while (1) {
909 if (pf_wait(pf_current, STAT_BUSY, STAT_DRQ | STAT_ERR,
910 "read block", "completion") & STAT_ERR) {
911 pi_disconnect(pf_current->pi);
912 if (pf_retries < PF_MAX_RETRIES) {
913 pf_req_sense(pf_current, 0);
914 pf_retries++;
915 pi_do_claimed(pf_current->pi, do_pf_read_start);
916 return;
917 }
Tejun Heof06d9a22009-04-23 11:05:19 +0900918 next_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 return;
920 }
921 pi_read_block(pf_current->pi, pf_buf, 512);
922 if (pf_next_buf())
923 break;
924 }
925 pi_disconnect(pf_current->pi);
Tejun Heof06d9a22009-04-23 11:05:19 +0900926 next_request(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927}
928
929static void do_pf_write(void)
930{
931 ps_set_intr(do_pf_write_start, NULL, 0, nice);
932}
933
934static void do_pf_write_start(void)
935{
936 pf_busy = 1;
937
938 if (pf_start(pf_current, ATAPI_WRITE_10, pf_block, pf_run)) {
939 pi_disconnect(pf_current->pi);
940 if (pf_retries < PF_MAX_RETRIES) {
941 pf_retries++;
942 pi_do_claimed(pf_current->pi, do_pf_write_start);
943 return;
944 }
Tejun Heof06d9a22009-04-23 11:05:19 +0900945 next_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 return;
947 }
948
949 while (1) {
950 if (pf_wait(pf_current, STAT_BUSY, STAT_DRQ | STAT_ERR,
951 "write block", "data wait") & STAT_ERR) {
952 pi_disconnect(pf_current->pi);
953 if (pf_retries < PF_MAX_RETRIES) {
954 pf_retries++;
955 pi_do_claimed(pf_current->pi, do_pf_write_start);
956 return;
957 }
Tejun Heof06d9a22009-04-23 11:05:19 +0900958 next_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return;
960 }
961 pi_write_block(pf_current->pi, pf_buf, 512);
962 if (pf_next_buf())
963 break;
964 }
965 pf_mask = 0;
966 ps_set_intr(do_pf_write_done, pf_ready, PF_TMO, nice);
967}
968
969static void do_pf_write_done(void)
970{
971 if (pf_wait(pf_current, STAT_BUSY, 0, "write block", "done") & STAT_ERR) {
972 pi_disconnect(pf_current->pi);
973 if (pf_retries < PF_MAX_RETRIES) {
974 pf_retries++;
975 pi_do_claimed(pf_current->pi, do_pf_write_start);
976 return;
977 }
Tejun Heof06d9a22009-04-23 11:05:19 +0900978 next_request(-EIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 return;
980 }
981 pi_disconnect(pf_current->pi);
Tejun Heof06d9a22009-04-23 11:05:19 +0900982 next_request(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983}
984
985static int __init pf_init(void)
986{ /* preliminary initialisation */
987 struct pf_unit *pf;
988 int unit;
989
990 if (disable)
Akinobu Mita8bca98c2006-12-06 20:36:43 -0800991 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
993 pf_init_units();
994
995 if (pf_detect())
Akinobu Mita8bca98c2006-12-06 20:36:43 -0800996 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 pf_busy = 0;
998
999 if (register_blkdev(major, name)) {
1000 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++)
1001 put_disk(pf->disk);
Akinobu Mita8bca98c2006-12-06 20:36:43 -08001002 return -EBUSY;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
1005 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++) {
1006 struct gendisk *disk = pf->disk;
1007
1008 if (!pf->present)
1009 continue;
1010 disk->private_data = pf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 add_disk(disk);
1012 }
1013 return 0;
1014}
1015
1016static void __exit pf_exit(void)
1017{
1018 struct pf_unit *pf;
1019 int unit;
1020 unregister_blkdev(major, name);
1021 for (pf = units, unit = 0; unit < PF_UNITS; pf++, unit++) {
1022 if (!pf->present)
1023 continue;
1024 del_gendisk(pf->disk);
Omar Sandoval3a644142017-03-27 23:28:45 -07001025 blk_cleanup_queue(pf->disk->queue);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 put_disk(pf->disk);
1027 pi_release(pf->pi);
1028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029}
1030
1031MODULE_LICENSE("GPL");
1032module_init(pf_init)
1033module_exit(pf_exit)