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/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>
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
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))
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)
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)
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)
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
60 #define DEV_IS_EXPANDER(type) \
61 ((type == SAS_EDGE_EXPANDER_DEVICE) || \
62 (type == SAS_FANOUT_EXPANDER_DEVICE))
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
73 PORT_TYPE_SAS
= (1U << 1),
74 PORT_TYPE_SATA
= (1U << 0),
83 HISI_SAS_INT_ABT_CMD
= 0,
84 HISI_SAS_INT_ABT_DEV
= 1,
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
,
93 struct hisi_sas_hw_error
{
99 const struct hisi_sas_hw_error
*sub
;
102 struct hisi_sas_phy
{
103 struct hisi_hba
*hisi_hba
;
104 struct hisi_sas_port
*port
;
105 struct asd_sas_phy sas_phy
;
106 struct sas_identify identify
;
107 struct timer_list timer
;
108 struct work_struct phyup_ws
;
109 u64 port_id
; /* from hw */
116 enum sas_linkrate minimum_linkrate
;
117 enum sas_linkrate maximum_linkrate
;
120 struct hisi_sas_port
{
121 struct asd_sas_port sas_port
;
127 struct hisi_hba
*hisi_hba
;
128 struct tasklet_struct tasklet
;
134 struct hisi_hba
*hisi_hba
;
135 struct hisi_sas_slot
*slot_prep
;
141 struct hisi_sas_device
{
142 struct hisi_hba
*hisi_hba
;
143 struct domain_device
*sas_device
;
144 struct completion
*completion
;
145 struct hisi_sas_dq
*dq
;
146 struct list_head list
;
148 atomic64_t running_req
;
149 enum sas_device_type dev_type
;
155 struct hisi_sas_slot
{
156 struct list_head entry
;
157 struct sas_task
*task
;
158 struct hisi_sas_port
*port
;
161 int dlvry_queue_slot
;
163 int cmplt_queue_slot
;
169 dma_addr_t cmd_hdr_dma
;
170 struct work_struct abort_slot
;
171 struct timer_list internal_abort_timer
;
174 struct hisi_sas_tmf_task
{
176 u16 tag_of_task_to_be_managed
;
180 int (*hw_init
)(struct hisi_hba
*hisi_hba
);
181 void (*setup_itct
)(struct hisi_hba
*hisi_hba
,
182 struct hisi_sas_device
*device
);
183 int (*slot_index_alloc
)(struct hisi_hba
*hisi_hba
, int *slot_idx
,
184 struct domain_device
*device
);
185 struct hisi_sas_device
*(*alloc_dev
)(struct domain_device
*device
);
186 void (*sl_notify
)(struct hisi_hba
*hisi_hba
, int phy_no
);
187 int (*get_free_slot
)(struct hisi_hba
*hisi_hba
, struct hisi_sas_dq
*dq
);
188 void (*start_delivery
)(struct hisi_sas_dq
*dq
);
189 int (*prep_ssp
)(struct hisi_hba
*hisi_hba
,
190 struct hisi_sas_slot
*slot
, int is_tmf
,
191 struct hisi_sas_tmf_task
*tmf
);
192 int (*prep_smp
)(struct hisi_hba
*hisi_hba
,
193 struct hisi_sas_slot
*slot
);
194 int (*prep_stp
)(struct hisi_hba
*hisi_hba
,
195 struct hisi_sas_slot
*slot
);
196 int (*prep_abort
)(struct hisi_hba
*hisi_hba
,
197 struct hisi_sas_slot
*slot
,
198 int device_id
, int abort_flag
, int tag_to_abort
);
199 int (*slot_complete
)(struct hisi_hba
*hisi_hba
,
200 struct hisi_sas_slot
*slot
);
201 void (*phys_init
)(struct hisi_hba
*hisi_hba
);
202 void (*phy_start
)(struct hisi_hba
*hisi_hba
, int phy_no
);
203 void (*phy_disable
)(struct hisi_hba
*hisi_hba
, int phy_no
);
204 void (*phy_hard_reset
)(struct hisi_hba
*hisi_hba
, int phy_no
);
205 void (*get_events
)(struct hisi_hba
*hisi_hba
, int phy_no
);
206 void (*phy_set_linkrate
)(struct hisi_hba
*hisi_hba
, int phy_no
,
207 struct sas_phy_linkrates
*linkrates
);
208 enum sas_linkrate (*phy_get_max_linkrate
)(void);
209 void (*free_device
)(struct hisi_hba
*hisi_hba
,
210 struct hisi_sas_device
*dev
);
211 int (*get_wideport_bitmap
)(struct hisi_hba
*hisi_hba
, int port_id
);
212 void (*dereg_device
)(struct hisi_hba
*hisi_hba
,
213 struct domain_device
*device
);
214 int (*soft_reset
)(struct hisi_hba
*hisi_hba
);
215 u32 (*get_phys_state
)(struct hisi_hba
*hisi_hba
);
216 int max_command_entries
;
217 int complete_hdr_size
;
221 /* This must be the first element, used by SHOST_TO_SAS_HA */
222 struct sas_ha_struct
*p
;
224 struct platform_device
*platform_dev
;
225 struct pci_dev
*pci_dev
;
231 u32 ctrl_reset_sts_reg
;
232 u32 ctrl_clock_ena_reg
;
233 u32 refclk_frequency_mhz
;
234 u8 sas_addr
[SAS_ADDR_SIZE
];
239 struct timer_list timer
;
240 struct workqueue_struct
*wq
;
242 int slot_index_count
;
243 unsigned long *slot_index_tags
;
244 unsigned long reject_stp_links_msk
;
247 struct sas_ha_struct sha
;
248 struct Scsi_Host
*shost
;
250 struct hisi_sas_cq cq
[HISI_SAS_MAX_QUEUES
];
251 struct hisi_sas_dq dq
[HISI_SAS_MAX_QUEUES
];
252 struct hisi_sas_phy phy
[HISI_SAS_MAX_PHYS
];
253 struct hisi_sas_port port
[HISI_SAS_MAX_PHYS
];
257 struct dma_pool
*buffer_pool
;
258 struct hisi_sas_device devices
[HISI_SAS_MAX_DEVICES
];
259 struct hisi_sas_cmd_hdr
*cmd_hdr
[HISI_SAS_MAX_QUEUES
];
260 dma_addr_t cmd_hdr_dma
[HISI_SAS_MAX_QUEUES
];
261 void *complete_hdr
[HISI_SAS_MAX_QUEUES
];
262 dma_addr_t complete_hdr_dma
[HISI_SAS_MAX_QUEUES
];
263 struct hisi_sas_initial_fis
*initial_fis
;
264 dma_addr_t initial_fis_dma
;
265 struct hisi_sas_itct
*itct
;
267 struct hisi_sas_iost
*iost
;
269 struct hisi_sas_breakpoint
*breakpoint
;
270 dma_addr_t breakpoint_dma
;
271 struct hisi_sas_breakpoint
*sata_breakpoint
;
272 dma_addr_t sata_breakpoint_dma
;
273 struct hisi_sas_slot
*slot_info
;
275 const struct hisi_sas_hw
*hw
; /* Low level hw interface */
276 unsigned long sata_dev_bitmap
[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES
)];
277 struct work_struct rst_work
;
280 /* Generic HW DMA host memory structures */
281 /* Delivery queue header */
282 struct hisi_sas_cmd_hdr
{
293 __le32 transfer_tags
;
296 __le32 data_transfer_len
;
299 __le32 first_burst_num
;
308 __le64 cmd_table_addr
;
311 __le64 sts_buffer_addr
;
314 __le64 prd_table_addr
;
317 __le64 dif_prd_table_addr
;
320 struct hisi_sas_itct
{
328 struct hisi_sas_iost
{
335 struct hisi_sas_err_record
{
339 struct hisi_sas_initial_fis
{
340 struct hisi_sas_err_record err_record
;
341 struct dev_to_host_fis fis
;
345 struct hisi_sas_breakpoint
{
349 struct hisi_sas_sata_breakpoint
{
350 struct hisi_sas_breakpoint tag
[32];
353 struct hisi_sas_sge
{
361 struct hisi_sas_command_table_smp
{
365 struct hisi_sas_command_table_stp
{
366 struct host_to_dev_fis command_fis
;
368 u8 atapi_cdb
[ATAPI_CDB_LEN
];
371 #define HISI_SAS_SGE_PAGE_CNT SG_CHUNK_SIZE
372 struct hisi_sas_sge_page
{
373 struct hisi_sas_sge sge
[HISI_SAS_SGE_PAGE_CNT
];
376 struct hisi_sas_command_table_ssp
{
377 struct ssp_frame_hdr hdr
;
380 struct ssp_command_iu task
;
383 struct ssp_tmf_iu ssp_task
;
384 struct xfer_rdy_iu xfer_rdy
;
385 struct ssp_response_iu ssp_res
;
389 union hisi_sas_command_table
{
390 struct hisi_sas_command_table_ssp ssp
;
391 struct hisi_sas_command_table_smp smp
;
392 struct hisi_sas_command_table_stp stp
;
395 struct hisi_sas_status_buffer
{
396 struct hisi_sas_err_record err
;
400 struct hisi_sas_slot_buf_table
{
401 struct hisi_sas_status_buffer status_buffer
;
402 union hisi_sas_command_table command_header
;
403 struct hisi_sas_sge_page sge_page
;
406 extern struct scsi_transport_template
*hisi_sas_stt
;
407 extern struct scsi_host_template
*hisi_sas_sht
;
409 extern void hisi_sas_stop_phys(struct hisi_hba
*hisi_hba
);
410 extern void hisi_sas_init_add(struct hisi_hba
*hisi_hba
);
411 extern int hisi_sas_alloc(struct hisi_hba
*hisi_hba
, struct Scsi_Host
*shost
);
412 extern void hisi_sas_free(struct hisi_hba
*hisi_hba
);
413 extern u8
hisi_sas_get_ata_protocol(u8 cmd
, int direction
);
414 extern struct hisi_sas_port
*to_hisi_sas_port(struct asd_sas_port
*sas_port
);
415 extern void hisi_sas_sata_done(struct sas_task
*task
,
416 struct hisi_sas_slot
*slot
);
417 extern int hisi_sas_get_ncq_tag(struct sas_task
*task
, u32
*tag
);
418 extern int hisi_sas_get_fw_info(struct hisi_hba
*hisi_hba
);
419 extern int hisi_sas_probe(struct platform_device
*pdev
,
420 const struct hisi_sas_hw
*ops
);
421 extern int hisi_sas_remove(struct platform_device
*pdev
);
423 extern void hisi_sas_phy_down(struct hisi_hba
*hisi_hba
, int phy_no
, int rdy
);
424 extern void hisi_sas_slot_task_free(struct hisi_hba
*hisi_hba
,
425 struct sas_task
*task
,
426 struct hisi_sas_slot
*slot
);
427 extern void hisi_sas_init_mem(struct hisi_hba
*hisi_hba
);