Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef SCSI_TRANSPORT_SAS_H
3#define SCSI_TRANSPORT_SAS_H
4
5#include <linux/transport_class.h>
6#include <linux/types.h>
7#include <linux/mutex.h>
8#include <scsi/sas.h>
9#include <linux/bsg-lib.h>
10
11struct scsi_transport_template;
12struct sas_rphy;
13struct request;
14
15#if !IS_ENABLED(CONFIG_SCSI_SAS_ATTRS)
16static inline int scsi_is_sas_rphy(const struct device *sdev)
17{
18 return 0;
19}
20#else
21extern int scsi_is_sas_rphy(const struct device *);
22#endif
23
24static inline int sas_protocol_ata(enum sas_protocol proto)
25{
26 return ((proto & SAS_PROTOCOL_SATA) ||
27 (proto & SAS_PROTOCOL_STP))? 1 : 0;
28}
29
30enum sas_linkrate {
31 /* These Values are defined in the SAS standard */
32 SAS_LINK_RATE_UNKNOWN = 0,
33 SAS_PHY_DISABLED = 1,
34 SAS_PHY_RESET_PROBLEM = 2,
35 SAS_SATA_SPINUP_HOLD = 3,
36 SAS_SATA_PORT_SELECTOR = 4,
37 SAS_PHY_RESET_IN_PROGRESS = 5,
38 SAS_LINK_RATE_1_5_GBPS = 8,
39 SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
40 SAS_LINK_RATE_3_0_GBPS = 9,
41 SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
42 SAS_LINK_RATE_6_0_GBPS = 10,
43 SAS_LINK_RATE_12_0_GBPS = 11,
44 SAS_LINK_RATE_22_5_GBPS = 12,
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
52struct 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
60struct 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 /* available to the lldd */
85 void *hostdata;
86};
87
88#define dev_to_phy(d) \
89 container_of((d), struct sas_phy, dev)
90#define transport_class_to_phy(dev) \
91 dev_to_phy((dev)->parent)
92#define phy_to_shost(phy) \
93 dev_to_shost((phy)->dev.parent)
94
95struct request_queue;
96struct sas_rphy {
97 struct device dev;
98 struct sas_identify identify;
99 struct list_head list;
100 struct request_queue *q;
101 u32 scsi_target_id;
102};
103
104#define dev_to_rphy(d) \
105 container_of((d), struct sas_rphy, dev)
106#define transport_class_to_rphy(dev) \
107 dev_to_rphy((dev)->parent)
108#define rphy_to_shost(rphy) \
109 dev_to_shost((rphy)->dev.parent)
110#define target_to_rphy(targ) \
111 dev_to_rphy((targ)->dev.parent)
112
113struct sas_end_device {
114 struct sas_rphy rphy;
115 /* flags */
116 unsigned ready_led_meaning:1;
117 unsigned tlr_supported:1;
118 unsigned tlr_enabled:1;
119 /* parameters */
120 u16 I_T_nexus_loss_timeout;
121 u16 initiator_response_timeout;
122};
123#define rphy_to_end_device(r) \
124 container_of((r), struct sas_end_device, rphy)
125
126struct sas_expander_device {
127 int level;
128 int next_port_id;
129
130 #define SAS_EXPANDER_VENDOR_ID_LEN 8
131 char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
132 #define SAS_EXPANDER_PRODUCT_ID_LEN 16
133 char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
134 #define SAS_EXPANDER_PRODUCT_REV_LEN 4
135 char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
136 #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
137 char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
138 u16 component_id;
139 u8 component_revision_id;
140
141 struct sas_rphy rphy;
142
143};
144#define rphy_to_expander_device(r) \
145 container_of((r), struct sas_expander_device, rphy)
146
147struct sas_port {
148 struct device dev;
149
150 int port_identifier;
151 int num_phys;
152 /* port flags */
153 unsigned int is_backlink:1;
154
155 /* the other end of the link */
156 struct sas_rphy *rphy;
157
158 struct mutex phy_list_mutex;
159 struct list_head phy_list;
160 struct list_head del_list; /* libsas only */
161};
162
163#define dev_to_sas_port(d) \
164 container_of((d), struct sas_port, dev)
165#define transport_class_to_sas_port(dev) \
166 dev_to_sas_port((dev)->parent)
167
168struct sas_phy_linkrates {
169 enum sas_linkrate maximum_linkrate;
170 enum sas_linkrate minimum_linkrate;
171};
172
173/* The functions by which the transport class and the driver communicate */
174struct sas_function_template {
175 int (*get_linkerrors)(struct sas_phy *);
176 int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
177 int (*get_bay_identifier)(struct sas_rphy *);
178 int (*phy_reset)(struct sas_phy *, int);
179 int (*phy_enable)(struct sas_phy *, int);
180 int (*phy_setup)(struct sas_phy *);
181 void (*phy_release)(struct sas_phy *);
182 int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
183 void (*smp_handler)(struct bsg_job *, struct Scsi_Host *,
184 struct sas_rphy *);
185};
186
187
188void sas_remove_children(struct device *);
189extern void sas_remove_host(struct Scsi_Host *);
190
191extern struct sas_phy *sas_phy_alloc(struct device *, int);
192extern void sas_phy_free(struct sas_phy *);
193extern int sas_phy_add(struct sas_phy *);
194extern void sas_phy_delete(struct sas_phy *);
195extern int scsi_is_sas_phy(const struct device *);
196
197u64 sas_get_address(struct scsi_device *);
198unsigned int sas_tlr_supported(struct scsi_device *);
199unsigned int sas_is_tlr_enabled(struct scsi_device *);
200void sas_disable_tlr(struct scsi_device *);
201void sas_enable_tlr(struct scsi_device *);
202
203extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
204extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
205void sas_rphy_free(struct sas_rphy *);
206extern int sas_rphy_add(struct sas_rphy *);
207extern void sas_rphy_remove(struct sas_rphy *);
208extern void sas_rphy_delete(struct sas_rphy *);
209extern void sas_rphy_unlink(struct sas_rphy *);
210
211struct sas_port *sas_port_alloc(struct device *, int);
212struct sas_port *sas_port_alloc_num(struct device *);
213int sas_port_add(struct sas_port *);
214void sas_port_free(struct sas_port *);
215void sas_port_delete(struct sas_port *);
216void sas_port_add_phy(struct sas_port *, struct sas_phy *);
217void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
218void sas_port_mark_backlink(struct sas_port *);
219int scsi_is_sas_port(const struct device *);
220struct sas_phy *sas_port_get_phy(struct sas_port *port);
221static inline void sas_port_put_phy(struct sas_phy *phy)
222{
223 if (phy)
224 put_device(&phy->dev);
225}
226
227extern struct scsi_transport_template *
228sas_attach_transport(struct sas_function_template *);
229extern void sas_release_transport(struct scsi_transport_template *);
230int sas_read_port_mode_page(struct scsi_device *);
231
232static inline int
233scsi_is_sas_expander_device(struct device *dev)
234{
235 struct sas_rphy *rphy;
236 if (!scsi_is_sas_rphy(dev))
237 return 0;
238 rphy = dev_to_rphy(dev);
239 return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
240 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
241}
242
243#define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
244
245#endif /* 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
9struct scsi_transport_template;
10struct sas_rphy;
11struct request;
12
13static inline int sas_protocol_ata(enum sas_protocol proto)
14{
15 return ((proto & SAS_PROTOCOL_SATA) ||
16 (proto & SAS_PROTOCOL_STP))? 1 : 0;
17}
18
19enum sas_linkrate {
20 /* These Values are defined in the SAS standard */
21 SAS_LINK_RATE_UNKNOWN = 0,
22 SAS_PHY_DISABLED = 1,
23 SAS_PHY_RESET_PROBLEM = 2,
24 SAS_SATA_SPINUP_HOLD = 3,
25 SAS_SATA_PORT_SELECTOR = 4,
26 SAS_PHY_RESET_IN_PROGRESS = 5,
27 SAS_LINK_RATE_1_5_GBPS = 8,
28 SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS,
29 SAS_LINK_RATE_3_0_GBPS = 9,
30 SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS,
31 SAS_LINK_RATE_6_0_GBPS = 10,
32 SAS_LINK_RATE_12_0_GBPS = 11,
33 /* These are virtual to the transport class and may never
34 * be signalled normally since the standard defined field
35 * is only 4 bits */
36 SAS_LINK_RATE_FAILED = 0x10,
37 SAS_PHY_VIRTUAL = 0x11,
38};
39
40struct sas_identify {
41 enum sas_device_type device_type;
42 enum sas_protocol initiator_port_protocols;
43 enum sas_protocol target_port_protocols;
44 u64 sas_address;
45 u8 phy_identifier;
46};
47
48struct sas_phy {
49 struct device dev;
50 int number;
51 int enabled;
52
53 /* phy identification */
54 struct sas_identify identify;
55
56 /* phy attributes */
57 enum sas_linkrate negotiated_linkrate;
58 enum sas_linkrate minimum_linkrate_hw;
59 enum sas_linkrate minimum_linkrate;
60 enum sas_linkrate maximum_linkrate_hw;
61 enum sas_linkrate maximum_linkrate;
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 /* available to the lldd */
73 void *hostdata;
74};
75
76#define dev_to_phy(d) \
77 container_of((d), struct sas_phy, dev)
78#define transport_class_to_phy(dev) \
79 dev_to_phy((dev)->parent)
80#define phy_to_shost(phy) \
81 dev_to_shost((phy)->dev.parent)
82
83struct request_queue;
84struct sas_rphy {
85 struct device dev;
86 struct sas_identify identify;
87 struct list_head list;
88 struct request_queue *q;
89 u32 scsi_target_id;
90};
91
92#define dev_to_rphy(d) \
93 container_of((d), struct sas_rphy, dev)
94#define transport_class_to_rphy(dev) \
95 dev_to_rphy((dev)->parent)
96#define rphy_to_shost(rphy) \
97 dev_to_shost((rphy)->dev.parent)
98#define target_to_rphy(targ) \
99 dev_to_rphy((targ)->dev.parent)
100
101struct sas_end_device {
102 struct sas_rphy rphy;
103 /* flags */
104 unsigned ready_led_meaning:1;
105 unsigned tlr_supported:1;
106 unsigned tlr_enabled:1;
107 /* parameters */
108 u16 I_T_nexus_loss_timeout;
109 u16 initiator_response_timeout;
110};
111#define rphy_to_end_device(r) \
112 container_of((r), struct sas_end_device, rphy)
113
114struct sas_expander_device {
115 int level;
116 int next_port_id;
117
118 #define SAS_EXPANDER_VENDOR_ID_LEN 8
119 char vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
120 #define SAS_EXPANDER_PRODUCT_ID_LEN 16
121 char product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
122 #define SAS_EXPANDER_PRODUCT_REV_LEN 4
123 char product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
124 #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN 8
125 char component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
126 u16 component_id;
127 u8 component_revision_id;
128
129 struct sas_rphy rphy;
130
131};
132#define rphy_to_expander_device(r) \
133 container_of((r), struct sas_expander_device, rphy)
134
135struct sas_port {
136 struct device dev;
137
138 int port_identifier;
139 int num_phys;
140 /* port flags */
141 unsigned int is_backlink:1;
142
143 /* the other end of the link */
144 struct sas_rphy *rphy;
145
146 struct mutex phy_list_mutex;
147 struct list_head phy_list;
148};
149
150#define dev_to_sas_port(d) \
151 container_of((d), struct sas_port, dev)
152#define transport_class_to_sas_port(dev) \
153 dev_to_sas_port((dev)->parent)
154
155struct sas_phy_linkrates {
156 enum sas_linkrate maximum_linkrate;
157 enum sas_linkrate minimum_linkrate;
158};
159
160/* The functions by which the transport class and the driver communicate */
161struct sas_function_template {
162 int (*get_linkerrors)(struct sas_phy *);
163 int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
164 int (*get_bay_identifier)(struct sas_rphy *);
165 int (*phy_reset)(struct sas_phy *, int);
166 int (*phy_enable)(struct sas_phy *, int);
167 int (*phy_setup)(struct sas_phy *);
168 void (*phy_release)(struct sas_phy *);
169 int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
170 int (*smp_handler)(struct Scsi_Host *, struct sas_rphy *, struct request *);
171};
172
173
174void sas_remove_children(struct device *);
175extern void sas_remove_host(struct Scsi_Host *);
176
177extern struct sas_phy *sas_phy_alloc(struct device *, int);
178extern void sas_phy_free(struct sas_phy *);
179extern int sas_phy_add(struct sas_phy *);
180extern void sas_phy_delete(struct sas_phy *);
181extern int scsi_is_sas_phy(const struct device *);
182
183unsigned int sas_tlr_supported(struct scsi_device *);
184unsigned int sas_is_tlr_enabled(struct scsi_device *);
185void sas_disable_tlr(struct scsi_device *);
186void sas_enable_tlr(struct scsi_device *);
187
188extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
189extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
190void sas_rphy_free(struct sas_rphy *);
191extern int sas_rphy_add(struct sas_rphy *);
192extern void sas_rphy_remove(struct sas_rphy *);
193extern void sas_rphy_delete(struct sas_rphy *);
194extern void sas_rphy_unlink(struct sas_rphy *);
195extern int scsi_is_sas_rphy(const struct device *);
196
197struct sas_port *sas_port_alloc(struct device *, int);
198struct sas_port *sas_port_alloc_num(struct device *);
199int sas_port_add(struct sas_port *);
200void sas_port_free(struct sas_port *);
201void sas_port_delete(struct sas_port *);
202void sas_port_add_phy(struct sas_port *, struct sas_phy *);
203void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
204void sas_port_mark_backlink(struct sas_port *);
205int scsi_is_sas_port(const struct device *);
206struct sas_phy *sas_port_get_phy(struct sas_port *port);
207static inline void sas_port_put_phy(struct sas_phy *phy)
208{
209 if (phy)
210 put_device(&phy->dev);
211}
212
213extern struct scsi_transport_template *
214sas_attach_transport(struct sas_function_template *);
215extern void sas_release_transport(struct scsi_transport_template *);
216int sas_read_port_mode_page(struct scsi_device *);
217
218static inline int
219scsi_is_sas_expander_device(struct device *dev)
220{
221 struct sas_rphy *rphy;
222 if (!scsi_is_sas_rphy(dev))
223 return 0;
224 rphy = dev_to_rphy(dev);
225 return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
226 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
227}
228
229#define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent)
230
231#endif /* SCSI_TRANSPORT_SAS_H */