[mirror_ubuntu-artful-kernel.git] / drivers / scsi / hisi_sas / hisi_sas.h

/*
 * Copyright (c) 2015 Linaro Ltd.
 * Copyright (c) 2015 Hisilicon Limited.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 */

#ifndef _HISI_SAS_H_
#define _HISI_SAS_H_

#include <linux/acpi.h>
#include <linux/clk.h>
#include <linux/dmapool.h>
#include <linux/mfd/syscon.h>
#include <linux/module.h>
#include <linux/of_address.h>
#include <linux/pci.h>
#include <linux/platform_device.h>
#include <linux/property.h>
#include <linux/regmap.h>
#include <scsi/sas_ata.h>
#include <scsi/libsas.h>

#define DRV_VERSION "v1.6"

#define HISI_SAS_MAX_PHYS	9
#define HISI_SAS_MAX_QUEUES	32
#define HISI_SAS_QUEUE_SLOTS 512
#define HISI_SAS_MAX_ITCT_ENTRIES 2048
#define HISI_SAS_MAX_DEVICES HISI_SAS_MAX_ITCT_ENTRIES
#define HISI_SAS_RESET_BIT	0
#define HISI_SAS_REJECT_CMD_BIT	1

#define HISI_SAS_STATUS_BUF_SZ (sizeof(struct hisi_sas_status_buffer))
#define HISI_SAS_COMMAND_TABLE_SZ (sizeof(union hisi_sas_command_table))

#define hisi_sas_status_buf_addr(buf) \
	(buf + offsetof(struct hisi_sas_slot_buf_table, status_buffer))
#define hisi_sas_status_buf_addr_mem(slot) hisi_sas_status_buf_addr(slot->buf)
#define hisi_sas_status_buf_addr_dma(slot) \
	hisi_sas_status_buf_addr(slot->buf_dma)

#define hisi_sas_cmd_hdr_addr(buf) \
	(buf + offsetof(struct hisi_sas_slot_buf_table, command_header))
#define hisi_sas_cmd_hdr_addr_mem(slot) hisi_sas_cmd_hdr_addr(slot->buf)
#define hisi_sas_cmd_hdr_addr_dma(slot) hisi_sas_cmd_hdr_addr(slot->buf_dma)

#define hisi_sas_sge_addr(buf) \
	(buf + offsetof(struct hisi_sas_slot_buf_table, sge_page))
#define hisi_sas_sge_addr_mem(slot) hisi_sas_sge_addr(slot->buf)
#define hisi_sas_sge_addr_dma(slot) hisi_sas_sge_addr(slot->buf_dma)

#define HISI_SAS_MAX_SSP_RESP_SZ (sizeof(struct ssp_frame_hdr) + 1024)
#define HISI_SAS_MAX_SMP_RESP_SZ 1028
#define HISI_SAS_MAX_STP_RESP_SZ 28

#define DEV_IS_EXPANDER(type) \
	((type == SAS_EDGE_EXPANDER_DEVICE) || \
	(type == SAS_FANOUT_EXPANDER_DEVICE))

#define HISI_SAS_SATA_PROTOCOL_NONDATA		0x1
#define HISI_SAS_SATA_PROTOCOL_PIO			0x2
#define HISI_SAS_SATA_PROTOCOL_DMA			0x4
#define HISI_SAS_SATA_PROTOCOL_FPDMA		0x8
#define HISI_SAS_SATA_PROTOCOL_ATAPI		0x10

struct hisi_hba;

enum {
	PORT_TYPE_SAS = (1U << 1),
	PORT_TYPE_SATA = (1U << 0),
};

enum dev_status {
	HISI_SAS_DEV_NORMAL,
	HISI_SAS_DEV_EH,
};

enum {
	HISI_SAS_INT_ABT_CMD = 0,
	HISI_SAS_INT_ABT_DEV = 1,
};

enum hisi_sas_dev_type {
	HISI_SAS_DEV_TYPE_STP = 0,
	HISI_SAS_DEV_TYPE_SSP,
	HISI_SAS_DEV_TYPE_SATA,
};

