cregit-Linux how code gets into the kernel

Release 4.11 drivers/scsi/ppa.c

Directory: drivers/scsi
/* ppa.c   --  low level driver for the IOMEGA PPA3 
 * parallel port SCSI host adapter.
 * 
 * (The PPA3 is the embedded controller in the ZIP drive.)
 * 
 * (c) 1995,1996 Grant R. Guenther, grant@torque.net,
 * under the terms of the GNU General Public License.
 * 
 */

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/blkdev.h>
#include <linux/parport.h>
#include <linux/workqueue.h>
#include <linux/delay.h>
#include <linux/jiffies.h>
#include <asm/io.h>

#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_device.h>
#include <scsi/scsi_host.h>


static void ppa_reset_pulse(unsigned int base);

typedef struct {
	
struct pardevice *dev;	/* Parport device entry         */
	
int base;		/* Actual port address          */
	
int mode;		/* Transfer mode                */
	
struct scsi_cmnd *cur_cmd;	/* Current queued command       */
	
struct delayed_work ppa_tq;	/* Polling interrupt stuff       */
	
unsigned long jstart;	/* Jiffies at start             */
	
unsigned long recon_tmo;	/* How many usecs to wait for reconnection (6th bit) */
	
unsigned int failed:1;	/* Failure flag                 */
	
unsigned wanted:1;	/* Parport sharing busy flag    */
	
unsigned int dev_no;	/* Device number                */
	
wait_queue_head_t *waiting;
	
struct Scsi_Host *host;
	
struct list_head list;
} 
ppa_struct;

#include  "ppa.h"


