drivers/usb/gadget/function/f_mass_storage.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef USB_F_MASS_STORAGE_H
   3 #define USB_F_MASS_STORAGE_H
   4
   5 #include <linux/usb/composite.h>
   6 #include "storage_common.h"
   7
   8 struct fsg_module_parameters {
   9         char            *file[FSG_MAX_LUNS];
  10         bool            ro[FSG_MAX_LUNS];
  11         bool            removable[FSG_MAX_LUNS];
  12         bool            cdrom[FSG_MAX_LUNS];
  13         bool            nofua[FSG_MAX_LUNS];
  14
  15         unsigned int    file_count, ro_count, removable_count, cdrom_count;
  16         unsigned int    nofua_count;
  17         unsigned int    luns;   /* nluns */
  18         bool            stall;  /* can_stall */
  19 };
  20
  21 #define _FSG_MODULE_PARAM_ARRAY(prefix, params, name, type, desc)       \
  22         module_param_array_named(prefix ## name, params.name, type,     \
  23                                  &prefix ## params.name ## _count,      \
  24                                  S_IRUGO);                              \
  25         MODULE_PARM_DESC(prefix ## name, desc)
  26
  27 #define _FSG_MODULE_PARAM(prefix, params, name, type, desc)             \
  28         module_param_named(prefix ## name, params.name, type,           \
  29                            S_IRUGO);                                    \
  30         MODULE_PARM_DESC(prefix ## name, desc)
  31
  32 #define __FSG_MODULE_PARAMETERS(prefix, params)                         \
  33         _FSG_MODULE_PARAM_ARRAY(prefix, params, file, charp,            \
  34                                 "names of backing files or devices");   \
  35         _FSG_MODULE_PARAM_ARRAY(prefix, params, ro, bool,               \
  36                                 "true to force read-only");             \
  37         _FSG_MODULE_PARAM_ARRAY(prefix, params, removable, bool,        \
  38                                 "true to simulate removable media");    \
  39         _FSG_MODULE_PARAM_ARRAY(prefix, params, cdrom, bool,            \
  40                                 "true to simulate CD-ROM instead of disk"); \
  41         _FSG_MODULE_PARAM_ARRAY(prefix, params, nofua, bool,            \
  42                                 "true to ignore SCSI WRITE(10,12) FUA bit"); \
  43         _FSG_MODULE_PARAM(prefix, params, luns, uint,                   \
  44                           "number of LUNs");                            \
  45         _FSG_MODULE_PARAM(prefix, params, stall, bool,                  \
  46                           "false to prevent bulk stalls")
  47
  48 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
  49
  50 #define FSG_MODULE_PARAMETERS(prefix, params)                           \
  51         __FSG_MODULE_PARAMETERS(prefix, params);                        \
  52         module_param_named(num_buffers, fsg_num_buffers, uint, S_IRUGO);\
  53         MODULE_PARM_DESC(num_buffers, "Number of pipeline buffers")
  54 #else
  55
  56 #define FSG_MODULE_PARAMETERS(prefix, params)                           \
  57         __FSG_MODULE_PARAMETERS(prefix, params)
  58
  59 #endif
  60
  61 struct fsg_common;
  62
  63 /* FSF callback functions */
  64 struct fsg_lun_opts {
  65         struct config_group group;
  66         struct fsg_lun *lun;
  67         int lun_id;
  68 };
  69
  70 struct fsg_opts {
  71         struct fsg_common *common;
  72         struct usb_function_instance func_inst;
  73         struct fsg_lun_opts lun0;
  74         struct config_group *default_groups[2];
  75         bool no_configfs; /* for legacy gadgets */
  76
  77         /*
  78          * Read/write access to configfs attributes is handled by configfs.
  79          *
  80          * This is to protect the data from concurrent access by read/write
  81          * and create symlink/remove symlink.
  82          */
  83         struct mutex                    lock;
  84         int                             refcnt;
  85 };
  86
  87 struct fsg_lun_config {
  88         const char *filename;
  89         char ro;
  90         char removable;
  91         char cdrom;
  92         char nofua;
  93         char inquiry_string[INQUIRY_STRING_LEN];
  94 };
  95
  96 struct fsg_config {
  97         unsigned nluns;
  98         struct fsg_lun_config luns[FSG_MAX_LUNS];
  99
 100         /* Callback functions. */
 101         const struct fsg_operations     *ops;
 102         /* Gadget's private data. */
 103         void                    *private_data;
 104
 105         const char *vendor_name;                /*  8 characters or less */
 106         const char *product_name;               /* 16 characters or less */
 107
 108         char                    can_stall;
 109         unsigned int            fsg_num_buffers;
 110 };
 111
 112 static inline struct fsg_opts *
 113 fsg_opts_from_func_inst(const struct usb_function_instance *fi)
 114 {
 115         return container_of(fi, struct fsg_opts, func_inst);
 116 }
 117
 118 void fsg_common_get(struct fsg_common *common);
 119
 120 void fsg_common_put(struct fsg_common *common);
 121
 122 void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs);
 123
 124 int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n);
 125
 126 void fsg_common_free_buffers(struct fsg_common *common);
 127
 128 int fsg_common_set_cdev(struct fsg_common *common,
 129                         struct usb_composite_dev *cdev, bool can_stall);
 130
 131 void fsg_common_remove_lun(struct fsg_lun *lun);
 132
 133 void fsg_common_remove_luns(struct fsg_common *common);
 134
 135 int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
 136                           unsigned int id, const char *name,
 137                           const char **name_pfx);
 138
 139 int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg);
 140
 141 void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
 142                                    const char *pn);
 143
 144 void fsg_config_from_params(struct fsg_config *cfg,
 145                             const struct fsg_module_parameters *params,
 146                             unsigned int fsg_num_buffers);
 147
 148 #endif /* USB_F_MASS_STORAGE_H */