storage_common.c 21.0 KB
Newer Older
1 2 3 4 5 6
/*
 * storage_common.c -- Common definitions for mass storage functionality
 *
 * Copyright (C) 2003-2008 Alan Stern
 * Copyeight (C) 2009 Samsung Electronics
 * Author: Michal Nazarewicz (m.nazarewicz@samsung.com)
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */


/*
 * This file requires the following identifiers used in USB strings to
 * be defined (each of type pointer to char):
 *  - fsg_string_manufacturer -- name of the manufacturer
 *  - fsg_string_product      -- name of the product
 *  - fsg_string_config       -- name of the configuration
 *  - fsg_string_interface    -- name of the interface
 * The first four are only needed when FSG_DESCRIPTORS_DEVICE_STRINGS
 * macro is defined prior to including this file.
33 34
 */

35 36 37 38 39 40 41 42 43 44 45 46 47 48
/*
 * When FSG_NO_INTR_EP is defined fsg_fs_intr_in_desc and
 * fsg_hs_intr_in_desc objects as well as
 * FSG_FS_FUNCTION_PRE_EP_ENTRIES and FSG_HS_FUNCTION_PRE_EP_ENTRIES
 * macros are not defined.
 *
 * When FSG_NO_DEVICE_STRINGS is defined FSG_STRING_MANUFACTURER,
 * FSG_STRING_PRODUCT, FSG_STRING_SERIAL and FSG_STRING_CONFIG are not
 * defined (as well as corresponding entries in string tables are
 * missing) and FSG_STRING_INTERFACE has value of zero.
 *
 * When FSG_NO_OTG is defined fsg_otg_desc won't be defined.
 */

49 50 51 52 53 54
/*
 * When FSG_BUFFHD_STATIC_BUFFER is defined when this file is included
 * the fsg_buffhd structure's buf field will be an array of FSG_BUFLEN
 * characters rather then a pointer to void.
 */

55

56
#include <linux/usb/storage.h>
57 58
#include <scsi/scsi.h>
#include <asm/unaligned.h>
59

60

61 62
/*
 * Thanks to NetChip Technologies for donating this product ID.
63 64
 *
 * DO NOT REUSE THESE IDs with any other driver!!  Ever!!
65 66
 * Instead:  allocate your own, using normal USB-IF procedures.
 */
67 68
#define FSG_VENDOR_ID	0x0525	/* NetChip */
#define FSG_PRODUCT_ID	0xa4a5	/* Linux-USB File-backed Storage Gadget */
69 70


71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
/*-------------------------------------------------------------------------*/


#ifndef DEBUG
#undef VERBOSE_DEBUG
#undef DUMP_MSGS
#endif /* !DEBUG */

#ifdef VERBOSE_DEBUG
#define VLDBG	LDBG
#else
#define VLDBG(lun, fmt, args...) do { } while (0)
#endif /* VERBOSE_DEBUG */

#define LDBG(lun, fmt, args...)   dev_dbg (&(lun)->dev, fmt, ## args)
#define LERROR(lun, fmt, args...) dev_err (&(lun)->dev, fmt, ## args)
#define LWARN(lun, fmt, args...)  dev_warn(&(lun)->dev, fmt, ## args)
#define LINFO(lun, fmt, args...)  dev_info(&(lun)->dev, fmt, ## args)

90 91 92
/*
 * Keep those macros in sync with those in
 * include/linux/usb/composite.h or else GCC will complain.  If they
93 94
 * are identical (the same names of arguments, white spaces in the
 * same places) GCC will allow redefinition otherwise (even if some
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
 * white space is removed or added) warning will be issued.
 *
 * Those macros are needed here because File Storage Gadget does not
 * include the composite.h header.  For composite gadgets those macros
 * are redundant since composite.h is included any way.
 *
 * One could check whether those macros are already defined (which
 * would indicate composite.h had been included) or not (which would
 * indicate we were in FSG) but this is not done because a warning is
 * desired if definitions here differ from the ones in composite.h.
 *
 * We want the definitions to match and be the same in File Storage
 * Gadget as well as Mass Storage Function (and so composite gadgets
 * using MSF).  If someone changes them in composite.h it will produce
 * a warning in this file when building MSF.
 */