struct hisi_sas_phy {
	struct hisi_hba	*hisi_hba;
	struct hisi_sas_port	*port;
	struct asd_sas_phy	sas_phy;
	struct sas_identify	identify;
	struct timer_list	timer;
	struct work_struct	phyup_ws;
	u64		port_id; /* from hw */
	u64		dev_sas_addr;
	u64		frame_rcvd_size;
	u8		frame_rcvd[32];
	u8		phy_attached;
	u8		reserved[3];
	u32		phy_type;
	enum sas_linkrate	minimum_linkrate;
	enum sas_linkrate	maximum_linkrate;
};

struct hisi_sas_port {
	struct asd_sas_port	sas_port;
	u8	port_attached;
	u8	id; /* from hw */
};

struct hisi_sas_cq {
	struct hisi_hba *hisi_hba;
	struct tasklet_struct tasklet;
	int	rd_point;
	int	id;
};

struct hisi_sas_dq {
	struct hisi_hba *hisi_hba;
	struct hisi_sas_slot	*slot_prep;
	spinlock_t lock;
	int	wr_point;
	int	id;
};

struct hisi_sas_device {
	struct hisi_hba		*hisi_hba;
	struct domain_device	*sas_device;
	struct completion *completion;
	struct hisi_sas_dq	*dq;
	struct list_head	list;
	u64 attached_phy;
	atomic64_t running_req;
	enum sas_device_type	dev_type;
	int device_id;
	int sata_idx;
	u8 dev_status;
};

struct hisi_sas_slot {
	struct list_head entry;
	struct sas_task *task;
	struct hisi_sas_port	*port;
	u64	n_elem;
	int	dlvry_queue;
	int	dlvry_queue_slot;
	int	cmplt_queue;
	int	cmplt_queue_slot;
	int	idx;
	int	abort;
	void	*buf;
	dma_addr_t buf_dma;
	void	*cmd_hdr;
	dma_addr_t cmd_hdr_dma;
	struct work_struct abort_slot;
	struct timer_list internal_abort_timer;
};

struct hisi_sas_tmf_task {
	u8 tmf;
	u16 tag_of_task_to_be_managed;
};

struct hisi_sas_hw {
	int (*hw_init)(struct hisi_hba *hisi_hba);
	void (*setup_itct)(struct hisi_hba *hisi_hba,
			   struct hisi_sas_device *device);
	int (*slot_index_alloc)(struct hisi_hba *hisi_hba, int *slot_idx,
				struct domain_device *device);
	struct hisi_sas_device *(*alloc_dev)(struct domain_device *device);
	void (*sl_notify)(struct hisi_hba *hisi_hba, int phy_no);
	int (*get_free_slot)(struct hisi_hba *hisi_hba, struct hisi_sas_dq *dq);
	void (*start_delivery)(struct hisi_sas_dq *dq);
	int (*prep_ssp)(struct hisi_hba *hisi_hba,
			struct hisi_sas_slot *slot, int is_tmf,
			struct hisi_sas_tmf_task *tmf);
	int (*prep_smp)(struct hisi_hba *hisi_hba,
			struct hisi_sas_slot *slot);
	int (*prep_stp)(struct hisi_hba *hisi_hba,
			struct hisi_sas_slot *slot);
	int (*prep_abort)(struct hisi_hba *hisi_hba,
			  struct hisi_sas_slot *slot,
			  int device_id, int abort_flag, int tag_to_abort);
	int (*slot_complete)(struct hisi_hba *hisi_hba,
			     struct hisi_sas_slot *slot);
	void (*phys_init)(struct hisi_hba *hisi_hba);
	void (*phy_start)(struct hisi_hba *hisi_hba, int phy_no);
	void (*phy_disable)(struct hisi_hba *hisi_hba, int phy_no);
	void (*phy_hard_reset)(struct hisi_hba *hisi_hba, int phy_no);
	void (*get_events)(struct hisi_hba *hisi_hba, int phy_no);
	void (*phy_set_linkrate)(struct hisi_hba *hisi_hba, int phy_no,
			struct sas_phy_linkrates *linkrates);
	enum sas_linkrate (*phy_get_max_linkrate)(void);
	void (*free_device)(struct hisi_hba *hisi_hba,
			    struct hisi_sas_device *dev);
	int (*get_wideport_bitmap)(struct hisi_hba *hisi_hba, int port_id);
	void (*dereg_device)(struct hisi_hba *hisi_hba,
				struct domain_device *device);
	int (*soft_reset)(struct hisi_hba *hisi_hba);
	u32 (*get_phys_state)(struct hisi_hba *hisi_hba);
	int (*write_gpio)(struct hisi_hba *hisi_hba, u8 reg_type,
				u8 reg_index, u8 reg_count, u8 *write_data);
	int max_command_entries;
	int complete_hdr_size;
};

