2 * Copyright (c) 2015 Linaro Ltd.
3 * Copyright (c) 2015 Hisilicon Limited.
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.
15 #include <linux/acpi.h>
16 #include <linux/clk.h>
17 #include <linux/dmapool.h>
18 #include <linux/iopoll.h>
19 #include <linux/lcm.h>
20 #include <linux/mfd/syscon.h>
21 #include <linux/module.h>
22 #include <linux/of_address.h>
23 #include <linux/pci.h>
24 #include <linux/platform_device.h>
25 #include <linux/property.h>
26 #include <linux/regmap.h>
27 #include <scsi/sas_ata.h>
28 #include <scsi/libsas.h>
30 #define HISI_SAS_MAX_PHYS 9
31 #define HISI_SAS_MAX_QUEUES 32
32 #define HISI_SAS_QUEUE_SLOTS 512
33 #define HISI_SAS_MAX_ITCT_ENTRIES 1024
34 #define HISI_SAS_MAX_DEVICES HISI_SAS_MAX_ITCT_ENTRIES
35 #define HISI_SAS_RESET_BIT 0
36 #define HISI_SAS_REJECT_CMD_BIT 1
38 #define HISI_SAS_STATUS_BUF_SZ (sizeof(struct hisi_sas_status_buffer))
39 #define HISI_SAS_COMMAND_TABLE_SZ (sizeof(union hisi_sas_command_table))
41 #define hisi_sas_status_buf_addr(buf) \
42 (buf + offsetof(struct hisi_sas_slot_buf_table, status_buffer))
43 #define hisi_sas_status_buf_addr_mem(slot) hisi_sas_status_buf_addr(slot->buf)
44 #define hisi_sas_status_buf_addr_dma(slot) \
45 hisi_sas_status_buf_addr(slot->buf_dma)
47 #define hisi_sas_cmd_hdr_addr(buf) \
48 (buf + offsetof(struct hisi_sas_slot_buf_table, command_header))
49 #define hisi_sas_cmd_hdr_addr_mem(slot) hisi_sas_cmd_hdr_addr(slot->buf)
50 #define hisi_sas_cmd_hdr_addr_dma(slot) hisi_sas_cmd_hdr_addr(slot->buf_dma)
52 #define hisi_sas_sge_addr(buf) \
53 (buf + offsetof(struct hisi_sas_slot_buf_table, sge_page))
54 #define hisi_sas_sge_addr_mem(slot) hisi_sas_sge_addr(slot->buf)
55 #define hisi_sas_sge_addr_dma(slot) hisi_sas_sge_addr(slot->buf_dma)
57 #define HISI_SAS_MAX_SSP_RESP_SZ (sizeof(struct ssp_frame_hdr) + 1024)
58 #define HISI_SAS_MAX_SMP_RESP_SZ 1028
59 #define HISI_SAS_MAX_STP_RESP_SZ 28
61 #define DEV_IS_EXPANDER(type) \
62 ((type == SAS_EDGE_EXPANDER_DEVICE) || \
63 (type == SAS_FANOUT_EXPANDER_DEVICE))
65 #define HISI_SAS_SATA_PROTOCOL_NONDATA 0x1
66 #define HISI_SAS_SATA_PROTOCOL_PIO 0x2
67 #define HISI_SAS_SATA_PROTOCOL_DMA 0x4
68 #define HISI_SAS_SATA_PROTOCOL_FPDMA 0x8
69 #define HISI_SAS_SATA_PROTOCOL_ATAPI 0x10
74 PORT_TYPE_SAS
= (1U << 1),
75 PORT_TYPE_SATA
= (1U << 0),
84 HISI_SAS_INT_ABT_CMD
= 0,
85 HISI_SAS_INT_ABT_DEV
= 1,
88 enum hisi_sas_dev_type
{
89 HISI_SAS_DEV_TYPE_STP
= 0,
90 HISI_SAS_DEV_TYPE_SSP
,
91 HISI_SAS_DEV_TYPE_SATA
,
94 struct hisi_sas_hw_error
{
100 const struct hisi_sas_hw_error
*sub
;
103 struct hisi_sas_rst
{
104 struct hisi_hba
*hisi_hba
;
105 struct completion
*completion
;
106 struct work_struct work
;
110 #define HISI_SAS_RST_WORK_INIT(r, c) \
111 { .hisi_hba = hisi_hba, \
113 .work = __WORK_INITIALIZER(r.work, \
114 hisi_sas_sync_rst_work_handler), \
118 #define HISI_SAS_DECLARE_RST_WORK_ON_STACK(r) \
119 DECLARE_COMPLETION_ONSTACK(c); \
120 DECLARE_WORK(w, hisi_sas_sync_rst_work_handler); \
121 struct hisi_sas_rst r = HISI_SAS_RST_WORK_INIT(r, c)
123 enum hisi_sas_bit_err_type
{
124 HISI_SAS_ERR_SINGLE_BIT_ECC
= 0x0,
125 HISI_SAS_ERR_MULTI_BIT_ECC
= 0x1,
128 enum hisi_sas_phy_event
{
129 HISI_PHYE_PHY_UP
= 0U,
130 HISI_PHYE_LINK_RESET
,
134 struct hisi_sas_phy
{
135 struct work_struct works
[HISI_PHYES_NUM
];
136 struct hisi_hba
*hisi_hba
;
137 struct hisi_sas_port
*port
;
138 struct asd_sas_phy sas_phy
;
139 struct sas_identify identify
;
140 struct completion
*reset_completion
;
142 u64 port_id
; /* from hw */
149 enum sas_linkrate minimum_linkrate
;
150 enum sas_linkrate maximum_linkrate
;
153 struct hisi_sas_port
{
154 struct asd_sas_port sas_port
;
160 struct hisi_hba
*hisi_hba
;
161 struct tasklet_struct tasklet
;
167 struct hisi_hba
*hisi_hba
;
168 struct list_head list
;
174 struct hisi_sas_device
{
175 struct hisi_hba
*hisi_hba
;
176 struct domain_device
*sas_device
;
177 struct completion
*completion
;
178 struct hisi_sas_dq
*dq
;
179 struct list_head list
;
180 enum sas_device_type dev_type
;
186 struct hisi_sas_tmf_task
{
190 u16 tag_of_task_to_be_managed
;
193 struct hisi_sas_slot
{
194 struct list_head entry
;
195 struct list_head delivery
;
196 struct sas_task
*task
;
197 struct hisi_sas_port
*port
;
200 int dlvry_queue_slot
;
202 int cmplt_queue_slot
;
206 dma_addr_t cmd_hdr_dma
;
207 struct work_struct abort_slot
;
208 struct timer_list internal_abort_timer
;
210 struct hisi_sas_tmf_task
*tmf
;
211 /* Do not reorder/change members after here */
218 int (*hw_init
)(struct hisi_hba
*hisi_hba
);
219 void (*setup_itct
)(struct hisi_hba
*hisi_hba
,
220 struct hisi_sas_device
*device
);
221 int (*slot_index_alloc
)(struct hisi_hba
*hisi_hba
, int *slot_idx
,
222 struct domain_device
*device
);
223 struct hisi_sas_device
*(*alloc_dev
)(struct domain_device
*device
);
224 void (*sl_notify
)(struct hisi_hba
*hisi_hba
, int phy_no
);
225 int (*get_free_slot
)(struct hisi_hba
*hisi_hba
, struct hisi_sas_dq
*dq
);
226 void (*start_delivery
)(struct hisi_sas_dq
*dq
);
227 void (*prep_ssp
)(struct hisi_hba
*hisi_hba
,
228 struct hisi_sas_slot
*slot
);
229 void (*prep_smp
)(struct hisi_hba
*hisi_hba
,
230 struct hisi_sas_slot
*slot
);
231 void (*prep_stp
)(struct hisi_hba
*hisi_hba
,
232 struct hisi_sas_slot
*slot
);
233 void (*prep_abort
)(struct hisi_hba
*hisi_hba
,
234 struct hisi_sas_slot
*slot
,
235 int device_id
, int abort_flag
, int tag_to_abort
);
236 int (*slot_complete
)(struct hisi_hba
*hisi_hba
,
237 struct hisi_sas_slot
*slot
);
238 void (*phys_init
)(struct hisi_hba
*hisi_hba
);
239 void (*phy_start
)(struct hisi_hba
*hisi_hba
, int phy_no
);
240 void (*phy_disable
)(struct hisi_hba
*hisi_hba
, int phy_no
);
241 void (*phy_hard_reset
)(struct hisi_hba
*hisi_hba
, int phy_no
);
242 void (*get_events
)(struct hisi_hba
*hisi_hba
, int phy_no
);
243 void (*phy_set_linkrate
)(struct hisi_hba
*hisi_hba
, int phy_no
,
244 struct sas_phy_linkrates
*linkrates
);
245 enum sas_linkrate (*phy_get_max_linkrate
)(void);
246 void (*clear_itct
)(struct hisi_hba
*hisi_hba
,
247 struct hisi_sas_device
*dev
);
248 void (*free_device
)(struct hisi_sas_device
*sas_dev
);
249 int (*get_wideport_bitmap
)(struct hisi_hba
*hisi_hba
, int port_id
);
250 void (*dereg_device
)(struct hisi_hba
*hisi_hba
,
251 struct domain_device
*device
);
252 int (*soft_reset
)(struct hisi_hba
*hisi_hba
);
253 u32 (*get_phys_state
)(struct hisi_hba
*hisi_hba
);
254 int (*write_gpio
)(struct hisi_hba
*hisi_hba
, u8 reg_type
,
255 u8 reg_index
, u8 reg_count
, u8
*write_data
);
256 void (*wait_cmds_complete_timeout
)(struct hisi_hba
*hisi_hba
,
257 int delay_ms
, int timeout_ms
);
258 int max_command_entries
;
259 int complete_hdr_size
;
260 struct scsi_host_template
*sht
;
264 /* This must be the first element, used by SHOST_TO_SAS_HA */
265 struct sas_ha_struct
*p
;
267 struct platform_device
*platform_dev
;
268 struct pci_dev
*pci_dev
;
272 void __iomem
*sgpio_regs
;
275 u32 ctrl_reset_sts_reg
;
276 u32 ctrl_clock_ena_reg
;
277 u32 refclk_frequency_mhz
;
278 u8 sas_addr
[SAS_ADDR_SIZE
];
282 struct semaphore sem
;
284 struct timer_list timer
;
285 struct workqueue_struct
*wq
;
287 int slot_index_count
;
290 unsigned long *slot_index_tags
;
291 unsigned long reject_stp_links_msk
;
294 struct sas_ha_struct sha
;
295 struct Scsi_Host
*shost
;
297 struct hisi_sas_cq cq
[HISI_SAS_MAX_QUEUES
];
298 struct hisi_sas_dq dq
[HISI_SAS_MAX_QUEUES
];
299 struct hisi_sas_phy phy
[HISI_SAS_MAX_PHYS
];
300 struct hisi_sas_port port
[HISI_SAS_MAX_PHYS
];
304 struct hisi_sas_device devices
[HISI_SAS_MAX_DEVICES
];
305 struct hisi_sas_cmd_hdr
*cmd_hdr
[HISI_SAS_MAX_QUEUES
];
306 dma_addr_t cmd_hdr_dma
[HISI_SAS_MAX_QUEUES
];
307 void *complete_hdr
[HISI_SAS_MAX_QUEUES
];
308 dma_addr_t complete_hdr_dma
[HISI_SAS_MAX_QUEUES
];
309 struct hisi_sas_initial_fis
*initial_fis
;
310 dma_addr_t initial_fis_dma
;
311 struct hisi_sas_itct
*itct
;
313 struct hisi_sas_iost
*iost
;
315 struct hisi_sas_breakpoint
*breakpoint
;
316 dma_addr_t breakpoint_dma
;
317 struct hisi_sas_breakpoint
*sata_breakpoint
;
318 dma_addr_t sata_breakpoint_dma
;
319 struct hisi_sas_slot
*slot_info
;
321 const struct hisi_sas_hw
*hw
; /* Low level hw interface */
322 unsigned long sata_dev_bitmap
[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES
)];
323 struct work_struct rst_work
;
327 /* Generic HW DMA host memory structures */
328 /* Delivery queue header */
329 struct hisi_sas_cmd_hdr
{
340 __le32 transfer_tags
;
343 __le32 data_transfer_len
;
346 __le32 first_burst_num
;
355 __le64 cmd_table_addr
;
358 __le64 sts_buffer_addr
;
361 __le64 prd_table_addr
;
364 __le64 dif_prd_table_addr
;
367 struct hisi_sas_itct
{
375 struct hisi_sas_iost
{
382 struct hisi_sas_err_record
{
386 struct hisi_sas_initial_fis
{
387 struct hisi_sas_err_record err_record
;
388 struct dev_to_host_fis fis
;
392 struct hisi_sas_breakpoint
{
396 struct hisi_sas_sata_breakpoint
{
397 struct hisi_sas_breakpoint tag
[32];
400 struct hisi_sas_sge
{
408 struct hisi_sas_command_table_smp
{
412 struct hisi_sas_command_table_stp
{
413 struct host_to_dev_fis command_fis
;
415 u8 atapi_cdb
[ATAPI_CDB_LEN
];
418 #define HISI_SAS_SGE_PAGE_CNT SG_CHUNK_SIZE
419 struct hisi_sas_sge_page
{
420 struct hisi_sas_sge sge
[HISI_SAS_SGE_PAGE_CNT
];
423 struct hisi_sas_command_table_ssp
{
424 struct ssp_frame_hdr hdr
;
427 struct ssp_command_iu task
;
430 struct ssp_tmf_iu ssp_task
;
431 struct xfer_rdy_iu xfer_rdy
;
432 struct ssp_response_iu ssp_res
;
436 union hisi_sas_command_table
{
437 struct hisi_sas_command_table_ssp ssp
;
438 struct hisi_sas_command_table_smp smp
;
439 struct hisi_sas_command_table_stp stp
;
442 struct hisi_sas_status_buffer
{
443 struct hisi_sas_err_record err
;
447 struct hisi_sas_slot_buf_table
{
448 struct hisi_sas_status_buffer status_buffer
;
449 union hisi_sas_command_table command_header
;
450 struct hisi_sas_sge_page sge_page
;
453 extern struct scsi_transport_template
*hisi_sas_stt
;
454 extern void hisi_sas_stop_phys(struct hisi_hba
*hisi_hba
);
455 extern int hisi_sas_alloc(struct hisi_hba
*hisi_hba
, struct Scsi_Host
*shost
);
456 extern void hisi_sas_free(struct hisi_hba
*hisi_hba
);
457 extern u8
hisi_sas_get_ata_protocol(struct host_to_dev_fis
*fis
,
459 extern struct hisi_sas_port
*to_hisi_sas_port(struct asd_sas_port
*sas_port
);
460 extern void hisi_sas_sata_done(struct sas_task
*task
,
461 struct hisi_sas_slot
*slot
);
462 extern int hisi_sas_get_ncq_tag(struct sas_task
*task
, u32
*tag
);
463 extern int hisi_sas_get_fw_info(struct hisi_hba
*hisi_hba
);
464 extern int hisi_sas_probe(struct platform_device
*pdev
,
465 const struct hisi_sas_hw
*ops
);
466 extern int hisi_sas_remove(struct platform_device
*pdev
);
468 extern int hisi_sas_slave_configure(struct scsi_device
*sdev
);
469 extern int hisi_sas_scan_finished(struct Scsi_Host
*shost
, unsigned long time
);
470 extern void hisi_sas_scan_start(struct Scsi_Host
*shost
);
471 extern struct device_attribute
*host_attrs
[];
472 extern int hisi_sas_host_reset(struct Scsi_Host
*shost
, int reset_type
);
473 extern void hisi_sas_phy_down(struct hisi_hba
*hisi_hba
, int phy_no
, int rdy
);
474 extern void hisi_sas_slot_task_free(struct hisi_hba
*hisi_hba
,
475 struct sas_task
*task
,
476 struct hisi_sas_slot
*slot
);
477 extern void hisi_sas_init_mem(struct hisi_hba
*hisi_hba
);
478 extern void hisi_sas_rst_work_handler(struct work_struct
*work
);
479 extern void hisi_sas_sync_rst_work_handler(struct work_struct
*work
);
480 extern void hisi_sas_kill_tasklets(struct hisi_hba
*hisi_hba
);
481 extern bool hisi_sas_notify_phy_event(struct hisi_sas_phy
*phy
,
482 enum hisi_sas_phy_event event
);
483 extern void hisi_sas_release_tasks(struct hisi_hba
*hisi_hba
);
484 extern u8
hisi_sas_get_prog_phy_linkrate_mask(enum sas_linkrate max
);
485 extern void hisi_sas_controller_reset_prepare(struct hisi_hba
*hisi_hba
);
486 extern void hisi_sas_controller_reset_done(struct hisi_hba
*hisi_hba
);