1 /* 2 * Copyright (c) 2015 Linaro Ltd. 3 * Copyright (c) 2015 Hisilicon Limited. 4 * 5 * This program is free software; you can redistribute it and/or modify 6 * it under the terms of the GNU General Public License as published by 7 * the Free Software Foundation; either version 2 of the License, or 8 * (at your option) any later version. 9 * 10 */ 11 12 #ifndef _HISI_SAS_H_ 13 #define _HISI_SAS_H_ 14 15 #include <linux/acpi.h> 16 #include <linux/clk.h> 17 #include <linux/dmapool.h> 18 #include <linux/iopoll.h> 19 #include <linux/mfd/syscon.h> 20 #include <linux/module.h> 21 #include <linux/of_address.h> 22 #include <linux/pci.h> 23 #include <linux/platform_device.h> 24 #include <linux/property.h> 25 #include <linux/regmap.h> 26 #include <scsi/sas_ata.h> 27 #include <scsi/libsas.h> 28 29 #define HISI_SAS_MAX_PHYS 9 30 #define HISI_SAS_MAX_QUEUES 32 31 #define HISI_SAS_QUEUE_SLOTS 512 32 #define HISI_SAS_MAX_ITCT_ENTRIES 1024 33 #define HISI_SAS_MAX_DEVICES HISI_SAS_MAX_ITCT_ENTRIES 34 #define HISI_SAS_RESET_BIT 0 35 #define HISI_SAS_REJECT_CMD_BIT 1 36 37 #define HISI_SAS_STATUS_BUF_SZ (sizeof(struct hisi_sas_status_buffer)) 38 #define HISI_SAS_COMMAND_TABLE_SZ (sizeof(union hisi_sas_command_table)) 39 40 #define hisi_sas_status_buf_addr(buf) \ 41 (buf + offsetof(struct hisi_sas_slot_buf_table, status_buffer)) 42 #define hisi_sas_status_buf_addr_mem(slot) hisi_sas_status_buf_addr(slot->buf) 43 #define hisi_sas_status_buf_addr_dma(slot) \ 44 hisi_sas_status_buf_addr(slot->buf_dma) 45 46 #define hisi_sas_cmd_hdr_addr(buf) \ 47 (buf + offsetof(struct hisi_sas_slot_buf_table, command_header)) 48 #define hisi_sas_cmd_hdr_addr_mem(slot) hisi_sas_cmd_hdr_addr(slot->buf) 49 #define hisi_sas_cmd_hdr_addr_dma(slot) hisi_sas_cmd_hdr_addr(slot->buf_dma) 50 51 #define hisi_sas_sge_addr(buf) \ 52 (buf + offsetof(struct hisi_sas_slot_buf_table, sge_page)) 53 #define hisi_sas_sge_addr_mem(slot) hisi_sas_sge_addr(slot->buf) 54 #define hisi_sas_sge_addr_dma(slot) hisi_sas_sge_addr(slot->buf_dma) 55 56 #define HISI_SAS_MAX_SSP_RESP_SZ (sizeof(struct ssp_frame_hdr) + 1024) 57 #define HISI_SAS_MAX_SMP_RESP_SZ 1028 58 #define HISI_SAS_MAX_STP_RESP_SZ 28 59 60 #define DEV_IS_EXPANDER(type) \ 61 ((type == SAS_EDGE_EXPANDER_DEVICE) || \ 62 (type == SAS_FANOUT_EXPANDER_DEVICE)) 63 64 #define HISI_SAS_SATA_PROTOCOL_NONDATA 0x1 65 #define HISI_SAS_SATA_PROTOCOL_PIO 0x2 66 #define HISI_SAS_SATA_PROTOCOL_DMA 0x4 67 #define HISI_SAS_SATA_PROTOCOL_FPDMA 0x8 68 #define HISI_SAS_SATA_PROTOCOL_ATAPI 0x10 69 70 struct hisi_hba; 71 72 enum { 73 PORT_TYPE_SAS = (1U << 1), 74 PORT_TYPE_SATA = (1U << 0), 75 }; 76 77 enum dev_status { 78 HISI_SAS_DEV_NORMAL, 79 HISI_SAS_DEV_EH, 80 }; 81 82 enum { 83 HISI_SAS_INT_ABT_CMD = 0, 84 HISI_SAS_INT_ABT_DEV = 1, 85 }; 86 87 enum hisi_sas_dev_type { 88 HISI_SAS_DEV_TYPE_STP = 0, 89 HISI_SAS_DEV_TYPE_SSP, 90 HISI_SAS_DEV_TYPE_SATA, 91 }; 92 93 struct hisi_sas_hw_error { 94 u32 irq_msk; 95 u32 msk; 96 int shift; 97 const char *msg; 98 int reg; 99 const struct hisi_sas_hw_error *sub; 100 }; 101 102 struct hisi_sas_rst { 103 struct hisi_hba *hisi_hba; 104 struct completion *completion; 105 struct work_struct work; 106 bool done; 107 }; 108 109 #define HISI_SAS_RST_WORK_INIT(r, c) \ 110 { .hisi_hba = hisi_hba, \ 111 .completion = &c, \ 112 .work = __WORK_INITIALIZER(r.work, \ 113 hisi_sas_sync_rst_work_handler), \ 114 .done = false, \ 115 } 116 117 #define HISI_SAS_DECLARE_RST_WORK_ON_STACK(r) \ 118 DECLARE_COMPLETION_ONSTACK(c); \ 119 DECLARE_WORK(w, hisi_sas_sync_rst_work_handler); \ 120 struct hisi_sas_rst r = HISI_SAS_RST_WORK_INIT(r, c) 121 122 enum hisi_sas_bit_err_type { 123 HISI_SAS_ERR_SINGLE_BIT_ECC = 0x0, 124 HISI_SAS_ERR_MULTI_BIT_ECC = 0x1, 125 }; 126 127 enum hisi_sas_phy_event { 128 HISI_PHYE_PHY_UP = 0U, 129 HISI_PHYE_LINK_RESET, 130 HISI_PHYES_NUM, 131 }; 132 133 struct hisi_sas_phy { 134 struct work_struct works[HISI_PHYES_NUM]; 135 struct hisi_hba *hisi_hba; 136 struct hisi_sas_port *port; 137 struct asd_sas_phy sas_phy; 138 struct sas_identify identify; 139 u64 port_id; /* from hw */ 140 u64 dev_sas_addr; 141 u64 frame_rcvd_size; 142 u8 frame_rcvd[32]; 143 u8 phy_attached; 144 u8 reserved[3]; 145 u32 phy_type; 146 enum sas_linkrate minimum_linkrate; 147 enum sas_linkrate maximum_linkrate; 148 }; 149 150 struct hisi_sas_port { 151 struct asd_sas_port sas_port; 152 u8 port_attached; 153 u8 id; /* from hw */ 154 }; 155 156 struct hisi_sas_cq { 157 struct hisi_hba *hisi_hba; 158 struct tasklet_struct tasklet; 159 int rd_point; 160 int id; 161 }; 162 163 struct hisi_sas_dq { 164 struct hisi_hba *hisi_hba; 165 struct hisi_sas_slot *slot_prep; 166 spinlock_t lock; 167 int wr_point; 168 int id; 169 }; 170 171 struct hisi_sas_device { 172 struct hisi_hba *hisi_hba; 173 struct domain_device *sas_device; 174 struct completion *completion; 175 struct hisi_sas_dq *dq; 176 struct list_head list; 177 u64 attached_phy; 178 atomic64_t running_req; 179 enum sas_device_type dev_type; 180 int device_id; 181 int sata_idx; 182 u8 dev_status; 183 }; 184 185 struct hisi_sas_slot { 186 struct list_head entry; 187 struct sas_task *task; 188 struct hisi_sas_port *port; 189 u64 n_elem; 190 int dlvry_queue; 191 int dlvry_queue_slot; 192 int cmplt_queue; 193 int cmplt_queue_slot; 194 int idx; 195 int abort; 196 void *buf; 197 dma_addr_t buf_dma; 198 void *cmd_hdr; 199 dma_addr_t cmd_hdr_dma; 200 struct work_struct abort_slot; 201 struct timer_list internal_abort_timer; 202 }; 203 204 struct hisi_sas_tmf_task { 205 u8 tmf; 206 u16 tag_of_task_to_be_managed; 207 }; 208 209 struct hisi_sas_hw { 210 int (*hw_init)(struct hisi_hba *hisi_hba); 211 void (*setup_itct)(struct hisi_hba *hisi_hba, 212 struct hisi_sas_device *device); 213 int (*slot_index_alloc)(struct hisi_hba *hisi_hba, int *slot_idx, 214 struct domain_device *device); 215 struct hisi_sas_device *(*alloc_dev)(struct domain_device *device); 216 void (*sl_notify)(struct hisi_hba *hisi_hba, int phy_no); 217 int (*get_free_slot)(struct hisi_hba *hisi_hba, struct hisi_sas_dq *dq); 218 void (*start_delivery)(struct hisi_sas_dq *dq); 219 int (*prep_ssp)(struct hisi_hba *hisi_hba, 220 struct hisi_sas_slot *slot, int is_tmf, 221 struct hisi_sas_tmf_task *tmf); 222 int (*prep_smp)(struct hisi_hba *hisi_hba, 223 struct hisi_sas_slot *slot); 224 int (*prep_stp)(struct hisi_hba *hisi_hba, 225 struct hisi_sas_slot *slot); 226 int (*prep_abort)(struct hisi_hba *hisi_hba, 227 struct hisi_sas_slot *slot, 228 int device_id, int abort_flag, int tag_to_abort); 229 int (*slot_complete)(struct hisi_hba *hisi_hba, 230 struct hisi_sas_slot *slot); 231 void (*phys_init)(struct hisi_hba *hisi_hba); 232 void (*phy_start)(struct hisi_hba *hisi_hba, int phy_no); 233 void (*phy_disable)(struct hisi_hba *hisi_hba, int phy_no); 234 void (*phy_hard_reset)(struct hisi_hba *hisi_hba, int phy_no); 235 void (*get_events)(struct hisi_hba *hisi_hba, int phy_no); 236 void (*phy_set_linkrate)(struct hisi_hba *hisi_hba, int phy_no, 237 struct sas_phy_linkrates *linkrates); 238 enum sas_linkrate (*phy_get_max_linkrate)(void); 239 void (*clear_itct)(struct hisi_hba *hisi_hba, 240 struct hisi_sas_device *dev); 241 void (*free_device)(struct hisi_sas_device *sas_dev); 242 int (*get_wideport_bitmap)(struct hisi_hba *hisi_hba, int port_id); 243 void (*dereg_device)(struct hisi_hba *hisi_hba, 244 struct domain_device *device); 245 int (*soft_reset)(struct hisi_hba *hisi_hba); 246 u32 (*get_phys_state)(struct hisi_hba *hisi_hba); 247 int (*write_gpio)(struct hisi_hba *hisi_hba, u8 reg_type, 248 u8 reg_index, u8 reg_count, u8 *write_data); 249 int max_command_entries; 250 int complete_hdr_size; 251 }; 252 253 struct hisi_hba { 254 /* This must be the first element, used by SHOST_TO_SAS_HA */ 255 struct sas_ha_struct *p; 256 257 struct platform_device *platform_dev; 258 struct pci_dev *pci_dev; 259 struct device *dev; 260 261 void __iomem *regs; 262 void __iomem *sgpio_regs; 263 struct regmap *ctrl; 264 u32 ctrl_reset_reg; 265 u32 ctrl_reset_sts_reg; 266 u32 ctrl_clock_ena_reg; 267 u32 refclk_frequency_mhz; 268 u8 sas_addr[SAS_ADDR_SIZE]; 269 270 int n_phy; 271 spinlock_t lock; 272 273 struct timer_list timer; 274 struct workqueue_struct *wq; 275 276 int slot_index_count; 277 unsigned long *slot_index_tags; 278 unsigned long reject_stp_links_msk; 279 280 /* SCSI/SAS glue */ 281 struct sas_ha_struct sha; 282 struct Scsi_Host *shost; 283 284 struct hisi_sas_cq cq[HISI_SAS_MAX_QUEUES]; 285 struct hisi_sas_dq dq[HISI_SAS_MAX_QUEUES]; 286 struct hisi_sas_phy phy[HISI_SAS_MAX_PHYS]; 287 struct hisi_sas_port port[HISI_SAS_MAX_PHYS]; 288 289 int queue_count; 290 291 struct dma_pool *buffer_pool; 292 struct hisi_sas_device devices[HISI_SAS_MAX_DEVICES]; 293 struct hisi_sas_cmd_hdr *cmd_hdr[HISI_SAS_MAX_QUEUES]; 294 dma_addr_t cmd_hdr_dma[HISI_SAS_MAX_QUEUES]; 295 void *complete_hdr[HISI_SAS_MAX_QUEUES]; 296 dma_addr_t complete_hdr_dma[HISI_SAS_MAX_QUEUES]; 297 struct hisi_sas_initial_fis *initial_fis; 298 dma_addr_t initial_fis_dma; 299 struct hisi_sas_itct *itct; 300 dma_addr_t itct_dma; 301 struct hisi_sas_iost *iost; 302 dma_addr_t iost_dma; 303 struct hisi_sas_breakpoint *breakpoint; 304 dma_addr_t breakpoint_dma; 305 struct hisi_sas_breakpoint *sata_breakpoint; 306 dma_addr_t sata_breakpoint_dma; 307 struct hisi_sas_slot *slot_info; 308 unsigned long flags; 309 const struct hisi_sas_hw *hw; /* Low level hw interface */ 310 unsigned long sata_dev_bitmap[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES)]; 311 struct work_struct rst_work; 312 }; 313 314 /* Generic HW DMA host memory structures */ 315 /* Delivery queue header */ 316 struct hisi_sas_cmd_hdr { 317 /* dw0 */ 318 __le32 dw0; 319 320 /* dw1 */ 321 __le32 dw1; 322 323 /* dw2 */ 324 __le32 dw2; 325 326 /* dw3 */ 327 __le32 transfer_tags; 328 329 /* dw4 */ 330 __le32 data_transfer_len; 331 332 /* dw5 */ 333 __le32 first_burst_num; 334 335 /* dw6 */ 336 __le32 sg_len; 337 338 /* dw7 */ 339 __le32 dw7; 340 341 /* dw8-9 */ 342 __le64 cmd_table_addr; 343 344 /* dw10-11 */ 345 __le64 sts_buffer_addr; 346 347 /* dw12-13 */ 348 __le64 prd_table_addr; 349 350 /* dw14-15 */ 351 __le64 dif_prd_table_addr; 352 }; 353 354 struct hisi_sas_itct { 355 __le64 qw0; 356 __le64 sas_addr; 357 __le64 qw2; 358 __le64 qw3; 359 __le64 qw4_15[12]; 360 }; 361 362 struct hisi_sas_iost { 363 __le64 qw0; 364 __le64 qw1; 365 __le64 qw2; 366 __le64 qw3; 367 }; 368 369 struct hisi_sas_err_record { 370 u32 data[4]; 371 }; 372 373 struct hisi_sas_initial_fis { 374 struct hisi_sas_err_record err_record; 375 struct dev_to_host_fis fis; 376 u32 rsvd[3]; 377 }; 378 379 struct hisi_sas_breakpoint { 380 u8 data[128]; 381 }; 382 383 struct hisi_sas_sata_breakpoint { 384 struct hisi_sas_breakpoint tag[32]; 385 }; 386 387 struct hisi_sas_sge { 388 __le64 addr; 389 __le32 page_ctrl_0; 390 __le32 page_ctrl_1; 391 __le32 data_len; 392 __le32 data_off; 393 }; 394 395 struct hisi_sas_command_table_smp { 396 u8 bytes[44]; 397 }; 398 399 struct hisi_sas_command_table_stp { 400 struct host_to_dev_fis command_fis; 401 u8 dummy[12]; 402 u8 atapi_cdb[ATAPI_CDB_LEN]; 403 }; 404 405 #define HISI_SAS_SGE_PAGE_CNT SG_CHUNK_SIZE 406 struct hisi_sas_sge_page { 407 struct hisi_sas_sge sge[HISI_SAS_SGE_PAGE_CNT]; 408 } __aligned(16); 409 410 struct hisi_sas_command_table_ssp { 411 struct ssp_frame_hdr hdr; 412 union { 413 struct { 414 struct ssp_command_iu task; 415 u32 prot[6]; 416 }; 417 struct ssp_tmf_iu ssp_task; 418 struct xfer_rdy_iu xfer_rdy; 419 struct ssp_response_iu ssp_res; 420 } u; 421 }; 422 423 union hisi_sas_command_table { 424 struct hisi_sas_command_table_ssp ssp; 425 struct hisi_sas_command_table_smp smp; 426 struct hisi_sas_command_table_stp stp; 427 } __aligned(16); 428 429 struct hisi_sas_status_buffer { 430 struct hisi_sas_err_record err; 431 u8 iu[1024]; 432 } __aligned(16); 433 434 struct hisi_sas_slot_buf_table { 435 struct hisi_sas_status_buffer status_buffer; 436 union hisi_sas_command_table command_header; 437 struct hisi_sas_sge_page sge_page; 438 }; 439 440 extern struct scsi_transport_template *hisi_sas_stt; 441 extern struct scsi_host_template *hisi_sas_sht; 442 443 extern void hisi_sas_stop_phys(struct hisi_hba *hisi_hba); 444 extern void hisi_sas_init_add(struct hisi_hba *hisi_hba); 445 extern int hisi_sas_alloc(struct hisi_hba *hisi_hba, struct Scsi_Host *shost); 446 extern void hisi_sas_free(struct hisi_hba *hisi_hba); 447 extern u8 hisi_sas_get_ata_protocol(struct host_to_dev_fis *fis, 448 int direction); 449 extern struct hisi_sas_port *to_hisi_sas_port(struct asd_sas_port *sas_port); 450 extern void hisi_sas_sata_done(struct sas_task *task, 451 struct hisi_sas_slot *slot); 452 extern int hisi_sas_get_ncq_tag(struct sas_task *task, u32 *tag); 453 extern int hisi_sas_get_fw_info(struct hisi_hba *hisi_hba); 454 extern int hisi_sas_probe(struct platform_device *pdev, 455 const struct hisi_sas_hw *ops); 456 extern int hisi_sas_remove(struct platform_device *pdev); 457 458 extern void hisi_sas_phy_down(struct hisi_hba *hisi_hba, int phy_no, int rdy); 459 extern void hisi_sas_slot_task_free(struct hisi_hba *hisi_hba, 460 struct sas_task *task, 461 struct hisi_sas_slot *slot); 462 extern void hisi_sas_init_mem(struct hisi_hba *hisi_hba); 463 extern void hisi_sas_rst_work_handler(struct work_struct *work); 464 extern void hisi_sas_sync_rst_work_handler(struct work_struct *work); 465 extern void hisi_sas_kill_tasklets(struct hisi_hba *hisi_hba); 466 extern bool hisi_sas_notify_phy_event(struct hisi_sas_phy *phy, 467 enum hisi_sas_phy_event event); 468 extern void hisi_sas_release_tasks(struct hisi_hba *hisi_hba); 469 #endif 470