scsi_transport_spi.c 44.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/* 
 *  Parallel SCSI (SPI) transport specific attributes exported to sysfs.
 *
 *  Copyright (c) 2003 Silicon Graphics, Inc.  All rights reserved.
 *  Copyright (c) 2004, 2005 James Bottomley <James.Bottomley@SteelEye.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#include <linux/ctype.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/workqueue.h>
25
#include <linux/blkdev.h>
26
#include <linux/mutex.h>
27
#include <linux/sysfs.h>
28
#include <linux/slab.h>
29
#include <linux/suspend.h>
L
Linus Torvalds 已提交
30 31 32 33
#include <scsi/scsi.h>
#include "scsi_priv.h"
#include <scsi/scsi_device.h>
#include <scsi/scsi_host.h>
34
#include <scsi/scsi_cmnd.h>
L
Linus Torvalds 已提交
35
#include <scsi/scsi_eh.h>
36
#include <scsi/scsi_tcq.h>
L
Linus Torvalds 已提交
37 38 39
#include <scsi/scsi_transport.h>
#include <scsi/scsi_transport_spi.h>

40
#define SPI_NUM_ATTRS 14	/* increase this if you add attributes */
L
Linus Torvalds 已提交
41 42 43 44 45 46
#define SPI_OTHER_ATTRS 1	/* Increase this if you add "always
				 * on" attributes */
#define SPI_HOST_ATTRS	1

#define SPI_MAX_ECHO_BUFFER_SIZE	4096

47 48 49 50 51
#define DV_LOOPS	3
#define DV_TIMEOUT	(10*HZ)
#define DV_RETRIES	3	/* should only need at most 
				 * two cc/ua clears */

52 53
/* Our blacklist flags */
enum {
54
	SPI_BLIST_NOIUS = (__force blist_flags_t)0x1,
55 56 57 58 59 60
};

/* blacklist table, modelled on scsi_devinfo.c */
static struct {
	char *vendor;
	char *model;
61
	blist_flags_t flags;
62 63 64 65 66 67
} spi_static_device_list[] __initdata = {
	{"HP", "Ultrium 3-SCSI", SPI_BLIST_NOIUS },
	{"IBM", "ULTRIUM-TD3", SPI_BLIST_NOIUS },
	{NULL, NULL, 0}
};

L
Linus Torvalds 已提交
68
/* Private data accessors (keep these out of the header file) */
69
#define spi_dv_in_progress(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_in_progress)
70
#define spi_dv_mutex(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_mutex)
L
Linus Torvalds 已提交
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

struct spi_internal {
	struct scsi_transport_template t;
	struct spi_function_template *f;
};

#define to_spi_internal(tmpl)	container_of(tmpl, struct spi_internal, t)

static const int ppr_to_ps[] = {
	/* The PPR values 0-6 are reserved, fill them in when
	 * the committee defines them */
	-1,			/* 0x00 */
	-1,			/* 0x01 */
	-1,			/* 0x02 */
	-1,			/* 0x03 */
	-1,			/* 0x04 */
	-1,			/* 0x05 */
	-1,			/* 0x06 */
	 3125,			/* 0x07 */
	 6250,			/* 0x08 */
	12500,			/* 0x09 */
	25000,			/* 0x0a */
	30300,			/* 0x0b */
	50000,			/* 0x0c */
};
/* The PPR values at which you calculate the period in ns by multiplying
 * by 4 */
#define SPI_STATIC_PPR	0x0c

static int sprint_frac(char *dest, int value, int denom)
{
	int frac = value % denom;
	int result = sprintf(dest, "%d", value / denom);

	if (frac == 0)
		return result;
	dest[result++] = '.';

	do {
		denom /= 10;
		sprintf(dest + result, "%d", frac / denom);
		result++;
		frac %= denom;
	} while (frac);

	dest[result++] = '\0';
	return result;
}

120 121 122 123
static int spi_execute(struct scsi_device *sdev, const void *cmd,
		       enum dma_data_direction dir,
		       void *buffer, unsigned bufflen,
		       struct scsi_sense_hdr *sshdr)
124
{
125 126
	int i, result;
	unsigned char sense[SCSI_SENSE_BUFFERSIZE];
127 128 129 130
	struct scsi_sense_hdr sshdr_tmp;

	if (!sshdr)
		sshdr = &sshdr_tmp;
131 132

	for(i = 0; i < DV_RETRIES; i++) {
133 134
		result = scsi_execute(sdev, cmd, dir, buffer, bufflen, sense,
				      sshdr, DV_TIMEOUT, /* retries */ 1,
135 136
				      REQ_FAILFAST_DEV |
				      REQ_FAILFAST_TRANSPORT |
137
				      REQ_FAILFAST_DRIVER,
138 139 140 141
				      0, NULL);
		if (!(driver_byte(result) & DRIVER_SENSE) ||
		    sshdr->sense_key != UNIT_ATTENTION)
			break;
142
	}
143
	return result;
144 145
}

L
Linus Torvalds 已提交
146 147 148 149 150 151 152 153 154 155 156 157 158 159
static struct {
	enum spi_signal_type	value;
	char			*name;
} signal_types[] = {
	{ SPI_SIGNAL_UNKNOWN, "unknown" },
	{ SPI_SIGNAL_SE, "SE" },
	{ SPI_SIGNAL_LVD, "LVD" },
	{ SPI_SIGNAL_HVD, "HVD" },
};

static inline const char *spi_signal_to_string(enum spi_signal_type type)
{
	int i;

160
	for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
L
Linus Torvalds 已提交
161 162 163 164 165 166 167 168 169
		if (type == signal_types[i].value)
			return signal_types[i].name;
	}
	return NULL;
}
static inline enum spi_signal_type spi_signal_to_value(const char *name)
{
	int i, len;

170
	for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
L
Linus Torvalds 已提交
171 172 173 174 175 176 177 178
		len =  strlen(signal_types[i].name);
		if (strncmp(name, signal_types[i].name, len) == 0 &&
		    (name[len] == '\n' || name[len] == '\0'))
			return signal_types[i].value;
	}
	return SPI_SIGNAL_UNKNOWN;
}

179
static int spi_host_setup(struct transport_container *tc, struct device *dev,
180
			  struct device *cdev)
L
Linus Torvalds 已提交
181 182 183 184 185 186 187 188
{
	struct Scsi_Host *shost = dev_to_shost(dev);

	spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;

	return 0;
}

189 190
static int spi_host_configure(struct transport_container *tc,
			      struct device *dev,
191
			      struct device *cdev);
192

L
Linus Torvalds 已提交
193 194 195 196
static DECLARE_TRANSPORT_CLASS(spi_host_class,
			       "spi_host",
			       spi_host_setup,
			       NULL,
197
			       spi_host_configure);
L
Linus Torvalds 已提交
198 199 200 201 202 203 204 205 206 207 208 209 210 211

static int spi_host_match(struct attribute_container *cont,
			  struct device *dev)
{
	struct Scsi_Host *shost;

	if (!scsi_is_host_device(dev))
		return 0;

	shost = dev_to_shost(dev);
	if (!shost->transportt  || shost->transportt->host_attrs.ac.class
	    != &spi_host_class.class)
		return 0;

212
	return &shost->transportt->host_attrs.ac == cont;
L
Linus Torvalds 已提交
213 214
}

215 216
static int spi_target_configure(struct transport_container *tc,
				struct device *dev,
217
				struct device *cdev);
218

219 220
static int spi_device_configure(struct transport_container *tc,
				struct device *dev,
221
				struct device *cdev)
