[linux-2.6-block.git] / drivers / scsi / cxlflash / superpipe.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_SUPERPIPE_H
#define _CXLFLASH_SUPERPIPE_H

extern struct cxlflash_global global;

/*
 * Terminology: use afu (and not adapter) to refer to the HW.
 * Adapter is the entire slot and includes PSL out of which
 * only the AFU is visible to user space.
 */

/* Chunk size parms: note sislite minimum chunk size is
 * 0x10000 LBAs corresponding to a NMASK or 16.
 */
#define MC_CHUNK_SIZE     (1 << MC_RHT_NMASK)	/* in LBAs */

#define CMD_TIMEOUT 30  /* 30 secs */
#define CMD_RETRIES 5   /* 5 retries for scsi_execute */

#define MAX_SECTOR_UNIT  512 /* max_sector is in 512 byte multiples */

enum lun_mode {
	MODE_NONE = 0,
	MODE_VIRTUAL,
	MODE_PHYSICAL
};

/* Global (entire driver, spans adapters) lun_info structure */
struct glun_info {
	u64 max_lba;		/* from read cap(16) */
	u32 blk_len;		/* from read cap(16) */
	enum lun_mode mode;	/* NONE, VIRTUAL, PHYSICAL */
	int users;		/* Number of users w/ references to LUN */

	u8 wwid[16];

	struct mutex mutex;

	struct blka blka;
	struct list_head list;
};

/* Local (per-adapter) lun_info structure */
struct llun_info {
	u64 lun_id[MAX_FC_PORTS]; /* from REPORT_LUNS */
	u32 lun_index;		/* Index in the LUN table */
	u32 host_no;		/* host_no from Scsi_host */
	u32 port_sel;		/* What port to use for this LUN */
	bool in_table;		/* Whether a LUN table entry was created */

	u8 wwid[16];		/* Keep a duplicate copy here? */

	struct glun_info *parent; /* Pointer to entry in global LUN structure */
	struct scsi_device *sdev;
	struct list_head list;
};

struct lun_access {
	struct llun_info *lli;
	struct scsi_device *sdev;
	struct list_head list;
};

enum ctx_ctrl {
	CTX_CTRL_CLONE		= (1 << 1),
	CTX_CTRL_ERR		= (1 << 2),
	CTX_CTRL_ERR_FALLBACK	= (1 << 3),
	CTX_CTRL_NOPID		= (1 << 4),
	CTX_CTRL_FILE		= (1 << 5)
};

#define ENCODE_CTXID(_ctx, _id)	(((((u64)_ctx) & 0xFFFFFFFF0ULL) << 28) | _id)
#define DECODE_CTXID(_val)	(_val & 0xFFFFFFFF)

struct ctx_info {
	struct sisl_ctrl_map __iomem *ctrl_map; /* initialized at startup */
	struct sisl_rht_entry *rht_start; /* 1 page (req'd for alignment),
					   * alloc/free on attach/detach
					   */
	u32 rht_out;		/* Number of checked out RHT entries */
	u32 rht_perms;		/* User-defined permissions for RHT entries */
	struct llun_info **rht_lun;       /* Mapping of RHT entries to LUNs */
	u8 *rht_needs_ws;	/* User-desired write-same function per RHTE */

	struct cxl_ioctl_start_work work;
	u64 ctxid;
	pid_t pid;
	bool initialized;
	bool unavail;
	bool err_recovery_active;
	struct mutex mutex; /* Context protection */
	struct kref kref;
	struct cxl_context *ctx;
	struct cxlflash_cfg *cfg;
	struct list_head luns;	/* LUNs attached to this context */
	const struct vm_operations_struct *cxl_mmap_vmops;
	struct file *file;
	struct list_head list; /* Link contexts in error recovery */
};

struct cxlflash_global {
	struct mutex mutex;
	struct list_head gluns;/* list of glun_info structs */
	struct page *err_page; /* One page of all 0xF for error notification */
};

int cxlflash_vlun_resize(struct scsi_device *sdev,
			 struct dk_cxlflash_resize *resize);
int _cxlflash_vlun_resize(struct scsi_device *sdev, struct ctx_info *ctxi,
			  struct dk_cxlflash_resize *resize);

int cxlflash_disk_release(struct scsi_device *sdev,
			  struct dk_cxlflash_release *release);
int _cxlflash_disk_release(struct scsi_device *sdev, struct ctx_info *ctxi,
			   struct dk_cxlflash_release *release);