111 112 113 114 115
#define DBG(d, fmt, args...)     dev_dbg(&(d)->gadget->dev , fmt , ## args)
#define VDBG(d, fmt, args...)    dev_vdbg(&(d)->gadget->dev , fmt , ## args)
#define ERROR(d, fmt, args...)   dev_err(&(d)->gadget->dev , fmt , ## args)
#define WARNING(d, fmt, args...) dev_warn(&(d)->gadget->dev , fmt , ## args)
#define INFO(d, fmt, args...)    dev_info(&(d)->gadget->dev , fmt , ## args)
116 117 118 119 120 121



#ifdef DUMP_MSGS

#  define dump_msg(fsg, /* const char * */ label,			\
122
		   /* const u8 * */ buf, /* unsigned */ length) do {	\
123 124 125 126 127 128 129 130 131 132 133 134
	if (length < 512) {						\
		DBG(fsg, "%s, length %u:\n", label, length);		\
		print_hex_dump(KERN_DEBUG, "", DUMP_PREFIX_OFFSET,	\
			       16, 1, buf, length, 0);			\
	}								\
} while (0)

#  define dump_cdb(fsg) do { } while (0)

#else

#  define dump_msg(fsg, /* const char * */ label, \
135
		   /* const u8 * */ buf, /* unsigned */ length) do { } while (0)
136 137 138

#  ifdef VERBOSE_DEBUG

139
#    define dump_cdb(fsg)						\
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
	print_hex_dump(KERN_DEBUG, "SCSI CDB: ", DUMP_PREFIX_NONE,	\
		       16, 1, (fsg)->cmnd, (fsg)->cmnd_size, 0)		\

#  else

#    define dump_cdb(fsg) do { } while (0)

#  endif /* VERBOSE_DEBUG */

#endif /* DUMP_MSGS */





/*-------------------------------------------------------------------------*/

/* Bulk-only data structures */

/* Command Block Wrapper */
160
struct fsg_bulk_cb_wrap {
161 162 163 164 165 166 167
	__le32	Signature;		/* Contains 'USBC' */
	u32	Tag;			/* Unique per command id */
	__le32	DataTransferLength;	/* Size of the data */
	u8	Flags;			/* Direction in bit 7 */
	u8	Lun;			/* LUN (normally 0) */
	u8	Length;			/* Of the CDB, <= MAX_COMMAND_SIZE */
	u8	CDB[16];		/* Command Data Block */
168 169 170
};

#define USB_BULK_CB_WRAP_LEN	31
171
#define USB_BULK_CB_SIG		0x43425355	/* Spells out USBC */
172 173 174 175
#define USB_BULK_IN_FLAG	0x80

/* Command Status Wrapper */
struct bulk_cs_wrap {
176 177 178 179
	__le32	Signature;		/* Should = 'USBS' */
	u32	Tag;			/* Same as original command */
	__le32	Residue;		/* Amount not transferred */
	u8	Status;			/* See below */
180 181 182
};

#define USB_BULK_CS_WRAP_LEN	13
183
#define USB_BULK_CS_SIG		0x53425355	/* Spells out 'USBS' */
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
#define USB_STATUS_PASS		0
#define USB_STATUS_FAIL		1
#define USB_STATUS_PHASE_ERROR	2

/* Bulk-only class specific requests */
#define USB_BULK_RESET_REQUEST		0xff
#define USB_BULK_GET_MAX_LUN_REQUEST	0xfe


/* CBI Interrupt data structure */
struct interrupt_data {
	u8	bType;
	u8	bValue;
};

#define CBI_INTERRUPT_DATA_LEN		2

/* CBI Accept Device-Specific Command request */
#define USB_CBI_ADSC_REQUEST		0x00


205 206
/* Length of a SCSI Command Data Block */
#define MAX_COMMAND_SIZE	16
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

/* SCSI Sense Key/Additional Sense Code/ASC Qualifier values */
#define SS_NO_SENSE				0
#define SS_COMMUNICATION_FAILURE		0x040800
#define SS_INVALID_COMMAND			0x052000
#define SS_INVALID_FIELD_IN_CDB			0x052400
#define SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE	0x052100
#define SS_LOGICAL_UNIT_NOT_SUPPORTED		0x052500
#define SS_MEDIUM_NOT_PRESENT			0x023a00
#define SS_MEDIUM_REMOVAL_PREVENTED		0x055302
#define SS_NOT_READY_TO_READY_TRANSITION	0x062800
#define SS_RESET_OCCURRED			0x062900
#define SS_SAVING_PARAMETERS_NOT_SUPPORTED	0x053900
#define SS_UNRECOVERED_READ_ERROR		0x031100
#define SS_WRITE_ERROR				0x030c02
#define SS_WRITE_PROTECTED			0x072700

