tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 request_queue;
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
38 ssize_t (*set_configfs_dev_params)(struct se_device *,
39 const char *, ssize_t);
40 ssize_t (*show_configfs_dev_params)(struct se_device *, 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 struct configfs_attribute **tb_dev_action_attrs;
58};
59
60struct sbc_ops {
61 sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
62 u32, enum dma_data_direction);
63 sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
64 sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
65 sense_reason_t (*execute_unmap)(struct se_cmd *cmd,
66 sector_t lba, sector_t nolb);
67};
68
69int transport_backend_register(const struct target_backend_ops *);
70void target_backend_unregister(const struct target_backend_ops *);
71
72void target_complete_cmd(struct se_cmd *, u8);
73void target_complete_cmd_with_length(struct se_cmd *, u8, int);
74
75void transport_copy_sense_to_cmd(struct se_cmd *, unsigned char *);
76
77sense_reason_t spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
78sense_reason_t spc_emulate_report_luns(struct se_cmd *cmd);
79sense_reason_t spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
80sense_reason_t spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
81
82sense_reason_t sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
83u32 sbc_get_device_rev(struct se_device *dev);
84u32 sbc_get_device_type(struct se_device *dev);
85sector_t sbc_get_write_same_sectors(struct se_cmd *cmd);
86void sbc_dif_generate(struct se_cmd *);
87sense_reason_t sbc_dif_verify(struct se_cmd *, sector_t, unsigned int,
88 unsigned int, struct scatterlist *, int);
89void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool,
90 struct scatterlist *, int);
91void transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
92int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
93int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
94int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
95
96extern struct configfs_attribute *sbc_attrib_attrs[];
97extern struct configfs_attribute *passthrough_attrib_attrs[];
98extern struct configfs_attribute *passthrough_pr_attrib_attrs[];
99
100/* core helpers also used by command snooping in pscsi */
101void *transport_kmap_data_sg(struct se_cmd *);
102void transport_kunmap_data_sg(struct se_cmd *);
103/* core helpers also used by xcopy during internal command setup */
104sense_reason_t transport_generic_map_mem_to_cmd(struct se_cmd *,
105 struct scatterlist *, u32, struct scatterlist *, u32);
106
107bool target_lun_is_rdonly(struct se_cmd *);
108sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd,
109 sense_reason_t (*exec_cmd)(struct se_cmd *cmd));
110
111bool target_sense_desc_format(struct se_device *dev);
112sector_t target_to_linux_sector(struct se_device *dev, sector_t lb);
113bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib,
114 struct request_queue *q);
115
116static inline bool target_dev_configured(struct se_device *se_dev)
117{
118 return !!(se_dev->dev_flags & DF_CONFIGURED);
119}
120
121#endif /* TARGET_CORE_BACKEND_H */