[mirror_ubuntu-zesty-kernel.git] / drivers / scsi / cxlflash / common.h

/*
 * CXL Flash Device Driver
 *
 * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
 *             Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
 *
 * Copyright (C) 2015 IBM Corporation
 *
 * 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 _CXLFLASH_COMMON_H
#define _CXLFLASH_COMMON_H

#include <linux/list.h>
#include <linux/rwsem.h>
#include <linux/types.h>
#include <scsi/scsi.h>
#include <scsi/scsi_device.h>


#define MAX_CONTEXT  CXLFLASH_MAX_CONTEXT       /* num contexts per afu */

#define CXLFLASH_BLOCK_SIZE	4096	/* 4K blocks */
#define CXLFLASH_MAX_XFER_SIZE	16777216	/* 16MB transfer */
#define CXLFLASH_MAX_SECTORS	(CXLFLASH_MAX_XFER_SIZE/512)	/* SCSI wants
								   max_sectors
								   in units of
								   512 byte
								   sectors
								*/

#define NUM_RRQ_ENTRY    16     /* for master issued cmds */
#define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))

/* AFU command retry limit */
#define MC_RETRY_CNT         5	/* sufficient for SCSI check and
				   certain AFU errors */

/* Command management definitions */
#define CXLFLASH_NUM_CMDS	(2 * CXLFLASH_MAX_CMDS)	/* Must be a pow2 for
							   alignment and more
							   efficient array
							   index derivation
							 */

#define CXLFLASH_MAX_CMDS               16
#define CXLFLASH_MAX_CMDS_PER_LUN       CXLFLASH_MAX_CMDS


static inline void check_sizes(void)
{
	BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS);
}

/* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
#define CMD_BUFSIZE     SIZE_4K

/* flags in IOA status area for host use */
#define B_DONE       0x01
#define B_ERROR      0x02	/* set with B_DONE */
#define B_TIMEOUT    0x04	/* set with B_DONE & B_ERROR */

enum cxlflash_lr_state {
	LINK_RESET_INVALID,
	LINK_RESET_REQUIRED,
	LINK_RESET_COMPLETE
};

enum cxlflash_init_state {
	INIT_STATE_NONE,
	INIT_STATE_PCI,
	INIT_STATE_AFU,
	INIT_STATE_SCSI
};

enum cxlflash_state {
	STATE_NORMAL,	/* Normal running state, everything good */
	STATE_RESET,	/* Reset state, trying to reset/recover */
	STATE_FAILTERM	/* Failed/terminating state, error out users/threads */
};

/*
 * Each context has its own set of resource handles that is visible
 * only from that context.
 */

struct cxlflash_cfg {
	struct afu *afu;
	struct cxl_context *mcctx;

	struct pci_dev *dev;
	struct pci_device_id *dev_id;
	struct Scsi_Host *host;

	ulong cxlflash_regs_pci;

	struct work_struct work_q;
	enum cxlflash_init_state init_state;
	enum cxlflash_lr_state lr_state;
	int lr_port;
	atomic_t scan_host_needed;

	struct cxl_afu *cxl_afu;
	struct pci_dev *parent_dev;

	atomic_t recovery_threads;
	struct mutex ctx_recovery_mutex;
	struct mutex ctx_tbl_list_mutex;
	struct rw_semaphore ioctl_rwsem;
	struct ctx_info *ctx_tbl[MAX_CONTEXT];
	struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
	struct file_operations cxl_fops;

	atomic_t num_user_contexts;

	/* Parameters that are LUN table related */
	int last_lun_index[CXLFLASH_NUM_FC_PORTS];
	int promote_lun_index;
	struct list_head lluns; /* list of llun_info structs */

	wait_queue_head_t tmf_waitq;
	spinlock_t tmf_slock;
	bool tmf_active;
	wait_queue_head_t reset_waitq;
	enum cxlflash_state state;
};

struct afu_cmd {
	struct sisl_ioarcb rcb;	/* IOARCB (cache line aligned) */
	struct sisl_ioasa sa;	/* IOASA must follow IOARCB */
	spinlock_t slock;
	struct completion cevent;
	char *buf;		/* per command buffer */
	struct afu *parent;
	int slot;
	atomic_t free;

	u8 cmd_tmf:1;

	/* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
	 * However for performance reasons the IOARCB/IOASA should be
	 * cache line aligned.
	 */
} __aligned(cache_line_size());

struct afu {
	/* Stuff requiring alignment go first. */

	u64 rrq_entry[NUM_RRQ_ENTRY];	/* 128B RRQ */
	/*
	 * Command & data for AFU commands.
	 */
	struct afu_cmd cmd[CXLFLASH_NUM_CMDS];

