123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825 |
- //*****************************************************************************
- //
- // usb.c - Driver for the USB Interface.
- //
- // Copyright (c) 2007-2010 Texas Instruments Incorporated. All rights reserved.
- // Software License Agreement
- //
- // Texas Instruments (TI) is supplying this software for use solely and
- // exclusively on TI's microcontroller products. The software is owned by
- // TI and/or its suppliers, and is protected under applicable copyright
- // laws. You may not combine this software with "viral" open-source
- // software in order to form a larger program.
- //
- // THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
- // NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
- // NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- // A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
- // CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
- // DAMAGES, FOR ANY REASON WHATSOEVER.
- //
- // This is part of revision 6459 of the Stellaris Peripheral Driver Library.
- //
- //*****************************************************************************
- //*****************************************************************************
- //
- //! \addtogroup usb_api
- //! @{
- //
- //*****************************************************************************
- #include "inc/hw_ints.h"
- #include "inc/hw_memmap.h"
- #include "inc/hw_types.h"
- #include "inc/hw_usb.h"
- #include "driverlib/debug.h"
- #include "driverlib/interrupt.h"
- #include "driverlib/udma.h"
- #include "driverlib/usb.h"
- //*****************************************************************************
- //
- // Amount to shift the RX interrupt sources by in the flags used in the
- // interrupt calls.
- //
- //*****************************************************************************
- #ifndef DEPRECATED
- #define USB_INT_RX_SHIFT 8
- #endif
- #define USB_INTEP_RX_SHIFT 16
- //*****************************************************************************
- //
- // Amount to shift the status interrupt sources by in the flags used in the
- // interrupt calls.
- //
- //*****************************************************************************
- #ifndef DEPRECATED
- #define USB_INT_STATUS_SHIFT 24
- #endif
- //*****************************************************************************
- //
- // Amount to shift the RX endpoint status sources by in the flags used in the
- // calls.
- //
- //*****************************************************************************
- #define USB_RX_EPSTATUS_SHIFT 16
- //*****************************************************************************
- //
- // Converts from an endpoint specifier to the offset of the endpoint's
- // control/status registers.
- //
- //*****************************************************************************
- #define EP_OFFSET(Endpoint) (Endpoint - 0x10)
- //*****************************************************************************
- //
- // Sets one of the indexed registers.
- //
- // \param ulBase specifies the USB module base address.
- // \param ulEndpoint is the endpoint index to target for this write.
- // \param ulIndexedReg is the indexed register to write to.
- // \param ucValue is the value to write to the register.
- //
- // This function is used to access the indexed registers for each endpoint.
- // The only registers that are indexed are the FIFO configuration registers
- // which are not used after configuration.
- //
- // \return None.
- //
- //*****************************************************************************
- static void
- USBIndexWrite(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulIndexedReg, unsigned long ulValue,
- unsigned long ulSize)
- {
- unsigned long ulIndex;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == 0) || (ulEndpoint == 1) || (ulEndpoint == 2) ||
- (ulEndpoint == 3));
- ASSERT((ulSize == 1) || (ulSize == 2));
- //
- // Save the old index in case it was in use.
- //
- ulIndex = HWREGB(ulBase + USB_O_EPIDX);
- //
- // Set the index.
- //
- HWREGB(ulBase + USB_O_EPIDX) = ulEndpoint;
- //
- // Determine the size of the register value.
- //
- if(ulSize == 1)
- {
- //
- // Set the value.
- //
- HWREGB(ulBase + ulIndexedReg) = ulValue;
- }
- else
- {
- //
- // Set the value.
- //
- HWREGH(ulBase + ulIndexedReg) = ulValue;
- }
- //
- // Restore the old index in case it was in use.
- //
- HWREGB(ulBase + USB_O_EPIDX) = ulIndex;
- }
- //*****************************************************************************
- //
- // Reads one of the indexed registers.
- //
- // \param ulBase specifies the USB module base address.
- // \param ulEndpoint is the endpoint index to target for this write.
- // \param ulIndexedReg is the indexed register to write to.
- //
- // This function is used internally to access the indexed registers for each
- // endpoint. The only registers that are indexed are the FIFO configuration
- // registers which are not used after configuration.
- //
- // \return The value in the register requested.
- //
- //*****************************************************************************
- static unsigned long
- USBIndexRead(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulIndexedReg, unsigned long ulSize)
- {
- unsigned char ulIndex;
- unsigned char ulValue;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == 0) || (ulEndpoint == 1) || (ulEndpoint == 2) ||
- (ulEndpoint == 3));
- ASSERT((ulSize == 1) || (ulSize == 2));
- //
- // Save the old index in case it was in use.
- //
- ulIndex = HWREGB(ulBase + USB_O_EPIDX);
- //
- // Set the index.
- //
- HWREGB(ulBase + USB_O_EPIDX) = ulEndpoint;
- //
- // Determine the size of the register value.
- //
- if(ulSize == 1)
- {
- //
- // Get the value.
- //
- ulValue = HWREGB(ulBase + ulIndexedReg);
- }
- else
- {
- //
- // Get the value.
- //
- ulValue = HWREGH(ulBase + ulIndexedReg);
- }
- //
- // Restore the old index in case it was in use.
- //
- HWREGB(ulBase + USB_O_EPIDX) = ulIndex;
- //
- // Return the register's value.
- //
- return(ulValue);
- }
- //*****************************************************************************
- //
- //! Puts the USB bus in a suspended state.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! When used in host mode, this function will put the USB bus in the suspended
- //! state.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostSuspend(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Send the suspend signaling to the USB bus.
- //
- HWREGB(ulBase + USB_O_POWER) |= USB_POWER_SUSPEND;
- }
- //*****************************************************************************
- //
- //! Handles the USB bus reset condition.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param bStart specifies whether to start or stop signaling reset on the USB
- //! bus.
- //!
- //! When this function is called with the \e bStart parameter set to \b true,
- //! this function will cause the start of a reset condition on the USB bus.
- //! The caller should then delay at least 20ms before calling this function
- //! again with the \e bStart parameter set to \b false.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostReset(unsigned long ulBase, tBoolean bStart)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Send a reset signal to the bus.
- //
- if(bStart)
- {
- HWREGB(ulBase + USB_O_POWER) |= USB_POWER_RESET;
- }
- else
- {
- HWREGB(ulBase + USB_O_POWER) &= ~USB_POWER_RESET;
- }
- }
- //*****************************************************************************
- //
- //! Handles the USB bus resume condition.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param bStart specifies if the USB controller is entering or leaving the
- //! resume signaling state.
- //!
- //! When in device mode this function will bring the USB controller out of the
- //! suspend state. This call should first be made with the \e bStart parameter
- //! set to \b true to start resume signaling. The device application should
- //! then delay at least 10ms but not more than 15ms before calling this
- //! function with the \e bStart parameter set to \b false.
- //!
- //! When in host mode this function will signal devices to leave the suspend
- //! state. This call should first be made with the \e bStart parameter set to
- //! \b true to start resume signaling. The host application should then delay
- //! at least 20ms before calling this function with the \e bStart parameter set
- //! to \b false. This will cause the controller to complete the resume
- //! signaling on the USB bus.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostResume(unsigned long ulBase, tBoolean bStart)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Send a resume signal to the bus.
- //
- if(bStart)
- {
- HWREGB(ulBase + USB_O_POWER) |= USB_POWER_RESUME;
- }
- else
- {
- HWREGB(ulBase + USB_O_POWER) &= ~USB_POWER_RESUME;
- }
- }
- //*****************************************************************************
- //
- //! Returns the current speed of the USB device connected.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will return the current speed of the USB bus.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return Returns either \b USB_LOW_SPEED, \b USB_FULL_SPEED, or
- //! \b USB_UNDEF_SPEED.
- //
- //*****************************************************************************
- unsigned long
- USBHostSpeedGet(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // If the Full Speed device bit is set, then this is a full speed device.
- //
- if(HWREGB(ulBase + USB_O_DEVCTL) & USB_DEVCTL_FSDEV)
- {
- return(USB_FULL_SPEED);
- }
- //
- // If the Low Speed device bit is set, then this is a low speed device.
- //
- if(HWREGB(ulBase + USB_O_DEVCTL) & USB_DEVCTL_LSDEV)
- {
- return(USB_LOW_SPEED);
- }
- //
- // The device speed is not known.
- //
- return(USB_UNDEF_SPEED);
- }
- //*****************************************************************************
- //
- //! Returns the status of the USB interrupts.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will read the source of the interrupt for the USB controller.
- //! There are three groups of interrupt sources, IN Endpoints, OUT Endpoints,
- //! and general status changes. This call will return the current status for
- //! all of these interrupts. The bit values returned should be compared
- //! against the \b USB_HOST_IN, \b USB_HOST_OUT, \b USB_HOST_EP0,
- //! \b USB_DEV_IN, \b USB_DEV_OUT, and \b USB_DEV_EP0 values.
- //!
- //! \note This call will clear the source of all of the general status
- //! interrupts.
- //!
- //! \note WARNING: This API cannot be used on endpoint numbers greater than
- //! endpoint 3 so USBIntStatusControl() or USBIntStatusEndpoint() should be
- //! used instead.
- //!
- //! \return Returns the status of the sources for the USB controller's
- //! interrupt.
- //
- //*****************************************************************************
- #ifndef DEPRECATED
- unsigned long
- USBIntStatus(unsigned long ulBase)
- {
- unsigned long ulStatus;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Get the transmit interrupt status.
- //
- ulStatus = (HWREGB(ulBase + USB_O_TXIS));
- //
- // Get the receive interrupt status, these bits go into the second byte of
- // the returned value.
- //
- ulStatus |= (HWREGB(ulBase + USB_O_RXIS) << USB_INT_RX_SHIFT);
- //
- // Get the general interrupt status, these bits go into the upper 8 bits
- // of the returned value.
- //
- ulStatus |= (HWREGB(ulBase + USB_O_IS) << USB_INT_STATUS_SHIFT);
- //
- // Add the power fault status.
- //
- if(HWREG(ulBase + USB_O_EPCISC) & USB_EPCISC_PF)
- {
- //
- // Indicate a power fault was detected.
- //
- ulStatus |= USB_INT_POWER_FAULT;
- //
- // Clear the power fault interrupt.
- //
- HWREGB(ulBase + USB_O_EPCISC) |= USB_EPCISC_PF;
- }
- if(HWREG(USB0_BASE + USB_O_IDVISC) & USB_IDVRIS_ID)
- {
- //
- // Indicate a id detection was detected.
- //
- ulStatus |= USB_INT_MODE_DETECT;
- //
- // Clear the id detection interrupt.
- //
- HWREG(USB0_BASE + USB_O_IDVISC) |= USB_IDVRIS_ID;
- }
- //
- // Return the combined interrupt status.
- //
- return(ulStatus);
- }
- #endif
- //*****************************************************************************
- //
- //! Disables the sources for USB interrupts.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies which interrupts to disable.
- //!
- //! This function will disable the USB controller from generating the
- //! interrupts indicated by the \e ulFlags parameter. There are three groups
- //! of interrupt sources, IN Endpoints, OUT Endpoints, and general status
- //! changes, specified by \b USB_INT_HOST_IN, \b USB_INT_HOST_OUT,
- //! \b USB_INT_DEV_IN, \b USB_INT_DEV_OUT, and \b USB_INT_STATUS. If
- //! \b USB_INT_ALL is specified then all interrupts will be disabled.
- //!
- //! \note WARNING: This API cannot be used on endpoint numbers greater than
- //! endpoint 3 so USBIntDisableControl() or USBIntDisableEndpoint() should be
- //! used instead.
- //!
- //! \return None.
- //
- //*****************************************************************************
- #ifndef DEPRECATED
- void
- USBIntDisable(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulFlags & ~(USB_INT_ALL)) == 0);
- //
- // If any transmit interrupts were disabled then write the transmit
- // interrupt settings out to the hardware.
- //
- if(ulFlags & (USB_INT_HOST_OUT | USB_INT_DEV_IN | USB_INT_EP0))
- {
- HWREGH(ulBase + USB_O_TXIE) &=
- ~(ulFlags & (USB_INT_HOST_OUT | USB_INT_DEV_IN | USB_INT_EP0));
- }
- //
- // If any receive interrupts were disabled then write the receive interrupt
- // settings out to the hardware.
- //
- if(ulFlags & (USB_INT_HOST_IN | USB_INT_DEV_OUT))
- {
- HWREGH(ulBase + USB_O_RXIE) &=
- ~((ulFlags & (USB_INT_HOST_IN | USB_INT_DEV_OUT)) >>
- USB_INT_RX_SHIFT);
- }
- //
- // If any general interrupts were disabled then write the general interrupt
- // settings out to the hardware.
- //
- if(ulFlags & USB_INT_STATUS)
- {
- HWREGB(ulBase + USB_O_IE) &=
- ~((ulFlags & USB_INT_STATUS) >> USB_INT_STATUS_SHIFT);
- }
- //
- // Disable the power fault interrupt.
- //
- if(ulFlags & USB_INT_POWER_FAULT)
- {
- HWREG(ulBase + USB_O_EPCIM) = 0;
- }
- //
- // Disable the ID pin detect interrupt.
- //
- if(ulFlags & USB_INT_MODE_DETECT)
- {
- HWREG(USB0_BASE + USB_O_IDVIM) = 0;
- }
- }
- #endif
- //*****************************************************************************
- //
- //! Enables the sources for USB interrupts.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies which interrupts to enable.
- //!
- //! This function will enable the USB controller's ability to generate the
- //! interrupts indicated by the \e ulFlags parameter. There are three
- //! groups of interrupt sources, IN Endpoints, OUT Endpoints, and
- //! general status changes, specified by \b USB_INT_HOST_IN,
- //! \b USB_INT_HOST_OUT, \b USB_INT_DEV_IN, \b USB_INT_DEV_OUT, and
- //! \b USB_STATUS. If \b USB_INT_ALL is specified then all interrupts will be
- //! enabled.
- //!
- //! \note A call must be made to enable the interrupt in the main interrupt
- //! controller to receive interrupts. The USBIntRegister() API performs this
- //! controller level interrupt enable. However if static interrupt handlers
- //! are used then then a call to IntEnable() must be made in order to allow any
- //! USB interrupts to occur.
- //!
- //! \note WARNING: This API cannot be used on endpoint numbers greater than
- //! endpoint 3 so USBIntEnableControl() or USBIntEnableEndpoint() should be
- //! used instead.
- //!
- //! \return None.
- //
- //*****************************************************************************
- #ifndef DEPRECATED
- void
- USBIntEnable(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulFlags & (~USB_INT_ALL)) == 0);
- //
- // If any transmit interrupts were enabled then write the transmit
- // interrupt settings out to the hardware.
- //
- if(ulFlags & (USB_INT_HOST_OUT | USB_INT_DEV_IN | USB_INT_EP0))
- {
- HWREGH(ulBase + USB_O_TXIE) |=
- ulFlags & (USB_INT_HOST_OUT | USB_INT_DEV_IN | USB_INT_EP0);
- }
- //
- // If any receive interrupts were enabled then write the receive interrupt
- // settings out to the hardware.
- //
- if(ulFlags & (USB_INT_HOST_IN | USB_INT_DEV_OUT))
- {
- HWREGH(ulBase + USB_O_RXIE) |=
- ((ulFlags & (USB_INT_HOST_IN | USB_INT_DEV_OUT)) >>
- USB_INT_RX_SHIFT);
- }
- //
- // If any general interrupts were enabled then write the general interrupt
- // settings out to the hardware.
- //
- if(ulFlags & USB_INT_STATUS)
- {
- HWREGB(ulBase + USB_O_IE) |=
- (ulFlags & USB_INT_STATUS) >> USB_INT_STATUS_SHIFT;
- }
- //
- // Enable the power fault interrupt.
- //
- if(ulFlags & USB_INT_POWER_FAULT)
- {
- HWREG(ulBase + USB_O_EPCIM) = USB_EPCIM_PF;
- }
- //
- // Enable the ID pin detect interrupt.
- //
- if(ulFlags & USB_INT_MODE_DETECT)
- {
- HWREG(USB0_BASE + USB_O_IDVIM) = USB_IDVIM_ID;
- }
- }
- #endif
- //*****************************************************************************
- //
- //! Disable control interrupts on a given USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies which control interrupts to disable.
- //!
- //! This function will disable the control interrupts for the USB controller
- //! specified by the \e ulBase parameter. The \e ulFlags parameter specifies
- //! which control interrupts to disable. The flags passed in the \e ulFlags
- //! parameters should be the definitions that start with \b USB_INTCTRL_* and
- //! not any other \b USB_INT flags.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBIntDisableControl(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulFlags & ~(USB_INTCTRL_ALL)) == 0);
- //
- // If any general interrupts were disabled then write the general interrupt
- // settings out to the hardware.
- //
- if(ulFlags & USB_INTCTRL_STATUS)
- {
- HWREGB(ulBase + USB_O_IE) &= ~(ulFlags & USB_INTCTRL_STATUS);
- }
- //
- // Disable the power fault interrupt.
- //
- if(ulFlags & USB_INTCTRL_POWER_FAULT)
- {
- HWREG(ulBase + USB_O_EPCIM) = 0;
- }
- //
- // Disable the ID pin detect interrupt.
- //
- if(ulFlags & USB_INTCTRL_MODE_DETECT)
- {
- HWREG(USB0_BASE + USB_O_IDVIM) = 0;
- }
- }
- //*****************************************************************************
- //
- //! Enable control interrupts on a given USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies which control interrupts to enable.
- //!
- //! This function will enable the control interrupts for the USB controller
- //! specified by the \e ulBase parameter. The \e ulFlags parameter specifies
- //! which control interrupts to enable. The flags passed in the \e ulFlags
- //! parameters should be the definitions that start with \b USB_INTCTRL_* and
- //! not any other \b USB_INT flags.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBIntEnableControl(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulFlags & (~USB_INTCTRL_ALL)) == 0);
- //
- // If any general interrupts were enabled then write the general interrupt
- // settings out to the hardware.
- //
- if(ulFlags & USB_INTCTRL_STATUS)
- {
- HWREGB(ulBase + USB_O_IE) |= ulFlags;
- }
- //
- // Enable the power fault interrupt.
- //
- if(ulFlags & USB_INTCTRL_POWER_FAULT)
- {
- HWREG(ulBase + USB_O_EPCIM) = USB_EPCIM_PF;
- }
- //
- // Enable the ID pin detect interrupt.
- //
- if(ulFlags & USB_INTCTRL_MODE_DETECT)
- {
- HWREG(USB0_BASE + USB_O_IDVIM) = USB_IDVIM_ID;
- }
- }
- //*****************************************************************************
- //
- //! Returns the control interrupt status on a given USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will read control interrupt status for a USB controller.
- //! This call will return the current status for control interrupts only, the
- //! endpoint interrupt status is retrieved by calling USBIntStatusEndpoint().
- //! The bit values returned should be compared against the \b USB_INTCTRL_*
- //! values.
- //!
- //! The following are the meanings of all \b USB_INCTRL_ flags and the modes
- //! for which they are valid. These values apply to any calls to
- //! USBIntStatusControl(), USBIntEnableControl(), and USBIntDisableConrol().
- //! Some of these flags are only valid in the following modes as indicated in
- //! the parenthesis: Host, Device, and OTG.
- //!
- //! - \b USB_INTCTRL_ALL - A full mask of all control interrupt sources.
- //! - \b USB_INTCTRL_VBUS_ERR - A VBUS error has occurred (Host Only).
- //! - \b USB_INTCTRL_SESSION - Session Start Detected on A-side of cable
- //! (OTG Only).
- //! - \b USB_INTCTRL_SESSION_END - Session End Detected (Device Only)
- //! - \b USB_INTCTRL_DISCONNECT - Device Disconnect Detected (Host Only)
- //! - \b USB_INTCTRL_CONNECT - Device Connect Detected (Host Only)
- //! - \b USB_INTCTRL_SOF - Start of Frame Detected.
- //! - \b USB_INTCTRL_BABBLE - USB controller detected a device signaling past
- //! the end of a frame. (Host Only)
- //! - \b USB_INTCTRL_RESET - Reset signaling detected by device. (Device Only)
- //! - \b USB_INTCTRL_RESUME - Resume signaling detected.
- //! - \b USB_INTCTRL_SUSPEND - Suspend signaling detected by device (Device
- //! Only)
- //! - \b USB_INTCTRL_MODE_DETECT - OTG cable mode detection has completed
- //! (OTG Only)
- //! - \b USB_INTCTRL_POWER_FAULT - Power Fault detected. (Host Only)
- //!
- //! \note This call will clear the source of all of the control status
- //! interrupts.
- //!
- //! \return Returns the status of the control interrupts for a USB controller.
- //
- //*****************************************************************************
- unsigned long
- USBIntStatusControl(unsigned long ulBase)
- {
- unsigned long ulStatus;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Get the general interrupt status, these bits go into the upper 8 bits
- // of the returned value.
- //
- ulStatus = HWREGB(ulBase + USB_O_IS);
- //
- // Add the power fault status.
- //
- if(HWREG(ulBase + USB_O_EPCISC) & USB_EPCISC_PF)
- {
- //
- // Indicate a power fault was detected.
- //
- ulStatus |= USB_INTCTRL_POWER_FAULT;
- //
- // Clear the power fault interrupt.
- //
- HWREGB(ulBase + USB_O_EPCISC) |= USB_EPCISC_PF;
- }
- if(HWREG(USB0_BASE + USB_O_IDVISC) & USB_IDVRIS_ID)
- {
- //
- // Indicate a id detection was detected.
- //
- ulStatus |= USB_INTCTRL_MODE_DETECT;
- //
- // Clear the id detection interrupt.
- //
- HWREG(USB0_BASE + USB_O_IDVISC) |= USB_IDVRIS_ID;
- }
- //
- // Return the combined interrupt status.
- //
- return(ulStatus);
- }
- //*****************************************************************************
- //
- //! Disable endpoint interrupts on a given USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies which endpoint interrupts to disable.
- //!
- //! This function will disable endpoint interrupts for the USB controller
- //! specified by the \e ulBase parameter. The \e ulFlags parameter specifies
- //! which endpoint interrupts to disable. The flags passed in the \e ulFlags
- //! parameters should be the definitions that start with \b USB_INTEP_* and not
- //! any other \b USB_INT flags.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBIntDisableEndpoint(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // If any transmit interrupts were disabled then write the transmit
- // interrupt settings out to the hardware.
- //
- HWREGH(ulBase + USB_O_TXIE) &=
- ~(ulFlags & (USB_INTEP_HOST_OUT | USB_INTEP_DEV_IN | USB_INTEP_0));
- //
- // If any receive interrupts were disabled then write the receive interrupt
- // settings out to the hardware.
- //
- HWREGH(ulBase + USB_O_RXIE) &=
- ~((ulFlags & (USB_INTEP_HOST_IN | USB_INTEP_DEV_OUT)) >>
- USB_INTEP_RX_SHIFT);
- }
- //*****************************************************************************
- //
- //! Enable endpoint interrupts on a given USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies which endpoint interrupts to enable.
- //!
- //! This function will enable endpoint interrupts for the USB controller
- //! specified by the \e ulBase parameter. The \e ulFlags parameter specifies
- //! which endpoint interrupts to enable. The flags passed in the \e ulFlags
- //! parameters should be the definitions that start with \b USB_INTEP_* and not
- //! any other \b USB_INT flags.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBIntEnableEndpoint(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Enable any transmit endpoint interrupts.
- //
- HWREGH(ulBase + USB_O_TXIE) |=
- ulFlags & (USB_INTEP_HOST_OUT | USB_INTEP_DEV_IN | USB_INTEP_0);
- //
- // Enable any receive endpoint interrupts.
- //
- HWREGH(ulBase + USB_O_RXIE) |=
- ((ulFlags & (USB_INTEP_HOST_IN | USB_INTEP_DEV_OUT)) >>
- USB_INTEP_RX_SHIFT);
- }
- //*****************************************************************************
- //
- //! Returns the endpoint interrupt status on a given USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will read endpoint interrupt status for a USB controller.
- //! This call will return the current status for endpoint interrupts only, the
- //! control interrupt status is retrieved by calling USBIntStatusControl().
- //! The bit values returned should be compared against the \b USB_INTEP_*
- //! values. These are grouped into classes for \b USB_INTEP_HOST_* and
- //! \b USB_INTEP_DEV_* values to handle both host and device modes with all
- //! endpoints.
- //!
- //! \note This call will clear the source of all of the endpoint interrupts.
- //!
- //! \return Returns the status of the endpoint interrupts for a USB controller.
- //
- //*****************************************************************************
- unsigned long
- USBIntStatusEndpoint(unsigned long ulBase)
- {
- unsigned long ulStatus;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Get the transmit interrupt status.
- //
- ulStatus = HWREGH(ulBase + USB_O_TXIS);
- ulStatus |= (HWREGH(ulBase + USB_O_RXIS) << USB_INTEP_RX_SHIFT);
- //
- // Return the combined interrupt status.
- //
- return(ulStatus);
- }
- //*****************************************************************************
- //
- //! Registers an interrupt handler for the USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param pfnHandler is a pointer to the function to be called when a USB
- //! interrupt occurs.
- //!
- //! This sets the handler to be called when a USB interrupt occurs. This will
- //! also enable the global USB interrupt in the interrupt controller. The
- //! specific desired USB interrupts must be enabled via a separate call to
- //! USBIntEnable(). It is the interrupt handler's responsibility to clear the
- //! interrupt sources via a calls to USBIntStatusControl() and
- //! USBIntStatusEndpoint().
- //!
- //! \sa IntRegister() for important information about registering interrupt
- //! handlers.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBIntRegister(unsigned long ulBase, void(*pfnHandler)(void))
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Register the interrupt handler.
- //
- IntRegister(INT_USB0, pfnHandler);
- //
- // Enable the USB interrupt.
- //
- IntEnable(INT_USB0);
- }
- //*****************************************************************************
- //
- //! Unregisters an interrupt handler for the USB controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function unregister the interrupt handler. This function will also
- //! disable the USB interrupt in the interrupt controller.
- //!
- //! \sa IntRegister() for important information about registering or
- //! unregistering interrupt handlers.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBIntUnregister(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Unregister the interrupt handler.
- //
- IntUnregister(INT_USB0);
- //
- // Disable the CAN interrupt.
- //
- IntDisable(INT_USB0);
- }
- //*****************************************************************************
- //
- //! Returns the current status of an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //!
- //! This function will return the status of a given endpoint. If any of these
- //! status bits need to be cleared, then these these values must be cleared by
- //! calling the USBDevEndpointStatusClear() or USBHostEndpointStatusClear()
- //! functions.
- //!
- //! The following are the status flags for host mode:
- //!
- //! - \b USB_HOST_IN_PID_ERROR - PID error on the given endpoint.
- //! - \b USB_HOST_IN_NOT_COMP - The device failed to respond to an IN request.
- //! - \b USB_HOST_IN_STALL - A stall was received on an IN endpoint.
- //! - \b USB_HOST_IN_DATA_ERROR - There was a CRC or bit-stuff error on an IN
- //! endpoint in Isochronous mode.
- //! - \b USB_HOST_IN_NAK_TO - NAKs received on this IN endpoint for more than
- //! the specified timeout period.
- //! - \b USB_HOST_IN_ERROR - Failed to communicate with a device using this IN
- //! endpoint.
- //! - \b USB_HOST_IN_FIFO_FULL - This IN endpoint's FIFO is full.
- //! - \b USB_HOST_IN_PKTRDY - Data packet ready on this IN endpoint.
- //! - \b USB_HOST_OUT_NAK_TO - NAKs received on this OUT endpoint for more than
- //! the specified timeout period.
- //! - \b USB_HOST_OUT_NOT_COMP - The device failed to respond to an OUT
- //! request.
- //! - \b USB_HOST_OUT_STALL - A stall was received on this OUT endpoint.
- //! - \b USB_HOST_OUT_ERROR - Failed to communicate with a device using this
- //! OUT endpoint.
- //! - \b USB_HOST_OUT_FIFO_NE - This endpoint's OUT FIFO is not empty.
- //! - \b USB_HOST_OUT_PKTPEND - The data transfer on this OUT endpoint has not
- //! completed.
- //! - \b USB_HOST_EP0_NAK_TO - NAKs received on endpoint zero for more than the
- //! specified timeout period.
- //! - \b USB_HOST_EP0_ERROR - The device failed to respond to a request on
- //! endpoint zero.
- //! - \b USB_HOST_EP0_IN_STALL - A stall was received on endpoint zero for an
- //! IN transaction.
- //! - \b USB_HOST_EP0_IN_PKTRDY - Data packet ready on endpoint zero for an IN
- //! transaction.
- //!
- //! The following are the status flags for device mode:
- //!
- //! - \b USB_DEV_OUT_SENT_STALL - A stall was sent on this OUT endpoint.
- //! - \b USB_DEV_OUT_DATA_ERROR - There was a CRC or bit-stuff error on an OUT
- //! endpoint.
- //! - \b USB_DEV_OUT_OVERRUN - An OUT packet was not loaded due to a full FIFO.
- //! - \b USB_DEV_OUT_FIFO_FULL - The OUT endpoint's FIFO is full.
- //! - \b USB_DEV_OUT_PKTRDY - There is a data packet ready in the OUT
- //! endpoint's FIFO.
- //! - \b USB_DEV_IN_NOT_COMP - A larger packet was split up, more data to come.
- //! - \b USB_DEV_IN_SENT_STALL - A stall was sent on this IN endpoint.
- //! - \b USB_DEV_IN_UNDERRUN - Data was requested on the IN endpoint and no
- //! data was ready.
- //! - \b USB_DEV_IN_FIFO_NE - The IN endpoint's FIFO is not empty.
- //! - \b USB_DEV_IN_PKTPEND - The data transfer on this IN endpoint has not
- //! completed.
- //! - \b USB_DEV_EP0_SETUP_END - A control transaction ended before Data End
- //! condition was sent.
- //! - \b USB_DEV_EP0_SENT_STALL - A stall was sent on endpoint zero.
- //! - \b USB_DEV_EP0_IN_PKTPEND - The data transfer on endpoint zero has not
- //! completed.
- //! - \b USB_DEV_EP0_OUT_PKTRDY - There is a data packet ready in endpoint
- //! zero's OUT FIFO.
- //!
- //! \return The current status flags for the endpoint depending on mode.
- //
- //*****************************************************************************
- unsigned long
- USBEndpointStatus(unsigned long ulBase, unsigned long ulEndpoint)
- {
- unsigned long ulStatus;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Get the TX portion of the endpoint status.
- //
- ulStatus = HWREGH(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXCSRL1);
- //
- // Get the RX portion of the endpoint status.
- //
- ulStatus |= ((HWREGH(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXCSRL1)) <<
- USB_RX_EPSTATUS_SHIFT);
- //
- // Return the endpoint status.
- //
- return(ulStatus);
- }
- //*****************************************************************************
- //
- //! Clears the status bits in this endpoint in host mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags are the status bits that will be cleared.
- //!
- //! This function will clear the status of any bits that are passed in the
- //! \e ulFlags parameter. The \e ulFlags parameter can take the value returned
- //! from the USBEndpointStatus() call.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostEndpointStatusClear(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Clear the specified flags for the endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- HWREGB(ulBase + USB_O_CSRL0) &= ~ulFlags;
- }
- else
- {
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) &= ~ulFlags;
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~(ulFlags >> USB_RX_EPSTATUS_SHIFT);
- }
- }
- //*****************************************************************************
- //
- //! Clears the status bits in this endpoint in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags are the status bits that will be cleared.
- //!
- //! This function will clear the status of any bits that are passed in the
- //! \e ulFlags parameter. The \e ulFlags parameter can take the value returned
- //! from the USBEndpointStatus() call.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevEndpointStatusClear(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // If this is endpoint 0 then the bits have different meaning and map into
- // the TX memory location.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Set the Serviced RxPktRdy bit to clear the RxPktRdy.
- //
- if(ulFlags & USB_DEV_EP0_OUT_PKTRDY)
- {
- HWREGB(ulBase + USB_O_CSRL0) |= USB_CSRL0_RXRDYC;
- }
- //
- // Set the serviced Setup End bit to clear the SetupEnd status.
- //
- if(ulFlags & USB_DEV_EP0_SETUP_END)
- {
- HWREGB(ulBase + USB_O_CSRL0) |= USB_CSRL0_SETENDC;
- }
- //
- // Clear the Sent Stall status flag.
- //
- if(ulFlags & USB_DEV_EP0_SENT_STALL)
- {
- HWREGB(ulBase + USB_O_CSRL0) &= ~(USB_DEV_EP0_SENT_STALL);
- }
- }
- else
- {
- //
- // Clear out any TX flags that were passed in. Only
- // USB_DEV_TX_SENT_STALL and USB_DEV_TX_UNDERRUN should be cleared.
- //
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~(ulFlags & (USB_DEV_TX_SENT_STALL | USB_DEV_TX_UNDERRUN));
- //
- // Clear out valid RX flags that were passed in. Only
- // USB_DEV_RX_SENT_STALL, USB_DEV_RX_DATA_ERROR, and USB_DEV_RX_OVERRUN
- // should be cleared.
- //
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~((ulFlags & (USB_DEV_RX_SENT_STALL | USB_DEV_RX_DATA_ERROR |
- USB_DEV_RX_OVERRUN)) >> USB_RX_EPSTATUS_SHIFT);
- }
- }
- //*****************************************************************************
- //
- //! Sets the value data toggle on an endpoint in host mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint specifies the endpoint to reset the data toggle.
- //! \param bDataToggle specifies whether to set the state to DATA0 or DATA1.
- //! \param ulFlags specifies whether to set the IN or OUT endpoint.
- //!
- //! This function is used to force the state of the data toggle in host mode.
- //! If the value passed in the \e bDataToggle parameter is \b false, then the
- //! data toggle will be set to the DATA0 state, and if it is \b true it will be
- //! set to the DATA1 state. The \e ulFlags parameter can be \b USB_EP_HOST_IN
- //! or \b USB_EP_HOST_OUT to access the desired portion of this endpoint. The
- //! \e ulFlags parameter is ignored for endpoint zero.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostEndpointDataToggle(unsigned long ulBase, unsigned long ulEndpoint,
- tBoolean bDataToggle, unsigned long ulFlags)
- {
- unsigned long ulDataToggle;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // The data toggle defaults to DATA0.
- //
- ulDataToggle = 0;
- //
- // See if the data toggle should be set to DATA1.
- //
- if(bDataToggle)
- {
- //
- // Select the data toggle bit based on the endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- ulDataToggle = USB_CSRH0_DT;
- }
- else if(ulFlags == USB_EP_HOST_IN)
- {
- ulDataToggle = USB_RXCSRH1_DT;
- }
- else
- {
- ulDataToggle = USB_TXCSRH1_DT;
- }
- }
- //
- // Set the data toggle based on the endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Set the write enable and the bit value for endpoint zero.
- //
- HWREGB(ulBase + USB_O_CSRH0) =
- ((HWREGB(ulBase + USB_O_CSRH0) &
- ~(USB_CSRH0_DTWE | USB_CSRH0_DT)) |
- (ulDataToggle | USB_CSRH0_DTWE));
- }
- else if(ulFlags == USB_EP_HOST_IN)
- {
- //
- // Set the Write enable and the bit value for an IN endpoint.
- //
- HWREGB(ulBase + USB_O_RXCSRH1 + EP_OFFSET(ulEndpoint)) =
- ((HWREGB(ulBase + USB_O_RXCSRH1 + EP_OFFSET(ulEndpoint)) &
- ~(USB_RXCSRH1_DTWE | USB_RXCSRH1_DT)) |
- (ulDataToggle | USB_RXCSRH1_DTWE));
- }
- else
- {
- //
- // Set the Write enable and the bit value for an OUT endpoint.
- //
- HWREGB(ulBase + USB_O_TXCSRH1 + EP_OFFSET(ulEndpoint)) =
- ((HWREGB(ulBase + USB_O_TXCSRH1 + EP_OFFSET(ulEndpoint)) &
- ~(USB_TXCSRH1_DTWE | USB_TXCSRH1_DT)) |
- (ulDataToggle | USB_TXCSRH1_DTWE));
- }
- }
- //*****************************************************************************
- //
- //! Sets the Data toggle on an endpoint to zero.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint specifies the endpoint to reset the data toggle.
- //! \param ulFlags specifies whether to access the IN or OUT endpoint.
- //!
- //! This function will cause the controller to clear the data toggle for an
- //! endpoint. This call is not valid for endpoint zero and can be made with
- //! host or device controllers.
- //!
- //! The \e ulFlags parameter should be one of \b USB_EP_HOST_OUT,
- //! \b USB_EP_HOST_IN, \b USB_EP_DEV_OUT, or \b USB_EP_DEV_IN.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBEndpointDataToggleClear(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_1) || (ulEndpoint == USB_EP_2) ||
- (ulEndpoint == USB_EP_3) || (ulEndpoint == USB_EP_4) ||
- (ulEndpoint == USB_EP_5) || (ulEndpoint == USB_EP_6) ||
- (ulEndpoint == USB_EP_7) || (ulEndpoint == USB_EP_8) ||
- (ulEndpoint == USB_EP_9) || (ulEndpoint == USB_EP_10) ||
- (ulEndpoint == USB_EP_11) || (ulEndpoint == USB_EP_12) ||
- (ulEndpoint == USB_EP_13) || (ulEndpoint == USB_EP_14) ||
- (ulEndpoint == USB_EP_15));
- //
- // See if the transmit or receive data toggle should be cleared.
- //
- if(ulFlags & (USB_EP_HOST_OUT | USB_EP_DEV_IN))
- {
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_TXCSRL1_CLRDT;
- }
- else
- {
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_RXCSRL1_CLRDT;
- }
- }
- //*****************************************************************************
- //
- //! Stalls the specified endpoint in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint specifies the endpoint to stall.
- //! \param ulFlags specifies whether to stall the IN or OUT endpoint.
- //!
- //! This function will cause to endpoint number passed in to go into a stall
- //! condition. If the \e ulFlags parameter is \b USB_EP_DEV_IN then the stall
- //! will be issued on the IN portion of this endpoint. If the \e ulFlags
- //! parameter is \b USB_EP_DEV_OUT then the stall will be issued on the OUT
- //! portion of this endpoint.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevEndpointStall(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulFlags & ~(USB_EP_DEV_IN | USB_EP_DEV_OUT)) == 0)
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Determine how to stall this endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Perform a stall on endpoint zero.
- //
- HWREGB(ulBase + USB_O_CSRL0) |=
- (USB_CSRL0_STALL | USB_CSRL0_RXRDYC);
- }
- else if(ulFlags == USB_EP_DEV_IN)
- {
- //
- // Perform a stall on an IN endpoint.
- //
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_TXCSRL1_STALL;
- }
- else
- {
- //
- // Perform a stall on an OUT endpoint.
- //
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_RXCSRL1_STALL;
- }
- }
- //*****************************************************************************
- //
- //! Clears the stall condition on the specified endpoint in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint specifies which endpoint to remove the stall condition.
- //! \param ulFlags specifies whether to remove the stall condition from the IN
- //! or the OUT portion of this endpoint.
- //!
- //! This function will cause the endpoint number passed in to exit the stall
- //! condition. If the \e ulFlags parameter is \b USB_EP_DEV_IN then the stall
- //! will be cleared on the IN portion of this endpoint. If the \e ulFlags
- //! parameter is \b USB_EP_DEV_OUT then the stall will be cleared on the OUT
- //! portion of this endpoint.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevEndpointStallClear(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- ASSERT((ulFlags & ~(USB_EP_DEV_IN | USB_EP_DEV_OUT)) == 0)
- //
- // Determine how to clear the stall on this endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Clear the stall on endpoint zero.
- //
- HWREGB(ulBase + USB_O_CSRL0) &= ~USB_CSRL0_STALLED;
- }
- else if(ulFlags == USB_EP_DEV_IN)
- {
- //
- // Clear the stall on an IN endpoint.
- //
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~(USB_TXCSRL1_STALL | USB_TXCSRL1_STALLED);
- //
- // Reset the data toggle.
- //
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_TXCSRL1_CLRDT;
- }
- else
- {
- //
- // Clear the stall on an OUT endpoint.
- //
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~(USB_RXCSRL1_STALL | USB_RXCSRL1_STALLED);
- //
- // Reset the data toggle.
- //
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_RXCSRL1_CLRDT;
- }
- }
- //*****************************************************************************
- //
- //! Connects the USB controller to the bus in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will cause the soft connect feature of the USB controller to
- //! be enabled. Call USBDisconnect() to remove the USB device from the bus.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevConnect(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Enable connection to the USB bus.
- //
- HWREGB(ulBase + USB_O_POWER) |= USB_POWER_SOFTCONN;
- }
- //*****************************************************************************
- //
- //! Removes the USB controller from the bus in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will cause the soft connect feature of the USB controller to
- //! remove the device from the USB bus. A call to USBDevConnect() is needed to
- //! reconnect to the bus.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevDisconnect(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Disable connection to the USB bus.
- //
- HWREGB(ulBase + USB_O_POWER) &= (~USB_POWER_SOFTCONN);
- }
- //*****************************************************************************
- //
- //! Sets the address in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulAddress is the address to use for a device.
- //!
- //! This function will set the device address on the USB bus. This address was
- //! likely received via a SET ADDRESS command from the host controller.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevAddrSet(unsigned long ulBase, unsigned long ulAddress)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Set the function address in the correct location.
- //
- HWREGB(ulBase + USB_O_FADDR) = (unsigned char)ulAddress;
- }
- //*****************************************************************************
- //
- //! Returns the current device address in device mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function will return the current device address. This address was set
- //! by a call to USBDevAddrSet().
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return The current device address.
- //
- //*****************************************************************************
- unsigned long
- USBDevAddrGet(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Return the function address.
- //
- return(HWREGB(ulBase + USB_O_FADDR));
- }
- //*****************************************************************************
- //
- //! Sets the base configuration for a host endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulMaxPayload is the maximum payload for this endpoint.
- //! \param ulNAKPollInterval is the either the NAK timeout limit or the polling
- //! interval depending on the type of endpoint.
- //! \param ulTargetEndpoint is the endpoint that the host endpoint is
- //! targeting.
- //! \param ulFlags are used to configure other endpoint settings.
- //!
- //! This function will set the basic configuration for the transmit or receive
- //! portion of an endpoint in host mode. The \e ulFlags parameter determines
- //! some of the configuration while the other parameters provide the rest. The
- //! \e ulFlags parameter determines whether this is an IN endpoint
- //! (USB_EP_HOST_IN or USB_EP_DEV_IN) or an OUT endpoint (USB_EP_HOST_OUT or
- //! USB_EP_DEV_OUT), whether this is a Full speed endpoint (USB_EP_SPEED_FULL)
- //! or a Low speed endpoint (USB_EP_SPEED_LOW).
- //!
- //! The \b USB_EP_MODE_ flags control the type of the endpoint.
- //! - \b USB_EP_MODE_CTRL is a control endpoint.
- //! - \b USB_EP_MODE_ISOC is an isochronous endpoint.
- //! - \b USB_EP_MODE_BULK is a bulk endpoint.
- //! - \b USB_EP_MODE_INT is an interrupt endpoint.
- //!
- //! The \e ulNAKPollInterval parameter has different meanings based on the
- //! \b USB_EP_MODE value and whether or not this call is being made for
- //! endpoint zero or another endpoint. For endpoint zero or any Bulk
- //! endpoints, this value always indicates the number of frames to allow a
- //! device to NAK before considering it a timeout. If this endpoint is an
- //! isochronous or interrupt endpoint, this value is the polling interval for
- //! this endpoint.
- //!
- //! For interrupt endpoints the polling interval is simply the number of
- //! frames between polling an interrupt endpoint. For isochronous endpoints
- //! this value represents a polling interval of 2 ^ (\e ulNAKPollInterval - 1)
- //! frames. When used as a NAK timeout, the \e ulNAKPollInterval value
- //! specifies 2 ^ (\e ulNAKPollInterval - 1) frames before issuing a time out.
- //! There are two special time out values that can be specified when setting
- //! the \e ulNAKPollInterval value. The first is \b MAX_NAK_LIMIT which is the
- //! maximum value that can be passed in this variable. The other is
- //! \b DISABLE_NAK_LIMIT which indicates that there should be no limit on the
- //! number of NAKs.
- //!
- //! The \b USB_EP_DMA_MODE_ flags enables the type of DMA used to access the
- //! endpoint's data FIFOs. The choice of the DMA mode depends on how the DMA
- //! controller is configured and how it is being used. See the ``Using USB
- //! with the uDMA Controller'' section for more information on DMA
- //! configuration.
- //!
- //! When configuring the OUT portion of an endpoint, the \b USB_EP_AUTO_SET bit
- //! is specified to cause the transmission of data on the USB bus to start
- //! as soon as the number of bytes specified by \e ulMaxPayload have been
- //! written into the OUT FIFO for this endpoint.
- //!
- //! When configuring the IN portion of an endpoint, the \b USB_EP_AUTO_REQUEST
- //! bit can be specified to trigger the request for more data once the FIFO has
- //! been drained enough to fit \e ulMaxPayload bytes. The \b USB_EP_AUTO_CLEAR
- //! bit can be used to clear the data packet ready flag automatically once the
- //! data has been read from the FIFO. If this is not used, this flag must be
- //! manually cleared via a call to USBDevEndpointStatusClear() or
- //! USBHostEndpointStatusClear().
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostEndpointConfig(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulMaxPayload,
- unsigned long ulNAKPollInterval,
- unsigned long ulTargetEndpoint, unsigned long ulFlags)
- {
- unsigned long ulRegister;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- ASSERT(ulNAKPollInterval <= MAX_NAK_LIMIT);
- //
- // Endpoint zero is configured differently than the other endpoints, so see
- // if this is endpoint zero.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Set the NAK timeout.
- //
- HWREGB(ulBase + USB_O_NAKLMT) = ulNAKPollInterval;
- //
- // Set the transfer type information.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TYPE0) =
- ((ulFlags & USB_EP_SPEED_FULL) ? USB_TYPE0_SPEED_FULL :
- USB_TYPE0_SPEED_LOW);
- }
- else
- {
- //
- // Start with the target endpoint.
- //
- ulRegister = ulTargetEndpoint;
- //
- // Set the speed for the device using this endpoint.
- //
- if(ulFlags & USB_EP_SPEED_FULL)
- {
- ulRegister |= USB_TXTYPE1_SPEED_FULL;
- }
- else
- {
- ulRegister |= USB_TXTYPE1_SPEED_LOW;
- }
- //
- // Set the protocol for the device using this endpoint.
- //
- switch(ulFlags & USB_EP_MODE_MASK)
- {
- //
- // The bulk protocol is being used.
- //
- case USB_EP_MODE_BULK:
- {
- ulRegister |= USB_TXTYPE1_PROTO_BULK;
- break;
- }
- //
- // The isochronous protocol is being used.
- //
- case USB_EP_MODE_ISOC:
- {
- ulRegister |= USB_TXTYPE1_PROTO_ISOC;
- break;
- }
- //
- // The interrupt protocol is being used.
- //
- case USB_EP_MODE_INT:
- {
- ulRegister |= USB_TXTYPE1_PROTO_INT;
- break;
- }
- //
- // The control protocol is being used.
- //
- case USB_EP_MODE_CTRL:
- {
- ulRegister |= USB_TXTYPE1_PROTO_CTRL;
- break;
- }
- }
- //
- // See if the transmit or receive endpoint is being configured.
- //
- if(ulFlags & USB_EP_HOST_OUT)
- {
- //
- // Set the transfer type information.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXTYPE1) =
- ulRegister;
- //
- // Set the NAK timeout or polling interval.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXINTERVAL1) =
- ulNAKPollInterval;
- //
- // Set the Maximum Payload per transaction.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXMAXP1) =
- ulMaxPayload;
- //
- // Set the transmit control value to zero.
- //
- ulRegister = 0;
- //
- // Allow auto setting of TxPktRdy when max packet size has been
- // loaded into the FIFO.
- //
- if(ulFlags & USB_EP_AUTO_SET)
- {
- ulRegister |= USB_TXCSRH1_AUTOSET;
- }
- //
- // Configure the DMA Mode.
- //
- if(ulFlags & USB_EP_DMA_MODE_1)
- {
- ulRegister |= USB_TXCSRH1_DMAEN | USB_TXCSRH1_DMAMOD;
- }
- else if(ulFlags & USB_EP_DMA_MODE_0)
- {
- ulRegister |= USB_TXCSRH1_DMAEN;
- }
- //
- // Write out the transmit control value.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXCSRH1) =
- (unsigned char)ulRegister;
- }
- else
- {
- //
- // Set the transfer type information.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXTYPE1) =
- ulRegister;
- //
- // Set the NAK timeout or polling interval.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXINTERVAL1) =
- ulNAKPollInterval;
- //
- // Set the receive control value to zero.
- //
- ulRegister = 0;
- //
- // Allow auto clearing of RxPktRdy when packet of size max packet
- // has been unloaded from the FIFO.
- //
- if(ulFlags & USB_EP_AUTO_CLEAR)
- {
- ulRegister |= USB_RXCSRH1_AUTOCL;
- }
- //
- // Configure the DMA Mode.
- //
- if(ulFlags & USB_EP_DMA_MODE_1)
- {
- ulRegister |= USB_RXCSRH1_DMAEN | USB_RXCSRH1_DMAMOD;
- }
- else if(ulFlags & USB_EP_DMA_MODE_0)
- {
- ulRegister |= USB_RXCSRH1_DMAEN;
- }
- //
- // Write out the receive control value.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXCSRH1) =
- (unsigned char)ulRegister;
- }
- }
- }
- //*****************************************************************************
- //
- //! Sets the configuration for an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulMaxPacketSize is the maximum packet size for this endpoint.
- //! \param ulFlags are used to configure other endpoint settings.
- //!
- //! This function will set the basic configuration for an endpoint in device
- //! mode. Endpoint zero does not have a dynamic configuration, so this
- //! function should not be called for endpoint zero. The \e ulFlags parameter
- //! determines some of the configuration while the other parameters provide the
- //! rest.
- //!
- //! The \b USB_EP_MODE_ flags define what the type is for the given endpoint.
- //!
- //! - \b USB_EP_MODE_CTRL is a control endpoint.
- //! - \b USB_EP_MODE_ISOC is an isochronous endpoint.
- //! - \b USB_EP_MODE_BULK is a bulk endpoint.
- //! - \b USB_EP_MODE_INT is an interrupt endpoint.
- //!
- //! The \b USB_EP_DMA_MODE_ flags determines the type of DMA access to the
- //! endpoint data FIFOs. The choice of the DMA mode depends on how the DMA
- //! controller is configured and how it is being used. See the ``Using USB
- //! with the uDMA Controller'' section for more information on DMA
- //! configuration.
- //!
- //! When configuring an IN endpoint, the \b USB_EP_AUTO_SET bit can be
- //! specified to cause the automatic transmission of data on the USB bus as
- //! soon as \e ulMaxPacketSize bytes of data are written into the FIFO for
- //! this endpoint. This is commonly used with DMA as no interaction is
- //! required to start the transmission of data.
- //!
- //! When configuring an OUT endpoint, the \b USB_EP_AUTO_REQUEST bit is
- //! specified to trigger the request for more data once the FIFO has been
- //! drained enough to receive \e ulMaxPacketSize more bytes of data. Also for
- //! OUT endpoints, the \b USB_EP_AUTO_CLEAR bit can be used to clear the data
- //! packet ready flag automatically once the data has been read from the FIFO.
- //! If this is not used, this flag must be manually cleared via a call to
- //! USBDevEndpointStatusClear(). Both of these settings can be used to remove
- //! the need for extra calls when using the controller in DMA mode.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevEndpointConfigSet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulMaxPacketSize, unsigned long ulFlags)
- {
- unsigned long ulRegister;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_1) || (ulEndpoint == USB_EP_2) ||
- (ulEndpoint == USB_EP_3) || (ulEndpoint == USB_EP_4) ||
- (ulEndpoint == USB_EP_5) || (ulEndpoint == USB_EP_6) ||
- (ulEndpoint == USB_EP_7) || (ulEndpoint == USB_EP_8) ||
- (ulEndpoint == USB_EP_9) || (ulEndpoint == USB_EP_10) ||
- (ulEndpoint == USB_EP_11) || (ulEndpoint == USB_EP_12) ||
- (ulEndpoint == USB_EP_13) || (ulEndpoint == USB_EP_14) ||
- (ulEndpoint == USB_EP_15));
- //
- // Determine if a transmit or receive endpoint is being configured.
- //
- if(ulFlags & USB_EP_DEV_IN)
- {
- //
- // Set the maximum packet size.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXMAXP1) =
- ulMaxPacketSize;
- //
- // The transmit control value is zero unless options are enabled.
- //
- ulRegister = 0;
- //
- // Allow auto setting of TxPktRdy when max packet size has been loaded
- // into the FIFO.
- //
- if(ulFlags & USB_EP_AUTO_SET)
- {
- ulRegister |= USB_TXCSRH1_AUTOSET;
- }
- //
- // Configure the DMA mode.
- //
- if(ulFlags & USB_EP_DMA_MODE_1)
- {
- ulRegister |= USB_TXCSRH1_DMAEN | USB_TXCSRH1_DMAMOD;
- }
- else if(ulFlags & USB_EP_DMA_MODE_0)
- {
- ulRegister |= USB_TXCSRH1_DMAEN;
- }
- //
- // Enable isochronous mode if requested.
- //
- if((ulFlags & USB_EP_MODE_MASK) == USB_EP_MODE_ISOC)
- {
- ulRegister |= USB_TXCSRH1_ISO;
- }
- //
- // Write the transmit control value.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXCSRH1) =
- (unsigned char)ulRegister;
- //
- // Reset the Data toggle to zero.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXCSRL1) =
- USB_TXCSRL1_CLRDT;
- }
- else
- {
- //
- // Set the MaxPacketSize.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXMAXP1) =
- ulMaxPacketSize;
- //
- // The receive control value is zero unless options are enabled.
- //
- ulRegister = 0;
- //
- // Allow auto clearing of RxPktRdy when packet of size max packet
- // has been unloaded from the FIFO.
- //
- if(ulFlags & USB_EP_AUTO_CLEAR)
- {
- ulRegister = USB_RXCSRH1_AUTOCL;
- }
- //
- // Configure the DMA mode.
- //
- if(ulFlags & USB_EP_DMA_MODE_1)
- {
- ulRegister |= USB_RXCSRH1_DMAEN | USB_RXCSRH1_DMAMOD;
- }
- else if(ulFlags & USB_EP_DMA_MODE_0)
- {
- ulRegister |= USB_RXCSRH1_DMAEN;
- }
- //
- // Enable isochronous mode if requested.
- //
- if((ulFlags & USB_EP_MODE_MASK) == USB_EP_MODE_ISOC)
- {
- ulRegister |= USB_RXCSRH1_ISO;
- }
- //
- // Write the receive control value.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXCSRH1) =
- (unsigned char)ulRegister;
- //
- // Reset the Data toggle to zero.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXCSRL1) =
- USB_RXCSRL1_CLRDT;
- }
- }
- //*****************************************************************************
- //
- //! Gets the current configuration for an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param pulMaxPacketSize is a pointer which will be written with the
- //! maximum packet size for this endpoint.
- //! \param pulFlags is a pointer which will be written with the current
- //! endpoint settings. On entry to the function, this pointer must contain
- //! either \b USB_EP_DEV_IN or \b USB_EP_DEV_OUT to indicate whether the IN or
- //! OUT endpoint is to be queried.
- //!
- //! This function will return the basic configuration for an endpoint in device
- //! mode. The values returned in \e *pulMaxPacketSize and \e *pulFlags are
- //! equivalent to the \e ulMaxPacketSize and \e ulFlags previously passed to
- //! USBDevEndpointConfigSet() for this endpoint.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevEndpointConfigGet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long *pulMaxPacketSize,
- unsigned long *pulFlags)
- {
- unsigned long ulRegister;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT(pulMaxPacketSize && pulFlags);
- ASSERT((ulEndpoint == USB_EP_1) || (ulEndpoint == USB_EP_2) ||
- (ulEndpoint == USB_EP_3) || (ulEndpoint == USB_EP_4) ||
- (ulEndpoint == USB_EP_5) || (ulEndpoint == USB_EP_6) ||
- (ulEndpoint == USB_EP_7) || (ulEndpoint == USB_EP_8) ||
- (ulEndpoint == USB_EP_9) || (ulEndpoint == USB_EP_10) ||
- (ulEndpoint == USB_EP_11) || (ulEndpoint == USB_EP_12) ||
- (ulEndpoint == USB_EP_13) || (ulEndpoint == USB_EP_14) ||
- (ulEndpoint == USB_EP_15));
- //
- // Determine if a transmit or receive endpoint is being queried.
- //
- if(*pulFlags & USB_EP_DEV_IN)
- {
- //
- // Clear the flags other than the direction bit.
- //
- *pulFlags = USB_EP_DEV_IN;
- //
- // Get the maximum packet size.
- //
- *pulMaxPacketSize = (unsigned long)HWREGB(ulBase +
- EP_OFFSET(ulEndpoint) +
- USB_O_TXMAXP1);
- //
- // Get the current transmit control register value.
- //
- ulRegister = (unsigned long)HWREGB(ulBase + EP_OFFSET(ulEndpoint) +
- USB_O_TXCSRH1);
- //
- // Are we allowing auto setting of TxPktRdy when max packet size has
- // been loaded into the FIFO?
- //
- if(ulRegister & USB_TXCSRH1_AUTOSET)
- {
- *pulFlags |= USB_EP_AUTO_SET;
- }
- //
- // Get the DMA mode.
- //
- if(ulRegister & USB_TXCSRH1_DMAEN)
- {
- if(ulRegister & USB_TXCSRH1_DMAMOD)
- {
- *pulFlags |= USB_EP_DMA_MODE_1;
- }
- else
- {
- *pulFlags |= USB_EP_DMA_MODE_0;
- }
- }
- //
- // Are we in isochronous mode?
- //
- if(ulRegister & USB_TXCSRH1_ISO)
- {
- *pulFlags |= USB_EP_MODE_ISOC;
- }
- else
- {
- //
- // The hardware doesn't differentiate between bulk, interrupt
- // and control mode for the endpoint so we just set something
- // that isn't isochronous. This ensures that anyone modifying
- // the returned flags in preparation for a call to
- // USBDevEndpointConfigSet will not see an unexpected mode change.
- // If they decode the returned mode, however, they may be in for
- // a surprise.
- //
- *pulFlags |= USB_EP_MODE_BULK;
- }
- }
- else
- {
- //
- // Clear the flags other than the direction bit.
- //
- *pulFlags = USB_EP_DEV_OUT;
- //
- // Get the MaxPacketSize.
- //
- *pulMaxPacketSize = (unsigned long)HWREGB(ulBase +
- EP_OFFSET(ulEndpoint) +
- USB_O_RXMAXP1);
- //
- // Get the current receive control register value.
- //
- ulRegister = (unsigned long)HWREGB(ulBase + EP_OFFSET(ulEndpoint) +
- USB_O_RXCSRH1);
- //
- // Are we allowing auto clearing of RxPktRdy when packet of size max
- // packet has been unloaded from the FIFO?
- //
- if(ulRegister & USB_RXCSRH1_AUTOCL)
- {
- *pulFlags |= USB_EP_AUTO_CLEAR;
- }
- //
- // Get the DMA mode.
- //
- if(ulRegister & USB_RXCSRH1_DMAEN)
- {
- if(ulRegister & USB_RXCSRH1_DMAMOD)
- {
- *pulFlags |= USB_EP_DMA_MODE_1;
- }
- else
- {
- *pulFlags |= USB_EP_DMA_MODE_0;
- }
- }
- //
- // Are we in isochronous mode?
- //
- if(ulRegister & USB_RXCSRH1_ISO)
- {
- *pulFlags |= USB_EP_MODE_ISOC;
- }
- else
- {
- //
- // The hardware doesn't differentiate between bulk, interrupt
- // and control mode for the endpoint so we just set something
- // that isn't isochronous. This ensures that anyone modifying
- // the returned flags in preparation for a call to
- // USBDevEndpointConfigSet will not see an unexpected mode change.
- // If they decode the returned mode, however, they may be in for
- // a surprise.
- //
- *pulFlags |= USB_EP_MODE_BULK;
- }
- }
- }
- //*****************************************************************************
- //
- //! Sets the FIFO configuration for an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFIFOAddress is the starting address for the FIFO.
- //! \param ulFIFOSize is the size of the FIFO in bytes.
- //! \param ulFlags specifies what information to set in the FIFO configuration.
- //!
- //! This function will set the starting FIFO RAM address and size of the FIFO
- //! for a given endpoint. Endpoint zero does not have a dynamically
- //! configurable FIFO so this function should not be called for endpoint zero.
- //! The \e ulFIFOSize parameter should be one of the values in the
- //! \b USB_FIFO_SZ_ values. If the endpoint is going to use double buffering
- //! it should use the values with the \b _DB at the end of the value. For
- //! example, use \b USB_FIFO_SZ_16_DB to configure an endpoint to have a 16
- //! byte double buffered FIFO. If a double buffered FIFO is used, then the
- //! actual size of the FIFO will be twice the size indicated by the
- //! \e ulFIFOSize parameter. This means that the \b USB_FIFO_SZ_16_DB value
- //! will use 32 bytes of the USB controller's FIFO memory.
- //!
- //! The \e ulFIFOAddress value should be a multiple of 8 bytes and directly
- //! indicates the starting address in the USB controller's FIFO RAM. For
- //! example, a value of 64 indicates that the FIFO should start 64 bytes into
- //! the USB controller's FIFO memory. The \e ulFlags value specifies whether
- //! the endpoint's OUT or IN FIFO should be configured. If in host mode, use
- //! \b USB_EP_HOST_OUT or \b USB_EP_HOST_IN, and if in device mode use
- //! \b USB_EP_DEV_OUT or \b USB_EP_DEV_IN.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBFIFOConfigSet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFIFOAddress, unsigned long ulFIFOSize,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_1) || (ulEndpoint == USB_EP_2) ||
- (ulEndpoint == USB_EP_3) || (ulEndpoint == USB_EP_4) ||
- (ulEndpoint == USB_EP_5) || (ulEndpoint == USB_EP_6) ||
- (ulEndpoint == USB_EP_7) || (ulEndpoint == USB_EP_8) ||
- (ulEndpoint == USB_EP_9) || (ulEndpoint == USB_EP_10) ||
- (ulEndpoint == USB_EP_11) || (ulEndpoint == USB_EP_12) ||
- (ulEndpoint == USB_EP_13) || (ulEndpoint == USB_EP_14) ||
- (ulEndpoint == USB_EP_15));
- //
- // See if the transmit or receive FIFO is being configured.
- //
- if(ulFlags & (USB_EP_HOST_OUT | USB_EP_DEV_IN))
- {
- //
- // Set the transmit FIFO location and size for this endpoint.
- //
- USBIndexWrite(ulBase, ulEndpoint >> 4, USB_O_TXFIFOSZ, ulFIFOSize, 1);
- USBIndexWrite(ulBase, ulEndpoint >> 4, USB_O_TXFIFOADD,
- ulFIFOAddress >> 3, 2);
- }
- else
- {
- //
- // Set the receive FIFO location and size for this endpoint.
- //
- USBIndexWrite(ulBase, ulEndpoint >> 4, USB_O_RXFIFOSZ, ulFIFOSize, 1);
- USBIndexWrite(ulBase, ulEndpoint >> 4, USB_O_RXFIFOADD,
- ulFIFOAddress >> 3, 2);
- }
- }
- //*****************************************************************************
- //
- //! Returns the FIFO configuration for an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param pulFIFOAddress is the starting address for the FIFO.
- //! \param pulFIFOSize is the size of the FIFO in bytes.
- //! \param ulFlags specifies what information to retrieve from the FIFO
- //! configuration.
- //!
- //! This function will return the starting address and size of the FIFO for a
- //! given endpoint. Endpoint zero does not have a dynamically configurable
- //! FIFO so this function should not be called for endpoint zero. The
- //! \e ulFlags parameter specifies whether the endpoint's OUT or IN FIFO should
- //! be read. If in host mode, the \e ulFlags parameter should be
- //! \b USB_EP_HOST_OUT or \b USB_EP_HOST_IN, and if in device mode the
- //! \e ulFlags parameter should be either \b USB_EP_DEV_OUT or
- //! \b USB_EP_DEV_IN.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBFIFOConfigGet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long *pulFIFOAddress, unsigned long *pulFIFOSize,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_1) || (ulEndpoint == USB_EP_2) ||
- (ulEndpoint == USB_EP_3) || (ulEndpoint == USB_EP_4) ||
- (ulEndpoint == USB_EP_5) || (ulEndpoint == USB_EP_6) ||
- (ulEndpoint == USB_EP_7) || (ulEndpoint == USB_EP_8) ||
- (ulEndpoint == USB_EP_9) || (ulEndpoint == USB_EP_10) ||
- (ulEndpoint == USB_EP_11) || (ulEndpoint == USB_EP_12) ||
- (ulEndpoint == USB_EP_13) || (ulEndpoint == USB_EP_14) ||
- (ulEndpoint == USB_EP_15));
- //
- // See if the transmit or receive FIFO is being configured.
- //
- if(ulFlags & (USB_EP_HOST_OUT | USB_EP_DEV_IN))
- {
- //
- // Get the transmit FIFO location and size for this endpoint.
- //
- *pulFIFOAddress = (USBIndexRead(ulBase, ulEndpoint >> 4,
- (unsigned long)USB_O_TXFIFOADD,
- 2)) << 3;
- *pulFIFOSize = USBIndexRead(ulBase, ulEndpoint >> 4,
- (unsigned long)USB_O_TXFIFOSZ, 1);
- }
- else
- {
- //
- // Get the receive FIFO location and size for this endpoint.
- //
- *pulFIFOAddress = (USBIndexRead(ulBase, ulEndpoint >> 4,
- (unsigned long)USB_O_RXFIFOADD,
- 2)) << 3;
- *pulFIFOSize = USBIndexRead(ulBase, ulEndpoint >> 4,
- (unsigned long)USB_O_RXFIFOSZ, 1);
- }
- }
- //*****************************************************************************
- //
- //! Enable DMA on a given endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags specifies which direction and what mode to use when enabling
- //! DMA.
- //!
- //! This function will enable DMA on a given endpoint and set the mode according
- //! to the values in the \e ulFlags parameter. The \e ulFlags parameter should
- //! have \b USB_EP_DEV_IN or \b USB_EP_DEV_OUT set.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBEndpointDMAEnable(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // See if the transmit DMA is being enabled.
- //
- if(ulFlags & USB_EP_DEV_IN)
- {
- //
- // Enable DMA on the transmit end point.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXCSRH1) |=
- USB_TXCSRH1_DMAEN;
- }
- else
- {
- //
- // Enable DMA on the receive end point.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXCSRH1) |=
- USB_RXCSRH1_DMAEN;
- }
- }
- //*****************************************************************************
- //
- //! Disable DMA on a given endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags specifies which direction to disable.
- //!
- //! This function will disable DMA on a given end point to allow non-DMA
- //! USB transactions to generate interrupts normally. The ulFlags should be
- //! \b USB_EP_DEV_IN or \b USB_EP_DEV_OUT all other bits are ignored.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBEndpointDMADisable(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // If this was a request to disable DMA on the IN portion of the end point
- // then handle it.
- //
- if(ulFlags & USB_EP_DEV_IN)
- {
- //
- // Just disable DMA leave the mode setting.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_TXCSRH1) &=
- ~USB_TXCSRH1_DMAEN;
- }
- else
- {
- //
- // Just disable DMA leave the mode setting.
- //
- HWREGB(ulBase + EP_OFFSET(ulEndpoint) + USB_O_RXCSRH1) &=
- ~USB_RXCSRH1_DMAEN;
- }
- }
- //*****************************************************************************
- //
- //! Determine the number of bytes of data available in a given endpoint's FIFO.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //!
- //! This function will return the number of bytes of data currently available
- //! in the FIFO for the given receive (OUT) endpoint. It may be used prior to
- //! calling USBEndpointDataGet() to determine the size of buffer required to
- //! hold the newly-received packet.
- //!
- //! \return This call will return the number of bytes available in a given
- //! endpoint FIFO.
- //
- //*****************************************************************************
- unsigned long
- USBEndpointDataAvail(unsigned long ulBase, unsigned long ulEndpoint)
- {
- unsigned long ulRegister;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Get the address of the receive status register to use, based on the
- // endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- ulRegister = USB_O_CSRL0;
- }
- else
- {
- ulRegister = USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint);
- }
- //
- // Is there a packet ready in the FIFO?
- //
- if((HWREGH(ulBase + ulRegister) & USB_CSRL0_RXRDY) == 0)
- {
- return(0);
- }
- //
- // Return the byte count in the FIFO.
- //
- return(HWREGH(ulBase + USB_O_COUNT0 + ulEndpoint));
- }
- //*****************************************************************************
- //
- //! Retrieves data from the given endpoint's FIFO.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param pucData is a pointer to the data area used to return the data from
- //! the FIFO.
- //! \param pulSize is initially the size of the buffer passed into this call
- //! via the \e pucData parameter. It will be set to the amount of data
- //! returned in the buffer.
- //!
- //! This function will return the data from the FIFO for the given endpoint.
- //! The \e pulSize parameter should indicate the size of the buffer passed in
- //! the \e pulData parameter. The data in the \e pulSize parameter will be
- //! changed to match the amount of data returned in the \e pucData parameter.
- //! If a zero byte packet was received this call will not return a error but
- //! will instead just return a zero in the \e pulSize parameter. The only
- //! error case occurs when there is no data packet available.
- //!
- //! \return This call will return 0, or -1 if no packet was received.
- //
- //*****************************************************************************
- long
- USBEndpointDataGet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned char *pucData, unsigned long *pulSize)
- {
- unsigned long ulRegister, ulByteCount, ulFIFO;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Get the address of the receive status register to use, based on the
- // endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- ulRegister = USB_O_CSRL0;
- }
- else
- {
- ulRegister = USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint);
- }
- //
- // Don't allow reading of data if the RxPktRdy bit is not set.
- //
- if((HWREGH(ulBase + ulRegister) & USB_CSRL0_RXRDY) == 0)
- {
- //
- // Can't read the data because none is available.
- //
- *pulSize = 0;
- //
- // Return a failure since there is no data to read.
- //
- return(-1);
- }
- //
- // Get the byte count in the FIFO.
- //
- ulByteCount = HWREGH(ulBase + USB_O_COUNT0 + ulEndpoint);
- //
- // Determine how many bytes we will actually copy.
- //
- ulByteCount = (ulByteCount < *pulSize) ? ulByteCount : *pulSize;
- //
- // Return the number of bytes we are going to read.
- //
- *pulSize = ulByteCount;
- //
- // Calculate the FIFO address.
- //
- ulFIFO = ulBase + USB_O_FIFO0 + (ulEndpoint >> 2);
- //
- // Read the data out of the FIFO.
- //
- for(; ulByteCount > 0; ulByteCount--)
- {
- //
- // Read a byte at a time from the FIFO.
- //
- *pucData++ = HWREGB(ulFIFO);
- }
- //
- // Success.
- //
- return(0);
- }
- //*****************************************************************************
- //
- //! Acknowledge that data was read from the given endpoint's FIFO in device
- //! mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param bIsLastPacket indicates if this is the last packet.
- //!
- //! This function acknowledges that the data was read from the endpoint's FIFO.
- //! The \e bIsLastPacket parameter is set to a \b true value if this is the
- //! last in a series of data packets on endpoint zero. The \e bIsLastPacket
- //! parameter is not used for endpoints other than endpoint zero. This call
- //! can be used if processing is required between reading the data and
- //! acknowledging that the data has been read.
- //!
- //! \note This function should only be called in device mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevEndpointDataAck(unsigned long ulBase, unsigned long ulEndpoint,
- tBoolean bIsLastPacket)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Determine which endpoint is being acked.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Clear RxPktRdy, and optionally DataEnd, on endpoint zero.
- //
- HWREGB(ulBase + USB_O_CSRL0) =
- USB_CSRL0_RXRDYC | (bIsLastPacket ? USB_CSRL0_DATAEND : 0);
- }
- else
- {
- //
- // Clear RxPktRdy on all other endpoints.
- //
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~(USB_RXCSRL1_RXRDY);
- }
- }
- //*****************************************************************************
- //
- //! Acknowledge that data was read from the given endpoint's FIFO in host
- //! mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //!
- //! This function acknowledges that the data was read from the endpoint's FIFO.
- //! This call is used if processing is required between reading the data and
- //! acknowledging that the data has been read.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostEndpointDataAck(unsigned long ulBase, unsigned long ulEndpoint)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Clear RxPktRdy.
- //
- if(ulEndpoint == USB_EP_0)
- {
- HWREGB(ulBase + USB_O_CSRL0) &= ~USB_CSRL0_RXRDY;
- }
- else
- {
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) &=
- ~(USB_RXCSRL1_RXRDY);
- }
- }
- //*****************************************************************************
- //
- //! Puts data into the given endpoint's FIFO.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param pucData is a pointer to the data area used as the source for the
- //! data to put into the FIFO.
- //! \param ulSize is the amount of data to put into the FIFO.
- //!
- //! This function will put the data from the \e pucData parameter into the FIFO
- //! for this endpoint. If a packet is already pending for transmission then
- //! this call will not put any of the data into the FIFO and will return -1.
- //! Care should be taken to not write more data than can fit into the FIFO
- //! allocated by the call to USBFIFOConfig().
- //!
- //! \return This call will return 0 on success, or -1 to indicate that the FIFO
- //! is in use and cannot be written.
- //
- //*****************************************************************************
- long
- USBEndpointDataPut(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned char *pucData, unsigned long ulSize)
- {
- unsigned long ulFIFO;
- unsigned char ucTxPktRdy;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Get the bit position of TxPktRdy based on the endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- ucTxPktRdy = USB_CSRL0_TXRDY;
- }
- else
- {
- ucTxPktRdy = USB_TXCSRL1_TXRDY;
- }
- //
- // Don't allow transmit of data if the TxPktRdy bit is already set.
- //
- if(HWREGB(ulBase + USB_O_CSRL0 + ulEndpoint) & ucTxPktRdy)
- {
- return(-1);
- }
- //
- // Calculate the FIFO address.
- //
- ulFIFO = ulBase + USB_O_FIFO0 + (ulEndpoint >> 2);
- //
- // Write the data to the FIFO.
- //
- for(; ulSize > 0; ulSize--)
- {
- HWREGB(ulFIFO) = *pucData++;
- }
- //
- // Success.
- //
- return(0);
- }
- //*****************************************************************************
- //
- //! Starts the transfer of data from an endpoint's FIFO.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulTransType is set to indicate what type of data is being sent.
- //!
- //! This function will start the transfer of data from the FIFO for a given
- //! endpoint. This is necessary if the \b USB_EP_AUTO_SET bit was not enabled
- //! for the endpoint. Setting the \e ulTransType parameter will allow the
- //! appropriate signaling on the USB bus for the type of transaction being
- //! requested. The \e ulTransType parameter should be one of the following:
- //!
- //! - USB_TRANS_OUT for OUT transaction on any endpoint in host mode.
- //! - USB_TRANS_IN for IN transaction on any endpoint in device mode.
- //! - USB_TRANS_IN_LAST for the last IN transactions on endpoint zero in a
- //! sequence of IN transactions.
- //! - USB_TRANS_SETUP for setup transactions on endpoint zero.
- //! - USB_TRANS_STATUS for status results on endpoint zero.
- //!
- //! \return This call will return 0 on success, or -1 if a transmission is
- //! already in progress.
- //
- //*****************************************************************************
- long
- USBEndpointDataSend(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulTransType)
- {
- unsigned long ulTxPktRdy;
- //
- // CHeck the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Get the bit position of TxPktRdy based on the endpoint.
- //
- if(ulEndpoint == USB_EP_0)
- {
- ulTxPktRdy = ulTransType & 0xff;
- }
- else
- {
- ulTxPktRdy = (ulTransType >> 8) & 0xff;
- }
- //
- // Don't allow transmit of data if the TxPktRdy bit is already set.
- //
- if(HWREGB(ulBase + USB_O_CSRL0 + ulEndpoint) & USB_CSRL0_TXRDY)
- {
- return(-1);
- }
- //
- // Set TxPktRdy in order to send the data.
- //
- HWREGB(ulBase + USB_O_CSRL0 + ulEndpoint) = ulTxPktRdy;
- //
- // Success.
- //
- return(0);
- }
- //*****************************************************************************
- //
- //! Forces a flush of an endpoint's FIFO.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags specifies if the IN or OUT endpoint should be accessed.
- //!
- //! This function will force the controller to flush out the data in the FIFO.
- //! The function can be called with either host or device controllers and
- //! requires the \e ulFlags parameter be one of \b USB_EP_HOST_OUT,
- //! \b USB_EP_HOST_IN, \b USB_EP_DEV_OUT, or \b USB_EP_DEV_IN.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBFIFOFlush(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Endpoint zero has a different register set for FIFO flushing.
- //
- if(ulEndpoint == USB_EP_0)
- {
- //
- // Nothing in the FIFO if neither of these bits are set.
- //
- if((HWREGB(ulBase + USB_O_CSRL0) &
- (USB_CSRL0_RXRDY | USB_CSRL0_TXRDY)) != 0)
- {
- //
- // Hit the Flush FIFO bit.
- //
- HWREGB(ulBase + USB_O_CSRH0) = USB_CSRH0_FLUSH;
- }
- }
- else
- {
- //
- // Only reset the IN or OUT FIFO.
- //
- if(ulFlags & (USB_EP_HOST_OUT | USB_EP_DEV_IN))
- {
- //
- // Make sure the FIFO is not empty.
- //
- if(HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) &
- USB_TXCSRL1_TXRDY)
- {
- //
- // Hit the Flush FIFO bit.
- //
- HWREGB(ulBase + USB_O_TXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_TXCSRL1_FLUSH;
- }
- }
- else
- {
- //
- // Make sure that the FIFO is not empty.
- //
- if(HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) &
- USB_RXCSRL1_RXRDY)
- {
- //
- // Hit the Flush FIFO bit.
- //
- HWREGB(ulBase + USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint)) |=
- USB_RXCSRL1_FLUSH;
- }
- }
- }
- }
- //*****************************************************************************
- //
- //! Schedules a request for an IN transaction on an endpoint in host mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //!
- //! This function will schedule a request for an IN transaction. When the USB
- //! device being communicated with responds the data, the data can be retrieved
- //! by calling USBEndpointDataGet() or via a DMA transfer.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostRequestIN(unsigned long ulBase, unsigned long ulEndpoint)
- {
- unsigned long ulRegister;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // Endpoint zero uses a different offset than the other endpoints.
- //
- if(ulEndpoint == USB_EP_0)
- {
- ulRegister = USB_O_CSRL0;
- }
- else
- {
- ulRegister = USB_O_RXCSRL1 + EP_OFFSET(ulEndpoint);
- }
- //
- // Set the request for an IN transaction.
- //
- HWREGB(ulBase + ulRegister) = USB_RXCSRL1_REQPKT;
- }
- //*****************************************************************************
- //
- //! Issues a request for a status IN transaction on endpoint zero.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function is used to cause a request for an status IN transaction from
- //! a device on endpoint zero. This function can only be used with endpoint
- //! zero as that is the only control endpoint that supports this ability. This
- //! is used to complete the last phase of a control transaction to a device and
- //! an interrupt will be signaled when the status packet has been received.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostRequestStatus(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Set the request for a status IN transaction.
- //
- HWREGB(ulBase + USB_O_CSRL0) = USB_CSRL0_REQPKT | USB_CSRL0_STATUS;
- }
- //*****************************************************************************
- //
- //! Sets the functional address for the device that is connected to an
- //! endpoint in host mode.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulAddr is the functional address for the controller to use for this
- //! endpoint.
- //! \param ulFlags determines if this is an IN or an OUT endpoint.
- //!
- //! This function will set the functional address for a device that is using
- //! this endpoint for communication. This \e ulAddr parameter is the address
- //! of the target device that this endpoint will be used to communicate with.
- //! The \e ulFlags parameter indicates if the IN or OUT endpoint should be set.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostAddrSet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulAddr, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // See if the transmit or receive address should be set.
- //
- if(ulFlags & USB_EP_HOST_OUT)
- {
- //
- // Set the transmit address.
- //
- HWREGB(ulBase + USB_O_TXFUNCADDR0 + (ulEndpoint >> 1)) = ulAddr;
- }
- else
- {
- //
- // Set the receive address.
- //
- HWREGB(ulBase + USB_O_TXFUNCADDR0 + 4 + (ulEndpoint >> 1)) = ulAddr;
- }
- }
- //*****************************************************************************
- //
- //! Gets the current functional device address for an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags determines if this is an IN or an OUT endpoint.
- //!
- //! This function returns the current functional address that an endpoint is
- //! using to communicate with a device. The \e ulFlags parameter determines if
- //! the IN or OUT endpoint's device address is returned.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return Returns the current function address being used by an endpoint.
- //
- //*****************************************************************************
- unsigned long
- USBHostAddrGet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // See if the transmit or receive address should be returned.
- //
- if(ulFlags & USB_EP_HOST_OUT)
- {
- //
- // Return this endpoint's transmit address.
- //
- return(HWREGB(ulBase + USB_O_TXFUNCADDR0 + (ulEndpoint >> 1)));
- }
- else
- {
- //
- // Return this endpoint's receive address.
- //
- return(HWREGB(ulBase + USB_O_TXFUNCADDR0 + 4 + (ulEndpoint >> 1)));
- }
- }
- //*****************************************************************************
- //
- //! Set the hub address for the device that is connected to an endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulAddr is the hub address for the device using this endpoint.
- //! \param ulFlags determines if this is an IN or an OUT endpoint.
- //!
- //! This function will set the hub address for a device that is using this
- //! endpoint for communication. The \e ulFlags parameter determines if the
- //! device address for the IN or the OUT endpoint is set by this call.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostHubAddrSet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulAddr, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // See if the hub transmit or receive address is being set.
- //
- if(ulFlags & USB_EP_HOST_OUT)
- {
- //
- // Set the hub transmit address for this endpoint.
- //
- HWREGB(ulBase + USB_O_TXHUBADDR0 + (ulEndpoint >> 1)) = ulAddr;
- }
- else
- {
- //
- // Set the hub receive address for this endpoint.
- //
- HWREGB(ulBase + USB_O_TXHUBADDR0 + 4 + (ulEndpoint >> 1)) = ulAddr;
- }
- }
- //*****************************************************************************
- //
- //! Get the current device hub address for this endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint is the endpoint to access.
- //! \param ulFlags determines if this is an IN or an OUT endpoint.
- //!
- //! This function will return the current hub address that an endpoint is using
- //! to communicate with a device. The \e ulFlags parameter determines if the
- //! device address for the IN or OUT endpoint is returned.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return This function returns the current hub address being used by an
- //! endpoint.
- //
- //*****************************************************************************
- unsigned long
- USBHostHubAddrGet(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_0) || (ulEndpoint == USB_EP_1) ||
- (ulEndpoint == USB_EP_2) || (ulEndpoint == USB_EP_3) ||
- (ulEndpoint == USB_EP_4) || (ulEndpoint == USB_EP_5) ||
- (ulEndpoint == USB_EP_6) || (ulEndpoint == USB_EP_7) ||
- (ulEndpoint == USB_EP_8) || (ulEndpoint == USB_EP_9) ||
- (ulEndpoint == USB_EP_10) || (ulEndpoint == USB_EP_11) ||
- (ulEndpoint == USB_EP_12) || (ulEndpoint == USB_EP_13) ||
- (ulEndpoint == USB_EP_14) || (ulEndpoint == USB_EP_15));
- //
- // See if the hub transmit or receive address should be returned.
- //
- if(ulFlags & USB_EP_HOST_OUT)
- {
- //
- // Return the hub transmit address for this endpoint.
- //
- return(HWREGB(ulBase + USB_O_TXHUBADDR0 + (ulEndpoint >> 1)));
- }
- else
- {
- //
- // Return the hub receive address for this endpoint.
- //
- return(HWREGB(ulBase + USB_O_TXHUBADDR0 + 4 + (ulEndpoint >> 1)));
- }
- }
- //*****************************************************************************
- //
- //! Sets the configuration for USB power fault.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulFlags specifies the configuration of the power fault.
- //!
- //! This function controls how the USB controller uses its external power
- //! control pins(USBnPFTL and USBnEPEN). The flags specify the power
- //! fault level sensitivity, the power fault action, and the power enable level
- //! and source.
- //!
- //! One of the following can be selected as the power fault level
- //! sensitivity:
- //!
- //! - \b USB_HOST_PWRFLT_LOW - An external power fault is indicated by the pin
- //! being driven low.
- //! - \b USB_HOST_PWRFLT_HIGH - An external power fault is indicated by the pin
- //! being driven high.
- //!
- //! One of the following can be selected as the power fault action:
- //!
- //! - \b USB_HOST_PWRFLT_EP_NONE - No automatic action when power fault
- //! detected.
- //! - \b USB_HOST_PWRFLT_EP_TRI - Automatically Tri-state the USBnEPEN pin on a
- //! power fault.
- //! - \b USB_HOST_PWRFLT_EP_LOW - Automatically drive USBnEPEN pin low on a
- //! power fault.
- //! - \b USB_HOST_PWRFLT_EP_HIGH - Automatically drive USBnEPEN pin high on a
- //! power fault.
- //!
- //! One of the following can be selected as the power enable level and source:
- //!
- //! - \b USB_HOST_PWREN_MAN_LOW - USBEPEN is driven low by the USB controller
- //! when USBHostPwrEnable() is called.
- //! - \b USB_HOST_PWREN_MAN_HIGH - USBEPEN is driven high by the USB controller
- //! when USBHostPwrEnable() is called.
- //! - \b USB_HOST_PWREN_AUTOLOW - USBEPEN is driven low by the USB controller
- //! automatically if USBOTGSessionRequest() has
- //! enabled a session.
- //! - \b USB_HOST_PWREN_AUTOHIGH - USBEPEN is driven high by the USB controller
- //! automatically if USBOTGSessionRequest() has
- //! enabled a session.
- //!
- //! On devices that support the VBUS glitch filter, the
- //! \b USB_HOST_PWREN_FILTER can be added to ignore small short drops in VBUS
- //! level caused by high power consumption. This is mainly used to avoid
- //! causing VBUS errors caused by devices with high in-rush current.
- //!
- //! \note The following values have been deprecated and should no longer be
- //! used.
- //! - \b USB_HOST_PWREN_LOW - Automatically drive USBnEPEN low when power is
- //! enabled.
- //! - \b USB_HOST_PWREN_HIGH - Automatically drive USBnEPEN high when power is
- //! enabled.
- //! - \b USB_HOST_PWREN_VBLOW - Automatically drive USBnEPEN low when power is
- //! enabled.
- //! - \b USB_HOST_PWREN_VBHIGH - Automatically drive USBnEPEN high when power is
- //! enabled.
- //!
- //! \note This function should only be called on microcontrollers that support
- //! host mode or OTG operation.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostPwrConfig(unsigned long ulBase, unsigned long ulFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulFlags & ~(USB_EPC_PFLTACT_M | USB_EPC_PFLTAEN |
- USB_EPC_PFLTSEN_HIGH | USB_EPC_EPEN_M)) == 0);
- //
- // If requested, enable VBUS droop detection on parts that support this
- // feature.
- //
- HWREG(ulBase + USB_O_VDC) = ulFlags >> 16;
- //
- // Set the power fault configuration as specified. This will not change
- // whether fault detection is enabled or not.
- //
- HWREGH(ulBase + USB_O_EPC) =
- (ulFlags | (HWREGH(ulBase + USB_O_EPC) &
- ~(USB_EPC_PFLTACT_M | USB_EPC_PFLTAEN |
- USB_EPC_PFLTSEN_HIGH | USB_EPC_EPEN_M)));
- }
- //*****************************************************************************
- //
- //! Enables power fault detection.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function enables power fault detection in the USB controller. If the
- //! USBPFLT pin is not in use this function should not be used.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostPwrFaultEnable(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Enable power fault input.
- //
- HWREGH(ulBase + USB_O_EPC) |= USB_EPC_PFLTEN;
- }
- //*****************************************************************************
- //
- //! Disables power fault detection.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function disables power fault detection in the USB controller.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostPwrFaultDisable(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Enable power fault input.
- //
- HWREGH(ulBase + USB_O_EPC) &= ~USB_EPC_PFLTEN;
- }
- //*****************************************************************************
- //
- //! Enables the external power pin.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function enables the USBEPEN signal to enable an external power supply
- //! in host mode operation.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostPwrEnable(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Enable the external power supply enable signal.
- //
- HWREGH(ulBase + USB_O_EPC) |= USB_EPC_EPENDE;
- }
- //*****************************************************************************
- //
- //! Disables the external power pin.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function disables the USBEPEN signal to disable an external power
- //! supply in host mode operation.
- //!
- //! \note This function should only be called in host mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostPwrDisable(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Disable the external power supply enable signal.
- //
- HWREGH(ulBase + USB_O_EPC) &= ~USB_EPC_EPENDE;
- }
- //*****************************************************************************
- //
- //! Get the current frame number.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function returns the last frame number received.
- //!
- //! \return The last frame number received.
- //
- //*****************************************************************************
- unsigned long
- USBFrameNumberGet(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Return the most recent frame number.
- //
- return(HWREGH(ulBase + USB_O_FRAME));
- }
- //*****************************************************************************
- //
- //! Starts or ends a session.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param bStart specifies if this call starts or ends a session.
- //!
- //! This function is used in OTG mode to start a session request or end a
- //! session. If the \e bStart parameter is set to \b true, then this function
- //! start a session and if it is \b false it will end a session.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBOTGSessionRequest(unsigned long ulBase, tBoolean bStart)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Start or end the session as directed.
- //
- if(bStart)
- {
- HWREGB(ulBase + USB_O_DEVCTL) |= USB_DEVCTL_SESSION;
- }
- else
- {
- HWREGB(ulBase + USB_O_DEVCTL) &= ~USB_DEVCTL_SESSION;
- }
- }
- //*****************************************************************************
- //
- //! Returns the absolute FIFO address for a given endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint specifies which endpoint's FIFO address to return.
- //!
- //! This function returns the actual physical address of the FIFO. This is
- //! needed when the USB is going to be used with the uDMA controller and the
- //! source or destination address needs to be set to the physical FIFO address
- //! for a given endpoint.
- //!
- //! \return None.
- //
- //*****************************************************************************
- unsigned long
- USBFIFOAddrGet(unsigned long ulBase, unsigned long ulEndpoint)
- {
- //
- // Return the FIFO address for this endpoint.
- //
- return(ulBase + USB_O_FIFO0 + (ulEndpoint >> 2));
- }
- //*****************************************************************************
- //
- //! Returns the current operating mode of the controller.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function returns the current operating mode on USB controllers with
- //! OTG or Dual mode functionality.
- //!
- //! For OTG controllers:
- //!
- //! The function will return on of the following values on OTG controllers:
- //! \b USB_OTG_MODE_ASIDE_HOST, \b USB_OTG_MODE_ASIDE_DEV,
- //! \b USB_OTG_MODE_BSIDE_HOST, \b USB_OTG_MODE_BSIDE_DEV,
- //! \b USB_OTG_MODE_NONE.
- //!
- //! \b USB_OTG_MODE_ASIDE_HOST indicates that the controller is in host mode
- //! on the A-side of the cable.
- //!
- //! \b USB_OTG_MODE_ASIDE_DEV indicates that the controller is in device mode
- //! on the A-side of the cable.
- //!
- //! \b USB_OTG_MODE_BSIDE_HOST indicates that the controller is in host mode
- //! on the B-side of the cable.
- //!
- //! \b USB_OTG_MODE_BSIDE_DEV indicates that the controller is in device mode
- //! on the B-side of the cable. If and OTG session request is started with no
- //! cable in place this is the default mode for the controller.
- //!
- //! \b USB_OTG_MODE_NONE indicates that the controller is not attempting to
- //! determine its role in the system.
- //!
- //! For Dual Mode controllers:
- //!
- //! The function will return on of the following values:
- //! \b USB_DUAL_MODE_HOST, \b USB_DUAL_MODE_DEVICE, or
- //! \b USB_DUAL_MODE_NONE.
- //!
- //! \b USB_DUAL_MODE_HOST indicates that the controller is acting as a host.
- //!
- //! \b USB_DUAL_MODE_DEVICE indicates that the controller acting as a device.
- //!
- //! \b USB_DUAL_MODE_NONE indicates that the controller is not active as
- //! either a host or device.
- //!
- //! \return Returns \b USB_OTG_MODE_ASIDE_HOST, \b USB_OTG_MODE_ASIDE_DEV,
- //! \b USB_OTG_MODE_BSIDE_HOST, \b USB_OTG_MODE_BSIDE_DEV,
- //! \b USB_OTG_MODE_NONE, \b USB_DUAL_MODE_HOST, \b USB_DUAL_MODE_DEVICE, or
- //! \b USB_DUAL_MODE_NONE.
- //
- //*****************************************************************************
- unsigned long
- USBModeGet(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Checks the current mode in the USB_O_DEVCTL and returns the current
- // mode.
- //
- // USB_OTG_MODE_ASIDE_HOST: USB_DEVCTL_HOST | USB_DEVCTL_SESSION
- // USB_OTG_MODE_ASIDE_DEV: USB_DEVCTL_SESSION
- // USB_OTG_MODE_BSIDE_HOST: USB_DEVCTL_DEV | USB_DEVCTL_SESSION |
- // USB_DEVCTL_HOST
- // USB_OTG_MODE_BSIDE_DEV: USB_DEVCTL_DEV | USB_DEVCTL_SESSION
- // USB_OTG_MODE_NONE: USB_DEVCTL_DEV
- //
- return(HWREGB(ulBase + USB_O_DEVCTL) &
- (USB_DEVCTL_DEV | USB_DEVCTL_HOST | USB_DEVCTL_SESSION |
- USB_DEVCTL_VBUS_M));
- }
- //*****************************************************************************
- //
- //! Sets the DMA channel to use for a given endpoint.
- //!
- //! \param ulBase specifies the USB module base address.
- //! \param ulEndpoint specifies which endpoint's FIFO address to return.
- //! \param ulChannel specifies which DMA channel to use for which endpoint.
- //!
- //! This function is used to configure which DMA channel to use with a given
- //! endpoint. Receive DMA channels can only be used with receive endpoints
- //! and transmit DMA channels can only be used with transmit endpoints. This
- //! allows the 3 receive and 3 transmit DMA channels to be mapped to any
- //! endpoint other than 0. The values that should be passed into the \e
- //! ulChannel value are the UDMA_CHANNEL_USBEP* values defined in udma.h.
- //!
- //! \note This function only has an effect on microcontrollers that have the
- //! ability to change the DMA channel for an endpoint. Calling this function
- //! on other devices will have no effect.
- //!
- //! \return None.
- //!
- //*****************************************************************************
- void
- USBEndpointDMAChannel(unsigned long ulBase, unsigned long ulEndpoint,
- unsigned long ulChannel)
- {
- unsigned long ulMask;
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- ASSERT((ulEndpoint == USB_EP_1) || (ulEndpoint == USB_EP_2) ||
- (ulEndpoint == USB_EP_3) || (ulEndpoint == USB_EP_4) ||
- (ulEndpoint == USB_EP_5) || (ulEndpoint == USB_EP_6) ||
- (ulEndpoint == USB_EP_7) || (ulEndpoint == USB_EP_8) ||
- (ulEndpoint == USB_EP_9) || (ulEndpoint == USB_EP_10) ||
- (ulEndpoint == USB_EP_11) || (ulEndpoint == USB_EP_12) ||
- (ulEndpoint == USB_EP_13) || (ulEndpoint == USB_EP_14) ||
- (ulEndpoint == USB_EP_15));
- ASSERT(ulChannel <= UDMA_CHANNEL_USBEP3TX);
- //
- // The input select mask needs to be shifted into the correct position
- // based on the channel.
- //
- ulMask = 0xf << (ulChannel * 4);
- //
- // Clear out the current selection for the channel.
- //
- ulMask = HWREG(ulBase + USB_O_DMASEL) & (~ulMask);
- //
- // The input select is now shifted into the correct position based on the
- // channel.
- //
- ulMask |= (USB_EP_TO_INDEX(ulEndpoint)) << (ulChannel * 4);
- //
- // Write the value out to the register.
- //
- HWREG(ulBase + USB_O_DMASEL) = ulMask;
- }
- //*****************************************************************************
- //
- //! Change the mode of the USB controller to host.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function changes the mode of the USB controller to host mode. This
- //! is only valid on microcontrollers that have the host and device
- //! capabilities and not the OTG capabilities.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBHostMode(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Force mode in OTG parts that support forcing USB controller mode.
- // This bit is not writable in USB controllers that do not support
- // forcing the mode. Not setting the USB_GPCS_DEVMOD bit makes this a
- // force of host mode.
- //
- HWREGB(ulBase + USB_O_GPCS) = USB_GPCS_DEVMODOTG;
- }
- //*****************************************************************************
- //
- //! Change the mode of the USB controller to device.
- //!
- //! \param ulBase specifies the USB module base address.
- //!
- //! This function changes the mode of the USB controller to device mode. This
- //! is only valid on microcontrollers that have the host and device
- //! capabilities and not the OTG capabilities.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- USBDevMode(unsigned long ulBase)
- {
- //
- // Check the arguments.
- //
- ASSERT(ulBase == USB0_BASE);
- //
- // Set the USB controller mode to device.
- //
- HWREGB(ulBase + USB_O_GPCS) = USB_GPCS_DEVMODOTG | USB_GPCS_DEVMOD;
- }
- //*****************************************************************************
- //
- // Close the Doxygen group.
- //! @}
- //
- //*****************************************************************************
|