224
#define SK(x)		((u8) ((x) >> 16))	/* Sense Key byte, etc. */
225 226 227 228 229 230 231
#define ASC(x)		((u8) ((x) >> 8))
#define ASCQ(x)		((u8) (x))


/*-------------------------------------------------------------------------*/


232
struct fsg_lun {
233 234 235 236
	struct file	*filp;
	loff_t		file_length;
	loff_t		num_sectors;

237 238 239 240 241 242 243
	unsigned int	initially_ro:1;
	unsigned int	ro:1;
	unsigned int	removable:1;
	unsigned int	cdrom:1;
	unsigned int	prevent_medium_removal:1;
	unsigned int	registered:1;
	unsigned int	info_valid:1;
244
	unsigned int	nofua:1;
245 246 247 248 249

	u32		sense_data;
	u32		sense_data_info;
	u32		unit_attention_data;

250 251
	unsigned int	blkbits;	/* Bits of logical block size of bound block device */
	unsigned int	blksize;	/* logical block size of bound block device */
252 253 254
	struct device	dev;
};

255
#define fsg_lun_is_open(curlun)	((curlun)->filp != NULL)
256

257
static struct fsg_lun *fsg_lun_from_dev(struct device *dev)
258
{
259
	return container_of(dev, struct fsg_lun, dev);
260 261 262 263 264
}


/* Big enough to hold our biggest descriptor */
#define EP0_BUFSIZE	256
265
#define DELAYED_STATUS	(EP0_BUFSIZE + 999)	/* An impossibly large value */
266 267

/* Number of buffers we will use.  2 is enough for double-buffering */
268
#define FSG_NUM_BUFFERS	2
269

270 271 272 273 274 275
/* Default size of buffer length. */
#define FSG_BUFLEN	((u32)16384)

/* Maximal number of LUNs supported in mass storage function */
#define FSG_MAX_LUNS	8

276 277 278 279 280 281 282
enum fsg_buffer_state {
	BUF_STATE_EMPTY = 0,
	BUF_STATE_FULL,
	BUF_STATE_BUSY
};

struct fsg_buffhd {
283 284 285
#ifdef FSG_BUFFHD_STATIC_BUFFER
	char				buf[FSG_BUFLEN];
#else
286
	void				*buf;
287
#endif
288 289 290
	enum fsg_buffer_state		state;
	struct fsg_buffhd		*next;

291 292 293 294 295 296 297
	/*
	 * The NetChip 2280 is faster, and handles some protocol faults
	 * better, if we don't submit any short bulk-out read requests.
	 * So we will record the intended request length here.
	 */
	unsigned int			bulk_out_intended_length;

298 299 300 301 302 303 304
	struct usb_request		*inreq;
	int				inreq_busy;
	struct usb_request		*outreq;
	int				outreq_busy;
};

enum fsg_state {
305 306
	/* This one isn't used anywhere */
	FSG_STATE_COMMAND_PHASE = -10,
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
	FSG_STATE_DATA_PHASE,
	FSG_STATE_STATUS_PHASE,

	FSG_STATE_IDLE = 0,
	FSG_STATE_ABORT_BULK_OUT,
	FSG_STATE_RESET,
	FSG_STATE_INTERFACE_CHANGE,
	FSG_STATE_CONFIG_CHANGE,
	FSG_STATE_DISCONNECT,
	FSG_STATE_EXIT,
	FSG_STATE_TERMINATED
};

enum data_direction {
	DATA_DIR_UNKNOWN = 0,
	DATA_DIR_FROM_HOST,
	DATA_DIR_TO_HOST,
	DATA_DIR_NONE
};


/*-------------------------------------------------------------------------*/


static inline u32 get_unaligned_be24(u8 *buf)
{
	return 0xffffff & (u32) get_unaligned_be32(buf - 1);
}


/*-------------------------------------------------------------------------*/


340
enum {
341
#ifndef FSG_NO_DEVICE_STRINGS
342 343 344 345
	FSG_STRING_MANUFACTURER	= 1,
	FSG_STRING_PRODUCT,
	FSG_STRING_SERIAL,
	FSG_STRING_CONFIG,
346
#endif
347 348
	FSG_STRING_INTERFACE
};
349 350