	/* Beware of alignment till here. Preferably introduce new
	 * fields after this point
	 */

	/* AFU HW */
	struct cxl_ioctl_start_work work;
	struct cxlflash_afu_map __iomem *afu_map;	/* entire MMIO map */
	struct sisl_host_map __iomem *host_map;		/* MC host map */
	struct sisl_ctrl_map __iomem *ctrl_map;		/* MC control map */

	ctx_hndl_t ctx_hndl;	/* master's context handle */
	u64 *hrrq_start;
	u64 *hrrq_end;
	u64 *hrrq_curr;
	bool toggle;
	bool read_room;
	atomic64_t room;
	u64 hb;
	u32 cmd_couts;		/* Number of command checkouts */
	u32 internal_lun;	/* User-desired LUN mode for this AFU */

	char version[16];
	u64 interface_version;

	struct cxlflash_cfg *parent; /* Pointer back to parent cxlflash_cfg */

};

static inline u64 lun_to_lunid(u64 lun)
{
	__be64 lun_id;

	int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
	return be64_to_cpu(lun_id);
}

int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8);
void cxlflash_list_init(void);
void cxlflash_term_global_luns(void);
void cxlflash_free_errpage(void);
int cxlflash_ioctl(struct scsi_device *, int, void __user *);
void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *);
int cxlflash_mark_contexts_error(struct cxlflash_cfg *);
void cxlflash_term_local_luns(struct cxlflash_cfg *);
void cxlflash_restore_luntable(struct cxlflash_cfg *);

#endif /* ifndef _CXLFLASH_COMMON_H */
Commit	Line	Data
c21e0bbf MO	1	/*
	2	* CXL Flash Device Driver
	3	*
	4	* Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
	5	* Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
	6	*
	7	* Copyright (C) 2015 IBM Corporation
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License
	11	* as published by the Free Software Foundation; either version
	12	* 2 of the License, or (at your option) any later version.
	13	*/
	14
	15	#ifndef _CXLFLASH_COMMON_H
	16	#define _CXLFLASH_COMMON_H
	17
	18	#include <linux/list.h>
0a27ae51	19	#include <linux/rwsem.h>
c21e0bbf MO	20	#include <linux/types.h>
	21	#include <scsi/scsi.h>
	22	#include <scsi/scsi_device.h>
	23
	24
	25	#define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
	26
	27	#define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
	28	#define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
	29	#define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
	30	max_sectors
	31	in units of
	32	512 byte
	33	sectors
	34	*/
	35
	36	#define NUM_RRQ_ENTRY 16 /* for master issued cmds */
	37	#define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))
	38
	39	/* AFU command retry limit */
	40	#define MC_RETRY_CNT 5 /* sufficient for SCSI check and
	41	certain AFU errors */
	42
	43	/* Command management definitions */
	44	#define CXLFLASH_NUM_CMDS (2 * CXLFLASH_MAX_CMDS) /* Must be a pow2 for
	45	alignment and more
	46	efficient array
	47	index derivation
	48	*/
	49
	50	#define CXLFLASH_MAX_CMDS 16
	51	#define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
	52
	53
	54	static inline void check_sizes(void)
	55	{
	56	BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS);
	57	}
	58
	59	/* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
	60	#define CMD_BUFSIZE SIZE_4K
	61
	62	/* flags in IOA status area for host use */
	63	#define B_DONE 0x01
	64	#define B_ERROR 0x02 /* set with B_DONE */
	65	#define B_TIMEOUT 0x04 /* set with B_DONE & B_ERROR */
	66
	67	enum cxlflash_lr_state {
	68	LINK_RESET_INVALID,
	69	LINK_RESET_REQUIRED,
	70	LINK_RESET_COMPLETE
	71	};
	72
	73	enum cxlflash_init_state {
	74	INIT_STATE_NONE,
	75	INIT_STATE_PCI,
	76	INIT_STATE_AFU,
	77	INIT_STATE_SCSI
	78	};
	79
5cdac81a MO	80	enum cxlflash_state {
5cdac81a MO	81	STATE_NORMAL, /* Normal running state, everything good */
439e85c1	82	STATE_RESET, /* Reset state, trying to reset/recover */
5cdac81a MO	83	STATE_FAILTERM /* Failed/terminating state, error out users/threads */
	84	};
	85
