xref: /linux/Documentation/ABI/testing/configfs-usb-gadget-mass-storage (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
1ef0aa4b9SAndrzej PietrasiewiczWhat:		/config/usb-gadget/gadget/functions/mass_storage.name
2ef0aa4b9SAndrzej PietrasiewiczDate:		Oct 2013
306519e7fSArd BiesheuvelKernelVersion:	3.13
4ef0aa4b9SAndrzej PietrasiewiczDescription:
5ef0aa4b9SAndrzej Pietrasiewicz		The attributes:
6ef0aa4b9SAndrzej Pietrasiewicz
754a19b4dSMauro Carvalho Chehab		===========	==============================================
854a19b4dSMauro Carvalho Chehab		stall		Set to permit function to halt bulk endpoints.
9ef0aa4b9SAndrzej Pietrasiewicz				Disabled on some USB devices known not to work
10ef0aa4b9SAndrzej Pietrasiewicz				correctly. You should set it to true.
1154a19b4dSMauro Carvalho Chehab		num_buffers	Number of pipeline buffers. Valid numbers
12ef0aa4b9SAndrzej Pietrasiewicz				are 2..4. Available only if
13ef0aa4b9SAndrzej Pietrasiewicz				CONFIG_USB_GADGET_DEBUG_FILES is set.
1454a19b4dSMauro Carvalho Chehab		===========	==============================================
15ef0aa4b9SAndrzej Pietrasiewicz
16ef0aa4b9SAndrzej PietrasiewiczWhat:		/config/usb-gadget/gadget/functions/mass_storage.name/lun.name
17ef0aa4b9SAndrzej PietrasiewiczDate:		Oct 2013
1806519e7fSArd BiesheuvelKernelVersion:	3.13
19ef0aa4b9SAndrzej PietrasiewiczDescription:
20ef0aa4b9SAndrzej Pietrasiewicz		The attributes:
21ef0aa4b9SAndrzej Pietrasiewicz
22*b7423bb2SMaxim Devaev		============	==============================================
2354a19b4dSMauro Carvalho Chehab		file		The path to the backing file for the LUN.
24ef0aa4b9SAndrzej Pietrasiewicz				Required if LUN is not marked as removable.
2554a19b4dSMauro Carvalho Chehab		ro		Flag specifying access to the LUN shall be
26ef0aa4b9SAndrzej Pietrasiewicz				read-only. This is implied if CD-ROM emulation
27ef0aa4b9SAndrzej Pietrasiewicz				is enabled as well as when it was impossible
28ef0aa4b9SAndrzej Pietrasiewicz				to open "filename" in R/W mode.
2954a19b4dSMauro Carvalho Chehab		removable	Flag specifying that LUN shall be indicated as
30ef0aa4b9SAndrzej Pietrasiewicz				being removable.
3154a19b4dSMauro Carvalho Chehab		cdrom		Flag specifying that LUN shall be reported as
32ef0aa4b9SAndrzej Pietrasiewicz				being a CD-ROM.
3354a19b4dSMauro Carvalho Chehab		nofua		Flag specifying that FUA flag
34ef0aa4b9SAndrzej Pietrasiewicz				in SCSI WRITE(10,12)
35421c8d9aSMaxim Devaev		forced_eject	This write-only file is useful only when
36421c8d9aSMaxim Devaev				the function is active. It causes the backing
37421c8d9aSMaxim Devaev				file to be forcibly detached from the LUN,
38421c8d9aSMaxim Devaev				regardless of whether the host has allowed it.
39421c8d9aSMaxim Devaev				Any non-zero number of bytes written will
40421c8d9aSMaxim Devaev				result in ejection.
41*b7423bb2SMaxim Devaev		============	==============================================
42