Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
c4795fb2 CH |
2 | #ifndef TARGET_CORE_BACKEND_H |
3 | #define TARGET_CORE_BACKEND_H | |
4 | ||
8dcf07be | 5 | #include <linux/types.h> |
a85d667e | 6 | #include <asm/unaligned.h> |
8dcf07be BVA |
7 | #include <target/target_core_base.h> |
8 | ||
530c6891 MC |
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 | |
4ec5bf0e | 15 | #define TRANSPORT_FLAG_PASSTHROUGH_PGR 0x4 |
c4795fb2 | 16 | |
8dcf07be BVA |
17 | struct request_queue; |
18 | struct scatterlist; | |
19 | ||
0a06d430 | 20 | struct target_backend_ops { |
c4795fb2 | 21 | char name[16]; |
0fd97ccf CH |
22 | char inquiry_prod[16]; |
23 | char inquiry_rev[4]; | |
c4795fb2 CH |
24 | struct module *owner; |
25 | ||
69088a04 | 26 | u8 transport_flags_default; |
356ba2a8 | 27 | u8 transport_flags_changeable; |
c4795fb2 | 28 | |
c4795fb2 CH |
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); | |
0fd97ccf CH |
32 | |
33 | struct se_device *(*alloc_device)(struct se_hba *, const char *); | |
34 | int (*configure_device)(struct se_device *); | |
92634706 | 35 | void (*destroy_device)(struct se_device *); |
0fd97ccf | 36 | void (*free_device)(struct se_device *device); |
302990ac MC |
37 | struct se_dev_plug *(*plug_device)(struct se_device *se_dev); |
38 | void (*unplug_device)(struct se_dev_plug *se_plug); | |
0fd97ccf CH |
39 | |
40 | ssize_t (*set_configfs_dev_params)(struct se_device *, | |
41 | const char *, ssize_t); | |
42 | ssize_t (*show_configfs_dev_params)(struct se_device *, char *); | |
43 | ||
de103c93 | 44 | sense_reason_t (*parse_cdb)(struct se_cmd *cmd); |
2e45a1a9 BS |
45 | void (*tmr_notify)(struct se_device *se_dev, enum tcm_tmreq_table, |
46 | struct list_head *aborted_cmds); | |
c4795fb2 CH |
47 | u32 (*get_device_type)(struct se_device *); |
48 | sector_t (*get_blocks)(struct se_device *); | |
7f7caf6a AG |
49 | sector_t (*get_alignment_offset_lbas)(struct se_device *); |
50 | /* lbppbe = logical blocks per physical block exponent. see SBC-3 */ | |
51 | unsigned int (*get_lbppbe)(struct se_device *); | |
52 | unsigned int (*get_io_min)(struct se_device *); | |
53 | unsigned int (*get_io_opt)(struct se_device *); | |
5787cacd | 54 | unsigned char *(*get_sense_buffer)(struct se_cmd *); |
d0c8b259 | 55 | bool (*get_write_cache)(struct se_device *); |
ce65e5b9 NB |
56 | int (*init_prot)(struct se_device *); |
57 | int (*format_prot)(struct se_device *); | |
58 | void (*free_prot)(struct se_device *); | |
73112edc | 59 | |
0a06d430 | 60 | struct configfs_attribute **tb_dev_attrib_attrs; |
8dc31ff9 | 61 | struct configfs_attribute **tb_dev_action_attrs; |
c4795fb2 CH |
62 | }; |
63 | ||
9e999a6c | 64 | struct sbc_ops { |
a82a9538 NB |
65 | sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *, |
66 | u32, enum dma_data_direction); | |
de103c93 CH |
67 | sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd); |
68 | sense_reason_t (*execute_write_same)(struct se_cmd *cmd); | |
62e46942 CH |
69 | sense_reason_t (*execute_unmap)(struct se_cmd *cmd, |
70 | sector_t lba, sector_t nolb); | |
0c2ad7d1 CH |
71 | }; |
72 | ||
0a06d430 CH |
73 | int transport_backend_register(const struct target_backend_ops *); |
74 | void target_backend_unregister(const struct target_backend_ops *); | |
c4795fb2 | 75 | |
6bb35e00 | 76 | void target_complete_cmd(struct se_cmd *, u8); |
1c73e0c5 | 77 | void target_set_cmd_data_length(struct se_cmd *, int); |
44678553 | 78 | void target_complete_cmd_with_sense(struct se_cmd *, u8, sense_reason_t); |
2426bd45 | 79 | void target_complete_cmd_with_length(struct se_cmd *, u8, int); |
c4795fb2 | 80 | |
c6d66aba MC |
81 | void transport_copy_sense_to_cmd(struct se_cmd *, unsigned char *); |
82 | ||
de103c93 CH |
83 | sense_reason_t spc_parse_cdb(struct se_cmd *cmd, unsigned int *size); |
84 | sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd); | |
0dfa1c5d HR |
85 | sense_reason_t spc_emulate_inquiry_std(struct se_cmd *, unsigned char *); |
86 | sense_reason_t spc_emulate_evpd_83(struct se_cmd *, unsigned char *); | |
d6e0175c | 87 | |
de103c93 | 88 | sense_reason_t sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops); |
6f23ac8a CH |
89 | u32 sbc_get_device_rev(struct se_device *dev); |
90 | u32 sbc_get_device_type(struct se_device *dev); | |
972b29c8 | 91 | sector_t sbc_get_write_same_sectors(struct se_cmd *cmd); |
66a3d5bc | 92 | void sbc_dif_generate(struct se_cmd *); |
f75b6fae | 93 | sense_reason_t sbc_dif_verify(struct se_cmd *, sector_t, unsigned int, |
41861fa8 | 94 | unsigned int, struct scatterlist *, int); |
f75b6fae SG |
95 | void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool, |
96 | struct scatterlist *, int); | |
c4795fb2 CH |
97 | void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *); |
98 | int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *); | |
99 | int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *); | |
100 | int transport_set_vpd_ident(struct t10_vpd *, unsigned char *); | |
101 | ||
5873c4d1 CH |
102 | extern struct configfs_attribute *sbc_attrib_attrs[]; |
103 | extern struct configfs_attribute *passthrough_attrib_attrs[]; | |
4703b625 | 104 | extern struct configfs_attribute *passthrough_pr_attrib_attrs[]; |
5873c4d1 | 105 | |
c4795fb2 | 106 | /* core helpers also used by command snooping in pscsi */ |
4949314c AG |
107 | void *transport_kmap_data_sg(struct se_cmd *); |
108 | void transport_kunmap_data_sg(struct se_cmd *); | |
c5ff8d6b | 109 | /* core helpers also used by xcopy during internal command setup */ |
c5ff8d6b NB |
110 | sense_reason_t transport_generic_map_mem_to_cmd(struct se_cmd *, |
111 | struct scatterlist *, u32, struct scatterlist *, u32); | |
c4795fb2 | 112 | |
29a05dee | 113 | bool target_lun_is_rdonly(struct se_cmd *); |
7bfea53b AG |
114 | sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd, |
115 | sense_reason_t (*exec_cmd)(struct se_cmd *cmd)); | |
d30cd123 | 116 | |
4e4937e8 | 117 | bool target_sense_desc_format(struct se_device *dev); |
8a9ebe71 MC |
118 | sector_t target_to_linux_sector(struct se_device *dev, sector_t lb); |
119 | bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib, | |
ea263c7f | 120 | struct request_queue *q); |
4e4937e8 | 121 | |
cb0f32e1 MC |
122 | static inline bool target_dev_configured(struct se_device *se_dev) |
123 | { | |
124 | return !!(se_dev->dev_flags & DF_CONFIGURED); | |
125 | } | |
a85d667e | 126 | |
c4795fb2 | 127 | #endif /* TARGET_CORE_BACKEND_H */ |