struct hisi_hba {
	/* This must be the first element, used by SHOST_TO_SAS_HA */
	struct sas_ha_struct *p;

	struct platform_device *platform_dev;
	struct pci_dev *pci_dev;
	struct device *dev;

	void __iomem *regs;
	void __iomem *sgpio_regs;
	struct regmap *ctrl;
	u32 ctrl_reset_reg;
	u32 ctrl_reset_sts_reg;
	u32 ctrl_clock_ena_reg;
	u32 refclk_frequency_mhz;
	u8 sas_addr[SAS_ADDR_SIZE];

	int n_phy;
	spinlock_t lock;

	struct timer_list timer;
	struct workqueue_struct *wq;

	int slot_index_count;
	unsigned long *slot_index_tags;
	unsigned long reject_stp_links_msk;

	/* SCSI/SAS glue */
	struct sas_ha_struct sha;
	struct Scsi_Host *shost;

	struct hisi_sas_cq cq[HISI_SAS_MAX_QUEUES];
	struct hisi_sas_dq dq[HISI_SAS_MAX_QUEUES];
	struct hisi_sas_phy phy[HISI_SAS_MAX_PHYS];
	struct hisi_sas_port port[HISI_SAS_MAX_PHYS];

	int	queue_count;

	struct dma_pool *buffer_pool;
	struct hisi_sas_device	devices[HISI_SAS_MAX_DEVICES];
	struct hisi_sas_cmd_hdr	*cmd_hdr[HISI_SAS_MAX_QUEUES];
	dma_addr_t cmd_hdr_dma[HISI_SAS_MAX_QUEUES];
	void *complete_hdr[HISI_SAS_MAX_QUEUES];
	dma_addr_t complete_hdr_dma[HISI_SAS_MAX_QUEUES];
	struct hisi_sas_initial_fis *initial_fis;
	dma_addr_t initial_fis_dma;
	struct hisi_sas_itct *itct;
	dma_addr_t itct_dma;
	struct hisi_sas_iost *iost;
	dma_addr_t iost_dma;
	struct hisi_sas_breakpoint *breakpoint;
	dma_addr_t breakpoint_dma;
	struct hisi_sas_breakpoint *sata_breakpoint;
	dma_addr_t sata_breakpoint_dma;
	struct hisi_sas_slot	*slot_info;
	unsigned long flags;
	const struct hisi_sas_hw *hw;	/* Low level hw interface */
	unsigned long sata_dev_bitmap[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES)];
	struct work_struct rst_work;
};

/* Generic HW DMA host memory structures */
/* Delivery queue header */
struct hisi_sas_cmd_hdr {
	/* dw0 */
	__le32 dw0;

	/* dw1 */
	__le32 dw1;

	/* dw2 */
	__le32 dw2;

	/* dw3 */
	__le32 transfer_tags;

	/* dw4 */
	__le32 data_transfer_len;

	/* dw5 */
	__le32 first_burst_num;

	/* dw6 */
	__le32 sg_len;

	/* dw7 */
	__le32 dw7;

	/* dw8-9 */
	__le64 cmd_table_addr;

	/* dw10-11 */
	__le64 sts_buffer_addr;

	/* dw12-13 */
	__le64 prd_table_addr;

	/* dw14-15 */
	__le64 dif_prd_table_addr;
};

struct hisi_sas_itct {
	__le64 qw0;
	__le64 sas_addr;
	__le64 qw2;
	__le64 qw3;
	__le64 qw4_15[12];
};

struct hisi_sas_iost {
	__le64 qw0;
	__le64 qw1;
	__le64 qw2;
	__le64 qw3;
};

struct hisi_sas_err_record {
	u32	data[4];
};

struct hisi_sas_initial_fis {
	struct hisi_sas_err_record err_record;
	struct dev_to_host_fis fis;
	u32 rsvd[3];
};

struct hisi_sas_breakpoint {
	u8	data[128];	/*io128 byte*/
};

struct hisi_sas_sge {
	__le64 addr;
	__le32 page_ctrl_0;
	__le32 page_ctrl_1;
	__le32 data_len;
	__le32 data_off;
};

