include/target/target_core_backend.h

   1 #ifndef TARGET_CORE_BACKEND_H
   2 #define TARGET_CORE_BACKEND_H
   3
   4 #define TRANSPORT_PLUGIN_PHBA_PDEV              1
   5 #define TRANSPORT_PLUGIN_VHBA_PDEV              2
   6 #define TRANSPORT_PLUGIN_VHBA_VDEV              3
   7
   8 struct target_backend_cits {
   9         struct config_item_type tb_dev_cit;
  10         struct config_item_type tb_dev_attrib_cit;
  11         struct config_item_type tb_dev_pr_cit;
  12         struct config_item_type tb_dev_wwn_cit;
  13         struct config_item_type tb_dev_alua_tg_pt_gps_cit;
  14 };
  15
  16 struct se_subsystem_api {
  17         struct list_head sub_api_list;
  18
  19         char name[16];
  20         char inquiry_prod[16];
  21         char inquiry_rev[4];
  22         struct module *owner;
  23
  24         u8 transport_type;
  25
  26         int (*attach_hba)(struct se_hba *, u32);
  27         void (*detach_hba)(struct se_hba *);
  28         int (*pmode_enable_hba)(struct se_hba *, unsigned long);
  29
  30         struct se_device *(*alloc_device)(struct se_hba *, const char *);
  31         int (*configure_device)(struct se_device *);
  32         void (*free_device)(struct se_device *device);
  33
  34         ssize_t (*set_configfs_dev_params)(struct se_device *,
  35                                            const char *, ssize_t);
  36         ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
  37
  38         void (*transport_complete)(struct se_cmd *cmd,
  39                                    struct scatterlist *,
  40                                    unsigned 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 target_backend_cits tb_cits;
  57 };
  58
  59 struct sbc_ops {
  60         sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
  61                                      u32, enum dma_data_direction);
  62         sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
  63         sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
  64         sense_reason_t (*execute_write_same_unmap)(struct se_cmd *cmd);
  65         sense_reason_t (*execute_unmap)(struct se_cmd *cmd);
  66 };
  67
  68 int     transport_subsystem_register(struct se_subsystem_api *);
  69 void    transport_subsystem_release(struct se_subsystem_api *);
  70
  71 void    target_complete_cmd(struct se_cmd *, u8);
  72 void    target_complete_cmd_with_length(struct se_cmd *, u8, int);
  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 sense_reason_t sbc_execute_unmap(struct se_cmd *cmd,
  84         sense_reason_t (*do_unmap_fn)(struct se_cmd *cmd, void *priv,
  85                                       sector_t lba, sector_t nolb),
  86         void *priv);
  87 void    sbc_dif_generate(struct se_cmd *);
  88 sense_reason_t  sbc_dif_verify_write(struct se_cmd *, sector_t, unsigned int,
  89                                      unsigned int, struct scatterlist *, int);
  90 sense_reason_t  sbc_dif_verify_read(struct se_cmd *, sector_t, unsigned int,
  91                                     unsigned int, struct scatterlist *, int);
  92 sense_reason_t  sbc_dif_read_strip(struct se_cmd *);
  93
  94 void    transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
  95 int     transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
  96 int     transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
  97 int     transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
  98
  99 /* core helpers also used by command snooping in pscsi */
 100 void    *transport_kmap_data_sg(struct se_cmd *);
 101 void    transport_kunmap_data_sg(struct se_cmd *);
 102 /* core helpers also used by xcopy during internal command setup */
 103 int     target_alloc_sgl(struct scatterlist **, unsigned int *, u32, bool);
 104 sense_reason_t  transport_generic_map_mem_to_cmd(struct se_cmd *,
 105                 struct scatterlist *, u32, struct scatterlist *, u32);
 106
 107 void    array_free(void *array, int n);
 108
 109 /* From target_core_configfs.c to setup default backend config_item_types */
 110 void    target_core_setup_sub_cits(struct se_subsystem_api *);
 111
 112 #endif /* TARGET_CORE_BACKEND_H */