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         SAS_LINK_RATE_UNKNOWN,
  28         SAS_PHY_DISABLED,
  29         SAS_LINK_RATE_FAILED,
  30         SAS_SATA_SPINUP_HOLD,
  31         SAS_SATA_PORT_SELECTOR,
  32         SAS_LINK_RATE_1_5_GBPS,
  33         SAS_LINK_RATE_3_0_GBPS,
  34         SAS_LINK_RATE_6_0_GBPS,
  35         SAS_LINK_VIRTUAL,
  36 };
  37
  38 struct sas_identify {
  39         enum sas_device_type    device_type;
  40         enum sas_protocol       initiator_port_protocols;
  41         enum sas_protocol       target_port_protocols;
  42         u64                     sas_address;
  43         u8                      phy_identifier;
  44 };
  45
  46 struct sas_phy {
  47         struct device           dev;
  48         int                     number;
  49
  50         /* phy identification */
  51         struct sas_identify     identify;
  52
  53         /* phy attributes */
  54         enum sas_linkrate       negotiated_linkrate;
  55         enum sas_linkrate       minimum_linkrate_hw;
  56         enum sas_linkrate       minimum_linkrate;
  57         enum sas_linkrate       maximum_linkrate_hw;
  58         enum sas_linkrate       maximum_linkrate;
  59
  60         /* link error statistics */
  61         u32                     invalid_dword_count;
  62         u32                     running_disparity_error_count;
  63         u32                     loss_of_dword_sync_count;
  64         u32                     phy_reset_problem_count;
  65
  66         /* for the list of phys belonging to a port */
  67         struct list_head        port_siblings;
  68 };
  69
  70 #define dev_to_phy(d) \
  71         container_of((d), struct sas_phy, dev)
  72 #define transport_class_to_phy(cdev) \
  73         dev_to_phy((cdev)->dev)
  74 #define phy_to_shost(phy) \
  75         dev_to_shost((phy)->dev.parent)
  76
  77 struct sas_rphy {
  78         struct device           dev;
  79         struct sas_identify     identify;
  80         struct list_head        list;
  81         u32                     scsi_target_id;
  82 };
  83
  84 #define dev_to_rphy(d) \
  85         container_of((d), struct sas_rphy, dev)
  86 #define transport_class_to_rphy(cdev) \
  87         dev_to_rphy((cdev)->dev)
  88 #define rphy_to_shost(rphy) \
  89         dev_to_shost((rphy)->dev.parent)
  90 #define target_to_rphy(targ) \
  91         dev_to_rphy((targ)->dev.parent)
  92
  93 struct sas_end_device {
  94         struct sas_rphy         rphy;
  95         /* flags */
  96         unsigned                ready_led_meaning:1;
  97         /* parameters */
  98         u16                     I_T_nexus_loss_timeout;
  99         u16                     initiator_response_timeout;
 100 };
 101 #define rphy_to_end_device(r) \
 102         container_of((r), struct sas_end_device, rphy)
 103
 104 struct sas_expander_device {
 105         int    level;
 106         int    next_port_id;
 107
 108         #define SAS_EXPANDER_VENDOR_ID_LEN      8
 109         char   vendor_id[SAS_EXPANDER_VENDOR_ID_LEN+1];
 110         #define SAS_EXPANDER_PRODUCT_ID_LEN     16
 111         char   product_id[SAS_EXPANDER_PRODUCT_ID_LEN+1];
 112         #define SAS_EXPANDER_PRODUCT_REV_LEN    4
 113         char   product_rev[SAS_EXPANDER_PRODUCT_REV_LEN+1];
 114         #define SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN    8
 115         char   component_vendor_id[SAS_EXPANDER_COMPONENT_VENDOR_ID_LEN+1];
 116         u16    component_id;
 117         u8     component_revision_id;
 118
 119         struct sas_rphy         rphy;
 120
 121 };
 122 #define rphy_to_expander_device(r) \
 123         container_of((r), struct sas_expander_device, rphy)
 124
 125 struct sas_port {
 126         struct device           dev;
 127
 128         int                     port_identifier;
 129         int                     num_phys;
 130         /* port flags */
 131         unsigned int            is_backlink:1;
 132
 133         /* the other end of the link */
 134         struct sas_rphy         *rphy;
 135
 136         struct mutex            phy_list_mutex;
 137         struct list_head        phy_list;
 138 };
 139
 140 #define dev_to_sas_port(d) \
 141         container_of((d), struct sas_port, dev)
 142 #define transport_class_to_sas_port(cdev) \
 143         dev_to_sas_port((cdev)->dev)
 144
 145 /* The functions by which the transport class and the driver communicate */
 146 struct sas_function_template {
 147         int (*get_linkerrors)(struct sas_phy *);
 148         int (*get_enclosure_identifier)(struct sas_rphy *, u64 *);
 149         int (*get_bay_identifier)(struct sas_rphy *);
 150         int (*phy_reset)(struct sas_phy *, int);
 151 };
 152
 153
 154 void sas_remove_children(struct device *);
 155 extern void sas_remove_host(struct Scsi_Host *);
 156
 157 extern struct sas_phy *sas_phy_alloc(struct device *, int);
 158 extern void sas_phy_free(struct sas_phy *);
 159 extern int sas_phy_add(struct sas_phy *);
 160 extern void sas_phy_delete(struct sas_phy *);
 161 extern int scsi_is_sas_phy(const struct device *);
 162
 163 extern struct sas_rphy *sas_end_device_alloc(struct sas_port *);
 164 extern struct sas_rphy *sas_expander_alloc(struct sas_port *, enum sas_device_type);
 165 void sas_rphy_free(struct sas_rphy *);
 166 extern int sas_rphy_add(struct sas_rphy *);
 167 extern void sas_rphy_delete(struct sas_rphy *);
 168 extern int scsi_is_sas_rphy(const struct device *);
 169
 170 struct sas_port *sas_port_alloc(struct device *, int);
 171 struct sas_port *sas_port_alloc_num(struct device *);
 172 int sas_port_add(struct sas_port *);
 173 void sas_port_free(struct sas_port *);
 174 void sas_port_delete(struct sas_port *);
 175 void sas_port_add_phy(struct sas_port *, struct sas_phy *);
 176 void sas_port_delete_phy(struct sas_port *, struct sas_phy *);
 177 void sas_port_mark_backlink(struct sas_port *);
 178 int scsi_is_sas_port(const struct device *);
 179
 180 extern struct scsi_transport_template *
 181 sas_attach_transport(struct sas_function_template *);
 182 extern void sas_release_transport(struct scsi_transport_template *);
 183 int sas_read_port_mode_page(struct scsi_device *);
 184
 185 static inline int
 186 scsi_is_sas_expander_device(struct device *dev)
 187 {
 188         struct sas_rphy *rphy;
 189         if (!scsi_is_sas_rphy(dev))
 190                 return 0;
 191         rphy = dev_to_rphy(dev);
 192         return rphy->identify.device_type == SAS_FANOUT_EXPANDER_DEVICE ||
 193                 rphy->identify.device_type == SAS_EDGE_EXPANDER_DEVICE;
 194 }
 195
 196 #define scsi_is_sas_phy_local(phy)      scsi_is_host_device((phy)->dev.parent)
 197
 198 #endif /* SCSI_TRANSPORT_SAS_H */