1/* fcal.c: Fibre Channel Arbitrated Loop SCSI host adapter driver.
2 *
3 * Copyright (C) 1998,1999 Jakub Jelinek (jj@ultra.linux.cz)
4 *
5 */
6
7#include <linux/kernel.h>
8#include <linux/delay.h>
9#include <linux/types.h>
10#include <linux/string.h>
11#include <linux/slab.h>
12#include <linux/blkdev.h>
13#include <linux/proc_fs.h>
14#include <linux/stat.h>
15#include <linux/init.h>
16#ifdef CONFIG_KMOD
17#include <linux/kmod.h>
18#endif
19
20#include <asm/irq.h>
21
22#include "scsi.h"
23#include <scsi/scsi_host.h>
24#include "../fc4/fcp_impl.h"
25#include "fcal.h"
26
27#include <linux/module.h>
28
29/* #define FCAL_DEBUG */
30
31#define fcal_printk printk ("FCAL %s: ", fc->name); printk
32
33#ifdef FCAL_DEBUG
34#define FCALD(x)  fcal_printk x;
35#define FCALND(x) printk ("FCAL: "); printk x;
36#else
37#define FCALD(x)
38#define FCALND(x)
39#endif
40
41static unsigned char alpa2target[] = {
420x7e, 0x7d, 0x7c, 0xff, 0x7b, 0xff, 0xff, 0xff, 0x7a, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x79,
430x78, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x77, 0x76, 0xff, 0xff, 0x75, 0xff, 0x74, 0x73, 0x72,
440xff, 0xff, 0xff, 0x71, 0xff, 0x70, 0x6f, 0x6e, 0xff, 0x6d, 0x6c, 0x6b, 0x6a, 0x69, 0x68, 0xff,
450xff, 0x67, 0x66, 0x65, 0x64, 0x63, 0x62, 0xff, 0xff, 0x61, 0x60, 0xff, 0x5f, 0xff, 0xff, 0xff,
460xff, 0xff, 0xff, 0x5e, 0xff, 0x5d, 0x5c, 0x5b, 0xff, 0x5a, 0x59, 0x58, 0x57, 0x56, 0x55, 0xff,
470xff, 0x54, 0x53, 0x52, 0x51, 0x50, 0x4f, 0xff, 0xff, 0x4e, 0x4d, 0xff, 0x4c, 0xff, 0xff, 0xff,
480xff, 0xff, 0xff, 0x4b, 0xff, 0x4a, 0x49, 0x48, 0xff, 0x47, 0x46, 0x45, 0x44, 0x43, 0x42, 0xff,
490xff, 0x41, 0x40, 0x3f, 0x3e, 0x3d, 0x3c, 0xff, 0xff, 0x3b, 0x3a, 0xff, 0x39, 0xff, 0xff, 0xff,
500x38, 0x37, 0x36, 0xff, 0x35, 0xff, 0xff, 0xff, 0x34, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x33,
510x32, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x31, 0x30, 0xff, 0xff, 0x2f, 0xff, 0x2e, 0x2d, 0x2c,
520xff, 0xff, 0xff, 0x2b, 0xff, 0x2a, 0x29, 0x28, 0xff, 0x27, 0x26, 0x25, 0x24, 0x23, 0x22, 0xff,
530xff, 0x21, 0x20, 0x1f, 0x1e, 0x1d, 0x1c, 0xff, 0xff, 0x1b, 0x1a, 0xff, 0x19, 0xff, 0xff, 0xff,
540xff, 0xff, 0xff, 0x18, 0xff, 0x17, 0x16, 0x15, 0xff, 0x14, 0x13, 0x12, 0x11, 0x10, 0x0f, 0xff,
550xff, 0x0e, 0x0d, 0x0c, 0x0b, 0x0a, 0x09, 0xff, 0xff, 0x08, 0x07, 0xff, 0x06, 0xff, 0xff, 0xff,
560x05, 0x04, 0x03, 0xff, 0x02, 0xff, 0xff, 0xff, 0x01, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00
57};
58
59static unsigned char target2alpa[] = {
600xef, 0xe8, 0xe4, 0xe2, 0xe1, 0xe0, 0xdc, 0xda, 0xd9, 0xd6, 0xd5, 0xd4, 0xd3, 0xd2, 0xd1, 0xce,
610xcd, 0xcc, 0xcb, 0xca, 0xc9, 0xc7, 0xc6, 0xc5, 0xc3, 0xbc, 0xba, 0xb9, 0xb6, 0xb5, 0xb4, 0xb3,
620xb2, 0xb1, 0xae, 0xad, 0xac, 0xab, 0xaa, 0xa9, 0xa7, 0xa6, 0xa5, 0xa3, 0x9f, 0x9e, 0x9d, 0x9b,
630x98, 0x97, 0x90, 0x8f, 0x88, 0x84, 0x82, 0x81, 0x80, 0x7c, 0x7a, 0x79, 0x76, 0x75, 0x74, 0x73,
640x72, 0x71, 0x6e, 0x6d, 0x6c, 0x6b, 0x6a, 0x69, 0x67, 0x66, 0x65, 0x63, 0x5c, 0x5a, 0x59, 0x56,
650x55, 0x54, 0x53, 0x52, 0x51, 0x4e, 0x4d, 0x4c, 0x4b, 0x4a, 0x49, 0x47, 0x46, 0x45, 0x43, 0x3c,
660x3a, 0x39, 0x36, 0x35, 0x34, 0x33, 0x32, 0x31, 0x2e, 0x2d, 0x2c, 0x2b, 0x2a, 0x29, 0x27, 0x26,
670x25, 0x23, 0x1f, 0x1e, 0x1d, 0x1b, 0x18, 0x17, 0x10, 0x0f, 0x08, 0x04, 0x02, 0x01, 0x00
68};
69
70static int fcal_encode_addr(Scsi_Cmnd *SCpnt, u16 *addr, fc_channel *fc, fcp_cmnd *fcmd);
71
72int fcal_slave_configure(struct scsi_device *device)
73{
74	int depth_to_use;
75
76	if (device->tagged_supported)
77		depth_to_use = /* 254 */ 8;
78	else
79		depth_to_use = 2;
80
81	scsi_adjust_queue_depth(device,
82				(device->tagged_supported ?
83				 MSG_SIMPLE_TAG : 0),
84				depth_to_use);
85
86	return 0;
87}
88
89/* Detect all FC Arbitrated Loops attached to the machine.
90   fc4 module has done all the work for us... */
91int __init fcal_detect(struct scsi_host_template *tpnt)
92{
93	int nfcals = 0;
94	fc_channel *fc;
95	int fcalcount;
96	int i;
97
98	tpnt->proc_name = "fcal";
99	fcalcount = 0;
100	for_each_online_fc_channel(fc)
101		if (fc->posmap)
102			fcalcount++;
103	FCALND(("%d channels online\n", fcalcount))
104	if (!fcalcount) {
105#if defined(MODULE) && defined(CONFIG_FC4_SOCAL_MODULE) && defined(CONFIG_KMOD)
106		request_module("socal");
107
108		for_each_online_fc_channel(fc)
109			if (fc->posmap)
110				fcalcount++;
111		if (!fcalcount)
112#endif
113			return 0;
114	}
115	for_each_online_fc_channel(fc) {
116		struct Scsi_Host *host;
117		long *ages;
118		struct fcal *fcal;
119
120		if (!fc->posmap) continue;
121
122		/* Strange, this is already registered to some other SCSI host, then it cannot be fcal */
123		if (fc->scsi_name[0]) continue;
124		memcpy (fc->scsi_name, "FCAL", 4);
125
126		fc->can_queue = FCAL_CAN_QUEUE;
127		fc->rsp_size = 64;
128		fc->encode_addr = fcal_encode_addr;
129
130		ages = kmalloc (128 * sizeof(long), GFP_KERNEL);
131		if (!ages) continue;
132
133		host = scsi_register (tpnt, sizeof (struct fcal));
134		if (!host)
135		{
136			kfree(ages);
137			continue;
138		}
139
140		if (!try_module_get(fc->module)) {
141			kfree(ages);
142			scsi_unregister(host);
143			continue;
144		}
145
146		nfcals++;
147
148		fcal = (struct fcal *)host->hostdata;
149
150		fc->fcp_register(fc, TYPE_SCSI_FCP, 0);
151
152		for (i = 0; i < fc->posmap->len; i++) {
153			int status, target, alpa;
154
155			alpa = fc->posmap->list[i];
156			FCALD(("Sending PLOGI to %02x\n", alpa))
157			target = alpa2target[alpa];
158			status = fc_do_plogi(fc, alpa, fcal->node_wwn + target,
159					     fcal->nport_wwn + target);
160			FCALD(("PLOGI returned with status %d\n", status))
161			if (status != FC_STATUS_OK)
162				continue;
163			FCALD(("Sending PRLI to %02x\n", alpa))
164			status = fc_do_prli(fc, alpa);
165			FCALD(("PRLI returned with status %d\n", status))
166			if (status == FC_STATUS_OK)
167				fcal->map[target] = 1;
168		}
169
170		host->max_id = 127;
171		host->irq = fc->irq;
172#ifdef __sparc_v9__
173		host->unchecked_isa_dma = 1;
174#endif
175
176		fc->channels = 1;
177		fc->targets = 127;
178		fc->ages = ages;
179		memset (ages, 0, 128 * sizeof(long));
180
181		fcal->fc = fc;
182
183		FCALD(("Found FCAL\n"))
184	}
185	if (nfcals)
186#ifdef __sparc__
187		printk ("FCAL: Total of %d Sun Enterprise Network Array (A5000 or EX500) channels found\n", nfcals);
188#else
189		printk ("FCAL: Total of %d Fibre Channel Arbitrated Loops found\n", nfcals);
190#endif
191	return nfcals;
192}
193
194int fcal_release(struct Scsi_Host *host)
195{
196	struct fcal *fcal = (struct fcal *)host->hostdata;
197	fc_channel *fc = fcal->fc;
198
199	module_put(fc->module);
200
201	fc->fcp_register(fc, TYPE_SCSI_FCP, 1);
202	FCALND((" releasing fcal.\n"));
203	kfree (fc->ages);
204	FCALND(("released fcal!\n"));
205	return 0;
206}
207
208#undef SPRINTF
209#define SPRINTF(args...) { if (pos < (buffer + length)) pos += sprintf (pos, ## args); }
210
211int fcal_proc_info (struct Scsi_Host *host, char *buffer, char **start, off_t offset, int length, int inout)
212{
213	struct fcal *fcal;
214	fc_channel *fc;
215	char *pos = buffer;
216	int i, j;
217
218	if (inout) return length;
219
220	fcal = (struct fcal *)host->hostdata;
221	fc = fcal->fc;
222
223#ifdef __sparc__
224	SPRINTF ("Sun Enterprise Network Array (A5000 or E?500) on %s PROM node %x\n", fc->name, fc->dev->prom_node);
225#else
226	SPRINTF ("Fibre Channel Arbitrated Loop on %s\n", fc->name);
227#endif
228	SPRINTF ("Initiator AL-PA: %02x\n", fc->sid);
229
230	SPRINTF ("\nAttached devices:\n");
231
232	for (i = 0; i < fc->posmap->len; i++) {
233		unsigned char alpa = fc->posmap->list[i];
234		unsigned char target;
235		u32 *u1, *u2;
236
237		target = alpa2target[alpa];
238		u1 = (u32 *)&fcal->nport_wwn[target];
239		u2 = (u32 *)&fcal->node_wwn[target];
240		if (!u1[0] && !u1[1]) {
241			SPRINTF ("  [AL-PA: %02x] Not responded to PLOGI\n", alpa);
242		} else if (!fcal->map[target]) {
243			SPRINTF ("  [AL-PA: %02x, Port WWN: %08x%08x, Node WWN: %08x%08x] Not responded to PRLI\n",
244				 alpa, u1[0], u1[1], u2[0], u2[1]);
245		} else {
246			struct scsi_device *scd;
247			shost_for_each_device(scd, host)
248				if (scd->id == target) {
249					SPRINTF ("  [AL-PA: %02x, Id: %02d, Port WWN: %08x%08x, Node WWN: %08x%08x]  ",
250						alpa, target, u1[0], u1[1], u2[0], u2[1]);
251					SPRINTF ("%s ", scsi_device_type(scd->type));
252
253					for (j = 0; (j < 8) && (scd->vendor[j] >= 0x20); j++)
254						SPRINTF ("%c", scd->vendor[j]);
255					SPRINTF (" ");
256
257					for (j = 0; (j < 16) && (scd->model[j] >= 0x20); j++)
258						SPRINTF ("%c", scd->model[j]);
259
260					SPRINTF ("\n");
261				}
262		}
263	}
264	SPRINTF ("\n");
265
266	*start = buffer + offset;
267
268	if ((pos - buffer) < offset)
269		return 0;
270	else if (pos - buffer - offset < length)
271		return pos - buffer - offset;
272	else
273		return length;
274}
275
276/*
277   For FC-AL, we use a simple addressing: we have just one channel 0,
278   and all AL-PAs are mapped to targets 0..0x7e
279 */
280static int fcal_encode_addr(Scsi_Cmnd *SCpnt, u16 *addr, fc_channel *fc, fcp_cmnd *fcmd)
281{
282	struct fcal *f;
283
284	/* We don't support LUNs yet - I'm not sure if LUN should be in SCSI fcp_cdb, or in second byte of addr[0] */
285	if (SCpnt->cmnd[1] & 0xe0) return -EINVAL;
286	/* FC-PLDA tells us... */
287	memset(addr, 0, 8);
288	f = (struct fcal *)SCpnt->device->host->hostdata;
289	if (!f->map[SCpnt->device->id])
290		return -EINVAL;
291	/* Now, determine DID: It will be Native Identifier, so we zero upper
292	   2 bytes of the 3 byte DID, lowest byte will be AL-PA */
293	fcmd->did = target2alpa[SCpnt->device->id];
294	FCALD(("trying DID %06x\n", fcmd->did))
295	return 0;
296}
297
298static struct scsi_host_template driver_template = {
299	.name			= "Fibre Channel Arbitrated Loop",
300	.detect			= fcal_detect,
301	.release		= fcal_release,
302	.proc_info		= fcal_proc_info,
303	.queuecommand		= fcp_scsi_queuecommand,
304	.slave_configure	= fcal_slave_configure,
305	.can_queue		= FCAL_CAN_QUEUE,
306	.this_id		= -1,
307	.sg_tablesize		= 1,
308	.cmd_per_lun		= 1,
309	.use_clustering		= ENABLE_CLUSTERING,
310	.eh_abort_handler	= fcp_scsi_abort,
311	.eh_device_reset_handler = fcp_scsi_dev_reset,
312	.eh_host_reset_handler	= fcp_scsi_host_reset,
313};
314#include "scsi_module.c"
315
316MODULE_LICENSE("GPL");
317