Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Parallel SCSI (SPI) transport specific attributes exported to sysfs. |
| 3 | * |
| 4 | * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved. |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | */ |
| 20 | #ifndef SCSI_TRANSPORT_SPI_H |
| 21 | #define SCSI_TRANSPORT_SPI_H |
| 22 | |
| 23 | #include <linux/config.h> |
| 24 | #include <linux/transport_class.h> |
Andrew Morton | c8d338c | 2006-01-18 17:42:22 -0800 | [diff] [blame] | 25 | #include <linux/mutex.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | |
| 27 | struct scsi_transport_template; |
Matthew Wilcox | 829b846 | 2005-12-13 10:29:31 -0700 | [diff] [blame] | 28 | struct scsi_target; |
| 29 | struct scsi_device; |
| 30 | struct Scsi_Host; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | |
| 32 | struct spi_transport_attrs { |
| 33 | int period; /* value in the PPR/SDTR command */ |
James Bottomley | 62a8612 | 2005-05-06 18:05:20 -0500 | [diff] [blame] | 34 | int min_period; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | int offset; |
James Bottomley | 62a8612 | 2005-05-06 18:05:20 -0500 | [diff] [blame] | 36 | int max_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | unsigned int width:1; /* 0 - narrow, 1 - wide */ |
James Bottomley | 62a8612 | 2005-05-06 18:05:20 -0500 | [diff] [blame] | 38 | unsigned int max_width:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 39 | unsigned int iu:1; /* Information Units enabled */ |
| 40 | unsigned int dt:1; /* DT clocking enabled */ |
| 41 | unsigned int qas:1; /* Quick Arbitration and Selection enabled */ |
| 42 | unsigned int wr_flow:1; /* Write Flow control enabled */ |
| 43 | unsigned int rd_strm:1; /* Read streaming enabled */ |
| 44 | unsigned int rti:1; /* Retain Training Information */ |
| 45 | unsigned int pcomp_en:1;/* Precompensation enabled */ |
James Bottomley | d872ebe | 2005-08-03 15:43:52 -0500 | [diff] [blame] | 46 | unsigned int hold_mcs:1;/* Hold Margin Control Settings */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | unsigned int initial_dv:1; /* DV done to this target yet */ |
| 48 | unsigned long flags; /* flags field for drivers to use */ |
| 49 | /* Device Properties fields */ |
| 50 | unsigned int support_sync:1; /* synchronous support */ |
| 51 | unsigned int support_wide:1; /* wide support */ |
| 52 | unsigned int support_dt:1; /* allows DT phases */ |
| 53 | unsigned int support_dt_only; /* disallows ST phases */ |
| 54 | unsigned int support_ius; /* support Information Units */ |
| 55 | unsigned int support_qas; /* supports quick arbitration and selection */ |
| 56 | /* Private Fields */ |
| 57 | unsigned int dv_pending:1; /* Internal flag */ |
Jes Sorensen | d158d26 | 2006-01-13 16:05:44 -0800 | [diff] [blame] | 58 | struct mutex dv_mutex; /* semaphore to serialise dv */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | }; |
| 60 | |
| 61 | enum spi_signal_type { |
| 62 | SPI_SIGNAL_UNKNOWN = 1, |
| 63 | SPI_SIGNAL_SE, |
| 64 | SPI_SIGNAL_LVD, |
| 65 | SPI_SIGNAL_HVD, |
| 66 | }; |
| 67 | |
| 68 | struct spi_host_attrs { |
| 69 | enum spi_signal_type signalling; |
| 70 | }; |
| 71 | |
| 72 | /* accessor functions */ |
| 73 | #define spi_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->period) |
James Bottomley | 62a8612 | 2005-05-06 18:05:20 -0500 | [diff] [blame] | 74 | #define spi_min_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->min_period) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | #define spi_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->offset) |
James Bottomley | 62a8612 | 2005-05-06 18:05:20 -0500 | [diff] [blame] | 76 | #define spi_max_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_offset) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | #define spi_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->width) |
James Bottomley | 62a8612 | 2005-05-06 18:05:20 -0500 | [diff] [blame] | 78 | #define spi_max_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_width) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | #define spi_iu(x) (((struct spi_transport_attrs *)&(x)->starget_data)->iu) |
| 80 | #define spi_dt(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dt) |
| 81 | #define spi_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->qas) |
| 82 | #define spi_wr_flow(x) (((struct spi_transport_attrs *)&(x)->starget_data)->wr_flow) |
| 83 | #define spi_rd_strm(x) (((struct spi_transport_attrs *)&(x)->starget_data)->rd_strm) |
| 84 | #define spi_rti(x) (((struct spi_transport_attrs *)&(x)->starget_data)->rti) |
| 85 | #define spi_pcomp_en(x) (((struct spi_transport_attrs *)&(x)->starget_data)->pcomp_en) |
James Bottomley | d872ebe | 2005-08-03 15:43:52 -0500 | [diff] [blame] | 86 | #define spi_hold_mcs(x) (((struct spi_transport_attrs *)&(x)->starget_data)->hold_mcs) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 | #define spi_initial_dv(x) (((struct spi_transport_attrs *)&(x)->starget_data)->initial_dv) |
| 88 | |
| 89 | #define spi_support_sync(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_sync) |
| 90 | #define spi_support_wide(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_wide) |
| 91 | #define spi_support_dt(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_dt) |
| 92 | #define spi_support_dt_only(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_dt_only) |
| 93 | #define spi_support_ius(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_ius) |
| 94 | #define spi_support_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_qas) |
| 95 | |
| 96 | #define spi_flags(x) (((struct spi_transport_attrs *)&(x)->starget_data)->flags) |
| 97 | #define spi_signalling(h) (((struct spi_host_attrs *)(h)->shost_data)->signalling) |
| 98 | |
| 99 | |
| 100 | |
| 101 | /* The functions by which the transport class and the driver communicate */ |
| 102 | struct spi_function_template { |
| 103 | void (*get_period)(struct scsi_target *); |
| 104 | void (*set_period)(struct scsi_target *, int); |
| 105 | void (*get_offset)(struct scsi_target *); |
| 106 | void (*set_offset)(struct scsi_target *, int); |
| 107 | void (*get_width)(struct scsi_target *); |
| 108 | void (*set_width)(struct scsi_target *, int); |
| 109 | void (*get_iu)(struct scsi_target *); |
| 110 | void (*set_iu)(struct scsi_target *, int); |
| 111 | void (*get_dt)(struct scsi_target *); |
| 112 | void (*set_dt)(struct scsi_target *, int); |
| 113 | void (*get_qas)(struct scsi_target *); |
| 114 | void (*set_qas)(struct scsi_target *, int); |
| 115 | void (*get_wr_flow)(struct scsi_target *); |
| 116 | void (*set_wr_flow)(struct scsi_target *, int); |
| 117 | void (*get_rd_strm)(struct scsi_target *); |
| 118 | void (*set_rd_strm)(struct scsi_target *, int); |
| 119 | void (*get_rti)(struct scsi_target *); |
| 120 | void (*set_rti)(struct scsi_target *, int); |
| 121 | void (*get_pcomp_en)(struct scsi_target *); |
| 122 | void (*set_pcomp_en)(struct scsi_target *, int); |
James Bottomley | d872ebe | 2005-08-03 15:43:52 -0500 | [diff] [blame] | 123 | void (*get_hold_mcs)(struct scsi_target *); |
| 124 | void (*set_hold_mcs)(struct scsi_target *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | void (*get_signalling)(struct Scsi_Host *); |
| 126 | void (*set_signalling)(struct Scsi_Host *, enum spi_signal_type); |
James Bottomley | 10c1b88 | 2005-08-14 14:34:06 -0500 | [diff] [blame] | 127 | int (*deny_binding)(struct scsi_target *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | /* The driver sets these to tell the transport class it |
| 129 | * wants the attributes displayed in sysfs. If the show_ flag |
| 130 | * is not set, the attribute will be private to the transport |
| 131 | * class */ |
| 132 | unsigned long show_period:1; |
| 133 | unsigned long show_offset:1; |
| 134 | unsigned long show_width:1; |
| 135 | unsigned long show_iu:1; |
| 136 | unsigned long show_dt:1; |
| 137 | unsigned long show_qas:1; |
| 138 | unsigned long show_wr_flow:1; |
| 139 | unsigned long show_rd_strm:1; |
| 140 | unsigned long show_rti:1; |
| 141 | unsigned long show_pcomp_en:1; |
James Bottomley | d872ebe | 2005-08-03 15:43:52 -0500 | [diff] [blame] | 142 | unsigned long show_hold_mcs:1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 143 | }; |
| 144 | |
| 145 | struct scsi_transport_template *spi_attach_transport(struct spi_function_template *); |
| 146 | void spi_release_transport(struct scsi_transport_template *); |
| 147 | void spi_schedule_dv_device(struct scsi_device *); |
| 148 | void spi_dv_device(struct scsi_device *); |
| 149 | void spi_display_xfer_agreement(struct scsi_target *); |
Matthew Wilcox | 1abfd37 | 2005-12-15 16:22:01 -0500 | [diff] [blame] | 150 | int spi_print_msg(const unsigned char *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 151 | |
| 152 | #endif /* SCSI_TRANSPORT_SPI_H */ |