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