file_storage.c 102 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616
  1. /*
  2. * file_storage.c -- File-backed USB Storage Gadget, for USB development
  3. *
  4. * Copyright (C) 2003-2008 Alan Stern
  5. * All rights reserved.
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. * 1. Redistributions of source code must retain the above copyright
  11. * notice, this list of conditions, and the following disclaimer,
  12. * without modification.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in the
  15. * documentation and/or other materials provided with the distribution.
  16. * 3. The names of the above-listed copyright holders may not be used
  17. * to endorse or promote products derived from this software without
  18. * specific prior written permission.
  19. *
  20. * ALTERNATIVELY, this software may be distributed under the terms of the
  21. * GNU General Public License ("GPL") as published by the Free Software
  22. * Foundation, either version 2 of that License or (at your option) any
  23. * later version.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  26. * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  27. * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29. * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  30. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  31. * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  32. * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  33. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  34. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36. */
  37. /*
  38. * The File-backed Storage Gadget acts as a USB Mass Storage device,
  39. * appearing to the host as a disk drive or as a CD-ROM drive. In addition
  40. * to providing an example of a genuinely useful gadget driver for a USB
  41. * device, it also illustrates a technique of double-buffering for increased
  42. * throughput. Last but not least, it gives an easy way to probe the
  43. * behavior of the Mass Storage drivers in a USB host.
  44. *
  45. * Backing storage is provided by a regular file or a block device, specified
  46. * by the "file" module parameter. Access can be limited to read-only by
  47. * setting the optional "ro" module parameter. (For CD-ROM emulation,
  48. * access is always read-only.) The gadget will indicate that it has
  49. * removable media if the optional "removable" module parameter is set.
  50. *
  51. * The gadget supports the Control-Bulk (CB), Control-Bulk-Interrupt (CBI),
  52. * and Bulk-Only (also known as Bulk-Bulk-Bulk or BBB) transports, selected
  53. * by the optional "transport" module parameter. It also supports the
  54. * following protocols: RBC (0x01), ATAPI or SFF-8020i (0x02), QIC-157 (0c03),
  55. * UFI (0x04), SFF-8070i (0x05), and transparent SCSI (0x06), selected by
  56. * the optional "protocol" module parameter. In addition, the default
  57. * Vendor ID, Product ID, release number and serial number can be overridden.
  58. *
  59. * There is support for multiple logical units (LUNs), each of which has
  60. * its own backing file. The number of LUNs can be set using the optional
  61. * "luns" module parameter (anywhere from 1 to 8), and the corresponding
  62. * files are specified using comma-separated lists for "file" and "ro".
  63. * The default number of LUNs is taken from the number of "file" elements;
  64. * it is 1 if "file" is not given. If "removable" is not set then a backing
  65. * file must be specified for each LUN. If it is set, then an unspecified
  66. * or empty backing filename means the LUN's medium is not loaded. Ideally
  67. * each LUN would be settable independently as a disk drive or a CD-ROM
  68. * drive, but currently all LUNs have to be the same type. The CD-ROM
  69. * emulation includes a single data track and no audio tracks; hence there
  70. * need be only one backing file per LUN.
  71. *
  72. * Requirements are modest; only a bulk-in and a bulk-out endpoint are
  73. * needed (an interrupt-out endpoint is also needed for CBI). The memory
  74. * requirement amounts to two 16K buffers, size configurable by a parameter.
  75. * Support is included for both full-speed and high-speed operation.
  76. *
  77. * Note that the driver is slightly non-portable in that it assumes a
  78. * single memory/DMA buffer will be useable for bulk-in, bulk-out, and
  79. * interrupt-in endpoints. With most device controllers this isn't an
  80. * issue, but there may be some with hardware restrictions that prevent
  81. * a buffer from being used by more than one endpoint.
  82. *
  83. * Module options:
  84. *
  85. * file=filename[,filename...]
  86. * Required if "removable" is not set, names of
  87. * the files or block devices used for
  88. * backing storage
  89. * serial=HHHH... Required serial number (string of hex chars)
  90. * ro=b[,b...] Default false, booleans for read-only access
  91. * removable Default false, boolean for removable media
  92. * luns=N Default N = number of filenames, number of
  93. * LUNs to support
  94. * nofua=b[,b...] Default false, booleans for ignore FUA flag
  95. * in SCSI WRITE(10,12) commands
  96. * stall Default determined according to the type of
  97. * USB device controller (usually true),
  98. * boolean to permit the driver to halt
  99. * bulk endpoints
  100. * cdrom Default false, boolean for whether to emulate
  101. * a CD-ROM drive
  102. * transport=XXX Default BBB, transport name (CB, CBI, or BBB)
  103. * protocol=YYY Default SCSI, protocol name (RBC, 8020 or
  104. * ATAPI, QIC, UFI, 8070, or SCSI;
  105. * also 1 - 6)
  106. * vendor=0xVVVV Default 0x0525 (NetChip), USB Vendor ID
  107. * product=0xPPPP Default 0xa4a5 (FSG), USB Product ID
  108. * release=0xRRRR Override the USB release number (bcdDevice)
  109. * buflen=N Default N=16384, buffer size used (will be
  110. * rounded down to a multiple of
  111. * PAGE_CACHE_SIZE)
  112. *
  113. * If CONFIG_USB_FILE_STORAGE_TEST is not set, only the "file", "serial", "ro",
  114. * "removable", "luns", "nofua", "stall", and "cdrom" options are available;
  115. * default values are used for everything else.
  116. *
  117. * The pathnames of the backing files and the ro settings are available in
  118. * the attribute files "file", "nofua", and "ro" in the lun<n> subdirectory of
  119. * the gadget's sysfs directory. If the "removable" option is set, writing to
  120. * these files will simulate ejecting/loading the medium (writing an empty
  121. * line means eject) and adjusting a write-enable tab. Changes to the ro
  122. * setting are not allowed when the medium is loaded or if CD-ROM emulation
  123. * is being used.
  124. *
  125. * This gadget driver is heavily based on "Gadget Zero" by David Brownell.
  126. * The driver's SCSI command interface was based on the "Information
  127. * technology - Small Computer System Interface - 2" document from
  128. * X3T9.2 Project 375D, Revision 10L, 7-SEP-93, available at
  129. * <http://www.t10.org/ftp/t10/drafts/s2/s2-r10l.pdf>. The single exception
  130. * is opcode 0x23 (READ FORMAT CAPACITIES), which was based on the
  131. * "Universal Serial Bus Mass Storage Class UFI Command Specification"
  132. * document, Revision 1.0, December 14, 1998, available at
  133. * <http://www.usb.org/developers/devclass_docs/usbmass-ufi10.pdf>.
  134. */
  135. /*
  136. * Driver Design
  137. *
  138. * The FSG driver is fairly straightforward. There is a main kernel
  139. * thread that handles most of the work. Interrupt routines field
  140. * callbacks from the controller driver: bulk- and interrupt-request
  141. * completion notifications, endpoint-0 events, and disconnect events.
  142. * Completion events are passed to the main thread by wakeup calls. Many
  143. * ep0 requests are handled at interrupt time, but SetInterface,
  144. * SetConfiguration, and device reset requests are forwarded to the
  145. * thread in the form of "exceptions" using SIGUSR1 signals (since they
  146. * should interrupt any ongoing file I/O operations).
  147. *
  148. * The thread's main routine implements the standard command/data/status
  149. * parts of a SCSI interaction. It and its subroutines are full of tests
  150. * for pending signals/exceptions -- all this polling is necessary since
  151. * the kernel has no setjmp/longjmp equivalents. (Maybe this is an
  152. * indication that the driver really wants to be running in userspace.)
  153. * An important point is that so long as the thread is alive it keeps an
  154. * open reference to the backing file. This will prevent unmounting
  155. * the backing file's underlying filesystem and could cause problems
  156. * during system shutdown, for example. To prevent such problems, the
  157. * thread catches INT, TERM, and KILL signals and converts them into
  158. * an EXIT exception.
  159. *
  160. * In normal operation the main thread is started during the gadget's
  161. * fsg_bind() callback and stopped during fsg_unbind(). But it can also
  162. * exit when it receives a signal, and there's no point leaving the
  163. * gadget running when the thread is dead. So just before the thread
  164. * exits, it deregisters the gadget driver. This makes things a little
  165. * tricky: The driver is deregistered at two places, and the exiting
  166. * thread can indirectly call fsg_unbind() which in turn can tell the
  167. * thread to exit. The first problem is resolved through the use of the
  168. * REGISTERED atomic bitflag; the driver will only be deregistered once.
  169. * The second problem is resolved by having fsg_unbind() check
  170. * fsg->state; it won't try to stop the thread if the state is already
  171. * FSG_STATE_TERMINATED.
  172. *
  173. * To provide maximum throughput, the driver uses a circular pipeline of
  174. * buffer heads (struct fsg_buffhd). In principle the pipeline can be
  175. * arbitrarily long; in practice the benefits don't justify having more
  176. * than 2 stages (i.e., double buffering). But it helps to think of the
  177. * pipeline as being a long one. Each buffer head contains a bulk-in and
  178. * a bulk-out request pointer (since the buffer can be used for both
  179. * output and input -- directions always are given from the host's
  180. * point of view) as well as a pointer to the buffer and various state
  181. * variables.
  182. *
  183. * Use of the pipeline follows a simple protocol. There is a variable
  184. * (fsg->next_buffhd_to_fill) that points to the next buffer head to use.
  185. * At any time that buffer head may still be in use from an earlier
  186. * request, so each buffer head has a state variable indicating whether
  187. * it is EMPTY, FULL, or BUSY. Typical use involves waiting for the
  188. * buffer head to be EMPTY, filling the buffer either by file I/O or by
  189. * USB I/O (during which the buffer head is BUSY), and marking the buffer
  190. * head FULL when the I/O is complete. Then the buffer will be emptied
  191. * (again possibly by USB I/O, during which it is marked BUSY) and
  192. * finally marked EMPTY again (possibly by a completion routine).
  193. *
  194. * A module parameter tells the driver to avoid stalling the bulk
  195. * endpoints wherever the transport specification allows. This is
  196. * necessary for some UDCs like the SuperH, which cannot reliably clear a
  197. * halt on a bulk endpoint. However, under certain circumstances the
  198. * Bulk-only specification requires a stall. In such cases the driver
  199. * will halt the endpoint and set a flag indicating that it should clear
  200. * the halt in software during the next device reset. Hopefully this
  201. * will permit everything to work correctly. Furthermore, although the
  202. * specification allows the bulk-out endpoint to halt when the host sends
  203. * too much data, implementing this would cause an unavoidable race.
  204. * The driver will always use the "no-stall" approach for OUT transfers.
  205. *
  206. * One subtle point concerns sending status-stage responses for ep0
  207. * requests. Some of these requests, such as device reset, can involve
  208. * interrupting an ongoing file I/O operation, which might take an
  209. * arbitrarily long time. During that delay the host might give up on
  210. * the original ep0 request and issue a new one. When that happens the
  211. * driver should not notify the host about completion of the original
  212. * request, as the host will no longer be waiting for it. So the driver
  213. * assigns to each ep0 request a unique tag, and it keeps track of the
  214. * tag value of the request associated with a long-running exception
  215. * (device-reset, interface-change, or configuration-change). When the
  216. * exception handler is finished, the status-stage response is submitted
  217. * only if the current ep0 request tag is equal to the exception request
  218. * tag. Thus only the most recently received ep0 request will get a
  219. * status-stage response.
  220. *
  221. * Warning: This driver source file is too long. It ought to be split up
  222. * into a header file plus about 3 separate .c files, to handle the details
  223. * of the Gadget, USB Mass Storage, and SCSI protocols.
  224. */
  225. /* #define VERBOSE_DEBUG */
  226. /* #define DUMP_MSGS */
  227. #include <linux/blkdev.h>
  228. #include <linux/completion.h>
  229. #include <linux/dcache.h>
  230. #include <linux/delay.h>
  231. #include <linux/device.h>
  232. #include <linux/fcntl.h>
  233. #include <linux/file.h>
  234. #include <linux/fs.h>
  235. #include <linux/kref.h>
  236. #include <linux/kthread.h>
  237. #include <linux/limits.h>
  238. #include <linux/rwsem.h>
  239. #include <linux/slab.h>
  240. #include <linux/spinlock.h>
  241. #include <linux/string.h>
  242. #include <linux/freezer.h>
  243. #include <linux/utsname.h>
  244. #include <linux/usb/ch9.h>
  245. #include <linux/usb/gadget.h>
  246. #include "gadget_chips.h"
  247. /*
  248. * Kbuild is not very cooperative with respect to linking separately
  249. * compiled library objects into one module. So for now we won't use
  250. * separate compilation ... ensuring init/exit sections work to shrink
  251. * the runtime footprint, and giving us at least some parts of what
  252. * a "gcc --combine ... part1.c part2.c part3.c ... " build would.
  253. */
  254. #include "usbstring.c"
  255. #include "config.c"
  256. #include "epautoconf.c"
  257. /*-------------------------------------------------------------------------*/
  258. #define DRIVER_DESC "File-backed Storage Gadget"
  259. #define DRIVER_NAME "g_file_storage"
  260. #define DRIVER_VERSION "1 September 2010"
  261. static char fsg_string_manufacturer[64];
  262. static const char fsg_string_product[] = DRIVER_DESC;
  263. static const char fsg_string_config[] = "Self-powered";
  264. static const char fsg_string_interface[] = "Mass Storage";
  265. #include "storage_common.c"
  266. MODULE_DESCRIPTION(DRIVER_DESC);
  267. MODULE_AUTHOR("Alan Stern");
  268. MODULE_LICENSE("Dual BSD/GPL");
  269. /*
  270. * This driver assumes self-powered hardware and has no way for users to
  271. * trigger remote wakeup. It uses autoconfiguration to select endpoints
  272. * and endpoint addresses.
  273. */
  274. /*-------------------------------------------------------------------------*/
  275. /* Encapsulate the module parameter settings */
  276. static struct {
  277. char *file[FSG_MAX_LUNS];
  278. char *serial;
  279. int ro[FSG_MAX_LUNS];
  280. int nofua[FSG_MAX_LUNS];
  281. unsigned int num_filenames;
  282. unsigned int num_ros;
  283. unsigned int num_nofuas;
  284. unsigned int nluns;
  285. int removable;
  286. int can_stall;
  287. int cdrom;
  288. char *transport_parm;
  289. char *protocol_parm;
  290. unsigned short vendor;
  291. unsigned short product;
  292. unsigned short release;
  293. unsigned int buflen;
  294. int transport_type;
  295. char *transport_name;
  296. int protocol_type;
  297. char *protocol_name;
  298. } mod_data = { // Default values
  299. .transport_parm = "BBB",
  300. .protocol_parm = "SCSI",
  301. .removable = 0,
  302. .can_stall = 1,
  303. .cdrom = 0,
  304. .vendor = FSG_VENDOR_ID,
  305. .product = FSG_PRODUCT_ID,
  306. .release = 0xffff, // Use controller chip type
  307. .buflen = 16384,
  308. };
  309. module_param_array_named(file, mod_data.file, charp, &mod_data.num_filenames,
  310. S_IRUGO);
  311. MODULE_PARM_DESC(file, "names of backing files or devices");
  312. module_param_named(serial, mod_data.serial, charp, S_IRUGO);
  313. MODULE_PARM_DESC(serial, "USB serial number");
  314. module_param_array_named(ro, mod_data.ro, bool, &mod_data.num_ros, S_IRUGO);
  315. MODULE_PARM_DESC(ro, "true to force read-only");
  316. module_param_array_named(nofua, mod_data.nofua, bool, &mod_data.num_nofuas,
  317. S_IRUGO);
  318. MODULE_PARM_DESC(nofua, "true to ignore SCSI WRITE(10,12) FUA bit");
  319. module_param_named(luns, mod_data.nluns, uint, S_IRUGO);
  320. MODULE_PARM_DESC(luns, "number of LUNs");
  321. module_param_named(removable, mod_data.removable, bool, S_IRUGO);
  322. MODULE_PARM_DESC(removable, "true to simulate removable media");
  323. module_param_named(stall, mod_data.can_stall, bool, S_IRUGO);
  324. MODULE_PARM_DESC(stall, "false to prevent bulk stalls");
  325. module_param_named(cdrom, mod_data.cdrom, bool, S_IRUGO);
  326. MODULE_PARM_DESC(cdrom, "true to emulate cdrom instead of disk");
  327. /* In the non-TEST version, only the module parameters listed above
  328. * are available. */
  329. #ifdef CONFIG_USB_FILE_STORAGE_TEST
  330. module_param_named(transport, mod_data.transport_parm, charp, S_IRUGO);
  331. MODULE_PARM_DESC(transport, "type of transport (BBB, CBI, or CB)");
  332. module_param_named(protocol, mod_data.protocol_parm, charp, S_IRUGO);
  333. MODULE_PARM_DESC(protocol, "type of protocol (RBC, 8020, QIC, UFI, "
  334. "8070, or SCSI)");
  335. module_param_named(vendor, mod_data.vendor, ushort, S_IRUGO);
  336. MODULE_PARM_DESC(vendor, "USB Vendor ID");
  337. module_param_named(product, mod_data.product, ushort, S_IRUGO);
  338. MODULE_PARM_DESC(product, "USB Product ID");
  339. module_param_named(release, mod_data.release, ushort, S_IRUGO);
  340. MODULE_PARM_DESC(release, "USB release number");
  341. module_param_named(buflen, mod_data.buflen, uint, S_IRUGO);
  342. MODULE_PARM_DESC(buflen, "I/O buffer size");
  343. #endif /* CONFIG_USB_FILE_STORAGE_TEST */
  344. /*
  345. * These definitions will permit the compiler to avoid generating code for
  346. * parts of the driver that aren't used in the non-TEST version. Even gcc
  347. * can recognize when a test of a constant expression yields a dead code
  348. * path.
  349. */
  350. #ifdef CONFIG_USB_FILE_STORAGE_TEST
  351. #define transport_is_bbb() (mod_data.transport_type == USB_PR_BULK)
  352. #define transport_is_cbi() (mod_data.transport_type == USB_PR_CBI)
  353. #define protocol_is_scsi() (mod_data.protocol_type == USB_SC_SCSI)
  354. #else
  355. #define transport_is_bbb() 1
  356. #define transport_is_cbi() 0
  357. #define protocol_is_scsi() 1
  358. #endif /* CONFIG_USB_FILE_STORAGE_TEST */
  359. /*-------------------------------------------------------------------------*/
  360. struct fsg_dev {
  361. /* lock protects: state, all the req_busy's, and cbbuf_cmnd */
  362. spinlock_t lock;
  363. struct usb_gadget *gadget;
  364. /* filesem protects: backing files in use */
  365. struct rw_semaphore filesem;
  366. /* reference counting: wait until all LUNs are released */
  367. struct kref ref;
  368. struct usb_ep *ep0; // Handy copy of gadget->ep0
  369. struct usb_request *ep0req; // For control responses
  370. unsigned int ep0_req_tag;
  371. const char *ep0req_name;
  372. struct usb_request *intreq; // For interrupt responses
  373. int intreq_busy;
  374. struct fsg_buffhd *intr_buffhd;
  375. unsigned int bulk_out_maxpacket;
  376. enum fsg_state state; // For exception handling
  377. unsigned int exception_req_tag;
  378. u8 config, new_config;
  379. unsigned int running : 1;
  380. unsigned int bulk_in_enabled : 1;
  381. unsigned int bulk_out_enabled : 1;
  382. unsigned int intr_in_enabled : 1;
  383. unsigned int phase_error : 1;
  384. unsigned int short_packet_received : 1;
  385. unsigned int bad_lun_okay : 1;
  386. unsigned long atomic_bitflags;
  387. #define REGISTERED 0
  388. #define IGNORE_BULK_OUT 1
  389. #define SUSPENDED 2
  390. struct usb_ep *bulk_in;
  391. struct usb_ep *bulk_out;
  392. struct usb_ep *intr_in;
  393. struct fsg_buffhd *next_buffhd_to_fill;
  394. struct fsg_buffhd *next_buffhd_to_drain;
  395. int thread_wakeup_needed;
  396. struct completion thread_notifier;
  397. struct task_struct *thread_task;
  398. int cmnd_size;
  399. u8 cmnd[MAX_COMMAND_SIZE];
  400. enum data_direction data_dir;
  401. u32 data_size;
  402. u32 data_size_from_cmnd;
  403. u32 tag;
  404. unsigned int lun;
  405. u32 residue;
  406. u32 usb_amount_left;
  407. /* The CB protocol offers no way for a host to know when a command
  408. * has completed. As a result the next command may arrive early,
  409. * and we will still have to handle it. For that reason we need
  410. * a buffer to store new commands when using CB (or CBI, which
  411. * does not oblige a host to wait for command completion either). */
  412. int cbbuf_cmnd_size;
  413. u8 cbbuf_cmnd[MAX_COMMAND_SIZE];
  414. unsigned int nluns;
  415. struct fsg_lun *luns;
  416. struct fsg_lun *curlun;
  417. /* Must be the last entry */
  418. struct fsg_buffhd buffhds[];
  419. };
  420. typedef void (*fsg_routine_t)(struct fsg_dev *);
  421. static int exception_in_progress(struct fsg_dev *fsg)
  422. {
  423. return (fsg->state > FSG_STATE_IDLE);
  424. }
  425. /* Make bulk-out requests be divisible by the maxpacket size */
  426. static void set_bulk_out_req_length(struct fsg_dev *fsg,
  427. struct fsg_buffhd *bh, unsigned int length)
  428. {
  429. unsigned int rem;
  430. bh->bulk_out_intended_length = length;
  431. rem = length % fsg->bulk_out_maxpacket;
  432. if (rem > 0)
  433. length += fsg->bulk_out_maxpacket - rem;
  434. bh->outreq->length = length;
  435. }
  436. static struct fsg_dev *the_fsg;
  437. static struct usb_gadget_driver fsg_driver;
  438. /*-------------------------------------------------------------------------*/
  439. static int fsg_set_halt(struct fsg_dev *fsg, struct usb_ep *ep)
  440. {
  441. const char *name;
  442. if (ep == fsg->bulk_in)
  443. name = "bulk-in";
  444. else if (ep == fsg->bulk_out)
  445. name = "bulk-out";
  446. else
  447. name = ep->name;
  448. DBG(fsg, "%s set halt\n", name);
  449. return usb_ep_set_halt(ep);
  450. }
  451. /*-------------------------------------------------------------------------*/
  452. /*
  453. * DESCRIPTORS ... most are static, but strings and (full) configuration
  454. * descriptors are built on demand. Also the (static) config and interface
  455. * descriptors are adjusted during fsg_bind().
  456. */
  457. /* There is only one configuration. */
  458. #define CONFIG_VALUE 1
  459. static struct usb_device_descriptor
  460. device_desc = {
  461. .bLength = sizeof device_desc,
  462. .bDescriptorType = USB_DT_DEVICE,
  463. .bcdUSB = cpu_to_le16(0x0200),
  464. .bDeviceClass = USB_CLASS_PER_INTERFACE,
  465. /* The next three values can be overridden by module parameters */
  466. .idVendor = cpu_to_le16(FSG_VENDOR_ID),
  467. .idProduct = cpu_to_le16(FSG_PRODUCT_ID),
  468. .bcdDevice = cpu_to_le16(0xffff),
  469. .iManufacturer = FSG_STRING_MANUFACTURER,
  470. .iProduct = FSG_STRING_PRODUCT,
  471. .iSerialNumber = FSG_STRING_SERIAL,
  472. .bNumConfigurations = 1,
  473. };
  474. static struct usb_config_descriptor
  475. config_desc = {
  476. .bLength = sizeof config_desc,
  477. .bDescriptorType = USB_DT_CONFIG,
  478. /* wTotalLength computed by usb_gadget_config_buf() */
  479. .bNumInterfaces = 1,
  480. .bConfigurationValue = CONFIG_VALUE,
  481. .iConfiguration = FSG_STRING_CONFIG,
  482. .bmAttributes = USB_CONFIG_ATT_ONE | USB_CONFIG_ATT_SELFPOWER,
  483. .bMaxPower = CONFIG_USB_GADGET_VBUS_DRAW / 2,
  484. };
  485. static struct usb_qualifier_descriptor
  486. dev_qualifier = {
  487. .bLength = sizeof dev_qualifier,
  488. .bDescriptorType = USB_DT_DEVICE_QUALIFIER,
  489. .bcdUSB = cpu_to_le16(0x0200),
  490. .bDeviceClass = USB_CLASS_PER_INTERFACE,
  491. .bNumConfigurations = 1,
  492. };
  493. /*
  494. * Config descriptors must agree with the code that sets configurations
  495. * and with code managing interfaces and their altsettings. They must
  496. * also handle different speeds and other-speed requests.
  497. */
  498. static int populate_config_buf(struct usb_gadget *gadget,
  499. u8 *buf, u8 type, unsigned index)
  500. {
  501. enum usb_device_speed speed = gadget->speed;
  502. int len;
  503. const struct usb_descriptor_header **function;
  504. if (index > 0)
  505. return -EINVAL;
  506. if (gadget_is_dualspeed(gadget) && type == USB_DT_OTHER_SPEED_CONFIG)
  507. speed = (USB_SPEED_FULL + USB_SPEED_HIGH) - speed;
  508. function = gadget_is_dualspeed(gadget) && speed == USB_SPEED_HIGH
  509. ? (const struct usb_descriptor_header **)fsg_hs_function
  510. : (const struct usb_descriptor_header **)fsg_fs_function;
  511. /* for now, don't advertise srp-only devices */
  512. if (!gadget_is_otg(gadget))
  513. function++;
  514. len = usb_gadget_config_buf(&config_desc, buf, EP0_BUFSIZE, function);
  515. ((struct usb_config_descriptor *) buf)->bDescriptorType = type;
  516. return len;
  517. }
  518. /*-------------------------------------------------------------------------*/
  519. /* These routines may be called in process context or in_irq */
  520. /* Caller must hold fsg->lock */
  521. static void wakeup_thread(struct fsg_dev *fsg)
  522. {
  523. /* Tell the main thread that something has happened */
  524. fsg->thread_wakeup_needed = 1;
  525. if (fsg->thread_task)
  526. wake_up_process(fsg->thread_task);
  527. }
  528. static void raise_exception(struct fsg_dev *fsg, enum fsg_state new_state)
  529. {
  530. unsigned long flags;
  531. /* Do nothing if a higher-priority exception is already in progress.
  532. * If a lower-or-equal priority exception is in progress, preempt it
  533. * and notify the main thread by sending it a signal. */
  534. spin_lock_irqsave(&fsg->lock, flags);
  535. if (fsg->state <= new_state) {
  536. fsg->exception_req_tag = fsg->ep0_req_tag;
  537. fsg->state = new_state;
  538. if (fsg->thread_task)
  539. send_sig_info(SIGUSR1, SEND_SIG_FORCED,
  540. fsg->thread_task);
  541. }
  542. spin_unlock_irqrestore(&fsg->lock, flags);
  543. }
  544. /*-------------------------------------------------------------------------*/
  545. /* The disconnect callback and ep0 routines. These always run in_irq,
  546. * except that ep0_queue() is called in the main thread to acknowledge
  547. * completion of various requests: set config, set interface, and
  548. * Bulk-only device reset. */
  549. static void fsg_disconnect(struct usb_gadget *gadget)
  550. {
  551. struct fsg_dev *fsg = get_gadget_data(gadget);
  552. DBG(fsg, "disconnect or port reset\n");
  553. raise_exception(fsg, FSG_STATE_DISCONNECT);
  554. }
  555. static int ep0_queue(struct fsg_dev *fsg)
  556. {
  557. int rc;
  558. rc = usb_ep_queue(fsg->ep0, fsg->ep0req, GFP_ATOMIC);
  559. if (rc != 0 && rc != -ESHUTDOWN) {
  560. /* We can't do much more than wait for a reset */
  561. WARNING(fsg, "error in submission: %s --> %d\n",
  562. fsg->ep0->name, rc);
  563. }
  564. return rc;
  565. }
  566. static void ep0_complete(struct usb_ep *ep, struct usb_request *req)
  567. {
  568. struct fsg_dev *fsg = ep->driver_data;
  569. if (req->actual > 0)
  570. dump_msg(fsg, fsg->ep0req_name, req->buf, req->actual);
  571. if (req->status || req->actual != req->length)
  572. DBG(fsg, "%s --> %d, %u/%u\n", __func__,
  573. req->status, req->actual, req->length);
  574. if (req->status == -ECONNRESET) // Request was cancelled
  575. usb_ep_fifo_flush(ep);
  576. if (req->status == 0 && req->context)
  577. ((fsg_routine_t) (req->context))(fsg);
  578. }
  579. /*-------------------------------------------------------------------------*/
  580. /* Bulk and interrupt endpoint completion handlers.
  581. * These always run in_irq. */
  582. static void bulk_in_complete(struct usb_ep *ep, struct usb_request *req)
  583. {
  584. struct fsg_dev *fsg = ep->driver_data;
  585. struct fsg_buffhd *bh = req->context;
  586. if (req->status || req->actual != req->length)
  587. DBG(fsg, "%s --> %d, %u/%u\n", __func__,
  588. req->status, req->actual, req->length);
  589. if (req->status == -ECONNRESET) // Request was cancelled
  590. usb_ep_fifo_flush(ep);
  591. /* Hold the lock while we update the request and buffer states */
  592. smp_wmb();
  593. spin_lock(&fsg->lock);
  594. bh->inreq_busy = 0;
  595. bh->state = BUF_STATE_EMPTY;
  596. wakeup_thread(fsg);
  597. spin_unlock(&fsg->lock);
  598. }
  599. static void bulk_out_complete(struct usb_ep *ep, struct usb_request *req)
  600. {
  601. struct fsg_dev *fsg = ep->driver_data;
  602. struct fsg_buffhd *bh = req->context;
  603. dump_msg(fsg, "bulk-out", req->buf, req->actual);
  604. if (req->status || req->actual != bh->bulk_out_intended_length)
  605. DBG(fsg, "%s --> %d, %u/%u\n", __func__,
  606. req->status, req->actual,
  607. bh->bulk_out_intended_length);
  608. if (req->status == -ECONNRESET) // Request was cancelled
  609. usb_ep_fifo_flush(ep);
  610. /* Hold the lock while we update the request and buffer states */
  611. smp_wmb();
  612. spin_lock(&fsg->lock);
  613. bh->outreq_busy = 0;
  614. bh->state = BUF_STATE_FULL;
  615. wakeup_thread(fsg);
  616. spin_unlock(&fsg->lock);
  617. }
  618. #ifdef CONFIG_USB_FILE_STORAGE_TEST
  619. static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
  620. {
  621. struct fsg_dev *fsg = ep->driver_data;
  622. struct fsg_buffhd *bh = req->context;
  623. if (req->status || req->actual != req->length)
  624. DBG(fsg, "%s --> %d, %u/%u\n", __func__,
  625. req->status, req->actual, req->length);
  626. if (req->status == -ECONNRESET) // Request was cancelled
  627. usb_ep_fifo_flush(ep);
  628. /* Hold the lock while we update the request and buffer states */
  629. smp_wmb();
  630. spin_lock(&fsg->lock);
  631. fsg->intreq_busy = 0;
  632. bh->state = BUF_STATE_EMPTY;
  633. wakeup_thread(fsg);
  634. spin_unlock(&fsg->lock);
  635. }
  636. #else
  637. static void intr_in_complete(struct usb_ep *ep, struct usb_request *req)
  638. {}
  639. #endif /* CONFIG_USB_FILE_STORAGE_TEST */
  640. /*-------------------------------------------------------------------------*/
  641. /* Ep0 class-specific handlers. These always run in_irq. */
  642. #ifdef CONFIG_USB_FILE_STORAGE_TEST
  643. static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  644. {
  645. struct usb_request *req = fsg->ep0req;
  646. static u8 cbi_reset_cmnd[6] = {
  647. SEND_DIAGNOSTIC, 4, 0xff, 0xff, 0xff, 0xff};
  648. /* Error in command transfer? */
  649. if (req->status || req->length != req->actual ||
  650. req->actual < 6 || req->actual > MAX_COMMAND_SIZE) {
  651. /* Not all controllers allow a protocol stall after
  652. * receiving control-out data, but we'll try anyway. */
  653. fsg_set_halt(fsg, fsg->ep0);
  654. return; // Wait for reset
  655. }
  656. /* Is it the special reset command? */
  657. if (req->actual >= sizeof cbi_reset_cmnd &&
  658. memcmp(req->buf, cbi_reset_cmnd,
  659. sizeof cbi_reset_cmnd) == 0) {
  660. /* Raise an exception to stop the current operation
  661. * and reinitialize our state. */
  662. DBG(fsg, "cbi reset request\n");
  663. raise_exception(fsg, FSG_STATE_RESET);
  664. return;
  665. }
  666. VDBG(fsg, "CB[I] accept device-specific command\n");
  667. spin_lock(&fsg->lock);
  668. /* Save the command for later */
  669. if (fsg->cbbuf_cmnd_size)
  670. WARNING(fsg, "CB[I] overwriting previous command\n");
  671. fsg->cbbuf_cmnd_size = req->actual;
  672. memcpy(fsg->cbbuf_cmnd, req->buf, fsg->cbbuf_cmnd_size);
  673. wakeup_thread(fsg);
  674. spin_unlock(&fsg->lock);
  675. }
  676. #else
  677. static void received_cbi_adsc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  678. {}
  679. #endif /* CONFIG_USB_FILE_STORAGE_TEST */
  680. static int class_setup_req(struct fsg_dev *fsg,
  681. const struct usb_ctrlrequest *ctrl)
  682. {
  683. struct usb_request *req = fsg->ep0req;
  684. int value = -EOPNOTSUPP;
  685. u16 w_index = le16_to_cpu(ctrl->wIndex);
  686. u16 w_value = le16_to_cpu(ctrl->wValue);
  687. u16 w_length = le16_to_cpu(ctrl->wLength);
  688. if (!fsg->config)
  689. return value;
  690. /* Handle Bulk-only class-specific requests */
  691. if (transport_is_bbb()) {
  692. switch (ctrl->bRequest) {
  693. case USB_BULK_RESET_REQUEST:
  694. if (ctrl->bRequestType != (USB_DIR_OUT |
  695. USB_TYPE_CLASS | USB_RECIP_INTERFACE))
  696. break;
  697. if (w_index != 0 || w_value != 0) {
  698. value = -EDOM;
  699. break;
  700. }
  701. /* Raise an exception to stop the current operation
  702. * and reinitialize our state. */
  703. DBG(fsg, "bulk reset request\n");
  704. raise_exception(fsg, FSG_STATE_RESET);
  705. value = DELAYED_STATUS;
  706. break;
  707. case USB_BULK_GET_MAX_LUN_REQUEST:
  708. if (ctrl->bRequestType != (USB_DIR_IN |
  709. USB_TYPE_CLASS | USB_RECIP_INTERFACE))
  710. break;
  711. if (w_index != 0 || w_value != 0) {
  712. value = -EDOM;
  713. break;
  714. }
  715. VDBG(fsg, "get max LUN\n");
  716. *(u8 *) req->buf = fsg->nluns - 1;
  717. value = 1;
  718. break;
  719. }
  720. }
  721. /* Handle CBI class-specific requests */
  722. else {
  723. switch (ctrl->bRequest) {
  724. case USB_CBI_ADSC_REQUEST:
  725. if (ctrl->bRequestType != (USB_DIR_OUT |
  726. USB_TYPE_CLASS | USB_RECIP_INTERFACE))
  727. break;
  728. if (w_index != 0 || w_value != 0) {
  729. value = -EDOM;
  730. break;
  731. }
  732. if (w_length > MAX_COMMAND_SIZE) {
  733. value = -EOVERFLOW;
  734. break;
  735. }
  736. value = w_length;
  737. fsg->ep0req->context = received_cbi_adsc;
  738. break;
  739. }
  740. }
  741. if (value == -EOPNOTSUPP)
  742. VDBG(fsg,
  743. "unknown class-specific control req "
  744. "%02x.%02x v%04x i%04x l%u\n",
  745. ctrl->bRequestType, ctrl->bRequest,
  746. le16_to_cpu(ctrl->wValue), w_index, w_length);
  747. return value;
  748. }
  749. /*-------------------------------------------------------------------------*/
  750. /* Ep0 standard request handlers. These always run in_irq. */
  751. static int standard_setup_req(struct fsg_dev *fsg,
  752. const struct usb_ctrlrequest *ctrl)
  753. {
  754. struct usb_request *req = fsg->ep0req;
  755. int value = -EOPNOTSUPP;
  756. u16 w_index = le16_to_cpu(ctrl->wIndex);
  757. u16 w_value = le16_to_cpu(ctrl->wValue);
  758. /* Usually this just stores reply data in the pre-allocated ep0 buffer,
  759. * but config change events will also reconfigure hardware. */
  760. switch (ctrl->bRequest) {
  761. case USB_REQ_GET_DESCRIPTOR:
  762. if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
  763. USB_RECIP_DEVICE))
  764. break;
  765. switch (w_value >> 8) {
  766. case USB_DT_DEVICE:
  767. VDBG(fsg, "get device descriptor\n");
  768. device_desc.bMaxPacketSize0 = fsg->ep0->maxpacket;
  769. value = sizeof device_desc;
  770. memcpy(req->buf, &device_desc, value);
  771. break;
  772. case USB_DT_DEVICE_QUALIFIER:
  773. VDBG(fsg, "get device qualifier\n");
  774. if (!gadget_is_dualspeed(fsg->gadget))
  775. break;
  776. /*
  777. * Assume ep0 uses the same maxpacket value for both
  778. * speeds
  779. */
  780. dev_qualifier.bMaxPacketSize0 = fsg->ep0->maxpacket;
  781. value = sizeof dev_qualifier;
  782. memcpy(req->buf, &dev_qualifier, value);
  783. break;
  784. case USB_DT_OTHER_SPEED_CONFIG:
  785. VDBG(fsg, "get other-speed config descriptor\n");
  786. if (!gadget_is_dualspeed(fsg->gadget))
  787. break;
  788. goto get_config;
  789. case USB_DT_CONFIG:
  790. VDBG(fsg, "get configuration descriptor\n");
  791. get_config:
  792. value = populate_config_buf(fsg->gadget,
  793. req->buf,
  794. w_value >> 8,
  795. w_value & 0xff);
  796. break;
  797. case USB_DT_STRING:
  798. VDBG(fsg, "get string descriptor\n");
  799. /* wIndex == language code */
  800. value = usb_gadget_get_string(&fsg_stringtab,
  801. w_value & 0xff, req->buf);
  802. break;
  803. }
  804. break;
  805. /* One config, two speeds */
  806. case USB_REQ_SET_CONFIGURATION:
  807. if (ctrl->bRequestType != (USB_DIR_OUT | USB_TYPE_STANDARD |
  808. USB_RECIP_DEVICE))
  809. break;
  810. VDBG(fsg, "set configuration\n");
  811. if (w_value == CONFIG_VALUE || w_value == 0) {
  812. fsg->new_config = w_value;
  813. /* Raise an exception to wipe out previous transaction
  814. * state (queued bufs, etc) and set the new config. */
  815. raise_exception(fsg, FSG_STATE_CONFIG_CHANGE);
  816. value = DELAYED_STATUS;
  817. }
  818. break;
  819. case USB_REQ_GET_CONFIGURATION:
  820. if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
  821. USB_RECIP_DEVICE))
  822. break;
  823. VDBG(fsg, "get configuration\n");
  824. *(u8 *) req->buf = fsg->config;
  825. value = 1;
  826. break;
  827. case USB_REQ_SET_INTERFACE:
  828. if (ctrl->bRequestType != (USB_DIR_OUT| USB_TYPE_STANDARD |
  829. USB_RECIP_INTERFACE))
  830. break;
  831. if (fsg->config && w_index == 0) {
  832. /* Raise an exception to wipe out previous transaction
  833. * state (queued bufs, etc) and install the new
  834. * interface altsetting. */
  835. raise_exception(fsg, FSG_STATE_INTERFACE_CHANGE);
  836. value = DELAYED_STATUS;
  837. }
  838. break;
  839. case USB_REQ_GET_INTERFACE:
  840. if (ctrl->bRequestType != (USB_DIR_IN | USB_TYPE_STANDARD |
  841. USB_RECIP_INTERFACE))
  842. break;
  843. if (!fsg->config)
  844. break;
  845. if (w_index != 0) {
  846. value = -EDOM;
  847. break;
  848. }
  849. VDBG(fsg, "get interface\n");
  850. *(u8 *) req->buf = 0;
  851. value = 1;
  852. break;
  853. default:
  854. VDBG(fsg,
  855. "unknown control req %02x.%02x v%04x i%04x l%u\n",
  856. ctrl->bRequestType, ctrl->bRequest,
  857. w_value, w_index, le16_to_cpu(ctrl->wLength));
  858. }
  859. return value;
  860. }
  861. static int fsg_setup(struct usb_gadget *gadget,
  862. const struct usb_ctrlrequest *ctrl)
  863. {
  864. struct fsg_dev *fsg = get_gadget_data(gadget);
  865. int rc;
  866. int w_length = le16_to_cpu(ctrl->wLength);
  867. ++fsg->ep0_req_tag; // Record arrival of a new request
  868. fsg->ep0req->context = NULL;
  869. fsg->ep0req->length = 0;
  870. dump_msg(fsg, "ep0-setup", (u8 *) ctrl, sizeof(*ctrl));
  871. if ((ctrl->bRequestType & USB_TYPE_MASK) == USB_TYPE_CLASS)
  872. rc = class_setup_req(fsg, ctrl);
  873. else
  874. rc = standard_setup_req(fsg, ctrl);
  875. /* Respond with data/status or defer until later? */
  876. if (rc >= 0 && rc != DELAYED_STATUS) {
  877. rc = min(rc, w_length);
  878. fsg->ep0req->length = rc;
  879. fsg->ep0req->zero = rc < w_length;
  880. fsg->ep0req_name = (ctrl->bRequestType & USB_DIR_IN ?
  881. "ep0-in" : "ep0-out");
  882. rc = ep0_queue(fsg);
  883. }
  884. /* Device either stalls (rc < 0) or reports success */
  885. return rc;
  886. }
  887. /*-------------------------------------------------------------------------*/
  888. /* All the following routines run in process context */
  889. /* Use this for bulk or interrupt transfers, not ep0 */
  890. static void start_transfer(struct fsg_dev *fsg, struct usb_ep *ep,
  891. struct usb_request *req, int *pbusy,
  892. enum fsg_buffer_state *state)
  893. {
  894. int rc;
  895. if (ep == fsg->bulk_in)
  896. dump_msg(fsg, "bulk-in", req->buf, req->length);
  897. else if (ep == fsg->intr_in)
  898. dump_msg(fsg, "intr-in", req->buf, req->length);
  899. spin_lock_irq(&fsg->lock);
  900. *pbusy = 1;
  901. *state = BUF_STATE_BUSY;
  902. spin_unlock_irq(&fsg->lock);
  903. rc = usb_ep_queue(ep, req, GFP_KERNEL);
  904. if (rc != 0) {
  905. *pbusy = 0;
  906. *state = BUF_STATE_EMPTY;
  907. /* We can't do much more than wait for a reset */
  908. /* Note: currently the net2280 driver fails zero-length
  909. * submissions if DMA is enabled. */
  910. if (rc != -ESHUTDOWN && !(rc == -EOPNOTSUPP &&
  911. req->length == 0))
  912. WARNING(fsg, "error in submission: %s --> %d\n",
  913. ep->name, rc);
  914. }
  915. }
  916. static int sleep_thread(struct fsg_dev *fsg)
  917. {
  918. int rc = 0;
  919. /* Wait until a signal arrives or we are woken up */
  920. for (;;) {
  921. try_to_freeze();
  922. set_current_state(TASK_INTERRUPTIBLE);
  923. if (signal_pending(current)) {
  924. rc = -EINTR;
  925. break;
  926. }
  927. if (fsg->thread_wakeup_needed)
  928. break;
  929. schedule();
  930. }
  931. __set_current_state(TASK_RUNNING);
  932. fsg->thread_wakeup_needed = 0;
  933. return rc;
  934. }
  935. /*-------------------------------------------------------------------------*/
  936. static int do_read(struct fsg_dev *fsg)
  937. {
  938. struct fsg_lun *curlun = fsg->curlun;
  939. u32 lba;
  940. struct fsg_buffhd *bh;
  941. int rc;
  942. u32 amount_left;
  943. loff_t file_offset, file_offset_tmp;
  944. unsigned int amount;
  945. ssize_t nread;
  946. /* Get the starting Logical Block Address and check that it's
  947. * not too big */
  948. if (fsg->cmnd[0] == READ_6)
  949. lba = get_unaligned_be24(&fsg->cmnd[1]);
  950. else {
  951. lba = get_unaligned_be32(&fsg->cmnd[2]);
  952. /* We allow DPO (Disable Page Out = don't save data in the
  953. * cache) and FUA (Force Unit Access = don't read from the
  954. * cache), but we don't implement them. */
  955. if ((fsg->cmnd[1] & ~0x18) != 0) {
  956. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  957. return -EINVAL;
  958. }
  959. }
  960. if (lba >= curlun->num_sectors) {
  961. curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  962. return -EINVAL;
  963. }
  964. file_offset = ((loff_t) lba) << curlun->blkbits;
  965. /* Carry out the file reads */
  966. amount_left = fsg->data_size_from_cmnd;
  967. if (unlikely(amount_left == 0))
  968. return -EIO; // No default reply
  969. for (;;) {
  970. /* Figure out how much we need to read:
  971. * Try to read the remaining amount.
  972. * But don't read more than the buffer size.
  973. * And don't try to read past the end of the file.
  974. */
  975. amount = min((unsigned int) amount_left, mod_data.buflen);
  976. amount = min((loff_t) amount,
  977. curlun->file_length - file_offset);
  978. /* Wait for the next buffer to become available */
  979. bh = fsg->next_buffhd_to_fill;
  980. while (bh->state != BUF_STATE_EMPTY) {
  981. rc = sleep_thread(fsg);
  982. if (rc)
  983. return rc;
  984. }
  985. /* If we were asked to read past the end of file,
  986. * end with an empty buffer. */
  987. if (amount == 0) {
  988. curlun->sense_data =
  989. SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  990. curlun->sense_data_info = file_offset >> curlun->blkbits;
  991. curlun->info_valid = 1;
  992. bh->inreq->length = 0;
  993. bh->state = BUF_STATE_FULL;
  994. break;
  995. }
  996. /* Perform the read */
  997. file_offset_tmp = file_offset;
  998. nread = vfs_read(curlun->filp,
  999. (char __user *) bh->buf,
  1000. amount, &file_offset_tmp);
  1001. VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
  1002. (unsigned long long) file_offset,
  1003. (int) nread);
  1004. if (signal_pending(current))
  1005. return -EINTR;
  1006. if (nread < 0) {
  1007. LDBG(curlun, "error in file read: %d\n",
  1008. (int) nread);
  1009. nread = 0;
  1010. } else if (nread < amount) {
  1011. LDBG(curlun, "partial file read: %d/%u\n",
  1012. (int) nread, amount);
  1013. nread = round_down(nread, curlun->blksize);
  1014. }
  1015. file_offset += nread;
  1016. amount_left -= nread;
  1017. fsg->residue -= nread;
  1018. /* Except at the end of the transfer, nread will be
  1019. * equal to the buffer size, which is divisible by the
  1020. * bulk-in maxpacket size.
  1021. */
  1022. bh->inreq->length = nread;
  1023. bh->state = BUF_STATE_FULL;
  1024. /* If an error occurred, report it and its position */
  1025. if (nread < amount) {
  1026. curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
  1027. curlun->sense_data_info = file_offset >> curlun->blkbits;
  1028. curlun->info_valid = 1;
  1029. break;
  1030. }
  1031. if (amount_left == 0)
  1032. break; // No more left to read
  1033. /* Send this buffer and go read some more */
  1034. bh->inreq->zero = 0;
  1035. start_transfer(fsg, fsg->bulk_in, bh->inreq,
  1036. &bh->inreq_busy, &bh->state);
  1037. fsg->next_buffhd_to_fill = bh->next;
  1038. }
  1039. return -EIO; // No default reply
  1040. }
  1041. /*-------------------------------------------------------------------------*/
  1042. static int do_write(struct fsg_dev *fsg)
  1043. {
  1044. struct fsg_lun *curlun = fsg->curlun;
  1045. u32 lba;
  1046. struct fsg_buffhd *bh;
  1047. int get_some_more;
  1048. u32 amount_left_to_req, amount_left_to_write;
  1049. loff_t usb_offset, file_offset, file_offset_tmp;
  1050. unsigned int amount;
  1051. ssize_t nwritten;
  1052. int rc;
  1053. if (curlun->ro) {
  1054. curlun->sense_data = SS_WRITE_PROTECTED;
  1055. return -EINVAL;
  1056. }
  1057. spin_lock(&curlun->filp->f_lock);
  1058. curlun->filp->f_flags &= ~O_SYNC; // Default is not to wait
  1059. spin_unlock(&curlun->filp->f_lock);
  1060. /* Get the starting Logical Block Address and check that it's
  1061. * not too big */
  1062. if (fsg->cmnd[0] == WRITE_6)
  1063. lba = get_unaligned_be24(&fsg->cmnd[1]);
  1064. else {
  1065. lba = get_unaligned_be32(&fsg->cmnd[2]);
  1066. /* We allow DPO (Disable Page Out = don't save data in the
  1067. * cache) and FUA (Force Unit Access = write directly to the
  1068. * medium). We don't implement DPO; we implement FUA by
  1069. * performing synchronous output. */
  1070. if ((fsg->cmnd[1] & ~0x18) != 0) {
  1071. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1072. return -EINVAL;
  1073. }
  1074. /* FUA */
  1075. if (!curlun->nofua && (fsg->cmnd[1] & 0x08)) {
  1076. spin_lock(&curlun->filp->f_lock);
  1077. curlun->filp->f_flags |= O_DSYNC;
  1078. spin_unlock(&curlun->filp->f_lock);
  1079. }
  1080. }
  1081. if (lba >= curlun->num_sectors) {
  1082. curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  1083. return -EINVAL;
  1084. }
  1085. /* Carry out the file writes */
  1086. get_some_more = 1;
  1087. file_offset = usb_offset = ((loff_t) lba) << curlun->blkbits;
  1088. amount_left_to_req = amount_left_to_write = fsg->data_size_from_cmnd;
  1089. while (amount_left_to_write > 0) {
  1090. /* Queue a request for more data from the host */
  1091. bh = fsg->next_buffhd_to_fill;
  1092. if (bh->state == BUF_STATE_EMPTY && get_some_more) {
  1093. /* Figure out how much we want to get:
  1094. * Try to get the remaining amount,
  1095. * but not more than the buffer size.
  1096. */
  1097. amount = min(amount_left_to_req, mod_data.buflen);
  1098. /* Beyond the end of the backing file? */
  1099. if (usb_offset >= curlun->file_length) {
  1100. get_some_more = 0;
  1101. curlun->sense_data =
  1102. SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  1103. curlun->sense_data_info = usb_offset >> curlun->blkbits;
  1104. curlun->info_valid = 1;
  1105. continue;
  1106. }
  1107. /* Get the next buffer */
  1108. usb_offset += amount;
  1109. fsg->usb_amount_left -= amount;
  1110. amount_left_to_req -= amount;
  1111. if (amount_left_to_req == 0)
  1112. get_some_more = 0;
  1113. /* Except at the end of the transfer, amount will be
  1114. * equal to the buffer size, which is divisible by
  1115. * the bulk-out maxpacket size.
  1116. */
  1117. set_bulk_out_req_length(fsg, bh, amount);
  1118. start_transfer(fsg, fsg->bulk_out, bh->outreq,
  1119. &bh->outreq_busy, &bh->state);
  1120. fsg->next_buffhd_to_fill = bh->next;
  1121. continue;
  1122. }
  1123. /* Write the received data to the backing file */
  1124. bh = fsg->next_buffhd_to_drain;
  1125. if (bh->state == BUF_STATE_EMPTY && !get_some_more)
  1126. break; // We stopped early
  1127. if (bh->state == BUF_STATE_FULL) {
  1128. smp_rmb();
  1129. fsg->next_buffhd_to_drain = bh->next;
  1130. bh->state = BUF_STATE_EMPTY;
  1131. /* Did something go wrong with the transfer? */
  1132. if (bh->outreq->status != 0) {
  1133. curlun->sense_data = SS_COMMUNICATION_FAILURE;
  1134. curlun->sense_data_info = file_offset >> curlun->blkbits;
  1135. curlun->info_valid = 1;
  1136. break;
  1137. }
  1138. amount = bh->outreq->actual;
  1139. if (curlun->file_length - file_offset < amount) {
  1140. LERROR(curlun,
  1141. "write %u @ %llu beyond end %llu\n",
  1142. amount, (unsigned long long) file_offset,
  1143. (unsigned long long) curlun->file_length);
  1144. amount = curlun->file_length - file_offset;
  1145. }
  1146. /* Don't accept excess data. The spec doesn't say
  1147. * what to do in this case. We'll ignore the error.
  1148. */
  1149. amount = min(amount, bh->bulk_out_intended_length);
  1150. /* Don't write a partial block */
  1151. amount = round_down(amount, curlun->blksize);
  1152. if (amount == 0)
  1153. goto empty_write;
  1154. /* Perform the write */
  1155. file_offset_tmp = file_offset;
  1156. nwritten = vfs_write(curlun->filp,
  1157. (char __user *) bh->buf,
  1158. amount, &file_offset_tmp);
  1159. VLDBG(curlun, "file write %u @ %llu -> %d\n", amount,
  1160. (unsigned long long) file_offset,
  1161. (int) nwritten);
  1162. if (signal_pending(current))
  1163. return -EINTR; // Interrupted!
  1164. if (nwritten < 0) {
  1165. LDBG(curlun, "error in file write: %d\n",
  1166. (int) nwritten);
  1167. nwritten = 0;
  1168. } else if (nwritten < amount) {
  1169. LDBG(curlun, "partial file write: %d/%u\n",
  1170. (int) nwritten, amount);
  1171. nwritten = round_down(nwritten, curlun->blksize);
  1172. }
  1173. file_offset += nwritten;
  1174. amount_left_to_write -= nwritten;
  1175. fsg->residue -= nwritten;
  1176. /* If an error occurred, report it and its position */
  1177. if (nwritten < amount) {
  1178. curlun->sense_data = SS_WRITE_ERROR;
  1179. curlun->sense_data_info = file_offset >> curlun->blkbits;
  1180. curlun->info_valid = 1;
  1181. break;
  1182. }
  1183. empty_write:
  1184. /* Did the host decide to stop early? */
  1185. if (bh->outreq->actual < bh->bulk_out_intended_length) {
  1186. fsg->short_packet_received = 1;
  1187. break;
  1188. }
  1189. continue;
  1190. }
  1191. /* Wait for something to happen */
  1192. rc = sleep_thread(fsg);
  1193. if (rc)
  1194. return rc;
  1195. }
  1196. return -EIO; // No default reply
  1197. }
  1198. /*-------------------------------------------------------------------------*/
  1199. static int do_synchronize_cache(struct fsg_dev *fsg)
  1200. {
  1201. struct fsg_lun *curlun = fsg->curlun;
  1202. int rc;
  1203. /* We ignore the requested LBA and write out all file's
  1204. * dirty data buffers. */
  1205. rc = fsg_lun_fsync_sub(curlun);
  1206. if (rc)
  1207. curlun->sense_data = SS_WRITE_ERROR;
  1208. return 0;
  1209. }
  1210. /*-------------------------------------------------------------------------*/
  1211. static void invalidate_sub(struct fsg_lun *curlun)
  1212. {
  1213. struct file *filp = curlun->filp;
  1214. struct inode *inode = filp->f_path.dentry->d_inode;
  1215. unsigned long rc;
  1216. rc = invalidate_mapping_pages(inode->i_mapping, 0, -1);
  1217. VLDBG(curlun, "invalidate_mapping_pages -> %ld\n", rc);
  1218. }
  1219. static int do_verify(struct fsg_dev *fsg)
  1220. {
  1221. struct fsg_lun *curlun = fsg->curlun;
  1222. u32 lba;
  1223. u32 verification_length;
  1224. struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
  1225. loff_t file_offset, file_offset_tmp;
  1226. u32 amount_left;
  1227. unsigned int amount;
  1228. ssize_t nread;
  1229. /* Get the starting Logical Block Address and check that it's
  1230. * not too big */
  1231. lba = get_unaligned_be32(&fsg->cmnd[2]);
  1232. if (lba >= curlun->num_sectors) {
  1233. curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  1234. return -EINVAL;
  1235. }
  1236. /* We allow DPO (Disable Page Out = don't save data in the
  1237. * cache) but we don't implement it. */
  1238. if ((fsg->cmnd[1] & ~0x10) != 0) {
  1239. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1240. return -EINVAL;
  1241. }
  1242. verification_length = get_unaligned_be16(&fsg->cmnd[7]);
  1243. if (unlikely(verification_length == 0))
  1244. return -EIO; // No default reply
  1245. /* Prepare to carry out the file verify */
  1246. amount_left = verification_length << curlun->blkbits;
  1247. file_offset = ((loff_t) lba) << curlun->blkbits;
  1248. /* Write out all the dirty buffers before invalidating them */
  1249. fsg_lun_fsync_sub(curlun);
  1250. if (signal_pending(current))
  1251. return -EINTR;
  1252. invalidate_sub(curlun);
  1253. if (signal_pending(current))
  1254. return -EINTR;
  1255. /* Just try to read the requested blocks */
  1256. while (amount_left > 0) {
  1257. /* Figure out how much we need to read:
  1258. * Try to read the remaining amount, but not more than
  1259. * the buffer size.
  1260. * And don't try to read past the end of the file.
  1261. */
  1262. amount = min((unsigned int) amount_left, mod_data.buflen);
  1263. amount = min((loff_t) amount,
  1264. curlun->file_length - file_offset);
  1265. if (amount == 0) {
  1266. curlun->sense_data =
  1267. SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  1268. curlun->sense_data_info = file_offset >> curlun->blkbits;
  1269. curlun->info_valid = 1;
  1270. break;
  1271. }
  1272. /* Perform the read */
  1273. file_offset_tmp = file_offset;
  1274. nread = vfs_read(curlun->filp,
  1275. (char __user *) bh->buf,
  1276. amount, &file_offset_tmp);
  1277. VLDBG(curlun, "file read %u @ %llu -> %d\n", amount,
  1278. (unsigned long long) file_offset,
  1279. (int) nread);
  1280. if (signal_pending(current))
  1281. return -EINTR;
  1282. if (nread < 0) {
  1283. LDBG(curlun, "error in file verify: %d\n",
  1284. (int) nread);
  1285. nread = 0;
  1286. } else if (nread < amount) {
  1287. LDBG(curlun, "partial file verify: %d/%u\n",
  1288. (int) nread, amount);
  1289. nread = round_down(nread, curlun->blksize);
  1290. }
  1291. if (nread == 0) {
  1292. curlun->sense_data = SS_UNRECOVERED_READ_ERROR;
  1293. curlun->sense_data_info = file_offset >> curlun->blkbits;
  1294. curlun->info_valid = 1;
  1295. break;
  1296. }
  1297. file_offset += nread;
  1298. amount_left -= nread;
  1299. }
  1300. return 0;
  1301. }
  1302. /*-------------------------------------------------------------------------*/
  1303. static int do_inquiry(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1304. {
  1305. u8 *buf = (u8 *) bh->buf;
  1306. static char vendor_id[] = "Linux ";
  1307. static char product_disk_id[] = "File-Stor Gadget";
  1308. static char product_cdrom_id[] = "File-CD Gadget ";
  1309. if (!fsg->curlun) { // Unsupported LUNs are okay
  1310. fsg->bad_lun_okay = 1;
  1311. memset(buf, 0, 36);
  1312. buf[0] = 0x7f; // Unsupported, no device-type
  1313. buf[4] = 31; // Additional length
  1314. return 36;
  1315. }
  1316. memset(buf, 0, 8);
  1317. buf[0] = (mod_data.cdrom ? TYPE_ROM : TYPE_DISK);
  1318. if (mod_data.removable)
  1319. buf[1] = 0x80;
  1320. buf[2] = 2; // ANSI SCSI level 2
  1321. buf[3] = 2; // SCSI-2 INQUIRY data format
  1322. buf[4] = 31; // Additional length
  1323. // No special options
  1324. sprintf(buf + 8, "%-8s%-16s%04x", vendor_id,
  1325. (mod_data.cdrom ? product_cdrom_id :
  1326. product_disk_id),
  1327. mod_data.release);
  1328. return 36;
  1329. }
  1330. static int do_request_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1331. {
  1332. struct fsg_lun *curlun = fsg->curlun;
  1333. u8 *buf = (u8 *) bh->buf;
  1334. u32 sd, sdinfo;
  1335. int valid;
  1336. /*
  1337. * From the SCSI-2 spec., section 7.9 (Unit attention condition):
  1338. *
  1339. * If a REQUEST SENSE command is received from an initiator
  1340. * with a pending unit attention condition (before the target
  1341. * generates the contingent allegiance condition), then the
  1342. * target shall either:
  1343. * a) report any pending sense data and preserve the unit
  1344. * attention condition on the logical unit, or,
  1345. * b) report the unit attention condition, may discard any
  1346. * pending sense data, and clear the unit attention
  1347. * condition on the logical unit for that initiator.
  1348. *
  1349. * FSG normally uses option a); enable this code to use option b).
  1350. */
  1351. #if 0
  1352. if (curlun && curlun->unit_attention_data != SS_NO_SENSE) {
  1353. curlun->sense_data = curlun->unit_attention_data;
  1354. curlun->unit_attention_data = SS_NO_SENSE;
  1355. }
  1356. #endif
  1357. if (!curlun) { // Unsupported LUNs are okay
  1358. fsg->bad_lun_okay = 1;
  1359. sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
  1360. sdinfo = 0;
  1361. valid = 0;
  1362. } else {
  1363. sd = curlun->sense_data;
  1364. sdinfo = curlun->sense_data_info;
  1365. valid = curlun->info_valid << 7;
  1366. curlun->sense_data = SS_NO_SENSE;
  1367. curlun->sense_data_info = 0;
  1368. curlun->info_valid = 0;
  1369. }
  1370. memset(buf, 0, 18);
  1371. buf[0] = valid | 0x70; // Valid, current error
  1372. buf[2] = SK(sd);
  1373. put_unaligned_be32(sdinfo, &buf[3]); /* Sense information */
  1374. buf[7] = 18 - 8; // Additional sense length
  1375. buf[12] = ASC(sd);
  1376. buf[13] = ASCQ(sd);
  1377. return 18;
  1378. }
  1379. static int do_read_capacity(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1380. {
  1381. struct fsg_lun *curlun = fsg->curlun;
  1382. u32 lba = get_unaligned_be32(&fsg->cmnd[2]);
  1383. int pmi = fsg->cmnd[8];
  1384. u8 *buf = (u8 *) bh->buf;
  1385. /* Check the PMI and LBA fields */
  1386. if (pmi > 1 || (pmi == 0 && lba != 0)) {
  1387. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1388. return -EINVAL;
  1389. }
  1390. put_unaligned_be32(curlun->num_sectors - 1, &buf[0]);
  1391. /* Max logical block */
  1392. put_unaligned_be32(curlun->blksize, &buf[4]); /* Block length */
  1393. return 8;
  1394. }
  1395. static int do_read_header(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1396. {
  1397. struct fsg_lun *curlun = fsg->curlun;
  1398. int msf = fsg->cmnd[1] & 0x02;
  1399. u32 lba = get_unaligned_be32(&fsg->cmnd[2]);
  1400. u8 *buf = (u8 *) bh->buf;
  1401. if ((fsg->cmnd[1] & ~0x02) != 0) { /* Mask away MSF */
  1402. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1403. return -EINVAL;
  1404. }
  1405. if (lba >= curlun->num_sectors) {
  1406. curlun->sense_data = SS_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE;
  1407. return -EINVAL;
  1408. }
  1409. memset(buf, 0, 8);
  1410. buf[0] = 0x01; /* 2048 bytes of user data, rest is EC */
  1411. store_cdrom_address(&buf[4], msf, lba);
  1412. return 8;
  1413. }
  1414. static int do_read_toc(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1415. {
  1416. struct fsg_lun *curlun = fsg->curlun;
  1417. int msf = fsg->cmnd[1] & 0x02;
  1418. int start_track = fsg->cmnd[6];
  1419. u8 *buf = (u8 *) bh->buf;
  1420. if ((fsg->cmnd[1] & ~0x02) != 0 || /* Mask away MSF */
  1421. start_track > 1) {
  1422. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1423. return -EINVAL;
  1424. }
  1425. memset(buf, 0, 20);
  1426. buf[1] = (20-2); /* TOC data length */
  1427. buf[2] = 1; /* First track number */
  1428. buf[3] = 1; /* Last track number */
  1429. buf[5] = 0x16; /* Data track, copying allowed */
  1430. buf[6] = 0x01; /* Only track is number 1 */
  1431. store_cdrom_address(&buf[8], msf, 0);
  1432. buf[13] = 0x16; /* Lead-out track is data */
  1433. buf[14] = 0xAA; /* Lead-out track number */
  1434. store_cdrom_address(&buf[16], msf, curlun->num_sectors);
  1435. return 20;
  1436. }
  1437. static int do_mode_sense(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1438. {
  1439. struct fsg_lun *curlun = fsg->curlun;
  1440. int mscmnd = fsg->cmnd[0];
  1441. u8 *buf = (u8 *) bh->buf;
  1442. u8 *buf0 = buf;
  1443. int pc, page_code;
  1444. int changeable_values, all_pages;
  1445. int valid_page = 0;
  1446. int len, limit;
  1447. if ((fsg->cmnd[1] & ~0x08) != 0) { // Mask away DBD
  1448. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1449. return -EINVAL;
  1450. }
  1451. pc = fsg->cmnd[2] >> 6;
  1452. page_code = fsg->cmnd[2] & 0x3f;
  1453. if (pc == 3) {
  1454. curlun->sense_data = SS_SAVING_PARAMETERS_NOT_SUPPORTED;
  1455. return -EINVAL;
  1456. }
  1457. changeable_values = (pc == 1);
  1458. all_pages = (page_code == 0x3f);
  1459. /* Write the mode parameter header. Fixed values are: default
  1460. * medium type, no cache control (DPOFUA), and no block descriptors.
  1461. * The only variable value is the WriteProtect bit. We will fill in
  1462. * the mode data length later. */
  1463. memset(buf, 0, 8);
  1464. if (mscmnd == MODE_SENSE) {
  1465. buf[2] = (curlun->ro ? 0x80 : 0x00); // WP, DPOFUA
  1466. buf += 4;
  1467. limit = 255;
  1468. } else { // MODE_SENSE_10
  1469. buf[3] = (curlun->ro ? 0x80 : 0x00); // WP, DPOFUA
  1470. buf += 8;
  1471. limit = 65535; // Should really be mod_data.buflen
  1472. }
  1473. /* No block descriptors */
  1474. /* The mode pages, in numerical order. The only page we support
  1475. * is the Caching page. */
  1476. if (page_code == 0x08 || all_pages) {
  1477. valid_page = 1;
  1478. buf[0] = 0x08; // Page code
  1479. buf[1] = 10; // Page length
  1480. memset(buf+2, 0, 10); // None of the fields are changeable
  1481. if (!changeable_values) {
  1482. buf[2] = 0x04; // Write cache enable,
  1483. // Read cache not disabled
  1484. // No cache retention priorities
  1485. put_unaligned_be16(0xffff, &buf[4]);
  1486. /* Don't disable prefetch */
  1487. /* Minimum prefetch = 0 */
  1488. put_unaligned_be16(0xffff, &buf[8]);
  1489. /* Maximum prefetch */
  1490. put_unaligned_be16(0xffff, &buf[10]);
  1491. /* Maximum prefetch ceiling */
  1492. }
  1493. buf += 12;
  1494. }
  1495. /* Check that a valid page was requested and the mode data length
  1496. * isn't too long. */
  1497. len = buf - buf0;
  1498. if (!valid_page || len > limit) {
  1499. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1500. return -EINVAL;
  1501. }
  1502. /* Store the mode data length */
  1503. if (mscmnd == MODE_SENSE)
  1504. buf0[0] = len - 1;
  1505. else
  1506. put_unaligned_be16(len - 2, buf0);
  1507. return len;
  1508. }
  1509. static int do_start_stop(struct fsg_dev *fsg)
  1510. {
  1511. struct fsg_lun *curlun = fsg->curlun;
  1512. int loej, start;
  1513. if (!mod_data.removable) {
  1514. curlun->sense_data = SS_INVALID_COMMAND;
  1515. return -EINVAL;
  1516. }
  1517. // int immed = fsg->cmnd[1] & 0x01;
  1518. loej = fsg->cmnd[4] & 0x02;
  1519. start = fsg->cmnd[4] & 0x01;
  1520. #ifdef CONFIG_USB_FILE_STORAGE_TEST
  1521. if ((fsg->cmnd[1] & ~0x01) != 0 || // Mask away Immed
  1522. (fsg->cmnd[4] & ~0x03) != 0) { // Mask LoEj, Start
  1523. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1524. return -EINVAL;
  1525. }
  1526. if (!start) {
  1527. /* Are we allowed to unload the media? */
  1528. if (curlun->prevent_medium_removal) {
  1529. LDBG(curlun, "unload attempt prevented\n");
  1530. curlun->sense_data = SS_MEDIUM_REMOVAL_PREVENTED;
  1531. return -EINVAL;
  1532. }
  1533. if (loej) { // Simulate an unload/eject
  1534. up_read(&fsg->filesem);
  1535. down_write(&fsg->filesem);
  1536. fsg_lun_close(curlun);
  1537. up_write(&fsg->filesem);
  1538. down_read(&fsg->filesem);
  1539. }
  1540. } else {
  1541. /* Our emulation doesn't support mounting; the medium is
  1542. * available for use as soon as it is loaded. */
  1543. if (!fsg_lun_is_open(curlun)) {
  1544. curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
  1545. return -EINVAL;
  1546. }
  1547. }
  1548. #endif
  1549. return 0;
  1550. }
  1551. static int do_prevent_allow(struct fsg_dev *fsg)
  1552. {
  1553. struct fsg_lun *curlun = fsg->curlun;
  1554. int prevent;
  1555. if (!mod_data.removable) {
  1556. curlun->sense_data = SS_INVALID_COMMAND;
  1557. return -EINVAL;
  1558. }
  1559. prevent = fsg->cmnd[4] & 0x01;
  1560. if ((fsg->cmnd[4] & ~0x01) != 0) { // Mask away Prevent
  1561. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1562. return -EINVAL;
  1563. }
  1564. if (curlun->prevent_medium_removal && !prevent)
  1565. fsg_lun_fsync_sub(curlun);
  1566. curlun->prevent_medium_removal = prevent;
  1567. return 0;
  1568. }
  1569. static int do_read_format_capacities(struct fsg_dev *fsg,
  1570. struct fsg_buffhd *bh)
  1571. {
  1572. struct fsg_lun *curlun = fsg->curlun;
  1573. u8 *buf = (u8 *) bh->buf;
  1574. buf[0] = buf[1] = buf[2] = 0;
  1575. buf[3] = 8; // Only the Current/Maximum Capacity Descriptor
  1576. buf += 4;
  1577. put_unaligned_be32(curlun->num_sectors, &buf[0]);
  1578. /* Number of blocks */
  1579. put_unaligned_be32(curlun->blksize, &buf[4]); /* Block length */
  1580. buf[4] = 0x02; /* Current capacity */
  1581. return 12;
  1582. }
  1583. static int do_mode_select(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  1584. {
  1585. struct fsg_lun *curlun = fsg->curlun;
  1586. /* We don't support MODE SELECT */
  1587. curlun->sense_data = SS_INVALID_COMMAND;
  1588. return -EINVAL;
  1589. }
  1590. /*-------------------------------------------------------------------------*/
  1591. static int halt_bulk_in_endpoint(struct fsg_dev *fsg)
  1592. {
  1593. int rc;
  1594. rc = fsg_set_halt(fsg, fsg->bulk_in);
  1595. if (rc == -EAGAIN)
  1596. VDBG(fsg, "delayed bulk-in endpoint halt\n");
  1597. while (rc != 0) {
  1598. if (rc != -EAGAIN) {
  1599. WARNING(fsg, "usb_ep_set_halt -> %d\n", rc);
  1600. rc = 0;
  1601. break;
  1602. }
  1603. /* Wait for a short time and then try again */
  1604. if (msleep_interruptible(100) != 0)
  1605. return -EINTR;
  1606. rc = usb_ep_set_halt(fsg->bulk_in);
  1607. }
  1608. return rc;
  1609. }
  1610. static int wedge_bulk_in_endpoint(struct fsg_dev *fsg)
  1611. {
  1612. int rc;
  1613. DBG(fsg, "bulk-in set wedge\n");
  1614. rc = usb_ep_set_wedge(fsg->bulk_in);
  1615. if (rc == -EAGAIN)
  1616. VDBG(fsg, "delayed bulk-in endpoint wedge\n");
  1617. while (rc != 0) {
  1618. if (rc != -EAGAIN) {
  1619. WARNING(fsg, "usb_ep_set_wedge -> %d\n", rc);
  1620. rc = 0;
  1621. break;
  1622. }
  1623. /* Wait for a short time and then try again */
  1624. if (msleep_interruptible(100) != 0)
  1625. return -EINTR;
  1626. rc = usb_ep_set_wedge(fsg->bulk_in);
  1627. }
  1628. return rc;
  1629. }
  1630. static int throw_away_data(struct fsg_dev *fsg)
  1631. {
  1632. struct fsg_buffhd *bh;
  1633. u32 amount;
  1634. int rc;
  1635. while ((bh = fsg->next_buffhd_to_drain)->state != BUF_STATE_EMPTY ||
  1636. fsg->usb_amount_left > 0) {
  1637. /* Throw away the data in a filled buffer */
  1638. if (bh->state == BUF_STATE_FULL) {
  1639. smp_rmb();
  1640. bh->state = BUF_STATE_EMPTY;
  1641. fsg->next_buffhd_to_drain = bh->next;
  1642. /* A short packet or an error ends everything */
  1643. if (bh->outreq->actual < bh->bulk_out_intended_length ||
  1644. bh->outreq->status != 0) {
  1645. raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
  1646. return -EINTR;
  1647. }
  1648. continue;
  1649. }
  1650. /* Try to submit another request if we need one */
  1651. bh = fsg->next_buffhd_to_fill;
  1652. if (bh->state == BUF_STATE_EMPTY && fsg->usb_amount_left > 0) {
  1653. amount = min(fsg->usb_amount_left,
  1654. (u32) mod_data.buflen);
  1655. /* Except at the end of the transfer, amount will be
  1656. * equal to the buffer size, which is divisible by
  1657. * the bulk-out maxpacket size.
  1658. */
  1659. set_bulk_out_req_length(fsg, bh, amount);
  1660. start_transfer(fsg, fsg->bulk_out, bh->outreq,
  1661. &bh->outreq_busy, &bh->state);
  1662. fsg->next_buffhd_to_fill = bh->next;
  1663. fsg->usb_amount_left -= amount;
  1664. continue;
  1665. }
  1666. /* Otherwise wait for something to happen */
  1667. rc = sleep_thread(fsg);
  1668. if (rc)
  1669. return rc;
  1670. }
  1671. return 0;
  1672. }
  1673. static int finish_reply(struct fsg_dev *fsg)
  1674. {
  1675. struct fsg_buffhd *bh = fsg->next_buffhd_to_fill;
  1676. int rc = 0;
  1677. switch (fsg->data_dir) {
  1678. case DATA_DIR_NONE:
  1679. break; // Nothing to send
  1680. /* If we don't know whether the host wants to read or write,
  1681. * this must be CB or CBI with an unknown command. We mustn't
  1682. * try to send or receive any data. So stall both bulk pipes
  1683. * if we can and wait for a reset. */
  1684. case DATA_DIR_UNKNOWN:
  1685. if (mod_data.can_stall) {
  1686. fsg_set_halt(fsg, fsg->bulk_out);
  1687. rc = halt_bulk_in_endpoint(fsg);
  1688. }
  1689. break;
  1690. /* All but the last buffer of data must have already been sent */
  1691. case DATA_DIR_TO_HOST:
  1692. if (fsg->data_size == 0)
  1693. ; // Nothing to send
  1694. /* If there's no residue, simply send the last buffer */
  1695. else if (fsg->residue == 0) {
  1696. bh->inreq->zero = 0;
  1697. start_transfer(fsg, fsg->bulk_in, bh->inreq,
  1698. &bh->inreq_busy, &bh->state);
  1699. fsg->next_buffhd_to_fill = bh->next;
  1700. }
  1701. /* There is a residue. For CB and CBI, simply mark the end
  1702. * of the data with a short packet. However, if we are
  1703. * allowed to stall, there was no data at all (residue ==
  1704. * data_size), and the command failed (invalid LUN or
  1705. * sense data is set), then halt the bulk-in endpoint
  1706. * instead. */
  1707. else if (!transport_is_bbb()) {
  1708. if (mod_data.can_stall &&
  1709. fsg->residue == fsg->data_size &&
  1710. (!fsg->curlun || fsg->curlun->sense_data != SS_NO_SENSE)) {
  1711. bh->state = BUF_STATE_EMPTY;
  1712. rc = halt_bulk_in_endpoint(fsg);
  1713. } else {
  1714. bh->inreq->zero = 1;
  1715. start_transfer(fsg, fsg->bulk_in, bh->inreq,
  1716. &bh->inreq_busy, &bh->state);
  1717. fsg->next_buffhd_to_fill = bh->next;
  1718. }
  1719. }
  1720. /*
  1721. * For Bulk-only, mark the end of the data with a short
  1722. * packet. If we are allowed to stall, halt the bulk-in
  1723. * endpoint. (Note: This violates the Bulk-Only Transport
  1724. * specification, which requires us to pad the data if we
  1725. * don't halt the endpoint. Presumably nobody will mind.)
  1726. */
  1727. else {
  1728. bh->inreq->zero = 1;
  1729. start_transfer(fsg, fsg->bulk_in, bh->inreq,
  1730. &bh->inreq_busy, &bh->state);
  1731. fsg->next_buffhd_to_fill = bh->next;
  1732. if (mod_data.can_stall)
  1733. rc = halt_bulk_in_endpoint(fsg);
  1734. }
  1735. break;
  1736. /* We have processed all we want from the data the host has sent.
  1737. * There may still be outstanding bulk-out requests. */
  1738. case DATA_DIR_FROM_HOST:
  1739. if (fsg->residue == 0)
  1740. ; // Nothing to receive
  1741. /* Did the host stop sending unexpectedly early? */
  1742. else if (fsg->short_packet_received) {
  1743. raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
  1744. rc = -EINTR;
  1745. }
  1746. /* We haven't processed all the incoming data. Even though
  1747. * we may be allowed to stall, doing so would cause a race.
  1748. * The controller may already have ACK'ed all the remaining
  1749. * bulk-out packets, in which case the host wouldn't see a
  1750. * STALL. Not realizing the endpoint was halted, it wouldn't
  1751. * clear the halt -- leading to problems later on. */
  1752. #if 0
  1753. else if (mod_data.can_stall) {
  1754. fsg_set_halt(fsg, fsg->bulk_out);
  1755. raise_exception(fsg, FSG_STATE_ABORT_BULK_OUT);
  1756. rc = -EINTR;
  1757. }
  1758. #endif
  1759. /* We can't stall. Read in the excess data and throw it
  1760. * all away. */
  1761. else
  1762. rc = throw_away_data(fsg);
  1763. break;
  1764. }
  1765. return rc;
  1766. }
  1767. static int send_status(struct fsg_dev *fsg)
  1768. {
  1769. struct fsg_lun *curlun = fsg->curlun;
  1770. struct fsg_buffhd *bh;
  1771. int rc;
  1772. u8 status = USB_STATUS_PASS;
  1773. u32 sd, sdinfo = 0;
  1774. /* Wait for the next buffer to become available */
  1775. bh = fsg->next_buffhd_to_fill;
  1776. while (bh->state != BUF_STATE_EMPTY) {
  1777. rc = sleep_thread(fsg);
  1778. if (rc)
  1779. return rc;
  1780. }
  1781. if (curlun) {
  1782. sd = curlun->sense_data;
  1783. sdinfo = curlun->sense_data_info;
  1784. } else if (fsg->bad_lun_okay)
  1785. sd = SS_NO_SENSE;
  1786. else
  1787. sd = SS_LOGICAL_UNIT_NOT_SUPPORTED;
  1788. if (fsg->phase_error) {
  1789. DBG(fsg, "sending phase-error status\n");
  1790. status = USB_STATUS_PHASE_ERROR;
  1791. sd = SS_INVALID_COMMAND;
  1792. } else if (sd != SS_NO_SENSE) {
  1793. DBG(fsg, "sending command-failure status\n");
  1794. status = USB_STATUS_FAIL;
  1795. VDBG(fsg, " sense data: SK x%02x, ASC x%02x, ASCQ x%02x;"
  1796. " info x%x\n",
  1797. SK(sd), ASC(sd), ASCQ(sd), sdinfo);
  1798. }
  1799. if (transport_is_bbb()) {
  1800. struct bulk_cs_wrap *csw = bh->buf;
  1801. /* Store and send the Bulk-only CSW */
  1802. csw->Signature = cpu_to_le32(USB_BULK_CS_SIG);
  1803. csw->Tag = fsg->tag;
  1804. csw->Residue = cpu_to_le32(fsg->residue);
  1805. csw->Status = status;
  1806. bh->inreq->length = USB_BULK_CS_WRAP_LEN;
  1807. bh->inreq->zero = 0;
  1808. start_transfer(fsg, fsg->bulk_in, bh->inreq,
  1809. &bh->inreq_busy, &bh->state);
  1810. } else if (mod_data.transport_type == USB_PR_CB) {
  1811. /* Control-Bulk transport has no status phase! */
  1812. return 0;
  1813. } else { // USB_PR_CBI
  1814. struct interrupt_data *buf = bh->buf;
  1815. /* Store and send the Interrupt data. UFI sends the ASC
  1816. * and ASCQ bytes. Everything else sends a Type (which
  1817. * is always 0) and the status Value. */
  1818. if (mod_data.protocol_type == USB_SC_UFI) {
  1819. buf->bType = ASC(sd);
  1820. buf->bValue = ASCQ(sd);
  1821. } else {
  1822. buf->bType = 0;
  1823. buf->bValue = status;
  1824. }
  1825. fsg->intreq->length = CBI_INTERRUPT_DATA_LEN;
  1826. fsg->intr_buffhd = bh; // Point to the right buffhd
  1827. fsg->intreq->buf = bh->inreq->buf;
  1828. fsg->intreq->context = bh;
  1829. start_transfer(fsg, fsg->intr_in, fsg->intreq,
  1830. &fsg->intreq_busy, &bh->state);
  1831. }
  1832. fsg->next_buffhd_to_fill = bh->next;
  1833. return 0;
  1834. }
  1835. /*-------------------------------------------------------------------------*/
  1836. /* Check whether the command is properly formed and whether its data size
  1837. * and direction agree with the values we already have. */
  1838. static int check_command(struct fsg_dev *fsg, int cmnd_size,
  1839. enum data_direction data_dir, unsigned int mask,
  1840. int needs_medium, const char *name)
  1841. {
  1842. int i;
  1843. int lun = fsg->cmnd[1] >> 5;
  1844. static const char dirletter[4] = {'u', 'o', 'i', 'n'};
  1845. char hdlen[20];
  1846. struct fsg_lun *curlun;
  1847. /* Adjust the expected cmnd_size for protocol encapsulation padding.
  1848. * Transparent SCSI doesn't pad. */
  1849. if (protocol_is_scsi())
  1850. ;
  1851. /* There's some disagreement as to whether RBC pads commands or not.
  1852. * We'll play it safe and accept either form. */
  1853. else if (mod_data.protocol_type == USB_SC_RBC) {
  1854. if (fsg->cmnd_size == 12)
  1855. cmnd_size = 12;
  1856. /* All the other protocols pad to 12 bytes */
  1857. } else
  1858. cmnd_size = 12;
  1859. hdlen[0] = 0;
  1860. if (fsg->data_dir != DATA_DIR_UNKNOWN)
  1861. sprintf(hdlen, ", H%c=%u", dirletter[(int) fsg->data_dir],
  1862. fsg->data_size);
  1863. VDBG(fsg, "SCSI command: %s; Dc=%d, D%c=%u; Hc=%d%s\n",
  1864. name, cmnd_size, dirletter[(int) data_dir],
  1865. fsg->data_size_from_cmnd, fsg->cmnd_size, hdlen);
  1866. /* We can't reply at all until we know the correct data direction
  1867. * and size. */
  1868. if (fsg->data_size_from_cmnd == 0)
  1869. data_dir = DATA_DIR_NONE;
  1870. if (fsg->data_dir == DATA_DIR_UNKNOWN) { // CB or CBI
  1871. fsg->data_dir = data_dir;
  1872. fsg->data_size = fsg->data_size_from_cmnd;
  1873. } else { // Bulk-only
  1874. if (fsg->data_size < fsg->data_size_from_cmnd) {
  1875. /* Host data size < Device data size is a phase error.
  1876. * Carry out the command, but only transfer as much
  1877. * as we are allowed. */
  1878. fsg->data_size_from_cmnd = fsg->data_size;
  1879. fsg->phase_error = 1;
  1880. }
  1881. }
  1882. fsg->residue = fsg->usb_amount_left = fsg->data_size;
  1883. /* Conflicting data directions is a phase error */
  1884. if (fsg->data_dir != data_dir && fsg->data_size_from_cmnd > 0) {
  1885. fsg->phase_error = 1;
  1886. return -EINVAL;
  1887. }
  1888. /* Verify the length of the command itself */
  1889. if (cmnd_size != fsg->cmnd_size) {
  1890. /* Special case workaround: There are plenty of buggy SCSI
  1891. * implementations. Many have issues with cbw->Length
  1892. * field passing a wrong command size. For those cases we
  1893. * always try to work around the problem by using the length
  1894. * sent by the host side provided it is at least as large
  1895. * as the correct command length.
  1896. * Examples of such cases would be MS-Windows, which issues
  1897. * REQUEST SENSE with cbw->Length == 12 where it should
  1898. * be 6, and xbox360 issuing INQUIRY, TEST UNIT READY and
  1899. * REQUEST SENSE with cbw->Length == 10 where it should
  1900. * be 6 as well.
  1901. */
  1902. if (cmnd_size <= fsg->cmnd_size) {
  1903. DBG(fsg, "%s is buggy! Expected length %d "
  1904. "but we got %d\n", name,
  1905. cmnd_size, fsg->cmnd_size);
  1906. cmnd_size = fsg->cmnd_size;
  1907. } else {
  1908. fsg->phase_error = 1;
  1909. return -EINVAL;
  1910. }
  1911. }
  1912. /* Check that the LUN values are consistent */
  1913. if (transport_is_bbb()) {
  1914. if (fsg->lun != lun)
  1915. DBG(fsg, "using LUN %d from CBW, "
  1916. "not LUN %d from CDB\n",
  1917. fsg->lun, lun);
  1918. } else
  1919. fsg->lun = lun; // Use LUN from the command
  1920. /* Check the LUN */
  1921. if (fsg->lun < fsg->nluns) {
  1922. fsg->curlun = curlun = &fsg->luns[fsg->lun];
  1923. if (fsg->cmnd[0] != REQUEST_SENSE) {
  1924. curlun->sense_data = SS_NO_SENSE;
  1925. curlun->sense_data_info = 0;
  1926. curlun->info_valid = 0;
  1927. }
  1928. } else {
  1929. fsg->curlun = curlun = NULL;
  1930. fsg->bad_lun_okay = 0;
  1931. /* INQUIRY and REQUEST SENSE commands are explicitly allowed
  1932. * to use unsupported LUNs; all others may not. */
  1933. if (fsg->cmnd[0] != INQUIRY &&
  1934. fsg->cmnd[0] != REQUEST_SENSE) {
  1935. DBG(fsg, "unsupported LUN %d\n", fsg->lun);
  1936. return -EINVAL;
  1937. }
  1938. }
  1939. /* If a unit attention condition exists, only INQUIRY and
  1940. * REQUEST SENSE commands are allowed; anything else must fail. */
  1941. if (curlun && curlun->unit_attention_data != SS_NO_SENSE &&
  1942. fsg->cmnd[0] != INQUIRY &&
  1943. fsg->cmnd[0] != REQUEST_SENSE) {
  1944. curlun->sense_data = curlun->unit_attention_data;
  1945. curlun->unit_attention_data = SS_NO_SENSE;
  1946. return -EINVAL;
  1947. }
  1948. /* Check that only command bytes listed in the mask are non-zero */
  1949. fsg->cmnd[1] &= 0x1f; // Mask away the LUN
  1950. for (i = 1; i < cmnd_size; ++i) {
  1951. if (fsg->cmnd[i] && !(mask & (1 << i))) {
  1952. if (curlun)
  1953. curlun->sense_data = SS_INVALID_FIELD_IN_CDB;
  1954. return -EINVAL;
  1955. }
  1956. }
  1957. /* If the medium isn't mounted and the command needs to access
  1958. * it, return an error. */
  1959. if (curlun && !fsg_lun_is_open(curlun) && needs_medium) {
  1960. curlun->sense_data = SS_MEDIUM_NOT_PRESENT;
  1961. return -EINVAL;
  1962. }
  1963. return 0;
  1964. }
  1965. static int do_scsi_command(struct fsg_dev *fsg)
  1966. {
  1967. struct fsg_buffhd *bh;
  1968. int rc;
  1969. int reply = -EINVAL;
  1970. int i;
  1971. static char unknown[16];
  1972. dump_cdb(fsg);
  1973. /* Wait for the next buffer to become available for data or status */
  1974. bh = fsg->next_buffhd_to_drain = fsg->next_buffhd_to_fill;
  1975. while (bh->state != BUF_STATE_EMPTY) {
  1976. rc = sleep_thread(fsg);
  1977. if (rc)
  1978. return rc;
  1979. }
  1980. fsg->phase_error = 0;
  1981. fsg->short_packet_received = 0;
  1982. down_read(&fsg->filesem); // We're using the backing file
  1983. switch (fsg->cmnd[0]) {
  1984. case INQUIRY:
  1985. fsg->data_size_from_cmnd = fsg->cmnd[4];
  1986. if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
  1987. (1<<4), 0,
  1988. "INQUIRY")) == 0)
  1989. reply = do_inquiry(fsg, bh);
  1990. break;
  1991. case MODE_SELECT:
  1992. fsg->data_size_from_cmnd = fsg->cmnd[4];
  1993. if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
  1994. (1<<1) | (1<<4), 0,
  1995. "MODE SELECT(6)")) == 0)
  1996. reply = do_mode_select(fsg, bh);
  1997. break;
  1998. case MODE_SELECT_10:
  1999. fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
  2000. if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
  2001. (1<<1) | (3<<7), 0,
  2002. "MODE SELECT(10)")) == 0)
  2003. reply = do_mode_select(fsg, bh);
  2004. break;
  2005. case MODE_SENSE:
  2006. fsg->data_size_from_cmnd = fsg->cmnd[4];
  2007. if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
  2008. (1<<1) | (1<<2) | (1<<4), 0,
  2009. "MODE SENSE(6)")) == 0)
  2010. reply = do_mode_sense(fsg, bh);
  2011. break;
  2012. case MODE_SENSE_10:
  2013. fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
  2014. if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
  2015. (1<<1) | (1<<2) | (3<<7), 0,
  2016. "MODE SENSE(10)")) == 0)
  2017. reply = do_mode_sense(fsg, bh);
  2018. break;
  2019. case ALLOW_MEDIUM_REMOVAL:
  2020. fsg->data_size_from_cmnd = 0;
  2021. if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
  2022. (1<<4), 0,
  2023. "PREVENT-ALLOW MEDIUM REMOVAL")) == 0)
  2024. reply = do_prevent_allow(fsg);
  2025. break;
  2026. case READ_6:
  2027. i = fsg->cmnd[4];
  2028. fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << fsg->curlun->blkbits;
  2029. if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
  2030. (7<<1) | (1<<4), 1,
  2031. "READ(6)")) == 0)
  2032. reply = do_read(fsg);
  2033. break;
  2034. case READ_10:
  2035. fsg->data_size_from_cmnd =
  2036. get_unaligned_be16(&fsg->cmnd[7]) << fsg->curlun->blkbits;
  2037. if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
  2038. (1<<1) | (0xf<<2) | (3<<7), 1,
  2039. "READ(10)")) == 0)
  2040. reply = do_read(fsg);
  2041. break;
  2042. case READ_12:
  2043. fsg->data_size_from_cmnd =
  2044. get_unaligned_be32(&fsg->cmnd[6]) << fsg->curlun->blkbits;
  2045. if ((reply = check_command(fsg, 12, DATA_DIR_TO_HOST,
  2046. (1<<1) | (0xf<<2) | (0xf<<6), 1,
  2047. "READ(12)")) == 0)
  2048. reply = do_read(fsg);
  2049. break;
  2050. case READ_CAPACITY:
  2051. fsg->data_size_from_cmnd = 8;
  2052. if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
  2053. (0xf<<2) | (1<<8), 1,
  2054. "READ CAPACITY")) == 0)
  2055. reply = do_read_capacity(fsg, bh);
  2056. break;
  2057. case READ_HEADER:
  2058. if (!mod_data.cdrom)
  2059. goto unknown_cmnd;
  2060. fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
  2061. if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
  2062. (3<<7) | (0x1f<<1), 1,
  2063. "READ HEADER")) == 0)
  2064. reply = do_read_header(fsg, bh);
  2065. break;
  2066. case READ_TOC:
  2067. if (!mod_data.cdrom)
  2068. goto unknown_cmnd;
  2069. fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
  2070. if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
  2071. (7<<6) | (1<<1), 1,
  2072. "READ TOC")) == 0)
  2073. reply = do_read_toc(fsg, bh);
  2074. break;
  2075. case READ_FORMAT_CAPACITIES:
  2076. fsg->data_size_from_cmnd = get_unaligned_be16(&fsg->cmnd[7]);
  2077. if ((reply = check_command(fsg, 10, DATA_DIR_TO_HOST,
  2078. (3<<7), 1,
  2079. "READ FORMAT CAPACITIES")) == 0)
  2080. reply = do_read_format_capacities(fsg, bh);
  2081. break;
  2082. case REQUEST_SENSE:
  2083. fsg->data_size_from_cmnd = fsg->cmnd[4];
  2084. if ((reply = check_command(fsg, 6, DATA_DIR_TO_HOST,
  2085. (1<<4), 0,
  2086. "REQUEST SENSE")) == 0)
  2087. reply = do_request_sense(fsg, bh);
  2088. break;
  2089. case START_STOP:
  2090. fsg->data_size_from_cmnd = 0;
  2091. if ((reply = check_command(fsg, 6, DATA_DIR_NONE,
  2092. (1<<1) | (1<<4), 0,
  2093. "START-STOP UNIT")) == 0)
  2094. reply = do_start_stop(fsg);
  2095. break;
  2096. case SYNCHRONIZE_CACHE:
  2097. fsg->data_size_from_cmnd = 0;
  2098. if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
  2099. (0xf<<2) | (3<<7), 1,
  2100. "SYNCHRONIZE CACHE")) == 0)
  2101. reply = do_synchronize_cache(fsg);
  2102. break;
  2103. case TEST_UNIT_READY:
  2104. fsg->data_size_from_cmnd = 0;
  2105. reply = check_command(fsg, 6, DATA_DIR_NONE,
  2106. 0, 1,
  2107. "TEST UNIT READY");
  2108. break;
  2109. /* Although optional, this command is used by MS-Windows. We
  2110. * support a minimal version: BytChk must be 0. */
  2111. case VERIFY:
  2112. fsg->data_size_from_cmnd = 0;
  2113. if ((reply = check_command(fsg, 10, DATA_DIR_NONE,
  2114. (1<<1) | (0xf<<2) | (3<<7), 1,
  2115. "VERIFY")) == 0)
  2116. reply = do_verify(fsg);
  2117. break;
  2118. case WRITE_6:
  2119. i = fsg->cmnd[4];
  2120. fsg->data_size_from_cmnd = (i == 0 ? 256 : i) << fsg->curlun->blkbits;
  2121. if ((reply = check_command(fsg, 6, DATA_DIR_FROM_HOST,
  2122. (7<<1) | (1<<4), 1,
  2123. "WRITE(6)")) == 0)
  2124. reply = do_write(fsg);
  2125. break;
  2126. case WRITE_10:
  2127. fsg->data_size_from_cmnd =
  2128. get_unaligned_be16(&fsg->cmnd[7]) << fsg->curlun->blkbits;
  2129. if ((reply = check_command(fsg, 10, DATA_DIR_FROM_HOST,
  2130. (1<<1) | (0xf<<2) | (3<<7), 1,
  2131. "WRITE(10)")) == 0)
  2132. reply = do_write(fsg);
  2133. break;
  2134. case WRITE_12:
  2135. fsg->data_size_from_cmnd =
  2136. get_unaligned_be32(&fsg->cmnd[6]) << fsg->curlun->blkbits;
  2137. if ((reply = check_command(fsg, 12, DATA_DIR_FROM_HOST,
  2138. (1<<1) | (0xf<<2) | (0xf<<6), 1,
  2139. "WRITE(12)")) == 0)
  2140. reply = do_write(fsg);
  2141. break;
  2142. /* Some mandatory commands that we recognize but don't implement.
  2143. * They don't mean much in this setting. It's left as an exercise
  2144. * for anyone interested to implement RESERVE and RELEASE in terms
  2145. * of Posix locks. */
  2146. case FORMAT_UNIT:
  2147. case RELEASE:
  2148. case RESERVE:
  2149. case SEND_DIAGNOSTIC:
  2150. // Fall through
  2151. default:
  2152. unknown_cmnd:
  2153. fsg->data_size_from_cmnd = 0;
  2154. sprintf(unknown, "Unknown x%02x", fsg->cmnd[0]);
  2155. if ((reply = check_command(fsg, fsg->cmnd_size,
  2156. DATA_DIR_UNKNOWN, 0xff, 0, unknown)) == 0) {
  2157. fsg->curlun->sense_data = SS_INVALID_COMMAND;
  2158. reply = -EINVAL;
  2159. }
  2160. break;
  2161. }
  2162. up_read(&fsg->filesem);
  2163. if (reply == -EINTR || signal_pending(current))
  2164. return -EINTR;
  2165. /* Set up the single reply buffer for finish_reply() */
  2166. if (reply == -EINVAL)
  2167. reply = 0; // Error reply length
  2168. if (reply >= 0 && fsg->data_dir == DATA_DIR_TO_HOST) {
  2169. reply = min((u32) reply, fsg->data_size_from_cmnd);
  2170. bh->inreq->length = reply;
  2171. bh->state = BUF_STATE_FULL;
  2172. fsg->residue -= reply;
  2173. } // Otherwise it's already set
  2174. return 0;
  2175. }
  2176. /*-------------------------------------------------------------------------*/
  2177. static int received_cbw(struct fsg_dev *fsg, struct fsg_buffhd *bh)
  2178. {
  2179. struct usb_request *req = bh->outreq;
  2180. struct fsg_bulk_cb_wrap *cbw = req->buf;
  2181. /* Was this a real packet? Should it be ignored? */
  2182. if (req->status || test_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
  2183. return -EINVAL;
  2184. /* Is the CBW valid? */
  2185. if (req->actual != USB_BULK_CB_WRAP_LEN ||
  2186. cbw->Signature != cpu_to_le32(
  2187. USB_BULK_CB_SIG)) {
  2188. DBG(fsg, "invalid CBW: len %u sig 0x%x\n",
  2189. req->actual,
  2190. le32_to_cpu(cbw->Signature));
  2191. /* The Bulk-only spec says we MUST stall the IN endpoint
  2192. * (6.6.1), so it's unavoidable. It also says we must
  2193. * retain this state until the next reset, but there's
  2194. * no way to tell the controller driver it should ignore
  2195. * Clear-Feature(HALT) requests.
  2196. *
  2197. * We aren't required to halt the OUT endpoint; instead
  2198. * we can simply accept and discard any data received
  2199. * until the next reset. */
  2200. wedge_bulk_in_endpoint(fsg);
  2201. set_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
  2202. return -EINVAL;
  2203. }
  2204. /* Is the CBW meaningful? */
  2205. if (cbw->Lun >= FSG_MAX_LUNS || cbw->Flags & ~USB_BULK_IN_FLAG ||
  2206. cbw->Length <= 0 || cbw->Length > MAX_COMMAND_SIZE) {
  2207. DBG(fsg, "non-meaningful CBW: lun = %u, flags = 0x%x, "
  2208. "cmdlen %u\n",
  2209. cbw->Lun, cbw->Flags, cbw->Length);
  2210. /* We can do anything we want here, so let's stall the
  2211. * bulk pipes if we are allowed to. */
  2212. if (mod_data.can_stall) {
  2213. fsg_set_halt(fsg, fsg->bulk_out);
  2214. halt_bulk_in_endpoint(fsg);
  2215. }
  2216. return -EINVAL;
  2217. }
  2218. /* Save the command for later */
  2219. fsg->cmnd_size = cbw->Length;
  2220. memcpy(fsg->cmnd, cbw->CDB, fsg->cmnd_size);
  2221. if (cbw->Flags & USB_BULK_IN_FLAG)
  2222. fsg->data_dir = DATA_DIR_TO_HOST;
  2223. else
  2224. fsg->data_dir = DATA_DIR_FROM_HOST;
  2225. fsg->data_size = le32_to_cpu(cbw->DataTransferLength);
  2226. if (fsg->data_size == 0)
  2227. fsg->data_dir = DATA_DIR_NONE;
  2228. fsg->lun = cbw->Lun;
  2229. fsg->tag = cbw->Tag;
  2230. return 0;
  2231. }
  2232. static int get_next_command(struct fsg_dev *fsg)
  2233. {
  2234. struct fsg_buffhd *bh;
  2235. int rc = 0;
  2236. if (transport_is_bbb()) {
  2237. /* Wait for the next buffer to become available */
  2238. bh = fsg->next_buffhd_to_fill;
  2239. while (bh->state != BUF_STATE_EMPTY) {
  2240. rc = sleep_thread(fsg);
  2241. if (rc)
  2242. return rc;
  2243. }
  2244. /* Queue a request to read a Bulk-only CBW */
  2245. set_bulk_out_req_length(fsg, bh, USB_BULK_CB_WRAP_LEN);
  2246. start_transfer(fsg, fsg->bulk_out, bh->outreq,
  2247. &bh->outreq_busy, &bh->state);
  2248. /* We will drain the buffer in software, which means we
  2249. * can reuse it for the next filling. No need to advance
  2250. * next_buffhd_to_fill. */
  2251. /* Wait for the CBW to arrive */
  2252. while (bh->state != BUF_STATE_FULL) {
  2253. rc = sleep_thread(fsg);
  2254. if (rc)
  2255. return rc;
  2256. }
  2257. smp_rmb();
  2258. rc = received_cbw(fsg, bh);
  2259. bh->state = BUF_STATE_EMPTY;
  2260. } else { // USB_PR_CB or USB_PR_CBI
  2261. /* Wait for the next command to arrive */
  2262. while (fsg->cbbuf_cmnd_size == 0) {
  2263. rc = sleep_thread(fsg);
  2264. if (rc)
  2265. return rc;
  2266. }
  2267. /* Is the previous status interrupt request still busy?
  2268. * The host is allowed to skip reading the status,
  2269. * so we must cancel it. */
  2270. if (fsg->intreq_busy)
  2271. usb_ep_dequeue(fsg->intr_in, fsg->intreq);
  2272. /* Copy the command and mark the buffer empty */
  2273. fsg->data_dir = DATA_DIR_UNKNOWN;
  2274. spin_lock_irq(&fsg->lock);
  2275. fsg->cmnd_size = fsg->cbbuf_cmnd_size;
  2276. memcpy(fsg->cmnd, fsg->cbbuf_cmnd, fsg->cmnd_size);
  2277. fsg->cbbuf_cmnd_size = 0;
  2278. spin_unlock_irq(&fsg->lock);
  2279. }
  2280. return rc;
  2281. }
  2282. /*-------------------------------------------------------------------------*/
  2283. static int enable_endpoint(struct fsg_dev *fsg, struct usb_ep *ep,
  2284. const struct usb_endpoint_descriptor *d)
  2285. {
  2286. int rc;
  2287. ep->driver_data = fsg;
  2288. ep->desc = d;
  2289. rc = usb_ep_enable(ep);
  2290. if (rc)
  2291. ERROR(fsg, "can't enable %s, result %d\n", ep->name, rc);
  2292. return rc;
  2293. }
  2294. static int alloc_request(struct fsg_dev *fsg, struct usb_ep *ep,
  2295. struct usb_request **preq)
  2296. {
  2297. *preq = usb_ep_alloc_request(ep, GFP_ATOMIC);
  2298. if (*preq)
  2299. return 0;
  2300. ERROR(fsg, "can't allocate request for %s\n", ep->name);
  2301. return -ENOMEM;
  2302. }
  2303. /*
  2304. * Reset interface setting and re-init endpoint state (toggle etc).
  2305. * Call with altsetting < 0 to disable the interface. The only other
  2306. * available altsetting is 0, which enables the interface.
  2307. */
  2308. static int do_set_interface(struct fsg_dev *fsg, int altsetting)
  2309. {
  2310. int rc = 0;
  2311. int i;
  2312. const struct usb_endpoint_descriptor *d;
  2313. if (fsg->running)
  2314. DBG(fsg, "reset interface\n");
  2315. reset:
  2316. /* Deallocate the requests */
  2317. for (i = 0; i < fsg_num_buffers; ++i) {
  2318. struct fsg_buffhd *bh = &fsg->buffhds[i];
  2319. if (bh->inreq) {
  2320. usb_ep_free_request(fsg->bulk_in, bh->inreq);
  2321. bh->inreq = NULL;
  2322. }
  2323. if (bh->outreq) {
  2324. usb_ep_free_request(fsg->bulk_out, bh->outreq);
  2325. bh->outreq = NULL;
  2326. }
  2327. }
  2328. if (fsg->intreq) {
  2329. usb_ep_free_request(fsg->intr_in, fsg->intreq);
  2330. fsg->intreq = NULL;
  2331. }
  2332. /* Disable the endpoints */
  2333. if (fsg->bulk_in_enabled) {
  2334. usb_ep_disable(fsg->bulk_in);
  2335. fsg->bulk_in_enabled = 0;
  2336. }
  2337. if (fsg->bulk_out_enabled) {
  2338. usb_ep_disable(fsg->bulk_out);
  2339. fsg->bulk_out_enabled = 0;
  2340. }
  2341. if (fsg->intr_in_enabled) {
  2342. usb_ep_disable(fsg->intr_in);
  2343. fsg->intr_in_enabled = 0;
  2344. }
  2345. fsg->running = 0;
  2346. if (altsetting < 0 || rc != 0)
  2347. return rc;
  2348. DBG(fsg, "set interface %d\n", altsetting);
  2349. /* Enable the endpoints */
  2350. d = fsg_ep_desc(fsg->gadget,
  2351. &fsg_fs_bulk_in_desc, &fsg_hs_bulk_in_desc);
  2352. if ((rc = enable_endpoint(fsg, fsg->bulk_in, d)) != 0)
  2353. goto reset;
  2354. fsg->bulk_in_enabled = 1;
  2355. d = fsg_ep_desc(fsg->gadget,
  2356. &fsg_fs_bulk_out_desc, &fsg_hs_bulk_out_desc);
  2357. if ((rc = enable_endpoint(fsg, fsg->bulk_out, d)) != 0)
  2358. goto reset;
  2359. fsg->bulk_out_enabled = 1;
  2360. fsg->bulk_out_maxpacket = usb_endpoint_maxp(d);
  2361. clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags);
  2362. if (transport_is_cbi()) {
  2363. d = fsg_ep_desc(fsg->gadget,
  2364. &fsg_fs_intr_in_desc, &fsg_hs_intr_in_desc);
  2365. if ((rc = enable_endpoint(fsg, fsg->intr_in, d)) != 0)
  2366. goto reset;
  2367. fsg->intr_in_enabled = 1;
  2368. }
  2369. /* Allocate the requests */
  2370. for (i = 0; i < fsg_num_buffers; ++i) {
  2371. struct fsg_buffhd *bh = &fsg->buffhds[i];
  2372. if ((rc = alloc_request(fsg, fsg->bulk_in, &bh->inreq)) != 0)
  2373. goto reset;
  2374. if ((rc = alloc_request(fsg, fsg->bulk_out, &bh->outreq)) != 0)
  2375. goto reset;
  2376. bh->inreq->buf = bh->outreq->buf = bh->buf;
  2377. bh->inreq->context = bh->outreq->context = bh;
  2378. bh->inreq->complete = bulk_in_complete;
  2379. bh->outreq->complete = bulk_out_complete;
  2380. }
  2381. if (transport_is_cbi()) {
  2382. if ((rc = alloc_request(fsg, fsg->intr_in, &fsg->intreq)) != 0)
  2383. goto reset;
  2384. fsg->intreq->complete = intr_in_complete;
  2385. }
  2386. fsg->running = 1;
  2387. for (i = 0; i < fsg->nluns; ++i)
  2388. fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
  2389. return rc;
  2390. }
  2391. /*
  2392. * Change our operational configuration. This code must agree with the code
  2393. * that returns config descriptors, and with interface altsetting code.
  2394. *
  2395. * It's also responsible for power management interactions. Some
  2396. * configurations might not work with our current power sources.
  2397. * For now we just assume the gadget is always self-powered.
  2398. */
  2399. static int do_set_config(struct fsg_dev *fsg, u8 new_config)
  2400. {
  2401. int rc = 0;
  2402. /* Disable the single interface */
  2403. if (fsg->config != 0) {
  2404. DBG(fsg, "reset config\n");
  2405. fsg->config = 0;
  2406. rc = do_set_interface(fsg, -1);
  2407. }
  2408. /* Enable the interface */
  2409. if (new_config != 0) {
  2410. fsg->config = new_config;
  2411. if ((rc = do_set_interface(fsg, 0)) != 0)
  2412. fsg->config = 0; // Reset on errors
  2413. else
  2414. INFO(fsg, "%s config #%d\n",
  2415. usb_speed_string(fsg->gadget->speed),
  2416. fsg->config);
  2417. }
  2418. return rc;
  2419. }
  2420. /*-------------------------------------------------------------------------*/
  2421. static void handle_exception(struct fsg_dev *fsg)
  2422. {
  2423. siginfo_t info;
  2424. int sig;
  2425. int i;
  2426. int num_active;
  2427. struct fsg_buffhd *bh;
  2428. enum fsg_state old_state;
  2429. u8 new_config;
  2430. struct fsg_lun *curlun;
  2431. unsigned int exception_req_tag;
  2432. int rc;
  2433. /* Clear the existing signals. Anything but SIGUSR1 is converted
  2434. * into a high-priority EXIT exception. */
  2435. for (;;) {
  2436. sig = dequeue_signal_lock(current, &current->blocked, &info);
  2437. if (!sig)
  2438. break;
  2439. if (sig != SIGUSR1) {
  2440. if (fsg->state < FSG_STATE_EXIT)
  2441. DBG(fsg, "Main thread exiting on signal\n");
  2442. raise_exception(fsg, FSG_STATE_EXIT);
  2443. }
  2444. }
  2445. /* Cancel all the pending transfers */
  2446. if (fsg->intreq_busy)
  2447. usb_ep_dequeue(fsg->intr_in, fsg->intreq);
  2448. for (i = 0; i < fsg_num_buffers; ++i) {
  2449. bh = &fsg->buffhds[i];
  2450. if (bh->inreq_busy)
  2451. usb_ep_dequeue(fsg->bulk_in, bh->inreq);
  2452. if (bh->outreq_busy)
  2453. usb_ep_dequeue(fsg->bulk_out, bh->outreq);
  2454. }
  2455. /* Wait until everything is idle */
  2456. for (;;) {
  2457. num_active = fsg->intreq_busy;
  2458. for (i = 0; i < fsg_num_buffers; ++i) {
  2459. bh = &fsg->buffhds[i];
  2460. num_active += bh->inreq_busy + bh->outreq_busy;
  2461. }
  2462. if (num_active == 0)
  2463. break;
  2464. if (sleep_thread(fsg))
  2465. return;
  2466. }
  2467. /* Clear out the controller's fifos */
  2468. if (fsg->bulk_in_enabled)
  2469. usb_ep_fifo_flush(fsg->bulk_in);
  2470. if (fsg->bulk_out_enabled)
  2471. usb_ep_fifo_flush(fsg->bulk_out);
  2472. if (fsg->intr_in_enabled)
  2473. usb_ep_fifo_flush(fsg->intr_in);
  2474. /* Reset the I/O buffer states and pointers, the SCSI
  2475. * state, and the exception. Then invoke the handler. */
  2476. spin_lock_irq(&fsg->lock);
  2477. for (i = 0; i < fsg_num_buffers; ++i) {
  2478. bh = &fsg->buffhds[i];
  2479. bh->state = BUF_STATE_EMPTY;
  2480. }
  2481. fsg->next_buffhd_to_fill = fsg->next_buffhd_to_drain =
  2482. &fsg->buffhds[0];
  2483. exception_req_tag = fsg->exception_req_tag;
  2484. new_config = fsg->new_config;
  2485. old_state = fsg->state;
  2486. if (old_state == FSG_STATE_ABORT_BULK_OUT)
  2487. fsg->state = FSG_STATE_STATUS_PHASE;
  2488. else {
  2489. for (i = 0; i < fsg->nluns; ++i) {
  2490. curlun = &fsg->luns[i];
  2491. curlun->prevent_medium_removal = 0;
  2492. curlun->sense_data = curlun->unit_attention_data =
  2493. SS_NO_SENSE;
  2494. curlun->sense_data_info = 0;
  2495. curlun->info_valid = 0;
  2496. }
  2497. fsg->state = FSG_STATE_IDLE;
  2498. }
  2499. spin_unlock_irq(&fsg->lock);
  2500. /* Carry out any extra actions required for the exception */
  2501. switch (old_state) {
  2502. default:
  2503. break;
  2504. case FSG_STATE_ABORT_BULK_OUT:
  2505. send_status(fsg);
  2506. spin_lock_irq(&fsg->lock);
  2507. if (fsg->state == FSG_STATE_STATUS_PHASE)
  2508. fsg->state = FSG_STATE_IDLE;
  2509. spin_unlock_irq(&fsg->lock);
  2510. break;
  2511. case FSG_STATE_RESET:
  2512. /* In case we were forced against our will to halt a
  2513. * bulk endpoint, clear the halt now. (The SuperH UDC
  2514. * requires this.) */
  2515. if (test_and_clear_bit(IGNORE_BULK_OUT, &fsg->atomic_bitflags))
  2516. usb_ep_clear_halt(fsg->bulk_in);
  2517. if (transport_is_bbb()) {
  2518. if (fsg->ep0_req_tag == exception_req_tag)
  2519. ep0_queue(fsg); // Complete the status stage
  2520. } else if (transport_is_cbi())
  2521. send_status(fsg); // Status by interrupt pipe
  2522. /* Technically this should go here, but it would only be
  2523. * a waste of time. Ditto for the INTERFACE_CHANGE and
  2524. * CONFIG_CHANGE cases. */
  2525. // for (i = 0; i < fsg->nluns; ++i)
  2526. // fsg->luns[i].unit_attention_data = SS_RESET_OCCURRED;
  2527. break;
  2528. case FSG_STATE_INTERFACE_CHANGE:
  2529. rc = do_set_interface(fsg, 0);
  2530. if (fsg->ep0_req_tag != exception_req_tag)
  2531. break;
  2532. if (rc != 0) // STALL on errors
  2533. fsg_set_halt(fsg, fsg->ep0);
  2534. else // Complete the status stage
  2535. ep0_queue(fsg);
  2536. break;
  2537. case FSG_STATE_CONFIG_CHANGE:
  2538. rc = do_set_config(fsg, new_config);
  2539. if (fsg->ep0_req_tag != exception_req_tag)
  2540. break;
  2541. if (rc != 0) // STALL on errors
  2542. fsg_set_halt(fsg, fsg->ep0);
  2543. else // Complete the status stage
  2544. ep0_queue(fsg);
  2545. break;
  2546. case FSG_STATE_DISCONNECT:
  2547. for (i = 0; i < fsg->nluns; ++i)
  2548. fsg_lun_fsync_sub(fsg->luns + i);
  2549. do_set_config(fsg, 0); // Unconfigured state
  2550. break;
  2551. case FSG_STATE_EXIT:
  2552. case FSG_STATE_TERMINATED:
  2553. do_set_config(fsg, 0); // Free resources
  2554. spin_lock_irq(&fsg->lock);
  2555. fsg->state = FSG_STATE_TERMINATED; // Stop the thread
  2556. spin_unlock_irq(&fsg->lock);
  2557. break;
  2558. }
  2559. }
  2560. /*-------------------------------------------------------------------------*/
  2561. static int fsg_main_thread(void *fsg_)
  2562. {
  2563. struct fsg_dev *fsg = fsg_;
  2564. /* Allow the thread to be killed by a signal, but set the signal mask
  2565. * to block everything but INT, TERM, KILL, and USR1. */
  2566. allow_signal(SIGINT);
  2567. allow_signal(SIGTERM);
  2568. allow_signal(SIGKILL);
  2569. allow_signal(SIGUSR1);
  2570. /* Allow the thread to be frozen */
  2571. set_freezable();
  2572. /* Arrange for userspace references to be interpreted as kernel
  2573. * pointers. That way we can pass a kernel pointer to a routine
  2574. * that expects a __user pointer and it will work okay. */
  2575. set_fs(get_ds());
  2576. /* The main loop */
  2577. while (fsg->state != FSG_STATE_TERMINATED) {
  2578. if (exception_in_progress(fsg) || signal_pending(current)) {
  2579. handle_exception(fsg);
  2580. continue;
  2581. }
  2582. if (!fsg->running) {
  2583. sleep_thread(fsg);
  2584. continue;
  2585. }
  2586. if (get_next_command(fsg))
  2587. continue;
  2588. spin_lock_irq(&fsg->lock);
  2589. if (!exception_in_progress(fsg))
  2590. fsg->state = FSG_STATE_DATA_PHASE;
  2591. spin_unlock_irq(&fsg->lock);
  2592. if (do_scsi_command(fsg) || finish_reply(fsg))
  2593. continue;
  2594. spin_lock_irq(&fsg->lock);
  2595. if (!exception_in_progress(fsg))
  2596. fsg->state = FSG_STATE_STATUS_PHASE;
  2597. spin_unlock_irq(&fsg->lock);
  2598. if (send_status(fsg))
  2599. continue;
  2600. spin_lock_irq(&fsg->lock);
  2601. if (!exception_in_progress(fsg))
  2602. fsg->state = FSG_STATE_IDLE;
  2603. spin_unlock_irq(&fsg->lock);
  2604. }
  2605. spin_lock_irq(&fsg->lock);
  2606. fsg->thread_task = NULL;
  2607. spin_unlock_irq(&fsg->lock);
  2608. /* If we are exiting because of a signal, unregister the
  2609. * gadget driver. */
  2610. if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
  2611. usb_gadget_unregister_driver(&fsg_driver);
  2612. /* Let the unbind and cleanup routines know the thread has exited */
  2613. complete_and_exit(&fsg->thread_notifier, 0);
  2614. }
  2615. /*-------------------------------------------------------------------------*/
  2616. /* The write permissions and store_xxx pointers are set in fsg_bind() */
  2617. static DEVICE_ATTR(ro, 0444, fsg_show_ro, NULL);
  2618. static DEVICE_ATTR(nofua, 0644, fsg_show_nofua, NULL);
  2619. static DEVICE_ATTR(file, 0444, fsg_show_file, NULL);
  2620. /*-------------------------------------------------------------------------*/
  2621. static void fsg_release(struct kref *ref)
  2622. {
  2623. struct fsg_dev *fsg = container_of(ref, struct fsg_dev, ref);
  2624. kfree(fsg->luns);
  2625. kfree(fsg);
  2626. }
  2627. static void lun_release(struct device *dev)
  2628. {
  2629. struct rw_semaphore *filesem = dev_get_drvdata(dev);
  2630. struct fsg_dev *fsg =
  2631. container_of(filesem, struct fsg_dev, filesem);
  2632. kref_put(&fsg->ref, fsg_release);
  2633. }
  2634. static void /* __init_or_exit */ fsg_unbind(struct usb_gadget *gadget)
  2635. {
  2636. struct fsg_dev *fsg = get_gadget_data(gadget);
  2637. int i;
  2638. struct fsg_lun *curlun;
  2639. struct usb_request *req = fsg->ep0req;
  2640. DBG(fsg, "unbind\n");
  2641. clear_bit(REGISTERED, &fsg->atomic_bitflags);
  2642. /* Unregister the sysfs attribute files and the LUNs */
  2643. for (i = 0; i < fsg->nluns; ++i) {
  2644. curlun = &fsg->luns[i];
  2645. if (curlun->registered) {
  2646. device_remove_file(&curlun->dev, &dev_attr_nofua);
  2647. device_remove_file(&curlun->dev, &dev_attr_ro);
  2648. device_remove_file(&curlun->dev, &dev_attr_file);
  2649. fsg_lun_close(curlun);
  2650. device_unregister(&curlun->dev);
  2651. curlun->registered = 0;
  2652. }
  2653. }
  2654. /* If the thread isn't already dead, tell it to exit now */
  2655. if (fsg->state != FSG_STATE_TERMINATED) {
  2656. raise_exception(fsg, FSG_STATE_EXIT);
  2657. wait_for_completion(&fsg->thread_notifier);
  2658. /* The cleanup routine waits for this completion also */
  2659. complete(&fsg->thread_notifier);
  2660. }
  2661. /* Free the data buffers */
  2662. for (i = 0; i < fsg_num_buffers; ++i)
  2663. kfree(fsg->buffhds[i].buf);
  2664. /* Free the request and buffer for endpoint 0 */
  2665. if (req) {
  2666. kfree(req->buf);
  2667. usb_ep_free_request(fsg->ep0, req);
  2668. }
  2669. set_gadget_data(gadget, NULL);
  2670. }
  2671. static int __init check_parameters(struct fsg_dev *fsg)
  2672. {
  2673. int prot;
  2674. int gcnum;
  2675. /* Store the default values */
  2676. mod_data.transport_type = USB_PR_BULK;
  2677. mod_data.transport_name = "Bulk-only";
  2678. mod_data.protocol_type = USB_SC_SCSI;
  2679. mod_data.protocol_name = "Transparent SCSI";
  2680. /* Some peripheral controllers are known not to be able to
  2681. * halt bulk endpoints correctly. If one of them is present,
  2682. * disable stalls.
  2683. */
  2684. if (gadget_is_at91(fsg->gadget))
  2685. mod_data.can_stall = 0;
  2686. if (mod_data.release == 0xffff) { // Parameter wasn't set
  2687. gcnum = usb_gadget_controller_number(fsg->gadget);
  2688. if (gcnum >= 0)
  2689. mod_data.release = 0x0300 + gcnum;
  2690. else {
  2691. WARNING(fsg, "controller '%s' not recognized\n",
  2692. fsg->gadget->name);
  2693. mod_data.release = 0x0399;
  2694. }
  2695. }
  2696. prot = simple_strtol(mod_data.protocol_parm, NULL, 0);
  2697. #ifdef CONFIG_USB_FILE_STORAGE_TEST
  2698. if (strnicmp(mod_data.transport_parm, "BBB", 10) == 0) {
  2699. ; // Use default setting
  2700. } else if (strnicmp(mod_data.transport_parm, "CB", 10) == 0) {
  2701. mod_data.transport_type = USB_PR_CB;
  2702. mod_data.transport_name = "Control-Bulk";
  2703. } else if (strnicmp(mod_data.transport_parm, "CBI", 10) == 0) {
  2704. mod_data.transport_type = USB_PR_CBI;
  2705. mod_data.transport_name = "Control-Bulk-Interrupt";
  2706. } else {
  2707. ERROR(fsg, "invalid transport: %s\n", mod_data.transport_parm);
  2708. return -EINVAL;
  2709. }
  2710. if (strnicmp(mod_data.protocol_parm, "SCSI", 10) == 0 ||
  2711. prot == USB_SC_SCSI) {
  2712. ; // Use default setting
  2713. } else if (strnicmp(mod_data.protocol_parm, "RBC", 10) == 0 ||
  2714. prot == USB_SC_RBC) {
  2715. mod_data.protocol_type = USB_SC_RBC;
  2716. mod_data.protocol_name = "RBC";
  2717. } else if (strnicmp(mod_data.protocol_parm, "8020", 4) == 0 ||
  2718. strnicmp(mod_data.protocol_parm, "ATAPI", 10) == 0 ||
  2719. prot == USB_SC_8020) {
  2720. mod_data.protocol_type = USB_SC_8020;
  2721. mod_data.protocol_name = "8020i (ATAPI)";
  2722. } else if (strnicmp(mod_data.protocol_parm, "QIC", 3) == 0 ||
  2723. prot == USB_SC_QIC) {
  2724. mod_data.protocol_type = USB_SC_QIC;
  2725. mod_data.protocol_name = "QIC-157";
  2726. } else if (strnicmp(mod_data.protocol_parm, "UFI", 10) == 0 ||
  2727. prot == USB_SC_UFI) {
  2728. mod_data.protocol_type = USB_SC_UFI;
  2729. mod_data.protocol_name = "UFI";
  2730. } else if (strnicmp(mod_data.protocol_parm, "8070", 4) == 0 ||
  2731. prot == USB_SC_8070) {
  2732. mod_data.protocol_type = USB_SC_8070;
  2733. mod_data.protocol_name = "8070i";
  2734. } else {
  2735. ERROR(fsg, "invalid protocol: %s\n", mod_data.protocol_parm);
  2736. return -EINVAL;
  2737. }
  2738. mod_data.buflen &= PAGE_CACHE_MASK;
  2739. if (mod_data.buflen <= 0) {
  2740. ERROR(fsg, "invalid buflen\n");
  2741. return -ETOOSMALL;
  2742. }
  2743. #endif /* CONFIG_USB_FILE_STORAGE_TEST */
  2744. /* Serial string handling.
  2745. * On a real device, the serial string would be loaded
  2746. * from permanent storage. */
  2747. if (mod_data.serial) {
  2748. const char *ch;
  2749. unsigned len = 0;
  2750. /* Sanity check :
  2751. * The CB[I] specification limits the serial string to
  2752. * 12 uppercase hexadecimal characters.
  2753. * BBB need at least 12 uppercase hexadecimal characters,
  2754. * with a maximum of 126. */
  2755. for (ch = mod_data.serial; *ch; ++ch) {
  2756. ++len;
  2757. if ((*ch < '0' || *ch > '9') &&
  2758. (*ch < 'A' || *ch > 'F')) { /* not uppercase hex */
  2759. WARNING(fsg,
  2760. "Invalid serial string character: %c\n",
  2761. *ch);
  2762. goto no_serial;
  2763. }
  2764. }
  2765. if (len > 126 ||
  2766. (mod_data.transport_type == USB_PR_BULK && len < 12) ||
  2767. (mod_data.transport_type != USB_PR_BULK && len > 12)) {
  2768. WARNING(fsg, "Invalid serial string length!\n");
  2769. goto no_serial;
  2770. }
  2771. fsg_strings[FSG_STRING_SERIAL - 1].s = mod_data.serial;
  2772. } else {
  2773. WARNING(fsg, "No serial-number string provided!\n");
  2774. no_serial:
  2775. device_desc.iSerialNumber = 0;
  2776. }
  2777. return 0;
  2778. }
  2779. static int __init fsg_bind(struct usb_gadget *gadget)
  2780. {
  2781. struct fsg_dev *fsg = the_fsg;
  2782. int rc;
  2783. int i;
  2784. struct fsg_lun *curlun;
  2785. struct usb_ep *ep;
  2786. struct usb_request *req;
  2787. char *pathbuf, *p;
  2788. fsg->gadget = gadget;
  2789. set_gadget_data(gadget, fsg);
  2790. fsg->ep0 = gadget->ep0;
  2791. fsg->ep0->driver_data = fsg;
  2792. if ((rc = check_parameters(fsg)) != 0)
  2793. goto out;
  2794. if (mod_data.removable) { // Enable the store_xxx attributes
  2795. dev_attr_file.attr.mode = 0644;
  2796. dev_attr_file.store = fsg_store_file;
  2797. if (!mod_data.cdrom) {
  2798. dev_attr_ro.attr.mode = 0644;
  2799. dev_attr_ro.store = fsg_store_ro;
  2800. }
  2801. }
  2802. /* Only for removable media? */
  2803. dev_attr_nofua.attr.mode = 0644;
  2804. dev_attr_nofua.store = fsg_store_nofua;
  2805. /* Find out how many LUNs there should be */
  2806. i = mod_data.nluns;
  2807. if (i == 0)
  2808. i = max(mod_data.num_filenames, 1u);
  2809. if (i > FSG_MAX_LUNS) {
  2810. ERROR(fsg, "invalid number of LUNs: %d\n", i);
  2811. rc = -EINVAL;
  2812. goto out;
  2813. }
  2814. /* Create the LUNs, open their backing files, and register the
  2815. * LUN devices in sysfs. */
  2816. fsg->luns = kzalloc(i * sizeof(struct fsg_lun), GFP_KERNEL);
  2817. if (!fsg->luns) {
  2818. rc = -ENOMEM;
  2819. goto out;
  2820. }
  2821. fsg->nluns = i;
  2822. for (i = 0; i < fsg->nluns; ++i) {
  2823. curlun = &fsg->luns[i];
  2824. curlun->cdrom = !!mod_data.cdrom;
  2825. curlun->ro = mod_data.cdrom || mod_data.ro[i];
  2826. curlun->initially_ro = curlun->ro;
  2827. curlun->removable = mod_data.removable;
  2828. curlun->nofua = mod_data.nofua[i];
  2829. curlun->dev.release = lun_release;
  2830. curlun->dev.parent = &gadget->dev;
  2831. curlun->dev.driver = &fsg_driver.driver;
  2832. dev_set_drvdata(&curlun->dev, &fsg->filesem);
  2833. dev_set_name(&curlun->dev,"%s-lun%d",
  2834. dev_name(&gadget->dev), i);
  2835. kref_get(&fsg->ref);
  2836. rc = device_register(&curlun->dev);
  2837. if (rc) {
  2838. INFO(fsg, "failed to register LUN%d: %d\n", i, rc);
  2839. put_device(&curlun->dev);
  2840. goto out;
  2841. }
  2842. curlun->registered = 1;
  2843. rc = device_create_file(&curlun->dev, &dev_attr_ro);
  2844. if (rc)
  2845. goto out;
  2846. rc = device_create_file(&curlun->dev, &dev_attr_nofua);
  2847. if (rc)
  2848. goto out;
  2849. rc = device_create_file(&curlun->dev, &dev_attr_file);
  2850. if (rc)
  2851. goto out;
  2852. if (mod_data.file[i] && *mod_data.file[i]) {
  2853. rc = fsg_lun_open(curlun, mod_data.file[i]);
  2854. if (rc)
  2855. goto out;
  2856. } else if (!mod_data.removable) {
  2857. ERROR(fsg, "no file given for LUN%d\n", i);
  2858. rc = -EINVAL;
  2859. goto out;
  2860. }
  2861. }
  2862. /* Find all the endpoints we will use */
  2863. usb_ep_autoconfig_reset(gadget);
  2864. ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_in_desc);
  2865. if (!ep)
  2866. goto autoconf_fail;
  2867. ep->driver_data = fsg; // claim the endpoint
  2868. fsg->bulk_in = ep;
  2869. ep = usb_ep_autoconfig(gadget, &fsg_fs_bulk_out_desc);
  2870. if (!ep)
  2871. goto autoconf_fail;
  2872. ep->driver_data = fsg; // claim the endpoint
  2873. fsg->bulk_out = ep;
  2874. if (transport_is_cbi()) {
  2875. ep = usb_ep_autoconfig(gadget, &fsg_fs_intr_in_desc);
  2876. if (!ep)
  2877. goto autoconf_fail;
  2878. ep->driver_data = fsg; // claim the endpoint
  2879. fsg->intr_in = ep;
  2880. }
  2881. /* Fix up the descriptors */
  2882. device_desc.idVendor = cpu_to_le16(mod_data.vendor);
  2883. device_desc.idProduct = cpu_to_le16(mod_data.product);
  2884. device_desc.bcdDevice = cpu_to_le16(mod_data.release);
  2885. i = (transport_is_cbi() ? 3 : 2); // Number of endpoints
  2886. fsg_intf_desc.bNumEndpoints = i;
  2887. fsg_intf_desc.bInterfaceSubClass = mod_data.protocol_type;
  2888. fsg_intf_desc.bInterfaceProtocol = mod_data.transport_type;
  2889. fsg_fs_function[i + FSG_FS_FUNCTION_PRE_EP_ENTRIES] = NULL;
  2890. if (gadget_is_dualspeed(gadget)) {
  2891. fsg_hs_function[i + FSG_HS_FUNCTION_PRE_EP_ENTRIES] = NULL;
  2892. /* Assume endpoint addresses are the same for both speeds */
  2893. fsg_hs_bulk_in_desc.bEndpointAddress =
  2894. fsg_fs_bulk_in_desc.bEndpointAddress;
  2895. fsg_hs_bulk_out_desc.bEndpointAddress =
  2896. fsg_fs_bulk_out_desc.bEndpointAddress;
  2897. fsg_hs_intr_in_desc.bEndpointAddress =
  2898. fsg_fs_intr_in_desc.bEndpointAddress;
  2899. }
  2900. if (gadget_is_otg(gadget))
  2901. fsg_otg_desc.bmAttributes |= USB_OTG_HNP;
  2902. rc = -ENOMEM;
  2903. /* Allocate the request and buffer for endpoint 0 */
  2904. fsg->ep0req = req = usb_ep_alloc_request(fsg->ep0, GFP_KERNEL);
  2905. if (!req)
  2906. goto out;
  2907. req->buf = kmalloc(EP0_BUFSIZE, GFP_KERNEL);
  2908. if (!req->buf)
  2909. goto out;
  2910. req->complete = ep0_complete;
  2911. /* Allocate the data buffers */
  2912. for (i = 0; i < fsg_num_buffers; ++i) {
  2913. struct fsg_buffhd *bh = &fsg->buffhds[i];
  2914. /* Allocate for the bulk-in endpoint. We assume that
  2915. * the buffer will also work with the bulk-out (and
  2916. * interrupt-in) endpoint. */
  2917. bh->buf = kmalloc(mod_data.buflen, GFP_KERNEL);
  2918. if (!bh->buf)
  2919. goto out;
  2920. bh->next = bh + 1;
  2921. }
  2922. fsg->buffhds[fsg_num_buffers - 1].next = &fsg->buffhds[0];
  2923. /* This should reflect the actual gadget power source */
  2924. usb_gadget_set_selfpowered(gadget);
  2925. snprintf(fsg_string_manufacturer, sizeof fsg_string_manufacturer,
  2926. "%s %s with %s",
  2927. init_utsname()->sysname, init_utsname()->release,
  2928. gadget->name);
  2929. fsg->thread_task = kthread_create(fsg_main_thread, fsg,
  2930. "file-storage-gadget");
  2931. if (IS_ERR(fsg->thread_task)) {
  2932. rc = PTR_ERR(fsg->thread_task);
  2933. goto out;
  2934. }
  2935. INFO(fsg, DRIVER_DESC ", version: " DRIVER_VERSION "\n");
  2936. INFO(fsg, "NOTE: This driver is deprecated. "
  2937. "Consider using g_mass_storage instead.\n");
  2938. INFO(fsg, "Number of LUNs=%d\n", fsg->nluns);
  2939. pathbuf = kmalloc(PATH_MAX, GFP_KERNEL);
  2940. for (i = 0; i < fsg->nluns; ++i) {
  2941. curlun = &fsg->luns[i];
  2942. if (fsg_lun_is_open(curlun)) {
  2943. p = NULL;
  2944. if (pathbuf) {
  2945. p = d_path(&curlun->filp->f_path,
  2946. pathbuf, PATH_MAX);
  2947. if (IS_ERR(p))
  2948. p = NULL;
  2949. }
  2950. LINFO(curlun, "ro=%d, nofua=%d, file: %s\n",
  2951. curlun->ro, curlun->nofua, (p ? p : "(error)"));
  2952. }
  2953. }
  2954. kfree(pathbuf);
  2955. DBG(fsg, "transport=%s (x%02x)\n",
  2956. mod_data.transport_name, mod_data.transport_type);
  2957. DBG(fsg, "protocol=%s (x%02x)\n",
  2958. mod_data.protocol_name, mod_data.protocol_type);
  2959. DBG(fsg, "VendorID=x%04x, ProductID=x%04x, Release=x%04x\n",
  2960. mod_data.vendor, mod_data.product, mod_data.release);
  2961. DBG(fsg, "removable=%d, stall=%d, cdrom=%d, buflen=%u\n",
  2962. mod_data.removable, mod_data.can_stall,
  2963. mod_data.cdrom, mod_data.buflen);
  2964. DBG(fsg, "I/O thread pid: %d\n", task_pid_nr(fsg->thread_task));
  2965. set_bit(REGISTERED, &fsg->atomic_bitflags);
  2966. /* Tell the thread to start working */
  2967. wake_up_process(fsg->thread_task);
  2968. return 0;
  2969. autoconf_fail:
  2970. ERROR(fsg, "unable to autoconfigure all endpoints\n");
  2971. rc = -ENOTSUPP;
  2972. out:
  2973. fsg->state = FSG_STATE_TERMINATED; // The thread is dead
  2974. fsg_unbind(gadget);
  2975. complete(&fsg->thread_notifier);
  2976. return rc;
  2977. }
  2978. /*-------------------------------------------------------------------------*/
  2979. static void fsg_suspend(struct usb_gadget *gadget)
  2980. {
  2981. struct fsg_dev *fsg = get_gadget_data(gadget);
  2982. DBG(fsg, "suspend\n");
  2983. set_bit(SUSPENDED, &fsg->atomic_bitflags);
  2984. }
  2985. static void fsg_resume(struct usb_gadget *gadget)
  2986. {
  2987. struct fsg_dev *fsg = get_gadget_data(gadget);
  2988. DBG(fsg, "resume\n");
  2989. clear_bit(SUSPENDED, &fsg->atomic_bitflags);
  2990. }
  2991. /*-------------------------------------------------------------------------*/
  2992. static struct usb_gadget_driver fsg_driver = {
  2993. #ifdef CONFIG_USB_GADGET_DUALSPEED
  2994. .speed = USB_SPEED_HIGH,
  2995. #else
  2996. .speed = USB_SPEED_FULL,
  2997. #endif
  2998. .function = (char *) fsg_string_product,
  2999. .unbind = fsg_unbind,
  3000. .disconnect = fsg_disconnect,
  3001. .setup = fsg_setup,
  3002. .suspend = fsg_suspend,
  3003. .resume = fsg_resume,
  3004. .driver = {
  3005. .name = DRIVER_NAME,
  3006. .owner = THIS_MODULE,
  3007. // .release = ...
  3008. // .suspend = ...
  3009. // .resume = ...
  3010. },
  3011. };
  3012. static int __init fsg_alloc(void)
  3013. {
  3014. struct fsg_dev *fsg;
  3015. fsg = kzalloc(sizeof *fsg +
  3016. fsg_num_buffers * sizeof *(fsg->buffhds), GFP_KERNEL);
  3017. if (!fsg)
  3018. return -ENOMEM;
  3019. spin_lock_init(&fsg->lock);
  3020. init_rwsem(&fsg->filesem);
  3021. kref_init(&fsg->ref);
  3022. init_completion(&fsg->thread_notifier);
  3023. the_fsg = fsg;
  3024. return 0;
  3025. }
  3026. static int __init fsg_init(void)
  3027. {
  3028. int rc;
  3029. struct fsg_dev *fsg;
  3030. rc = fsg_num_buffers_validate();
  3031. if (rc != 0)
  3032. return rc;
  3033. if ((rc = fsg_alloc()) != 0)
  3034. return rc;
  3035. fsg = the_fsg;
  3036. if ((rc = usb_gadget_probe_driver(&fsg_driver, fsg_bind)) != 0)
  3037. kref_put(&fsg->ref, fsg_release);
  3038. return rc;
  3039. }
  3040. module_init(fsg_init);
  3041. static void __exit fsg_cleanup(void)
  3042. {
  3043. struct fsg_dev *fsg = the_fsg;
  3044. /* Unregister the driver iff the thread hasn't already done so */
  3045. if (test_and_clear_bit(REGISTERED, &fsg->atomic_bitflags))
  3046. usb_gadget_unregister_driver(&fsg_driver);
  3047. /* Wait for the thread to finish up */
  3048. wait_for_completion(&fsg->thread_notifier);
  3049. kref_put(&fsg->ref, fsg_release);
  3050. }
  3051. module_exit(fsg_cleanup);