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