blob: 514b520193808e5a3015f010a72f51a343618fb6 [file] [log] [blame]
Christoph Hellwigc4795fb2011-11-16 09:46:48 -05001#ifndef TARGET_CORE_BACKEND_H
2#define TARGET_CORE_BACKEND_H
3
Andy Grovera3541702015-05-19 14:44:41 -07004#define TRANSPORT_FLAG_PASSTHROUGH 1
Christoph Hellwigc4795fb2011-11-16 09:46:48 -05005
Christoph Hellwig0a06d432015-05-10 18:14:56 +02006struct target_backend_ops {
Christoph Hellwigc4795fb2011-11-16 09:46:48 -05007 char name[16];
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -04008 char inquiry_prod[16];
9 char inquiry_rev[4];
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050010 struct module *owner;
11
Andy Grovera3541702015-05-19 14:44:41 -070012 u8 transport_flags;
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050013
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050014 int (*attach_hba)(struct se_hba *, u32);
15 void (*detach_hba)(struct se_hba *);
16 int (*pmode_enable_hba)(struct se_hba *, unsigned long);
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040017
18 struct se_device *(*alloc_device)(struct se_hba *, const char *);
19 int (*configure_device)(struct se_device *);
20 void (*free_device)(struct se_device *device);
21
22 ssize_t (*set_configfs_dev_params)(struct se_device *,
23 const char *, ssize_t);
24 ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
25
Paolo Bonzinid5829ea2012-09-05 17:09:15 +020026 void (*transport_complete)(struct se_cmd *cmd,
27 struct scatterlist *,
28 unsigned char *);
Christoph Hellwigd6e01752012-05-20 11:59:14 -040029
Christoph Hellwigde103c92012-11-06 12:24:09 -080030 sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050031 u32 (*get_device_type)(struct se_device *);
32 sector_t (*get_blocks)(struct se_device *);
Andy Grover7f7caf62013-11-11 08:59:17 -080033 sector_t (*get_alignment_offset_lbas)(struct se_device *);
34 /* lbppbe = logical blocks per physical block exponent. see SBC-3 */
35 unsigned int (*get_lbppbe)(struct se_device *);
36 unsigned int (*get_io_min)(struct se_device *);
37 unsigned int (*get_io_opt)(struct se_device *);
Christoph Hellwig5787cac2012-04-24 00:25:06 -040038 unsigned char *(*get_sense_buffer)(struct se_cmd *);
Nicholas Bellingerd0c8b252013-01-29 22:10:06 -080039 bool (*get_write_cache)(struct se_device *);
Nicholas Bellingerce65e5b2013-12-23 20:28:13 +000040 int (*init_prot)(struct se_device *);
41 int (*format_prot)(struct se_device *);
42 void (*free_prot)(struct se_device *);
Nicholas Bellinger73112ed2014-11-27 13:59:20 -080043
Christoph Hellwig0a06d432015-05-10 18:14:56 +020044 struct configfs_attribute **tb_dev_attrib_attrs;
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050045};
46
Christoph Hellwig9e999a62012-10-07 10:55:50 -040047struct sbc_ops {
Nicholas Bellingera82a9532013-08-19 23:57:30 -070048 sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
49 u32, enum dma_data_direction);
Christoph Hellwigde103c92012-11-06 12:24:09 -080050 sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
51 sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
Nicholas Bellingercd063be2012-11-07 20:01:10 -080052 sense_reason_t (*execute_write_same_unmap)(struct se_cmd *cmd);
Christoph Hellwigde103c92012-11-06 12:24:09 -080053 sense_reason_t (*execute_unmap)(struct se_cmd *cmd);
Christoph Hellwig0c2ad7d2012-06-17 18:40:52 -040054};
55
Christoph Hellwig0a06d432015-05-10 18:14:56 +020056int transport_backend_register(const struct target_backend_ops *);
57void target_backend_unregister(const struct target_backend_ops *);
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050058
Christoph Hellwig6bb35e02012-04-23 11:35:33 -040059void target_complete_cmd(struct se_cmd *, u8);
Roland Dreier2426bd42014-06-10 11:07:47 -070060void target_complete_cmd_with_length(struct se_cmd *, u8, int);
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050061
Christoph Hellwigde103c92012-11-06 12:24:09 -080062sense_reason_t spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
63sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd);
Hannes Reinecke0dfa1c52012-12-17 09:53:35 +010064sense_reason_t spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
65sense_reason_t spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
Christoph Hellwigd6e01752012-05-20 11:59:14 -040066
Christoph Hellwigde103c92012-11-06 12:24:09 -080067sense_reason_t sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
Christoph Hellwig6f23ac82012-10-07 10:55:53 -040068u32 sbc_get_device_rev(struct se_device *dev);
69u32 sbc_get_device_type(struct se_device *dev);
Roland Dreier972b29c82013-02-22 09:52:57 -080070sector_t sbc_get_write_same_sectors(struct se_cmd *cmd);
Asias He86d71822013-02-25 14:03:46 +080071sense_reason_t sbc_execute_unmap(struct se_cmd *cmd,
72 sense_reason_t (*do_unmap_fn)(struct se_cmd *cmd, void *priv,
73 sector_t lba, sector_t nolb),
74 void *priv);
Nicholas Bellinger66a3d5b2014-04-02 14:19:09 -070075void sbc_dif_generate(struct se_cmd *);
Sagi Grimbergf75b6fa2015-04-19 20:27:19 +030076sense_reason_t sbc_dif_verify(struct se_cmd *, sector_t, unsigned int,
Nicholas Bellinger41861fa2014-01-07 22:44:57 +000077 unsigned int, struct scatterlist *, int);
Sagi Grimbergf75b6fa2015-04-19 20:27:19 +030078void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool,
79 struct scatterlist *, int);
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050080void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
81int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
82int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
83int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
84
85/* core helpers also used by command snooping in pscsi */
Andy Grover49493142012-01-16 16:57:08 -080086void *transport_kmap_data_sg(struct se_cmd *);
87void transport_kunmap_data_sg(struct se_cmd *);
Nicholas Bellingerc5ff8d62013-08-22 11:58:43 -070088/* core helpers also used by xcopy during internal command setup */
89int target_alloc_sgl(struct scatterlist **, unsigned int *, u32, bool);
90sense_reason_t transport_generic_map_mem_to_cmd(struct se_cmd *,
91 struct scatterlist *, u32, struct scatterlist *, u32);
Christoph Hellwigc4795fb2011-11-16 09:46:48 -050092
Nicholas Bellinger29a05de2015-03-22 20:42:19 -070093bool target_lun_is_rdonly(struct se_cmd *);
Jörn Engel4a5a75f2012-03-15 15:05:12 -040094
Nicholas Bellingerd30cd122014-11-27 19:15:48 -080095/* attribute helpers from target_core_device.c for backend drivers */
Christophe Vu-Brugier9bc65482015-03-19 14:30:13 +010096bool se_dev_check_wce(struct se_device *);
Nicholas Bellingerd30cd122014-11-27 19:15:48 -080097int se_dev_set_max_unmap_lba_count(struct se_device *, u32);
98int se_dev_set_max_unmap_block_desc_count(struct se_device *, u32);
99int se_dev_set_unmap_granularity(struct se_device *, u32);
100int se_dev_set_unmap_granularity_alignment(struct se_device *, u32);
101int se_dev_set_max_write_same_len(struct se_device *, u32);
102int se_dev_set_emulate_model_alias(struct se_device *, int);
103int se_dev_set_emulate_dpo(struct se_device *, int);
104int se_dev_set_emulate_fua_write(struct se_device *, int);
105int se_dev_set_emulate_fua_read(struct se_device *, int);
106int se_dev_set_emulate_write_cache(struct se_device *, int);
107int se_dev_set_emulate_ua_intlck_ctrl(struct se_device *, int);
108int se_dev_set_emulate_tas(struct se_device *, int);
109int se_dev_set_emulate_tpu(struct se_device *, int);
110int se_dev_set_emulate_tpws(struct se_device *, int);
111int se_dev_set_emulate_caw(struct se_device *, int);
112int se_dev_set_emulate_3pc(struct se_device *, int);
113int se_dev_set_pi_prot_type(struct se_device *, int);
114int se_dev_set_pi_prot_format(struct se_device *, int);
115int se_dev_set_enforce_pr_isids(struct se_device *, int);
116int se_dev_set_force_pr_aptpl(struct se_device *, int);
117int se_dev_set_is_nonrot(struct se_device *, int);
118int se_dev_set_emulate_rest_reord(struct se_device *dev, int);
119int se_dev_set_queue_depth(struct se_device *, u32);
120int se_dev_set_max_sectors(struct se_device *, u32);
Nicholas Bellingerd30cd122014-11-27 19:15:48 -0800121int se_dev_set_optimal_sectors(struct se_device *, u32);
122int se_dev_set_block_size(struct se_device *, u32);
Andy Grover7bfea53b2015-05-19 14:44:40 -0700123sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd,
124 sense_reason_t (*exec_cmd)(struct se_cmd *cmd));
Nicholas Bellingerd30cd122014-11-27 19:15:48 -0800125
Christoph Hellwigc4795fb2011-11-16 09:46:48 -0500126#endif /* TARGET_CORE_BACKEND_H */