include/target/target_core_backend.h

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