L
Linus Torvalds 已提交
222 223 224
{
	struct scsi_device *sdev = to_scsi_device(dev);
	struct scsi_target *starget = sdev->sdev_target;
225 226 227 228 229
	blist_flags_t bflags;

	bflags = scsi_get_device_flags_keyed(sdev, &sdev->inquiry[8],
					     &sdev->inquiry[16],
					     SCSI_DEVINFO_SPI);
L
Linus Torvalds 已提交
230 231 232 233 234 235 236 237 238

	/* Populate the target capability fields with the values
	 * gleaned from the device inquiry */

	spi_support_sync(starget) = scsi_device_sync(sdev);
	spi_support_wide(starget) = scsi_device_wide(sdev);
	spi_support_dt(starget) = scsi_device_dt(sdev);
	spi_support_dt_only(starget) = scsi_device_dt_only(sdev);
	spi_support_ius(starget) = scsi_device_ius(sdev);
239 240 241 242
	if (bflags & SPI_BLIST_NOIUS) {
		dev_info(dev, "Information Units disabled by blacklist\n");
		spi_support_ius(starget) = 0;
	}
L
Linus Torvalds 已提交
243 244 245 246 247
	spi_support_qas(starget) = scsi_device_qas(sdev);

	return 0;
}

248 249
static int spi_setup_transport_attrs(struct transport_container *tc,
				     struct device *dev,
250
				     struct device *cdev)
L
Linus Torvalds 已提交
251 252 253 254
{
	struct scsi_target *starget = to_scsi_target(dev);

	spi_period(starget) = -1;	/* illegal value */
255
	spi_min_period(starget) = 0;
L
Linus Torvalds 已提交
256
	spi_offset(starget) = 0;	/* async */
257
	spi_max_offset(starget) = 255;
L
Linus Torvalds 已提交
258
	spi_width(starget) = 0;	/* narrow */
259
	spi_max_width(starget) = 1;
L
Linus Torvalds 已提交
260
	spi_iu(starget) = 0;	/* no IU */
261
	spi_max_iu(starget) = 1;
L
Linus Torvalds 已提交
262 263
	spi_dt(starget) = 0;	/* ST */
	spi_qas(starget) = 0;
264
	spi_max_qas(starget) = 1;
L
Linus Torvalds 已提交
265 266 267 268
	spi_wr_flow(starget) = 0;
	spi_rd_strm(starget) = 0;
	spi_rti(starget) = 0;
	spi_pcomp_en(starget) = 0;
269
	spi_hold_mcs(starget) = 0;
L
Linus Torvalds 已提交
270
	spi_dv_pending(starget) = 0;
271
	spi_dv_in_progress(starget) = 0;
L
Linus Torvalds 已提交
272
	spi_initial_dv(starget) = 0;
273
	mutex_init(&spi_dv_mutex(starget));
L
Linus Torvalds 已提交
274 275 276 277

	return 0;
}

278 279 280
#define spi_transport_show_simple(field, format_string)			\
									\
static ssize_t								\
281 282
show_spi_transport_##field(struct device *dev, 			\
			   struct device_attribute *attr, char *buf)	\
283
{									\
284
	struct scsi_target *starget = transport_class_to_starget(dev);	\
285 286 287 288 289 290 291 292 293
	struct spi_transport_attrs *tp;					\
									\
	tp = (struct spi_transport_attrs *)&starget->starget_data;	\
	return snprintf(buf, 20, format_string, tp->field);		\
}

#define spi_transport_store_simple(field, format_string)		\
									\
static ssize_t								\
294 295 296
store_spi_transport_##field(struct device *dev, 			\
			    struct device_attribute *attr, 		\
			    const char *buf, size_t count)		\
297 298
{									\
	int val;							\
299
	struct scsi_target *starget = transport_class_to_starget(dev);	\
300 301 302 303 304 305 306 307
	struct spi_transport_attrs *tp;					\
									\
	tp = (struct spi_transport_attrs *)&starget->starget_data;	\
	val = simple_strtoul(buf, NULL, 0);				\
	tp->field = val;						\
	return count;							\
}

L
Linus Torvalds 已提交
308 309 310
#define spi_transport_show_function(field, format_string)		\
									\
static ssize_t								\
311 312
show_spi_transport_##field(struct device *dev, 			\
			   struct device_attribute *attr, char *buf)	\
L
Linus Torvalds 已提交
313
{									\
314
	struct scsi_target *starget = transport_class_to_starget(dev);	\
L
Linus Torvalds 已提交
315 316 317 318 319 320 321 322 323 324 325
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);	\
	struct spi_transport_attrs *tp;					\
	struct spi_internal *i = to_spi_internal(shost->transportt);	\
	tp = (struct spi_transport_attrs *)&starget->starget_data;	\
	if (i->f->get_##field)						\
		i->f->get_##field(starget);				\
	return snprintf(buf, 20, format_string, tp->field);		\
}

#define spi_transport_store_function(field, format_string)		\
static ssize_t								\
326 327 328
store_spi_transport_##field(struct device *dev, 			\
			    struct device_attribute *attr,		\
			    const char *buf, size_t count)		\
L
Linus Torvalds 已提交
329 330
{									\
	int val;							\
331
	struct scsi_target *starget = transport_class_to_starget(dev);	\
L
Linus Torvalds 已提交
332 333 334
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);	\
	struct spi_internal *i = to_spi_internal(shost->transportt);	\
									\
335 336
	if (!i->f->set_##field)						\
		return -EINVAL;						\
L
Linus Torvalds 已提交
337
	val = simple_strtoul(buf, NULL, 0);				\
338
	i->f->set_##field(starget, val);				\
339 340 341 342 343
	return count;							\
}

#define spi_transport_store_max(field, format_string)			\
static ssize_t								\
344 345 346
store_spi_transport_##field(struct device *dev, 			\
			    struct device_attribute *attr,		\
			    const char *buf, size_t count)		\
347 348
{									\
	int val;							\
349
	struct scsi_target *starget = transport_class_to_starget(dev);	\
350 351 352 353 354
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);	\
	struct spi_internal *i = to_spi_internal(shost->transportt);	\
	struct spi_transport_attrs *tp					\
		= (struct spi_transport_attrs *)&starget->starget_data;	\
									\
