Commit | Line | Data |
---|---|---|
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 | ||
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 | |
e22a7f07 RD |
104 | /* By default don't report non-rotating (solid state) medium */ |
105 | #define DA_IS_NONROT 0 | |
5de619a3 NB |
106 | /* Queue Algorithm Modifier default for restricted reordering in control mode page */ |
107 | #define DA_EMULATE_REST_REORD 0 | |
c66ac9db NB |
108 | |
109 | #define SE_MODE_PAGE_BUF 512 | |
110 | ||
111 | #define MOD_MAX_SECTORS(ms, bs) (ms % (PAGE_SIZE / bs)) | |
112 | ||
c66ac9db NB |
113 | struct se_subsystem_api; |
114 | ||
e3d6f909 AG |
115 | extern int init_se_kmem_caches(void); |
116 | extern void release_se_kmem_caches(void); | |
e89d15ee | 117 | extern u32 scsi_get_new_index(scsi_index_t); |
c66ac9db NB |
118 | extern void transport_init_queue_obj(struct se_queue_obj *); |
119 | extern int transport_subsystem_check_init(void); | |
120 | extern int transport_subsystem_register(struct se_subsystem_api *); | |
121 | extern void transport_subsystem_release(struct se_subsystem_api *); | |
122 | extern void transport_load_plugins(void); | |
123 | extern struct se_session *transport_init_session(void); | |
124 | extern void __transport_register_session(struct se_portal_group *, | |
125 | struct se_node_acl *, | |
126 | struct se_session *, void *); | |
127 | extern void transport_register_session(struct se_portal_group *, | |
128 | struct se_node_acl *, | |
129 | struct se_session *, void *); | |
130 | extern void transport_free_session(struct se_session *); | |
131 | extern void transport_deregister_session_configfs(struct se_session *); | |
132 | extern void transport_deregister_session(struct se_session *); | |
133 | extern void transport_cmd_finish_abort(struct se_cmd *, int); | |
c66ac9db NB |
134 | extern void transport_complete_sync_cache(struct se_cmd *, int); |
135 | extern void transport_complete_task(struct se_task *, int); | |
136 | extern void transport_add_task_to_execute_queue(struct se_task *, | |
137 | struct se_task *, | |
138 | struct se_device *); | |
52208ae3 NB |
139 | extern void transport_remove_task_from_execute_queue(struct se_task *, |
140 | struct se_device *); | |
c66ac9db NB |
141 | unsigned char *transport_dump_cmd_direction(struct se_cmd *); |
142 | extern void transport_dump_dev_state(struct se_device *, char *, int *); | |
143 | extern void transport_dump_dev_info(struct se_device *, struct se_lun *, | |
144 | unsigned long long, char *, int *); | |
145 | extern void transport_dump_vpd_proto_id(struct t10_vpd *, | |
146 | unsigned char *, int); | |
147 | extern void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *); | |
148 | extern int transport_dump_vpd_assoc(struct t10_vpd *, | |
149 | unsigned char *, int); | |
150 | extern int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *); | |
151 | extern int transport_dump_vpd_ident_type(struct t10_vpd *, | |
152 | unsigned char *, int); | |
153 | extern int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *); | |
154 | extern int transport_dump_vpd_ident(struct t10_vpd *, | |
155 | unsigned char *, int); | |
156 | extern int transport_set_vpd_ident(struct t10_vpd *, unsigned char *); | |
157 | extern struct se_device *transport_add_device_to_core_hba(struct se_hba *, | |
158 | struct se_subsystem_api *, | |
159 | struct se_subsystem_dev *, u32, | |
160 | void *, struct se_dev_limits *, | |
161 | const char *, const char *); | |
c66ac9db NB |
162 | extern void transport_init_se_cmd(struct se_cmd *, |
163 | struct target_core_fabric_ops *, | |
164 | struct se_session *, u32, int, int, | |
165 | unsigned char *); | |
05d1c7c0 AG |
166 | void *transport_kmap_first_data_page(struct se_cmd *cmd); |
167 | void transport_kunmap_first_data_page(struct se_cmd *cmd); | |
c66ac9db | 168 | extern int transport_generic_allocate_tasks(struct se_cmd *, unsigned char *); |
695434e1 | 169 | extern int transport_handle_cdb_direct(struct se_cmd *); |
c66ac9db NB |
170 | extern int transport_generic_handle_cdb_map(struct se_cmd *); |
171 | extern int transport_generic_handle_data(struct se_cmd *); | |
172 | extern void transport_new_cmd_failure(struct se_cmd *); | |
173 | extern int transport_generic_handle_tmr(struct se_cmd *); | |
f4366772 | 174 | extern void transport_generic_free_cmd_intr(struct se_cmd *); |
c66ac9db | 175 | extern void __transport_stop_task_timer(struct se_task *, unsigned long *); |
c66ac9db NB |
176 | extern int transport_generic_map_mem_to_cmd(struct se_cmd *cmd, struct scatterlist *, u32, |
177 | struct scatterlist *, u32); | |
178 | extern int transport_clear_lun_from_sessions(struct se_lun *); | |
d14921d6 | 179 | extern void transport_wait_for_tasks(struct se_cmd *); |
c66ac9db NB |
180 | extern int transport_check_aborted_status(struct se_cmd *, int); |
181 | extern int transport_send_check_condition_and_sense(struct se_cmd *, u8, int); | |
182 | extern void transport_send_task_abort(struct se_cmd *); | |
35462975 | 183 | extern void transport_release_cmd(struct se_cmd *); |
39c05f32 | 184 | extern void transport_generic_free_cmd(struct se_cmd *, int); |
c66ac9db | 185 | extern void transport_generic_wait_for_cmds(struct se_cmd *, int); |
c66ac9db NB |
186 | extern void transport_do_task_sg_chain(struct se_cmd *); |
187 | extern void transport_generic_process_write(struct se_cmd *); | |
a1d8b49a | 188 | extern int transport_generic_new_cmd(struct se_cmd *); |
c66ac9db NB |
189 | extern int transport_generic_do_tmr(struct se_cmd *); |
190 | /* From target_core_alua.c */ | |
191 | extern int core_alua_check_nonop_delay(struct se_cmd *); | |
5dd7ed2e DC |
192 | /* From target_core_cdb.c */ |
193 | extern int transport_emulate_control_cdb(struct se_task *); | |
c66ac9db NB |
194 | |
195 | /* | |
196 | * Each se_transport_task_t can have N number of possible struct se_task's | |
197 | * for the storage transport(s) to possibly execute. | |
198 | * Used primarily for splitting up CDBs that exceed the physical storage | |
199 | * HBA's maximum sector count per task. | |
200 | */ | |
201 | struct se_mem { | |
202 | struct page *se_page; | |
203 | u32 se_len; | |
204 | u32 se_off; | |
205 | struct list_head se_list; | |
206 | } ____cacheline_aligned; | |
207 | ||
208 | /* | |
209 | * Each type of disk transport supported MUST have a template defined | |
210 | * within its .h file. | |
211 | */ | |
212 | struct se_subsystem_api { | |
213 | /* | |
214 | * The Name. :-) | |
215 | */ | |
216 | char name[16]; | |
217 | /* | |
218 | * Transport Type. | |
219 | */ | |
220 | u8 transport_type; | |
221 | /* | |
222 | * struct module for struct se_hba references | |
223 | */ | |
224 | struct module *owner; | |
225 | /* | |
226 | * Used for global se_subsystem_api list_head | |
227 | */ | |
228 | struct list_head sub_api_list; | |
c66ac9db NB |
229 | /* |
230 | * attach_hba(): | |
231 | */ | |
232 | int (*attach_hba)(struct se_hba *, u32); | |
233 | /* | |
234 | * detach_hba(): | |
235 | */ | |
236 | void (*detach_hba)(struct se_hba *); | |
237 | /* | |
238 | * pmode_hba(): Used for TCM/pSCSI subsystem plugin HBA -> | |
239 | * Linux/SCSI struct Scsi_Host passthrough | |
240 | */ | |
241 | int (*pmode_enable_hba)(struct se_hba *, unsigned long); | |
242 | /* | |
243 | * allocate_virtdevice(): | |
244 | */ | |
245 | void *(*allocate_virtdevice)(struct se_hba *, const char *); | |
246 | /* | |
247 | * create_virtdevice(): Only for Virtual HBAs | |
248 | */ | |
249 | struct se_device *(*create_virtdevice)(struct se_hba *, | |
250 | struct se_subsystem_dev *, void *); | |
251 | /* | |
252 | * free_device(): | |
253 | */ | |
254 | void (*free_device)(void *); | |
255 | ||
256 | /* | |
257 | * dpo_emulated(): | |
258 | */ | |
259 | int (*dpo_emulated)(struct se_device *); | |
260 | /* | |
261 | * fua_write_emulated(): | |
262 | */ | |
263 | int (*fua_write_emulated)(struct se_device *); | |
264 | /* | |
265 | * fua_read_emulated(): | |
266 | */ | |
267 | int (*fua_read_emulated)(struct se_device *); | |
268 | /* | |
269 | * write_cache_emulated(): | |
270 | */ | |
271 | int (*write_cache_emulated)(struct se_device *); | |
272 | /* | |
273 | * transport_complete(): | |
274 | * | |
275 | * Use transport_generic_complete() for majority of DAS transport | |
276 | * drivers. Provided out of convenience. | |
277 | */ | |
278 | int (*transport_complete)(struct se_task *task); | |
6708bb27 | 279 | struct se_task *(*alloc_task)(unsigned char *cdb); |
c66ac9db NB |
280 | /* |
281 | * do_task(): | |
282 | */ | |
283 | int (*do_task)(struct se_task *); | |
284 | /* | |
285 | * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate | |
286 | * UNMAP and WRITE_SAME_* w/ UNMAP=1 <-> Linux/Block Discard | |
287 | */ | |
288 | int (*do_discard)(struct se_device *, sector_t, u32); | |
289 | /* | |
290 | * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate | |
291 | * SYNCHRONIZE_CACHE_* <-> Linux/Block blkdev_issue_flush() | |
292 | */ | |
293 | void (*do_sync_cache)(struct se_task *); | |
294 | /* | |
295 | * free_task(): | |
296 | */ | |
297 | void (*free_task)(struct se_task *); | |
298 | /* | |
299 | * check_configfs_dev_params(): | |
300 | */ | |
301 | ssize_t (*check_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *); | |
302 | /* | |
303 | * set_configfs_dev_params(): | |
304 | */ | |
305 | ssize_t (*set_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *, | |
306 | const char *, ssize_t); | |
307 | /* | |
308 | * show_configfs_dev_params(): | |
309 | */ | |
310 | ssize_t (*show_configfs_dev_params)(struct se_hba *, struct se_subsystem_dev *, | |
311 | char *); | |
312 | /* | |
313 | * get_cdb(): | |
314 | */ | |
315 | unsigned char *(*get_cdb)(struct se_task *); | |
316 | /* | |
317 | * get_device_rev(): | |
318 | */ | |
319 | u32 (*get_device_rev)(struct se_device *); | |
320 | /* | |
321 | * get_device_type(): | |
322 | */ | |
323 | u32 (*get_device_type)(struct se_device *); | |
324 | /* | |
325 | * Get the sector_t from a subsystem backstore.. | |
326 | */ | |
327 | sector_t (*get_blocks)(struct se_device *); | |
c66ac9db NB |
328 | /* |
329 | * get_sense_buffer(): | |
330 | */ | |
331 | unsigned char *(*get_sense_buffer)(struct se_task *); | |
332 | } ____cacheline_aligned; | |
333 | ||
c66ac9db | 334 | #endif /* TARGET_CORE_TRANSPORT_H */ |