xref: /linux/include/target/target_core_backend.h (revision 905e46acd3272d04566fec49afbd7ad9e2ed9ae3)
1 #ifndef TARGET_CORE_BACKEND_H
2 #define TARGET_CORE_BACKEND_H
3 
4 #include <linux/types.h>
5 #include <target/target_core_base.h>
6 
7 #define TRANSPORT_FLAG_PASSTHROUGH		0x1
8 /*
9  * ALUA commands, state checks and setup operations are handled by the
10  * backend module.
11  */
12 #define TRANSPORT_FLAG_PASSTHROUGH_ALUA		0x2
13 #define TRANSPORT_FLAG_PASSTHROUGH_PGR          0x4
14 
15 struct request_queue;
16 struct scatterlist;
17 
18 struct target_backend_ops {
19 	char name[16];
20 	char inquiry_prod[16];
21 	char inquiry_rev[4];
22 	struct module *owner;
23 
24 	u8 transport_flags;
25 
26 	int (*attach_hba)(struct se_hba *, u32);
27 	void (*detach_hba)(struct se_hba *);
28 	int (*pmode_enable_hba)(struct se_hba *, unsigned long);
29 
30 	struct se_device *(*alloc_device)(struct se_hba *, const char *);
31 	int (*configure_device)(struct se_device *);
32 	void (*free_device)(struct se_device *device);
33 
34 	ssize_t (*set_configfs_dev_params)(struct se_device *,
35 					   const char *, ssize_t);
36 	ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
37 
38 	void (*transport_complete)(struct se_cmd *cmd,
39 				   struct scatterlist *,
40 				   unsigned char *);
41 
42 	sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
43 	u32 (*get_device_type)(struct se_device *);
44 	sector_t (*get_blocks)(struct se_device *);
45 	sector_t (*get_alignment_offset_lbas)(struct se_device *);
46 	/* lbppbe = logical blocks per physical block exponent. see SBC-3 */
47 	unsigned int (*get_lbppbe)(struct se_device *);
48 	unsigned int (*get_io_min)(struct se_device *);
49 	unsigned int (*get_io_opt)(struct se_device *);
50 	unsigned char *(*get_sense_buffer)(struct se_cmd *);
51 	bool (*get_write_cache)(struct se_device *);
52 	int (*init_prot)(struct se_device *);
53 	int (*format_prot)(struct se_device *);
54 	void (*free_prot)(struct se_device *);
55 
56 	struct configfs_attribute **tb_dev_attrib_attrs;
57 };
58 
59 struct sbc_ops {
60 	sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
61 				     u32, enum dma_data_direction);
62 	sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
63 	sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
64 	sense_reason_t (*execute_unmap)(struct se_cmd *cmd,
65 				sector_t lba, sector_t nolb);
66 };
67 
68 int	transport_backend_register(const struct target_backend_ops *);
69 void	target_backend_unregister(const struct target_backend_ops *);
70 
71 void	target_complete_cmd(struct se_cmd *, u8);
72 void	target_complete_cmd_with_length(struct se_cmd *, u8, int);
73 
74 sense_reason_t	spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
75 sense_reason_t	spc_emulate_report_luns(struct se_cmd *cmd);
76 sense_reason_t	spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
77 sense_reason_t	spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
78 
79 sense_reason_t	sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
80 u32	sbc_get_device_rev(struct se_device *dev);
81 u32	sbc_get_device_type(struct se_device *dev);
82 sector_t	sbc_get_write_same_sectors(struct se_cmd *cmd);
83 void	sbc_dif_generate(struct se_cmd *);
84 sense_reason_t	sbc_dif_verify(struct se_cmd *, sector_t, unsigned int,
85 				     unsigned int, struct scatterlist *, int);
86 void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool,
87 		       struct scatterlist *, int);
88 void	transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
89 int	transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
90 int	transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
91 int	transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
92 
93 extern struct configfs_attribute *sbc_attrib_attrs[];
94 extern struct configfs_attribute *passthrough_attrib_attrs[];
95 
96 /* core helpers also used by command snooping in pscsi */
97 void	*transport_kmap_data_sg(struct se_cmd *);
98 void	transport_kunmap_data_sg(struct se_cmd *);
99 /* core helpers also used by xcopy during internal command setup */
100 sense_reason_t	transport_generic_map_mem_to_cmd(struct se_cmd *,
101 		struct scatterlist *, u32, struct scatterlist *, u32);
102 
103 bool	target_lun_is_rdonly(struct se_cmd *);
104 sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd,
105 	sense_reason_t (*exec_cmd)(struct se_cmd *cmd));
106 
107 bool target_sense_desc_format(struct se_device *dev);
108 sector_t target_to_linux_sector(struct se_device *dev, sector_t lb);
109 bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib,
110 				       struct request_queue *q);
111 
112 #endif /* TARGET_CORE_BACKEND_H */
113