Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
scsi_transport_spi.h
Go to the documentation of this file.
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/transport_class.h>
24 #include <linux/mutex.h>
25 
26 struct scsi_transport_template;
27 struct scsi_target;
28 struct scsi_device;
29 struct Scsi_Host;
30 
31 struct spi_transport_attrs {
32  int period; /* value in the PPR/SDTR command */
33  int min_period;
34  int offset;
35  int max_offset;
36  unsigned int width:1; /* 0 - narrow, 1 - wide */
37  unsigned int max_width:1;
38  unsigned int iu:1; /* Information Units enabled */
39  unsigned int max_iu:1;
40  unsigned int dt:1; /* DT clocking enabled */
41  unsigned int qas:1; /* Quick Arbitration and Selection enabled */
42  unsigned int max_qas:1;
43  unsigned int wr_flow:1; /* Write Flow control enabled */
44  unsigned int rd_strm:1; /* Read streaming enabled */
45  unsigned int rti:1; /* Retain Training Information */
46  unsigned int pcomp_en:1;/* Precompensation enabled */
47  unsigned int hold_mcs:1;/* Hold Margin Control Settings */
48  unsigned int initial_dv:1; /* DV done to this target yet */
49  unsigned long flags; /* flags field for drivers to use */
50  /* Device Properties fields */
51  unsigned int support_sync:1; /* synchronous support */
52  unsigned int support_wide:1; /* wide support */
53  unsigned int support_dt:1; /* allows DT phases */
54  unsigned int support_dt_only; /* disallows ST phases */
55  unsigned int support_ius; /* support Information Units */
56  unsigned int support_qas; /* supports quick arbitration and selection */
57  /* Private Fields */
58  unsigned int dv_pending:1; /* Internal flag: DV Requested */
59  unsigned int dv_in_progress:1; /* Internal: DV started */
60  struct mutex dv_mutex; /* semaphore to serialise dv */
61 };
62 
63 enum spi_signal_type {
64  SPI_SIGNAL_UNKNOWN = 1,
65  SPI_SIGNAL_SE,
66  SPI_SIGNAL_LVD,
67  SPI_SIGNAL_HVD,
68 };
69 
70 struct spi_host_attrs {
71  enum spi_signal_type signalling;
72 };
73 
74 /* accessor functions */
75 #define spi_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->period)
76 #define spi_min_period(x) (((struct spi_transport_attrs *)&(x)->starget_data)->min_period)
77 #define spi_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->offset)
78 #define spi_max_offset(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_offset)
79 #define spi_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->width)
80 #define spi_max_width(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_width)
81 #define spi_iu(x) (((struct spi_transport_attrs *)&(x)->starget_data)->iu)
82 #define spi_max_iu(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_iu)
83 #define spi_dt(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dt)
84 #define spi_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->qas)
85 #define spi_max_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->max_qas)
86 #define spi_wr_flow(x) (((struct spi_transport_attrs *)&(x)->starget_data)->wr_flow)
87 #define spi_rd_strm(x) (((struct spi_transport_attrs *)&(x)->starget_data)->rd_strm)
88 #define spi_rti(x) (((struct spi_transport_attrs *)&(x)->starget_data)->rti)
89 #define spi_pcomp_en(x) (((struct spi_transport_attrs *)&(x)->starget_data)->pcomp_en)
90 #define spi_hold_mcs(x) (((struct spi_transport_attrs *)&(x)->starget_data)->hold_mcs)
91 #define spi_initial_dv(x) (((struct spi_transport_attrs *)&(x)->starget_data)->initial_dv)
92 #define spi_dv_pending(x) (((struct spi_transport_attrs *)&(x)->starget_data)->dv_pending)
93 
94 #define spi_support_sync(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_sync)
95 #define spi_support_wide(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_wide)
96 #define spi_support_dt(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_dt)
97 #define spi_support_dt_only(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_dt_only)
98 #define spi_support_ius(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_ius)
99 #define spi_support_qas(x) (((struct spi_transport_attrs *)&(x)->starget_data)->support_qas)
100 
101 #define spi_flags(x) (((struct spi_transport_attrs *)&(x)->starget_data)->flags)
102 #define spi_signalling(h) (((struct spi_host_attrs *)(h)->shost_data)->signalling)
103 
104 
105 
106 /* The functions by which the transport class and the driver communicate */
107 struct spi_function_template {
108  void (*get_period)(struct scsi_target *);
109  void (*set_period)(struct scsi_target *, int);
110  void (*get_offset)(struct scsi_target *);
111  void (*set_offset)(struct scsi_target *, int);
112  void (*get_width)(struct scsi_target *);
113  void (*set_width)(struct scsi_target *, int);
114  void (*get_iu)(struct scsi_target *);
115  void (*set_iu)(struct scsi_target *, int);
116  void (*get_dt)(struct scsi_target *);
117  void (*set_dt)(struct scsi_target *, int);
118  void (*get_qas)(struct scsi_target *);
119  void (*set_qas)(struct scsi_target *, int);
120  void (*get_wr_flow)(struct scsi_target *);
121  void (*set_wr_flow)(struct scsi_target *, int);
122  void (*get_rd_strm)(struct scsi_target *);
123  void (*set_rd_strm)(struct scsi_target *, int);
124  void (*get_rti)(struct scsi_target *);
125  void (*set_rti)(struct scsi_target *, int);
126  void (*get_pcomp_en)(struct scsi_target *);
127  void (*set_pcomp_en)(struct scsi_target *, int);
128  void (*get_hold_mcs)(struct scsi_target *);
129  void (*set_hold_mcs)(struct scsi_target *, int);
130  void (*get_signalling)(struct Scsi_Host *);
131  void (*set_signalling)(struct Scsi_Host *, enum spi_signal_type);
132  int (*deny_binding)(struct scsi_target *);
133  /* The driver sets these to tell the transport class it
134  * wants the attributes displayed in sysfs. If the show_ flag
135  * is not set, the attribute will be private to the transport
136  * class */
137  unsigned long show_period:1;
138  unsigned long show_offset:1;
139  unsigned long show_width:1;
140  unsigned long show_iu:1;
141  unsigned long show_dt:1;
142  unsigned long show_qas:1;
143  unsigned long show_wr_flow:1;
144  unsigned long show_rd_strm:1;
145  unsigned long show_rti:1;
146  unsigned long show_pcomp_en:1;
147  unsigned long show_hold_mcs:1;
148 };
149 
150 struct scsi_transport_template *spi_attach_transport(struct spi_function_template *);
151 void spi_release_transport(struct scsi_transport_template *);
152 void spi_schedule_dv_device(struct scsi_device *);
153 void spi_dv_device(struct scsi_device *);
154 void spi_display_xfer_agreement(struct scsi_target *);
155 int spi_print_msg(const unsigned char *);
156 int spi_populate_width_msg(unsigned char *msg, int width);
157 int spi_populate_sync_msg(unsigned char *msg, int period, int offset);
158 int spi_populate_ppr_msg(unsigned char *msg, int period, int offset, int width,
159  int options);
160 
161 #endif /* SCSI_TRANSPORT_SPI_H */
Generated on Thu Jan 10 2013 14:53:29 for Linux Kernel by   doxygen 1.8.2