LXR linux/drivers/usb/gadget/function/f_mass

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