include/scsi/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
   8 struct scsi_transport_template;
   9 struct sas_rphy;
  10
  11
  12 enum sas_device_type {
  13         SAS_PHY_UNUSED,
  14         SAS_END_DEVICE,
  15         SAS_EDGE_EXPANDER_DEVICE,
  16         SAS_FANOUT_EXPANDER_DEVICE,
  17 };
  18
  19 enum sas_protocol {
  20         SAS_PROTOCOL_SATA               = 0x01,
  21         SAS_PROTOCOL_SMP                = 0x02,
  22         SAS_PROTOCOL_STP                = 0x04,
  23         SAS_PROTOCOL_SSP                = 0x08,
  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         /* These are virtual to the transport class and may never
  40          * be signalled normally since the standard defined field
  41          * is only 4 bits */
  42         SAS_LINK_RATE_FAILED = 0x10,
  43         SAS_PHY_VIRTUAL = 0x11,
  44 };
  45
  46 struct sas_identify {
  47         enum sas_device_type    device_type;
  48         enum sas_protocol       initiator_port_protocols;
  49         enum sas_protocol       target_port_protocols;
  50         u64                     sas_address;
  51         u8                      phy_identifier;
  52 };
  53
  54 struct sas_phy {
  55         struct device           dev;
  56         int                     number;
  57
  58         /* phy identification */
  59         struct sas_identify     identify;
  60
  61         /* phy attributes */
  62         enum sas_linkrate       negotiated_linkrate;
  63         enum sas_linkrate       minimum_linkrate_hw;
  64         enum sas_linkrate       minimum_linkrate;
  65         enum sas_linkrate       maximum_linkrate_hw;
  66         enum sas_linkrate       maximum_linkrate;
  67
  68         /* link error statistics */
  69         u32                     invalid_dword_count;
  70         u32                     running_disparity_error_count;
  71         u32                     loss_of_dword_sync_count;
  72         u32                     phy_reset_problem_count;
  73
  74         /* for the list of phys belonging to a port */
  75         struct list_head        port_siblings;
  76 };
  77
  78 #define dev_to_phy(d) \
  79         container_of((d), struct sas_phy, dev)
  80 #define transport_class_to_phy(cdev) \
  81         dev_to_phy((cdev)->dev)
  82 #define phy_to_shost(phy) \
  83         dev_to_shost((phy)->dev.parent)
  84
  85 struct sas_rphy {
  86         struct device           dev;
  87         struct sas_identify     identify;
  88         struct list_head        list;
  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(cdev) \
  95         dev_to_rphy((cdev)->dev)
  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         /* parameters */
 106         u16                     I_T_nexus_loss_timeout;
 107         u16                     initiator_response_timeout;
 108 };
 109 #define rphy_to_end_device(r) \
 110         container_of((r), struct sas_end_device, rphy)
 111
 112 struct sas_expander_device {
 113         int    level;
 114         int    next_port_id;
 115
 116         #define SAS_EXPANDER_VENDOR_ID_LEN      8
 117         char   vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
 118         #define SAS_EXPANDER_PRODUCT_ID_LEN     16
 119         char   product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
 120         #define SAS_EXPANDER_PRODUCT_REV_LEN    4
 121         char   product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
 122         #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN    8
 123         char   component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
 124         u16    component_id;
 125         u8     component_revision_id;
 126
 127         struct sas_rphy         rphy;
 128
 129 };
 130 #define rphy_to_expander_device(r) \
 131         container_of((r), struct sas_expander_device, rphy)
 132
 133 struct sas_port {
 134         struct device           dev;
 135
 136         int                     port_identifier;
 137         int                     num_phys;
 138         /* port flags */
 139         unsigned int            is_backlink:1;
 140
 141         /* the other end of the link */
 142         struct sas_rphy         *rphy;
 143
 144         struct mutex            phy_list_mutex;
 145         struct list_head        phy_list;
 146 };
 147
 148 #define dev_to_sas_port(d) \
 149         container_of((d), struct sas_port, dev)
 150 #define transport_class_to_sas_port(cdev) \
 151         dev_to_sas_port((cdev)->dev)
 152
 153 struct sas_phy_linkrates {
 154         enum sas_linkrate maximum_linkrate;
 155         enum sas_linkrate minimum_linkrate;
 156 };
 157
 158 /* The functions by which the transport class and the driver communicate */
 159 struct sas_function_template {
 160         int (*get_linkerrors)(struct sas_phy *);
 161         int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
 162         int (*get_bay_identifier)(struct sas_rphy *);
 163         int (*phy_reset)(struct sas_phy *, int);
 164         int (*set_phy_speed)(struct sas_phy *, struct sas_phy_linkrates *);
 165 };
 166
 167
 168 void sas_remove_children(struct device *);
 169 extern void sas_remove_host(struct Scsi_Host *);
 170
 171 extern struct sas_phy *sas_phy_alloc(struct device *, int);
 172 extern void sas_phy_free(struct sas_phy *);
 173 extern int sas_phy_add(struct sas_phy *);
 174 extern void sas_phy_delete(struct sas_phy *);
 175 extern int scsi_is_sas_phy(const struct device *);
 176
 177 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
 178 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
 179 void sas_rphy_free(struct sas_rphy *);
 180 extern int sas_rphy_add(struct sas_rphy *);
 181 extern void sas_rphy_delete(struct sas_rphy *);
 182 extern int scsi_is_sas_rphy(const struct device *);
 183
 184 struct sas_port *sas_port_alloc(struct device *, int);
 185 struct sas_port *sas_port_alloc_num(struct device *);
 186 int sas_port_add(struct sas_port *);
 187 void sas_port_free(struct sas_port *);
 188 void sas_port_delete(struct sas_port *);
 189 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
 190 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
 191 void sas_port_mark_backlink(struct sas_port *);
 192 int scsi_is_sas_port(const struct device *);
 193
 194 extern struct scsi_transport_template *
 195 sas_attach_transport(struct sas_function_template *);
 196 extern void sas_release_transport(struct scsi_transport_template *);
 197 int sas_read_port_mode_page(struct scsi_device *);
 198
 199 static inline int
 200 scsi_is_sas_expander_device(struct device *dev)
 201 {
 202         struct sas_rphy *rphy;
 203         if (!scsi_is_sas_rphy(dev))
 204                 return 0;
 205         rphy = dev_to_rphy(dev);
 206         return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
 207                 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
 208 }
 209
 210 #define scsi_is_sas_phy_local(phy)      scsi_is_host_device((phy)->dev.parent)
 211
 212 #endif /* SCSI_TRANSPORT_SAS_H */