int cxlflash_disk_clone(struct scsi_device *sdev,
			struct dk_cxlflash_clone *clone);

int cxlflash_disk_virtual_open(struct scsi_device *sdev, void *arg);

int cxlflash_lun_attach(struct glun_info *gli, enum lun_mode mode, bool locked);
void cxlflash_lun_detach(struct glun_info *gli);

struct ctx_info *get_context(struct cxlflash_cfg *cfg, u64 rctxit, void *arg,
			     enum ctx_ctrl ctrl);
void put_context(struct ctx_info *ctxi);

struct sisl_rht_entry *get_rhte(struct ctx_info *ctxi, res_hndl_t rhndl,
				struct llun_info *lli);

struct sisl_rht_entry *rhte_checkout(struct ctx_info *ctxi,
				     struct llun_info *lli);
void rhte_checkin(struct ctx_info *ctxi, struct sisl_rht_entry *rhte);

void cxlflash_ba_terminate(struct ba_lun *ba_lun);

int cxlflash_manage_lun(struct scsi_device *sdev,
			struct dk_cxlflash_manage_lun *manage);

int check_state(struct cxlflash_cfg *cfg);

#endif /* ifndef _CXLFLASH_SUPERPIPE_H */
Commit	Line	Data
65be2c79 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_SUPERPIPE_H
	16	#define _CXLFLASH_SUPERPIPE_H
	17
	18	extern struct cxlflash_global global;
	19
	20	/*
	21	* Terminology: use afu (and not adapter) to refer to the HW.
	22	* Adapter is the entire slot and includes PSL out of which
	23	* only the AFU is visible to user space.
	24	*/
	25
	26	/* Chunk size parms: note sislite minimum chunk size is
fcc87e74 MO	27	* 0x10000 LBAs corresponding to a NMASK or 16.
fcc87e74 MO	28	*/
65be2c79 MO	29	#define MC_CHUNK_SIZE (1 << MC_RHT_NMASK) /* in LBAs */
65be2c79 MO	30
471a5a60	31	#define CMD_TIMEOUT 30 /* 30 secs */
3ebf2030 MK	32	#define CMD_RETRIES 5 /* 5 retries for scsi_execute */
	33
	34	#define MAX_SECTOR_UNIT 512 /* max_sector is in 512 byte multiples */
65be2c79	35
65be2c79 MO	36	enum lun_mode {
65be2c79 MO	37	MODE_NONE = 0,
2cb79266	38	MODE_VIRTUAL,
65be2c79 MO	39	MODE_PHYSICAL
	40	};
	41
	42	/* Global (entire driver, spans adapters) lun_info structure */
	43	struct glun_info {
	44	u64 max_lba; /* from read cap(16) */
	45	u32 blk_len; /* from read cap(16) */
2cb79266	46	enum lun_mode mode; /* NONE, VIRTUAL, PHYSICAL */
65be2c79 MO	47	int users; /* Number of users w/ references to LUN */
	48
	49	u8 wwid[16];
	50
	51	struct mutex mutex;
	52
2cb79266	53	struct blka blka;
65be2c79 MO	54	struct list_head list;
	55	};
	56
	57	/* Local (per-adapter) lun_info structure */
	58	struct llun_info {
78ae028e	59	u64 lun_id[MAX_FC_PORTS]; /* from REPORT_LUNS */
65be2c79 MO	60	u32 lun_index; /* Index in the LUN table */
	61	u32 host_no; /* host_no from Scsi_host */
	62	u32 port_sel; /* What port to use for this LUN */
2cb79266	63	bool in_table; /* Whether a LUN table entry was created */
65be2c79 MO	64
	65	u8 wwid[16]; /* Keep a duplicate copy here? */
	66
	67	struct glun_info parent; / Pointer to entry in global LUN structure */
	68	struct scsi_device *sdev;
	69	struct list_head list;
	70	};
	71
	72	struct lun_access {
	73	struct llun_info *lli;
	74	struct scsi_device *sdev;
	75	struct list_head list;
	76	};
	77
	78	enum ctx_ctrl {
	79	CTX_CTRL_CLONE = (1 << 1),
	80	CTX_CTRL_ERR = (1 << 2),
	81	CTX_CTRL_ERR_FALLBACK = (1 << 3),
	82	CTX_CTRL_NOPID = (1 << 4),
	83	CTX_CTRL_FILE = (1 << 5)
	84	};
	85
