file_storage.c 104 KB

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