351
#ifndef FSG_NO_OTG
352
static struct usb_otg_descriptor
353 354
fsg_otg_desc = {
	.bLength =		sizeof fsg_otg_desc,
355 356 357 358
	.bDescriptorType =	USB_DT_OTG,

	.bmAttributes =		USB_OTG_SRP,
};
359
#endif
360 361 362 363

/* There is only one interface. */

static struct usb_interface_descriptor
364 365
fsg_intf_desc = {
	.bLength =		sizeof fsg_intf_desc,
366 367
	.bDescriptorType =	USB_DT_INTERFACE,

368
	.bNumEndpoints =	2,		/* Adjusted during fsg_bind() */
369
	.bInterfaceClass =	USB_CLASS_MASS_STORAGE,
370 371
	.bInterfaceSubClass =	USB_SC_SCSI,	/* Adjusted during fsg_bind() */
	.bInterfaceProtocol =	USB_PR_BULK,	/* Adjusted during fsg_bind() */
372
	.iInterface =		FSG_STRING_INTERFACE,
373 374
};

375 376 377 378
/*
 * Three full-speed endpoint descriptors: bulk-in, bulk-out, and
 * interrupt-in.
 */
379 380

static struct usb_endpoint_descriptor
381
fsg_fs_bulk_in_desc = {
382 383 384 385 386 387 388 389 390
	.bLength =		USB_DT_ENDPOINT_SIZE,
	.bDescriptorType =	USB_DT_ENDPOINT,

	.bEndpointAddress =	USB_DIR_IN,
	.bmAttributes =		USB_ENDPOINT_XFER_BULK,
	/* wMaxPacketSize set by autoconfiguration */
};

static struct usb_endpoint_descriptor
391
fsg_fs_bulk_out_desc = {
392 393 394 395 396 397 398 399
	.bLength =		USB_DT_ENDPOINT_SIZE,
	.bDescriptorType =	USB_DT_ENDPOINT,

	.bEndpointAddress =	USB_DIR_OUT,
	.bmAttributes =		USB_ENDPOINT_XFER_BULK,
	/* wMaxPacketSize set by autoconfiguration */
};

400 401
#ifndef FSG_NO_INTR_EP

402
static struct usb_endpoint_descriptor
403
fsg_fs_intr_in_desc = {
404 405 406 407 408 409
	.bLength =		USB_DT_ENDPOINT_SIZE,
	.bDescriptorType =	USB_DT_ENDPOINT,

	.bEndpointAddress =	USB_DIR_IN,
	.bmAttributes =		USB_ENDPOINT_XFER_INT,
	.wMaxPacketSize =	cpu_to_le16(2),
410
	.bInterval =		32,	/* frames -> 32 ms */
411 412
};

413 414 415 416 417 418 419 420
#ifndef FSG_NO_OTG
#  define FSG_FS_FUNCTION_PRE_EP_ENTRIES	2
#else
#  define FSG_FS_FUNCTION_PRE_EP_ENTRIES	1
#endif

#endif

421
static struct usb_descriptor_header *fsg_fs_function[] = {
422
#ifndef FSG_NO_OTG
423
	(struct usb_descriptor_header *) &fsg_otg_desc,
424
#endif
425 426 427
	(struct usb_descriptor_header *) &fsg_intf_desc,
	(struct usb_descriptor_header *) &fsg_fs_bulk_in_desc,
	(struct usb_descriptor_header *) &fsg_fs_bulk_out_desc,
428
#ifndef FSG_NO_INTR_EP
429
	(struct usb_descriptor_header *) &fsg_fs_intr_in_desc,
430
#endif
431 432 433 434 435 436 437 438 439 440
	NULL,
};


/*
 * USB 2.0 devices need to expose both high speed and full speed
 * descriptors, unless they only run at full speed.
 *
 * That means alternate endpoint descriptors (bigger packets)
 * and a "device qualifier" ... plus more construction options
441
 * for the configuration descriptor.
442 443
 */
static struct usb_endpoint_descriptor
444
fsg_hs_bulk_in_desc = {
445 446 447 448 449 450 451 452 453
	.bLength =		USB_DT_ENDPOINT_SIZE,
	.bDescriptorType =	USB_DT_ENDPOINT,

	/* bEndpointAddress copied from fs_bulk_in_desc during fsg_bind() */
	.bmAttributes =		USB_ENDPOINT_XFER_BULK,
	.wMaxPacketSize =	cpu_to_le16(512),
};

