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 enum sas_device_type { 14 SAS_PHY_UNUSED = 0, 15 SAS_END_DEVICE = 1, 16 SAS_EDGE_EXPANDER_DEVICE = 2, 17 SAS_FANOUT_EXPANDER_DEVICE = 3, 18 }; 19 20 static inline int sas_protocol_ata(enum sas_protocol proto) 21 { 22 return ((proto & SAS_PROTOCOL_SATA) || 23 (proto & SAS_PROTOCOL_STP))? 1 : 0; 24 } 25 26 enum sas_linkrate { 27 /* These Values are defined in the SAS standard */ 28 SAS_LINK_RATE_UNKNOWN = 0, 29 SAS_PHY_DISABLED = 1, 30 SAS_PHY_RESET_PROBLEM = 2, 31 SAS_SATA_SPINUP_HOLD = 3, 32 SAS_SATA_PORT_SELECTOR = 4, 33 SAS_PHY_RESET_IN_PROGRESS = 5, 34 SAS_LINK_RATE_1_5_GBPS = 8, 35 SAS_LINK_RATE_G1 = SAS_LINK_RATE_1_5_GBPS, 36 SAS_LINK_RATE_3_0_GBPS = 9, 37 SAS_LINK_RATE_G2 = SAS_LINK_RATE_3_0_GBPS, 38 SAS_LINK_RATE_6_0_GBPS = 10, 39 SAS_LINK_RATE_12_0_GBPS = 11, 40 /* These are virtual to the transport class and may never 41 * be signalled normally since the standard defined field 42 * is only 4 bits */ 43 SAS_LINK_RATE_FAILED = 0x10, 44 SAS_PHY_VIRTUAL = 0x11, 45 }; 46 47 struct sas_identify { 48 enum sas_device_type device_type; 49 enum sas_protocol initiator_port_protocols; 50 enum sas_protocol target_port_protocols; 51 u64 sas_address; 52 u8 phy_identifier; 53 }; 54 55 struct sas_phy { 56 struct device dev; 57 int number; 58 int enabled; 59 60 /* phy identification */ 61 struct sas_identify identify; 62 63 /* phy attributes */ 64 enum sas_linkrate negotiated_linkrate; 65 enum sas_linkrate minimum_linkrate_hw; 66 enum sas_linkrate minimum_linkrate; 67 enum sas_linkrate maximum_linkrate_hw; 68 enum sas_linkrate maximum_linkrate; 69 70 /* link error statistics */ 71 u32 invalid_dword_count; 72 u32 running_disparity_error_count; 73 u32 loss_of_dword_sync_count; 74 u32 phy_reset_problem_count; 75 76 /* for the list of phys belonging to a port */ 77 struct list_head port_siblings; 78 79 /* available to the lldd */ 80 void *hostdata; 81 }; 82 83 #define dev_to_phy(d) \ 84 container_of((d), struct sas_phy, dev) 85 #define transport_class_to_phy(dev) \ 86 dev_to_phy((dev)->parent) 87 #define phy_to_shost(phy) \ 88 dev_to_shost((phy)->dev.parent) 89 90 struct request_queue; 91 struct sas_rphy { 92 struct device dev; 93 struct sas_identify identify; 94 struct list_head list; 95 struct request_queue *q; 96 u32 scsi_target_id; 97 }; 98 99 #define dev_to_rphy(d) \ 100 container_of((d), struct sas_rphy, dev) 101 #define transport_class_to_rphy(dev) \ 102 dev_to_rphy((dev)->parent) 103 #define rphy_to_shost(rphy) \ 104 dev_to_shost((rphy)->dev.parent) 105 #define target_to_rphy(targ) \ 106 dev_to_rphy((targ)->dev.parent) 107 108 struct sas_end_device { 109 struct sas_rphy rphy; 110 /* flags */ 111 unsigned ready_led_meaning:1; 112 unsigned tlr_supported:1; 113 unsigned tlr_enabled: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(dev) \ 160 dev_to_sas_port((dev)->parent) 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 (*phy_setup)(struct sas_phy *); 175 void (*phy_release)(struct sas_phy *); 176 int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *); 177 int (*smp_handler)(struct Scsi_Host *, struct sas_rphy *, struct request *); 178 }; 179 180 181 void sas_remove_children(struct device *); 182 extern void sas_remove_host(struct Scsi_Host *); 183 184 extern struct sas_phy *sas_phy_alloc(struct device *, int); 185 extern void sas_phy_free(struct sas_phy *); 186 extern int sas_phy_add(struct sas_phy *); 187 extern void sas_phy_delete(struct sas_phy *); 188 extern int scsi_is_sas_phy(const struct device *); 189 190 unsigned int sas_tlr_supported(struct scsi_device *); 191 unsigned int sas_is_tlr_enabled(struct scsi_device *); 192 void sas_disable_tlr(struct scsi_device *); 193 void sas_enable_tlr(struct scsi_device *); 194 195 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *); 196 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type); 197 void sas_rphy_free(struct sas_rphy *); 198 extern int sas_rphy_add(struct sas_rphy *); 199 extern void sas_rphy_remove(struct sas_rphy *); 200 extern void sas_rphy_delete(struct sas_rphy *); 201 extern void sas_rphy_unlink(struct sas_rphy *); 202 extern int scsi_is_sas_rphy(const struct device *); 203 204 struct sas_port *sas_port_alloc(struct device *, int); 205 struct sas_port *sas_port_alloc_num(struct device *); 206 int sas_port_add(struct sas_port *); 207 void sas_port_free(struct sas_port *); 208 void sas_port_delete(struct sas_port *); 209 void sas_port_add_phy(struct sas_port *, struct sas_phy *); 210 void sas_port_delete_phy(struct sas_port *, struct sas_phy *); 211 void sas_port_mark_backlink(struct sas_port *); 212 int scsi_is_sas_port(const struct device *); 213 struct sas_phy *sas_port_get_phy(struct sas_port *port); 214 static inline void sas_port_put_phy(struct sas_phy *phy) 215 { 216 if (phy) 217 put_device(&phy->dev); 218 } 219 220 extern struct scsi_transport_template * 221 sas_attach_transport(struct sas_function_template *); 222 extern void sas_release_transport(struct scsi_transport_template *); 223 int sas_read_port_mode_page(struct scsi_device *); 224 225 static inline int 226 scsi_is_sas_expander_device(struct device *dev) 227 { 228 struct sas_rphy *rphy; 229 if (!scsi_is_sas_rphy(dev)) 230 return 0; 231 rphy = dev_to_rphy(dev); 232 return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE || 233 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE; 234 } 235 236 #define scsi_is_sas_phy_local(phy) scsi_is_host_device((phy)->dev.parent) 237 238 #endif /* SCSI_TRANSPORT_SAS_H */ 239