struct hisi_sas_command_table_smp {
	u8 bytes[44];
};

struct hisi_sas_command_table_stp {
	struct	host_to_dev_fis command_fis;
	u8	dummy[12];
	u8	atapi_cdb[ATAPI_CDB_LEN];
};

#define HISI_SAS_SGE_PAGE_CNT SG_CHUNK_SIZE
struct hisi_sas_sge_page {
	struct hisi_sas_sge sge[HISI_SAS_SGE_PAGE_CNT];
}  __aligned(16);

struct hisi_sas_command_table_ssp {
	struct ssp_frame_hdr hdr;
	union {
		struct {
			struct ssp_command_iu task;
			u32 prot[6];
		};
		struct ssp_tmf_iu ssp_task;
		struct xfer_rdy_iu xfer_rdy;
		struct ssp_response_iu ssp_res;
	} u;
};

union hisi_sas_command_table {
	struct hisi_sas_command_table_ssp ssp;
	struct hisi_sas_command_table_smp smp;
	struct hisi_sas_command_table_stp stp;
}  __aligned(16);

struct hisi_sas_status_buffer {
	struct hisi_sas_err_record err;
	u8	iu[1024];
}  __aligned(16);

struct hisi_sas_slot_buf_table {
	struct hisi_sas_status_buffer status_buffer;
	union hisi_sas_command_table command_header;
	struct hisi_sas_sge_page sge_page;
};

extern struct scsi_transport_template *hisi_sas_stt;
extern struct scsi_host_template *hisi_sas_sht;

extern void hisi_sas_init_add(struct hisi_hba *hisi_hba);
extern int hisi_sas_alloc(struct hisi_hba *hisi_hba, struct Scsi_Host *shost);
extern void hisi_sas_free(struct hisi_hba *hisi_hba);
extern u8 hisi_sas_get_ata_protocol(u8 cmd, int direction);
extern struct hisi_sas_port *to_hisi_sas_port(struct asd_sas_port *sas_port);
extern void hisi_sas_sata_done(struct sas_task *task,
			    struct hisi_sas_slot *slot);
extern int hisi_sas_get_ncq_tag(struct sas_task *task, u32 *tag);
extern int hisi_sas_get_fw_info(struct hisi_hba *hisi_hba);
extern int hisi_sas_probe(struct platform_device *pdev,
			  const struct hisi_sas_hw *ops);
extern int hisi_sas_remove(struct platform_device *pdev);

extern void hisi_sas_phy_down(struct hisi_hba *hisi_hba, int phy_no, int rdy);
extern void hisi_sas_slot_task_free(struct hisi_hba *hisi_hba,
				    struct sas_task *task,
				    struct hisi_sas_slot *slot);
extern void hisi_sas_init_mem(struct hisi_hba *hisi_hba);
extern void hisi_sas_kill_tasklets(struct hisi_hba *hisi_hba);
#endif
Commit	Line	Data
e8899fad JG	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
4d558c77	15	#include <linux/acpi.h>
3bc45af8	16	#include <linux/clk.h>
e8899fad JG	17	#include <linux/dmapool.h>
	18	#include <linux/mfd/syscon.h>
	19	#include <linux/module.h>
	20	#include <linux/of_address.h>
11b75249	21	#include <linux/pci.h>
e8899fad	22	#include <linux/platform_device.h>
4d558c77	23	#include <linux/property.h>
e8899fad	24	#include <linux/regmap.h>
6f2ff1a1	25	#include <scsi/sas_ata.h>
e8899fad JG	26	#include <scsi/libsas.h>
e8899fad JG	27
6328d903	28	#define DRV_VERSION "v1.6"
e8899fad	29
7eb7869f	30	#define HISI_SAS_MAX_PHYS 9
6be6de18 JG	31	#define HISI_SAS_MAX_QUEUES 32
6be6de18 JG	32	#define HISI_SAS_QUEUE_SLOTS 512
5560e9fb	33	#define HISI_SAS_MAX_ITCT_ENTRIES 2048
7eb7869f	34	#define HISI_SAS_MAX_DEVICES HISI_SAS_MAX_ITCT_ENTRIES
06ec0fb9	35	#define HISI_SAS_RESET_BIT 0
689ad4fb	36	#define HISI_SAS_REJECT_CMD_BIT 1
7eb7869f	37
f557e32c XT	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))
	40
	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)
	46
	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)
	51
	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)