static struct usb_endpoint_descriptor
454
fsg_hs_bulk_out_desc = {
455 456 457 458 459 460
	.bLength =		USB_DT_ENDPOINT_SIZE,
	.bDescriptorType =	USB_DT_ENDPOINT,

	/* bEndpointAddress copied from fs_bulk_out_desc during fsg_bind() */
	.bmAttributes =		USB_ENDPOINT_XFER_BULK,
	.wMaxPacketSize =	cpu_to_le16(512),
461
	.bInterval =		1,	/* NAK every 1 uframe */
462 463
};

464 465
#ifndef FSG_NO_INTR_EP

466
static struct usb_endpoint_descriptor
467
fsg_hs_intr_in_desc = {
468 469 470 471 472 473
	.bLength =		USB_DT_ENDPOINT_SIZE,
	.bDescriptorType =	USB_DT_ENDPOINT,

	/* bEndpointAddress copied from fs_intr_in_desc during fsg_bind() */
	.bmAttributes =		USB_ENDPOINT_XFER_INT,
	.wMaxPacketSize =	cpu_to_le16(2),
474
	.bInterval =		9,	/* 2**(9-1) = 256 uframes -> 32 ms */
475 476
};

477 478 479 480 481 482 483 484
#ifndef FSG_NO_OTG
#  define FSG_HS_FUNCTION_PRE_EP_ENTRIES	2
#else
#  define FSG_HS_FUNCTION_PRE_EP_ENTRIES	1
#endif

#endif

485
static struct usb_descriptor_header *fsg_hs_function[] = {
486
#ifndef FSG_NO_OTG
487
	(struct usb_descriptor_header *) &fsg_otg_desc,
488
#endif
489 490 491
	(struct usb_descriptor_header *) &fsg_intf_desc,
	(struct usb_descriptor_header *) &fsg_hs_bulk_in_desc,
	(struct usb_descriptor_header *) &fsg_hs_bulk_out_desc,
492
#ifndef FSG_NO_INTR_EP
493
	(struct usb_descriptor_header *) &fsg_hs_intr_in_desc,
494
#endif
495 496 497 498
	NULL,
};

/* Maxpacket and other transfer characteristics vary by speed. */
499
static __maybe_unused struct usb_endpoint_descriptor *
500
fsg_ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *fs,
501 502 503 504 505 506 507 508 509
		struct usb_endpoint_descriptor *hs)
{
	if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
		return hs;
	return fs;
}


/* Static strings, in UTF-8 (for simplicity we use only ASCII characters) */
510
static struct usb_string		fsg_strings[] = {
511
#ifndef FSG_NO_DEVICE_STRINGS
512 513
	{FSG_STRING_MANUFACTURER,	fsg_string_manufacturer},
	{FSG_STRING_PRODUCT,		fsg_string_product},
514
	{FSG_STRING_SERIAL,		""},
515
	{FSG_STRING_CONFIG,		fsg_string_config},
516
#endif
517
	{FSG_STRING_INTERFACE,		fsg_string_interface},
518 519 520
	{}
};

521
static struct usb_gadget_strings	fsg_stringtab = {
522
	.language	= 0x0409,		/* en-us */
523
	.strings	= fsg_strings,
524 525 526 527 528
};


 /*-------------------------------------------------------------------------*/

529 530 531 532
/*
 * If the next two routines are called while the gadget is registered,
 * the caller must own fsg->filesem for writing.
 */
533

534
static int fsg_lun_open(struct fsg_lun *curlun, const char *filename)
535 536 537 538 539 540 541 542 543 544
{
	int				ro;
	struct file			*filp = NULL;
	int				rc = -EINVAL;
	struct inode			*inode = NULL;
	loff_t				size;
	loff_t				num_sectors;
	loff_t				min_sectors;

	/* R/W if we can, R/O if we must */
545
	ro = curlun->initially_ro;
546 547
	if (!ro) {
		filp = filp_open(filename, O_RDWR | O_LARGEFILE, 0);
548
		if (PTR_ERR(filp) == -EROFS || PTR_ERR(filp) == -EACCES)
549 550 551 552 553 554 555 556 557 558 559 560 561 562
			ro = 1;
	}
	if (ro)
		filp = filp_open(filename, O_RDONLY | O_LARGEFILE, 0);
	if (IS_ERR(filp)) {
		LINFO(curlun, "unable to open backing file: %s\n", filename);
		return PTR_ERR(filp);
	}

	if (!(filp->f_mode & FMODE_WRITE))
		ro = 1;

	if (filp->f_path.dentry)
		inode = filp->f_path.dentry->d_inode;
563
	if (!inode || (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))) {
564 565 566 567
		LINFO(curlun, "invalid file type: %s\n", filename);
		goto out;
	}

