[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_cmnd.h>
#include <scsi/scsi_device.h>

extern const struct file_operations cxlflash_cxl_fops;

#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 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               256
#define CXLFLASH_MAX_CMDS_PER_LUN       CXLFLASH_MAX_CMDS

/* RRQ for master issued cmds */
#define NUM_RRQ_ENTRY                   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

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;

	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;

	/* 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 */
	struct afu *parent;
	struct completion cevent;

	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());

static inline struct afu_cmd *sc_to_afuc(struct scsi_cmnd *sc)
{
	return PTR_ALIGN(scsi_cmd_priv(sc), __alignof__(struct afu_cmd));
}

static inline struct afu_cmd *sc_to_afucz(struct scsi_cmnd *sc)
{
	struct afu_cmd *afuc = sc_to_afuc(sc);

	memset(afuc, 0, sizeof(*afuc));
	return afuc;
}

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

	u64 rrq_entry[NUM_RRQ_ENTRY];	/* 2K RRQ */

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

	int (*send_cmd)(struct afu *, struct afu_cmd *);
	void (*context_reset)(struct afu_cmd *);

	/* 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 */

	struct kref mapcount;

	ctx_hndl_t ctx_hndl;	/* master's context handle */
	u64 *hrrq_start;
	u64 *hrrq_end;
	u64 *hrrq_curr;
	bool toggle;
	atomic_t cmds_active;	/* Number of currently active AFU commands */
	s64 room;
	spinlock_t rrin_slock; /* Lock to rrin queuing and cmd_room updates */
	u64 hb;
	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>
c21e0bbf MO	21	#include <scsi/scsi.h>
5fbb96c8	22	#include <scsi/scsi_cmnd.h>
c21e0bbf MO	23	#include <scsi/scsi_device.h>
c21e0bbf MO	24
17ead26f	25	extern const struct file_operations cxlflash_cxl_fops;
c21e0bbf MO	26
	27	#define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
	28
	29	#define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
	30	#define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
	31	#define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
	32	max_sectors
	33	in units of
	34	512 byte
	35	sectors
	36	*/
	37
c21e0bbf MO	38	#define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))
	39
	40	/* AFU command retry limit */
	41	#define MC_RETRY_CNT 5 /* sufficient for SCSI check and
	42	certain AFU errors */
	43
	44	/* Command management definitions */
	45	#define CXLFLASH_NUM_CMDS (2 * CXLFLASH_MAX_CMDS) /* Must be a pow2 for
	46	alignment and more
	47	efficient array
	48	index derivation
	49	*/
	50
83430833	51	#define CXLFLASH_MAX_CMDS 256
c21e0bbf MO	52	#define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
c21e0bbf MO	53
83430833 MK	54	/* RRQ for master issued cmds */
	55	#define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS
	56
c21e0bbf MO	57
	58	static inline void check_sizes(void)
	59	{
	60	BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_CMDS);
	61	}
	62
	63	/* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
	64	#define CMD_BUFSIZE SIZE_4K
	65
c21e0bbf MO	66	enum cxlflash_lr_state {
	67	LINK_RESET_INVALID,
	68	LINK_RESET_REQUIRED,
	69	LINK_RESET_COMPLETE
	70	};
	71
	72	enum cxlflash_init_state {
	73	INIT_STATE_NONE,
	74	INIT_STATE_PCI,
	75	INIT_STATE_AFU,
	76	INIT_STATE_SCSI
	77	};
	78
5cdac81a MO	79	enum cxlflash_state {
5cdac81a MO	80	STATE_NORMAL, /* Normal running state, everything good */
439e85c1	81	STATE_RESET, /* Reset state, trying to reset/recover */
5cdac81a MO	82	STATE_FAILTERM /* Failed/terminating state, error out users/threads */
	83	};
	84
