]>
Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
f3fed367 AP |
2 | #ifndef USB_F_MASS_STORAGE_H |
3 | #define USB_F_MASS_STORAGE_H | |
4 | ||
e5eaa0dc | 5 | #include <linux/usb/composite.h> |
f3fed367 AP |
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 */ | |
ef0aa4b9 AP |
64 | struct fsg_lun_opts { |
65 | struct config_group group; | |
66 | struct fsg_lun *lun; | |
67 | int lun_id; | |
68 | }; | |
69 | ||
e5eaa0dc AP |
70 | struct fsg_opts { |
71 | struct fsg_common *common; | |
72 | struct usb_function_instance func_inst; | |
ef0aa4b9 AP |
73 | struct fsg_lun_opts lun0; |
74 | struct config_group *default_groups[2]; | |
e5eaa0dc | 75 | bool no_configfs; /* for legacy gadgets */ |
ef0aa4b9 AP |
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; | |
e5eaa0dc AP |
85 | }; |
86 | ||
f3fed367 AP |
87 | struct fsg_lun_config { |
88 | const char *filename; | |
89 | char ro; | |
90 | char removable; | |
91 | char cdrom; | |
92 | char nofua; | |
6ac47090 | 93 | char inquiry_string[INQUIRY_STRING_LEN]; |
f3fed367 AP |
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 | ||
e5eaa0dc AP |
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 | ||
f3fed367 AP |
118 | void fsg_common_get(struct fsg_common *common); |
119 | ||
120 | void fsg_common_put(struct fsg_common *common); | |
121 | ||
bd528d4e AP |
122 | void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs); |
123 | ||
6313caac AP |
124 | int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n); |
125 | ||
e5eaa0dc AP |
126 | void fsg_common_free_buffers(struct fsg_common *common); |
127 | ||
a891d7a3 AP |
128 | int fsg_common_set_cdev(struct fsg_common *common, |
129 | struct usb_composite_dev *cdev, bool can_stall); | |
130 | ||
5542f58c | 131 | void fsg_common_remove_lun(struct fsg_lun *lun); |
70634170 AP |
132 | |
133 | void fsg_common_remove_luns(struct fsg_common *common); | |
134 | ||
b27c08c9 AP |
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 | ||
23682e3c AP |
141 | void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn, |
142 | const char *pn); | |
143 | ||
f3fed367 AP |
144 | void fsg_config_from_params(struct fsg_config *cfg, |
145 | const struct fsg_module_parameters *params, | |
146 | unsigned int fsg_num_buffers); | |
147 | ||
f3fed367 | 148 | #endif /* USB_F_MASS_STORAGE_H */ |