6be6de18	56
42e7a693	57	#define HISI_SAS_MAX_SSP_RESP_SZ (sizeof(struct ssp_frame_hdr) + 1024)
66ee999b	58	#define HISI_SAS_MAX_SMP_RESP_SZ 1028
6f2ff1a1	59	#define HISI_SAS_MAX_STP_RESP_SZ 28
42e7a693	60
98bf39fc JG	61	#define DEV_IS_EXPANDER(type) \
	62	((type == SAS_EDGE_EXPANDER_DEVICE) \|\| \
	63	(type == SAS_FANOUT_EXPANDER_DEVICE))
	64
6c7bb8a1 XC	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
	70
abda97c2	71	struct hisi_hba;
af740dbe	72
07d78592 JG	73	enum {
	74	PORT_TYPE_SAS = (1U << 1),
	75	PORT_TYPE_SATA = (1U << 0),
	76	};
	77
af740dbe JG	78	enum dev_status {
	79	HISI_SAS_DEV_NORMAL,
	80	HISI_SAS_DEV_EH,
	81	};
abda97c2	82
441c2740 JG	83	enum {
	84	HISI_SAS_INT_ABT_CMD = 0,
	85	HISI_SAS_INT_ABT_DEV = 1,
	86	};
	87
abda97c2 JG	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,
	92	};
	93
7eb7869f	94	struct hisi_sas_phy {
976867e6 JG	95	struct hisi_hba *hisi_hba;
976867e6 JG	96	struct hisi_sas_port *port;
7eb7869f	97	struct asd_sas_phy sas_phy;
976867e6 JG	98	struct sas_identify identify;
976867e6 JG	99	struct timer_list timer;
66139921	100	struct work_struct phyup_ws;
976867e6	101	u64 port_id; /* from hw */
5d74242e	102	u64 dev_sas_addr;
976867e6 JG	103	u64 frame_rcvd_size;
	104	u8 frame_rcvd[32];
	105	u8 phy_attached;
	106	u8 reserved[3];
d0ef10c9	107	u32 phy_type;
976867e6 JG	108	enum sas_linkrate minimum_linkrate;
976867e6 JG	109	enum sas_linkrate maximum_linkrate;
7eb7869f JG	110	};
	111
	112	struct hisi_sas_port {
	113	struct asd_sas_port sas_port;
976867e6 JG	114	u8 port_attached;
976867e6 JG	115	u8 id; /* from hw */
7eb7869f JG	116	};
7eb7869f JG	117
9101a079 JG	118	struct hisi_sas_cq {
9101a079 JG	119	struct hisi_hba *hisi_hba;
d177c408	120	struct tasklet_struct tasklet;
e6c346f3	121	int rd_point;
9101a079 JG	122	int id;
	123	};
	124
4fde02ad JG	125	struct hisi_sas_dq {
4fde02ad JG	126	struct hisi_hba *hisi_hba;
b1a49412 XC	127	struct hisi_sas_slot *slot_prep;
b1a49412 XC	128	spinlock_t lock;
4fde02ad JG	129	int wr_point;
	130	int id;
	131	};
	132
