LXR linux/include/target/target_core

   1#ifndef TARGET_CORE_BACKEND_H
   2#define TARGET_CORE_BACKEND_H
   3
   4#include <linux/types.h>
   5#include <target/target_core_base.h>
   6
   7#define TRANSPORT_FLAG_PASSTHROUGH              0x1
   8/*
   9 * ALUA commands, state checks and setup operations are handled by the
  10 * backend module.
  11 */
  12#define TRANSPORT_FLAG_PASSTHROUGH_ALUA         0x2
  13
  14struct request_queue;
  15struct scatterlist;
  16
  17struct target_backend_ops {
  18        char name[16];
  19        char inquiry_prod[16];
  20        char inquiry_rev[4];
  21        struct module *owner;
  22
  23        u8 transport_flags;
  24
  25        int (*attach_hba)(struct se_hba *, u32);
  26        void (*detach_hba)(struct se_hba *);
  27        int (*pmode_enable_hba)(struct se_hba *, unsigned long);
  28
  29        struct se_device *(*alloc_device)(struct se_hba *, const char *);
  30        int (*configure_device)(struct se_device *);
  31        void (*free_device)(struct se_device *device);
  32
  33        ssize_t (*set_configfs_dev_params)(struct se_device *,
  34                                           const char *, ssize_t);
  35        ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
  36
  37        void (*transport_complete)(struct se_cmd *cmd,
  38                                   struct scatterlist *,
  39                                   unsigned char *);
  40
  41        sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
  42        u32 (*get_device_type)(struct se_device *);
  43        sector_t (*get_blocks)(struct se_device *);
  44        sector_t (*get_alignment_offset_lbas)(struct se_device *);
  45        /* lbppbe = logical blocks per physical block exponent. see SBC-3 */
  46        unsigned int (*get_lbppbe)(struct se_device *);
  47        unsigned int (*get_io_min)(struct se_device *);
  48        unsigned int (*get_io_opt)(struct se_device *);
  49        unsigned char *(*get_sense_buffer)(struct se_cmd *);
  50        bool (*get_write_cache)(struct se_device *);
  51        int (*init_prot)(struct se_device *);
  52        int (*format_prot)(struct se_device *);
  53        void (*free_prot)(struct se_device *);
  54
  55        struct configfs_attribute **tb_dev_attrib_attrs;
  56};
  57
  58struct sbc_ops {
  59        sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
  60                                     u32, enum dma_data_direction);
  61        sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
  62        sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
  63        sense_reason_t (*execute_unmap)(struct se_cmd *cmd,
  64                                sector_t lba, sector_t nolb);
  65};
  66
  67int     transport_backend_register(const struct target_backend_ops *);
  68void    target_backend_unregister(const struct target_backend_ops *);
  69
  70void    target_complete_cmd(struct se_cmd *, u8);
  71void    target_complete_cmd_with_length(struct se_cmd *, u8, int);
  72
  73sense_reason_t  spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
  74sense_reason_t  spc_emulate_report_luns(struct se_cmd *cmd);
  75sense_reason_t  spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
  76sense_reason_t  spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
  77
  78sense_reason_t  sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
  79u32     sbc_get_device_rev(struct se_device *dev);
  80u32     sbc_get_device_type(struct se_device *dev);
  81sector_t        sbc_get_write_same_sectors(struct se_cmd *cmd);
  82void    sbc_dif_generate(struct se_cmd *);
  83sense_reason_t  sbc_dif_verify(struct se_cmd *, sector_t, unsigned int,
  84                                     unsigned int, struct scatterlist *, int);
  85void sbc_dif_copy_prot(struct se_cmd *, unsigned int, bool,
  86                       struct scatterlist *, int);
  87void    transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
  88int     transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
  89int     transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
  90int     transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
  91
  92extern struct configfs_attribute *sbc_attrib_attrs[];
  93extern struct configfs_attribute *passthrough_attrib_attrs[];
  94
  95/* core helpers also used by command snooping in pscsi */
  96void    *transport_kmap_data_sg(struct se_cmd *);
  97void    transport_kunmap_data_sg(struct se_cmd *);
  98/* core helpers also used by xcopy during internal command setup */
  99sense_reason_t  transport_generic_map_mem_to_cmd(struct se_cmd *,
 100                struct scatterlist *, u32, struct scatterlist *, u32);
 101
 102bool    target_lun_is_rdonly(struct se_cmd *);
 103sense_reason_t passthrough_parse_cdb(struct se_cmd *cmd,
 104        sense_reason_t (*exec_cmd)(struct se_cmd *cmd));
 105
 106bool target_sense_desc_format(struct se_device *dev);
 107sector_t target_to_linux_sector(struct se_device *dev, sector_t lb);
 108bool target_configure_unmap_from_queue(struct se_dev_attrib *attrib,
 109                                       struct request_queue *q);
 110
 111#endif /* TARGET_CORE_BACKEND_H */
 112