355 356
	if (i->f->set_##field)						\
		return -EINVAL;						\
357 358 359
	val = simple_strtoul(buf, NULL, 0);				\
	if (val > tp->max_##field)					\
		val = tp->max_##field;					\
L
Linus Torvalds 已提交
360 361 362 363 364 365 366
	i->f->set_##field(starget, val);				\
	return count;							\
}

#define spi_transport_rd_attr(field, format_string)			\
	spi_transport_show_function(field, format_string)		\
	spi_transport_store_function(field, format_string)		\
367 368 369
static DEVICE_ATTR(field, S_IRUGO,				\
		   show_spi_transport_##field,			\
		   store_spi_transport_##field);
L
Linus Torvalds 已提交
370

371 372 373
#define spi_transport_simple_attr(field, format_string)			\
	spi_transport_show_simple(field, format_string)			\
	spi_transport_store_simple(field, format_string)		\
374 375 376
static DEVICE_ATTR(field, S_IRUGO,				\
		   show_spi_transport_##field,			\
		   store_spi_transport_##field);
377 378 379 380 381

#define spi_transport_max_attr(field, format_string)			\
	spi_transport_show_function(field, format_string)		\
	spi_transport_store_max(field, format_string)			\
	spi_transport_simple_attr(max_##field, format_string)		\
382 383 384
static DEVICE_ATTR(field, S_IRUGO,				\
		   show_spi_transport_##field,			\
		   store_spi_transport_##field);
385

L
Linus Torvalds 已提交
386
/* The Parallel SCSI Tranport Attributes: */
387 388
spi_transport_max_attr(offset, "%d\n");
spi_transport_max_attr(width, "%d\n");
389
spi_transport_max_attr(iu, "%d\n");
L
Linus Torvalds 已提交
390
spi_transport_rd_attr(dt, "%d\n");
391
spi_transport_max_attr(qas, "%d\n");
L
Linus Torvalds 已提交
392 393 394 395
spi_transport_rd_attr(wr_flow, "%d\n");
spi_transport_rd_attr(rd_strm, "%d\n");
spi_transport_rd_attr(rti, "%d\n");
spi_transport_rd_attr(pcomp_en, "%d\n");
396
spi_transport_rd_attr(hold_mcs, "%d\n");
L
Linus Torvalds 已提交
397

398 399
/* we only care about the first child device that's a real SCSI device
 * so we return 1 to terminate the iteration when we find it */
400 401
static int child_iter(struct device *dev, void *data)
{
402 403
	if (!scsi_is_sdev_device(dev))
		return 0;
404

405
	spi_dv_device(to_scsi_device(dev));
406 407 408
	return 1;
}

L
Linus Torvalds 已提交
409
static ssize_t
410 411
store_spi_revalidate(struct device *dev, struct device_attribute *attr,
		     const char *buf, size_t count)
L
Linus Torvalds 已提交
412
{
413
	struct scsi_target *starget = transport_class_to_starget(dev);
L
Linus Torvalds 已提交
414

415
	device_for_each_child(&starget->dev, NULL, child_iter);
L
Linus Torvalds 已提交
416 417
	return count;
}
418
static DEVICE_ATTR(revalidate, S_IWUSR, NULL, store_spi_revalidate);
L
Linus Torvalds 已提交
419 420 421

/* Translate the period into ns according to the current spec
 * for SDTR/PPR messages */
422
static int period_to_str(char *buf, int period)
L
Linus Torvalds 已提交
423 424 425
{
	int len, picosec;

426
	if (period < 0 || period > 0xff) {
L
Linus Torvalds 已提交
427
		picosec = -1;
428 429
	} else if (period <= SPI_STATIC_PPR) {
		picosec = ppr_to_ps[period];
L
Linus Torvalds 已提交
430
	} else {
431
		picosec = period * 4000;
L
Linus Torvalds 已提交
432 433 434 435 436 437 438 439
	}

	if (picosec == -1) {
		len = sprintf(buf, "reserved");
	} else {
		len = sprint_frac(buf, picosec, 1000);
	}

440 441 442 443
	return len;
}

static ssize_t
444
show_spi_transport_period_helper(char *buf, int period)
445 446
{
	int len = period_to_str(buf, period);
L
Linus Torvalds 已提交
447 448 449 450 451 452
	buf[len++] = '\n';
	buf[len] = '\0';
	return len;
}

static ssize_t
453
store_spi_transport_period_helper(struct device *dev, const char *buf,
454
				  size_t count, int *periodp)
L
Linus Torvalds 已提交
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
{
	int j, picosec, period = -1;
	char *endp;

	picosec = simple_strtoul(buf, &endp, 10) * 1000;
	if (*endp == '.') {
		int mult = 100;
		do {
			endp++;
			if (!isdigit(*endp))
				break;
			picosec += (*endp - '0') * mult;
			mult /= 10;
		} while (mult > 0);
	}

	for (j = 0; j <= SPI_STATIC_PPR; j++) {
		if (ppr_to_ps[j] < picosec)
			continue;
		period = j;
		break;
	}

	if (period == -1)
		period = picosec / 4000;

	if (period > 0xff)
		period = 0xff;

484
	*periodp = period;
L
Linus Torvalds 已提交
485 486 487 488

	return count;
}

489
static ssize_t
490 491
show_spi_transport_period(struct device *dev,
			  struct device_attribute *attr, char *buf)
492
{
493
	struct scsi_target *starget = transport_class_to_starget(dev);
494 495 496 497 498 499 500 501
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
	struct spi_internal *i = to_spi_internal(shost->transportt);
	struct spi_transport_attrs *tp =
		(struct spi_transport_attrs *)&starget->starget_data;

	if (i->f->get_period)
		i->f->get_period(starget);

502
	return show_spi_transport_period_helper(buf, tp->period);
503 504 505
}

static ssize_t
506 507
store_spi_transport_period(struct device *cdev, struct device_attribute *attr,
			   const char *buf, size_t count)
508 509 510 511 512 513 514 515
{
	struct scsi_target *starget = transport_class_to_starget(cdev);
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
	struct spi_internal *i = to_spi_internal(shost->transportt);
	struct spi_transport_attrs *tp =
		(struct spi_transport_attrs *)&starget->starget_data;
	int period, retval;

516 517 518
	if (!i->f->set_period)
		return -EINVAL;

519 520 521 522 523 524 525 526 527 528
	retval = store_spi_transport_period_helper(cdev, buf, count, &period);

	if (period < tp->min_period)
		period = tp->min_period;

	i->f->set_period(starget, period);

	return retval;
}

529 530 531
static DEVICE_ATTR(period, S_IRUGO,
		   show_spi_transport_period,
		   store_spi_transport_period);
L
Linus Torvalds 已提交
532

533
static ssize_t
534 535
show_spi_transport_min_period(struct device *cdev,
			      struct device_attribute *attr, char *buf)
536 537
{
	struct scsi_target *starget = transport_class_to_starget(cdev);
538 539
	struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
	struct spi_internal *i = to_spi_internal(shost->transportt);
540 541 542
	struct spi_transport_attrs *tp =
		(struct spi_transport_attrs *)&starget->starget_data;

543 544 545
	if (!i->f->set_period)
		return -EINVAL;

546
	return show_spi_transport_period_helper(buf, tp->min_period);
547 548 549
}

static ssize_t
550 551 552
store_spi_transport_min_period(struct device *cdev,
			       struct device_attribute *attr,
			       const char *buf, size_t count)
553 554 555 556 557 558 559 560 561 562
{
	struct scsi_target *starget = transport_class_to_starget(cdev);
	struct spi_transport_attrs *tp =
		(struct spi_transport_attrs *)&starget->starget_data;

	return store_spi_transport_period_helper(cdev, buf, count,
						 &tp->min_period);
}


563 564 565
static DEVICE_ATTR(min_period, S_IRUGO,
		   show_spi_transport_min_period,
		   store_spi_transport_min_period);
566 567


568 569 570
static ssize_t show_spi_host_signalling(struct device *cdev,
					struct device_attribute *attr,
					char *buf)
L
Linus Torvalds 已提交
571 572 573 574 575 576 577 578 579
{
	struct Scsi_Host *shost = transport_class_to_shost(cdev);
	struct spi_internal *i = to_spi_internal(shost->transportt);

	if (i->f->get_signalling)
		i->f->get_signalling(shost);

	return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
}
580 581
static ssize_t store_spi_host_signalling(struct device *dev,
					 struct device_attribute *attr,
L
Linus Torvalds 已提交
582 583
					 const char *buf, size_t count)
{
584
	struct Scsi_Host *shost = transport_class_to_shost(dev);
L
Linus Torvalds 已提交
585 586 587
	struct spi_internal *i = to_spi_internal(shost->transportt);
	enum spi_signal_type type = spi_signal_to_value(buf);

588 589 590
	if (!i->f->set_signalling)
		return -EINVAL;

L
Linus Torvalds 已提交
591 592 593 594 595
	if (type != SPI_SIGNAL_UNKNOWN)
		i->f->set_signalling(shost, type);

	return count;
}
596 597 598
static DEVICE_ATTR(signalling, S_IRUGO,
		   show_spi_host_signalling,
		   store_spi_host_signalling);
L
Linus Torvalds 已提交
599

600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
static ssize_t show_spi_host_width(struct device *cdev,
				      struct device_attribute *attr,
				      char *buf)
{
	struct Scsi_Host *shost = transport_class_to_shost(cdev);

	return sprintf(buf, "%s\n", shost->max_id == 16 ? "wide" : "narrow");
}
static DEVICE_ATTR(host_width, S_IRUGO,
		   show_spi_host_width, NULL);

static ssize_t show_spi_host_hba_id(struct device *cdev,
				    struct device_attribute *attr,
				    char *buf)
{
	struct Scsi_Host *shost = transport_class_to_shost(cdev);

	return sprintf(buf, "%d\n", shost->this_id);
}
static DEVICE_ATTR(hba_id, S_IRUGO,
		   show_spi_host_hba_id, NULL);

L
Linus Torvalds 已提交
622 623 624 625 626 627 628 629 630 631 632 633 634 635
#define DV_SET(x, y)			\
	if(i->f->set_##x)		\
		i->f->set_##x(sdev->sdev_target, y)

enum spi_compare_returns {
	SPI_COMPARE_SUCCESS,
	SPI_COMPARE_FAILURE,
	SPI_COMPARE_SKIP_TEST,
};


/* This is for read/write Domain Validation:  If the device supports
 * an echo buffer, we do read/write tests to it */
static enum spi_compare_returns
636
spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
L
Linus Torvalds 已提交
637 638 639
			  u8 *ptr, const int retries)
{
	int len = ptr - buffer;
640
	int j, k, r, result;
L
Linus Torvalds 已提交
641
	unsigned int pattern = 0x0000ffff;
642
	struct scsi_sense_hdr sshdr;
L
Linus Torvalds 已提交
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686

	const char spi_write_buffer[] = {
		WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
	};
	const char spi_read_buffer[] = {
		READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
	};

	/* set up the pattern buffer.  Doesn't matter if we spill
	 * slightly beyond since that's where the read buffer is */
	for (j = 0; j < len; ) {

		/* fill the buffer with counting (test a) */
		for ( ; j < min(len, 32); j++)
			buffer[j] = j;
		k = j;
		/* fill the buffer with alternating words of 0x0 and
		 * 0xffff (test b) */
		for ( ; j < min(len, k + 32); j += 2) {
			u16 *word = (u16 *)&buffer[j];
			
			*word = (j & 0x02) ? 0x0000 : 0xffff;
		}
		k = j;
		/* fill with crosstalk (alternating 0x5555 0xaaa)
                 * (test c) */
		for ( ; j < min(len, k + 32); j += 2) {
			u16 *word = (u16 *)&buffer[j];

			*word = (j & 0x02) ? 0x5555 : 0xaaaa;
		}
		k = j;
		/* fill with shifting bits (test d) */
		for ( ; j < min(len, k + 32); j += 4) {
			u32 *word = (unsigned int *)&buffer[j];
			u32 roll = (pattern & 0x80000000) ? 1 : 0;
			
			*word = pattern;
			pattern = (pattern << 1) | roll;
		}
		/* don't bother with random data (test e) */
	}

	for (r = 0; r < retries; r++) {
687 688 689
		result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
				     buffer, len, &sshdr);
		if(result || !scsi_device_online(sdev)) {
L
Linus Torvalds 已提交
690 691

			scsi_device_set_state(sdev, SDEV_QUIESCE);
692
			if (scsi_sense_valid(&sshdr)
L
Linus Torvalds 已提交
693 694 695 696 697 698 699 700 701 702 703
			    && sshdr.sense_key == ILLEGAL_REQUEST
			    /* INVALID FIELD IN CDB */
			    && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
				/* This would mean that the drive lied
				 * to us about supporting an echo
				 * buffer (unfortunately some Western
				 * Digital drives do precisely this)
				 */
				return SPI_COMPARE_SKIP_TEST;


704
			sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
L
Linus Torvalds 已提交
705 706 707 708
			return SPI_COMPARE_FAILURE;
		}

		memset(ptr, 0, len);
709 710
		spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
			    ptr, len, NULL);
L
Linus Torvalds 已提交
711 712 713 714 715 716 717 718 719 720 721
		scsi_device_set_state(sdev, SDEV_QUIESCE);

		if (memcmp(buffer, ptr, len) != 0)
			return SPI_COMPARE_FAILURE;
	}
	return SPI_COMPARE_SUCCESS;
}

/* This is for the simplest form of Domain Validation: a read test
 * on the inquiry data from the device */
static enum spi_compare_returns
722
spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
L
Linus Torvalds 已提交
723 724
			      u8 *ptr, const int retries)
{
725 726
	int r, result;
	const int len = sdev->inquiry_len;
L
Linus Torvalds 已提交
727 728 729 730 731 732 733
	const char spi_inquiry[] = {
		INQUIRY, 0, 0, 0, len, 0
	};

	for (r = 0; r < retries; r++) {
		memset(ptr, 0, len);

734 735
		result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
				     ptr, len, NULL);
L
Linus Torvalds 已提交
736
		
737
		if(result || !scsi_device_online(sdev)) {
L
Linus Torvalds 已提交
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
			scsi_device_set_state(sdev, SDEV_QUIESCE);
			return SPI_COMPARE_FAILURE;
		}

		/* If we don't have the inquiry data already, the
		 * first read gets it */
		if (ptr == buffer) {
			ptr += len;
			--r;
			continue;
		}

		if (memcmp(buffer, ptr, len) != 0)
			/* failure */
			return SPI_COMPARE_FAILURE;
	}
	return SPI_COMPARE_SUCCESS;
}

static enum spi_compare_returns
758
spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
L
Linus Torvalds 已提交
759
	       enum spi_compare_returns 
760
	       (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
L
Linus Torvalds 已提交
761
{
762
	struct spi_internal *i = to_spi_internal(sdev->host->transportt);
763
	struct scsi_target *starget = sdev->sdev_target;
L
Linus Torvalds 已提交
764 765 766 767 768 769
	int period = 0, prevperiod = 0; 
	enum spi_compare_returns retval;


	for (;;) {
		int newperiod;
770
		retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
L
Linus Torvalds 已提交
771 772 773 774 775 776

		if (retval == SPI_COMPARE_SUCCESS
		    || retval == SPI_COMPARE_SKIP_TEST)
			break;

		/* OK, retrain, fallback */
777 778 779 780
		if (i->f->get_iu)
			i->f->get_iu(starget);
		if (i->f->get_qas)
			i->f->get_qas(starget);
L
Linus Torvalds 已提交
781 782
		if (i->f->get_period)
			i->f->get_period(sdev->sdev_target);
783 784 785 786 787

		/* Here's the fallback sequence; first try turning off
		 * IU, then QAS (if we can control them), then finally
		 * fall down the periods */
		if (i->f->set_iu && spi_iu(starget)) {
788
			starget_printk(KERN_ERR, starget, "Domain Validation Disabling Information Units\n");
789 790
			DV_SET(iu, 0);
		} else if (i->f->set_qas && spi_qas(starget)) {
791
			starget_printk(KERN_ERR, starget, "Domain Validation Disabling Quick Arbitration and Selection\n");
792 793 794 795 796 797 798 799 800 801 802
			DV_SET(qas, 0);
		} else {
			newperiod = spi_period(starget);
			period = newperiod > period ? newperiod : period;
			if (period < 0x0d)
				period++;
			else
				period += period >> 1;

			if (unlikely(period > 0xff || period == prevperiod)) {
				/* Total failure; set to async and return */
803
				starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
804 805 806
				DV_SET(offset, 0);
				return SPI_COMPARE_FAILURE;
			}
807
			starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
808 809
			DV_SET(period, period);
			prevperiod = period;
L
Linus Torvalds 已提交
810 811 812 813 814 815
		}
	}
	return retval;
}

static int
816
spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
L
Linus Torvalds 已提交
817
{
818
	int l, result;
L
Linus Torvalds 已提交
819 820 821 822 823 824

	/* first off do a test unit ready.  This can error out 
	 * because of reservations or some other reason.  If it
	 * fails, the device won't let us write to the echo buffer
	 * so just return failure */
	
825
	static const char spi_test_unit_ready[] = {
L
Linus Torvalds 已提交
826 827 828
		TEST_UNIT_READY, 0, 0, 0, 0, 0
	};

829
	static const char spi_read_buffer_descriptor[] = {
L
Linus Torvalds 已提交
830 831 832 833 834 835 836 837 838 839
		READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
	};

	
	/* We send a set of three TURs to clear any outstanding 
	 * unit attention conditions if they exist (Otherwise the
	 * buffer tests won't be happy).  If the TUR still fails
	 * (reservation conflict, device not ready, etc) just
	 * skip the write tests */
	for (l = 0; ; l++) {
840 841
		result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE, 
				     NULL, 0, NULL);
L
Linus Torvalds 已提交
842

843
		if(result) {
L
Linus Torvalds 已提交
844 845 846 847 848 849 850 851
			if(l >= 3)
				return 0;
		} else {
			/* TUR succeeded */
			break;
		}
	}

852 853
	result = spi_execute(sdev, spi_read_buffer_descriptor, 
			     DMA_FROM_DEVICE, buffer, 4, NULL);
L
Linus Torvalds 已提交
854

855
	if (result)
L
Linus Torvalds 已提交
856 857 858 859 860 861 862
		/* Device has no echo buffer */
		return 0;

	return buffer[3] + ((buffer[2] & 0x1f) << 8);
}

static void
863
spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
L
Linus Torvalds 已提交
864
{
865
	struct spi_internal *i = to_spi_internal(sdev->host->transportt);
866
	struct scsi_target *starget = sdev->sdev_target;
867
	struct Scsi_Host *shost = sdev->host;
L
Linus Torvalds 已提交
868
	int len = sdev->inquiry_len;
869 870
	int min_period = spi_min_period(starget);
	int max_width = spi_max_width(starget);
L
Linus Torvalds 已提交
871 872 873
	/* first set us up for narrow async */
	DV_SET(offset, 0);
	DV_SET(width, 0);
874

875
	if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
L
Linus Torvalds 已提交
876
	    != SPI_COMPARE_SUCCESS) {
877
		starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
L
Linus Torvalds 已提交
878 879 880 881
		/* FIXME: should probably offline the device here? */
		return;
	}

882
	if (!spi_support_wide(starget)) {
883 884 885 886
		spi_max_width(starget) = 0;
		max_width = 0;
	}

L
Linus Torvalds 已提交
887
	/* test width */
888
	if (i->f->set_width && max_width) {
889
		i->f->set_width(starget, 1);
890

891
		if (spi_dv_device_compare_inquiry(sdev, buffer,
L
Linus Torvalds 已提交
892 893 894
						   buffer + len,
						   DV_LOOPS)
		    != SPI_COMPARE_SUCCESS) {
895
			starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
896
			i->f->set_width(starget, 0);
897 898 899 900 901
			/* Make sure we don't force wide back on by asking
			 * for a transfer period that requires it */
			max_width = 0;
			if (min_period < 10)
				min_period = 10;
L
Linus Torvalds 已提交
902 903 904 905 906 907 908
		}
	}

	if (!i->f->set_period)
		return;

	/* device can't handle synchronous */
909
	if (!spi_support_sync(starget) && !spi_support_dt(starget))
L
Linus Torvalds 已提交
910 911
		return;

912 913 914 915
	/* len == -1 is the signal that we need to ascertain the
	 * presence of an echo buffer before trying to use it.  len ==
	 * 0 means we don't have an echo buffer */
	len = -1;
L
Linus Torvalds 已提交
916 917 918 919

 retry:

	/* now set up to the maximum */
920
	DV_SET(offset, spi_max_offset(starget));
921 922
	DV_SET(period, min_period);

923 924
	/* try QAS requests; this should be harmless to set if the
	 * target supports it */
925
	if (spi_support_qas(starget) && spi_max_qas(starget)) {
926
		DV_SET(qas, 1);
927 928 929 930
	} else {
		DV_SET(qas, 0);
	}

931 932
	if (spi_support_ius(starget) && spi_max_iu(starget) &&
	    min_period < 9) {
933
		/* This u320 (or u640). Set IU transfers */
934
		DV_SET(iu, 1);
935
		/* Then set the optional parameters */
936 937 938
		DV_SET(rd_strm, 1);
		DV_SET(wr_flow, 1);
		DV_SET(rti, 1);
939
		if (min_period == 8)
940
			DV_SET(pcomp_en, 1);
941 942
	} else {
		DV_SET(iu, 0);
943
	}
944

945 946 947 948 949 950
	/* now that we've done all this, actually check the bus
	 * signal type (if known).  Some devices are stupid on
	 * a SE bus and still claim they can try LVD only settings */
	if (i->f->get_signalling)
		i->f->get_signalling(shost);
	if (spi_signalling(shost) == SPI_SIGNAL_SE ||
951
	    spi_signalling(shost) == SPI_SIGNAL_HVD ||
952
	    !spi_support_dt(starget)) {
953
		DV_SET(dt, 0);
954 955 956
	} else {
		DV_SET(dt, 1);
	}
957 958 959 960
	/* set width last because it will pull all the other
	 * parameters down to required values */
	DV_SET(width, max_width);

961 962 963 964 965 966 967 968 969 970 971 972 973 974
	/* Do the read only INQUIRY tests */
	spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
		       spi_dv_device_compare_inquiry);
	/* See if we actually managed to negotiate and sustain DT */
	if (i->f->get_dt)
		i->f->get_dt(starget);

	/* see if the device has an echo buffer.  If it does we can do
	 * the SPI pattern write tests.  Because of some broken
	 * devices, we *only* try this on a device that has actually
	 * negotiated DT */

	if (len == -1 && spi_dt(starget))
		len = spi_dv_device_get_echo_buffer(sdev, buffer);
L
Linus Torvalds 已提交
975

976
	if (len <= 0) {
977
		starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
L
Linus Torvalds 已提交
978 979 980 981
		return;
	}

	if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
982
		starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
L
Linus Torvalds 已提交
983 984 985
		len = SPI_MAX_ECHO_BUFFER_SIZE;
	}

