blob: 9b8e08879cfc9d7f7038245cf12e9b162f0f7f4e [file] [log] [blame]
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +02001#ifndef SCSI_TRANSPORT_SAS_H
2#define SCSI_TRANSPORT_SAS_H
3
4#include <linux/transport_class.h>
5#include <linux/types.h>
James Bottomley65c92b02006-06-28 12:22:50 -04006#include <linux/mutex.h>
Darrick J. Wong5929faf2007-11-05 11:51:17 -08007#include <scsi/sas.h>
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +02008
9struct scsi_transport_template;
10struct sas_rphy;
FUJITA Tomonori7aa68e82007-07-09 12:52:06 +090011struct request;
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020012
13enum sas_device_type {
James Bottomleyb98e66f2007-12-28 16:35:17 -060014 SAS_PHY_UNUSED = 0,
15 SAS_END_DEVICE = 1,
16 SAS_EDGE_EXPANDER_DEVICE = 2,
17 SAS_FANOUT_EXPANDER_DEVICE = 3,
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020018};
19
James Bottomley0f05df8b2007-07-16 13:41:04 -050020static inline int sas_protocol_ata(enum sas_protocol proto)
21{
22 return ((proto & SAS_PROTOCOL_SATA) ||
23 (proto & SAS_PROTOCOL_STP))? 1 : 0;
24}
25
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020026enum sas_linkrate {
James Bottomley88edf742006-09-06 17:36:13 -050027 /* These Values are defined in the SAS standard */
28 SAS_LINK_RATE_UNKNOWN = 0,
29 SAS_PHY_DISABLED = 1,
30 SAS_PHY_RESET_PROBLEM = 2,
31 SAS_SATA_SPINUP_HOLD = 3,
32 SAS_SATA_PORT_SELECTOR = 4,
33 SAS_PHY_RESET_IN_PROGRESS = 5,
34 SAS_LINK_RATE_1_5_GBPS = 8,
35 SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
36 SAS_LINK_RATE_3_0_GBPS = 9,
37 SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
38 SAS_LINK_RATE_6_0_GBPS = 10,
Sreekanth Reddyd84fd392012-11-30 07:43:11 +053039 SAS_LINK_RATE_12_0_GBPS = 11,
James Bottomley88edf742006-09-06 17:36:13 -050040 /* These are virtual to the transport class and may never
41 * be signalled normally since the standard defined field
42 * is only 4 bits */
43 SAS_LINK_RATE_FAILED = 0x10,
44 SAS_PHY_VIRTUAL = 0x11,
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020045};
46
47struct sas_identify {
48 enum sas_device_type device_type;
49 enum sas_protocol initiator_port_protocols;
50 enum sas_protocol target_port_protocols;
51 u64 sas_address;
52 u8 phy_identifier;
53};
54
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020055struct sas_phy {
56 struct device dev;
57 int number;
Darrick J. Wongacbf1672007-01-11 14:14:57 -080058 int enabled;
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020059
60 /* phy identification */
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020061 struct sas_identify identify;
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020062
63 /* phy attributes */
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020064 enum sas_linkrate negotiated_linkrate;
65 enum sas_linkrate minimum_linkrate_hw;
66 enum sas_linkrate minimum_linkrate;
67 enum sas_linkrate maximum_linkrate_hw;
68 enum sas_linkrate maximum_linkrate;
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020069
70 /* link error statistics */
71 u32 invalid_dword_count;
72 u32 running_disparity_error_count;
73 u32 loss_of_dword_sync_count;
74 u32 phy_reset_problem_count;
75
James Bottomley65c92b02006-06-28 12:22:50 -040076 /* for the list of phys belonging to a port */
77 struct list_head port_siblings;
Darrick J. Wongdea22212006-11-07 17:28:55 -080078
Dan Williams0b3e09d2011-12-20 01:03:48 -080079 /* available to the lldd */
80 void *hostdata;
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020081};
82
83#define dev_to_phy(d) \
84 container_of((d), struct sas_phy, dev)
Tony Jonesee959b02008-02-22 00:13:36 +010085#define transport_class_to_phy(dev) \
86 dev_to_phy((dev)->parent)
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020087#define phy_to_shost(phy) \
88 dev_to_shost((phy)->dev.parent)
89
James Bottomleyb6aff662007-07-20 11:10:05 -050090struct request_queue;
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020091struct sas_rphy {
92 struct device dev;
93 struct sas_identify identify;
94 struct list_head list;
James Bottomleyb6aff662007-07-20 11:10:05 -050095 struct request_queue *q;
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020096 u32 scsi_target_id;
97};
98
99#define dev_to_rphy(d) \
100 container_of((d), struct sas_rphy, dev)
Tony Jonesee959b02008-02-22 00:13:36 +0100101#define transport_class_to_rphy(dev) \
102 dev_to_rphy((dev)->parent)
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200103#define rphy_to_shost(rphy) \
104 dev_to_shost((rphy)->dev.parent)
James Bottomley42ab0362006-03-04 09:10:18 -0600105#define target_to_rphy(targ) \
106 dev_to_rphy((targ)->dev.parent)
107
108struct sas_end_device {
109 struct sas_rphy rphy;
110 /* flags */
111 unsigned ready_led_meaning:1;
James Bottomley0f880092010-01-18 10:14:51 -0600112 unsigned tlr_supported:1;
113 unsigned tlr_enabled:1;
James Bottomley42ab0362006-03-04 09:10:18 -0600114 /* parameters */
115 u16 I_T_nexus_loss_timeout;
116 u16 initiator_response_timeout;
117};
118#define rphy_to_end_device(r) \
119 container_of((r), struct sas_end_device, rphy)
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200120
James Bottomley79cb1812006-03-13 13:50:04 -0600121struct sas_expander_device {
122 int level;
James Bottomleyc9fefeb2006-07-02 11:10:18 -0500123 int next_port_id;
James Bottomley79cb1812006-03-13 13:50:04 -0600124
125 #define SAS_EXPANDER_VENDOR_ID_LEN 8
126 char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
127 #define SAS_EXPANDER_PRODUCT_ID_LEN 16
128 char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
129 #define SAS_EXPANDER_PRODUCT_REV_LEN 4
130 char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
131 #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
132 char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
133 u16 component_id;
134 u8 component_revision_id;
135
136 struct sas_rphy rphy;
137
138};
139#define rphy_to_expander_device(r) \
140 container_of((r), struct sas_expander_device, rphy)
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +0200141
James Bottomley65c92b02006-06-28 12:22:50 -0400142struct sas_port {
143 struct device dev;
144
James Bottomleyc9fefeb2006-07-02 11:10:18 -0500145 int port_identifier;
James Bottomley65c92b02006-06-28 12:22:50 -0400146 int num_phys;
James Bottomleya0e1b6e2006-07-09 12:38:19 -0500147 /* port flags */
148 unsigned int is_backlink:1;
James Bottomley65c92b02006-06-28 12:22:50 -0400149
150 /* the other end of the link */
151 struct sas_rphy *rphy;
152
153 struct mutex phy_list_mutex;
154 struct list_head phy_list;
155};
156
157#define dev_to_sas_port(d) \
158 container_of((d), struct sas_port, dev)
Tony Jonesee959b02008-02-22 00:13:36 +0100159#define transport_class_to_sas_port(dev) \
160 dev_to_sas_port((dev)->parent)
James Bottomley65c92b02006-06-28 12:22:50 -0400161
James Bottomleyd24e1ee2006-09-06 19:25:22 -0500162struct sas_phy_linkrates {
163 enum sas_linkrate maximum_linkrate;
164 enum sas_linkrate minimum_linkrate;
165};
166
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +0200167/* The functions by which the transport class and the driver communicate */
168struct sas_function_template {
169 int (*get_linkerrors)(struct sas_phy *);
Christoph Hellwiga0125642006-02-16 13:31:47 +0100170 int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
171 int (*get_bay_identifier)(struct sas_rphy *);
Christoph Hellwig07ba3a92005-10-19 20:01:31 +0200172 int (*phy_reset)(struct sas_phy *, int);
Darrick J. Wongacbf1672007-01-11 14:14:57 -0800173 int (*phy_enable)(struct sas_phy *, int);
Dan Williams0b3e09d2011-12-20 01:03:48 -0800174 int (*phy_setup)(struct sas_phy *);
175 void (*phy_release)(struct sas_phy *);
James Bottomleyd24e1ee2006-09-06 19:25:22 -0500176 int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
FUJITA Tomonori7aa68e82007-07-09 12:52:06 +0900177 int (*smp_handler)(struct Scsi_Host *, struct sas_rphy *, struct request *);
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +0200178};
179
180
James Bottomley65c92b02006-06-28 12:22:50 -0400181void sas_remove_children(struct device *);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200182extern void sas_remove_host(struct Scsi_Host *);
183
184extern struct sas_phy *sas_phy_alloc(struct device *, int);
185extern void sas_phy_free(struct sas_phy *);
186extern int sas_phy_add(struct sas_phy *);
187extern void sas_phy_delete(struct sas_phy *);
188extern int scsi_is_sas_phy(const struct device *);
189
James Bottomley0f880092010-01-18 10:14:51 -0600190unsigned int sas_tlr_supported(struct scsi_device *);
191unsigned int sas_is_tlr_enabled(struct scsi_device *);
192void sas_disable_tlr(struct scsi_device *);
193void sas_enable_tlr(struct scsi_device *);
194
James Bottomley65c92b02006-06-28 12:22:50 -0400195extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
196extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200197void sas_rphy_free(struct sas_rphy *);
198extern int sas_rphy_add(struct sas_rphy *);
Darrick J. Wong6f63caa2007-01-26 14:08:43 -0800199extern void sas_rphy_remove(struct sas_rphy *);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200200extern void sas_rphy_delete(struct sas_rphy *);
Dan Williams87c83312011-11-17 17:59:51 -0800201extern void sas_rphy_unlink(struct sas_rphy *);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200202extern int scsi_is_sas_rphy(const struct device *);
203
James Bottomley65c92b02006-06-28 12:22:50 -0400204struct sas_port *sas_port_alloc(struct device *, int);
James Bottomleyc9fefeb2006-07-02 11:10:18 -0500205struct sas_port *sas_port_alloc_num(struct device *);
James Bottomley65c92b02006-06-28 12:22:50 -0400206int sas_port_add(struct sas_port *);
207void sas_port_free(struct sas_port *);
208void sas_port_delete(struct sas_port *);
209void sas_port_add_phy(struct sas_port *, struct sas_phy *);
210void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
James Bottomleya0e1b6e2006-07-09 12:38:19 -0500211void sas_port_mark_backlink(struct sas_port *);
James Bottomley65c92b02006-06-28 12:22:50 -0400212int scsi_is_sas_port(const struct device *);
Dan Williamsf41a0c42011-12-21 21:33:17 -0800213struct sas_phy *sas_port_get_phy(struct sas_port *port);
214static inline void sas_port_put_phy(struct sas_phy *phy)
215{
216 if (phy)
217 put_device(&phy->dev);
218}
James Bottomley65c92b02006-06-28 12:22:50 -0400219
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200220extern struct scsi_transport_template *
221sas_attach_transport(struct sas_function_template *);
222extern void sas_release_transport(struct scsi_transport_template *);
James Bottomley42ab0362006-03-04 09:10:18 -0600223int sas_read_port_mode_page(struct scsi_device *);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200224
James Bottomley79cb1812006-03-13 13:50:04 -0600225static inline int
226scsi_is_sas_expander_device(struct device *dev)
227{
228 struct sas_rphy *rphy;
229 if (!scsi_is_sas_rphy(dev))
230 return 0;
231 rphy = dev_to_rphy(dev);
232 return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
233 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
234}
235
James Bottomleyf4ad7b52006-08-25 13:48:18 -0500236#define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
237
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200238#endif /* SCSI_TRANSPORT_SAS_H */