1 /*======================================================================
2 
3     A driver for the Qlogic SCSI card
4 
5     qlogic_cs.c 1.79 2000/06/12 21:27:26
6 
7     The contents of this file are subject to the Mozilla Public
8     License Version 1.1 (the "License"); you may not use this file
9     except in compliance with the License. You may obtain a copy of
10     the License at http://www.mozilla.org/MPL/
11 
12     Software distributed under the License is distributed on an "AS
13     IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
14     implied. See the License for the specific language governing
15     rights and limitations under the License.
16 
17     The initial developer of the original code is David A. Hinds
18     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
19     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
20 
21     Alternatively, the contents of this file may be used under the
22     terms of the GNU General Public License version 2 (the "GPL"), in which
23     case the provisions of the GPL are applicable instead of the
24     above.  If you wish to allow the use of your version of this file
25     only under the terms of the GPL and not to allow others to use
26     your version of this file under the MPL, indicate your decision
27     by deleting the provisions above and replace them with the notice
28     and other provisions required by the GPL.  If you do not delete
29     the provisions above, a recipient may use your version of this
30     file under either the MPL or the GPL.
31 
32 ======================================================================*/
33 
34 #include <linux/module.h>
35 #include <linux/init.h>
36 #include <linux/kernel.h>
37 #include <linux/sched.h>
38 #include <linux/slab.h>
39 #include <linux/string.h>
40 #include <linux/ioport.h>
41 #include <asm/io.h>
42 #include <scsi/scsi.h>
43 #include <linux/major.h>
44 #include <linux/blkdev.h>
45 #include <scsi/scsi_ioctl.h>
46 #include <linux/interrupt.h>
47 
48 #include "scsi.h"
49 #include <scsi/scsi_host.h>
50 #include "../qlogicfas408.h"
51 
52 #include <pcmcia/cs_types.h>
53 #include <pcmcia/cs.h>
54 #include <pcmcia/cistpl.h>
55 #include <pcmcia/ds.h>
56 #include <pcmcia/ciscode.h>
57 
58 /* Set the following to 2 to use normal interrupt (active high/totempole-
59  * tristate), otherwise use 0 (REQUIRED FOR PCMCIA) for active low, open
60  * drain
61  */
62 #define INT_TYPE	0
63 
64 static char qlogic_name[] = "qlogic_cs";
65 
66 #ifdef PCMCIA_DEBUG
67 static int pc_debug = PCMCIA_DEBUG;
68 module_param(pc_debug, int, 0644);
69 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
70 static char *version = "qlogic_cs.c 1.79-ac 2002/10/26 (David Hinds)";
71 #else
72 #define DEBUG(n, args...)
73 #endif
74 
75 static struct scsi_host_template qlogicfas_driver_template = {
76 	.module			= THIS_MODULE,
77 	.name			= qlogic_name,
78 	.proc_name		= qlogic_name,
79 	.info			= qlogicfas408_info,
80 	.queuecommand		= qlogicfas408_queuecommand,
81 	.eh_abort_handler	= qlogicfas408_abort,
82 	.eh_bus_reset_handler	= qlogicfas408_bus_reset,
83 	.bios_param		= qlogicfas408_biosparam,
84 	.can_queue		= 1,
85 	.this_id		= -1,
86 	.sg_tablesize		= SG_ALL,
87 	.cmd_per_lun		= 1,
88 	.use_clustering		= DISABLE_CLUSTERING,
89 };
90 
91 /*====================================================================*/
92 
93 typedef struct scsi_info_t {
94 	dev_link_t link;
95 	dev_node_t node;
96 	struct Scsi_Host *host;
97 	unsigned short manf_id;
98 } scsi_info_t;
99 
100 static void qlogic_release(dev_link_t *link);
101 static void qlogic_detach(struct pcmcia_device *p_dev);
102 static void qlogic_config(dev_link_t * link);
103 
104 static struct Scsi_Host *qlogic_detect(struct scsi_host_template *host,
105 				dev_link_t *link, int qbase, int qlirq)
106 {
107 	int qltyp;		/* type of chip */
108 	int qinitid;
109 	struct Scsi_Host *shost;	/* registered host structure */
110 	struct qlogicfas408_priv *priv;
111 
112 	qltyp = qlogicfas408_get_chip_type(qbase, INT_TYPE);
113 	qinitid = host->this_id;
114 	if (qinitid < 0)
115 		qinitid = 7;	/* if no ID, use 7 */
116 
117 	qlogicfas408_setup(qbase, qinitid, INT_TYPE);
118 
119 	host->name = qlogic_name;
120 	shost = scsi_host_alloc(host, sizeof(struct qlogicfas408_priv));
121 	if (!shost)
122 		goto err;
123 	shost->io_port = qbase;
124 	shost->n_io_port = 16;
125 	shost->dma_channel = -1;
126 	if (qlirq != -1)
127 		shost->irq = qlirq;
128 
129 	priv = get_priv_by_host(shost);
130 	priv->qlirq = qlirq;
131 	priv->qbase = qbase;
132 	priv->qinitid = qinitid;
133 	priv->shost = shost;
134 	priv->int_type = INT_TYPE;
135 
136 	if (request_irq(qlirq, qlogicfas408_ihandl, 0, qlogic_name, shost))
137 		goto free_scsi_host;
138 
139 	sprintf(priv->qinfo,
140 		"Qlogicfas Driver version 0.46, chip %02X at %03X, IRQ %d, TPdma:%d",
141 		qltyp, qbase, qlirq, QL_TURBO_PDMA);
142 
143 	if (scsi_add_host(shost, NULL))
144 		goto free_interrupt;
145 
146 	scsi_scan_host(shost);
147 
148 	return shost;
149 
150 free_interrupt:
151 	free_irq(qlirq, shost);
152 
153 free_scsi_host:
154 	scsi_host_put(shost);
155 
156 err:
157 	return NULL;
158 }
159 static int qlogic_attach(struct pcmcia_device *p_dev)
160 {
161 	scsi_info_t *info;
162 	dev_link_t *link;
163 
164 	DEBUG(0, "qlogic_attach()\n");
165 
166 	/* Create new SCSI device */
167 	info = kmalloc(sizeof(*info), GFP_KERNEL);
168 	if (!info)
169 		return -ENOMEM;
170 	memset(info, 0, sizeof(*info));
171 	link = &info->link;
172 	link->priv = info;
173 	link->io.NumPorts1 = 16;
174 	link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
175 	link->io.IOAddrLines = 10;
176 	link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
177 	link->irq.IRQInfo1 = IRQ_LEVEL_ID;
178 	link->conf.Attributes = CONF_ENABLE_IRQ;
179 	link->conf.Vcc = 50;
180 	link->conf.IntType = INT_MEMORY_AND_IO;
181 	link->conf.Present = PRESENT_OPTION;
182 
183 	link->handle = p_dev;
184 	p_dev->instance = link;
185 
186 	link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
187 	qlogic_config(link);
188 
189 	return 0;
190 }				/* qlogic_attach */
191 
192 /*====================================================================*/
193 
194 static void qlogic_detach(struct pcmcia_device *p_dev)
195 {
196 	dev_link_t *link = dev_to_instance(p_dev);
197 
198 	DEBUG(0, "qlogic_detach(0x%p)\n", link);
199 
200 	if (link->state & DEV_CONFIG)
201 		qlogic_release(link);
202 
203 	kfree(link->priv);
204 
205 }				/* qlogic_detach */
206 
207 /*====================================================================*/
208 
209 #define CS_CHECK(fn, ret) \
210 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
211 
212 static void qlogic_config(dev_link_t * link)
213 {
214 	client_handle_t handle = link->handle;
215 	scsi_info_t *info = link->priv;
216 	tuple_t tuple;
217 	cisparse_t parse;
218 	int i, last_ret, last_fn;
219 	unsigned short tuple_data[32];
220 	struct Scsi_Host *host;
221 
222 	DEBUG(0, "qlogic_config(0x%p)\n", link);
223 
224 	tuple.TupleData = (cisdata_t *) tuple_data;
225 	tuple.TupleDataMax = 64;
226 	tuple.TupleOffset = 0;
227 	tuple.DesiredTuple = CISTPL_CONFIG;
228 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
229 	CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
230 	CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
231 	link->conf.ConfigBase = parse.config.base;
232 
233 	tuple.DesiredTuple = CISTPL_MANFID;
234 	if ((pcmcia_get_first_tuple(handle, &tuple) == CS_SUCCESS) && (pcmcia_get_tuple_data(handle, &tuple) == CS_SUCCESS))
235 		info->manf_id = le16_to_cpu(tuple.TupleData[0]);
236 
237 	/* Configure card */
238 	link->state |= DEV_CONFIG;
239 
240 	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
241 	CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
242 	while (1) {
243 		if (pcmcia_get_tuple_data(handle, &tuple) != 0 ||
244 				pcmcia_parse_tuple(handle, &tuple, &parse) != 0)
245 			goto next_entry;
246 		link->conf.ConfigIndex = parse.cftable_entry.index;
247 		link->io.BasePort1 = parse.cftable_entry.io.win[0].base;
248 		link->io.NumPorts1 = parse.cftable_entry.io.win[0].len;
249 		if (link->io.BasePort1 != 0) {
250 			i = pcmcia_request_io(handle, &link->io);
251 			if (i == CS_SUCCESS)
252 				break;
253 		}
254 	      next_entry:
255 		CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
256 	}
257 
258 	CS_CHECK(RequestIRQ, pcmcia_request_irq(handle, &link->irq));
259 	CS_CHECK(RequestConfiguration, pcmcia_request_configuration(handle, &link->conf));
260 
261 	if ((info->manf_id == MANFID_MACNICA) || (info->manf_id == MANFID_PIONEER) || (info->manf_id == 0x0098)) {
262 		/* set ATAcmd */
263 		outb(0xb4, link->io.BasePort1 + 0xd);
264 		outb(0x24, link->io.BasePort1 + 0x9);
265 		outb(0x04, link->io.BasePort1 + 0xd);
266 	}
267 
268 	/* The KXL-810AN has a bigger IO port window */
269 	if (link->io.NumPorts1 == 32)
270 		host = qlogic_detect(&qlogicfas_driver_template, link,
271 			link->io.BasePort1 + 16, link->irq.AssignedIRQ);
272 	else
273 		host = qlogic_detect(&qlogicfas_driver_template, link,
274 			link->io.BasePort1, link->irq.AssignedIRQ);
275 
276 	if (!host) {
277 		printk(KERN_INFO "%s: no SCSI devices found\n", qlogic_name);
278 		goto out;
279 	}
280 
281 	sprintf(info->node.dev_name, "scsi%d", host->host_no);
282 	link->dev = &info->node;
283 	info->host = host;
284 
285 out:
286 	link->state &= ~DEV_CONFIG_PENDING;
287 	return;
288 
289 cs_failed:
290 	cs_error(link->handle, last_fn, last_ret);
291 	link->dev = NULL;
292 	pcmcia_release_configuration(link->handle);
293 	pcmcia_release_io(link->handle, &link->io);
294 	pcmcia_release_irq(link->handle, &link->irq);
295 	link->state &= ~DEV_CONFIG;
296 	return;
297 
298 }				/* qlogic_config */
299 
300 /*====================================================================*/
301 
302 static void qlogic_release(dev_link_t *link)
303 {
304 	scsi_info_t *info = link->priv;
305 
306 	DEBUG(0, "qlogic_release(0x%p)\n", link);
307 
308 	scsi_remove_host(info->host);
309 	link->dev = NULL;
310 
311 	free_irq(link->irq.AssignedIRQ, info->host);
312 
313 	pcmcia_release_configuration(link->handle);
314 	pcmcia_release_io(link->handle, &link->io);
315 	pcmcia_release_irq(link->handle, &link->irq);
316 
317 	scsi_host_put(info->host);
318 
319 	link->state &= ~DEV_CONFIG;
320 }
321 
322 /*====================================================================*/
323 
324 static int qlogic_suspend(struct pcmcia_device *dev)
325 {
326 	dev_link_t *link = dev_to_instance(dev);
327 
328 	link->state |= DEV_SUSPEND;
329 	if (link->state & DEV_CONFIG)
330 		pcmcia_release_configuration(link->handle);
331 
332 	return 0;
333 }
334 
335 static int qlogic_resume(struct pcmcia_device *dev)
336 {
337 	dev_link_t *link = dev_to_instance(dev);
338 
339 	link->state &= ~DEV_SUSPEND;
340 	if (link->state & DEV_CONFIG) {
341 		scsi_info_t *info = link->priv;
342 
343 		pcmcia_request_configuration(link->handle, &link->conf);
344 		if ((info->manf_id == MANFID_MACNICA) ||
345 		    (info->manf_id == MANFID_PIONEER) ||
346 		    (info->manf_id == 0x0098)) {
347 			outb(0x80, link->io.BasePort1 + 0xd);
348 			outb(0x24, link->io.BasePort1 + 0x9);
349 			outb(0x04, link->io.BasePort1 + 0xd);
350 		}
351 		/* Ugggglllyyyy!!! */
352 		qlogicfas408_bus_reset(NULL);
353 	}
354 
355 	return 0;
356 }
357 
358 static struct pcmcia_device_id qlogic_ids[] = {
359 	PCMCIA_DEVICE_PROD_ID12("EIger Labs", "PCMCIA-to-SCSI Adapter", 0x88395fa7, 0x33b7a5e6),
360 	PCMCIA_DEVICE_PROD_ID12("EPSON", "SCSI-2 PC Card SC200", 0xd361772f, 0x299d1751),
361 	PCMCIA_DEVICE_PROD_ID12("MACNICA", "MIRACLE SCSI-II mPS110", 0x20841b68, 0xab3c3b6d),
362 	PCMCIA_DEVICE_PROD_ID12("MIDORI ELECTRONICS ", "CN-SC43", 0x6534382a, 0xd67eee79),
363 	PCMCIA_DEVICE_PROD_ID12("NEC", "PC-9801N-J03R", 0x18df0ba0, 0x24662e8a),
364 	PCMCIA_DEVICE_PROD_ID12("KME ", "KXLC003", 0x82375a27, 0xf68e5bf7),
365 	PCMCIA_DEVICE_PROD_ID12("KME ", "KXLC004", 0x82375a27, 0x68eace54),
366 	PCMCIA_DEVICE_PROD_ID12("KME", "KXLC101", 0x3faee676, 0x194250ec),
367 	PCMCIA_DEVICE_PROD_ID12("QLOGIC CORPORATION", "pc05", 0xd77b2930, 0xa85b2735),
368 	PCMCIA_DEVICE_PROD_ID12("QLOGIC CORPORATION", "pc05 rev 1.10", 0xd77b2930, 0x70f8b5f8),
369 	PCMCIA_DEVICE_PROD_ID123("KME", "KXLC002", "00", 0x3faee676, 0x81896b61, 0xf99f065f),
370 	PCMCIA_DEVICE_PROD_ID12("RATOC System Inc.", "SCSI2 CARD 37", 0x85c10e17, 0x1a2640c1),
371 	PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "SCSC200A PC CARD SCSI", 0xb4585a1a, 0xa6f06ebe),
372 	PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "SCSC200B PC CARD SCSI-10", 0xb4585a1a, 0x0a88dea0),
373 	/* these conflict with other cards! */
374 	/* PCMCIA_DEVICE_PROD_ID123("MACNICA", "MIRACLE SCSI", "mPS100", 0x20841b68, 0xf8dedaeb, 0x89f7fafb), */
375 	/* PCMCIA_DEVICE_PROD_ID123("MACNICA", "MIRACLE SCSI", "mPS100", 0x20841b68, 0xf8dedaeb, 0x89f7fafb), */
376 	PCMCIA_DEVICE_NULL,
377 };
378 MODULE_DEVICE_TABLE(pcmcia, qlogic_ids);
379 
380 static struct pcmcia_driver qlogic_cs_driver = {
381 	.owner		= THIS_MODULE,
382 	.drv		= {
383 	.name		= "qlogic_cs",
384 	},
385 	.probe		= qlogic_attach,
386 	.remove		= qlogic_detach,
387 	.id_table       = qlogic_ids,
388 	.suspend	= qlogic_suspend,
389 	.resume		= qlogic_resume,
390 };
391 
392 static int __init init_qlogic_cs(void)
393 {
394 	return pcmcia_register_driver(&qlogic_cs_driver);
395 }
396 
397 static void __exit exit_qlogic_cs(void)
398 {
399 	pcmcia_unregister_driver(&qlogic_cs_driver);
400 }
401 
402 MODULE_AUTHOR("Tom Zerucha, Michael Griffith");
403 MODULE_DESCRIPTION("Driver for the PCMCIA Qlogic FAS SCSI controllers");
404 MODULE_LICENSE("GPL");
405 module_init(init_qlogic_cs);
406 module_exit(exit_qlogic_cs);
407