af740dbe	133	struct hisi_sas_device {
abda97c2 JG	134	struct hisi_hba *hisi_hba;
abda97c2 JG	135	struct domain_device *sas_device;
5838f006	136	struct completion *completion;
b1a49412	137	struct hisi_sas_dq *dq;
ad604832	138	struct list_head list;
abda97c2	139	u64 attached_phy;
f696cc32	140	atomic64_t running_req;
ad604832 JG	141	enum sas_device_type dev_type;
ad604832 JG	142	int device_id;
32ccba52	143	int sata_idx;
ad604832	144	u8 dev_status;
af740dbe JG	145	};
af740dbe JG	146
6be6de18	147	struct hisi_sas_slot {
42e7a693 JG	148	struct list_head entry;
	149	struct sas_task *task;
	150	struct hisi_sas_port *port;
	151	u64 n_elem;
	152	int dlvry_queue;
	153	int dlvry_queue_slot;
27a3f229 JG	154	int cmplt_queue;
27a3f229 JG	155	int cmplt_queue_slot;
42e7a693	156	int idx;
cac9b2a2	157	int abort;
f557e32c XT	158	void *buf;
f557e32c XT	159	dma_addr_t buf_dma;
42e7a693 JG	160	void *cmd_hdr;
42e7a693 JG	161	dma_addr_t cmd_hdr_dma;
cac9b2a2	162	struct work_struct abort_slot;
0844a3ff	163	struct timer_list internal_abort_timer;
42e7a693 JG	164	};
	165
	166	struct hisi_sas_tmf_task {
	167	u8 tmf;
	168	u16 tag_of_task_to_be_managed;
6be6de18 JG	169	};
6be6de18 JG	170
7eb7869f	171	struct hisi_sas_hw {
8ff1d571	172	int (hw_init)(struct hisi_hba hisi_hba);
abda97c2 JG	173	void (setup_itct)(struct hisi_hba hisi_hba,
abda97c2 JG	174	struct hisi_sas_device *device);
685b6d6e JG	175	int (slot_index_alloc)(struct hisi_hba hisi_hba, int *slot_idx,
	176	struct domain_device *device);
	177	struct hisi_sas_device (alloc_dev)(struct domain_device *device);
66139921	178	void (sl_notify)(struct hisi_hba hisi_hba, int phy_no);
b1a49412 XC	179	int (get_free_slot)(struct hisi_hba hisi_hba, struct hisi_sas_dq *dq);
b1a49412 XC	180	void (start_delivery)(struct hisi_sas_dq dq);
42e7a693 JG	181	int (prep_ssp)(struct hisi_hba hisi_hba,
	182	struct hisi_sas_slot *slot, int is_tmf,
	183	struct hisi_sas_tmf_task *tmf);
66ee999b JG	184	int (prep_smp)(struct hisi_hba hisi_hba,
66ee999b JG	185	struct hisi_sas_slot *slot);
6f2ff1a1 JG	186	int (prep_stp)(struct hisi_hba hisi_hba,
6f2ff1a1 JG	187	struct hisi_sas_slot *slot);
441c2740 JG	188	int (prep_abort)(struct hisi_hba hisi_hba,
	189	struct hisi_sas_slot *slot,
	190	int device_id, int abort_flag, int tag_to_abort);
27a3f229	191	int (slot_complete)(struct hisi_hba hisi_hba,
405314df	192	struct hisi_sas_slot *slot);
396b8044	193	void (phys_init)(struct hisi_hba hisi_hba);
a0c341d7	194	void (phy_start)(struct hisi_hba hisi_hba, int phy_no);
e4189d53 JG	195	void (phy_disable)(struct hisi_hba hisi_hba, int phy_no);
e4189d53 JG	196	void (phy_hard_reset)(struct hisi_hba hisi_hba, int phy_no);
ce999301	197	void (get_events)(struct hisi_hba hisi_hba, int phy_no);
2ae75787 XC	198	void (phy_set_linkrate)(struct hisi_hba hisi_hba, int phy_no,
	199	struct sas_phy_linkrates *linkrates);
	200	enum sas_linkrate (*phy_get_max_linkrate)(void);
27a3f229 JG	201	void (free_device)(struct hisi_hba hisi_hba,
27a3f229 JG	202	struct hisi_sas_device *dev);
184a4635	203	int (get_wideport_bitmap)(struct hisi_hba hisi_hba, int port_id);
d30ff263 XC	204	void (dereg_device)(struct hisi_hba hisi_hba,
d30ff263 XC	205	struct domain_device *device);
06ec0fb9	206	int (soft_reset)(struct hisi_hba hisi_hba);
689ad4fb	207	u32 (get_phys_state)(struct hisi_hba hisi_hba);
b96b97af XT	208	int (write_gpio)(struct hisi_hba hisi_hba, u8 reg_type,
b96b97af XT	209	u8 reg_index, u8 reg_count, u8 *write_data);
a8d547bd	210	int max_command_entries;
6be6de18	211	int complete_hdr_size;
7eb7869f JG	212	};
	213
	214	struct hisi_hba {
	215	/* This must be the first element, used by SHOST_TO_SAS_HA */
	216	struct sas_ha_struct *p;
	217
11b75249 JG	218	struct platform_device *platform_dev;
	219	struct pci_dev *pci_dev;
	220	struct device *dev;
	221
e26b2f40	222	void __iomem *regs;
b96b97af	223	void __iomem *sgpio_regs;
e26b2f40 JG	224	struct regmap *ctrl;
	225	u32 ctrl_reset_reg;
	226	u32 ctrl_reset_sts_reg;
	227	u32 ctrl_clock_ena_reg;
3bc45af8	228	u32 refclk_frequency_mhz;
7eb7869f JG	229	u8 sas_addr[SAS_ADDR_SIZE];
	230
	231	int n_phy;
fa42d80d	232	spinlock_t lock;
7eb7869f	233
fa42d80d	234	struct timer_list timer;
7e9080e1	235	struct workqueue_struct *wq;
257efd1f JG	236
	237	int slot_index_count;
	238	unsigned long *slot_index_tags;
c7b9d369	239	unsigned long reject_stp_links_msk;
257efd1f	240
7eb7869f JG	241	/* SCSI/SAS glue */
	242	struct sas_ha_struct sha;
	243	struct Scsi_Host *shost;
9101a079 JG	244
9101a079 JG	245	struct hisi_sas_cq cq[HISI_SAS_MAX_QUEUES];
4fde02ad	246	struct hisi_sas_dq dq[HISI_SAS_MAX_QUEUES];
7eb7869f JG	247	struct hisi_sas_phy phy[HISI_SAS_MAX_PHYS];
7eb7869f JG	248	struct hisi_sas_port port[HISI_SAS_MAX_PHYS];
e26b2f40 JG	249
e26b2f40 JG	250	int queue_count;
6be6de18	251
f557e32c	252	struct dma_pool *buffer_pool;
af740dbe	253	struct hisi_sas_device devices[HISI_SAS_MAX_DEVICES];
6be6de18 JG	254	struct hisi_sas_cmd_hdr *cmd_hdr[HISI_SAS_MAX_QUEUES];
	255	dma_addr_t cmd_hdr_dma[HISI_SAS_MAX_QUEUES];
	256	void *complete_hdr[HISI_SAS_MAX_QUEUES];
	257	dma_addr_t complete_hdr_dma[HISI_SAS_MAX_QUEUES];
	258	struct hisi_sas_initial_fis *initial_fis;
	259	dma_addr_t initial_fis_dma;
	260	struct hisi_sas_itct *itct;
	261	dma_addr_t itct_dma;
	262	struct hisi_sas_iost *iost;
	263	dma_addr_t iost_dma;
	264	struct hisi_sas_breakpoint *breakpoint;
	265	dma_addr_t breakpoint_dma;
	266	struct hisi_sas_breakpoint *sata_breakpoint;
	267	dma_addr_t sata_breakpoint_dma;
	268	struct hisi_sas_slot *slot_info;
06ec0fb9	269	unsigned long flags;
7eb7869f	270	const struct hisi_sas_hw hw; / Low level hw interface */
32ccba52	271	unsigned long sata_dev_bitmap[BITS_TO_LONGS(HISI_SAS_MAX_DEVICES)];
06ec0fb9	272	struct work_struct rst_work;
7eb7869f JG	273	};
7eb7869f JG	274
c799d6bd JG	275	/* Generic HW DMA host memory structures */
	276	/* Delivery queue header */
	277	struct hisi_sas_cmd_hdr {
	278	/* dw0 */
	279	__le32 dw0;
	280
	281	/* dw1 */
	282	__le32 dw1;
	283
	284	/* dw2 */
	285	__le32 dw2;
	286
	287	/* dw3 */
	288	__le32 transfer_tags;
	289
	290	/* dw4 */
	291	__le32 data_transfer_len;
	292
	293	/* dw5 */
	294	__le32 first_burst_num;
	295
	296	/* dw6 */
	297	__le32 sg_len;
	298
	299	/* dw7 */
	300	__le32 dw7;
	301
	302	/* dw8-9 */
	303	__le64 cmd_table_addr;
	304
	305	/* dw10-11 */
	306	__le64 sts_buffer_addr;
	307
	308	/* dw12-13 */
	309	__le64 prd_table_addr;
	310
	311	/* dw14-15 */
	312	__le64 dif_prd_table_addr;
	313	};
	314
	315	struct hisi_sas_itct {
	316	__le64 qw0;
	317	__le64 sas_addr;
	318	__le64 qw2;
	319	__le64 qw3;
281e3bf6	320	__le64 qw4_15[12];
c799d6bd JG	321	};
	322
	323	struct hisi_sas_iost {
	324	__le64 qw0;
	325	__le64 qw1;
	326	__le64 qw2;
	327	__le64 qw3;
	328	};
	329
	330	struct hisi_sas_err_record {
8d1eee7d	331	u32 data[4];
c799d6bd JG	332	};
	333
	334	struct hisi_sas_initial_fis {
	335	struct hisi_sas_err_record err_record;
	336	struct dev_to_host_fis fis;
	337	u32 rsvd[3];
	338	};
	339
	340	struct hisi_sas_breakpoint {
	341	u8 data[128]; /io128 byte/
	342	};
	343
	344	struct hisi_sas_sge {
	345	__le64 addr;
	346	__le32 page_ctrl_0;
	347	__le32 page_ctrl_1;
	348	__le32 data_len;
	349	__le32 data_off;
	350	};
	351
	352	struct hisi_sas_command_table_smp {
	353	u8 bytes[44];
	354	};
	355
	356	struct hisi_sas_command_table_stp {
	357	struct host_to_dev_fis command_fis;
	358	u8 dummy[12];
	359	u8 atapi_cdb[ATAPI_CDB_LEN];
	360	};
	361