986
	if (spi_dv_retrain(sdev, buffer, buffer + len,
L
Linus Torvalds 已提交
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
			   spi_dv_device_echo_buffer)
	    == SPI_COMPARE_SKIP_TEST) {
		/* OK, the stupid drive can't do a write echo buffer
		 * test after all, fall back to the read tests */
		len = 0;
		goto retry;
	}
}


/**	spi_dv_device - Do Domain Validation on the device
 *	@sdev:		scsi device to validate
 *
 *	Performs the domain validation on the given device in the
 *	current execution thread.  Since DV operations may sleep,
 *	the current thread must have user context.  Also no SCSI
 *	related locks that would deadlock I/O issued by the DV may
 *	be held.
 */
void
spi_dv_device(struct scsi_device *sdev)
{
	struct scsi_target *starget = sdev->sdev_target;
	u8 *buffer;
	const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;

1013 1014 1015 1016 1017 1018 1019 1020
	/*
	 * Because this function and the power management code both call
	 * scsi_device_quiesce(), it is not safe to perform domain validation
	 * while suspend or resume is in progress. Hence the
	 * lock/unlock_system_sleep() calls.
	 */
	lock_system_sleep();

1021
	if (unlikely(spi_dv_in_progress(starget)))
1022
		goto unlock;
L
Linus Torvalds 已提交
1023

1024
	if (unlikely(scsi_device_get(sdev)))
1025 1026
		goto unlock;

1027 1028
	spi_dv_in_progress(starget) = 1;

J
Jes Sorensen 已提交
1029
	buffer = kzalloc(len, GFP_KERNEL);
L
Linus Torvalds 已提交
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041

	if (unlikely(!buffer))
		goto out_put;

	/* We need to verify that the actual device will quiesce; the
	 * later target quiesce is just a nice to have */
	if (unlikely(scsi_device_quiesce(sdev)))
		goto out_free;

	scsi_target_quiesce(starget);

	spi_dv_pending(starget) = 1;
1042
	mutex_lock(&spi_dv_mutex(starget));
L
Linus Torvalds 已提交
1043

1044
	starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
L
Linus Torvalds 已提交
1045

1046
	spi_dv_device_internal(sdev, buffer);
L
Linus Torvalds 已提交
1047

1048
	starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
L
Linus Torvalds 已提交
1049

1050
	mutex_unlock(&spi_dv_mutex(starget));
L
Linus Torvalds 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059
	spi_dv_pending(starget) = 0;

	scsi_target_resume(starget);

	spi_initial_dv(starget) = 1;

 out_free:
	kfree(buffer);
 out_put:
1060
	spi_dv_in_progress(starget) = 0;
L
Linus Torvalds 已提交
1061
	scsi_device_put(sdev);
1062 1063
unlock:
	unlock_system_sleep();
L
Linus Torvalds 已提交
1064 1065 1066 1067 1068 1069 1070 1071 1072
}
EXPORT_SYMBOL(spi_dv_device);