static inline ppa_struct *ppa_dev(struct Scsi_Host *host) { return *(ppa_struct **)&host->hostdata; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro2392.00%266.67%
Linus Torvalds (pre-git)28.00%133.33%
Total25100.00%3100.00%

static DEFINE_SPINLOCK(arbitration_lock);
static void got_it(ppa_struct *dev) { dev->base = dev->dev->port->base; if (dev->cur_cmd) dev->cur_cmd->SCp.phase = 1; else wake_up(dev->waiting); }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro46100.00%1100.00%
Total46100.00%1100.00%


static void ppa_wakeup(void *ref) { ppa_struct *dev = (ppa_struct *) ref; unsigned long flags; spin_lock_irqsave(&arbitration_lock, flags); if (dev->wanted) { parport_claim(dev->dev); got_it(dev); dev->wanted = 0; } spin_unlock_irqrestore(&arbitration_lock, flags); return; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)3653.73%240.00%
Al Viro3146.27%360.00%
Total67100.00%5100.00%


static int ppa_pb_claim(ppa_struct *dev) { unsigned long flags; int res = 1; spin_lock_irqsave(&arbitration_lock, flags); if (parport_claim(dev->dev) == 0) { got_it(dev); res = 0; } dev->wanted = res; spin_unlock_irqrestore(&arbitration_lock, flags); return res; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro4771.21%250.00%
Linus Torvalds (pre-git)1928.79%250.00%
Total66100.00%4100.00%


static void ppa_pb_dismiss(ppa_struct *dev) { unsigned long flags; int wanted; spin_lock_irqsave(&arbitration_lock, flags); wanted = dev->wanted; dev->wanted = 0; spin_unlock_irqrestore(&arbitration_lock, flags); if (!wanted) parport_release(dev->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro5494.74%250.00%
Linus Torvalds (pre-git)35.26%250.00%
Total57100.00%4100.00%


static inline void ppa_pb_release(ppa_struct *dev) { parport_release(dev->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro1583.33%150.00%
Linus Torvalds (pre-git)316.67%150.00%
Total18100.00%2100.00%

/* * Start of Chipset kludges */ /* This is to give the ppa driver a way to modify the timings (and other * parameters) by writing to the /proc/scsi/ppa/0 file. * Very simple method really... (To simple, no error checking :( ) * Reason: Kernel hackers HATE having to unload and reload modules for * testing... * Also gives a method to use a script to obtain optimum timings (TODO) */
static inline int ppa_write_info(struct Scsi_Host *host, char *buffer, int length) { ppa_struct *dev = ppa_dev(host); unsigned long x; if ((length > 5) && (strncmp(buffer, "mode=", 5) == 0)) { x = simple_strtoul(buffer + 5, NULL, 0); dev->mode = x; return length; } if ((length > 10) && (strncmp(buffer, "recon_tmo=", 10) == 0)) { x = simple_strtoul(buffer + 10, NULL, 0); dev->recon_tmo = x; printk(KERN_INFO "ppa: recon_tmo set to %ld\n", x); return length; } printk(KERN_WARNING "ppa /proc: invalid variable\n"); return -EINVAL; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro11582.14%654.55%
Linus Torvalds (pre-git)2316.43%436.36%
Alan Cox21.43%19.09%
Total140100.00%11100.00%


static int ppa_show_info(struct seq_file *m, struct Scsi_Host *host) { ppa_struct *dev = ppa_dev(host); seq_printf(m, "Version : %s\n", PPA_VERSION); seq_printf(m, "Parport : %s\n", dev->dev->port->name); seq_printf(m, "Mode : %s\n", PPA_MODE_STRING[dev->mode]); #if PPA_DEBUG > 0 seq_printf(m, "recon_tmo : %lu\n", dev->recon_tmo); #endif return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro7083.33%360.00%
Linus Torvalds (pre-git)1416.67%240.00%
Total84100.00%5100.00%

static int device_check(ppa_struct *dev); #if PPA_DEBUG > 0 #define ppa_fail(x,y) printk("ppa: ppa_fail(%i) from %s at line %d\n",\ y, __func__, __LINE__); ppa_fail_func(x,y); static inline void ppa_fail_func(ppa_struct *dev, int error_code) #else static inline void ppa_fail(ppa_struct *dev, int error_code) #endif { /* If we fail a device then we trash status / message bytes */ if (dev->cur_cmd) { dev->cur_cmd->result = error_code << 16; dev->failed = 1; } } /* * Wait for the high bit to be set. * * In principle, this could be tied to an interrupt, but the adapter * doesn't appear to be designed to support interrupts. We spin on * the 0x80 ready bit. */
static unsigned char ppa_wait(ppa_struct *dev) { int k; unsigned short ppb = dev->base; unsigned char r; k = PPA_SPIN_TMO; /* Wait for bit 6 and 7 - PJC */ for (r = r_str(ppb); ((r & 0xc0) != 0xc0) && (k); k--) { udelay(1); r = r_str(ppb); } /* * return some status information. * Semantics: 0xc0 = ZIP wants more data * 0xd0 = ZIP wants to send more data * 0xe0 = ZIP is expecting SCSI command data * 0xf0 = end of transfer, ZIP is sending status */ if (k) return (r & 0xf0); /* Counter expired - Time out occurred */ ppa_fail(dev, DID_TIME_OUT); printk(KERN_WARNING "ppa timeout in ppa_wait\n"); return 0; /* command timed out */ }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro8786.14%350.00%
Linus Torvalds (pre-git)1110.89%116.67%
Linus Torvalds21.98%116.67%
Alan Cox10.99%116.67%
Total101100.00%6100.00%

/* * Clear EPP Timeout Bit */
static inline void epp_reset(unsigned short ppb) { int i; i = r_str(ppb); w_str(ppb, i); w_str(ppb, i & 0xfe); }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro2464.86%133.33%
Linus Torvalds (pre-git)1335.14%266.67%
Total37100.00%3100.00%

/* * Wait for empty ECP fifo (if we are in ECP fifo mode only) */
static inline void ecp_sync(ppa_struct *dev) { int i, ppb_hi = dev->dev->port->base_hi; if (ppb_hi == 0) return; if ((r_ecr(ppb_hi) & 0xe0) == 0x60) { /* mode 011 == ECP fifo mode */ for (i = 0; i < 100; i++) { if (r_ecr(ppb_hi) & 0x01) return; udelay(5); } printk(KERN_WARNING "ppa: ECP sync failed as data still present in FIFO.\n"); } }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro6274.70%233.33%
Linus Torvalds (pre-git)2024.10%350.00%
Alan Cox11.20%116.67%
Total83100.00%6100.00%


static int ppa_byte_out(unsigned short base, const char *buffer, int len) { int i; for (i = len; i; i--) { w_dtr(base, *buffer++); w_ctr(base, 0xe); w_ctr(base, 0xc); } return 1; /* All went well - we hope! */ }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro3862.30%350.00%
Linus Torvalds (pre-git)2236.07%233.33%
Christoph Hellwig11.64%116.67%
Total61100.00%6100.00%


static int ppa_byte_in(unsigned short base, char *buffer, int len) { int i; for (i = len; i; i--) { *buffer++ = r_dtr(base); w_ctr(base, 0x27); w_ctr(base, 0x25); } return 1; /* All went well - we hope! */ }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro4981.67%125.00%
Linus Torvalds (pre-git)1118.33%375.00%
Total60100.00%4100.00%


static int ppa_nibble_in(unsigned short base, char *buffer, int len) { for (; len; len--) { unsigned char h; w_ctr(base, 0x4); h = r_str(base) & 0xf0; w_ctr(base, 0x6); *buffer++ = h | ((r_str(base) & 0xf0) >> 4); } return 1; /* All went well - we hope! */ }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro6888.31%133.33%
Linus Torvalds (pre-git)911.69%266.67%
Total77100.00%3100.00%


static int ppa_out(ppa_struct *dev, char *buffer, int len) { int r; unsigned short ppb = dev->base; r = ppa_wait(dev); if ((r & 0x50) != 0x40) { ppa_fail(dev, DID_ERROR); return 0; } switch (dev->mode) { case PPA_NIBBLE: case PPA_PS2: /* 8 bit output, with a loop */ r = ppa_byte_out(ppb, buffer, len); break; case PPA_EPP_32: case PPA_EPP_16: case PPA_EPP_8: epp_reset(ppb); w_ctr(ppb, 0x4); #ifdef CONFIG_SCSI_IZIP_EPP16 if (!(((long) buffer | len) & 0x01)) outsw(ppb + 4, buffer, len >> 1); #else if (!(((long) buffer | len) & 0x03)) outsl(ppb + 4, buffer, len >> 2); #endif else outsb(ppb + 4, buffer, len); w_ctr(ppb, 0xc); r = !(r_str(ppb) & 0x01); w_ctr(ppb, 0xc); ecp_sync(dev); break; default: printk(KERN_ERR "PPA: bug in ppa_out()\n"); r = 0; } return r; }

Contributors

PersonTokensPropCommitsCommitProp
Al Viro14764.47%225.00%
Linus Torvalds (pre-git)8035.09%562.50%
Alan Cox10.44%112.50%
Total228100.00%8100.00%


static int ppa_in(ppa_struct *dev, char *buffer, int len) { int r; unsigned short ppb = dev->base; r = ppa_wait(dev); if ((r & 0x50) != 0x50) { ppa_fail(dev, DID_ERROR); return 0; } switch (dev->mode) { case PPA_NIBBLE: /* 4 bit input, with a loop */ r = ppa_nibble_in(ppb, buffer, len); w_ctr(ppb, 0xc); break; case PPA_PS2: /* 8 bit input, with a loop */ w_ctr(ppb, 0x25); r = ppa_byte_in(ppb, buffer, len); w_ctr(ppb, 0x4); w_ctr(ppb, 0xc); break; case PPA_EPP_32: case PPA_EPP_16: case PPA_EPP_8: epp_reset(ppb); w_ctr(ppb, 0x24); #ifdef CONFIG_SCSI_IZIP_EPP16 if (!(((long) buffer | len) & 0x01)) insw(ppb + 4, buffer, len >> 1); #else if (!(((long) buffer | len) & 0x03)) insl(ppb + 4, buffer, len >> 2); #endif else insb(ppb + 4, buffer, len); w_ctr(ppb, 0x2c); r = !(r_str(ppb) & 0x01); w_ctr(ppb, 0x2c); ecp_sync(dev); break; default: printk(KERN_ERR "PPA: bug in ppa_ins()\n"); r = 0; break; } return r; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)18769.26%562.50%
Al Viro8230.37%225.00%
Alan Cox10.37%112.50%
Total270100.00%8100.00%

/* end of ppa_io.h */
static inline void ppa_d_pulse(unsigned short ppb, unsigned char b) { w_dtr(ppb, b); w_ctr(ppb, 0xc); w_ctr(ppb, 0xe); w_ctr(ppb, 0xc); w_ctr(ppb, 0x4); w_ctr(ppb, 0xc); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)3663.16%375.00%
Al Viro2136.84%125.00%
Total57100.00%4100.00%


static void ppa_disconnect(ppa_struct *dev) { unsigned short ppb = dev->base; ppa_d_pulse(ppb, 0); ppa_d_pulse(ppb, 0x3c); ppa_d_pulse(ppb, 0x20); ppa_d_pulse(ppb, 0xf); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)4086.96%375.00%
Al Viro613.04%125.00%
Total46100.00%4100.00%


static inline void ppa_c_pulse(unsigned short ppb, unsigned char b) { w_dtr(ppb, b); w_ctr(ppb, 0x4); w_ctr(ppb, 0x6); w_ctr(ppb, 0x4); w_ctr(ppb, 0xc); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)50100.00%3100.00%
Total50100.00%3100.00%


static inline void ppa_connect(ppa_struct *dev, int flag) { unsigned short ppb = dev->base; ppa_c_pulse(ppb, 0); ppa_c_pulse(ppb, 0x3c); ppa_c_pulse(ppb, 0x20); if ((flag == CONNECT_EPP_MAYBE) && IN_EPP_MODE(dev->mode)) ppa_c_pulse(ppb, 0xcf); else ppa_c_pulse(ppb, 0x8f); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)6589.04%375.00%
Al Viro810.96%125.00%
Total73100.00%4100.00%


static int ppa_select(ppa_struct *dev, int target) { int k; unsigned short ppb = dev->base; /* * Bit 6 (0x40) is the device selected bit. * First we must wait till the current device goes off line... */ k = PPA_SELECT_TMO; do { k--; udelay(1); } while ((r_str(ppb) & 0x40) && (k)); if (!k) return 0; w_dtr(ppb, (1 << target)); w_ctr(ppb, 0xe); w_ctr(ppb, 0xc); w_dtr(ppb, 0x80); /* This is NOT the initator */ w_ctr(ppb, 0x8); k = PPA_SELECT_TMO; do { k--; udelay(1); } while (!(r_str(ppb) & 0x40) && (k)); if (!k) return 0; return 1; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)14095.24%466.67%
Al Viro74.76%233.33%
Total147100.00%6100.00%

/* * This is based on a trace of what the Iomega DOS 'guest' driver does. * I've tried several different kinds of parallel ports with guest and * coded this to react in the same ways that it does. * * The return value from this function is just a hint about where the * handshaking failed. * */
static int ppa_init(ppa_struct *dev) { int retv; unsigned short ppb = dev->base; ppa_disconnect(dev); ppa_connect(dev, CONNECT_NORMAL); retv = 2; /* Failed */ w_ctr(ppb, 0xe); if ((r_str(ppb) & 0x08) == 0x08) retv--; w_ctr(ppb, 0xc); if ((r_str(ppb) & 0x08) == 0x00) retv--; if (!retv) ppa_reset_pulse(ppb); udelay(1000); /* Allow devices to settle down */ ppa_disconnect(dev); udelay(1000); /* Another delay to allow devices to settle */ if (retv) return -EIO; return device_check(dev); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)11088.00%466.67%
Al Viro1512.00%233.33%
Total125100.00%6100.00%


static inline int ppa_send_command(struct scsi_cmnd *cmd) { ppa_struct *dev = ppa_dev(cmd->device->host); int k; w_ctr(dev->base, 0x0c); for (k = 0; k < cmd->cmd_len; k++) if (!ppa_out(dev, &cmd->cmnd[k], 1)) return 0; return 1; }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)6281.58%350.00%
Al Viro1013.16%116.67%
Christoph Hellwig22.63%116.67%
Alan Cox22.63%116.67%
Total76100.00%6100.00%

/* * The bulk flag enables some optimisations in the data transfer loops, * it should be true for any command that transfers data in integral * numbers of sectors. * * The driver appears to remain stable if we speed up the parallel port * i/o in this function, but not elsewhere. */
static int ppa_completion(struct scsi_cmnd *cmd) { /* Return codes: * -1 Error * 0 Told to schedule * 1 Finished data transfer */ ppa_struct *dev = ppa_dev(cmd->device->host); unsigned short ppb = dev->base; unsigned long start_jiffies = jiffies; unsigned char r, v; int fast, bulk, status; v = cmd->cmnd[0]; bulk = ((v == READ_6) || (v == READ_10) || (v == WRITE_6) || (v == WRITE_10)); /* * We only get here if the drive is ready to comunicate, * hence no need for a full ppa_wait. */ r = (r_str(ppb) & 0xf0); while (r != (unsigned char) 0xf0) { /* * If we have been running for more than a full timer tick * then take a rest. */ if (time_after(jiffies, start_jiffies + 1)) return 0; if ((cmd->SCp.this_residual <= 0)) { ppa_fail(dev, DID_ERROR); return -1; /* ERROR_RETURN */ } /* On some hardware we have SCSI disconnected (6th bit low) * for about 100usecs. It is too expensive to wait a * tick on every loop so we busy wait for no more than * 500usecs to give the drive a chance first. We do not * change things for "normal" hardware since generally * the 6th bit is always high. * This makes the CPU load higher on some hardware * but otherwise we can not get more than 50K/secs * on this problem hardware. */ if ((r & 0xc0) != 0xc0) { /* Wait for reconnection should be no more than * jiffy/2 = 5ms = 5000 loops */ unsigned long k = dev->recon_tmo; for (; k && ((r = (r_str(ppb) & 0xf0)) & 0xc0) != 0xc0; k--) udelay(1); if (!k) return 0; } /* determine if we should use burst I/O */ fast = (bulk && (cmd->SCp.this_residual >= PPA_BURST_SIZE)) ? PPA_BURST_SIZE : 1; if (r == (unsigned char) 0xc0) status = ppa_out(dev, cmd->SCp.ptr, fast); else status = ppa_in(dev, cmd->SCp.ptr, fast); cmd->SCp.ptr += fast; cmd->SCp.this_residual -= fast; if (!status) { ppa_fail(dev, DID_BUS_BUSY); return -1; /* ERROR_RETURN */ } if (cmd->SCp.buffer && !cmd->SCp.this_residual) { /* if scatter/gather, advance to the next segment */ if (cmd->SCp.buffers_residual--) { cmd->SCp.buffer++; cmd->SCp.this_residual = cmd->SCp.buffer->length; cmd->SCp.ptr = sg_virt(cmd->SCp.buffer); } } /* Now check to see if the drive is ready to comunicate */ r = (r_str(ppb) & 0xf0); /* If not, drop back down to the scheduler and wait a timer tick */ if (!(r & 0x80)) return 0; } return 1; /* FINISH_RETURN */ }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)38093.37%545.45%
Al Viro204.91%218.18%
Christoph Hellwig20.49%19.09%
Andries E. Brouwer20.49%19.09%
Alan Cox20.49%19.09%
Jens Axboe10.25%19.09%
Total407100.00%11100.00%

/* * Since the PPA itself doesn't generate interrupts, we use * the scheduler's task queue to generate a stream of call-backs and * complete the request when the drive is ready. */
static void ppa_interrupt(struct work_struct *work) { ppa_struct *dev = container_of(work, ppa_struct, ppa_tq.work); struct scsi_cmnd *cmd = dev->cur_cmd; if (!cmd) { printk(KERN_ERR "PPA: bug in ppa_interrupt\n"); return; } if (ppa_engine(dev, cmd)) { schedule_delayed_work(&dev->ppa_tq, 1); return; } /* Command must of completed hence it is safe to let go... */ #if PPA_DEBUG > 0 switch ((cmd->result >> 16) & 0xff) { case DID_OK: break; case DID_NO_CONNECT: printk(KERN_DEBUG "ppa: no device at SCSI ID %i\n", cmd->device->target); break; case DID_BUS_BUSY: printk(KERN_DEBUG "ppa: BUS BUSY - EPP timeout detected\n"); break; case DID_TIME_OUT: printk(KERN_DEBUG "ppa: unknown timeout\n"); break; case DID_ABORT: printk(KERN_DEBUG "ppa: told to abort\n"); break; case DID_PARITY: printk(KERN_DEBUG "ppa: parity error (???)\n"); break; case DID_ERROR: printk(KERN_DEBUG "ppa: internal driver error\n"); break; case DID_RESET: printk(KERN_DEBUG "ppa: told to reset device\n"); break; case DID_BAD_INTR: printk(KERN_WARNING "ppa: bad interrupt (???)\n"); break; default: printk(KERN_WARNING "ppa: bad return code (%02x)\n", (cmd->result >> 16) & 0xff); } #endif if (cmd->SCp.phase > 1) ppa_disconnect(dev); ppa_pb_dismiss(dev); dev->cur_cmd = NULL; cmd->scsi_done(cmd); }

Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)19081.55%433.33%
Al Viro156.44%325.00%
David Howells125.15%18.33%
Alan Cox125.15%216.67%
Ingo Molnar20.86%18.33%
Christoph Hellwig20.86%18.33%
Total233100.00%12100.00%


static int ppa_engine(ppa_struct *dev, struct scsi_cmnd *cmd) { unsigned short ppb = dev->base; unsigned char l = 0, h = 0; int retv; /* First check for any errors that may of occurred * Here we check for internal errors */ if (dev->failed) return 0; switch (cmd->SCp.phase) { case 0: /* Phase 0 - Waiting for parport */ if (time_after(jiffies, dev->jstart + HZ)) { /* * We waited more than a second * for parport to call us */ ppa_fail(dev, DID_BUS_BUSY); return 0; } return 1; /* wait until ppa_wakeup claims parport */ case 1: /* Phase 1 - Connected */ { /* Perform a sanity check for cable unplugged */ int retv = 2; /* Failed */ ppa_connect(dev, CONNECT_EPP_MAYBE); w_ctr(ppb, 0xe); if ((r_str(ppb) & 0x08) == 0x08) retv--; w_ctr(ppb, 0xc); if ((r_str(ppb) & 0x08) == 0x00) retv--; if (retv) { if (time_after(jiffies, dev->jstart + (1 * HZ))) { printk(KERN_ERR "ppa: Parallel port cable is unplugged.\n"); ppa_fail(dev, DID_BUS_BUSY); return 0; } else { ppa_disconnect(dev); return 1; /* Try again in a jiffy */ } } cmd->SCp.phase++; } case 2: /* Phase 2 - We are now talking to the scsi bus */ if (!ppa_select(dev, scmd_id(cmd))) { ppa_fail(dev, DID_NO_CONNECT); return 0; } cmd->SCp.phase++; case 3: /* Phase 3 - Ready to accept a command */ w_ctr(ppb, 0x0c); if (!