tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1#ifndef TARGET_CORE_TRANSPORT_H
2#define TARGET_CORE_TRANSPORT_H
3
4#define TARGET_CORE_VERSION TARGET_CORE_MOD_VERSION
5
6/* Attempts before moving from SHORT to LONG */
7#define PYX_TRANSPORT_WINDOW_CLOSED_THRESHOLD 3
8#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_SHORT 3 /* In milliseconds */
9#define PYX_TRANSPORT_WINDOW_CLOSED_WAIT_LONG 10 /* In milliseconds */
10
11#define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
12
13#define PYX_TRANSPORT_SENT_TO_TRANSPORT 0
14#define PYX_TRANSPORT_WRITE_PENDING 1
15
16#define PYX_TRANSPORT_UNKNOWN_SAM_OPCODE -1
17#define PYX_TRANSPORT_HBA_QUEUE_FULL -2
18#define PYX_TRANSPORT_REQ_TOO_MANY_SECTORS -3
19#define PYX_TRANSPORT_OUT_OF_MEMORY_RESOURCES -4
20#define PYX_TRANSPORT_INVALID_CDB_FIELD -5
21#define PYX_TRANSPORT_INVALID_PARAMETER_LIST -6
22#define PYX_TRANSPORT_LU_COMM_FAILURE -7
23#define PYX_TRANSPORT_UNKNOWN_MODE_PAGE -8
24#define PYX_TRANSPORT_WRITE_PROTECTED -9
25#define PYX_TRANSPORT_TASK_TIMEOUT -10
26#define PYX_TRANSPORT_RESERVATION_CONFLICT -11
27#define PYX_TRANSPORT_ILLEGAL_REQUEST -12
28#define PYX_TRANSPORT_USE_SENSE_REASON -13
29
30#ifndef SAM_STAT_RESERVATION_CONFLICT
31#define SAM_STAT_RESERVATION_CONFLICT 0x18
32#endif
33
34#define TRANSPORT_PLUGIN_FREE 0
35#define TRANSPORT_PLUGIN_REGISTERED 1
36
37#define TRANSPORT_PLUGIN_PHBA_PDEV 1
38#define TRANSPORT_PLUGIN_VHBA_PDEV 2
39#define TRANSPORT_PLUGIN_VHBA_VDEV 3
40
41/* For SE OBJ Plugins, in seconds */
42#define TRANSPORT_TIMEOUT_TUR 10
43#define TRANSPORT_TIMEOUT_TYPE_DISK 60
44#define TRANSPORT_TIMEOUT_TYPE_ROM 120
45#define TRANSPORT_TIMEOUT_TYPE_TAPE 600
46#define TRANSPORT_TIMEOUT_TYPE_OTHER 300
47
48/* For se_task->task_state_flags */
49#define TSF_EXCEPTION_CLEARED 0x01
50
51/*
52 * struct se_subsystem_dev->su_dev_flags
53*/
54#define SDF_FIRMWARE_VPD_UNIT_SERIAL 0x00000001
55#define SDF_EMULATED_VPD_UNIT_SERIAL 0x00000002
56#define SDF_USING_UDEV_PATH 0x00000004
57#define SDF_USING_ALIAS 0x00000008
58
59/*
60 * struct se_device->dev_flags
61 */
62#define DF_READ_ONLY 0x00000001
63#define DF_SPC2_RESERVATIONS 0x00000002
64#define DF_SPC2_RESERVATIONS_WITH_ISID 0x00000004
65
66/* struct se_dev_attrib sanity values */
67/* 10 Minutes */
68#define DA_TASK_TIMEOUT_MAX 600
69/* Default max_unmap_lba_count */
70#define DA_MAX_UNMAP_LBA_COUNT 0
71/* Default max_unmap_block_desc_count */
72#define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
73/* Default unmap_granularity */
74#define DA_UNMAP_GRANULARITY_DEFAULT 0
75/* Default unmap_granularity_alignment */
76#define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
77/* Emulation for Direct Page Out */
78#define DA_EMULATE_DPO 0
79/* Emulation for Forced Unit Access WRITEs */
80#define DA_EMULATE_FUA_WRITE 1
81/* Emulation for Forced Unit Access READs */
82#define DA_EMULATE_FUA_READ 0
83/* Emulation for WriteCache and SYNCHRONIZE_CACHE */
84#define DA_EMULATE_WRITE_CACHE 0
85/* Emulation for UNIT ATTENTION Interlock Control */
86#define DA_EMULATE_UA_INTLLCK_CTRL 0
87/* Emulation for TASK_ABORTED status (TAS) by default */
88#define DA_EMULATE_TAS 1
89/* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
90#define DA_EMULATE_TPU 0
91/*
92 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
93 * block/blk-lib.c:blkdev_issue_discard()
94 */
95#define DA_EMULATE_TPWS 0
96/* No Emulation for PSCSI by default */
97#define DA_EMULATE_RESERVATIONS 0
98/* No Emulation for PSCSI by default */
99#define DA_EMULATE_ALUA 0
100/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
101#define DA_ENFORCE_PR_ISIDS 1
102#define DA_STATUS_MAX_SECTORS_MIN 16
103#define DA_STATUS_MAX_SECTORS_MAX 8192
104
105#define SE_MODE_PAGE_BUF 512
106
107#define MOD_MAX_SECTORS(ms, bs) (ms % (PAGE_SIZE / bs))
108
109struct se_mem;
110struct se_subsystem_api;
111
112extern struct kmem_cache *se_mem_cache;
113
114extern int init_se_global(void);
115extern void release_se_global(void);
116extern void init_scsi_index_table(void);
117extern u32 scsi_get_new_index(scsi_index_t);
118extern void transport_init_queue_obj(struct se_queue_obj *);
119extern int transport_subsystem_check_init(void);
120extern int transport_subsystem_register(struct se_subsystem_api *);
121extern void transport_subsystem_release(struct se_subsystem_api *);
122extern void transport_load_plugins(void);
123extern struct se_session *transport_init_session(void);
124extern void __transport_register_session(struct se_portal_group *,
125 struct se_node_acl *,
126 struct se_session *, void *);
127extern void transport_register_session(struct se_portal_group *,
128 struct se_node_acl *,
129 struct se_session *, void *);
130extern void transport_free_session(struct se_session *);
131extern void transport_deregister_session_configfs(struct se_session *);
132extern void transport_deregister_session(struct se_session *);
133extern void transport_cmd_finish_abort(struct se_cmd *, int);
134extern void transport_cmd_finish_abort_tmr(struct se_cmd *);
135extern void transport_complete_sync_cache(struct se_cmd *, int);
136extern void transport_complete_task(struct se_task *, int);
137extern void transport_add_task_to_execute_queue(struct se_task *,
138 struct se_task *,
139 struct se_device *);
140extern void transport_remove_task_from_execute_queue(struct se_task *,
141 struct se_device *);
142unsigned char *transport_dump_cmd_direction(struct se_cmd *);
143extern void transport_dump_dev_state(struct se_device *, char *, int *);
144extern void transport_dump_dev_info(struct se_device *, struct se_lun *,
145 unsigned long long, char *, int *);
146extern void transport_dump_vpd_proto_id(struct t10_vpd *,
147 unsigned char *, int);
148extern void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
149extern int transport_dump_vpd_assoc(struct t10_vpd *,
150 unsigned char *, int);
151extern int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
152extern int transport_dump_vpd_ident_type(struct t10_vpd *,
153 unsigned char *, int);
154extern int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
155extern int transport_dump_vpd_ident(struct t10_vpd *,
156 unsigned char *, int);
157extern int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
158extern struct se_device *transport_add_device_to_core_hba(struct se_hba *,
159 struct se_subsystem_api *,
160 struct se_subsystem_dev *, u32,
161 void *, struct se_dev_limits *,
162 const char *, const char *);
163extern void transport_device_setup_cmd(struct se_cmd *);
164extern void transport_init_se_cmd(struct se_cmd *,
165 struct target_core_fabric_ops *,
166 struct se_session *, u32, int, int,
167 unsigned char *);
168extern void transport_free_se_cmd(struct se_cmd *);
169extern int transport_generic_allocate_tasks(struct se_cmd *, unsigned char *);
170extern int transport_generic_handle_cdb(struct se_cmd *);
171extern int transport_generic_handle_cdb_map(struct se_cmd *);
172extern int transport_generic_handle_data(struct se_cmd *);
173extern void transport_new_cmd_failure(struct se_cmd *);
174extern int transport_generic_handle_tmr(struct se_cmd *);
175extern void transport_generic_free_cmd_intr(struct se_cmd *);
176extern void __transport_stop_task_timer(struct se_task *, unsigned long *);
177extern unsigned char transport_asciihex_to_binaryhex(unsigned char val[2]);
178extern int transport_generic_map_mem_to_cmd(struct se_cmd *cmd, struct scatterlist *, u32,
179 struct scatterlist *, u32);
180extern int transport_clear_lun_from_sessions(struct se_lun *);
181extern int transport_check_aborted_status(struct se_cmd *, int);
182extern int transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
183extern void transport_send_task_abort(struct se_cmd *);
184extern void transport_release_cmd_to_pool(struct se_cmd *);
185extern void transport_generic_free_cmd(struct se_cmd *, int, int, int);
186extern void transport_generic_wait_for_cmds(struct se_cmd *, int);
187extern u32 transport_calc_sg_num(struct se_task *, struct se_mem *, u32);
188extern int transport_map_mem_to_sg(struct se_task *, struct list_head *,
189 void *, struct se_mem *,
190 struct se_mem **, u32 *, u32 *);
191extern void transport_do_task_sg_chain(struct se_cmd *);
192extern void transport_generic_process_write(struct se_cmd *);
193extern int transport_generic_do_tmr(struct se_cmd *);
194/* From target_core_alua.c */
195extern int core_alua_check_nonop_delay(struct se_cmd *);
196/* From target_core_cdb.c */
197extern int transport_emulate_control_cdb(struct se_task *);
198
199/*
200 * Each se_transport_task_t can have N number of possible struct se_task's
201 * for the storage transport(s) to possibly execute.
202 * Used primarily for splitting up CDBs that exceed the physical storage
203 * HBA's maximum sector count per task.
204 */
205struct se_mem {
206 struct page *se_page;
207 u32 se_len;
208 u32 se_off;
209 struct list_head se_list;
210} ____cacheline_aligned;
211
212/*
213 * Each type of disk transport supported MUST have a template defined
214 * within its .h file.
215 */
216struct se_subsystem_api {
217 /*
218 * The Name. :-)
219 */
220 char name[16];
221 /*
222 * Transport Type.
223 */
224 u8 transport_type;
225 /*
226 * struct module for struct se_hba references
227 */
228 struct module *owner;
229 /*
230 * Used for global se_subsystem_api list_head
231 */
232 struct list_head sub_api_list;
233 /*
234 * For SCF_SCSI_NON_DATA_CDB
235 */
236 int (*cdb_none)(struct se_task *);
237 /*
238 * For SCF_SCSI_CONTROL_NONSG_IO_CDB
239 */
240 int (*map_task_non_SG)(struct se_task *);
241 /*
242 * For SCF_SCSI_DATA_SG_IO_CDB and SCF_SCSI_CONTROL_SG_IO_CDB
243 */
244 int (*map_task_SG)(struct se_task *);
245 /*
246 * attach_hba():
247 */
248 int (*attach_hba)(struct se_hba *, u32);
249 /*
250 * detach_hba():
251 */
252 void (*detach_hba)(struct se_hba *);
253 /*
254 * pmode_hba(): Used for TCM/pSCSI subsystem plugin HBA ->
255 * Linux/SCSI struct Scsi_Host passthrough
256 */
257 int (*pmode_enable_hba)(struct se_hba *, unsigned long);
258 /*
259 * allocate_virtdevice():
260 */
261 void *(*allocate_virtdevice)(struct se_hba *, const char *);
262 /*
263 * create_virtdevice(): Only for Virtual HBAs
264 */
265 struct se_device *(*create_virtdevice)(struct se_hba *,
266 struct se_subsystem_dev *, void *);
267 /*
268 * free_device():
269 */
270 void (*free_device)(void *);
271
272 /*
273 * dpo_emulated():
274 */
275 int (*dpo_emulated)(struct se_device *);
276 /*
277 * fua_write_emulated():
278 */
279 int (*fua_write_emulated)(struct se_device *);
280 /*
281 * fua_read_emulated():
282 */
283 int (*fua_read_emulated)(struct se_device *);
284 /*
285 * write_cache_emulated():
286 */
287 int (*write_cache_emulated)(struct se_device *);
288 /*
289 * transport_complete():
290 *
291 * Use transport_generic_complete() for majority of DAS transport
292 * drivers. Provided out of convenience.
293 */
294 int (*transport_complete)(struct se_task *task);
295 struct se_task *(*alloc_task)(struct se_cmd *);
296 /*
297 * do_task():
298 */
299 int (*do_task)(struct se_task *);
300 /*
301 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
302 * UNMAP and WRITE_SAME_* w/ UNMAP=1 <-> Linux/Block Discard
303 */
304 int (*do_discard)(struct se_device *, sector_t, u32);
305 /*
306 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
307 * SYNCHRONIZE_CACHE_* <-> Linux/Block blkdev_issue_flush()
308 */
309 void (*do_sync_cache)(struct se_task *);
310 /*
311 * free_task():
312 */
313 void (*free_task)(struct se_task *);
314 /*
315 * check_configfs_dev_params():
316 */
317 ssize_t (*check_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *);
318 /*
319 * set_configfs_dev_params():
320 */
321 ssize_t (*set_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
322 const char *, ssize_t);
323 /*
324 * show_configfs_dev_params():
325 */
326 ssize_t (*show_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
327 char *);
328 /*
329 * get_cdb():
330 */
331 unsigned char *(*get_cdb)(struct se_task *);
332 /*
333 * get_device_rev():
334 */
335 u32 (*get_device_rev)(struct se_device *);
336 /*
337 * get_device_type():
338 */
339 u32 (*get_device_type)(struct se_device *);
340 /*
341 * Get the sector_t from a subsystem backstore..
342 */
343 sector_t (*get_blocks)(struct se_device *);
344 /*
345 * do_se_mem_map():
346 */
347 int (*do_se_mem_map)(struct se_task *, struct list_head *, void *,
348 struct se_mem *, struct se_mem **, u32 *, u32 *);
349 /*
350 * get_sense_buffer():
351 */
352 unsigned char *(*get_sense_buffer)(struct se_task *);
353} ____cacheline_aligned;
354
355#define TRANSPORT(dev) ((dev)->transport)
356#define HBA_TRANSPORT(hba) ((hba)->transport)
357
358extern struct se_global *se_global;
359
360#endif /* TARGET_CORE_TRANSPORT_H */