65e8617f	362	#define HISI_SAS_SGE_PAGE_CNT SG_CHUNK_SIZE
c799d6bd JG	363	struct hisi_sas_sge_page {
c799d6bd JG	364	struct hisi_sas_sge sge[HISI_SAS_SGE_PAGE_CNT];
f557e32c	365	} __aligned(16);
c799d6bd JG	366
	367	struct hisi_sas_command_table_ssp {
	368	struct ssp_frame_hdr hdr;
	369	union {
	370	struct {
	371	struct ssp_command_iu task;
	372	u32 prot[6];
	373	};
	374	struct ssp_tmf_iu ssp_task;
	375	struct xfer_rdy_iu xfer_rdy;
	376	struct ssp_response_iu ssp_res;
	377	} u;
	378	};
	379
	380	union hisi_sas_command_table {
	381	struct hisi_sas_command_table_ssp ssp;
	382	struct hisi_sas_command_table_smp smp;
	383	struct hisi_sas_command_table_stp stp;
f557e32c XT	384	} __aligned(16);
	385
	386	struct hisi_sas_status_buffer {
	387	struct hisi_sas_err_record err;
	388	u8 iu[1024];
	389	} __aligned(16);
	390
	391	struct hisi_sas_slot_buf_table {
	392	struct hisi_sas_status_buffer status_buffer;
	393	union hisi_sas_command_table command_header;
	394	struct hisi_sas_sge_page sge_page;
c799d6bd	395	};
2e244f0f	396
e21fe3a5 JG	397	extern struct scsi_transport_template *hisi_sas_stt;
	398	extern struct scsi_host_template *hisi_sas_sht;
	399
	400	extern void hisi_sas_init_add(struct hisi_hba *hisi_hba);
	401	extern int hisi_sas_alloc(struct hisi_hba hisi_hba, struct Scsi_Host shost);
	402	extern void hisi_sas_free(struct hisi_hba *hisi_hba);
