[SCSI] scsi_transport_sas: introduce a sas_port entity
[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         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,
34         SAS_LINK_RATE_6_0_GBPS,
35         SAS_LINK_VIRTUAL,
36 };
37
38 struct 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
46 struct sas_phy {
47         struct device           dev;
48         int                     number;
49
50         /* phy identification */
51         struct sas_identify     identify;
52
53         /* phy attributes */
54         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;
59
60         /* internal state */
61         unsigned int            local_attached : 1;
62
63         /* 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
69         /* for the list of phys belonging to a port */
70         struct list_head        port_siblings;
71 };
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
80 struct 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)
93 #define target_to_rphy(targ) \
94         dev_to_rphy((targ)->dev.parent)
95
96 struct 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)
106
107 struct sas_expander_device {
108         int    level;
109
110         #define SAS_EXPANDER_VENDOR_ID_LEN      8
111         char   vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
112         #define SAS_EXPANDER_PRODUCT_ID_LEN     16
113         char   product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
114         #define SAS_EXPANDER_PRODUCT_REV_LEN    4
115         char   product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
116         #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN    8
117         char   component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
118         u16    component_id;
119         u8     component_revision_id;
120
121         struct sas_rphy         rphy;
122
123 };
124 #define rphy_to_expander_device(r) \
125         container_of((r), struct sas_expander_device, rphy)
126
127 struct sas_port {
128         struct device           dev;
129
130         u8                      port_identifier;
131         int                     num_phys;
132
133         /* the other end of the link */
134         struct sas_rphy         *rphy;
135
136         struct mutex            phy_list_mutex;
137         struct list_head        phy_list;
138 };
139
140 #define dev_to_sas_port(d) \
141         container_of((d), struct sas_port, dev)
142 #define transport_class_to_sas_port(cdev) \
143         dev_to_sas_port((cdev)->dev)
144
145 /* The functions by which the transport class and the driver communicate */
146 struct sas_function_template {
147         int (*get_linkerrors)(struct sas_phy *);
148         int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
149         int (*get_bay_identifier)(struct sas_rphy *);
150         int (*phy_reset)(struct sas_phy *, int);
151 };
152
153
154 void sas_remove_children(struct device *);
155 extern void sas_remove_host(struct Scsi_Host *);
156
157 extern struct sas_phy *sas_phy_alloc(struct device *, int);
158 extern void sas_phy_free(struct sas_phy *);
159 extern int sas_phy_add(struct sas_phy *);
160 extern void sas_phy_delete(struct sas_phy *);
161 extern int scsi_is_sas_phy(const struct device *);
162
163 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
164 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
165 void sas_rphy_free(struct sas_rphy *);
166 extern int sas_rphy_add(struct sas_rphy *);
167 extern void sas_rphy_delete(struct sas_rphy *);
168 extern int scsi_is_sas_rphy(const struct device *);
169
170 struct sas_port *sas_port_alloc(struct device *, int);
171 int sas_port_add(struct sas_port *);
172 void sas_port_free(struct sas_port *);
173 void sas_port_delete(struct sas_port *);
174 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
175 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
176 int scsi_is_sas_port(const struct device *);
177
178 extern struct scsi_transport_template *
179 sas_attach_transport(struct sas_function_template *);
180 extern void sas_release_transport(struct scsi_transport_template *);
181 int sas_read_port_mode_page(struct scsi_device *);
182
183 static inline int
184 scsi_is_sas_expander_device(struct device *dev)
185 {
186         struct sas_rphy *rphy;
187         if (!scsi_is_sas_rphy(dev))
188                 return 0;
189         rphy = dev_to_rphy(dev);
190         return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
191                 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
192 }
193
194 #endif /* SCSI_TRANSPORT_SAS_H */