1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright (c) 2015 Linaro Ltd.
4 * Copyright (c) 2015 Hisilicon Limited.
10 #include <linux/acpi.h>
11 #include <linux/blk-mq.h>
12 #include <linux/blk-mq-pci.h>
13 #include <linux/clk.h>
14 #include <linux/debugfs.h>
15 #include <linux/dmapool.h>
16 #include <linux/iopoll.h>
17 #include <linux/lcm.h>
18 #include <linux/libata.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/pm_runtime.h>
25 #include <linux/property.h>
26 #include <linux/regmap.h>
27 #include <linux/timer.h>
28 #include <scsi/sas_ata.h>
29 #include <scsi/libsas.h>
31 #define HISI_SAS_MAX_PHYS 9
32 #define HISI_SAS_MAX_QUEUES 32
33 #define HISI_SAS_QUEUE_SLOTS 4096
34 #define HISI_SAS_MAX_ITCT_ENTRIES 1024
35 #define HISI_SAS_MAX_DEVICES HISI_SAS_MAX_ITCT_ENTRIES
36 #define HISI_SAS_RESET_BIT 0
37 #define HISI_SAS_REJECT_CMD_BIT 1
38 #define HISI_SAS_PM_BIT 2
39 #define HISI_SAS_MAX_COMMANDS (HISI_SAS_QUEUE_SLOTS)
40 #define HISI_SAS_RESERVED_IPTT 96
41 #define HISI_SAS_UNRESERVED_IPTT \
42 (HISI_SAS_MAX_COMMANDS - HISI_SAS_RESERVED_IPTT)
44 #define HISI_SAS_IOST_ITCT_CACHE_NUM 64
45 #define HISI_SAS_IOST_ITCT_CACHE_DW_SZ 10
47 #define HISI_SAS_STATUS_BUF_SZ (sizeof(struct hisi_sas_status_buffer))
48 #define HISI_SAS_COMMAND_TABLE_SZ (sizeof(union hisi_sas_command_table))
50 #define hisi_sas_status_buf_addr(buf) \
51 ((buf) + offsetof(struct hisi_sas_slot_buf_table, status_buffer))
52 #define hisi_sas_status_buf_addr_mem(slot) hisi_sas_status_buf_addr((slot)->buf)
53 #define hisi_sas_status_buf_addr_dma(slot) \
54 hisi_sas_status_buf_addr((slot)->buf_dma)
56 #define hisi_sas_cmd_hdr_addr(buf) \
57 ((buf) + offsetof(struct hisi_sas_slot_buf_table, command_header))
58 #define hisi_sas_cmd_hdr_addr_mem(slot) hisi_sas_cmd_hdr_addr((slot)->buf)
59 #define hisi_sas_cmd_hdr_addr_dma(slot) hisi_sas_cmd_hdr_addr((slot)->buf_dma)
61 #define hisi_sas_sge_addr(buf) \
62 ((buf) + offsetof(struct hisi_sas_slot_buf_table, sge_page))
63 #define hisi_sas_sge_addr_mem(slot) hisi_sas_sge_addr((slot)->buf)
64 #define hisi_sas_sge_addr_dma(slot) hisi_sas_sge_addr((slot)->buf_dma)
66 #define hisi_sas_sge_dif_addr(buf) \
67 ((buf) + offsetof(struct hisi_sas_slot_dif_buf_table, sge_dif_page))
68 #define hisi_sas_sge_dif_addr_mem(slot) hisi_sas_sge_dif_addr((slot)->buf)
69 #define hisi_sas_sge_dif_addr_dma(slot) hisi_sas_sge_dif_addr((slot)->buf_dma)
71 #define HISI_SAS_MAX_SSP_RESP_SZ (sizeof(struct ssp_frame_hdr) + 1024)
72 #define HISI_SAS_MAX_SMP_RESP_SZ 1028
73 #define HISI_SAS_MAX_STP_RESP_SZ 28
75 #define HISI_SAS_SATA_PROTOCOL_NONDATA 0x1
76 #define HISI_SAS_SATA_PROTOCOL_PIO 0x2
77 #define HISI_SAS_SATA_PROTOCOL_DMA 0x4
78 #define HISI_SAS_SATA_PROTOCOL_FPDMA 0x8
79 #define HISI_SAS_SATA_PROTOCOL_ATAPI 0x10
81 #define HISI_SAS_DIF_PROT_MASK (SHOST_DIF_TYPE1_PROTECTION | \
82 SHOST_DIF_TYPE2_PROTECTION | \
83 SHOST_DIF_TYPE3_PROTECTION)
85 #define HISI_SAS_DIX_PROT_MASK (SHOST_DIX_TYPE1_PROTECTION | \
86 SHOST_DIX_TYPE2_PROTECTION | \
87 SHOST_DIX_TYPE3_PROTECTION)
89 #define HISI_SAS_PROT_MASK (HISI_SAS_DIF_PROT_MASK | HISI_SAS_DIX_PROT_MASK)
91 #define HISI_SAS_WAIT_PHYUP_TIMEOUT 20
92 #define CLEAR_ITCT_TIMEOUT 20
97 PORT_TYPE_SAS = (1U << 1),
98 PORT_TYPE_SATA = (1U << 0),
107 HISI_SAS_INT_ABT_CMD = 0,
108 HISI_SAS_INT_ABT_DEV = 1,
111 enum hisi_sas_dev_type {
112 HISI_SAS_DEV_TYPE_STP = 0,
113 HISI_SAS_DEV_TYPE_SSP,
114 HISI_SAS_DEV_TYPE_SATA,
117 struct hisi_sas_hw_error {
123 const struct hisi_sas_hw_error *sub;
126 struct hisi_sas_rst {
127 struct hisi_hba *hisi_hba;
128 struct completion *completion;
129 struct work_struct work;
133 #define HISI_SAS_RST_WORK_INIT(r, c) \
134 { .hisi_hba = hisi_hba, \
136 .work = __WORK_INITIALIZER(r.work, \
137 hisi_sas_sync_rst_work_handler), \
141 #define HISI_SAS_DECLARE_RST_WORK_ON_STACK(r) \
142 DECLARE_COMPLETION_ONSTACK(c); \
143 struct hisi_sas_rst r = HISI_SAS_RST_WORK_INIT(r, c)
145 enum hisi_sas_bit_err_type {
146 HISI_SAS_ERR_SINGLE_BIT_ECC = 0x0,
147 HISI_SAS_ERR_MULTI_BIT_ECC = 0x1,
150 enum hisi_sas_phy_event {
151 HISI_PHYE_PHY_UP = 0U,
152 HISI_PHYE_LINK_RESET,
156 struct hisi_sas_phy {
157 struct work_struct works[HISI_PHYES_NUM];
158 struct hisi_hba *hisi_hba;
159 struct hisi_sas_port *port;
160 struct asd_sas_phy sas_phy;
161 struct sas_identify identify;
162 struct completion *reset_completion;
163 struct timer_list timer;
165 u64 port_id; /* from hw */
172 u32 code_violation_err_count;
173 enum sas_linkrate minimum_linkrate;
174 enum sas_linkrate maximum_linkrate;
179 struct hisi_sas_port {
180 struct asd_sas_port sas_port;
186 struct hisi_hba *hisi_hba;
187 const struct cpumask *irq_mask;
194 struct hisi_hba *hisi_hba;
195 struct list_head list;
201 struct hisi_sas_device {
202 struct hisi_hba *hisi_hba;
203 struct domain_device *sas_device;
204 struct completion *completion;
205 struct hisi_sas_dq *dq;
206 struct list_head list;
207 enum sas_device_type dev_type;
208 enum dev_status dev_status;
211 spinlock_t lock; /* For protecting slots */
214 struct hisi_sas_tmf_task {
218 u16 tag_of_task_to_be_managed;
221 struct hisi_sas_slot {
222 struct list_head entry;
223 struct list_head delivery;
224 struct sas_task *task;
225 struct hisi_sas_port *port;
229 int dlvry_queue_slot;
231 int cmplt_queue_slot;
236 dma_addr_t cmd_hdr_dma;
237 struct timer_list internal_abort_timer;
239 struct hisi_sas_tmf_task *tmf;
240 /* Do not reorder/change members after here */
246 struct hisi_sas_iost_itct_cache {
247 u32 data[HISI_SAS_IOST_ITCT_CACHE_DW_SZ];
250 enum hisi_sas_debugfs_reg_array_member {
257 enum hisi_sas_debugfs_cache_type {
262 enum hisi_sas_debugfs_bist_ffe_cfg {
274 enum hisi_sas_debugfs_bist_fixed_code {
281 HISI_SAS_BIST_CODE_MODE_PRBS7,
282 HISI_SAS_BIST_CODE_MODE_PRBS23,
283 HISI_SAS_BIST_CODE_MODE_PRBS31,
284 HISI_SAS_BIST_CODE_MODE_JTPAT,
285 HISI_SAS_BIST_CODE_MODE_CJTPAT,
286 HISI_SAS_BIST_CODE_MODE_SCRAMBED_0,
287 HISI_SAS_BIST_CODE_MODE_TRAIN,
288 HISI_SAS_BIST_CODE_MODE_TRAIN_DONE,
289 HISI_SAS_BIST_CODE_MODE_HFTP,
290 HISI_SAS_BIST_CODE_MODE_MFTP,
291 HISI_SAS_BIST_CODE_MODE_LFTP,
292 HISI_SAS_BIST_CODE_MODE_FIXED_DATA,
296 int (*hw_init)(struct hisi_hba *hisi_hba);
297 void (*setup_itct)(struct hisi_hba *hisi_hba,
298 struct hisi_sas_device *device);
299 int (*slot_index_alloc)(struct hisi_hba *hisi_hba,
300 struct domain_device *device);
301 struct hisi_sas_device *(*alloc_dev)(struct domain_device *device);
302 void (*sl_notify_ssp)(struct hisi_hba *hisi_hba, int phy_no);
303 void (*start_delivery)(struct hisi_sas_dq *dq);
304 void (*prep_ssp)(struct hisi_hba *hisi_hba,
305 struct hisi_sas_slot *slot);
306 void (*prep_smp)(struct hisi_hba *hisi_hba,
307 struct hisi_sas_slot *slot);
308 void (*prep_stp)(struct hisi_hba *hisi_hba,
309 struct hisi_sas_slot *slot);
310 void (*prep_abort)(struct hisi_hba *hisi_hba,
311 struct hisi_sas_slot *slot,
312 int device_id, int abort_flag, int tag_to_abort);
313 void (*phys_init)(struct hisi_hba *hisi_hba);
314 void (*phy_start)(struct hisi_hba *hisi_hba, int phy_no);
315 void (*phy_disable)(struct hisi_hba *hisi_hba, int phy_no);
316 void (*phy_hard_reset)(struct hisi_hba *hisi_hba, int phy_no);
317 void (*get_events)(struct hisi_hba *hisi_hba, int phy_no);
318 void (*phy_set_linkrate)(struct hisi_hba *hisi_hba, int phy_no,
319 struct sas_phy_linkrates *linkrates);
320 enum sas_linkrate (*phy_get_max_linkrate)(void);
321 int (*clear_itct)(struct hisi_hba *hisi_hba,
322 struct hisi_sas_device *dev);
323 void (*free_device)(struct hisi_sas_device *sas_dev);
324 int (*get_wideport_bitmap)(struct hisi_hba *hisi_hba, int port_id);
325 void (*dereg_device)(struct hisi_hba *hisi_hba,
326 struct domain_device *device);
327 int (*soft_reset)(struct hisi_hba *hisi_hba);
328 u32 (*get_phys_state)(struct hisi_hba *hisi_hba);
329 int (*write_gpio)(struct hisi_hba *hisi_hba, u8 reg_type,
330 u8 reg_index, u8 reg_count, u8 *write_data);
331 void (*wait_cmds_complete_timeout)(struct hisi_hba *hisi_hba,
332 int delay_ms, int timeout_ms);
333 void (*snapshot_prepare)(struct hisi_hba *hisi_hba);
334 void (*snapshot_restore)(struct hisi_hba *hisi_hba);
335 int complete_hdr_size;
336 struct scsi_host_template *sht;
339 #define HISI_SAS_MAX_DEBUGFS_DUMP (50)
341 struct hisi_sas_debugfs_cq {
342 struct hisi_sas_cq *cq;
346 struct hisi_sas_debugfs_dq {
347 struct hisi_sas_dq *dq;
348 struct hisi_sas_cmd_hdr *hdr;
351 struct hisi_sas_debugfs_regs {
352 struct hisi_hba *hisi_hba;
356 struct hisi_sas_debugfs_port {
357 struct hisi_sas_phy *phy;
361 struct hisi_sas_debugfs_iost {
362 struct hisi_sas_iost *iost;
365 struct hisi_sas_debugfs_itct {
366 struct hisi_sas_itct *itct;
369 struct hisi_sas_debugfs_iost_cache {
370 struct hisi_sas_iost_itct_cache *cache;
373 struct hisi_sas_debugfs_itct_cache {
374 struct hisi_sas_iost_itct_cache *cache;
378 /* This must be the first element, used by SHOST_TO_SAS_HA */
379 struct sas_ha_struct *p;
381 struct platform_device *platform_dev;
382 struct pci_dev *pci_dev;
388 void __iomem *sgpio_regs;
391 u32 ctrl_reset_sts_reg;
392 u32 ctrl_clock_ena_reg;
393 u32 refclk_frequency_mhz;
394 u8 sas_addr[SAS_ADDR_SIZE];
398 struct semaphore sem;
400 struct timer_list timer;
401 struct workqueue_struct *wq;
403 int slot_index_count;
406 unsigned long *slot_index_tags;
407 unsigned long reject_stp_links_msk;
410 struct sas_ha_struct sha;
411 struct Scsi_Host *shost;
413 struct hisi_sas_cq cq[HISI_SAS_MAX_QUEUES];
414 struct hisi_sas_dq dq[HISI_SAS_MAX_QUEUES];
415 struct hisi_sas_phy phy[HISI_SAS_MAX_PHYS];
416 struct hisi_sas_port port[HISI_SAS_MAX_PHYS];
420 struct hisi_sas_device devices[HISI_SAS_MAX_DEVICES];
421 struct hisi_sas_cmd_hdr *cmd_hdr[HISI_SAS_MAX_QUEUES];
422 dma_addr_t cmd_hdr_dma[HISI_SAS_MAX_QUEUES];
423 void *complete_hdr[HISI_SAS_MAX_QUEUES];
424 dma_addr_t complete_hdr_dma[HISI_SAS_MAX_QUEUES];
425 struct hisi_sas_initial_fis *initial_fis;
426 dma_addr_t initial_fis_dma;
427 struct hisi_sas_itct *itct;
429 struct hisi_sas_iost *iost;
431 struct hisi_sas_breakpoint *breakpoint;
432 dma_addr_t breakpoint_dma;
433 struct hisi_sas_breakpoint *sata_breakpoint;
434 dma_addr_t sata_breakpoint_dma;
435 struct hisi_sas_slot *slot_info;
437 const struct hisi_sas_hw *hw; /* Low level hw interface */
438 unsigned long sata_dev_bitmap[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES)];
439 struct work_struct rst_work;
440 struct work_struct debugfs_work;
442 u32 intr_coal_ticks; /* Time of interrupt coalesce in us */
443 u32 intr_coal_count; /* Interrupt count to coalesce */
448 enum sas_linkrate debugfs_bist_linkrate;
449 int debugfs_bist_code_mode;
450 int debugfs_bist_phy_no;
451 int debugfs_bist_mode;
452 u32 debugfs_bist_cnt;
453 int debugfs_bist_enable;
454 u32 debugfs_bist_ffe[HISI_SAS_MAX_PHYS][FFE_CFG_MAX];
455 u32 debugfs_bist_fixed_code[FIXED_CODE_MAX];
457 /* debugfs memories */
458 /* Put Global AXI and RAS Register into register array */
459 struct hisi_sas_debugfs_regs debugfs_regs[HISI_SAS_MAX_DEBUGFS_DUMP][DEBUGFS_REGS_NUM];
460 struct hisi_sas_debugfs_port debugfs_port_reg[HISI_SAS_MAX_DEBUGFS_DUMP][HISI_SAS_MAX_PHYS];
461 struct hisi_sas_debugfs_cq debugfs_cq[HISI_SAS_MAX_DEBUGFS_DUMP][HISI_SAS_MAX_QUEUES];
462 struct hisi_sas_debugfs_dq debugfs_dq[HISI_SAS_MAX_DEBUGFS_DUMP][HISI_SAS_MAX_QUEUES];
463 struct hisi_sas_debugfs_iost debugfs_iost[HISI_SAS_MAX_DEBUGFS_DUMP];
464 struct hisi_sas_debugfs_itct debugfs_itct[HISI_SAS_MAX_DEBUGFS_DUMP];
465 struct hisi_sas_debugfs_iost_cache debugfs_iost_cache[HISI_SAS_MAX_DEBUGFS_DUMP];
466 struct hisi_sas_debugfs_itct_cache debugfs_itct_cache[HISI_SAS_MAX_DEBUGFS_DUMP];
468 u64 debugfs_timestamp[HISI_SAS_MAX_DEBUGFS_DUMP];
469 int debugfs_dump_index;
470 struct dentry *debugfs_dir;
471 struct dentry *debugfs_dump_dentry;
472 struct dentry *debugfs_bist_dentry;
475 /* Generic HW DMA host memory structures */
476 /* Delivery queue header */
477 struct hisi_sas_cmd_hdr {
488 __le32 transfer_tags;
491 __le32 data_transfer_len;
494 __le32 first_burst_num;
503 __le64 cmd_table_addr;
506 __le64 sts_buffer_addr;
509 __le64 prd_table_addr;
512 __le64 dif_prd_table_addr;
515 struct hisi_sas_itct {
523 struct hisi_sas_iost {
530 struct hisi_sas_err_record {
534 struct hisi_sas_initial_fis {
535 struct hisi_sas_err_record err_record;
536 struct dev_to_host_fis fis;
540 struct hisi_sas_breakpoint {
544 struct hisi_sas_sata_breakpoint {
545 struct hisi_sas_breakpoint tag[32];
548 struct hisi_sas_sge {
556 struct hisi_sas_command_table_smp {
560 struct hisi_sas_command_table_stp {
561 struct host_to_dev_fis command_fis;
563 u8 atapi_cdb[ATAPI_CDB_LEN];
566 #define HISI_SAS_SGE_PAGE_CNT (124)
567 struct hisi_sas_sge_page {
568 struct hisi_sas_sge sge[HISI_SAS_SGE_PAGE_CNT];
571 #define HISI_SAS_SGE_DIF_PAGE_CNT HISI_SAS_SGE_PAGE_CNT
572 struct hisi_sas_sge_dif_page {
573 struct hisi_sas_sge sge[HISI_SAS_SGE_DIF_PAGE_CNT];
576 struct hisi_sas_command_table_ssp {
577 struct ssp_frame_hdr hdr;
580 struct ssp_command_iu task;
583 struct ssp_tmf_iu ssp_task;
584 struct xfer_rdy_iu xfer_rdy;
585 struct ssp_response_iu ssp_res;
589 union hisi_sas_command_table {
590 struct hisi_sas_command_table_ssp ssp;
591 struct hisi_sas_command_table_smp smp;
592 struct hisi_sas_command_table_stp stp;
595 struct hisi_sas_status_buffer {
596 struct hisi_sas_err_record err;
600 struct hisi_sas_slot_buf_table {
601 struct hisi_sas_status_buffer status_buffer;
602 union hisi_sas_command_table command_header;
603 struct hisi_sas_sge_page sge_page;
606 struct hisi_sas_slot_dif_buf_table {
607 struct hisi_sas_slot_buf_table slot_buf;
608 struct hisi_sas_sge_dif_page sge_dif_page;
611 extern struct scsi_transport_template *hisi_sas_stt;
613 extern bool hisi_sas_debugfs_enable;
614 extern u32 hisi_sas_debugfs_dump_count;
615 extern struct dentry *hisi_sas_debugfs_dir;
617 extern void hisi_sas_stop_phys(struct hisi_hba *hisi_hba);
618 extern int hisi_sas_alloc(struct hisi_hba *hisi_hba);
619 extern void hisi_sas_free(struct hisi_hba *hisi_hba);
620 extern u8 hisi_sas_get_ata_protocol(struct host_to_dev_fis *fis,
622 extern struct hisi_sas_port *to_hisi_sas_port(struct asd_sas_port *sas_port);
623 extern void hisi_sas_sata_done(struct sas_task *task,
624 struct hisi_sas_slot *slot);
625 extern int hisi_sas_get_fw_info(struct hisi_hba *hisi_hba);
626 extern int hisi_sas_probe(struct platform_device *pdev,
627 const struct hisi_sas_hw *ops);
628 extern int hisi_sas_remove(struct platform_device *pdev);
630 extern int hisi_sas_slave_configure(struct scsi_device *sdev);
631 extern int hisi_sas_scan_finished(struct Scsi_Host *shost, unsigned long time);
632 extern void hisi_sas_scan_start(struct Scsi_Host *shost);
633 extern int hisi_sas_host_reset(struct Scsi_Host *shost, int reset_type);
634 extern void hisi_sas_phy_enable(struct hisi_hba *hisi_hba, int phy_no,
636 extern void hisi_sas_phy_down(struct hisi_hba *hisi_hba, int phy_no, int rdy);
637 extern void hisi_sas_slot_task_free(struct hisi_hba *hisi_hba,
638 struct sas_task *task,
639 struct hisi_sas_slot *slot);
640 extern void hisi_sas_init_mem(struct hisi_hba *hisi_hba);
641 extern void hisi_sas_rst_work_handler(struct work_struct *work);
642 extern void hisi_sas_sync_rst_work_handler(struct work_struct *work);
643 extern void hisi_sas_sync_irqs(struct hisi_hba *hisi_hba);
644 extern void hisi_sas_phy_oob_ready(struct hisi_hba *hisi_hba, int phy_no);
645 extern bool hisi_sas_notify_phy_event(struct hisi_sas_phy *phy,
646 enum hisi_sas_phy_event event);
647 extern void hisi_sas_release_tasks(struct hisi_hba *hisi_hba);
648 extern u8 hisi_sas_get_prog_phy_linkrate_mask(enum sas_linkrate max);
649 extern void hisi_sas_controller_reset_prepare(struct hisi_hba *hisi_hba);
650 extern void hisi_sas_controller_reset_done(struct hisi_hba *hisi_hba);