12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679 |
- From 888f8f300f9a547535e251f192759902545208f0 Mon Sep 17 00:00:00 2001
- From: Dorian Stoll <dorian.stoll@tmsp.io>
- Date: Sun, 11 Dec 2022 12:03:38 +0100
- Subject: [PATCH] iommu: intel: Disable source id verification for ITHC
- Signed-off-by: Dorian Stoll <dorian.stoll@tmsp.io>
- Patchset: ithc
- ---
- drivers/iommu/intel/irq_remapping.c | 16 ++++++++++++++++
- 1 file changed, 16 insertions(+)
- diff --git a/drivers/iommu/intel/irq_remapping.c b/drivers/iommu/intel/irq_remapping.c
- index 566297bc87dd..a8cd8f12d593 100644
- --- a/drivers/iommu/intel/irq_remapping.c
- +++ b/drivers/iommu/intel/irq_remapping.c
- @@ -386,6 +386,22 @@ static int set_msi_sid(struct irte *irte, struct pci_dev *dev)
- data.busmatch_count = 0;
- pci_for_each_dma_alias(dev, set_msi_sid_cb, &data);
-
- + /*
- + * The Intel Touch Host Controller is at 00:10.6, but for some reason
- + * the MSI interrupts have request id 01:05.0.
- + * Disable id verification to work around this.
- + * FIXME Find proper fix or turn this into a quirk.
- + */
- + if (dev->vendor == PCI_VENDOR_ID_INTEL && (dev->class >> 8) == PCI_CLASS_INPUT_PEN) {
- + switch(dev->device) {
- + case 0x98d0: case 0x98d1: // LKF
- + case 0xa0d0: case 0xa0d1: // TGL LP
- + case 0x43d0: case 0x43d1: // TGL H
- + set_irte_sid(irte, SVT_NO_VERIFY, SQ_ALL_16, 0);
- + return 0;
- + }
- + }
- +
- /*
- * DMA alias provides us with a PCI device and alias. The only case
- * where the it will return an alias on a different bus than the
- --
- 2.45.2
- From e5bbe336297f8d6fbaac16f8b091522bb394e30a Mon Sep 17 00:00:00 2001
- From: quo <tuple@list.ru>
- Date: Sun, 11 Dec 2022 12:10:54 +0100
- Subject: [PATCH] hid: Add support for Intel Touch Host Controller
- Based on quo/ithc-linux@0b8b45d
- Signed-off-by: Dorian Stoll <dorian.stoll@tmsp.io>
- Patchset: ithc
- ---
- drivers/hid/Kconfig | 2 +
- drivers/hid/Makefile | 1 +
- drivers/hid/ithc/Kbuild | 6 +
- drivers/hid/ithc/Kconfig | 12 +
- drivers/hid/ithc/ithc-debug.c | 130 ++++++
- drivers/hid/ithc/ithc-dma.c | 373 +++++++++++++++++
- drivers/hid/ithc/ithc-dma.h | 69 ++++
- drivers/hid/ithc/ithc-main.c | 728 ++++++++++++++++++++++++++++++++++
- drivers/hid/ithc/ithc-regs.c | 96 +++++
- drivers/hid/ithc/ithc-regs.h | 189 +++++++++
- drivers/hid/ithc/ithc.h | 67 ++++
- 11 files changed, 1673 insertions(+)
- create mode 100644 drivers/hid/ithc/Kbuild
- create mode 100644 drivers/hid/ithc/Kconfig
- create mode 100644 drivers/hid/ithc/ithc-debug.c
- create mode 100644 drivers/hid/ithc/ithc-dma.c
- create mode 100644 drivers/hid/ithc/ithc-dma.h
- create mode 100644 drivers/hid/ithc/ithc-main.c
- create mode 100644 drivers/hid/ithc/ithc-regs.c
- create mode 100644 drivers/hid/ithc/ithc-regs.h
- create mode 100644 drivers/hid/ithc/ithc.h
- diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig
- index a263e49b2ae2..03f0f5af289a 100644
- --- a/drivers/hid/Kconfig
- +++ b/drivers/hid/Kconfig
- @@ -1353,4 +1353,6 @@ source "drivers/hid/surface-hid/Kconfig"
-
- source "drivers/hid/ipts/Kconfig"
-
- +source "drivers/hid/ithc/Kconfig"
- +
- endif # HID_SUPPORT
- diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile
- index f4bad1b8d813..d32c194400ae 100644
- --- a/drivers/hid/Makefile
- +++ b/drivers/hid/Makefile
- @@ -172,3 +172,4 @@ obj-$(CONFIG_AMD_SFH_HID) += amd-sfh-hid/
- obj-$(CONFIG_SURFACE_HID_CORE) += surface-hid/
-
- obj-$(CONFIG_HID_IPTS) += ipts/
- +obj-$(CONFIG_HID_ITHC) += ithc/
- diff --git a/drivers/hid/ithc/Kbuild b/drivers/hid/ithc/Kbuild
- new file mode 100644
- index 000000000000..aea83f2ac07b
- --- /dev/null
- +++ b/drivers/hid/ithc/Kbuild
- @@ -0,0 +1,6 @@
- +obj-$(CONFIG_HID_ITHC) := ithc.o
- +
- +ithc-objs := ithc-main.o ithc-regs.o ithc-dma.o ithc-debug.o
- +
- +ccflags-y := -std=gnu11 -Wno-declaration-after-statement
- +
- diff --git a/drivers/hid/ithc/Kconfig b/drivers/hid/ithc/Kconfig
- new file mode 100644
- index 000000000000..ede713023609
- --- /dev/null
- +++ b/drivers/hid/ithc/Kconfig
- @@ -0,0 +1,12 @@
- +config HID_ITHC
- + tristate "Intel Touch Host Controller"
- + depends on PCI
- + depends on HID
- + help
- + Say Y here if your system has a touchscreen using Intels
- + Touch Host Controller (ITHC / IPTS) technology.
- +
- + If unsure say N.
- +
- + To compile this driver as a module, choose M here: the
- + module will be called ithc.
- diff --git a/drivers/hid/ithc/ithc-debug.c b/drivers/hid/ithc/ithc-debug.c
- new file mode 100644
- index 000000000000..1f1f1e33f2e5
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-debug.c
- @@ -0,0 +1,130 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +#include "ithc.h"
- +
- +void ithc_log_regs(struct ithc *ithc)
- +{
- + if (!ithc->prev_regs)
- + return;
- + u32 __iomem *cur = (__iomem void *)ithc->regs;
- + u32 *prev = (void *)ithc->prev_regs;
- + for (int i = 1024; i < sizeof(*ithc->regs) / 4; i++) {
- + u32 x = readl(cur + i);
- + if (x != prev[i]) {
- + pci_info(ithc->pci, "reg %04x: %08x -> %08x\n", i * 4, prev[i], x);
- + prev[i] = x;
- + }
- + }
- +}
- +
- +static ssize_t ithc_debugfs_cmd_write(struct file *f, const char __user *buf, size_t len,
- + loff_t *offset)
- +{
- + // Debug commands consist of a single letter followed by a list of numbers (decimal or
- + // hexadecimal, space-separated).
- + struct ithc *ithc = file_inode(f)->i_private;
- + char cmd[256];
- + if (!ithc || !ithc->pci)
- + return -ENODEV;
- + if (!len)
- + return -EINVAL;
- + if (len >= sizeof(cmd))
- + return -EINVAL;
- + if (copy_from_user(cmd, buf, len))
- + return -EFAULT;
- + cmd[len] = 0;
- + if (cmd[len-1] == '\n')
- + cmd[len-1] = 0;
- + pci_info(ithc->pci, "debug command: %s\n", cmd);
- +
- + // Parse the list of arguments into a u32 array.
- + u32 n = 0;
- + const char *s = cmd + 1;
- + u32 a[32];
- + while (*s && *s != '\n') {
- + if (n >= ARRAY_SIZE(a))
- + return -EINVAL;
- + if (*s++ != ' ')
- + return -EINVAL;
- + char *e;
- + a[n++] = simple_strtoul(s, &e, 0);
- + if (e == s)
- + return -EINVAL;
- + s = e;
- + }
- + ithc_log_regs(ithc);
- +
- + // Execute the command.
- + switch (cmd[0]) {
- + case 'x': // reset
- + ithc_reset(ithc);
- + break;
- + case 'w': // write register: offset mask value
- + if (n != 3 || (a[0] & 3))
- + return -EINVAL;
- + pci_info(ithc->pci, "debug write 0x%04x = 0x%08x (mask 0x%08x)\n",
- + a[0], a[2], a[1]);
- + bitsl(((__iomem u32 *)ithc->regs) + a[0] / 4, a[1], a[2]);
- + break;
- + case 'r': // read register: offset
- + if (n != 1 || (a[0] & 3))
- + return -EINVAL;
- + pci_info(ithc->pci, "debug read 0x%04x = 0x%08x\n", a[0],
- + readl(((__iomem u32 *)ithc->regs) + a[0] / 4));
- + break;
- + case 's': // spi command: cmd offset len data...
- + // read config: s 4 0 64 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
- + // set touch cfg: s 6 12 4 XX
- + if (n < 3 || a[2] > (n - 3) * 4)
- + return -EINVAL;
- + pci_info(ithc->pci, "debug spi command %u with %u bytes of data\n", a[0], a[2]);
- + if (!CHECK(ithc_spi_command, ithc, a[0], a[1], a[2], a + 3))
- + for (u32 i = 0; i < (a[2] + 3) / 4; i++)
- + pci_info(ithc->pci, "resp %u = 0x%08x\n", i, a[3+i]);
- + break;
- + case 'd': // dma command: cmd len data...
- + // get report descriptor: d 7 8 0 0
- + // enable multitouch: d 3 2 0x0105
- + if (n < 2 || a[1] > (n - 2) * 4)
- + return -EINVAL;
- + pci_info(ithc->pci, "debug dma command %u with %u bytes of data\n", a[0], a[1]);
- + if (ithc_dma_tx(ithc, a[0], a[1], a + 2))
- + pci_err(ithc->pci, "dma tx failed\n");
- + break;
- + default:
- + return -EINVAL;
- + }
- + ithc_log_regs(ithc);
- + return len;
- +}
- +
- +static const struct file_operations ithc_debugfops_cmd = {
- + .owner = THIS_MODULE,
- + .write = ithc_debugfs_cmd_write,
- +};
- +
- +static void ithc_debugfs_devres_release(struct device *dev, void *res)
- +{
- + struct dentry **dbgm = res;
- + if (*dbgm)
- + debugfs_remove_recursive(*dbgm);
- +}
- +
- +int ithc_debug_init(struct ithc *ithc)
- +{
- + struct dentry **dbgm = devres_alloc(ithc_debugfs_devres_release, sizeof(*dbgm), GFP_KERNEL);
- + if (!dbgm)
- + return -ENOMEM;
- + devres_add(&ithc->pci->dev, dbgm);
- + struct dentry *dbg = debugfs_create_dir(DEVNAME, NULL);
- + if (IS_ERR(dbg))
- + return PTR_ERR(dbg);
- + *dbgm = dbg;
- +
- + struct dentry *cmd = debugfs_create_file("cmd", 0220, dbg, ithc, &ithc_debugfops_cmd);
- + if (IS_ERR(cmd))
- + return PTR_ERR(cmd);
- +
- + return 0;
- +}
- +
- diff --git a/drivers/hid/ithc/ithc-dma.c b/drivers/hid/ithc/ithc-dma.c
- new file mode 100644
- index 000000000000..ffb8689b8a78
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-dma.c
- @@ -0,0 +1,373 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +#include "ithc.h"
- +
- +// The THC uses tables of PRDs (physical region descriptors) to describe the TX and RX data buffers.
- +// Each PRD contains the DMA address and size of a block of DMA memory, and some status flags.
- +// This allows each data buffer to consist of multiple non-contiguous blocks of memory.
- +
- +static int ithc_dma_prd_alloc(struct ithc *ithc, struct ithc_dma_prd_buffer *p,
- + unsigned int num_buffers, unsigned int num_pages, enum dma_data_direction dir)
- +{
- + p->num_pages = num_pages;
- + p->dir = dir;
- + // We allocate enough space to have one PRD per data buffer page, however if the data
- + // buffer pages happen to be contiguous, we can describe the buffer using fewer PRDs, so
- + // some will remain unused (which is fine).
- + p->size = round_up(num_buffers * num_pages * sizeof(struct ithc_phys_region_desc), PAGE_SIZE);
- + p->addr = dmam_alloc_coherent(&ithc->pci->dev, p->size, &p->dma_addr, GFP_KERNEL);
- + if (!p->addr)
- + return -ENOMEM;
- + if (p->dma_addr & (PAGE_SIZE - 1))
- + return -EFAULT;
- + return 0;
- +}
- +
- +// Devres managed sg_table wrapper.
- +struct ithc_sg_table {
- + void *addr;
- + struct sg_table sgt;
- + enum dma_data_direction dir;
- +};
- +static void ithc_dma_sgtable_free(struct sg_table *sgt)
- +{
- + struct scatterlist *sg;
- + int i;
- + for_each_sgtable_sg(sgt, sg, i) {
- + struct page *p = sg_page(sg);
- + if (p)
- + __free_page(p);
- + }
- + sg_free_table(sgt);
- +}
- +static void ithc_dma_data_devres_release(struct device *dev, void *res)
- +{
- + struct ithc_sg_table *sgt = res;
- + if (sgt->addr)
- + vunmap(sgt->addr);
- + dma_unmap_sgtable(dev, &sgt->sgt, sgt->dir, 0);
- + ithc_dma_sgtable_free(&sgt->sgt);
- +}
- +
- +static int ithc_dma_data_alloc(struct ithc *ithc, struct ithc_dma_prd_buffer *prds,
- + struct ithc_dma_data_buffer *b)
- +{
- + // We don't use dma_alloc_coherent() for data buffers, because they don't have to be
- + // coherent (they are unidirectional) or contiguous (we can use one PRD per page).
- + // We could use dma_alloc_noncontiguous(), however this still always allocates a single
- + // DMA mapped segment, which is more restrictive than what we need.
- + // Instead we use an sg_table of individually allocated pages.
- + struct page *pages[16];
- + if (prds->num_pages == 0 || prds->num_pages > ARRAY_SIZE(pages))
- + return -EINVAL;
- + b->active_idx = -1;
- + struct ithc_sg_table *sgt = devres_alloc(
- + ithc_dma_data_devres_release, sizeof(*sgt), GFP_KERNEL);
- + if (!sgt)
- + return -ENOMEM;
- + sgt->dir = prds->dir;
- +
- + if (!sg_alloc_table(&sgt->sgt, prds->num_pages, GFP_KERNEL)) {
- + struct scatterlist *sg;
- + int i;
- + bool ok = true;
- + for_each_sgtable_sg(&sgt->sgt, sg, i) {
- + // NOTE: don't need __GFP_DMA for PCI DMA
- + struct page *p = pages[i] = alloc_page(GFP_KERNEL | __GFP_ZERO);
- + if (!p) {
- + ok = false;
- + break;
- + }
- + sg_set_page(sg, p, PAGE_SIZE, 0);
- + }
- + if (ok && !dma_map_sgtable(&ithc->pci->dev, &sgt->sgt, prds->dir, 0)) {
- + devres_add(&ithc->pci->dev, sgt);
- + b->sgt = &sgt->sgt;
- + b->addr = sgt->addr = vmap(pages, prds->num_pages, 0, PAGE_KERNEL);
- + if (!b->addr)
- + return -ENOMEM;
- + return 0;
- + }
- + ithc_dma_sgtable_free(&sgt->sgt);
- + }
- + devres_free(sgt);
- + return -ENOMEM;
- +}
- +
- +static int ithc_dma_data_buffer_put(struct ithc *ithc, struct ithc_dma_prd_buffer *prds,
- + struct ithc_dma_data_buffer *b, unsigned int idx)
- +{
- + // Give a buffer to the THC.
- + struct ithc_phys_region_desc *prd = prds->addr;
- + prd += idx * prds->num_pages;
- + if (b->active_idx >= 0) {
- + pci_err(ithc->pci, "buffer already active\n");
- + return -EINVAL;
- + }
- + b->active_idx = idx;
- + if (prds->dir == DMA_TO_DEVICE) {
- + // TX buffer: Caller should have already filled the data buffer, so just fill
- + // the PRD and flush.
- + // (TODO: Support multi-page TX buffers. So far no device seems to use or need
- + // these though.)
- + if (b->data_size > PAGE_SIZE)
- + return -EINVAL;
- + prd->addr = sg_dma_address(b->sgt->sgl) >> 10;
- + prd->size = b->data_size | PRD_FLAG_END;
- + flush_kernel_vmap_range(b->addr, b->data_size);
- + } else if (prds->dir == DMA_FROM_DEVICE) {
- + // RX buffer: Reset PRDs.
- + struct scatterlist *sg;
- + int i;
- + for_each_sgtable_dma_sg(b->sgt, sg, i) {
- + prd->addr = sg_dma_address(sg) >> 10;
- + prd->size = sg_dma_len(sg);
- + prd++;
- + }
- + prd[-1].size |= PRD_FLAG_END;
- + }
- + dma_wmb(); // for the prds
- + dma_sync_sgtable_for_device(&ithc->pci->dev, b->sgt, prds->dir);
- + return 0;
- +}
- +
- +static int ithc_dma_data_buffer_get(struct ithc *ithc, struct ithc_dma_prd_buffer *prds,
- + struct ithc_dma_data_buffer *b, unsigned int idx)
- +{
- + // Take a buffer from the THC.
- + struct ithc_phys_region_desc *prd = prds->addr;
- + prd += idx * prds->num_pages;
- + // This is purely a sanity check. We don't strictly need the idx parameter for this
- + // function, because it should always be the same as active_idx, unless we have a bug.
- + if (b->active_idx != idx) {
- + pci_err(ithc->pci, "wrong buffer index\n");
- + return -EINVAL;
- + }
- + b->active_idx = -1;
- + if (prds->dir == DMA_FROM_DEVICE) {
- + // RX buffer: Calculate actual received data size from PRDs.
- + dma_rmb(); // for the prds
- + b->data_size = 0;
- + struct scatterlist *sg;
- + int i;
- + for_each_sgtable_dma_sg(b->sgt, sg, i) {
- + unsigned int size = prd->size;
- + b->data_size += size & PRD_SIZE_MASK;
- + if (size & PRD_FLAG_END)
- + break;
- + if ((size & PRD_SIZE_MASK) != sg_dma_len(sg)) {
- + pci_err(ithc->pci, "truncated prd\n");
- + break;
- + }
- + prd++;
- + }
- + invalidate_kernel_vmap_range(b->addr, b->data_size);
- + }
- + dma_sync_sgtable_for_cpu(&ithc->pci->dev, b->sgt, prds->dir);
- + return 0;
- +}
- +
- +int ithc_dma_rx_init(struct ithc *ithc, u8 channel)
- +{
- + struct ithc_dma_rx *rx = &ithc->dma_rx[channel];
- + mutex_init(&rx->mutex);
- +
- + // Allocate buffers.
- + u32 buf_size = DEVCFG_DMA_RX_SIZE(ithc->config.dma_buf_sizes);
- + unsigned int num_pages = (buf_size + PAGE_SIZE - 1) / PAGE_SIZE;
- + pci_dbg(ithc->pci, "allocating rx buffers: num = %u, size = %u, pages = %u\n",
- + NUM_RX_BUF, buf_size, num_pages);
- + CHECK_RET(ithc_dma_prd_alloc, ithc, &rx->prds, NUM_RX_BUF, num_pages, DMA_FROM_DEVICE);
- + for (unsigned int i = 0; i < NUM_RX_BUF; i++)
- + CHECK_RET(ithc_dma_data_alloc, ithc, &rx->prds, &rx->bufs[i]);
- +
- + // Init registers.
- + writeb(DMA_RX_CONTROL2_RESET, &ithc->regs->dma_rx[channel].control2);
- + lo_hi_writeq(rx->prds.dma_addr, &ithc->regs->dma_rx[channel].addr);
- + writeb(NUM_RX_BUF - 1, &ithc->regs->dma_rx[channel].num_bufs);
- + writeb(num_pages - 1, &ithc->regs->dma_rx[channel].num_prds);
- + u8 head = readb(&ithc->regs->dma_rx[channel].head);
- + if (head) {
- + pci_err(ithc->pci, "head is nonzero (%u)\n", head);
- + return -EIO;
- + }
- +
- + // Init buffers.
- + for (unsigned int i = 0; i < NUM_RX_BUF; i++)
- + CHECK_RET(ithc_dma_data_buffer_put, ithc, &rx->prds, &rx->bufs[i], i);
- +
- + writeb(head ^ DMA_RX_WRAP_FLAG, &ithc->regs->dma_rx[channel].tail);
- + return 0;
- +}
- +
- +void ithc_dma_rx_enable(struct ithc *ithc, u8 channel)
- +{
- + bitsb_set(&ithc->regs->dma_rx[channel].control,
- + DMA_RX_CONTROL_ENABLE | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_DATA);
- + CHECK(waitl, ithc, &ithc->regs->dma_rx[channel].status,
- + DMA_RX_STATUS_ENABLED, DMA_RX_STATUS_ENABLED);
- +}
- +
- +int ithc_dma_tx_init(struct ithc *ithc)
- +{
- + struct ithc_dma_tx *tx = &ithc->dma_tx;
- + mutex_init(&tx->mutex);
- +
- + // Allocate buffers.
- + tx->max_size = DEVCFG_DMA_TX_SIZE(ithc->config.dma_buf_sizes);
- + unsigned int num_pages = (tx->max_size + PAGE_SIZE - 1) / PAGE_SIZE;
- + pci_dbg(ithc->pci, "allocating tx buffers: size = %u, pages = %u\n",
- + tx->max_size, num_pages);
- + CHECK_RET(ithc_dma_prd_alloc, ithc, &tx->prds, 1, num_pages, DMA_TO_DEVICE);
- + CHECK_RET(ithc_dma_data_alloc, ithc, &tx->prds, &tx->buf);
- +
- + // Init registers.
- + lo_hi_writeq(tx->prds.dma_addr, &ithc->regs->dma_tx.addr);
- + writeb(num_pages - 1, &ithc->regs->dma_tx.num_prds);
- +
- + // Init buffers.
- + CHECK_RET(ithc_dma_data_buffer_put, ithc, &ithc->dma_tx.prds, &ithc->dma_tx.buf, 0);
- + return 0;
- +}
- +
- +static int ithc_dma_rx_process_buf(struct ithc *ithc, struct ithc_dma_data_buffer *data,
- + u8 channel, u8 buf)
- +{
- + if (buf >= NUM_RX_BUF) {
- + pci_err(ithc->pci, "invalid dma ringbuffer index\n");
- + return -EINVAL;
- + }
- + u32 len = data->data_size;
- + struct ithc_dma_rx_header *hdr = data->addr;
- + u8 *hiddata = (void *)(hdr + 1);
- + if (len >= sizeof(*hdr) && hdr->code == DMA_RX_CODE_RESET) {
- + // The THC sends a reset request when we need to reinitialize the device.
- + // This usually only happens if we send an invalid command or put the device
- + // in a bad state.
- + CHECK(ithc_reset, ithc);
- + } else if (len < sizeof(*hdr) || len != sizeof(*hdr) + hdr->data_size) {
- + if (hdr->code == DMA_RX_CODE_INPUT_REPORT) {
- + // When the CPU enters a low power state during DMA, we can get truncated
- + // messages. For Surface devices, this will typically be a single touch
- + // report that is only 1 byte, or a multitouch report that is 257 bytes.
- + // See also ithc_set_active().
- + } else {
- + pci_err(ithc->pci, "invalid dma rx data! channel %u, buffer %u, size %u, code %u, data size %u\n",
- + channel, buf, len, hdr->code, hdr->data_size);
- + print_hex_dump_debug(DEVNAME " data: ", DUMP_PREFIX_OFFSET, 32, 1,
- + hdr, min(len, 0x400u), 0);
- + }
- + } else if (hdr->code == DMA_RX_CODE_REPORT_DESCRIPTOR && hdr->data_size > 8) {
- + // Response to a 'get report descriptor' request.
- + // The actual descriptor is preceded by 8 nul bytes.
- + CHECK(hid_parse_report, ithc->hid, hiddata + 8, hdr->data_size - 8);
- + WRITE_ONCE(ithc->hid_parse_done, true);
- + wake_up(&ithc->wait_hid_parse);
- + } else if (hdr->code == DMA_RX_CODE_INPUT_REPORT) {
- + // Standard HID input report containing touch data.
- + CHECK(hid_input_report, ithc->hid, HID_INPUT_REPORT, hiddata, hdr->data_size, 1);
- + } else if (hdr->code == DMA_RX_CODE_FEATURE_REPORT) {
- + // Response to a 'get feature' request.
- + bool done = false;
- + mutex_lock(&ithc->hid_get_feature_mutex);
- + if (ithc->hid_get_feature_buf) {
- + if (hdr->data_size < ithc->hid_get_feature_size)
- + ithc->hid_get_feature_size = hdr->data_size;
- + memcpy(ithc->hid_get_feature_buf, hiddata, ithc->hid_get_feature_size);
- + ithc->hid_get_feature_buf = NULL;
- + done = true;
- + }
- + mutex_unlock(&ithc->hid_get_feature_mutex);
- + if (done) {
- + wake_up(&ithc->wait_hid_get_feature);
- + } else {
- + // Received data without a matching request, or the request already
- + // timed out. (XXX What's the correct thing to do here?)
- + CHECK(hid_input_report, ithc->hid, HID_FEATURE_REPORT,
- + hiddata, hdr->data_size, 1);
- + }
- + } else {
- + pci_dbg(ithc->pci, "unhandled dma rx data! channel %u, buffer %u, size %u, code %u\n",
- + channel, buf, len, hdr->code);
- + print_hex_dump_debug(DEVNAME " data: ", DUMP_PREFIX_OFFSET, 32, 1,
- + hdr, min(len, 0x400u), 0);
- + }
- + return 0;
- +}
- +
- +static int ithc_dma_rx_unlocked(struct ithc *ithc, u8 channel)
- +{
- + // Process all filled RX buffers from the ringbuffer.
- + struct ithc_dma_rx *rx = &ithc->dma_rx[channel];
- + unsigned int n = rx->num_received;
- + u8 head_wrap = readb(&ithc->regs->dma_rx[channel].head);
- + while (1) {
- + u8 tail = n % NUM_RX_BUF;
- + u8 tail_wrap = tail | ((n / NUM_RX_BUF) & 1 ? 0 : DMA_RX_WRAP_FLAG);
- + writeb(tail_wrap, &ithc->regs->dma_rx[channel].tail);
- + // ringbuffer is full if tail_wrap == head_wrap
- + // ringbuffer is empty if tail_wrap == head_wrap ^ WRAP_FLAG
- + if (tail_wrap == (head_wrap ^ DMA_RX_WRAP_FLAG))
- + return 0;
- +
- + // take the buffer that the device just filled
- + struct ithc_dma_data_buffer *b = &rx->bufs[n % NUM_RX_BUF];
- + CHECK_RET(ithc_dma_data_buffer_get, ithc, &rx->prds, b, tail);
- + rx->num_received = ++n;
- +
- + // process data
- + CHECK(ithc_dma_rx_process_buf, ithc, b, channel, tail);
- +
- + // give the buffer back to the device
- + CHECK_RET(ithc_dma_data_buffer_put, ithc, &rx->prds, b, tail);
- + }
- +}
- +int ithc_dma_rx(struct ithc *ithc, u8 channel)
- +{
- + struct ithc_dma_rx *rx = &ithc->dma_rx[channel];
- + mutex_lock(&rx->mutex);
- + int ret = ithc_dma_rx_unlocked(ithc, channel);
- + mutex_unlock(&rx->mutex);
- + return ret;
- +}
- +
- +static int ithc_dma_tx_unlocked(struct ithc *ithc, u32 cmdcode, u32 datasize, void *data)
- +{
- + ithc_set_active(ithc, 100 * USEC_PER_MSEC);
- +
- + // Send a single TX buffer to the THC.
- + pci_dbg(ithc->pci, "dma tx command %u, size %u\n", cmdcode, datasize);
- + struct ithc_dma_tx_header *hdr;
- + // Data must be padded to next 4-byte boundary.
- + u8 padding = datasize & 3 ? 4 - (datasize & 3) : 0;
- + unsigned int fullsize = sizeof(*hdr) + datasize + padding;
- + if (fullsize > ithc->dma_tx.max_size || fullsize > PAGE_SIZE)
- + return -EINVAL;
- + CHECK_RET(ithc_dma_data_buffer_get, ithc, &ithc->dma_tx.prds, &ithc->dma_tx.buf, 0);
- +
- + // Fill the TX buffer with header and data.
- + ithc->dma_tx.buf.data_size = fullsize;
- + hdr = ithc->dma_tx.buf.addr;
- + hdr->code = cmdcode;
- + hdr->data_size = datasize;
- + u8 *dest = (void *)(hdr + 1);
- + memcpy(dest, data, datasize);
- + dest += datasize;
- + for (u8 p = 0; p < padding; p++)
- + *dest++ = 0;
- + CHECK_RET(ithc_dma_data_buffer_put, ithc, &ithc->dma_tx.prds, &ithc->dma_tx.buf, 0);
- +
- + // Let the THC process the buffer.
- + bitsb_set(&ithc->regs->dma_tx.control, DMA_TX_CONTROL_SEND);
- + CHECK_RET(waitb, ithc, &ithc->regs->dma_tx.control, DMA_TX_CONTROL_SEND, 0);
- + writel(DMA_TX_STATUS_DONE, &ithc->regs->dma_tx.status);
- + return 0;
- +}
- +int ithc_dma_tx(struct ithc *ithc, u32 cmdcode, u32 datasize, void *data)
- +{
- + mutex_lock(&ithc->dma_tx.mutex);
- + int ret = ithc_dma_tx_unlocked(ithc, cmdcode, datasize, data);
- + mutex_unlock(&ithc->dma_tx.mutex);
- + return ret;
- +}
- +
- diff --git a/drivers/hid/ithc/ithc-dma.h b/drivers/hid/ithc/ithc-dma.h
- new file mode 100644
- index 000000000000..93652e4476bf
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-dma.h
- @@ -0,0 +1,69 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +#define PRD_SIZE_MASK 0xffffff
- +#define PRD_FLAG_END 0x1000000
- +#define PRD_FLAG_SUCCESS 0x2000000
- +#define PRD_FLAG_ERROR 0x4000000
- +
- +struct ithc_phys_region_desc {
- + u64 addr; // physical addr/1024
- + u32 size; // num bytes, PRD_FLAG_END marks last prd for data split over multiple prds
- + u32 unused;
- +};
- +
- +#define DMA_RX_CODE_INPUT_REPORT 3
- +#define DMA_RX_CODE_FEATURE_REPORT 4
- +#define DMA_RX_CODE_REPORT_DESCRIPTOR 5
- +#define DMA_RX_CODE_RESET 7
- +
- +struct ithc_dma_rx_header {
- + u32 code;
- + u32 data_size;
- + u32 _unknown[14];
- +};
- +
- +#define DMA_TX_CODE_SET_FEATURE 3
- +#define DMA_TX_CODE_GET_FEATURE 4
- +#define DMA_TX_CODE_OUTPUT_REPORT 5
- +#define DMA_TX_CODE_GET_REPORT_DESCRIPTOR 7
- +
- +struct ithc_dma_tx_header {
- + u32 code;
- + u32 data_size;
- +};
- +
- +struct ithc_dma_prd_buffer {
- + void *addr;
- + dma_addr_t dma_addr;
- + u32 size;
- + u32 num_pages; // per data buffer
- + enum dma_data_direction dir;
- +};
- +
- +struct ithc_dma_data_buffer {
- + void *addr;
- + struct sg_table *sgt;
- + int active_idx;
- + u32 data_size;
- +};
- +
- +struct ithc_dma_tx {
- + struct mutex mutex;
- + u32 max_size;
- + struct ithc_dma_prd_buffer prds;
- + struct ithc_dma_data_buffer buf;
- +};
- +
- +struct ithc_dma_rx {
- + struct mutex mutex;
- + u32 num_received;
- + struct ithc_dma_prd_buffer prds;
- + struct ithc_dma_data_buffer bufs[NUM_RX_BUF];
- +};
- +
- +int ithc_dma_rx_init(struct ithc *ithc, u8 channel);
- +void ithc_dma_rx_enable(struct ithc *ithc, u8 channel);
- +int ithc_dma_tx_init(struct ithc *ithc);
- +int ithc_dma_rx(struct ithc *ithc, u8 channel);
- +int ithc_dma_tx(struct ithc *ithc, u32 cmdcode, u32 datasize, void *cmddata);
- +
- diff --git a/drivers/hid/ithc/ithc-main.c b/drivers/hid/ithc/ithc-main.c
- new file mode 100644
- index 000000000000..87ed4aa70fda
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-main.c
- @@ -0,0 +1,728 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +#include "ithc.h"
- +
- +MODULE_DESCRIPTION("Intel Touch Host Controller driver");
- +MODULE_LICENSE("Dual BSD/GPL");
- +
- +// Lakefield
- +#define PCI_DEVICE_ID_INTEL_THC_LKF_PORT1 0x98d0
- +#define PCI_DEVICE_ID_INTEL_THC_LKF_PORT2 0x98d1
- +// Tiger Lake
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT1 0xa0d0
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT2 0xa0d1
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT1 0x43d0
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT2 0x43d1
- +// Alder Lake
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1 0x7ad8
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2 0x7ad9
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1 0x51d0
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2 0x51d1
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1 0x54d0
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2 0x54d1
- +// Raptor Lake
- +#define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT1 0x7a58
- +#define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT2 0x7a59
- +// Meteor Lake
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT1 0x7e48
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT2 0x7e4a
- +
- +static const struct pci_device_id ithc_pci_tbl[] = {
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_LKF_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_LKF_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT2) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_MTL_PORT1) },
- + { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_MTL_PORT2) },
- + // XXX So far the THC seems to be the only Intel PCI device with PCI_CLASS_INPUT_PEN,
- + // so instead of the device list we could just do:
- + // { .vendor = PCI_VENDOR_ID_INTEL, .device = PCI_ANY_ID, .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, .class = PCI_CLASS_INPUT_PEN, .class_mask = ~0, },
- + {}
- +};
- +MODULE_DEVICE_TABLE(pci, ithc_pci_tbl);
- +
- +// Module parameters
- +
- +static bool ithc_use_polling = false;
- +module_param_named(poll, ithc_use_polling, bool, 0);
- +MODULE_PARM_DESC(poll, "Use polling instead of interrupts");
- +
- +// Since all known devices seem to use only channel 1, by default we disable channel 0.
- +static bool ithc_use_rx0 = false;
- +module_param_named(rx0, ithc_use_rx0, bool, 0);
- +MODULE_PARM_DESC(rx0, "Use DMA RX channel 0");
- +
- +static bool ithc_use_rx1 = true;
- +module_param_named(rx1, ithc_use_rx1, bool, 0);
- +MODULE_PARM_DESC(rx1, "Use DMA RX channel 1");
- +
- +// Values below 250 seem to work well on the SP7+. If this is set too high, you may observe cursor stuttering.
- +static int ithc_dma_latency_us = 200;
- +module_param_named(dma_latency_us, ithc_dma_latency_us, int, 0);
- +MODULE_PARM_DESC(dma_latency_us, "Determines the CPU latency QoS value for DMA transfers (in microseconds), -1 to disable latency QoS");
- +
- +// Values above 1700 seem to work well on the SP7+. If this is set too low, you may observe cursor stuttering.
- +static unsigned int ithc_dma_early_us = 2000;
- +module_param_named(dma_early_us, ithc_dma_early_us, uint, 0);
- +MODULE_PARM_DESC(dma_early_us, "Determines how early the CPU latency QoS value is applied before the next expected IRQ (in microseconds)");
- +
- +static bool ithc_log_regs_enabled = false;
- +module_param_named(logregs, ithc_log_regs_enabled, bool, 0);
- +MODULE_PARM_DESC(logregs, "Log changes in register values (for debugging)");
- +
- +// Sysfs attributes
- +
- +static bool ithc_is_config_valid(struct ithc *ithc)
- +{
- + return ithc->config.device_id == DEVCFG_DEVICE_ID_TIC;
- +}
- +
- +static ssize_t vendor_show(struct device *dev, struct device_attribute *attr, char *buf)
- +{
- + struct ithc *ithc = dev_get_drvdata(dev);
- + if (!ithc || !ithc_is_config_valid(ithc))
- + return -ENODEV;
- + return sprintf(buf, "0x%04x", ithc->config.vendor_id);
- +}
- +static DEVICE_ATTR_RO(vendor);
- +static ssize_t product_show(struct device *dev, struct device_attribute *attr, char *buf)
- +{
- + struct ithc *ithc = dev_get_drvdata(dev);
- + if (!ithc || !ithc_is_config_valid(ithc))
- + return -ENODEV;
- + return sprintf(buf, "0x%04x", ithc->config.product_id);
- +}
- +static DEVICE_ATTR_RO(product);
- +static ssize_t revision_show(struct device *dev, struct device_attribute *attr, char *buf)
- +{
- + struct ithc *ithc = dev_get_drvdata(dev);
- + if (!ithc || !ithc_is_config_valid(ithc))
- + return -ENODEV;
- + return sprintf(buf, "%u", ithc->config.revision);
- +}
- +static DEVICE_ATTR_RO(revision);
- +static ssize_t fw_version_show(struct device *dev, struct device_attribute *attr, char *buf)
- +{
- + struct ithc *ithc = dev_get_drvdata(dev);
- + if (!ithc || !ithc_is_config_valid(ithc))
- + return -ENODEV;
- + u32 v = ithc->config.fw_version;
- + return sprintf(buf, "%i.%i.%i.%i", v >> 24, v >> 16 & 0xff, v >> 8 & 0xff, v & 0xff);
- +}
- +static DEVICE_ATTR_RO(fw_version);
- +
- +static const struct attribute_group *ithc_attribute_groups[] = {
- + &(const struct attribute_group){
- + .name = DEVNAME,
- + .attrs = (struct attribute *[]){
- + &dev_attr_vendor.attr,
- + &dev_attr_product.attr,
- + &dev_attr_revision.attr,
- + &dev_attr_fw_version.attr,
- + NULL
- + },
- + },
- + NULL
- +};
- +
- +// HID setup
- +
- +static int ithc_hid_start(struct hid_device *hdev) { return 0; }
- +static void ithc_hid_stop(struct hid_device *hdev) { }
- +static int ithc_hid_open(struct hid_device *hdev) { return 0; }
- +static void ithc_hid_close(struct hid_device *hdev) { }
- +
- +static int ithc_hid_parse(struct hid_device *hdev)
- +{
- + struct ithc *ithc = hdev->driver_data;
- + u64 val = 0;
- + WRITE_ONCE(ithc->hid_parse_done, false);
- + for (int retries = 0; ; retries++) {
- + CHECK_RET(ithc_dma_tx, ithc, DMA_TX_CODE_GET_REPORT_DESCRIPTOR, sizeof(val), &val);
- + if (wait_event_timeout(ithc->wait_hid_parse, READ_ONCE(ithc->hid_parse_done),
- + msecs_to_jiffies(200)))
- + return 0;
- + if (retries > 5) {
- + pci_err(ithc->pci, "failed to read report descriptor\n");
- + return -ETIMEDOUT;
- + }
- + pci_warn(ithc->pci, "failed to read report descriptor, retrying\n");
- + }
- +}
- +
- +static int ithc_hid_raw_request(struct hid_device *hdev, unsigned char reportnum, __u8 *buf,
- + size_t len, unsigned char rtype, int reqtype)
- +{
- + struct ithc *ithc = hdev->driver_data;
- + if (!buf || !len)
- + return -EINVAL;
- + u32 code;
- + if (rtype == HID_OUTPUT_REPORT && reqtype == HID_REQ_SET_REPORT) {
- + code = DMA_TX_CODE_OUTPUT_REPORT;
- + } else if (rtype == HID_FEATURE_REPORT && reqtype == HID_REQ_SET_REPORT) {
- + code = DMA_TX_CODE_SET_FEATURE;
- + } else if (rtype == HID_FEATURE_REPORT && reqtype == HID_REQ_GET_REPORT) {
- + code = DMA_TX_CODE_GET_FEATURE;
- + } else {
- + pci_err(ithc->pci, "unhandled hid request %i %i for report id %i\n",
- + rtype, reqtype, reportnum);
- + return -EINVAL;
- + }
- + buf[0] = reportnum;
- +
- + if (reqtype == HID_REQ_GET_REPORT) {
- + // Prepare for response.
- + mutex_lock(&ithc->hid_get_feature_mutex);
- + ithc->hid_get_feature_buf = buf;
- + ithc->hid_get_feature_size = len;
- + mutex_unlock(&ithc->hid_get_feature_mutex);
- +
- + // Transmit 'get feature' request.
- + int r = CHECK(ithc_dma_tx, ithc, code, 1, buf);
- + if (!r) {
- + r = wait_event_interruptible_timeout(ithc->wait_hid_get_feature,
- + !ithc->hid_get_feature_buf, msecs_to_jiffies(1000));
- + if (!r)
- + r = -ETIMEDOUT;
- + else if (r < 0)
- + r = -EINTR;
- + else
- + r = 0;
- + }
- +
- + // If everything went ok, the buffer has been filled with the response data.
- + // Return the response size.
- + mutex_lock(&ithc->hid_get_feature_mutex);
- + ithc->hid_get_feature_buf = NULL;
- + if (!r)
- + r = ithc->hid_get_feature_size;
- + mutex_unlock(&ithc->hid_get_feature_mutex);
- + return r;
- + }
- +
- + // 'Set feature', or 'output report'. These don't have a response.
- + CHECK_RET(ithc_dma_tx, ithc, code, len, buf);
- + return 0;
- +}
- +
- +static struct hid_ll_driver ithc_ll_driver = {
- + .start = ithc_hid_start,
- + .stop = ithc_hid_stop,
- + .open = ithc_hid_open,
- + .close = ithc_hid_close,
- + .parse = ithc_hid_parse,
- + .raw_request = ithc_hid_raw_request,
- +};
- +
- +static void ithc_hid_devres_release(struct device *dev, void *res)
- +{
- + struct hid_device **hidm = res;
- + if (*hidm)
- + hid_destroy_device(*hidm);
- +}
- +
- +static int ithc_hid_init(struct ithc *ithc)
- +{
- + struct hid_device **hidm = devres_alloc(ithc_hid_devres_release, sizeof(*hidm), GFP_KERNEL);
- + if (!hidm)
- + return -ENOMEM;
- + devres_add(&ithc->pci->dev, hidm);
- + struct hid_device *hid = hid_allocate_device();
- + if (IS_ERR(hid))
- + return PTR_ERR(hid);
- + *hidm = hid;
- +
- + strscpy(hid->name, DEVFULLNAME, sizeof(hid->name));
- + strscpy(hid->phys, ithc->phys, sizeof(hid->phys));
- + hid->ll_driver = &ithc_ll_driver;
- + hid->bus = BUS_PCI;
- + hid->vendor = ithc->config.vendor_id;
- + hid->product = ithc->config.product_id;
- + hid->version = 0x100;
- + hid->dev.parent = &ithc->pci->dev;
- + hid->driver_data = ithc;
- +
- + ithc->hid = hid;
- + return 0;
- +}
- +
- +// Interrupts/polling
- +
- +static enum hrtimer_restart ithc_activity_start_timer_callback(struct hrtimer *t)
- +{
- + struct ithc *ithc = container_of(t, struct ithc, activity_start_timer);
- + ithc_set_active(ithc, ithc_dma_early_us * 2 + USEC_PER_MSEC);
- + return HRTIMER_NORESTART;
- +}
- +
- +static enum hrtimer_restart ithc_activity_end_timer_callback(struct hrtimer *t)
- +{
- + struct ithc *ithc = container_of(t, struct ithc, activity_end_timer);
- + cpu_latency_qos_update_request(&ithc->activity_qos, PM_QOS_DEFAULT_VALUE);
- + return HRTIMER_NORESTART;
- +}
- +
- +void ithc_set_active(struct ithc *ithc, unsigned int duration_us)
- +{
- + if (ithc_dma_latency_us < 0)
- + return;
- + // When CPU usage is very low, the CPU can enter various low power states (C2-C10).
- + // This disrupts DMA, causing truncated DMA messages. ERROR_FLAG_DMA_RX_TIMEOUT will be
- + // set when this happens. The amount of truncated messages can become very high, resulting
- + // in user-visible effects (laggy/stuttering cursor). To avoid this, we use a CPU latency
- + // QoS request to prevent the CPU from entering low power states during touch interactions.
- + cpu_latency_qos_update_request(&ithc->activity_qos, ithc_dma_latency_us);
- + hrtimer_start_range_ns(&ithc->activity_end_timer,
- + ns_to_ktime(duration_us * NSEC_PER_USEC), duration_us * NSEC_PER_USEC, HRTIMER_MODE_REL);
- +}
- +
- +static int ithc_set_device_enabled(struct ithc *ithc, bool enable)
- +{
- + u32 x = ithc->config.touch_cfg =
- + (ithc->config.touch_cfg & ~(u32)DEVCFG_TOUCH_MASK) | DEVCFG_TOUCH_UNKNOWN_2 |
- + (enable ? DEVCFG_TOUCH_ENABLE | DEVCFG_TOUCH_UNKNOWN_3 | DEVCFG_TOUCH_UNKNOWN_4 : 0);
- + return ithc_spi_command(ithc, SPI_CMD_CODE_WRITE,
- + offsetof(struct ithc_device_config, touch_cfg), sizeof(x), &x);
- +}
- +
- +static void ithc_disable_interrupts(struct ithc *ithc)
- +{
- + writel(0, &ithc->regs->error_control);
- + bitsb(&ithc->regs->spi_cmd.control, SPI_CMD_CONTROL_IRQ, 0);
- + bitsb(&ithc->regs->dma_rx[0].control, DMA_RX_CONTROL_IRQ_UNKNOWN_1 | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_UNKNOWN_4 | DMA_RX_CONTROL_IRQ_DATA, 0);
- + bitsb(&ithc->regs->dma_rx[1].control, DMA_RX_CONTROL_IRQ_UNKNOWN_1 | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_UNKNOWN_4 | DMA_RX_CONTROL_IRQ_DATA, 0);
- + bitsb(&ithc->regs->dma_tx.control, DMA_TX_CONTROL_IRQ, 0);
- +}
- +
- +static void ithc_clear_dma_rx_interrupts(struct ithc *ithc, unsigned int channel)
- +{
- + writel(DMA_RX_STATUS_ERROR | DMA_RX_STATUS_UNKNOWN_4 | DMA_RX_STATUS_HAVE_DATA,
- + &ithc->regs->dma_rx[channel].status);
- +}
- +
- +static void ithc_clear_interrupts(struct ithc *ithc)
- +{
- + writel(0xffffffff, &ithc->regs->error_flags);
- + writel(ERROR_STATUS_DMA | ERROR_STATUS_SPI, &ithc->regs->error_status);
- + writel(SPI_CMD_STATUS_DONE | SPI_CMD_STATUS_ERROR, &ithc->regs->spi_cmd.status);
- + ithc_clear_dma_rx_interrupts(ithc, 0);
- + ithc_clear_dma_rx_interrupts(ithc, 1);
- + writel(DMA_TX_STATUS_DONE | DMA_TX_STATUS_ERROR | DMA_TX_STATUS_UNKNOWN_2,
- + &ithc->regs->dma_tx.status);
- +}
- +
- +static void ithc_process(struct ithc *ithc)
- +{
- + ithc_log_regs(ithc);
- +
- + bool rx0 = ithc_use_rx0 && (readl(&ithc->regs->dma_rx[0].status) & (DMA_RX_STATUS_ERROR | DMA_RX_STATUS_HAVE_DATA)) != 0;
- + bool rx1 = ithc_use_rx1 && (readl(&ithc->regs->dma_rx[1].status) & (DMA_RX_STATUS_ERROR | DMA_RX_STATUS_HAVE_DATA)) != 0;
- +
- + // Track time between DMA rx transfers, so we can try to predict when we need to enable CPU latency QoS for the next transfer
- + ktime_t t = ktime_get();
- + ktime_t dt = ktime_sub(t, ithc->last_rx_time);
- + if (rx0 || rx1) {
- + ithc->last_rx_time = t;
- + if (dt > ms_to_ktime(100)) {
- + ithc->cur_rx_seq_count = 0;
- + ithc->cur_rx_seq_errors = 0;
- + }
- + ithc->cur_rx_seq_count++;
- + if (!ithc_use_polling && ithc_dma_latency_us >= 0) {
- + // Disable QoS, since the DMA transfer has completed (we re-enable it after a delay below)
- + cpu_latency_qos_update_request(&ithc->activity_qos, PM_QOS_DEFAULT_VALUE);
- + hrtimer_try_to_cancel(&ithc->activity_end_timer);
- + }
- + }
- +
- + // Read and clear error bits
- + u32 err = readl(&ithc->regs->error_flags);
- + if (err) {
- + writel(err, &ithc->regs->error_flags);
- + if (err & ~ERROR_FLAG_DMA_RX_TIMEOUT)
- + pci_err(ithc->pci, "error flags: 0x%08x\n", err);
- + if (err & ERROR_FLAG_DMA_RX_TIMEOUT) {
- + // Only log an error if we see a significant number of these errors.
- + ithc->cur_rx_seq_errors++;
- + if (ithc->cur_rx_seq_errors && ithc->cur_rx_seq_errors % 50 == 0 && ithc->cur_rx_seq_errors > ithc->cur_rx_seq_count / 10)
- + pci_err(ithc->pci, "High number of DMA RX timeouts/errors (%u/%u, dt=%lldus). Try adjusting dma_early_us and/or dma_latency_us.\n",
- + ithc->cur_rx_seq_errors, ithc->cur_rx_seq_count, ktime_to_us(dt));
- + }
- + }
- +
- + // Process DMA rx
- + if (ithc_use_rx0) {
- + ithc_clear_dma_rx_interrupts(ithc, 0);
- + if (rx0)
- + ithc_dma_rx(ithc, 0);
- + }
- + if (ithc_use_rx1) {
- + ithc_clear_dma_rx_interrupts(ithc, 1);
- + if (rx1)
- + ithc_dma_rx(ithc, 1);
- + }
- +
- + // Start timer to re-enable QoS for next rx, but only if we've seen an ERROR_FLAG_DMA_RX_TIMEOUT
- + if ((rx0 || rx1) && !ithc_use_polling && ithc_dma_latency_us >= 0 && ithc->cur_rx_seq_errors > 0) {
- + ktime_t expires = ktime_add(t, ktime_sub_us(dt, ithc_dma_early_us));
- + hrtimer_start_range_ns(&ithc->activity_start_timer, expires, 10 * NSEC_PER_USEC, HRTIMER_MODE_ABS);
- + }
- +
- + ithc_log_regs(ithc);
- +}
- +
- +static irqreturn_t ithc_interrupt_thread(int irq, void *arg)
- +{
- + struct ithc *ithc = arg;
- + pci_dbg(ithc->pci, "IRQ! err=%08x/%08x/%08x, cmd=%02x/%08x, rx0=%02x/%08x, rx1=%02x/%08x, tx=%02x/%08x\n",
- + readl(&ithc->regs->error_control), readl(&ithc->regs->error_status), readl(&ithc->regs->error_flags),
- + readb(&ithc->regs->spi_cmd.control), readl(&ithc->regs->spi_cmd.status),
- + readb(&ithc->regs->dma_rx[0].control), readl(&ithc->regs->dma_rx[0].status),
- + readb(&ithc->regs->dma_rx[1].control), readl(&ithc->regs->dma_rx[1].status),
- + readb(&ithc->regs->dma_tx.control), readl(&ithc->regs->dma_tx.status));
- + ithc_process(ithc);
- + return IRQ_HANDLED;
- +}
- +
- +static int ithc_poll_thread(void *arg)
- +{
- + struct ithc *ithc = arg;
- + unsigned int sleep = 100;
- + while (!kthread_should_stop()) {
- + u32 n = ithc->dma_rx[1].num_received;
- + ithc_process(ithc);
- + // Decrease polling interval to 20ms if we received data, otherwise slowly
- + // increase it up to 200ms.
- + if (n != ithc->dma_rx[1].num_received) {
- + ithc_set_active(ithc, 100 * USEC_PER_MSEC);
- + sleep = 20;
- + } else {
- + sleep = min(200u, sleep + (sleep >> 4) + 1);
- + }
- + msleep_interruptible(sleep);
- + }
- + return 0;
- +}
- +
- +// Device initialization and shutdown
- +
- +static void ithc_disable(struct ithc *ithc)
- +{
- + bitsl_set(&ithc->regs->control_bits, CONTROL_QUIESCE);
- + CHECK(waitl, ithc, &ithc->regs->control_bits, CONTROL_IS_QUIESCED, CONTROL_IS_QUIESCED);
- + bitsl(&ithc->regs->control_bits, CONTROL_NRESET, 0);
- + bitsb(&ithc->regs->spi_cmd.control, SPI_CMD_CONTROL_SEND, 0);
- + bitsb(&ithc->regs->dma_tx.control, DMA_TX_CONTROL_SEND, 0);
- + bitsb(&ithc->regs->dma_rx[0].control, DMA_RX_CONTROL_ENABLE, 0);
- + bitsb(&ithc->regs->dma_rx[1].control, DMA_RX_CONTROL_ENABLE, 0);
- + ithc_disable_interrupts(ithc);
- + ithc_clear_interrupts(ithc);
- +}
- +
- +static int ithc_init_device(struct ithc *ithc)
- +{
- + ithc_log_regs(ithc);
- + bool was_enabled = (readl(&ithc->regs->control_bits) & CONTROL_NRESET) != 0;
- + ithc_disable(ithc);
- + CHECK_RET(waitl, ithc, &ithc->regs->control_bits, CONTROL_READY, CONTROL_READY);
- +
- + // Since we don't yet know which SPI config the device wants, use default speed and mode
- + // initially for reading config data.
- + ithc_set_spi_config(ithc, 10, 0);
- +
- + // Setting the following bit seems to make reading the config more reliable.
- + bitsl_set(&ithc->regs->dma_rx[0].unknown_init_bits, 0x80000000);
- +
- + // If the device was previously enabled, wait a bit to make sure it's fully shut down.
- + if (was_enabled)
- + if (msleep_interruptible(100))
- + return -EINTR;
- +
- + // Take the touch device out of reset.
- + bitsl(&ithc->regs->control_bits, CONTROL_QUIESCE, 0);
- + CHECK_RET(waitl, ithc, &ithc->regs->control_bits, CONTROL_IS_QUIESCED, 0);
- + for (int retries = 0; ; retries++) {
- + ithc_log_regs(ithc);
- + bitsl_set(&ithc->regs->control_bits, CONTROL_NRESET);
- + if (!waitl(ithc, &ithc->regs->state, 0xf, 2))
- + break;
- + if (retries > 5) {
- + pci_err(ithc->pci, "failed to reset device, state = 0x%08x\n", readl(&ithc->regs->state));
- + return -ETIMEDOUT;
- + }
- + pci_warn(ithc->pci, "invalid state, retrying reset\n");
- + bitsl(&ithc->regs->control_bits, CONTROL_NRESET, 0);
- + if (msleep_interruptible(1000))
- + return -EINTR;
- + }
- + ithc_log_regs(ithc);
- +
- + // Waiting for the following status bit makes reading config much more reliable,
- + // however the official driver does not seem to do this...
- + CHECK(waitl, ithc, &ithc->regs->dma_rx[0].status, DMA_RX_STATUS_UNKNOWN_4, DMA_RX_STATUS_UNKNOWN_4);
- +
- + // Read configuration data.
- + for (int retries = 0; ; retries++) {
- + ithc_log_regs(ithc);
- + memset(&ithc->config, 0, sizeof(ithc->config));
- + CHECK_RET(ithc_spi_command, ithc, SPI_CMD_CODE_READ, 0, sizeof(ithc->config), &ithc->config);
- + u32 *p = (void *)&ithc->config;
- + pci_info(ithc->pci, "config: %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x\n",
- + p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
- + if (ithc_is_config_valid(ithc))
- + break;
- + if (retries > 10) {
- + pci_err(ithc->pci, "failed to read config, unknown device ID 0x%08x\n",
- + ithc->config.device_id);
- + return -EIO;
- + }
- + pci_warn(ithc->pci, "failed to read config, retrying\n");
- + if (msleep_interruptible(100))
- + return -EINTR;
- + }
- + ithc_log_regs(ithc);
- +
- + // Apply SPI config and enable touch device.
- + CHECK_RET(ithc_set_spi_config, ithc,
- + DEVCFG_SPI_MAX_FREQ(ithc->config.spi_config),
- + DEVCFG_SPI_MODE(ithc->config.spi_config));
- + CHECK_RET(ithc_set_device_enabled, ithc, true);
- + ithc_log_regs(ithc);
- + return 0;
- +}
- +
- +int ithc_reset(struct ithc *ithc)
- +{
- + // FIXME This should probably do devres_release_group()+ithc_start().
- + // But because this is called during DMA processing, that would have to be done
- + // asynchronously (schedule_work()?). And with extra locking?
- + pci_err(ithc->pci, "reset\n");
- + CHECK(ithc_init_device, ithc);
- + if (ithc_use_rx0)
- + ithc_dma_rx_enable(ithc, 0);
- + if (ithc_use_rx1)
- + ithc_dma_rx_enable(ithc, 1);
- + ithc_log_regs(ithc);
- + pci_dbg(ithc->pci, "reset completed\n");
- + return 0;
- +}
- +
- +static void ithc_stop(void *res)
- +{
- + struct ithc *ithc = res;
- + pci_dbg(ithc->pci, "stopping\n");
- + ithc_log_regs(ithc);
- +
- + if (ithc->poll_thread)
- + CHECK(kthread_stop, ithc->poll_thread);
- + if (ithc->irq >= 0)
- + disable_irq(ithc->irq);
- + CHECK(ithc_set_device_enabled, ithc, false);
- + ithc_disable(ithc);
- + hrtimer_cancel(&ithc->activity_start_timer);
- + hrtimer_cancel(&ithc->activity_end_timer);
- + cpu_latency_qos_remove_request(&ithc->activity_qos);
- +
- + // Clear DMA config.
- + for (unsigned int i = 0; i < 2; i++) {
- + CHECK(waitl, ithc, &ithc->regs->dma_rx[i].status, DMA_RX_STATUS_ENABLED, 0);
- + lo_hi_writeq(0, &ithc->regs->dma_rx[i].addr);
- + writeb(0, &ithc->regs->dma_rx[i].num_bufs);
- + writeb(0, &ithc->regs->dma_rx[i].num_prds);
- + }
- + lo_hi_writeq(0, &ithc->regs->dma_tx.addr);
- + writeb(0, &ithc->regs->dma_tx.num_prds);
- +
- + ithc_log_regs(ithc);
- + pci_dbg(ithc->pci, "stopped\n");
- +}
- +
- +static void ithc_clear_drvdata(void *res)
- +{
- + struct pci_dev *pci = res;
- + pci_set_drvdata(pci, NULL);
- +}
- +
- +static int ithc_start(struct pci_dev *pci)
- +{
- + pci_dbg(pci, "starting\n");
- + if (pci_get_drvdata(pci)) {
- + pci_err(pci, "device already initialized\n");
- + return -EINVAL;
- + }
- + if (!devres_open_group(&pci->dev, ithc_start, GFP_KERNEL))
- + return -ENOMEM;
- +
- + // Allocate/init main driver struct.
- + struct ithc *ithc = devm_kzalloc(&pci->dev, sizeof(*ithc), GFP_KERNEL);
- + if (!ithc)
- + return -ENOMEM;
- + ithc->irq = -1;
- + ithc->pci = pci;
- + snprintf(ithc->phys, sizeof(ithc->phys), "pci-%s/" DEVNAME, pci_name(pci));
- + init_waitqueue_head(&ithc->wait_hid_parse);
- + init_waitqueue_head(&ithc->wait_hid_get_feature);
- + mutex_init(&ithc->hid_get_feature_mutex);
- + pci_set_drvdata(pci, ithc);
- + CHECK_RET(devm_add_action_or_reset, &pci->dev, ithc_clear_drvdata, pci);
- + if (ithc_log_regs_enabled)
- + ithc->prev_regs = devm_kzalloc(&pci->dev, sizeof(*ithc->prev_regs), GFP_KERNEL);
- +
- + // PCI initialization.
- + CHECK_RET(pcim_enable_device, pci);
- + pci_set_master(pci);
- + CHECK_RET(pcim_iomap_regions, pci, BIT(0), DEVNAME " regs");
- + CHECK_RET(dma_set_mask_and_coherent, &pci->dev, DMA_BIT_MASK(64));
- + CHECK_RET(pci_set_power_state, pci, PCI_D0);
- + ithc->regs = pcim_iomap_table(pci)[0];
- +
- + // Allocate IRQ.
- + if (!ithc_use_polling) {
- + CHECK_RET(pci_alloc_irq_vectors, pci, 1, 1, PCI_IRQ_MSI | PCI_IRQ_MSIX);
- + ithc->irq = CHECK(pci_irq_vector, pci, 0);
- + if (ithc->irq < 0)
- + return ithc->irq;
- + }
- +
- + // Initialize THC and touch device.
- + CHECK_RET(ithc_init_device, ithc);
- + CHECK(devm_device_add_groups, &pci->dev, ithc_attribute_groups);
- + if (ithc_use_rx0)
- + CHECK_RET(ithc_dma_rx_init, ithc, 0);
- + if (ithc_use_rx1)
- + CHECK_RET(ithc_dma_rx_init, ithc, 1);
- + CHECK_RET(ithc_dma_tx_init, ithc);
- +
- + cpu_latency_qos_add_request(&ithc->activity_qos, PM_QOS_DEFAULT_VALUE);
- + hrtimer_init(&ithc->activity_start_timer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
- + ithc->activity_start_timer.function = ithc_activity_start_timer_callback;
- + hrtimer_init(&ithc->activity_end_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
- + ithc->activity_end_timer.function = ithc_activity_end_timer_callback;
- +
- + // Add ithc_stop() callback AFTER setting up DMA buffers, so that polling/irqs/DMA are
- + // disabled BEFORE the buffers are freed.
- + CHECK_RET(devm_add_action_or_reset, &pci->dev, ithc_stop, ithc);
- +
- + CHECK_RET(ithc_hid_init, ithc);
- +
- + // Start polling/IRQ.
- + if (ithc_use_polling) {
- + pci_info(pci, "using polling instead of irq\n");
- + // Use a thread instead of simple timer because we want to be able to sleep.
- + ithc->poll_thread = kthread_run(ithc_poll_thread, ithc, DEVNAME "poll");
- + if (IS_ERR(ithc->poll_thread)) {
- + int err = PTR_ERR(ithc->poll_thread);
- + ithc->poll_thread = NULL;
- + return err;
- + }
- + } else {
- + CHECK_RET(devm_request_threaded_irq, &pci->dev, ithc->irq, NULL,
- + ithc_interrupt_thread, IRQF_TRIGGER_HIGH | IRQF_ONESHOT, DEVNAME, ithc);
- + }
- +
- + if (ithc_use_rx0)
- + ithc_dma_rx_enable(ithc, 0);
- + if (ithc_use_rx1)
- + ithc_dma_rx_enable(ithc, 1);
- +
- + // hid_add_device() can only be called after irq/polling is started and DMA is enabled,
- + // because it calls ithc_hid_parse() which reads the report descriptor via DMA.
- + CHECK_RET(hid_add_device, ithc->hid);
- +
- + CHECK(ithc_debug_init, ithc);
- +
- + pci_dbg(pci, "started\n");
- + return 0;
- +}
- +
- +static int ithc_probe(struct pci_dev *pci, const struct pci_device_id *id)
- +{
- + pci_dbg(pci, "device probe\n");
- + return ithc_start(pci);
- +}
- +
- +static void ithc_remove(struct pci_dev *pci)
- +{
- + pci_dbg(pci, "device remove\n");
- + // all cleanup is handled by devres
- +}
- +
- +// For suspend/resume, we just deinitialize and reinitialize everything.
- +// TODO It might be cleaner to keep the HID device around, however we would then have to signal
- +// to userspace that the touch device has lost state and userspace needs to e.g. resend 'set
- +// feature' requests. Hidraw does not seem to have a facility to do that.
- +static int ithc_suspend(struct device *dev)
- +{
- + struct pci_dev *pci = to_pci_dev(dev);
- + pci_dbg(pci, "pm suspend\n");
- + devres_release_group(dev, ithc_start);
- + return 0;
- +}
- +
- +static int ithc_resume(struct device *dev)
- +{
- + struct pci_dev *pci = to_pci_dev(dev);
- + pci_dbg(pci, "pm resume\n");
- + return ithc_start(pci);
- +}
- +
- +static int ithc_freeze(struct device *dev)
- +{
- + struct pci_dev *pci = to_pci_dev(dev);
- + pci_dbg(pci, "pm freeze\n");
- + devres_release_group(dev, ithc_start);
- + return 0;
- +}
- +
- +static int ithc_thaw(struct device *dev)
- +{
- + struct pci_dev *pci = to_pci_dev(dev);
- + pci_dbg(pci, "pm thaw\n");
- + return ithc_start(pci);
- +}
- +
- +static int ithc_restore(struct device *dev)
- +{
- + struct pci_dev *pci = to_pci_dev(dev);
- + pci_dbg(pci, "pm restore\n");
- + return ithc_start(pci);
- +}
- +
- +static struct pci_driver ithc_driver = {
- + .name = DEVNAME,
- + .id_table = ithc_pci_tbl,
- + .probe = ithc_probe,
- + .remove = ithc_remove,
- + .driver.pm = &(const struct dev_pm_ops) {
- + .suspend = ithc_suspend,
- + .resume = ithc_resume,
- + .freeze = ithc_freeze,
- + .thaw = ithc_thaw,
- + .restore = ithc_restore,
- + },
- + //.dev_groups = ithc_attribute_groups, // could use this (since 5.14), however the attributes won't have valid values until config has been read anyway
- +};
- +
- +static int __init ithc_init(void)
- +{
- + return pci_register_driver(&ithc_driver);
- +}
- +
- +static void __exit ithc_exit(void)
- +{
- + pci_unregister_driver(&ithc_driver);
- +}
- +
- +module_init(ithc_init);
- +module_exit(ithc_exit);
- +
- diff --git a/drivers/hid/ithc/ithc-regs.c b/drivers/hid/ithc/ithc-regs.c
- new file mode 100644
- index 000000000000..e058721886e3
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-regs.c
- @@ -0,0 +1,96 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +#include "ithc.h"
- +
- +#define reg_num(r) (0x1fff & (u16)(__force u64)(r))
- +
- +void bitsl(__iomem u32 *reg, u32 mask, u32 val)
- +{
- + if (val & ~mask)
- + pr_err("register 0x%x: invalid value 0x%x for bitmask 0x%x\n",
- + reg_num(reg), val, mask);
- + writel((readl(reg) & ~mask) | (val & mask), reg);
- +}
- +
- +void bitsb(__iomem u8 *reg, u8 mask, u8 val)
- +{
- + if (val & ~mask)
- + pr_err("register 0x%x: invalid value 0x%x for bitmask 0x%x\n",
- + reg_num(reg), val, mask);
- + writeb((readb(reg) & ~mask) | (val & mask), reg);
- +}
- +
- +int waitl(struct ithc *ithc, __iomem u32 *reg, u32 mask, u32 val)
- +{
- + pci_dbg(ithc->pci, "waiting for reg 0x%04x mask 0x%08x val 0x%08x\n",
- + reg_num(reg), mask, val);
- + u32 x;
- + if (readl_poll_timeout(reg, x, (x & mask) == val, 200, 1000*1000)) {
- + pci_err(ithc->pci, "timed out waiting for reg 0x%04x mask 0x%08x val 0x%08x\n",
- + reg_num(reg), mask, val);
- + return -ETIMEDOUT;
- + }
- + pci_dbg(ithc->pci, "done waiting\n");
- + return 0;
- +}
- +
- +int waitb(struct ithc *ithc, __iomem u8 *reg, u8 mask, u8 val)
- +{
- + pci_dbg(ithc->pci, "waiting for reg 0x%04x mask 0x%02x val 0x%02x\n",
- + reg_num(reg), mask, val);
- + u8 x;
- + if (readb_poll_timeout(reg, x, (x & mask) == val, 200, 1000*1000)) {
- + pci_err(ithc->pci, "timed out waiting for reg 0x%04x mask 0x%02x val 0x%02x\n",
- + reg_num(reg), mask, val);
- + return -ETIMEDOUT;
- + }
- + pci_dbg(ithc->pci, "done waiting\n");
- + return 0;
- +}
- +
- +int ithc_set_spi_config(struct ithc *ithc, u8 speed, u8 mode)
- +{
- + pci_dbg(ithc->pci, "setting SPI speed to %i, mode %i\n", speed, mode);
- + if (mode == 3)
- + mode = 2;
- + bitsl(&ithc->regs->spi_config,
- + SPI_CONFIG_MODE(0xff) | SPI_CONFIG_SPEED(0xff) | SPI_CONFIG_UNKNOWN_18(0xff) | SPI_CONFIG_SPEED2(0xff),
- + SPI_CONFIG_MODE(mode) | SPI_CONFIG_SPEED(speed) | SPI_CONFIG_UNKNOWN_18(0) | SPI_CONFIG_SPEED2(speed));
- + return 0;
- +}
- +
- +int ithc_spi_command(struct ithc *ithc, u8 command, u32 offset, u32 size, void *data)
- +{
- + pci_dbg(ithc->pci, "SPI command %u, size %u, offset %u\n", command, size, offset);
- + if (size > sizeof(ithc->regs->spi_cmd.data))
- + return -EINVAL;
- +
- + // Wait if the device is still busy.
- + CHECK_RET(waitl, ithc, &ithc->regs->spi_cmd.status, SPI_CMD_STATUS_BUSY, 0);
- + // Clear result flags.
- + writel(SPI_CMD_STATUS_DONE | SPI_CMD_STATUS_ERROR, &ithc->regs->spi_cmd.status);
- +
- + // Init SPI command data.
- + writeb(command, &ithc->regs->spi_cmd.code);
- + writew(size, &ithc->regs->spi_cmd.size);
- + writel(offset, &ithc->regs->spi_cmd.offset);
- + u32 *p = data, n = (size + 3) / 4;
- + for (u32 i = 0; i < n; i++)
- + writel(p[i], &ithc->regs->spi_cmd.data[i]);
- +
- + // Start transmission.
- + bitsb_set(&ithc->regs->spi_cmd.control, SPI_CMD_CONTROL_SEND);
- + CHECK_RET(waitl, ithc, &ithc->regs->spi_cmd.status, SPI_CMD_STATUS_BUSY, 0);
- +
- + // Read response.
- + if ((readl(&ithc->regs->spi_cmd.status) & (SPI_CMD_STATUS_DONE | SPI_CMD_STATUS_ERROR)) != SPI_CMD_STATUS_DONE)
- + return -EIO;
- + if (readw(&ithc->regs->spi_cmd.size) != size)
- + return -EMSGSIZE;
- + for (u32 i = 0; i < n; i++)
- + p[i] = readl(&ithc->regs->spi_cmd.data[i]);
- +
- + writel(SPI_CMD_STATUS_DONE | SPI_CMD_STATUS_ERROR, &ithc->regs->spi_cmd.status);
- + return 0;
- +}
- +
- diff --git a/drivers/hid/ithc/ithc-regs.h b/drivers/hid/ithc/ithc-regs.h
- new file mode 100644
- index 000000000000..d4007d9e2bac
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-regs.h
- @@ -0,0 +1,189 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +#define CONTROL_QUIESCE BIT(1)
- +#define CONTROL_IS_QUIESCED BIT(2)
- +#define CONTROL_NRESET BIT(3)
- +#define CONTROL_READY BIT(29)
- +
- +#define SPI_CONFIG_MODE(x) (((x) & 3) << 2)
- +#define SPI_CONFIG_SPEED(x) (((x) & 7) << 4)
- +#define SPI_CONFIG_UNKNOWN_18(x) (((x) & 3) << 18)
- +#define SPI_CONFIG_SPEED2(x) (((x) & 0xf) << 20) // high bit = high speed mode?
- +
- +#define ERROR_CONTROL_UNKNOWN_0 BIT(0)
- +#define ERROR_CONTROL_DISABLE_DMA BIT(1) // clears DMA_RX_CONTROL_ENABLE when a DMA error occurs
- +#define ERROR_CONTROL_UNKNOWN_2 BIT(2)
- +#define ERROR_CONTROL_UNKNOWN_3 BIT(3)
- +#define ERROR_CONTROL_IRQ_DMA_UNKNOWN_9 BIT(9)
- +#define ERROR_CONTROL_IRQ_DMA_UNKNOWN_10 BIT(10)
- +#define ERROR_CONTROL_IRQ_DMA_UNKNOWN_12 BIT(12)
- +#define ERROR_CONTROL_IRQ_DMA_UNKNOWN_13 BIT(13)
- +#define ERROR_CONTROL_UNKNOWN_16(x) (((x) & 0xff) << 16) // spi error code irq?
- +#define ERROR_CONTROL_SET_DMA_STATUS BIT(29) // sets DMA_RX_STATUS_ERROR when a DMA error occurs
- +
- +#define ERROR_STATUS_DMA BIT(28)
- +#define ERROR_STATUS_SPI BIT(30)
- +
- +#define ERROR_FLAG_DMA_UNKNOWN_9 BIT(9)
- +#define ERROR_FLAG_DMA_UNKNOWN_10 BIT(10)
- +#define ERROR_FLAG_DMA_RX_TIMEOUT BIT(12) // set when we receive a truncated DMA message
- +#define ERROR_FLAG_DMA_UNKNOWN_13 BIT(13)
- +#define ERROR_FLAG_SPI_BUS_TURNAROUND BIT(16)
- +#define ERROR_FLAG_SPI_RESPONSE_TIMEOUT BIT(17)
- +#define ERROR_FLAG_SPI_INTRA_PACKET_TIMEOUT BIT(18)
- +#define ERROR_FLAG_SPI_INVALID_RESPONSE BIT(19)
- +#define ERROR_FLAG_SPI_HS_RX_TIMEOUT BIT(20)
- +#define ERROR_FLAG_SPI_TOUCH_IC_INIT BIT(21)
- +
- +#define SPI_CMD_CONTROL_SEND BIT(0) // cleared by device when sending is complete
- +#define SPI_CMD_CONTROL_IRQ BIT(1)
- +
- +#define SPI_CMD_CODE_READ 4
- +#define SPI_CMD_CODE_WRITE 6
- +
- +#define SPI_CMD_STATUS_DONE BIT(0)
- +#define SPI_CMD_STATUS_ERROR BIT(1)
- +#define SPI_CMD_STATUS_BUSY BIT(3)
- +
- +#define DMA_TX_CONTROL_SEND BIT(0) // cleared by device when sending is complete
- +#define DMA_TX_CONTROL_IRQ BIT(3)
- +
- +#define DMA_TX_STATUS_DONE BIT(0)
- +#define DMA_TX_STATUS_ERROR BIT(1)
- +#define DMA_TX_STATUS_UNKNOWN_2 BIT(2)
- +#define DMA_TX_STATUS_UNKNOWN_3 BIT(3) // busy?
- +
- +#define DMA_RX_CONTROL_ENABLE BIT(0)
- +#define DMA_RX_CONTROL_IRQ_UNKNOWN_1 BIT(1) // rx1 only?
- +#define DMA_RX_CONTROL_IRQ_ERROR BIT(3) // rx1 only?
- +#define DMA_RX_CONTROL_IRQ_UNKNOWN_4 BIT(4) // rx0 only?
- +#define DMA_RX_CONTROL_IRQ_DATA BIT(5)
- +
- +#define DMA_RX_CONTROL2_UNKNOWN_5 BIT(5) // rx0 only?
- +#define DMA_RX_CONTROL2_RESET BIT(7) // resets ringbuffer indices
- +
- +#define DMA_RX_WRAP_FLAG BIT(7)
- +
- +#define DMA_RX_STATUS_ERROR BIT(3)
- +#define DMA_RX_STATUS_UNKNOWN_4 BIT(4) // set in rx0 after using CONTROL_NRESET when it becomes possible to read config (can take >100ms)
- +#define DMA_RX_STATUS_HAVE_DATA BIT(5)
- +#define DMA_RX_STATUS_ENABLED BIT(8)
- +
- +// COUNTER_RESET can be written to counter registers to reset them to zero. However, in some cases this can mess up the THC.
- +#define COUNTER_RESET BIT(31)
- +
- +struct ithc_registers {
- + /* 0000 */ u32 _unknown_0000[1024];
- + /* 1000 */ u32 _unknown_1000;
- + /* 1004 */ u32 _unknown_1004;
- + /* 1008 */ u32 control_bits;
- + /* 100c */ u32 _unknown_100c;
- + /* 1010 */ u32 spi_config;
- + /* 1014 */ u32 _unknown_1014[3];
- + /* 1020 */ u32 error_control;
- + /* 1024 */ u32 error_status; // write to clear
- + /* 1028 */ u32 error_flags; // write to clear
- + /* 102c */ u32 _unknown_102c[5];
- + struct {
- + /* 1040 */ u8 control;
- + /* 1041 */ u8 code;
- + /* 1042 */ u16 size;
- + /* 1044 */ u32 status; // write to clear
- + /* 1048 */ u32 offset;
- + /* 104c */ u32 data[16];
- + /* 108c */ u32 _unknown_108c;
- + } spi_cmd;
- + struct {
- + /* 1090 */ u64 addr; // cannot be written with writeq(), must use lo_hi_writeq()
- + /* 1098 */ u8 control;
- + /* 1099 */ u8 _unknown_1099;
- + /* 109a */ u8 _unknown_109a;
- + /* 109b */ u8 num_prds;
- + /* 109c */ u32 status; // write to clear
- + } dma_tx;
- + /* 10a0 */ u32 _unknown_10a0[7];
- + /* 10bc */ u32 state; // is 0xe0000402 (dev config val 0) after CONTROL_NRESET, 0xe0000461 after first touch, 0xe0000401 after DMA_RX_CODE_RESET
- + /* 10c0 */ u32 _unknown_10c0[8];
- + /* 10e0 */ u32 _unknown_10e0_counters[3];
- + /* 10ec */ u32 _unknown_10ec[5];
- + struct {
- + /* 1100/1200 */ u64 addr; // cannot be written with writeq(), must use lo_hi_writeq()
- + /* 1108/1208 */ u8 num_bufs;
- + /* 1109/1209 */ u8 num_prds;
- + /* 110a/120a */ u16 _unknown_110a;
- + /* 110c/120c */ u8 control;
- + /* 110d/120d */ u8 head;
- + /* 110e/120e */ u8 tail;
- + /* 110f/120f */ u8 control2;
- + /* 1110/1210 */ u32 status; // write to clear
- + /* 1114/1214 */ u32 _unknown_1114;
- + /* 1118/1218 */ u64 _unknown_1118_guc_addr;
- + /* 1120/1220 */ u32 _unknown_1120_guc;
- + /* 1124/1224 */ u32 _unknown_1124_guc;
- + /* 1128/1228 */ u32 unknown_init_bits; // bit 2 = guc related, bit 3 = rx1 related, bit 4 = guc related
- + /* 112c/122c */ u32 _unknown_112c;
- + /* 1130/1230 */ u64 _unknown_1130_guc_addr;
- + /* 1138/1238 */ u32 _unknown_1138_guc;
- + /* 113c/123c */ u32 _unknown_113c;
- + /* 1140/1240 */ u32 _unknown_1140_guc;
- + /* 1144/1244 */ u32 _unknown_1144[23];
- + /* 11a0/12a0 */ u32 _unknown_11a0_counters[6];
- + /* 11b8/12b8 */ u32 _unknown_11b8[18];
- + } dma_rx[2];
- +};
- +static_assert(sizeof(struct ithc_registers) == 0x1300);
- +
- +#define DEVCFG_DMA_RX_SIZE(x) ((((x) & 0x3fff) + 1) << 6)
- +#define DEVCFG_DMA_TX_SIZE(x) (((((x) >> 14) & 0x3ff) + 1) << 6)
- +
- +#define DEVCFG_TOUCH_MASK 0x3f
- +#define DEVCFG_TOUCH_ENABLE BIT(0)
- +#define DEVCFG_TOUCH_UNKNOWN_1 BIT(1)
- +#define DEVCFG_TOUCH_UNKNOWN_2 BIT(2)
- +#define DEVCFG_TOUCH_UNKNOWN_3 BIT(3)
- +#define DEVCFG_TOUCH_UNKNOWN_4 BIT(4)
- +#define DEVCFG_TOUCH_UNKNOWN_5 BIT(5)
- +#define DEVCFG_TOUCH_UNKNOWN_6 BIT(6)
- +
- +#define DEVCFG_DEVICE_ID_TIC 0x43495424 // "$TIC"
- +
- +#define DEVCFG_SPI_MAX_FREQ(x) (((x) >> 1) & 0xf) // high bit = use high speed mode?
- +#define DEVCFG_SPI_MODE(x) (((x) >> 6) & 3)
- +#define DEVCFG_SPI_UNKNOWN_8(x) (((x) >> 8) & 0x3f)
- +#define DEVCFG_SPI_NEEDS_HEARTBEAT BIT(20) // TODO implement heartbeat
- +#define DEVCFG_SPI_HEARTBEAT_INTERVAL(x) (((x) >> 21) & 7)
- +#define DEVCFG_SPI_UNKNOWN_25 BIT(25)
- +#define DEVCFG_SPI_UNKNOWN_26 BIT(26)
- +#define DEVCFG_SPI_UNKNOWN_27 BIT(27)
- +#define DEVCFG_SPI_DELAY(x) (((x) >> 28) & 7) // TODO use this
- +#define DEVCFG_SPI_USE_EXT_READ_CFG BIT(31) // TODO use this?
- +
- +struct ithc_device_config { // (Example values are from an SP7+.)
- + u32 _unknown_00; // 00 = 0xe0000402 (0xe0000401 after DMA_RX_CODE_RESET)
- + u32 _unknown_04; // 04 = 0x00000000
- + u32 dma_buf_sizes; // 08 = 0x000a00ff
- + u32 touch_cfg; // 0c = 0x0000001c
- + u32 _unknown_10; // 10 = 0x0000001c
- + u32 device_id; // 14 = 0x43495424 = "$TIC"
- + u32 spi_config; // 18 = 0xfda00a2e
- + u16 vendor_id; // 1c = 0x045e = Microsoft Corp.
- + u16 product_id; // 1e = 0x0c1a
- + u32 revision; // 20 = 0x00000001
- + u32 fw_version; // 24 = 0x05008a8b = 5.0.138.139 (this value looks more random on newer devices)
- + u32 _unknown_28; // 28 = 0x00000000
- + u32 fw_mode; // 2c = 0x00000000 (for fw update?)
- + u32 _unknown_30; // 30 = 0x00000000
- + u32 _unknown_34; // 34 = 0x0404035e (u8,u8,u8,u8 = version?)
- + u32 _unknown_38; // 38 = 0x000001c0 (0x000001c1 after DMA_RX_CODE_RESET)
- + u32 _unknown_3c; // 3c = 0x00000002
- +};
- +
- +void bitsl(__iomem u32 *reg, u32 mask, u32 val);
- +void bitsb(__iomem u8 *reg, u8 mask, u8 val);
- +#define bitsl_set(reg, x) bitsl(reg, x, x)
- +#define bitsb_set(reg, x) bitsb(reg, x, x)
- +int waitl(struct ithc *ithc, __iomem u32 *reg, u32 mask, u32 val);
- +int waitb(struct ithc *ithc, __iomem u8 *reg, u8 mask, u8 val);
- +int ithc_set_spi_config(struct ithc *ithc, u8 speed, u8 mode);
- +int ithc_spi_command(struct ithc *ithc, u8 command, u32 offset, u32 size, void *data);
- +
- diff --git a/drivers/hid/ithc/ithc.h b/drivers/hid/ithc/ithc.h
- new file mode 100644
- index 000000000000..028e55a4ec53
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc.h
- @@ -0,0 +1,67 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +#include <linux/module.h>
- +#include <linux/input.h>
- +#include <linux/hid.h>
- +#include <linux/dma-mapping.h>
- +#include <linux/highmem.h>
- +#include <linux/pci.h>
- +#include <linux/io-64-nonatomic-lo-hi.h>
- +#include <linux/iopoll.h>
- +#include <linux/delay.h>
- +#include <linux/kthread.h>
- +#include <linux/miscdevice.h>
- +#include <linux/debugfs.h>
- +#include <linux/poll.h>
- +#include <linux/timer.h>
- +#include <linux/pm_qos.h>
- +
- +#define DEVNAME "ithc"
- +#define DEVFULLNAME "Intel Touch Host Controller"
- +
- +#undef pr_fmt
- +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
- +
- +#define CHECK(fn, ...) ({ int r = fn(__VA_ARGS__); if (r < 0) pci_err(ithc->pci, "%s: %s failed with %i\n", __func__, #fn, r); r; })
- +#define CHECK_RET(...) do { int r = CHECK(__VA_ARGS__); if (r < 0) return r; } while (0)
- +
- +#define NUM_RX_BUF 16
- +
- +struct ithc;
- +
- +#include "ithc-regs.h"
- +#include "ithc-dma.h"
- +
- +struct ithc {
- + char phys[32];
- + struct pci_dev *pci;
- + int irq;
- + struct task_struct *poll_thread;
- +
- + struct pm_qos_request activity_qos;
- + struct hrtimer activity_start_timer;
- + struct hrtimer activity_end_timer;
- + ktime_t last_rx_time;
- + unsigned int cur_rx_seq_count;
- + unsigned int cur_rx_seq_errors;
- +
- + struct hid_device *hid;
- + bool hid_parse_done;
- + wait_queue_head_t wait_hid_parse;
- + wait_queue_head_t wait_hid_get_feature;
- + struct mutex hid_get_feature_mutex;
- + void *hid_get_feature_buf;
- + size_t hid_get_feature_size;
- +
- + struct ithc_registers __iomem *regs;
- + struct ithc_registers *prev_regs; // for debugging
- + struct ithc_device_config config;
- + struct ithc_dma_rx dma_rx[2];
- + struct ithc_dma_tx dma_tx;
- +};
- +
- +int ithc_reset(struct ithc *ithc);
- +void ithc_set_active(struct ithc *ithc, unsigned int duration_us);
- +int ithc_debug_init(struct ithc *ithc);
- +void ithc_log_regs(struct ithc *ithc);
- +
- --
- 2.45.2
- From 299f645a4bc247c2f5adae925f56978870b133f8 Mon Sep 17 00:00:00 2001
- From: quo <tuple@list.ru>
- Date: Fri, 19 Apr 2024 22:11:09 +0200
- Subject: [PATCH] hid: ithc: Update from quo/ithc-linux
- - Added QuickSPI support for Surface Laptop Studio 2
- - Use Latency Tolerance Reporting instead of manual CPU latency adjustments
- Based on: https://github.com/quo/ithc-linux/commit/18afc6ffacd70b49fdee2eb1ab0a8acd159edb31
- Signed-off-by: Dorian Stoll <dorian.stoll@tmsp.io>
- Patchset: ithc
- ---
- drivers/hid/ithc/Kbuild | 2 +-
- drivers/hid/ithc/ithc-debug.c | 33 +-
- drivers/hid/ithc/ithc-debug.h | 7 +
- drivers/hid/ithc/ithc-dma.c | 125 ++-----
- drivers/hid/ithc/ithc-dma.h | 24 +-
- drivers/hid/ithc/ithc-hid.c | 207 +++++++++++
- drivers/hid/ithc/ithc-hid.h | 32 ++
- drivers/hid/ithc/ithc-legacy.c | 252 ++++++++++++++
- drivers/hid/ithc/ithc-legacy.h | 8 +
- drivers/hid/ithc/ithc-main.c | 386 ++++-----------------
- drivers/hid/ithc/ithc-quickspi.c | 578 +++++++++++++++++++++++++++++++
- drivers/hid/ithc/ithc-quickspi.h | 39 +++
- drivers/hid/ithc/ithc-regs.c | 72 +++-
- drivers/hid/ithc/ithc-regs.h | 143 ++++----
- drivers/hid/ithc/ithc.h | 71 ++--
- 15 files changed, 1441 insertions(+), 538 deletions(-)
- create mode 100644 drivers/hid/ithc/ithc-debug.h
- create mode 100644 drivers/hid/ithc/ithc-hid.c
- create mode 100644 drivers/hid/ithc/ithc-hid.h
- create mode 100644 drivers/hid/ithc/ithc-legacy.c
- create mode 100644 drivers/hid/ithc/ithc-legacy.h
- create mode 100644 drivers/hid/ithc/ithc-quickspi.c
- create mode 100644 drivers/hid/ithc/ithc-quickspi.h
- diff --git a/drivers/hid/ithc/Kbuild b/drivers/hid/ithc/Kbuild
- index aea83f2ac07b..4937ba131297 100644
- --- a/drivers/hid/ithc/Kbuild
- +++ b/drivers/hid/ithc/Kbuild
- @@ -1,6 +1,6 @@
- obj-$(CONFIG_HID_ITHC) := ithc.o
-
- -ithc-objs := ithc-main.o ithc-regs.o ithc-dma.o ithc-debug.o
- +ithc-objs := ithc-main.o ithc-regs.o ithc-dma.o ithc-hid.o ithc-legacy.o ithc-quickspi.o ithc-debug.o
-
- ccflags-y := -std=gnu11 -Wno-declaration-after-statement
-
- diff --git a/drivers/hid/ithc/ithc-debug.c b/drivers/hid/ithc/ithc-debug.c
- index 1f1f1e33f2e5..2d8c6afe9966 100644
- --- a/drivers/hid/ithc/ithc-debug.c
- +++ b/drivers/hid/ithc/ithc-debug.c
- @@ -85,10 +85,11 @@ static ssize_t ithc_debugfs_cmd_write(struct file *f, const char __user *buf, si
- case 'd': // dma command: cmd len data...
- // get report descriptor: d 7 8 0 0
- // enable multitouch: d 3 2 0x0105
- - if (n < 2 || a[1] > (n - 2) * 4)
- + if (n < 1)
- return -EINVAL;
- - pci_info(ithc->pci, "debug dma command %u with %u bytes of data\n", a[0], a[1]);
- - if (ithc_dma_tx(ithc, a[0], a[1], a + 2))
- + pci_info(ithc->pci, "debug dma command with %u bytes of data\n", n * 4);
- + struct ithc_data data = { .type = ITHC_DATA_RAW, .size = n * 4, .data = a };
- + if (ithc_dma_tx(ithc, &data))
- pci_err(ithc->pci, "dma tx failed\n");
- break;
- default:
- @@ -98,6 +99,23 @@ static ssize_t ithc_debugfs_cmd_write(struct file *f, const char __user *buf, si
- return len;
- }
-
- +static struct dentry *dbg_dir;
- +
- +void __init ithc_debug_init_module(void)
- +{
- + struct dentry *d = debugfs_create_dir(DEVNAME, NULL);
- + if (IS_ERR(d))
- + pr_warn("failed to create debugfs dir (%li)\n", PTR_ERR(d));
- + else
- + dbg_dir = d;
- +}
- +
- +void __exit ithc_debug_exit_module(void)
- +{
- + debugfs_remove_recursive(dbg_dir);
- + dbg_dir = NULL;
- +}
- +
- static const struct file_operations ithc_debugfops_cmd = {
- .owner = THIS_MODULE,
- .write = ithc_debugfs_cmd_write,
- @@ -106,17 +124,18 @@ static const struct file_operations ithc_debugfops_cmd = {
- static void ithc_debugfs_devres_release(struct device *dev, void *res)
- {
- struct dentry **dbgm = res;
- - if (*dbgm)
- - debugfs_remove_recursive(*dbgm);
- + debugfs_remove_recursive(*dbgm);
- }
-
- -int ithc_debug_init(struct ithc *ithc)
- +int ithc_debug_init_device(struct ithc *ithc)
- {
- + if (!dbg_dir)
- + return -ENOENT;
- struct dentry **dbgm = devres_alloc(ithc_debugfs_devres_release, sizeof(*dbgm), GFP_KERNEL);
- if (!dbgm)
- return -ENOMEM;
- devres_add(&ithc->pci->dev, dbgm);
- - struct dentry *dbg = debugfs_create_dir(DEVNAME, NULL);
- + struct dentry *dbg = debugfs_create_dir(pci_name(ithc->pci), dbg_dir);
- if (IS_ERR(dbg))
- return PTR_ERR(dbg);
- *dbgm = dbg;
- diff --git a/drivers/hid/ithc/ithc-debug.h b/drivers/hid/ithc/ithc-debug.h
- new file mode 100644
- index 000000000000..38c53d916bdb
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-debug.h
- @@ -0,0 +1,7 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +void ithc_debug_init_module(void);
- +void ithc_debug_exit_module(void);
- +int ithc_debug_init_device(struct ithc *ithc);
- +void ithc_log_regs(struct ithc *ithc);
- +
- diff --git a/drivers/hid/ithc/ithc-dma.c b/drivers/hid/ithc/ithc-dma.c
- index ffb8689b8a78..bf4eab33062b 100644
- --- a/drivers/hid/ithc/ithc-dma.c
- +++ b/drivers/hid/ithc/ithc-dma.c
- @@ -173,10 +173,9 @@ int ithc_dma_rx_init(struct ithc *ithc, u8 channel)
- mutex_init(&rx->mutex);
-
- // Allocate buffers.
- - u32 buf_size = DEVCFG_DMA_RX_SIZE(ithc->config.dma_buf_sizes);
- - unsigned int num_pages = (buf_size + PAGE_SIZE - 1) / PAGE_SIZE;
- + unsigned int num_pages = (ithc->max_rx_size + PAGE_SIZE - 1) / PAGE_SIZE;
- pci_dbg(ithc->pci, "allocating rx buffers: num = %u, size = %u, pages = %u\n",
- - NUM_RX_BUF, buf_size, num_pages);
- + NUM_RX_BUF, ithc->max_rx_size, num_pages);
- CHECK_RET(ithc_dma_prd_alloc, ithc, &rx->prds, NUM_RX_BUF, num_pages, DMA_FROM_DEVICE);
- for (unsigned int i = 0; i < NUM_RX_BUF; i++)
- CHECK_RET(ithc_dma_data_alloc, ithc, &rx->prds, &rx->bufs[i]);
- @@ -214,10 +213,9 @@ int ithc_dma_tx_init(struct ithc *ithc)
- mutex_init(&tx->mutex);
-
- // Allocate buffers.
- - tx->max_size = DEVCFG_DMA_TX_SIZE(ithc->config.dma_buf_sizes);
- - unsigned int num_pages = (tx->max_size + PAGE_SIZE - 1) / PAGE_SIZE;
- + unsigned int num_pages = (ithc->max_tx_size + PAGE_SIZE - 1) / PAGE_SIZE;
- pci_dbg(ithc->pci, "allocating tx buffers: size = %u, pages = %u\n",
- - tx->max_size, num_pages);
- + ithc->max_tx_size, num_pages);
- CHECK_RET(ithc_dma_prd_alloc, ithc, &tx->prds, 1, num_pages, DMA_TO_DEVICE);
- CHECK_RET(ithc_dma_data_alloc, ithc, &tx->prds, &tx->buf);
-
- @@ -230,71 +228,6 @@ int ithc_dma_tx_init(struct ithc *ithc)
- return 0;
- }
-
- -static int ithc_dma_rx_process_buf(struct ithc *ithc, struct ithc_dma_data_buffer *data,
- - u8 channel, u8 buf)
- -{
- - if (buf >= NUM_RX_BUF) {
- - pci_err(ithc->pci, "invalid dma ringbuffer index\n");
- - return -EINVAL;
- - }
- - u32 len = data->data_size;
- - struct ithc_dma_rx_header *hdr = data->addr;
- - u8 *hiddata = (void *)(hdr + 1);
- - if (len >= sizeof(*hdr) && hdr->code == DMA_RX_CODE_RESET) {
- - // The THC sends a reset request when we need to reinitialize the device.
- - // This usually only happens if we send an invalid command or put the device
- - // in a bad state.
- - CHECK(ithc_reset, ithc);
- - } else if (len < sizeof(*hdr) || len != sizeof(*hdr) + hdr->data_size) {
- - if (hdr->code == DMA_RX_CODE_INPUT_REPORT) {
- - // When the CPU enters a low power state during DMA, we can get truncated
- - // messages. For Surface devices, this will typically be a single touch
- - // report that is only 1 byte, or a multitouch report that is 257 bytes.
- - // See also ithc_set_active().
- - } else {
- - pci_err(ithc->pci, "invalid dma rx data! channel %u, buffer %u, size %u, code %u, data size %u\n",
- - channel, buf, len, hdr->code, hdr->data_size);
- - print_hex_dump_debug(DEVNAME " data: ", DUMP_PREFIX_OFFSET, 32, 1,
- - hdr, min(len, 0x400u), 0);
- - }
- - } else if (hdr->code == DMA_RX_CODE_REPORT_DESCRIPTOR && hdr->data_size > 8) {
- - // Response to a 'get report descriptor' request.
- - // The actual descriptor is preceded by 8 nul bytes.
- - CHECK(hid_parse_report, ithc->hid, hiddata + 8, hdr->data_size - 8);
- - WRITE_ONCE(ithc->hid_parse_done, true);
- - wake_up(&ithc->wait_hid_parse);
- - } else if (hdr->code == DMA_RX_CODE_INPUT_REPORT) {
- - // Standard HID input report containing touch data.
- - CHECK(hid_input_report, ithc->hid, HID_INPUT_REPORT, hiddata, hdr->data_size, 1);
- - } else if (hdr->code == DMA_RX_CODE_FEATURE_REPORT) {
- - // Response to a 'get feature' request.
- - bool done = false;
- - mutex_lock(&ithc->hid_get_feature_mutex);
- - if (ithc->hid_get_feature_buf) {
- - if (hdr->data_size < ithc->hid_get_feature_size)
- - ithc->hid_get_feature_size = hdr->data_size;
- - memcpy(ithc->hid_get_feature_buf, hiddata, ithc->hid_get_feature_size);
- - ithc->hid_get_feature_buf = NULL;
- - done = true;
- - }
- - mutex_unlock(&ithc->hid_get_feature_mutex);
- - if (done) {
- - wake_up(&ithc->wait_hid_get_feature);
- - } else {
- - // Received data without a matching request, or the request already
- - // timed out. (XXX What's the correct thing to do here?)
- - CHECK(hid_input_report, ithc->hid, HID_FEATURE_REPORT,
- - hiddata, hdr->data_size, 1);
- - }
- - } else {
- - pci_dbg(ithc->pci, "unhandled dma rx data! channel %u, buffer %u, size %u, code %u\n",
- - channel, buf, len, hdr->code);
- - print_hex_dump_debug(DEVNAME " data: ", DUMP_PREFIX_OFFSET, 32, 1,
- - hdr, min(len, 0x400u), 0);
- - }
- - return 0;
- -}
- -
- static int ithc_dma_rx_unlocked(struct ithc *ithc, u8 channel)
- {
- // Process all filled RX buffers from the ringbuffer.
- @@ -316,7 +249,16 @@ static int ithc_dma_rx_unlocked(struct ithc *ithc, u8 channel)
- rx->num_received = ++n;
-
- // process data
- - CHECK(ithc_dma_rx_process_buf, ithc, b, channel, tail);
- + struct ithc_data d;
- + if ((ithc->use_quickspi ? ithc_quickspi_decode_rx : ithc_legacy_decode_rx)
- + (ithc, b->addr, b->data_size, &d) < 0) {
- + pci_err(ithc->pci, "invalid dma rx data! channel %u, buffer %u, size %u: %*ph\n",
- + channel, tail, b->data_size, min((int)b->data_size, 64), b->addr);
- + print_hex_dump_debug(DEVNAME " data: ", DUMP_PREFIX_OFFSET, 32, 1,
- + b->addr, min(b->data_size, 0x400u), 0);
- + } else {
- + ithc_hid_process_data(ithc, &d);
- + }
-
- // give the buffer back to the device
- CHECK_RET(ithc_dma_data_buffer_put, ithc, &rx->prds, b, tail);
- @@ -331,31 +273,28 @@ int ithc_dma_rx(struct ithc *ithc, u8 channel)
- return ret;
- }
-
- -static int ithc_dma_tx_unlocked(struct ithc *ithc, u32 cmdcode, u32 datasize, void *data)
- +static int ithc_dma_tx_unlocked(struct ithc *ithc, const struct ithc_data *data)
- {
- - ithc_set_active(ithc, 100 * USEC_PER_MSEC);
- -
- // Send a single TX buffer to the THC.
- - pci_dbg(ithc->pci, "dma tx command %u, size %u\n", cmdcode, datasize);
- - struct ithc_dma_tx_header *hdr;
- - // Data must be padded to next 4-byte boundary.
- - u8 padding = datasize & 3 ? 4 - (datasize & 3) : 0;
- - unsigned int fullsize = sizeof(*hdr) + datasize + padding;
- - if (fullsize > ithc->dma_tx.max_size || fullsize > PAGE_SIZE)
- - return -EINVAL;
- + pci_dbg(ithc->pci, "dma tx data type %u, size %u\n", data->type, data->size);
- CHECK_RET(ithc_dma_data_buffer_get, ithc, &ithc->dma_tx.prds, &ithc->dma_tx.buf, 0);
-
- // Fill the TX buffer with header and data.
- - ithc->dma_tx.buf.data_size = fullsize;
- - hdr = ithc->dma_tx.buf.addr;
- - hdr->code = cmdcode;
- - hdr->data_size = datasize;
- - u8 *dest = (void *)(hdr + 1);
- - memcpy(dest, data, datasize);
- - dest += datasize;
- - for (u8 p = 0; p < padding; p++)
- - *dest++ = 0;
- + ssize_t sz;
- + if (data->type == ITHC_DATA_RAW) {
- + sz = min(data->size, ithc->max_tx_size);
- + memcpy(ithc->dma_tx.buf.addr, data->data, sz);
- + } else {
- + sz = (ithc->use_quickspi ? ithc_quickspi_encode_tx : ithc_legacy_encode_tx)
- + (ithc, data, ithc->dma_tx.buf.addr, ithc->max_tx_size);
- + }
- + ithc->dma_tx.buf.data_size = sz < 0 ? 0 : sz;
- CHECK_RET(ithc_dma_data_buffer_put, ithc, &ithc->dma_tx.prds, &ithc->dma_tx.buf, 0);
- + if (sz < 0) {
- + pci_err(ithc->pci, "failed to encode tx data type %i, size %u, error %i\n",
- + data->type, data->size, (int)sz);
- + return -EINVAL;
- + }
-
- // Let the THC process the buffer.
- bitsb_set(&ithc->regs->dma_tx.control, DMA_TX_CONTROL_SEND);
- @@ -363,10 +302,10 @@ static int ithc_dma_tx_unlocked(struct ithc *ithc, u32 cmdcode, u32 datasize, vo
- writel(DMA_TX_STATUS_DONE, &ithc->regs->dma_tx.status);
- return 0;
- }
- -int ithc_dma_tx(struct ithc *ithc, u32 cmdcode, u32 datasize, void *data)
- +int ithc_dma_tx(struct ithc *ithc, const struct ithc_data *data)
- {
- mutex_lock(&ithc->dma_tx.mutex);
- - int ret = ithc_dma_tx_unlocked(ithc, cmdcode, datasize, data);
- + int ret = ithc_dma_tx_unlocked(ithc, data);
- mutex_unlock(&ithc->dma_tx.mutex);
- return ret;
- }
- diff --git a/drivers/hid/ithc/ithc-dma.h b/drivers/hid/ithc/ithc-dma.h
- index 93652e4476bf..1749a5819b3e 100644
- --- a/drivers/hid/ithc/ithc-dma.h
- +++ b/drivers/hid/ithc/ithc-dma.h
- @@ -11,27 +11,6 @@ struct ithc_phys_region_desc {
- u32 unused;
- };
-
- -#define DMA_RX_CODE_INPUT_REPORT 3
- -#define DMA_RX_CODE_FEATURE_REPORT 4
- -#define DMA_RX_CODE_REPORT_DESCRIPTOR 5
- -#define DMA_RX_CODE_RESET 7
- -
- -struct ithc_dma_rx_header {
- - u32 code;
- - u32 data_size;
- - u32 _unknown[14];
- -};
- -
- -#define DMA_TX_CODE_SET_FEATURE 3
- -#define DMA_TX_CODE_GET_FEATURE 4
- -#define DMA_TX_CODE_OUTPUT_REPORT 5
- -#define DMA_TX_CODE_GET_REPORT_DESCRIPTOR 7
- -
- -struct ithc_dma_tx_header {
- - u32 code;
- - u32 data_size;
- -};
- -
- struct ithc_dma_prd_buffer {
- void *addr;
- dma_addr_t dma_addr;
- @@ -49,7 +28,6 @@ struct ithc_dma_data_buffer {
-
- struct ithc_dma_tx {
- struct mutex mutex;
- - u32 max_size;
- struct ithc_dma_prd_buffer prds;
- struct ithc_dma_data_buffer buf;
- };
- @@ -65,5 +43,5 @@ int ithc_dma_rx_init(struct ithc *ithc, u8 channel);
- void ithc_dma_rx_enable(struct ithc *ithc, u8 channel);
- int ithc_dma_tx_init(struct ithc *ithc);
- int ithc_dma_rx(struct ithc *ithc, u8 channel);
- -int ithc_dma_tx(struct ithc *ithc, u32 cmdcode, u32 datasize, void *cmddata);
- +int ithc_dma_tx(struct ithc *ithc, const struct ithc_data *data);
-
- diff --git a/drivers/hid/ithc/ithc-hid.c b/drivers/hid/ithc/ithc-hid.c
- new file mode 100644
- index 000000000000..065646ab499e
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-hid.c
- @@ -0,0 +1,207 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +#include "ithc.h"
- +
- +static int ithc_hid_start(struct hid_device *hdev) { return 0; }
- +static void ithc_hid_stop(struct hid_device *hdev) { }
- +static int ithc_hid_open(struct hid_device *hdev) { return 0; }
- +static void ithc_hid_close(struct hid_device *hdev) { }
- +
- +static int ithc_hid_parse(struct hid_device *hdev)
- +{
- + struct ithc *ithc = hdev->driver_data;
- + const struct ithc_data get_report_desc = { .type = ITHC_DATA_REPORT_DESCRIPTOR };
- + WRITE_ONCE(ithc->hid.parse_done, false);
- + for (int retries = 0; ; retries++) {
- + ithc_log_regs(ithc);
- + CHECK_RET(ithc_dma_tx, ithc, &get_report_desc);
- + if (wait_event_timeout(ithc->hid.wait_parse, READ_ONCE(ithc->hid.parse_done),
- + msecs_to_jiffies(200))) {
- + ithc_log_regs(ithc);
- + return 0;
- + }
- + if (retries > 5) {
- + ithc_log_regs(ithc);
- + pci_err(ithc->pci, "failed to read report descriptor\n");
- + return -ETIMEDOUT;
- + }
- + pci_warn(ithc->pci, "failed to read report descriptor, retrying\n");
- + }
- +}
- +
- +static int ithc_hid_raw_request(struct hid_device *hdev, unsigned char reportnum, __u8 *buf,
- + size_t len, unsigned char rtype, int reqtype)
- +{
- + struct ithc *ithc = hdev->driver_data;
- + if (!buf || !len)
- + return -EINVAL;
- +
- + struct ithc_data d = { .size = len, .data = buf };
- + buf[0] = reportnum;
- +
- + if (rtype == HID_OUTPUT_REPORT && reqtype == HID_REQ_SET_REPORT) {
- + d.type = ITHC_DATA_OUTPUT_REPORT;
- + CHECK_RET(ithc_dma_tx, ithc, &d);
- + return 0;
- + }
- +
- + if (rtype == HID_FEATURE_REPORT && reqtype == HID_REQ_SET_REPORT) {
- + d.type = ITHC_DATA_SET_FEATURE;
- + CHECK_RET(ithc_dma_tx, ithc, &d);
- + return 0;
- + }
- +
- + if (rtype == HID_FEATURE_REPORT && reqtype == HID_REQ_GET_REPORT) {
- + d.type = ITHC_DATA_GET_FEATURE;
- + d.data = &reportnum;
- + d.size = 1;
- +
- + // Prepare for response.
- + mutex_lock(&ithc->hid.get_feature_mutex);
- + ithc->hid.get_feature_buf = buf;
- + ithc->hid.get_feature_size = len;
- + mutex_unlock(&ithc->hid.get_feature_mutex);
- +
- + // Transmit 'get feature' request.
- + int r = CHECK(ithc_dma_tx, ithc, &d);
- + if (!r) {
- + r = wait_event_interruptible_timeout(ithc->hid.wait_get_feature,
- + !ithc->hid.get_feature_buf, msecs_to_jiffies(1000));
- + if (!r)
- + r = -ETIMEDOUT;
- + else if (r < 0)
- + r = -EINTR;
- + else
- + r = 0;
- + }
- +
- + // If everything went ok, the buffer has been filled with the response data.
- + // Return the response size.
- + mutex_lock(&ithc->hid.get_feature_mutex);
- + ithc->hid.get_feature_buf = NULL;
- + if (!r)
- + r = ithc->hid.get_feature_size;
- + mutex_unlock(&ithc->hid.get_feature_mutex);
- + return r;
- + }
- +
- + pci_err(ithc->pci, "unhandled hid request %i %i for report id %i\n",
- + rtype, reqtype, reportnum);
- + return -EINVAL;
- +}
- +
- +// FIXME hid_input_report()/hid_parse_report() currently don't take const buffers, so we have to
- +// cast away the const to avoid a compiler warning...
- +#define NOCONST(x) ((void *)x)
- +
- +void ithc_hid_process_data(struct ithc *ithc, struct ithc_data *d)
- +{
- + WARN_ON(!ithc->hid.dev);
- + if (!ithc->hid.dev)
- + return;
- +
- + switch (d->type) {
- +
- + case ITHC_DATA_IGNORE:
- + return;
- +
- + case ITHC_DATA_ERROR:
- + CHECK(ithc_reset, ithc);
- + return;
- +
- + case ITHC_DATA_REPORT_DESCRIPTOR:
- + // Response to the report descriptor request sent by ithc_hid_parse().
- + CHECK(hid_parse_report, ithc->hid.dev, NOCONST(d->data), d->size);
- + WRITE_ONCE(ithc->hid.parse_done, true);
- + wake_up(&ithc->hid.wait_parse);
- + return;
- +
- + case ITHC_DATA_INPUT_REPORT:
- + {
- + // Standard HID input report.
- + int r = hid_input_report(ithc->hid.dev, HID_INPUT_REPORT, NOCONST(d->data), d->size, 1);
- + if (r < 0) {
- + pci_warn(ithc->pci, "hid_input_report failed with %i (size %u, report ID 0x%02x)\n",
- + r, d->size, d->size ? *(u8 *)d->data : 0);
- + print_hex_dump_debug(DEVNAME " report: ", DUMP_PREFIX_OFFSET, 32, 1,
- + d->data, min(d->size, 0x400u), 0);
- + }
- + return;
- + }
- +
- + case ITHC_DATA_GET_FEATURE:
- + {
- + // Response to a 'get feature' request sent by ithc_hid_raw_request().
- + bool done = false;
- + mutex_lock(&ithc->hid.get_feature_mutex);
- + if (ithc->hid.get_feature_buf) {
- + if (d->size < ithc->hid.get_feature_size)
- + ithc->hid.get_feature_size = d->size;
- + memcpy(ithc->hid.get_feature_buf, d->data, ithc->hid.get_feature_size);
- + ithc->hid.get_feature_buf = NULL;
- + done = true;
- + }
- + mutex_unlock(&ithc->hid.get_feature_mutex);
- + if (done) {
- + wake_up(&ithc->hid.wait_get_feature);
- + } else {
- + // Received data without a matching request, or the request already
- + // timed out. (XXX What's the correct thing to do here?)
- + CHECK(hid_input_report, ithc->hid.dev, HID_FEATURE_REPORT,
- + NOCONST(d->data), d->size, 1);
- + }
- + return;
- + }
- +
- + default:
- + pci_err(ithc->pci, "unhandled data type %i\n", d->type);
- + return;
- + }
- +}
- +
- +static struct hid_ll_driver ithc_ll_driver = {
- + .start = ithc_hid_start,
- + .stop = ithc_hid_stop,
- + .open = ithc_hid_open,
- + .close = ithc_hid_close,
- + .parse = ithc_hid_parse,
- + .raw_request = ithc_hid_raw_request,
- +};
- +
- +static void ithc_hid_devres_release(struct device *dev, void *res)
- +{
- + struct hid_device **hidm = res;
- + if (*hidm)
- + hid_destroy_device(*hidm);
- +}
- +
- +int ithc_hid_init(struct ithc *ithc)
- +{
- + struct hid_device **hidm = devres_alloc(ithc_hid_devres_release, sizeof(*hidm), GFP_KERNEL);
- + if (!hidm)
- + return -ENOMEM;
- + devres_add(&ithc->pci->dev, hidm);
- + struct hid_device *hid = hid_allocate_device();
- + if (IS_ERR(hid))
- + return PTR_ERR(hid);
- + *hidm = hid;
- +
- + strscpy(hid->name, DEVFULLNAME, sizeof(hid->name));
- + strscpy(hid->phys, ithc->phys, sizeof(hid->phys));
- + hid->ll_driver = &ithc_ll_driver;
- + hid->bus = BUS_PCI;
- + hid->vendor = ithc->vendor_id;
- + hid->product = ithc->product_id;
- + hid->version = 0x100;
- + hid->dev.parent = &ithc->pci->dev;
- + hid->driver_data = ithc;
- +
- + ithc->hid.dev = hid;
- +
- + init_waitqueue_head(&ithc->hid.wait_parse);
- + init_waitqueue_head(&ithc->hid.wait_get_feature);
- + mutex_init(&ithc->hid.get_feature_mutex);
- +
- + return 0;
- +}
- +
- diff --git a/drivers/hid/ithc/ithc-hid.h b/drivers/hid/ithc/ithc-hid.h
- new file mode 100644
- index 000000000000..599eb912c8c8
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-hid.h
- @@ -0,0 +1,32 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +enum ithc_data_type {
- + ITHC_DATA_IGNORE,
- + ITHC_DATA_RAW,
- + ITHC_DATA_ERROR,
- + ITHC_DATA_REPORT_DESCRIPTOR,
- + ITHC_DATA_INPUT_REPORT,
- + ITHC_DATA_OUTPUT_REPORT,
- + ITHC_DATA_GET_FEATURE,
- + ITHC_DATA_SET_FEATURE,
- +};
- +
- +struct ithc_data {
- + enum ithc_data_type type;
- + u32 size;
- + const void *data;
- +};
- +
- +struct ithc_hid {
- + struct hid_device *dev;
- + bool parse_done;
- + wait_queue_head_t wait_parse;
- + wait_queue_head_t wait_get_feature;
- + struct mutex get_feature_mutex;
- + void *get_feature_buf;
- + size_t get_feature_size;
- +};
- +
- +int ithc_hid_init(struct ithc *ithc);
- +void ithc_hid_process_data(struct ithc *ithc, struct ithc_data *d);
- +
- diff --git a/drivers/hid/ithc/ithc-legacy.c b/drivers/hid/ithc/ithc-legacy.c
- new file mode 100644
- index 000000000000..5c1da11e3f1d
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-legacy.c
- @@ -0,0 +1,252 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +#include "ithc.h"
- +
- +#define DEVCFG_DMA_RX_SIZE(x) ((((x) & 0x3fff) + 1) << 6)
- +#define DEVCFG_DMA_TX_SIZE(x) (((((x) >> 14) & 0x3ff) + 1) << 6)
- +
- +#define DEVCFG_TOUCH_MASK 0x3f
- +#define DEVCFG_TOUCH_ENABLE BIT(0)
- +#define DEVCFG_TOUCH_PROP_DATA_ENABLE BIT(1)
- +#define DEVCFG_TOUCH_HID_REPORT_ENABLE BIT(2)
- +#define DEVCFG_TOUCH_POWER_STATE(x) (((x) & 7) << 3)
- +#define DEVCFG_TOUCH_UNKNOWN_6 BIT(6)
- +
- +#define DEVCFG_DEVICE_ID_TIC 0x43495424 // "$TIC"
- +
- +#define DEVCFG_SPI_CLKDIV(x) (((x) >> 1) & 7)
- +#define DEVCFG_SPI_CLKDIV_8 BIT(4)
- +#define DEVCFG_SPI_SUPPORTS_SINGLE BIT(5)
- +#define DEVCFG_SPI_SUPPORTS_DUAL BIT(6)
- +#define DEVCFG_SPI_SUPPORTS_QUAD BIT(7)
- +#define DEVCFG_SPI_MAX_TOUCH_POINTS(x) (((x) >> 8) & 0x3f)
- +#define DEVCFG_SPI_MIN_RESET_TIME(x) (((x) >> 16) & 0xf)
- +#define DEVCFG_SPI_NEEDS_HEARTBEAT BIT(20) // TODO implement heartbeat
- +#define DEVCFG_SPI_HEARTBEAT_INTERVAL(x) (((x) >> 21) & 7)
- +#define DEVCFG_SPI_UNKNOWN_25 BIT(25)
- +#define DEVCFG_SPI_UNKNOWN_26 BIT(26)
- +#define DEVCFG_SPI_UNKNOWN_27 BIT(27)
- +#define DEVCFG_SPI_DELAY(x) (((x) >> 28) & 7) // TODO use this
- +#define DEVCFG_SPI_USE_EXT_READ_CFG BIT(31) // TODO use this?
- +
- +struct ithc_device_config { // (Example values are from an SP7+.)
- + u32 irq_cause; // 00 = 0xe0000402 (0xe0000401 after DMA_RX_CODE_RESET)
- + u32 error; // 04 = 0x00000000
- + u32 dma_buf_sizes; // 08 = 0x000a00ff
- + u32 touch_cfg; // 0c = 0x0000001c
- + u32 touch_state; // 10 = 0x0000001c
- + u32 device_id; // 14 = 0x43495424 = "$TIC"
- + u32 spi_config; // 18 = 0xfda00a2e
- + u16 vendor_id; // 1c = 0x045e = Microsoft Corp.
- + u16 product_id; // 1e = 0x0c1a
- + u32 revision; // 20 = 0x00000001
- + u32 fw_version; // 24 = 0x05008a8b = 5.0.138.139 (this value looks more random on newer devices)
- + u32 command; // 28 = 0x00000000
- + u32 fw_mode; // 2c = 0x00000000 (for fw update?)
- + u32 _unknown_30; // 30 = 0x00000000
- + u8 eds_minor_ver; // 34 = 0x5e
- + u8 eds_major_ver; // 35 = 0x03
- + u8 interface_rev; // 36 = 0x04
- + u8 eu_kernel_ver; // 37 = 0x04
- + u32 _unknown_38; // 38 = 0x000001c0 (0x000001c1 after DMA_RX_CODE_RESET)
- + u32 _unknown_3c; // 3c = 0x00000002
- +};
- +static_assert(sizeof(struct ithc_device_config) == 64);
- +
- +#define RX_CODE_INPUT_REPORT 3
- +#define RX_CODE_FEATURE_REPORT 4
- +#define RX_CODE_REPORT_DESCRIPTOR 5
- +#define RX_CODE_RESET 7
- +
- +#define TX_CODE_SET_FEATURE 3
- +#define TX_CODE_GET_FEATURE 4
- +#define TX_CODE_OUTPUT_REPORT 5
- +#define TX_CODE_GET_REPORT_DESCRIPTOR 7
- +
- +static int ithc_set_device_enabled(struct ithc *ithc, bool enable)
- +{
- + u32 x = ithc->legacy_touch_cfg =
- + (ithc->legacy_touch_cfg & ~(u32)DEVCFG_TOUCH_MASK) |
- + DEVCFG_TOUCH_HID_REPORT_ENABLE |
- + (enable ? DEVCFG_TOUCH_ENABLE | DEVCFG_TOUCH_POWER_STATE(3) : 0);
- + return ithc_spi_command(ithc, SPI_CMD_CODE_WRITE,
- + offsetof(struct ithc_device_config, touch_cfg), sizeof(x), &x);
- +}
- +
- +int ithc_legacy_init(struct ithc *ithc)
- +{
- + // Since we don't yet know which SPI config the device wants, use default speed and mode
- + // initially for reading config data.
- + CHECK(ithc_set_spi_config, ithc, 2, true, SPI_MODE_SINGLE, SPI_MODE_SINGLE);
- +
- + // Setting the following bit seems to make reading the config more reliable.
- + bitsl_set(&ithc->regs->dma_rx[0].init_unknown, INIT_UNKNOWN_31);
- +
- + // Setting this bit may be necessary on some ADL devices.
- + switch (ithc->pci->device) {
- + case PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2:
- + bitsl_set(&ithc->regs->dma_rx[0].init_unknown, INIT_UNKNOWN_5);
- + break;
- + }
- +
- + // Take the touch device out of reset.
- + bitsl(&ithc->regs->control_bits, CONTROL_QUIESCE, 0);
- + CHECK_RET(waitl, ithc, &ithc->regs->control_bits, CONTROL_IS_QUIESCED, 0);
- + for (int retries = 0; ; retries++) {
- + ithc_log_regs(ithc);
- + bitsl_set(&ithc->regs->control_bits, CONTROL_NRESET);
- + if (!waitl(ithc, &ithc->regs->irq_cause, 0xf, 2))
- + break;
- + if (retries > 5) {
- + pci_err(ithc->pci, "failed to reset device, irq_cause = 0x%08x\n",
- + readl(&ithc->regs->irq_cause));
- + return -ETIMEDOUT;
- + }
- + pci_warn(ithc->pci, "invalid irq_cause, retrying reset\n");
- + bitsl(&ithc->regs->control_bits, CONTROL_NRESET, 0);
- + if (msleep_interruptible(1000))
- + return -EINTR;
- + }
- + ithc_log_regs(ithc);
- +
- + CHECK(waitl, ithc, &ithc->regs->dma_rx[0].status, DMA_RX_STATUS_READY, DMA_RX_STATUS_READY);
- +
- + // Read configuration data.
- + u32 spi_cfg;
- + for (int retries = 0; ; retries++) {
- + ithc_log_regs(ithc);
- + struct ithc_device_config config = { 0 };
- + CHECK_RET(ithc_spi_command, ithc, SPI_CMD_CODE_READ, 0, sizeof(config), &config);
- + u32 *p = (void *)&config;
- + pci_info(ithc->pci, "config: %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x\n",
- + p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
- + if (config.device_id == DEVCFG_DEVICE_ID_TIC) {
- + spi_cfg = config.spi_config;
- + ithc->vendor_id = config.vendor_id;
- + ithc->product_id = config.product_id;
- + ithc->product_rev = config.revision;
- + ithc->max_rx_size = DEVCFG_DMA_RX_SIZE(config.dma_buf_sizes);
- + ithc->max_tx_size = DEVCFG_DMA_TX_SIZE(config.dma_buf_sizes);
- + ithc->legacy_touch_cfg = config.touch_cfg;
- + ithc->have_config = true;
- + break;
- + }
- + if (retries > 10) {
- + pci_err(ithc->pci, "failed to read config, unknown device ID 0x%08x\n",
- + config.device_id);
- + return -EIO;
- + }
- + pci_warn(ithc->pci, "failed to read config, retrying\n");
- + if (msleep_interruptible(100))
- + return -EINTR;
- + }
- + ithc_log_regs(ithc);
- +
- + // Apply SPI config and enable touch device.
- + CHECK_RET(ithc_set_spi_config, ithc,
- + DEVCFG_SPI_CLKDIV(spi_cfg), (spi_cfg & DEVCFG_SPI_CLKDIV_8) != 0,
- + spi_cfg & DEVCFG_SPI_SUPPORTS_QUAD ? SPI_MODE_QUAD :
- + spi_cfg & DEVCFG_SPI_SUPPORTS_DUAL ? SPI_MODE_DUAL :
- + SPI_MODE_SINGLE,
- + SPI_MODE_SINGLE);
- + CHECK_RET(ithc_set_device_enabled, ithc, true);
- + ithc_log_regs(ithc);
- + return 0;
- +}
- +
- +void ithc_legacy_exit(struct ithc *ithc)
- +{
- + CHECK(ithc_set_device_enabled, ithc, false);
- +}
- +
- +int ithc_legacy_decode_rx(struct ithc *ithc, const void *src, size_t len, struct ithc_data *dest)
- +{
- + const struct {
- + u32 code;
- + u32 data_size;
- + u32 _unknown[14];
- + } *hdr = src;
- +
- + if (len < sizeof(*hdr))
- + return -ENODATA;
- + // Note: RX data is not padded, even though TX data must be padded.
- + if (len != sizeof(*hdr) + hdr->data_size)
- + return -EMSGSIZE;
- +
- + dest->data = hdr + 1;
- + dest->size = hdr->data_size;
- +
- + switch (hdr->code) {
- + case RX_CODE_RESET:
- + // The THC sends a reset request when we need to reinitialize the device.
- + // This usually only happens if we send an invalid command or put the device
- + // in a bad state.
- + dest->type = ITHC_DATA_ERROR;
- + return 0;
- + case RX_CODE_REPORT_DESCRIPTOR:
- + // The descriptor is preceded by 8 nul bytes.
- + if (hdr->data_size < 8)
- + return -ENODATA;
- + dest->type = ITHC_DATA_REPORT_DESCRIPTOR;
- + dest->data = (char *)(hdr + 1) + 8;
- + dest->size = hdr->data_size - 8;
- + return 0;
- + case RX_CODE_INPUT_REPORT:
- + dest->type = ITHC_DATA_INPUT_REPORT;
- + return 0;
- + case RX_CODE_FEATURE_REPORT:
- + dest->type = ITHC_DATA_GET_FEATURE;
- + return 0;
- + default:
- + return -EINVAL;
- + }
- +}
- +
- +ssize_t ithc_legacy_encode_tx(struct ithc *ithc, const struct ithc_data *src, void *dest,
- + size_t maxlen)
- +{
- + struct {
- + u32 code;
- + u32 data_size;
- + } *hdr = dest;
- +
- + size_t src_size = src->size;
- + const void *src_data = src->data;
- + const u64 get_report_desc_data = 0;
- + u32 code;
- +
- + switch (src->type) {
- + case ITHC_DATA_SET_FEATURE:
- + code = TX_CODE_SET_FEATURE;
- + break;
- + case ITHC_DATA_GET_FEATURE:
- + code = TX_CODE_GET_FEATURE;
- + break;
- + case ITHC_DATA_OUTPUT_REPORT:
- + code = TX_CODE_OUTPUT_REPORT;
- + break;
- + case ITHC_DATA_REPORT_DESCRIPTOR:
- + code = TX_CODE_GET_REPORT_DESCRIPTOR;
- + src_size = sizeof(get_report_desc_data);
- + src_data = &get_report_desc_data;
- + break;
- + default:
- + return -EINVAL;
- + }
- +
- + // Data must be padded to next 4-byte boundary.
- + size_t padded = round_up(src_size, 4);
- + if (sizeof(*hdr) + padded > maxlen)
- + return -EOVERFLOW;
- +
- + // Fill the TX buffer with header and data.
- + hdr->code = code;
- + hdr->data_size = src_size;
- + memcpy_and_pad(hdr + 1, padded, src_data, src_size, 0);
- +
- + return sizeof(*hdr) + padded;
- +}
- +
- diff --git a/drivers/hid/ithc/ithc-legacy.h b/drivers/hid/ithc/ithc-legacy.h
- new file mode 100644
- index 000000000000..28d692462072
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-legacy.h
- @@ -0,0 +1,8 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +int ithc_legacy_init(struct ithc *ithc);
- +void ithc_legacy_exit(struct ithc *ithc);
- +int ithc_legacy_decode_rx(struct ithc *ithc, const void *src, size_t len, struct ithc_data *dest);
- +ssize_t ithc_legacy_encode_tx(struct ithc *ithc, const struct ithc_data *src, void *dest,
- + size_t maxlen);
- +
- diff --git a/drivers/hid/ithc/ithc-main.c b/drivers/hid/ithc/ithc-main.c
- index 87ed4aa70fda..2acf02e41d40 100644
- --- a/drivers/hid/ithc/ithc-main.c
- +++ b/drivers/hid/ithc/ithc-main.c
- @@ -5,28 +5,6 @@
- MODULE_DESCRIPTION("Intel Touch Host Controller driver");
- MODULE_LICENSE("Dual BSD/GPL");
-
- -// Lakefield
- -#define PCI_DEVICE_ID_INTEL_THC_LKF_PORT1 0x98d0
- -#define PCI_DEVICE_ID_INTEL_THC_LKF_PORT2 0x98d1
- -// Tiger Lake
- -#define PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT1 0xa0d0
- -#define PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT2 0xa0d1
- -#define PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT1 0x43d0
- -#define PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT2 0x43d1
- -// Alder Lake
- -#define PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1 0x7ad8
- -#define PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2 0x7ad9
- -#define PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1 0x51d0
- -#define PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2 0x51d1
- -#define PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1 0x54d0
- -#define PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2 0x54d1
- -// Raptor Lake
- -#define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT1 0x7a58
- -#define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT2 0x7a59
- -// Meteor Lake
- -#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT1 0x7e48
- -#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT2 0x7e4a
- -
- static const struct pci_device_id ithc_pci_tbl[] = {
- { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_LKF_PORT1) },
- { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_LKF_PORT2) },
- @@ -66,15 +44,13 @@ static bool ithc_use_rx1 = true;
- module_param_named(rx1, ithc_use_rx1, bool, 0);
- MODULE_PARM_DESC(rx1, "Use DMA RX channel 1");
-
- -// Values below 250 seem to work well on the SP7+. If this is set too high, you may observe cursor stuttering.
- -static int ithc_dma_latency_us = 200;
- -module_param_named(dma_latency_us, ithc_dma_latency_us, int, 0);
- -MODULE_PARM_DESC(dma_latency_us, "Determines the CPU latency QoS value for DMA transfers (in microseconds), -1 to disable latency QoS");
- +static int ithc_active_ltr_us = -1;
- +module_param_named(activeltr, ithc_active_ltr_us, int, 0);
- +MODULE_PARM_DESC(activeltr, "Active LTR value override (in microseconds)");
-
- -// Values above 1700 seem to work well on the SP7+. If this is set too low, you may observe cursor stuttering.
- -static unsigned int ithc_dma_early_us = 2000;
- -module_param_named(dma_early_us, ithc_dma_early_us, uint, 0);
- -MODULE_PARM_DESC(dma_early_us, "Determines how early the CPU latency QoS value is applied before the next expected IRQ (in microseconds)");
- +static int ithc_idle_ltr_us = -1;
- +module_param_named(idleltr, ithc_idle_ltr_us, int, 0);
- +MODULE_PARM_DESC(idleltr, "Idle LTR value override (in microseconds)");
-
- static bool ithc_log_regs_enabled = false;
- module_param_named(logregs, ithc_log_regs_enabled, bool, 0);
- @@ -82,44 +58,30 @@ MODULE_PARM_DESC(logregs, "Log changes in register values (for debugging)");
-
- // Sysfs attributes
-
- -static bool ithc_is_config_valid(struct ithc *ithc)
- -{
- - return ithc->config.device_id == DEVCFG_DEVICE_ID_TIC;
- -}
- -
- static ssize_t vendor_show(struct device *dev, struct device_attribute *attr, char *buf)
- {
- struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc_is_config_valid(ithc))
- + if (!ithc || !ithc->have_config)
- return -ENODEV;
- - return sprintf(buf, "0x%04x", ithc->config.vendor_id);
- + return sprintf(buf, "0x%04x", ithc->vendor_id);
- }
- static DEVICE_ATTR_RO(vendor);
- static ssize_t product_show(struct device *dev, struct device_attribute *attr, char *buf)
- {
- struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc_is_config_valid(ithc))
- + if (!ithc || !ithc->have_config)
- return -ENODEV;
- - return sprintf(buf, "0x%04x", ithc->config.product_id);
- + return sprintf(buf, "0x%04x", ithc->product_id);
- }
- static DEVICE_ATTR_RO(product);
- static ssize_t revision_show(struct device *dev, struct device_attribute *attr, char *buf)
- {
- struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc_is_config_valid(ithc))
- + if (!ithc || !ithc->have_config)
- return -ENODEV;
- - return sprintf(buf, "%u", ithc->config.revision);
- + return sprintf(buf, "%u", ithc->product_rev);
- }
- static DEVICE_ATTR_RO(revision);
- -static ssize_t fw_version_show(struct device *dev, struct device_attribute *attr, char *buf)
- -{
- - struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc_is_config_valid(ithc))
- - return -ENODEV;
- - u32 v = ithc->config.fw_version;
- - return sprintf(buf, "%i.%i.%i.%i", v >> 24, v >> 16 & 0xff, v >> 8 & 0xff, v & 0xff);
- -}
- -static DEVICE_ATTR_RO(fw_version);
-
- static const struct attribute_group *ithc_attribute_groups[] = {
- &(const struct attribute_group){
- @@ -128,185 +90,26 @@ static const struct attribute_group *ithc_attribute_groups[] = {
- &dev_attr_vendor.attr,
- &dev_attr_product.attr,
- &dev_attr_revision.attr,
- - &dev_attr_fw_version.attr,
- NULL
- },
- },
- NULL
- };
-
- -// HID setup
- -
- -static int ithc_hid_start(struct hid_device *hdev) { return 0; }
- -static void ithc_hid_stop(struct hid_device *hdev) { }
- -static int ithc_hid_open(struct hid_device *hdev) { return 0; }
- -static void ithc_hid_close(struct hid_device *hdev) { }
- -
- -static int ithc_hid_parse(struct hid_device *hdev)
- -{
- - struct ithc *ithc = hdev->driver_data;
- - u64 val = 0;
- - WRITE_ONCE(ithc->hid_parse_done, false);
- - for (int retries = 0; ; retries++) {
- - CHECK_RET(ithc_dma_tx, ithc, DMA_TX_CODE_GET_REPORT_DESCRIPTOR, sizeof(val), &val);
- - if (wait_event_timeout(ithc->wait_hid_parse, READ_ONCE(ithc->hid_parse_done),
- - msecs_to_jiffies(200)))
- - return 0;
- - if (retries > 5) {
- - pci_err(ithc->pci, "failed to read report descriptor\n");
- - return -ETIMEDOUT;
- - }
- - pci_warn(ithc->pci, "failed to read report descriptor, retrying\n");
- - }
- -}
- -
- -static int ithc_hid_raw_request(struct hid_device *hdev, unsigned char reportnum, __u8 *buf,
- - size_t len, unsigned char rtype, int reqtype)
- -{
- - struct ithc *ithc = hdev->driver_data;
- - if (!buf || !len)
- - return -EINVAL;
- - u32 code;
- - if (rtype == HID_OUTPUT_REPORT && reqtype == HID_REQ_SET_REPORT) {
- - code = DMA_TX_CODE_OUTPUT_REPORT;
- - } else if (rtype == HID_FEATURE_REPORT && reqtype == HID_REQ_SET_REPORT) {
- - code = DMA_TX_CODE_SET_FEATURE;
- - } else if (rtype == HID_FEATURE_REPORT && reqtype == HID_REQ_GET_REPORT) {
- - code = DMA_TX_CODE_GET_FEATURE;
- - } else {
- - pci_err(ithc->pci, "unhandled hid request %i %i for report id %i\n",
- - rtype, reqtype, reportnum);
- - return -EINVAL;
- - }
- - buf[0] = reportnum;
- -
- - if (reqtype == HID_REQ_GET_REPORT) {
- - // Prepare for response.
- - mutex_lock(&ithc->hid_get_feature_mutex);
- - ithc->hid_get_feature_buf = buf;
- - ithc->hid_get_feature_size = len;
- - mutex_unlock(&ithc->hid_get_feature_mutex);
- -
- - // Transmit 'get feature' request.
- - int r = CHECK(ithc_dma_tx, ithc, code, 1, buf);
- - if (!r) {
- - r = wait_event_interruptible_timeout(ithc->wait_hid_get_feature,
- - !ithc->hid_get_feature_buf, msecs_to_jiffies(1000));
- - if (!r)
- - r = -ETIMEDOUT;
- - else if (r < 0)
- - r = -EINTR;
- - else
- - r = 0;
- - }
- -
- - // If everything went ok, the buffer has been filled with the response data.
- - // Return the response size.
- - mutex_lock(&ithc->hid_get_feature_mutex);
- - ithc->hid_get_feature_buf = NULL;
- - if (!r)
- - r = ithc->hid_get_feature_size;
- - mutex_unlock(&ithc->hid_get_feature_mutex);
- - return r;
- - }
- -
- - // 'Set feature', or 'output report'. These don't have a response.
- - CHECK_RET(ithc_dma_tx, ithc, code, len, buf);
- - return 0;
- -}
- -
- -static struct hid_ll_driver ithc_ll_driver = {
- - .start = ithc_hid_start,
- - .stop = ithc_hid_stop,
- - .open = ithc_hid_open,
- - .close = ithc_hid_close,
- - .parse = ithc_hid_parse,
- - .raw_request = ithc_hid_raw_request,
- -};
- -
- -static void ithc_hid_devres_release(struct device *dev, void *res)
- -{
- - struct hid_device **hidm = res;
- - if (*hidm)
- - hid_destroy_device(*hidm);
- -}
- -
- -static int ithc_hid_init(struct ithc *ithc)
- -{
- - struct hid_device **hidm = devres_alloc(ithc_hid_devres_release, sizeof(*hidm), GFP_KERNEL);
- - if (!hidm)
- - return -ENOMEM;
- - devres_add(&ithc->pci->dev, hidm);
- - struct hid_device *hid = hid_allocate_device();
- - if (IS_ERR(hid))
- - return PTR_ERR(hid);
- - *hidm = hid;
- -
- - strscpy(hid->name, DEVFULLNAME, sizeof(hid->name));
- - strscpy(hid->phys, ithc->phys, sizeof(hid->phys));
- - hid->ll_driver = &ithc_ll_driver;
- - hid->bus = BUS_PCI;
- - hid->vendor = ithc->config.vendor_id;
- - hid->product = ithc->config.product_id;
- - hid->version = 0x100;
- - hid->dev.parent = &ithc->pci->dev;
- - hid->driver_data = ithc;
- -
- - ithc->hid = hid;
- - return 0;
- -}
- -
- // Interrupts/polling
-
- -static enum hrtimer_restart ithc_activity_start_timer_callback(struct hrtimer *t)
- -{
- - struct ithc *ithc = container_of(t, struct ithc, activity_start_timer);
- - ithc_set_active(ithc, ithc_dma_early_us * 2 + USEC_PER_MSEC);
- - return HRTIMER_NORESTART;
- -}
- -
- -static enum hrtimer_restart ithc_activity_end_timer_callback(struct hrtimer *t)
- -{
- - struct ithc *ithc = container_of(t, struct ithc, activity_end_timer);
- - cpu_latency_qos_update_request(&ithc->activity_qos, PM_QOS_DEFAULT_VALUE);
- - return HRTIMER_NORESTART;
- -}
- -
- -void ithc_set_active(struct ithc *ithc, unsigned int duration_us)
- -{
- - if (ithc_dma_latency_us < 0)
- - return;
- - // When CPU usage is very low, the CPU can enter various low power states (C2-C10).
- - // This disrupts DMA, causing truncated DMA messages. ERROR_FLAG_DMA_RX_TIMEOUT will be
- - // set when this happens. The amount of truncated messages can become very high, resulting
- - // in user-visible effects (laggy/stuttering cursor). To avoid this, we use a CPU latency
- - // QoS request to prevent the CPU from entering low power states during touch interactions.
- - cpu_latency_qos_update_request(&ithc->activity_qos, ithc_dma_latency_us);
- - hrtimer_start_range_ns(&ithc->activity_end_timer,
- - ns_to_ktime(duration_us * NSEC_PER_USEC), duration_us * NSEC_PER_USEC, HRTIMER_MODE_REL);
- -}
- -
- -static int ithc_set_device_enabled(struct ithc *ithc, bool enable)
- -{
- - u32 x = ithc->config.touch_cfg =
- - (ithc->config.touch_cfg & ~(u32)DEVCFG_TOUCH_MASK) | DEVCFG_TOUCH_UNKNOWN_2 |
- - (enable ? DEVCFG_TOUCH_ENABLE | DEVCFG_TOUCH_UNKNOWN_3 | DEVCFG_TOUCH_UNKNOWN_4 : 0);
- - return ithc_spi_command(ithc, SPI_CMD_CODE_WRITE,
- - offsetof(struct ithc_device_config, touch_cfg), sizeof(x), &x);
- -}
- -
- static void ithc_disable_interrupts(struct ithc *ithc)
- {
- writel(0, &ithc->regs->error_control);
- bitsb(&ithc->regs->spi_cmd.control, SPI_CMD_CONTROL_IRQ, 0);
- - bitsb(&ithc->regs->dma_rx[0].control, DMA_RX_CONTROL_IRQ_UNKNOWN_1 | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_UNKNOWN_4 | DMA_RX_CONTROL_IRQ_DATA, 0);
- - bitsb(&ithc->regs->dma_rx[1].control, DMA_RX_CONTROL_IRQ_UNKNOWN_1 | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_UNKNOWN_4 | DMA_RX_CONTROL_IRQ_DATA, 0);
- + bitsb(&ithc->regs->dma_rx[0].control, DMA_RX_CONTROL_IRQ_UNKNOWN_1 | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_READY | DMA_RX_CONTROL_IRQ_DATA, 0);
- + bitsb(&ithc->regs->dma_rx[1].control, DMA_RX_CONTROL_IRQ_UNKNOWN_1 | DMA_RX_CONTROL_IRQ_ERROR | DMA_RX_CONTROL_IRQ_READY | DMA_RX_CONTROL_IRQ_DATA, 0);
- bitsb(&ithc->regs->dma_tx.control, DMA_TX_CONTROL_IRQ, 0);
- }
-
- static void ithc_clear_dma_rx_interrupts(struct ithc *ithc, unsigned int channel)
- {
- - writel(DMA_RX_STATUS_ERROR | DMA_RX_STATUS_UNKNOWN_4 | DMA_RX_STATUS_HAVE_DATA,
- + writel(DMA_RX_STATUS_ERROR | DMA_RX_STATUS_READY | DMA_RX_STATUS_HAVE_DATA,
- &ithc->regs->dma_rx[channel].status);
- }
-
- @@ -325,39 +128,22 @@ static void ithc_process(struct ithc *ithc)
- {
- ithc_log_regs(ithc);
-
- + // The THC automatically transitions from LTR idle to active at the start of a DMA transfer.
- + // It does not appear to automatically go back to idle, so we switch it back here, since
- + // the DMA transfer should be complete.
- + ithc_set_ltr_idle(ithc);
- +
- bool rx0 = ithc_use_rx0 && (readl(&ithc->regs->dma_rx[0].status) & (DMA_RX_STATUS_ERROR | DMA_RX_STATUS_HAVE_DATA)) != 0;
- bool rx1 = ithc_use_rx1 && (readl(&ithc->regs->dma_rx[1].status) & (DMA_RX_STATUS_ERROR | DMA_RX_STATUS_HAVE_DATA)) != 0;
-
- - // Track time between DMA rx transfers, so we can try to predict when we need to enable CPU latency QoS for the next transfer
- - ktime_t t = ktime_get();
- - ktime_t dt = ktime_sub(t, ithc->last_rx_time);
- - if (rx0 || rx1) {
- - ithc->last_rx_time = t;
- - if (dt > ms_to_ktime(100)) {
- - ithc->cur_rx_seq_count = 0;
- - ithc->cur_rx_seq_errors = 0;
- - }
- - ithc->cur_rx_seq_count++;
- - if (!ithc_use_polling && ithc_dma_latency_us >= 0) {
- - // Disable QoS, since the DMA transfer has completed (we re-enable it after a delay below)
- - cpu_latency_qos_update_request(&ithc->activity_qos, PM_QOS_DEFAULT_VALUE);
- - hrtimer_try_to_cancel(&ithc->activity_end_timer);
- - }
- - }
- -
- // Read and clear error bits
- u32 err = readl(&ithc->regs->error_flags);
- if (err) {
- writel(err, &ithc->regs->error_flags);
- if (err & ~ERROR_FLAG_DMA_RX_TIMEOUT)
- pci_err(ithc->pci, "error flags: 0x%08x\n", err);
- - if (err & ERROR_FLAG_DMA_RX_TIMEOUT) {
- - // Only log an error if we see a significant number of these errors.
- - ithc->cur_rx_seq_errors++;
- - if (ithc->cur_rx_seq_errors && ithc->cur_rx_seq_errors % 50 == 0 && ithc->cur_rx_seq_errors > ithc->cur_rx_seq_count / 10)
- - pci_err(ithc->pci, "High number of DMA RX timeouts/errors (%u/%u, dt=%lldus). Try adjusting dma_early_us and/or dma_latency_us.\n",
- - ithc->cur_rx_seq_errors, ithc->cur_rx_seq_count, ktime_to_us(dt));
- - }
- + if (err & ERROR_FLAG_DMA_RX_TIMEOUT)
- + pci_err(ithc->pci, "DMA RX timeout/error (try decreasing activeltr/idleltr if this happens frequently)\n");
- }
-
- // Process DMA rx
- @@ -372,12 +158,6 @@ static void ithc_process(struct ithc *ithc)
- ithc_dma_rx(ithc, 1);
- }
-
- - // Start timer to re-enable QoS for next rx, but only if we've seen an ERROR_FLAG_DMA_RX_TIMEOUT
- - if ((rx0 || rx1) && !ithc_use_polling && ithc_dma_latency_us >= 0 && ithc->cur_rx_seq_errors > 0) {
- - ktime_t expires = ktime_add(t, ktime_sub_us(dt, ithc_dma_early_us));
- - hrtimer_start_range_ns(&ithc->activity_start_timer, expires, 10 * NSEC_PER_USEC, HRTIMER_MODE_ABS);
- - }
- -
- ithc_log_regs(ithc);
- }
-
- @@ -403,12 +183,8 @@ static int ithc_poll_thread(void *arg)
- ithc_process(ithc);
- // Decrease polling interval to 20ms if we received data, otherwise slowly
- // increase it up to 200ms.
- - if (n != ithc->dma_rx[1].num_received) {
- - ithc_set_active(ithc, 100 * USEC_PER_MSEC);
- - sleep = 20;
- - } else {
- - sleep = min(200u, sleep + (sleep >> 4) + 1);
- - }
- + sleep = n != ithc->dma_rx[1].num_received ? 20
- + : min(200u, sleep + (sleep >> 4) + 1);
- msleep_interruptible(sleep);
- }
- return 0;
- @@ -431,73 +207,44 @@ static void ithc_disable(struct ithc *ithc)
-
- static int ithc_init_device(struct ithc *ithc)
- {
- + // Read ACPI config for QuickSPI mode
- + struct ithc_acpi_config cfg = { 0 };
- + CHECK_RET(ithc_read_acpi_config, ithc, &cfg);
- + if (!cfg.has_config)
- + pci_info(ithc->pci, "no ACPI config, using legacy mode\n");
- + else
- + ithc_print_acpi_config(ithc, &cfg);
- + ithc->use_quickspi = cfg.has_config;
- +
- + // Shut down device
- ithc_log_regs(ithc);
- bool was_enabled = (readl(&ithc->regs->control_bits) & CONTROL_NRESET) != 0;
- ithc_disable(ithc);
- CHECK_RET(waitl, ithc, &ithc->regs->control_bits, CONTROL_READY, CONTROL_READY);
- -
- - // Since we don't yet know which SPI config the device wants, use default speed and mode
- - // initially for reading config data.
- - ithc_set_spi_config(ithc, 10, 0);
- -
- - // Setting the following bit seems to make reading the config more reliable.
- - bitsl_set(&ithc->regs->dma_rx[0].unknown_init_bits, 0x80000000);
- + ithc_log_regs(ithc);
-
- // If the device was previously enabled, wait a bit to make sure it's fully shut down.
- if (was_enabled)
- if (msleep_interruptible(100))
- return -EINTR;
-
- - // Take the touch device out of reset.
- - bitsl(&ithc->regs->control_bits, CONTROL_QUIESCE, 0);
- - CHECK_RET(waitl, ithc, &ithc->regs->control_bits, CONTROL_IS_QUIESCED, 0);
- - for (int retries = 0; ; retries++) {
- - ithc_log_regs(ithc);
- - bitsl_set(&ithc->regs->control_bits, CONTROL_NRESET);
- - if (!waitl(ithc, &ithc->regs->state, 0xf, 2))
- - break;
- - if (retries > 5) {
- - pci_err(ithc->pci, "failed to reset device, state = 0x%08x\n", readl(&ithc->regs->state));
- - return -ETIMEDOUT;
- - }
- - pci_warn(ithc->pci, "invalid state, retrying reset\n");
- - bitsl(&ithc->regs->control_bits, CONTROL_NRESET, 0);
- - if (msleep_interruptible(1000))
- - return -EINTR;
- - }
- - ithc_log_regs(ithc);
- + // Set Latency Tolerance Reporting config. The device will automatically
- + // apply these values depending on whether it is active or idle.
- + // If active value is too high, DMA buffer data can become truncated.
- + // By default, we set the active LTR value to 100us, and idle to 100ms.
- + u64 active_ltr_ns = ithc_active_ltr_us >= 0 ? (u64)ithc_active_ltr_us * 1000
- + : cfg.has_config && cfg.has_active_ltr ? (u64)cfg.active_ltr << 10
- + : 100 * 1000;
- + u64 idle_ltr_ns = ithc_idle_ltr_us >= 0 ? (u64)ithc_idle_ltr_us * 1000
- + : cfg.has_config && cfg.has_idle_ltr ? (u64)cfg.idle_ltr << 10
- + : 100 * 1000 * 1000;
- + ithc_set_ltr_config(ithc, active_ltr_ns, idle_ltr_ns);
- +
- + if (ithc->use_quickspi)
- + CHECK_RET(ithc_quickspi_init, ithc, &cfg);
- + else
- + CHECK_RET(ithc_legacy_init, ithc);
-
- - // Waiting for the following status bit makes reading config much more reliable,
- - // however the official driver does not seem to do this...
- - CHECK(waitl, ithc, &ithc->regs->dma_rx[0].status, DMA_RX_STATUS_UNKNOWN_4, DMA_RX_STATUS_UNKNOWN_4);
- -
- - // Read configuration data.
- - for (int retries = 0; ; retries++) {
- - ithc_log_regs(ithc);
- - memset(&ithc->config, 0, sizeof(ithc->config));
- - CHECK_RET(ithc_spi_command, ithc, SPI_CMD_CODE_READ, 0, sizeof(ithc->config), &ithc->config);
- - u32 *p = (void *)&ithc->config;
- - pci_info(ithc->pci, "config: %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x %08x\n",
- - p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
- - if (ithc_is_config_valid(ithc))
- - break;
- - if (retries > 10) {
- - pci_err(ithc->pci, "failed to read config, unknown device ID 0x%08x\n",
- - ithc->config.device_id);
- - return -EIO;
- - }
- - pci_warn(ithc->pci, "failed to read config, retrying\n");
- - if (msleep_interruptible(100))
- - return -EINTR;
- - }
- - ithc_log_regs(ithc);
- -
- - // Apply SPI config and enable touch device.
- - CHECK_RET(ithc_set_spi_config, ithc,
- - DEVCFG_SPI_MAX_FREQ(ithc->config.spi_config),
- - DEVCFG_SPI_MODE(ithc->config.spi_config));
- - CHECK_RET(ithc_set_device_enabled, ithc, true);
- - ithc_log_regs(ithc);
- return 0;
- }
-
- @@ -527,11 +274,11 @@ static void ithc_stop(void *res)
- CHECK(kthread_stop, ithc->poll_thread);
- if (ithc->irq >= 0)
- disable_irq(ithc->irq);
- - CHECK(ithc_set_device_enabled, ithc, false);
- + if (ithc->use_quickspi)
- + ithc_quickspi_exit(ithc);
- + else
- + ithc_legacy_exit(ithc);
- ithc_disable(ithc);
- - hrtimer_cancel(&ithc->activity_start_timer);
- - hrtimer_cancel(&ithc->activity_end_timer);
- - cpu_latency_qos_remove_request(&ithc->activity_qos);
-
- // Clear DMA config.
- for (unsigned int i = 0; i < 2; i++) {
- @@ -570,9 +317,6 @@ static int ithc_start(struct pci_dev *pci)
- ithc->irq = -1;
- ithc->pci = pci;
- snprintf(ithc->phys, sizeof(ithc->phys), "pci-%s/" DEVNAME, pci_name(pci));
- - init_waitqueue_head(&ithc->wait_hid_parse);
- - init_waitqueue_head(&ithc->wait_hid_get_feature);
- - mutex_init(&ithc->hid_get_feature_mutex);
- pci_set_drvdata(pci, ithc);
- CHECK_RET(devm_add_action_or_reset, &pci->dev, ithc_clear_drvdata, pci);
- if (ithc_log_regs_enabled)
- @@ -596,6 +340,9 @@ static int ithc_start(struct pci_dev *pci)
-
- // Initialize THC and touch device.
- CHECK_RET(ithc_init_device, ithc);
- +
- + // Initialize HID and DMA.
- + CHECK_RET(ithc_hid_init, ithc);
- CHECK(devm_device_add_groups, &pci->dev, ithc_attribute_groups);
- if (ithc_use_rx0)
- CHECK_RET(ithc_dma_rx_init, ithc, 0);
- @@ -603,18 +350,10 @@ static int ithc_start(struct pci_dev *pci)
- CHECK_RET(ithc_dma_rx_init, ithc, 1);
- CHECK_RET(ithc_dma_tx_init, ithc);
-
- - cpu_latency_qos_add_request(&ithc->activity_qos, PM_QOS_DEFAULT_VALUE);
- - hrtimer_init(&ithc->activity_start_timer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
- - ithc->activity_start_timer.function = ithc_activity_start_timer_callback;
- - hrtimer_init(&ithc->activity_end_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
- - ithc->activity_end_timer.function = ithc_activity_end_timer_callback;
- -
- // Add ithc_stop() callback AFTER setting up DMA buffers, so that polling/irqs/DMA are
- // disabled BEFORE the buffers are freed.
- CHECK_RET(devm_add_action_or_reset, &pci->dev, ithc_stop, ithc);
-
- - CHECK_RET(ithc_hid_init, ithc);
- -
- // Start polling/IRQ.
- if (ithc_use_polling) {
- pci_info(pci, "using polling instead of irq\n");
- @@ -637,9 +376,11 @@ static int ithc_start(struct pci_dev *pci)
-
- // hid_add_device() can only be called after irq/polling is started and DMA is enabled,
- // because it calls ithc_hid_parse() which reads the report descriptor via DMA.
- - CHECK_RET(hid_add_device, ithc->hid);
- + CHECK_RET(hid_add_device, ithc->hid.dev);
- +
- + CHECK(ithc_debug_init_device, ithc);
-
- - CHECK(ithc_debug_init, ithc);
- + ithc_set_ltr_idle(ithc);
-
- pci_dbg(pci, "started\n");
- return 0;
- @@ -710,17 +451,20 @@ static struct pci_driver ithc_driver = {
- .thaw = ithc_thaw,
- .restore = ithc_restore,
- },
- + .driver.probe_type = PROBE_PREFER_ASYNCHRONOUS,
- //.dev_groups = ithc_attribute_groups, // could use this (since 5.14), however the attributes won't have valid values until config has been read anyway
- };
-
- static int __init ithc_init(void)
- {
- + ithc_debug_init_module();
- return pci_register_driver(&ithc_driver);
- }
-
- static void __exit ithc_exit(void)
- {
- pci_unregister_driver(&ithc_driver);
- + ithc_debug_exit_module();
- }
-
- module_init(ithc_init);
- diff --git a/drivers/hid/ithc/ithc-quickspi.c b/drivers/hid/ithc/ithc-quickspi.c
- new file mode 100644
- index 000000000000..760e55ead078
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-quickspi.c
- @@ -0,0 +1,578 @@
- +// SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
- +
- +// Some public THC/QuickSPI documentation can be found in:
- +// - Intel Firmware Support Package repo: https://github.com/intel/FSP
- +// - HID over SPI (HIDSPI) spec: https://www.microsoft.com/en-us/download/details.aspx?id=103325
- +
- +#include "ithc.h"
- +
- +static const guid_t guid_hidspi =
- + GUID_INIT(0x6e2ac436, 0x0fcf, 0x41af, 0xa2, 0x65, 0xb3, 0x2a, 0x22, 0x0d, 0xcf, 0xab);
- +static const guid_t guid_thc_quickspi =
- + GUID_INIT(0x300d35b7, 0xac20, 0x413e, 0x8e, 0x9c, 0x92, 0xe4, 0xda, 0xfd, 0x0a, 0xfe);
- +static const guid_t guid_thc_ltr =
- + GUID_INIT(0x84005682, 0x5b71, 0x41a4, 0x8d, 0x66, 0x81, 0x30, 0xf7, 0x87, 0xa1, 0x38);
- +
- +// TODO The HIDSPI spec says revision should be 3. Should we try both?
- +#define DSM_REV 2
- +
- +struct hidspi_header {
- + u8 type;
- + u16 len;
- + u8 id;
- +} __packed;
- +static_assert(sizeof(struct hidspi_header) == 4);
- +
- +#define HIDSPI_INPUT_TYPE_DATA 1
- +#define HIDSPI_INPUT_TYPE_RESET_RESPONSE 3
- +#define HIDSPI_INPUT_TYPE_COMMAND_RESPONSE 4
- +#define HIDSPI_INPUT_TYPE_GET_FEATURE_RESPONSE 5
- +#define HIDSPI_INPUT_TYPE_DEVICE_DESCRIPTOR 7
- +#define HIDSPI_INPUT_TYPE_REPORT_DESCRIPTOR 8
- +#define HIDSPI_INPUT_TYPE_SET_FEATURE_RESPONSE 9
- +#define HIDSPI_INPUT_TYPE_OUTPUT_REPORT_RESPONSE 10
- +#define HIDSPI_INPUT_TYPE_GET_INPUT_REPORT_RESPONSE 11
- +
- +#define HIDSPI_OUTPUT_TYPE_DEVICE_DESCRIPTOR_REQUEST 1
- +#define HIDSPI_OUTPUT_TYPE_REPORT_DESCRIPTOR_REQUEST 2
- +#define HIDSPI_OUTPUT_TYPE_SET_FEATURE 3
- +#define HIDSPI_OUTPUT_TYPE_GET_FEATURE 4
- +#define HIDSPI_OUTPUT_TYPE_OUTPUT_REPORT 5
- +#define HIDSPI_OUTPUT_TYPE_INPUT_REPORT_REQUEST 6
- +#define HIDSPI_OUTPUT_TYPE_COMMAND 7
- +
- +struct hidspi_device_descriptor {
- + u16 wDeviceDescLength;
- + u16 bcdVersion;
- + u16 wReportDescLength;
- + u16 wMaxInputLength;
- + u16 wMaxOutputLength;
- + u16 wMaxFragmentLength;
- + u16 wVendorID;
- + u16 wProductID;
- + u16 wVersionID;
- + u16 wFlags;
- + u32 dwReserved;
- +};
- +static_assert(sizeof(struct hidspi_device_descriptor) == 24);
- +
- +static int read_acpi_u32(struct ithc *ithc, const guid_t *guid, u32 func, u32 *dest)
- +{
- + acpi_handle handle = ACPI_HANDLE(&ithc->pci->dev);
- + union acpi_object *o = acpi_evaluate_dsm(handle, guid, DSM_REV, func, NULL);
- + if (!o)
- + return 0;
- + if (o->type != ACPI_TYPE_INTEGER) {
- + pci_err(ithc->pci, "DSM %pUl %u returned type %i instead of integer\n",
- + guid, func, o->type);
- + ACPI_FREE(o);
- + return -1;
- + }
- + pci_dbg(ithc->pci, "DSM %pUl %u = 0x%08x\n", guid, func, (u32)o->integer.value);
- + *dest = (u32)o->integer.value;
- + ACPI_FREE(o);
- + return 1;
- +}
- +
- +static int read_acpi_buf(struct ithc *ithc, const guid_t *guid, u32 func, size_t len, u8 *dest)
- +{
- + acpi_handle handle = ACPI_HANDLE(&ithc->pci->dev);
- + union acpi_object *o = acpi_evaluate_dsm(handle, guid, DSM_REV, func, NULL);
- + if (!o)
- + return 0;
- + if (o->type != ACPI_TYPE_BUFFER) {
- + pci_err(ithc->pci, "DSM %pUl %u returned type %i instead of buffer\n",
- + guid, func, o->type);
- + ACPI_FREE(o);
- + return -1;
- + }
- + if (o->buffer.length != len) {
- + pci_err(ithc->pci, "DSM %pUl %u returned len %u instead of %zu\n",
- + guid, func, o->buffer.length, len);
- + ACPI_FREE(o);
- + return -1;
- + }
- + memcpy(dest, o->buffer.pointer, len);
- + pci_dbg(ithc->pci, "DSM %pUl %u = 0x%02x\n", guid, func, dest[0]);
- + ACPI_FREE(o);
- + return 1;
- +}
- +
- +int ithc_read_acpi_config(struct ithc *ithc, struct ithc_acpi_config *cfg)
- +{
- + int r;
- + acpi_handle handle = ACPI_HANDLE(&ithc->pci->dev);
- +
- + cfg->has_config = acpi_check_dsm(handle, &guid_hidspi, DSM_REV, BIT(0));
- + if (!cfg->has_config)
- + return 0;
- +
- + // HIDSPI settings
- +
- + r = read_acpi_u32(ithc, &guid_hidspi, 1, &cfg->input_report_header_address);
- + if (r < 0)
- + return r;
- + cfg->has_input_report_header_address = r > 0;
- + if (r > 0 && cfg->input_report_header_address > 0xffffff) {
- + pci_err(ithc->pci, "Invalid input report header address 0x%x\n",
- + cfg->input_report_header_address);
- + return -1;
- + }
- +
- + r = read_acpi_u32(ithc, &guid_hidspi, 2, &cfg->input_report_body_address);
- + if (r < 0)
- + return r;
- + cfg->has_input_report_body_address = r > 0;
- + if (r > 0 && cfg->input_report_body_address > 0xffffff) {
- + pci_err(ithc->pci, "Invalid input report body address 0x%x\n",
- + cfg->input_report_body_address);
- + return -1;
- + }
- +
- + r = read_acpi_u32(ithc, &guid_hidspi, 3, &cfg->output_report_body_address);
- + if (r < 0)
- + return r;
- + cfg->has_output_report_body_address = r > 0;
- + if (r > 0 && cfg->output_report_body_address > 0xffffff) {
- + pci_err(ithc->pci, "Invalid output report body address 0x%x\n",
- + cfg->output_report_body_address);
- + return -1;
- + }
- +
- + r = read_acpi_buf(ithc, &guid_hidspi, 4, sizeof(cfg->read_opcode), &cfg->read_opcode);
- + if (r < 0)
- + return r;
- + cfg->has_read_opcode = r > 0;
- +
- + r = read_acpi_buf(ithc, &guid_hidspi, 5, sizeof(cfg->write_opcode), &cfg->write_opcode);
- + if (r < 0)
- + return r;
- + cfg->has_write_opcode = r > 0;
- +
- + u32 flags;
- + r = read_acpi_u32(ithc, &guid_hidspi, 6, &flags);
- + if (r < 0)
- + return r;
- + cfg->has_read_mode = cfg->has_write_mode = r > 0;
- + if (r > 0) {
- + cfg->read_mode = (flags >> 14) & 3;
- + cfg->write_mode = flags & BIT(13) ? cfg->read_mode : SPI_MODE_SINGLE;
- + }
- +
- + // Quick SPI settings
- +
- + r = read_acpi_u32(ithc, &guid_thc_quickspi, 1, &cfg->spi_frequency);
- + if (r < 0)
- + return r;
- + cfg->has_spi_frequency = r > 0;
- +
- + r = read_acpi_u32(ithc, &guid_thc_quickspi, 2, &cfg->limit_packet_size);
- + if (r < 0)
- + return r;
- + cfg->has_limit_packet_size = r > 0;
- +
- + r = read_acpi_u32(ithc, &guid_thc_quickspi, 3, &cfg->tx_delay);
- + if (r < 0)
- + return r;
- + cfg->has_tx_delay = r > 0;
- + if (r > 0)
- + cfg->tx_delay &= 0xffff;
- +
- + // LTR settings
- +
- + r = read_acpi_u32(ithc, &guid_thc_ltr, 1, &cfg->active_ltr);
- + if (r < 0)
- + return r;
- + cfg->has_active_ltr = r > 0;
- + if (r > 0 && (!cfg->active_ltr || cfg->active_ltr > 0x3ff)) {
- + if (cfg->active_ltr != 0xffffffff)
- + pci_warn(ithc->pci, "Ignoring invalid active LTR value 0x%x\n",
- + cfg->active_ltr);
- + cfg->active_ltr = 500;
- + }
- +
- + r = read_acpi_u32(ithc, &guid_thc_ltr, 2, &cfg->idle_ltr);
- + if (r < 0)
- + return r;
- + cfg->has_idle_ltr = r > 0;
- + if (r > 0 && (!cfg->idle_ltr || cfg->idle_ltr > 0x3ff)) {
- + if (cfg->idle_ltr != 0xffffffff)
- + pci_warn(ithc->pci, "Ignoring invalid idle LTR value 0x%x\n",
- + cfg->idle_ltr);
- + cfg->idle_ltr = 500;
- + if (cfg->has_active_ltr && cfg->active_ltr > cfg->idle_ltr)
- + cfg->idle_ltr = cfg->active_ltr;
- + }
- +
- + return 0;
- +}
- +
- +void ithc_print_acpi_config(struct ithc *ithc, const struct ithc_acpi_config *cfg)
- +{
- + if (!cfg->has_config) {
- + pci_info(ithc->pci, "No ACPI config");
- + return;
- + }
- +
- + char input_report_header_address[16] = "-";
- + if (cfg->has_input_report_header_address)
- + sprintf(input_report_header_address, "0x%x", cfg->input_report_header_address);
- + char input_report_body_address[16] = "-";
- + if (cfg->has_input_report_body_address)
- + sprintf(input_report_body_address, "0x%x", cfg->input_report_body_address);
- + char output_report_body_address[16] = "-";
- + if (cfg->has_output_report_body_address)
- + sprintf(output_report_body_address, "0x%x", cfg->output_report_body_address);
- + char read_opcode[16] = "-";
- + if (cfg->has_read_opcode)
- + sprintf(read_opcode, "0x%02x", cfg->read_opcode);
- + char write_opcode[16] = "-";
- + if (cfg->has_write_opcode)
- + sprintf(write_opcode, "0x%02x", cfg->write_opcode);
- + char read_mode[16] = "-";
- + if (cfg->has_read_mode)
- + sprintf(read_mode, "%i", cfg->read_mode);
- + char write_mode[16] = "-";
- + if (cfg->has_write_mode)
- + sprintf(write_mode, "%i", cfg->write_mode);
- + char spi_frequency[16] = "-";
- + if (cfg->has_spi_frequency)
- + sprintf(spi_frequency, "%u", cfg->spi_frequency);
- + char limit_packet_size[16] = "-";
- + if (cfg->has_limit_packet_size)
- + sprintf(limit_packet_size, "%u", cfg->limit_packet_size);
- + char tx_delay[16] = "-";
- + if (cfg->has_tx_delay)
- + sprintf(tx_delay, "%u", cfg->tx_delay);
- + char active_ltr[16] = "-";
- + if (cfg->has_active_ltr)
- + sprintf(active_ltr, "%u", cfg->active_ltr);
- + char idle_ltr[16] = "-";
- + if (cfg->has_idle_ltr)
- + sprintf(idle_ltr, "%u", cfg->idle_ltr);
- +
- + pci_info(ithc->pci, "ACPI config: InputHeaderAddr=%s InputBodyAddr=%s OutputBodyAddr=%s ReadOpcode=%s WriteOpcode=%s ReadMode=%s WriteMode=%s Frequency=%s LimitPacketSize=%s TxDelay=%s ActiveLTR=%s IdleLTR=%s\n",
- + input_report_header_address, input_report_body_address, output_report_body_address,
- + read_opcode, write_opcode, read_mode, write_mode,
- + spi_frequency, limit_packet_size, tx_delay, active_ltr, idle_ltr);
- +}
- +
- +static int ithc_quickspi_init_regs(struct ithc *ithc, const struct ithc_acpi_config *cfg)
- +{
- + pci_dbg(ithc->pci, "initializing QuickSPI registers\n");
- +
- + // SPI frequency and mode
- + if (!cfg->has_spi_frequency || !cfg->spi_frequency) {
- + pci_err(ithc->pci, "Missing SPI frequency in configuration\n");
- + return -EINVAL;
- + }
- + unsigned int clkdiv = DIV_ROUND_UP(SPI_CLK_FREQ_BASE, cfg->spi_frequency);
- + bool clkdiv8 = clkdiv > 7;
- + if (clkdiv8)
- + clkdiv = min(7u, DIV_ROUND_UP(clkdiv, 8u));
- + if (!clkdiv)
- + clkdiv = 1;
- + CHECK_RET(ithc_set_spi_config, ithc, clkdiv, clkdiv8,
- + cfg->has_read_mode ? cfg->read_mode : SPI_MODE_SINGLE,
- + cfg->has_write_mode ? cfg->write_mode : SPI_MODE_SINGLE);
- +
- + // SPI addresses and opcodes
- + if (cfg->has_input_report_header_address)
- + writel(cfg->input_report_header_address, &ithc->regs->spi_header_addr);
- + if (cfg->has_input_report_body_address)
- + writel(cfg->input_report_body_address, &ithc->regs->dma_rx[0].spi_addr);
- + if (cfg->has_output_report_body_address)
- + writel(cfg->output_report_body_address, &ithc->regs->dma_tx.spi_addr);
- +
- + if (cfg->has_read_opcode) {
- + writeb(cfg->read_opcode, &ithc->regs->read_opcode);
- + writeb(cfg->read_opcode, &ithc->regs->read_opcode_single);
- + writeb(cfg->read_opcode, &ithc->regs->read_opcode_dual);
- + writeb(cfg->read_opcode, &ithc->regs->read_opcode_quad);
- + }
- + if (cfg->has_write_opcode) {
- + writeb(cfg->write_opcode, &ithc->regs->write_opcode);
- + writeb(cfg->write_opcode, &ithc->regs->write_opcode_single);
- + writeb(cfg->write_opcode, &ithc->regs->write_opcode_dual);
- + writeb(cfg->write_opcode, &ithc->regs->write_opcode_quad);
- + }
- + ithc_log_regs(ithc);
- +
- + // The rest...
- + bitsl(&ithc->regs->quickspi_config1,
- + QUICKSPI_CONFIG1_UNKNOWN_0(0xff) | QUICKSPI_CONFIG1_UNKNOWN_5(0xff) |
- + QUICKSPI_CONFIG1_UNKNOWN_10(0xff) | QUICKSPI_CONFIG1_UNKNOWN_16(0xffff),
- + QUICKSPI_CONFIG1_UNKNOWN_0(4) | QUICKSPI_CONFIG1_UNKNOWN_5(4) |
- + QUICKSPI_CONFIG1_UNKNOWN_10(22) | QUICKSPI_CONFIG1_UNKNOWN_16(2));
- +
- + bitsl(&ithc->regs->quickspi_config2,
- + QUICKSPI_CONFIG2_UNKNOWN_0(0xff) | QUICKSPI_CONFIG2_UNKNOWN_5(0xff) |
- + QUICKSPI_CONFIG2_UNKNOWN_12(0xff),
- + QUICKSPI_CONFIG2_UNKNOWN_0(8) | QUICKSPI_CONFIG2_UNKNOWN_5(14) |
- + QUICKSPI_CONFIG2_UNKNOWN_12(2));
- +
- + u32 pktsize = cfg->has_limit_packet_size && cfg->limit_packet_size == 1 ? 4 : 0x80;
- + bitsl(&ithc->regs->spi_config,
- + SPI_CONFIG_READ_PACKET_SIZE(0xfff) | SPI_CONFIG_WRITE_PACKET_SIZE(0xfff),
- + SPI_CONFIG_READ_PACKET_SIZE(pktsize) | SPI_CONFIG_WRITE_PACKET_SIZE(pktsize));
- +
- + bitsl_set(&ithc->regs->quickspi_config2,
- + QUICKSPI_CONFIG2_UNKNOWN_16 | QUICKSPI_CONFIG2_UNKNOWN_17);
- + bitsl(&ithc->regs->quickspi_config2,
- + QUICKSPI_CONFIG2_DISABLE_READ_ADDRESS_INCREMENT |
- + QUICKSPI_CONFIG2_DISABLE_WRITE_ADDRESS_INCREMENT |
- + QUICKSPI_CONFIG2_ENABLE_WRITE_STREAMING_MODE, 0);
- +
- + return 0;
- +}
- +
- +static int wait_for_report(struct ithc *ithc)
- +{
- + CHECK_RET(waitl, ithc, &ithc->regs->dma_rx[0].status,
- + DMA_RX_STATUS_READY, DMA_RX_STATUS_READY);
- + writel(DMA_RX_STATUS_READY, &ithc->regs->dma_rx[0].status);
- +
- + u32 h = readl(&ithc->regs->input_header);
- + ithc_log_regs(ithc);
- + if (INPUT_HEADER_SYNC(h) != INPUT_HEADER_SYNC_VALUE
- + || INPUT_HEADER_VERSION(h) != INPUT_HEADER_VERSION_VALUE) {
- + pci_err(ithc->pci, "invalid input report frame header 0x%08x\n", h);
- + return -ENODATA;
- + }
- + return INPUT_HEADER_REPORT_LENGTH(h) * 4;
- +}
- +
- +static int ithc_quickspi_init_hidspi(struct ithc *ithc, const struct ithc_acpi_config *cfg)
- +{
- + pci_dbg(ithc->pci, "initializing HIDSPI\n");
- +
- + // HIDSPI initialization sequence:
- + // "1. The host shall invoke the ACPI reset method to clear the device state."
- + acpi_status s = acpi_evaluate_object(ACPI_HANDLE(&ithc->pci->dev), "_RST", NULL, NULL);
- + if (ACPI_FAILURE(s)) {
- + pci_err(ithc->pci, "ACPI reset failed\n");
- + return -EIO;
- + }
- +
- + bitsl(&ithc->regs->control_bits, CONTROL_QUIESCE, 0);
- +
- + // "2. Within 1 second, the device shall signal an interrupt and make available to the host
- + // an input report containing a device reset response."
- + int size = wait_for_report(ithc);
- + if (size < 0)
- + return size;
- + if (size < sizeof(struct hidspi_header)) {
- + pci_err(ithc->pci, "SPI data size too small for reset response (%u)\n", size);
- + return -EMSGSIZE;
- + }
- +
- + // "3. The host shall read the reset response from the device at the Input Report addresses
- + // specified in ACPI."
- + u32 in_addr = cfg->has_input_report_body_address ? cfg->input_report_body_address : 0x1000;
- + struct {
- + struct hidspi_header header;
- + union {
- + struct hidspi_device_descriptor device_desc;
- + u32 data[16];
- + };
- + } resp = { 0 };
- + if (size > sizeof(resp)) {
- + pci_err(ithc->pci, "SPI data size for reset response too big (%u)\n", size);
- + return -EMSGSIZE;
- + }
- + CHECK_RET(ithc_spi_command, ithc, SPI_CMD_CODE_READ, in_addr, size, &resp);
- + if (resp.header.type != HIDSPI_INPUT_TYPE_RESET_RESPONSE) {
- + pci_err(ithc->pci, "received type %i instead of reset response\n", resp.header.type);
- + return -ENOMSG;
- + }
- +
- + // "4. The host shall then write an Output Report to the device at the Output Report Address
- + // specified in ACPI, requesting the Device Descriptor from the device."
- + u32 out_addr = cfg->has_output_report_body_address ? cfg->output_report_body_address : 0x1000;
- + struct hidspi_header req = { .type = HIDSPI_OUTPUT_TYPE_DEVICE_DESCRIPTOR_REQUEST };
- + CHECK_RET(ithc_spi_command, ithc, SPI_CMD_CODE_WRITE, out_addr, sizeof(req), &req);
- +
- + // "5. Within 1 second, the device shall signal an interrupt and make available to the host
- + // an input report containing the Device Descriptor."
- + size = wait_for_report(ithc);
- + if (size < 0)
- + return size;
- + if (size < sizeof(resp.header) + sizeof(resp.device_desc)) {
- + pci_err(ithc->pci, "SPI data size too small for device descriptor (%u)\n", size);
- + return -EMSGSIZE;
- + }
- +
- + // "6. The host shall read the Device Descriptor from the Input Report addresses specified
- + // in ACPI."
- + if (size > sizeof(resp)) {
- + pci_err(ithc->pci, "SPI data size for device descriptor too big (%u)\n", size);
- + return -EMSGSIZE;
- + }
- + memset(&resp, 0, sizeof(resp));
- + CHECK_RET(ithc_spi_command, ithc, SPI_CMD_CODE_READ, in_addr, size, &resp);
- + if (resp.header.type != HIDSPI_INPUT_TYPE_DEVICE_DESCRIPTOR) {
- + pci_err(ithc->pci, "received type %i instead of device descriptor\n",
- + resp.header.type);
- + return -ENOMSG;
- + }
- + struct hidspi_device_descriptor *d = &resp.device_desc;
- + if (resp.header.len < sizeof(*d)) {
- + pci_err(ithc->pci, "response too small for device descriptor (%u)\n",
- + resp.header.len);
- + return -EMSGSIZE;
- + }
- + if (d->wDeviceDescLength != sizeof(*d)) {
- + pci_err(ithc->pci, "invalid device descriptor length (%u)\n",
- + d->wDeviceDescLength);
- + return -EMSGSIZE;
- + }
- +
- + pci_info(ithc->pci, "Device descriptor: bcdVersion=0x%04x wReportDescLength=%u wMaxInputLength=%u wMaxOutputLength=%u wMaxFragmentLength=%u wVendorID=0x%04x wProductID=0x%04x wVersionID=0x%04x wFlags=0x%04x dwReserved=0x%08x\n",
- + d->bcdVersion, d->wReportDescLength,
- + d->wMaxInputLength, d->wMaxOutputLength, d->wMaxFragmentLength,
- + d->wVendorID, d->wProductID, d->wVersionID,
- + d->wFlags, d->dwReserved);
- +
- + ithc->vendor_id = d->wVendorID;
- + ithc->product_id = d->wProductID;
- + ithc->product_rev = d->wVersionID;
- + ithc->max_rx_size = max_t(u32, d->wMaxInputLength,
- + d->wReportDescLength + sizeof(struct hidspi_header));
- + ithc->max_tx_size = d->wMaxOutputLength;
- + ithc->have_config = true;
- +
- + // "7. The device and host shall then enter their "Ready" states - where the device may
- + // begin sending Input Reports, and the device shall be prepared for Output Reports from
- + // the host."
- +
- + return 0;
- +}
- +
- +int ithc_quickspi_init(struct ithc *ithc, const struct ithc_acpi_config *cfg)
- +{
- + bitsl_set(&ithc->regs->control_bits, CONTROL_QUIESCE);
- + CHECK_RET(waitl, ithc, &ithc->regs->control_bits, CONTROL_IS_QUIESCED, CONTROL_IS_QUIESCED);
- +
- + ithc_log_regs(ithc);
- + CHECK_RET(ithc_quickspi_init_regs, ithc, cfg);
- + ithc_log_regs(ithc);
- + CHECK_RET(ithc_quickspi_init_hidspi, ithc, cfg);
- + ithc_log_regs(ithc);
- +
- + // This value is set to 2 in ithc_quickspi_init_regs(). It needs to be set to 1 here,
- + // otherwise DMA will not work. Maybe selects between DMA and PIO mode?
- + bitsl(&ithc->regs->quickspi_config1,
- + QUICKSPI_CONFIG1_UNKNOWN_16(0xffff), QUICKSPI_CONFIG1_UNKNOWN_16(1));
- +
- + // TODO Do we need to set any of the following bits here?
- + //bitsb_set(&ithc->regs->dma_rx[1].control2, DMA_RX_CONTROL2_UNKNOWN_4);
- + //bitsb_set(&ithc->regs->dma_rx[0].control2, DMA_RX_CONTROL2_UNKNOWN_5);
- + //bitsb_set(&ithc->regs->dma_rx[1].control2, DMA_RX_CONTROL2_UNKNOWN_5);
- + //bitsl_set(&ithc->regs->dma_rx[0].init_unknown, INIT_UNKNOWN_3);
- + //bitsl_set(&ithc->regs->dma_rx[0].init_unknown, INIT_UNKNOWN_31);
- +
- + ithc_log_regs(ithc);
- +
- + return 0;
- +}
- +
- +void ithc_quickspi_exit(struct ithc *ithc)
- +{
- + // TODO Should we send HIDSPI 'power off' command?
- + //struct hidspi_header h = { .type = HIDSPI_OUTPUT_TYPE_COMMAND, .id = 3, };
- + //struct ithc_data d = { .type = ITHC_DATA_RAW, .data = &h, .size = sizeof(h) };
- + //CHECK(ithc_dma_tx, ithc, &d); // or ithc_spi_command()
- +}
- +
- +int ithc_quickspi_decode_rx(struct ithc *ithc, const void *src, size_t len, struct ithc_data *dest)
- +{
- + const struct hidspi_header *hdr = src;
- +
- + if (len < sizeof(*hdr))
- + return -ENODATA;
- + // TODO Do we need to handle HIDSPI packet fragmentation?
- + if (len < sizeof(*hdr) + hdr->len)
- + return -EMSGSIZE;
- + if (len > round_up(sizeof(*hdr) + hdr->len, 4))
- + return -EMSGSIZE;
- +
- + switch (hdr->type) {
- + case HIDSPI_INPUT_TYPE_RESET_RESPONSE:
- + // TODO "When the device detects an error condition, it may interrupt and make
- + // available to the host an Input Report containing an unsolicited Reset Response.
- + // After receiving an unsolicited Reset Response, the host shall initiate the
- + // request procedure from step (4) in the [HIDSPI initialization] process."
- + dest->type = ITHC_DATA_ERROR;
- + return 0;
- + case HIDSPI_INPUT_TYPE_REPORT_DESCRIPTOR:
- + dest->type = ITHC_DATA_REPORT_DESCRIPTOR;
- + dest->data = hdr + 1;
- + dest->size = hdr->len;
- + return 0;
- + case HIDSPI_INPUT_TYPE_DATA:
- + case HIDSPI_INPUT_TYPE_GET_INPUT_REPORT_RESPONSE:
- + dest->type = ITHC_DATA_INPUT_REPORT;
- + dest->data = &hdr->id;
- + dest->size = hdr->len + 1;
- + return 0;
- + case HIDSPI_INPUT_TYPE_GET_FEATURE_RESPONSE:
- + dest->type = ITHC_DATA_GET_FEATURE;
- + dest->data = &hdr->id;
- + dest->size = hdr->len + 1;
- + return 0;
- + case HIDSPI_INPUT_TYPE_SET_FEATURE_RESPONSE:
- + case HIDSPI_INPUT_TYPE_OUTPUT_REPORT_RESPONSE:
- + dest->type = ITHC_DATA_IGNORE;
- + return 0;
- + default:
- + return -EINVAL;
- + }
- +}
- +
- +ssize_t ithc_quickspi_encode_tx(struct ithc *ithc, const struct ithc_data *src, void *dest,
- + size_t maxlen)
- +{
- + struct hidspi_header *hdr = dest;
- +
- + size_t src_size = src->size;
- + const u8 *src_data = src->data;
- + u8 type;
- +
- + switch (src->type) {
- + case ITHC_DATA_SET_FEATURE:
- + type = HIDSPI_OUTPUT_TYPE_SET_FEATURE;
- + break;
- + case ITHC_DATA_GET_FEATURE:
- + type = HIDSPI_OUTPUT_TYPE_GET_FEATURE;
- + break;
- + case ITHC_DATA_OUTPUT_REPORT:
- + type = HIDSPI_OUTPUT_TYPE_OUTPUT_REPORT;
- + break;
- + case ITHC_DATA_REPORT_DESCRIPTOR:
- + type = HIDSPI_OUTPUT_TYPE_REPORT_DESCRIPTOR_REQUEST;
- + src_size = 0;
- + break;
- + default:
- + return -EINVAL;
- + }
- +
- + u8 id = 0;
- + if (src_size) {
- + id = *src_data++;
- + src_size--;
- + }
- +
- + // Data must be padded to next 4-byte boundary.
- + size_t padded = round_up(src_size, 4);
- + if (sizeof(*hdr) + padded > maxlen)
- + return -EOVERFLOW;
- +
- + // Fill the TX buffer with header and data.
- + hdr->type = type;
- + hdr->len = (u16)src_size;
- + hdr->id = id;
- + memcpy_and_pad(hdr + 1, padded, src_data, src_size, 0);
- +
- + return sizeof(*hdr) + padded;
- +}
- +
- diff --git a/drivers/hid/ithc/ithc-quickspi.h b/drivers/hid/ithc/ithc-quickspi.h
- new file mode 100644
- index 000000000000..74d882f6b2f0
- --- /dev/null
- +++ b/drivers/hid/ithc/ithc-quickspi.h
- @@ -0,0 +1,39 @@
- +/* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
- +
- +struct ithc_acpi_config {
- + bool has_config: 1;
- + bool has_input_report_header_address: 1;
- + bool has_input_report_body_address: 1;
- + bool has_output_report_body_address: 1;
- + bool has_read_opcode: 1;
- + bool has_write_opcode: 1;
- + bool has_read_mode: 1;
- + bool has_write_mode: 1;
- + bool has_spi_frequency: 1;
- + bool has_limit_packet_size: 1;
- + bool has_tx_delay: 1;
- + bool has_active_ltr: 1;
- + bool has_idle_ltr: 1;
- + u32 input_report_header_address;
- + u32 input_report_body_address;
- + u32 output_report_body_address;
- + u8 read_opcode;
- + u8 write_opcode;
- + u8 read_mode;
- + u8 write_mode;
- + u32 spi_frequency;
- + u32 limit_packet_size;
- + u32 tx_delay; // us/10 // TODO use?
- + u32 active_ltr; // ns/1024
- + u32 idle_ltr; // ns/1024
- +};
- +
- +int ithc_read_acpi_config(struct ithc *ithc, struct ithc_acpi_config *cfg);
- +void ithc_print_acpi_config(struct ithc *ithc, const struct ithc_acpi_config *cfg);
- +
- +int ithc_quickspi_init(struct ithc *ithc, const struct ithc_acpi_config *cfg);
- +void ithc_quickspi_exit(struct ithc *ithc);
- +int ithc_quickspi_decode_rx(struct ithc *ithc, const void *src, size_t len, struct ithc_data *dest);
- +ssize_t ithc_quickspi_encode_tx(struct ithc *ithc, const struct ithc_data *src, void *dest,
- + size_t maxlen);
- +
- diff --git a/drivers/hid/ithc/ithc-regs.c b/drivers/hid/ithc/ithc-regs.c
- index e058721886e3..c0f13506af20 100644
- --- a/drivers/hid/ithc/ithc-regs.c
- +++ b/drivers/hid/ithc/ithc-regs.c
- @@ -22,46 +22,104 @@ void bitsb(__iomem u8 *reg, u8 mask, u8 val)
-
- int waitl(struct ithc *ithc, __iomem u32 *reg, u32 mask, u32 val)
- {
- + ithc_log_regs(ithc);
- pci_dbg(ithc->pci, "waiting for reg 0x%04x mask 0x%08x val 0x%08x\n",
- reg_num(reg), mask, val);
- u32 x;
- if (readl_poll_timeout(reg, x, (x & mask) == val, 200, 1000*1000)) {
- + ithc_log_regs(ithc);
- pci_err(ithc->pci, "timed out waiting for reg 0x%04x mask 0x%08x val 0x%08x\n",
- reg_num(reg), mask, val);
- return -ETIMEDOUT;
- }
- + ithc_log_regs(ithc);
- pci_dbg(ithc->pci, "done waiting\n");
- return 0;
- }
-
- int waitb(struct ithc *ithc, __iomem u8 *reg, u8 mask, u8 val)
- {
- + ithc_log_regs(ithc);
- pci_dbg(ithc->pci, "waiting for reg 0x%04x mask 0x%02x val 0x%02x\n",
- reg_num(reg), mask, val);
- u8 x;
- if (readb_poll_timeout(reg, x, (x & mask) == val, 200, 1000*1000)) {
- + ithc_log_regs(ithc);
- pci_err(ithc->pci, "timed out waiting for reg 0x%04x mask 0x%02x val 0x%02x\n",
- reg_num(reg), mask, val);
- return -ETIMEDOUT;
- }
- + ithc_log_regs(ithc);
- pci_dbg(ithc->pci, "done waiting\n");
- return 0;
- }
-
- -int ithc_set_spi_config(struct ithc *ithc, u8 speed, u8 mode)
- +static void calc_ltr(u64 *ns, unsigned int *val, unsigned int *scale)
- {
- - pci_dbg(ithc->pci, "setting SPI speed to %i, mode %i\n", speed, mode);
- - if (mode == 3)
- - mode = 2;
- + unsigned int s = 0;
- + u64 v = *ns;
- + while (v > 0x3ff) {
- + s++;
- + v >>= 5;
- + }
- + if (s > 5) {
- + s = 5;
- + v = 0x3ff;
- + }
- + *val = v;
- + *scale = s;
- + *ns = v << (5 * s);
- +}
- +
- +void ithc_set_ltr_config(struct ithc *ithc, u64 active_ltr_ns, u64 idle_ltr_ns)
- +{
- + unsigned int active_val, active_scale, idle_val, idle_scale;
- + calc_ltr(&active_ltr_ns, &active_val, &active_scale);
- + calc_ltr(&idle_ltr_ns, &idle_val, &idle_scale);
- + pci_dbg(ithc->pci, "setting active LTR value to %llu ns, idle LTR value to %llu ns\n",
- + active_ltr_ns, idle_ltr_ns);
- + writel(LTR_CONFIG_ENABLE_ACTIVE | LTR_CONFIG_ENABLE_IDLE | LTR_CONFIG_APPLY |
- + LTR_CONFIG_ACTIVE_LTR_SCALE(active_scale) | LTR_CONFIG_ACTIVE_LTR_VALUE(active_val) |
- + LTR_CONFIG_IDLE_LTR_SCALE(idle_scale) | LTR_CONFIG_IDLE_LTR_VALUE(idle_val),
- + &ithc->regs->ltr_config);
- +}
- +
- +void ithc_set_ltr_idle(struct ithc *ithc)
- +{
- + u32 ltr = readl(&ithc->regs->ltr_config);
- + switch (ltr & (LTR_CONFIG_STATUS_ACTIVE | LTR_CONFIG_STATUS_IDLE)) {
- + case LTR_CONFIG_STATUS_IDLE:
- + break;
- + case LTR_CONFIG_STATUS_ACTIVE:
- + writel(ltr | LTR_CONFIG_TOGGLE | LTR_CONFIG_APPLY, &ithc->regs->ltr_config);
- + break;
- + default:
- + pci_err(ithc->pci, "invalid LTR state 0x%08x\n", ltr);
- + break;
- + }
- +}
- +
- +int ithc_set_spi_config(struct ithc *ithc, u8 clkdiv, bool clkdiv8, u8 read_mode, u8 write_mode)
- +{
- + if (clkdiv == 0 || clkdiv > 7 || read_mode > SPI_MODE_QUAD || write_mode > SPI_MODE_QUAD)
- + return -EINVAL;
- + static const char * const modes[] = { "single", "dual", "quad" };
- + pci_dbg(ithc->pci, "setting SPI frequency to %i Hz, %s read, %s write\n",
- + SPI_CLK_FREQ_BASE / (clkdiv * (clkdiv8 ? 8 : 1)),
- + modes[read_mode], modes[write_mode]);
- bitsl(&ithc->regs->spi_config,
- - SPI_CONFIG_MODE(0xff) | SPI_CONFIG_SPEED(0xff) | SPI_CONFIG_UNKNOWN_18(0xff) | SPI_CONFIG_SPEED2(0xff),
- - SPI_CONFIG_MODE(mode) | SPI_CONFIG_SPEED(speed) | SPI_CONFIG_UNKNOWN_18(0) | SPI_CONFIG_SPEED2(speed));
- + SPI_CONFIG_READ_MODE(0xff) | SPI_CONFIG_READ_CLKDIV(0xff) |
- + SPI_CONFIG_WRITE_MODE(0xff) | SPI_CONFIG_WRITE_CLKDIV(0xff) |
- + SPI_CONFIG_CLKDIV_8,
- + SPI_CONFIG_READ_MODE(read_mode) | SPI_CONFIG_READ_CLKDIV(clkdiv) |
- + SPI_CONFIG_WRITE_MODE(write_mode) | SPI_CONFIG_WRITE_CLKDIV(clkdiv) |
- + (clkdiv8 ? SPI_CONFIG_CLKDIV_8 : 0));
- return 0;
- }
-
- int ithc_spi_command(struct ithc *ithc, u8 command, u32 offset, u32 size, void *data)
- {
- - pci_dbg(ithc->pci, "SPI command %u, size %u, offset %u\n", command, size, offset);
- + pci_dbg(ithc->pci, "SPI command %u, size %u, offset 0x%x\n", command, size, offset);
- if (size > sizeof(ithc->regs->spi_cmd.data))
- return -EINVAL;
-
- diff --git a/drivers/hid/ithc/ithc-regs.h b/drivers/hid/ithc/ithc-regs.h
- index d4007d9e2bac..a9d236454644 100644
- --- a/drivers/hid/ithc/ithc-regs.h
- +++ b/drivers/hid/ithc/ithc-regs.h
- @@ -1,14 +1,34 @@
- /* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
-
- +#define LTR_CONFIG_ENABLE_ACTIVE BIT(0)
- +#define LTR_CONFIG_TOGGLE BIT(1)
- +#define LTR_CONFIG_ENABLE_IDLE BIT(2)
- +#define LTR_CONFIG_APPLY BIT(3)
- +#define LTR_CONFIG_IDLE_LTR_SCALE(x) (((x) & 7) << 4)
- +#define LTR_CONFIG_IDLE_LTR_VALUE(x) (((x) & 0x3ff) << 7)
- +#define LTR_CONFIG_ACTIVE_LTR_SCALE(x) (((x) & 7) << 17)
- +#define LTR_CONFIG_ACTIVE_LTR_VALUE(x) (((x) & 0x3ff) << 20)
- +#define LTR_CONFIG_STATUS_ACTIVE BIT(30)
- +#define LTR_CONFIG_STATUS_IDLE BIT(31)
- +
- #define CONTROL_QUIESCE BIT(1)
- #define CONTROL_IS_QUIESCED BIT(2)
- #define CONTROL_NRESET BIT(3)
- +#define CONTROL_UNKNOWN_24(x) (((x) & 3) << 24)
- #define CONTROL_READY BIT(29)
-
- -#define SPI_CONFIG_MODE(x) (((x) & 3) << 2)
- -#define SPI_CONFIG_SPEED(x) (((x) & 7) << 4)
- -#define SPI_CONFIG_UNKNOWN_18(x) (((x) & 3) << 18)
- -#define SPI_CONFIG_SPEED2(x) (((x) & 0xf) << 20) // high bit = high speed mode?
- +#define SPI_CONFIG_READ_MODE(x) (((x) & 3) << 2)
- +#define SPI_CONFIG_READ_CLKDIV(x) (((x) & 7) << 4)
- +#define SPI_CONFIG_READ_PACKET_SIZE(x) (((x) & 0x1ff) << 7)
- +#define SPI_CONFIG_WRITE_MODE(x) (((x) & 3) << 18)
- +#define SPI_CONFIG_WRITE_CLKDIV(x) (((x) & 7) << 20)
- +#define SPI_CONFIG_CLKDIV_8 BIT(23) // additionally divide clk by 8, for both read and write
- +#define SPI_CONFIG_WRITE_PACKET_SIZE(x) (((x) & 0xff) << 24)
- +
- +#define SPI_CLK_FREQ_BASE 125000000
- +#define SPI_MODE_SINGLE 0
- +#define SPI_MODE_DUAL 1
- +#define SPI_MODE_QUAD 2
-
- #define ERROR_CONTROL_UNKNOWN_0 BIT(0)
- #define ERROR_CONTROL_DISABLE_DMA BIT(1) // clears DMA_RX_CONTROL_ENABLE when a DMA error occurs
- @@ -53,33 +73,71 @@
- #define DMA_TX_STATUS_UNKNOWN_2 BIT(2)
- #define DMA_TX_STATUS_UNKNOWN_3 BIT(3) // busy?
-
- +#define INPUT_HEADER_VERSION(x) ((x) & 0xf)
- +#define INPUT_HEADER_REPORT_LENGTH(x) (((x) >> 8) & 0x3fff)
- +#define INPUT_HEADER_SYNC(x) ((x) >> 24)
- +#define INPUT_HEADER_VERSION_VALUE 3
- +#define INPUT_HEADER_SYNC_VALUE 0x5a
- +
- +#define QUICKSPI_CONFIG1_UNKNOWN_0(x) (((x) & 0x1f) << 0)
- +#define QUICKSPI_CONFIG1_UNKNOWN_5(x) (((x) & 0x1f) << 5)
- +#define QUICKSPI_CONFIG1_UNKNOWN_10(x) (((x) & 0x1f) << 10)
- +#define QUICKSPI_CONFIG1_UNKNOWN_16(x) (((x) & 0xffff) << 16)
- +
- +#define QUICKSPI_CONFIG2_UNKNOWN_0(x) (((x) & 0x1f) << 0)
- +#define QUICKSPI_CONFIG2_UNKNOWN_5(x) (((x) & 0x1f) << 5)
- +#define QUICKSPI_CONFIG2_UNKNOWN_12(x) (((x) & 0xf) << 12)
- +#define QUICKSPI_CONFIG2_UNKNOWN_16 BIT(16)
- +#define QUICKSPI_CONFIG2_UNKNOWN_17 BIT(17)
- +#define QUICKSPI_CONFIG2_DISABLE_READ_ADDRESS_INCREMENT BIT(24)
- +#define QUICKSPI_CONFIG2_DISABLE_WRITE_ADDRESS_INCREMENT BIT(25)
- +#define QUICKSPI_CONFIG2_ENABLE_WRITE_STREAMING_MODE BIT(27)
- +#define QUICKSPI_CONFIG2_IRQ_POLARITY BIT(28)
- +
- #define DMA_RX_CONTROL_ENABLE BIT(0)
- #define DMA_RX_CONTROL_IRQ_UNKNOWN_1 BIT(1) // rx1 only?
- #define DMA_RX_CONTROL_IRQ_ERROR BIT(3) // rx1 only?
- -#define DMA_RX_CONTROL_IRQ_UNKNOWN_4 BIT(4) // rx0 only?
- +#define DMA_RX_CONTROL_IRQ_READY BIT(4) // rx0 only
- #define DMA_RX_CONTROL_IRQ_DATA BIT(5)
-
- +#define DMA_RX_CONTROL2_UNKNOWN_4 BIT(4) // rx1 only?
- #define DMA_RX_CONTROL2_UNKNOWN_5 BIT(5) // rx0 only?
- #define DMA_RX_CONTROL2_RESET BIT(7) // resets ringbuffer indices
-
- #define DMA_RX_WRAP_FLAG BIT(7)
-
- #define DMA_RX_STATUS_ERROR BIT(3)
- -#define DMA_RX_STATUS_UNKNOWN_4 BIT(4) // set in rx0 after using CONTROL_NRESET when it becomes possible to read config (can take >100ms)
- +#define DMA_RX_STATUS_READY BIT(4) // set in rx0 after using CONTROL_NRESET when it becomes possible to read config (can take >100ms)
- #define DMA_RX_STATUS_HAVE_DATA BIT(5)
- #define DMA_RX_STATUS_ENABLED BIT(8)
-
- +#define INIT_UNKNOWN_GUC_2 BIT(2)
- +#define INIT_UNKNOWN_3 BIT(3)
- +#define INIT_UNKNOWN_GUC_4 BIT(4)
- +#define INIT_UNKNOWN_5 BIT(5)
- +#define INIT_UNKNOWN_31 BIT(31)
- +
- // COUNTER_RESET can be written to counter registers to reset them to zero. However, in some cases this can mess up the THC.
- #define COUNTER_RESET BIT(31)
-
- struct ithc_registers {
- - /* 0000 */ u32 _unknown_0000[1024];
- + /* 0000 */ u32 _unknown_0000[5];
- + /* 0014 */ u32 ltr_config;
- + /* 0018 */ u32 _unknown_0018[1018];
- /* 1000 */ u32 _unknown_1000;
- /* 1004 */ u32 _unknown_1004;
- /* 1008 */ u32 control_bits;
- /* 100c */ u32 _unknown_100c;
- /* 1010 */ u32 spi_config;
- - /* 1014 */ u32 _unknown_1014[3];
- + /* 1014 */ u8 read_opcode; // maybe for header?
- + /* 1015 */ u8 read_opcode_quad;
- + /* 1016 */ u8 read_opcode_dual;
- + /* 1017 */ u8 read_opcode_single;
- + /* 1018 */ u8 write_opcode; // not used?
- + /* 1019 */ u8 write_opcode_quad;
- + /* 101a */ u8 write_opcode_dual;
- + /* 101b */ u8 write_opcode_single;
- + /* 101c */ u32 _unknown_101c;
- /* 1020 */ u32 error_control;
- /* 1024 */ u32 error_status; // write to clear
- /* 1028 */ u32 error_flags; // write to clear
- @@ -100,12 +158,19 @@ struct ithc_registers {
- /* 109a */ u8 _unknown_109a;
- /* 109b */ u8 num_prds;
- /* 109c */ u32 status; // write to clear
- + /* 10a0 */ u32 _unknown_10a0[5];
- + /* 10b4 */ u32 spi_addr;
- } dma_tx;
- - /* 10a0 */ u32 _unknown_10a0[7];
- - /* 10bc */ u32 state; // is 0xe0000402 (dev config val 0) after CONTROL_NRESET, 0xe0000461 after first touch, 0xe0000401 after DMA_RX_CODE_RESET
- + /* 10b8 */ u32 spi_header_addr;
- + union {
- + /* 10bc */ u32 irq_cause; // in legacy THC mode
- + /* 10bc */ u32 input_header; // in QuickSPI mode (see HIDSPI spec)
- + };
- /* 10c0 */ u32 _unknown_10c0[8];
- /* 10e0 */ u32 _unknown_10e0_counters[3];
- - /* 10ec */ u32 _unknown_10ec[5];
- + /* 10ec */ u32 quickspi_config1;
- + /* 10f0 */ u32 quickspi_config2;
- + /* 10f4 */ u32 _unknown_10f4[3];
- struct {
- /* 1100/1200 */ u64 addr; // cannot be written with writeq(), must use lo_hi_writeq()
- /* 1108/1208 */ u8 num_bufs;
- @@ -120,70 +185,30 @@ struct ithc_registers {
- /* 1118/1218 */ u64 _unknown_1118_guc_addr;
- /* 1120/1220 */ u32 _unknown_1120_guc;
- /* 1124/1224 */ u32 _unknown_1124_guc;
- - /* 1128/1228 */ u32 unknown_init_bits; // bit 2 = guc related, bit 3 = rx1 related, bit 4 = guc related
- + /* 1128/1228 */ u32 init_unknown;
- /* 112c/122c */ u32 _unknown_112c;
- /* 1130/1230 */ u64 _unknown_1130_guc_addr;
- /* 1138/1238 */ u32 _unknown_1138_guc;
- /* 113c/123c */ u32 _unknown_113c;
- /* 1140/1240 */ u32 _unknown_1140_guc;
- - /* 1144/1244 */ u32 _unknown_1144[23];
- + /* 1144/1244 */ u32 _unknown_1144[11];
- + /* 1170/1270 */ u32 spi_addr;
- + /* 1174/1274 */ u32 _unknown_1174[11];
- /* 11a0/12a0 */ u32 _unknown_11a0_counters[6];
- /* 11b8/12b8 */ u32 _unknown_11b8[18];
- } dma_rx[2];
- };
- static_assert(sizeof(struct ithc_registers) == 0x1300);
-
- -#define DEVCFG_DMA_RX_SIZE(x) ((((x) & 0x3fff) + 1) << 6)
- -#define DEVCFG_DMA_TX_SIZE(x) (((((x) >> 14) & 0x3ff) + 1) << 6)
- -
- -#define DEVCFG_TOUCH_MASK 0x3f
- -#define DEVCFG_TOUCH_ENABLE BIT(0)
- -#define DEVCFG_TOUCH_UNKNOWN_1 BIT(1)
- -#define DEVCFG_TOUCH_UNKNOWN_2 BIT(2)
- -#define DEVCFG_TOUCH_UNKNOWN_3 BIT(3)
- -#define DEVCFG_TOUCH_UNKNOWN_4 BIT(4)
- -#define DEVCFG_TOUCH_UNKNOWN_5 BIT(5)
- -#define DEVCFG_TOUCH_UNKNOWN_6 BIT(6)
- -
- -#define DEVCFG_DEVICE_ID_TIC 0x43495424 // "$TIC"
- -
- -#define DEVCFG_SPI_MAX_FREQ(x) (((x) >> 1) & 0xf) // high bit = use high speed mode?
- -#define DEVCFG_SPI_MODE(x) (((x) >> 6) & 3)
- -#define DEVCFG_SPI_UNKNOWN_8(x) (((x) >> 8) & 0x3f)
- -#define DEVCFG_SPI_NEEDS_HEARTBEAT BIT(20) // TODO implement heartbeat
- -#define DEVCFG_SPI_HEARTBEAT_INTERVAL(x) (((x) >> 21) & 7)
- -#define DEVCFG_SPI_UNKNOWN_25 BIT(25)
- -#define DEVCFG_SPI_UNKNOWN_26 BIT(26)
- -#define DEVCFG_SPI_UNKNOWN_27 BIT(27)
- -#define DEVCFG_SPI_DELAY(x) (((x) >> 28) & 7) // TODO use this
- -#define DEVCFG_SPI_USE_EXT_READ_CFG BIT(31) // TODO use this?
- -
- -struct ithc_device_config { // (Example values are from an SP7+.)
- - u32 _unknown_00; // 00 = 0xe0000402 (0xe0000401 after DMA_RX_CODE_RESET)
- - u32 _unknown_04; // 04 = 0x00000000
- - u32 dma_buf_sizes; // 08 = 0x000a00ff
- - u32 touch_cfg; // 0c = 0x0000001c
- - u32 _unknown_10; // 10 = 0x0000001c
- - u32 device_id; // 14 = 0x43495424 = "$TIC"
- - u32 spi_config; // 18 = 0xfda00a2e
- - u16 vendor_id; // 1c = 0x045e = Microsoft Corp.
- - u16 product_id; // 1e = 0x0c1a
- - u32 revision; // 20 = 0x00000001
- - u32 fw_version; // 24 = 0x05008a8b = 5.0.138.139 (this value looks more random on newer devices)
- - u32 _unknown_28; // 28 = 0x00000000
- - u32 fw_mode; // 2c = 0x00000000 (for fw update?)
- - u32 _unknown_30; // 30 = 0x00000000
- - u32 _unknown_34; // 34 = 0x0404035e (u8,u8,u8,u8 = version?)
- - u32 _unknown_38; // 38 = 0x000001c0 (0x000001c1 after DMA_RX_CODE_RESET)
- - u32 _unknown_3c; // 3c = 0x00000002
- -};
- -
- void bitsl(__iomem u32 *reg, u32 mask, u32 val);
- void bitsb(__iomem u8 *reg, u8 mask, u8 val);
- #define bitsl_set(reg, x) bitsl(reg, x, x)
- #define bitsb_set(reg, x) bitsb(reg, x, x)
- int waitl(struct ithc *ithc, __iomem u32 *reg, u32 mask, u32 val);
- int waitb(struct ithc *ithc, __iomem u8 *reg, u8 mask, u8 val);
- -int ithc_set_spi_config(struct ithc *ithc, u8 speed, u8 mode);
- +
- +void ithc_set_ltr_config(struct ithc *ithc, u64 active_ltr_ns, u64 idle_ltr_ns);
- +void ithc_set_ltr_idle(struct ithc *ithc);
- +int ithc_set_spi_config(struct ithc *ithc, u8 clkdiv, bool clkdiv8, u8 read_mode, u8 write_mode);
- int ithc_spi_command(struct ithc *ithc, u8 command, u32 offset, u32 size, void *data);
-
- diff --git a/drivers/hid/ithc/ithc.h b/drivers/hid/ithc/ithc.h
- index 028e55a4ec53..e90c38044432 100644
- --- a/drivers/hid/ithc/ithc.h
- +++ b/drivers/hid/ithc/ithc.h
- @@ -1,20 +1,19 @@
- /* SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause */
-
- -#include <linux/module.h>
- -#include <linux/input.h>
- -#include <linux/hid.h>
- +#include <linux/acpi.h>
- +#include <linux/debugfs.h>
- +#include <linux/delay.h>
- #include <linux/dma-mapping.h>
- +#include <linux/hid.h>
- #include <linux/highmem.h>
- -#include <linux/pci.h>
- +#include <linux/input.h>
- #include <linux/io-64-nonatomic-lo-hi.h>
- #include <linux/iopoll.h>
- -#include <linux/delay.h>
- #include <linux/kthread.h>
- #include <linux/miscdevice.h>
- -#include <linux/debugfs.h>
- +#include <linux/module.h>
- +#include <linux/pci.h>
- #include <linux/poll.h>
- -#include <linux/timer.h>
- -#include <linux/pm_qos.h>
-
- #define DEVNAME "ithc"
- #define DEVFULLNAME "Intel Touch Host Controller"
- @@ -27,10 +26,37 @@
-
- #define NUM_RX_BUF 16
-
- +// PCI device IDs:
- +// Lakefield
- +#define PCI_DEVICE_ID_INTEL_THC_LKF_PORT1 0x98d0
- +#define PCI_DEVICE_ID_INTEL_THC_LKF_PORT2 0x98d1
- +// Tiger Lake
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT1 0xa0d0
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT2 0xa0d1
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT1 0x43d0
- +#define PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT2 0x43d1
- +// Alder Lake
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1 0x7ad8
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2 0x7ad9
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1 0x51d0
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2 0x51d1
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1 0x54d0
- +#define PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2 0x54d1
- +// Raptor Lake
- +#define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT1 0x7a58
- +#define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT2 0x7a59
- +// Meteor Lake
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT1 0x7e48
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT2 0x7e4a
- +
- struct ithc;
-
- #include "ithc-regs.h"
- +#include "ithc-hid.h"
- #include "ithc-dma.h"
- +#include "ithc-legacy.h"
- +#include "ithc-quickspi.h"
- +#include "ithc-debug.h"
-
- struct ithc {
- char phys[32];
- @@ -38,30 +64,21 @@ struct ithc {
- int irq;
- struct task_struct *poll_thread;
-
- - struct pm_qos_request activity_qos;
- - struct hrtimer activity_start_timer;
- - struct hrtimer activity_end_timer;
- - ktime_t last_rx_time;
- - unsigned int cur_rx_seq_count;
- - unsigned int cur_rx_seq_errors;
- -
- - struct hid_device *hid;
- - bool hid_parse_done;
- - wait_queue_head_t wait_hid_parse;
- - wait_queue_head_t wait_hid_get_feature;
- - struct mutex hid_get_feature_mutex;
- - void *hid_get_feature_buf;
- - size_t hid_get_feature_size;
- -
- struct ithc_registers __iomem *regs;
- struct ithc_registers *prev_regs; // for debugging
- - struct ithc_device_config config;
- struct ithc_dma_rx dma_rx[2];
- struct ithc_dma_tx dma_tx;
- + struct ithc_hid hid;
- +
- + bool use_quickspi;
- + bool have_config;
- + u16 vendor_id;
- + u16 product_id;
- + u32 product_rev;
- + u32 max_rx_size;
- + u32 max_tx_size;
- + u32 legacy_touch_cfg;
- };
-
- int ithc_reset(struct ithc *ithc);
- -void ithc_set_active(struct ithc *ithc, unsigned int duration_us);
- -int ithc_debug_init(struct ithc *ithc);
- -void ithc_log_regs(struct ithc *ithc);
-
- --
- 2.45.2
- From 79abe7fc9d3cd1eda0d9904695a98e98eab037aa Mon Sep 17 00:00:00 2001
- From: Maximilian Luz <luzmaximilian@gmail.com>
- Date: Sun, 4 Aug 2024 16:04:53 +0200
- Subject: [PATCH] hid: ithc: Update from quo/ithc-linux
- - Enable support for SL6/SP10
- - Fixes for SP8
- Based on: https://github.com/quo/ithc-linux/commit/34539af4726d970f9765363bb78b5fd920611a0b
- Signed-off-by: Maximilian Luz <luzmaximilian@gmail.com>
- Patchset: ithc
- ---
- drivers/hid/ithc/ithc-legacy.c | 4 +-
- drivers/hid/ithc/ithc-main.c | 91 +++++++++-----------------------
- drivers/hid/ithc/ithc-quickspi.c | 53 ++++++++++++++-----
- drivers/hid/ithc/ithc-regs.h | 15 +++---
- drivers/hid/ithc/ithc.h | 9 +++-
- 5 files changed, 82 insertions(+), 90 deletions(-)
- diff --git a/drivers/hid/ithc/ithc-legacy.c b/drivers/hid/ithc/ithc-legacy.c
- index 5c1da11e3f1d..8883987fb352 100644
- --- a/drivers/hid/ithc/ithc-legacy.c
- +++ b/drivers/hid/ithc/ithc-legacy.c
- @@ -82,8 +82,10 @@ int ithc_legacy_init(struct ithc *ithc)
- // Setting the following bit seems to make reading the config more reliable.
- bitsl_set(&ithc->regs->dma_rx[0].init_unknown, INIT_UNKNOWN_31);
-
- - // Setting this bit may be necessary on some ADL devices.
- + // Setting this bit may be necessary on ADL devices.
- switch (ithc->pci->device) {
- + case PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2:
- case PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1:
- case PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2:
- case PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1:
- diff --git a/drivers/hid/ithc/ithc-main.c b/drivers/hid/ithc/ithc-main.c
- index 2acf02e41d40..ac56c253674b 100644
- --- a/drivers/hid/ithc/ithc-main.c
- +++ b/drivers/hid/ithc/ithc-main.c
- @@ -6,25 +6,14 @@ MODULE_DESCRIPTION("Intel Touch Host Controller driver");
- MODULE_LICENSE("Dual BSD/GPL");
-
- static const struct pci_device_id ithc_pci_tbl[] = {
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_LKF_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_LKF_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_LP_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_TGL_H_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT2) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_MTL_PORT1) },
- - { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_THC_MTL_PORT2) },
- - // XXX So far the THC seems to be the only Intel PCI device with PCI_CLASS_INPUT_PEN,
- - // so instead of the device list we could just do:
- - // { .vendor = PCI_VENDOR_ID_INTEL, .device = PCI_ANY_ID, .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, .class = PCI_CLASS_INPUT_PEN, .class_mask = ~0, },
- + {
- + .vendor = PCI_VENDOR_ID_INTEL,
- + .device = PCI_ANY_ID,
- + .subvendor = PCI_ANY_ID,
- + .subdevice = PCI_ANY_ID,
- + .class = PCI_CLASS_INPUT_PEN << 8,
- + .class_mask = ~0,
- + },
- {}
- };
- MODULE_DEVICE_TABLE(pci, ithc_pci_tbl);
- @@ -52,50 +41,14 @@ static int ithc_idle_ltr_us = -1;
- module_param_named(idleltr, ithc_idle_ltr_us, int, 0);
- MODULE_PARM_DESC(idleltr, "Idle LTR value override (in microseconds)");
-
- +static unsigned int ithc_idle_delay_ms = 1000;
- +module_param_named(idledelay, ithc_idle_delay_ms, uint, 0);
- +MODULE_PARM_DESC(idleltr, "Minimum idle time before applying idle LTR value (in milliseconds)");
- +
- static bool ithc_log_regs_enabled = false;
- module_param_named(logregs, ithc_log_regs_enabled, bool, 0);
- MODULE_PARM_DESC(logregs, "Log changes in register values (for debugging)");
-
- -// Sysfs attributes
- -
- -static ssize_t vendor_show(struct device *dev, struct device_attribute *attr, char *buf)
- -{
- - struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc->have_config)
- - return -ENODEV;
- - return sprintf(buf, "0x%04x", ithc->vendor_id);
- -}
- -static DEVICE_ATTR_RO(vendor);
- -static ssize_t product_show(struct device *dev, struct device_attribute *attr, char *buf)
- -{
- - struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc->have_config)
- - return -ENODEV;
- - return sprintf(buf, "0x%04x", ithc->product_id);
- -}
- -static DEVICE_ATTR_RO(product);
- -static ssize_t revision_show(struct device *dev, struct device_attribute *attr, char *buf)
- -{
- - struct ithc *ithc = dev_get_drvdata(dev);
- - if (!ithc || !ithc->have_config)
- - return -ENODEV;
- - return sprintf(buf, "%u", ithc->product_rev);
- -}
- -static DEVICE_ATTR_RO(revision);
- -
- -static const struct attribute_group *ithc_attribute_groups[] = {
- - &(const struct attribute_group){
- - .name = DEVNAME,
- - .attrs = (struct attribute *[]){
- - &dev_attr_vendor.attr,
- - &dev_attr_product.attr,
- - &dev_attr_revision.attr,
- - NULL
- - },
- - },
- - NULL
- -};
- -
- // Interrupts/polling
-
- static void ithc_disable_interrupts(struct ithc *ithc)
- @@ -124,14 +77,19 @@ static void ithc_clear_interrupts(struct ithc *ithc)
- &ithc->regs->dma_tx.status);
- }
-
- +static void ithc_idle_timer_callback(struct timer_list *t)
- +{
- + struct ithc *ithc = container_of(t, struct ithc, idle_timer);
- + ithc_set_ltr_idle(ithc);
- +}
- +
- static void ithc_process(struct ithc *ithc)
- {
- ithc_log_regs(ithc);
-
- // The THC automatically transitions from LTR idle to active at the start of a DMA transfer.
- - // It does not appear to automatically go back to idle, so we switch it back here, since
- - // the DMA transfer should be complete.
- - ithc_set_ltr_idle(ithc);
- + // It does not appear to automatically go back to idle, so we switch it back after a delay.
- + mod_timer(&ithc->idle_timer, jiffies + msecs_to_jiffies(ithc_idle_delay_ms));
-
- bool rx0 = ithc_use_rx0 && (readl(&ithc->regs->dma_rx[0].status) & (DMA_RX_STATUS_ERROR | DMA_RX_STATUS_HAVE_DATA)) != 0;
- bool rx1 = ithc_use_rx1 && (readl(&ithc->regs->dma_rx[1].status) & (DMA_RX_STATUS_ERROR | DMA_RX_STATUS_HAVE_DATA)) != 0;
- @@ -231,10 +189,10 @@ static int ithc_init_device(struct ithc *ithc)
- // Set Latency Tolerance Reporting config. The device will automatically
- // apply these values depending on whether it is active or idle.
- // If active value is too high, DMA buffer data can become truncated.
- - // By default, we set the active LTR value to 100us, and idle to 100ms.
- + // By default, we set the active LTR value to 50us, and idle to 100ms.
- u64 active_ltr_ns = ithc_active_ltr_us >= 0 ? (u64)ithc_active_ltr_us * 1000
- : cfg.has_config && cfg.has_active_ltr ? (u64)cfg.active_ltr << 10
- - : 100 * 1000;
- + : 50 * 1000;
- u64 idle_ltr_ns = ithc_idle_ltr_us >= 0 ? (u64)ithc_idle_ltr_us * 1000
- : cfg.has_config && cfg.has_idle_ltr ? (u64)cfg.idle_ltr << 10
- : 100 * 1000 * 1000;
- @@ -279,6 +237,7 @@ static void ithc_stop(void *res)
- else
- ithc_legacy_exit(ithc);
- ithc_disable(ithc);
- + del_timer_sync(&ithc->idle_timer);
-
- // Clear DMA config.
- for (unsigned int i = 0; i < 2; i++) {
- @@ -343,13 +302,14 @@ static int ithc_start(struct pci_dev *pci)
-
- // Initialize HID and DMA.
- CHECK_RET(ithc_hid_init, ithc);
- - CHECK(devm_device_add_groups, &pci->dev, ithc_attribute_groups);
- if (ithc_use_rx0)
- CHECK_RET(ithc_dma_rx_init, ithc, 0);
- if (ithc_use_rx1)
- CHECK_RET(ithc_dma_rx_init, ithc, 1);
- CHECK_RET(ithc_dma_tx_init, ithc);
-
- + timer_setup(&ithc->idle_timer, ithc_idle_timer_callback, 0);
- +
- // Add ithc_stop() callback AFTER setting up DMA buffers, so that polling/irqs/DMA are
- // disabled BEFORE the buffers are freed.
- CHECK_RET(devm_add_action_or_reset, &pci->dev, ithc_stop, ithc);
- @@ -452,7 +412,6 @@ static struct pci_driver ithc_driver = {
- .restore = ithc_restore,
- },
- .driver.probe_type = PROBE_PREFER_ASYNCHRONOUS,
- - //.dev_groups = ithc_attribute_groups, // could use this (since 5.14), however the attributes won't have valid values until config has been read anyway
- };
-
- static int __init ithc_init(void)
- diff --git a/drivers/hid/ithc/ithc-quickspi.c b/drivers/hid/ithc/ithc-quickspi.c
- index 760e55ead078..e2d1690b8cf8 100644
- --- a/drivers/hid/ithc/ithc-quickspi.c
- +++ b/drivers/hid/ithc/ithc-quickspi.c
- @@ -257,6 +257,14 @@ void ithc_print_acpi_config(struct ithc *ithc, const struct ithc_acpi_config *cf
- spi_frequency, limit_packet_size, tx_delay, active_ltr, idle_ltr);
- }
-
- +static void set_opcode(struct ithc *ithc, size_t i, u8 opcode)
- +{
- + writeb(opcode, &ithc->regs->opcode[i].header);
- + writeb(opcode, &ithc->regs->opcode[i].single);
- + writeb(opcode, &ithc->regs->opcode[i].dual);
- + writeb(opcode, &ithc->regs->opcode[i].quad);
- +}
- +
- static int ithc_quickspi_init_regs(struct ithc *ithc, const struct ithc_acpi_config *cfg)
- {
- pci_dbg(ithc->pci, "initializing QuickSPI registers\n");
- @@ -279,26 +287,47 @@ static int ithc_quickspi_init_regs(struct ithc *ithc, const struct ithc_acpi_con
- // SPI addresses and opcodes
- if (cfg->has_input_report_header_address)
- writel(cfg->input_report_header_address, &ithc->regs->spi_header_addr);
- - if (cfg->has_input_report_body_address)
- + if (cfg->has_input_report_body_address) {
- writel(cfg->input_report_body_address, &ithc->regs->dma_rx[0].spi_addr);
- + writel(cfg->input_report_body_address, &ithc->regs->dma_rx[1].spi_addr);
- + }
- if (cfg->has_output_report_body_address)
- writel(cfg->output_report_body_address, &ithc->regs->dma_tx.spi_addr);
-
- - if (cfg->has_read_opcode) {
- - writeb(cfg->read_opcode, &ithc->regs->read_opcode);
- - writeb(cfg->read_opcode, &ithc->regs->read_opcode_single);
- - writeb(cfg->read_opcode, &ithc->regs->read_opcode_dual);
- - writeb(cfg->read_opcode, &ithc->regs->read_opcode_quad);
- - }
- - if (cfg->has_write_opcode) {
- - writeb(cfg->write_opcode, &ithc->regs->write_opcode);
- - writeb(cfg->write_opcode, &ithc->regs->write_opcode_single);
- - writeb(cfg->write_opcode, &ithc->regs->write_opcode_dual);
- - writeb(cfg->write_opcode, &ithc->regs->write_opcode_quad);
- + switch (ithc->pci->device) {
- + // LKF/TGL don't support QuickSPI.
- + // For ADL, opcode layout is RX/TX/unused.
- + case PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT1:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_S_PORT2:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT1:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_P_PORT2:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT1:
- + case PCI_DEVICE_ID_INTEL_THC_ADL_M_PORT2:
- + if (cfg->has_read_opcode) {
- + set_opcode(ithc, 0, cfg->read_opcode);
- + }
- + if (cfg->has_write_opcode) {
- + set_opcode(ithc, 1, cfg->write_opcode);
- + }
- + break;
- + // For MTL, opcode layout was changed to RX/RX/TX.
- + // (RPL layout is unknown.)
- + default:
- + if (cfg->has_read_opcode) {
- + set_opcode(ithc, 0, cfg->read_opcode);
- + set_opcode(ithc, 1, cfg->read_opcode);
- + }
- + if (cfg->has_write_opcode) {
- + set_opcode(ithc, 2, cfg->write_opcode);
- + }
- + break;
- }
- +
- ithc_log_regs(ithc);
-
- // The rest...
- + bitsl_set(&ithc->regs->dma_rx[0].init_unknown, INIT_UNKNOWN_31);
- +
- bitsl(&ithc->regs->quickspi_config1,
- QUICKSPI_CONFIG1_UNKNOWN_0(0xff) | QUICKSPI_CONFIG1_UNKNOWN_5(0xff) |
- QUICKSPI_CONFIG1_UNKNOWN_10(0xff) | QUICKSPI_CONFIG1_UNKNOWN_16(0xffff),
- diff --git a/drivers/hid/ithc/ithc-regs.h b/drivers/hid/ithc/ithc-regs.h
- index a9d236454644..4f541fe533fa 100644
- --- a/drivers/hid/ithc/ithc-regs.h
- +++ b/drivers/hid/ithc/ithc-regs.h
- @@ -129,15 +129,12 @@ struct ithc_registers {
- /* 1008 */ u32 control_bits;
- /* 100c */ u32 _unknown_100c;
- /* 1010 */ u32 spi_config;
- - /* 1014 */ u8 read_opcode; // maybe for header?
- - /* 1015 */ u8 read_opcode_quad;
- - /* 1016 */ u8 read_opcode_dual;
- - /* 1017 */ u8 read_opcode_single;
- - /* 1018 */ u8 write_opcode; // not used?
- - /* 1019 */ u8 write_opcode_quad;
- - /* 101a */ u8 write_opcode_dual;
- - /* 101b */ u8 write_opcode_single;
- - /* 101c */ u32 _unknown_101c;
- + struct {
- + /* 1014/1018/101c */ u8 header;
- + /* 1015/1019/101d */ u8 quad;
- + /* 1016/101a/101e */ u8 dual;
- + /* 1017/101b/101f */ u8 single;
- + } opcode[3];
- /* 1020 */ u32 error_control;
- /* 1024 */ u32 error_status; // write to clear
- /* 1028 */ u32 error_flags; // write to clear
- diff --git a/drivers/hid/ithc/ithc.h b/drivers/hid/ithc/ithc.h
- index e90c38044432..aec320d4e945 100644
- --- a/drivers/hid/ithc/ithc.h
- +++ b/drivers/hid/ithc/ithc.h
- @@ -14,6 +14,8 @@
- #include <linux/module.h>
- #include <linux/pci.h>
- #include <linux/poll.h>
- +#include <linux/timer.h>
- +#include <linux/vmalloc.h>
-
- #define DEVNAME "ithc"
- #define DEVFULLNAME "Intel Touch Host Controller"
- @@ -46,8 +48,10 @@
- #define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT1 0x7a58
- #define PCI_DEVICE_ID_INTEL_THC_RPL_S_PORT2 0x7a59
- // Meteor Lake
- -#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT1 0x7e48
- -#define PCI_DEVICE_ID_INTEL_THC_MTL_PORT2 0x7e4a
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_S_PORT1 0x7f59
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_S_PORT2 0x7f5b
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_MP_PORT1 0x7e49
- +#define PCI_DEVICE_ID_INTEL_THC_MTL_MP_PORT2 0x7e4b
-
- struct ithc;
-
- @@ -63,6 +67,7 @@ struct ithc {
- struct pci_dev *pci;
- int irq;
- struct task_struct *poll_thread;
- + struct timer_list idle_timer;
-
- struct ithc_registers __iomem *regs;
- struct ithc_registers *prev_regs; // for debugging
- --
- 2.45.2
|