struct work_queue_wrapper {
	struct work_struct	work;
	struct scsi_device	*sdev;
};

static void
D
David Howells 已提交
1073
spi_dv_device_work_wrapper(struct work_struct *work)
L
Linus Torvalds 已提交
1074
{
D
David Howells 已提交
1075 1076
	struct work_queue_wrapper *wqw =
		container_of(work, struct work_queue_wrapper, work);
L
Linus Torvalds 已提交
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
	struct scsi_device *sdev = wqw->sdev;

	kfree(wqw);
	spi_dv_device(sdev);
	spi_dv_pending(sdev->sdev_target) = 0;
	scsi_device_put(sdev);
}


/**
 *	spi_schedule_dv_device - schedule domain validation to occur on the device
 *	@sdev:	The device to validate
 *
 *	Identical to spi_dv_device() above, except that the DV will be
 *	scheduled to occur in a workqueue later.  All memory allocations
 *	are atomic, so may be called from any context including those holding
 *	SCSI locks.
 */
void
spi_schedule_dv_device(struct scsi_device *sdev)
{
	struct work_queue_wrapper *wqw =
		kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);

	if (unlikely(!wqw))
		return;

	if (unlikely(spi_dv_pending(sdev->sdev_target))) {
		kfree(wqw);
		return;
	}
	/* Set pending early (dv_device doesn't check it, only sets it) */
	spi_dv_pending(sdev->sdev_target) = 1;
	if (unlikely(scsi_device_get(sdev))) {
		kfree(wqw);
		spi_dv_pending(sdev->sdev_target) = 0;
		return;
	}

