Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef TARGET_CORE_BACKEND_H
3#define TARGET_CORE_BACKEND_H
4
5#include <linux/types.h>
6#include <asm/unaligned.h>
7#include <target/target_core_base.h>
8
9#define TRANSPORT_FLAG_PASSTHROUGH 0x1
10/*
11 * ALUA commands, state checks and setup operations are handled by the
12 * backend module.
13 */
14#define TRANSPORT_FLAG_PASSTHROUGH_ALUA 0x2
15#define TRANSPORT_FLAG_PASSTHROUGH_PGR 0x4
16
17struct block_device;
18struct scatterlist;
19
20struct target_backend_ops {
21 char name[16];
22 char inquiry_prod[16];
23 char inquiry_rev[4];
24 struct module *owner;
25
26 u8 transport_flags_default;
27 u8 transport_flags_changeable;
28
29 int (*attach_hba)(struct se_hba *, u32);
30 void (*detach_hba)(struct se_hba *);
31 int (*pmode_enable_hba)(struct se_hba *, unsigned long);
32
33 struct se_device *(*alloc_device)(struct se_hba *, const char *);
34 int (*configure_device)(struct se_device *);
35 void (*destroy_device)(struct se_device *);
36 void (*free_device)(struct se_device *device);
37 struct se_dev_plug *(*plug_device)(struct se_device *se_dev);
38 void (*unplug_device)(struct se_dev_plug *se_plug);
39
40 bool (*configure_unmap)(struct se_device *se_dev);
41 ssize_t (*set_configfs_dev_params)(struct se_device *,
42 const char *, ssize_t);
43 ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
44
45 sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
46 void (*tmr_notify)(struct se_device *se_dev, enum tcm_tmreq_table,
47 struct list_head *aborted_cmds);
48 u32 (*get_device_type)(struct se_device *);
49 sector_t (*get_blocks)(struct se_device *);
50 sector_t (*get_alignment_offset_lbas)(struct se_device *);
51 /* lbppbe = logical blocks per physical block exponent. see SBC-3 */
52 unsigned int (*get_lbppbe)(struct se_device *);
53 unsigned int (*get_io_min)(struct se_device *);
54 unsigned int (*get_io_opt)(struct se_device *);
55 unsigned char *(*get_sense_buffer)(struct se_cmd *);
56 bool (*get_write_cache)(struct se_device *);
57 int (*init_prot)(struct se_device *);
58 int (*format_prot)(struct se_device *);
59 void (*free_prot)(struct se_device *);
60
61 struct configfs_attribute **tb_dev_attrib_attrs;
62 struct configfs_attribute **tb_dev_action_attrs;
63};
64
65struct sbc_ops {
66 sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
67 u32, enum dma_data_direction);
68 sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
69 sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
70 sense_reason_t (*execute_unmap)(struct se_cmd *cmd,
71 sector_t lba, sector_t nolb);
72};
73
74int transport_backend_register(const struct target_backend_ops *);
75void target_backend_unregister(const struct target_backend_ops *);
76
77void target_complete_cmd(struct se_cmd *, u8);
78void target_set_cmd_data_length(struct se_cmd *, int);
79void target_complete_cmd_with_sense(struct se_cmd *, u8, sense_reason_t);
80void target_complete_cmd_with_length(struct se_cmd *, u8, int);
81
82void transport_copy_sense_to_cmd(struct se_cmd *, unsigned char *);
83
84sense_reason_t spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
85sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd);
86sense_reason_t spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
87sense_reason_t spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
88
89sense_reason_t sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
90u32 sbc_get_device_rev(struct se_device *dev);
91u32 sbc_get_device_type(struct se_device *dev);
92sector_t sbc_get_write_same_sectors(struct se_cmd *cmd);
93void sbc_dif_generate(struct se_cmd *);
94sense_reason_t sbc_dif_verify(struct se_cmd *, sector_t, unsigned int,
95 unsigned int, struct scatterlist *, int);
96void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool,
97 struct scatterlist *, int);
98void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
99int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
100int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
101int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
102
103extern struct configfs_attribute *sbc_attrib_attrs[];
104extern struct configfs_attribute *passthrough_attrib_attrs[];
105extern struct configfs_attribute *passthrough_pr_attrib_attrs[];
106
107/* core helpers also used by command snooping in pscsi */
108void *transport_kmap_data_sg(struct se_cmd *);
109void transport_kunmap_data_sg(struct se_cmd *);
110/* core helpers also used by xcopy during internal command setup */
111sense_reason_t transport_generic_map_mem_to_cmd(struct se_cmd *,
112 struct scatterlist *, u32, struct scatterlist *, u32);
113
114bool target_lun_is_rdonly(struct se_cmd *);
115sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd,
116 sense_reason_t (*exec_cmd)(struct se_cmd *cmd));
117
118bool target_sense_desc_format(struct se_device *dev);
119sector_t target_to_linux_sector(struct se_device *dev, sector_t lb);
120bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib,
121 struct block_device *bdev);
122
123static inline bool target_dev_configured(struct se_device *se_dev)
124{
125 return !!(se_dev->dev_flags & DF_CONFIGURED);
126}
127
128#endif /* TARGET_CORE_BACKEND_H */
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
8struct se_subsystem_api {
9 struct list_head sub_api_list;
10
11 char name[16];
12 struct module *owner;
13
14 u8 transport_type;
15
16 unsigned int fua_write_emulated : 1;
17 unsigned int write_cache_emulated : 1;
18
19 int (*attach_hba)(struct se_hba *, u32);
20 void (*detach_hba)(struct se_hba *);
21 int (*pmode_enable_hba)(struct se_hba *, unsigned long);
22 void *(*allocate_virtdevice)(struct se_hba *, const char *);
23 struct se_device *(*create_virtdevice)(struct se_hba *,
24 struct se_subsystem_dev *, void *);
25 void (*free_device)(void *);
26 int (*transport_complete)(struct se_cmd *cmd, struct scatterlist *);
27 int (*execute_cmd)(struct se_cmd *, struct scatterlist *, u32,
28 enum dma_data_direction);
29 int (*do_discard)(struct se_device *, sector_t, u32);
30 void (*do_sync_cache)(struct se_cmd *);
31 ssize_t (*check_configfs_dev_params)(struct se_hba *,
32 struct se_subsystem_dev *);
33 ssize_t (*set_configfs_dev_params)(struct se_hba *,
34 struct se_subsystem_dev *, const char *, ssize_t);
35 ssize_t (*show_configfs_dev_params)(struct se_hba *,
36 struct se_subsystem_dev *, char *);
37 u32 (*get_device_rev)(struct se_device *);
38 u32 (*get_device_type)(struct se_device *);
39 sector_t (*get_blocks)(struct se_device *);
40 unsigned char *(*get_sense_buffer)(struct se_cmd *);
41};
42
43int transport_subsystem_register(struct se_subsystem_api *);
44void transport_subsystem_release(struct se_subsystem_api *);
45
46struct se_device *transport_add_device_to_core_hba(struct se_hba *,
47 struct se_subsystem_api *, struct se_subsystem_dev *, u32,
48 void *, struct se_dev_limits *, const char *, const char *);
49
50void target_complete_cmd(struct se_cmd *, u8);
51
52void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
53int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
54int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
55int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
56
57/* core helpers also used by command snooping in pscsi */
58void *transport_kmap_data_sg(struct se_cmd *);
59void transport_kunmap_data_sg(struct se_cmd *);
60
61void array_free(void *array, int n);
62
63#endif /* TARGET_CORE_BACKEND_H */