projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
target: factor some duplicate code for stopping a task
[deliverable/linux.git] / include / target / target_core_transport.h
CommitLineData
c66ac9db
NB		 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
c66ac9db
NB		 48/*
49 * struct se_subsystem_dev->su_dev_flags
50*/
51#define SDF_FIRMWARE_VPD_UNIT_SERIAL 0x00000001
52#define SDF_EMULATED_VPD_UNIT_SERIAL 0x00000002
53#define SDF_USING_UDEV_PATH 0x00000004
54#define SDF_USING_ALIAS 0x00000008
55
56/*
57 * struct se_device->dev_flags
58 */
59#define DF_READ_ONLY 0x00000001
60#define DF_SPC2_RESERVATIONS 0x00000002
61#define DF_SPC2_RESERVATIONS_WITH_ISID 0x00000004
62
63/* struct se_dev_attrib sanity values */
64/* 10 Minutes */
65#define DA_TASK_TIMEOUT_MAX 600
66/* Default max_unmap_lba_count */
67#define DA_MAX_UNMAP_LBA_COUNT 0
68/* Default max_unmap_block_desc_count */
69#define DA_MAX_UNMAP_BLOCK_DESC_COUNT 0
70/* Default unmap_granularity */
71#define DA_UNMAP_GRANULARITY_DEFAULT 0
72/* Default unmap_granularity_alignment */
73#define DA_UNMAP_GRANULARITY_ALIGNMENT_DEFAULT 0
74/* Emulation for Direct Page Out */
75#define DA_EMULATE_DPO 0
76/* Emulation for Forced Unit Access WRITEs */
77#define DA_EMULATE_FUA_WRITE 1
78/* Emulation for Forced Unit Access READs */
79#define DA_EMULATE_FUA_READ 0
80/* Emulation for WriteCache and SYNCHRONIZE_CACHE */
81#define DA_EMULATE_WRITE_CACHE 0
82/* Emulation for UNIT ATTENTION Interlock Control */
83#define DA_EMULATE_UA_INTLLCK_CTRL 0
84/* Emulation for TASK_ABORTED status (TAS) by default */
85#define DA_EMULATE_TAS 1
86/* Emulation for Thin Provisioning UNMAP using block/blk-lib.c:blkdev_issue_discard() */
87#define DA_EMULATE_TPU 0
88/*
89 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
90 * block/blk-lib.c:blkdev_issue_discard()
91 */
92#define DA_EMULATE_TPWS 0
93/* No Emulation for PSCSI by default */
94#define DA_EMULATE_RESERVATIONS 0
95/* No Emulation for PSCSI by default */
96#define DA_EMULATE_ALUA 0
97/* Enforce SCSI Initiator Port TransportID with 'ISID' for PR */
98#define DA_ENFORCE_PR_ISIDS 1
99#define DA_STATUS_MAX_SECTORS_MIN 16
100#define DA_STATUS_MAX_SECTORS_MAX 8192
e22a7f07
RD		 101/* By default don't report non-rotating (solid state) medium */
102#define DA_IS_NONROT 0
5de619a3
NB		 103/* Queue Algorithm Modifier default for restricted reordering in control mode page */
104#define DA_EMULATE_REST_REORD 0
c66ac9db
NB		 105
106#define SE_MODE_PAGE_BUF 512
107
108#define MOD_MAX_SECTORS(ms, bs) (ms % (PAGE_SIZE / bs))
109
c66ac9db
NB		 110struct se_subsystem_api;
111
e3d6f909
AG		 112extern int init_se_kmem_caches(void);
113extern void release_se_kmem_caches(void);
e89d15ee 114extern u32 scsi_get_new_index(scsi_index_t);
c66ac9db
NB		 115extern void transport_init_queue_obj(struct se_queue_obj *);
116extern int transport_subsystem_check_init(void);
117extern int transport_subsystem_register(struct se_subsystem_api *);
118extern void transport_subsystem_release(struct se_subsystem_api *);
119extern void transport_load_plugins(void);
120extern struct se_session *transport_init_session(void);
121extern void __transport_register_session(struct se_portal_group *,
122 struct se_node_acl *,
123 struct se_session *, void *);
124extern void transport_register_session(struct se_portal_group *,
125 struct se_node_acl *,
126 struct se_session *, void *);
127extern void transport_free_session(struct se_session *);
128extern void transport_deregister_session_configfs(struct se_session *);
129extern void transport_deregister_session(struct se_session *);
130extern void transport_cmd_finish_abort(struct se_cmd *, int);
c66ac9db
NB		 131extern void transport_complete_sync_cache(struct se_cmd *, int);
132extern void transport_complete_task(struct se_task *, int);
133extern void transport_add_task_to_execute_queue(struct se_task *,
134 struct se_task *,
135 struct se_device *);
52208ae3
NB		 136extern void transport_remove_task_from_execute_queue(struct se_task *,
137 struct se_device *);
04629b7b
CH		 138extern void __transport_remove_task_from_execute_queue(struct se_task *,
139 struct se_device *);
c66ac9db
NB		 140unsigned char *transport_dump_cmd_direction(struct se_cmd *);
141extern void transport_dump_dev_state(struct se_device *, char *, int *);
142extern void transport_dump_dev_info(struct se_device *, struct se_lun *,
143 unsigned long long, char *, int *);
144extern void transport_dump_vpd_proto_id(struct t10_vpd *,
145 unsigned char *, int);
146extern void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
147extern int transport_dump_vpd_assoc(struct t10_vpd *,
148 unsigned char *, int);
149extern int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
150extern int transport_dump_vpd_ident_type(struct t10_vpd *,
151 unsigned char *, int);
152extern int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
153extern int transport_dump_vpd_ident(struct t10_vpd *,
154 unsigned char *, int);
155extern int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
156extern struct se_device *transport_add_device_to_core_hba(struct se_hba *,
157 struct se_subsystem_api *,
158 struct se_subsystem_dev *, u32,
159 void *, struct se_dev_limits *,
160 const char *, const char *);
c66ac9db
NB		 161extern void transport_init_se_cmd(struct se_cmd *,
162 struct target_core_fabric_ops *,
163 struct se_session *, u32, int, int,
164 unsigned char *);
05d1c7c0
AG		 165void *transport_kmap_first_data_page(struct se_cmd *cmd);
166void transport_kunmap_first_data_page(struct se_cmd *cmd);
c66ac9db 167extern int transport_generic_allocate_tasks(struct se_cmd *, unsigned char *);
695434e1 168extern int transport_handle_cdb_direct(struct se_cmd *);
c66ac9db
NB		 169extern int transport_generic_handle_cdb_map(struct se_cmd *);
170extern int transport_generic_handle_data(struct se_cmd *);
171extern void transport_new_cmd_failure(struct se_cmd *);
172extern int transport_generic_handle_tmr(struct se_cmd *);
f4366772 173extern void transport_generic_free_cmd_intr(struct se_cmd *);
cdbb70bb 174extern bool target_stop_task(struct se_task *task, unsigned long *flags);
c66ac9db 175extern void __transport_stop_task_timer(struct se_task *, unsigned long *);
c66ac9db
NB		 176extern int transport_generic_map_mem_to_cmd(struct se_cmd *cmd, struct scatterlist *, u32,
177 struct scatterlist *, u32);
178extern int transport_clear_lun_from_sessions(struct se_lun *);
d14921d6 179extern void transport_wait_for_tasks(struct se_cmd *);
c66ac9db
NB		 180extern int transport_check_aborted_status(struct se_cmd *, int);
181extern int transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
182extern void transport_send_task_abort(struct se_cmd *);
35462975 183extern void transport_release_cmd(struct se_cmd *);
39c05f32 184extern void transport_generic_free_cmd(struct se_cmd *, int);
c66ac9db 185extern void transport_generic_wait_for_cmds(struct se_cmd *, int);
c66ac9db
NB		 186extern void transport_do_task_sg_chain(struct se_cmd *);
187extern void transport_generic_process_write(struct se_cmd *);
a1d8b49a 188extern int transport_generic_new_cmd(struct se_cmd *);
c66ac9db
NB		 189extern int transport_generic_do_tmr(struct se_cmd *);
190/* From target_core_alua.c */
191extern int core_alua_check_nonop_delay(struct se_cmd *);
5dd7ed2e
DC		 192/* From target_core_cdb.c */
193extern int transport_emulate_control_cdb(struct se_task *);
485fd0d1 194extern void target_get_task_cdb(struct se_task *task, unsigned char *cdb);
c66ac9db
NB		 195
196/*
197 * Each se_transport_task_t can have N number of possible struct se_task's
198 * for the storage transport(s) to possibly execute.
199 * Used primarily for splitting up CDBs that exceed the physical storage
200 * HBA's maximum sector count per task.
201 */
202struct se_mem {
203 struct page *se_page;
204 u32 se_len;
205 u32 se_off;
206 struct list_head se_list;
207} ____cacheline_aligned;
208
209/*
210 * Each type of disk transport supported MUST have a template defined
211 * within its .h file.
212 */
213struct se_subsystem_api {
214 /*
215 * The Name. :-)
216 */
217 char name[16];
218 /*
219 * Transport Type.
220 */
221 u8 transport_type;
f55918fa
CH		 222
223 unsigned int fua_write_emulated : 1;
224 unsigned int write_cache_emulated : 1;
225
c66ac9db
NB		 226 /*
227 * struct module for struct se_hba references
228 */
229 struct module *owner;
230 /*
231 * Used for global se_subsystem_api list_head
232 */
233 struct list_head sub_api_list;
c66ac9db
NB		 234 /*
235 * attach_hba():
236 */
237 int (*attach_hba)(struct se_hba *, u32);
238 /*
239 * detach_hba():
240 */
241 void (*detach_hba)(struct se_hba *);
242 /*
243 * pmode_hba(): Used for TCM/pSCSI subsystem plugin HBA ->
244 * Linux/SCSI struct Scsi_Host passthrough
245 */
246 int (*pmode_enable_hba)(struct se_hba *, unsigned long);
247 /*
248 * allocate_virtdevice():
249 */
250 void *(*allocate_virtdevice)(struct se_hba *, const char *);
251 /*
252 * create_virtdevice(): Only for Virtual HBAs
253 */
254 struct se_device *(*create_virtdevice)(struct se_hba *,
255 struct se_subsystem_dev *, void *);
256 /*
257 * free_device():
258 */
259 void (*free_device)(void *);
260
c66ac9db
NB		 261 /*
262 * transport_complete():
263 *
264 * Use transport_generic_complete() for majority of DAS transport
265 * drivers. Provided out of convenience.
266 */
267 int (*transport_complete)(struct se_task *task);
6708bb27 268 struct se_task *(*alloc_task)(unsigned char *cdb);
c66ac9db
NB		 269 /*
270 * do_task():
271 */
272 int (*do_task)(struct se_task *);
273 /*
274 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
275 * UNMAP and WRITE_SAME_* w/ UNMAP=1 <-> Linux/Block Discard
276 */
277 int (*do_discard)(struct se_device *, sector_t, u32);
278 /*
279 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
280 * SYNCHRONIZE_CACHE_* <-> Linux/Block blkdev_issue_flush()
281 */
282 void (*do_sync_cache)(struct se_task *);
283 /*
284 * free_task():
285 */
286 void (*free_task)(struct se_task *);
287 /*
288 * check_configfs_dev_params():
289 */
290 ssize_t (*check_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *);
291 /*
292 * set_configfs_dev_params():
293 */
294 ssize_t (*set_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
295 const char *, ssize_t);
296 /*
297 * show_configfs_dev_params():
298 */
299 ssize_t (*show_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *,
300 char *);
c66ac9db
NB		 301 /*
302 * get_device_rev():
303 */
304 u32 (*get_device_rev)(struct se_device *);
305 /*
306 * get_device_type():
307 */
308 u32 (*get_device_type)(struct se_device *);
309 /*
310 * Get the sector_t from a subsystem backstore..
311 */
312 sector_t (*get_blocks)(struct se_device *);
c66ac9db
NB		 313 /*
314 * get_sense_buffer():
315 */
316 unsigned char *(*get_sense_buffer)(struct se_task *);
317} ____cacheline_aligned;
318
c66ac9db 319#endif /* TARGET_CORE_TRANSPORT_H */
Linux kernel - Deliverables
This page took 0.073294 seconds and 5 git commands to generate.