Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / c4795fb20edf2fe2c862c8fe9f8b681edeb79ac1 / . / include / target / target_core_fabric.h
blob: d035d865dbefe4a24fbca6d7e6325a75d61ad893 [file] [log] [blame]
Christoph Hellwigc4795fb2011-11-16 09:46:48 -0500[diff] [blame^]1#ifndef TARGET_CORE_FABRIC_H
2#define TARGET_CORE_FABRIC_H
3
4struct target_core_fabric_ops {
5 struct configfs_subsystem *tf_subsys;
6 /*
7 * Optional to signal struct se_task->task_sg[] padding entries
8 * for scatterlist chaining using transport_do_task_sg_link(),
9 * disabled by default
10 */
11 bool task_sg_chaining;
12 char *(*get_fabric_name)(void);
13 u8 (*get_fabric_proto_ident)(struct se_portal_group *);
14 char *(*tpg_get_wwn)(struct se_portal_group *);
15 u16 (*tpg_get_tag)(struct se_portal_group *);
16 u32 (*tpg_get_default_depth)(struct se_portal_group *);
17 u32 (*tpg_get_pr_transport_id)(struct se_portal_group *,
18 struct se_node_acl *,
19 struct t10_pr_registration *, int *,
20 unsigned char *);
21 u32 (*tpg_get_pr_transport_id_len)(struct se_portal_group *,
22 struct se_node_acl *,
23 struct t10_pr_registration *, int *);
24 char *(*tpg_parse_pr_out_transport_id)(struct se_portal_group *,
25 const char *, u32 *, char **);
26 int (*tpg_check_demo_mode)(struct se_portal_group *);
27 int (*tpg_check_demo_mode_cache)(struct se_portal_group *);
28 int (*tpg_check_demo_mode_write_protect)(struct se_portal_group *);
29 int (*tpg_check_prod_mode_write_protect)(struct se_portal_group *);
30 /*
31 * Optionally used by fabrics to allow demo-mode login, but not
32 * expose any TPG LUNs, and return 'not connected' in standard
33 * inquiry response
34 */
35 int (*tpg_check_demo_mode_login_only)(struct se_portal_group *);
36 struct se_node_acl *(*tpg_alloc_fabric_acl)(
37 struct se_portal_group *);
38 void (*tpg_release_fabric_acl)(struct se_portal_group *,
39 struct se_node_acl *);
40 u32 (*tpg_get_inst_index)(struct se_portal_group *);
41 /*
42 * Optional function pointer for TCM to perform command map
43 * from TCM processing thread context, for those struct se_cmd
44 * initially allocated in interrupt context.
45 */
46 int (*new_cmd_map)(struct se_cmd *);
47 /*
48 * Optional to release struct se_cmd and fabric dependent allocated
49 * I/O descriptor in transport_cmd_check_stop().
50 *
51 * Returning 1 will signal a descriptor has been released.
52 * Returning 0 will signal a descriptor has not been released.
53 */
54 int (*check_stop_free)(struct se_cmd *);
55 /*
56 * Optional check for active I/O shutdown
57 */
58 int (*check_release_cmd)(struct se_cmd *);
59 void (*release_cmd)(struct se_cmd *);
60 /*
61 * Called with spin_lock_bh(struct se_portal_group->session_lock held.
62 */
63 int (*shutdown_session)(struct se_session *);
64 void (*close_session)(struct se_session *);
65 void (*stop_session)(struct se_session *, int, int);
66 void (*fall_back_to_erl0)(struct se_session *);
67 int (*sess_logged_in)(struct se_session *);
68 u32 (*sess_get_index)(struct se_session *);
69 /*
70 * Used only for SCSI fabrics that contain multi-value TransportIDs
71 * (like iSCSI). All other SCSI fabrics should set this to NULL.
72 */
73 u32 (*sess_get_initiator_sid)(struct se_session *,
74 unsigned char *, u32);
75 int (*write_pending)(struct se_cmd *);
76 int (*write_pending_status)(struct se_cmd *);
77 void (*set_default_node_attributes)(struct se_node_acl *);
78 u32 (*get_task_tag)(struct se_cmd *);
79 int (*get_cmd_state)(struct se_cmd *);
80 int (*queue_data_in)(struct se_cmd *);
81 int (*queue_status)(struct se_cmd *);
82 int (*queue_tm_rsp)(struct se_cmd *);
83 u16 (*set_fabric_sense_len)(struct se_cmd *, u32);
84 u16 (*get_fabric_sense_len)(void);
85 int (*is_state_remove)(struct se_cmd *);
86 /*
87 * fabric module calls for target_core_fabric_configfs.c
88 */
89 struct se_wwn *(*fabric_make_wwn)(struct target_fabric_configfs *,
90 struct config_group *, const char *);
91 void (*fabric_drop_wwn)(struct se_wwn *);
92 struct se_portal_group *(*fabric_make_tpg)(struct se_wwn *,
93 struct config_group *, const char *);
94 void (*fabric_drop_tpg)(struct se_portal_group *);
95 int (*fabric_post_link)(struct se_portal_group *,
96 struct se_lun *);
97 void (*fabric_pre_unlink)(struct se_portal_group *,
98 struct se_lun *);
99 struct se_tpg_np *(*fabric_make_np)(struct se_portal_group *,
100 struct config_group *, const char *);
101 void (*fabric_drop_np)(struct se_tpg_np *);
102 struct se_node_acl *(*fabric_make_nodeacl)(struct se_portal_group *,
103 struct config_group *, const char *);
104 void (*fabric_drop_nodeacl)(struct se_node_acl *);
105};
106
107struct se_session *transport_init_session(void);
108void __transport_register_session(struct se_portal_group *,
109 struct se_node_acl *, struct se_session *, void *);
110void transport_register_session(struct se_portal_group *,
111 struct se_node_acl *, struct se_session *, void *);
112void transport_free_session(struct se_session *);
113void transport_deregister_session_configfs(struct se_session *);
114void transport_deregister_session(struct se_session *);
115
116
117void transport_init_se_cmd(struct se_cmd *, struct target_core_fabric_ops *,
118 struct se_session *, u32, int, int, unsigned char *);
119int transport_lookup_cmd_lun(struct se_cmd *, u32);
120int transport_generic_allocate_tasks(struct se_cmd *, unsigned char *);
121int transport_handle_cdb_direct(struct se_cmd *);
122int transport_generic_handle_cdb_map(struct se_cmd *);
123int transport_generic_handle_data(struct se_cmd *);
124int transport_generic_map_mem_to_cmd(struct se_cmd *cmd,
125 struct scatterlist *, u32, struct scatterlist *, u32);
126void transport_do_task_sg_chain(struct se_cmd *);
127int transport_generic_new_cmd(struct se_cmd *);
128
129void transport_generic_process_write(struct se_cmd *);
130
131void transport_generic_free_cmd(struct se_cmd *, int);
132
133bool transport_wait_for_tasks(struct se_cmd *);
134int transport_check_aborted_status(struct se_cmd *, int);
135int transport_send_check_condition_and_sense(struct se_cmd *, u8, int);
136
137void target_get_sess_cmd(struct se_session *, struct se_cmd *);
138int target_put_sess_cmd(struct se_session *, struct se_cmd *);
139void target_splice_sess_cmd_list(struct se_session *);
140void target_wait_for_sess_cmds(struct se_session *, int);
141
142int core_alua_check_nonop_delay(struct se_cmd *);
143
144struct se_tmr_req *core_tmr_alloc_req(struct se_cmd *, void *, u8, gfp_t);
145void core_tmr_release_req(struct se_tmr_req *);
146int transport_generic_handle_tmr(struct se_cmd *);
147int transport_lookup_tmr_lun(struct se_cmd *, u32);
148
149struct se_node_acl *core_tpg_check_initiator_node_acl(struct se_portal_group *,
150 unsigned char *);
151void core_tpg_clear_object_luns(struct se_portal_group *);
152struct se_node_acl *core_tpg_add_initiator_node_acl(struct se_portal_group *,
153 struct se_node_acl *, const char *, u32);
154int core_tpg_del_initiator_node_acl(struct se_portal_group *,
155 struct se_node_acl *, int);
156int core_tpg_set_initiator_node_queue_depth(struct se_portal_group *,
157 unsigned char *, u32, int);
158int core_tpg_register(struct target_core_fabric_ops *, struct se_wwn *,
159 struct se_portal_group *, void *, int);
160int core_tpg_deregister(struct se_portal_group *);
161
162/* SAS helpers */
163u8 sas_get_fabric_proto_ident(struct se_portal_group *);
164u32 sas_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
165 struct t10_pr_registration *, int *, unsigned char *);
166u32 sas_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
167 struct t10_pr_registration *, int *);
168char *sas_parse_pr_out_transport_id(struct se_portal_group *, const char *,
169 u32 *, char **);
170
171/* FC helpers */
172u8 fc_get_fabric_proto_ident(struct se_portal_group *);
173u32 fc_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
174 struct t10_pr_registration *, int *, unsigned char *);
175u32 fc_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
176 struct t10_pr_registration *, int *);
177char *fc_parse_pr_out_transport_id(struct se_portal_group *, const char *,
178 u32 *, char **);
179
180/* iSCSI helpers */
181u8 iscsi_get_fabric_proto_ident(struct se_portal_group *);
182u32 iscsi_get_pr_transport_id(struct se_portal_group *, struct se_node_acl *,
183 struct t10_pr_registration *, int *, unsigned char *);
184u32 iscsi_get_pr_transport_id_len(struct se_portal_group *, struct se_node_acl *,
185 struct t10_pr_registration *, int *);
186char *iscsi_parse_pr_out_transport_id(struct se_portal_group *, const char *,
187 u32 *, char **);
188
189#endif /* TARGET_CORE_FABRICH */