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