[SCSI] libsas: Add a sysfs knob to enable/disable a phy
[linux-2.6.git] / include / scsi / scsi_transport_sas.h
1 #ifndef SCSI_TRANSPORT_SAS_H
2 #define SCSI_TRANSPORT_SAS_H
3
4 #include <linux/transport_class.h>
5 #include <linux/types.h>
6 #include <linux/mutex.h>
7
8 struct scsi_transport_template;
9 struct sas_rphy;
10
11
12 enum sas_device_type {
13         SAS_PHY_UNUSED,
14         SAS_END_DEVICE,
15         SAS_EDGE_EXPANDER_DEVICE,
16         SAS_FANOUT_EXPANDER_DEVICE,
17 };
18
19 enum sas_protocol {
20         SAS_PROTOCOL_SATA               = 0x01,
21         SAS_PROTOCOL_SMP                = 0x02,
22         SAS_PROTOCOL_STP                = 0x04,
23         SAS_PROTOCOL_SSP                = 0x08,
24 };
25
26 enum sas_linkrate {
27         /* 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,
39         /* These are virtual to the transport class and may never
40          * be signalled normally since the standard defined field
41          * is only 4 bits */
42         SAS_LINK_RATE_FAILED = 0x10,
43         SAS_PHY_VIRTUAL = 0x11,
44 };
45
46 struct sas_identify {
47         enum sas_device_type    device_type;
48         enum sas_protocol       initiator_port_protocols;
49         enum sas_protocol       target_port_protocols;
50         u64                     sas_address;
51         u8                      phy_identifier;
52 };
53
54 struct sas_phy {
55         struct device           dev;
56         int                     number;
57         int                     enabled;
58
59         /* phy identification */
60         struct sas_identify     identify;
61
62         /* phy attributes */
63         enum sas_linkrate       negotiated_linkrate;
64         enum sas_linkrate       minimum_linkrate_hw;
65         enum sas_linkrate       minimum_linkrate;
66         enum sas_linkrate       maximum_linkrate_hw;
67         enum sas_linkrate       maximum_linkrate;
68
69         /* link error statistics */
70         u32                     invalid_dword_count;
71         u32                     running_disparity_error_count;
72         u32                     loss_of_dword_sync_count;
73         u32                     phy_reset_problem_count;
74
75         /* for the list of phys belonging to a port */
76         struct list_head        port_siblings;
77
78         struct work_struct      reset_work;
79 };
80
81 #define dev_to_phy(d) \
82         container_of((d), struct sas_phy, dev)
83 #define transport_class_to_phy(cdev) \
84         dev_to_phy((cdev)->dev)
85 #define phy_to_shost(phy) \
86         dev_to_shost((phy)->dev.parent)
87
88 struct sas_rphy {
89         struct device           dev;
90         struct sas_identify     identify;
91         struct list_head        list;
92         u32                     scsi_target_id;
93 };
94
95 #define dev_to_rphy(d) \
96         container_of((d), struct sas_rphy, dev)
97 #define transport_class_to_rphy(cdev) \
98         dev_to_rphy((cdev)->dev)
99 #define rphy_to_shost(rphy) \
100         dev_to_shost((rphy)->dev.parent)
101 #define target_to_rphy(targ) \
102         dev_to_rphy((targ)->dev.parent)
103
104 struct sas_end_device {
105         struct sas_rphy         rphy;
106         /* flags */
107         unsigned                ready_led_meaning:1;
108         /* parameters */
109         u16                     I_T_nexus_loss_timeout;
110         u16                     initiator_response_timeout;
111 };
112 #define rphy_to_end_device(r) \
113         container_of((r), struct sas_end_device, rphy)
114
115 struct sas_expander_device {
116         int    level;
117         int    next_port_id;
118
119         #define SAS_EXPANDER_VENDOR_ID_LEN      8
120         char   vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
121         #define SAS_EXPANDER_PRODUCT_ID_LEN     16
122         char   product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
123         #define SAS_EXPANDER_PRODUCT_REV_LEN    4
124         char   product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
125         #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN    8
126         char   component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
127         u16    component_id;
128         u8     component_revision_id;
129
130         struct sas_rphy         rphy;
131
132 };
133 #define rphy_to_expander_device(r) \
134         container_of((r), struct sas_expander_device, rphy)
135
136 struct sas_port {
137         struct device           dev;
138
139         int                     port_identifier;
140         int                     num_phys;
141         /* port flags */
142         unsigned int            is_backlink:1;
143
144         /* the other end of the link */
145         struct sas_rphy         *rphy;
146
147         struct mutex            phy_list_mutex;
148         struct list_head        phy_list;
149 };
150
151 #define dev_to_sas_port(d) \
152         container_of((d), struct sas_port, dev)
153 #define transport_class_to_sas_port(cdev) \
154         dev_to_sas_port((cdev)->dev)
155
156 struct sas_phy_linkrates {
157         enum sas_linkrate maximum_linkrate;
158         enum sas_linkrate minimum_linkrate;
159 };
160
161 /* The functions by which the transport class and the driver communicate */
162 struct sas_function_template {
163         int (*get_linkerrors)(struct sas_phy *);
164         int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
165         int (*get_bay_identifier)(struct sas_rphy *);
166         int (*phy_reset)(struct sas_phy *, int);
167         int (*phy_enable)(struct sas_phy *, int);
168         int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
169 };
170
171
172 void sas_remove_children(struct device *);
173 extern void sas_remove_host(struct Scsi_Host *);
174
175 extern struct sas_phy *sas_phy_alloc(struct device *, int);
176 extern void sas_phy_free(struct sas_phy *);
177 extern int sas_phy_add(struct sas_phy *);
178 extern void sas_phy_delete(struct sas_phy *);
179 extern int scsi_is_sas_phy(const struct device *);
180
181 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
182 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
183 void sas_rphy_free(struct sas_rphy *);
184 extern int sas_rphy_add(struct sas_rphy *);
185 extern void sas_rphy_delete(struct sas_rphy *);
186 extern int scsi_is_sas_rphy(const struct device *);
187
188 struct sas_port *sas_port_alloc(struct device *, int);
189 struct sas_port *sas_port_alloc_num(struct device *);
190 int sas_port_add(struct sas_port *);
191 void sas_port_free(struct sas_port *);
192 void sas_port_delete(struct sas_port *);
193 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
194 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
195 void sas_port_mark_backlink(struct sas_port *);
196 int scsi_is_sas_port(const struct device *);
197
198 extern struct scsi_transport_template *
199 sas_attach_transport(struct sas_function_template *);
200 extern void sas_release_transport(struct scsi_transport_template *);
201 int sas_read_port_mode_page(struct scsi_device *);
202
203 static inline int
204 scsi_is_sas_expander_device(struct device *dev)
205 {
206         struct sas_rphy *rphy;
207         if (!scsi_is_sas_rphy(dev))
208                 return 0;
209         rphy = dev_to_rphy(dev);
210         return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
211                 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
212 }
213
214 #define scsi_is_sas_phy_local(phy)      scsi_is_host_device((phy)->dev.parent)
215
216 #endif /* SCSI_TRANSPORT_SAS_H */