Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /* 
0003  *  Parallel SCSI (SPI) transport specific attributes exported to sysfs.
0004  *
0005  *  Copyright (c) 2003 Silicon Graphics, Inc.  All rights reserved.
0006  *  Copyright (c) 2004, 2005 James Bottomley <James.Bottomley@SteelEye.com>
0007  */
0008 #include <linux/ctype.h>
0009 #include <linux/init.h>
0010 #include <linux/module.h>
0011 #include <linux/workqueue.h>
0012 #include <linux/blkdev.h>
0013 #include <linux/mutex.h>
0014 #include <linux/sysfs.h>
0015 #include <linux/slab.h>
0016 #include <linux/suspend.h>
0017 #include <scsi/scsi.h>
0018 #include "scsi_priv.h"
0019 #include <scsi/scsi_device.h>
0020 #include <scsi/scsi_host.h>
0021 #include <scsi/scsi_cmnd.h>
0022 #include <scsi/scsi_eh.h>
0023 #include <scsi/scsi_tcq.h>
0024 #include <scsi/scsi_transport.h>
0025 #include <scsi/scsi_transport_spi.h>
0026 
0027 #define SPI_NUM_ATTRS 14    /* increase this if you add attributes */
0028 #define SPI_OTHER_ATTRS 1   /* Increase this if you add "always
0029                  * on" attributes */
0030 #define SPI_HOST_ATTRS  1
0031 
0032 #define SPI_MAX_ECHO_BUFFER_SIZE    4096
0033 
0034 #define DV_LOOPS    3
0035 #define DV_TIMEOUT  (10*HZ)
0036 #define DV_RETRIES  3   /* should only need at most 
0037                  * two cc/ua clears */
0038 
0039 /* Our blacklist flags */
0040 enum {
0041     SPI_BLIST_NOIUS = (__force blist_flags_t)0x1,
0042 };
0043 
0044 /* blacklist table, modelled on scsi_devinfo.c */
0045 static struct {
0046     char *vendor;
0047     char *model;
0048     blist_flags_t flags;
0049 } spi_static_device_list[] __initdata = {
0050     {"HP", "Ultrium 3-SCSI", SPI_BLIST_NOIUS },
0051     {"IBM", "ULTRIUM-TD3", SPI_BLIST_NOIUS },
0052     {NULL, NULL, 0}
0053 };
0054 
0055 /* Private data accessors (keep these out of the header file) */
0056 #define spi_dv_in_progress(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_in_progress)
0057 #define spi_dv_mutex(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_mutex)
0058 
0059 struct spi_internal {
0060     struct scsi_transport_template t;
0061     struct spi_function_template *f;
0062 };
0063 
0064 #define to_spi_internal(tmpl)   container_of(tmpl, struct spi_internal, t)
0065 
0066 static const int ppr_to_ps[] = {
0067     /* The PPR values 0-6 are reserved, fill them in when
0068      * the committee defines them */
0069     -1,         /* 0x00 */
0070     -1,         /* 0x01 */
0071     -1,         /* 0x02 */
0072     -1,         /* 0x03 */
0073     -1,         /* 0x04 */
0074     -1,         /* 0x05 */
0075     -1,         /* 0x06 */
0076      3125,          /* 0x07 */
0077      6250,          /* 0x08 */
0078     12500,          /* 0x09 */
0079     25000,          /* 0x0a */
0080     30300,          /* 0x0b */
0081     50000,          /* 0x0c */
0082 };
0083 /* The PPR values at which you calculate the period in ns by multiplying
0084  * by 4 */
0085 #define SPI_STATIC_PPR  0x0c
0086 
0087 static int sprint_frac(char *dest, int value, int denom)
0088 {
0089     int frac = value % denom;
0090     int result = sprintf(dest, "%d", value / denom);
0091 
0092     if (frac == 0)
0093         return result;
0094     dest[result++] = '.';
0095 
0096     do {
0097         denom /= 10;
0098         sprintf(dest + result, "%d", frac / denom);
0099         result++;
0100         frac %= denom;
0101     } while (frac);
0102 
0103     dest[result++] = '\0';
0104     return result;
0105 }
0106 
0107 static int spi_execute(struct scsi_device *sdev, const void *cmd,
0108                enum dma_data_direction dir,
0109                void *buffer, unsigned bufflen,
0110                struct scsi_sense_hdr *sshdr)
0111 {
0112     int i, result;
0113     unsigned char sense[SCSI_SENSE_BUFFERSIZE];
0114     struct scsi_sense_hdr sshdr_tmp;
0115 
0116     if (!sshdr)
0117         sshdr = &sshdr_tmp;
0118 
0119     for(i = 0; i < DV_RETRIES; i++) {
0120         /*
0121          * The purpose of the RQF_PM flag below is to bypass the
0122          * SDEV_QUIESCE state.
0123          */
0124         result = scsi_execute(sdev, cmd, dir, buffer, bufflen, sense,
0125                       sshdr, DV_TIMEOUT, /* retries */ 1,
0126                       REQ_FAILFAST_DEV |
0127                       REQ_FAILFAST_TRANSPORT |
0128                       REQ_FAILFAST_DRIVER,
0129                       RQF_PM, NULL);
0130         if (result < 0 || !scsi_sense_valid(sshdr) ||
0131             sshdr->sense_key != UNIT_ATTENTION)
0132             break;
0133     }
0134     return result;
0135 }
0136 
0137 static struct {
0138     enum spi_signal_type    value;
0139     char            *name;
0140 } signal_types[] = {
0141     { SPI_SIGNAL_UNKNOWN, "unknown" },
0142     { SPI_SIGNAL_SE, "SE" },
0143     { SPI_SIGNAL_LVD, "LVD" },
0144     { SPI_SIGNAL_HVD, "HVD" },
0145 };
0146 
0147 static inline const char *spi_signal_to_string(enum spi_signal_type type)
0148 {
0149     int i;
0150 
0151     for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
0152         if (type == signal_types[i].value)
0153             return signal_types[i].name;
0154     }
0155     return NULL;
0156 }
0157 static inline enum spi_signal_type spi_signal_to_value(const char *name)
0158 {
0159     int i, len;
0160 
0161     for (i = 0; i < ARRAY_SIZE(signal_types); i++) {
0162         len =  strlen(signal_types[i].name);
0163         if (strncmp(name, signal_types[i].name, len) == 0 &&
0164             (name[len] == '\n' || name[len] == '\0'))
0165             return signal_types[i].value;
0166     }
0167     return SPI_SIGNAL_UNKNOWN;
0168 }
0169 
0170 static int spi_host_setup(struct transport_container *tc, struct device *dev,
0171               struct device *cdev)
0172 {
0173     struct Scsi_Host *shost = dev_to_shost(dev);
0174 
0175     spi_signalling(shost) = SPI_SIGNAL_UNKNOWN;
0176 
0177     return 0;
0178 }
0179 
0180 static int spi_host_configure(struct transport_container *tc,
0181                   struct device *dev,
0182                   struct device *cdev);
0183 
0184 static DECLARE_TRANSPORT_CLASS(spi_host_class,
0185                    "spi_host",
0186                    spi_host_setup,
0187                    NULL,
0188                    spi_host_configure);
0189 
0190 static int spi_host_match(struct attribute_container *cont,
0191               struct device *dev)
0192 {
0193     struct Scsi_Host *shost;
0194 
0195     if (!scsi_is_host_device(dev))
0196         return 0;
0197 
0198     shost = dev_to_shost(dev);
0199     if (!shost->transportt  || shost->transportt->host_attrs.ac.class
0200         != &spi_host_class.class)
0201         return 0;
0202 
0203     return &shost->transportt->host_attrs.ac == cont;
0204 }
0205 
0206 static int spi_target_configure(struct transport_container *tc,
0207                 struct device *dev,
0208                 struct device *cdev);
0209 
0210 static int spi_device_configure(struct transport_container *tc,
0211                 struct device *dev,
0212                 struct device *cdev)
0213 {
0214     struct scsi_device *sdev = to_scsi_device(dev);
0215     struct scsi_target *starget = sdev->sdev_target;
0216     blist_flags_t bflags;
0217 
0218     bflags = scsi_get_device_flags_keyed(sdev, &sdev->inquiry[8],
0219                          &sdev->inquiry[16],
0220                          SCSI_DEVINFO_SPI);
0221 
0222     /* Populate the target capability fields with the values
0223      * gleaned from the device inquiry */
0224 
0225     spi_support_sync(starget) = scsi_device_sync(sdev);
0226     spi_support_wide(starget) = scsi_device_wide(sdev);
0227     spi_support_dt(starget) = scsi_device_dt(sdev);
0228     spi_support_dt_only(starget) = scsi_device_dt_only(sdev);
0229     spi_support_ius(starget) = scsi_device_ius(sdev);
0230     if (bflags & SPI_BLIST_NOIUS) {
0231         dev_info(dev, "Information Units disabled by blacklist\n");
0232         spi_support_ius(starget) = 0;
0233     }
0234     spi_support_qas(starget) = scsi_device_qas(sdev);
0235 
0236     return 0;
0237 }
0238 
0239 static int spi_setup_transport_attrs(struct transport_container *tc,
0240                      struct device *dev,
0241                      struct device *cdev)
0242 {
0243     struct scsi_target *starget = to_scsi_target(dev);
0244 
0245     spi_period(starget) = -1;   /* illegal value */
0246     spi_min_period(starget) = 0;
0247     spi_offset(starget) = 0;    /* async */
0248     spi_max_offset(starget) = 255;
0249     spi_width(starget) = 0; /* narrow */
0250     spi_max_width(starget) = 1;
0251     spi_iu(starget) = 0;    /* no IU */
0252     spi_max_iu(starget) = 1;
0253     spi_dt(starget) = 0;    /* ST */
0254     spi_qas(starget) = 0;
0255     spi_max_qas(starget) = 1;
0256     spi_wr_flow(starget) = 0;
0257     spi_rd_strm(starget) = 0;
0258     spi_rti(starget) = 0;
0259     spi_pcomp_en(starget) = 0;
0260     spi_hold_mcs(starget) = 0;
0261     spi_dv_pending(starget) = 0;
0262     spi_dv_in_progress(starget) = 0;
0263     spi_initial_dv(starget) = 0;
0264     mutex_init(&spi_dv_mutex(starget));
0265 
0266     return 0;
0267 }
0268 
0269 #define spi_transport_show_simple(field, format_string)         \
0270                                     \
0271 static ssize_t                              \
0272 show_spi_transport_##field(struct device *dev,          \
0273                struct device_attribute *attr, char *buf)    \
0274 {                                   \
0275     struct scsi_target *starget = transport_class_to_starget(dev);  \
0276     struct spi_transport_attrs *tp;                 \
0277                                     \
0278     tp = (struct spi_transport_attrs *)&starget->starget_data;  \
0279     return snprintf(buf, 20, format_string, tp->field);     \
0280 }
0281 
0282 #define spi_transport_store_simple(field, format_string)        \
0283                                     \
0284 static ssize_t                              \
0285 store_spi_transport_##field(struct device *dev,             \
0286                 struct device_attribute *attr,      \
0287                 const char *buf, size_t count)      \
0288 {                                   \
0289     int val;                            \
0290     struct scsi_target *starget = transport_class_to_starget(dev);  \
0291     struct spi_transport_attrs *tp;                 \
0292                                     \
0293     tp = (struct spi_transport_attrs *)&starget->starget_data;  \
0294     val = simple_strtoul(buf, NULL, 0);             \
0295     tp->field = val;                        \
0296     return count;                           \
0297 }
0298 
0299 #define spi_transport_show_function(field, format_string)       \
0300                                     \
0301 static ssize_t                              \
0302 show_spi_transport_##field(struct device *dev,          \
0303                struct device_attribute *attr, char *buf)    \
0304 {                                   \
0305     struct scsi_target *starget = transport_class_to_starget(dev);  \
0306     struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);    \
0307     struct spi_transport_attrs *tp;                 \
0308     struct spi_internal *i = to_spi_internal(shost->transportt);    \
0309     tp = (struct spi_transport_attrs *)&starget->starget_data;  \
0310     if (i->f->get_##field)                      \
0311         i->f->get_##field(starget);             \
0312     return snprintf(buf, 20, format_string, tp->field);     \
0313 }
0314 
0315 #define spi_transport_store_function(field, format_string)      \
0316 static ssize_t                              \
0317 store_spi_transport_##field(struct device *dev,             \
0318                 struct device_attribute *attr,      \
0319                 const char *buf, size_t count)      \
0320 {                                   \
0321     int val;                            \
0322     struct scsi_target *starget = transport_class_to_starget(dev);  \
0323     struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);    \
0324     struct spi_internal *i = to_spi_internal(shost->transportt);    \
0325                                     \
0326     if (!i->f->set_##field)                     \
0327         return -EINVAL;                     \
0328     val = simple_strtoul(buf, NULL, 0);             \
0329     i->f->set_##field(starget, val);                \
0330     return count;                           \
0331 }
0332 
0333 #define spi_transport_store_max(field, format_string)           \
0334 static ssize_t                              \
0335 store_spi_transport_##field(struct device *dev,             \
0336                 struct device_attribute *attr,      \
0337                 const char *buf, size_t count)      \
0338 {                                   \
0339     int val;                            \
0340     struct scsi_target *starget = transport_class_to_starget(dev);  \
0341     struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);    \
0342     struct spi_internal *i = to_spi_internal(shost->transportt);    \
0343     struct spi_transport_attrs *tp                  \
0344         = (struct spi_transport_attrs *)&starget->starget_data; \
0345                                     \
0346     if (!i->f->set_##field)                     \
0347         return -EINVAL;                     \
0348     val = simple_strtoul(buf, NULL, 0);             \
0349     if (val > tp->max_##field)                  \
0350         val = tp->max_##field;                  \
0351     i->f->set_##field(starget, val);                \
0352     return count;                           \
0353 }
0354 
0355 #define spi_transport_rd_attr(field, format_string)         \
0356     spi_transport_show_function(field, format_string)       \
0357     spi_transport_store_function(field, format_string)      \
0358 static DEVICE_ATTR(field, S_IRUGO,              \
0359            show_spi_transport_##field,          \
0360            store_spi_transport_##field);
0361 
0362 #define spi_transport_simple_attr(field, format_string)         \
0363     spi_transport_show_simple(field, format_string)         \
0364     spi_transport_store_simple(field, format_string)        \
0365 static DEVICE_ATTR(field, S_IRUGO,              \
0366            show_spi_transport_##field,          \
0367            store_spi_transport_##field);
0368 
0369 #define spi_transport_max_attr(field, format_string)            \
0370     spi_transport_show_function(field, format_string)       \
0371     spi_transport_store_max(field, format_string)           \
0372     spi_transport_simple_attr(max_##field, format_string)       \
0373 static DEVICE_ATTR(field, S_IRUGO,              \
0374            show_spi_transport_##field,          \
0375            store_spi_transport_##field);
0376 
0377 /* The Parallel SCSI Tranport Attributes: */
0378 spi_transport_max_attr(offset, "%d\n");
0379 spi_transport_max_attr(width, "%d\n");
0380 spi_transport_max_attr(iu, "%d\n");
0381 spi_transport_rd_attr(dt, "%d\n");
0382 spi_transport_max_attr(qas, "%d\n");
0383 spi_transport_rd_attr(wr_flow, "%d\n");
0384 spi_transport_rd_attr(rd_strm, "%d\n");
0385 spi_transport_rd_attr(rti, "%d\n");
0386 spi_transport_rd_attr(pcomp_en, "%d\n");
0387 spi_transport_rd_attr(hold_mcs, "%d\n");
0388 
0389 /* we only care about the first child device that's a real SCSI device
0390  * so we return 1 to terminate the iteration when we find it */
0391 static int child_iter(struct device *dev, void *data)
0392 {
0393     if (!scsi_is_sdev_device(dev))
0394         return 0;
0395 
0396     spi_dv_device(to_scsi_device(dev));
0397     return 1;
0398 }
0399 
0400 static ssize_t
0401 store_spi_revalidate(struct device *dev, struct device_attribute *attr,
0402              const char *buf, size_t count)
0403 {
0404     struct scsi_target *starget = transport_class_to_starget(dev);
0405 
0406     device_for_each_child(&starget->dev, NULL, child_iter);
0407     return count;
0408 }
0409 static DEVICE_ATTR(revalidate, S_IWUSR, NULL, store_spi_revalidate);
0410 
0411 /* Translate the period into ns according to the current spec
0412  * for SDTR/PPR messages */
0413 static int period_to_str(char *buf, int period)
0414 {
0415     int len, picosec;
0416 
0417     if (period < 0 || period > 0xff) {
0418         picosec = -1;
0419     } else if (period <= SPI_STATIC_PPR) {
0420         picosec = ppr_to_ps[period];
0421     } else {
0422         picosec = period * 4000;
0423     }
0424 
0425     if (picosec == -1) {
0426         len = sprintf(buf, "reserved");
0427     } else {
0428         len = sprint_frac(buf, picosec, 1000);
0429     }
0430 
0431     return len;
0432 }
0433 
0434 static ssize_t
0435 show_spi_transport_period_helper(char *buf, int period)
0436 {
0437     int len = period_to_str(buf, period);
0438     buf[len++] = '\n';
0439     buf[len] = '\0';
0440     return len;
0441 }
0442 
0443 static ssize_t
0444 store_spi_transport_period_helper(struct device *dev, const char *buf,
0445                   size_t count, int *periodp)
0446 {
0447     int j, picosec, period = -1;
0448     char *endp;
0449 
0450     picosec = simple_strtoul(buf, &endp, 10) * 1000;
0451     if (*endp == '.') {
0452         int mult = 100;
0453         do {
0454             endp++;
0455             if (!isdigit(*endp))
0456                 break;
0457             picosec += (*endp - '0') * mult;
0458             mult /= 10;
0459         } while (mult > 0);
0460     }
0461 
0462     for (j = 0; j <= SPI_STATIC_PPR; j++) {
0463         if (ppr_to_ps[j] < picosec)
0464             continue;
0465         period = j;
0466         break;
0467     }
0468 
0469     if (period == -1)
0470         period = picosec / 4000;
0471 
0472     if (period > 0xff)
0473         period = 0xff;
0474 
0475     *periodp = period;
0476 
0477     return count;
0478 }
0479 
0480 static ssize_t
0481 show_spi_transport_period(struct device *dev,
0482               struct device_attribute *attr, char *buf)
0483 {
0484     struct scsi_target *starget = transport_class_to_starget(dev);
0485     struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
0486     struct spi_internal *i = to_spi_internal(shost->transportt);
0487     struct spi_transport_attrs *tp =
0488         (struct spi_transport_attrs *)&starget->starget_data;
0489 
0490     if (i->f->get_period)
0491         i->f->get_period(starget);
0492 
0493     return show_spi_transport_period_helper(buf, tp->period);
0494 }
0495 
0496 static ssize_t
0497 store_spi_transport_period(struct device *cdev, struct device_attribute *attr,
0498                const char *buf, size_t count)
0499 {
0500     struct scsi_target *starget = transport_class_to_starget(cdev);
0501     struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
0502     struct spi_internal *i = to_spi_internal(shost->transportt);
0503     struct spi_transport_attrs *tp =
0504         (struct spi_transport_attrs *)&starget->starget_data;
0505     int period, retval;
0506 
0507     if (!i->f->set_period)
0508         return -EINVAL;
0509 
0510     retval = store_spi_transport_period_helper(cdev, buf, count, &period);
0511 
0512     if (period < tp->min_period)
0513         period = tp->min_period;
0514 
0515     i->f->set_period(starget, period);
0516 
0517     return retval;
0518 }
0519 
0520 static DEVICE_ATTR(period, S_IRUGO,
0521            show_spi_transport_period,
0522            store_spi_transport_period);
0523 
0524 static ssize_t
0525 show_spi_transport_min_period(struct device *cdev,
0526                   struct device_attribute *attr, char *buf)
0527 {
0528     struct scsi_target *starget = transport_class_to_starget(cdev);
0529     struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
0530     struct spi_internal *i = to_spi_internal(shost->transportt);
0531     struct spi_transport_attrs *tp =
0532         (struct spi_transport_attrs *)&starget->starget_data;
0533 
0534     if (!i->f->set_period)
0535         return -EINVAL;
0536 
0537     return show_spi_transport_period_helper(buf, tp->min_period);
0538 }
0539 
0540 static ssize_t
0541 store_spi_transport_min_period(struct device *cdev,
0542                    struct device_attribute *attr,
0543                    const char *buf, size_t count)
0544 {
0545     struct scsi_target *starget = transport_class_to_starget(cdev);
0546     struct spi_transport_attrs *tp =
0547         (struct spi_transport_attrs *)&starget->starget_data;
0548 
0549     return store_spi_transport_period_helper(cdev, buf, count,
0550                          &tp->min_period);
0551 }
0552 
0553 
0554 static DEVICE_ATTR(min_period, S_IRUGO,
0555            show_spi_transport_min_period,
0556            store_spi_transport_min_period);
0557 
0558 
0559 static ssize_t show_spi_host_signalling(struct device *cdev,
0560                     struct device_attribute *attr,
0561                     char *buf)
0562 {
0563     struct Scsi_Host *shost = transport_class_to_shost(cdev);
0564     struct spi_internal *i = to_spi_internal(shost->transportt);
0565 
0566     if (i->f->get_signalling)
0567         i->f->get_signalling(shost);
0568 
0569     return sprintf(buf, "%s\n", spi_signal_to_string(spi_signalling(shost)));
0570 }
0571 static ssize_t store_spi_host_signalling(struct device *dev,
0572                      struct device_attribute *attr,
0573                      const char *buf, size_t count)
0574 {
0575     struct Scsi_Host *shost = transport_class_to_shost(dev);
0576     struct spi_internal *i = to_spi_internal(shost->transportt);
0577     enum spi_signal_type type = spi_signal_to_value(buf);
0578 
0579     if (!i->f->set_signalling)
0580         return -EINVAL;
0581 
0582     if (type != SPI_SIGNAL_UNKNOWN)
0583         i->f->set_signalling(shost, type);
0584 
0585     return count;
0586 }
0587 static DEVICE_ATTR(signalling, S_IRUGO,
0588            show_spi_host_signalling,
0589            store_spi_host_signalling);
0590 
0591 static ssize_t show_spi_host_width(struct device *cdev,
0592                       struct device_attribute *attr,
0593                       char *buf)
0594 {
0595     struct Scsi_Host *shost = transport_class_to_shost(cdev);
0596 
0597     return sprintf(buf, "%s\n", shost->max_id == 16 ? "wide" : "narrow");
0598 }
0599 static DEVICE_ATTR(host_width, S_IRUGO,
0600            show_spi_host_width, NULL);
0601 
0602 static ssize_t show_spi_host_hba_id(struct device *cdev,
0603                     struct device_attribute *attr,
0604                     char *buf)
0605 {
0606     struct Scsi_Host *shost = transport_class_to_shost(cdev);
0607 
0608     return sprintf(buf, "%d\n", shost->this_id);
0609 }
0610 static DEVICE_ATTR(hba_id, S_IRUGO,
0611            show_spi_host_hba_id, NULL);
0612 
0613 #define DV_SET(x, y)            \
0614     if(i->f->set_##x)       \
0615         i->f->set_##x(sdev->sdev_target, y)
0616 
0617 enum spi_compare_returns {
0618     SPI_COMPARE_SUCCESS,
0619     SPI_COMPARE_FAILURE,
0620     SPI_COMPARE_SKIP_TEST,
0621 };
0622 
0623 
0624 /* This is for read/write Domain Validation:  If the device supports
0625  * an echo buffer, we do read/write tests to it */
0626 static enum spi_compare_returns
0627 spi_dv_device_echo_buffer(struct scsi_device *sdev, u8 *buffer,
0628               u8 *ptr, const int retries)
0629 {
0630     int len = ptr - buffer;
0631     int j, k, r, result;
0632     unsigned int pattern = 0x0000ffff;
0633     struct scsi_sense_hdr sshdr;
0634 
0635     const char spi_write_buffer[] = {
0636         WRITE_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
0637     };
0638     const char spi_read_buffer[] = {
0639         READ_BUFFER, 0x0a, 0, 0, 0, 0, 0, len >> 8, len & 0xff, 0
0640     };
0641 
0642     /* set up the pattern buffer.  Doesn't matter if we spill
0643      * slightly beyond since that's where the read buffer is */
0644     for (j = 0; j < len; ) {
0645 
0646         /* fill the buffer with counting (test a) */
0647         for ( ; j < min(len, 32); j++)
0648             buffer[j] = j;
0649         k = j;
0650         /* fill the buffer with alternating words of 0x0 and
0651          * 0xffff (test b) */
0652         for ( ; j < min(len, k + 32); j += 2) {
0653             u16 *word = (u16 *)&buffer[j];
0654             
0655             *word = (j & 0x02) ? 0x0000 : 0xffff;
0656         }
0657         k = j;
0658         /* fill with crosstalk (alternating 0x5555 0xaaa)
0659                  * (test c) */
0660         for ( ; j < min(len, k + 32); j += 2) {
0661             u16 *word = (u16 *)&buffer[j];
0662 
0663             *word = (j & 0x02) ? 0x5555 : 0xaaaa;
0664         }
0665         k = j;
0666         /* fill with shifting bits (test d) */
0667         for ( ; j < min(len, k + 32); j += 4) {
0668             u32 *word = (unsigned int *)&buffer[j];
0669             u32 roll = (pattern & 0x80000000) ? 1 : 0;
0670             
0671             *word = pattern;
0672             pattern = (pattern << 1) | roll;
0673         }
0674         /* don't bother with random data (test e) */
0675     }
0676 
0677     for (r = 0; r < retries; r++) {
0678         result = spi_execute(sdev, spi_write_buffer, DMA_TO_DEVICE,
0679                      buffer, len, &sshdr);
0680         if(result || !scsi_device_online(sdev)) {
0681 
0682             scsi_device_set_state(sdev, SDEV_QUIESCE);
0683             if (scsi_sense_valid(&sshdr)
0684                 && sshdr.sense_key == ILLEGAL_REQUEST
0685                 /* INVALID FIELD IN CDB */
0686                 && sshdr.asc == 0x24 && sshdr.ascq == 0x00)
0687                 /* This would mean that the drive lied
0688                  * to us about supporting an echo
0689                  * buffer (unfortunately some Western
0690                  * Digital drives do precisely this)
0691                  */
0692                 return SPI_COMPARE_SKIP_TEST;
0693 
0694 
0695             sdev_printk(KERN_ERR, sdev, "Write Buffer failure %x\n", result);
0696             return SPI_COMPARE_FAILURE;
0697         }
0698 
0699         memset(ptr, 0, len);
0700         spi_execute(sdev, spi_read_buffer, DMA_FROM_DEVICE,
0701                 ptr, len, NULL);
0702         scsi_device_set_state(sdev, SDEV_QUIESCE);
0703 
0704         if (memcmp(buffer, ptr, len) != 0)
0705             return SPI_COMPARE_FAILURE;
0706     }
0707     return SPI_COMPARE_SUCCESS;
0708 }
0709 
0710 /* This is for the simplest form of Domain Validation: a read test
0711  * on the inquiry data from the device */
0712 static enum spi_compare_returns
0713 spi_dv_device_compare_inquiry(struct scsi_device *sdev, u8 *buffer,
0714                   u8 *ptr, const int retries)
0715 {
0716     int r, result;
0717     const int len = sdev->inquiry_len;
0718     const char spi_inquiry[] = {
0719         INQUIRY, 0, 0, 0, len, 0
0720     };
0721 
0722     for (r = 0; r < retries; r++) {
0723         memset(ptr, 0, len);
0724 
0725         result = spi_execute(sdev, spi_inquiry, DMA_FROM_DEVICE,
0726                      ptr, len, NULL);
0727         
0728         if(result || !scsi_device_online(sdev)) {
0729             scsi_device_set_state(sdev, SDEV_QUIESCE);
0730             return SPI_COMPARE_FAILURE;
0731         }
0732 
0733         /* If we don't have the inquiry data already, the
0734          * first read gets it */
0735         if (ptr == buffer) {
0736             ptr += len;
0737             --r;
0738             continue;
0739         }
0740 
0741         if (memcmp(buffer, ptr, len) != 0)
0742             /* failure */
0743             return SPI_COMPARE_FAILURE;
0744     }
0745     return SPI_COMPARE_SUCCESS;
0746 }
0747 
0748 static enum spi_compare_returns
0749 spi_dv_retrain(struct scsi_device *sdev, u8 *buffer, u8 *ptr,
0750            enum spi_compare_returns 
0751            (*compare_fn)(struct scsi_device *, u8 *, u8 *, int))
0752 {
0753     struct spi_internal *i = to_spi_internal(sdev->host->transportt);
0754     struct scsi_target *starget = sdev->sdev_target;
0755     int period = 0, prevperiod = 0; 
0756     enum spi_compare_returns retval;
0757 
0758 
0759     for (;;) {
0760         int newperiod;
0761         retval = compare_fn(sdev, buffer, ptr, DV_LOOPS);
0762 
0763         if (retval == SPI_COMPARE_SUCCESS
0764             || retval == SPI_COMPARE_SKIP_TEST)
0765             break;
0766 
0767         /* OK, retrain, fallback */
0768         if (i->f->get_iu)
0769             i->f->get_iu(starget);
0770         if (i->f->get_qas)
0771             i->f->get_qas(starget);
0772         if (i->f->get_period)
0773             i->f->get_period(sdev->sdev_target);
0774 
0775         /* Here's the fallback sequence; first try turning off
0776          * IU, then QAS (if we can control them), then finally
0777          * fall down the periods */
0778         if (i->f->set_iu && spi_iu(starget)) {
0779             starget_printk(KERN_ERR, starget, "Domain Validation Disabling Information Units\n");
0780             DV_SET(iu, 0);
0781         } else if (i->f->set_qas && spi_qas(starget)) {
0782             starget_printk(KERN_ERR, starget, "Domain Validation Disabling Quick Arbitration and Selection\n");
0783             DV_SET(qas, 0);
0784         } else {
0785             newperiod = spi_period(starget);
0786             period = newperiod > period ? newperiod : period;
0787             if (period < 0x0d)
0788                 period++;
0789             else
0790                 period += period >> 1;
0791 
0792             if (unlikely(period > 0xff || period == prevperiod)) {
0793                 /* Total failure; set to async and return */
0794                 starget_printk(KERN_ERR, starget, "Domain Validation Failure, dropping back to Asynchronous\n");
0795                 DV_SET(offset, 0);
0796                 return SPI_COMPARE_FAILURE;
0797             }
0798             starget_printk(KERN_ERR, starget, "Domain Validation detected failure, dropping back\n");
0799             DV_SET(period, period);
0800             prevperiod = period;
0801         }
0802     }
0803     return retval;
0804 }
0805 
0806 static int
0807 spi_dv_device_get_echo_buffer(struct scsi_device *sdev, u8 *buffer)
0808 {
0809     int l, result;
0810 
0811     /* first off do a test unit ready.  This can error out 
0812      * because of reservations or some other reason.  If it
0813      * fails, the device won't let us write to the echo buffer
0814      * so just return failure */
0815     
0816     static const char spi_test_unit_ready[] = {
0817         TEST_UNIT_READY, 0, 0, 0, 0, 0
0818     };
0819 
0820     static const char spi_read_buffer_descriptor[] = {
0821         READ_BUFFER, 0x0b, 0, 0, 0, 0, 0, 0, 4, 0
0822     };
0823 
0824     
0825     /* We send a set of three TURs to clear any outstanding 
0826      * unit attention conditions if they exist (Otherwise the
0827      * buffer tests won't be happy).  If the TUR still fails
0828      * (reservation conflict, device not ready, etc) just
0829      * skip the write tests */
0830     for (l = 0; ; l++) {
0831         result = spi_execute(sdev, spi_test_unit_ready, DMA_NONE, 
0832                      NULL, 0, NULL);
0833 
0834         if(result) {
0835             if(l >= 3)
0836                 return 0;
0837         } else {
0838             /* TUR succeeded */
0839             break;
0840         }
0841     }
0842 
0843     result = spi_execute(sdev, spi_read_buffer_descriptor, 
0844                  DMA_FROM_DEVICE, buffer, 4, NULL);
0845 
0846     if (result)
0847         /* Device has no echo buffer */
0848         return 0;
0849 
0850     return buffer[3] + ((buffer[2] & 0x1f) << 8);
0851 }
0852 
0853 static void
0854 spi_dv_device_internal(struct scsi_device *sdev, u8 *buffer)
0855 {
0856     struct spi_internal *i = to_spi_internal(sdev->host->transportt);
0857     struct scsi_target *starget = sdev->sdev_target;
0858     struct Scsi_Host *shost = sdev->host;
0859     int len = sdev->inquiry_len;
0860     int min_period = spi_min_period(starget);
0861     int max_width = spi_max_width(starget);
0862     /* first set us up for narrow async */
0863     DV_SET(offset, 0);
0864     DV_SET(width, 0);
0865 
0866     if (spi_dv_device_compare_inquiry(sdev, buffer, buffer, DV_LOOPS)
0867         != SPI_COMPARE_SUCCESS) {
0868         starget_printk(KERN_ERR, starget, "Domain Validation Initial Inquiry Failed\n");
0869         /* FIXME: should probably offline the device here? */
0870         return;
0871     }
0872 
0873     if (!spi_support_wide(starget)) {
0874         spi_max_width(starget) = 0;
0875         max_width = 0;
0876     }
0877 
0878     /* test width */
0879     if (i->f->set_width && max_width) {
0880         i->f->set_width(starget, 1);
0881 
0882         if (spi_dv_device_compare_inquiry(sdev, buffer,
0883                            buffer + len,
0884                            DV_LOOPS)
0885             != SPI_COMPARE_SUCCESS) {
0886             starget_printk(KERN_ERR, starget, "Wide Transfers Fail\n");
0887             i->f->set_width(starget, 0);
0888             /* Make sure we don't force wide back on by asking
0889              * for a transfer period that requires it */
0890             max_width = 0;
0891             if (min_period < 10)
0892                 min_period = 10;
0893         }
0894     }
0895 
0896     if (!i->f->set_period)
0897         return;
0898 
0899     /* device can't handle synchronous */
0900     if (!spi_support_sync(starget) && !spi_support_dt(starget))
0901         return;
0902 
0903     /* len == -1 is the signal that we need to ascertain the
0904      * presence of an echo buffer before trying to use it.  len ==
0905      * 0 means we don't have an echo buffer */
0906     len = -1;
0907 
0908  retry:
0909 
0910     /* now set up to the maximum */
0911     DV_SET(offset, spi_max_offset(starget));
0912     DV_SET(period, min_period);
0913 
0914     /* try QAS requests; this should be harmless to set if the
0915      * target supports it */
0916     if (spi_support_qas(starget) && spi_max_qas(starget)) {
0917         DV_SET(qas, 1);
0918     } else {
0919         DV_SET(qas, 0);
0920     }
0921 
0922     if (spi_support_ius(starget) && spi_max_iu(starget) &&
0923         min_period < 9) {
0924         /* This u320 (or u640). Set IU transfers */
0925         DV_SET(iu, 1);
0926         /* Then set the optional parameters */
0927         DV_SET(rd_strm, 1);
0928         DV_SET(wr_flow, 1);
0929         DV_SET(rti, 1);
0930         if (min_period == 8)
0931             DV_SET(pcomp_en, 1);
0932     } else {
0933         DV_SET(iu, 0);
0934     }
0935 
0936     /* now that we've done all this, actually check the bus
0937      * signal type (if known).  Some devices are stupid on
0938      * a SE bus and still claim they can try LVD only settings */
0939     if (i->f->get_signalling)
0940         i->f->get_signalling(shost);
0941     if (spi_signalling(shost) == SPI_SIGNAL_SE ||
0942         spi_signalling(shost) == SPI_SIGNAL_HVD ||
0943         !spi_support_dt(starget)) {
0944         DV_SET(dt, 0);
0945     } else {
0946         DV_SET(dt, 1);
0947     }
0948     /* set width last because it will pull all the other
0949      * parameters down to required values */
0950     DV_SET(width, max_width);
0951 
0952     /* Do the read only INQUIRY tests */
0953     spi_dv_retrain(sdev, buffer, buffer + sdev->inquiry_len,
0954                spi_dv_device_compare_inquiry);
0955     /* See if we actually managed to negotiate and sustain DT */
0956     if (i->f->get_dt)
0957         i->f->get_dt(starget);
0958 
0959     /* see if the device has an echo buffer.  If it does we can do
0960      * the SPI pattern write tests.  Because of some broken
0961      * devices, we *only* try this on a device that has actually
0962      * negotiated DT */
0963 
0964     if (len == -1 && spi_dt(starget))
0965         len = spi_dv_device_get_echo_buffer(sdev, buffer);
0966 
0967     if (len <= 0) {
0968         starget_printk(KERN_INFO, starget, "Domain Validation skipping write tests\n");
0969         return;
0970     }
0971 
0972     if (len > SPI_MAX_ECHO_BUFFER_SIZE) {
0973         starget_printk(KERN_WARNING, starget, "Echo buffer size %d is too big, trimming to %d\n", len, SPI_MAX_ECHO_BUFFER_SIZE);
0974         len = SPI_MAX_ECHO_BUFFER_SIZE;
0975     }
0976 
0977     if (spi_dv_retrain(sdev, buffer, buffer + len,
0978                spi_dv_device_echo_buffer)
0979         == SPI_COMPARE_SKIP_TEST) {
0980         /* OK, the stupid drive can't do a write echo buffer
0981          * test after all, fall back to the read tests */
0982         len = 0;
0983         goto retry;
0984     }
0985 }
0986 
0987 
0988 /** spi_dv_device - Do Domain Validation on the device
0989  *  @sdev:      scsi device to validate
0990  *
0991  *  Performs the domain validation on the given device in the
0992  *  current execution thread.  Since DV operations may sleep,
0993  *  the current thread must have user context.  Also no SCSI
0994  *  related locks that would deadlock I/O issued by the DV may
0995  *  be held.
0996  */
0997 void
0998 spi_dv_device(struct scsi_device *sdev)
0999 {
1000     struct scsi_target *starget = sdev->sdev_target;
1001     u8 *buffer;
1002     const int len = SPI_MAX_ECHO_BUFFER_SIZE*2;
1003 
1004     /*
1005      * Because this function and the power management code both call
1006      * scsi_device_quiesce(), it is not safe to perform domain validation
1007      * while suspend or resume is in progress. Hence the
1008      * lock/unlock_system_sleep() calls.
1009      */
1010     lock_system_sleep();
1011 
1012     if (scsi_autopm_get_device(sdev))
1013         goto unlock_system_sleep;
1014 
1015     if (unlikely(spi_dv_in_progress(starget)))
1016         goto put_autopm;
1017 
1018     if (unlikely(scsi_device_get(sdev)))
1019         goto put_autopm;
1020 
1021     spi_dv_in_progress(starget) = 1;
1022 
1023     buffer = kzalloc(len, GFP_KERNEL);
1024 
1025     if (unlikely(!buffer))
1026         goto put_sdev;
1027 
1028     /* We need to verify that the actual device will quiesce; the
1029      * later target quiesce is just a nice to have */
1030     if (unlikely(scsi_device_quiesce(sdev)))
1031         goto free_buffer;
1032 
1033     scsi_target_quiesce(starget);
1034 
1035     spi_dv_pending(starget) = 1;
1036     mutex_lock(&spi_dv_mutex(starget));
1037 
1038     starget_printk(KERN_INFO, starget, "Beginning Domain Validation\n");
1039 
1040     spi_dv_device_internal(sdev, buffer);
1041 
1042     starget_printk(KERN_INFO, starget, "Ending Domain Validation\n");
1043 
1044     mutex_unlock(&spi_dv_mutex(starget));
1045     spi_dv_pending(starget) = 0;
1046 
1047     scsi_target_resume(starget);
1048 
1049     spi_initial_dv(starget) = 1;
1050 
1051 free_buffer:
1052     kfree(buffer);
1053 
1054 put_sdev:
1055     spi_dv_in_progress(starget) = 0;
1056     scsi_device_put(sdev);
1057 put_autopm:
1058     scsi_autopm_put_device(sdev);
1059 
1060 unlock_system_sleep:
1061     unlock_system_sleep();
1062 }
1063 EXPORT_SYMBOL(spi_dv_device);
1064 
1065 struct work_queue_wrapper {
1066     struct work_struct  work;
1067     struct scsi_device  *sdev;
1068 };
1069 
1070 static void
1071 spi_dv_device_work_wrapper(struct work_struct *work)
1072 {
1073     struct work_queue_wrapper *wqw =
1074         container_of(work, struct work_queue_wrapper, work);
1075     struct scsi_device *sdev = wqw->sdev;
1076 
1077     kfree(wqw);
1078     spi_dv_device(sdev);
1079     spi_dv_pending(sdev->sdev_target) = 0;
1080     scsi_device_put(sdev);
1081 }
1082 
1083 
1084 /**
1085  *  spi_schedule_dv_device - schedule domain validation to occur on the device
1086  *  @sdev:  The device to validate
1087  *
1088  *  Identical to spi_dv_device() above, except that the DV will be
1089  *  scheduled to occur in a workqueue later.  All memory allocations
1090  *  are atomic, so may be called from any context including those holding
1091  *  SCSI locks.
1092  */
1093 void
1094 spi_schedule_dv_device(struct scsi_device *sdev)
1095 {
1096     struct work_queue_wrapper *wqw =
1097         kmalloc(sizeof(struct work_queue_wrapper), GFP_ATOMIC);
1098 
1099     if (unlikely(!wqw))
1100         return;
1101 
1102     if (unlikely(spi_dv_pending(sdev->sdev_target))) {
1103         kfree(wqw);
1104         return;
1105     }
1106     /* Set pending early (dv_device doesn't check it, only sets it) */
1107     spi_dv_pending(sdev->sdev_target) = 1;
1108     if (unlikely(scsi_device_get(sdev))) {
1109         kfree(wqw);
1110         spi_dv_pending(sdev->sdev_target) = 0;
1111         return;
1112     }
1113 
1114     INIT_WORK(&wqw->work, spi_dv_device_work_wrapper);
1115     wqw->sdev = sdev;
1116 
1117     schedule_work(&wqw->work);
1118 }
1119 EXPORT_SYMBOL(spi_schedule_dv_device);
1120 
1121 /**
1122  * spi_display_xfer_agreement - Print the current target transfer agreement
1123  * @starget: The target for which to display the agreement
1124  *
1125  * Each SPI port is required to maintain a transfer agreement for each
1126  * other port on the bus.  This function prints a one-line summary of
1127  * the current agreement; more detailed information is available in sysfs.
1128  */
1129 void spi_display_xfer_agreement(struct scsi_target *starget)
1130 {
1131     struct spi_transport_attrs *tp;
1132     tp = (struct spi_transport_attrs *)&starget->starget_data;
1133 
1134     if (tp->offset > 0 && tp->period > 0) {
1135         unsigned int picosec, kb100;
1136         char *scsi = "FAST-?";
1137         char tmp[8];
1138 
1139         if (tp->period <= SPI_STATIC_PPR) {
1140             picosec = ppr_to_ps[tp->period];
1141             switch (tp->period) {
1142                 case  7: scsi = "FAST-320"; break;
1143                 case  8: scsi = "FAST-160"; break;
1144                 case  9: scsi = "FAST-80"; break;
1145                 case 10:
1146                 case 11: scsi = "FAST-40"; break;
1147                 case 12: scsi = "FAST-20"; break;
1148             }
1149         } else {
1150             picosec = tp->period * 4000;
1151             if (tp->period < 25)
1152                 scsi = "FAST-20";
1153             else if (tp->period < 50)
1154                 scsi = "FAST-10";
1155             else
1156                 scsi = "FAST-5";
1157         }
1158 
1159         kb100 = (10000000 + picosec / 2) / picosec;
1160         if (tp->width)
1161             kb100 *= 2;
1162         sprint_frac(tmp, picosec, 1000);
1163 
1164         dev_info(&starget->dev,
1165              "%s %sSCSI %d.%d MB/s %s%s%s%s%s%s%s%s (%s ns, offset %d)\n",
1166              scsi, tp->width ? "WIDE " : "", kb100/10, kb100 % 10,
1167              tp->dt ? "DT" : "ST",
1168              tp->iu ? " IU" : "",
1169              tp->qas  ? " QAS" : "",
1170              tp->rd_strm ? " RDSTRM" : "",
1171              tp->rti ? " RTI" : "",
1172              tp->wr_flow ? " WRFLOW" : "",
1173              tp->pcomp_en ? " PCOMP" : "",
1174              tp->hold_mcs ? " HMCS" : "",
1175              tmp, tp->offset);
1176     } else {
1177         dev_info(&starget->dev, "%sasynchronous\n",
1178                 tp->width ? "wide " : "");
1179     }
1180 }
1181 EXPORT_SYMBOL(spi_display_xfer_agreement);
1182 
1183 int spi_populate_width_msg(unsigned char *msg, int width)
1184 {
1185     msg[0] = EXTENDED_MESSAGE;
1186     msg[1] = 2;
1187     msg[2] = EXTENDED_WDTR;
1188     msg[3] = width;
1189     return 4;
1190 }
1191 EXPORT_SYMBOL_GPL(spi_populate_width_msg);
1192 
1193 int spi_populate_sync_msg(unsigned char *msg, int period, int offset)
1194 {
1195     msg[0] = EXTENDED_MESSAGE;
1196     msg[1] = 3;
1197     msg[2] = EXTENDED_SDTR;
1198     msg[3] = period;
1199     msg[4] = offset;
1200     return 5;
1201 }
1202 EXPORT_SYMBOL_GPL(spi_populate_sync_msg);
1203 
1204 int spi_populate_ppr_msg(unsigned char *msg, int period, int offset,
1205         int width, int options)
1206 {
1207     msg[0] = EXTENDED_MESSAGE;
1208     msg[1] = 6;
1209     msg[2] = EXTENDED_PPR;
1210     msg[3] = period;
1211     msg[4] = 0;
1212     msg[5] = offset;
1213     msg[6] = width;
1214     msg[7] = options;
1215     return 8;
1216 }
1217 EXPORT_SYMBOL_GPL(spi_populate_ppr_msg);
1218 
1219 /**
1220  * spi_populate_tag_msg - place a tag message in a buffer
1221  * @msg:    pointer to the area to place the tag
1222  * @cmd:    pointer to the scsi command for the tag
1223  *
1224  * Notes:
1225  *  designed to create the correct type of tag message for the 
1226  *  particular request.  Returns the size of the tag message.
1227  *  May return 0 if TCQ is disabled for this device.
1228  **/
1229 int spi_populate_tag_msg(unsigned char *msg, struct scsi_cmnd *cmd)
1230 {
1231         if (cmd->flags & SCMD_TAGGED) {
1232         *msg++ = SIMPLE_QUEUE_TAG;
1233         *msg++ = scsi_cmd_to_rq(cmd)->tag;
1234             return 2;
1235     }
1236 
1237     return 0;
1238 }
1239 EXPORT_SYMBOL_GPL(spi_populate_tag_msg);
1240 
1241 #ifdef CONFIG_SCSI_CONSTANTS
1242 static const char * const one_byte_msgs[] = {
1243 /* 0x00 */ "Task Complete", NULL /* Extended Message */, "Save Pointers",
1244 /* 0x03 */ "Restore Pointers", "Disconnect", "Initiator Error", 
1245 /* 0x06 */ "Abort Task Set", "Message Reject", "Nop", "Message Parity Error",
1246 /* 0x0a */ "Linked Command Complete", "Linked Command Complete w/flag",
1247 /* 0x0c */ "Target Reset", "Abort Task", "Clear Task Set", 
1248 /* 0x0f */ "Initiate Recovery", "Release Recovery",
1249 /* 0x11 */ "Terminate Process", "Continue Task", "Target Transfer Disable",
1250 /* 0x14 */ NULL, NULL, "Clear ACA", "LUN Reset"
1251 };
1252 
1253 static const char * const two_byte_msgs[] = {
1254 /* 0x20 */ "Simple Queue Tag", "Head of Queue Tag", "Ordered Queue Tag",
1255 /* 0x23 */ "Ignore Wide Residue", "ACA"
1256 };
1257 
1258 static const char * const extended_msgs[] = {
1259 /* 0x00 */ "Modify Data Pointer", "Synchronous Data Transfer Request",
1260 /* 0x02 */ "SCSI-I Extended Identify", "Wide Data Transfer Request",
1261 /* 0x04 */ "Parallel Protocol Request", "Modify Bidirectional Data Pointer"
1262 };
1263 
1264 static void print_nego(const unsigned char *msg, int per, int off, int width)
1265 {
1266     if (per) {
1267         char buf[20];
1268         period_to_str(buf, msg[per]);
1269         printk("period = %s ns ", buf);
1270     }
1271 
1272     if (off)
1273         printk("offset = %d ", msg[off]);
1274     if (width)
1275         printk("width = %d ", 8 << msg[width]);
1276 }
1277 
1278 static void print_ptr(const unsigned char *msg, int msb, const char *desc)
1279 {
1280     int ptr = (msg[msb] << 24) | (msg[msb+1] << 16) | (msg[msb+2] << 8) |
1281             msg[msb+3];
1282     printk("%s = %d ", desc, ptr);
1283 }
1284 
1285 int spi_print_msg(const unsigned char *msg)
1286 {
1287     int len = 1, i;
1288     if (msg[0] == EXTENDED_MESSAGE) {
1289         len = 2 + msg[1];
1290         if (len == 2)
1291             len += 256;
1292         if (msg[2] < ARRAY_SIZE(extended_msgs))
1293             printk ("%s ", extended_msgs[msg[2]]); 
1294         else 
1295             printk ("Extended Message, reserved code (0x%02x) ",
1296                 (int) msg[2]);
1297         switch (msg[2]) {
1298         case EXTENDED_MODIFY_DATA_POINTER:
1299             print_ptr(msg, 3, "pointer");
1300             break;
1301         case EXTENDED_SDTR:
1302             print_nego(msg, 3, 4, 0);
1303             break;
1304         case EXTENDED_WDTR:
1305             print_nego(msg, 0, 0, 3);
1306             break;
1307         case EXTENDED_PPR:
1308             print_nego(msg, 3, 5, 6);
1309             break;
1310         case EXTENDED_MODIFY_BIDI_DATA_PTR:
1311             print_ptr(msg, 3, "out");
1312             print_ptr(msg, 7, "in");
1313             break;
1314         default:
1315         for (i = 2; i < len; ++i) 
1316             printk("%02x ", msg[i]);
1317         }
1318     /* Identify */
1319     } else if (msg[0] & 0x80) {
1320         printk("Identify disconnect %sallowed %s %d ",
1321             (msg[0] & 0x40) ? "" : "not ",
1322             (msg[0] & 0x20) ? "target routine" : "lun",
1323             msg[0] & 0x7);
1324     /* Normal One byte */
1325     } else if (msg[0] < 0x1f) {
1326         if (msg[0] < ARRAY_SIZE(one_byte_msgs) && one_byte_msgs[msg[0]])
1327             printk("%s ", one_byte_msgs[msg[0]]);
1328         else
1329             printk("reserved (%02x) ", msg[0]);
1330     } else if (msg[0] == 0x55) {
1331         printk("QAS Request ");
1332     /* Two byte */
1333     } else if (msg[0] <= 0x2f) {
1334         if ((msg[0] - 0x20) < ARRAY_SIZE(two_byte_msgs))
1335             printk("%s %02x ", two_byte_msgs[msg[0] - 0x20], 
1336                 msg[1]);
1337         else 
1338             printk("reserved two byte (%02x %02x) ", 
1339                 msg[0], msg[1]);
1340         len = 2;
1341     } else 
1342         printk("reserved ");
1343     return len;
1344 }
1345 EXPORT_SYMBOL(spi_print_msg);
1346 
1347 #else  /* ifndef CONFIG_SCSI_CONSTANTS */
1348 
1349 int spi_print_msg(const unsigned char *msg)
1350 {
1351     int len = 1, i;
1352 
1353     if (msg[0] == EXTENDED_MESSAGE) {
1354         len = 2 + msg[1];
1355         if (len == 2)
1356             len += 256;
1357         for (i = 0; i < len; ++i)
1358             printk("%02x ", msg[i]);
1359     /* Identify */
1360     } else if (msg[0] & 0x80) {
1361         printk("%02x ", msg[0]);
1362     /* Normal One byte */
1363     } else if ((msg[0] < 0x1f) || (msg[0] == 0x55)) {
1364         printk("%02x ", msg[0]);
1365     /* Two byte */
1366     } else if (msg[0] <= 0x2f) {
1367         printk("%02x %02x", msg[0], msg[1]);
1368         len = 2;
1369     } else 
1370         printk("%02x ", msg[0]);
1371     return len;
1372 }
1373 EXPORT_SYMBOL(spi_print_msg);
1374 #endif /* ! CONFIG_SCSI_CONSTANTS */
1375 
1376 static int spi_device_match(struct attribute_container *cont,
1377                 struct device *dev)
1378 {
1379     struct scsi_device *sdev;
1380     struct Scsi_Host *shost;
1381     struct spi_internal *i;
1382 
1383     if (!scsi_is_sdev_device(dev))
1384         return 0;
1385 
1386     sdev = to_scsi_device(dev);
1387     shost = sdev->host;
1388     if (!shost->transportt  || shost->transportt->host_attrs.ac.class
1389         != &spi_host_class.class)
1390         return 0;
1391     /* Note: this class has no device attributes, so it has
1392      * no per-HBA allocation and thus we don't need to distinguish
1393      * the attribute containers for the device */
1394     i = to_spi_internal(shost->transportt);
1395     if (i->f->deny_binding && i->f->deny_binding(sdev->sdev_target))
1396         return 0;
1397     return 1;
1398 }
1399 
1400 static int spi_target_match(struct attribute_container *cont,
1401                 struct device *dev)
1402 {
1403     struct Scsi_Host *shost;
1404     struct scsi_target *starget;
1405     struct spi_internal *i;
1406 
1407     if (!scsi_is_target_device(dev))
1408         return 0;
1409 
1410     shost = dev_to_shost(dev->parent);
1411     if (!shost->transportt  || shost->transportt->host_attrs.ac.class
1412         != &spi_host_class.class)
1413         return 0;
1414 
1415     i = to_spi_internal(shost->transportt);
1416     starget = to_scsi_target(dev);
1417 
1418     if (i->f->deny_binding && i->f->deny_binding(starget))
1419         return 0;
1420 
1421     return &i->t.target_attrs.ac == cont;
1422 }
1423 
1424 static DECLARE_TRANSPORT_CLASS(spi_transport_class,
1425                    "spi_transport",
1426                    spi_setup_transport_attrs,
1427                    NULL,
1428                    spi_target_configure);
1429 
1430 static DECLARE_ANON_TRANSPORT_CLASS(spi_device_class,
1431                     spi_device_match,
1432                     spi_device_configure);
1433 
1434 static struct attribute *host_attributes[] = {
1435     &dev_attr_signalling.attr,
1436     &dev_attr_host_width.attr,
1437     &dev_attr_hba_id.attr,
1438     NULL
1439 };
1440 
1441 static struct attribute_group host_attribute_group = {
1442     .attrs = host_attributes,
1443 };
1444 
1445 static int spi_host_configure(struct transport_container *tc,
1446                   struct device *dev,
1447                   struct device *cdev)
1448 {
1449     struct kobject *kobj = &cdev->kobj;
1450     struct Scsi_Host *shost = transport_class_to_shost(cdev);
1451     struct spi_internal *si = to_spi_internal(shost->transportt);
1452     struct attribute *attr = &dev_attr_signalling.attr;
1453     int rc = 0;
1454 
1455     if (si->f->set_signalling)
1456         rc = sysfs_chmod_file(kobj, attr, attr->mode | S_IWUSR);
1457 
1458     return rc;
1459 }
1460 
1461 /* returns true if we should be showing the variable.  Also
1462  * overloads the return by setting 1<<1 if the attribute should
1463  * be writeable */
1464 #define TARGET_ATTRIBUTE_HELPER(name) \
1465     (si->f->show_##name ? S_IRUGO : 0) | \
1466     (si->f->set_##name ? S_IWUSR : 0)
1467 
1468 static umode_t target_attribute_is_visible(struct kobject *kobj,
1469                       struct attribute *attr, int i)
1470 {
1471     struct device *cdev = container_of(kobj, struct device, kobj);
1472     struct scsi_target *starget = transport_class_to_starget(cdev);
1473     struct Scsi_Host *shost = transport_class_to_shost(cdev);
1474     struct spi_internal *si = to_spi_internal(shost->transportt);
1475 
1476     if (attr == &dev_attr_period.attr &&
1477         spi_support_sync(starget))
1478         return TARGET_ATTRIBUTE_HELPER(period);
1479     else if (attr == &dev_attr_min_period.attr &&
1480          spi_support_sync(starget))
1481         return TARGET_ATTRIBUTE_HELPER(period);
1482     else if (attr == &dev_attr_offset.attr &&
1483          spi_support_sync(starget))
1484         return TARGET_ATTRIBUTE_HELPER(offset);
1485     else if (attr == &dev_attr_max_offset.attr &&
1486          spi_support_sync(starget))
1487         return TARGET_ATTRIBUTE_HELPER(offset);
1488     else if (attr == &dev_attr_width.attr &&
1489          spi_support_wide(starget))
1490         return TARGET_ATTRIBUTE_HELPER(width);
1491     else if (attr == &dev_attr_max_width.attr &&
1492          spi_support_wide(starget))
1493         return TARGET_ATTRIBUTE_HELPER(width);
1494     else if (attr == &dev_attr_iu.attr &&
1495          spi_support_ius(starget))
1496         return TARGET_ATTRIBUTE_HELPER(iu);
1497     else if (attr == &dev_attr_max_iu.attr &&
1498          spi_support_ius(starget))
1499         return TARGET_ATTRIBUTE_HELPER(iu);
1500     else if (attr == &dev_attr_dt.attr &&
1501          spi_support_dt(starget))
1502         return TARGET_ATTRIBUTE_HELPER(dt);
1503     else if (attr == &dev_attr_qas.attr &&
1504          spi_support_qas(starget))
1505         return TARGET_ATTRIBUTE_HELPER(qas);
1506     else if (attr == &dev_attr_max_qas.attr &&
1507          spi_support_qas(starget))
1508         return TARGET_ATTRIBUTE_HELPER(qas);
1509     else if (attr == &dev_attr_wr_flow.attr &&
1510          spi_support_ius(starget))
1511         return TARGET_ATTRIBUTE_HELPER(wr_flow);
1512     else if (attr == &dev_attr_rd_strm.attr &&
1513          spi_support_ius(starget))
1514         return TARGET_ATTRIBUTE_HELPER(rd_strm);
1515     else if (attr == &dev_attr_rti.attr &&
1516          spi_support_ius(starget))
1517         return TARGET_ATTRIBUTE_HELPER(rti);
1518     else if (attr == &dev_attr_pcomp_en.attr &&
1519          spi_support_ius(starget))
1520         return TARGET_ATTRIBUTE_HELPER(pcomp_en);
1521     else if (attr == &dev_attr_hold_mcs.attr &&
1522          spi_support_ius(starget))
1523         return TARGET_ATTRIBUTE_HELPER(hold_mcs);
1524     else if (attr == &dev_attr_revalidate.attr)
1525         return S_IWUSR;
1526 
1527     return 0;
1528 }
1529 
1530 static struct attribute *target_attributes[] = {
1531     &dev_attr_period.attr,
1532     &dev_attr_min_period.attr,
1533     &dev_attr_offset.attr,
1534     &dev_attr_max_offset.attr,
1535     &dev_attr_width.attr,
1536     &dev_attr_max_width.attr,
1537     &dev_attr_iu.attr,
1538     &dev_attr_max_iu.attr,
1539     &dev_attr_dt.attr,
1540     &dev_attr_qas.attr,
1541     &dev_attr_max_qas.attr,
1542     &dev_attr_wr_flow.attr,
1543     &dev_attr_rd_strm.attr,
1544     &dev_attr_rti.attr,
1545     &dev_attr_pcomp_en.attr,
1546     &dev_attr_hold_mcs.attr,
1547     &dev_attr_revalidate.attr,
1548     NULL
1549 };
1550 
1551 static struct attribute_group target_attribute_group = {
1552     .attrs = target_attributes,
1553     .is_visible = target_attribute_is_visible,
1554 };
1555 
1556 static int spi_target_configure(struct transport_container *tc,
1557                 struct device *dev,
1558                 struct device *cdev)
1559 {
1560     struct kobject *kobj = &cdev->kobj;
1561 
1562     /* force an update based on parameters read from the device */
1563     sysfs_update_group(kobj, &target_attribute_group);
1564 
1565     return 0;
1566 }
1567 
1568 struct scsi_transport_template *
1569 spi_attach_transport(struct spi_function_template *ft)
1570 {
1571     struct spi_internal *i = kzalloc(sizeof(struct spi_internal),
1572                      GFP_KERNEL);
1573 
1574     if (unlikely(!i))
1575         return NULL;
1576 
1577     i->t.target_attrs.ac.class = &spi_transport_class.class;
1578     i->t.target_attrs.ac.grp = &target_attribute_group;
1579     i->t.target_attrs.ac.match = spi_target_match;
1580     transport_container_register(&i->t.target_attrs);
1581     i->t.target_size = sizeof(struct spi_transport_attrs);
1582     i->t.host_attrs.ac.class = &spi_host_class.class;
1583     i->t.host_attrs.ac.grp = &host_attribute_group;
1584     i->t.host_attrs.ac.match = spi_host_match;
1585     transport_container_register(&i->t.host_attrs);
1586     i->t.host_size = sizeof(struct spi_host_attrs);
1587     i->f = ft;
1588 
1589     return &i->t;
1590 }
1591 EXPORT_SYMBOL(spi_attach_transport);
1592 
1593 void spi_release_transport(struct scsi_transport_template *t)
1594 {
1595     struct spi_internal *i = to_spi_internal(t);
1596 
1597     transport_container_unregister(&i->t.target_attrs);
1598     transport_container_unregister(&i->t.host_attrs);
1599 
1600     kfree(i);
1601 }
1602 EXPORT_SYMBOL(spi_release_transport);
1603 
1604 static __init int spi_transport_init(void)
1605 {
1606     int error = scsi_dev_info_add_list(SCSI_DEVINFO_SPI,
1607                        "SCSI Parallel Transport Class");
1608     if (!error) {
1609         int i;
1610 
1611         for (i = 0; spi_static_device_list[i].vendor; i++)
1612             scsi_dev_info_list_add_keyed(1, /* compatible */
1613                              spi_static_device_list[i].vendor,
1614                              spi_static_device_list[i].model,
1615                              NULL,
1616                              spi_static_device_list[i].flags,
1617                              SCSI_DEVINFO_SPI);
1618     }
1619 
1620     error = transport_class_register(&spi_transport_class);
1621     if (error)
1622         return error;
1623     error = anon_transport_class_register(&spi_device_class);
1624     return transport_class_register(&spi_host_class);
1625 }
1626 
1627 static void __exit spi_transport_exit(void)
1628 {
1629     transport_class_unregister(&spi_transport_class);
1630     anon_transport_class_unregister(&spi_device_class);
1631     transport_class_unregister(&spi_host_class);
1632     scsi_dev_info_remove_list(SCSI_DEVINFO_SPI);
1633 }
1634 
1635 MODULE_AUTHOR("Martin Hicks");
1636 MODULE_DESCRIPTION("SPI Transport Attributes");
1637 MODULE_LICENSE("GPL");
1638 
1639 module_init(spi_transport_init);
1640 module_exit(spi_transport_exit);