D
David Howells 已提交
1116
	INIT_WORK(&wqw->work, spi_dv_device_work_wrapper);
L
Linus Torvalds 已提交
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
	wqw->sdev = sdev;

	schedule_work(&wqw->work);
}
EXPORT_SYMBOL(spi_schedule_dv_device);

/**
 * spi_display_xfer_agreement - Print the current target transfer agreement
 * @starget: The target for which to display the agreement
 *
 * Each SPI port is required to maintain a transfer agreement for each
 * other port on the bus.  This function prints a one-line summary of
 * the current agreement; more detailed information is available in sysfs.
 */
void spi_display_xfer_agreement(struct scsi_target *starget)
{
	struct spi_transport_attrs *tp;
	tp = (struct spi_transport_attrs *)&starget->starget_data;

	if (tp->offset > 0 && tp->period > 0) {
		unsigned int picosec, kb100;
		char *scsi = "FAST-?";
		char tmp[8];

		if (tp->period <= SPI_STATIC_PPR) {
			picosec = ppr_to_ps[tp->period];
			switch (tp->period) {
				case  7: scsi = "FAST-320"; break;
				case  8: scsi = "FAST-160"; break;
				case  9: scsi = "FAST-80"; break;
				case 10:
				case 11: scsi = "FAST-40"; break;
				case 12: scsi = "FAST-20"; break;
			}
		} else {
			picosec = tp->period * 4000;
			if (tp->period < 25)
				scsi = "FAST-20";
			else if (tp->period < 50)
				scsi = "FAST-10";
			else
				scsi = "FAST-5";
		}

		kb100 = (10000000 + picosec / 2) / picosec;
		if (tp->width)
			kb100 *= 2;
		sprint_frac(tmp, picosec, 1000);

		dev_info(&starget->dev,
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
			 "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
			 scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
			 tp->dt ? "DT" : "ST",
			 tp->iu ? " IU" : "",
			 tp->qas  ? " QAS" : "",
			 tp->rd_strm ? " RDSTRM" : "",
			 tp->rti ? " RTI" : "",
			 tp->wr_flow ? " WRFLOW" : "",
			 tp->pcomp_en ? " PCOMP" : "",
			 tp->hold_mcs ? " HMCS" : "",
			 tmp, tp->offset);
L
Linus Torvalds 已提交
1178
	} else {
M
Matthew Wilcox 已提交
1179
		dev_info(&starget->dev, "%sasynchronous\n",
L
Linus Torvalds 已提交
1180 1181 1182 1183 1184
				tp->width ? "wide " : "");
	}
}
EXPORT_SYMBOL(spi_display_xfer_agreement);

1185 1186 1187 1188 1189 1190 1191 1192
int spi_populate_width_msg(unsigned char *msg, int width)
{
	msg[0] = EXTENDED_MESSAGE;
	msg[1] = 2;
	msg[2] = EXTENDED_WDTR;
	msg[3] = width;
	return 4;
}
1193
EXPORT_SYMBOL_GPL(spi_populate_width_msg);
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203

int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
{
	msg[0] = EXTENDED_MESSAGE;
	msg[1] = 3;
	msg[2] = EXTENDED_SDTR;
	msg[3] = period;
	msg[4] = offset;
	return 5;
}
1204
EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218

int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
		int width, int options)
{
	msg[0] = EXTENDED_MESSAGE;
	msg[1] = 6;
	msg[2] = EXTENDED_PPR;
	msg[3] = period;
	msg[4] = 0;
	msg[5] = offset;
	msg[6] = width;
	msg[7] = options;
	return 8;
}
1219
EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
1220

1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
/**
 * spi_populate_tag_msg - place a tag message in a buffer
 * @msg:	pointer to the area to place the tag
 * @cmd:	pointer to the scsi command for the tag
 *
 * Notes:
 *	designed to create the correct type of tag message for the 
 *	particular request.  Returns the size of the tag message.
 *	May return 0 if TCQ is disabled for this device.
 **/
int spi_populate_tag_msg(unsigned char *msg, struct scsi_cmnd *cmd)
{
        if (cmd->flags & SCMD_TAGGED) {
C
Christoph Hellwig 已提交
1234
		*msg++ = SIMPLE_QUEUE_TAG;
1235 1236 1237 1238 1239 1240 1241 1242
        	*msg++ = cmd->request->tag;
        	return 2;
	}

	return 0;
}
EXPORT_SYMBOL_GPL(spi_populate_tag_msg);

