xref: /linux/include/target/target_core_backend.h (revision c4ee0af3fa0dc65f690fc908f02b8355f9576ea0)
1 #ifndef TARGET_CORE_BACKEND_H
2 #define TARGET_CORE_BACKEND_H
3 
4 #define TRANSPORT_PLUGIN_PHBA_PDEV		1
5 #define TRANSPORT_PLUGIN_VHBA_PDEV		2
6 #define TRANSPORT_PLUGIN_VHBA_VDEV		3
7 
8 struct se_subsystem_api {
9 	struct list_head sub_api_list;
10 
11 	char name[16];
12 	char inquiry_prod[16];
13 	char inquiry_rev[4];
14 	struct module *owner;
15 
16 	u8 transport_type;
17 
18 	int (*attach_hba)(struct se_hba *, u32);
19 	void (*detach_hba)(struct se_hba *);
20 	int (*pmode_enable_hba)(struct se_hba *, unsigned long);
21 
22 	struct se_device *(*alloc_device)(struct se_hba *, const char *);
23 	int (*configure_device)(struct se_device *);
24 	void (*free_device)(struct se_device *device);
25 
26 	ssize_t (*set_configfs_dev_params)(struct se_device *,
27 					   const char *, ssize_t);
28 	ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
29 
30 	void (*transport_complete)(struct se_cmd *cmd,
31 				   struct scatterlist *,
32 				   unsigned char *);
33 
34 	sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
35 	u32 (*get_device_type)(struct se_device *);
36 	sector_t (*get_blocks)(struct se_device *);
37 	sector_t (*get_alignment_offset_lbas)(struct se_device *);
38 	/* lbppbe = logical blocks per physical block exponent. see SBC-3 */
39 	unsigned int (*get_lbppbe)(struct se_device *);
40 	unsigned int (*get_io_min)(struct se_device *);
41 	unsigned int (*get_io_opt)(struct se_device *);
42 	unsigned char *(*get_sense_buffer)(struct se_cmd *);
43 	bool (*get_write_cache)(struct se_device *);
44 };
45 
46 struct sbc_ops {
47 	sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
48 				     u32, enum dma_data_direction);
49 	sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
50 	sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
51 	sense_reason_t (*execute_write_same_unmap)(struct se_cmd *cmd);
52 	sense_reason_t (*execute_unmap)(struct se_cmd *cmd);
53 };
54 
55 int	transport_subsystem_register(struct se_subsystem_api *);
56 void	transport_subsystem_release(struct se_subsystem_api *);
57 
58 void	target_complete_cmd(struct se_cmd *, u8);
59 
60 sense_reason_t	spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
61 sense_reason_t	spc_emulate_report_luns(struct se_cmd *cmd);
62 sense_reason_t	spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
63 sense_reason_t	spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
64 
65 sense_reason_t	sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
66 u32	sbc_get_device_rev(struct se_device *dev);
67 u32	sbc_get_device_type(struct se_device *dev);
68 sector_t	sbc_get_write_same_sectors(struct se_cmd *cmd);
69 sense_reason_t sbc_execute_unmap(struct se_cmd *cmd,
70 	sense_reason_t (*do_unmap_fn)(struct se_cmd *cmd, void *priv,
71 				      sector_t lba, sector_t nolb),
72 	void *priv);
73 
74 void	transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
75 int	transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
76 int	transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
77 int	transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
78 
79 /* core helpers also used by command snooping in pscsi */
80 void	*transport_kmap_data_sg(struct se_cmd *);
81 void	transport_kunmap_data_sg(struct se_cmd *);
82 /* core helpers also used by xcopy during internal command setup */
83 int	target_alloc_sgl(struct scatterlist **, unsigned int *, u32, bool);
84 sense_reason_t	transport_generic_map_mem_to_cmd(struct se_cmd *,
85 		struct scatterlist *, u32, struct scatterlist *, u32);
86 
87 void	array_free(void *array, int n);
88 
89 #endif /* TARGET_CORE_BACKEND_H */
90