tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
18extern 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
27 0x10000 LBAs corresponding to a NMASK or 16.
28*/
29#define MC_CHUNK_SIZE (1 << MC_RHT_NMASK) /* in LBAs */
30
31#define CMD_TIMEOUT 30 /* 30 secs */
32#define CMD_RETRIES 5 /* 5 retries for scsi_execute */
33
34#define MAX_SECTOR_UNIT 512 /* max_sector is in 512 byte multiples */
35
36#define CHAN2PORT(_x) ((_x) + 1)
37#define PORT2CHAN(_x) ((_x) - 1)
38
39enum lun_mode {
40 MODE_NONE = 0,
41 MODE_VIRTUAL,
42 MODE_PHYSICAL
43};
44
45/* Global (entire driver, spans adapters) lun_info structure */
46struct glun_info {
47 u64 max_lba; /* from read cap(16) */
48 u32 blk_len; /* from read cap(16) */
49 enum lun_mode mode; /* NONE, VIRTUAL, PHYSICAL */
50 int users; /* Number of users w/ references to LUN */
51
52 u8 wwid[16];
53
54 struct mutex mutex;
55
56 struct blka blka;
57 struct list_head list;
58};
59
60/* Local (per-adapter) lun_info structure */
61struct llun_info {
62 u64 lun_id[CXLFLASH_NUM_FC_PORTS]; /* from REPORT_LUNS */
63 u32 lun_index; /* Index in the LUN table */
64 u32 host_no; /* host_no from Scsi_host */
65 u32 port_sel; /* What port to use for this LUN */
66 bool in_table; /* Whether a LUN table entry was created */
67
68 u8 wwid[16]; /* Keep a duplicate copy here? */
69
70 struct glun_info *parent; /* Pointer to entry in global LUN structure */
71 struct scsi_device *sdev;
72 struct list_head list;
73};
74
75struct lun_access {
76 struct llun_info *lli;
77 struct scsi_device *sdev;
78 struct list_head list;
79};
80
81enum ctx_ctrl {
82 CTX_CTRL_CLONE = (1 << 1),
83 CTX_CTRL_ERR = (1 << 2),
84 CTX_CTRL_ERR_FALLBACK = (1 << 3),
85 CTX_CTRL_NOPID = (1 << 4),
86 CTX_CTRL_FILE = (1 << 5)
87};
88
89#define ENCODE_CTXID(_ctx, _id) (((((u64)_ctx) & 0xFFFFFFFF0ULL) << 28) | _id)
90#define DECODE_CTXID(_val) (_val & 0xFFFFFFFF)
91
92struct ctx_info {
93 struct sisl_ctrl_map __iomem *ctrl_map; /* initialized at startup */
94 struct sisl_rht_entry *rht_start; /* 1 page (req'd for alignment),
95 alloc/free on attach/detach */
96 u32 rht_out; /* Number of checked out RHT entries */
97 u32 rht_perms; /* User-defined permissions for RHT entries */
98 struct llun_info **rht_lun; /* Mapping of RHT entries to LUNs */
99 u8 *rht_needs_ws; /* User-desired write-same function per RHTE */
100
101 struct cxl_ioctl_start_work work;
102 u64 ctxid;
103 int lfd;
104 pid_t pid;
105 bool initialized;
106 bool unavail;
107 bool err_recovery_active;
108 struct mutex mutex; /* Context protection */
109 struct cxl_context *ctx;
110 struct list_head luns; /* LUNs attached to this context */
111 const struct vm_operations_struct *cxl_mmap_vmops;
112 struct file *file;
113 struct list_head list; /* Link contexts in error recovery */
114};
115
116struct cxlflash_global {
117 struct mutex mutex;
118 struct list_head gluns;/* list of glun_info structs */
119 struct page *err_page; /* One page of all 0xF for error notification */
120};
121
122int cxlflash_vlun_resize(struct scsi_device *, struct dk_cxlflash_resize *);
123int _cxlflash_vlun_resize(struct scsi_device *, struct ctx_info *,
124 struct dk_cxlflash_resize *);
125
126int cxlflash_disk_release(struct scsi_device *, struct dk_cxlflash_release *);
127int _cxlflash_disk_release(struct scsi_device *, struct ctx_info *,
128 struct dk_cxlflash_release *);
129
130int cxlflash_disk_clone(struct scsi_device *, struct dk_cxlflash_clone *);
131
132int cxlflash_disk_virtual_open(struct scsi_device *, void *);
133
134int cxlflash_lun_attach(struct glun_info *, enum lun_mode, bool);
135void cxlflash_lun_detach(struct glun_info *);
136
137struct ctx_info *get_context(struct cxlflash_cfg *, u64, void *, enum ctx_ctrl);
138void put_context(struct ctx_info *);
139
140struct sisl_rht_entry *get_rhte(struct ctx_info *, res_hndl_t,
141 struct llun_info *);
142
143struct sisl_rht_entry *rhte_checkout(struct ctx_info *, struct llun_info *);
144void rhte_checkin(struct ctx_info *, struct sisl_rht_entry *);
145
146void cxlflash_ba_terminate(struct ba_lun *);
147
148int cxlflash_manage_lun(struct scsi_device *, struct dk_cxlflash_manage_lun *);
149
150int check_state(struct cxlflash_cfg *);
151
152#endif /* ifndef _CXLFLASH_SUPERPIPE_H */