blob: f5772ff61d0d406fdb8745b7610b4a30e6295e1b [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>
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +02007
8struct scsi_transport_template;
9struct sas_rphy;
10
11
12enum sas_device_type {
13 SAS_PHY_UNUSED,
14 SAS_END_DEVICE,
15 SAS_EDGE_EXPANDER_DEVICE,
16 SAS_FANOUT_EXPANDER_DEVICE,
17};
18
19enum sas_protocol {
20 SAS_PROTOCOL_SATA = 0x01,
21 SAS_PROTOCOL_SMP = 0x02,
22 SAS_PROTOCOL_STP = 0x04,
23 SAS_PROTOCOL_SSP = 0x08,
24};
25
26enum sas_linkrate {
27 SAS_LINK_RATE_UNKNOWN,
28 SAS_PHY_DISABLED,
29 SAS_LINK_RATE_FAILED,
30 SAS_SATA_SPINUP_HOLD,
31 SAS_SATA_PORT_SELECTOR,
32 SAS_LINK_RATE_1_5_GBPS,
33 SAS_LINK_RATE_3_0_GBPS,
James Bottomley7e6dff62006-03-02 14:12:56 -060034 SAS_LINK_RATE_6_0_GBPS,
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020035 SAS_LINK_VIRTUAL,
36};
37
38struct sas_identify {
39 enum sas_device_type device_type;
40 enum sas_protocol initiator_port_protocols;
41 enum sas_protocol target_port_protocols;
42 u64 sas_address;
43 u8 phy_identifier;
44};
45
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020046struct sas_phy {
47 struct device dev;
48 int number;
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020049
50 /* phy identification */
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020051 struct sas_identify identify;
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020052
53 /* phy attributes */
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020054 enum sas_linkrate negotiated_linkrate;
55 enum sas_linkrate minimum_linkrate_hw;
56 enum sas_linkrate minimum_linkrate;
57 enum sas_linkrate maximum_linkrate_hw;
58 enum sas_linkrate maximum_linkrate;
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020059
Christoph Hellwigac01bbb2005-10-19 20:01:17 +020060 /* internal state */
61 unsigned int local_attached : 1;
62
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +020063 /* link error statistics */
64 u32 invalid_dword_count;
65 u32 running_disparity_error_count;
66 u32 loss_of_dword_sync_count;
67 u32 phy_reset_problem_count;
68
James Bottomley65c92b02006-06-28 12:22:50 -040069 /* for the list of phys belonging to a port */
70 struct list_head port_siblings;
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +020071};
72
73#define dev_to_phy(d) \
74 container_of((d), struct sas_phy, dev)
75#define transport_class_to_phy(cdev) \
76 dev_to_phy((cdev)->dev)
77#define phy_to_shost(phy) \
78 dev_to_shost((phy)->dev.parent)
79
80struct sas_rphy {
81 struct device dev;
82 struct sas_identify identify;
83 struct list_head list;
84 u32 scsi_target_id;
85};
86
87#define dev_to_rphy(d) \
88 container_of((d), struct sas_rphy, dev)
89#define transport_class_to_rphy(cdev) \
90 dev_to_rphy((cdev)->dev)
91#define rphy_to_shost(rphy) \
92 dev_to_shost((rphy)->dev.parent)
James Bottomley42ab0362006-03-04 09:10:18 -060093#define target_to_rphy(targ) \
94 dev_to_rphy((targ)->dev.parent)
95
96struct sas_end_device {
97 struct sas_rphy rphy;
98 /* flags */
99 unsigned ready_led_meaning:1;
100 /* parameters */
101 u16 I_T_nexus_loss_timeout;
102 u16 initiator_response_timeout;
103};
104#define rphy_to_end_device(r) \
105 container_of((r), struct sas_end_device, rphy)
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200106
James Bottomley79cb1812006-03-13 13:50:04 -0600107struct sas_expander_device {
108 int level;
James Bottomleyc9fefeb2006-07-02 11:10:18 -0500109 int next_port_id;
James Bottomley79cb1812006-03-13 13:50:04 -0600110
111 #define SAS_EXPANDER_VENDOR_ID_LEN 8
112 char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
113 #define SAS_EXPANDER_PRODUCT_ID_LEN 16
114 char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
115 #define SAS_EXPANDER_PRODUCT_REV_LEN 4
116 char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
117 #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
118 char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
119 u16 component_id;
120 u8 component_revision_id;
121
122 struct sas_rphy rphy;
123
124};
125#define rphy_to_expander_device(r) \
126 container_of((r), struct sas_expander_device, rphy)
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +0200127
James Bottomley65c92b02006-06-28 12:22:50 -0400128struct sas_port {
129 struct device dev;
130
James Bottomleyc9fefeb2006-07-02 11:10:18 -0500131 int port_identifier;
James Bottomley65c92b02006-06-28 12:22:50 -0400132 int num_phys;
133
134 /* the other end of the link */
135 struct sas_rphy *rphy;
136
137 struct mutex phy_list_mutex;
138 struct list_head phy_list;
139};
140
141#define dev_to_sas_port(d) \
142 container_of((d), struct sas_port, dev)
143#define transport_class_to_sas_port(cdev) \
144 dev_to_sas_port((cdev)->dev)
145
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +0200146/* The functions by which the transport class and the driver communicate */
147struct sas_function_template {
148 int (*get_linkerrors)(struct sas_phy *);
Christoph Hellwiga0125642006-02-16 13:31:47 +0100149 int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
150 int (*get_bay_identifier)(struct sas_rphy *);
Christoph Hellwig07ba3a92005-10-19 20:01:31 +0200151 int (*phy_reset)(struct sas_phy *, int);
Christoph Hellwigc3ee74c2005-09-19 21:59:42 +0200152};
153
154
James Bottomley65c92b02006-06-28 12:22:50 -0400155void sas_remove_children(struct device *);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200156extern void sas_remove_host(struct Scsi_Host *);
157
158extern struct sas_phy *sas_phy_alloc(struct device *, int);
159extern void sas_phy_free(struct sas_phy *);
160extern int sas_phy_add(struct sas_phy *);
161extern void sas_phy_delete(struct sas_phy *);
162extern int scsi_is_sas_phy(const struct device *);
163
James Bottomley65c92b02006-06-28 12:22:50 -0400164extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
165extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200166void sas_rphy_free(struct sas_rphy *);
167extern int sas_rphy_add(struct sas_rphy *);
168extern void sas_rphy_delete(struct sas_rphy *);
169extern int scsi_is_sas_rphy(const struct device *);
170
James Bottomley65c92b02006-06-28 12:22:50 -0400171struct sas_port *sas_port_alloc(struct device *, int);
James Bottomleyc9fefeb2006-07-02 11:10:18 -0500172struct sas_port *sas_port_alloc_num(struct device *);
James Bottomley65c92b02006-06-28 12:22:50 -0400173int sas_port_add(struct sas_port *);
174void sas_port_free(struct sas_port *);
175void sas_port_delete(struct sas_port *);
176void sas_port_add_phy(struct sas_port *, struct sas_phy *);
177void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
178int scsi_is_sas_port(const struct device *);
179
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200180extern struct scsi_transport_template *
181sas_attach_transport(struct sas_function_template *);
182extern void sas_release_transport(struct scsi_transport_template *);
James Bottomley42ab0362006-03-04 09:10:18 -0600183int sas_read_port_mode_page(struct scsi_device *);
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200184
James Bottomley79cb1812006-03-13 13:50:04 -0600185static inline int
186scsi_is_sas_expander_device(struct device *dev)
187{
188 struct sas_rphy *rphy;
189 if (!scsi_is_sas_rphy(dev))
190 return 0;
191 rphy = dev_to_rphy(dev);
192 return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
193 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
194}
195
Christoph Hellwigc7ebbbc2005-09-09 16:22:50 +0200196#endif /* SCSI_TRANSPORT_SAS_H */