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 se_subsystem_api {
   9         struct list_head sub_api_list;
  10
  11         char name[16];
  12         char inquiry_prod[16];
  13         char inquiry_rev[4];
  14         struct module *owner;
  15
  16         u8 transport_type;
  17
  18         int (*attach_hba)(struct se_hba *, u32);
  19         void (*detach_hba)(struct se_hba *);
  20         int (*pmode_enable_hba)(struct se_hba *, unsigned long);
  21
  22         struct se_device *(*alloc_device)(struct se_hba *, const char *);
  23         int (*configure_device)(struct se_device *);
  24         void (*free_device)(struct se_device *device);
  25
  26         ssize_t (*set_configfs_dev_params)(struct se_device *,
  27                                            const char *, ssize_t);
  28         ssize_t (*show_configfs_dev_params)(struct se_device *, char *);
  29
  30         void (*transport_complete)(struct se_cmd *cmd,
  31                                    struct scatterlist *,
  32                                    unsigned char *);
  33
  34         sense_reason_t (*parse_cdb)(struct se_cmd *cmd);
  35         u32 (*get_device_type)(struct se_device *);
  36         sector_t (*get_blocks)(struct se_device *);
  37         sector_t (*get_alignment_offset_lbas)(struct se_device *);
  38         /* lbppbe = logical blocks per physical block exponent. see SBC-3 */
  39         unsigned int (*get_lbppbe)(struct se_device *);
  40         unsigned int (*get_io_min)(struct se_device *);
  41         unsigned int (*get_io_opt)(struct se_device *);
  42         unsigned char *(*get_sense_buffer)(struct se_cmd *);
  43         bool (*get_write_cache)(struct se_device *);
  44         int (*init_prot)(struct se_device *);
  45         int (*format_prot)(struct se_device *);
  46         void (*free_prot)(struct se_device *);
  47 };
  48
  49 struct sbc_ops {
  50         sense_reason_t (*execute_rw)(struct se_cmd *cmd, struct scatterlist *,
  51                                      u32, enum dma_data_direction);
  52         sense_reason_t (*execute_sync_cache)(struct se_cmd *cmd);
  53         sense_reason_t (*execute_write_same)(struct se_cmd *cmd);
  54         sense_reason_t (*execute_write_same_unmap)(struct se_cmd *cmd);
  55         sense_reason_t (*execute_unmap)(struct se_cmd *cmd);
  56 };
  57
  58 int     transport_subsystem_register(struct se_subsystem_api *);
  59 void    transport_subsystem_release(struct se_subsystem_api *);
  60
  61 void    target_complete_cmd(struct se_cmd *, u8);
  62 void    target_complete_cmd_with_length(struct se_cmd *, u8, int);
  63
  64 sense_reason_t  spc_parse_cdb(struct se_cmd *cmd, unsigned int *size);
  65 sense_reason_t  spc_emulate_report_luns(struct se_cmd *cmd);
  66 sense_reason_t  spc_emulate_inquiry_std(struct se_cmd *, unsigned char *);
  67 sense_reason_t  spc_emulate_evpd_83(struct se_cmd *, unsigned char *);
  68
  69 sense_reason_t  sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops);
  70 u32     sbc_get_device_rev(struct se_device *dev);
  71 u32     sbc_get_device_type(struct se_device *dev);
  72 sector_t        sbc_get_write_same_sectors(struct se_cmd *cmd);
  73 sense_reason_t sbc_execute_unmap(struct se_cmd *cmd,
  74         sense_reason_t (*do_unmap_fn)(struct se_cmd *cmd, void *priv,
  75                                       sector_t lba, sector_t nolb),
  76         void *priv);
  77 void    sbc_dif_generate(struct se_cmd *);
  78 sense_reason_t  sbc_dif_verify_write(struct se_cmd *, sector_t, unsigned int,
  79                                      unsigned int, struct scatterlist *, int);
  80 sense_reason_t  sbc_dif_verify_read(struct se_cmd *, sector_t, unsigned int,
  81                                     unsigned int, struct scatterlist *, int);
  82 sense_reason_t  sbc_dif_read_strip(struct se_cmd *);
  83
  84 void    transport_set_vpd_proto_id(struct t10_vpd *, unsigned char *);
  85 int     transport_set_vpd_assoc(struct t10_vpd *, unsigned char *);
  86 int     transport_set_vpd_ident_type(struct t10_vpd *, unsigned char *);
  87 int     transport_set_vpd_ident(struct t10_vpd *, unsigned char *);
  88
  89 /* core helpers also used by command snooping in pscsi */
  90 void    *transport_kmap_data_sg(struct se_cmd *);
  91 void    transport_kunmap_data_sg(struct se_cmd *);
  92 /* core helpers also used by xcopy during internal command setup */
  93 int     target_alloc_sgl(struct scatterlist **, unsigned int *, u32, bool);
  94 sense_reason_t  transport_generic_map_mem_to_cmd(struct se_cmd *,
  95                 struct scatterlist *, u32, struct scatterlist *, u32);
  96
  97 void    array_free(void *array, int n);
  98
  99 #endif /* TARGET_CORE_BACKEND_H */