1243 1244
#ifdef CONFIG_SCSI_CONSTANTS
static const char * const one_byte_msgs[] = {
1245
/* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
1246
/* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error", 
1247
/* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
1248
/* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1249 1250 1251 1252
/* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set", 
/* 0x0f */ "Initiate Recovery", "Release Recovery",
/* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
/* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
1253 1254 1255
};

static const char * const two_byte_msgs[] = {
1256
/* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
1257
/* 0x23 */ "Ignore Wide Residue", "ACA"
1258 1259 1260 1261
};

static const char * const extended_msgs[] = {
/* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
1262
/* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
1263
/* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
1264 1265
};

1266
static void print_nego(const unsigned char *msg, int per, int off, int width)
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278
{
	if (per) {
		char buf[20];
		period_to_str(buf, msg[per]);
		printk("period = %s ns ", buf);
	}

	if (off)
		printk("offset = %d ", msg[off]);
	if (width)
		printk("width = %d ", 8 << msg[width]);
}
1279

1280 1281 1282 1283 1284 1285 1286
static void print_ptr(const unsigned char *msg, int msb, const char *desc)
{
	int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
			msg[msb+3];
	printk("%s = %d ", desc, ptr);
}

1287
int spi_print_msg(const unsigned char *msg)
1288
{
1289
	int len = 1, i;
1290
	if (msg[0] == EXTENDED_MESSAGE) {
1291 1292 1293
		len = 2 + msg[1];
		if (len == 2)
			len += 256;
1294
		if (msg[2] < ARRAY_SIZE(extended_msgs))
1295 1296 1297 1298 1299 1300
			printk ("%s ", extended_msgs[msg[2]]); 
		else 
			printk ("Extended Message, reserved code (0x%02x) ",
				(int) msg[2]);
		switch (msg[2]) {
		case EXTENDED_MODIFY_DATA_POINTER:
1301
			print_ptr(msg, 3, "pointer");
1302 1303
			break;
		case EXTENDED_SDTR:
1304
			print_nego(msg, 3, 4, 0);
1305 1306
			break;
		case EXTENDED_WDTR:
1307 1308 1309 1310
			print_nego(msg, 0, 0, 3);
			break;
		case EXTENDED_PPR:
			print_nego(msg, 3, 5, 6);
1311
			break;
1312 1313 1314 1315
		case EXTENDED_MODIFY_BIDI_DATA_PTR:
			print_ptr(msg, 3, "out");
			print_ptr(msg, 7, "in");
			break;
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
		default:
		for (i = 2; i < len; ++i) 
			printk("%02x ", msg[i]);
		}
	/* Identify */
	} else if (msg[0] & 0x80) {
		printk("Identify disconnect %sallowed %s %d ",
			(msg[0] & 0x40) ? "" : "not ",
			(msg[0] & 0x20) ? "target routine" : "lun",
			msg[0] & 0x7);
	/* Normal One byte */
	} else if (msg[0] < 0x1f) {
1328
		if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
1329
			printk("%s ", one_byte_msgs[msg[0]]);
1330 1331
		else
			printk("reserved (%02x) ", msg[0]);
1332 1333
	} else if (msg[0] == 0x55) {
		printk("QAS Request ");
1334 1335
	/* Two byte */
	} else if (msg[0] <= 0x2f) {
1336
		if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
1337 1338 1339 1340 1341 1342 1343
			printk("%s %02x ", two_byte_msgs[msg[0] - 0x20], 
				msg[1]);
		else 
			printk("reserved two byte (%02x %02x) ", 
				msg[0], msg[1]);
		len = 2;
	} else 
1344
		printk("reserved ");
1345 1346
	return len;
}
1347
EXPORT_SYMBOL(spi_print_msg);
1348 1349 1350

#else  /* ifndef CONFIG_SCSI_CONSTANTS */

1351
int spi_print_msg(const unsigned char *msg)
1352
{
1353
	int len = 1, i;
1354 1355

	if (msg[0] == EXTENDED_MESSAGE) {
1356 1357 1358
		len = 2 + msg[1];
		if (len == 2)
			len += 256;
1359 1360 1361 1362 1363 1364
		for (i = 0; i < len; ++i)
			printk("%02x ", msg[i]);
	/* Identify */
	} else if (msg[0] & 0x80) {
		printk("%02x ", msg[0]);
	/* Normal One byte */
1365
	} else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
1366 1367 1368 1369 1370 1371 1372 1373 1374
		printk("%02x ", msg[0]);
	/* Two byte */
	} else if (msg[0] <= 0x2f) {
		printk("%02x %02x", msg[0], msg[1]);
		len = 2;
	} else 
		printk("%02x ", msg[0]);
	return len;
}
1375
EXPORT_SYMBOL(spi_print_msg);
1376 1377
#endif /* ! CONFIG_SCSI_CONSTANTS */

L
Linus Torvalds 已提交
1378 1379 1380 1381 1382
static int spi_device_match(struct attribute_container *cont,
			    struct device *dev)
{
	struct scsi_device *sdev;
	struct Scsi_Host *shost;
1383
	struct spi_internal *i;
L
Linus Torvalds 已提交
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395

	if (!scsi_is_sdev_device(dev))
		return 0;

	sdev = to_scsi_device(dev);
	shost = sdev->host;
	if (!shost->transportt  || shost->transportt->host_attrs.ac.class
	    != &spi_host_class.class)
		return 0;
	/* Note: this class has no device attributes, so it has
	 * no per-HBA allocation and thus we don't need to distinguish
	 * the attribute containers for the device */
1396 1397 1398
	i = to_spi_internal(shost->transportt);
	if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
		return 0;
L
Linus Torvalds 已提交
1399 1400 1401 1402 1403 1404 1405
	return 1;
}

static int spi_target_match(struct attribute_container *cont,
			    struct device *dev)
{
	struct Scsi_Host *shost;
1406
	struct scsi_target *starget;
L
Linus Torvalds 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
	struct spi_internal *i;

	if (!scsi_is_target_device(dev))
		return 0;

	shost = dev_to_shost(dev->parent);
	if (!shost->transportt  || shost->transportt->host_attrs.ac.class
	    != &spi_host_class.class)
		return 0;

	i = to_spi_internal(shost->transportt);
1418 1419 1420 1421 1422
	starget = to_scsi_target(dev);

	if (i->f->deny_binding && i->f->deny_binding(starget))
		return 0;

L
Linus Torvalds 已提交
1423 1424 1425 1426 1427 1428 1429
	return &i->t.target_attrs.ac == cont;
}

static DECLARE_TRANSPORT_CLASS(spi_transport_class,
			       "spi_transport",
			       spi_setup_transport_attrs,
			       NULL,
1430
			       spi_target_configure);
L
Linus Torvalds 已提交
1431 1432 1433 1434 1435

static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
				    spi_device_match,
				    spi_device_configure);

1436
static struct attribute *host_attributes[] = {
1437
	&dev_attr_signalling.attr,
1438 1439
	&dev_attr_host_width.attr,
	&dev_attr_hba_id.attr,
1440 1441 1442 1443 1444 1445 1446 1447 1448
	NULL
};

static struct attribute_group host_attribute_group = {
	.attrs = host_attributes,
};

static int spi_host_configure(struct transport_container *tc,
			      struct device *dev,
1449
			      struct device *cdev)
1450 1451 1452 1453
{
	struct kobject *kobj = &cdev->kobj;
	struct Scsi_Host *shost = transport_class_to_shost(cdev);
	struct spi_internal *si = to_spi_internal(shost->transportt);
1454
	struct attribute *attr = &dev_attr_signalling.attr;
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
	int rc = 0;

	if (si->f->set_signalling)
		rc = sysfs_chmod_file(kobj, attr, attr->mode | S_IWUSR);

	return rc;
}

