[SCSI] libsas, aic94xx: fix dma mapping cockups with ATA
[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 static inline int sas_protocol_ata(enum sas_protocol proto)
27 {
28         return ((proto & SAS_PROTOCOL_SATA) ||
29                 (proto & SAS_PROTOCOL_STP))? 1 : 0;
30 }
31
32 enum sas_linkrate {
33         /* These Values are defined in the SAS standard */
34         SAS_LINK_RATE_UNKNOWN = 0,
35         SAS_PHY_DISABLED = 1,
36         SAS_PHY_RESET_PROBLEM = 2,
37         SAS_SATA_SPINUP_HOLD = 3,
38         SAS_SATA_PORT_SELECTOR = 4,
39         SAS_PHY_RESET_IN_PROGRESS = 5,
40         SAS_LINK_RATE_1_5_GBPS = 8,
41         SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
42         SAS_LINK_RATE_3_0_GBPS = 9,
43         SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
44         SAS_LINK_RATE_6_0_GBPS = 10,
45         /* These are virtual to the transport class and may never
46          * be signalled normally since the standard defined field
47          * is only 4 bits */
48         SAS_LINK_RATE_FAILED = 0x10,
49         SAS_PHY_VIRTUAL = 0x11,
50 };
51
52 struct sas_identify {
53         enum sas_device_type    device_type;
54         enum sas_protocol       initiator_port_protocols;
55         enum sas_protocol       target_port_protocols;
56         u64                     sas_address;
57         u8                      phy_identifier;
58 };
59
60 struct sas_phy {
61         struct device           dev;
62         int                     number;
63         int                     enabled;
64
65         /* phy identification */
66         struct sas_identify     identify;
67
68         /* phy attributes */
69         enum sas_linkrate       negotiated_linkrate;
70         enum sas_linkrate       minimum_linkrate_hw;
71         enum sas_linkrate       minimum_linkrate;
72         enum sas_linkrate       maximum_linkrate_hw;
73         enum sas_linkrate       maximum_linkrate;
74
75         /* link error statistics */
76         u32                     invalid_dword_count;
77         u32                     running_disparity_error_count;
78         u32                     loss_of_dword_sync_count;
79         u32                     phy_reset_problem_count;
80
81         /* for the list of phys belonging to a port */
82         struct list_head        port_siblings;
83
84         struct work_struct      reset_work;
85 };
86
87 #define dev_to_phy(d) \
88         container_of((d), struct sas_phy, dev)
89 #define transport_class_to_phy(cdev) \
90         dev_to_phy((cdev)->dev)
91 #define phy_to_shost(phy) \
92         dev_to_shost((phy)->dev.parent)
93
94 struct sas_rphy {
95         struct device           dev;
96         struct sas_identify     identify;
97         struct list_head        list;
98         u32                     scsi_target_id;
99 };
100
101 #define dev_to_rphy(d) \
102         container_of((d), struct sas_rphy, dev)
103 #define transport_class_to_rphy(cdev) \
104         dev_to_rphy((cdev)->dev)
105 #define rphy_to_shost(rphy) \
106         dev_to_shost((rphy)->dev.parent)
107 #define target_to_rphy(targ) \
108         dev_to_rphy((targ)->dev.parent)
109
110 struct sas_end_device {
111         struct sas_rphy         rphy;
112         /* flags */
113         unsigned                ready_led_meaning:1;
114         /* 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)
120
121 struct sas_expander_device {
122         int    level;
123         int    next_port_id;
124
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)
141
142 struct sas_port {
143         struct device           dev;
144
145         int                     port_identifier;
146         int                     num_phys;
147         /* port flags */
148         unsigned int            is_backlink:1;
149
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)
159 #define transport_class_to_sas_port(cdev) \
160         dev_to_sas_port((cdev)->dev)
161
162 struct sas_phy_linkrates {
163         enum sas_linkrate maximum_linkrate;
164         enum sas_linkrate minimum_linkrate;
165 };
166
167 /* The functions by which the transport class and the driver communicate */
168 struct sas_function_template {
169         int (*get_linkerrors)(struct sas_phy *);
170         int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
171         int (*get_bay_identifier)(struct sas_rphy *);
172         int (*phy_reset)(struct sas_phy *, int);
173         int (*phy_enable)(struct sas_phy *, int);
174         int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
175 };
176
177
178 void sas_remove_children(struct device *);
179 extern void sas_remove_host(struct Scsi_Host *);
180
181 extern struct sas_phy *sas_phy_alloc(struct device *, int);
182 extern void sas_phy_free(struct sas_phy *);
183 extern int sas_phy_add(struct sas_phy *);
184 extern void sas_phy_delete(struct sas_phy *);
185 extern int scsi_is_sas_phy(const struct device *);
186
187 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
188 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
189 void sas_rphy_free(struct sas_rphy *);
190 extern int sas_rphy_add(struct sas_rphy *);
191 extern void sas_rphy_remove(struct sas_rphy *);
192 extern void sas_rphy_delete(struct sas_rphy *);
193 extern int scsi_is_sas_rphy(const struct device *);
194
195 struct sas_port *sas_port_alloc(struct device *, int);
196 struct sas_port *sas_port_alloc_num(struct device *);
197 int sas_port_add(struct sas_port *);
198 void sas_port_free(struct sas_port *);
199 void sas_port_delete(struct sas_port *);
200 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
201 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
202 void sas_port_mark_backlink(struct sas_port *);
203 int scsi_is_sas_port(const struct device *);
204
205 extern struct scsi_transport_template *
206 sas_attach_transport(struct sas_function_template *);
207 extern void sas_release_transport(struct scsi_transport_template *);
208 int sas_read_port_mode_page(struct scsi_device *);
209
210 static inline int
211 scsi_is_sas_expander_device(struct device *dev)
212 {
213         struct sas_rphy *rphy;
214         if (!scsi_is_sas_rphy(dev))
215                 return 0;
216         rphy = dev_to_rphy(dev);
217         return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
218                 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
219 }
220
221 #define scsi_is_sas_phy_local(phy)      scsi_is_host_device((phy)->dev.parent)
222
223 #endif /* SCSI_TRANSPORT_SAS_H */