1 #ifndef TARGET_CORE_TRANSPORT_H
2 #define TARGET_CORE_TRANSPORT_H
4 #define TARGET_CORE_VERSION TARGET_CORE_MOD_VERSION
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 */
11 #define PYX_TRANSPORT_STATUS_INTERVAL 5 /* In seconds */
13 #define TRANSPORT_PLUGIN_PHBA_PDEV 1
14 #define TRANSPORT_PLUGIN_VHBA_PDEV 2
15 #define TRANSPORT_PLUGIN_VHBA_VDEV 3
18 * struct se_subsystem_dev->su_dev_flags
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
26 * struct se_device->dev_flags
28 #define DF_READ_ONLY 0x00000001
29 #define DF_SPC2_RESERVATIONS 0x00000002
30 #define DF_SPC2_RESERVATIONS_WITH_ISID 0x00000004
32 /* struct se_dev_attrib sanity values */
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
56 * Emulation for Thin Provisioning WRITE_SAME w/ UNMAP=1 bit using
57 * block/blk-lib.c:blkdev_issue_discard()
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
68 /* By default don't report non-rotating (solid state) medium */
69 #define DA_IS_NONROT 0
70 /* Queue Algorithm Modifier default for restricted reordering in control mode page */
71 #define DA_EMULATE_REST_REORD 0
73 #define SE_MODE_PAGE_BUF 512
75 #define MOD_MAX_SECTORS(ms, bs) (ms % (PAGE_SIZE / bs))
77 struct se_subsystem_api
;
79 extern int transport_subsystem_register(struct se_subsystem_api
*);
80 extern void transport_subsystem_release(struct se_subsystem_api
*);
81 extern struct se_session
*transport_init_session(void);
82 extern void __transport_register_session(struct se_portal_group
*,
84 struct se_session
*, void *);
85 extern void transport_register_session(struct se_portal_group
*,
87 struct se_session
*, void *);
88 extern void transport_free_session(struct se_session
*);
89 extern void transport_deregister_session_configfs(struct se_session
*);
90 extern void transport_deregister_session(struct se_session
*);
91 extern void transport_complete_sync_cache(struct se_cmd
*, int);
92 extern void transport_complete_task(struct se_task
*, int);
94 extern void transport_set_vpd_proto_id(struct t10_vpd
*, unsigned char *);
95 extern int transport_set_vpd_assoc(struct t10_vpd
*, unsigned char *);
96 extern int transport_set_vpd_ident_type(struct t10_vpd
*, unsigned char *);
97 extern int transport_set_vpd_ident(struct t10_vpd
*, unsigned char *);
99 extern struct se_device
*transport_add_device_to_core_hba(struct se_hba
*,
100 struct se_subsystem_api
*,
101 struct se_subsystem_dev
*, u32
,
102 void *, struct se_dev_limits
*,
103 const char *, const char *);
104 extern void transport_init_se_cmd(struct se_cmd
*,
105 struct target_core_fabric_ops
*,
106 struct se_session
*, u32
, int, int,
108 void *transport_kmap_first_data_page(struct se_cmd
*cmd
);
109 void transport_kunmap_first_data_page(struct se_cmd
*cmd
);
110 extern int transport_generic_allocate_tasks(struct se_cmd
*, unsigned char *);
111 extern int transport_handle_cdb_direct(struct se_cmd
*);
112 extern int transport_generic_handle_cdb_map(struct se_cmd
*);
113 extern int transport_generic_handle_data(struct se_cmd
*);
114 extern int transport_generic_handle_tmr(struct se_cmd
*);
115 extern int transport_generic_map_mem_to_cmd(struct se_cmd
*cmd
, struct scatterlist
*, u32
,
116 struct scatterlist
*, u32
);
117 extern bool transport_wait_for_tasks(struct se_cmd
*);
118 extern int transport_check_aborted_status(struct se_cmd
*, int);
119 extern int transport_send_check_condition_and_sense(struct se_cmd
*, u8
, int);
120 extern void transport_generic_free_cmd(struct se_cmd
*, int);
121 extern void target_get_sess_cmd(struct se_session
*, struct se_cmd
*);
122 extern int target_put_sess_cmd(struct se_session
*, struct se_cmd
*);
123 extern void target_splice_sess_cmd_list(struct se_session
*);
124 extern void target_wait_for_sess_cmds(struct se_session
*, int);
125 extern void transport_do_task_sg_chain(struct se_cmd
*);
126 extern void transport_generic_process_write(struct se_cmd
*);
127 extern int transport_generic_new_cmd(struct se_cmd
*);
128 /* From target_core_alua.c */
129 extern int core_alua_check_nonop_delay(struct se_cmd
*);
130 /* From target_core_cdb.c */
131 extern void target_get_task_cdb(struct se_task
*task
, unsigned char *cdb
);
134 * Each se_transport_task_t can have N number of possible struct se_task's
135 * for the storage transport(s) to possibly execute.
136 * Used primarily for splitting up CDBs that exceed the physical storage
137 * HBA's maximum sector count per task.
140 struct page
*se_page
;
143 struct list_head se_list
;
144 } ____cacheline_aligned
;
147 * Each type of disk transport supported MUST have a template defined
148 * within its .h file.
150 struct se_subsystem_api
{
160 unsigned int fua_write_emulated
: 1;
161 unsigned int write_cache_emulated
: 1;
164 * struct module for struct se_hba references
166 struct module
*owner
;
168 * Used for global se_subsystem_api list_head
170 struct list_head sub_api_list
;
174 int (*attach_hba
)(struct se_hba
*, u32
);
178 void (*detach_hba
)(struct se_hba
*);
180 * pmode_hba(): Used for TCM/pSCSI subsystem plugin HBA ->
181 * Linux/SCSI struct Scsi_Host passthrough
183 int (*pmode_enable_hba
)(struct se_hba
*, unsigned long);
185 * allocate_virtdevice():
187 void *(*allocate_virtdevice
)(struct se_hba
*, const char *);
189 * create_virtdevice(): Only for Virtual HBAs
191 struct se_device
*(*create_virtdevice
)(struct se_hba
*,
192 struct se_subsystem_dev
*, void *);
196 void (*free_device
)(void *);
199 * transport_complete():
201 * Use transport_generic_complete() for majority of DAS transport
202 * drivers. Provided out of convenience.
204 int (*transport_complete
)(struct se_task
*task
);
205 struct se_task
*(*alloc_task
)(unsigned char *cdb
);
209 int (*do_task
)(struct se_task
*);
211 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
212 * UNMAP and WRITE_SAME_* w/ UNMAP=1 <-> Linux/Block Discard
214 int (*do_discard
)(struct se_device
*, sector_t
, u32
);
216 * Used by virtual subsystem plugins IBLOCK and FILEIO to emulate
217 * SYNCHRONIZE_CACHE_* <-> Linux/Block blkdev_issue_flush()
219 void (*do_sync_cache
)(struct se_task
*);
223 void (*free_task
)(struct se_task
*);
225 * check_configfs_dev_params():
227 ssize_t (*check_configfs_dev_params
)(struct se_hba
*, struct se_subsystem_dev
*);
229 * set_configfs_dev_params():
231 ssize_t (*set_configfs_dev_params
)(struct se_hba
*, struct se_subsystem_dev
*,
232 const char *, ssize_t
);
234 * show_configfs_dev_params():
236 ssize_t (*show_configfs_dev_params
)(struct se_hba
*, struct se_subsystem_dev
*,
241 u32 (*get_device_rev
)(struct se_device
*);
245 u32 (*get_device_type
)(struct se_device
*);
247 * Get the sector_t from a subsystem backstore..
249 sector_t (*get_blocks
)(struct se_device
*);
251 * get_sense_buffer():
253 unsigned char *(*get_sense_buffer
)(struct se_task
*);
254 } ____cacheline_aligned
;
256 #endif /* TARGET_CORE_TRANSPORT_H */