[deliverable/linux.git] / drivers / usb / gadget / f_mass_storage.h

#ifndef USB_F_MASS_STORAGE_H
#define USB_F_MASS_STORAGE_H

#include "storage_common.h"

struct fsg_module_parameters {
	char		*file[FSG_MAX_LUNS];
	bool		ro[FSG_MAX_LUNS];
	bool		removable[FSG_MAX_LUNS];
	bool		cdrom[FSG_MAX_LUNS];
	bool		nofua[FSG_MAX_LUNS];

	unsigned int	file_count, ro_count, removable_count, cdrom_count;
	unsigned int	nofua_count;
	unsigned int	luns;	/* nluns */
	bool		stall;	/* can_stall */
};

#define _FSG_MODULE_PARAM_ARRAY(prefix, params, name, type, desc)	\
	module_param_array_named(prefix ## name, params.name, type,	\
				 &prefix ## params.name ## _count,	\
				 S_IRUGO);				\
	MODULE_PARM_DESC(prefix ## name, desc)

#define _FSG_MODULE_PARAM(prefix, params, name, type, desc)		\
	module_param_named(prefix ## name, params.name, type,		\
			   S_IRUGO);					\
	MODULE_PARM_DESC(prefix ## name, desc)

#define __FSG_MODULE_PARAMETERS(prefix, params)				\
	_FSG_MODULE_PARAM_ARRAY(prefix, params, file, charp,		\
				"names of backing files or devices");	\
	_FSG_MODULE_PARAM_ARRAY(prefix, params, ro, bool,		\
				"true to force read-only");		\
	_FSG_MODULE_PARAM_ARRAY(prefix, params, removable, bool,	\
				"true to simulate removable media");	\
	_FSG_MODULE_PARAM_ARRAY(prefix, params, cdrom, bool,		\
				"true to simulate CD-ROM instead of disk"); \
	_FSG_MODULE_PARAM_ARRAY(prefix, params, nofua, bool,		\
				"true to ignore SCSI WRITE(10,12) FUA bit"); \
	_FSG_MODULE_PARAM(prefix, params, luns, uint,			\
			  "number of LUNs");				\
	_FSG_MODULE_PARAM(prefix, params, stall, bool,			\
			  "false to prevent bulk stalls")

#ifdef CONFIG_USB_GADGET_DEBUG_FILES

#define FSG_MODULE_PARAMETERS(prefix, params)				\
	__FSG_MODULE_PARAMETERS(prefix, params);			\
	module_param_named(num_buffers, fsg_num_buffers, uint, S_IRUGO);\
	MODULE_PARM_DESC(num_buffers, "Number of pipeline buffers")
#else

#define FSG_MODULE_PARAMETERS(prefix, params)				\
	__FSG_MODULE_PARAMETERS(prefix, params)

#endif

struct fsg_common;

/* FSF callback functions */
struct fsg_operations {
	/*
	 * Callback function to call when thread exits.  If no
	 * callback is set or it returns value lower then zero MSF
	 * will force eject all LUNs it operates on (including those
	 * marked as non-removable or with prevent_medium_removal flag
	 * set).
	 */
	int (*thread_exits)(struct fsg_common *common);
};

struct fsg_lun_config {
	const char *filename;
	char ro;
	char removable;
	char cdrom;
	char nofua;
};

struct fsg_config {
	unsigned nluns;
	struct fsg_lun_config luns[FSG_MAX_LUNS];

	/* Callback functions. */
	const struct fsg_operations	*ops;
	/* Gadget's private data. */
	void			*private_data;

	const char *vendor_name;		/*  8 characters or less */
	const char *product_name;		/* 16 characters or less */

	char			can_stall;
	unsigned int		fsg_num_buffers;
};

void fsg_common_get(struct fsg_common *common);

void fsg_common_put(struct fsg_common *common);

struct fsg_common *fsg_common_init(struct fsg_common *common,
				   struct usb_composite_dev *cdev,
				   struct fsg_config *cfg);

void fsg_common_set_sysfs(struct fsg_common *common, bool sysfs);

int fsg_common_set_num_buffers(struct fsg_common *common, unsigned int n);

int fsg_common_set_cdev(struct fsg_common *common,
			struct usb_composite_dev *cdev, bool can_stall);

void fsg_common_remove_lun(struct fsg_lun *lun, bool sysfs);

void fsg_common_remove_luns(struct fsg_common *common);

void fsg_common_free_luns(struct fsg_common *common);

int fsg_common_set_nluns(struct fsg_common *common, int nluns);

int fsg_common_create_lun(struct fsg_common *common, struct fsg_lun_config *cfg,
			  unsigned int id, const char *name,
			  const char **name_pfx);

int fsg_common_create_luns(struct fsg_common *common, struct fsg_config *cfg);

void fsg_common_set_inquiry_string(struct fsg_common *common, const char *vn,
				   const char *pn);

int fsg_common_run_thread(struct fsg_common *common);

void fsg_config_from_params(struct fsg_config *cfg,
			    const struct fsg_module_parameters *params,
			    unsigned int fsg_num_buffers);

static inline struct fsg_common *
fsg_common_from_params(struct fsg_common *common,
		       struct usb_composite_dev *cdev,
		       const struct fsg_module_parameters *params,
		       unsigned int fsg_num_buffers)
	__attribute__((unused));
static inline struct fsg_common *
fsg_common_from_params(struct fsg_common *common,
		       struct usb_composite_dev *cdev,
		       const struct fsg_module_parameters *params,
		       unsigned int fsg_num_buffers)
{
	struct fsg_config cfg;
	fsg_config_from_params(&cfg, params, fsg_num_buffers);
	return fsg_common_init(common, cdev, &cfg);
}

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