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 static 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 19 enum 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 40 struct 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 48 struct 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 83 struct request_queue; 84 struct 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 101 struct 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 114 struct 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 135 struct 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 155 struct 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 */ 161 struct 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 174 void sas_remove_children(struct device *); 175 extern void sas_remove_host(struct Scsi_Host *); 176 177 extern struct sas_phy *sas_phy_alloc(struct device *, int); 178 extern void sas_phy_free(struct sas_phy *); 179 extern int sas_phy_add(struct sas_phy *); 180 extern void sas_phy_delete(struct sas_phy *); 181 extern int scsi_is_sas_phy(const struct device *); 182 183 unsigned int sas_tlr_supported(struct scsi_device *); 184 unsigned int sas_is_tlr_enabled(struct scsi_device *); 185 void sas_disable_tlr(struct scsi_device *); 186 void sas_enable_tlr(struct scsi_device *); 187 188 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *); 189 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type); 190 void sas_rphy_free(struct sas_rphy *); 191 extern int sas_rphy_add(struct sas_rphy *); 192 extern void sas_rphy_remove(struct sas_rphy *); 193 extern void sas_rphy_delete(struct sas_rphy *); 194 extern void sas_rphy_unlink(struct sas_rphy *); 195 extern int scsi_is_sas_rphy(const struct device *); 196 197 struct sas_port *sas_port_alloc(struct device *, int); 198 struct sas_port *sas_port_alloc_num(struct device *); 199 int sas_port_add(struct sas_port *); 200 void sas_port_free(struct sas_port *); 201 void sas_port_delete(struct sas_port *); 202 void sas_port_add_phy(struct sas_port *, struct sas_phy *); 203 void sas_port_delete_phy(struct sas_port *, struct sas_phy *); 204 void sas_port_mark_backlink(struct sas_port *); 205 int scsi_is_sas_port(const struct device *); 206 struct sas_phy *sas_port_get_phy(struct sas_port *port); 207 static inline void sas_port_put_phy(struct sas_phy *phy) 208 { 209 if (phy) 210 put_device(&phy->dev); 211 } 212 213 extern struct scsi_transport_template * 214 sas_attach_transport(struct sas_function_template *); 215 extern void sas_release_transport(struct scsi_transport_template *); 216 int sas_read_port_mode_page(struct scsi_device *); 217 218 static inline int 219 scsi_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 */ 232