a76df368	86	#define ENCODE_CTXID(_ctx, _id) (((((u64)_ctx) & 0xFFFFFFFF0ULL) << 28) \| _id)
65be2c79 MO	87	#define DECODE_CTXID(_val) (_val & 0xFFFFFFFF)
	88
	89	struct ctx_info {
1786f4a0	90	struct sisl_ctrl_map __iomem ctrl_map; / initialized at startup */
65be2c79	91	struct sisl_rht_entry rht_start; / 1 page (req'd for alignment),
fcc87e74 MO	92	* alloc/free on attach/detach
fcc87e74 MO	93	*/
65be2c79 MO	94	u32 rht_out; /* Number of checked out RHT entries */
	95	u32 rht_perms; /* User-defined permissions for RHT entries */
	96	struct llun_info *rht_lun; / Mapping of RHT entries to LUNs */
e568e23f	97	u8 rht_needs_ws; / User-desired write-same function per RHTE */
65be2c79 MO	98
	99	struct cxl_ioctl_start_work work;
	100	u64 ctxid;
65be2c79	101	pid_t pid;
5e6632d1	102	bool initialized;
65be2c79 MO	103	bool unavail;
	104	bool err_recovery_active;
	105	struct mutex mutex; /* Context protection */
888baf06	106	struct kref kref;
65be2c79	107	struct cxl_context *ctx;
44ef38f9	108	struct cxlflash_cfg *cfg;
65be2c79 MO	109	struct list_head luns; /* LUNs attached to this context */
	110	const struct vm_operations_struct *cxl_mmap_vmops;
	111	struct file *file;
	112	struct list_head list; /* Link contexts in error recovery */
	113	};
	114
	115	struct cxlflash_global {
	116	struct mutex mutex;
	117	struct list_head gluns;/* list of glun_info structs */
	118	struct page err_page; / One page of all 0xF for error notification */
	119	};
	120
fcc87e74 MO	121	int cxlflash_vlun_resize(struct scsi_device *sdev,
	122	struct dk_cxlflash_resize *resize);
	123	int _cxlflash_vlun_resize(struct scsi_device sdev, struct ctx_info ctxi,
	124	struct dk_cxlflash_resize *resize);
2cb79266	125
fcc87e74 MO	126	int cxlflash_disk_release(struct scsi_device *sdev,
	127	struct dk_cxlflash_release *release);
	128	int _cxlflash_disk_release(struct scsi_device sdev, struct ctx_info ctxi,
	129	struct dk_cxlflash_release *release);
65be2c79	130
fcc87e74 MO	131	int cxlflash_disk_clone(struct scsi_device *sdev,
fcc87e74 MO	132	struct dk_cxlflash_clone *clone);
2cb79266	133
fcc87e74	134	int cxlflash_disk_virtual_open(struct scsi_device sdev, void arg);
2cb79266	135
fcc87e74 MO	136	int cxlflash_lun_attach(struct glun_info *gli, enum lun_mode mode, bool locked);
fcc87e74 MO	137	void cxlflash_lun_detach(struct glun_info *gli);
65be2c79	138
fcc87e74 MO	139	struct ctx_info get_context(struct cxlflash_cfg cfg, u64 rctxit, void *arg,
	140	enum ctx_ctrl ctrl);
	141	void put_context(struct ctx_info *ctxi);
65be2c79	142
fcc87e74 MO	143	struct sisl_rht_entry get_rhte(struct ctx_info ctxi, res_hndl_t rhndl,
fcc87e74 MO	144	struct llun_info *lli);
65be2c79	145
fcc87e74 MO	146	struct sisl_rht_entry rhte_checkout(struct ctx_info ctxi,
	147	struct llun_info *lli);
	148	void rhte_checkin(struct ctx_info ctxi, struct sisl_rht_entry rhte);
65be2c79	149
fcc87e74	150	void cxlflash_ba_terminate(struct ba_lun *ba_lun);
2cb79266	151
fcc87e74 MO	152	int cxlflash_manage_lun(struct scsi_device *sdev,
fcc87e74 MO	153	struct dk_cxlflash_manage_lun *manage);
65be2c79	154
fcc87e74	155	int check_state(struct cxlflash_cfg *cfg);
aacb4ff6	156
65be2c79	157	#endif /* ifndef _CXLFLASH_SUPERPIPE_H */