/* returns true if we should be showing the variable.  Also
 * overloads the return by setting 1<<1 if the attribute should
 * be writeable */
#define TARGET_ATTRIBUTE_HELPER(name) \
1467 1468
	(si->f->show_##name ? S_IRUGO : 0) | \
	(si->f->set_##name ? S_IWUSR : 0)
1469

1470
static umode_t target_attribute_is_visible(struct kobject *kobj,
1471
					  struct attribute *attr, int i)
1472
{
1473
	struct device *cdev = container_of(kobj, struct device, kobj);
1474 1475 1476 1477
	struct scsi_target *starget = transport_class_to_starget(cdev);
	struct Scsi_Host *shost = transport_class_to_shost(cdev);
	struct spi_internal *si = to_spi_internal(shost->transportt);

1478
	if (attr == &dev_attr_period.attr &&
1479 1480
	    spi_support_sync(starget))
		return TARGET_ATTRIBUTE_HELPER(period);
1481
	else if (attr == &dev_attr_min_period.attr &&
1482 1483
		 spi_support_sync(starget))
		return TARGET_ATTRIBUTE_HELPER(period);
1484
	else if (attr == &dev_attr_offset.attr &&
1485 1486
		 spi_support_sync(starget))
		return TARGET_ATTRIBUTE_HELPER(offset);
1487
	else if (attr == &dev_attr_max_offset.attr &&
1488 1489
		 spi_support_sync(starget))
		return TARGET_ATTRIBUTE_HELPER(offset);
1490
	else if (attr == &dev_attr_width.attr &&
1491 1492
		 spi_support_wide(starget))
		return TARGET_ATTRIBUTE_HELPER(width);
1493
	else if (attr == &dev_attr_max_width.attr &&
1494 1495
		 spi_support_wide(starget))
		return TARGET_ATTRIBUTE_HELPER(width);
1496
	else if (attr == &dev_attr_iu.attr &&
1497 1498
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(iu);
1499 1500 1501
	else if (attr == &dev_attr_max_iu.attr &&
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(iu);
1502
	else if (attr == &dev_attr_dt.attr &&
1503 1504
		 spi_support_dt(starget))
		return TARGET_ATTRIBUTE_HELPER(dt);
1505
	else if (attr == &dev_attr_qas.attr &&
1506 1507
		 spi_support_qas(starget))
		return TARGET_ATTRIBUTE_HELPER(qas);
1508 1509 1510
	else if (attr == &dev_attr_max_qas.attr &&
		 spi_support_qas(starget))
		return TARGET_ATTRIBUTE_HELPER(qas);
1511
	else if (attr == &dev_attr_wr_flow.attr &&
1512 1513
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(wr_flow);
1514
	else if (attr == &dev_attr_rd_strm.attr &&
1515 1516
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(rd_strm);
1517
	else if (attr == &dev_attr_rti.attr &&
1518 1519
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(rti);
1520
	else if (attr == &dev_attr_pcomp_en.attr &&
1521 1522
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(pcomp_en);
1523
	else if (attr == &dev_attr_hold_mcs.attr &&
1524 1525
		 spi_support_ius(starget))
		return TARGET_ATTRIBUTE_HELPER(hold_mcs);
1526
	else if (attr == &dev_attr_revalidate.attr)
1527
		return S_IWUSR;
1528 1529 1530 1531 1532

	return 0;
}

static struct attribute *target_attributes[] = {
1533 1534 1535 1536 1537 1538 1539
	&dev_attr_period.attr,
	&dev_attr_min_period.attr,
	&dev_attr_offset.attr,
	&dev_attr_max_offset.attr,
	&dev_attr_width.attr,
	&dev_attr_max_width.attr,
	&dev_attr_iu.attr,
1540
	&dev_attr_max_iu.attr,
1541 1542
	&dev_attr_dt.attr,
	&dev_attr_qas.attr,
1543
	&dev_attr_max_qas.attr,
1544 1545 1546 1547 1548 1549
	&dev_attr_wr_flow.attr,
	&dev_attr_rd_strm.attr,
	&dev_attr_rti.attr,
	&dev_attr_pcomp_en.attr,
	&dev_attr_hold_mcs.attr,
	&dev_attr_revalidate.attr,
1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
	NULL
};

static struct attribute_group target_attribute_group = {
	.attrs = target_attributes,
	.is_visible = target_attribute_is_visible,
};

static int spi_target_configure(struct transport_container *tc,
				struct device *dev,
1560
				struct device *cdev)
1561 1562
{
	struct kobject *kobj = &cdev->kobj;
1563 1564 1565

	/* force an update based on parameters read from the device */
	sysfs_update_group(kobj, &target_attribute_group);
1566 1567 1568 1569

	return 0;
}

L
Linus Torvalds 已提交
1570 1571 1572
struct scsi_transport_template *
spi_attach_transport(struct spi_function_template *ft)
{
J
Jes Sorensen 已提交
1573 1574 1575
	struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
					 GFP_KERNEL);

L
Linus Torvalds 已提交
1576 1577 1578 1579
	if (unlikely(!i))
		return NULL;

	i->t.target_attrs.ac.class = &spi_transport_class.class;
1580
	i->t.target_attrs.ac.grp = &target_attribute_group;
L
Linus Torvalds 已提交
1581 1582 1583 1584
	i->t.target_attrs.ac.match = spi_target_match;
	transport_container_register(&i->t.target_attrs);
	i->t.target_size = sizeof(struct spi_transport_attrs);
	i->t.host_attrs.ac.class = &spi_host_class.class;
1585
	i->t.host_attrs.ac.grp = &host_attribute_group;
L
Linus Torvalds 已提交
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
	i->t.host_attrs.ac.match = spi_host_match;
	transport_container_register(&i->t.host_attrs);
	i->t.host_size = sizeof(struct spi_host_attrs);
	i->f = ft;

	return &i->t;
}
EXPORT_SYMBOL(spi_attach_transport);

void spi_release_transport(struct scsi_transport_template *t)
{
	struct spi_internal *i = to_spi_internal(t);

	transport_container_unregister(&i->t.target_attrs);
	transport_container_unregister(&i->t.host_attrs);

	kfree(i);
}
EXPORT_SYMBOL(spi_release_transport);

static __init int spi_transport_init(void)
{
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
	int error = scsi_dev_info_add_list(SCSI_DEVINFO_SPI,
					   "SCSI Parallel Transport Class");
	if (!error) {
		int i;

		for (i = 0; spi_static_device_list[i].vendor; i++)
			scsi_dev_info_list_add_keyed(1,	/* compatible */
						     spi_static_device_list[i].vendor,
						     spi_static_device_list[i].model,
						     NULL,
						     spi_static_device_list[i].flags,
						     SCSI_DEVINFO_SPI);
	}

	error = transport_class_register(&spi_transport_class);
L
Linus Torvalds 已提交
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
	if (error)
		return error;
	error = anon_transport_class_register(&spi_device_class);
	return transport_class_register(&spi_host_class);
}

static void __exit spi_transport_exit(void)
{
	transport_class_unregister(&spi_transport_class);
	anon_transport_class_unregister(&spi_device_class);
	transport_class_unregister(&spi_host_class);
1634
	scsi_dev_info_remove_list(SCSI_DEVINFO_SPI);
L
Linus Torvalds 已提交
1635 1636 1637 1638 1639 1640 1641 1642
}

MODULE_AUTHOR("Martin Hicks");
MODULE_DESCRIPTION("SPI Transport Attributes");
MODULE_LICENSE("GPL");

module_init(spi_transport_init);
module_exit(spi_transport_exit);