568 569 570 571
	/*
	 * If we can't read the file, it's no good.
	 * If we can't write the file, use it read-only.
	 */
572 573 574 575 576 577 578 579 580 581 582 583 584
	if (!filp->f_op || !(filp->f_op->read || filp->f_op->aio_read)) {
		LINFO(curlun, "file not readable: %s\n", filename);
		goto out;
	}
	if (!(filp->f_op->write || filp->f_op->aio_write))
		ro = 1;

	size = i_size_read(inode->i_mapping->host);
	if (size < 0) {
		LINFO(curlun, "unable to find file size: %s\n", filename);
		rc = (int) size;
		goto out;
	}
585 586 587 588 589 590 591 592 593 594 595 596 597

	if (curlun->cdrom) {
		curlun->blksize = 2048;
		curlun->blkbits = 11;
	} else if (inode->i_bdev) {
		curlun->blksize = bdev_logical_block_size(inode->i_bdev);
		curlun->blkbits = blksize_bits(curlun->blksize);
	} else {
		curlun->blksize = 512;
		curlun->blkbits = 9;
	}

	num_sectors = size >> curlun->blkbits; /* File size in logic-block-size blocks */
598
	min_sectors = 1;
599
	if (curlun->cdrom) {
600 601 602
		min_sectors = 300;	/* Smallest track is 300 frames */
		if (num_sectors >= 256*60*75) {
			num_sectors = 256*60*75 - 1;
603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
			LINFO(curlun, "file too big: %s\n", filename);
			LINFO(curlun, "using only first %d blocks\n",
					(int) num_sectors);
		}
	}
	if (num_sectors < min_sectors) {
		LINFO(curlun, "file too small: %s\n", filename);
		rc = -ETOOSMALL;
		goto out;
	}

	get_file(filp);
	curlun->ro = ro;
	curlun->filp = filp;
	curlun->file_length = size;
	curlun->num_sectors = num_sectors;
	LDBG(curlun, "open backing file: %s\n", filename);
	rc = 0;

out:
	filp_close(filp, current->files);
	return rc;
}


628
static void fsg_lun_close(struct fsg_lun *curlun)
629 630 631 632 633 634 635 636 637 638 639
{
	if (curlun->filp) {
		LDBG(curlun, "close backing file\n");
		fput(curlun->filp);
		curlun->filp = NULL;
	}
}


/*-------------------------------------------------------------------------*/

640 641 642 643
/*
 * Sync the file data, don't bother with the metadata.
 * This code was copied from fs/buffer.c:sys_fdatasync().
 */
644
static int fsg_lun_fsync_sub(struct fsg_lun *curlun)
645 646 647 648 649
{
	struct file	*filp = curlun->filp;

	if (curlun->ro || !filp)
		return 0;
650
	return vfs_fsync(filp, 1);
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
}

static void store_cdrom_address(u8 *dest, int msf, u32 addr)
{
	if (msf) {
		/* Convert to Minutes-Seconds-Frames */
		addr >>= 2;		/* Convert to 2048-byte frames */
		addr += 2*75;		/* Lead-in occupies 2 seconds */
		dest[3] = addr % 75;	/* Frames */
		addr /= 75;
		dest[2] = addr % 60;	/* Seconds */
		addr /= 60;
		dest[1] = addr;		/* Minutes */
		dest[0] = 0;		/* Reserved */
	} else {
		/* Absolute sector */
		put_unaligned_be32(addr, dest);
	}
}
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684


/*-------------------------------------------------------------------------*/


static ssize_t fsg_show_ro(struct device *dev, struct device_attribute *attr,
			   char *buf)
{
	struct fsg_lun	*curlun = fsg_lun_from_dev(dev);

	return sprintf(buf, "%d\n", fsg_lun_is_open(curlun)
				  ? curlun->ro
				  : curlun->initially_ro);
}

