include/target/target_core_backend.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef TARGET_CORE_BACKEND_H
0003 #define TARGET_CORE_BACKEND_H
0004
0005 #include <linux/types.h>
0006 #include <asm/unaligned.h>
0007 #include <target/target_core_base.h>
0008
0009 #define TRANSPORT_FLAG_PASSTHROUGH      0x1
0010 /*
0011  * ALUA commands, state checks and setup operations are handled by the
0012  * backend module.
0013  */
0014 #define TRANSPORT_FLAG_PASSTHROUGH_ALUA     0x2
0015 #define TRANSPORT_FLAG_PASSTHROUGH_PGR          0x4
0016
0017 struct block_device;
0018 struct scatterlist;
0019
0020 struct target_backend_ops {
0021     char name[16];
0022     char inquiry_prod[16];
0023     char inquiry_rev[4];
0024     struct module *owner;
0025
0026     u8 transport_flags_default;
0027     u8 transport_flags_changeable;
0028
0029     int (*attach_hba)(struct se_hba *, u32);
0030     void (*detach_hba)(struct se_hba *);
0031     int (*pmode_enable_hba)(struct se_hba *, unsigned long);
0032
0033     struct se_device *(*alloc_device)(struct se_hba *, const char *);
0034     int (*configure_device)(struct se_device *);
0035     void (*destroy_device)(struct se_device *);
0036     void (*free_device)(struct se_device *device);
0037     struct se_dev_plug *(*plug_device)(struct se_device *se_dev);
0038     void (*unplug_device)(struct se_dev_plug *se_plug);
0039
0040     bool (*configure_unmap)(struct se_device *se_dev);
0041     ssize_t (*set_configfs_dev_params)(struct se_device *,
0042                        const char *, ssize_t);
0043     ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
0044
0045     sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
0046     void (*tmr_notify)(struct se_device *se_dev, enum tcm_tmreq_table,
0047                struct list_head *aborted_cmds);
0048     u32 (*get_device_type)(struct se_device *);
0049     sector_t (*get_blocks)(struct se_device *);
0050     sector_t (*get_alignment_offset_lbas)(struct se_device *);
0051     /* lbppbe = logical blocks per physical block exponent. see SBC-3 */
0052     unsigned int (*get_lbppbe)(struct se_device *);
0053     unsigned int (*get_io_min)(struct se_device *);
0054     unsigned int (*get_io_opt)(struct se_device *);
0055     unsigned char *(*get_sense_buffer)(struct se_cmd *);
0056     bool (*get_write_cache)(struct se_device *);
0057     int (*init_prot)(struct se_device *);
0058     int (*format_prot)(struct se_device *);
0059     void (*free_prot)(struct se_device *);
0060
0061     struct configfs_attribute **tb_dev_attrib_attrs;
0062     struct configfs_attribute **tb_dev_action_attrs;
0063 };
0064
0065 struct sbc_ops {
0066     sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
0067                      u32, enum dma_data_direction);
0068     sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
0069     sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
0070     sense_reason_t (*execute_unmap)(struct se_cmd *cmd,
0071                 sector_t lba, sector_t nolb);
0072 };
0073
0074 int transport_backend_register(const struct target_backend_ops *);
0075 void    target_backend_unregister(const struct target_backend_ops *);
0076
0077 void    target_complete_cmd(struct se_cmd *, u8);
0078 void    target_set_cmd_data_length(struct se_cmd *, int);
0079 void    target_complete_cmd_with_sense(struct se_cmd *, u8, sense_reason_t);
0080 void    target_complete_cmd_with_length(struct se_cmd *, u8, int);
0081
0082 void    transport_copy_sense_to_cmd(struct se_cmd *, unsigned char *);
0083
0084 sense_reason_t  spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
0085 sense_reason_t  spc_emulate_report_luns(struct se_cmd *cmd);
0086 sense_reason_t  spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
0087 sense_reason_t  spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
0088
0089 sense_reason_t  sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
0090 u32 sbc_get_device_rev(struct se_device *dev);
0091 u32 sbc_get_device_type(struct se_device *dev);
0092 sector_t    sbc_get_write_same_sectors(struct se_cmd *cmd);
0093 void    sbc_dif_generate(struct se_cmd *);
0094 sense_reason_t  sbc_dif_verify(struct se_cmd *, sector_t, unsigned int,
0095                      unsigned int, struct scatterlist *, int);
0096 void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool,
0097                struct scatterlist *, int);
0098 void    transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
0099 int transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
0100 int transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
0101 int transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
0102
0103 extern struct configfs_attribute *sbc_attrib_attrs[];
0104 extern struct configfs_attribute *passthrough_attrib_attrs[];
0105 extern struct configfs_attribute *passthrough_pr_attrib_attrs[];
0106
0107 /* core helpers also used by command snooping in pscsi */
0108 void    *transport_kmap_data_sg(struct se_cmd *);
0109 void    transport_kunmap_data_sg(struct se_cmd *);
0110 /* core helpers also used by xcopy during internal command setup */
0111 sense_reason_t  transport_generic_map_mem_to_cmd(struct se_cmd *,
0112         struct scatterlist *, u32, struct scatterlist *, u32);
0113
0114 bool    target_lun_is_rdonly(struct se_cmd *);
0115 sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd,
0116     sense_reason_t (*exec_cmd)(struct se_cmd *cmd));
0117
0118 bool target_sense_desc_format(struct se_device *dev);
0119 sector_t target_to_linux_sector(struct se_device *dev, sector_t lb);
0120 bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib,
0121                        struct block_device *bdev);
0122
0123 static inline bool target_dev_configured(struct se_device *se_dev)
0124 {
0125     return !!(se_dev->dev_flags & DF_CONFIGURED);
0126 }
0127
0128 #endif /* TARGET_CORE_BACKEND_H */