file_storage.c 103 KB

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