[SCSI] eliminate potential kmalloc failure in scsi_get_vpd_page()
[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 #include <scsi/sas.h>
8
9 struct scsi_transport_template;
10 struct sas_rphy;
11 struct request;
12
13 enum sas_device_type {
14         SAS_PHY_UNUSED = 0,
15         SAS_END_DEVICE = 1,
16         SAS_EDGE_EXPANDER_DEVICE = 2,
17         SAS_FANOUT_EXPANDER_DEVICE = 3,
18 };
19
20 static 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
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(dev) \
84         dev_to_phy((dev)->parent)
85 #define phy_to_shost(phy) \
86         dev_to_shost((phy)->dev.parent)
87
88 struct request_queue;
89 struct sas_rphy {
90         struct device           dev;
91         struct sas_identify     identify;
92         struct list_head        list;
93         struct request_queue    *q;
94         u32                     scsi_target_id;
95 };
96
97 #define dev_to_rphy(d) \
98         container_of((d), struct sas_rphy, dev)
99 #define transport_class_to_rphy(dev) \
100         dev_to_rphy((dev)->parent)
101 #define rphy_to_shost(rphy) \
102         dev_to_shost((rphy)->dev.parent)
103 #define target_to_rphy(targ) \
104         dev_to_rphy((targ)->dev.parent)
105
106 struct sas_end_device {
107         struct sas_rphy         rphy;
108         /* flags */
109         unsigned                ready_led_meaning:1;
110         /* parameters */
111         u16                     I_T_nexus_loss_timeout;
112         u16                     initiator_response_timeout;
113 };
114 #define rphy_to_end_device(r) \
115         container_of((r), struct sas_end_device, rphy)
116
117 struct sas_expander_device {
118         int    level;
119         int    next_port_id;
120
121         #define SAS_EXPANDER_VENDOR_ID_LEN      8
122         char   vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
123         #define SAS_EXPANDER_PRODUCT_ID_LEN     16
124         char   product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
125         #define SAS_EXPANDER_PRODUCT_REV_LEN    4
126         char   product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
127         #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN    8
128         char   component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
129         u16    component_id;
130         u8     component_revision_id;
131
132         struct sas_rphy         rphy;
133
134 };
135 #define rphy_to_expander_device(r) \
136         container_of((r), struct sas_expander_device, rphy)
137
138 struct sas_port {
139         struct device           dev;
140
141         int                     port_identifier;
142         int                     num_phys;
143         /* port flags */
144         unsigned int            is_backlink:1;
145
146         /* the other end of the link */
147         struct sas_rphy         *rphy;
148
149         struct mutex            phy_list_mutex;
150         struct list_head        phy_list;
151 };
152
153 #define dev_to_sas_port(d) \
154         container_of((d), struct sas_port, dev)
155 #define transport_class_to_sas_port(dev) \
156         dev_to_sas_port((dev)->parent)
157
158 struct sas_phy_linkrates {
159         enum sas_linkrate maximum_linkrate;
160         enum sas_linkrate minimum_linkrate;
161 };
162
163 /* The functions by which the transport class and the driver communicate */
164 struct sas_function_template {
165         int (*get_linkerrors)(struct sas_phy *);
166         int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
167         int (*get_bay_identifier)(struct sas_rphy *);
168         int (*phy_reset)(struct sas_phy *, int);
169         int (*phy_enable)(struct sas_phy *, int);
170         int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
171         int (*smp_handler)(struct Scsi_Host *, struct sas_rphy *, struct request *);
172 };
173
174
175 void sas_remove_children(struct device *);
176 extern void sas_remove_host(struct Scsi_Host *);
177
178 extern struct sas_phy *sas_phy_alloc(struct device *, int);
179 extern void sas_phy_free(struct sas_phy *);
180 extern int sas_phy_add(struct sas_phy *);
181 extern void sas_phy_delete(struct sas_phy *);
182 extern int scsi_is_sas_phy(const struct device *);
183
184 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
185 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
186 void sas_rphy_free(struct sas_rphy *);
187 extern int sas_rphy_add(struct sas_rphy *);
188 extern void sas_rphy_remove(struct sas_rphy *);
189 extern void sas_rphy_delete(struct sas_rphy *);
190 extern int scsi_is_sas_rphy(const struct device *);
191
192 struct sas_port *sas_port_alloc(struct device *, int);
193 struct sas_port *sas_port_alloc_num(struct device *);
194 int sas_port_add(struct sas_port *);
195 void sas_port_free(struct sas_port *);
196 void sas_port_delete(struct sas_port *);
197 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
198 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
199 void sas_port_mark_backlink(struct sas_port *);
200 int scsi_is_sas_port(const struct device *);
201
202 extern struct scsi_transport_template *
203 sas_attach_transport(struct sas_function_template *);
204 extern void sas_release_transport(struct scsi_transport_template *);
205 int sas_read_port_mode_page(struct scsi_device *);
206
207 static inline int
208 scsi_is_sas_expander_device(struct device *dev)
209 {
210         struct sas_rphy *rphy;
211         if (!scsi_is_sas_rphy(dev))
212                 return 0;
213         rphy = dev_to_rphy(dev);
214         return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
215                 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
216 }
217
218 #define scsi_is_sas_phy_local(phy)      scsi_is_host_device((phy)->dev.parent)
219
220 #endif /* SCSI_TRANSPORT_SAS_H */