c21e0bbf MO	86	/*
	87	* Each context has its own set of resource handles that is visible
	88	* only from that context.
	89	*/
	90
	91	struct cxlflash_cfg {
	92	struct afu *afu;
	93	struct cxl_context *mcctx;
	94
	95	struct pci_dev *dev;
	96	struct pci_device_id *dev_id;
	97	struct Scsi_Host *host;
	98
	99	ulong cxlflash_regs_pci;
	100
c21e0bbf MO	101	struct work_struct work_q;
	102	enum cxlflash_init_state init_state;
	103	enum cxlflash_lr_state lr_state;
	104	int lr_port;
ef51074a	105	atomic_t scan_host_needed;
c21e0bbf MO	106
c21e0bbf MO	107	struct cxl_afu *cxl_afu;
c21e0bbf MO	108	struct pci_dev *parent_dev;
c21e0bbf MO	109
65be2c79 MO	110	atomic_t recovery_threads;
	111	struct mutex ctx_recovery_mutex;
	112	struct mutex ctx_tbl_list_mutex;
0a27ae51	113	struct rw_semaphore ioctl_rwsem;
65be2c79 MO	114	struct ctx_info *ctx_tbl[MAX_CONTEXT];
	115	struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
	116	struct file_operations cxl_fops;
	117
	118	atomic_t num_user_contexts;
	119
2cb79266 MO	120	/* Parameters that are LUN table related */
	121	int last_lun_index[CXLFLASH_NUM_FC_PORTS];
	122	int promote_lun_index;
65be2c79 MO	123	struct list_head lluns; /* list of llun_info structs */
65be2c79 MO	124
c21e0bbf	125	wait_queue_head_t tmf_waitq;
018d1dc9	126	spinlock_t tmf_slock;
c21e0bbf	127	bool tmf_active;
439e85c1	128	wait_queue_head_t reset_waitq;
5cdac81a	129	enum cxlflash_state state;
c21e0bbf MO	130	};
	131
	132	struct afu_cmd {
	133	struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */
	134	struct sisl_ioasa sa; /* IOASA must follow IOARCB */
	135	spinlock_t slock;
	136	struct completion cevent;
	137	char buf; / per command buffer */
	138	struct afu *parent;
	139	int slot;
	140	atomic_t free;
	141
	142	u8 cmd_tmf:1;
	143
	144	/* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
	145	* However for performance reasons the IOARCB/IOASA should be
	146	* cache line aligned.
	147	*/
	148	} __aligned(cache_line_size());
	149
	150	struct afu {
	151	/* Stuff requiring alignment go first. */
	152
	153	u64 rrq_entry[NUM_RRQ_ENTRY]; /* 128B RRQ */
	154	/*
	155	* Command & data for AFU commands.
	156	*/
	157	struct afu_cmd cmd[CXLFLASH_NUM_CMDS];
	158
	159	/* Beware of alignment till here. Preferably introduce new
	160	* fields after this point
	161	*/
	162
	163	/* AFU HW */
	164	struct cxl_ioctl_start_work work;
1786f4a0 MO	165	struct cxlflash_afu_map __iomem afu_map; / entire MMIO map */
	166	struct sisl_host_map __iomem host_map; / MC host map */
	167	struct sisl_ctrl_map __iomem ctrl_map; / MC control map */
c21e0bbf MO	168
	169	ctx_hndl_t ctx_hndl; /* master's context handle */
	170	u64 *hrrq_start;
	171	u64 *hrrq_end;
	172	u64 *hrrq_curr;
	173	bool toggle;
	174	bool read_room;
	175	atomic64_t room;
	176	u64 hb;
	177	u32 cmd_couts; /* Number of command checkouts */
	178	u32 internal_lun; /* User-desired LUN mode for this AFU */
	179
e5ce067b	180	char version[16];
c21e0bbf MO	181	u64 interface_version;
	182
	183	struct cxlflash_cfg parent; / Pointer back to parent cxlflash_cfg */
	184
	185	};
	186
	187	static inline u64 lun_to_lunid(u64 lun)
	188	{
1786f4a0	189	__be64 lun_id;
c21e0bbf MO	190
c21e0bbf MO	191	int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
1786f4a0	192	return be64_to_cpu(lun_id);
c21e0bbf MO	193	}
c21e0bbf MO	194
c21e0bbf	195	int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8);
65be2c79 MO	196	void cxlflash_list_init(void);
	197	void cxlflash_term_global_luns(void);
	198	void cxlflash_free_errpage(void);
	199	int cxlflash_ioctl(struct scsi_device , int, void __user );
	200	void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *);
	201	int cxlflash_mark_contexts_error(struct cxlflash_cfg *);
	202	void cxlflash_term_local_luns(struct cxlflash_cfg *);
2cb79266	203	void cxlflash_restore_luntable(struct cxlflash_cfg *);
65be2c79	204
c21e0bbf	205	#endif /* ifndef _CXLFLASH_COMMON_H */