blob: 8e36ede12cf19761f646994c6180d9cbd70e7e8e [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
John Garrye8899fa2015-11-18 00:50:30 +08002/*
3 * Copyright (c) 2015 Linaro Ltd.
4 * Copyright (c) 2015 Hisilicon Limited.
John Garrye8899fa2015-11-18 00:50:30 +08005 */
6
7#ifndef _HISI_SAS_H_
8#define _HISI_SAS_H_
9
John Garry4d558c72016-02-04 02:26:08 +080010#include <linux/acpi.h>
John Garry8d984162020-08-19 23:20:32 +080011#include <linux/blk-mq.h>
12#include <linux/blk-mq-pci.h>
John Garry3bc45af2016-10-04 19:11:11 +080013#include <linux/clk.h>
Luo Jiaxingef634642018-12-19 23:56:39 +080014#include <linux/debugfs.h>
John Garrye8899fa2015-11-18 00:50:30 +080015#include <linux/dmapool.h>
Xiang Chena25d0d32017-08-11 00:09:40 +080016#include <linux/iopoll.h>
John Garry74a29212020-12-02 18:36:57 +080017#include <linux/irq.h>
Xiang Chen2ba5afb2018-05-31 20:50:48 +080018#include <linux/lcm.h>
Xiang Chen57dbb2b2019-02-28 22:51:01 +080019#include <linux/libata.h>
John Garrye8899fa2015-11-18 00:50:30 +080020#include <linux/mfd/syscon.h>
21#include <linux/module.h>
22#include <linux/of_address.h>
John Garry11b75242017-06-14 23:33:17 +080023#include <linux/pci.h>
John Garrye8899fa2015-11-18 00:50:30 +080024#include <linux/platform_device.h>
Xiang Chen65ff4ae2020-10-02 22:30:34 +080025#include <linux/pm_runtime.h>
John Garry4d558c72016-02-04 02:26:08 +080026#include <linux/property.h>
John Garrye8899fa2015-11-18 00:50:30 +080027#include <linux/regmap.h>
Luo Jiaxingd28ed832019-10-24 22:08:12 +080028#include <linux/timer.h>
John Garry6f2ff1a2016-01-26 02:47:20 +080029#include <scsi/sas_ata.h>
John Garrye8899fa2015-11-18 00:50:30 +080030#include <scsi/libsas.h>
31
John Garry7eb78692015-11-18 00:50:31 +080032#define HISI_SAS_MAX_PHYS 9
John Garry6be6de12015-11-18 00:50:34 +080033#define HISI_SAS_MAX_QUEUES 32
Xiang Chen1273d652019-02-06 18:52:53 +080034#define HISI_SAS_QUEUE_SLOTS 4096
Xiang Chen3297ded2017-10-24 23:51:35 +080035#define HISI_SAS_MAX_ITCT_ENTRIES 1024
John Garry7eb78692015-11-18 00:50:31 +080036#define HISI_SAS_MAX_DEVICES HISI_SAS_MAX_ITCT_ENTRIES
Xiang Chen06ec0fb2017-03-23 01:25:18 +080037#define HISI_SAS_RESET_BIT 0
Xiaofei Tan917d3bd2017-08-11 00:09:26 +080038#define HISI_SAS_REJECT_CMD_BIT 1
Xiang Chen65ff4ae2020-10-02 22:30:34 +080039#define HISI_SAS_PM_BIT 2
John Garry93352ab2019-08-05 21:47:58 +080040#define HISI_SAS_MAX_COMMANDS (HISI_SAS_QUEUE_SLOTS)
41#define HISI_SAS_RESERVED_IPTT 96
42#define HISI_SAS_UNRESERVED_IPTT \
43 (HISI_SAS_MAX_COMMANDS - HISI_SAS_RESERVED_IPTT)
John Garry7eb78692015-11-18 00:50:31 +080044
Luo Jiaxingbbe0a7b2019-08-05 21:48:01 +080045#define HISI_SAS_IOST_ITCT_CACHE_NUM 64
46#define HISI_SAS_IOST_ITCT_CACHE_DW_SZ 10
Luo Jiaxingcd96fe62021-01-26 19:04:28 +080047#define HISI_SAS_FIFO_DATA_DW_SIZE 32
Luo Jiaxingbbe0a7b2019-08-05 21:48:01 +080048
Xiaofei Tanf557e322017-06-29 21:02:14 +080049#define HISI_SAS_STATUS_BUF_SZ (sizeof(struct hisi_sas_status_buffer))
50#define HISI_SAS_COMMAND_TABLE_SZ (sizeof(union hisi_sas_command_table))
51
52#define hisi_sas_status_buf_addr(buf) \
Xiang Chenb3cce122019-02-06 18:52:51 +080053 ((buf) + offsetof(struct hisi_sas_slot_buf_table, status_buffer))
54#define hisi_sas_status_buf_addr_mem(slot) hisi_sas_status_buf_addr((slot)->buf)
Xiaofei Tanf557e322017-06-29 21:02:14 +080055#define hisi_sas_status_buf_addr_dma(slot) \
Xiang Chenb3cce122019-02-06 18:52:51 +080056 hisi_sas_status_buf_addr((slot)->buf_dma)
Xiaofei Tanf557e322017-06-29 21:02:14 +080057
58#define hisi_sas_cmd_hdr_addr(buf) \
Xiang Chenb3cce122019-02-06 18:52:51 +080059 ((buf) + offsetof(struct hisi_sas_slot_buf_table, command_header))
60#define hisi_sas_cmd_hdr_addr_mem(slot) hisi_sas_cmd_hdr_addr((slot)->buf)
61#define hisi_sas_cmd_hdr_addr_dma(slot) hisi_sas_cmd_hdr_addr((slot)->buf_dma)
Xiaofei Tanf557e322017-06-29 21:02:14 +080062
63#define hisi_sas_sge_addr(buf) \
Xiang Chenb3cce122019-02-06 18:52:51 +080064 ((buf) + offsetof(struct hisi_sas_slot_buf_table, sge_page))
65#define hisi_sas_sge_addr_mem(slot) hisi_sas_sge_addr((slot)->buf)
66#define hisi_sas_sge_addr_dma(slot) hisi_sas_sge_addr((slot)->buf_dma)
67
68#define hisi_sas_sge_dif_addr(buf) \
69 ((buf) + offsetof(struct hisi_sas_slot_dif_buf_table, sge_dif_page))
70#define hisi_sas_sge_dif_addr_mem(slot) hisi_sas_sge_dif_addr((slot)->buf)
71#define hisi_sas_sge_dif_addr_dma(slot) hisi_sas_sge_dif_addr((slot)->buf_dma)
John Garry6be6de12015-11-18 00:50:34 +080072
John Garry42e7a692015-11-18 00:50:49 +080073#define HISI_SAS_MAX_SSP_RESP_SZ (sizeof(struct ssp_frame_hdr) + 1024)
John Garry66ee9992015-11-18 00:50:54 +080074#define HISI_SAS_MAX_SMP_RESP_SZ 1028
John Garry6f2ff1a2016-01-26 02:47:20 +080075#define HISI_SAS_MAX_STP_RESP_SZ 28
John Garry42e7a692015-11-18 00:50:49 +080076
Xiang Chen6c7bb8a2017-06-14 23:33:14 +080077#define HISI_SAS_SATA_PROTOCOL_NONDATA 0x1
78#define HISI_SAS_SATA_PROTOCOL_PIO 0x2
79#define HISI_SAS_SATA_PROTOCOL_DMA 0x4
80#define HISI_SAS_SATA_PROTOCOL_FPDMA 0x8
81#define HISI_SAS_SATA_PROTOCOL_ATAPI 0x10
82
Xiang Chend6a90002018-12-17 22:40:07 +080083#define HISI_SAS_DIF_PROT_MASK (SHOST_DIF_TYPE1_PROTECTION | \
84 SHOST_DIF_TYPE2_PROTECTION | \
85 SHOST_DIF_TYPE3_PROTECTION)
86
Xiang Chenb3cce122019-02-06 18:52:51 +080087#define HISI_SAS_DIX_PROT_MASK (SHOST_DIX_TYPE1_PROTECTION | \
88 SHOST_DIX_TYPE2_PROTECTION | \
89 SHOST_DIX_TYPE3_PROTECTION)
90
91#define HISI_SAS_PROT_MASK (HISI_SAS_DIF_PROT_MASK | HISI_SAS_DIX_PROT_MASK)
Xiang Chend6a90002018-12-17 22:40:07 +080092
Xiaofei Tanb6c9b152019-01-25 22:22:35 +080093#define HISI_SAS_WAIT_PHYUP_TIMEOUT 20
Xiang Chen8fa9a7b2019-10-24 22:08:10 +080094#define CLEAR_ITCT_TIMEOUT 20
Xiaofei Tanb6c9b152019-01-25 22:22:35 +080095
John Garryabda97c2015-11-18 00:50:51 +080096struct hisi_hba;
John Garryaf740db2015-11-18 00:50:41 +080097
John Garry07d78592015-11-18 00:50:47 +080098enum {
99 PORT_TYPE_SAS = (1U << 1),
100 PORT_TYPE_SATA = (1U << 0),
101};
102
Xiang Chen57dbb2b2019-02-28 22:51:01 +0800103enum dev_status {
104 HISI_SAS_DEV_INIT,
105 HISI_SAS_DEV_NORMAL,
106};
107
John Garry441c2742016-08-24 19:05:47 +0800108enum {
109 HISI_SAS_INT_ABT_CMD = 0,
110 HISI_SAS_INT_ABT_DEV = 1,
111};
112
John Garryabda97c2015-11-18 00:50:51 +0800113enum hisi_sas_dev_type {
114 HISI_SAS_DEV_TYPE_STP = 0,
115 HISI_SAS_DEV_TYPE_SSP,
116 HISI_SAS_DEV_TYPE_SATA,
117};
118
John Garry2b383352017-08-11 00:09:30 +0800119struct hisi_sas_hw_error {
120 u32 irq_msk;
121 u32 msk;
122 int shift;
123 const char *msg;
124 int reg;
Shiju Jose729428c2017-10-24 23:51:39 +0800125 const struct hisi_sas_hw_error *sub;
John Garry2b383352017-08-11 00:09:30 +0800126};
127
Xiaofei Tane402acd2017-12-09 01:16:38 +0800128struct hisi_sas_rst {
129 struct hisi_hba *hisi_hba;
130 struct completion *completion;
131 struct work_struct work;
132 bool done;
133};
134
135#define HISI_SAS_RST_WORK_INIT(r, c) \
136 { .hisi_hba = hisi_hba, \
137 .completion = &c, \
138 .work = __WORK_INITIALIZER(r.work, \
139 hisi_sas_sync_rst_work_handler), \
140 .done = false, \
141 }
142
143#define HISI_SAS_DECLARE_RST_WORK_ON_STACK(r) \
144 DECLARE_COMPLETION_ONSTACK(c); \
Xiaofei Tane402acd2017-12-09 01:16:38 +0800145 struct hisi_sas_rst r = HISI_SAS_RST_WORK_INIT(r, c)
146
147enum hisi_sas_bit_err_type {
148 HISI_SAS_ERR_SINGLE_BIT_ECC = 0x0,
149 HISI_SAS_ERR_MULTI_BIT_ECC = 0x1,
150};
151
Xiaofei Tane537b622017-12-09 01:16:44 +0800152enum hisi_sas_phy_event {
153 HISI_PHYE_PHY_UP = 0U,
Xiaofei Tan057c3d12017-12-09 01:16:45 +0800154 HISI_PHYE_LINK_RESET,
Xiaofei Tane537b622017-12-09 01:16:44 +0800155 HISI_PHYES_NUM,
156};
157
Luo Jiaxingcd96fe62021-01-26 19:04:28 +0800158struct hisi_sas_debugfs_fifo {
159 u32 signal_sel;
160 u32 dump_msk;
161 u32 dump_mode;
162 u32 trigger;
163 u32 trigger_msk;
164 u32 trigger_mode;
165 u32 rd_data[HISI_SAS_FIFO_DATA_DW_SIZE];
166};
167
John Garry7eb78692015-11-18 00:50:31 +0800168struct hisi_sas_phy {
Xiaofei Tane537b622017-12-09 01:16:44 +0800169 struct work_struct works[HISI_PHYES_NUM];
John Garry976867e2015-11-18 00:50:42 +0800170 struct hisi_hba *hisi_hba;
171 struct hisi_sas_port *port;
John Garry7eb78692015-11-18 00:50:31 +0800172 struct asd_sas_phy sas_phy;
John Garry976867e2015-11-18 00:50:42 +0800173 struct sas_identify identify;
Xiang Chen3e1fb1b2018-05-21 18:09:25 +0800174 struct completion *reset_completion;
Xiaofei Tanb6c9b152019-01-25 22:22:35 +0800175 struct timer_list timer;
Xiang Chen3e1fb1b2018-05-21 18:09:25 +0800176 spinlock_t lock;
John Garry976867e2015-11-18 00:50:42 +0800177 u64 port_id; /* from hw */
John Garry976867e2015-11-18 00:50:42 +0800178 u64 frame_rcvd_size;
179 u8 frame_rcvd[32];
180 u8 phy_attached;
Xiang Chen3e1fb1b2018-05-21 18:09:25 +0800181 u8 in_reset;
182 u8 reserved[2];
John Garryd0ef10c2017-06-26 18:27:28 +0800183 u32 phy_type;
Xiaofei Tanaaeb8232019-02-28 22:50:59 +0800184 u32 code_violation_err_count;
John Garry976867e2015-11-18 00:50:42 +0800185 enum sas_linkrate minimum_linkrate;
186 enum sas_linkrate maximum_linkrate;
John Garryc63b88c2019-04-11 20:46:38 +0800187 int enable;
Luo Jiaxing366da0d2021-06-07 17:29:35 +0800188 int wait_phyup_cnt;
Luo Jiaxingf873b662019-10-24 22:08:25 +0800189 atomic_t down_cnt;
Luo Jiaxingcd96fe62021-01-26 19:04:28 +0800190
191 /* Trace FIFO */
192 struct hisi_sas_debugfs_fifo fifo;
John Garry7eb78692015-11-18 00:50:31 +0800193};
194
195struct hisi_sas_port {
196 struct asd_sas_port sas_port;
John Garry976867e2015-11-18 00:50:42 +0800197 u8 port_attached;
198 u8 id; /* from hw */
John Garry7eb78692015-11-18 00:50:31 +0800199};
200
John Garry9101a072015-11-18 00:50:37 +0800201struct hisi_sas_cq {
202 struct hisi_hba *hisi_hba;
John Garry11e67322020-01-20 20:22:36 +0800203 const struct cpumask *irq_mask;
John Garrye6c346f2016-09-06 23:36:11 +0800204 int rd_point;
John Garry9101a072015-11-18 00:50:37 +0800205 int id;
Xiang Chen81f338e2020-01-20 20:22:31 +0800206 int irq_no;
John Garry9101a072015-11-18 00:50:37 +0800207};
208
John Garry4fde02a2016-09-06 23:36:12 +0800209struct hisi_sas_dq {
210 struct hisi_hba *hisi_hba;
Xiang Chenfa222db2018-05-09 23:10:48 +0800211 struct list_head list;
Xiang Chenb1a49412017-06-14 23:33:13 +0800212 spinlock_t lock;
John Garry4fde02a2016-09-06 23:36:12 +0800213 int wr_point;
214 int id;
215};
216
John Garryaf740db2015-11-18 00:50:41 +0800217struct hisi_sas_device {
John Garryabda97c2015-11-18 00:50:51 +0800218 struct hisi_hba *hisi_hba;
219 struct domain_device *sas_device;
Xiang Chen640acc92017-08-11 00:09:33 +0800220 struct completion *completion;
Xiang Chenb1a49412017-06-14 23:33:13 +0800221 struct hisi_sas_dq *dq;
John Garry405314d2017-03-23 01:25:21 +0800222 struct list_head list;
John Garryad604832017-06-14 23:33:12 +0800223 enum sas_device_type dev_type;
Xiang Chen57dbb2b2019-02-28 22:51:01 +0800224 enum dev_status dev_status;
John Garryad604832017-06-14 23:33:12 +0800225 int device_id;
Xiaofei Tan32ccba52017-04-10 21:21:57 +0800226 int sata_idx;
Xiang Chen4fefe5b2019-02-06 18:52:55 +0800227 spinlock_t lock; /* For protecting slots */
John Garryaf740db2015-11-18 00:50:41 +0800228};
229
Xiaofei Tan78bd2b42018-05-21 18:09:21 +0800230struct hisi_sas_tmf_task {
Xiaofei Tanb09fcd02018-05-21 18:09:22 +0800231 int force_phy;
232 int phy_id;
Xiaofei Tan78bd2b42018-05-21 18:09:21 +0800233 u8 tmf;
234 u16 tag_of_task_to_be_managed;
235};
236
John Garry6be6de12015-11-18 00:50:34 +0800237struct hisi_sas_slot {
John Garry42e7a692015-11-18 00:50:49 +0800238 struct list_head entry;
Xiang Chenfa222db2018-05-09 23:10:48 +0800239 struct list_head delivery;
John Garry42e7a692015-11-18 00:50:49 +0800240 struct sas_task *task;
241 struct hisi_sas_port *port;
242 u64 n_elem;
Xiang Chenb3cce122019-02-06 18:52:51 +0800243 u64 n_elem_dif;
John Garry42e7a692015-11-18 00:50:49 +0800244 int dlvry_queue;
245 int dlvry_queue_slot;
John Garry27a3f222015-11-18 00:50:50 +0800246 int cmplt_queue;
247 int cmplt_queue_slot;
John Garrycac9b2a2016-02-25 17:42:11 +0800248 int abort;
Xiang Chenfa222db2018-05-09 23:10:48 +0800249 int ready;
Xiang Chen4fefe5b2019-02-06 18:52:55 +0800250 int device_id;
John Garry42e7a692015-11-18 00:50:49 +0800251 void *cmd_hdr;
252 dma_addr_t cmd_hdr_dma;
John Garry0844a3f2017-04-10 21:21:59 +0800253 struct timer_list internal_abort_timer;
Xiang Chencd938e52018-05-02 23:56:26 +0800254 bool is_internal;
Xiaofei Tan78bd2b42018-05-21 18:09:21 +0800255 struct hisi_sas_tmf_task *tmf;
Xiang Chen2ba5afb2018-05-31 20:50:48 +0800256 /* Do not reorder/change members after here */
257 void *buf;
258 dma_addr_t buf_dma;
John Garry735bcc72018-12-06 21:34:40 +0800259 u16 idx;
John Garry6be6de12015-11-18 00:50:34 +0800260};
261
Luo Jiaxingbbe0a7b2019-08-05 21:48:01 +0800262struct hisi_sas_iost_itct_cache {
263 u32 data[HISI_SAS_IOST_ITCT_CACHE_DW_SZ];
264};
265
Luo Jiaxingb0b3e4292019-08-05 21:48:02 +0800266enum hisi_sas_debugfs_reg_array_member {
267 DEBUGFS_GLOBAL = 0,
268 DEBUGFS_AXI,
269 DEBUGFS_RAS,
270 DEBUGFS_REGS_NUM
271};
272
Luo Jiaxingbbe0a7b2019-08-05 21:48:01 +0800273enum hisi_sas_debugfs_cache_type {
274 HISI_SAS_ITCT_CACHE,
275 HISI_SAS_IOST_CACHE,
276};
277
Luo Jiaxing2c4d5822020-09-01 19:13:07 +0800278enum hisi_sas_debugfs_bist_ffe_cfg {
279 FFE_SAS_1_5_GBPS,
280 FFE_SAS_3_0_GBPS,
281 FFE_SAS_6_0_GBPS,
282 FFE_SAS_12_0_GBPS,
283 FFE_RESV,
284 FFE_SATA_1_5_GBPS,
285 FFE_SATA_3_0_GBPS,
286 FFE_SATA_6_0_GBPS,
287 FFE_CFG_MAX
288};
289
Luo Jiaxing981cc232020-09-01 19:13:08 +0800290enum hisi_sas_debugfs_bist_fixed_code {
291 FIXED_CODE,
292 FIXED_CODE_1,
293 FIXED_CODE_MAX
294};
295
296enum {
297 HISI_SAS_BIST_CODE_MODE_PRBS7,
298 HISI_SAS_BIST_CODE_MODE_PRBS23,
299 HISI_SAS_BIST_CODE_MODE_PRBS31,
300 HISI_SAS_BIST_CODE_MODE_JTPAT,
301 HISI_SAS_BIST_CODE_MODE_CJTPAT,
302 HISI_SAS_BIST_CODE_MODE_SCRAMBED_0,
303 HISI_SAS_BIST_CODE_MODE_TRAIN,
304 HISI_SAS_BIST_CODE_MODE_TRAIN_DONE,
305 HISI_SAS_BIST_CODE_MODE_HFTP,
306 HISI_SAS_BIST_CODE_MODE_MFTP,
307 HISI_SAS_BIST_CODE_MODE_LFTP,
308 HISI_SAS_BIST_CODE_MODE_FIXED_DATA,
309};
310
John Garry7eb78692015-11-18 00:50:31 +0800311struct hisi_sas_hw {
John Garry8ff1d572015-11-18 00:50:46 +0800312 int (*hw_init)(struct hisi_hba *hisi_hba);
John Garry74a29212020-12-02 18:36:57 +0800313 int (*interrupt_preinit)(struct hisi_hba *hisi_hba);
John Garryabda97c2015-11-18 00:50:51 +0800314 void (*setup_itct)(struct hisi_hba *hisi_hba,
315 struct hisi_sas_device *device);
Xiang Chen784b46b2018-09-24 23:06:33 +0800316 int (*slot_index_alloc)(struct hisi_hba *hisi_hba,
John Garry685b6d62016-04-15 21:36:36 +0800317 struct domain_device *device);
318 struct hisi_sas_device *(*alloc_dev)(struct domain_device *device);
Xiang Chen569eddc2019-01-25 22:22:30 +0800319 void (*sl_notify_ssp)(struct hisi_hba *hisi_hba, int phy_no);
Xiang Chenb1a49412017-06-14 23:33:13 +0800320 void (*start_delivery)(struct hisi_sas_dq *dq);
Xiang Chena2b38202018-05-09 23:10:46 +0800321 void (*prep_ssp)(struct hisi_hba *hisi_hba,
Xiaofei Tan78bd2b42018-05-21 18:09:21 +0800322 struct hisi_sas_slot *slot);
Xiang Chena2b38202018-05-09 23:10:46 +0800323 void (*prep_smp)(struct hisi_hba *hisi_hba,
John Garry66ee9992015-11-18 00:50:54 +0800324 struct hisi_sas_slot *slot);
Xiang Chena2b38202018-05-09 23:10:46 +0800325 void (*prep_stp)(struct hisi_hba *hisi_hba,
John Garry6f2ff1a2016-01-26 02:47:20 +0800326 struct hisi_sas_slot *slot);
Xiang Chena2b38202018-05-09 23:10:46 +0800327 void (*prep_abort)(struct hisi_hba *hisi_hba,
John Garry441c2742016-08-24 19:05:47 +0800328 struct hisi_sas_slot *slot,
329 int device_id, int abort_flag, int tag_to_abort);
John Garry396b8042017-03-23 01:25:19 +0800330 void (*phys_init)(struct hisi_hba *hisi_hba);
Xiang Chen1eb8eea2017-10-24 23:51:36 +0800331 void (*phy_start)(struct hisi_hba *hisi_hba, int phy_no);
John Garrye4189d52015-11-18 00:50:57 +0800332 void (*phy_disable)(struct hisi_hba *hisi_hba, int phy_no);
333 void (*phy_hard_reset)(struct hisi_hba *hisi_hba, int phy_no);
Xiaofei Tanc52108c2017-08-11 00:09:29 +0800334 void (*get_events)(struct hisi_hba *hisi_hba, int phy_no);
Xiang Chen2ae75782016-11-07 20:48:40 +0800335 void (*phy_set_linkrate)(struct hisi_hba *hisi_hba, int phy_no,
336 struct sas_phy_linkrates *linkrates);
337 enum sas_linkrate (*phy_get_max_linkrate)(void);
Xiang Chen8fa9a7b2019-10-24 22:08:10 +0800338 int (*clear_itct)(struct hisi_hba *hisi_hba,
339 struct hisi_sas_device *dev);
Xiaofei Tan02581412017-12-09 01:16:34 +0800340 void (*free_device)(struct hisi_sas_device *sas_dev);
John Garry184a4632015-11-18 00:50:52 +0800341 int (*get_wideport_bitmap)(struct hisi_hba *hisi_hba, int port_id);
Xiang Chend30ff262017-06-14 23:33:32 +0800342 void (*dereg_device)(struct hisi_hba *hisi_hba,
343 struct domain_device *device);
Xiang Chen06ec0fb2017-03-23 01:25:18 +0800344 int (*soft_reset)(struct hisi_hba *hisi_hba);
Xiaofei Tan917d3bd2017-08-11 00:09:26 +0800345 u32 (*get_phys_state)(struct hisi_hba *hisi_hba);
Xiaofei Tan6379c562018-01-18 00:46:53 +0800346 int (*write_gpio)(struct hisi_hba *hisi_hba, u8 reg_type,
347 u8 reg_index, u8 reg_count, u8 *write_data);
Luo Jiaxing4bc05802019-09-06 20:55:34 +0800348 void (*wait_cmds_complete_timeout)(struct hisi_hba *hisi_hba,
349 int delay_ms, int timeout_ms);
Jianqin Xie2c74cb12021-04-06 19:48:29 +0800350 void (*debugfs_snapshot_regs)(struct hisi_hba *hisi_hba);
John Garry6be6de12015-11-18 00:50:34 +0800351 int complete_hdr_size;
Xiang Chen235bfc72018-05-21 18:09:18 +0800352 struct scsi_host_template *sht;
John Garry7eb78692015-11-18 00:50:31 +0800353};
354
Luo Jiaxinga70e33e2019-10-24 22:08:21 +0800355#define HISI_SAS_MAX_DEBUGFS_DUMP (50)
356
Luo Jiaxing35ea6302019-10-24 22:08:13 +0800357struct hisi_sas_debugfs_cq {
358 struct hisi_sas_cq *cq;
359 void *complete_hdr;
360};
361
Luo Jiaxing1b54c4d2019-10-24 22:08:14 +0800362struct hisi_sas_debugfs_dq {
363 struct hisi_sas_dq *dq;
364 struct hisi_sas_cmd_hdr *hdr;
365};
366
Luo Jiaxingc6116392019-10-24 22:08:15 +0800367struct hisi_sas_debugfs_regs {
368 struct hisi_hba *hisi_hba;
369 u32 *data;
370};
371
Luo Jiaxing1f66e1f2019-10-24 22:08:16 +0800372struct hisi_sas_debugfs_port {
373 struct hisi_sas_phy *phy;
374 u32 *data;
375};
376
Luo Jiaxinge15f2e22019-10-24 22:08:17 +0800377struct hisi_sas_debugfs_iost {
378 struct hisi_sas_iost *iost;
379};
380
Luo Jiaxing0161d552019-10-24 22:08:18 +0800381struct hisi_sas_debugfs_itct {
382 struct hisi_sas_itct *itct;
383};
384
Luo Jiaxingb714dd82019-10-24 22:08:19 +0800385struct hisi_sas_debugfs_iost_cache {
386 struct hisi_sas_iost_itct_cache *cache;
387};
388
Luo Jiaxing357e4fc2019-10-24 22:08:20 +0800389struct hisi_sas_debugfs_itct_cache {
390 struct hisi_sas_iost_itct_cache *cache;
391};
392
John Garry7eb78692015-11-18 00:50:31 +0800393struct hisi_hba {
394 /* This must be the first element, used by SHOST_TO_SAS_HA */
395 struct sas_ha_struct *p;
396
John Garry11b75242017-06-14 23:33:17 +0800397 struct platform_device *platform_dev;
398 struct pci_dev *pci_dev;
399 struct device *dev;
400
Xiang Chend6a90002018-12-17 22:40:07 +0800401 int prot_mask;
402
John Garrye26b2f42015-11-18 00:50:32 +0800403 void __iomem *regs;
Xiaofei Tan6379c562018-01-18 00:46:53 +0800404 void __iomem *sgpio_regs;
John Garrye26b2f42015-11-18 00:50:32 +0800405 struct regmap *ctrl;
406 u32 ctrl_reset_reg;
407 u32 ctrl_reset_sts_reg;
408 u32 ctrl_clock_ena_reg;
John Garry3bc45af2016-10-04 19:11:11 +0800409 u32 refclk_frequency_mhz;
John Garry7eb78692015-11-18 00:50:31 +0800410 u8 sas_addr[SAS_ADDR_SIZE];
411
John Garry74a29212020-12-02 18:36:57 +0800412 int *irq_map; /* v2 hw */
413
John Garry7eb78692015-11-18 00:50:31 +0800414 int n_phy;
John Garryfa42d802015-11-18 00:50:43 +0800415 spinlock_t lock;
Xiaofei Tand2fc4012018-05-31 20:50:44 +0800416 struct semaphore sem;
John Garry7eb78692015-11-18 00:50:31 +0800417
John Garryfa42d802015-11-18 00:50:43 +0800418 struct timer_list timer;
John Garry7e9080e2015-11-18 00:50:40 +0800419 struct workqueue_struct *wq;
John Garry257efd12015-11-18 00:50:36 +0800420
421 int slot_index_count;
Xiang Chenfa3be0f2018-05-21 18:09:14 +0800422 int last_slot_index;
Xiang Chen1b865182018-05-21 18:09:15 +0800423 int last_dev_id;
John Garry257efd12015-11-18 00:50:36 +0800424 unsigned long *slot_index_tags;
Xiaofei Tanc7b9d362017-04-10 21:21:56 +0800425 unsigned long reject_stp_links_msk;
John Garry257efd12015-11-18 00:50:36 +0800426
John Garry7eb78692015-11-18 00:50:31 +0800427 /* SCSI/SAS glue */
428 struct sas_ha_struct sha;
429 struct Scsi_Host *shost;
John Garry9101a072015-11-18 00:50:37 +0800430
431 struct hisi_sas_cq cq[HISI_SAS_MAX_QUEUES];
John Garry4fde02a2016-09-06 23:36:12 +0800432 struct hisi_sas_dq dq[HISI_SAS_MAX_QUEUES];
John Garry7eb78692015-11-18 00:50:31 +0800433 struct hisi_sas_phy phy[HISI_SAS_MAX_PHYS];
434 struct hisi_sas_port port[HISI_SAS_MAX_PHYS];
John Garrye26b2f42015-11-18 00:50:32 +0800435
436 int queue_count;
John Garry6be6de12015-11-18 00:50:34 +0800437
John Garryaf740db2015-11-18 00:50:41 +0800438 struct hisi_sas_device devices[HISI_SAS_MAX_DEVICES];
John Garry6be6de12015-11-18 00:50:34 +0800439 struct hisi_sas_cmd_hdr *cmd_hdr[HISI_SAS_MAX_QUEUES];
440 dma_addr_t cmd_hdr_dma[HISI_SAS_MAX_QUEUES];
441 void *complete_hdr[HISI_SAS_MAX_QUEUES];
442 dma_addr_t complete_hdr_dma[HISI_SAS_MAX_QUEUES];
443 struct hisi_sas_initial_fis *initial_fis;
444 dma_addr_t initial_fis_dma;
445 struct hisi_sas_itct *itct;
446 dma_addr_t itct_dma;
447 struct hisi_sas_iost *iost;
448 dma_addr_t iost_dma;
449 struct hisi_sas_breakpoint *breakpoint;
450 dma_addr_t breakpoint_dma;
451 struct hisi_sas_breakpoint *sata_breakpoint;
452 dma_addr_t sata_breakpoint_dma;
453 struct hisi_sas_slot *slot_info;
Xiang Chen06ec0fb2017-03-23 01:25:18 +0800454 unsigned long flags;
John Garry7eb78692015-11-18 00:50:31 +0800455 const struct hisi_sas_hw *hw; /* Low level hw interface */
Xiaofei Tan32ccba52017-04-10 21:21:57 +0800456 unsigned long sata_dev_bitmap[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES)];
Xiang Chen06ec0fb2017-03-23 01:25:18 +0800457 struct work_struct rst_work;
Luo Jiaxing49159a52018-12-19 23:56:41 +0800458 struct work_struct debugfs_work;
Xiaofei Tan45222042018-07-18 22:14:28 +0800459 u32 phy_state;
Xiang Chen37359792018-11-09 22:06:34 +0800460 u32 intr_coal_ticks; /* Time of interrupt coalesce in us */
461 u32 intr_coal_count; /* Interrupt count to coalesce */
Luo Jiaxingef634642018-12-19 23:56:39 +0800462
John Garry795f25a2019-02-06 18:52:54 +0800463 int cq_nvecs;
464
Xiang Chen97b151e2019-09-06 20:55:36 +0800465 /* bist */
466 enum sas_linkrate debugfs_bist_linkrate;
467 int debugfs_bist_code_mode;
468 int debugfs_bist_phy_no;
469 int debugfs_bist_mode;
470 u32 debugfs_bist_cnt;
471 int debugfs_bist_enable;
Luo Jiaxing2c4d5822020-09-01 19:13:07 +0800472 u32 debugfs_bist_ffe[HISI_SAS_MAX_PHYS][FFE_CFG_MAX];
Luo Jiaxing981cc232020-09-01 19:13:08 +0800473 u32 debugfs_bist_fixed_code[FIXED_CODE_MAX];
Xiang Chen97b151e2019-09-06 20:55:36 +0800474
Luo Jiaxingeb1c2b72018-12-19 23:56:40 +0800475 /* debugfs memories */
Luo Jiaxingb0b3e4292019-08-05 21:48:02 +0800476 /* Put Global AXI and RAS Register into register array */
Luo Jiaxinga70e33e2019-10-24 22:08:21 +0800477 struct hisi_sas_debugfs_regs debugfs_regs[HISI_SAS_MAX_DEBUGFS_DUMP][DEBUGFS_REGS_NUM];
478 struct hisi_sas_debugfs_port debugfs_port_reg[HISI_SAS_MAX_DEBUGFS_DUMP][HISI_SAS_MAX_PHYS];
479 struct hisi_sas_debugfs_cq debugfs_cq[HISI_SAS_MAX_DEBUGFS_DUMP][HISI_SAS_MAX_QUEUES];
480 struct hisi_sas_debugfs_dq debugfs_dq[HISI_SAS_MAX_DEBUGFS_DUMP][HISI_SAS_MAX_QUEUES];
481 struct hisi_sas_debugfs_iost debugfs_iost[HISI_SAS_MAX_DEBUGFS_DUMP];
482 struct hisi_sas_debugfs_itct debugfs_itct[HISI_SAS_MAX_DEBUGFS_DUMP];
483 struct hisi_sas_debugfs_iost_cache debugfs_iost_cache[HISI_SAS_MAX_DEBUGFS_DUMP];
484 struct hisi_sas_debugfs_itct_cache debugfs_itct_cache[HISI_SAS_MAX_DEBUGFS_DUMP];
485
Luo Jiaxing8f643292019-10-24 22:08:23 +0800486 u64 debugfs_timestamp[HISI_SAS_MAX_DEBUGFS_DUMP];
487 int debugfs_dump_index;
Luo Jiaxingef634642018-12-19 23:56:39 +0800488 struct dentry *debugfs_dir;
Luo Jiaxing49159a52018-12-19 23:56:41 +0800489 struct dentry *debugfs_dump_dentry;
Xiang Chen97b151e2019-09-06 20:55:36 +0800490 struct dentry *debugfs_bist_dentry;
Luo Jiaxingcd96fe62021-01-26 19:04:28 +0800491 struct dentry *debugfs_fifo_dentry;
John Garry7eb78692015-11-18 00:50:31 +0800492};
493
John Garryc799d6b2015-11-18 00:50:33 +0800494/* Generic HW DMA host memory structures */
495/* Delivery queue header */
496struct hisi_sas_cmd_hdr {
497 /* dw0 */
498 __le32 dw0;
499
500 /* dw1 */
501 __le32 dw1;
502
503 /* dw2 */
504 __le32 dw2;
505
506 /* dw3 */
507 __le32 transfer_tags;
508
509 /* dw4 */
510 __le32 data_transfer_len;
511
512 /* dw5 */
513 __le32 first_burst_num;
514
515 /* dw6 */
516 __le32 sg_len;
517
518 /* dw7 */
519 __le32 dw7;
520
521 /* dw8-9 */
522 __le64 cmd_table_addr;
523
524 /* dw10-11 */
525 __le64 sts_buffer_addr;
526
527 /* dw12-13 */
528 __le64 prd_table_addr;
529
530 /* dw14-15 */
531 __le64 dif_prd_table_addr;
532};
533
534struct hisi_sas_itct {
535 __le64 qw0;
536 __le64 sas_addr;
537 __le64 qw2;
538 __le64 qw3;
John Garry281e3bf2016-01-26 02:47:06 +0800539 __le64 qw4_15[12];
John Garryc799d6b2015-11-18 00:50:33 +0800540};
541
542struct hisi_sas_iost {
543 __le64 qw0;
544 __le64 qw1;
545 __le64 qw2;
546 __le64 qw3;
547};
548
549struct hisi_sas_err_record {
John Garry8d1eee72016-01-26 02:47:05 +0800550 u32 data[4];
John Garryc799d6b2015-11-18 00:50:33 +0800551};
552
553struct hisi_sas_initial_fis {
554 struct hisi_sas_err_record err_record;
555 struct dev_to_host_fis fis;
556 u32 rsvd[3];
557};
558
559struct hisi_sas_breakpoint {
Xiang Chen3297ded2017-10-24 23:51:35 +0800560 u8 data[128];
561};
562
563struct hisi_sas_sata_breakpoint {
564 struct hisi_sas_breakpoint tag[32];
John Garryc799d6b2015-11-18 00:50:33 +0800565};
566
567struct hisi_sas_sge {
568 __le64 addr;
569 __le32 page_ctrl_0;
570 __le32 page_ctrl_1;
571 __le32 data_len;
572 __le32 data_off;
573};
574
575struct hisi_sas_command_table_smp {
576 u8 bytes[44];
577};
578
579struct hisi_sas_command_table_stp {
580 struct host_to_dev_fis command_fis;
581 u8 dummy[12];
582 u8 atapi_cdb[ATAPI_CDB_LEN];
583};
584
John Garryc7669f52019-05-29 17:58:44 +0800585#define HISI_SAS_SGE_PAGE_CNT (124)
John Garryc799d6b2015-11-18 00:50:33 +0800586struct hisi_sas_sge_page {
587 struct hisi_sas_sge sge[HISI_SAS_SGE_PAGE_CNT];
Xiaofei Tanf557e322017-06-29 21:02:14 +0800588} __aligned(16);
John Garryc799d6b2015-11-18 00:50:33 +0800589
John Garryc7669f52019-05-29 17:58:44 +0800590#define HISI_SAS_SGE_DIF_PAGE_CNT HISI_SAS_SGE_PAGE_CNT
Xiang Chenb3cce122019-02-06 18:52:51 +0800591struct hisi_sas_sge_dif_page {
592 struct hisi_sas_sge sge[HISI_SAS_SGE_DIF_PAGE_CNT];
593} __aligned(16);
594
John Garryc799d6b2015-11-18 00:50:33 +0800595struct hisi_sas_command_table_ssp {
596 struct ssp_frame_hdr hdr;
597 union {
598 struct {
599 struct ssp_command_iu task;
Xiang Chena14da7a2018-05-02 23:56:27 +0800600 u32 prot[7];
John Garryc799d6b2015-11-18 00:50:33 +0800601 };
602 struct ssp_tmf_iu ssp_task;
603 struct xfer_rdy_iu xfer_rdy;
604 struct ssp_response_iu ssp_res;
605 } u;
606};
607
608union hisi_sas_command_table {
609 struct hisi_sas_command_table_ssp ssp;
610 struct hisi_sas_command_table_smp smp;
611 struct hisi_sas_command_table_stp stp;
Xiaofei Tanf557e322017-06-29 21:02:14 +0800612} __aligned(16);
613
614struct hisi_sas_status_buffer {
615 struct hisi_sas_err_record err;
616 u8 iu[1024];
617} __aligned(16);
618
619struct hisi_sas_slot_buf_table {
620 struct hisi_sas_status_buffer status_buffer;
621 union hisi_sas_command_table command_header;
622 struct hisi_sas_sge_page sge_page;
John Garryc799d6b2015-11-18 00:50:33 +0800623};
John Garry2e244f02017-03-23 01:25:17 +0800624
Xiang Chenb3cce122019-02-06 18:52:51 +0800625struct hisi_sas_slot_dif_buf_table {
626 struct hisi_sas_slot_buf_table slot_buf;
627 struct hisi_sas_sge_dif_page sge_dif_page;
628};
629
John Garrye21fe3a2017-06-14 23:33:20 +0800630extern struct scsi_transport_template *hisi_sas_stt;
Luo Jiaxingef634642018-12-19 23:56:39 +0800631
632extern bool hisi_sas_debugfs_enable;
Luo Jiaxing905ab012019-10-24 22:08:22 +0800633extern u32 hisi_sas_debugfs_dump_count;
Luo Jiaxingef634642018-12-19 23:56:39 +0800634extern struct dentry *hisi_sas_debugfs_dir;
635
Xiang Chena25d0d32017-08-11 00:09:40 +0800636extern void hisi_sas_stop_phys(struct hisi_hba *hisi_hba);
Xiang Chenae68b562019-01-25 22:22:33 +0800637extern int hisi_sas_alloc(struct hisi_hba *hisi_hba);
John Garrye21fe3a2017-06-14 23:33:20 +0800638extern void hisi_sas_free(struct hisi_hba *hisi_hba);
chenxiang468f4b82017-12-28 18:20:47 +0800639extern u8 hisi_sas_get_ata_protocol(struct host_to_dev_fis *fis,
640 int direction);
John Garry2e244f02017-03-23 01:25:17 +0800641extern struct hisi_sas_port *to_hisi_sas_port(struct asd_sas_port *sas_port);
Xiang Chen75904072017-06-14 23:33:15 +0800642extern void hisi_sas_sata_done(struct sas_task *task,
643 struct hisi_sas_slot *slot);
John Garry0fa24c12017-06-14 23:33:18 +0800644extern int hisi_sas_get_fw_info(struct hisi_hba *hisi_hba);
John Garry9fb10b52015-11-18 00:50:44 +0800645extern int hisi_sas_probe(struct platform_device *pdev,
646 const struct hisi_sas_hw *ops);
647extern int hisi_sas_remove(struct platform_device *pdev);
John Garryc799d6b2015-11-18 00:50:33 +0800648
Xiang Chen235bfc72018-05-21 18:09:18 +0800649extern int hisi_sas_slave_configure(struct scsi_device *sdev);
650extern int hisi_sas_scan_finished(struct Scsi_Host *shost, unsigned long time);
651extern void hisi_sas_scan_start(struct Scsi_Host *shost);
Xiang Chen235bfc72018-05-21 18:09:18 +0800652extern int hisi_sas_host_reset(struct Scsi_Host *shost, int reset_type);
John Garryc63b88c2019-04-11 20:46:38 +0800653extern void hisi_sas_phy_enable(struct hisi_hba *hisi_hba, int phy_no,
654 int enable);
Ahmed S. Darwish26c7efc2021-01-18 11:09:47 +0100655extern void hisi_sas_phy_down(struct hisi_hba *hisi_hba, int phy_no, int rdy,
656 gfp_t gfp_flags);
John Garry27a3f222015-11-18 00:50:50 +0800657extern void hisi_sas_slot_task_free(struct hisi_hba *hisi_hba,
658 struct sas_task *task,
659 struct hisi_sas_slot *slot);
Xiang Chen06ec0fb2017-03-23 01:25:18 +0800660extern void hisi_sas_init_mem(struct hisi_hba *hisi_hba);
Xiaofei Tanb4241f02017-10-24 23:51:45 +0800661extern void hisi_sas_rst_work_handler(struct work_struct *work);
Xiaofei Tane402acd2017-12-09 01:16:38 +0800662extern void hisi_sas_sync_rst_work_handler(struct work_struct *work);
Xiang Chen81f338e2020-01-20 20:22:31 +0800663extern void hisi_sas_sync_irqs(struct hisi_hba *hisi_hba);
Xiaofei Tanb6c9b152019-01-25 22:22:35 +0800664extern void hisi_sas_phy_oob_ready(struct hisi_hba *hisi_hba, int phy_no);
Xiaofei Tane537b622017-12-09 01:16:44 +0800665extern bool hisi_sas_notify_phy_event(struct hisi_sas_phy *phy,
666 enum hisi_sas_phy_event event);
Xiang Chen4d0951e2017-12-09 01:16:50 +0800667extern void hisi_sas_release_tasks(struct hisi_hba *hisi_hba);
Xiang Chenc2c1d9d2018-05-02 23:56:30 +0800668extern u8 hisi_sas_get_prog_phy_linkrate_mask(enum sas_linkrate max);
Xiaofei Tan45222042018-07-18 22:14:28 +0800669extern void hisi_sas_controller_reset_prepare(struct hisi_hba *hisi_hba);
670extern void hisi_sas_controller_reset_done(struct hisi_hba *hisi_hba);
John Garrye8899fa2015-11-18 00:50:30 +0800671#endif