c21e0bbf MO	85	/*
	86	* Each context has its own set of resource handles that is visible
	87	* only from that context.
	88	*/
	89
	90	struct cxlflash_cfg {
	91	struct afu *afu;
	92	struct cxl_context *mcctx;
	93
	94	struct pci_dev *dev;
	95	struct pci_device_id *dev_id;
	96	struct Scsi_Host *host;
	97
	98	ulong cxlflash_regs_pci;
	99
c21e0bbf MO	100	struct work_struct work_q;
	101	enum cxlflash_init_state init_state;
	102	enum cxlflash_lr_state lr_state;
	103	int lr_port;
ef51074a	104	atomic_t scan_host_needed;
c21e0bbf MO	105
c21e0bbf MO	106	struct cxl_afu *cxl_afu;
c21e0bbf	107
65be2c79 MO	108	atomic_t recovery_threads;
	109	struct mutex ctx_recovery_mutex;
	110	struct mutex ctx_tbl_list_mutex;
0a27ae51	111	struct rw_semaphore ioctl_rwsem;
65be2c79 MO	112	struct ctx_info *ctx_tbl[MAX_CONTEXT];
	113	struct list_head ctx_err_recovery; /* contexts w/ recovery pending */
	114	struct file_operations cxl_fops;
	115
2cb79266 MO	116	/* Parameters that are LUN table related */
	117	int last_lun_index[CXLFLASH_NUM_FC_PORTS];
	118	int promote_lun_index;
65be2c79 MO	119	struct list_head lluns; /* list of llun_info structs */
65be2c79 MO	120
c21e0bbf	121	wait_queue_head_t tmf_waitq;
018d1dc9	122	spinlock_t tmf_slock;
c21e0bbf	123	bool tmf_active;
439e85c1	124	wait_queue_head_t reset_waitq;
5cdac81a	125	enum cxlflash_state state;
c21e0bbf MO	126	};
	127
	128	struct afu_cmd {
	129	struct sisl_ioarcb rcb; /* IOARCB (cache line aligned) */
	130	struct sisl_ioasa sa; /* IOASA must follow IOARCB */
c21e0bbf	131	struct afu *parent;
9ba848ac	132	struct completion cevent;
c21e0bbf MO	133
	134	u8 cmd_tmf:1;
	135
	136	/* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
	137	* However for performance reasons the IOARCB/IOASA should be
	138	* cache line aligned.
	139	*/
	140	} __aligned(cache_line_size());
	141
5fbb96c8 MO	142	static inline struct afu_cmd sc_to_afuc(struct scsi_cmnd sc)
	143	{
	144	return PTR_ALIGN(scsi_cmd_priv(sc), __alignof__(struct afu_cmd));
	145	}
	146
	147	static inline struct afu_cmd sc_to_afucz(struct scsi_cmnd sc)
	148	{
	149	struct afu_cmd *afuc = sc_to_afuc(sc);
	150
	151	memset(afuc, 0, sizeof(*afuc));
	152	return afuc;
	153	}
	154
c21e0bbf MO	155	struct afu {
	156	/* Stuff requiring alignment go first. */
	157
83430833	158	u64 rrq_entry[NUM_RRQ_ENTRY]; /* 2K RRQ */
c21e0bbf MO	159
	160	/* Beware of alignment till here. Preferably introduce new
	161	* fields after this point
	162	*/
	163
48b4be36 MO	164	int (send_cmd)(struct afu , struct afu_cmd *);
	165	void (context_reset)(struct afu_cmd );
	166
c21e0bbf MO	167	/* AFU HW */
c21e0bbf MO	168	struct cxl_ioctl_start_work work;
1786f4a0 MO	169	struct cxlflash_afu_map __iomem afu_map; / entire MMIO map */
	170	struct sisl_host_map __iomem host_map; / MC host map */
	171	struct sisl_ctrl_map __iomem ctrl_map; / MC control map */
c21e0bbf	172
b45cdbaf MK	173	struct kref mapcount;
b45cdbaf MK	174
c21e0bbf MO	175	ctx_hndl_t ctx_hndl; /* master's context handle */
	176	u64 *hrrq_start;
	177	u64 *hrrq_end;
	178	u64 *hrrq_curr;
	179	bool toggle;
de01283b	180	atomic_t cmds_active; /* Number of currently active AFU commands */
11f7b184 UK	181	s64 room;
11f7b184 UK	182	spinlock_t rrin_slock; /* Lock to rrin queuing and cmd_room updates */
c21e0bbf	183	u64 hb;
c21e0bbf MO	184	u32 internal_lun; /* User-desired LUN mode for this AFU */
c21e0bbf MO	185
e5ce067b	186	char version[16];
c21e0bbf MO	187	u64 interface_version;
	188
	189	struct cxlflash_cfg parent; / Pointer back to parent cxlflash_cfg */
	190
	191	};
	192
	193	static inline u64 lun_to_lunid(u64 lun)
	194	{
1786f4a0	195	__be64 lun_id;
c21e0bbf MO	196
c21e0bbf MO	197	int_to_scsilun(lun, (struct scsi_lun *)&lun_id);
1786f4a0	198	return be64_to_cpu(lun_id);
c21e0bbf MO	199	}
c21e0bbf MO	200
c21e0bbf	201	int cxlflash_afu_sync(struct afu *, ctx_hndl_t, res_hndl_t, u8);
65be2c79 MO	202	void cxlflash_list_init(void);
	203	void cxlflash_term_global_luns(void);
	204	void cxlflash_free_errpage(void);
	205	int cxlflash_ioctl(struct scsi_device , int, void __user );
	206	void cxlflash_stop_term_user_contexts(struct cxlflash_cfg *);
	207	int cxlflash_mark_contexts_error(struct cxlflash_cfg *);
	208	void cxlflash_term_local_luns(struct cxlflash_cfg *);
2cb79266	209	void cxlflash_restore_luntable(struct cxlflash_cfg *);
65be2c79	210
c21e0bbf	211	#endif /* ifndef _CXLFLASH_COMMON_H */