685 686 687 688 689 690 691 692
static ssize_t fsg_show_nofua(struct device *dev, struct device_attribute *attr,
			      char *buf)
{
	struct fsg_lun	*curlun = fsg_lun_from_dev(dev);

	return sprintf(buf, "%u\n", curlun->nofua);
}

693 694 695 696 697 698 699 700 701
static ssize_t fsg_show_file(struct device *dev, struct device_attribute *attr,
			     char *buf)
{
	struct fsg_lun	*curlun = fsg_lun_from_dev(dev);
	struct rw_semaphore	*filesem = dev_get_drvdata(dev);
	char		*p;
	ssize_t		rc;

	down_read(filesem);
702
	if (fsg_lun_is_open(curlun)) {	/* Get the complete pathname */
703 704 705 706 707 708
		p = d_path(&curlun->filp->f_path, buf, PAGE_SIZE - 1);
		if (IS_ERR(p))
			rc = PTR_ERR(p);
		else {
			rc = strlen(p);
			memmove(buf, p, rc);
709
			buf[rc] = '\n';		/* Add a newline */
710 711
			buf[++rc] = 0;
		}
712
	} else {				/* No file, return 0 bytes */
713 714 715 716 717 718 719 720 721 722 723
		*buf = 0;
		rc = 0;
	}
	up_read(filesem);
	return rc;
}


static ssize_t fsg_store_ro(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
724
	ssize_t		rc;
725 726
	struct fsg_lun	*curlun = fsg_lun_from_dev(dev);
	struct rw_semaphore	*filesem = dev_get_drvdata(dev);
727
	unsigned	ro;
728

729 730 731
	rc = kstrtouint(buf, 2, &ro);
	if (rc)
		return rc;
732

733 734 735 736
	/*
	 * Allow the write-enable status to change only while the
	 * backing file is closed.
	 */
737 738 739 740 741
	down_read(filesem);
	if (fsg_lun_is_open(curlun)) {
		LDBG(curlun, "read-only status change prevented\n");
		rc = -EBUSY;
	} else {
742 743
		curlun->ro = ro;
		curlun->initially_ro = ro;
744
		LDBG(curlun, "read-only status set to %d\n", curlun->ro);
745
		rc = count;
746 747 748 749 750
	}
	up_read(filesem);
	return rc;
}

751 752 753 754 755
static ssize_t fsg_store_nofua(struct device *dev,
			       struct device_attribute *attr,
			       const char *buf, size_t count)
{
	struct fsg_lun	*curlun = fsg_lun_from_dev(dev);
756 757
	unsigned	nofua;
	int		ret;
758

759 760 761
	ret = kstrtouint(buf, 2, &nofua);
	if (ret)
		return ret;
762 763 764 765 766 767 768 769 770 771

	/* Sync data when switching from async mode to sync */
	if (!nofua && curlun->nofua)
		fsg_lun_fsync_sub(curlun);

	curlun->nofua = nofua;

	return count;
}

772 773 774 775 776 777 778 779 780
static ssize_t fsg_store_file(struct device *dev, struct device_attribute *attr,
			      const char *buf, size_t count)
{
	struct fsg_lun	*curlun = fsg_lun_from_dev(dev);
	struct rw_semaphore	*filesem = dev_get_drvdata(dev);
	int		rc = 0;

	if (curlun->prevent_medium_removal && fsg_lun_is_open(curlun)) {
		LDBG(curlun, "eject attempt prevented\n");
781
		return -EBUSY;				/* "Door is locked" */
782 783 784 785
	}

	/* Remove a trailing newline */
	if (count > 0 && buf[count-1] == '\n')
786
		((char *) buf)[count-1] = 0;		/* Ugh! */
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804

	/* Eject current medium */
	down_write(filesem);
	if (fsg_lun_is_open(curlun)) {
		fsg_lun_close(curlun);
		curlun->unit_attention_data = SS_MEDIUM_NOT_PRESENT;
	}

	/* Load new medium */
	if (count > 0 && buf[0]) {
		rc = fsg_lun_open(curlun, buf);
		if (rc == 0)
			curlun->unit_attention_data =
					SS_NOT_READY_TO_READY_TRANSITION;
	}
	up_write(filesem);
	return (rc < 0 ? rc : count);
}