6c7bb8a1	403	extern u8 hisi_sas_get_ata_protocol(u8 cmd, int direction);
2e244f0f	404	extern struct hisi_sas_port to_hisi_sas_port(struct asd_sas_port sas_port);
75904077 XC	405	extern void hisi_sas_sata_done(struct sas_task *task,
75904077 XC	406	struct hisi_sas_slot *slot);
318913c6	407	extern int hisi_sas_get_ncq_tag(struct sas_task task, u32 tag);
0fa24c19	408	extern int hisi_sas_get_fw_info(struct hisi_hba *hisi_hba);
9fb10b54 JG	409	extern int hisi_sas_probe(struct platform_device *pdev,
	410	const struct hisi_sas_hw *ops);
	411	extern int hisi_sas_remove(struct platform_device *pdev);
c799d6bd	412
184a4635	413	extern void hisi_sas_phy_down(struct hisi_hba *hisi_hba, int phy_no, int rdy);
27a3f229 JG	414	extern void hisi_sas_slot_task_free(struct hisi_hba *hisi_hba,
	415	struct sas_task *task,
	416	struct hisi_sas_slot *slot);
06ec0fb9	417	extern void hisi_sas_init_mem(struct hisi_hba *hisi_hba);
d3b286e6	418	extern void hisi_sas_kill_tasklets(struct hisi_hba *hisi_hba);
e8899fad	419	#endif