file_storage.c 103 KB

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