123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931 |
- From 095746ff0ecad3ef1ff67e444ef10d4ac36cf8f8 Mon Sep 17 00:00:00 2001
- From: Maximilian Luz <luzmaximilian@gmail.com>
- Date: Fri, 6 Dec 2019 11:56:12 +0100
- Subject: [PATCH 2/4] surface-sam
- ---
- drivers/platform/x86/Kconfig | 2 +
- drivers/platform/x86/Makefile | 1 +
- drivers/platform/x86/surface_sam/Kconfig | 176 +
- drivers/platform/x86/surface_sam/Makefile | 15 +
- .../x86/surface_sam/surface_sam_dtx.c | 590 ++
- .../x86/surface_sam/surface_sam_hps.c | 1297 +++++
- .../x86/surface_sam/surface_sam_san.c | 913 +++
- .../x86/surface_sam/surface_sam_san.h | 30 +
- .../x86/surface_sam/surface_sam_sid.c | 281 +
- .../x86/surface_sam/surface_sam_sid_gpelid.c | 232 +
- .../surface_sam/surface_sam_sid_perfmode.c | 216 +
- .../x86/surface_sam/surface_sam_sid_power.c | 1154 ++++
- .../x86/surface_sam/surface_sam_sid_power.h | 15 +
- .../x86/surface_sam/surface_sam_sid_vhf.c | 432 ++
- .../x86/surface_sam/surface_sam_sid_vhf.h | 13 +
- .../x86/surface_sam/surface_sam_ssh.c | 5111 +++++++++++++++++
- .../x86/surface_sam/surface_sam_ssh.h | 488 ++
- .../x86/surface_sam/surface_sam_ssh_trace.h | 536 ++
- .../x86/surface_sam/surface_sam_vhf.c | 261 +
- 19 files changed, 11763 insertions(+)
- create mode 100644 drivers/platform/x86/surface_sam/Kconfig
- create mode 100644 drivers/platform/x86/surface_sam/Makefile
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_dtx.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_hps.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_san.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_san.h
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid_gpelid.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid_perfmode.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid_power.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid_power.h
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid_vhf.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_sid_vhf.h
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_ssh.c
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_ssh.h
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_ssh_trace.h
- create mode 100644 drivers/platform/x86/surface_sam/surface_sam_vhf.c
- diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
- index 0ad7ad8cf8e1..5d1766294eca 100644
- --- a/drivers/platform/x86/Kconfig
- +++ b/drivers/platform/x86/Kconfig
- @@ -1350,6 +1350,8 @@ config INTEL_SCU_IPC
- some embedded Intel x86 platforms. This is not needed for PC-type
- machines.
-
- +source "drivers/platform/x86/surface_sam/Kconfig"
- +
- config INTEL_SCU_IPC_UTIL
- tristate "Intel SCU IPC utility driver"
- depends on INTEL_SCU_IPC
- diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
- index 53408d965874..b3f4305f73c5 100644
- --- a/drivers/platform/x86/Makefile
- +++ b/drivers/platform/x86/Makefile
- @@ -146,3 +146,4 @@ obj-$(CONFIG_INTEL_TELEMETRY) += intel_telemetry_core.o \
- intel_telemetry_pltdrv.o \
- intel_telemetry_debugfs.o
- obj-$(CONFIG_PMC_ATOM) += pmc_atom.o
- +obj-$(CONFIG_SURFACE_SAM) += surface_sam/
- diff --git a/drivers/platform/x86/surface_sam/Kconfig b/drivers/platform/x86/surface_sam/Kconfig
- new file mode 100644
- index 000000000000..7781c5cd932c
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/Kconfig
- @@ -0,0 +1,176 @@
- +menuconfig SURFACE_SAM
- + depends on ACPI
- + tristate "Microsoft Surface/System Aggregator Module and Platform Drivers"
- + help
- + Drivers for the Surface/System Aggregator Module (SAM) of Microsoft
- + Surface devices.
- +
- + SAM is an embedded controller that provides access to various
- + functionalities on these devices, including battery status, keyboard
- + events (on the Laptops) and many more.
- +
- + Say M/Y here if you have a Microsoft Surface device with a SAM device
- + (i.e. 5th generation or later).
- +
- +config SURFACE_SAM_SSH
- + tristate "Surface Serial Hub Driver"
- + depends on SURFACE_SAM
- + depends on SERIAL_DEV_CTRL_TTYPORT
- + select CRC_CCITT
- + default m
- + help
- + Surface Serial Hub driver for 5th generation (or later) Microsoft
- + Surface devices.
- +
- + This is the base driver for the embedded serial controller found on
- + 5th generation (and later) Microsoft Surface devices (e.g. Book 2,
- + Laptop, Laptop 2, Pro 2017, Pro 6, ...). This driver itself only
- + provides access to the embedded controller (SAM) and subsequent
- + drivers are required for the respective functionalities.
- +
- + If you have a 5th generation (or later) Microsoft Surface device, say
- + Y or M here.
- +
- +config SURFACE_SAM_SSH_DEBUG_DEVICE
- + bool "Surface Serial Hub Debug Device"
- + depends on SURFACE_SAM_SSH
- + depends on SYSFS
- + default n
- + help
- + Debug device for direct communication with the embedded controller
- + found on 5th generation (and later) Microsoft Surface devices (e.g.
- + Book 2, Laptop, Laptop 2, Pro 2017, Pro 6, ...) via sysfs.
- +
- + If you are not sure, say N here.
- +
- +config SURFACE_SAM_SSH_ERROR_INJECTION
- + bool "Surface Serial Hub Error Injection Capabilities"
- + depends on SURFACE_SAM_SSH
- + depends on FUNCTION_ERROR_INJECTION
- + default n
- + help
- + Enable error injection capabilities for the Surface Serial Hub.
- + This is used to debug the driver, specifically the communication
- + interface. It is not required for normal use.
- +
- + If you are not sure, say N here.
- +
- +config SURFACE_SAM_SAN
- + tristate "Surface ACPI Notify Driver"
- + depends on SURFACE_SAM_SSH
- + default m
- + help
- + Surface ACPI Notify driver for 5th generation (or later) Microsoft
- + Surface devices.
- +
- + This driver enables basic ACPI events and requests, such as battery
- + status requests/events, thermal events, lid status, and possibly more,
- + which would otherwise not work on these devices.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_VHF
- + tristate "Surface Virtual HID Framework Driver"
- + depends on SURFACE_SAM_SSH
- + depends on HID
- + default m
- + help
- + Surface Virtual HID Framework driver for 5th generation (or later)
- + Microsoft Surface devices.
- +
- + This driver provides support for the Microsoft Virtual HID framework,
- + which is required for keyboard support on the Surface Laptop 1 and 2.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_DTX
- + tristate "Surface Detachment System (DTX) Driver"
- + depends on SURFACE_SAM_SSH
- + depends on INPUT
- + default m
- + help
- + Surface Detachment System (DTX) driver for the Microsoft Surface Book
- + 2. This driver provides support for proper detachment handling in
- + user-space, status-events relating to the base and support for
- + the safe-guard keeping the base attached when the discrete GPU
- + contained in it is running via the special /dev/surface-dtx device.
- +
- + Also provides a standard input device to provide SW_TABLET_MODE events
- + upon device mode change.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_HPS
- + tristate "Surface dGPU Hot-Plug System (dGPU-HPS) Driver"
- + depends on SURFACE_SAM_SSH
- + depends on SURFACE_SAM_SAN
- + depends on GPIO_SYSFS
- + default m
- + help
- + Driver to properly handle hot-plugging and explicit power-on/power-off
- + of the discrete GPU (dGPU) on the Surface Book 2 and 3.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_SID
- + tristate "Surface Platform Integration Driver"
- + depends on SURFACE_SAM_SSH
- + default m
- + help
- + Surface Platform Integration Driver for the Microsoft Surface Devices.
- + This driver loads various model-specific sub-drivers, including
- + battery and keyboard support on 7th generation Surface devices, proper
- + lid setup to enable device wakeup when the lid is opened on multiple
- + models, as well as performance mode setting support on the Surface
- + Book 2.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_SID_GPELID
- + tristate "Surface Lid Wakeup Driver"
- + depends on SURFACE_SAM_SID
- + default m
- + help
- + Driver to set up device wake-up via lid on Intel-based Microsoft
- + Surface devices. These devices do not wake up from sleep as their GPE
- + interrupt is not configured automatically. This driver solves that
- + problem.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_SID_PERFMODE
- + tristate "Surface Performance Mode Driver"
- + depends on SURFACE_SAM_SID
- + depends on SYSFS
- + default m
- + help
- + This driver provides support for setting performance-modes on Surface
- + devices via the perf_mode sysfs attribute. Currently only supports the
- + Surface Book 2. Performance-modes directly influence the fan-profile
- + of the device, allowing to choose between higher performance or
- + quieter operation.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_SID_VHF
- + tristate "Surface SAM HID Driver"
- + depends on SURFACE_SAM_SID
- + depends on HID
- + default m
- + help
- + This driver provides support for HID devices connected via the Surface
- + SAM embedded controller. It provides support for keyboard and touchpad
- + on the Surface Laptop 3 models.
- +
- + If you are not sure, say M here.
- +
- +config SURFACE_SAM_SID_POWER
- + tristate "Surface SAM Battery/AC Driver"
- + depends on SURFACE_SAM_SID
- + select POWER_SUPPLY
- + default m
- + help
- + This driver provides support for the battery and AC on 7th generation
- + Surface devices.
- +
- + If you are not sure, say M here.
- diff --git a/drivers/platform/x86/surface_sam/Makefile b/drivers/platform/x86/surface_sam/Makefile
- new file mode 100644
- index 000000000000..1a5c1260639d
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/Makefile
- @@ -0,0 +1,15 @@
- +# SPDX-License-Identifier: GPL-2.0-or-later
- +
- +# For include/trace/define_trace.h to include surface_sam_ssh_trace.h
- +CFLAGS_surface_sam_ssh.o = -I$(src)
- +
- +obj-$(CONFIG_SURFACE_SAM_SSH) += surface_sam_ssh.o
- +obj-$(CONFIG_SURFACE_SAM_SAN) += surface_sam_san.o
- +obj-$(CONFIG_SURFACE_SAM_DTX) += surface_sam_dtx.o
- +obj-$(CONFIG_SURFACE_SAM_HPS) += surface_sam_hps.o
- +obj-$(CONFIG_SURFACE_SAM_VHF) += surface_sam_vhf.o
- +obj-$(CONFIG_SURFACE_SAM_SID) += surface_sam_sid.o
- +obj-$(CONFIG_SURFACE_SAM_SID_GPELID) += surface_sam_sid_gpelid.o
- +obj-$(CONFIG_SURFACE_SAM_SID_PERFMODE) += surface_sam_sid_perfmode.o
- +obj-$(CONFIG_SURFACE_SAM_SID_POWER) += surface_sam_sid_power.o
- +obj-$(CONFIG_SURFACE_SAM_SID_VHF) += surface_sam_sid_vhf.o
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_dtx.c b/drivers/platform/x86/surface_sam/surface_sam_dtx.c
- new file mode 100644
- index 000000000000..88dba7bced3a
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_dtx.c
- @@ -0,0 +1,590 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Detachment system (DTX) driver for Microsoft Surface Book 2.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/delay.h>
- +#include <linux/fs.h>
- +#include <linux/input.h>
- +#include <linux/ioctl.h>
- +#include <linux/kernel.h>
- +#include <linux/miscdevice.h>
- +#include <linux/module.h>
- +#include <linux/poll.h>
- +#include <linux/rculist.h>
- +#include <linux/slab.h>
- +#include <linux/spinlock.h>
- +#include <linux/platform_device.h>
- +
- +#include "surface_sam_ssh.h"
- +
- +
- +#define USB_VENDOR_ID_MICROSOFT 0x045e
- +#define USB_DEVICE_ID_MS_SURFACE_BASE_2_INTEGRATION 0x0922
- +
- +// name copied from MS device manager
- +#define DTX_INPUT_NAME "Microsoft Surface Base 2 Integration Device"
- +
- +
- +#define DTX_CMD_LATCH_LOCK _IO(0x11, 0x01)
- +#define DTX_CMD_LATCH_UNLOCK _IO(0x11, 0x02)
- +#define DTX_CMD_LATCH_REQUEST _IO(0x11, 0x03)
- +#define DTX_CMD_LATCH_OPEN _IO(0x11, 0x04)
- +#define DTX_CMD_GET_OPMODE _IOR(0x11, 0x05, int)
- +
- +#define SAM_RQST_DTX_TC 0x11
- +#define SAM_RQST_DTX_CID_LATCH_LOCK 0x06
- +#define SAM_RQST_DTX_CID_LATCH_UNLOCK 0x07
- +#define SAM_RQST_DTX_CID_LATCH_REQUEST 0x08
- +#define SAM_RQST_DTX_CID_LATCH_OPEN 0x09
- +#define SAM_RQST_DTX_CID_GET_OPMODE 0x0D
- +
- +#define SAM_EVENT_DTX_CID_CONNECTION 0x0c
- +#define SAM_EVENT_DTX_CID_BUTTON 0x0e
- +#define SAM_EVENT_DTX_CID_ERROR 0x0f
- +#define SAM_EVENT_DTX_CID_LATCH_STATUS 0x11
- +
- +#define DTX_OPMODE_TABLET 0x00
- +#define DTX_OPMODE_LAPTOP 0x01
- +#define DTX_OPMODE_STUDIO 0x02
- +
- +#define DTX_LATCH_CLOSED 0x00
- +#define DTX_LATCH_OPENED 0x01
- +
- +
- +// Warning: This must always be a power of 2!
- +#define DTX_CLIENT_BUF_SIZE 16
- +
- +#define DTX_CONNECT_OPMODE_DELAY 1000
- +
- +#define DTX_ERR KERN_ERR "surface_sam_dtx: "
- +#define DTX_WARN KERN_WARNING "surface_sam_dtx: "
- +
- +
- +struct surface_dtx_event {
- + u8 type;
- + u8 code;
- + u8 arg0;
- + u8 arg1;
- +} __packed;
- +
- +struct surface_dtx_dev {
- + struct ssam_event_notifier notif;
- + struct delayed_work opmode_work;
- + wait_queue_head_t waitq;
- + struct miscdevice mdev;
- + spinlock_t client_lock;
- + struct list_head client_list;
- + struct mutex mutex;
- + bool active;
- + spinlock_t input_lock;
- + struct input_dev *input_dev;
- +};
- +
- +struct surface_dtx_client {
- + struct list_head node;
- + struct surface_dtx_dev *ddev;
- + struct fasync_struct *fasync;
- + spinlock_t buffer_lock;
- + unsigned int buffer_head;
- + unsigned int buffer_tail;
- + struct surface_dtx_event buffer[DTX_CLIENT_BUF_SIZE];
- +};
- +
- +
- +static struct surface_dtx_dev surface_dtx_dev;
- +
- +
- +static int surface_sam_query_opmpde(void)
- +{
- + u8 result_buf[1];
- + int status;
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = SAM_RQST_DTX_TC,
- + .cid = SAM_RQST_DTX_CID_GET_OPMODE,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + .cap = 1,
- + .len = 0,
- + .data = result_buf,
- + };
- +
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status)
- + return status;
- +
- + if (result.len != 1)
- + return -EFAULT;
- +
- + return result.data[0];
- +}
- +
- +
- +static int dtx_cmd_simple(u8 cid)
- +{
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = SAM_RQST_DTX_TC,
- + .cid = cid,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x00,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + return surface_sam_ssh_rqst(&rqst, NULL);
- +}
- +
- +static int dtx_cmd_get_opmode(int __user *buf)
- +{
- + int opmode;
- +
- + opmode = surface_sam_query_opmpde();
- + if (opmode < 0)
- + return opmode;
- +
- + if (put_user(opmode, buf))
- + return -EACCES;
- +
- + return 0;
- +}
- +
- +
- +static int surface_dtx_open(struct inode *inode, struct file *file)
- +{
- + struct surface_dtx_dev *ddev = container_of(file->private_data, struct surface_dtx_dev, mdev);
- + struct surface_dtx_client *client;
- +
- + // initialize client
- + client = kzalloc(sizeof(struct surface_dtx_client), GFP_KERNEL);
- + if (!client)
- + return -ENOMEM;
- +
- + spin_lock_init(&client->buffer_lock);
- + client->buffer_head = 0;
- + client->buffer_tail = 0;
- + client->ddev = ddev;
- +
- + // attach client
- + spin_lock(&ddev->client_lock);
- + list_add_tail_rcu(&client->node, &ddev->client_list);
- + spin_unlock(&ddev->client_lock);
- +
- + file->private_data = client;
- + nonseekable_open(inode, file);
- +
- + return 0;
- +}
- +
- +static int surface_dtx_release(struct inode *inode, struct file *file)
- +{
- + struct surface_dtx_client *client = file->private_data;
- +
- + // detach client
- + spin_lock(&client->ddev->client_lock);
- + list_del_rcu(&client->node);
- + spin_unlock(&client->ddev->client_lock);
- + synchronize_rcu();
- +
- + kfree(client);
- + file->private_data = NULL;
- +
- + return 0;
- +}
- +
- +static ssize_t surface_dtx_read(struct file *file, char __user *buf, size_t count, loff_t *offs)
- +{
- + struct surface_dtx_client *client = file->private_data;
- + struct surface_dtx_dev *ddev = client->ddev;
- + struct surface_dtx_event event;
- + size_t read = 0;
- + int status = 0;
- +
- + if (count != 0 && count < sizeof(struct surface_dtx_event))
- + return -EINVAL;
- +
- + if (!ddev->active)
- + return -ENODEV;
- +
- + // check availability
- + if (client->buffer_head == client->buffer_tail) {
- + if (file->f_flags & O_NONBLOCK)
- + return -EAGAIN;
- +
- + status = wait_event_interruptible(ddev->waitq,
- + client->buffer_head != client->buffer_tail ||
- + !ddev->active);
- + if (status)
- + return status;
- +
- + if (!ddev->active)
- + return -ENODEV;
- + }
- +
- + // copy events one by one
- + while (read + sizeof(struct surface_dtx_event) <= count) {
- + spin_lock_irq(&client->buffer_lock);
- +
- + if (client->buffer_head == client->buffer_tail) {
- + spin_unlock_irq(&client->buffer_lock);
- + break;
- + }
- +
- + // get one event
- + event = client->buffer[client->buffer_tail];
- + client->buffer_tail = (client->buffer_tail + 1) & (DTX_CLIENT_BUF_SIZE - 1);
- + spin_unlock_irq(&client->buffer_lock);
- +
- + // copy to userspace
- + if (copy_to_user(buf, &event, sizeof(struct surface_dtx_event)))
- + return -EFAULT;
- +
- + read += sizeof(struct surface_dtx_event);
- + }
- +
- + return read;
- +}
- +
- +static __poll_t surface_dtx_poll(struct file *file, struct poll_table_struct *pt)
- +{
- + struct surface_dtx_client *client = file->private_data;
- + int mask;
- +
- + poll_wait(file, &client->ddev->waitq, pt);
- +
- + if (client->ddev->active)
- + mask = EPOLLOUT | EPOLLWRNORM;
- + else
- + mask = EPOLLHUP | EPOLLERR;
- +
- + if (client->buffer_head != client->buffer_tail)
- + mask |= EPOLLIN | EPOLLRDNORM;
- +
- + return mask;
- +}
- +
- +static int surface_dtx_fasync(int fd, struct file *file, int on)
- +{
- + struct surface_dtx_client *client = file->private_data;
- +
- + return fasync_helper(fd, file, on, &client->fasync);
- +}
- +
- +static long surface_dtx_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
- +{
- + struct surface_dtx_client *client = file->private_data;
- + struct surface_dtx_dev *ddev = client->ddev;
- + int status;
- +
- + status = mutex_lock_interruptible(&ddev->mutex);
- + if (status)
- + return status;
- +
- + if (!ddev->active) {
- + mutex_unlock(&ddev->mutex);
- + return -ENODEV;
- + }
- +
- + switch (cmd) {
- + case DTX_CMD_LATCH_LOCK:
- + status = dtx_cmd_simple(SAM_RQST_DTX_CID_LATCH_LOCK);
- + break;
- +
- + case DTX_CMD_LATCH_UNLOCK:
- + status = dtx_cmd_simple(SAM_RQST_DTX_CID_LATCH_UNLOCK);
- + break;
- +
- + case DTX_CMD_LATCH_REQUEST:
- + status = dtx_cmd_simple(SAM_RQST_DTX_CID_LATCH_REQUEST);
- + break;
- +
- + case DTX_CMD_LATCH_OPEN:
- + status = dtx_cmd_simple(SAM_RQST_DTX_CID_LATCH_OPEN);
- + break;
- +
- + case DTX_CMD_GET_OPMODE:
- + status = dtx_cmd_get_opmode((int __user *)arg);
- + break;
- +
- + default:
- + status = -EINVAL;
- + break;
- + }
- +
- + mutex_unlock(&ddev->mutex);
- + return status;
- +}
- +
- +static const struct file_operations surface_dtx_fops = {
- + .owner = THIS_MODULE,
- + .open = surface_dtx_open,
- + .release = surface_dtx_release,
- + .read = surface_dtx_read,
- + .poll = surface_dtx_poll,
- + .fasync = surface_dtx_fasync,
- + .unlocked_ioctl = surface_dtx_ioctl,
- + .llseek = no_llseek,
- +};
- +
- +static struct surface_dtx_dev surface_dtx_dev = {
- + .mdev = {
- + .minor = MISC_DYNAMIC_MINOR,
- + .name = "surface_dtx",
- + .fops = &surface_dtx_fops,
- + },
- + .client_lock = __SPIN_LOCK_UNLOCKED(),
- + .input_lock = __SPIN_LOCK_UNLOCKED(),
- + .mutex = __MUTEX_INITIALIZER(surface_dtx_dev.mutex),
- + .active = false,
- +};
- +
- +
- +static void surface_dtx_push_event(struct surface_dtx_dev *ddev, struct surface_dtx_event *event)
- +{
- + struct surface_dtx_client *client;
- +
- + rcu_read_lock();
- + list_for_each_entry_rcu(client, &ddev->client_list, node) {
- + spin_lock(&client->buffer_lock);
- +
- + client->buffer[client->buffer_head++] = *event;
- + client->buffer_head &= DTX_CLIENT_BUF_SIZE - 1;
- +
- + if (unlikely(client->buffer_head == client->buffer_tail)) {
- + printk(DTX_WARN "event buffer overrun\n");
- + client->buffer_tail = (client->buffer_tail + 1) & (DTX_CLIENT_BUF_SIZE - 1);
- + }
- +
- + spin_unlock(&client->buffer_lock);
- +
- + kill_fasync(&client->fasync, SIGIO, POLL_IN);
- + }
- + rcu_read_unlock();
- +
- + wake_up_interruptible(&ddev->waitq);
- +}
- +
- +
- +static void surface_dtx_update_opmpde(struct surface_dtx_dev *ddev)
- +{
- + struct surface_dtx_event event;
- + int opmode;
- +
- + // get operation mode
- + opmode = surface_sam_query_opmpde();
- + if (opmode < 0)
- + printk(DTX_ERR "EC request failed with error %d\n", opmode);
- +
- + // send DTX event
- + event.type = 0x11;
- + event.code = 0x0D;
- + event.arg0 = opmode;
- + event.arg1 = 0x00;
- +
- + surface_dtx_push_event(ddev, &event);
- +
- + // send SW_TABLET_MODE event
- + spin_lock(&ddev->input_lock);
- + input_report_switch(ddev->input_dev, SW_TABLET_MODE, opmode != DTX_OPMODE_LAPTOP);
- + input_sync(ddev->input_dev);
- + spin_unlock(&ddev->input_lock);
- +}
- +
- +static void surface_dtx_opmode_workfn(struct work_struct *work)
- +{
- + struct surface_dtx_dev *ddev = container_of(work, struct surface_dtx_dev, opmode_work.work);
- +
- + surface_dtx_update_opmpde(ddev);
- +}
- +
- +static u32 surface_dtx_notification(struct ssam_notifier_block *nb, const struct ssam_event *in_event)
- +{
- + struct surface_dtx_dev *ddev = container_of(nb, struct surface_dtx_dev, notif.base);
- + struct surface_dtx_event event;
- + unsigned long delay;
- +
- + switch (in_event->command_id) {
- + case SAM_EVENT_DTX_CID_CONNECTION:
- + case SAM_EVENT_DTX_CID_BUTTON:
- + case SAM_EVENT_DTX_CID_ERROR:
- + case SAM_EVENT_DTX_CID_LATCH_STATUS:
- + if (in_event->length > 2) {
- + printk(DTX_ERR "unexpected payload size (cid: %x, len: %u)\n",
- + in_event->command_id, in_event->length);
- + return SSAM_NOTIF_HANDLED;
- + }
- +
- + event.type = in_event->target_category;
- + event.code = in_event->command_id;
- + event.arg0 = in_event->length >= 1 ? in_event->data[0] : 0x00;
- + event.arg1 = in_event->length >= 2 ? in_event->data[1] : 0x00;
- + surface_dtx_push_event(ddev, &event);
- + break;
- +
- + default:
- + return 0;
- + }
- +
- + // update device mode
- + if (in_event->command_id == SAM_EVENT_DTX_CID_CONNECTION) {
- + delay = event.arg0 ? DTX_CONNECT_OPMODE_DELAY : 0;
- + schedule_delayed_work(&ddev->opmode_work, delay);
- + }
- +
- + return SSAM_NOTIF_HANDLED;
- +}
- +
- +
- +static struct input_dev *surface_dtx_register_inputdev(struct platform_device *pdev)
- +{
- + struct input_dev *input_dev;
- + int status;
- +
- + input_dev = input_allocate_device();
- + if (!input_dev)
- + return ERR_PTR(-ENOMEM);
- +
- + input_dev->name = DTX_INPUT_NAME;
- + input_dev->dev.parent = &pdev->dev;
- + input_dev->id.bustype = BUS_VIRTUAL;
- + input_dev->id.vendor = USB_VENDOR_ID_MICROSOFT;
- + input_dev->id.product = USB_DEVICE_ID_MS_SURFACE_BASE_2_INTEGRATION;
- +
- + input_set_capability(input_dev, EV_SW, SW_TABLET_MODE);
- +
- + status = surface_sam_query_opmpde();
- + if (status < 0) {
- + input_free_device(input_dev);
- + return ERR_PTR(status);
- + }
- +
- + input_report_switch(input_dev, SW_TABLET_MODE, status != DTX_OPMODE_LAPTOP);
- +
- + status = input_register_device(input_dev);
- + if (status) {
- + input_unregister_device(input_dev);
- + return ERR_PTR(status);
- + }
- +
- + return input_dev;
- +}
- +
- +
- +static int surface_sam_dtx_probe(struct platform_device *pdev)
- +{
- + struct surface_dtx_dev *ddev = &surface_dtx_dev;
- + struct input_dev *input_dev;
- + int status;
- +
- + // link to ec
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + input_dev = surface_dtx_register_inputdev(pdev);
- + if (IS_ERR(input_dev))
- + return PTR_ERR(input_dev);
- +
- + // initialize device
- + mutex_lock(&ddev->mutex);
- + if (ddev->active) {
- + mutex_unlock(&ddev->mutex);
- + status = -ENODEV;
- + goto err_register;
- + }
- +
- + INIT_DELAYED_WORK(&ddev->opmode_work, surface_dtx_opmode_workfn);
- + INIT_LIST_HEAD(&ddev->client_list);
- + init_waitqueue_head(&ddev->waitq);
- + ddev->active = true;
- + ddev->input_dev = input_dev;
- + mutex_unlock(&ddev->mutex);
- +
- + status = misc_register(&ddev->mdev);
- + if (status)
- + goto err_register;
- +
- + // set up events
- + ddev->notif.base.priority = 1;
- + ddev->notif.base.fn = surface_dtx_notification;
- + ddev->notif.event.reg = SSAM_EVENT_REGISTRY_SAM;
- + ddev->notif.event.id.target_category = SSAM_SSH_TC_BAS;
- + ddev->notif.event.id.instance = 0;
- + ddev->notif.event.flags = SSAM_EVENT_SEQUENCED;
- +
- + status = surface_sam_ssh_notifier_register(&ddev->notif);
- + if (status)
- + goto err_events_setup;
- +
- + return 0;
- +
- +err_events_setup:
- + misc_deregister(&ddev->mdev);
- +err_register:
- + input_unregister_device(ddev->input_dev);
- + return status;
- +}
- +
- +static int surface_sam_dtx_remove(struct platform_device *pdev)
- +{
- + struct surface_dtx_dev *ddev = &surface_dtx_dev;
- + struct surface_dtx_client *client;
- +
- + mutex_lock(&ddev->mutex);
- + if (!ddev->active) {
- + mutex_unlock(&ddev->mutex);
- + return 0;
- + }
- +
- + // mark as inactive
- + ddev->active = false;
- + mutex_unlock(&ddev->mutex);
- +
- + // After this call we're guaranteed that no more input events will arive
- + surface_sam_ssh_notifier_unregister(&ddev->notif);
- +
- + // wake up clients
- + spin_lock(&ddev->client_lock);
- + list_for_each_entry(client, &ddev->client_list, node) {
- + kill_fasync(&client->fasync, SIGIO, POLL_HUP);
- + }
- + spin_unlock(&ddev->client_lock);
- +
- + wake_up_interruptible(&ddev->waitq);
- +
- + // unregister user-space devices
- + input_unregister_device(ddev->input_dev);
- + misc_deregister(&ddev->mdev);
- +
- + return 0;
- +}
- +
- +
- +static const struct acpi_device_id surface_sam_dtx_match[] = {
- + { "MSHW0133", 0 },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surface_sam_dtx_match);
- +
- +static struct platform_driver surface_sam_dtx = {
- + .probe = surface_sam_dtx_probe,
- + .remove = surface_sam_dtx_remove,
- + .driver = {
- + .name = "surface_sam_dtx",
- + .acpi_match_table = surface_sam_dtx_match,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_dtx);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Detachment System (DTX) Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_hps.c b/drivers/platform/x86/surface_sam/surface_sam_hps.c
- new file mode 100644
- index 000000000000..40f39f29113c
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_hps.c
- @@ -0,0 +1,1297 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface dGPU hot-plug system driver.
- + * Supports explicit setting of the dGPU power-state on the Surface Book 2 and
- + * properly handles hot-plugging by detaching the base.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/delay.h>
- +#include <linux/gpio.h>
- +#include <linux/kernel.h>
- +#include <linux/module.h>
- +#include <linux/mutex.h>
- +#include <linux/pci.h>
- +#include <linux/platform_device.h>
- +#include <linux/sysfs.h>
- +
- +#include "surface_sam_ssh.h"
- +#include "surface_sam_san.h"
- +
- +
- +// TODO: vgaswitcheroo integration
- +
- +
- +static void dbg_dump_drvsta(struct platform_device *pdev, const char *prefix);
- +
- +
- +#define SHPS_DSM_REVISION 1
- +#define SHPS_DSM_GPU_ADDRS 0x02
- +#define SHPS_DSM_GPU_POWER 0x05
- +static const guid_t SHPS_DSM_UUID =
- + GUID_INIT(0x5515a847, 0xed55, 0x4b27, 0x83, 0x52, 0xcd,
- + 0x32, 0x0e, 0x10, 0x36, 0x0a);
- +
- +
- +#define SAM_DGPU_TC 0x13
- +#define SAM_DGPU_CID_POWERON 0x02
- +
- +#define SAM_DTX_TC 0x11
- +#define SAM_DTX_CID_LATCH_LOCK 0x06
- +#define SAM_DTX_CID_LATCH_UNLOCK 0x07
- +#define ACPI_SGCP_NOTIFY_POWER_ON 0x81
- +
- +#define SHPS_DSM_GPU_ADDRS_RP "RP5_PCIE"
- +#define SHPS_DSM_GPU_ADDRS_DGPU "DGPU_PCIE"
- +#define SHPS_PCI_GPU_ADDR_RP "\\_SB.PCI0.RP13._ADR"
- +
- +static const struct acpi_gpio_params gpio_base_presence_int = { 0, 0, false };
- +static const struct acpi_gpio_params gpio_base_presence = { 1, 0, false };
- +static const struct acpi_gpio_params gpio_dgpu_power_int = { 2, 0, false };
- +static const struct acpi_gpio_params gpio_dgpu_power = { 3, 0, false };
- +static const struct acpi_gpio_params gpio_dgpu_presence_int = { 4, 0, false };
- +static const struct acpi_gpio_params gpio_dgpu_presence = { 5, 0, false };
- +
- +static const struct acpi_gpio_mapping shps_acpi_gpios[] = {
- + { "base_presence-int-gpio", &gpio_base_presence_int, 1 },
- + { "base_presence-gpio", &gpio_base_presence, 1 },
- + { "dgpu_power-int-gpio", &gpio_dgpu_power_int, 1 },
- + { "dgpu_power-gpio", &gpio_dgpu_power, 1 },
- + { "dgpu_presence-int-gpio", &gpio_dgpu_presence_int, 1 },
- + { "dgpu_presence-gpio", &gpio_dgpu_presence, 1 },
- + { },
- +};
- +
- +
- +enum shps_dgpu_power {
- + SHPS_DGPU_POWER_OFF = 0,
- + SHPS_DGPU_POWER_ON = 1,
- + SHPS_DGPU_POWER_UNKNOWN = 2,
- +};
- +
- +static const char *shps_dgpu_power_str(enum shps_dgpu_power power)
- +{
- + if (power == SHPS_DGPU_POWER_OFF)
- + return "off";
- + else if (power == SHPS_DGPU_POWER_ON)
- + return "on";
- + else if (power == SHPS_DGPU_POWER_UNKNOWN)
- + return "unknown";
- + else
- + return "<invalid>";
- +}
- +
- +enum shps_notification_method {
- + SHPS_NOTIFICATION_METHOD_SAN = 1,
- + SHPS_NOTIFICATION_METHOD_SGCP = 2
- +};
- +
- +struct shps_hardware_traits {
- + enum shps_notification_method notification_method;
- + const char *dgpu_rp_pci_address;
- +};
- +
- +struct shps_driver_data {
- + struct mutex lock;
- + struct pci_dev *dgpu_root_port;
- + struct pci_saved_state *dgpu_root_port_state;
- + struct gpio_desc *gpio_dgpu_power;
- + struct gpio_desc *gpio_dgpu_presence;
- + struct gpio_desc *gpio_base_presence;
- + unsigned int irq_dgpu_presence;
- + unsigned int irq_base_presence;
- + unsigned long state;
- + acpi_handle sgpc_handle;
- + struct shps_hardware_traits hardware_traits;
- +};
- +
- +struct shps_hardware_probe {
- + const char *hardware_id;
- + int generation;
- + struct shps_hardware_traits *hardware_traits;
- +};
- +
- +static struct shps_hardware_traits shps_gen1_hwtraits = {
- + .notification_method = SHPS_NOTIFICATION_METHOD_SAN
- +};
- +
- +static struct shps_hardware_traits shps_gen2_hwtraits = {
- + .notification_method = SHPS_NOTIFICATION_METHOD_SGCP,
- + .dgpu_rp_pci_address = SHPS_PCI_GPU_ADDR_RP
- +};
- +
- +static const struct shps_hardware_probe shps_hardware_probe_match[] = {
- + /* Surface Book 3 */
- + { "MSHW0117", 2, &shps_gen2_hwtraits },
- +
- + /* Surface Book 2 (default, must be last entry) */
- + { NULL, 1, &shps_gen1_hwtraits }
- +};
- +
- +#define SHPS_STATE_BIT_PWRTGT 0 /* desired power state: 1 for on, 0 for off */
- +#define SHPS_STATE_BIT_RPPWRON_SYNC 1 /* synchronous/requested power-up in progress */
- +#define SHPS_STATE_BIT_WAKE_ENABLED 2 /* wakeup via base-presence GPIO enabled */
- +
- +
- +#define SHPS_DGPU_PARAM_PERM 0644
- +
- +enum shps_dgpu_power_mp {
- + SHPS_DGPU_MP_POWER_OFF = SHPS_DGPU_POWER_OFF,
- + SHPS_DGPU_MP_POWER_ON = SHPS_DGPU_POWER_ON,
- + SHPS_DGPU_MP_POWER_ASIS = -1,
- +
- + __SHPS_DGPU_MP_POWER_START = -1,
- + __SHPS_DGPU_MP_POWER_END = 1,
- +};
- +
- +static int param_dgpu_power_set(const char *val, const struct kernel_param *kp)
- +{
- + int power = SHPS_DGPU_MP_POWER_OFF;
- + int status;
- +
- + status = kstrtoint(val, 0, &power);
- + if (status)
- + return status;
- +
- + if (power < __SHPS_DGPU_MP_POWER_START || power > __SHPS_DGPU_MP_POWER_END)
- + return -EINVAL;
- +
- + return param_set_int(val, kp);
- +}
- +
- +static const struct kernel_param_ops param_dgpu_power_ops = {
- + .set = param_dgpu_power_set,
- + .get = param_get_int,
- +};
- +
- +static int param_dgpu_power_init = SHPS_DGPU_MP_POWER_OFF;
- +static int param_dgpu_power_exit = SHPS_DGPU_MP_POWER_ON;
- +static int param_dgpu_power_susp = SHPS_DGPU_MP_POWER_ASIS;
- +static bool param_dtx_latch = true;
- +
- +module_param_cb(dgpu_power_init, ¶m_dgpu_power_ops, ¶m_dgpu_power_init, SHPS_DGPU_PARAM_PERM);
- +module_param_cb(dgpu_power_exit, ¶m_dgpu_power_ops, ¶m_dgpu_power_exit, SHPS_DGPU_PARAM_PERM);
- +module_param_cb(dgpu_power_susp, ¶m_dgpu_power_ops, ¶m_dgpu_power_susp, SHPS_DGPU_PARAM_PERM);
- +module_param_named(dtx_latch, param_dtx_latch, bool, SHPS_DGPU_PARAM_PERM);
- +
- +MODULE_PARM_DESC(dgpu_power_init, "dGPU power state to be set on init (0: off / 1: on / 2: as-is, default: off)");
- +MODULE_PARM_DESC(dgpu_power_exit, "dGPU power state to be set on exit (0: off / 1: on / 2: as-is, default: on)");
- +MODULE_PARM_DESC(dgpu_power_susp, "dGPU power state to be set on exit (0: off / 1: on / 2: as-is, default: as-is)");
- +MODULE_PARM_DESC(dtx_latch, "lock/unlock DTX base latch in accordance to power-state (Y/n)");
- +
- +static int dtx_cmd_simple(u8 cid)
- +{
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = SAM_DTX_TC,
- + .cid = cid,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x00,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + return surface_sam_ssh_rqst(&rqst, NULL);
- +}
- +
- +static inline int shps_dtx_latch_lock(void)
- +{
- + return dtx_cmd_simple(SAM_DTX_CID_LATCH_LOCK);
- +}
- +
- +static inline int shps_dtx_latch_unlock(void)
- +{
- + return dtx_cmd_simple(SAM_DTX_CID_LATCH_UNLOCK);
- +}
- +
- +static int shps_dgpu_dsm_get_pci_addr_from_adr(struct platform_device *pdev, const char *entry) {
- + acpi_handle handle = ACPI_HANDLE(&pdev->dev);
- + int status;
- + struct acpi_object_list input;
- + union acpi_object input_args[0];
- + u64 device_addr;
- + u8 bus, dev, fun;
- +
- + input.count = 0;
- + input.pointer = input_args;
- +
- +
- + status = acpi_evaluate_integer(handle, (acpi_string)entry, &input, &device_addr);
- + if (status) {
- + return -ENODEV;
- + }
- +
- + bus = 0;
- + dev = (device_addr & 0xFF0000) >> 16;
- + fun = device_addr & 0xFF;
- +
- + dev_info(&pdev->dev, "found pci device at bus = %d, dev = %x, fun = %x\n",
- + (u32)bus, (u32)dev, (u32)fun);
- +
- + return bus << 8 | PCI_DEVFN(dev, fun);
- +}
- +
- +static int shps_dgpu_dsm_get_pci_addr_from_dsm(struct platform_device *pdev, const char *entry)
- +{
- + acpi_handle handle = ACPI_HANDLE(&pdev->dev);
- + union acpi_object *result;
- + union acpi_object *e0;
- + union acpi_object *e1;
- + union acpi_object *e2;
- + u64 device_addr = 0;
- + u8 bus, dev, fun;
- + int i;
- +
- +
- + result = acpi_evaluate_dsm_typed(handle, &SHPS_DSM_UUID, SHPS_DSM_REVISION,
- + SHPS_DSM_GPU_ADDRS, NULL, ACPI_TYPE_PACKAGE);
- +
- + if (IS_ERR_OR_NULL(result))
- + return result ? PTR_ERR(result) : -EIO;
- +
- + // three entries per device: name, address, <integer>
- + for (i = 0; i + 2 < result->package.count; i += 3) {
- + e0 = &result->package.elements[i];
- + e1 = &result->package.elements[i + 1];
- + e2 = &result->package.elements[i + 2];
- +
- + if (e0->type != ACPI_TYPE_STRING) {
- + ACPI_FREE(result);
- + return -EIO;
- + }
- +
- + if (e1->type != ACPI_TYPE_INTEGER) {
- + ACPI_FREE(result);
- + return -EIO;
- + }
- +
- + if (e2->type != ACPI_TYPE_INTEGER) {
- + ACPI_FREE(result);
- + return -EIO;
- + }
- +
- + if (strncmp(e0->string.pointer, entry, 64) == 0)
- + device_addr = e1->integer.value;
- + }
- +
- + ACPI_FREE(result);
- + if (device_addr == 0)
- + return -ENODEV;
- +
- +
- + // convert address
- + bus = (device_addr & 0x0FF00000) >> 20;
- + dev = (device_addr & 0x000F8000) >> 15;
- + fun = (device_addr & 0x00007000) >> 12;
- +
- + return bus << 8 | PCI_DEVFN(dev, fun);
- +}
- +
- +static struct pci_dev *shps_dgpu_dsm_get_pci_dev(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct pci_dev *dev;
- + int addr;
- +
- +
- + if (drvdata->hardware_traits.dgpu_rp_pci_address) {
- + addr = shps_dgpu_dsm_get_pci_addr_from_adr(pdev, drvdata->hardware_traits.dgpu_rp_pci_address);
- + } else {
- + addr = shps_dgpu_dsm_get_pci_addr_from_dsm(pdev, SHPS_DSM_GPU_ADDRS_RP);
- + }
- +
- + if (addr < 0)
- + return ERR_PTR(addr);
- +
- + dev = pci_get_domain_bus_and_slot(0, (addr & 0xFF00) >> 8, addr & 0xFF);
- + return dev ? dev : ERR_PTR(-ENODEV);
- +}
- +
- +
- +static int shps_dgpu_dsm_get_power_unlocked(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct gpio_desc *gpio = drvdata->gpio_dgpu_power;
- + int status;
- +
- + status = gpiod_get_value_cansleep(gpio);
- + if (status < 0)
- + return status;
- +
- + return status == 0 ? SHPS_DGPU_POWER_OFF : SHPS_DGPU_POWER_ON;
- +}
- +
- +static int shps_dgpu_dsm_get_power(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + mutex_lock(&drvdata->lock);
- + status = shps_dgpu_dsm_get_power_unlocked(pdev);
- + mutex_unlock(&drvdata->lock);
- +
- + return status;
- +}
- +
- +static int __shps_dgpu_dsm_set_power_unlocked(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + acpi_handle handle = ACPI_HANDLE(&pdev->dev);
- + union acpi_object *result;
- + union acpi_object param;
- +
- + dev_info(&pdev->dev, "setting dGPU direct power to \'%s\'\n", shps_dgpu_power_str(power));
- +
- + param.type = ACPI_TYPE_INTEGER;
- + param.integer.value = power == SHPS_DGPU_POWER_ON;
- +
- + result = acpi_evaluate_dsm_typed(handle, &SHPS_DSM_UUID, SHPS_DSM_REVISION,
- + SHPS_DSM_GPU_POWER, ¶m, ACPI_TYPE_BUFFER);
- +
- + if (IS_ERR_OR_NULL(result))
- + return result ? PTR_ERR(result) : -EIO;
- +
- + // check for the expected result
- + if (result->buffer.length != 1 || result->buffer.pointer[0] != 0) {
- + ACPI_FREE(result);
- + return -EIO;
- + }
- +
- + ACPI_FREE(result);
- + return 0;
- +}
- +
- +static int shps_dgpu_dsm_set_power_unlocked(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + int status;
- +
- + if (power != SHPS_DGPU_POWER_ON && power != SHPS_DGPU_POWER_OFF)
- + return -EINVAL;
- +
- + status = shps_dgpu_dsm_get_power_unlocked(pdev);
- + if (status < 0)
- + return status;
- + if (status == power)
- + return 0;
- +
- + return __shps_dgpu_dsm_set_power_unlocked(pdev, power);
- +}
- +
- +static int shps_dgpu_dsm_set_power(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + mutex_lock(&drvdata->lock);
- + status = shps_dgpu_dsm_set_power_unlocked(pdev, power);
- + mutex_unlock(&drvdata->lock);
- +
- + return status;
- +}
- +
- +
- +static bool shps_rp_link_up(struct pci_dev *rp)
- +{
- + u16 lnksta = 0, sltsta = 0;
- +
- + pcie_capability_read_word(rp, PCI_EXP_LNKSTA, &lnksta);
- + pcie_capability_read_word(rp, PCI_EXP_SLTSTA, &sltsta);
- +
- + return (lnksta & PCI_EXP_LNKSTA_DLLLA) || (sltsta & PCI_EXP_SLTSTA_PDS);
- +}
- +
- +
- +static int shps_dgpu_rp_get_power_unlocked(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct pci_dev *rp = drvdata->dgpu_root_port;
- +
- + if (rp->current_state == PCI_D3hot || rp->current_state == PCI_D3cold)
- + return SHPS_DGPU_POWER_OFF;
- + else if (rp->current_state == PCI_UNKNOWN || rp->current_state == PCI_POWER_ERROR)
- + return SHPS_DGPU_POWER_UNKNOWN;
- + else
- + return SHPS_DGPU_POWER_ON;
- +}
- +
- +static int shps_dgpu_rp_get_power(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + mutex_lock(&drvdata->lock);
- + status = shps_dgpu_rp_get_power_unlocked(pdev);
- + mutex_unlock(&drvdata->lock);
- +
- + return status;
- +}
- +
- +static int __shps_dgpu_rp_set_power_unlocked(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct pci_dev *rp = drvdata->dgpu_root_port;
- + int status, i;
- +
- + dev_info(&pdev->dev, "setting dGPU power state to \'%s\'\n", shps_dgpu_power_str(power));
- +
- + dbg_dump_drvsta(pdev, "__shps_dgpu_rp_set_power_unlocked.1");
- + if (power == SHPS_DGPU_POWER_ON) {
- + set_bit(SHPS_STATE_BIT_RPPWRON_SYNC, &drvdata->state);
- + pci_set_power_state(rp, PCI_D0);
- +
- + if (drvdata->dgpu_root_port_state)
- + pci_load_and_free_saved_state(rp, &drvdata->dgpu_root_port_state);
- +
- + pci_restore_state(rp);
- +
- + if (!pci_is_enabled(rp))
- + pci_enable_device(rp);
- +
- + pci_set_master(rp);
- + clear_bit(SHPS_STATE_BIT_RPPWRON_SYNC, &drvdata->state);
- +
- + set_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + } else {
- + if (!drvdata->dgpu_root_port_state) {
- + pci_save_state(rp);
- + drvdata->dgpu_root_port_state = pci_store_saved_state(rp);
- + }
- +
- + /*
- + * To properly update the hot-plug system we need to "remove" the dGPU
- + * before disabling it and sending it to D3cold. Following this, we
- + * need to wait for the link and slot status to actually change.
- + */
- + status = shps_dgpu_dsm_set_power_unlocked(pdev, SHPS_DGPU_POWER_OFF);
- + if (status)
- + return status;
- +
- + for (i = 0; i < 20 && shps_rp_link_up(rp); i++)
- + msleep(50);
- +
- + if (shps_rp_link_up(rp))
- + dev_err(&pdev->dev, "dGPU removal via DSM timed out\n");
- +
- + pci_clear_master(rp);
- +
- + if (pci_is_enabled(rp))
- + pci_disable_device(rp);
- +
- + pci_set_power_state(rp, PCI_D3cold);
- +
- + clear_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + }
- + dbg_dump_drvsta(pdev, "__shps_dgpu_rp_set_power_unlocked.2");
- +
- + return 0;
- +}
- +
- +static int shps_dgpu_rp_set_power_unlocked(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + int status;
- +
- + if (power != SHPS_DGPU_POWER_ON && power != SHPS_DGPU_POWER_OFF)
- + return -EINVAL;
- +
- + status = shps_dgpu_rp_get_power_unlocked(pdev);
- + if (status < 0)
- + return status;
- + if (status == power)
- + return 0;
- +
- + return __shps_dgpu_rp_set_power_unlocked(pdev, power);
- +}
- +
- +static int shps_dgpu_rp_set_power(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + mutex_lock(&drvdata->lock);
- + status = shps_dgpu_rp_set_power_unlocked(pdev, power);
- + mutex_unlock(&drvdata->lock);
- +
- + return status;
- +}
- +
- +
- +static int shps_dgpu_set_power(struct platform_device *pdev, enum shps_dgpu_power power)
- +{
- + int status;
- +
- + if (!param_dtx_latch)
- + return shps_dgpu_rp_set_power(pdev, power);
- +
- + if (power == SHPS_DGPU_POWER_ON) {
- + status = shps_dtx_latch_lock();
- + if (status)
- + return status;
- +
- + status = shps_dgpu_rp_set_power(pdev, power);
- + if (status)
- + shps_dtx_latch_unlock();
- +
- + } else {
- + status = shps_dgpu_rp_set_power(pdev, power);
- + if (status)
- + return status;
- +
- + status = shps_dtx_latch_unlock();
- + }
- +
- + return status;
- +}
- +
- +
- +static int shps_dgpu_is_present(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata;
- +
- + drvdata = platform_get_drvdata(pdev);
- + return gpiod_get_value_cansleep(drvdata->gpio_dgpu_presence);
- +}
- +
- +
- +static ssize_t dgpu_power_show(struct device *dev, struct device_attribute *attr, char *data)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + int power = shps_dgpu_rp_get_power(pdev);
- +
- + if (power < 0)
- + return power;
- +
- + return sprintf(data, "%s\n", shps_dgpu_power_str(power));
- +}
- +
- +static ssize_t dgpu_power_store(struct device *dev, struct device_attribute *attr,
- + const char *data, size_t count)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + enum shps_dgpu_power power;
- + bool b = false;
- + int status;
- +
- + status = kstrtobool(data, &b);
- + if (status)
- + return status;
- +
- + status = shps_dgpu_is_present(pdev);
- + if (status <= 0)
- + return status < 0 ? status : -EPERM;
- +
- + power = b ? SHPS_DGPU_POWER_ON : SHPS_DGPU_POWER_OFF;
- + status = shps_dgpu_set_power(pdev, power);
- +
- + return status < 0 ? status : count;
- +}
- +
- +static ssize_t dgpu_power_dsm_show(struct device *dev, struct device_attribute *attr, char *data)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + int power = shps_dgpu_dsm_get_power(pdev);
- +
- + if (power < 0)
- + return power;
- +
- + return sprintf(data, "%s\n", shps_dgpu_power_str(power));
- +}
- +
- +static ssize_t dgpu_power_dsm_store(struct device *dev, struct device_attribute *attr,
- + const char *data, size_t count)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + enum shps_dgpu_power power;
- + bool b = false;
- + int status;
- +
- + status = kstrtobool(data, &b);
- + if (status)
- + return status;
- +
- + status = shps_dgpu_is_present(pdev);
- + if (status <= 0)
- + return status < 0 ? status : -EPERM;
- +
- + power = b ? SHPS_DGPU_POWER_ON : SHPS_DGPU_POWER_OFF;
- + status = shps_dgpu_dsm_set_power(pdev, power);
- +
- + return status < 0 ? status : count;
- +}
- +
- +static DEVICE_ATTR_RW(dgpu_power);
- +static DEVICE_ATTR_RW(dgpu_power_dsm);
- +
- +static struct attribute *shps_power_attrs[] = {
- + &dev_attr_dgpu_power.attr,
- + &dev_attr_dgpu_power_dsm.attr,
- + NULL,
- +};
- +ATTRIBUTE_GROUPS(shps_power);
- +
- +
- +static void dbg_dump_power_states(struct platform_device *pdev, const char *prefix)
- +{
- + enum shps_dgpu_power power_dsm;
- + enum shps_dgpu_power power_rp;
- + int status;
- +
- + status = shps_dgpu_rp_get_power_unlocked(pdev);
- + if (status < 0)
- + dev_err(&pdev->dev, "%s: failed to get root-port power state: %d\n", prefix, status);
- + power_rp = status;
- +
- + status = shps_dgpu_rp_get_power_unlocked(pdev);
- + if (status < 0)
- + dev_err(&pdev->dev, "%s: failed to get direct power state: %d\n", prefix, status);
- + power_dsm = status;
- +
- + dev_dbg(&pdev->dev, "%s: root-port power state: %d\n", prefix, power_rp);
- + dev_dbg(&pdev->dev, "%s: direct power state: %d\n", prefix, power_dsm);
- +}
- +
- +static void dbg_dump_pciesta(struct platform_device *pdev, const char *prefix)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct pci_dev *rp = drvdata->dgpu_root_port;
- + u16 lnksta, lnksta2, sltsta, sltsta2;
- +
- + pcie_capability_read_word(rp, PCI_EXP_LNKSTA, &lnksta);
- + pcie_capability_read_word(rp, PCI_EXP_LNKSTA2, &lnksta2);
- + pcie_capability_read_word(rp, PCI_EXP_SLTSTA, &sltsta);
- + pcie_capability_read_word(rp, PCI_EXP_SLTSTA2, &sltsta2);
- +
- + dev_dbg(&pdev->dev, "%s: LNKSTA: 0x%04x\n", prefix, lnksta);
- + dev_dbg(&pdev->dev, "%s: LNKSTA2: 0x%04x\n", prefix, lnksta2);
- + dev_dbg(&pdev->dev, "%s: SLTSTA: 0x%04x\n", prefix, sltsta);
- + dev_dbg(&pdev->dev, "%s: SLTSTA2: 0x%04x\n", prefix, sltsta2);
- +}
- +
- +static void dbg_dump_drvsta(struct platform_device *pdev, const char *prefix)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct pci_dev *rp = drvdata->dgpu_root_port;
- +
- + dev_dbg(&pdev->dev, "%s: RP power: %d\n", prefix, rp->current_state);
- + dev_dbg(&pdev->dev, "%s: RP state saved: %d\n", prefix, rp->state_saved);
- + dev_dbg(&pdev->dev, "%s: RP state stored: %d\n", prefix, !!drvdata->dgpu_root_port_state);
- + dev_dbg(&pdev->dev, "%s: RP enabled: %d\n", prefix, atomic_read(&rp->enable_cnt));
- + dev_dbg(&pdev->dev, "%s: RP mastered: %d\n", prefix, rp->is_busmaster);
- +}
- +
- +static int shps_pm_prepare(struct device *dev)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + bool pwrtgt;
- + int status = 0;
- +
- + dbg_dump_power_states(pdev, "shps_pm_prepare");
- +
- + if (param_dgpu_power_susp != SHPS_DGPU_MP_POWER_ASIS) {
- + pwrtgt = test_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- +
- + status = shps_dgpu_set_power(pdev, param_dgpu_power_susp);
- + if (status) {
- + dev_err(&pdev->dev, "failed to power %s dGPU: %d\n",
- + param_dgpu_power_susp == SHPS_DGPU_MP_POWER_OFF ? "off" : "on",
- + status);
- + return status;
- + }
- +
- + if (pwrtgt)
- + set_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + else
- + clear_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + }
- +
- + return 0;
- +}
- +
- +static void shps_pm_complete(struct device *dev)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + dbg_dump_power_states(pdev, "shps_pm_complete");
- + dbg_dump_pciesta(pdev, "shps_pm_complete");
- + dbg_dump_drvsta(pdev, "shps_pm_complete.1");
- +
- + // update power target, dGPU may have been detached while suspended
- + status = shps_dgpu_is_present(pdev);
- + if (status < 0) {
- + dev_err(&pdev->dev, "failed to get dGPU presence: %d\n", status);
- + return;
- + } else if (status == 0) {
- + clear_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + }
- +
- + /*
- + * During resume, the PCIe core will power on the root-port, which in turn
- + * will power on the dGPU. Most of the state synchronization is already
- + * handled via the SAN RQSG handler, so it is in a fully consistent
- + * on-state here. If requested, turn it off here.
- + *
- + * As there seem to be some synchronization issues turning off the dGPU
- + * directly after the power-on SAN RQSG notification during the resume
- + * process, let's do this here.
- + *
- + * TODO/FIXME:
- + * This does not combat unhandled power-ons when the device is not fully
- + * resumed, i.e. re-suspended before shps_pm_complete is called. Those
- + * should normally not be an issue, but the dGPU does get hot even though
- + * it is suspended, so ideally we want to keep it off.
- + */
- + if (!test_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state)) {
- + status = shps_dgpu_set_power(pdev, SHPS_DGPU_POWER_OFF);
- + if (status)
- + dev_err(&pdev->dev, "failed to power-off dGPU: %d\n", status);
- + }
- +
- + dbg_dump_drvsta(pdev, "shps_pm_complete.2");
- +}
- +
- +static int shps_pm_suspend(struct device *dev)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + if (device_may_wakeup(dev)) {
- + status = enable_irq_wake(drvdata->irq_base_presence);
- + if (status)
- + return status;
- +
- + set_bit(SHPS_STATE_BIT_WAKE_ENABLED, &drvdata->state);
- + }
- +
- + return 0;
- +}
- +
- +static int shps_pm_resume(struct device *dev)
- +{
- + struct platform_device *pdev = to_platform_device(dev);
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status = 0;
- +
- + if (test_and_clear_bit(SHPS_STATE_BIT_WAKE_ENABLED, &drvdata->state))
- + status = disable_irq_wake(drvdata->irq_base_presence);
- +
- + return status;
- +}
- +
- +static void shps_shutdown(struct platform_device *pdev)
- +{
- + int status;
- +
- + /*
- + * Turn on dGPU before shutting down. This allows the core drivers to
- + * properly shut down the device. If we don't do this, the pcieport driver
- + * will complain that the device has already been disabled.
- + */
- + status = shps_dgpu_set_power(pdev, SHPS_DGPU_POWER_ON);
- + if (status)
- + dev_err(&pdev->dev, "failed to turn on dGPU: %d\n", status);
- +}
- +
- +static int shps_dgpu_detached(struct platform_device *pdev)
- +{
- + dbg_dump_power_states(pdev, "shps_dgpu_detached");
- + return shps_dgpu_set_power(pdev, SHPS_DGPU_POWER_OFF);
- +}
- +
- +static int shps_dgpu_attached(struct platform_device *pdev)
- +{
- + dbg_dump_power_states(pdev, "shps_dgpu_attached");
- + return 0;
- +}
- +
- +static int shps_dgpu_powered_on(struct platform_device *pdev)
- +{
- + /*
- + * This function gets called directly after a power-state transition of
- + * the dGPU root port out of D3cold state, indicating a power-on of the
- + * dGPU. Specifically, this function is called from the RQSG handler of
- + * SAN, invoked by the ACPI _ON method of the dGPU root port. This means
- + * that this function is run inside `pci_set_power_state(rp, ...)`
- + * syncrhonously and thus returns before the `pci_set_power_state` call
- + * does.
- + *
- + * `pci_set_power_state` may either be called by us or when the PCI
- + * subsystem decides to power up the root port (e.g. during resume). Thus
- + * we should use this function to ensure that the dGPU and root port
- + * states are consistent when an unexpected power-up is encountered.
- + */
- +
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct pci_dev *rp = drvdata->dgpu_root_port;
- + int status;
- +
- + dbg_dump_drvsta(pdev, "shps_dgpu_powered_on.1");
- +
- + // if we caused the root port to power-on, return
- + if (test_bit(SHPS_STATE_BIT_RPPWRON_SYNC, &drvdata->state))
- + return 0;
- +
- + // if dGPU is not present, force power-target to off and return
- + status = shps_dgpu_is_present(pdev);
- + if (status == 0)
- + clear_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + if (status <= 0)
- + return status;
- +
- + mutex_lock(&drvdata->lock);
- +
- + dbg_dump_power_states(pdev, "shps_dgpu_powered_on.1");
- + dbg_dump_pciesta(pdev, "shps_dgpu_powered_on.1");
- + if (drvdata->dgpu_root_port_state)
- + pci_load_and_free_saved_state(rp, &drvdata->dgpu_root_port_state);
- + pci_restore_state(rp);
- + if (!pci_is_enabled(rp))
- + pci_enable_device(rp);
- + pci_set_master(rp);
- + dbg_dump_drvsta(pdev, "shps_dgpu_powered_on.2");
- + dbg_dump_power_states(pdev, "shps_dgpu_powered_on.2");
- + dbg_dump_pciesta(pdev, "shps_dgpu_powered_on.2");
- +
- + mutex_unlock(&drvdata->lock);
- +
- + if (!test_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state)) {
- + dev_warn(&pdev->dev, "unexpected dGPU power-on detected\n");
- + // TODO: schedule state re-check and update
- + }
- +
- + return 0;
- +}
- +
- +static int shps_dgpu_handle_rqsg(struct surface_sam_san_rqsg *rqsg, void *data)
- +{
- + struct platform_device *pdev = data;
- +
- + if (rqsg->tc == SAM_DGPU_TC && rqsg->cid == SAM_DGPU_CID_POWERON)
- + return shps_dgpu_powered_on(pdev);
- +
- + dev_warn(&pdev->dev, "unimplemented dGPU request: RQSG(0x%02x, 0x%02x, 0x%02x)\n",
- + rqsg->tc, rqsg->cid, rqsg->iid);
- + return 0;
- +}
- +
- +static irqreturn_t shps_dgpu_presence_irq(int irq, void *data)
- +{
- + struct platform_device *pdev = data;
- + bool dgpu_present;
- + int status;
- +
- + status = shps_dgpu_is_present(pdev);
- + if (status < 0) {
- + dev_err(&pdev->dev, "failed to check physical dGPU presence: %d\n", status);
- + return IRQ_HANDLED;
- + }
- +
- + dgpu_present = status != 0;
- + dev_info(&pdev->dev, "dGPU physically %s\n", dgpu_present ? "attached" : "detached");
- +
- + if (dgpu_present)
- + status = shps_dgpu_attached(pdev);
- + else
- + status = shps_dgpu_detached(pdev);
- +
- + if (status)
- + dev_err(&pdev->dev, "error handling dGPU interrupt: %d\n", status);
- +
- + return IRQ_HANDLED;
- +}
- +
- +static irqreturn_t shps_base_presence_irq(int irq, void *data)
- +{
- + return IRQ_HANDLED; // nothing to do, just wake
- +}
- +
- +
- +static int shps_gpios_setup(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + struct gpio_desc *gpio_dgpu_power;
- + struct gpio_desc *gpio_dgpu_presence;
- + struct gpio_desc *gpio_base_presence;
- + int status;
- +
- + // get GPIOs
- + gpio_dgpu_power = devm_gpiod_get(&pdev->dev, "dgpu_power", GPIOD_IN);
- + if (IS_ERR(gpio_dgpu_power)) {
- + status = PTR_ERR(gpio_dgpu_power);
- + goto err_out;
- + }
- +
- + gpio_dgpu_presence = devm_gpiod_get(&pdev->dev, "dgpu_presence", GPIOD_IN);
- + if (IS_ERR(gpio_dgpu_presence)) {
- + status = PTR_ERR(gpio_dgpu_presence);
- + goto err_out;
- + }
- +
- + gpio_base_presence = devm_gpiod_get(&pdev->dev, "base_presence", GPIOD_IN);
- + if (IS_ERR(gpio_base_presence)) {
- + status = PTR_ERR(gpio_base_presence);
- + goto err_out;
- + }
- +
- + // export GPIOs
- + status = gpiod_export(gpio_dgpu_power, false);
- + if (status)
- + goto err_out;
- +
- + status = gpiod_export(gpio_dgpu_presence, false);
- + if (status)
- + goto err_export_dgpu_presence;
- +
- + status = gpiod_export(gpio_base_presence, false);
- + if (status)
- + goto err_export_base_presence;
- +
- + // create sysfs links
- + status = gpiod_export_link(&pdev->dev, "gpio-dgpu_power", gpio_dgpu_power);
- + if (status)
- + goto err_link_dgpu_power;
- +
- + status = gpiod_export_link(&pdev->dev, "gpio-dgpu_presence", gpio_dgpu_presence);
- + if (status)
- + goto err_link_dgpu_presence;
- +
- + status = gpiod_export_link(&pdev->dev, "gpio-base_presence", gpio_base_presence);
- + if (status)
- + goto err_link_base_presence;
- +
- + drvdata->gpio_dgpu_power = gpio_dgpu_power;
- + drvdata->gpio_dgpu_presence = gpio_dgpu_presence;
- + drvdata->gpio_base_presence = gpio_base_presence;
- + return 0;
- +
- +err_link_base_presence:
- + sysfs_remove_link(&pdev->dev.kobj, "gpio-dgpu_presence");
- +err_link_dgpu_presence:
- + sysfs_remove_link(&pdev->dev.kobj, "gpio-dgpu_power");
- +err_link_dgpu_power:
- + gpiod_unexport(gpio_base_presence);
- +err_export_base_presence:
- + gpiod_unexport(gpio_dgpu_presence);
- +err_export_dgpu_presence:
- + gpiod_unexport(gpio_dgpu_power);
- +err_out:
- + return status;
- +}
- +
- +static void shps_gpios_remove(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- +
- + sysfs_remove_link(&pdev->dev.kobj, "gpio-base_presence");
- + sysfs_remove_link(&pdev->dev.kobj, "gpio-dgpu_presence");
- + sysfs_remove_link(&pdev->dev.kobj, "gpio-dgpu_power");
- + gpiod_unexport(drvdata->gpio_base_presence);
- + gpiod_unexport(drvdata->gpio_dgpu_presence);
- + gpiod_unexport(drvdata->gpio_dgpu_power);
- +}
- +
- +static int shps_gpios_setup_irq(struct platform_device *pdev)
- +{
- + const int irqf_dgpu = IRQF_SHARED | IRQF_ONESHOT | IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
- + const int irqf_base = IRQF_SHARED;
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + status = gpiod_to_irq(drvdata->gpio_base_presence);
- + if (status < 0)
- + return status;
- + drvdata->irq_base_presence = status;
- +
- + status = gpiod_to_irq(drvdata->gpio_dgpu_presence);
- + if (status < 0)
- + return status;
- + drvdata->irq_dgpu_presence = status;
- +
- + status = request_irq(drvdata->irq_base_presence,
- + shps_base_presence_irq, irqf_base,
- + "shps_base_presence_irq", pdev);
- + if (status) {
- + dev_err(&pdev->dev, "base irq failed: %d\n", status);
- + return status;
- + }
- +
- + status = request_threaded_irq(drvdata->irq_dgpu_presence,
- + NULL, shps_dgpu_presence_irq, irqf_dgpu,
- + "shps_dgpu_presence_irq", pdev);
- + if (status) {
- + free_irq(drvdata->irq_base_presence, pdev);
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +static void shps_gpios_remove_irq(struct platform_device *pdev)
- +{
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- +
- + free_irq(drvdata->irq_base_presence, pdev);
- + free_irq(drvdata->irq_dgpu_presence, pdev);
- +}
- +
- +static void shps_sgcp_notify(acpi_handle device, u32 value, void *context) {
- + struct platform_device *pdev = context;
- + switch (value) {
- + case ACPI_SGCP_NOTIFY_POWER_ON:
- + shps_dgpu_powered_on(pdev);
- + }
- +}
- +
- +static int shps_start_sgcp_notification(struct platform_device *pdev, acpi_handle *sgpc_handle) {
- + acpi_handle handle;
- + int status;
- +
- + status = acpi_get_handle(NULL, "\\_SB.SGPC", &handle);
- + if (status) {
- + dev_err(&pdev->dev, "error in get_handle %d\n", status);
- + return status;
- + }
- +
- + status = acpi_install_notify_handler(handle, ACPI_DEVICE_NOTIFY, shps_sgcp_notify, pdev);
- + if (status) {
- + dev_err(&pdev->dev, "error in install notify %d\n", status);
- + *sgpc_handle = NULL;
- + return status;
- + }
- +
- + *sgpc_handle = handle;
- + return 0;
- +}
- +
- +static void shps_remove_sgcp_notification(struct platform_device *pdev) {
- + int status;
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- +
- + if (drvdata->sgpc_handle) {
- + status = acpi_remove_notify_handler(drvdata->sgpc_handle, ACPI_DEVICE_NOTIFY, shps_sgcp_notify);
- + if (status) {
- + dev_err(&pdev->dev, "failed to remove notify handler: %d\n", status);
- + }
- + }
- +}
- +
- +static struct shps_hardware_traits shps_detect_hardware_traits(struct platform_device *pdev) {
- + const struct shps_hardware_probe *p;
- +
- + for (p = shps_hardware_probe_match; p->hardware_id; ++p) {
- + if (acpi_dev_present(p->hardware_id, NULL, -1)) {
- + break;
- + }
- + }
- +
- + dev_info(&pdev->dev,
- + "shps_detect_hardware_traits found device %s, generation %d\n",
- + p->hardware_id ? p->hardware_id : "SAN (default)",
- + p->generation);
- +
- + return *p->hardware_traits;
- +}
- +
- +static int shps_probe(struct platform_device *pdev)
- +{
- + struct acpi_device *shps_dev = ACPI_COMPANION(&pdev->dev);
- + struct shps_driver_data *drvdata;
- + struct device_link *link;
- + int power, status;
- + struct shps_hardware_traits detected_traits;
- +
- + if (gpiod_count(&pdev->dev, NULL) < 0) {
- + dev_err(&pdev->dev, "gpiod_count returned < 0\n");
- + return -ENODEV;
- + }
- +
- + // link to SSH
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status) {
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- + }
- +
- + // detect what kind of hardware we're running
- + detected_traits = shps_detect_hardware_traits(pdev);
- +
- + if (detected_traits.notification_method == SHPS_NOTIFICATION_METHOD_SAN) {
- + // link to SAN
- + status = surface_sam_san_consumer_register(&pdev->dev, 0);
- + if (status) {
- + dev_err(&pdev->dev, "failed to register with san consumer: %d\n", status);
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- + }
- + }
- +
- + status = acpi_dev_add_driver_gpios(shps_dev, shps_acpi_gpios);
- + if (status) {
- + dev_err(&pdev->dev, "failed to add gpios: %d\n", status);
- + return status;
- + }
- +
- + drvdata = kzalloc(sizeof(struct shps_driver_data), GFP_KERNEL);
- + if (!drvdata) {
- + status = -ENOMEM;
- + goto err_drvdata;
- + }
- + mutex_init(&drvdata->lock);
- + platform_set_drvdata(pdev, drvdata);
- +
- + drvdata->hardware_traits = detected_traits;
- +
- + drvdata->dgpu_root_port = shps_dgpu_dsm_get_pci_dev(pdev);
- + if (IS_ERR(drvdata->dgpu_root_port)) {
- + status = PTR_ERR(drvdata->dgpu_root_port);
- + dev_err(&pdev->dev, "failed to get pci dev: %d\n", status);
- + goto err_rp_lookup;
- + }
- +
- + status = shps_gpios_setup(pdev);
- + if (status) {
- + dev_err(&pdev->dev, "unable to set up gpios, %d\n", status);
- + goto err_gpio;
- + }
- +
- + status = shps_gpios_setup_irq(pdev);
- + if (status) {
- + dev_err(&pdev->dev, "unable to set up irqs %d\n", status);
- + goto err_gpio_irqs;
- + }
- +
- + status = device_add_groups(&pdev->dev, shps_power_groups);
- + if (status)
- + goto err_devattr;
- +
- + link = device_link_add(&pdev->dev, &drvdata->dgpu_root_port->dev,
- + DL_FLAG_PM_RUNTIME | DL_FLAG_AUTOREMOVE_CONSUMER);
- + if (!link)
- + goto err_devlink;
- +
- + if (detected_traits.notification_method == SHPS_NOTIFICATION_METHOD_SAN) {
- + status = surface_sam_san_set_rqsg_handler(shps_dgpu_handle_rqsg, pdev);
- + if (status) {
- + dev_err(&pdev->dev, "unable to set SAN notification handler (%d)\n", status);
- + goto err_devlink;
- + }
- + } else if (detected_traits.notification_method == SHPS_NOTIFICATION_METHOD_SGCP) {
- + status = shps_start_sgcp_notification(pdev, &drvdata->sgpc_handle);
- + if (status) {
- + dev_err(&pdev->dev, "unable to install SGCP notification handler (%d)\n", status);
- + goto err_devlink;
- + }
- + }
- +
- + // if dGPU is not present turn-off root-port, else obey module param
- + status = shps_dgpu_is_present(pdev);
- + if (status < 0)
- + goto err_post_notification;
- +
- + power = status == 0 ? SHPS_DGPU_POWER_OFF : param_dgpu_power_init;
- + if (power != SHPS_DGPU_MP_POWER_ASIS) {
- + status = shps_dgpu_set_power(pdev, power);
- + if (status)
- + goto err_post_notification;
- + }
- +
- + // initialize power target
- + status = shps_dgpu_rp_get_power(pdev);
- + if (status < 0)
- + goto err_pwrtgt;
- +
- + if (status)
- + set_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- + else
- + clear_bit(SHPS_STATE_BIT_PWRTGT, &drvdata->state);
- +
- + device_init_wakeup(&pdev->dev, true);
- + return 0;
- +
- +err_pwrtgt:
- + if (param_dgpu_power_exit != SHPS_DGPU_MP_POWER_ASIS) {
- + status = shps_dgpu_set_power(pdev, param_dgpu_power_exit);
- + if (status)
- + dev_err(&pdev->dev, "failed to set dGPU power state: %d\n", status);
- + }
- +err_post_notification:
- + if (detected_traits.notification_method == SHPS_NOTIFICATION_METHOD_SGCP) {
- + shps_remove_sgcp_notification(pdev);
- + } else if (detected_traits.notification_method == SHPS_NOTIFICATION_METHOD_SAN) {
- + surface_sam_san_set_rqsg_handler(NULL, NULL);
- + }
- +err_devlink:
- + device_remove_groups(&pdev->dev, shps_power_groups);
- +err_devattr:
- + shps_gpios_remove_irq(pdev);
- +err_gpio_irqs:
- + shps_gpios_remove(pdev);
- +err_gpio:
- + pci_dev_put(drvdata->dgpu_root_port);
- +err_rp_lookup:
- + platform_set_drvdata(pdev, NULL);
- + kfree(drvdata);
- +err_drvdata:
- + acpi_dev_remove_driver_gpios(shps_dev);
- + return status;
- +}
- +
- +static int shps_remove(struct platform_device *pdev)
- +{
- + struct acpi_device *shps_dev = ACPI_COMPANION(&pdev->dev);
- + struct shps_driver_data *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + if (param_dgpu_power_exit != SHPS_DGPU_MP_POWER_ASIS) {
- + status = shps_dgpu_set_power(pdev, param_dgpu_power_exit);
- + if (status)
- + dev_err(&pdev->dev, "failed to set dGPU power state: %d\n", status);
- + }
- +
- + device_set_wakeup_capable(&pdev->dev, false);
- +
- + if (drvdata->hardware_traits.notification_method == SHPS_NOTIFICATION_METHOD_SGCP) {
- + shps_remove_sgcp_notification(pdev);
- + } else if (drvdata->hardware_traits.notification_method == SHPS_NOTIFICATION_METHOD_SAN) {
- + surface_sam_san_set_rqsg_handler(NULL, NULL);
- + }
- + device_remove_groups(&pdev->dev, shps_power_groups);
- + shps_gpios_remove_irq(pdev);
- + shps_gpios_remove(pdev);
- + pci_dev_put(drvdata->dgpu_root_port);
- + platform_set_drvdata(pdev, NULL);
- + kfree(drvdata);
- +
- + acpi_dev_remove_driver_gpios(shps_dev);
- + return 0;
- +}
- +
- +
- +static const struct dev_pm_ops shps_pm_ops = {
- + .prepare = shps_pm_prepare,
- + .complete = shps_pm_complete,
- + .suspend = shps_pm_suspend,
- + .resume = shps_pm_resume,
- +};
- +
- +static const struct acpi_device_id shps_acpi_match[] = {
- + { "MSHW0153", 0 },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, shps_acpi_match);
- +
- +static struct platform_driver surface_sam_hps = {
- + .probe = shps_probe,
- + .remove = shps_remove,
- + .shutdown = shps_shutdown,
- + .driver = {
- + .name = "surface_dgpu_hps",
- + .acpi_match_table = shps_acpi_match,
- + .pm = &shps_pm_ops,
- + },
- +};
- +
- +module_platform_driver(surface_sam_hps);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Hot-Plug System (HPS) and dGPU power-state Driver for Surface Book 2");
- +MODULE_LICENSE("GPL");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_san.c b/drivers/platform/x86/surface_sam/surface_sam_san.c
- new file mode 100644
- index 000000000000..11dd6daedc3d
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_san.c
- @@ -0,0 +1,913 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface ACPI Notify (SAN) and ACPI integration driver for SAM.
- + * Translates communication from ACPI to SSH and back.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/delay.h>
- +#include <linux/jiffies.h>
- +#include <linux/kernel.h>
- +#include <linux/platform_device.h>
- +
- +#include "surface_sam_ssh.h"
- +#include "surface_sam_san.h"
- +
- +
- +#define SAN_RQST_RETRY 5
- +
- +#define SAN_DSM_REVISION 0
- +#define SAN_DSM_FN_NOTIFY_SENSOR_TRIP_POINT 0x09
- +
- +static const guid_t SAN_DSM_UUID =
- + GUID_INIT(0x93b666c5, 0x70c6, 0x469f, 0xa2, 0x15, 0x3d,
- + 0x48, 0x7c, 0x91, 0xab, 0x3c);
- +
- +#define SAM_EVENT_DELAY_PWR_ADAPTER msecs_to_jiffies(5000)
- +#define SAM_EVENT_DELAY_PWR_BST msecs_to_jiffies(2500)
- +
- +#define SAM_EVENT_PWR_CID_BIX 0x15
- +#define SAM_EVENT_PWR_CID_BST 0x16
- +#define SAM_EVENT_PWR_CID_ADAPTER 0x17
- +#define SAM_EVENT_PWR_CID_DPTF 0x4f
- +
- +#define SAM_EVENT_TEMP_CID_NOTIFY_SENSOR_TRIP_POINT 0x0b
- +
- +#define SAN_RQST_TAG "surface_sam_san: rqst: "
- +#define SAN_RQSG_TAG "surface_sam_san: rqsg: "
- +
- +#define SAN_QUIRK_BASE_STATE_DELAY 1000
- +
- +
- +struct san_acpi_consumer {
- + char *path;
- + bool required;
- + u32 flags;
- +};
- +
- +struct san_opreg_context {
- + struct acpi_connection_info connection;
- + struct device *dev;
- +};
- +
- +struct san_consumer_link {
- + const struct san_acpi_consumer *properties;
- + struct device_link *link;
- +};
- +
- +struct san_consumers {
- + u32 num;
- + struct san_consumer_link *links;
- +};
- +
- +struct san_drvdata {
- + struct san_opreg_context opreg_ctx;
- + struct san_consumers consumers;
- +
- + struct platform_device *dev;
- + struct ssam_event_notifier nf_bat;
- + struct ssam_event_notifier nf_tmp;
- +};
- +
- +struct san_event_work {
- + struct delayed_work work;
- + struct platform_device *dev;
- + struct ssam_event event; // must be last
- +};
- +
- +struct gsb_data_in {
- + u8 cv;
- +} __packed;
- +
- +struct gsb_data_rqsx {
- + u8 cv; // command value (should be 0x01 or 0x03)
- + u8 tc; // target controller
- + u8 tid; // transport channnel ID?
- + u8 iid; // target sub-controller (e.g. primary vs. secondary battery)
- + u8 snc; // expect-response-flag
- + u8 cid; // command ID
- + u8 cdl; // payload length
- + u8 _pad; // padding
- + u8 pld[0]; // payload
- +} __packed;
- +
- +struct gsb_data_etwl {
- + u8 cv; // command value (should be 0x02)
- + u8 etw3; // ?
- + u8 etw4; // ?
- + u8 msg[0]; // error message (ASCIIZ)
- +} __packed;
- +
- +struct gsb_data_out {
- + u8 status; // _SSH communication status
- + u8 len; // _SSH payload length
- + u8 pld[0]; // _SSH payload
- +} __packed;
- +
- +union gsb_buffer_data {
- + struct gsb_data_in in; // common input
- + struct gsb_data_rqsx rqsx; // RQSX input
- + struct gsb_data_etwl etwl; // ETWL input
- + struct gsb_data_out out; // output
- +};
- +
- +struct gsb_buffer {
- + u8 status; // GSB AttribRawProcess status
- + u8 len; // GSB AttribRawProcess length
- + union gsb_buffer_data data;
- +} __packed;
- +
- +
- +enum san_pwr_event {
- + SAN_PWR_EVENT_BAT1_STAT = 0x03,
- + SAN_PWR_EVENT_BAT1_INFO = 0x04,
- + SAN_PWR_EVENT_ADP1_STAT = 0x05,
- + SAN_PWR_EVENT_ADP1_INFO = 0x06,
- + SAN_PWR_EVENT_BAT2_STAT = 0x07,
- + SAN_PWR_EVENT_BAT2_INFO = 0x08,
- + SAN_PWR_EVENT_DPTF = 0x0A,
- +};
- +
- +
- +static int sam_san_default_rqsg_handler(struct surface_sam_san_rqsg *rqsg, void *data);
- +
- +struct sam_san_rqsg_if {
- + struct mutex lock;
- + struct device *san_dev;
- + surface_sam_san_rqsg_handler_fn handler;
- + void *handler_data;
- +};
- +
- +static struct sam_san_rqsg_if rqsg_if = {
- + .lock = __MUTEX_INITIALIZER(rqsg_if.lock),
- + .san_dev = NULL,
- + .handler = sam_san_default_rqsg_handler,
- + .handler_data = NULL,
- +};
- +
- +int surface_sam_san_consumer_register(struct device *consumer, u32 flags)
- +{
- + const u32 valid = DL_FLAG_PM_RUNTIME | DL_FLAG_RPM_ACTIVE;
- + int status;
- +
- + if ((flags | valid) != valid)
- + return -EINVAL;
- +
- + flags |= DL_FLAG_AUTOREMOVE_CONSUMER;
- +
- + mutex_lock(&rqsg_if.lock);
- + if (rqsg_if.san_dev)
- + status = device_link_add(consumer, rqsg_if.san_dev, flags) ? 0 : -EINVAL;
- + else
- + status = -ENXIO;
- + mutex_unlock(&rqsg_if.lock);
- + return status;
- +}
- +EXPORT_SYMBOL_GPL(surface_sam_san_consumer_register);
- +
- +int surface_sam_san_set_rqsg_handler(surface_sam_san_rqsg_handler_fn fn, void *data)
- +{
- + int status = -EBUSY;
- +
- + mutex_lock(&rqsg_if.lock);
- +
- + if (rqsg_if.handler == sam_san_default_rqsg_handler || !fn) {
- + rqsg_if.handler = fn ? fn : sam_san_default_rqsg_handler;
- + rqsg_if.handler_data = data;
- + status = 0;
- + }
- +
- + mutex_unlock(&rqsg_if.lock);
- + return status;
- +}
- +EXPORT_SYMBOL_GPL(surface_sam_san_set_rqsg_handler);
- +
- +int san_call_rqsg_handler(struct surface_sam_san_rqsg *rqsg)
- +{
- + int status;
- +
- + mutex_lock(&rqsg_if.lock);
- + status = rqsg_if.handler(rqsg, rqsg_if.handler_data);
- + mutex_unlock(&rqsg_if.lock);
- +
- + return status;
- +}
- +
- +static int sam_san_default_rqsg_handler(struct surface_sam_san_rqsg *rqsg, void *data)
- +{
- + pr_warn(SAN_RQSG_TAG "unhandled request: RQSG(0x%02x, 0x%02x, 0x%02x)\n",
- + rqsg->tc, rqsg->cid, rqsg->iid);
- +
- + return 0;
- +}
- +
- +
- +static bool san_acpi_can_notify(struct device *dev, u64 func)
- +{
- + acpi_handle san = ACPI_HANDLE(dev);
- + return acpi_check_dsm(san, &SAN_DSM_UUID, SAN_DSM_REVISION, 1 << func);
- +}
- +
- +static int san_acpi_notify_power_event(struct device *dev, enum san_pwr_event event)
- +{
- + acpi_handle san = ACPI_HANDLE(dev);
- + union acpi_object *obj;
- +
- + if (!san_acpi_can_notify(dev, event))
- + return 0;
- +
- + dev_dbg(dev, "notify power event 0x%02x\n", event);
- + obj = acpi_evaluate_dsm_typed(san, &SAN_DSM_UUID, SAN_DSM_REVISION,
- + event, NULL, ACPI_TYPE_BUFFER);
- +
- + if (IS_ERR_OR_NULL(obj))
- + return obj ? PTR_ERR(obj) : -ENXIO;
- +
- + if (obj->buffer.length != 1 || obj->buffer.pointer[0] != 0) {
- + dev_err(dev, "got unexpected result from _DSM\n");
- + return -EFAULT;
- + }
- +
- + ACPI_FREE(obj);
- + return 0;
- +}
- +
- +static int san_acpi_notify_sensor_trip_point(struct device *dev, u8 iid)
- +{
- + acpi_handle san = ACPI_HANDLE(dev);
- + union acpi_object *obj;
- + union acpi_object param;
- +
- + if (!san_acpi_can_notify(dev, SAN_DSM_FN_NOTIFY_SENSOR_TRIP_POINT))
- + return 0;
- +
- + param.type = ACPI_TYPE_INTEGER;
- + param.integer.value = iid;
- +
- + obj = acpi_evaluate_dsm_typed(san, &SAN_DSM_UUID, SAN_DSM_REVISION,
- + SAN_DSM_FN_NOTIFY_SENSOR_TRIP_POINT,
- + ¶m, ACPI_TYPE_BUFFER);
- +
- + if (IS_ERR_OR_NULL(obj))
- + return obj ? PTR_ERR(obj) : -ENXIO;
- +
- + if (obj->buffer.length != 1 || obj->buffer.pointer[0] != 0) {
- + dev_err(dev, "got unexpected result from _DSM\n");
- + return -EFAULT;
- + }
- +
- + ACPI_FREE(obj);
- + return 0;
- +}
- +
- +
- +static inline int san_evt_power_adapter(struct device *dev, const struct ssam_event *event)
- +{
- + int status;
- +
- + status = san_acpi_notify_power_event(dev, SAN_PWR_EVENT_ADP1_STAT);
- + if (status)
- + return status;
- +
- + /*
- + * Enusre that the battery states get updated correctly.
- + * When the battery is fully charged and an adapter is plugged in, it
- + * sometimes is not updated correctly, instead showing it as charging.
- + * Explicitly trigger battery updates to fix this.
- + */
- +
- + status = san_acpi_notify_power_event(dev, SAN_PWR_EVENT_BAT1_STAT);
- + if (status)
- + return status;
- +
- + return san_acpi_notify_power_event(dev, SAN_PWR_EVENT_BAT2_STAT);
- +}
- +
- +static inline int san_evt_power_bix(struct device *dev, const struct ssam_event *event)
- +{
- + enum san_pwr_event evcode;
- +
- + if (event->instance_id == 0x02)
- + evcode = SAN_PWR_EVENT_BAT2_INFO;
- + else
- + evcode = SAN_PWR_EVENT_BAT1_INFO;
- +
- + return san_acpi_notify_power_event(dev, evcode);
- +}
- +
- +static inline int san_evt_power_bst(struct device *dev, const struct ssam_event *event)
- +{
- + enum san_pwr_event evcode;
- +
- + if (event->instance_id == 0x02)
- + evcode = SAN_PWR_EVENT_BAT2_STAT;
- + else
- + evcode = SAN_PWR_EVENT_BAT1_STAT;
- +
- + return san_acpi_notify_power_event(dev, evcode);
- +}
- +
- +static inline int san_evt_power_dptf(struct device *dev, const struct ssam_event *event)
- +{
- + union acpi_object payload;
- + acpi_handle san = ACPI_HANDLE(dev);
- + union acpi_object *obj;
- +
- + if (!san_acpi_can_notify(dev, SAN_PWR_EVENT_DPTF))
- + return 0;
- +
- + /*
- + * The Surface ACPI expects a buffer and not a package. It specifically
- + * checks for ObjectType (Arg3) == 0x03. This will cause a warning in
- + * acpica/nsarguments.c, but this can safely be ignored.
- + */
- + payload.type = ACPI_TYPE_BUFFER;
- + payload.buffer.length = event->length;
- + payload.buffer.pointer = (u8 *)&event->data[0];
- +
- + dev_dbg(dev, "notify power event 0x%02x\n", event->command_id);
- + obj = acpi_evaluate_dsm_typed(san, &SAN_DSM_UUID, SAN_DSM_REVISION,
- + SAN_PWR_EVENT_DPTF, &payload,
- + ACPI_TYPE_BUFFER);
- +
- + if (IS_ERR_OR_NULL(obj))
- + return obj ? PTR_ERR(obj) : -ENXIO;
- +
- + if (obj->buffer.length != 1 || obj->buffer.pointer[0] != 0) {
- + dev_err(dev, "got unexpected result from _DSM\n");
- + return -EFAULT;
- + }
- +
- + ACPI_FREE(obj);
- + return 0;
- +}
- +
- +static unsigned long san_evt_power_delay(u8 cid)
- +{
- + switch (cid) {
- + case SAM_EVENT_PWR_CID_ADAPTER:
- + /*
- + * Wait for battery state to update before signalling adapter change.
- + */
- + return SAM_EVENT_DELAY_PWR_ADAPTER;
- +
- + case SAM_EVENT_PWR_CID_BST:
- + /*
- + * Ensure we do not miss anything important due to caching.
- + */
- + return SAM_EVENT_DELAY_PWR_BST;
- +
- + case SAM_EVENT_PWR_CID_BIX:
- + case SAM_EVENT_PWR_CID_DPTF:
- + default:
- + return 0;
- + }
- +}
- +
- +static bool san_evt_power(const struct ssam_event *event, struct device *dev)
- +{
- + int status;
- +
- + switch (event->command_id) {
- + case SAM_EVENT_PWR_CID_BIX:
- + status = san_evt_power_bix(dev, event);
- + break;
- +
- + case SAM_EVENT_PWR_CID_BST:
- + status = san_evt_power_bst(dev, event);
- + break;
- +
- + case SAM_EVENT_PWR_CID_ADAPTER:
- + status = san_evt_power_adapter(dev, event);
- + break;
- +
- + case SAM_EVENT_PWR_CID_DPTF:
- + status = san_evt_power_dptf(dev, event);
- + break;
- +
- + default:
- + return false;
- + }
- +
- + if (status)
- + dev_err(dev, "error handling power event (cid = %x)\n",
- + event->command_id);
- +
- + return true;
- +}
- +
- +static void san_evt_power_workfn(struct work_struct *work)
- +{
- + struct san_event_work *ev = container_of(work, struct san_event_work, work.work);
- +
- + san_evt_power(&ev->event, &ev->dev->dev);
- + kfree(ev);
- +}
- +
- +
- +static u32 san_evt_power_nb(struct ssam_notifier_block *nb, const struct ssam_event *event)
- +{
- + struct san_drvdata *drvdata = container_of(nb, struct san_drvdata, nf_bat.base);
- + struct san_event_work *work;
- + unsigned long delay = san_evt_power_delay(event->command_id);
- +
- + if (delay == 0) {
- + if (san_evt_power(event, &drvdata->dev->dev))
- + return SSAM_NOTIF_HANDLED;
- + else
- + return 0;
- + }
- +
- + work = kzalloc(sizeof(struct san_event_work) + event->length, GFP_KERNEL);
- + if (!work)
- + return ssam_notifier_from_errno(-ENOMEM);
- +
- + INIT_DELAYED_WORK(&work->work, san_evt_power_workfn);
- + work->dev = drvdata->dev;
- +
- + memcpy(&work->event, event, sizeof(struct ssam_event) + event->length);
- +
- + schedule_delayed_work(&work->work, delay);
- + return SSAM_NOTIF_HANDLED;
- +}
- +
- +
- +static inline int san_evt_thermal_notify(struct device *dev, const struct ssam_event *event)
- +{
- + return san_acpi_notify_sensor_trip_point(dev, event->instance_id);
- +}
- +
- +static bool san_evt_thermal(const struct ssam_event *event, struct device *dev)
- +{
- + int status;
- +
- + switch (event->command_id) {
- + case SAM_EVENT_TEMP_CID_NOTIFY_SENSOR_TRIP_POINT:
- + status = san_evt_thermal_notify(dev, event);
- + break;
- +
- + default:
- + return false;
- + }
- +
- + if (status) {
- + dev_err(dev, "error handling thermal event (cid = %x)\n",
- + event->command_id);
- + }
- +
- + return true;
- +}
- +
- +static u32 san_evt_thermal_nb(struct ssam_notifier_block *nb, const struct ssam_event *event)
- +{
- + struct san_drvdata *drvdata = container_of(nb, struct san_drvdata, nf_tmp.base);
- + struct platform_device *pdev = drvdata->dev;
- +
- + if (san_evt_thermal(event, &pdev->dev))
- + return SSAM_NOTIF_HANDLED;
- + else
- + return 0;
- +}
- +
- +
- +static struct gsb_data_rqsx
- +*san_validate_rqsx(struct device *dev, const char *type, struct gsb_buffer *buffer)
- +{
- + struct gsb_data_rqsx *rqsx = &buffer->data.rqsx;
- +
- + if (buffer->len < 8) {
- + dev_err(dev, "invalid %s package (len = %d)\n",
- + type, buffer->len);
- + return NULL;
- + }
- +
- + if (rqsx->cdl != buffer->len - 8) {
- + dev_err(dev, "bogus %s package (len = %d, cdl = %d)\n",
- + type, buffer->len, rqsx->cdl);
- + return NULL;
- + }
- +
- + if (rqsx->tid != 0x01) {
- + dev_warn(dev, "unsupported %s package (tid = 0x%02x)\n",
- + type, rqsx->tid);
- + return NULL;
- + }
- +
- + return rqsx;
- +}
- +
- +static acpi_status
- +san_etwl(struct san_opreg_context *ctx, struct gsb_buffer *buffer)
- +{
- + struct gsb_data_etwl *etwl = &buffer->data.etwl;
- +
- + if (buffer->len < 3) {
- + dev_err(ctx->dev, "invalid ETWL package (len = %d)\n", buffer->len);
- + return AE_OK;
- + }
- +
- + dev_err(ctx->dev, "ETWL(0x%02x, 0x%02x): %.*s\n",
- + etwl->etw3, etwl->etw4,
- + buffer->len - 3, (char *)etwl->msg);
- +
- + // indicate success
- + buffer->status = 0x00;
- + buffer->len = 0x00;
- +
- + return AE_OK;
- +}
- +
- +static acpi_status
- +san_rqst(struct san_opreg_context *ctx, struct gsb_buffer *buffer)
- +{
- + struct gsb_data_rqsx *gsb_rqst = san_validate_rqsx(ctx->dev, "RQST", buffer);
- + struct surface_sam_ssh_rqst rqst = {};
- + struct surface_sam_ssh_buf result = {};
- + int status = 0;
- + int try;
- +
- + if (!gsb_rqst)
- + return AE_OK;
- +
- + rqst.tc = gsb_rqst->tc;
- + rqst.cid = gsb_rqst->cid;
- + rqst.iid = gsb_rqst->iid;
- + rqst.chn = gsb_rqst->tid;
- + rqst.snc = gsb_rqst->snc;
- + rqst.cdl = gsb_rqst->cdl;
- + rqst.pld = &gsb_rqst->pld[0];
- +
- + result.cap = SURFACE_SAM_SSH_MAX_RQST_RESPONSE;
- + result.len = 0;
- + result.data = kzalloc(result.cap, GFP_KERNEL);
- +
- + if (!result.data)
- + return AE_NO_MEMORY;
- +
- + for (try = 0; try < SAN_RQST_RETRY; try++) {
- + if (try)
- + dev_warn(ctx->dev, SAN_RQST_TAG "IO error occurred, trying again\n");
- +
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status != -EIO)
- + break;
- + }
- +
- + if (rqst.tc == 0x11 && rqst.cid == 0x0D && status == -EPERM) {
- + /* Base state quirk:
- + * The base state may be queried from ACPI when the EC is still
- + * suspended. In this case it will return '-EPERM'. This query
- + * will only be triggered from the ACPI lid GPE interrupt, thus
- + * we are either in laptop or studio mode (base status 0x01 or
- + * 0x02). Furthermore, we will only get here if the device (and
- + * EC) have been suspended.
- + *
- + * We now assume that the device is in laptop mode (0x01). This
- + * has the drawback that it will wake the device when unfolding
- + * it in studio mode, but it also allows us to avoid actively
- + * waiting for the EC to wake up, which may incur a notable
- + * delay.
- + */
- +
- + buffer->status = 0x00;
- + buffer->len = 0x03;
- + buffer->data.out.status = 0x00;
- + buffer->data.out.len = 0x01;
- + buffer->data.out.pld[0] = 0x01;
- +
- + } else if (!status) { // success
- + buffer->status = 0x00;
- + buffer->len = result.len + 2;
- + buffer->data.out.status = 0x00;
- + buffer->data.out.len = result.len;
- + memcpy(&buffer->data.out.pld[0], result.data, result.len);
- +
- + } else { // failure
- + dev_err(ctx->dev, SAN_RQST_TAG "failed with error %d\n", status);
- + buffer->status = 0x00;
- + buffer->len = 0x02;
- + buffer->data.out.status = 0x01; // indicate _SSH error
- + buffer->data.out.len = 0x00;
- + }
- +
- + kfree(result.data);
- +
- + return AE_OK;
- +}
- +
- +static acpi_status
- +san_rqsg(struct san_opreg_context *ctx, struct gsb_buffer *buffer)
- +{
- + struct gsb_data_rqsx *gsb_rqsg = san_validate_rqsx(ctx->dev, "RQSG", buffer);
- + struct surface_sam_san_rqsg rqsg = {};
- + int status;
- +
- + if (!gsb_rqsg)
- + return AE_OK;
- +
- + rqsg.tc = gsb_rqsg->tc;
- + rqsg.cid = gsb_rqsg->cid;
- + rqsg.iid = gsb_rqsg->iid;
- + rqsg.cdl = gsb_rqsg->cdl;
- + rqsg.pld = &gsb_rqsg->pld[0];
- +
- + status = san_call_rqsg_handler(&rqsg);
- + if (!status) {
- + buffer->status = 0x00;
- + buffer->len = 0x02;
- + buffer->data.out.status = 0x00;
- + buffer->data.out.len = 0x00;
- + } else {
- + dev_err(ctx->dev, SAN_RQSG_TAG "failed with error %d\n", status);
- + buffer->status = 0x00;
- + buffer->len = 0x02;
- + buffer->data.out.status = 0x01; // indicate _SSH error
- + buffer->data.out.len = 0x00;
- + }
- +
- + return AE_OK;
- +}
- +
- +
- +static acpi_status
- +san_opreg_handler(u32 function, acpi_physical_address command,
- + u32 bits, u64 *value64,
- + void *opreg_context, void *region_context)
- +{
- + struct san_opreg_context *context = opreg_context;
- + struct gsb_buffer *buffer = (struct gsb_buffer *)value64;
- + int accessor_type = (0xFFFF0000 & function) >> 16;
- +
- + if (command != 0) {
- + dev_warn(context->dev, "unsupported command: 0x%02llx\n", command);
- + return AE_OK;
- + }
- +
- + if (accessor_type != ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS) {
- + dev_err(context->dev, "invalid access type: 0x%02x\n", accessor_type);
- + return AE_OK;
- + }
- +
- + // buffer must have at least contain the command-value
- + if (buffer->len == 0) {
- + dev_err(context->dev, "request-package too small\n");
- + return AE_OK;
- + }
- +
- + switch (buffer->data.in.cv) {
- + case 0x01: return san_rqst(context, buffer);
- + case 0x02: return san_etwl(context, buffer);
- + case 0x03: return san_rqsg(context, buffer);
- + }
- +
- + dev_warn(context->dev, "unsupported SAN0 request (cv: 0x%02x)\n", buffer->data.in.cv);
- + return AE_OK;
- +}
- +
- +static int san_events_register(struct platform_device *pdev)
- +{
- + struct san_drvdata *drvdata = platform_get_drvdata(pdev);
- + int status;
- +
- + drvdata->nf_bat.base.priority = 1;
- + drvdata->nf_bat.base.fn = san_evt_power_nb;
- + drvdata->nf_bat.event.reg = SSAM_EVENT_REGISTRY_SAM;
- + drvdata->nf_bat.event.id.target_category = SSAM_SSH_TC_BAT;
- + drvdata->nf_bat.event.id.instance = 0;
- + drvdata->nf_bat.event.flags = SSAM_EVENT_SEQUENCED;
- +
- + drvdata->nf_tmp.base.priority = 1;
- + drvdata->nf_tmp.base.fn = san_evt_thermal_nb;
- + drvdata->nf_tmp.event.reg = SSAM_EVENT_REGISTRY_SAM;
- + drvdata->nf_tmp.event.id.target_category = SSAM_SSH_TC_TMP;
- + drvdata->nf_tmp.event.id.instance = 0;
- + drvdata->nf_tmp.event.flags = SSAM_EVENT_SEQUENCED;
- +
- + status = surface_sam_ssh_notifier_register(&drvdata->nf_bat);
- + if (status)
- + return status;
- +
- + status = surface_sam_ssh_notifier_register(&drvdata->nf_tmp);
- + if (status)
- + surface_sam_ssh_notifier_unregister(&drvdata->nf_bat);
- +
- + return status;
- +}
- +
- +static void san_events_unregister(struct platform_device *pdev)
- +{
- + struct san_drvdata *drvdata = platform_get_drvdata(pdev);
- +
- + surface_sam_ssh_notifier_unregister(&drvdata->nf_bat);
- + surface_sam_ssh_notifier_unregister(&drvdata->nf_tmp);
- +}
- +
- +
- +static int san_consumers_link(struct platform_device *pdev,
- + const struct san_acpi_consumer *cons,
- + struct san_consumers *out)
- +{
- + const struct san_acpi_consumer *con;
- + struct san_consumer_link *links, *link;
- + struct acpi_device *adev;
- + acpi_handle handle;
- + u32 max_links = 0;
- + int status;
- +
- + if (!cons)
- + return 0;
- +
- + // count links
- + for (con = cons; con->path; ++con)
- + max_links += 1;
- +
- + // allocate
- + links = kcalloc(max_links, sizeof(struct san_consumer_link), GFP_KERNEL);
- + link = &links[0];
- +
- + if (!links)
- + return -ENOMEM;
- +
- + // create links
- + for (con = cons; con->path; ++con) {
- + status = acpi_get_handle(NULL, con->path, &handle);
- + if (status) {
- + if (con->required || status != AE_NOT_FOUND) {
- + status = -ENXIO;
- + goto cleanup;
- + } else {
- + continue;
- + }
- + }
- +
- + status = acpi_bus_get_device(handle, &adev);
- + if (status)
- + goto cleanup;
- +
- + link->link = device_link_add(&adev->dev, &pdev->dev, con->flags);
- + if (!(link->link)) {
- + status = -EFAULT;
- + goto cleanup;
- + }
- + link->properties = con;
- +
- + link += 1;
- + }
- +
- + out->num = link - links;
- + out->links = links;
- +
- + return 0;
- +
- +cleanup:
- + for (link = link - 1; link >= links; --link) {
- + if (link->properties->flags & DL_FLAG_STATELESS)
- + device_link_del(link->link);
- + }
- +
- + return status;
- +}
- +
- +static void san_consumers_unlink(struct san_consumers *consumers)
- +{
- + u32 i;
- +
- + if (!consumers)
- + return;
- +
- + for (i = 0; i < consumers->num; ++i) {
- + if (consumers->links[i].properties->flags & DL_FLAG_STATELESS)
- + device_link_del(consumers->links[i].link);
- + }
- +
- + kfree(consumers->links);
- +
- + consumers->num = 0;
- + consumers->links = NULL;
- +}
- +
- +static int surface_sam_san_probe(struct platform_device *pdev)
- +{
- + const struct san_acpi_consumer *cons;
- + struct san_drvdata *drvdata;
- + acpi_handle san = ACPI_HANDLE(&pdev->dev); // _SAN device node
- + int status;
- +
- + /*
- + * Defer probe if the _SSH driver has not set up the controller yet. This
- + * makes sure we do not fail any initial requests (e.g. _STA request without
- + * which the battery does not get set up correctly). Otherwise register as
- + * consumer to set up a device_link.
- + */
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + drvdata = kzalloc(sizeof(struct san_drvdata), GFP_KERNEL);
- + if (!drvdata)
- + return -ENOMEM;
- +
- + drvdata->dev = pdev;
- + drvdata->opreg_ctx.dev = &pdev->dev;
- +
- + cons = acpi_device_get_match_data(&pdev->dev);
- + status = san_consumers_link(pdev, cons, &drvdata->consumers);
- + if (status)
- + goto err_consumers;
- +
- + platform_set_drvdata(pdev, drvdata);
- +
- + status = acpi_install_address_space_handler(san,
- + ACPI_ADR_SPACE_GSBUS,
- + &san_opreg_handler,
- + NULL, &drvdata->opreg_ctx);
- +
- + if (ACPI_FAILURE(status)) {
- + status = -ENODEV;
- + goto err_install_handler;
- + }
- +
- + status = san_events_register(pdev);
- + if (status)
- + goto err_enable_events;
- +
- + mutex_lock(&rqsg_if.lock);
- + if (!rqsg_if.san_dev)
- + rqsg_if.san_dev = &pdev->dev;
- + else
- + status = -EBUSY;
- + mutex_unlock(&rqsg_if.lock);
- +
- + if (status)
- + goto err_install_dev;
- +
- + acpi_walk_dep_device_list(san);
- + return 0;
- +
- +err_install_dev:
- + san_events_unregister(pdev);
- +err_enable_events:
- + acpi_remove_address_space_handler(san, ACPI_ADR_SPACE_GSBUS, &san_opreg_handler);
- +err_install_handler:
- + platform_set_drvdata(san, NULL);
- + san_consumers_unlink(&drvdata->consumers);
- +err_consumers:
- + kfree(drvdata);
- + return status;
- +}
- +
- +static int surface_sam_san_remove(struct platform_device *pdev)
- +{
- + struct san_drvdata *drvdata = platform_get_drvdata(pdev);
- + acpi_handle san = ACPI_HANDLE(&pdev->dev); // _SAN device node
- + acpi_status status = AE_OK;
- +
- + mutex_lock(&rqsg_if.lock);
- + rqsg_if.san_dev = NULL;
- + mutex_unlock(&rqsg_if.lock);
- +
- + acpi_remove_address_space_handler(san, ACPI_ADR_SPACE_GSBUS, &san_opreg_handler);
- + san_events_unregister(pdev);
- +
- + /*
- + * We have unregistered our event sources. Now we need to ensure that
- + * all delayed works they may have spawned are run to completion.
- + */
- + flush_scheduled_work();
- +
- + san_consumers_unlink(&drvdata->consumers);
- + kfree(drvdata);
- +
- + platform_set_drvdata(pdev, NULL);
- + return status;
- +}
- +
- +
- +static const struct san_acpi_consumer san_mshw0091_consumers[] = {
- + { "\\_SB.SRTC", true, DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS },
- + { "\\ADP1", true, DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS },
- + { "\\_SB.BAT1", true, DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS },
- + { "\\_SB.BAT2", false, DL_FLAG_PM_RUNTIME | DL_FLAG_STATELESS },
- + { },
- +};
- +
- +static const struct acpi_device_id surface_sam_san_match[] = {
- + { "MSHW0091", (unsigned long) san_mshw0091_consumers },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surface_sam_san_match);
- +
- +static struct platform_driver surface_sam_san = {
- + .probe = surface_sam_san_probe,
- + .remove = surface_sam_san_remove,
- + .driver = {
- + .name = "surface_sam_san",
- + .acpi_match_table = surface_sam_san_match,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_san);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface ACPI Notify Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_san.h b/drivers/platform/x86/surface_sam/surface_sam_san.h
- new file mode 100644
- index 000000000000..2b9dee159bbb
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_san.h
- @@ -0,0 +1,30 @@
- +/* SPDX-License-Identifier: GPL-2.0-or-later */
- +/*
- + * Interface for Surface ACPI/Notify (SAN).
- + *
- + * The SAN is the main interface between the Surface Serial Hub (SSH) and the
- + * Surface/System Aggregator Module (SAM). It allows requests to be translated
- + * from ACPI to SSH/SAM. It also interfaces with the discrete GPU hot-plug
- + * driver.
- + */
- +
- +#ifndef _SURFACE_SAM_SAN_H
- +#define _SURFACE_SAM_SAN_H
- +
- +#include <linux/types.h>
- +
- +
- +struct surface_sam_san_rqsg {
- + u8 tc; // target category
- + u8 cid; // command ID
- + u8 iid; // instance ID
- + u8 cdl; // command data length (length of payload)
- + u8 *pld; // pointer to payload of length cdl
- +};
- +
- +typedef int (*surface_sam_san_rqsg_handler_fn)(struct surface_sam_san_rqsg *rqsg, void *data);
- +
- +int surface_sam_san_consumer_register(struct device *consumer, u32 flags);
- +int surface_sam_san_set_rqsg_handler(surface_sam_san_rqsg_handler_fn fn, void *data);
- +
- +#endif /* _SURFACE_SAM_SAN_H */
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid.c b/drivers/platform/x86/surface_sam/surface_sam_sid.c
- new file mode 100644
- index 000000000000..caa2e6446b5f
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid.c
- @@ -0,0 +1,281 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface Integration Driver.
- + * MFD driver to provide device/model dependent functionality.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/kernel.h>
- +#include <linux/module.h>
- +#include <linux/platform_device.h>
- +#include <linux/mfd/core.h>
- +
- +#include "surface_sam_sid_power.h"
- +#include "surface_sam_sid_vhf.h"
- +
- +
- +struct ssam_battery_properties ssam_battery_props_bat1 = {
- + .registry = SSAM_EVENT_REGISTRY_SAM,
- + .num = 0,
- + .channel = 1,
- + .instance = 1,
- +};
- +
- +struct ssam_battery_properties ssam_battery_props_bat2_sb3 = {
- + .registry = SSAM_EVENT_REGISTRY_KIP,
- + .num = 1,
- + .channel = 2,
- + .instance = 1,
- +};
- +
- +
- +static const struct ssam_hid_properties ssam_hid_props_keyboard = {
- + .registry = SSAM_EVENT_REGISTRY_REG,
- + .instance = 1,
- +};
- +
- +static const struct ssam_hid_properties ssam_hid_props_touchpad = {
- + .registry = SSAM_EVENT_REGISTRY_REG,
- + .instance = 3,
- +};
- +
- +static const struct ssam_hid_properties ssam_hid_props_iid5 = {
- + .registry = SSAM_EVENT_REGISTRY_REG,
- + .instance = 5,
- +};
- +
- +static const struct ssam_hid_properties ssam_hid_props_iid6 = {
- + .registry = SSAM_EVENT_REGISTRY_REG,
- + .instance = 6,
- +};
- +
- +
- +static const struct mfd_cell sid_devs_sp4[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sp6[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sp7[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { .name = "surface_sam_sid_ac", .id = -1 },
- + {
- + .name = "surface_sam_sid_battery",
- + .id = -1,
- + .platform_data = &ssam_battery_props_bat1,
- + .pdata_size = sizeof(struct ssam_battery_properties),
- + },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sb1[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sb2[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sb3[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { .name = "surface_sam_sid_ac", .id = -1 },
- + {
- + .name = "surface_sam_sid_battery",
- + .id = 1,
- + .platform_data = &ssam_battery_props_bat1,
- + .pdata_size = sizeof(struct ssam_battery_properties),
- + },
- + {
- + .name = "surface_sam_sid_battery",
- + .id = 2,
- + .platform_data = &ssam_battery_props_bat2_sb3,
- + .pdata_size = sizeof(struct ssam_battery_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 1,
- + .platform_data = (void *)&ssam_hid_props_keyboard,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 3,
- + .platform_data = (void *)&ssam_hid_props_touchpad,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 5,
- + .platform_data = (void *)&ssam_hid_props_iid5,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 6,
- + .platform_data = (void *)&ssam_hid_props_iid6,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sl1[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sl2[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sl3_13[] = {
- + { .name = "surface_sam_sid_gpelid", .id = -1 },
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { .name = "surface_sam_sid_ac", .id = -1 },
- + {
- + .name = "surface_sam_sid_battery",
- + .id = -1,
- + .platform_data = &ssam_battery_props_bat1,
- + .pdata_size = sizeof(struct ssam_battery_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 1,
- + .platform_data = (void *)&ssam_hid_props_keyboard,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 3,
- + .platform_data = (void *)&ssam_hid_props_touchpad,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 5,
- + .platform_data = (void *)&ssam_hid_props_iid5,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + { },
- +};
- +
- +static const struct mfd_cell sid_devs_sl3_15[] = {
- + { .name = "surface_sam_sid_perfmode", .id = -1 },
- + { .name = "surface_sam_sid_ac", .id = -1 },
- + {
- + .name = "surface_sam_sid_battery",
- + .id = -1,
- + .platform_data = &ssam_battery_props_bat1,
- + .pdata_size = sizeof(struct ssam_battery_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 1,
- + .platform_data = (void *)&ssam_hid_props_keyboard,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 3,
- + .platform_data = (void *)&ssam_hid_props_touchpad,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + {
- + .name = "surface_sam_sid_vhf",
- + .id = 5,
- + .platform_data = (void *)&ssam_hid_props_iid5,
- + .pdata_size = sizeof(struct ssam_hid_properties),
- + },
- + { },
- +};
- +
- +static const struct acpi_device_id surface_sam_sid_match[] = {
- + /* Surface Pro 4, 5, and 6 */
- + { "MSHW0081", (unsigned long)sid_devs_sp4 },
- +
- + /* Surface Pro 6 (OMBR >= 0x10) */
- + { "MSHW0111", (unsigned long)sid_devs_sp6 },
- +
- + /* Surface Pro 7 */
- + { "MSHW0116", (unsigned long)sid_devs_sp7 },
- +
- + /* Surface Book 1 */
- + { "MSHW0080", (unsigned long)sid_devs_sb1 },
- +
- + /* Surface Book 2 */
- + { "MSHW0107", (unsigned long)sid_devs_sb2 },
- +
- + /* Surface Book 3 */
- + { "MSHW0117", (unsigned long)sid_devs_sb3 },
- +
- + /* Surface Laptop 1 */
- + { "MSHW0086", (unsigned long)sid_devs_sl1 },
- +
- + /* Surface Laptop 2 */
- + { "MSHW0112", (unsigned long)sid_devs_sl2 },
- +
- + /* Surface Laptop 3 (13") */
- + { "MSHW0114", (unsigned long)sid_devs_sl3_13 },
- +
- + /* Surface Laptop 3 (15") */
- + { "MSHW0110", (unsigned long)sid_devs_sl3_15 },
- +
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surface_sam_sid_match);
- +
- +
- +static int surface_sam_sid_probe(struct platform_device *pdev)
- +{
- + const struct acpi_device_id *match;
- + const struct mfd_cell *cells, *p;
- +
- + match = acpi_match_device(surface_sam_sid_match, &pdev->dev);
- + if (!match)
- + return -ENODEV;
- +
- + cells = (struct mfd_cell *)match->driver_data;
- + if (!cells)
- + return -ENODEV;
- +
- + for (p = cells; p->name; ++p) {
- + /* just count */
- + }
- +
- + if (p == cells)
- + return -ENODEV;
- +
- + return mfd_add_devices(&pdev->dev, 0, cells, p - cells, NULL, 0, NULL);
- +}
- +
- +static int surface_sam_sid_remove(struct platform_device *pdev)
- +{
- + mfd_remove_devices(&pdev->dev);
- + return 0;
- +}
- +
- +static struct platform_driver surface_sam_sid = {
- + .probe = surface_sam_sid_probe,
- + .remove = surface_sam_sid_remove,
- + .driver = {
- + .name = "surface_sam_sid",
- + .acpi_match_table = surface_sam_sid_match,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_sid);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Integration Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid_gpelid.c b/drivers/platform/x86/surface_sam/surface_sam_sid_gpelid.c
- new file mode 100644
- index 000000000000..f0cee43c859b
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid_gpelid.c
- @@ -0,0 +1,232 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface Lid driver to enable wakeup from suspend via the lid.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/dmi.h>
- +#include <linux/kernel.h>
- +#include <linux/module.h>
- +#include <linux/platform_device.h>
- +
- +
- +struct sid_lid_device {
- + const char *acpi_path;
- + const u32 gpe_number;
- +};
- +
- +
- +static const struct sid_lid_device lid_device_l17 = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x17,
- +};
- +
- +static const struct sid_lid_device lid_device_l4D = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x4D,
- +};
- +
- +static const struct sid_lid_device lid_device_l4F = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x4F,
- +};
- +
- +static const struct sid_lid_device lid_device_l57 = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x57,
- +};
- +
- +
- +static const struct dmi_system_id dmi_lid_device_table[] = {
- + {
- + .ident = "Surface Pro 4",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 4"),
- + },
- + .driver_data = (void *)&lid_device_l17,
- + },
- + {
- + .ident = "Surface Pro 5",
- + .matches = {
- + /* match for SKU here due to generic product name "Surface Pro" */
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1796"),
- + },
- + .driver_data = (void *)&lid_device_l4F,
- + },
- + {
- + .ident = "Surface Pro 5 (LTE)",
- + .matches = {
- + /* match for SKU here due to generic product name "Surface Pro" */
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1807"),
- + },
- + .driver_data = (void *)&lid_device_l4F,
- + },
- + {
- + .ident = "Surface Pro 6",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 6"),
- + },
- + .driver_data = (void *)&lid_device_l4F,
- + },
- + {
- + .ident = "Surface Pro 7",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 7"),
- + },
- + .driver_data = (void *)&lid_device_l4D,
- + },
- + {
- + .ident = "Surface Book 1",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book"),
- + },
- + .driver_data = (void *)&lid_device_l17,
- + },
- + {
- + .ident = "Surface Book 2",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 2"),
- + },
- + .driver_data = (void *)&lid_device_l17,
- + },
- + {
- + .ident = "Surface Book 3",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 3"),
- + },
- + .driver_data = (void *)&lid_device_l4D,
- + },
- + {
- + .ident = "Surface Laptop 1",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop"),
- + },
- + .driver_data = (void *)&lid_device_l57,
- + },
- + {
- + .ident = "Surface Laptop 2",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop 2"),
- + },
- + .driver_data = (void *)&lid_device_l57,
- + },
- + {
- + .ident = "Surface Laptop 3 (13\")",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Laptop_3_1867:1868"),
- + },
- + .driver_data = (void *)&lid_device_l4D,
- + },
- + { }
- +};
- +
- +
- +static int sid_lid_enable_wakeup(const struct sid_lid_device *dev, bool enable)
- +{
- + int action = enable ? ACPI_GPE_ENABLE : ACPI_GPE_DISABLE;
- + int status;
- +
- + status = acpi_set_gpe_wake_mask(NULL, dev->gpe_number, action);
- + if (status)
- + return -EFAULT;
- +
- + return 0;
- +}
- +
- +
- +static int surface_sam_sid_gpelid_suspend(struct device *dev)
- +{
- + const struct sid_lid_device *ldev;
- +
- + ldev = dev_get_drvdata(dev);
- + return sid_lid_enable_wakeup(ldev, true);
- +}
- +
- +static int surface_sam_sid_gpelid_resume(struct device *dev)
- +{
- + const struct sid_lid_device *ldev;
- +
- + ldev = dev_get_drvdata(dev);
- + return sid_lid_enable_wakeup(ldev, false);
- +}
- +
- +static SIMPLE_DEV_PM_OPS(surface_sam_sid_gpelid_pm,
- + surface_sam_sid_gpelid_suspend,
- + surface_sam_sid_gpelid_resume);
- +
- +
- +static int surface_sam_sid_gpelid_probe(struct platform_device *pdev)
- +{
- + const struct dmi_system_id *match;
- + struct sid_lid_device *dev;
- + acpi_handle lid_handle;
- + int status;
- +
- + match = dmi_first_match(dmi_lid_device_table);
- + if (!match)
- + return -ENODEV;
- +
- + dev = match->driver_data;
- + if (!dev)
- + return -ENODEV;
- +
- + status = acpi_get_handle(NULL, (acpi_string)dev->acpi_path, &lid_handle);
- + if (status)
- + return -EFAULT;
- +
- + status = acpi_setup_gpe_for_wake(lid_handle, NULL, dev->gpe_number);
- + if (status)
- + return -EFAULT;
- +
- + status = acpi_enable_gpe(NULL, dev->gpe_number);
- + if (status)
- + return -EFAULT;
- +
- + status = sid_lid_enable_wakeup(dev, false);
- + if (status) {
- + acpi_disable_gpe(NULL, dev->gpe_number);
- + return status;
- + }
- +
- + platform_set_drvdata(pdev, dev);
- + return 0;
- +}
- +
- +static int surface_sam_sid_gpelid_remove(struct platform_device *pdev)
- +{
- + struct sid_lid_device *dev = platform_get_drvdata(pdev);
- +
- + /* restore default behavior without this module */
- + sid_lid_enable_wakeup(dev, false);
- + acpi_disable_gpe(NULL, dev->gpe_number);
- +
- + platform_set_drvdata(pdev, NULL);
- + return 0;
- +}
- +
- +static struct platform_driver surface_sam_sid_gpelid = {
- + .probe = surface_sam_sid_gpelid_probe,
- + .remove = surface_sam_sid_gpelid_remove,
- + .driver = {
- + .name = "surface_sam_sid_gpelid",
- + .pm = &surface_sam_sid_gpelid_pm,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_sid_gpelid);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Lid Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- +MODULE_ALIAS("platform:surface_sam_sid_gpelid");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid_perfmode.c b/drivers/platform/x86/surface_sam/surface_sam_sid_perfmode.c
- new file mode 100644
- index 000000000000..2e11efb166f2
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid_perfmode.c
- @@ -0,0 +1,216 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface Performance Mode Driver.
- + * Allows to change cooling capabilities based on user preference.
- + */
- +
- +#include <asm/unaligned.h>
- +#include <linux/kernel.h>
- +#include <linux/module.h>
- +#include <linux/platform_device.h>
- +
- +#include "surface_sam_ssh.h"
- +
- +
- +#define SID_PARAM_PERM 0644
- +
- +enum sam_perf_mode {
- + SAM_PERF_MODE_NORMAL = 1,
- + SAM_PERF_MODE_BATTERY = 2,
- + SAM_PERF_MODE_PERF1 = 3,
- + SAM_PERF_MODE_PERF2 = 4,
- +
- + __SAM_PERF_MODE__START = 1,
- + __SAM_PERF_MODE__END = 4,
- +};
- +
- +enum sid_param_perf_mode {
- + SID_PARAM_PERF_MODE_AS_IS = 0,
- + SID_PARAM_PERF_MODE_NORMAL = SAM_PERF_MODE_NORMAL,
- + SID_PARAM_PERF_MODE_BATTERY = SAM_PERF_MODE_BATTERY,
- + SID_PARAM_PERF_MODE_PERF1 = SAM_PERF_MODE_PERF1,
- + SID_PARAM_PERF_MODE_PERF2 = SAM_PERF_MODE_PERF2,
- +
- + __SID_PARAM_PERF_MODE__START = 0,
- + __SID_PARAM_PERF_MODE__END = 4,
- +};
- +
- +
- +static int surface_sam_perf_mode_get(void)
- +{
- + u8 result_buf[8] = { 0 };
- + int status;
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x03,
- + .cid = 0x02,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + .cap = ARRAY_SIZE(result_buf),
- + .len = 0,
- + .data = result_buf,
- + };
- +
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status)
- + return status;
- +
- + if (result.len != 8)
- + return -EFAULT;
- +
- + return get_unaligned_le32(&result.data[0]);
- +}
- +
- +static int surface_sam_perf_mode_set(int perf_mode)
- +{
- + u8 payload[4] = { 0 };
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x03,
- + .cid = 0x03,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x00,
- + .cdl = ARRAY_SIZE(payload),
- + .pld = payload,
- + };
- +
- + if (perf_mode < __SAM_PERF_MODE__START || perf_mode > __SAM_PERF_MODE__END)
- + return -EINVAL;
- +
- + put_unaligned_le32(perf_mode, &rqst.pld[0]);
- + return surface_sam_ssh_rqst(&rqst, NULL);
- +}
- +
- +
- +static int param_perf_mode_set(const char *val, const struct kernel_param *kp)
- +{
- + int perf_mode;
- + int status;
- +
- + status = kstrtoint(val, 0, &perf_mode);
- + if (status)
- + return status;
- +
- + if (perf_mode < __SID_PARAM_PERF_MODE__START || perf_mode > __SID_PARAM_PERF_MODE__END)
- + return -EINVAL;
- +
- + return param_set_int(val, kp);
- +}
- +
- +static const struct kernel_param_ops param_perf_mode_ops = {
- + .set = param_perf_mode_set,
- + .get = param_get_int,
- +};
- +
- +static int param_perf_mode_init = SID_PARAM_PERF_MODE_AS_IS;
- +static int param_perf_mode_exit = SID_PARAM_PERF_MODE_AS_IS;
- +
- +module_param_cb(perf_mode_init, ¶m_perf_mode_ops, ¶m_perf_mode_init, SID_PARAM_PERM);
- +module_param_cb(perf_mode_exit, ¶m_perf_mode_ops, ¶m_perf_mode_exit, SID_PARAM_PERM);
- +
- +MODULE_PARM_DESC(perf_mode_init, "Performance-mode to be set on module initialization");
- +MODULE_PARM_DESC(perf_mode_exit, "Performance-mode to be set on module exit");
- +
- +
- +static ssize_t perf_mode_show(struct device *dev, struct device_attribute *attr, char *data)
- +{
- + int perf_mode;
- +
- + perf_mode = surface_sam_perf_mode_get();
- + if (perf_mode < 0) {
- + dev_err(dev, "failed to get current performance mode: %d\n", perf_mode);
- + return -EIO;
- + }
- +
- + return sprintf(data, "%d\n", perf_mode);
- +}
- +
- +static ssize_t perf_mode_store(struct device *dev, struct device_attribute *attr,
- + const char *data, size_t count)
- +{
- + int perf_mode;
- + int status;
- +
- + status = kstrtoint(data, 0, &perf_mode);
- + if (status)
- + return status;
- +
- + status = surface_sam_perf_mode_set(perf_mode);
- + if (status)
- + return status;
- +
- + // TODO: Should we notify ACPI here?
- + //
- + // There is a _DSM call described as
- + // WSID._DSM: Notify DPTF on Slider State change
- + // which calls
- + // ODV3 = ToInteger (Arg3)
- + // Notify(IETM, 0x88)
- + // IETM is an INT3400 Intel Dynamic Power Performance Management
- + // device, part of the DPTF framework. From the corresponding
- + // kernel driver, it looks like event 0x88 is being ignored. Also
- + // it is currently unknown what the consequecnes of setting ODV3
- + // are.
- +
- + return count;
- +}
- +
- +static const DEVICE_ATTR_RW(perf_mode);
- +
- +
- +static int surface_sam_sid_perfmode_probe(struct platform_device *pdev)
- +{
- + int status;
- +
- + // link to ec
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + // set initial perf_mode
- + if (param_perf_mode_init != SID_PARAM_PERF_MODE_AS_IS) {
- + status = surface_sam_perf_mode_set(param_perf_mode_init);
- + if (status)
- + return status;
- + }
- +
- + // register perf_mode attribute
- + status = sysfs_create_file(&pdev->dev.kobj, &dev_attr_perf_mode.attr);
- + if (status)
- + goto err_sysfs;
- +
- + return 0;
- +
- +err_sysfs:
- + surface_sam_perf_mode_set(param_perf_mode_exit);
- + return status;
- +}
- +
- +static int surface_sam_sid_perfmode_remove(struct platform_device *pdev)
- +{
- + sysfs_remove_file(&pdev->dev.kobj, &dev_attr_perf_mode.attr);
- + surface_sam_perf_mode_set(param_perf_mode_exit);
- + return 0;
- +}
- +
- +static struct platform_driver surface_sam_sid_perfmode = {
- + .probe = surface_sam_sid_perfmode_probe,
- + .remove = surface_sam_sid_perfmode_remove,
- + .driver = {
- + .name = "surface_sam_sid_perfmode",
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_sid_perfmode);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Performance Mode Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- +MODULE_ALIAS("platform:surface_sam_sid_perfmode");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid_power.c b/drivers/platform/x86/surface_sam/surface_sam_sid_power.c
- new file mode 100644
- index 000000000000..1d945c0a911a
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid_power.c
- @@ -0,0 +1,1154 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface SID Battery/AC Driver.
- + * Provides support for the battery and AC on 7th generation Surface devices.
- + */
- +
- +#include <linux/kernel.h>
- +#include <linux/delay.h>
- +#include <linux/jiffies.h>
- +#include <linux/module.h>
- +#include <linux/platform_device.h>
- +#include <linux/power_supply.h>
- +#include <linux/workqueue.h>
- +
- +#include "surface_sam_ssh.h"
- +#include "surface_sam_sid_power.h"
- +
- +#define SPWR_WARN KERN_WARNING KBUILD_MODNAME ": "
- +#define SPWR_DEBUG KERN_DEBUG KBUILD_MODNAME ": "
- +
- +
- +// TODO: check BIX/BST for unknown/unsupported 0xffffffff entries
- +// TODO: DPTF (/SAN notifications)?
- +// TODO: other properties?
- +
- +
- +static unsigned int cache_time = 1000;
- +module_param(cache_time, uint, 0644);
- +MODULE_PARM_DESC(cache_time, "battery state chaching time in milliseconds [default: 1000]");
- +
- +#define SPWR_AC_BAT_UPDATE_DELAY msecs_to_jiffies(5000)
- +
- +
- +/*
- + * SAM Interface.
- + */
- +
- +#define SAM_PWR_TC 0x02
- +
- +#define SAM_RQST_PWR_CID_STA 0x01
- +#define SAM_RQST_PWR_CID_BIX 0x02
- +#define SAM_RQST_PWR_CID_BST 0x03
- +#define SAM_RQST_PWR_CID_BTP 0x04
- +
- +#define SAM_RQST_PWR_CID_PMAX 0x0b
- +#define SAM_RQST_PWR_CID_PSOC 0x0c
- +#define SAM_RQST_PWR_CID_PSRC 0x0d
- +#define SAM_RQST_PWR_CID_CHGI 0x0e
- +#define SAM_RQST_PWR_CID_ARTG 0x0f
- +
- +#define SAM_EVENT_PWR_CID_BIX 0x15
- +#define SAM_EVENT_PWR_CID_BST 0x16
- +#define SAM_EVENT_PWR_CID_ADAPTER 0x17
- +
- +#define SAM_BATTERY_STA_OK 0x0f
- +#define SAM_BATTERY_STA_PRESENT 0x10
- +
- +#define SAM_BATTERY_STATE_DISCHARGING 0x01
- +#define SAM_BATTERY_STATE_CHARGING 0x02
- +#define SAM_BATTERY_STATE_CRITICAL 0x04
- +
- +#define SAM_BATTERY_POWER_UNIT_MA 1
- +
- +
- +/* Equivalent to data returned in ACPI _BIX method */
- +struct spwr_bix {
- + u8 revision;
- + u32 power_unit;
- + u32 design_cap;
- + u32 last_full_charge_cap;
- + u32 technology;
- + u32 design_voltage;
- + u32 design_cap_warn;
- + u32 design_cap_low;
- + u32 cycle_count;
- + u32 measurement_accuracy;
- + u32 max_sampling_time;
- + u32 min_sampling_time;
- + u32 max_avg_interval;
- + u32 min_avg_interval;
- + u32 bat_cap_granularity_1;
- + u32 bat_cap_granularity_2;
- + u8 model[21];
- + u8 serial[11];
- + u8 type[5];
- + u8 oem_info[21];
- +} __packed;
- +
- +/* Equivalent to data returned in ACPI _BST method */
- +struct spwr_bst {
- + u32 state;
- + u32 present_rate;
- + u32 remaining_cap;
- + u32 present_voltage;
- +} __packed;
- +
- +/* DPTF event payload */
- +struct spwr_event_dptf {
- + u32 pmax;
- + u32 _1; /* currently unknown */
- + u32 _2; /* currently unknown */
- +} __packed;
- +
- +
- +/* Get battery status (_STA) */
- +static int sam_psy_get_sta(u8 channel, u8 instance, u32 *sta)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_STA;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(u32);
- + result.len = 0;
- + result.data = (u8 *)sta;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Get battery static information (_BIX) */
- +static int sam_psy_get_bix(u8 channel, u8 instance, struct spwr_bix *bix)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_BIX;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(struct spwr_bix);
- + result.len = 0;
- + result.data = (u8 *)bix;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Get battery dynamic information (_BST) */
- +static int sam_psy_get_bst(u8 channel, u8 instance, struct spwr_bst *bst)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_BST;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(struct spwr_bst);
- + result.len = 0;
- + result.data = (u8 *)bst;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Set battery trip point (_BTP) */
- +static int sam_psy_set_btp(u8 channel, u8 instance, u32 btp)
- +{
- + struct surface_sam_ssh_rqst rqst;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_BTP;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x00;
- + rqst.cdl = sizeof(u32);
- + rqst.pld = (u8 *)&btp;
- +
- + return surface_sam_ssh_rqst(&rqst, NULL);
- +}
- +
- +/* Get platform power soruce for battery (DPTF PSRC) */
- +static int sam_psy_get_psrc(u8 channel, u8 instance, u32 *psrc)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_PSRC;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(u32);
- + result.len = 0;
- + result.data = (u8 *)psrc;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Get maximum platform power for battery (DPTF PMAX) */
- +__always_unused
- +static int sam_psy_get_pmax(u8 channel, u8 instance, u32 *pmax)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_PMAX;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(u32);
- + result.len = 0;
- + result.data = (u8 *)pmax;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Get adapter rating (DPTF ARTG) */
- +__always_unused
- +static int sam_psy_get_artg(u8 channel, u8 instance, u32 *artg)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_ARTG;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(u32);
- + result.len = 0;
- + result.data = (u8 *)artg;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Unknown (DPTF PSOC) */
- +__always_unused
- +static int sam_psy_get_psoc(u8 channel, u8 instance, u32 *psoc)
- +{
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_PSOC;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x01;
- + rqst.cdl = 0x00;
- + rqst.pld = NULL;
- +
- + result.cap = sizeof(u32);
- + result.len = 0;
- + result.data = (u8 *)psoc;
- +
- + return surface_sam_ssh_rqst(&rqst, &result);
- +}
- +
- +/* Unknown (DPTF CHGI/ INT3403 SPPC) */
- +__always_unused
- +static int sam_psy_set_chgi(u8 channel, u8 instance, u32 chgi)
- +{
- + struct surface_sam_ssh_rqst rqst;
- +
- + rqst.tc = SAM_PWR_TC;
- + rqst.cid = SAM_RQST_PWR_CID_CHGI;
- + rqst.iid = instance;
- + rqst.chn = channel;
- + rqst.snc = 0x00;
- + rqst.cdl = sizeof(u32);
- + rqst.pld = (u8 *)&chgi;
- +
- + return surface_sam_ssh_rqst(&rqst, NULL);
- +}
- +
- +
- +/*
- + * Common Power-Subsystem Interface.
- + */
- +
- +struct spwr_battery_device {
- + struct platform_device *pdev;
- + const struct ssam_battery_properties *p;
- +
- + char name[32];
- + struct power_supply *psy;
- + struct power_supply_desc psy_desc;
- +
- + struct delayed_work update_work;
- +
- + struct ssam_event_notifier notif;
- +
- + struct mutex lock;
- + unsigned long timestamp;
- +
- + u32 sta;
- + struct spwr_bix bix;
- + struct spwr_bst bst;
- + u32 alarm;
- +};
- +
- +struct spwr_ac_device {
- + struct platform_device *pdev;
- +
- + char name[32];
- + struct power_supply *psy;
- + struct power_supply_desc psy_desc;
- +
- + struct ssam_event_notifier notif;
- +
- + struct mutex lock;
- +
- + u32 state;
- +};
- +
- +static enum power_supply_property spwr_ac_props[] = {
- + POWER_SUPPLY_PROP_ONLINE,
- +};
- +
- +static enum power_supply_property spwr_battery_props_chg[] = {
- + POWER_SUPPLY_PROP_STATUS,
- + POWER_SUPPLY_PROP_PRESENT,
- + POWER_SUPPLY_PROP_TECHNOLOGY,
- + POWER_SUPPLY_PROP_CYCLE_COUNT,
- + POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
- + POWER_SUPPLY_PROP_VOLTAGE_NOW,
- + POWER_SUPPLY_PROP_CURRENT_NOW,
- + POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
- + POWER_SUPPLY_PROP_CHARGE_FULL,
- + POWER_SUPPLY_PROP_CHARGE_NOW,
- + POWER_SUPPLY_PROP_CAPACITY,
- + POWER_SUPPLY_PROP_CAPACITY_LEVEL,
- + POWER_SUPPLY_PROP_MODEL_NAME,
- + POWER_SUPPLY_PROP_MANUFACTURER,
- + POWER_SUPPLY_PROP_SERIAL_NUMBER,
- +};
- +
- +static enum power_supply_property spwr_battery_props_eng[] = {
- + POWER_SUPPLY_PROP_STATUS,
- + POWER_SUPPLY_PROP_PRESENT,
- + POWER_SUPPLY_PROP_TECHNOLOGY,
- + POWER_SUPPLY_PROP_CYCLE_COUNT,
- + POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
- + POWER_SUPPLY_PROP_VOLTAGE_NOW,
- + POWER_SUPPLY_PROP_POWER_NOW,
- + POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
- + POWER_SUPPLY_PROP_ENERGY_FULL,
- + POWER_SUPPLY_PROP_ENERGY_NOW,
- + POWER_SUPPLY_PROP_CAPACITY,
- + POWER_SUPPLY_PROP_CAPACITY_LEVEL,
- + POWER_SUPPLY_PROP_MODEL_NAME,
- + POWER_SUPPLY_PROP_MANUFACTURER,
- + POWER_SUPPLY_PROP_SERIAL_NUMBER,
- +};
- +
- +
- +static int spwr_battery_register(struct spwr_battery_device *bat,
- + struct platform_device *pdev,
- + const struct ssam_battery_properties *p);
- +
- +static void spwr_battery_unregister(struct spwr_battery_device *bat);
- +
- +
- +static inline bool spwr_battery_present(struct spwr_battery_device *bat)
- +{
- + return bat->sta & SAM_BATTERY_STA_PRESENT;
- +}
- +
- +
- +static inline int spwr_battery_load_sta(struct spwr_battery_device *bat)
- +{
- + return sam_psy_get_sta(bat->p->channel, bat->p->instance, &bat->sta);
- +}
- +
- +static inline int spwr_battery_load_bix(struct spwr_battery_device *bat)
- +{
- + if (!spwr_battery_present(bat))
- + return 0;
- +
- + return sam_psy_get_bix(bat->p->channel, bat->p->instance, &bat->bix);
- +}
- +
- +static inline int spwr_battery_load_bst(struct spwr_battery_device *bat)
- +{
- + if (!spwr_battery_present(bat))
- + return 0;
- +
- + return sam_psy_get_bst(bat->p->channel, bat->p->instance, &bat->bst);
- +}
- +
- +
- +static inline int spwr_battery_set_alarm_unlocked(struct spwr_battery_device *bat, u32 value)
- +{
- + bat->alarm = value;
- + return sam_psy_set_btp(bat->p->channel, bat->p->instance, bat->alarm);
- +}
- +
- +static inline int spwr_battery_set_alarm(struct spwr_battery_device *bat, u32 value)
- +{
- + int status;
- +
- + mutex_lock(&bat->lock);
- + status = spwr_battery_set_alarm_unlocked(bat, value);
- + mutex_unlock(&bat->lock);
- +
- + return status;
- +}
- +
- +static inline int spwr_battery_update_bst_unlocked(struct spwr_battery_device *bat, bool cached)
- +{
- + unsigned long cache_deadline = bat->timestamp + msecs_to_jiffies(cache_time);
- + int status;
- +
- + if (cached && bat->timestamp && time_is_after_jiffies(cache_deadline))
- + return 0;
- +
- + status = spwr_battery_load_sta(bat);
- + if (status)
- + return status;
- +
- + status = spwr_battery_load_bst(bat);
- + if (status)
- + return status;
- +
- + bat->timestamp = jiffies;
- + return 0;
- +}
- +
- +static int spwr_battery_update_bst(struct spwr_battery_device *bat, bool cached)
- +{
- + int status;
- +
- + mutex_lock(&bat->lock);
- + status = spwr_battery_update_bst_unlocked(bat, cached);
- + mutex_unlock(&bat->lock);
- +
- + return status;
- +}
- +
- +static inline int spwr_battery_update_bix_unlocked(struct spwr_battery_device *bat)
- +{
- + int status;
- +
- + status = spwr_battery_load_sta(bat);
- + if (status)
- + return status;
- +
- + status = spwr_battery_load_bix(bat);
- + if (status)
- + return status;
- +
- + status = spwr_battery_load_bst(bat);
- + if (status)
- + return status;
- +
- + bat->timestamp = jiffies;
- + return 0;
- +}
- +
- +static int spwr_battery_update_bix(struct spwr_battery_device *bat)
- +{
- + int status;
- +
- + mutex_lock(&bat->lock);
- + status = spwr_battery_update_bix_unlocked(bat);
- + mutex_unlock(&bat->lock);
- +
- + return status;
- +}
- +
- +static inline int spwr_ac_update_unlocked(struct spwr_ac_device *ac)
- +{
- + return sam_psy_get_psrc(0x01, 0x01, &ac->state);
- +}
- +
- +static int spwr_ac_update(struct spwr_ac_device *ac)
- +{
- + int status;
- +
- + mutex_lock(&ac->lock);
- + status = spwr_ac_update_unlocked(ac);
- + mutex_unlock(&ac->lock);
- +
- + return status;
- +}
- +
- +
- +static int spwr_battery_recheck(struct spwr_battery_device *bat)
- +{
- + bool present = spwr_battery_present(bat);
- + u32 unit = bat->bix.power_unit;
- + int status;
- +
- + status = spwr_battery_update_bix(bat);
- + if (status)
- + return status;
- +
- + // if battery has been attached, (re-)initialize alarm
- + if (!present && spwr_battery_present(bat)) {
- + status = spwr_battery_set_alarm(bat, bat->bix.design_cap_warn);
- + if (status)
- + return status;
- + }
- +
- + // if the unit has changed, re-add the battery
- + if (unit != bat->bix.power_unit) {
- + spwr_battery_unregister(bat);
- + status = spwr_battery_register(bat, bat->pdev, bat->p);
- + }
- +
- + return status;
- +}
- +
- +
- +static inline int spwr_notify_bix(struct spwr_battery_device *bat)
- +{
- + int status;
- +
- + status = spwr_battery_recheck(bat);
- + if (!status)
- + power_supply_changed(bat->psy);
- +
- + return status;
- +}
- +
- +static inline int spwr_notify_bst(struct spwr_battery_device *bat)
- +{
- + int status;
- +
- + status = spwr_battery_update_bst(bat, false);
- + if (!status)
- + power_supply_changed(bat->psy);
- +
- + return status;
- +}
- +
- +static inline int spwr_notify_adapter_bat(struct spwr_battery_device *bat)
- +{
- + /*
- + * Handle battery update quirk:
- + * When the battery is fully charged and the adapter is plugged in or
- + * removed, the EC does not send a separate event for the state
- + * (charging/discharging) change. Furthermore it may take some time until
- + * the state is updated on the battery. Schedule an update to solve this.
- + */
- +
- + if (bat->bst.remaining_cap >= bat->bix.last_full_charge_cap)
- + schedule_delayed_work(&bat->update_work, SPWR_AC_BAT_UPDATE_DELAY);
- +
- + return 0;
- +}
- +
- +static inline int spwr_notify_adapter_ac(struct spwr_ac_device *ac)
- +{
- + int status;
- +
- + status = spwr_ac_update(ac);
- + if (!status)
- + power_supply_changed(ac->psy);
- +
- + return status;
- +}
- +
- +static u32 spwr_notify_bat(struct ssam_notifier_block *nb, const struct ssam_event *event)
- +{
- + struct spwr_battery_device *bat = container_of(nb, struct spwr_battery_device, notif.base);
- + int status;
- +
- + dev_dbg(&bat->pdev->dev, "power event (cid = 0x%02x, iid = %d, chn = %d)\n",
- + event->command_id, event->instance_id, event->channel);
- +
- + // handled here, needs to be handled for all channels/instances
- + if (event->command_id == SAM_EVENT_PWR_CID_ADAPTER) {
- + status = spwr_notify_adapter_bat(bat);
- + return ssam_notifier_from_errno(status) | SSAM_NOTIF_HANDLED;
- + }
- +
- + // check for the correct channel and instance ID
- + if (event->channel != bat->p->channel)
- + return 0;
- +
- + if (event->instance_id != bat->p->instance)
- + return 0;
- +
- + switch (event->command_id) {
- + case SAM_EVENT_PWR_CID_BIX:
- + status = spwr_notify_bix(bat);
- + break;
- +
- + case SAM_EVENT_PWR_CID_BST:
- + status = spwr_notify_bst(bat);
- + break;
- +
- + default:
- + return 0;
- + }
- +
- + return ssam_notifier_from_errno(status) | SSAM_NOTIF_HANDLED;
- +}
- +
- +static u32 spwr_notify_ac(struct ssam_notifier_block *nb, const struct ssam_event *event)
- +{
- + struct spwr_ac_device *ac = container_of(nb, struct spwr_ac_device, notif.base);
- + int status;
- +
- + dev_dbg(&ac->pdev->dev, "power event (cid = 0x%02x, iid = %d, chn = %d)\n",
- + event->command_id, event->instance_id, event->channel);
- +
- + // AC has IID = 0
- + if (event->instance_id != 0)
- + return 0;
- +
- + switch (event->command_id) {
- + case SAM_EVENT_PWR_CID_ADAPTER:
- + status = spwr_notify_adapter_ac(ac);
- + return ssam_notifier_from_errno(status) | SSAM_NOTIF_HANDLED;
- +
- + default:
- + return 0;
- + }
- +}
- +
- +static void spwr_battery_update_bst_workfn(struct work_struct *work)
- +{
- + struct delayed_work *dwork = to_delayed_work(work);
- + struct spwr_battery_device *bat = container_of(dwork, struct spwr_battery_device, update_work);
- + int status;
- +
- + status = spwr_battery_update_bst(bat, false);
- + if (!status)
- + power_supply_changed(bat->psy);
- +
- + if (status)
- + dev_err(&bat->pdev->dev, "failed to update battery state: %d\n", status);
- +}
- +
- +
- +static inline int spwr_battery_prop_status(struct spwr_battery_device *bat)
- +{
- + if (bat->bst.state & SAM_BATTERY_STATE_DISCHARGING)
- + return POWER_SUPPLY_STATUS_DISCHARGING;
- +
- + if (bat->bst.state & SAM_BATTERY_STATE_CHARGING)
- + return POWER_SUPPLY_STATUS_CHARGING;
- +
- + if (bat->bix.last_full_charge_cap == bat->bst.remaining_cap)
- + return POWER_SUPPLY_STATUS_FULL;
- +
- + if (bat->bst.present_rate == 0)
- + return POWER_SUPPLY_STATUS_NOT_CHARGING;
- +
- + return POWER_SUPPLY_STATUS_UNKNOWN;
- +}
- +
- +static inline int spwr_battery_prop_technology(struct spwr_battery_device *bat)
- +{
- + if (!strcasecmp("NiCd", bat->bix.type))
- + return POWER_SUPPLY_TECHNOLOGY_NiCd;
- +
- + if (!strcasecmp("NiMH", bat->bix.type))
- + return POWER_SUPPLY_TECHNOLOGY_NiMH;
- +
- + if (!strcasecmp("LION", bat->bix.type))
- + return POWER_SUPPLY_TECHNOLOGY_LION;
- +
- + if (!strncasecmp("LI-ION", bat->bix.type, 6))
- + return POWER_SUPPLY_TECHNOLOGY_LION;
- +
- + if (!strcasecmp("LiP", bat->bix.type))
- + return POWER_SUPPLY_TECHNOLOGY_LIPO;
- +
- + return POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
- +}
- +
- +static inline int spwr_battery_prop_capacity(struct spwr_battery_device *bat)
- +{
- + if (bat->bst.remaining_cap && bat->bix.last_full_charge_cap)
- + return bat->bst.remaining_cap * 100 / bat->bix.last_full_charge_cap;
- + else
- + return 0;
- +}
- +
- +static inline int spwr_battery_prop_capacity_level(struct spwr_battery_device *bat)
- +{
- + if (bat->bst.state & SAM_BATTERY_STATE_CRITICAL)
- + return POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
- +
- + if (bat->bst.remaining_cap >= bat->bix.last_full_charge_cap)
- + return POWER_SUPPLY_CAPACITY_LEVEL_FULL;
- +
- + if (bat->bst.remaining_cap <= bat->alarm)
- + return POWER_SUPPLY_CAPACITY_LEVEL_LOW;
- +
- + return POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
- +}
- +
- +static int spwr_ac_get_property(struct power_supply *psy,
- + enum power_supply_property psp,
- + union power_supply_propval *val)
- +{
- + struct spwr_ac_device *ac = power_supply_get_drvdata(psy);
- + int status;
- +
- + mutex_lock(&ac->lock);
- +
- + status = spwr_ac_update_unlocked(ac);
- + if (status)
- + goto out;
- +
- + switch (psp) {
- + case POWER_SUPPLY_PROP_ONLINE:
- + val->intval = ac->state == 1;
- + break;
- +
- + default:
- + status = -EINVAL;
- + goto out;
- + }
- +
- +out:
- + mutex_unlock(&ac->lock);
- + return status;
- +}
- +
- +static int spwr_battery_get_property(struct power_supply *psy,
- + enum power_supply_property psp,
- + union power_supply_propval *val)
- +{
- + struct spwr_battery_device *bat = power_supply_get_drvdata(psy);
- + int status;
- +
- + mutex_lock(&bat->lock);
- +
- + status = spwr_battery_update_bst_unlocked(bat, true);
- + if (status)
- + goto out;
- +
- + // abort if battery is not present
- + if (!spwr_battery_present(bat) && psp != POWER_SUPPLY_PROP_PRESENT) {
- + status = -ENODEV;
- + goto out;
- + }
- +
- + switch (psp) {
- + case POWER_SUPPLY_PROP_STATUS:
- + val->intval = spwr_battery_prop_status(bat);
- + break;
- +
- + case POWER_SUPPLY_PROP_PRESENT:
- + val->intval = spwr_battery_present(bat);
- + break;
- +
- + case POWER_SUPPLY_PROP_TECHNOLOGY:
- + val->intval = spwr_battery_prop_technology(bat);
- + break;
- +
- + case POWER_SUPPLY_PROP_CYCLE_COUNT:
- + val->intval = bat->bix.cycle_count;
- + break;
- +
- + case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
- + val->intval = bat->bix.design_voltage * 1000;
- + break;
- +
- + case POWER_SUPPLY_PROP_VOLTAGE_NOW:
- + val->intval = bat->bst.present_voltage * 1000;
- + break;
- +
- + case POWER_SUPPLY_PROP_CURRENT_NOW:
- + case POWER_SUPPLY_PROP_POWER_NOW:
- + val->intval = bat->bst.present_rate * 1000;
- + break;
- +
- + case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
- + case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
- + val->intval = bat->bix.design_cap * 1000;
- + break;
- +
- + case POWER_SUPPLY_PROP_CHARGE_FULL:
- + case POWER_SUPPLY_PROP_ENERGY_FULL:
- + val->intval = bat->bix.last_full_charge_cap * 1000;
- + break;
- +
- + case POWER_SUPPLY_PROP_CHARGE_NOW:
- + case POWER_SUPPLY_PROP_ENERGY_NOW:
- + val->intval = bat->bst.remaining_cap * 1000;
- + break;
- +
- + case POWER_SUPPLY_PROP_CAPACITY:
- + val->intval = spwr_battery_prop_capacity(bat);
- + break;
- +
- + case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
- + val->intval = spwr_battery_prop_capacity_level(bat);
- + break;
- +
- + case POWER_SUPPLY_PROP_MODEL_NAME:
- + val->strval = bat->bix.model;
- + break;
- +
- + case POWER_SUPPLY_PROP_MANUFACTURER:
- + val->strval = bat->bix.oem_info;
- + break;
- +
- + case POWER_SUPPLY_PROP_SERIAL_NUMBER:
- + val->strval = bat->bix.serial;
- + break;
- +
- + default:
- + status = -EINVAL;
- + goto out;
- + }
- +
- +out:
- + mutex_unlock(&bat->lock);
- + return status;
- +}
- +
- +
- +static ssize_t spwr_battery_alarm_show(struct device *dev,
- + struct device_attribute *attr,
- + char *buf)
- +{
- + struct power_supply *psy = dev_get_drvdata(dev);
- + struct spwr_battery_device *bat = power_supply_get_drvdata(psy);
- +
- + return sprintf(buf, "%d\n", bat->alarm * 1000);
- +}
- +
- +static ssize_t spwr_battery_alarm_store(struct device *dev,
- + struct device_attribute *attr,
- + const char *buf, size_t count)
- +{
- + struct power_supply *psy = dev_get_drvdata(dev);
- + struct spwr_battery_device *bat = power_supply_get_drvdata(psy);
- + unsigned long value;
- + int status;
- +
- + status = kstrtoul(buf, 0, &value);
- + if (status)
- + return status;
- +
- + if (!spwr_battery_present(bat))
- + return -ENODEV;
- +
- + status = spwr_battery_set_alarm(bat, value / 1000);
- + if (status)
- + return status;
- +
- + return count;
- +}
- +
- +static const struct device_attribute alarm_attr = {
- + .attr = {.name = "alarm", .mode = 0644},
- + .show = spwr_battery_alarm_show,
- + .store = spwr_battery_alarm_store,
- +};
- +
- +
- +static int spwr_ac_register(struct spwr_ac_device *ac, struct platform_device *pdev)
- +{
- + struct power_supply_config psy_cfg = {};
- + u32 sta;
- + int status;
- +
- + // make sure the device is there and functioning properly
- + status = sam_psy_get_sta(0x01, 0x01, &sta);
- + if (status)
- + return status;
- +
- + if ((sta & SAM_BATTERY_STA_OK) != SAM_BATTERY_STA_OK)
- + return -ENODEV;
- +
- + psy_cfg.drv_data = ac;
- +
- + ac->pdev = pdev;
- + mutex_init(&ac->lock);
- +
- + snprintf(ac->name, ARRAY_SIZE(ac->name), "ADP0");
- +
- + ac->psy_desc.name = ac->name;
- + ac->psy_desc.type = POWER_SUPPLY_TYPE_MAINS;
- + ac->psy_desc.properties = spwr_ac_props;
- + ac->psy_desc.num_properties = ARRAY_SIZE(spwr_ac_props);
- + ac->psy_desc.get_property = spwr_ac_get_property;
- +
- + ac->psy = power_supply_register(&ac->pdev->dev, &ac->psy_desc, &psy_cfg);
- + if (IS_ERR(ac->psy)) {
- + status = PTR_ERR(ac->psy);
- + goto err_psy;
- + }
- +
- + ac->notif.base.priority = 1;
- + ac->notif.base.fn = spwr_notify_ac;
- + ac->notif.event.reg = SSAM_EVENT_REGISTRY_SAM;
- + ac->notif.event.id.target_category = SSAM_SSH_TC_BAT;
- + ac->notif.event.id.instance = 0;
- + ac->notif.event.flags = SSAM_EVENT_SEQUENCED;
- +
- + status = surface_sam_ssh_notifier_register(&ac->notif);
- + if (status)
- + goto err_notif;
- +
- + return 0;
- +
- +err_notif:
- + power_supply_unregister(ac->psy);
- +err_psy:
- + mutex_destroy(&ac->lock);
- + return status;
- +}
- +
- +static int spwr_ac_unregister(struct spwr_ac_device *ac)
- +{
- + surface_sam_ssh_notifier_unregister(&ac->notif);
- + power_supply_unregister(ac->psy);
- + mutex_destroy(&ac->lock);
- + return 0;
- +}
- +
- +static int spwr_battery_register(struct spwr_battery_device *bat,
- + struct platform_device *pdev,
- + const struct ssam_battery_properties *p)
- +{
- + struct power_supply_config psy_cfg = {};
- + u32 sta;
- + int status;
- +
- + bat->pdev = pdev;
- + bat->p = p;
- +
- + // make sure the device is there and functioning properly
- + status = sam_psy_get_sta(bat->p->channel, bat->p->instance, &sta);
- + if (status)
- + return status;
- +
- + if ((sta & SAM_BATTERY_STA_OK) != SAM_BATTERY_STA_OK)
- + return -ENODEV;
- +
- + status = spwr_battery_update_bix_unlocked(bat);
- + if (status)
- + return status;
- +
- + if (spwr_battery_present(bat)) {
- + status = spwr_battery_set_alarm_unlocked(bat, bat->bix.design_cap_warn);
- + if (status)
- + return status;
- + }
- +
- + snprintf(bat->name, ARRAY_SIZE(bat->name), "BAT%d", bat->p->num);
- + bat->psy_desc.name = bat->name;
- + bat->psy_desc.type = POWER_SUPPLY_TYPE_BATTERY;
- +
- + if (bat->bix.power_unit == SAM_BATTERY_POWER_UNIT_MA) {
- + bat->psy_desc.properties = spwr_battery_props_chg;
- + bat->psy_desc.num_properties = ARRAY_SIZE(spwr_battery_props_chg);
- + } else {
- + bat->psy_desc.properties = spwr_battery_props_eng;
- + bat->psy_desc.num_properties = ARRAY_SIZE(spwr_battery_props_eng);
- + }
- +
- + bat->psy_desc.get_property = spwr_battery_get_property;
- +
- + mutex_init(&bat->lock);
- + psy_cfg.drv_data = bat;
- +
- + INIT_DELAYED_WORK(&bat->update_work, spwr_battery_update_bst_workfn);
- +
- + bat->psy = power_supply_register(&bat->pdev->dev, &bat->psy_desc, &psy_cfg);
- + if (IS_ERR(bat->psy)) {
- + status = PTR_ERR(bat->psy);
- + goto err_psy;
- + }
- +
- + bat->notif.base.priority = 1;
- + bat->notif.base.fn = spwr_notify_bat;
- + bat->notif.event.reg = p->registry;
- + bat->notif.event.id.target_category = SSAM_SSH_TC_BAT;
- + bat->notif.event.id.instance = 0;
- + bat->notif.event.flags = SSAM_EVENT_SEQUENCED;
- +
- + status = surface_sam_ssh_notifier_register(&bat->notif);
- + if (status)
- + goto err_notif;
- +
- + status = device_create_file(&bat->psy->dev, &alarm_attr);
- + if (status)
- + goto err_file;
- +
- + return 0;
- +
- +err_file:
- + surface_sam_ssh_notifier_unregister(&bat->notif);
- +err_notif:
- + power_supply_unregister(bat->psy);
- +err_psy:
- + mutex_destroy(&bat->lock);
- + return status;
- +}
- +
- +static void spwr_battery_unregister(struct spwr_battery_device *bat)
- +{
- + surface_sam_ssh_notifier_unregister(&bat->notif);
- + cancel_delayed_work_sync(&bat->update_work);
- + device_remove_file(&bat->psy->dev, &alarm_attr);
- + power_supply_unregister(bat->psy);
- + mutex_destroy(&bat->lock);
- +}
- +
- +
- +/*
- + * Battery Driver.
- + */
- +
- +#ifdef CONFIG_PM_SLEEP
- +static int surface_sam_sid_battery_resume(struct device *dev)
- +{
- + struct spwr_battery_device *bat;
- +
- + bat = dev_get_drvdata(dev);
- + return spwr_battery_recheck(bat);
- +}
- +#else
- +#define surface_sam_sid_battery_resume NULL
- +#endif
- +
- +SIMPLE_DEV_PM_OPS(surface_sam_sid_battery_pm, NULL, surface_sam_sid_battery_resume);
- +
- +static int surface_sam_sid_battery_probe(struct platform_device *pdev)
- +{
- + struct spwr_battery_device *bat;
- + int status;
- +
- + // link to ec
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + bat = devm_kzalloc(&pdev->dev, sizeof(struct spwr_battery_device), GFP_KERNEL);
- + if (!bat)
- + return -ENOMEM;
- +
- + platform_set_drvdata(pdev, bat);
- + return spwr_battery_register(bat, pdev, pdev->dev.platform_data);
- +}
- +
- +static int surface_sam_sid_battery_remove(struct platform_device *pdev)
- +{
- + struct spwr_battery_device *bat;
- +
- + bat = platform_get_drvdata(pdev);
- + spwr_battery_unregister(bat);
- +
- + return 0;
- +}
- +
- +static struct platform_driver surface_sam_sid_battery = {
- + .probe = surface_sam_sid_battery_probe,
- + .remove = surface_sam_sid_battery_remove,
- + .driver = {
- + .name = "surface_sam_sid_battery",
- + .pm = &surface_sam_sid_battery_pm,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +
- +
- +/*
- + * AC Driver.
- + */
- +
- +static int surface_sam_sid_ac_probe(struct platform_device *pdev)
- +{
- + int status;
- + struct spwr_ac_device *ac;
- +
- + // link to ec
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + ac = devm_kzalloc(&pdev->dev, sizeof(struct spwr_ac_device), GFP_KERNEL);
- + if (!ac)
- + return -ENOMEM;
- +
- + status = spwr_ac_register(ac, pdev);
- + if (status)
- + return status;
- +
- + platform_set_drvdata(pdev, ac);
- + return 0;
- +}
- +
- +static int surface_sam_sid_ac_remove(struct platform_device *pdev)
- +{
- + struct spwr_ac_device *ac;
- +
- + ac = platform_get_drvdata(pdev);
- + return spwr_ac_unregister(ac);
- +}
- +
- +static struct platform_driver surface_sam_sid_ac = {
- + .probe = surface_sam_sid_ac_probe,
- + .remove = surface_sam_sid_ac_remove,
- + .driver = {
- + .name = "surface_sam_sid_ac",
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +
- +
- +static int __init surface_sam_sid_power_init(void)
- +{
- + int status;
- +
- + status = platform_driver_register(&surface_sam_sid_battery);
- + if (status)
- + return status;
- +
- + status = platform_driver_register(&surface_sam_sid_ac);
- + if (status) {
- + platform_driver_unregister(&surface_sam_sid_battery);
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +static void __exit surface_sam_sid_power_exit(void)
- +{
- + platform_driver_unregister(&surface_sam_sid_battery);
- + platform_driver_unregister(&surface_sam_sid_ac);
- +}
- +
- +module_init(surface_sam_sid_power_init);
- +module_exit(surface_sam_sid_power_exit);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Battery/AC Driver for 7th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- +MODULE_ALIAS("platform:surface_sam_sid_ac");
- +MODULE_ALIAS("platform:surface_sam_sid_battery");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid_power.h b/drivers/platform/x86/surface_sam/surface_sam_sid_power.h
- new file mode 100644
- index 000000000000..2e8f212086e1
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid_power.h
- @@ -0,0 +1,15 @@
- +#ifndef _SURFACE_SAM_SID_POWER_H
- +#define _SURFACE_SAM_SID_POWER_H
- +
- +#include <linux/types.h>
- +#include "surface_sam_ssh.h"
- +
- +
- +struct ssam_battery_properties {
- + struct ssam_event_registry registry;
- + u8 num;
- + u8 channel;
- + u8 instance;
- +};
- +
- +#endif /* _SURFACE_SAM_SID_POWER_H */
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid_vhf.c b/drivers/platform/x86/surface_sam/surface_sam_sid_vhf.c
- new file mode 100644
- index 000000000000..474221097eaf
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid_vhf.c
- @@ -0,0 +1,432 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Microsofs Surface HID (VHF) driver for HID input events via SAM.
- + * Used for keyboard input events on the 7th generation Surface Laptops.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/hid.h>
- +#include <linux/input.h>
- +#include <linux/platform_device.h>
- +#include <linux/types.h>
- +
- +#include "surface_sam_ssh.h"
- +#include "surface_sam_sid_vhf.h"
- +
- +#define SID_VHF_INPUT_NAME "Microsoft Surface HID"
- +
- +#define SAM_EVENT_SID_VHF_TC 0x15
- +
- +#define VHF_HID_STARTED 0
- +
- +struct sid_vhf {
- + const struct ssam_hid_properties *p;
- + struct platform_device *dev;
- + struct hid_device *hid;
- + struct ssam_event_notifier notif;
- + unsigned long state;
- +};
- +
- +
- +static int sid_vhf_hid_start(struct hid_device *hid)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- + return 0;
- +}
- +
- +static void sid_vhf_hid_stop(struct hid_device *hid)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- +}
- +
- +static int sid_vhf_hid_open(struct hid_device *hid)
- +{
- + struct sid_vhf *vhf = dev_get_drvdata(hid->dev.parent);
- +
- + hid_dbg(hid, "%s\n", __func__);
- +
- + set_bit(VHF_HID_STARTED, &vhf->state);
- + return 0;
- +}
- +
- +static void sid_vhf_hid_close(struct hid_device *hid)
- +{
- +
- + struct sid_vhf *vhf = dev_get_drvdata(hid->dev.parent);
- +
- + hid_dbg(hid, "%s\n", __func__);
- +
- + clear_bit(VHF_HID_STARTED, &vhf->state);
- +}
- +
- +struct surface_sam_sid_vhf_meta_rqst {
- + u8 id;
- + u32 offset;
- + u32 length; // buffer limit on send, length of data received on receive
- + u8 end; // 0x01 if end was reached
- +} __packed;
- +
- +struct vhf_device_metadata_info {
- + u8 len;
- + u8 _2;
- + u8 _3;
- + u8 _4;
- + u8 _5;
- + u8 _6;
- + u8 _7;
- + u16 hid_len; // hid descriptor length
- +} __packed;
- +
- +struct vhf_device_metadata {
- + u32 len;
- + u16 vendor_id;
- + u16 product_id;
- + u8 _1[24];
- +} __packed;
- +
- +union vhf_buffer_data {
- + struct vhf_device_metadata_info info;
- + u8 pld[0x76];
- + struct vhf_device_metadata meta;
- +};
- +
- +struct surface_sam_sid_vhf_meta_resp {
- + struct surface_sam_sid_vhf_meta_rqst rqst;
- + union vhf_buffer_data data;
- +} __packed;
- +
- +
- +static int vhf_get_metadata(u8 iid, struct vhf_device_metadata *meta)
- +{
- + int status;
- +
- + struct surface_sam_sid_vhf_meta_resp resp = {
- + .rqst = {
- + .id = 2,
- + .offset = 0,
- + .length = 0x76,
- + .end = 0
- + }
- + };
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x15,
- + .cid = 0x04,
- + .iid = iid,
- + .chn = 0x02,
- + .snc = 0x01,
- + .cdl = sizeof(struct surface_sam_sid_vhf_meta_rqst),
- + .pld = (u8 *)&resp.rqst,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + .cap = sizeof(struct surface_sam_sid_vhf_meta_resp),
- + .len = 0,
- + .data = (u8 *)&resp,
- + };
- +
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status)
- + return status;
- +
- + *meta = resp.data.meta;
- +
- + return 0;
- +}
- +
- +static int vhf_get_hid_descriptor(struct hid_device *hid, u8 iid, u8 **desc, int *size)
- +{
- + int status, len;
- + u8 *buf;
- +
- + struct surface_sam_sid_vhf_meta_resp resp = {
- + .rqst = {
- + .id = 0,
- + .offset = 0,
- + .length = 0x76,
- + .end = 0,
- + }
- + };
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x15,
- + .cid = 0x04,
- + .iid = iid,
- + .chn = 0x02,
- + .snc = 0x01,
- + .cdl = sizeof(struct surface_sam_sid_vhf_meta_rqst),
- + .pld = (u8 *)&resp.rqst,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + .cap = sizeof(struct surface_sam_sid_vhf_meta_resp),
- + .len = 0,
- + .data = (u8 *)&resp,
- + };
- +
- + // first fetch 00 to get the total length
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status)
- + return status;
- +
- + len = resp.data.info.hid_len;
- +
- + // allocate a buffer for the descriptor
- + buf = kzalloc(len, GFP_KERNEL);
- +
- + // then, iterate and write into buffer, copying out bytes
- + resp.rqst.id = 1;
- + resp.rqst.offset = 0;
- + resp.rqst.length = 0x76;
- + resp.rqst.end = 0;
- +
- + while (!resp.rqst.end && resp.rqst.offset < len) {
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status) {
- + kfree(buf);
- + return status;
- + }
- + memcpy(buf + resp.rqst.offset, resp.data.pld, resp.rqst.length);
- +
- + resp.rqst.offset += resp.rqst.length;
- + }
- +
- + *desc = buf;
- + *size = len;
- +
- + return 0;
- +}
- +
- +static int sid_vhf_hid_parse(struct hid_device *hid)
- +{
- + struct sid_vhf *vhf = dev_get_drvdata(hid->dev.parent);
- + int ret = 0, size;
- + u8 *buf;
- +
- + ret = vhf_get_hid_descriptor(hid, vhf->p->instance, &buf, &size);
- + if (ret != 0) {
- + hid_err(hid, "Failed to read HID descriptor from device: %d\n", ret);
- + return -EIO;
- + }
- + hid_dbg(hid, "HID descriptor of device:");
- + print_hex_dump_debug("descriptor:", DUMP_PREFIX_OFFSET, 16, 1, buf, size, false);
- +
- + ret = hid_parse_report(hid, buf, size);
- + kfree(buf);
- + return ret;
- +
- +}
- +
- +static int sid_vhf_hid_raw_request(struct hid_device *hid, unsigned char
- + reportnum, u8 *buf, size_t len, unsigned char rtype, int
- + reqtype)
- +{
- + struct sid_vhf *vhf = dev_get_drvdata(hid->dev.parent);
- + int status;
- + u8 cid;
- + struct surface_sam_ssh_rqst rqst = {};
- + struct surface_sam_ssh_buf result = {};
- +
- + hid_dbg(hid, "%s: reportnum=%#04x rtype=%i reqtype=%i\n", __func__, reportnum, rtype, reqtype);
- + print_hex_dump_debug("report:", DUMP_PREFIX_OFFSET, 16, 1, buf, len, false);
- +
- + // Byte 0 is the report number. Report data starts at byte 1.
- + buf[0] = reportnum;
- +
- + switch (rtype) {
- + case HID_OUTPUT_REPORT:
- + cid = 0x01;
- + break;
- + case HID_FEATURE_REPORT:
- + switch (reqtype) {
- + case HID_REQ_GET_REPORT:
- + // The EC doesn't respond to GET FEATURE for these touchpad reports
- + // we immediately discard to avoid waiting for a timeout.
- + if (reportnum == 6 || reportnum == 7 || reportnum == 8 || reportnum == 9 || reportnum == 0x0b) {
- + hid_dbg(hid, "%s: skipping get feature report for 0x%02x\n", __func__, reportnum);
- + return 0;
- + }
- +
- + cid = 0x02;
- + break;
- + case HID_REQ_SET_REPORT:
- + cid = 0x03;
- + break;
- + default:
- + hid_err(hid, "%s: unknown req type 0x%02x\n", __func__, rtype);
- + return -EIO;
- + }
- + break;
- + default:
- + hid_err(hid, "%s: unknown report type 0x%02x\n", __func__, reportnum);
- + return -EIO;
- + }
- +
- + rqst.tc = SAM_EVENT_SID_VHF_TC;
- + rqst.chn = 0x02;
- + rqst.iid = vhf->p->instance;
- + rqst.cid = cid;
- + rqst.snc = reqtype == HID_REQ_GET_REPORT ? 0x01 : 0x00;
- + rqst.cdl = reqtype == HID_REQ_GET_REPORT ? 0x01 : len;
- + rqst.pld = buf;
- +
- + result.cap = len;
- + result.len = 0;
- + result.data = buf;
- +
- + hid_dbg(hid, "%s: sending to cid=%#04x snc=%#04x\n", __func__, cid, HID_REQ_GET_REPORT == reqtype);
- +
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + hid_dbg(hid, "%s: status %i\n", __func__, status);
- +
- + if (status)
- + return status;
- +
- + if (result.len > 0)
- + print_hex_dump_debug("response:", DUMP_PREFIX_OFFSET, 16, 1, result.data, result.len, false);
- +
- + return result.len;
- +}
- +
- +static struct hid_ll_driver sid_vhf_hid_ll_driver = {
- + .start = sid_vhf_hid_start,
- + .stop = sid_vhf_hid_stop,
- + .open = sid_vhf_hid_open,
- + .close = sid_vhf_hid_close,
- + .parse = sid_vhf_hid_parse,
- + .raw_request = sid_vhf_hid_raw_request,
- +};
- +
- +
- +static struct hid_device *sid_vhf_create_hid_device(struct platform_device *pdev, struct vhf_device_metadata *meta)
- +{
- + struct hid_device *hid;
- +
- + hid = hid_allocate_device();
- + if (IS_ERR(hid))
- + return hid;
- +
- + hid->dev.parent = &pdev->dev;
- +
- + hid->bus = BUS_VIRTUAL;
- + hid->vendor = meta->vendor_id;
- + hid->product = meta->product_id;
- +
- + hid->ll_driver = &sid_vhf_hid_ll_driver;
- +
- + sprintf(hid->name, "%s", SID_VHF_INPUT_NAME);
- +
- + return hid;
- +}
- +
- +static u32 sid_vhf_event_handler(struct ssam_notifier_block *nb, const struct ssam_event *event)
- +{
- + struct sid_vhf *vhf = container_of(nb, struct sid_vhf, notif.base);
- + int status;
- +
- + if (event->target_category != SSAM_SSH_TC_HID)
- + return 0;
- +
- + if (event->channel != 0x02)
- + return 0;
- +
- + if (event->instance_id != vhf->p->instance)
- + return 0;
- +
- + if (event->command_id != 0x00 && event->command_id != 0x03 && event->command_id != 0x04)
- + return 0;
- +
- + // skip if HID hasn't started yet
- + if (!test_bit(VHF_HID_STARTED, &vhf->state))
- + return SSAM_NOTIF_HANDLED;
- +
- + status = hid_input_report(vhf->hid, HID_INPUT_REPORT, (u8 *)&event->data[0], event->length, 0);
- + return ssam_notifier_from_errno(status) | SSAM_NOTIF_HANDLED;
- +}
- +
- +static int surface_sam_sid_vhf_probe(struct platform_device *pdev)
- +{
- + const struct ssam_hid_properties *p = pdev->dev.platform_data;
- + struct sid_vhf *vhf;
- + struct vhf_device_metadata meta = {};
- + struct hid_device *hid;
- + int status;
- +
- + // add device link to EC
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + vhf = kzalloc(sizeof(struct sid_vhf), GFP_KERNEL);
- + if (!vhf)
- + return -ENOMEM;
- +
- + status = vhf_get_metadata(p->instance, &meta);
- + if (status)
- + goto err_create_hid;
- +
- + hid = sid_vhf_create_hid_device(pdev, &meta);
- + if (IS_ERR(hid)) {
- + status = PTR_ERR(hid);
- + goto err_create_hid;
- + }
- +
- + vhf->p = pdev->dev.platform_data;
- + vhf->dev = pdev;
- + vhf->hid = hid;
- +
- + vhf->notif.base.priority = 1;
- + vhf->notif.base.fn = sid_vhf_event_handler;
- + vhf->notif.event.reg = p->registry;
- + vhf->notif.event.id.target_category = SSAM_SSH_TC_HID;
- + vhf->notif.event.id.instance = p->instance;
- + vhf->notif.event.flags = 0;
- +
- + platform_set_drvdata(pdev, vhf);
- +
- + status = surface_sam_ssh_notifier_register(&vhf->notif);
- + if (status)
- + goto err_notif;
- +
- + status = hid_add_device(hid);
- + if (status)
- + goto err_add_hid;
- +
- + return 0;
- +
- +err_add_hid:
- + surface_sam_ssh_notifier_unregister(&vhf->notif);
- +err_notif:
- + hid_destroy_device(hid);
- + platform_set_drvdata(pdev, NULL);
- +err_create_hid:
- + kfree(vhf);
- + return status;
- +}
- +
- +static int surface_sam_sid_vhf_remove(struct platform_device *pdev)
- +{
- + struct sid_vhf *vhf = platform_get_drvdata(pdev);
- +
- + surface_sam_ssh_notifier_unregister(&vhf->notif);
- + hid_destroy_device(vhf->hid);
- + kfree(vhf);
- +
- + platform_set_drvdata(pdev, NULL);
- + return 0;
- +}
- +
- +static struct platform_driver surface_sam_sid_vhf = {
- + .probe = surface_sam_sid_vhf_probe,
- + .remove = surface_sam_sid_vhf_remove,
- + .driver = {
- + .name = "surface_sam_sid_vhf",
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_sid_vhf);
- +
- +MODULE_AUTHOR("Blaž Hrastnik <blaz@mxxn.io>");
- +MODULE_DESCRIPTION("Driver for HID devices connected via Surface SAM");
- +MODULE_LICENSE("GPL");
- +MODULE_ALIAS("platform:surface_sam_sid_vhf");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_sid_vhf.h b/drivers/platform/x86/surface_sam/surface_sam_sid_vhf.h
- new file mode 100644
- index 000000000000..eb55485ccb11
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_sid_vhf.h
- @@ -0,0 +1,13 @@
- +#ifndef _SURFACE_SAM_SID_VHF_H
- +#define _SURFACE_SAM_SID_VHF_H
- +
- +#include <linux/types.h>
- +#include "surface_sam_ssh.h"
- +
- +
- +struct ssam_hid_properties {
- + struct ssam_event_registry registry;
- + u8 instance;
- +};
- +
- +#endif /* _SURFACE_SAM_SID_VHF_H */
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_ssh.c b/drivers/platform/x86/surface_sam/surface_sam_ssh.c
- new file mode 100644
- index 000000000000..9f44bdfbc4fd
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_ssh.c
- @@ -0,0 +1,5111 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Surface Serial Hub (SSH) driver for communication with the Surface/System
- + * Aggregator Module.
- + */
- +
- +#include <asm/unaligned.h>
- +#include <linux/acpi.h>
- +#include <linux/atomic.h>
- +#include <linux/completion.h>
- +#include <linux/crc-ccitt.h>
- +#include <linux/dmaengine.h>
- +#include <linux/gpio/consumer.h>
- +#include <linux/interrupt.h>
- +#include <linux/jiffies.h>
- +#include <linux/kernel.h>
- +#include <linux/kfifo.h>
- +#include <linux/kref.h>
- +#include <linux/kthread.h>
- +#include <linux/ktime.h>
- +#include <linux/list.h>
- +#include <linux/mutex.h>
- +#include <linux/pm.h>
- +#include <linux/refcount.h>
- +#include <linux/serdev.h>
- +#include <linux/spinlock.h>
- +#include <linux/sysfs.h>
- +#include <linux/workqueue.h>
- +
- +#include "surface_sam_ssh.h"
- +
- +#define CREATE_TRACE_POINTS
- +#include "surface_sam_ssh_trace.h"
- +
- +
- +/* -- TODO. ----------------------------------------------------------------- */
- +
- +#define SSH_RQST_TAG_FULL "surface_sam_ssh_rqst: "
- +#define SSH_RQST_TAG "rqst: "
- +
- +#define SSH_SUPPORTED_FLOW_CONTROL_MASK (~((u8) ACPI_UART_FLOW_CONTROL_HW))
- +
- +
- +/* -- Error injection helpers. ---------------------------------------------- */
- +
- +#ifdef CONFIG_SURFACE_SAM_SSH_ERROR_INJECTION
- +#define noinline_if_inject noinline
- +#else /* CONFIG_SURFACE_SAM_SSH_ERROR_INJECTION */
- +#define noinline_if_inject inline
- +#endif /* CONFIG_SURFACE_SAM_SSH_ERROR_INJECTION */
- +
- +
- +/* -- Public interface. ----------------------------------------------------- */
- +
- +enum ssam_request_flags {
- + SSAM_REQUEST_HAS_RESPONSE = BIT(0),
- + SSAM_REQUEST_UNSEQUENCED = BIT(1),
- +};
- +
- +struct ssam_request {
- + u8 target_category;
- + u8 command_id;
- + u8 instance_id;
- + u8 channel;
- + u16 flags;
- + u16 length;
- + u8 *payload;
- +};
- +
- +
- +/* -- Common/utility functions. --------------------------------------------- */
- +
- +static inline u16 ssh_crc(const u8 *buf, size_t len)
- +{
- + return crc_ccitt_false(0xffff, buf, len);
- +}
- +
- +static inline u16 __ssh_rqid_next(u16 rqid)
- +{
- + return rqid > 0 ? rqid + 1u : rqid + SURFACE_SAM_SSH_NUM_EVENTS + 1u;
- +}
- +
- +static inline u16 ssh_event_to_rqid(u16 event)
- +{
- + return event + 1u;
- +}
- +
- +static inline u16 ssh_rqid_to_event(u16 rqid)
- +{
- + return rqid - 1u;
- +}
- +
- +static inline bool ssh_rqid_is_event(u16 rqid)
- +{
- + return ssh_rqid_to_event(rqid) < SURFACE_SAM_SSH_NUM_EVENTS;
- +}
- +
- +static inline int ssh_tc_to_rqid(u8 tc)
- +{
- +#if 0 // TODO: check if it works without this
- + /*
- + * TC=0x08 represents the input subsystem on Surface Laptop 1 and 2.
- + * This is mapped on Windows to RQID=0x0001. As input events seem to be
- + * somewhat special with regards to enabling/disabling (they seem to be
- + * enabled by default with a fixed RQID), let's do the same here.
- + */
- + if (tc == 0x08)
- + return 0x0001;
- +
- + /* Default path: Set RQID = TC. */
- +#endif
- + return tc;
- +}
- +
- +static inline int ssh_tc_to_event(u8 tc)
- +{
- + return ssh_rqid_to_event(ssh_tc_to_rqid(tc));
- +}
- +
- +static inline u8 ssh_channel_to_index(u8 channel)
- +{
- + return channel - 1u;
- +}
- +
- +static inline bool ssh_channel_is_valid(u8 channel)
- +{
- + return ssh_channel_to_index(channel) < SURFACE_SAM_SSH_NUM_CHANNELS;
- +}
- +
- +
- +/* -- Safe counters. -------------------------------------------------------- */
- +
- +struct ssh_seq_counter {
- + u8 value;
- +};
- +
- +struct ssh_rqid_counter {
- + u16 value;
- +};
- +
- +static inline void ssh_seq_reset(struct ssh_seq_counter *c)
- +{
- + WRITE_ONCE(c->value, 0);
- +}
- +
- +static inline u8 ssh_seq_next(struct ssh_seq_counter *c)
- +{
- + u8 old = READ_ONCE(c->value);
- + u8 new = old + 1;
- + u8 ret;
- +
- + while (unlikely((ret = cmpxchg(&c->value, old, new)) != old)) {
- + old = ret;
- + new = old + 1;
- + }
- +
- + return old;
- +}
- +
- +static inline void ssh_rqid_reset(struct ssh_rqid_counter *c)
- +{
- + WRITE_ONCE(c->value, 0);
- +}
- +
- +static inline u16 ssh_rqid_next(struct ssh_rqid_counter *c)
- +{
- + u16 old = READ_ONCE(c->value);
- + u16 new = __ssh_rqid_next(old);
- + u16 ret;
- +
- + while (unlikely((ret = cmpxchg(&c->value, old, new)) != old)) {
- + old = ret;
- + new = __ssh_rqid_next(old);
- + }
- +
- + return old;
- +}
- +
- +
- +/* -- Builder functions for SAM-over-SSH messages. -------------------------- */
- +
- +struct msgbuf {
- + u8 *buffer;
- + u8 *end;
- + u8 *ptr;
- +};
- +
- +static inline void msgb_init(struct msgbuf *msgb, u8 *buffer, size_t cap)
- +{
- + msgb->buffer = buffer;
- + msgb->end = buffer + cap;
- + msgb->ptr = buffer;
- +}
- +
- +static inline int msgb_alloc(struct msgbuf *msgb, size_t cap, gfp_t flags)
- +{
- + u8 *buf;
- +
- + buf = kzalloc(cap, flags);
- + if (!buf)
- + return -ENOMEM;
- +
- + msgb_init(msgb, buf, cap);
- + return 0;
- +}
- +
- +static inline void msgb_free(struct msgbuf *msgb)
- +{
- + kfree(msgb->buffer);
- + msgb->buffer = NULL;
- + msgb->end = NULL;
- + msgb->ptr = NULL;
- +}
- +
- +static inline void msgb_reset(struct msgbuf *msgb)
- +{
- + msgb->ptr = msgb->buffer;
- +}
- +
- +static inline size_t msgb_bytes_used(const struct msgbuf *msgb)
- +{
- + return msgb->ptr - msgb->buffer;
- +}
- +
- +static inline void msgb_push_u16(struct msgbuf *msgb, u16 value)
- +{
- + WARN_ON(msgb->ptr + sizeof(u16) > msgb->end);
- + if (msgb->ptr + sizeof(u16) > msgb->end)
- + return;
- +
- + put_unaligned_le16(value, msgb->ptr);
- + msgb->ptr += sizeof(u16);
- +}
- +
- +static inline void msgb_push_syn(struct msgbuf *msgb)
- +{
- + msgb_push_u16(msgb, SSH_MSG_SYN);
- +}
- +
- +static inline void msgb_push_buf(struct msgbuf *msgb, const u8 *buf, size_t len)
- +{
- + msgb->ptr = memcpy(msgb->ptr, buf, len) + len;
- +}
- +
- +static inline void msgb_push_crc(struct msgbuf *msgb, const u8 *buf, size_t len)
- +{
- + msgb_push_u16(msgb, ssh_crc(buf, len));
- +}
- +
- +static inline void msgb_push_frame(struct msgbuf *msgb, u8 ty, u16 len, u8 seq)
- +{
- + struct ssh_frame *frame = (struct ssh_frame *)msgb->ptr;
- + const u8 *const begin = msgb->ptr;
- +
- + WARN_ON(msgb->ptr + sizeof(*frame) > msgb->end);
- + if (msgb->ptr + sizeof(*frame) > msgb->end)
- + return;
- +
- + frame->type = ty;
- + put_unaligned_le16(len, &frame->len);
- + frame->seq = seq;
- +
- + msgb->ptr += sizeof(*frame);
- + msgb_push_crc(msgb, begin, msgb->ptr - begin);
- +}
- +
- +static inline void msgb_push_ack(struct msgbuf *msgb, u8 seq)
- +{
- + // SYN
- + msgb_push_syn(msgb);
- +
- + // ACK-type frame + CRC
- + msgb_push_frame(msgb, SSH_FRAME_TYPE_ACK, 0x00, seq);
- +
- + // payload CRC (ACK-type frames do not have a payload)
- + msgb_push_crc(msgb, msgb->ptr, 0);
- +}
- +
- +static inline void msgb_push_nak(struct msgbuf *msgb)
- +{
- + // SYN
- + msgb_push_syn(msgb);
- +
- + // NAK-type frame + CRC
- + msgb_push_frame(msgb, SSH_FRAME_TYPE_NAK, 0x00, 0x00);
- +
- + // payload CRC (ACK-type frames do not have a payload)
- + msgb_push_crc(msgb, msgb->ptr, 0);
- +}
- +
- +static inline void msgb_push_cmd(struct msgbuf *msgb, u8 seq,
- + const struct surface_sam_ssh_rqst *rqst,
- + u16 rqid)
- +{
- + struct ssh_command *cmd;
- + const u8 *cmd_begin;
- + const u8 type = SSH_FRAME_TYPE_DATA_SEQ;
- +
- + // SYN
- + msgb_push_syn(msgb);
- +
- + // command frame + crc
- + msgb_push_frame(msgb, type, sizeof(*cmd) + rqst->cdl, seq);
- +
- + // frame payload: command struct + payload
- + WARN_ON(msgb->ptr + sizeof(*cmd) > msgb->end);
- + if (msgb->ptr + sizeof(*cmd) > msgb->end)
- + return;
- +
- + cmd_begin = msgb->ptr;
- + cmd = (struct ssh_command *)msgb->ptr;
- +
- + cmd->type = SSH_PLD_TYPE_CMD;
- + cmd->tc = rqst->tc;
- + cmd->chn_out = rqst->chn;
- + cmd->chn_in = 0x00;
- + cmd->iid = rqst->iid;
- + put_unaligned_le16(rqid, &cmd->rqid);
- + cmd->cid = rqst->cid;
- +
- + msgb->ptr += sizeof(*cmd);
- +
- + // command payload
- + msgb_push_buf(msgb, rqst->pld, rqst->cdl);
- +
- + // crc for command struct + payload
- + msgb_push_crc(msgb, cmd_begin, msgb->ptr - cmd_begin);
- +}
- +
- +
- +/* -- Parser functions and utilities for SAM-over-SSH messages. ------------- */
- +
- +struct sshp_buf {
- + u8 *ptr;
- + size_t len;
- + size_t cap;
- +};
- +
- +
- +static inline bool sshp_validate_crc(const struct sshp_span *src, const u8 *crc)
- +{
- + u16 actual = ssh_crc(src->ptr, src->len);
- + u16 expected = get_unaligned_le16(crc);
- +
- + return actual == expected;
- +}
- +
- +static bool sshp_find_syn(const struct sshp_span *src, struct sshp_span *rem)
- +{
- + size_t i;
- +
- + for (i = 0; i < src->len - 1; i++) {
- + if (likely(get_unaligned_le16(src->ptr + i) == SSH_MSG_SYN)) {
- + rem->ptr = src->ptr + i;
- + rem->len = src->len - i;
- + return true;
- + }
- + }
- +
- + if (unlikely(src->ptr[src->len - 1] == (SSH_MSG_SYN & 0xff))) {
- + rem->ptr = src->ptr + src->len - 1;
- + rem->len = 1;
- + return false;
- + } else {
- + rem->ptr = src->ptr + src->len;
- + rem->len = 0;
- + return false;
- + }
- +}
- +
- +static bool sshp_starts_with_syn(const struct sshp_span *src)
- +{
- + return src->len >= 2 && get_unaligned_le16(src->ptr) == SSH_MSG_SYN;
- +}
- +
- +static int sshp_parse_frame(const struct device *dev,
- + const struct sshp_span *source,
- + struct ssh_frame **frame,
- + struct sshp_span *payload,
- + size_t maxlen)
- +{
- + struct sshp_span sf;
- + struct sshp_span sp;
- +
- + // initialize output
- + *frame = NULL;
- + payload->ptr = NULL;
- + payload->len = 0;
- +
- + if (!sshp_starts_with_syn(source)) {
- + dev_warn(dev, "rx: parser: invalid start of frame\n");
- + return -ENOMSG;
- + }
- +
- + // check for minumum packet length
- + if (unlikely(source->len < SSH_MESSAGE_LENGTH(0))) {
- + dev_dbg(dev, "rx: parser: not enough data for frame\n");
- + return 0;
- + }
- +
- + // pin down frame
- + sf.ptr = source->ptr + sizeof(u16);
- + sf.len = sizeof(struct ssh_frame);
- +
- + // validate frame CRC
- + if (unlikely(!sshp_validate_crc(&sf, sf.ptr + sf.len))) {
- + dev_warn(dev, "rx: parser: invalid frame CRC\n");
- + return -EBADMSG;
- + }
- +
- + // ensure packet does not exceed maximum length
- + if (unlikely(((struct ssh_frame *)sf.ptr)->len > maxlen)) {
- + dev_warn(dev, "rx: parser: frame too large: %u bytes\n",
- + ((struct ssh_frame *)sf.ptr)->len);
- + return -EMSGSIZE;
- + }
- +
- + // pin down payload
- + sp.ptr = sf.ptr + sf.len + sizeof(u16);
- + sp.len = get_unaligned_le16(&((struct ssh_frame *)sf.ptr)->len);
- +
- + // check for frame + payload length
- + if (source->len < SSH_MESSAGE_LENGTH(sp.len)) {
- + dev_dbg(dev, "rx: parser: not enough data for payload\n");
- + return 0;
- + }
- +
- + // validate payload crc
- + if (unlikely(!sshp_validate_crc(&sp, sp.ptr + sp.len))) {
- + dev_warn(dev, "rx: parser: invalid payload CRC\n");
- + return -EBADMSG;
- + }
- +
- + *frame = (struct ssh_frame *)sf.ptr;
- + *payload = sp;
- +
- + dev_dbg(dev, "rx: parser: valid frame found (type: 0x%02x, len: %u)\n",
- + (*frame)->type, (*frame)->len);
- +
- + return 0;
- +}
- +
- +static int sshp_parse_command(const struct device *dev,
- + const struct sshp_span *source,
- + struct ssh_command **command,
- + struct sshp_span *command_data)
- +{
- + // check for minimum length
- + if (unlikely(source->len < sizeof(struct ssh_command))) {
- + *command = NULL;
- + command_data->ptr = NULL;
- + command_data->len = 0;
- +
- + dev_err(dev, "rx: parser: command payload is too short\n");
- + return -ENOMSG;
- + }
- +
- + *command = (struct ssh_command *)source->ptr;
- + command_data->ptr = source->ptr + sizeof(struct ssh_command);
- + command_data->len = source->len - sizeof(struct ssh_command);
- +
- + dev_dbg(dev, "rx: parser: valid command found (tc: 0x%02x,"
- + " cid: 0x%02x)\n", (*command)->tc, (*command)->cid);
- +
- + return 0;
- +}
- +
- +
- +static inline void sshp_buf_init(struct sshp_buf *buf, u8 *ptr, size_t cap)
- +{
- + buf->ptr = ptr;
- + buf->len = 0;
- + buf->cap = cap;
- +}
- +
- +static inline int sshp_buf_alloc(struct sshp_buf *buf, size_t cap, gfp_t flags)
- +{
- + u8 *ptr;
- +
- + ptr = kzalloc(cap, flags);
- + if (!ptr)
- + return -ENOMEM;
- +
- + sshp_buf_init(buf, ptr, cap);
- + return 0;
- +
- +}
- +
- +static inline void sshp_buf_free(struct sshp_buf *buf)
- +{
- + kfree(buf->ptr);
- + buf->ptr = NULL;
- + buf->len = 0;
- + buf->cap = 0;
- +}
- +
- +static inline void sshp_buf_reset(struct sshp_buf *buf)
- +{
- + buf->len = 0;
- +}
- +
- +static inline void sshp_buf_drop(struct sshp_buf *buf, size_t n)
- +{
- + memmove(buf->ptr, buf->ptr + n, buf->len - n);
- + buf->len -= n;
- +}
- +
- +static inline size_t sshp_buf_read_from_fifo(struct sshp_buf *buf,
- + struct kfifo *fifo)
- +{
- + size_t n;
- +
- + n = kfifo_out(fifo, buf->ptr + buf->len, buf->cap - buf->len);
- + buf->len += n;
- +
- + return n;
- +}
- +
- +static inline void sshp_buf_span_from(struct sshp_buf *buf, size_t offset,
- + struct sshp_span *span)
- +{
- + span->ptr = buf->ptr + offset;
- + span->len = buf->len - offset;
- +}
- +
- +
- +/* -- Packet transport layer (ptl). ----------------------------------------- */
- +/*
- + * To simplify reasoning about the code below, we define a few concepts. The
- + * system below is similar to a state-machine for packets, however, there are
- + * too many states to explicitly write them down. To (somewhat) manage the
- + * states and packets we rely on flags, reference counting, and some simple
- + * concepts. State transitions are triggered by actions.
- + *
- + * >> Actions <<
- + *
- + * - submit
- + * - transmission start (process next item in queue)
- + * - transmission finished (guaranteed to never be parallel to transmission
- + * start)
- + * - ACK received
- + * - NAK received (this is equivalent to issuing re-submit for all pending
- + * packets)
- + * - timeout (this is equivalent to re-issuing a submit or canceling)
- + * - cancel (non-pending and pending)
- + *
- + * >> Data Structures, Packet Ownership, General Overview <<
- + *
- + * The code below employs two main data structures: The packet queue, containing
- + * all packets scheduled for transmission, and the set of pending packets,
- + * containing all packets awaiting an ACK.
- + *
- + * Shared ownership of a packet is controlled via reference counting. Inside the
- + * transmission system are a total of five packet owners:
- + *
- + * - the packet queue,
- + * - the pending set,
- + * - the transmitter thread,
- + * - the receiver thread (via ACKing), and
- + * - the timeout work item.
- + *
- + * Normal operation is as follows: The initial reference of the packet is
- + * obtained by submitting the packet and queueing it. The receiver thread
- + * takes packets from the queue. By doing this, it does not increment the
- + * refcount but takes over the reference (removing it from the queue).
- + * If the packet is sequenced (i.e. needs to be ACKed by the client), the
- + * transmitter thread sets-up the timeout and adds the packet to the pending set
- + * before starting to transmit it. As the timeout is handled by a reaper task,
- + * no additional reference for it is needed. After the transmit is done, the
- + * reference hold by the transmitter thread is dropped. If the packet is
- + * unsequenced (i.e. does not need an ACK), the packet is completed by the
- + * transmitter thread before dropping that reference.
- + *
- + * On receial of an ACK, the receiver thread removes and obtains the refernce to
- + * the packet from the pending set. On succes, the receiver thread will then
- + * complete the packet and drop its reference.
- + *
- + * On error, the completion callback is immediately run by on thread on which
- + * the error was detected.
- + *
- + * To ensure that a packet eventually leaves the system it is marked as "locked"
- + * directly before it is going to be completed or when it is canceled. Marking a
- + * packet as "locked" has the effect that passing and creating new references
- + * of the packet will be blocked. This means that the packet cannot be added
- + * to the queue, the pending set, and the timeout, or be picked up by the
- + * transmitter thread or receiver thread. To remove a packet from the system it
- + * has to be marked as locked and subsequently all references from the data
- + * structures (queue, pending) have to be removed. References held by threads
- + * will eventually be dropped automatically as their execution progresses.
- + *
- + * Note that the packet completion callback is, in case of success and for a
- + * sequenced packet, guaranteed to run on the receiver thread, thus providing a
- + * way to reliably identify responses to the packet. The packet completion
- + * callback is only run once and it does not indicate that the packet has fully
- + * left the system. In case of re-submission (and with somewhat unlikely
- + * timing), it may be possible that the packet is being re-transmitted while the
- + * completion callback runs. Completion will occur both on success and internal
- + * error, as well as when the packet is canceled.
- + *
- + * >> Flags <<
- + *
- + * Flags are used to indicate the state and progression of a packet. Some flags
- + * have stricter guarantees than other:
- + *
- + * - locked
- + * Indicates if the packet is locked. If the packet is locked, passing and/or
- + * creating additional references to the packet is forbidden. The packet thus
- + * may not be queued, dequeued, or removed or added to the pending set. Note
- + * that the packet state flags may still change (e.g. it may be marked as
- + * ACKed, transmitted, ...).
- + *
- + * - completed
- + * Indicates if the packet completion has been run or is about to be run. This
- + * flag is used to ensure that the packet completion callback is only run
- + * once.
- + *
- + * - queued
- + * Indicates if a packet is present in the submission queue or not. This flag
- + * must only be modified with the queue lock held, and must be coherent
- + * presence of the packet in the queue.
- + *
- + * - pending
- + * Indicates if a packet is present in the set of pending packets or not.
- + * This flag must only be modified with the pending lock held, and must be
- + * coherent presence of the packet in the pending set.
- + *
- + * - transmitting
- + * Indicates if the packet is currently transmitting. In case of
- + * re-transmissions, it is only safe to wait on the "transmitted" completion
- + * after this flag has been set. The completion will be set both in success
- + * and error case.
- + *
- + * - transmitted
- + * Indicates if the packet has been transmitted. This flag is not cleared by
- + * the system, thus it indicates the first transmission only.
- + *
- + * - acked
- + * Indicates if the packet has been acknowledged by the client. There are no
- + * other guarantees given. For example, the packet may still be canceled
- + * and/or the completion may be triggered an error even though this bit is
- + * set. Rely on the status provided by completion instead.
- + *
- + * - canceled
- + * Indicates if the packet has been canceled from the outside. There are no
- + * other guarantees given. Specifically, the packet may be completed by
- + * another part of the system before the cancellation attempts to complete it.
- + *
- + * >> General Notes <<
- + *
- + * To avoid deadlocks, if both queue and pending locks are required, the pending
- + * lock must be acquired before the queue lock.
- + */
- +
- +/**
- + * Maximum number transmission attempts per sequenced packet in case of
- + * time-outs. Must be smaller than 16.
- + */
- +#define SSH_PTL_MAX_PACKET_TRIES 3
- +
- +/**
- + * Timeout as ktime_t delta for ACKs. If we have not received an ACK in this
- + * time-frame after starting transmission, the packet will be re-submitted.
- + */
- +#define SSH_PTL_PACKET_TIMEOUT ms_to_ktime(1000)
- +
- +/**
- + * Maximum time resolution for timeouts. Currently set to max(2 jiffies, 50ms).
- + * Should be larger than one jiffy to avoid direct re-scheduling of reaper
- + * work_struct.
- + */
- +#define SSH_PTL_PACKET_TIMEOUT_RESOLUTION ms_to_ktime(max(2000 / HZ, 50))
- +
- +/**
- + * Maximum number of sequenced packets concurrently waiting for an ACK.
- + * Packets marked as blocking will not be transmitted while this limit is
- + * reached.
- + */
- +#define SSH_PTL_MAX_PENDING 1
- +
- +#define SSH_PTL_RX_BUF_LEN 4096
- +
- +#define SSH_PTL_RX_FIFO_LEN 4096
- +
- +
- +enum ssh_ptl_state_flags {
- + SSH_PTL_SF_SHUTDOWN_BIT,
- +};
- +
- +struct ssh_ptl_ops {
- + void (*data_received)(struct ssh_ptl *p, const struct sshp_span *data);
- +};
- +
- +struct ssh_ptl {
- + struct serdev_device *serdev;
- + unsigned long state;
- +
- + struct {
- + spinlock_t lock;
- + struct list_head head;
- + } queue;
- +
- + struct {
- + spinlock_t lock;
- + struct list_head head;
- + atomic_t count;
- + } pending;
- +
- + struct {
- + bool thread_signal;
- + struct task_struct *thread;
- + struct wait_queue_head thread_wq;
- + struct wait_queue_head packet_wq;
- + struct ssh_packet *packet;
- + size_t offset;
- + } tx;
- +
- + struct {
- + struct task_struct *thread;
- + struct wait_queue_head wq;
- + struct kfifo fifo;
- + struct sshp_buf buf;
- +
- + struct {
- + u16 seqs[8];
- + u16 offset;
- + } blacklist;
- + } rx;
- +
- + struct {
- + ktime_t timeout;
- + ktime_t expires;
- + struct delayed_work reaper;
- + } rtx_timeout;
- +
- + struct ssh_ptl_ops ops;
- +};
- +
- +
- +#define __ssam_prcond(func, p, fmt, ...) \
- + do { \
- + if ((p)) \
- + func((p), fmt, ##__VA_ARGS__); \
- + } while (0);
- +
- +#define ptl_dbg(p, fmt, ...) dev_dbg(&(p)->serdev->dev, fmt, ##__VA_ARGS__)
- +#define ptl_info(p, fmt, ...) dev_info(&(p)->serdev->dev, fmt, ##__VA_ARGS__)
- +#define ptl_warn(p, fmt, ...) dev_warn(&(p)->serdev->dev, fmt, ##__VA_ARGS__)
- +#define ptl_err(p, fmt, ...) dev_err(&(p)->serdev->dev, fmt, ##__VA_ARGS__)
- +#define ptl_dbg_cond(p, fmt, ...) __ssam_prcond(ptl_dbg, p, fmt, ##__VA_ARGS__)
- +
- +#define to_ssh_packet(ptr, member) \
- + container_of(ptr, struct ssh_packet, member)
- +
- +#define to_ssh_ptl(ptr, member) \
- + container_of(ptr, struct ssh_ptl, member)
- +
- +
- +#ifdef CONFIG_SURFACE_SAM_SSH_ERROR_INJECTION
- +
- +/**
- + * ssh_ptl_should_drop_ack_packet - error injection hook to drop ACK packets
- + *
- + * Useful to test detection and handling of automated re-transmits by the EC.
- + * Specifically of packets that the EC consideres not-ACKed but the driver
- + * already consideres ACKed (due to dropped ACK). In this case, the EC
- + * re-transmits the packet-to-be-ACKed and the driver should detect it as
- + * duplicate/already handled. Note that the driver should still send an ACK
- + * for the re-transmitted packet.
- + */
- +static noinline bool ssh_ptl_should_drop_ack_packet(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_drop_ack_packet, TRUE);
- +
- +/**
- + * ssh_ptl_should_drop_nak_packet - error injection hook to drop NAK packets
- + *
- + * Useful to test/force automated (timeout-based) re-transmit by the EC.
- + * Specifically, packets that have not reached the driver completely/with valid
- + * checksums. Only useful in combination with receival of (injected) bad data.
- + */
- +static noinline bool ssh_ptl_should_drop_nak_packet(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_drop_nak_packet, TRUE);
- +
- +/**
- + * ssh_ptl_should_drop_dsq_packet - error injection hook to drop sequenced data
- + * packet
- + *
- + * Useful to test re-transmit timeout of the driver. If the data packet has not
- + * been ACKed after a certain time, the driver should re-transmit the packet up
- + * to limited number of times defined in SSH_PTL_MAX_PACKET_TRIES.
- + */
- +static noinline bool ssh_ptl_should_drop_dsq_packet(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_drop_dsq_packet, TRUE);
- +
- +/**
- + * ssh_ptl_should_fail_write - error injection hook to make serdev_device_write
- + * fail
- + *
- + * Hook to simulate errors in serdev_device_write when transmitting packets.
- + */
- +static noinline int ssh_ptl_should_fail_write(void)
- +{
- + return 0;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_fail_write, ERRNO);
- +
- +/**
- + * ssh_ptl_should_corrupt_tx_data - error injection hook to simualte invalid
- + * data being sent to the EC
- + *
- + * Hook to simulate corrupt/invalid data being sent from host (driver) to EC.
- + * Causes the package data to be actively corrupted by overwriting it with
- + * pre-defined values, such that it becomes invalid, causing the EC to respond
- + * with a NAK packet. Useful to test handling of NAK packets received by the
- + * driver.
- + */
- +static noinline bool ssh_ptl_should_corrupt_tx_data(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_corrupt_tx_data, TRUE);
- +
- +/**
- + * ssh_ptl_should_corrupt_rx_syn - error injection hook to simulate invalid
- + * data being sent by the EC
- + *
- + * Hook to simulate invalid SYN bytes, i.e. an invalid start of messages and
- + * test handling thereof in the driver.
- + */
- +static noinline bool ssh_ptl_should_corrupt_rx_syn(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_corrupt_rx_syn, TRUE);
- +
- +/**
- + * ssh_ptl_should_corrupt_rx_data - error injection hook to simulate invalid
- + * data being sent by the EC
- + *
- + * Hook to simulate invalid data/checksum of the message frame and test handling
- + * thereof in the driver.
- + */
- +static noinline bool ssh_ptl_should_corrupt_rx_data(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_ptl_should_corrupt_rx_data, TRUE);
- +
- +
- +static inline bool __ssh_ptl_should_drop_ack_packet(struct ssh_packet *packet)
- +{
- + if (likely(!ssh_ptl_should_drop_ack_packet()))
- + return false;
- +
- + trace_ssam_ei_tx_drop_ack_packet(packet);
- + ptl_info(packet->ptl, "packet error injection: dropping ACK packet %p\n",
- + packet);
- +
- + return true;
- +}
- +
- +static inline bool __ssh_ptl_should_drop_nak_packet(struct ssh_packet *packet)
- +{
- + if (likely(!ssh_ptl_should_drop_nak_packet()))
- + return false;
- +
- + trace_ssam_ei_tx_drop_nak_packet(packet);
- + ptl_info(packet->ptl, "packet error injection: dropping NAK packet %p\n",
- + packet);
- +
- + return true;
- +}
- +
- +static inline bool __ssh_ptl_should_drop_dsq_packet(struct ssh_packet *packet)
- +{
- + if (likely(!ssh_ptl_should_drop_dsq_packet()))
- + return false;
- +
- + trace_ssam_ei_tx_drop_dsq_packet(packet);
- + ptl_info(packet->ptl,
- + "packet error injection: dropping sequenced data packet %p\n",
- + packet);
- +
- + return true;
- +}
- +
- +static bool ssh_ptl_should_drop_packet(struct ssh_packet *packet)
- +{
- + // ignore packets that don't carry any data (i.e. flush)
- + if (!packet->data || !packet->data_length)
- + return false;
- +
- + switch (packet->data[SSH_MSGOFFSET_FRAME(type)]) {
- + case SSH_FRAME_TYPE_ACK:
- + return __ssh_ptl_should_drop_ack_packet(packet);
- +
- + case SSH_FRAME_TYPE_NAK:
- + return __ssh_ptl_should_drop_nak_packet(packet);
- +
- + case SSH_FRAME_TYPE_DATA_SEQ:
- + return __ssh_ptl_should_drop_dsq_packet(packet);
- +
- + default:
- + return false;
- + }
- +}
- +
- +static inline int ssh_ptl_write_buf(struct ssh_ptl *ptl,
- + struct ssh_packet *packet,
- + const unsigned char *buf,
- + size_t count)
- +{
- + int status;
- +
- + status = ssh_ptl_should_fail_write();
- + if (unlikely(status)) {
- + trace_ssam_ei_tx_fail_write(packet, status);
- + ptl_info(packet->ptl,
- + "packet error injection: simulating transmit error %d, packet %p\n",
- + status, packet);
- +
- + return status;
- + }
- +
- + return serdev_device_write_buf(ptl->serdev, buf, count);
- +}
- +
- +static inline void ssh_ptl_tx_inject_invalid_data(struct ssh_packet *packet)
- +{
- + // ignore packets that don't carry any data (i.e. flush)
- + if (!packet->data || !packet->data_length)
- + return;
- +
- + // only allow sequenced data packets to be modified
- + if (packet->data[SSH_MSGOFFSET_FRAME(type)] != SSH_FRAME_TYPE_DATA_SEQ)
- + return;
- +
- + if (likely(!ssh_ptl_should_corrupt_tx_data()))
- + return;
- +
- + trace_ssam_ei_tx_corrupt_data(packet);
- + ptl_info(packet->ptl,
- + "packet error injection: simulating invalid transmit data on packet %p\n",
- + packet);
- +
- + /*
- + * NB: The value 0xb3 has been chosen more or less randomly so that it
- + * doesn't have any (major) overlap with the SYN bytes (aa 55) and is
- + * non-trivial (i.e. non-zero, non-0xff).
- + */
- + memset(packet->data, 0xb3, packet->data_length);
- +}
- +
- +static inline void ssh_ptl_rx_inject_invalid_syn(struct ssh_ptl *ptl,
- + struct sshp_span *data)
- +{
- + struct sshp_span frame;
- +
- + // check if there actually is something to corrupt
- + if (!sshp_find_syn(data, &frame))
- + return;
- +
- + if (likely(!ssh_ptl_should_corrupt_rx_syn()))
- + return;
- +
- + trace_ssam_ei_rx_corrupt_syn("data_length", data->len);
- +
- + data->ptr[1] = 0xb3; // set second byte of SYN to "random" value
- +}
- +
- +static inline void ssh_ptl_rx_inject_invalid_data(struct ssh_ptl *ptl,
- + struct sshp_span *frame)
- +{
- + size_t payload_len, message_len;
- + struct ssh_frame *sshf;
- +
- + // ignore incomplete messages, will get handled once it's complete
- + if (frame->len < SSH_MESSAGE_LENGTH(0))
- + return;
- +
- + // ignore incomplete messages, part 2
- + payload_len = get_unaligned_le16(&frame->ptr[SSH_MSGOFFSET_FRAME(len)]);
- + message_len = SSH_MESSAGE_LENGTH(payload_len);
- + if (frame->len < message_len)
- + return;
- +
- + if (likely(!ssh_ptl_should_corrupt_rx_data()))
- + return;
- +
- + sshf = (struct ssh_frame *)&frame->ptr[SSH_MSGOFFSET_FRAME(type)];
- + trace_ssam_ei_rx_corrupt_data(sshf);
- +
- + /*
- + * Flip bits in first byte of payload checksum. This is basically
- + * equivalent to a payload/frame data error without us having to worry
- + * about (the, arguably pretty small, probability of) accidental
- + * checksum collisions.
- + */
- + frame->ptr[frame->len - 2] = ~frame->ptr[frame->len - 2];
- +}
- +
- +#else /* CONFIG_SURFACE_SAM_SSH_ERROR_INJECTION */
- +
- +static inline bool ssh_ptl_should_drop_packet(struct ssh_packet *packet)
- +{
- + return false;
- +}
- +
- +static inline int ssh_ptl_write_buf(struct ssh_ptl *ptl,
- + struct ssh_packet *packet,
- + const unsigned char *buf,
- + size_t count)
- +{
- + return serdev_device_write_buf(ptl->serdev, buf, count);
- +}
- +
- +static inline void ssh_ptl_tx_inject_invalid_data(struct ssh_packet *packet)
- +{
- +}
- +
- +static inline void ssh_ptl_rx_inject_invalid_syn(struct ssh_ptl *ptl,
- + struct sshp_span *data)
- +{
- +}
- +
- +static inline void ssh_ptl_rx_inject_invalid_data(struct ssh_ptl *ptl,
- + struct sshp_span *frame)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_SAM_SSH_ERROR_INJECTION */
- +
- +
- +static void __ssh_ptl_packet_release(struct kref *kref)
- +{
- + struct ssh_packet *p = to_ssh_packet(kref, refcnt);
- +
- + trace_ssam_packet_release(p);
- +
- + ptl_dbg_cond(p->ptl, "ptl: releasing packet %p\n", p);
- + p->ops->release(p);
- +}
- +
- +static inline void ssh_packet_get(struct ssh_packet *packet)
- +{
- + kref_get(&packet->refcnt);
- +}
- +
- +static inline void ssh_packet_put(struct ssh_packet *packet)
- +{
- + kref_put(&packet->refcnt, __ssh_ptl_packet_release);
- +}
- +
- +
- +static inline u8 ssh_packet_get_seq(struct ssh_packet *packet)
- +{
- + return packet->data[SSH_MSGOFFSET_FRAME(seq)];
- +}
- +
- +
- +struct ssh_packet_args {
- + u8 type;
- + u8 priority;
- + const struct ssh_packet_ops *ops;
- +};
- +
- +static void ssh_packet_init(struct ssh_packet *packet,
- + const struct ssh_packet_args *args)
- +{
- + kref_init(&packet->refcnt);
- +
- + packet->ptl = NULL;
- + INIT_LIST_HEAD(&packet->queue_node);
- + INIT_LIST_HEAD(&packet->pending_node);
- +
- + packet->type = args->type;
- + packet->priority = args->priority;
- + packet->state = 0;
- + packet->timestamp = KTIME_MAX;
- +
- + packet->data_length = 0;
- + packet->data = NULL;
- +
- + packet->ops = args->ops;
- +}
- +
- +
- +static struct ssh_packet *ptl_alloc_ctrl_packet(
- + struct ssh_ptl *ptl, const struct ssh_packet_args *args,
- + gfp_t flags)
- +{
- + struct ssh_packet *packet;
- +
- + // TODO: chache packets
- +
- + packet = kzalloc(sizeof(struct ssh_packet) + SSH_MSG_LEN_CTRL, flags);
- + if (!packet)
- + return NULL;
- +
- + ssh_packet_init(packet, args);
- + packet->data_length = SSH_MSG_LEN_CTRL;
- + packet->data = ((u8 *) packet) + sizeof(struct ssh_packet);
- +
- + return packet;
- +}
- +
- +static void ptl_free_ctrl_packet(struct ssh_packet *p)
- +{
- + // TODO: chache packets
- +
- + kfree(p);
- +}
- +
- +static const struct ssh_packet_ops ssh_ptl_ctrl_packet_ops = {
- + .complete = NULL,
- + .release = ptl_free_ctrl_packet,
- +};
- +
- +
- +static void ssh_ptl_timeout_reaper_mod(struct ssh_ptl *ptl, ktime_t now,
- + ktime_t expires)
- +{
- + unsigned long delta = msecs_to_jiffies(ktime_ms_delta(expires, now));
- + ktime_t aexp = ktime_add(expires, SSH_PTL_PACKET_TIMEOUT_RESOLUTION);
- + ktime_t old;
- +
- + // re-adjust / schedule reaper if it is above resolution delta
- + old = READ_ONCE(ptl->rtx_timeout.expires);
- + while (ktime_before(aexp, old))
- + old = cmpxchg64(&ptl->rtx_timeout.expires, old, expires);
- +
- + // if we updated the reaper expiration, modify work timeout
- + if (old == expires)
- + mod_delayed_work(system_wq, &ptl->rtx_timeout.reaper, delta);
- +}
- +
- +static void ssh_ptl_timeout_start(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- + ktime_t timestamp = ktime_get_coarse_boottime();
- + ktime_t timeout = ptl->rtx_timeout.timeout;
- +
- + if (test_bit(SSH_PACKET_SF_LOCKED_BIT, &packet->state))
- + return;
- +
- + WRITE_ONCE(packet->timestamp, timestamp);
- + smp_mb__after_atomic();
- +
- + ssh_ptl_timeout_reaper_mod(packet->ptl, timestamp, timestamp + timeout);
- +}
- +
- +
- +static struct list_head *__ssh_ptl_queue_find_entrypoint(struct ssh_packet *p)
- +{
- + struct list_head *head;
- + u8 priority = READ_ONCE(p->priority);
- +
- + /*
- + * We generally assume that there are less control (ACK/NAK) packets and
- + * re-submitted data packets as there are normal data packets (at least
- + * in situations in which many packets are queued; if there aren't many
- + * packets queued the decision on how to iterate should be basically
- + * irrellevant; the number of control/data packets is more or less
- + * limited via the maximum number of pending packets). Thus, when
- + * inserting a control or re-submitted data packet, (determined by their
- + * priority), we search from front to back. Normal data packets are,
- + * usually queued directly at the tail of the queue, so for those search
- + * from back to front.
- + */
- +
- + if (priority > SSH_PACKET_PRIORITY_DATA) {
- + list_for_each(head, &p->ptl->queue.head) {
- + p = list_entry(head, struct ssh_packet, queue_node);
- +
- + if (READ_ONCE(p->priority) < priority)
- + break;
- + }
- + } else {
- + list_for_each_prev(head, &p->ptl->queue.head) {
- + p = list_entry(head, struct ssh_packet, queue_node);
- +
- + if (READ_ONCE(p->priority) >= priority) {
- + head = head->next;
- + break;
- + }
- + }
- + }
- +
- +
- + return head;
- +}
- +
- +static int ssh_ptl_queue_push(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- + struct list_head *head;
- +
- + spin_lock(&ptl->queue.lock);
- +
- + if (test_bit(SSH_PTL_SF_SHUTDOWN_BIT, &ptl->state)) {
- + spin_unlock(&ptl->queue.lock);
- + return -ESHUTDOWN;
- + }
- +
- + // avoid further transitions when cancelling/completing
- + if (test_bit(SSH_PACKET_SF_LOCKED_BIT, &packet->state)) {
- + spin_unlock(&ptl->queue.lock);
- + return -EINVAL;
- + }
- +
- + // if this packet has already been queued, do not add it
- + if (test_and_set_bit(SSH_PACKET_SF_QUEUED_BIT, &packet->state)) {
- + spin_unlock(&ptl->queue.lock);
- + return -EALREADY;
- + }
- +
- + head = __ssh_ptl_queue_find_entrypoint(packet);
- +
- + ssh_packet_get(packet);
- + list_add_tail(&packet->queue_node, &ptl->queue.head);
- +
- + spin_unlock(&ptl->queue.lock);
- + return 0;
- +}
- +
- +static void ssh_ptl_queue_remove(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- + bool remove;
- +
- + spin_lock(&ptl->queue.lock);
- +
- + remove = test_and_clear_bit(SSH_PACKET_SF_QUEUED_BIT, &packet->state);
- + if (remove)
- + list_del(&packet->queue_node);
- +
- + spin_unlock(&ptl->queue.lock);
- +
- + if (remove)
- + ssh_packet_put(packet);
- +}
- +
- +
- +static void ssh_ptl_pending_push(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- +
- + spin_lock(&ptl->pending.lock);
- +
- + // if we are cancelling/completing this packet, do not add it
- + if (test_bit(SSH_PACKET_SF_LOCKED_BIT, &packet->state)) {
- + spin_unlock(&ptl->pending.lock);
- + return;
- + }
- +
- + // in case it is already pending (e.g. re-submission), do not add it
- + if (test_and_set_bit(SSH_PACKET_SF_PENDING_BIT, &packet->state)) {
- + spin_unlock(&ptl->pending.lock);
- + return;
- + }
- +
- + atomic_inc(&ptl->pending.count);
- + ssh_packet_get(packet);
- + list_add_tail(&packet->pending_node, &ptl->pending.head);
- +
- + spin_unlock(&ptl->pending.lock);
- +}
- +
- +static void ssh_ptl_pending_remove(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- + bool remove;
- +
- + spin_lock(&ptl->pending.lock);
- +
- + remove = test_and_clear_bit(SSH_PACKET_SF_PENDING_BIT, &packet->state);
- + if (remove) {
- + list_del(&packet->pending_node);
- + atomic_dec(&ptl->pending.count);
- + }
- +
- + spin_unlock(&ptl->pending.lock);
- +
- + if (remove)
- + ssh_packet_put(packet);
- +}
- +
- +
- +static void __ssh_ptl_complete(struct ssh_packet *p, int status)
- +{
- + struct ssh_ptl *ptl = READ_ONCE(p->ptl);
- +
- + trace_ssam_packet_complete(p, status);
- +
- + ptl_dbg_cond(ptl, "ptl: completing packet %p\n", p);
- + if (p->ops->complete)
- + p->ops->complete(p, status);
- +}
- +
- +static void ssh_ptl_remove_and_complete(struct ssh_packet *p, int status)
- +{
- + /*
- + * A call to this function should in general be preceeded by
- + * set_bit(SSH_PACKET_SF_LOCKED_BIT, &p->flags) to avoid re-adding the
- + * packet to the structures it's going to be removed from.
- + *
- + * The set_bit call does not need explicit memory barriers as the
- + * implicit barrier of the test_and_set_bit call below ensure that the
- + * flag is visible before we actually attempt to remove the packet.
- + */
- +
- + if (test_and_set_bit(SSH_PACKET_SF_COMPLETED_BIT, &p->state))
- + return;
- +
- + ssh_ptl_queue_remove(p);
- + ssh_ptl_pending_remove(p);
- +
- + __ssh_ptl_complete(p, status);
- +}
- +
- +
- +static bool ssh_ptl_tx_can_process(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- +
- + if (packet->type & SSH_PACKET_TY_FLUSH)
- + return !atomic_read(&ptl->pending.count);
- +
- + // we can alwas process non-blocking packets
- + if (!(packet->type & SSH_PACKET_TY_BLOCKING))
- + return true;
- +
- + // if we are already waiting for this packet, send it again
- + if (test_bit(SSH_PACKET_SF_PENDING_BIT, &packet->state))
- + return true;
- +
- + // otherwise: check if we have the capacity to send
- + return atomic_read(&ptl->pending.count) < SSH_PTL_MAX_PENDING;
- +}
- +
- +static struct ssh_packet *ssh_ptl_tx_pop(struct ssh_ptl *ptl)
- +{
- + struct ssh_packet *packet = ERR_PTR(-ENOENT);
- + struct ssh_packet *p, *n;
- +
- + spin_lock(&ptl->queue.lock);
- + list_for_each_entry_safe(p, n, &ptl->queue.head, queue_node) {
- + /*
- + * If we are cancelling or completing this packet, ignore it.
- + * It's going to be removed from this queue shortly.
- + */
- + if (test_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))
- + continue;
- +
- + /*
- + * Packets should be ordered non-blocking/to-be-resent first.
- + * If we cannot process this packet, assume that we can't
- + * process any following packet either and abort.
- + */
- + if (!ssh_ptl_tx_can_process(p)) {
- + packet = ERR_PTR(-EBUSY);
- + break;
- + }
- +
- + /*
- + * We are allowed to change the state now. Remove it from the
- + * queue and mark it as being transmitted. Note that we cannot
- + * add it to the set of pending packets yet, as queue locks must
- + * always be acquired before packet locks (otherwise we might
- + * run into a deadlock).
- + */
- +
- + list_del(&p->queue_node);
- +
- + /*
- + * Ensure that the "queued" bit gets cleared after setting the
- + * "transmitting" bit to guaranteee non-zero flags.
- + */
- + set_bit(SSH_PACKET_SF_TRANSMITTING_BIT, &p->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_PACKET_SF_QUEUED_BIT, &p->state);
- +
- + packet = p;
- + break;
- + }
- + spin_unlock(&ptl->queue.lock);
- +
- + return packet;
- +}
- +
- +static struct ssh_packet *ssh_ptl_tx_next(struct ssh_ptl *ptl)
- +{
- + struct ssh_packet *p;
- +
- + p = ssh_ptl_tx_pop(ptl);
- + if (IS_ERR(p))
- + return p;
- +
- + if (p->type & SSH_PACKET_TY_SEQUENCED) {
- + ptl_dbg(ptl, "ptl: transmitting sequenced packet %p\n", p);
- + ssh_ptl_pending_push(p);
- + ssh_ptl_timeout_start(p);
- + } else {
- + ptl_dbg(ptl, "ptl: transmitting non-sequenced packet %p\n", p);
- + }
- +
- + /*
- + * Update number of tries. This directly influences the priority in case
- + * the packet is re-submitted (e.g. via timeout/NAK). Note that this is
- + * the only place where we update the priority in-flight. As this runs
- + * only on the tx-thread, this read-modify-write procedure is safe.
- + */
- + WRITE_ONCE(p->priority, READ_ONCE(p->priority) + 1);
- +
- + return p;
- +}
- +
- +static void ssh_ptl_tx_compl_success(struct ssh_packet *packet)
- +{
- + struct ssh_ptl *ptl = packet->ptl;
- +
- + ptl_dbg(ptl, "ptl: successfully transmitted packet %p\n", packet);
- +
- + /*
- + * Transition to state to "transmitted". Ensure that the flags never get
- + * zero with barrier.
- + */
- + set_bit(SSH_PACKET_SF_TRANSMITTED_BIT, &packet->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_PACKET_SF_TRANSMITTING_BIT, &packet->state);
- +
- + // if the packet is unsequenced, we're done: lock and complete
- + if (!(packet->type & SSH_PACKET_TY_SEQUENCED)) {
- + set_bit(SSH_PACKET_SF_LOCKED_BIT, &packet->state);
- + ssh_ptl_remove_and_complete(packet, 0);
- + }
- +
- + /*
- + * Notify that a packet transmission has finished. In general we're only
- + * waiting for one packet (if any), so wake_up_all should be fine.
- + */
- + wake_up_all(&ptl->tx.packet_wq);
- +}
- +
- +static void ssh_ptl_tx_compl_error(struct ssh_packet *packet, int status)
- +{
- + /*
- + * Transmission failure: Lock the packet and try to complete it. Ensure
- + * that the flags never get zero with barrier.
- + */
- + set_bit(SSH_PACKET_SF_LOCKED_BIT, &packet->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_PACKET_SF_TRANSMITTING_BIT, &packet->state);
- +
- + ptl_err(packet->ptl, "ptl: transmission error: %d\n", status);
- + ptl_dbg(packet->ptl, "ptl: failed to transmit packet: %p\n", packet);
- +
- + ssh_ptl_remove_and_complete(packet, status);
- +
- + /*
- + * Notify that a packet transmission has finished. In general we're only
- + * waiting for one packet (if any), so wake_up_all should be fine.
- + */
- + wake_up_all(&packet->ptl->tx.packet_wq);
- +}
- +
- +static void ssh_ptl_tx_threadfn_wait(struct ssh_ptl *ptl)
- +{
- + wait_event_interruptible(ptl->tx.thread_wq,
- + READ_ONCE(ptl->tx.thread_signal) || kthread_should_stop());
- + WRITE_ONCE(ptl->tx.thread_signal, false);
- +}
- +
- +static int ssh_ptl_tx_threadfn(void *data)
- +{
- + struct ssh_ptl *ptl = data;
- +
- + while (!kthread_should_stop()) {
- + unsigned char *buf;
- + bool drop = false;
- + size_t len = 0;
- + int status = 0;
- +
- + // if we don't have a packet, get the next and add it to pending
- + if (IS_ERR_OR_NULL(ptl->tx.packet)) {
- + ptl->tx.packet = ssh_ptl_tx_next(ptl);
- + ptl->tx.offset = 0;
- +
- + // if no packet is available, we are done
- + if (IS_ERR(ptl->tx.packet)) {
- + ssh_ptl_tx_threadfn_wait(ptl);
- + continue;
- + }
- + }
- +
- + // error injection: drop packet to simulate transmission problem
- + if (ptl->tx.offset == 0)
- + drop = ssh_ptl_should_drop_packet(ptl->tx.packet);
- +
- + // error injection: simulate invalid packet data
- + if (ptl->tx.offset == 0 && !drop)
- + ssh_ptl_tx_inject_invalid_data(ptl->tx.packet);
- +
- + // flush-packets don't have any data
- + if (likely(ptl->tx.packet->data && !drop)) {
- + buf = ptl->tx.packet->data + ptl->tx.offset;
- + len = ptl->tx.packet->data_length - ptl->tx.offset;
- +
- + ptl_dbg(ptl, "tx: sending data (length: %zu)\n", len);
- + print_hex_dump_debug("tx: ", DUMP_PREFIX_OFFSET, 16, 1,
- + buf, len, false);
- +
- + status = ssh_ptl_write_buf(ptl, ptl->tx.packet, buf, len);
- + }
- +
- + if (status < 0) {
- + // complete packet with error
- + ssh_ptl_tx_compl_error(ptl->tx.packet, status);
- + ssh_packet_put(ptl->tx.packet);
- + ptl->tx.packet = NULL;
- +
- + } else if (status == len) {
- + // complete packet and/or mark as transmitted
- + ssh_ptl_tx_compl_success(ptl->tx.packet);
- + ssh_packet_put(ptl->tx.packet);
- + ptl->tx.packet = NULL;
- +
- + } else { // need more buffer space
- + ptl->tx.offset += status;
- + ssh_ptl_tx_threadfn_wait(ptl);
- + }
- + }
- +
- + // cancel active packet before we actually stop
- + if (!IS_ERR_OR_NULL(ptl->tx.packet)) {
- + ssh_ptl_tx_compl_error(ptl->tx.packet, -ESHUTDOWN);
- + ssh_packet_put(ptl->tx.packet);
- + ptl->tx.packet = NULL;
- + }
- +
- + return 0;
- +}
- +
- +static inline void ssh_ptl_tx_wakeup(struct ssh_ptl *ptl, bool force)
- +{
- + if (test_bit(SSH_PTL_SF_SHUTDOWN_BIT, &ptl->state))
- + return;
- +
- + if (force || atomic_read(&ptl->pending.count) < SSH_PTL_MAX_PENDING) {
- + WRITE_ONCE(ptl->tx.thread_signal, true);
- + smp_mb__after_atomic();
- + wake_up(&ptl->tx.thread_wq);
- + }
- +}
- +
- +static int ssh_ptl_tx_start(struct ssh_ptl *ptl)
- +{
- + ptl->tx.thread = kthread_run(ssh_ptl_tx_threadfn, ptl, "surface-sh-tx");
- + if (IS_ERR(ptl->tx.thread))
- + return PTR_ERR(ptl->tx.thread);
- +
- + return 0;
- +}
- +
- +static int ssh_ptl_tx_stop(struct ssh_ptl *ptl)
- +{
- + int status = 0;
- +
- + if (ptl->tx.thread) {
- + status = kthread_stop(ptl->tx.thread);
- + ptl->tx.thread = NULL;
- + }
- +
- + return status;
- +}
- +
- +
- +static struct ssh_packet *ssh_ptl_ack_pop(struct ssh_ptl *ptl, u8 seq_id)
- +{
- + struct ssh_packet *packet = ERR_PTR(-ENOENT);
- + struct ssh_packet *p, *n;
- +
- + spin_lock(&ptl->pending.lock);
- + list_for_each_entry_safe(p, n, &ptl->pending.head, pending_node) {
- + /*
- + * We generally expect packets to be in order, so first packet
- + * to be added to pending is first to be sent, is first to be
- + * ACKed.
- + */
- + if (unlikely(ssh_packet_get_seq(p) != seq_id))
- + continue;
- +
- + /*
- + * In case we receive an ACK while handling a transmission error
- + * completion. The packet will be removed shortly.
- + */
- + if (unlikely(test_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))) {
- + packet = ERR_PTR(-EPERM);
- + break;
- + }
- +
- + /*
- + * Mark packet as ACKed and remove it from pending. Ensure that
- + * the flags never get zero with barrier.
- + */
- + set_bit(SSH_PACKET_SF_ACKED_BIT, &p->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_PACKET_SF_PENDING_BIT, &p->state);
- +
- + atomic_dec(&ptl->pending.count);
- + list_del(&p->pending_node);
- + packet = p;
- +
- + break;
- + }
- + spin_unlock(&ptl->pending.lock);
- +
- + return packet;
- +}
- +
- +static void ssh_ptl_wait_until_transmitted(struct ssh_packet *packet)
- +{
- + wait_event(packet->ptl->tx.packet_wq,
- + test_bit(SSH_PACKET_SF_TRANSMITTED_BIT, &packet->state)
- + || test_bit(SSH_PACKET_SF_LOCKED_BIT, &packet->state));
- +}
- +
- +static void ssh_ptl_acknowledge(struct ssh_ptl *ptl, u8 seq)
- +{
- + struct ssh_packet *p;
- + int status = 0;
- +
- + p = ssh_ptl_ack_pop(ptl, seq);
- + if (IS_ERR(p)) {
- + if (PTR_ERR(p) == -ENOENT) {
- + /*
- + * The packet has not been found in the set of pending
- + * packets.
- + */
- + ptl_warn(ptl, "ptl: received ACK for non-pending"
- + " packet\n");
- + } else {
- + /*
- + * The packet is pending, but we are not allowed to take
- + * it because it has been locked.
- + */
- + }
- + return;
- + }
- +
- + ptl_dbg(ptl, "ptl: received ACK for packet %p\n", p);
- +
- + /*
- + * It is possible that the packet has been transmitted, but the state
- + * has not been updated from "transmitting" to "transmitted" yet.
- + * In that case, we need to wait for this transition to occur in order
- + * to determine between success or failure.
- + */
- + if (test_bit(SSH_PACKET_SF_TRANSMITTING_BIT, &p->state))
- + ssh_ptl_wait_until_transmitted(p);
- +
- + /*
- + * The packet will already be locked in case of a transmission error or
- + * cancellation. Let the transmitter or cancellation issuer complete the
- + * packet.
- + */
- + if (unlikely(test_and_set_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))) {
- + ssh_packet_put(p);
- + return;
- + }
- +
- + if (unlikely(!test_bit(SSH_PACKET_SF_TRANSMITTED_BIT, &p->state))) {
- + ptl_err(ptl, "ptl: received ACK before packet had been fully"
- + " transmitted\n");
- + status = -EREMOTEIO;
- + }
- +
- + ssh_ptl_remove_and_complete(p, status);
- + ssh_packet_put(p);
- +
- + ssh_ptl_tx_wakeup(ptl, false);
- +}
- +
- +
- +static int ssh_ptl_submit(struct ssh_ptl *ptl, struct ssh_packet *packet)
- +{
- + int status;
- +
- + trace_ssam_packet_submit(packet);
- +
- + // validate packet fields
- + if (packet->type & SSH_PACKET_TY_FLUSH) {
- + if (packet->data || (packet->type & SSH_PACKET_TY_SEQUENCED))
- + return -EINVAL;
- + } else if (!packet->data) {
- + return -EINVAL;
- + }
- +
- + /*
- + * This function is currently not intended for re-submission. The ptl
- + * reference only gets set on the first submission. After the first
- + * submission, it has to be read-only.
- + *
- + * Use cmpxchg to ensure safety with regards to ssh_ptl_cancel and
- + * re-entry, where we can't guarantee that the packet has been submitted
- + * yet.
- + *
- + * The implicit barrier of cmpxchg is paired with barrier in
- + * ssh_ptl_cancel to guarantee cancelation in case the packet has never
- + * been submitted or is currently being submitted.
- + */
- + if (cmpxchg(&packet->ptl, NULL, ptl) != NULL)
- + return -EALREADY;
- +
- + status = ssh_ptl_queue_push(packet);
- + if (status)
- + return status;
- +
- + ssh_ptl_tx_wakeup(ptl, !(packet->type & SSH_PACKET_TY_BLOCKING));
- + return 0;
- +}
- +
- +static void __ssh_ptl_resubmit(struct ssh_packet *packet)
- +{
- + struct list_head *head;
- +
- + trace_ssam_packet_resubmit(packet);
- +
- + spin_lock(&packet->ptl->queue.lock);
- +
- + // if this packet has already been queued, do not add it
- + if (test_and_set_bit(SSH_PACKET_SF_QUEUED_BIT, &packet->state)) {
- + spin_unlock(&packet->ptl->queue.lock);
- + return;
- + }
- +
- + // find first node with lower priority
- + head = __ssh_ptl_queue_find_entrypoint(packet);
- +
- + WRITE_ONCE(packet->timestamp, KTIME_MAX);
- + smp_mb__after_atomic();
- +
- + // add packet
- + ssh_packet_get(packet);
- + list_add_tail(&packet->queue_node, head);
- +
- + spin_unlock(&packet->ptl->queue.lock);
- +}
- +
- +static void ssh_ptl_resubmit_pending(struct ssh_ptl *ptl)
- +{
- + struct ssh_packet *p;
- + bool resub = false;
- + u8 try;
- +
- + /*
- + * Note: We deliberately do not remove/attempt to cancel and complete
- + * packets that are out of tires in this function. The packet will be
- + * eventually canceled and completed by the timeout. Removing the packet
- + * here could lead to overly eager cancelation if the packet has not
- + * been re-transmitted yet but the tries-counter already updated (i.e
- + * ssh_ptl_tx_next removed the packet from the queue and updated the
- + * counter, but re-transmission for the last try has not actually
- + * started yet).
- + */
- +
- + spin_lock(&ptl->pending.lock);
- +
- + // re-queue all pending packets
- + list_for_each_entry(p, &ptl->pending.head, pending_node) {
- + // avoid further transitions if locked
- + if (test_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))
- + continue;
- +
- + // do not re-schedule if packet is out of tries
- + try = ssh_packet_priority_get_try(READ_ONCE(p->priority));
- + if (try >= SSH_PTL_MAX_PACKET_TRIES)
- + continue;
- +
- + resub = true;
- + __ssh_ptl_resubmit(p);
- + }
- +
- + spin_unlock(&ptl->pending.lock);
- +
- + ssh_ptl_tx_wakeup(ptl, resub);
- +}
- +
- +static void ssh_ptl_cancel(struct ssh_packet *p)
- +{
- + if (test_and_set_bit(SSH_PACKET_SF_CANCELED_BIT, &p->state))
- + return;
- +
- + trace_ssam_packet_cancel(p);
- +
- + /*
- + * Lock packet and commit with memory barrier. If this packet has
- + * already been locked, it's going to be removed and completed by
- + * another party, which should have precedence.
- + */
- + if (test_and_set_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))
- + return;
- +
- + /*
- + * By marking the packet as locked and employing the implicit memory
- + * barrier of test_and_set_bit, we have guaranteed that, at this point,
- + * the packet cannot be added to the queue any more.
- + *
- + * In case the packet has never been submitted, packet->ptl is NULL. If
- + * the packet is currently being submitted, packet->ptl may be NULL or
- + * non-NULL. Due marking the packet as locked above and committing with
- + * the memory barrier, we have guaranteed that, if packet->ptl is NULL,
- + * the packet will never be added to the queue. If packet->ptl is
- + * non-NULL, we don't have any guarantees.
- + */
- +
- + if (READ_ONCE(p->ptl)) {
- + ssh_ptl_remove_and_complete(p, -ECANCELED);
- + ssh_ptl_tx_wakeup(p->ptl, false);
- + } else if (!test_and_set_bit(SSH_PACKET_SF_COMPLETED_BIT, &p->state)) {
- + __ssh_ptl_complete(p, -ECANCELED);
- + }
- +}
- +
- +
- +static ktime_t ssh_packet_get_expiration(struct ssh_packet *p, ktime_t timeout)
- +{
- + ktime_t timestamp = READ_ONCE(p->timestamp);
- +
- + if (timestamp != KTIME_MAX)
- + return ktime_add(timestamp, timeout);
- + else
- + return KTIME_MAX;
- +}
- +
- +static void ssh_ptl_timeout_reap(struct work_struct *work)
- +{
- + struct ssh_ptl *ptl = to_ssh_ptl(work, rtx_timeout.reaper.work);
- + struct ssh_packet *p, *n;
- + LIST_HEAD(claimed);
- + ktime_t now = ktime_get_coarse_boottime();
- + ktime_t timeout = ptl->rtx_timeout.timeout;
- + ktime_t next = KTIME_MAX;
- + bool resub = false;
- +
- + trace_ssam_ptl_timeout_reap("pending", atomic_read(&ptl->pending.count));
- +
- + /*
- + * Mark reaper as "not pending". This is done before checking any
- + * packets to avoid lost-update type problems.
- + */
- + WRITE_ONCE(ptl->rtx_timeout.expires, KTIME_MAX);
- + smp_mb__after_atomic();
- +
- + spin_lock(&ptl->pending.lock);
- +
- + list_for_each_entry_safe(p, n, &ptl->pending.head, pending_node) {
- + ktime_t expires = ssh_packet_get_expiration(p, timeout);
- + u8 try;
- +
- + /*
- + * Check if the timeout hasn't expired yet. Find out next
- + * expiration date to be handled after this run.
- + */
- + if (ktime_after(expires, now)) {
- + next = ktime_before(expires, next) ? expires : next;
- + continue;
- + }
- +
- + // avoid further transitions if locked
- + if (test_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))
- + continue;
- +
- + trace_ssam_packet_timeout(p);
- +
- + // check if we still have some tries left
- + try = ssh_packet_priority_get_try(READ_ONCE(p->priority));
- + if (likely(try < SSH_PTL_MAX_PACKET_TRIES)) {
- + resub = true;
- + __ssh_ptl_resubmit(p);
- + continue;
- + }
- +
- + // no more tries left: cancel the packet
- +
- + // if someone else has locked the packet already, don't use it
- + if (test_and_set_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state))
- + continue;
- +
- + /*
- + * We have now marked the packet as locked. Thus it cannot be
- + * added to the pending list again after we've removed it here.
- + * We can therefore re-use the pending_node of this packet
- + * temporarily.
- + */
- +
- + clear_bit(SSH_PACKET_SF_PENDING_BIT, &p->state);
- +
- + atomic_dec(&ptl->pending.count);
- + list_del(&p->pending_node);
- +
- + list_add_tail(&p->pending_node, &claimed);
- + }
- +
- + spin_unlock(&ptl->pending.lock);
- +
- + // cancel and complete the packet
- + list_for_each_entry_safe(p, n, &claimed, pending_node) {
- + if (!test_and_set_bit(SSH_PACKET_SF_COMPLETED_BIT, &p->state)) {
- + ssh_ptl_queue_remove(p);
- + __ssh_ptl_complete(p, -ETIMEDOUT);
- + }
- +
- + // drop the reference we've obtained by removing it from pending
- + list_del(&p->pending_node);
- + ssh_packet_put(p);
- + }
- +
- + // ensure that reaper doesn't run again immediately
- + next = max(next, ktime_add(now, SSH_PTL_PACKET_TIMEOUT_RESOLUTION));
- + if (next != KTIME_MAX)
- + ssh_ptl_timeout_reaper_mod(ptl, now, next);
- +
- + // force-wakeup to properly handle re-transmits if we've re-submitted
- + ssh_ptl_tx_wakeup(ptl, resub);
- +}
- +
- +
- +static bool ssh_ptl_rx_blacklist_check(struct ssh_ptl *ptl, u8 seq)
- +{
- + int i;
- +
- + // check if SEQ is blacklisted
- + for (i = 0; i < ARRAY_SIZE(ptl->rx.blacklist.seqs); i++) {
- + if (likely(ptl->rx.blacklist.seqs[i] != seq))
- + continue;
- +
- + ptl_dbg(ptl, "ptl: ignoring repeated data packet\n");
- + return true;
- + }
- +
- + // update blacklist
- + ptl->rx.blacklist.seqs[ptl->rx.blacklist.offset] = seq;
- + ptl->rx.blacklist.offset = (ptl->rx.blacklist.offset + 1)
- + % ARRAY_SIZE(ptl->rx.blacklist.seqs);
- +
- + return false;
- +}
- +
- +static void ssh_ptl_rx_dataframe(struct ssh_ptl *ptl,
- + const struct ssh_frame *frame,
- + const struct sshp_span *payload)
- +{
- + if (ssh_ptl_rx_blacklist_check(ptl, frame->seq))
- + return;
- +
- + ptl->ops.data_received(ptl, payload);
- +}
- +
- +static void ssh_ptl_send_ack(struct ssh_ptl *ptl, u8 seq)
- +{
- + struct ssh_packet_args args;
- + struct ssh_packet *packet;
- + struct msgbuf msgb;
- +
- + args.type = 0;
- + args.priority = SSH_PACKET_PRIORITY(ACK, 0);
- + args.ops = &ssh_ptl_ctrl_packet_ops;
- +
- + packet = ptl_alloc_ctrl_packet(ptl, &args, GFP_KERNEL);
- + if (!packet) {
- + ptl_err(ptl, "ptl: failed to allocate ACK packet\n");
- + return;
- + }
- +
- + msgb_init(&msgb, packet->data, packet->data_length);
- + msgb_push_ack(&msgb, seq);
- + packet->data_length = msgb_bytes_used(&msgb);
- +
- + ssh_ptl_submit(ptl, packet);
- + ssh_packet_put(packet);
- +}
- +
- +static void ssh_ptl_send_nak(struct ssh_ptl *ptl)
- +{
- + struct ssh_packet_args args;
- + struct ssh_packet *packet;
- + struct msgbuf msgb;
- +
- + args.type = 0;
- + args.priority = SSH_PACKET_PRIORITY(NAK, 0);
- + args.ops = &ssh_ptl_ctrl_packet_ops;
- +
- + packet = ptl_alloc_ctrl_packet(ptl, &args, GFP_KERNEL);
- + if (!packet) {
- + ptl_err(ptl, "ptl: failed to allocate NAK packet\n");
- + return;
- + }
- +
- + msgb_init(&msgb, packet->data, packet->data_length);
- + msgb_push_nak(&msgb);
- + packet->data_length = msgb_bytes_used(&msgb);
- +
- + ssh_ptl_submit(ptl, packet);
- + ssh_packet_put(packet);
- +}
- +
- +static size_t ssh_ptl_rx_eval(struct ssh_ptl *ptl, struct sshp_span *source)
- +{
- + struct ssh_frame *frame;
- + struct sshp_span payload;
- + struct sshp_span aligned;
- + bool syn_found;
- + int status;
- +
- + // error injection: modify data to simulate corrupt SYN bytes
- + ssh_ptl_rx_inject_invalid_syn(ptl, source);
- +
- + // find SYN
- + syn_found = sshp_find_syn(source, &aligned);
- +
- + if (unlikely(aligned.ptr - source->ptr) > 0) {
- + ptl_warn(ptl, "rx: parser: invalid start of frame, skipping\n");
- +
- + /*
- + * Notes:
- + * - This might send multiple NAKs in case the communication
- + * starts with an invalid SYN and is broken down into multiple
- + * pieces. This should generally be handled fine, we just
- + * might receive duplicate data in this case, which is
- + * detected when handling data frames.
- + * - This path will also be executed on invalid CRCs: When an
- + * invalid CRC is encountered, the code below will skip data
- + * until direclty after the SYN. This causes the search for
- + * the next SYN, which is generally not placed directly after
- + * the last one.
- + */
- + ssh_ptl_send_nak(ptl);
- + }
- +
- + if (unlikely(!syn_found))
- + return aligned.ptr - source->ptr;
- +
- + // error injection: modify data to simulate corruption
- + ssh_ptl_rx_inject_invalid_data(ptl, &aligned);
- +
- + // parse and validate frame
- + status = sshp_parse_frame(&ptl->serdev->dev, &aligned, &frame, &payload,
- + SSH_PTL_RX_BUF_LEN);
- + if (status) // invalid frame: skip to next syn
- + return aligned.ptr - source->ptr + sizeof(u16);
- + if (!frame) // not enough data
- + return aligned.ptr - source->ptr;
- +
- + trace_ssam_rx_frame_received(frame);
- +
- + switch (frame->type) {
- + case SSH_FRAME_TYPE_ACK:
- + ssh_ptl_acknowledge(ptl, frame->seq);
- + break;
- +
- + case SSH_FRAME_TYPE_NAK:
- + ssh_ptl_resubmit_pending(ptl);
- + break;
- +
- + case SSH_FRAME_TYPE_DATA_SEQ:
- + ssh_ptl_send_ack(ptl, frame->seq);
- + /* fallthrough */
- +
- + case SSH_FRAME_TYPE_DATA_NSQ:
- + ssh_ptl_rx_dataframe(ptl, frame, &payload);
- + break;
- +
- + default:
- + ptl_warn(ptl, "ptl: received frame with unknown type 0x%02x\n",
- + frame->type);
- + break;
- + }
- +
- + return aligned.ptr - source->ptr + SSH_MESSAGE_LENGTH(frame->len);
- +}
- +
- +static int ssh_ptl_rx_threadfn(void *data)
- +{
- + struct ssh_ptl *ptl = data;
- +
- + while (true) {
- + struct sshp_span span;
- + size_t offs = 0;
- + size_t n;
- +
- + wait_event_interruptible(ptl->rx.wq,
- + !kfifo_is_empty(&ptl->rx.fifo)
- + || kthread_should_stop());
- + if (kthread_should_stop())
- + break;
- +
- + // copy from fifo to evaluation buffer
- + n = sshp_buf_read_from_fifo(&ptl->rx.buf, &ptl->rx.fifo);
- +
- + ptl_dbg(ptl, "rx: received data (size: %zu)\n", n);
- + print_hex_dump_debug("rx: ", DUMP_PREFIX_OFFSET, 16, 1,
- + ptl->rx.buf.ptr + ptl->rx.buf.len - n,
- + n, false);
- +
- + // parse until we need more bytes or buffer is empty
- + while (offs < ptl->rx.buf.len) {
- + sshp_buf_span_from(&ptl->rx.buf, offs, &span);
- + n = ssh_ptl_rx_eval(ptl, &span);
- + if (n == 0)
- + break; // need more bytes
- +
- + offs += n;
- + }
- +
- + // throw away the evaluated parts
- + sshp_buf_drop(&ptl->rx.buf, offs);
- + }
- +
- + return 0;
- +}
- +
- +static inline void ssh_ptl_rx_wakeup(struct ssh_ptl *ptl)
- +{
- + wake_up(&ptl->rx.wq);
- +}
- +
- +static int ssh_ptl_rx_start(struct ssh_ptl *ptl)
- +{
- + if (ptl->rx.thread)
- + return 0;
- +
- + ptl->rx.thread = kthread_run(ssh_ptl_rx_threadfn, ptl, "surface-sh-rx");
- + if (IS_ERR(ptl->rx.thread))
- + return PTR_ERR(ptl->rx.thread);
- +
- + return 0;
- +}
- +
- +static int ssh_ptl_rx_stop(struct ssh_ptl *ptl)
- +{
- + int status = 0;
- +
- + if (ptl->rx.thread) {
- + status = kthread_stop(ptl->rx.thread);
- + ptl->rx.thread = NULL;
- + }
- +
- + return status;
- +}
- +
- +static int ssh_ptl_rx_rcvbuf(struct ssh_ptl *ptl, const u8 *buf, size_t n)
- +{
- + int used;
- +
- + if (test_bit(SSH_PTL_SF_SHUTDOWN_BIT, &ptl->state))
- + return used;
- +
- + used = kfifo_in(&ptl->rx.fifo, buf, n);
- + if (used)
- + ssh_ptl_rx_wakeup(ptl);
- +
- + return used;
- +}
- +
- +
- +struct ssh_flush_packet {
- + struct ssh_packet base;
- + struct completion completion;
- + int status;
- +};
- +
- +static void ssh_ptl_flush_complete(struct ssh_packet *p, int status)
- +{
- + struct ssh_flush_packet *packet;
- +
- + packet = container_of(p, struct ssh_flush_packet, base);
- + packet->status = status;
- +}
- +
- +static void ssh_ptl_flush_release(struct ssh_packet *p)
- +{
- + struct ssh_flush_packet *packet;
- +
- + packet = container_of(p, struct ssh_flush_packet, base);
- + complete_all(&packet->completion);
- +}
- +
- +static const struct ssh_packet_ops ssh_flush_packet_ops = {
- + .complete = ssh_ptl_flush_complete,
- + .release = ssh_ptl_flush_release,
- +};
- +
- +/**
- + * ssh_ptl_flush - flush the packet transmission layer
- + * @ptl: packet transmission layer
- + * @timeout: timeout for the flush operation in jiffies
- + *
- + * Queue a special flush-packet and wait for its completion. This packet will
- + * be completed after all other currently queued and pending packets have been
- + * completed. Flushing guarantees that all previously submitted data packets
- + * have been fully completed before this call returns. Additionally, flushing
- + * blocks execution of all later submitted data packets until the flush has been
- + * completed.
- + *
- + * Control (i.e. ACK/NAK) packets that have been submitted after this call will
- + * be placed before the flush packet in the queue, as long as the flush-packet
- + * has not been chosen for processing yet.
- + *
- + * Flushing, even when no new data packets are submitted after this call, does
- + * not guarantee that no more packets are scheduled. For example, incoming
- + * messages can promt automated submission of ACK or NAK type packets. If this
- + * happens while the flush-packet is being processed (i.e. after it has been
- + * taken from the queue), such packets may still be queued after this function
- + * returns.
- + *
- + * Return: Zero on success, -ETIMEDOUT if the flush timed out and has been
- + * canceled as a result of the timeout, or -ESHUTDOWN if the packet transmission
- + * layer has been shut down before this call. May also return -EINTR if the
- + * packet transmission has been interrupted.
- + */
- +static int ssh_ptl_flush(struct ssh_ptl *ptl, unsigned long timeout)
- +{
- + struct ssh_flush_packet packet;
- + struct ssh_packet_args args;
- + int status;
- +
- + args.type = SSH_PACKET_TY_FLUSH | SSH_PACKET_TY_BLOCKING;
- + args.priority = SSH_PACKET_PRIORITY(FLUSH, 0);
- + args.ops = &ssh_flush_packet_ops;
- +
- + ssh_packet_init(&packet.base, &args);
- + init_completion(&packet.completion);
- +
- + status = ssh_ptl_submit(ptl, &packet.base);
- + if (status)
- + return status;
- +
- + ssh_packet_put(&packet.base);
- +
- + if (wait_for_completion_timeout(&packet.completion, timeout))
- + return 0;
- +
- + ssh_ptl_cancel(&packet.base);
- + wait_for_completion(&packet.completion);
- +
- + WARN_ON(packet.status != 0 && packet.status != -ECANCELED
- + && packet.status != -ESHUTDOWN && packet.status != -EINTR);
- +
- + return packet.status == -ECANCELED ? -ETIMEDOUT : status;
- +}
- +
- +/**
- + * ssh_ptl_shutdown - shut down the packet transmission layer
- + * @ptl: packet transmission layer
- + *
- + * Shuts down the packet transmission layer, removing and canceling all queued
- + * and pending packets. Packets canceled by this operation will be completed
- + * with -ESHUTDOWN as status.
- + *
- + * As a result of this function, the transmission layer will be marked as shut
- + * down. Submission of packets after the transmission layer has been shut down
- + * will fail with -ESHUTDOWN.
- + */
- +static void ssh_ptl_shutdown(struct ssh_ptl *ptl)
- +{
- + LIST_HEAD(complete_q);
- + LIST_HEAD(complete_p);
- + struct ssh_packet *p, *n;
- + int status;
- +
- + // ensure that no new packets (including ACK/NAK) can be submitted
- + set_bit(SSH_PTL_SF_SHUTDOWN_BIT, &ptl->state);
- + smp_mb__after_atomic();
- +
- + status = ssh_ptl_rx_stop(ptl);
- + if (status)
- + ptl_err(ptl, "ptl: failed to stop receiver thread\n");
- +
- + status = ssh_ptl_tx_stop(ptl);
- + if (status)
- + ptl_err(ptl, "ptl: failed to stop transmitter thread\n");
- +
- + cancel_delayed_work_sync(&ptl->rtx_timeout.reaper);
- +
- + /*
- + * At this point, all threads have been stopped. This means that the
- + * only references to packets from inside the system are in the queue
- + * and pending set.
- + *
- + * Note: We still need locks here because someone could still be
- + * cancelling packets.
- + *
- + * Note 2: We can re-use queue_node (or pending_node) if we mark the
- + * packet as locked an then remove it from the queue (or pending set
- + * respecitvely). Marking the packet as locked avoids re-queueing
- + * (which should already be prevented by having stopped the treads...)
- + * and not setting QUEUED_BIT (or PENDING_BIT) prevents removal from a
- + * new list via other threads (e.g. canellation).
- + *
- + * Note 3: There may be overlap between complete_p and complete_q.
- + * This is handled via test_and_set_bit on the "completed" flag
- + * (also handles cancelation).
- + */
- +
- + // mark queued packets as locked and move them to complete_q
- + spin_lock(&ptl->queue.lock);
- + list_for_each_entry_safe(p, n, &ptl->queue.head, queue_node) {
- + set_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_PACKET_SF_QUEUED_BIT, &p->state);
- +
- + list_del(&p->queue_node);
- + list_add_tail(&p->queue_node, &complete_q);
- + }
- + spin_unlock(&ptl->queue.lock);
- +
- + // mark pending packets as locked and move them to complete_p
- + spin_lock(&ptl->pending.lock);
- + list_for_each_entry_safe(p, n, &ptl->pending.head, pending_node) {
- + set_bit(SSH_PACKET_SF_LOCKED_BIT, &p->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_PACKET_SF_PENDING_BIT, &p->state);
- +
- + list_del(&p->pending_node);
- + list_add_tail(&p->pending_node, &complete_q);
- + }
- + atomic_set(&ptl->pending.count, 0);
- + spin_unlock(&ptl->pending.lock);
- +
- + // complete and drop packets on complete_q
- + list_for_each_entry(p, &complete_q, queue_node) {
- + if (!test_and_set_bit(SSH_PACKET_SF_COMPLETED_BIT, &p->state))
- + __ssh_ptl_complete(p, -ESHUTDOWN);
- +
- + ssh_packet_put(p);
- + }
- +
- + // complete and drop packets on complete_p
- + list_for_each_entry(p, &complete_p, pending_node) {
- + if (!test_and_set_bit(SSH_PACKET_SF_COMPLETED_BIT, &p->state))
- + __ssh_ptl_complete(p, -ESHUTDOWN);
- +
- + ssh_packet_put(p);
- + }
- +
- + /*
- + * At this point we have guaranteed that the system doesn't reference
- + * any packets any more.
- + */
- +}
- +
- +static inline struct device *ssh_ptl_get_device(struct ssh_ptl *ptl)
- +{
- + return &ptl->serdev->dev;
- +}
- +
- +static int ssh_ptl_init(struct ssh_ptl *ptl, struct serdev_device *serdev,
- + struct ssh_ptl_ops *ops)
- +{
- + int i, status;
- +
- + ptl->serdev = serdev;
- + ptl->state = 0;
- +
- + spin_lock_init(&ptl->queue.lock);
- + INIT_LIST_HEAD(&ptl->queue.head);
- +
- + spin_lock_init(&ptl->pending.lock);
- + INIT_LIST_HEAD(&ptl->pending.head);
- + atomic_set_release(&ptl->pending.count, 0);
- +
- + ptl->tx.thread = NULL;
- + ptl->tx.thread_signal = false;
- + ptl->tx.packet = NULL;
- + ptl->tx.offset = 0;
- + init_waitqueue_head(&ptl->tx.thread_wq);
- + init_waitqueue_head(&ptl->tx.packet_wq);
- +
- + ptl->rx.thread = NULL;
- + init_waitqueue_head(&ptl->rx.wq);
- +
- + ptl->rtx_timeout.timeout = SSH_PTL_PACKET_TIMEOUT;
- + ptl->rtx_timeout.expires = KTIME_MAX;
- + INIT_DELAYED_WORK(&ptl->rtx_timeout.reaper, ssh_ptl_timeout_reap);
- +
- + ptl->ops = *ops;
- +
- + // initialize SEQ blacklist with invalid sequence IDs
- + for (i = 0; i < ARRAY_SIZE(ptl->rx.blacklist.seqs); i++)
- + ptl->rx.blacklist.seqs[i] = 0xFFFF;
- + ptl->rx.blacklist.offset = 0;
- +
- + status = kfifo_alloc(&ptl->rx.fifo, SSH_PTL_RX_FIFO_LEN, GFP_KERNEL);
- + if (status)
- + return status;
- +
- + status = sshp_buf_alloc(&ptl->rx.buf, SSH_PTL_RX_BUF_LEN, GFP_KERNEL);
- + if (status)
- + kfifo_free(&ptl->rx.fifo);
- +
- + return status;
- +}
- +
- +static void ssh_ptl_destroy(struct ssh_ptl *ptl)
- +{
- + kfifo_free(&ptl->rx.fifo);
- + sshp_buf_free(&ptl->rx.buf);
- +}
- +
- +
- +/* -- Request transport layer (rtl). ---------------------------------------- */
- +
- +#define SSH_RTL_REQUEST_TIMEOUT ms_to_ktime(1000)
- +#define SSH_RTL_REQUEST_TIMEOUT_RESOLUTION ms_to_ktime(max(2000 / HZ, 50))
- +
- +#define SSH_RTL_MAX_PENDING 3
- +
- +
- +enum ssh_rtl_state_flags {
- + SSH_RTL_SF_SHUTDOWN_BIT,
- +};
- +
- +struct ssh_rtl_ops {
- + void (*handle_event)(struct ssh_rtl *rtl, const struct ssh_command *cmd,
- + const struct sshp_span *data);
- +};
- +
- +struct ssh_rtl {
- + struct ssh_ptl ptl;
- + unsigned long state;
- +
- + struct {
- + spinlock_t lock;
- + struct list_head head;
- + } queue;
- +
- + struct {
- + spinlock_t lock;
- + struct list_head head;
- + atomic_t count;
- + } pending;
- +
- + struct {
- + struct work_struct work;
- + } tx;
- +
- + struct {
- + ktime_t timeout;
- + ktime_t expires;
- + struct delayed_work reaper;
- + } rtx_timeout;
- +
- + struct ssh_rtl_ops ops;
- +};
- +
- +
- +#define rtl_dbg(r, fmt, ...) ptl_dbg(&(r)->ptl, fmt, ##__VA_ARGS__)
- +#define rtl_info(p, fmt, ...) ptl_info(&(p)->ptl, fmt, ##__VA_ARGS__)
- +#define rtl_warn(r, fmt, ...) ptl_warn(&(r)->ptl, fmt, ##__VA_ARGS__)
- +#define rtl_err(r, fmt, ...) ptl_err(&(r)->ptl, fmt, ##__VA_ARGS__)
- +#define rtl_dbg_cond(r, fmt, ...) __ssam_prcond(rtl_dbg, r, fmt, ##__VA_ARGS__)
- +
- +#define to_ssh_rtl(ptr, member) \
- + container_of(ptr, struct ssh_rtl, member)
- +
- +#define to_ssh_request(ptr, member) \
- + container_of(ptr, struct ssh_request, member)
- +
- +
- +/**
- + * ssh_rtl_should_drop_response - error injection hook to drop request responses
- + *
- + * Useful to cause request transmission timeouts in the driver by dropping the
- + * response to a request.
- + */
- +static noinline_if_inject bool ssh_rtl_should_drop_response(void)
- +{
- + return false;
- +}
- +ALLOW_ERROR_INJECTION(ssh_rtl_should_drop_response, TRUE);
- +
- +
- +static inline void ssh_request_get(struct ssh_request *rqst)
- +{
- + ssh_packet_get(&rqst->packet);
- +}
- +
- +static inline void ssh_request_put(struct ssh_request *rqst)
- +{
- + ssh_packet_put(&rqst->packet);
- +}
- +
- +
- +static inline u16 ssh_request_get_rqid(struct ssh_request *rqst)
- +{
- + return get_unaligned_le16(rqst->packet.data
- + + SSH_MSGOFFSET_COMMAND(rqid));
- +}
- +
- +static inline u32 ssh_request_get_rqid_safe(struct ssh_request *rqst)
- +{
- + if (!rqst->packet.data)
- + return -1;
- +
- + return ssh_request_get_rqid(rqst);
- +}
- +
- +
- +static void ssh_rtl_queue_remove(struct ssh_request *rqst)
- +{
- + bool remove;
- +
- + spin_lock(&rqst->rtl->queue.lock);
- +
- + remove = test_and_clear_bit(SSH_REQUEST_SF_QUEUED_BIT, &rqst->state);
- + if (remove)
- + list_del(&rqst->node);
- +
- + spin_unlock(&rqst->rtl->queue.lock);
- +
- + if (remove)
- + ssh_request_put(rqst);
- +}
- +
- +static void ssh_rtl_pending_remove(struct ssh_request *rqst)
- +{
- + bool remove;
- +
- + spin_lock(&rqst->rtl->pending.lock);
- +
- + remove = test_and_clear_bit(SSH_REQUEST_SF_PENDING_BIT, &rqst->state);
- + if (remove) {
- + atomic_dec(&rqst->rtl->pending.count);
- + list_del(&rqst->node);
- + }
- +
- + spin_unlock(&rqst->rtl->pending.lock);
- +
- + if (remove)
- + ssh_request_put(rqst);
- +}
- +
- +
- +static void ssh_rtl_complete_with_status(struct ssh_request *rqst, int status)
- +{
- + struct ssh_rtl *rtl = READ_ONCE(rqst->rtl);
- +
- + trace_ssam_request_complete(rqst, status);
- +
- + // rqst->rtl may not be set if we're cancelling before submitting
- + rtl_dbg_cond(rtl, "rtl: completing request (rqid: 0x%04x,"
- + " status: %d)\n", ssh_request_get_rqid_safe(rqst), status);
- +
- + rqst->ops->complete(rqst, NULL, NULL, status);
- +}
- +
- +static void ssh_rtl_complete_with_rsp(struct ssh_request *rqst,
- + const struct ssh_command *cmd,
- + const struct sshp_span *data)
- +{
- + trace_ssam_request_complete(rqst, 0);
- +
- + rtl_dbg(rqst->rtl, "rtl: completing request with response"
- + " (rqid: 0x%04x)\n", ssh_request_get_rqid(rqst));
- +
- + rqst->ops->complete(rqst, cmd, data, 0);
- +}
- +
- +
- +static bool ssh_rtl_tx_can_process(struct ssh_request *rqst)
- +{
- + if (test_bit(SSH_REQUEST_TY_FLUSH_BIT, &rqst->state))
- + return !atomic_read(&rqst->rtl->pending.count);
- +
- + return atomic_read(&rqst->rtl->pending.count) < SSH_RTL_MAX_PENDING;
- +}
- +
- +static struct ssh_request *ssh_rtl_tx_next(struct ssh_rtl *rtl)
- +{
- + struct ssh_request *rqst = ERR_PTR(-ENOENT);
- + struct ssh_request *p, *n;
- +
- + spin_lock(&rtl->queue.lock);
- +
- + // find first non-locked request and remove it
- + list_for_each_entry_safe(p, n, &rtl->queue.head, node) {
- + if (unlikely(test_bit(SSH_REQUEST_SF_LOCKED_BIT, &p->state)))
- + continue;
- +
- + if (!ssh_rtl_tx_can_process(p)) {
- + rqst = ERR_PTR(-EBUSY);
- + break;
- + }
- +
- + /*
- + * Remove from queue and mark as transmitting. Ensure that the
- + * state does not get zero via memory barrier.
- + */
- + set_bit(SSH_REQUEST_SF_TRANSMITTING_BIT, &p->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_REQUEST_SF_QUEUED_BIT, &p->state);
- +
- + list_del(&p->node);
- +
- + rqst = p;
- + break;
- + }
- +
- + spin_unlock(&rtl->queue.lock);
- + return rqst;
- +}
- +
- +static int ssh_rtl_tx_pending_push(struct ssh_request *rqst)
- +{
- + struct ssh_rtl *rtl = rqst->rtl;
- +
- + spin_lock(&rtl->pending.lock);
- +
- + if (test_bit(SSH_REQUEST_SF_LOCKED_BIT, &rqst->state)) {
- + spin_unlock(&rtl->pending.lock);
- + return -EINVAL;
- + }
- +
- + if (test_and_set_bit(SSH_REQUEST_SF_PENDING_BIT, &rqst->state)) {
- + spin_unlock(&rtl->pending.lock);
- + return -EALREADY;
- + }
- +
- + atomic_inc(&rtl->pending.count);
- + ssh_request_get(rqst);
- + list_add_tail(&rqst->node, &rtl->pending.head);
- +
- + spin_unlock(&rtl->pending.lock);
- + return 0;
- +}
- +
- +static int ssh_rtl_tx_try_process_one(struct ssh_rtl *rtl)
- +{
- + struct ssh_request *rqst;
- + int status;
- +
- + // get and prepare next request for transmit
- + rqst = ssh_rtl_tx_next(rtl);
- + if (IS_ERR(rqst))
- + return PTR_ERR(rqst);
- +
- + // add to/mark as pending
- + status = ssh_rtl_tx_pending_push(rqst);
- + if (status) {
- + ssh_request_put(rqst);
- + return -EAGAIN;
- + }
- +
- + // submit packet
- + status = ssh_ptl_submit(&rtl->ptl, &rqst->packet);
- + if (status == -ESHUTDOWN) {
- + /*
- + * Packet has been refused due to the packet layer shutting
- + * down. Complete it here.
- + */
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &rqst->state);
- + smp_mb__after_atomic();
- +
- + ssh_rtl_pending_remove(rqst);
- + ssh_rtl_complete_with_status(rqst, -ESHUTDOWN);
- +
- + ssh_request_put(rqst);
- + return -ESHUTDOWN;
- +
- + } else if (status) {
- + /*
- + * If submitting the packet failed and the packet layer isn't
- + * shutting down, the packet has either been submmitted/queued
- + * before (-EALREADY, which cannot happen as we have guaranteed
- + * that requests cannot be re-submitted), or the packet was
- + * marked as locked (-EINVAL). To mark the packet locked at this
- + * stage, the request, and thus the packets itself, had to have
- + * been canceled. Simply drop the reference. Cancellation itself
- + * will remove it from the set of pending requests.
- + */
- +
- + WARN_ON(status != -EINVAL);
- +
- + ssh_request_put(rqst);
- + return -EAGAIN;
- + }
- +
- + ssh_request_put(rqst);
- + return 0;
- +}
- +
- +static bool ssh_rtl_queue_empty(struct ssh_rtl *rtl)
- +{
- + bool empty;
- +
- + spin_lock(&rtl->queue.lock);
- + empty = list_empty(&rtl->queue.head);
- + spin_unlock(&rtl->queue.lock);
- +
- + return empty;
- +}
- +
- +static bool ssh_rtl_tx_schedule(struct ssh_rtl *rtl)
- +{
- + if (atomic_read(&rtl->pending.count) >= SSH_RTL_MAX_PENDING)
- + return false;
- +
- + if (ssh_rtl_queue_empty(rtl))
- + return false;
- +
- + return schedule_work(&rtl->tx.work);
- +}
- +
- +static void ssh_rtl_tx_work_fn(struct work_struct *work)
- +{
- + struct ssh_rtl *rtl = to_ssh_rtl(work, tx.work);
- + int i, status;
- +
- + /*
- + * Try to be nice and not block the workqueue: Run a maximum of 10
- + * tries, then re-submit if necessary. This should not be neccesary,
- + * for normal execution, but guarantee it anyway.
- + */
- + for (i = 0; i < 10; i++) {
- + status = ssh_rtl_tx_try_process_one(rtl);
- + if (status == -ENOENT || status == -EBUSY)
- + return; // no more requests to process
- +
- + if (status == -ESHUTDOWN) {
- + /*
- + * Packet system shutting down. No new packets can be
- + * transmitted. Return silently, the party initiating
- + * the shutdown should handle the rest.
- + */
- + return;
- + }
- +
- + WARN_ON(status != 0 && status != -EAGAIN);
- + }
- +
- + // out of tries, reschedule
- + ssh_rtl_tx_schedule(rtl);
- +}
- +
- +
- +static int ssh_rtl_submit(struct ssh_rtl *rtl, struct ssh_request *rqst)
- +{
- + trace_ssam_request_submit(rqst);
- +
- + /*
- + * Ensure that requests expecting a response are sequenced. If this
- + * invariant ever changes, see the comment in ssh_rtl_complete on what
- + * is required to be changed in the code.
- + */
- + if (test_bit(SSH_REQUEST_TY_HAS_RESPONSE_BIT, &rqst->state))
- + if (!(rqst->packet.type & SSH_PACKET_TY_SEQUENCED))
- + return -EINVAL;
- +
- + // try to set rtl and check if this request has already been submitted
- + if (cmpxchg(&rqst->rtl, NULL, rtl) != NULL)
- + return -EALREADY;
- +
- + spin_lock(&rtl->queue.lock);
- +
- + if (test_bit(SSH_RTL_SF_SHUTDOWN_BIT, &rtl->state)) {
- + spin_unlock(&rtl->queue.lock);
- + return -ESHUTDOWN;
- + }
- +
- + if (test_bit(SSH_REQUEST_SF_LOCKED_BIT, &rqst->state)) {
- + spin_unlock(&rtl->queue.lock);
- + return -EINVAL;
- + }
- +
- + ssh_request_get(rqst);
- + set_bit(SSH_REQUEST_SF_QUEUED_BIT, &rqst->state);
- + list_add_tail(&rqst->node, &rtl->queue.head);
- +
- + spin_unlock(&rtl->queue.lock);
- +
- + ssh_rtl_tx_schedule(rtl);
- + return 0;
- +}
- +
- +
- +static void ssh_rtl_timeout_reaper_mod(struct ssh_rtl *rtl, ktime_t now,
- + ktime_t expires)
- +{
- + unsigned long delta = msecs_to_jiffies(ktime_ms_delta(expires, now));
- + ktime_t aexp = ktime_add(expires, SSH_RTL_REQUEST_TIMEOUT_RESOLUTION);
- + ktime_t old;
- +
- + // re-adjust / schedule reaper if it is above resolution delta
- + old = READ_ONCE(rtl->rtx_timeout.expires);
- + while (ktime_before(aexp, old))
- + old = cmpxchg64(&rtl->rtx_timeout.expires, old, expires);
- +
- + // if we updated the reaper expiration, modify work timeout
- + if (old == expires)
- + mod_delayed_work(system_wq, &rtl->rtx_timeout.reaper, delta);
- +}
- +
- +static void ssh_rtl_timeout_start(struct ssh_request *rqst)
- +{
- + struct ssh_rtl *rtl = rqst->rtl;
- + ktime_t timestamp = ktime_get_coarse_boottime();
- + ktime_t timeout = rtl->rtx_timeout.timeout;
- +
- + if (test_bit(SSH_REQUEST_SF_LOCKED_BIT, &rqst->state))
- + return;
- +
- + WRITE_ONCE(rqst->timestamp, timestamp);
- + smp_mb__after_atomic();
- +
- + ssh_rtl_timeout_reaper_mod(rqst->rtl, timestamp, timestamp + timeout);
- +}
- +
- +
- +static void ssh_rtl_complete(struct ssh_rtl *rtl,
- + const struct ssh_command *command,
- + const struct sshp_span *command_data)
- +{
- + struct ssh_request *r = NULL;
- + struct ssh_request *p, *n;
- + u16 rqid = get_unaligned_le16(&command->rqid);
- +
- + trace_ssam_rx_response_received(command, command_data->len);
- +
- + /*
- + * Get request from pending based on request ID and mark it as response
- + * received and locked.
- + */
- + spin_lock(&rtl->pending.lock);
- + list_for_each_entry_safe(p, n, &rtl->pending.head, node) {
- + // we generally expect requests to be processed in order
- + if (unlikely(ssh_request_get_rqid(p) != rqid))
- + continue;
- +
- + // simulate response timeout
- + if (ssh_rtl_should_drop_response()) {
- + spin_unlock(&rtl->pending.lock);
- +
- + trace_ssam_ei_rx_drop_response(p);
- + rtl_info(rtl, "request error injection: "
- + "dropping response for request %p\n",
- + &p->packet);
- + return;
- + }
- +
- + /*
- + * Mark as "response received" and "locked" as we're going to
- + * complete it. Ensure that the state doesn't get zero by
- + * employing a memory barrier.
- + */
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &p->state);
- + set_bit(SSH_REQUEST_SF_RSPRCVD_BIT, &p->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_REQUEST_SF_PENDING_BIT, &p->state);
- +
- + atomic_dec(&rtl->pending.count);
- + list_del(&p->node);
- +
- + r = p;
- + break;
- + }
- + spin_unlock(&rtl->pending.lock);
- +
- + if (!r) {
- + rtl_warn(rtl, "rtl: dropping unexpected command message"
- + " (rqid = 0x%04x)\n", rqid);
- + return;
- + }
- +
- + // if the request hasn't been completed yet, we will do this now
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state)) {
- + ssh_request_put(r);
- + ssh_rtl_tx_schedule(rtl);
- + return;
- + }
- +
- + /*
- + * Make sure the request has been transmitted. In case of a sequenced
- + * request, we are guaranteed that the completion callback will run on
- + * the receiver thread directly when the ACK for the packet has been
- + * received. Similarly, this function is guaranteed to run on the
- + * receiver thread. Thus we are guaranteed that if the packet has been
- + * successfully transmitted and received an ACK, the transmitted flag
- + * has been set and is visible here.
- + *
- + * We are currently not handling unsequenced packets here, as those
- + * should never expect a response as ensured in ssh_rtl_submit. If this
- + * ever changes, one would have to test for
- + *
- + * (r->state & (transmitting | transmitted))
- + *
- + * on unsequenced packets to determine if they could have been
- + * transmitted. There are no synchronization guarantees as in the
- + * sequenced case, since, in this case, the callback function will not
- + * run on the same thread. Thus an exact determination is impossible.
- + */
- + if (!test_bit(SSH_REQUEST_SF_TRANSMITTED_BIT, &r->state)) {
- + rtl_err(rtl, "rtl: received response before ACK for request"
- + " (rqid = 0x%04x)\n", rqid);
- +
- + /*
- + * NB: Timeout has already been canceled, request already been
- + * removed from pending and marked as locked and completed. As
- + * we receive a "false" response, the packet might still be
- + * queued though.
- + */
- + ssh_rtl_queue_remove(r);
- +
- + ssh_rtl_complete_with_status(r, -EREMOTEIO);
- + ssh_request_put(r);
- +
- + ssh_rtl_tx_schedule(rtl);
- + return;
- + }
- +
- + /*
- + * NB: Timeout has already been canceled, request already been
- + * removed from pending and marked as locked and completed. The request
- + * can also not be queued any more, as it has been marked as
- + * transmitting and later transmitted. Thus no need to remove it from
- + * anywhere.
- + */
- +
- + ssh_rtl_complete_with_rsp(r, command, command_data);
- + ssh_request_put(r);
- +
- + ssh_rtl_tx_schedule(rtl);
- +}
- +
- +
- +static bool ssh_rtl_cancel_nonpending(struct ssh_request *r)
- +{
- + unsigned long state, fixed;
- + bool remove;
- +
- + /*
- + * Handle unsubmitted request: Try to mark the packet as locked,
- + * expecting the state to be zero (i.e. unsubmitted). Note that, if
- + * setting the state worked, we might still be adding the packet to the
- + * queue in a currently executing submit call. In that case, however,
- + * rqst->rtl must have been set previously, as locked is checked after
- + * setting rqst->rtl. Thus only if we successfully lock this request and
- + * rqst->rtl is NULL, we have successfully removed the request.
- + * Otherwise we need to try and grab it from the queue.
- + *
- + * Note that if the CMPXCHG fails, we are guaranteed that rqst->rtl has
- + * been set and is non-NULL, as states can only be nonzero after this
- + * has been set. Also note that we need to fetch the static (type) flags
- + * to ensure that they don't cause the cmpxchg to fail.
- + */
- + fixed = READ_ONCE(r->state) & SSH_REQUEST_FLAGS_TY_MASK;
- + state = cmpxchg(&r->state, fixed, SSH_REQUEST_SF_LOCKED_BIT);
- + if (!state && !READ_ONCE(r->rtl)) {
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + return true;
- +
- + ssh_rtl_complete_with_status(r, -ECANCELED);
- + return true;
- + }
- +
- + spin_lock(&r->rtl->queue.lock);
- +
- + /*
- + * Note: 1) Requests cannot be re-submitted. 2) If a request is queued,
- + * it cannot be "transmitting"/"pending" yet. Thus, if we successfully
- + * remove the the request here, we have removed all its occurences in
- + * the system.
- + */
- +
- + remove = test_and_clear_bit(SSH_REQUEST_SF_QUEUED_BIT, &r->state);
- + if (!remove) {
- + spin_unlock(&r->rtl->queue.lock);
- + return false;
- + }
- +
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state);
- + list_del(&r->node);
- +
- + spin_unlock(&r->rtl->queue.lock);
- +
- + ssh_request_put(r); // drop reference obtained from queue
- +
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + return true;
- +
- + ssh_rtl_complete_with_status(r, -ECANCELED);
- + return true;
- +}
- +
- +static bool ssh_rtl_cancel_pending(struct ssh_request *r)
- +{
- + // if the packet is already locked, it's going to be removed shortly
- + if (test_and_set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state))
- + return true;
- +
- + /*
- + * Now that we have locked the packet, we have guaranteed that it can't
- + * be added to the system any more. If rqst->rtl is zero, the locked
- + * check in ssh_rtl_submit has not been run and any submission,
- + * currently in progress or called later, won't add the packet. Thus we
- + * can directly complete it.
- + */
- + if (!READ_ONCE(r->rtl)) {
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + return true;
- +
- + ssh_rtl_complete_with_status(r, -ECANCELED);
- + return true;
- + }
- +
- + /*
- + * Try to cancel the packet. If the packet has not been completed yet,
- + * this will subsequently (and synchronously) call the completion
- + * callback of the packet, which will complete the request.
- + */
- + ssh_ptl_cancel(&r->packet);
- +
- + /*
- + * If the packet has been completed with success, i.e. has not been
- + * canceled by the above call, the request may not have been completed
- + * yet (may be waiting for a response). Check if we need to do this
- + * here.
- + */
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + return true;
- +
- + ssh_rtl_queue_remove(r);
- + ssh_rtl_pending_remove(r);
- + ssh_rtl_complete_with_status(r, -ECANCELED);
- +
- + return true;
- +}
- +
- +static bool ssh_rtl_cancel(struct ssh_request *rqst, bool pending)
- +{
- + struct ssh_rtl *rtl;
- + bool canceled;
- +
- + if (test_and_set_bit(SSH_REQUEST_SF_CANCELED_BIT, &rqst->state))
- + return true;
- +
- + trace_ssam_request_cancel(rqst);
- +
- + if (pending)
- + canceled = ssh_rtl_cancel_pending(rqst);
- + else
- + canceled = ssh_rtl_cancel_nonpending(rqst);
- +
- + // note: rqst->rtl may be NULL if request has not been submitted yet
- + rtl = READ_ONCE(rqst->rtl);
- + if (canceled && rtl)
- + ssh_rtl_tx_schedule(rtl);
- +
- + return canceled;
- +}
- +
- +
- +static void ssh_rtl_packet_callback(struct ssh_packet *p, int status)
- +{
- + struct ssh_request *r = to_ssh_request(p, packet);
- +
- + if (unlikely(status)) {
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state);
- +
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + return;
- +
- + /*
- + * The packet may get cancelled even though it has not been
- + * submitted yet. The request may still be queued. Check the
- + * queue and remove it if necessary. As the timeout would have
- + * been started in this function on success, there's no need to
- + * cancel it here.
- + */
- + ssh_rtl_queue_remove(r);
- + ssh_rtl_pending_remove(r);
- + ssh_rtl_complete_with_status(r, status);
- +
- + ssh_rtl_tx_schedule(r->rtl);
- + return;
- + }
- +
- + /*
- + * Mark as transmitted, ensure that state doesn't get zero by inserting
- + * a memory barrier.
- + */
- + set_bit(SSH_REQUEST_SF_TRANSMITTED_BIT, &r->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_REQUEST_SF_TRANSMITTING_BIT, &r->state);
- +
- + // if we expect a response, we just need to start the timeout
- + if (test_bit(SSH_REQUEST_TY_HAS_RESPONSE_BIT, &r->state)) {
- + ssh_rtl_timeout_start(r);
- + return;
- + }
- +
- + /*
- + * If we don't expect a response, lock, remove, and complete the
- + * request. Note that, at this point, the request is guaranteed to have
- + * left the queue and no timeout has been started. Thus we only need to
- + * remove it from pending. If the request has already been completed (it
- + * may have been canceled) return.
- + */
- +
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state);
- + if (test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + return;
- +
- + ssh_rtl_pending_remove(r);
- + ssh_rtl_complete_with_status(r, 0);
- +
- + ssh_rtl_tx_schedule(r->rtl);
- +}
- +
- +
- +static ktime_t ssh_request_get_expiration(struct ssh_request *r, ktime_t timeo)
- +{
- + ktime_t timestamp = READ_ONCE(r->timestamp);
- +
- + if (timestamp != KTIME_MAX)
- + return ktime_add(timestamp, timeo);
- + else
- + return KTIME_MAX;
- +}
- +
- +static void ssh_rtl_timeout_reap(struct work_struct *work)
- +{
- + struct ssh_rtl *rtl = to_ssh_rtl(work, rtx_timeout.reaper.work);
- + struct ssh_request *r, *n;
- + LIST_HEAD(claimed);
- + ktime_t now = ktime_get_coarse_boottime();
- + ktime_t timeout = rtl->rtx_timeout.timeout;
- + ktime_t next = KTIME_MAX;
- +
- + trace_ssam_rtl_timeout_reap("pending", atomic_read(&rtl->pending.count));
- +
- + /*
- + * Mark reaper as "not pending". This is done before checking any
- + * requests to avoid lost-update type problems.
- + */
- + WRITE_ONCE(rtl->rtx_timeout.expires, KTIME_MAX);
- + smp_mb__after_atomic();
- +
- + spin_lock(&rtl->pending.lock);
- + list_for_each_entry_safe(r, n, &rtl->pending.head, node) {
- + ktime_t expires = ssh_request_get_expiration(r, timeout);
- +
- + /*
- + * Check if the timeout hasn't expired yet. Find out next
- + * expiration date to be handled after this run.
- + */
- + if (ktime_after(expires, now)) {
- + next = ktime_before(expires, next) ? expires : next;
- + continue;
- + }
- +
- + // avoid further transitions if locked
- + if (test_and_set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state))
- + continue;
- +
- + /*
- + * We have now marked the packet as locked. Thus it cannot be
- + * added to the pending or queued lists again after we've
- + * removed it here. We can therefore re-use the node of this
- + * packet temporarily.
- + */
- +
- + clear_bit(SSH_REQUEST_SF_PENDING_BIT, &r->state);
- +
- + atomic_dec(&rtl->pending.count);
- + list_del(&r->node);
- +
- + list_add_tail(&r->node, &claimed);
- + }
- + spin_unlock(&rtl->pending.lock);
- +
- + // cancel and complete the request
- + list_for_each_entry_safe(r, n, &claimed, node) {
- + trace_ssam_request_timeout(r);
- +
- + /*
- + * At this point we've removed the packet from pending. This
- + * means that we've obtained the last (only) reference of the
- + * system to it. Thus we can just complete it.
- + */
- + if (!test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + ssh_rtl_complete_with_status(r, -ETIMEDOUT);
- +
- + // drop the reference we've obtained by removing it from pending
- + list_del(&r->node);
- + ssh_request_put(r);
- + }
- +
- + // ensure that reaper doesn't run again immediately
- + next = max(next, ktime_add(now, SSH_RTL_REQUEST_TIMEOUT_RESOLUTION));
- + if (next != KTIME_MAX)
- + ssh_rtl_timeout_reaper_mod(rtl, now, next);
- +
- + ssh_rtl_tx_schedule(rtl);
- +}
- +
- +
- +static void ssh_rtl_rx_event(struct ssh_rtl *rtl, const struct ssh_command *cmd,
- + const struct sshp_span *data)
- +{
- + trace_ssam_rx_event_received(cmd, data->len);
- +
- + rtl_dbg(rtl, "rtl: handling event (rqid: 0x%04x)\n",
- + get_unaligned_le16(&cmd->rqid));
- +
- + rtl->ops.handle_event(rtl, cmd, data);
- +}
- +
- +static void ssh_rtl_rx_command(struct ssh_ptl *p, const struct sshp_span *data)
- +{
- + struct ssh_rtl *rtl = to_ssh_rtl(p, ptl);
- + struct device *dev = &p->serdev->dev;
- + struct ssh_command *command;
- + struct sshp_span command_data;
- +
- + if (sshp_parse_command(dev, data, &command, &command_data))
- + return;
- +
- + if (ssh_rqid_is_event(get_unaligned_le16(&command->rqid)))
- + ssh_rtl_rx_event(rtl, command, &command_data);
- + else
- + ssh_rtl_complete(rtl, command, &command_data);
- +}
- +
- +static void ssh_rtl_rx_data(struct ssh_ptl *p, const struct sshp_span *data)
- +{
- + switch (data->ptr[0]) {
- + case SSH_PLD_TYPE_CMD:
- + ssh_rtl_rx_command(p, data);
- + break;
- +
- + default:
- + ptl_err(p, "rtl: rx: unknown frame payload type"
- + " (type: 0x%02x)\n", data->ptr[0]);
- + break;
- + }
- +}
- +
- +
- +static inline struct device *ssh_rtl_get_device(struct ssh_rtl *rtl)
- +{
- + return ssh_ptl_get_device(&rtl->ptl);
- +}
- +
- +static inline bool ssh_rtl_tx_flush(struct ssh_rtl *rtl)
- +{
- + return flush_work(&rtl->tx.work);
- +}
- +
- +static inline int ssh_rtl_tx_start(struct ssh_rtl *rtl)
- +{
- + int status;
- + bool sched;
- +
- + status = ssh_ptl_tx_start(&rtl->ptl);
- + if (status)
- + return status;
- +
- + /*
- + * If the packet layer has been shut down and restarted without shutting
- + * down the request layer, there may still be requests queued and not
- + * handled.
- + */
- + spin_lock(&rtl->queue.lock);
- + sched = !list_empty(&rtl->queue.head);
- + spin_unlock(&rtl->queue.lock);
- +
- + if (sched)
- + ssh_rtl_tx_schedule(rtl);
- +
- + return 0;
- +}
- +
- +static inline int ssh_rtl_rx_start(struct ssh_rtl *rtl)
- +{
- + return ssh_ptl_rx_start(&rtl->ptl);
- +}
- +
- +static int ssh_rtl_init(struct ssh_rtl *rtl, struct serdev_device *serdev,
- + struct ssh_rtl_ops *ops)
- +{
- + struct ssh_ptl_ops ptl_ops;
- + int status;
- +
- + ptl_ops.data_received = ssh_rtl_rx_data;
- +
- + status = ssh_ptl_init(&rtl->ptl, serdev, &ptl_ops);
- + if (status)
- + return status;
- +
- + spin_lock_init(&rtl->queue.lock);
- + INIT_LIST_HEAD(&rtl->queue.head);
- +
- + spin_lock_init(&rtl->pending.lock);
- + INIT_LIST_HEAD(&rtl->pending.head);
- + atomic_set_release(&rtl->pending.count, 0);
- +
- + INIT_WORK(&rtl->tx.work, ssh_rtl_tx_work_fn);
- +
- + rtl->rtx_timeout.timeout = SSH_RTL_REQUEST_TIMEOUT;
- + rtl->rtx_timeout.expires = KTIME_MAX;
- + INIT_DELAYED_WORK(&rtl->rtx_timeout.reaper, ssh_rtl_timeout_reap);
- +
- + rtl->ops = *ops;
- +
- + return 0;
- +}
- +
- +static void ssh_rtl_destroy(struct ssh_rtl *rtl)
- +{
- + ssh_ptl_destroy(&rtl->ptl);
- +}
- +
- +
- +static void ssh_rtl_packet_release(struct ssh_packet *p)
- +{
- + struct ssh_request *rqst = to_ssh_request(p, packet);
- + rqst->ops->release(rqst);
- +}
- +
- +static const struct ssh_packet_ops ssh_rtl_packet_ops = {
- + .complete = ssh_rtl_packet_callback,
- + .release = ssh_rtl_packet_release,
- +};
- +
- +static void ssh_request_init(struct ssh_request *rqst,
- + enum ssam_request_flags flags,
- + const struct ssh_request_ops *ops)
- +{
- + struct ssh_packet_args packet_args;
- +
- + packet_args.type = SSH_PACKET_TY_BLOCKING;
- + if (!(flags & SSAM_REQUEST_UNSEQUENCED))
- + packet_args.type |= SSH_PACKET_TY_SEQUENCED;
- +
- + packet_args.priority = SSH_PACKET_PRIORITY(DATA, 0);
- + packet_args.ops = &ssh_rtl_packet_ops;
- +
- + ssh_packet_init(&rqst->packet, &packet_args);
- +
- + rqst->rtl = NULL;
- + INIT_LIST_HEAD(&rqst->node);
- +
- + rqst->state = 0;
- + if (flags & SSAM_REQUEST_HAS_RESPONSE)
- + rqst->state |= BIT(SSH_REQUEST_TY_HAS_RESPONSE_BIT);
- +
- + rqst->timestamp = KTIME_MAX;
- + rqst->ops = ops;
- +}
- +
- +
- +struct ssh_flush_request {
- + struct ssh_request base;
- + struct completion completion;
- + int status;
- +};
- +
- +static void ssh_rtl_flush_request_complete(struct ssh_request *r,
- + const struct ssh_command *cmd,
- + const struct sshp_span *data,
- + int status)
- +{
- + struct ssh_flush_request *rqst;
- +
- + rqst = container_of(r, struct ssh_flush_request, base);
- + rqst->status = status;
- +}
- +
- +static void ssh_rtl_flush_request_release(struct ssh_request *r)
- +{
- + struct ssh_flush_request *rqst;
- +
- + rqst = container_of(r, struct ssh_flush_request, base);
- + complete_all(&rqst->completion);
- +}
- +
- +static const struct ssh_request_ops ssh_rtl_flush_request_ops = {
- + .complete = ssh_rtl_flush_request_complete,
- + .release = ssh_rtl_flush_request_release,
- +};
- +
- +/**
- + * ssh_rtl_flush - flush the request transmission layer
- + * @rtl: request transmission layer
- + * @timeout: timeout for the flush operation in jiffies
- + *
- + * Queue a special flush request and wait for its completion. This request
- + * will be completed after all other currently queued and pending requests
- + * have been completed. Instead of a normal data packet, this request submits
- + * a special flush packet, meaning that upon completion, also the underlying
- + * packet transmission layer has been flushed.
- + *
- + * Flushing the request layer gurarantees that all previously submitted
- + * requests have been fully completed before this call returns. Additinally,
- + * flushing blocks execution of all later submitted requests until the flush
- + * has been completed.
- + *
- + * If the caller ensures that no new requests are submitted after a call to
- + * this function, the request transmission layer is guaranteed to have no
- + * remaining requests when this call returns. The same guarantee does not hold
- + * for the packet layer, on which control packets may still be queued after
- + * this call. See the documentation of ssh_ptl_flush for more details on
- + * packet layer flushing.
- + *
- + * Return: Zero on success, -ETIMEDOUT if the flush timed out and has been
- + * canceled as a result of the timeout, or -ESHUTDOWN if the packet and/or
- + * request transmission layer has been shut down before this call. May also
- + * return -EINTR if the underlying packet transmission has been interrupted.
- + */
- +static int ssh_rtl_flush(struct ssh_rtl *rtl, unsigned long timeout)
- +{
- + const unsigned init_flags = SSAM_REQUEST_UNSEQUENCED;
- + struct ssh_flush_request rqst;
- + int status;
- +
- + ssh_request_init(&rqst.base, init_flags, &ssh_rtl_flush_request_ops);
- + rqst.base.packet.type |= SSH_PACKET_TY_FLUSH;
- + rqst.base.packet.priority = SSH_PACKET_PRIORITY(FLUSH, 0);
- + rqst.base.state |= BIT(SSH_REQUEST_TY_FLUSH_BIT);
- +
- + init_completion(&rqst.completion);
- +
- + status = ssh_rtl_submit(rtl, &rqst.base);
- + if (status)
- + return status;
- +
- + ssh_request_put(&rqst.base);
- +
- + if (wait_for_completion_timeout(&rqst.completion, timeout))
- + return 0;
- +
- + ssh_rtl_cancel(&rqst.base, true);
- + wait_for_completion(&rqst.completion);
- +
- + WARN_ON(rqst.status != 0 && rqst.status != -ECANCELED
- + && rqst.status != -ESHUTDOWN && rqst.status != -EINTR);
- +
- + return rqst.status == -ECANCELED ? -ETIMEDOUT : status;
- +}
- +
- +
- +static void ssh_rtl_shutdown(struct ssh_rtl *rtl)
- +{
- + struct ssh_request *r, *n;
- + LIST_HEAD(claimed);
- + int pending;
- +
- + set_bit(SSH_RTL_SF_SHUTDOWN_BIT, &rtl->state);
- + smp_mb__after_atomic();
- +
- + // remove requests from queue
- + spin_lock(&rtl->queue.lock);
- + list_for_each_entry_safe(r, n, &rtl->queue.head, node) {
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_REQUEST_SF_QUEUED_BIT, &r->state);
- +
- + list_del(&r->node);
- + list_add_tail(&r->node, &claimed);
- + }
- + spin_unlock(&rtl->queue.lock);
- +
- + /*
- + * We have now guaranteed that the queue is empty and no more new
- + * requests can be submitted (i.e. it will stay empty). This means that
- + * calling ssh_rtl_tx_schedule will not schedule tx.work any more. So we
- + * can simply call cancel_work_sync on tx.work here and when that
- + * returns, we've locked it down. This also means that after this call,
- + * we don't submit any more packets to the underlying packet layer, so
- + * we can also shut that down.
- + */
- +
- + cancel_work_sync(&rtl->tx.work);
- + ssh_ptl_shutdown(&rtl->ptl);
- + cancel_delayed_work_sync(&rtl->rtx_timeout.reaper);
- +
- + /*
- + * Shutting down the packet layer should also have caneled all requests.
- + * Thus the pending set should be empty. Attempt to handle this
- + * gracefully anyways, even though this should be dead code.
- + */
- +
- + pending = atomic_read(&rtl->pending.count);
- + WARN_ON(pending);
- +
- + if (pending) {
- + spin_lock(&rtl->pending.lock);
- + list_for_each_entry_safe(r, n, &rtl->pending.head, node) {
- + set_bit(SSH_REQUEST_SF_LOCKED_BIT, &r->state);
- + smp_mb__before_atomic();
- + clear_bit(SSH_REQUEST_SF_PENDING_BIT, &r->state);
- +
- + list_del(&r->node);
- + list_add_tail(&r->node, &claimed);
- + }
- + spin_unlock(&rtl->pending.lock);
- + }
- +
- + // finally cancel and complete requests
- + list_for_each_entry_safe(r, n, &claimed, node) {
- + // test_and_set because we still might compete with cancellation
- + if (!test_and_set_bit(SSH_REQUEST_SF_COMPLETED_BIT, &r->state))
- + ssh_rtl_complete_with_status(r, -ESHUTDOWN);
- +
- + // drop the reference we've obtained by removing it from list
- + list_del(&r->node);
- + ssh_request_put(r);
- + }
- +}
- +
- +
- +/* -- Event notifier/callbacks. --------------------------------------------- */
- +/*
- + * The notifier system is based on linux/notifier.h, specifically the SRCU
- + * implementation. The difference to that is, that some bits of the notifier
- + * call return value can be tracked accross multiple calls. This is done so that
- + * handling of events can be tracked and a warning can be issued in case an
- + * event goes unhandled. The idea of that waring is that it should help discover
- + * and identify new/currently unimplemented features.
- + */
- +
- +struct ssam_nf_head {
- + struct srcu_struct srcu;
- + struct ssam_notifier_block __rcu *head;
- +};
- +
- +
- +int ssam_nfblk_call_chain(struct ssam_nf_head *nh, struct ssam_event *event)
- +{
- + struct ssam_notifier_block *nb, *next_nb;
- + int ret = 0, idx;
- +
- + idx = srcu_read_lock(&nh->srcu);
- +
- + nb = rcu_dereference_raw(nh->head);
- + while (nb) {
- + next_nb = rcu_dereference_raw(nb->next);
- +
- + ret = (ret & SSAM_NOTIF_STATE_MASK) | nb->fn(nb, event);
- + if (ret & SSAM_NOTIF_STOP)
- + break;
- +
- + nb = next_nb;
- + }
- +
- + srcu_read_unlock(&nh->srcu, idx);
- + return ret;
- +}
- +
- +/*
- + * Note: This function must be synchronized by the caller with respect to other
- + * insert and/or remove calls.
- + */
- +int __ssam_nfblk_insert(struct ssam_nf_head *nh, struct ssam_notifier_block *nb)
- +{
- + struct ssam_notifier_block **link = &nh->head;
- +
- + while ((*link) != NULL) {
- + if (unlikely((*link) == nb)) {
- + WARN(1, "double register detected");
- + return -EINVAL;
- + }
- +
- + if (nb->priority > (*link)->priority)
- + break;
- +
- + link = &((*link)->next);
- + }
- +
- + nb->next = *link;
- + rcu_assign_pointer(*link, nb);
- +
- + return 0;
- +}
- +
- +/*
- + * Note: This function must be synchronized by the caller with respect to other
- + * insert and/or remove calls. On success, the caller _must_ ensure SRCU
- + * synchronization by calling `synchronize_srcu(&nh->srcu)` after leaving the
- + * critical section, to ensure that the removed notifier block is not in use any
- + * more.
- + */
- +int __ssam_nfblk_remove(struct ssam_nf_head *nh, struct ssam_notifier_block *nb)
- +{
- + struct ssam_notifier_block **link = &nh->head;
- +
- + while ((*link) != NULL) {
- + if ((*link) == nb) {
- + rcu_assign_pointer(*link, nb->next);
- + return 0;
- + }
- +
- + link = &((*link)->next);
- + }
- +
- + return -ENOENT;
- +}
- +
- +static int ssam_nf_head_init(struct ssam_nf_head *nh)
- +{
- + int status;
- +
- + status = init_srcu_struct(&nh->srcu);
- + if (status)
- + return status;
- +
- + nh->head = NULL;
- + return 0;
- +}
- +
- +static void ssam_nf_head_destroy(struct ssam_nf_head *nh)
- +{
- + cleanup_srcu_struct(&nh->srcu);
- +}
- +
- +
- +/* -- Event/notification registry. ------------------------------------------ */
- +
- +struct ssam_nf_refcount_key {
- + struct ssam_event_registry reg;
- + struct ssam_event_id id;
- +};
- +
- +struct ssam_nf_refcount_entry {
- + struct rb_node node;
- + struct ssam_nf_refcount_key key;
- + int refcount;
- +};
- +
- +struct ssam_nf {
- + struct mutex lock;
- + struct rb_root refcount;
- + struct ssam_nf_head head[SURFACE_SAM_SSH_NUM_EVENTS];
- +};
- +
- +
- +static int ssam_nf_refcount_inc(struct ssam_nf *nf,
- + struct ssam_event_registry reg,
- + struct ssam_event_id id)
- +{
- + struct ssam_nf_refcount_entry *entry;
- + struct ssam_nf_refcount_key key;
- + struct rb_node **link = &nf->refcount.rb_node;
- + struct rb_node *parent;
- + int cmp;
- +
- + key.reg = reg;
- + key.id = id;
- +
- + while (*link) {
- + entry = rb_entry(*link, struct ssam_nf_refcount_entry, node);
- + parent = *link;
- +
- + cmp = memcmp(&key, &entry->key, sizeof(key));
- + if (cmp < 0) {
- + link = &(*link)->rb_left;
- + } else if (cmp > 0) {
- + link = &(*link)->rb_right;
- + } else if (entry->refcount < INT_MAX) {
- + return ++entry->refcount;
- + } else {
- + return -ENOSPC;
- + }
- + }
- +
- + entry = kzalloc(sizeof(*entry), GFP_KERNEL);
- + if (!entry)
- + return -ENOMEM;
- +
- + entry->key = key;
- + entry->refcount = 1;
- +
- + rb_link_node(&entry->node, parent, link);
- + rb_insert_color(&entry->node, &nf->refcount);
- +
- + return entry->refcount;
- +}
- +
- +static int ssam_nf_refcount_dec(struct ssam_nf *nf,
- + struct ssam_event_registry reg,
- + struct ssam_event_id id)
- +{
- + struct ssam_nf_refcount_entry *entry;
- + struct ssam_nf_refcount_key key;
- + struct rb_node *node = nf->refcount.rb_node;
- + int cmp, rc;
- +
- + key.reg = reg;
- + key.id = id;
- +
- + while (node) {
- + entry = rb_entry(node, struct ssam_nf_refcount_entry, node);
- +
- + cmp = memcmp(&key, &entry->key, sizeof(key));
- + if (cmp < 0) {
- + node = node->rb_left;
- + } else if (cmp > 0) {
- + node = node->rb_right;
- + } else {
- + rc = --entry->refcount;
- +
- + if (rc == 0) {
- + rb_erase(&entry->node, &nf->refcount);
- + kfree(entry);
- + }
- +
- + return rc;
- + }
- + }
- +
- + return -ENOENT;
- +}
- +
- +static void ssam_nf_call(struct ssam_nf *nf, struct device *dev, u16 rqid,
- + struct ssam_event *event)
- +{
- + struct ssam_nf_head *nf_head;
- + int status, nf_ret;
- +
- + if (!ssh_rqid_is_event(rqid)) {
- + dev_warn(dev, "event: unsupported rqid: 0x%04x\n", rqid);
- + return;
- + }
- +
- + nf_head = &nf->head[ssh_rqid_to_event(rqid)];
- + nf_ret = ssam_nfblk_call_chain(nf_head, event);
- + status = ssam_notifier_to_errno(nf_ret);
- +
- + if (status < 0) {
- + dev_err(dev, "event: error handling event: %d "
- + "(tc: 0x%02x, cid: 0x%02x, iid: 0x%02x, chn: 0x%02x)\n",
- + status, event->target_category, event->command_id,
- + event->instance_id, event->channel);
- + }
- +
- + if (!(nf_ret & SSAM_NOTIF_HANDLED)) {
- + dev_warn(dev, "event: unhandled event (rqid: 0x%02x, "
- + "tc: 0x%02x, cid: 0x%02x, iid: 0x%02x, chn: 0x%02x)\n",
- + rqid, event->target_category, event->command_id,
- + event->instance_id, event->channel);
- + }
- +}
- +
- +static int ssam_nf_register(struct ssam_nf *nf, struct ssam_event_notifier *n)
- +{
- + u16 rqid = ssh_tc_to_rqid(n->event.id.target_category);
- + struct ssam_nf_head *nf_head;
- + int rc, status;
- +
- + if (!ssh_rqid_is_event(rqid))
- + return -EINVAL;
- +
- + nf_head = &nf->head[ssh_rqid_to_event(rqid)];
- +
- + mutex_lock(&nf->lock);
- +
- + rc = ssam_nf_refcount_inc(nf, n->event.reg, n->event.id);
- + if (rc < 0) {
- + mutex_lock(&nf->lock);
- + return rc;
- + }
- +
- + status = __ssam_nfblk_insert(nf_head, &n->base);
- + if (status)
- + ssam_nf_refcount_dec(nf, n->event.reg, n->event.id);
- +
- + mutex_unlock(&nf->lock);
- + return status;
- +}
- +
- +static int ssam_nf_unregister(struct ssam_nf *nf, struct ssam_event_notifier *n)
- +{
- + u16 rqid = ssh_tc_to_rqid(n->event.id.target_category);
- + struct ssam_nf_head *nf_head;
- + int status;
- +
- + if (!ssh_rqid_is_event(rqid))
- + return -EINVAL;
- +
- + nf_head = &nf->head[ssh_rqid_to_event(rqid)];
- +
- + mutex_lock(&nf->lock);
- +
- + status = __ssam_nfblk_remove(nf_head, &n->base);
- + if (status) {
- + mutex_unlock(&nf->lock);
- + return status;
- + }
- +
- + ssam_nf_refcount_dec(nf, n->event.reg, n->event.id);
- +
- + mutex_unlock(&nf->lock);
- + synchronize_srcu(&nf_head->srcu);
- +
- + return 0;
- +}
- +
- +static int ssam_nf_init(struct ssam_nf *nf)
- +{
- + int i, status;
- +
- + for (i = 0; i < SURFACE_SAM_SSH_NUM_EVENTS; i++) {
- + status = ssam_nf_head_init(&nf->head[i]);
- + if (status)
- + break;
- + }
- +
- + if (status) {
- + for (i = i - 1; i >= 0; i--)
- + ssam_nf_head_destroy(&nf->head[i]);
- +
- + return status;
- + }
- +
- + mutex_init(&nf->lock);
- + return 0;
- +}
- +
- +static void ssam_nf_destroy(struct ssam_nf *nf)
- +{
- + int i;
- +
- + for (i = 0; i < SURFACE_SAM_SSH_NUM_EVENTS; i++)
- + ssam_nf_head_destroy(&nf->head[i]);
- +
- + mutex_destroy(&nf->lock);
- +}
- +
- +
- +/* -- Event/async request completion system. -------------------------------- */
- +
- +#define SSAM_CPLT_WQ_NAME "ssam_cpltq"
- +
- +
- +struct ssam_cplt;
- +
- +struct ssam_event_item {
- + struct list_head node;
- + u16 rqid;
- + struct ssam_event event; // must be last
- +};
- +
- +struct ssam_event_queue {
- + struct ssam_cplt *cplt;
- +
- + spinlock_t lock;
- + struct list_head head;
- + struct work_struct work;
- +};
- +
- +struct ssam_event_channel {
- + struct ssam_event_queue queue[SURFACE_SAM_SSH_NUM_EVENTS];
- +};
- +
- +struct ssam_cplt {
- + struct device *dev;
- + struct workqueue_struct *wq;
- +
- + struct {
- + struct ssam_event_channel channel[SURFACE_SAM_SSH_NUM_CHANNELS];
- + struct ssam_nf notif;
- + } event;
- +};
- +
- +
- +static void ssam_event_queue_push(struct ssam_event_queue *q,
- + struct ssam_event_item *item)
- +{
- + spin_lock(&q->lock);
- + list_add_tail(&item->node, &q->head);
- + spin_unlock(&q->lock);
- +}
- +
- +static struct ssam_event_item *ssam_event_queue_pop(struct ssam_event_queue *q)
- +{
- + struct ssam_event_item *item;
- +
- + spin_lock(&q->lock);
- + item = list_first_entry_or_null(&q->head, struct ssam_event_item, node);
- + if (item)
- + list_del(&item->node);
- + spin_unlock(&q->lock);
- +
- + return item;
- +}
- +
- +static bool ssam_event_queue_is_empty(struct ssam_event_queue *q)
- +{
- + bool empty;
- +
- + spin_lock(&q->lock);
- + empty = list_empty(&q->head);
- + spin_unlock(&q->lock);
- +
- + return empty;
- +}
- +
- +static struct ssam_event_queue *ssam_cplt_get_event_queue(
- + struct ssam_cplt *cplt, u8 channel, u16 rqid)
- +{
- + u16 event = ssh_rqid_to_event(rqid);
- + u16 chidx = ssh_channel_to_index(channel);
- +
- + if (!ssh_rqid_is_event(rqid)) {
- + dev_err(cplt->dev, "event: unsupported rqid: 0x%04x\n", rqid);
- + return NULL;
- + }
- +
- + if (!ssh_channel_is_valid(channel)) {
- + dev_warn(cplt->dev, "event: unsupported channel: %u\n",
- + channel);
- + chidx = 0;
- + }
- +
- + return &cplt->event.channel[chidx].queue[event];
- +}
- +
- +static inline bool ssam_cplt_submit(struct ssam_cplt *cplt,
- + struct work_struct *work)
- +{
- + return queue_work(cplt->wq, work);
- +}
- +
- +static int ssam_cplt_submit_event(struct ssam_cplt *cplt,
- + struct ssam_event_item *item)
- +{
- + struct ssam_event_queue *evq;
- +
- + evq = ssam_cplt_get_event_queue(cplt, item->event.channel, item->rqid);
- + if (!evq)
- + return -EINVAL;
- +
- + ssam_event_queue_push(evq, item);
- + ssam_cplt_submit(cplt, &evq->work);
- + return 0;
- +}
- +
- +static void ssam_cplt_flush(struct ssam_cplt *cplt)
- +{
- + flush_workqueue(cplt->wq);
- +}
- +
- +static void ssam_event_queue_work_fn(struct work_struct *work)
- +{
- + struct ssam_event_queue *queue;
- + struct ssam_event_item *item;
- + struct ssam_nf *nf;
- + struct device *dev;
- + int i;
- +
- + queue = container_of(work, struct ssam_event_queue, work);
- + nf = &queue->cplt->event.notif;
- + dev = queue->cplt->dev;
- +
- + for (i = 0; i < 10; i++) {
- + item = ssam_event_queue_pop(queue);
- + if (item == NULL)
- + return;
- +
- + ssam_nf_call(nf, dev, item->rqid, &item->event);
- + kfree(item);
- + }
- +
- + if (!ssam_event_queue_is_empty(queue))
- + ssam_cplt_submit(queue->cplt, &queue->work);
- +}
- +
- +static void ssam_event_queue_init(struct ssam_cplt *cplt,
- + struct ssam_event_queue *evq)
- +{
- + evq->cplt = cplt;
- + spin_lock_init(&evq->lock);
- + INIT_LIST_HEAD(&evq->head);
- + INIT_WORK(&evq->work, ssam_event_queue_work_fn);
- +}
- +
- +static int ssam_cplt_init(struct ssam_cplt *cplt, struct device *dev)
- +{
- + struct ssam_event_channel *channel;
- + int status, c, i;
- +
- + cplt->dev = dev;
- +
- + cplt->wq = create_workqueue(SSAM_CPLT_WQ_NAME);
- + if (!cplt->wq)
- + return -ENOMEM;
- +
- + for (c = 0; c < ARRAY_SIZE(cplt->event.channel); c++) {
- + channel = &cplt->event.channel[c];
- +
- + for (i = 0; i < ARRAY_SIZE(channel->queue); i++)
- + ssam_event_queue_init(cplt, &channel->queue[i]);
- + }
- +
- + status = ssam_nf_init(&cplt->event.notif);
- + if (status)
- + destroy_workqueue(cplt->wq);
- +
- + return status;
- +}
- +
- +static void ssam_cplt_destroy(struct ssam_cplt *cplt)
- +{
- + destroy_workqueue(cplt->wq);
- + ssam_nf_destroy(&cplt->event.notif);
- +}
- +
- +
- +/* -- Top-Level Request Interface ------------------------------------------- */
- +
- +struct ssam_response {
- + int status;
- + u16 capacity;
- + u16 length;
- + u8 *pointer;
- +};
- +
- +struct ssam_request_sync {
- + struct ssh_request base;
- + struct completion comp;
- + struct ssam_response resp;
- +};
- +
- +
- +static void ssam_request_sync_complete(struct ssh_request *rqst,
- + const struct ssh_command *cmd,
- + const struct sshp_span *data, int status)
- +{
- + struct ssam_request_sync *r;
- + struct ssh_rtl *rtl = READ_ONCE(rqst->rtl);
- +
- + r = container_of(rqst, struct ssam_request_sync, base);
- + r->resp.status = status;
- + r->resp.length = 0;
- +
- + if (status) {
- + rtl_dbg_cond(rtl, "rsp: request failed: %d\n", status);
- + return;
- + }
- +
- + if (!data) // handle requests without a response
- + return;
- +
- + if (!r->resp.pointer && data->len) {
- + rtl_warn(rtl, "rsp: no response buffer provided, dropping data\n");
- + return;
- + }
- +
- + if (data->len > r->resp.capacity) {
- + rtl_err(rtl, "rsp: response buffer too small,"
- + " capacity: %u bytes, got: %zu bytes\n",
- + r->resp.capacity, data->len);
- + r->resp.status = -ENOSPC;
- + return;
- + }
- +
- + r->resp.length = data->len;
- + memcpy(r->resp.pointer, data->ptr, data->len);
- +}
- +
- +static void ssam_request_sync_release(struct ssh_request *rqst)
- +{
- + complete_all(&container_of(rqst, struct ssam_request_sync, base)->comp);
- +}
- +
- +static const struct ssh_request_ops ssam_request_sync_ops = {
- + .release = ssam_request_sync_release,
- + .complete = ssam_request_sync_complete,
- +};
- +
- +static void ssam_request_sync_wait_complete(struct ssam_request_sync *rqst)
- +{
- + wait_for_completion(&rqst->comp);
- +}
- +
- +
- +/* -- TODO ------------------------------------------------------------------ */
- +
- +enum ssh_ec_state {
- + SSH_EC_UNINITIALIZED,
- + SSH_EC_INITIALIZED,
- + SSH_EC_SUSPENDED,
- +};
- +
- +struct sam_ssh_ec {
- + struct serdev_device *serdev;
- +
- + struct ssh_rtl rtl;
- + struct ssam_cplt cplt;
- +
- + struct {
- + struct ssh_seq_counter seq;
- + struct ssh_rqid_counter rqid;
- + } counter;
- +
- + enum ssh_ec_state state;
- +
- + int irq;
- + bool irq_wakeup_enabled;
- +};
- +
- +static struct sam_ssh_ec ssh_ec = {
- + .state = SSH_EC_UNINITIALIZED,
- + .serdev = NULL,
- +};
- +
- +
- +/* -- TODO ------------------------------------------------------------------ */
- +
- +#define ssh_dbg(ec, fmt, ...) dev_dbg(&(ec)->serdev->dev, fmt, ##__VA_ARGS__)
- +#define ssh_warn(ec, fmt, ...) dev_warn(&(ec)->serdev->dev, fmt, ##__VA_ARGS__)
- +#define ssh_err(ec, fmt, ...) dev_err(&(ec)->serdev->dev, fmt, ##__VA_ARGS__)
- +
- +
- +static inline struct sam_ssh_ec *surface_sam_ssh_acquire(void)
- +{
- + return &ssh_ec;
- +}
- +
- +static inline struct sam_ssh_ec *surface_sam_ssh_acquire_init(void)
- +{
- + struct sam_ssh_ec *ec = surface_sam_ssh_acquire();
- +
- + if (smp_load_acquire(&ec->state) == SSH_EC_UNINITIALIZED)
- + return NULL;
- +
- + return ec;
- +}
- +
- +int surface_sam_ssh_consumer_register(struct device *consumer)
- +{
- + u32 flags = DL_FLAG_PM_RUNTIME | DL_FLAG_AUTOREMOVE_CONSUMER;
- + struct sam_ssh_ec *ec;
- + struct device_link *link;
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (!ec)
- + return -ENXIO;
- +
- + link = device_link_add(consumer, &ec->serdev->dev, flags);
- + if (!link)
- + return -EFAULT;
- +
- + return 0;
- +}
- +EXPORT_SYMBOL_GPL(surface_sam_ssh_consumer_register);
- +
- +
- +static int __surface_sam_ssh_rqst(struct sam_ssh_ec *ec,
- + const struct surface_sam_ssh_rqst *rqst,
- + struct surface_sam_ssh_buf *result);
- +
- +static int surface_sam_ssh_event_enable(struct sam_ssh_ec *ec,
- + struct ssam_event_registry reg,
- + struct ssam_event_id id,
- + u8 flags)
- +{
- + struct ssh_notification_params params;
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + u16 rqid = ssh_tc_to_rqid(id.target_category);
- + u8 buf[1] = { 0x00 };
- + int status;
- +
- + // only allow RQIDs that lie within event spectrum
- + if (!ssh_rqid_is_event(rqid))
- + return -EINVAL;
- +
- + params.target_category = id.target_category;
- + params.instance_id = id.instance;
- + params.flags = flags;
- + put_unaligned_le16(rqid, ¶ms.request_id);
- +
- + rqst.tc = reg.target_category;
- + rqst.cid = reg.cid_enable;
- + rqst.iid = 0x00;
- + rqst.chn = reg.channel;
- + rqst.snc = 0x01;
- + rqst.cdl = sizeof(params);
- + rqst.pld = (u8 *)¶ms;
- +
- + result.cap = ARRAY_SIZE(buf);
- + result.len = 0;
- + result.data = buf;
- +
- + status = __surface_sam_ssh_rqst(ec, &rqst, &result);
- +
- + if (status) {
- + dev_err(&ec->serdev->dev, "failed to enable event source"
- + " (tc: 0x%02x, rqid: 0x%04x)\n",
- + id.target_category, rqid);
- + }
- +
- + if (buf[0] != 0x00) {
- + pr_warn(SSH_RQST_TAG_FULL
- + "unexpected result while enabling event source: "
- + "0x%02x\n", buf[0]);
- + }
- +
- + return status;
- +
- +}
- +
- +static int surface_sam_ssh_event_disable(struct sam_ssh_ec *ec,
- + struct ssam_event_registry reg,
- + struct ssam_event_id id,
- + u8 flags)
- +{
- + struct ssh_notification_params params;
- + struct surface_sam_ssh_rqst rqst;
- + struct surface_sam_ssh_buf result;
- +
- + u16 rqid = ssh_tc_to_rqid(id.target_category);
- + u8 buf[1] = { 0x00 };
- + int status;
- +
- + // only allow RQIDs that lie within event spectrum
- + if (!ssh_rqid_is_event(rqid))
- + return -EINVAL;
- +
- + params.target_category = id.target_category;
- + params.instance_id = id.instance;
- + params.flags = flags;
- + put_unaligned_le16(rqid, ¶ms.request_id);
- +
- + rqst.tc = reg.target_category;
- + rqst.cid = reg.cid_disable;
- + rqst.iid = 0x00;
- + rqst.chn = reg.channel;
- + rqst.snc = 0x01;
- + rqst.cdl = sizeof(params);
- + rqst.pld = (u8 *)¶ms;
- +
- + result.cap = ARRAY_SIZE(buf);
- + result.len = 0;
- + result.data = buf;
- +
- + status = __surface_sam_ssh_rqst(ec, &rqst, &result);
- +
- + if (status) {
- + dev_err(&ec->serdev->dev, "failed to disable event source"
- + " (tc: 0x%02x, rqid: 0x%04x)\n",
- + id.target_category, rqid);
- + }
- +
- + if (buf[0] != 0x00) {
- + dev_warn(&ec->serdev->dev,
- + "unexpected result while disabling event source: "
- + "0x%02x\n", buf[0]);
- + }
- +
- + return status;
- +}
- +
- +
- +int surface_sam_ssh_notifier_register(struct ssam_event_notifier *n)
- +{
- + struct ssam_nf_head *nf_head;
- + struct sam_ssh_ec *ec;
- + struct ssam_nf *nf;
- + u16 event = ssh_tc_to_event(n->event.id.target_category);
- + u16 rqid = ssh_event_to_rqid(event);
- + int rc, status;
- +
- + if (!ssh_rqid_is_event(rqid))
- + return -EINVAL;
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (!ec)
- + return -ENXIO;
- +
- + nf = &ec->cplt.event.notif;
- + nf_head = &nf->head[event];
- +
- + mutex_lock(&nf->lock);
- +
- + rc = ssam_nf_refcount_inc(nf, n->event.reg, n->event.id);
- + if (rc < 0) {
- + mutex_unlock(&nf->lock);
- + return rc;
- + }
- +
- + ssh_dbg(ec, "enabling event (tc: 0x%02x, rc: %d)\n", rqid, rc);
- +
- + status = __ssam_nfblk_insert(nf_head, &n->base);
- + if (status) {
- + ssam_nf_refcount_dec(nf, n->event.reg, n->event.id);
- + mutex_unlock(&nf->lock);
- + return status;
- + }
- +
- + if (rc == 1) {
- + status = surface_sam_ssh_event_enable(ec, n->event.reg, n->event.id, n->event.flags);
- + if (status) {
- + __ssam_nfblk_remove(nf_head, &n->base);
- + ssam_nf_refcount_dec(nf, n->event.reg, n->event.id);
- + mutex_unlock(&nf->lock);
- + return status;
- + }
- + }
- +
- + mutex_unlock(&nf->lock);
- + return 0;
- +}
- +EXPORT_SYMBOL_GPL(surface_sam_ssh_notifier_register);
- +
- +int surface_sam_ssh_notifier_unregister(struct ssam_event_notifier *n)
- +{
- + struct ssam_nf_head *nf_head;
- + struct sam_ssh_ec *ec;
- + struct ssam_nf *nf;
- + u16 event = ssh_tc_to_event(n->event.id.target_category);
- + u16 rqid = ssh_event_to_rqid(event);
- + int rc, status = 0;
- +
- + if (!ssh_rqid_is_event(rqid))
- + return -EINVAL;
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (!ec)
- + return -ENXIO;
- +
- + nf = &ec->cplt.event.notif;
- + nf_head = &nf->head[event];
- +
- + mutex_lock(&nf->lock);
- +
- + rc = ssam_nf_refcount_dec(nf, n->event.reg, n->event.id);
- + if (rc < 0) {
- + mutex_unlock(&nf->lock);
- + return rc;
- + }
- +
- + ssh_dbg(ec, "disabling event (tc: 0x%02x, rc: %d)\n", rqid, rc);
- +
- + if (rc == 0)
- + status = surface_sam_ssh_event_disable(ec, n->event.reg, n->event.id, n->event.flags);
- +
- + __ssam_nfblk_remove(nf_head, &n->base);
- + mutex_unlock(&nf->lock);
- + synchronize_srcu(&nf_head->srcu);
- +
- + return status;
- +}
- +EXPORT_SYMBOL_GPL(surface_sam_ssh_notifier_unregister);
- +
- +
- +static int __surface_sam_ssh_rqst(struct sam_ssh_ec *ec,
- + const struct surface_sam_ssh_rqst *rqst,
- + struct surface_sam_ssh_buf *result)
- +{
- + struct ssam_request_sync actual;
- + struct msgbuf msgb;
- + size_t msglen = SSH_COMMAND_MESSAGE_LENGTH(rqst->cdl);
- + unsigned flags = 0;
- + u16 rqid;
- + u8 seq;
- + int status;
- +
- + // prevent overflow
- + if (rqst->cdl > SSH_COMMAND_MAX_PAYLOAD_SIZE) {
- + ssh_err(ec, SSH_RQST_TAG "request payload too large\n");
- + return -EINVAL;
- + }
- +
- + if (result && result->data && rqst->snc)
- + flags |= SSAM_REQUEST_HAS_RESPONSE;
- +
- + ssh_request_init(&actual.base, flags, &ssam_request_sync_ops);
- + init_completion(&actual.comp);
- +
- + actual.resp.pointer = NULL;
- + actual.resp.capacity = 0;
- + actual.resp.length = 0;
- + actual.resp.status = 0;
- +
- + if (result) {
- + actual.resp.pointer = result->data;
- + actual.resp.capacity = result->cap;
- + }
- +
- + // alloc and create message
- + status = msgb_alloc(&msgb, msglen, GFP_KERNEL);
- + if (status)
- + return status;
- +
- + seq = ssh_seq_next(&ec->counter.seq);
- + rqid = ssh_rqid_next(&ec->counter.rqid);
- + msgb_push_cmd(&msgb, seq, rqst, rqid);
- +
- + actual.base.packet.data = msgb.buffer;
- + actual.base.packet.data_length = msgb.ptr - msgb.buffer;
- +
- + status = ssh_rtl_submit(&ec->rtl, &actual.base);
- + if (status) {
- + msgb_free(&msgb);
- + return status;
- + }
- +
- + ssh_request_put(&actual.base);
- + ssam_request_sync_wait_complete(&actual);
- + msgb_free(&msgb);
- +
- + if (result)
- + result->len = actual.resp.length;
- +
- + return actual.resp.status;
- +}
- +
- +int surface_sam_ssh_rqst(const struct surface_sam_ssh_rqst *rqst, struct surface_sam_ssh_buf *result)
- +{
- + struct sam_ssh_ec *ec;
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (!ec) {
- + pr_warn(SSH_RQST_TAG_FULL "embedded controller is uninitialized\n");
- + return -ENXIO;
- + }
- +
- + if (smp_load_acquire(&ec->state) == SSH_EC_SUSPENDED) {
- + ssh_warn(ec, SSH_RQST_TAG "embedded controller is suspended\n");
- + return -EPERM;
- + }
- +
- + return __surface_sam_ssh_rqst(ec, rqst, result);
- +}
- +EXPORT_SYMBOL_GPL(surface_sam_ssh_rqst);
- +
- +
- +/**
- + * surface_sam_ssh_ec_resume - Resume the EC if it is in a suspended mode.
- + * @ec: the EC to resume
- + *
- + * Moves the EC from a suspended state to a normal state. See the
- + * `surface_sam_ssh_ec_suspend` function what the specific differences of
- + * these states are. Multiple repeated calls to this function seem to be
- + * handled fine by the EC, after the first call, the state will remain
- + * "normal".
- + *
- + * Must be called with the EC initialized and its lock held.
- + */
- +static int surface_sam_ssh_ec_resume(struct sam_ssh_ec *ec)
- +{
- + u8 buf[1] = { 0x00 };
- + int status;
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x01,
- + .cid = 0x16,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + result.cap = ARRAY_SIZE(buf),
- + result.len = 0,
- + result.data = buf,
- + };
- +
- + ssh_dbg(ec, "pm: resuming system aggregator module\n");
- + status = __surface_sam_ssh_rqst(ec, &rqst, &result);
- + if (status)
- + return status;
- +
- + /*
- + * The purpose of the return value of this request is unknown. Based on
- + * logging and experience, we expect it to be zero. No other value has
- + * been observed so far.
- + */
- + if (buf[0] != 0x00) {
- + ssh_warn(ec, "unexpected result while trying to resume EC: "
- + "0x%02x\n", buf[0]);
- + }
- +
- + return 0;
- +}
- +
- +/**
- + * surface_sam_ssh_ec_suspend - Put the EC in a suspended mode:
- + * @ec: the EC to suspend
- + *
- + * Tells the EC to enter a suspended mode. In this mode, events are quiesced
- + * and the wake IRQ is armed (note that the wake IRQ does not fire if the EC
- + * has not been suspended via this request). On some devices, the keyboard
- + * backlight is turned off. Apart from this, the EC seems to continue to work
- + * as normal, meaning requests sent to it are acknowledged and seem to be
- + * correctly handled, including potential responses. Multiple repeated calls
- + * to this function seem to be handled fine by the EC, after the first call,
- + * the state will remain "suspended".
- + *
- + * Must be called with the EC initialized and its lock held.
- + */
- +static int surface_sam_ssh_ec_suspend(struct sam_ssh_ec *ec)
- +{
- + u8 buf[1] = { 0x00 };
- + int status;
- +
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x01,
- + .cid = 0x15,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + result.cap = ARRAY_SIZE(buf),
- + result.len = 0,
- + result.data = buf,
- + };
- +
- + ssh_dbg(ec, "pm: suspending system aggregator module\n");
- + status = __surface_sam_ssh_rqst(ec, &rqst, &result);
- + if (status)
- + return status;
- +
- + /*
- + * The purpose of the return value of this request is unknown. Based on
- + * logging and experience, we expect it to be zero. No other value has
- + * been observed so far.
- + */
- + if (buf[0] != 0x00) {
- + ssh_warn(ec, "unexpected result while trying to suspend EC: "
- + "0x%02x\n", buf[0]);
- + }
- +
- + return 0;
- +}
- +
- +
- +static int surface_sam_ssh_get_controller_version(struct sam_ssh_ec *ec, u32 *version)
- +{
- + struct surface_sam_ssh_rqst rqst = {
- + .tc = 0x01,
- + .cid = 0x13,
- + .iid = 0x00,
- + .chn = 0x01,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surface_sam_ssh_buf result = {
- + result.cap = sizeof(*version),
- + result.len = 0,
- + result.data = (u8 *)version,
- + };
- +
- + *version = 0;
- + return __surface_sam_ssh_rqst(ec, &rqst, &result);
- +}
- +
- +static int surface_sam_ssh_log_controller_version(struct sam_ssh_ec *ec)
- +{
- + u32 version, a, b, c;
- + int status;
- +
- + status = surface_sam_ssh_get_controller_version(ec, &version);
- + if (status)
- + return status;
- +
- + a = (version >> 24) & 0xff;
- + b = le16_to_cpu((version >> 8) & 0xffff);
- + c = version & 0xff;
- +
- + dev_info(&ec->serdev->dev, "SAM controller version: %u.%u.%u\n",
- + a, b, c);
- + return 0;
- +}
- +
- +
- +static const struct acpi_gpio_params gpio_ssh_wakeup_int = { 0, 0, false };
- +static const struct acpi_gpio_params gpio_ssh_wakeup = { 1, 0, false };
- +
- +static const struct acpi_gpio_mapping ssh_acpi_gpios[] = {
- + { "ssh_wakeup-int-gpio", &gpio_ssh_wakeup_int, 1 },
- + { "ssh_wakeup-gpio", &gpio_ssh_wakeup, 1 },
- + { },
- +};
- +
- +static irqreturn_t ssh_wake_irq_handler(int irq, void *dev_id)
- +{
- + struct serdev_device *serdev = dev_id;
- +
- + dev_dbg(&serdev->dev, "pm: wake irq triggered\n");
- +
- + // TODO: Send GPIO callback command repeatedly to EC until callback
- + // returns 0x00. Return flag of callback is "has more events".
- + // Each time the command is sent, one event is "released". Once
- + // all events have been released (return = 0x00), the GPIO is
- + // re-armed.
- +
- + return IRQ_HANDLED;
- +}
- +
- +static int ssh_setup_irq(struct serdev_device *serdev)
- +{
- + const int irqf = IRQF_SHARED | IRQF_ONESHOT | IRQF_TRIGGER_RISING;
- + struct gpio_desc *gpiod;
- + int irq;
- + int status;
- +
- + gpiod = gpiod_get(&serdev->dev, "ssh_wakeup-int", GPIOD_ASIS);
- + if (IS_ERR(gpiod))
- + return PTR_ERR(gpiod);
- +
- + irq = gpiod_to_irq(gpiod);
- + gpiod_put(gpiod);
- +
- + if (irq < 0)
- + return irq;
- +
- + status = request_threaded_irq(irq, NULL, ssh_wake_irq_handler,
- + irqf, "surface_sam_sh_wakeup", serdev);
- + if (status)
- + return status;
- +
- + return irq;
- +}
- +
- +
- +static acpi_status ssh_setup_from_resource(struct acpi_resource *rsc, void *ctx)
- +{
- + struct serdev_device *serdev = ctx;
- + struct acpi_resource_common_serialbus *serial;
- + struct acpi_resource_uart_serialbus *uart;
- + bool flow_control;
- + int status = 0;
- +
- + if (rsc->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
- + return AE_OK;
- +
- + serial = &rsc->data.common_serial_bus;
- + if (serial->type != ACPI_RESOURCE_SERIAL_TYPE_UART)
- + return AE_OK;
- +
- + uart = &rsc->data.uart_serial_bus;
- +
- + // set up serdev device
- + serdev_device_set_baudrate(serdev, uart->default_baud_rate);
- +
- + // serdev currently only supports RTSCTS flow control
- + if (uart->flow_control & SSH_SUPPORTED_FLOW_CONTROL_MASK) {
- + dev_warn(&serdev->dev, "setup: unsupported flow control"
- + " (value: 0x%02x)\n", uart->flow_control);
- + }
- +
- + // set RTSCTS flow control
- + flow_control = uart->flow_control & ACPI_UART_FLOW_CONTROL_HW;
- + serdev_device_set_flow_control(serdev, flow_control);
- +
- + // serdev currently only supports EVEN/ODD parity
- + switch (uart->parity) {
- + case ACPI_UART_PARITY_NONE:
- + status = serdev_device_set_parity(serdev, SERDEV_PARITY_NONE);
- + break;
- + case ACPI_UART_PARITY_EVEN:
- + status = serdev_device_set_parity(serdev, SERDEV_PARITY_EVEN);
- + break;
- + case ACPI_UART_PARITY_ODD:
- + status = serdev_device_set_parity(serdev, SERDEV_PARITY_ODD);
- + break;
- + default:
- + dev_warn(&serdev->dev, "setup: unsupported parity"
- + " (value: 0x%02x)\n", uart->parity);
- + break;
- + }
- +
- + if (status) {
- + dev_err(&serdev->dev, "setup: failed to set parity"
- + " (value: 0x%02x)\n", uart->parity);
- + return status;
- + }
- +
- + return AE_CTRL_TERMINATE; // we've found the resource and are done
- +}
- +
- +
- +static int surface_sam_ssh_suspend(struct device *dev)
- +{
- + struct sam_ssh_ec *ec;
- + int status;
- +
- + dev_dbg(dev, "pm: suspending\n");
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (ec) {
- + status = surface_sam_ssh_ec_suspend(ec);
- + if (status)
- + return status;
- +
- + if (device_may_wakeup(dev)) {
- + status = enable_irq_wake(ec->irq);
- + if (status)
- + return status;
- +
- + ec->irq_wakeup_enabled = true;
- + } else {
- + ec->irq_wakeup_enabled = false;
- + }
- +
- + smp_store_release(&ec->state, SSH_EC_SUSPENDED);
- + }
- +
- + return 0;
- +}
- +
- +static int surface_sam_ssh_resume(struct device *dev)
- +{
- + struct sam_ssh_ec *ec;
- + int status;
- +
- + dev_dbg(dev, "pm: resuming\n");
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (ec) {
- + smp_store_release(&ec->state, SSH_EC_INITIALIZED);
- +
- + if (ec->irq_wakeup_enabled) {
- + status = disable_irq_wake(ec->irq);
- + if (status)
- + return status;
- +
- + ec->irq_wakeup_enabled = false;
- + }
- +
- + status = surface_sam_ssh_ec_resume(ec);
- + if (status)
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +static SIMPLE_DEV_PM_OPS(surface_sam_ssh_pm_ops, surface_sam_ssh_suspend,
- + surface_sam_ssh_resume);
- +
- +
- +static void ssam_handle_event(struct ssh_rtl *rtl,
- + const struct ssh_command *cmd,
- + const struct sshp_span *data)
- +{
- + struct sam_ssh_ec *ec = container_of(rtl, struct sam_ssh_ec, rtl);
- + struct ssam_event_item *item;
- +
- + item = kzalloc(sizeof(struct ssam_event_item) + data->len, GFP_KERNEL);
- + if (!item)
- + return;
- +
- + item->rqid = get_unaligned_le16(&cmd->rqid);
- + item->event.target_category = cmd->tc;
- + item->event.command_id = cmd->cid;
- + item->event.instance_id = cmd->iid;
- + item->event.channel = cmd->chn_in;
- + item->event.length = data->len;
- + memcpy(&item->event.data[0], data->ptr, data->len);
- +
- + ssam_cplt_submit_event(&ec->cplt, item);
- +}
- +
- +static struct ssh_rtl_ops ssam_rtl_ops = {
- + .handle_event = ssam_handle_event,
- +};
- +
- +
- +static int ssam_receive_buf(struct serdev_device *dev, const unsigned char *buf, size_t n)
- +{
- + struct sam_ssh_ec *ec = serdev_device_get_drvdata(dev);
- + return ssh_ptl_rx_rcvbuf(&ec->rtl.ptl, buf, n);
- +}
- +
- +static void ssam_write_wakeup(struct serdev_device *dev)
- +{
- + struct sam_ssh_ec *ec = serdev_device_get_drvdata(dev);
- + ssh_ptl_tx_wakeup(&ec->rtl.ptl, true);
- +}
- +
- +struct serdev_device_ops ssam_serdev_ops = {
- + .receive_buf = ssam_receive_buf,
- + .write_wakeup = ssam_write_wakeup,
- +};
- +
- +
- +#ifdef CONFIG_SURFACE_SAM_SSH_DEBUG_DEVICE
- +
- +static char sam_ssh_debug_rqst_buf_sysfs[256] = { 0 };
- +static char sam_ssh_debug_rqst_buf_pld[255] = { 0 };
- +static char sam_ssh_debug_rqst_buf_res[255] = { 0 };
- +
- +struct sysfs_rqst {
- + u8 tc;
- + u8 cid;
- + u8 iid;
- + u8 chn;
- + u8 snc;
- + u8 cdl;
- + u8 pld[0];
- +} __packed;
- +
- +static ssize_t rqst_read(struct file *f, struct kobject *kobj, struct bin_attribute *attr,
- + char *buf, loff_t offs, size_t count)
- +{
- + if (offs < 0 || count + offs > ARRAY_SIZE(sam_ssh_debug_rqst_buf_sysfs))
- + return -EINVAL;
- +
- + memcpy(buf, sam_ssh_debug_rqst_buf_sysfs + offs, count);
- + return count;
- +}
- +
- +static ssize_t rqst_write(struct file *f, struct kobject *kobj, struct bin_attribute *attr,
- + char *buf, loff_t offs, size_t count)
- +{
- + struct sysfs_rqst *input;
- + struct surface_sam_ssh_rqst rqst = {};
- + struct surface_sam_ssh_buf result = {};
- + int status;
- +
- + // check basic write constriants
- + if (offs != 0 || count - sizeof(struct sysfs_rqst) > ARRAY_SIZE(sam_ssh_debug_rqst_buf_pld))
- + return -EINVAL;
- +
- + if (count < sizeof(struct sysfs_rqst))
- + return -EINVAL;
- +
- + input = (struct sysfs_rqst *)buf;
- +
- + // payload length should be consistent with data provided
- + if (input->cdl + sizeof(struct sysfs_rqst) != count)
- + return -EINVAL;
- +
- + rqst.tc = input->tc;
- + rqst.cid = input->cid;
- + rqst.iid = input->iid;
- + rqst.chn = input->chn;
- + rqst.snc = input->snc;
- + rqst.cdl = input->cdl;
- + rqst.pld = sam_ssh_debug_rqst_buf_pld;
- + memcpy(sam_ssh_debug_rqst_buf_pld, &input->pld[0], input->cdl);
- +
- + result.cap = ARRAY_SIZE(sam_ssh_debug_rqst_buf_res);
- + result.len = 0;
- + result.data = sam_ssh_debug_rqst_buf_res;
- +
- + status = surface_sam_ssh_rqst(&rqst, &result);
- + if (status)
- + return status;
- +
- + sam_ssh_debug_rqst_buf_sysfs[0] = result.len;
- + memcpy(sam_ssh_debug_rqst_buf_sysfs + 1, result.data, result.len);
- + memset(sam_ssh_debug_rqst_buf_sysfs + result.len + 1, 0,
- + ARRAY_SIZE(sam_ssh_debug_rqst_buf_sysfs) + 1 - result.len);
- +
- + return count;
- +}
- +
- +static const BIN_ATTR_RW(rqst, ARRAY_SIZE(sam_ssh_debug_rqst_buf_sysfs));
- +
- +static int surface_sam_ssh_sysfs_register(struct device *dev)
- +{
- + return sysfs_create_bin_file(&dev->kobj, &bin_attr_rqst);
- +}
- +
- +static void surface_sam_ssh_sysfs_unregister(struct device *dev)
- +{
- + sysfs_remove_bin_file(&dev->kobj, &bin_attr_rqst);
- +}
- +
- +#else /* CONFIG_SURFACE_SAM_SSH_DEBUG_DEVICE */
- +
- +static int surface_sam_ssh_sysfs_register(struct device *dev)
- +{
- + return 0;
- +}
- +
- +static void surface_sam_ssh_sysfs_unregister(struct device *dev)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_SAM_SSH_DEBUG_DEVICE */
- +
- +
- +static int surface_sam_ssh_probe(struct serdev_device *serdev)
- +{
- + struct sam_ssh_ec *ec;
- + acpi_handle *ssh = ACPI_HANDLE(&serdev->dev);
- + int status, irq;
- +
- + if (gpiod_count(&serdev->dev, NULL) < 0)
- + return -ENODEV;
- +
- + status = devm_acpi_dev_add_driver_gpios(&serdev->dev, ssh_acpi_gpios);
- + if (status)
- + return status;
- +
- + // setup IRQ
- + irq = ssh_setup_irq(serdev);
- + if (irq < 0)
- + return irq;
- +
- + // set up EC
- + ec = surface_sam_ssh_acquire();
- + if (smp_load_acquire(&ec->state) != SSH_EC_UNINITIALIZED) {
- + dev_err(&serdev->dev, "embedded controller already initialized\n");
- +
- + status = -EBUSY;
- + goto err_ecinit;
- + }
- +
- + ec->serdev = serdev;
- + ec->irq = irq;
- + ssh_seq_reset(&ec->counter.seq);
- + ssh_rqid_reset(&ec->counter.rqid);
- +
- + // initialize event/request completion system
- + status = ssam_cplt_init(&ec->cplt, &serdev->dev);
- + if (status)
- + goto err_ecinit;
- +
- + // initialize request and packet transmission layers
- + status = ssh_rtl_init(&ec->rtl, serdev, &ssam_rtl_ops);
- + if (status)
- + goto err_rtl;
- +
- + serdev_device_set_drvdata(serdev, ec);
- +
- + serdev_device_set_client_ops(serdev, &ssam_serdev_ops);
- + status = serdev_device_open(serdev);
- + if (status)
- + goto err_open;
- +
- + status = acpi_walk_resources(ssh, METHOD_NAME__CRS,
- + ssh_setup_from_resource, serdev);
- + if (ACPI_FAILURE(status))
- + goto err_devinit;
- +
- + status = ssh_rtl_tx_start(&ec->rtl);
- + if (status)
- + goto err_devinit;
- +
- + status = ssh_rtl_rx_start(&ec->rtl);
- + if (status)
- + goto err_devinit;
- +
- + smp_store_release(&ec->state, SSH_EC_INITIALIZED);
- +
- + status = surface_sam_ssh_log_controller_version(ec);
- + if (status)
- + goto err_finalize;
- +
- + status = surface_sam_ssh_ec_resume(ec);
- + if (status)
- + goto err_finalize;
- +
- + status = surface_sam_ssh_sysfs_register(&serdev->dev);
- + if (status)
- + goto err_finalize;
- +
- + // TODO: The EC can wake up the system via the associated GPIO interrupt in
- + // multiple situations. One of which is the remaining battery capacity
- + // falling below a certain threshold. Normally, we should use the
- + // device_init_wakeup function, however, the EC also seems to have other
- + // reasons for waking up the system and it seems that Windows has
- + // additional checks whether the system should be resumed. In short, this
- + // causes some spourious unwanted wake-ups. For now let's thus default
- + // power/wakeup to false.
- + device_set_wakeup_capable(&serdev->dev, true);
- + acpi_walk_dep_device_list(ssh);
- +
- + return 0;
- +
- +err_finalize:
- + smp_store_release(&ec->state, SSH_EC_UNINITIALIZED);
- + ssh_rtl_flush(&ec->rtl, msecs_to_jiffies(5000));
- +err_devinit:
- + serdev_device_close(serdev);
- +err_open:
- + ssh_rtl_shutdown(&ec->rtl);
- + ssh_rtl_destroy(&ec->rtl);
- +err_rtl:
- + ssam_cplt_flush(&ec->cplt);
- + ssam_cplt_destroy(&ec->cplt);
- +err_ecinit:
- + free_irq(irq, serdev);
- + serdev_device_set_drvdata(serdev, NULL);
- + return status;
- +}
- +
- +static void surface_sam_ssh_remove(struct serdev_device *serdev)
- +{
- + struct sam_ssh_ec *ec;
- + int status;
- +
- + ec = surface_sam_ssh_acquire_init();
- + if (!ec)
- + return;
- +
- + free_irq(ec->irq, serdev);
- + surface_sam_ssh_sysfs_unregister(&serdev->dev);
- +
- + // suspend EC and disable events
- + status = surface_sam_ssh_ec_suspend(ec);
- + if (status)
- + dev_err(&serdev->dev, "failed to suspend EC: %d\n", status);
- +
- + // flush pending events and requests while everything still works
- + status = ssh_rtl_flush(&ec->rtl, msecs_to_jiffies(5000));
- + if (status)
- + dev_err(&serdev->dev, "failed to flush request transmission layer: %d\n", status);
- +
- + ssam_cplt_flush(&ec->cplt);
- +
- + // mark device as uninitialized
- + smp_store_release(&ec->state, SSH_EC_UNINITIALIZED);
- +
- + // cancel rem. requests, ensure no new ones can be queued, stop threads
- + ssh_rtl_tx_flush(&ec->rtl);
- + ssh_rtl_shutdown(&ec->rtl);
- +
- + // shut down actual transport
- + serdev_device_wait_until_sent(ec->serdev, 0);
- + serdev_device_close(ec->serdev);
- +
- + /*
- + * Ensure _all_ events are completed. New ones could still have been
- + * received after the last flush, before the request transport layer
- + * has been shut down. At this point we can be sure that no requests
- + * will remain after this call.
- + */
- + ssam_cplt_flush(&ec->cplt);
- +
- + // actually free resources
- + ssam_cplt_destroy(&ec->cplt);
- + ssh_rtl_destroy(&ec->rtl);
- +
- + ec->serdev = NULL;
- + ec->irq = -1;
- +
- + device_set_wakeup_capable(&serdev->dev, false);
- + serdev_device_set_drvdata(serdev, NULL);
- +}
- +
- +
- +static const struct acpi_device_id surface_sam_ssh_match[] = {
- + { "MSHW0084", 0 },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surface_sam_ssh_match);
- +
- +static struct serdev_device_driver surface_sam_ssh = {
- + .probe = surface_sam_ssh_probe,
- + .remove = surface_sam_ssh_remove,
- + .driver = {
- + .name = "surface_sam_ssh",
- + .acpi_match_table = surface_sam_ssh_match,
- + .pm = &surface_sam_ssh_pm_ops,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +
- +
- +static int __init surface_sam_ssh_init(void)
- +{
- + return serdev_device_driver_register(&surface_sam_ssh);
- +}
- +
- +static void __exit surface_sam_ssh_exit(void)
- +{
- + serdev_device_driver_unregister(&surface_sam_ssh);
- +}
- +
- +/*
- + * Ensure that the driver is loaded late due to some issues with the UART
- + * communication. Specifically, we want to ensure that DMA is ready and being
- + * used. Not using DMA can result in spurious communication failures,
- + * especially during boot, which among other things will result in wrong
- + * battery information (via ACPI _BIX) being displayed. Using a late init_call
- + * instead of the normal module_init gives the DMA subsystem time to
- + * initialize and via that results in a more stable communication, avoiding
- + * such failures.
- + */
- +late_initcall(surface_sam_ssh_init);
- +module_exit(surface_sam_ssh_exit);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Surface Serial Hub Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_ssh.h b/drivers/platform/x86/surface_sam/surface_sam_ssh.h
- new file mode 100644
- index 000000000000..25a3ae85fee7
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_ssh.h
- @@ -0,0 +1,488 @@
- +/* SPDX-License-Identifier: GPL-2.0-or-later */
- +/*
- + * Interface for Surface Serial Hub (SSH).
- + *
- + * The SSH is the main communication hub for communication between host and
- + * the Surface/System Aggregator Module (SAM) on newer Microsoft Surface
- + * devices (Book 2, Pro 5, Laptops, ...). Also referred to as SAM-over-SSH.
- + * Older devices (Book 1, Pro 4) use SAM-over-HID (via I2C).
- + */
- +
- +#ifndef _SURFACE_SAM_SSH_H
- +#define _SURFACE_SAM_SSH_H
- +
- +#include <linux/types.h>
- +#include <linux/device.h>
- +
- +
- +/* -- Data structures for SAM-over-SSH communication. ----------------------- */
- +
- +/**
- + * enum ssh_frame_type - Frame types for SSH frames.
- + * @SSH_FRAME_TYPE_DATA_SEQ: Indicates a data frame, followed by a payload with
- + * the length specified in the ssh_frame.len field. This
- + * frame is sequenced, meaning that an ACK is required.
- + * @SSH_FRAME_TYPE_DATA_NSQ: Same as SSH_FRAME_TYPE_DATA_SEQ, but unsequenced,
- + * meaning that the message does not have to be ACKed.
- + * @SSH_FRAME_TYPE_ACK: Indicates an ACK message.
- + * @SSH_FRAME_TYPE_NAK: Indicates an error response for previously sent
- + * frame. In general, this means that the frame and/or
- + * payload is malformed, e.g. a CRC is wrong. For command-
- + * type payloads, this can also mean that the command is
- + * invalid.
- + */
- +enum ssh_frame_type {
- + SSH_FRAME_TYPE_DATA_SEQ = 0x80,
- + SSH_FRAME_TYPE_DATA_NSQ = 0x00,
- + SSH_FRAME_TYPE_ACK = 0x40,
- + SSH_FRAME_TYPE_NAK = 0x04,
- +};
- +
- +/**
- + * struct ssh_frame - SSH communication frame.
- + * @type: The type of the frame. See &enum ssh_frame_type.
- + * @len: The length of the frame payload directly following the CRC for this
- + * frame. Does not include the final CRC for that payload.
- + * @seq: The sequence number for this message/exchange.
- + */
- +struct ssh_frame {
- + u8 type;
- + __le16 len;
- + u8 seq;
- +} __packed;
- +
- +static_assert(sizeof(struct ssh_frame) == 4);
- +
- +/*
- + * Maximum SSH frame payload length in bytes. This is the physical maximum
- + * length of the protocol. Implementations may set a more constrained limit.
- + */
- +#define SSH_FRAME_MAX_PAYLOAD_SIZE U16_MAX
- +
- +/**
- + * enum ssh_payload_type - Type indicator for the SSH payload.
- + * @SSH_PLD_TYPE_CMD: The payload is a command structure with optional command
- + * payload.
- + */
- +enum ssh_payload_type {
- + SSH_PLD_TYPE_CMD = 0x80,
- +};
- +
- +/**
- + * struct ssh_command - Payload of a command-type frame.
- + * @type: The type of the payload. See &enum ssh_payload_type. Should be
- + * SSH_PLD_TYPE_CMD for this struct.
- + * @tc: Command target category.
- + * @chn_out: Output channel. Should be zero if this an incoming (EC to host)
- + * message.
- + * @chn_in: Input channel. Should be zero if this is an outgoing (hos to EC)
- + * message.
- + * @iid: Instance ID.
- + * @rqid: Request ID. Used to match requests with responses and differentiate
- + * between responses and events.
- + * @cid: Command ID.
- + */
- +struct ssh_command {
- + u8 type;
- + u8 tc;
- + u8 chn_out;
- + u8 chn_in;
- + u8 iid;
- + __le16 rqid;
- + u8 cid;
- +} __packed;
- +
- +static_assert(sizeof(struct ssh_command) == 8);
- +
- +/*
- + * Maximum SSH command payload length in bytes. This is the physical maximum
- + * length of the protocol. Implementations may set a more constrained limit.
- + */
- +#define SSH_COMMAND_MAX_PAYLOAD_SIZE \
- + (SSH_FRAME_MAX_PAYLOAD_SIZE - sizeof(struct ssh_command))
- +
- +/**
- + * struct ssh_notification_params - Command payload to enable/disable SSH
- + * notifications.
- + * @target_category: The target category for which notifications should be
- + * enabled/disabled.
- + * @flags: Flags determining how notifications are being sent.
- + * @request_id: The request ID that is used to send these notifications.
- + * @instance_id: The specific instance in the given target category for
- + * which notifications should be enabled.
- + */
- +struct ssh_notification_params {
- + u8 target_category;
- + u8 flags;
- + __le16 request_id;
- + u8 instance_id;
- +} __packed;
- +
- +static_assert(sizeof(struct ssh_notification_params) == 5);
- +
- +/**
- + * SSH message syncrhonization (SYN) bytes.
- + */
- +#define SSH_MSG_SYN ((u16)0x55aa)
- +
- +/**
- + * Base-length of a SSH message. This is the minimum number of bytes required
- + * to form a message. The actual message length is SSH_MSG_LEN_BASE plus the
- + * length of the frame payload.
- + */
- +#define SSH_MSG_LEN_BASE (sizeof(struct ssh_frame) + 3ull * sizeof(u16))
- +
- +/**
- + * Length of a SSH control message.
- + */
- +#define SSH_MSG_LEN_CTRL SSH_MSG_LEN_BASE
- +
- +/**
- + * Length of a SSH message with payload of specified size.
- + */
- +#define SSH_MESSAGE_LENGTH(payload_size) (SSH_MSG_LEN_BASE + payload_size)
- +
- +/**
- + * Length of a SSH command message with command payload of specified size.
- + */
- +#define SSH_COMMAND_MESSAGE_LENGTH(payload_size) \
- + SSH_MESSAGE_LENGTH(sizeof(struct ssh_command) + payload_size)
- +
- +/**
- + * Offset of the specified struct ssh_frame field in the raw SSH message data.
- + */
- +#define SSH_MSGOFFSET_FRAME(field) \
- + (sizeof(u16) + offsetof(struct ssh_frame, field))
- +
- +/**
- + * Offset of the specified struct ssh_command field in the raw SSH message data.
- + */
- +#define SSH_MSGOFFSET_COMMAND(field) \
- + (2ull * sizeof(u16) + sizeof(struct ssh_frame) \
- + + offsetof(struct ssh_command, field))
- +
- +struct sshp_span {
- + u8 *ptr;
- + size_t len;
- +};
- +
- +
- +/* -- Packet transport layer (ptl). ----------------------------------------- */
- +
- +enum ssh_packet_priority {
- + SSH_PACKET_PRIORITY_FLUSH = 0,
- + SSH_PACKET_PRIORITY_DATA = 0,
- + SSH_PACKET_PRIORITY_NAK = 1 << 4,
- + SSH_PACKET_PRIORITY_ACK = 2 << 4,
- +};
- +
- +#define SSH_PACKET_PRIORITY(base, try) \
- + ((SSH_PACKET_PRIORITY_##base) | ((try) & 0x0f))
- +
- +#define ssh_packet_priority_get_try(p) ((p) & 0x0f)
- +
- +
- +enum ssh_packet_type_flags {
- + SSH_PACKET_TY_FLUSH_BIT,
- + SSH_PACKET_TY_SEQUENCED_BIT,
- + SSH_PACKET_TY_BLOCKING_BIT,
- +
- + SSH_PACKET_TY_FLUSH = BIT(SSH_PACKET_TY_FLUSH_BIT),
- + SSH_PACKET_TY_SEQUENCED = BIT(SSH_PACKET_TY_SEQUENCED_BIT),
- + SSH_PACKET_TY_BLOCKING = BIT(SSH_PACKET_TY_BLOCKING_BIT),
- +};
- +
- +enum ssh_packet_state_flags {
- + SSH_PACKET_SF_LOCKED_BIT,
- + SSH_PACKET_SF_QUEUED_BIT,
- + SSH_PACKET_SF_PENDING_BIT,
- + SSH_PACKET_SF_TRANSMITTING_BIT,
- + SSH_PACKET_SF_TRANSMITTED_BIT,
- + SSH_PACKET_SF_ACKED_BIT,
- + SSH_PACKET_SF_CANCELED_BIT,
- + SSH_PACKET_SF_COMPLETED_BIT,
- +};
- +
- +
- +struct ssh_ptl;
- +struct ssh_packet;
- +
- +struct ssh_packet_ops {
- + void (*release)(struct ssh_packet *packet);
- + void (*complete)(struct ssh_packet *packet, int status);
- +};
- +
- +struct ssh_packet {
- + struct ssh_ptl *ptl;
- + struct kref refcnt;
- +
- + u8 type;
- + u8 priority;
- + u16 data_length;
- + u8 *data;
- +
- + unsigned long state;
- + ktime_t timestamp;
- +
- + struct list_head queue_node;
- + struct list_head pending_node;
- +
- + const struct ssh_packet_ops *ops;
- +};
- +
- +
- +/* -- Request transport layer (rtl). ---------------------------------------- */
- +
- +enum ssh_request_flags {
- + SSH_REQUEST_SF_LOCKED_BIT,
- + SSH_REQUEST_SF_QUEUED_BIT,
- + SSH_REQUEST_SF_PENDING_BIT,
- + SSH_REQUEST_SF_TRANSMITTING_BIT,
- + SSH_REQUEST_SF_TRANSMITTED_BIT,
- + SSH_REQUEST_SF_RSPRCVD_BIT,
- + SSH_REQUEST_SF_CANCELED_BIT,
- + SSH_REQUEST_SF_COMPLETED_BIT,
- +
- + SSH_REQUEST_TY_FLUSH_BIT,
- + SSH_REQUEST_TY_HAS_RESPONSE_BIT,
- +
- + SSH_REQUEST_FLAGS_SF_MASK =
- + BIT(SSH_REQUEST_SF_LOCKED_BIT)
- + | BIT(SSH_REQUEST_SF_QUEUED_BIT)
- + | BIT(SSH_REQUEST_SF_PENDING_BIT)
- + | BIT(SSH_REQUEST_SF_TRANSMITTING_BIT)
- + | BIT(SSH_REQUEST_SF_TRANSMITTED_BIT)
- + | BIT(SSH_REQUEST_SF_RSPRCVD_BIT)
- + | BIT(SSH_REQUEST_SF_CANCELED_BIT)
- + | BIT(SSH_REQUEST_SF_COMPLETED_BIT),
- +
- + SSH_REQUEST_FLAGS_TY_MASK =
- + BIT(SSH_REQUEST_TY_FLUSH_BIT)
- + | BIT(SSH_REQUEST_TY_HAS_RESPONSE_BIT),
- +};
- +
- +
- +struct ssh_rtl;
- +struct ssh_request;
- +
- +struct ssh_request_ops {
- + void (*release)(struct ssh_request *rqst);
- + void (*complete)(struct ssh_request *rqst,
- + const struct ssh_command *cmd,
- + const struct sshp_span *data, int status);
- +};
- +
- +struct ssh_request {
- + struct ssh_rtl *rtl;
- + struct ssh_packet packet;
- + struct list_head node;
- +
- + unsigned long state;
- + ktime_t timestamp;
- +
- + const struct ssh_request_ops *ops;
- +};
- +
- +
- +/* -- Main data types and definitions --------------------------------------- */
- +
- +enum ssam_ssh_tc {
- + SSAM_SSH_TC_SAM = 0x01, // generic system functionality, real-time clock
- + SSAM_SSH_TC_BAT = 0x02, // battery/power subsystem
- + SSAM_SSH_TC_TMP = 0x03, // thermal subsystem
- + SSAM_SSH_TC_PMC = 0x04,
- + SSAM_SSH_TC_FAN = 0x05,
- + SSAM_SSH_TC_PoM = 0x06,
- + SSAM_SSH_TC_DBG = 0x07,
- + SSAM_SSH_TC_KBD = 0x08, // legacy keyboard (Laptop 1/2)
- + SSAM_SSH_TC_FWU = 0x09,
- + SSAM_SSH_TC_UNI = 0x0a,
- + SSAM_SSH_TC_LPC = 0x0b,
- + SSAM_SSH_TC_TCL = 0x0c,
- + SSAM_SSH_TC_SFL = 0x0d,
- + SSAM_SSH_TC_KIP = 0x0e,
- + SSAM_SSH_TC_EXT = 0x0f,
- + SSAM_SSH_TC_BLD = 0x10,
- + SSAM_SSH_TC_BAS = 0x11, // detachment system (Surface Book 2/3)
- + SSAM_SSH_TC_SEN = 0x12,
- + SSAM_SSH_TC_SRQ = 0x13,
- + SSAM_SSH_TC_MCU = 0x14,
- + SSAM_SSH_TC_HID = 0x15, // generic HID input subsystem
- + SSAM_SSH_TC_TCH = 0x16,
- + SSAM_SSH_TC_BKL = 0x17,
- + SSAM_SSH_TC_TAM = 0x18,
- + SSAM_SSH_TC_ACC = 0x19,
- + SSAM_SSH_TC_UFI = 0x1a,
- + SSAM_SSH_TC_USC = 0x1b,
- + SSAM_SSH_TC_PEN = 0x1c,
- + SSAM_SSH_TC_VID = 0x1d,
- + SSAM_SSH_TC_AUD = 0x1e,
- + SSAM_SSH_TC_SMC = 0x1f,
- + SSAM_SSH_TC_KPD = 0x20,
- + SSAM_SSH_TC_REG = 0x21,
- +};
- +
- +/**
- + * struct ssam_event_flags - Flags for enabling/disabling SAM-over-SSH events
- + * @SSAM_EVENT_SEQUENCED: The event will be sent via a sequenced data frame.
- + */
- +enum ssam_event_flags {
- + SSAM_EVENT_SEQUENCED = BIT(0),
- +};
- +
- +struct ssam_event {
- + u8 target_category;
- + u8 command_id;
- + u8 instance_id;
- + u8 channel;
- + u16 length;
- + u8 data[0];
- +};
- +
- +
- +/* -- Event notifier/callbacks. --------------------------------------------- */
- +
- +#define SSAM_NOTIF_STATE_SHIFT 2
- +#define SSAM_NOTIF_STATE_MASK ((1 << SSAM_NOTIF_STATE_SHIFT) - 1)
- +
- +#define SSAM_NOTIF_HANDLED BIT(0)
- +#define SSAM_NOTIF_STOP BIT(1)
- +
- +
- +struct ssam_notifier_block;
- +
- +typedef u32 (*ssam_notifier_fn_t)(struct ssam_notifier_block *nb,
- + const struct ssam_event *event);
- +
- +struct ssam_notifier_block {
- + struct ssam_notifier_block __rcu *next;
- + ssam_notifier_fn_t fn;
- + int priority;
- +};
- +
- +
- +static inline u32 ssam_notifier_from_errno(int err)
- +{
- + WARN_ON(err > 0);
- +
- + if (err >= 0)
- + return 0;
- + else
- + return ((-err) << SSAM_NOTIF_STATE_SHIFT) | SSAM_NOTIF_STOP;
- +}
- +
- +static inline int ssam_notifier_to_errno(u32 ret)
- +{
- + return -(ret >> SSAM_NOTIF_STATE_SHIFT);
- +}
- +
- +
- +/* -- Event/notification registry. ------------------------------------------ */
- +
- +struct ssam_event_registry {
- + u8 target_category;
- + u8 channel;
- + u8 cid_enable;
- + u8 cid_disable;
- +};
- +
- +struct ssam_event_id {
- + u8 target_category;
- + u8 instance;
- +};
- +
- +
- +#define SSAM_EVENT_REGISTRY(tc, chn, cid_en, cid_dis) \
- + ((struct ssam_event_registry) { \
- + .target_category = (tc), \
- + .channel = (chn), \
- + .cid_enable = (cid_en), \
- + .cid_disable = (cid_dis), \
- + })
- +
- +#define SSAM_EVENT_ID(tc, iid) \
- + ((struct ssam_event_id) { \
- + .target_category = tc, \
- + .instance = iid, \
- + })
- +
- +
- +#define SSAM_EVENT_REGISTRY_SAM \
- + SSAM_EVENT_REGISTRY(SSAM_SSH_TC_SAM, 0x01, 0x0b, 0x0c)
- +
- +#define SSAM_EVENT_REGISTRY_KIP \
- + SSAM_EVENT_REGISTRY(SSAM_SSH_TC_KIP, 0x02, 0x27, 0x28)
- +
- +#define SSAM_EVENT_REGISTRY_REG \
- + SSAM_EVENT_REGISTRY(SSAM_SSH_TC_REG, 0x02, 0x01, 0x02)
- +
- +
- +struct ssam_event_notifier {
- + struct ssam_notifier_block base;
- +
- + struct {
- + struct ssam_event_registry reg;
- + struct ssam_event_id id;
- + u8 flags;
- + } event;
- +};
- +
- +
- +/* -- TODO -------------------------------------------------------------------*/
- +
- +/*
- + * Maximum response payload size in bytes.
- + * Value based on ACPI (255 bytes minus header/status bytes).
- + */
- +#define SURFACE_SAM_SSH_MAX_RQST_RESPONSE (255 - 4)
- +
- +/*
- + * The number of reserved event IDs, used for registering an SSH event
- + * handler. Valid event IDs are numbers below or equal to this value, with
- + * exception of zero, which is not an event ID. Thus, this is also the
- + * absolute maximum number of event handlers that can be registered.
- + */
- +#define SURFACE_SAM_SSH_NUM_EVENTS 0x22
- +
- +/*
- + * The number of communication channels used in the protocol.
- + */
- +#define SURFACE_SAM_SSH_NUM_CHANNELS 2
- +
- +
- +struct surface_sam_ssh_buf {
- + u8 cap;
- + u8 len;
- + u8 *data;
- +};
- +
- +struct surface_sam_ssh_rqst {
- + u8 tc; // target category
- + u8 cid; // command ID
- + u8 iid; // instance ID
- + u8 chn; // channel
- + u8 snc; // expect response flag (bool: 0/1)
- + u16 cdl; // command data length (length of payload)
- + u8 *pld; // pointer to payload of length cdl
- +};
- +
- +// TODO: remove rqid on external api
- +struct surface_sam_ssh_event {
- + u16 rqid; // event type/source ID
- + u8 tc; // target category
- + u8 cid; // command ID
- + u8 iid; // instance ID
- + u8 chn; // channel
- + u8 len; // length of payload
- + u8 *pld; // payload of length len
- +};
- +
- +
- +int surface_sam_ssh_consumer_register(struct device *consumer);
- +
- +int surface_sam_ssh_notifier_register(struct ssam_event_notifier *n);
- +int surface_sam_ssh_notifier_unregister(struct ssam_event_notifier *n);
- +
- +int surface_sam_ssh_rqst(const struct surface_sam_ssh_rqst *rqst, struct surface_sam_ssh_buf *result);
- +
- +#endif /* _SURFACE_SAM_SSH_H */
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_ssh_trace.h b/drivers/platform/x86/surface_sam/surface_sam_ssh_trace.h
- new file mode 100644
- index 000000000000..801c60205128
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_ssh_trace.h
- @@ -0,0 +1,536 @@
- +#undef TRACE_SYSTEM
- +#define TRACE_SYSTEM surface_sam_ssh
- +
- +#if !defined(_SURFACE_SAM_SSH_TRACE_H) || defined(TRACE_HEADER_MULTI_READ)
- +#define _SURFACE_SAM_SSH_TRACE_H
- +
- +#include <linux/tracepoint.h>
- +
- +#include "surface_sam_ssh.h"
- +
- +
- +TRACE_DEFINE_ENUM(SSH_FRAME_TYPE_DATA_SEQ);
- +TRACE_DEFINE_ENUM(SSH_FRAME_TYPE_DATA_NSQ);
- +TRACE_DEFINE_ENUM(SSH_FRAME_TYPE_ACK);
- +TRACE_DEFINE_ENUM(SSH_FRAME_TYPE_NAK);
- +
- +TRACE_DEFINE_ENUM(SSH_PACKET_TY_FLUSH_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_TY_SEQUENCED_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_TY_BLOCKING_BIT);
- +
- +TRACE_DEFINE_ENUM(SSH_PACKET_TY_FLUSH);
- +TRACE_DEFINE_ENUM(SSH_PACKET_TY_SEQUENCED);
- +TRACE_DEFINE_ENUM(SSH_PACKET_TY_BLOCKING);
- +
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_LOCKED_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_QUEUED_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_PENDING_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_TRANSMITTING_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_TRANSMITTED_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_ACKED_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_CANCELED_BIT);
- +TRACE_DEFINE_ENUM(SSH_PACKET_SF_COMPLETED_BIT);
- +
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_LOCKED_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_QUEUED_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_PENDING_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_TRANSMITTING_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_TRANSMITTED_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_RSPRCVD_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_CANCELED_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_SF_COMPLETED_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_TY_FLUSH_BIT);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_TY_HAS_RESPONSE_BIT);
- +
- +TRACE_DEFINE_ENUM(SSH_REQUEST_FLAGS_SF_MASK);
- +TRACE_DEFINE_ENUM(SSH_REQUEST_FLAGS_TY_MASK);
- +
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_SAM);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_BAT);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_TMP);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_PMC);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_FAN);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_PoM);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_DBG);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_KBD);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_FWU);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_UNI);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_LPC);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_TCL);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_SFL);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_KIP);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_EXT);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_BLD);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_BAS);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_SEN);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_SRQ);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_MCU);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_HID);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_TCH);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_BKL);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_TAM);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_ACC);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_UFI);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_USC);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_PEN);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_VID);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_AUD);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_SMC);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_KPD);
- +TRACE_DEFINE_ENUM(SSAM_SSH_TC_REG);
- +
- +
- +#define SSAM_PTR_UID_LEN 9
- +#define SSAM_U8_FIELD_NOT_APPLICABLE ((u16)-1)
- +#define SSAM_SEQ_NOT_APPLICABLE ((u16)-1)
- +#define SSAM_RQID_NOT_APPLICABLE ((u32)-1)
- +#define SSAM_SSH_TC_NOT_APPLICABLE 0
- +
- +
- +#ifndef _SURFACE_SAM_SSH_TRACE_HELPERS
- +#define _SURFACE_SAM_SSH_TRACE_HELPERS
- +
- +static inline void ssam_trace_ptr_uid(const void *ptr, char* uid_str)
- +{
- + char buf[2 * sizeof(void*) + 1];
- +
- + snprintf(buf, ARRAY_SIZE(buf), "%p", ptr);
- + memcpy(uid_str, &buf[ARRAY_SIZE(buf) - SSAM_PTR_UID_LEN],
- + SSAM_PTR_UID_LEN);
- +}
- +
- +static inline u16 ssam_trace_get_packet_seq(const struct ssh_packet *p)
- +{
- + if (!p->data || p->data_length < SSH_MESSAGE_LENGTH(0))
- + return SSAM_SEQ_NOT_APPLICABLE;
- +
- + return p->data[SSH_MSGOFFSET_FRAME(seq)];
- +}
- +
- +static inline u32 ssam_trace_get_request_id(const struct ssh_packet *p)
- +{
- + if (!p->data || p->data_length < SSH_COMMAND_MESSAGE_LENGTH(0))
- + return SSAM_RQID_NOT_APPLICABLE;
- +
- + return get_unaligned_le16(&p->data[SSH_MSGOFFSET_COMMAND(rqid)]);
- +}
- +
- +static inline u32 ssam_trace_get_request_tc(const struct ssh_packet *p)
- +{
- + if (!p->data || p->data_length < SSH_COMMAND_MESSAGE_LENGTH(0))
- + return SSAM_SSH_TC_NOT_APPLICABLE;
- +
- + return get_unaligned_le16(&p->data[SSH_MSGOFFSET_COMMAND(tc)]);
- +}
- +
- +#endif /* _SURFACE_SAM_SSH_TRACE_HELPERS */
- +
- +#define ssam_trace_get_command_field_u8(packet, field) \
- + ((!packet || packet->data_length < SSH_COMMAND_MESSAGE_LENGTH(0)) \
- + ? 0 : p->data[SSH_MSGOFFSET_COMMAND(field)])
- +
- +#define ssam_show_generic_u8_field(value) \
- + __print_symbolic(value, \
- + { SSAM_U8_FIELD_NOT_APPLICABLE, "N/A" } \
- + )
- +
- +
- +#define ssam_show_frame_type(ty) \
- + __print_symbolic(ty, \
- + { SSH_FRAME_TYPE_DATA_SEQ, "DSEQ" }, \
- + { SSH_FRAME_TYPE_DATA_NSQ, "DNSQ" }, \
- + { SSH_FRAME_TYPE_ACK, "ACK" }, \
- + { SSH_FRAME_TYPE_NAK, "NAK" } \
- + )
- +
- +#define ssam_show_packet_type(type) \
- + __print_flags(type, "", \
- + { SSH_PACKET_TY_FLUSH, "F" }, \
- + { SSH_PACKET_TY_SEQUENCED, "S" }, \
- + { SSH_PACKET_TY_BLOCKING, "B" } \
- + )
- +
- +#define ssam_show_packet_state(state) \
- + __print_flags(state, "", \
- + { BIT(SSH_PACKET_SF_LOCKED_BIT), "L" }, \
- + { BIT(SSH_PACKET_SF_QUEUED_BIT), "Q" }, \
- + { BIT(SSH_PACKET_SF_PENDING_BIT), "P" }, \
- + { BIT(SSH_PACKET_SF_TRANSMITTING_BIT), "S" }, \
- + { BIT(SSH_PACKET_SF_TRANSMITTED_BIT), "T" }, \
- + { BIT(SSH_PACKET_SF_ACKED_BIT), "A" }, \
- + { BIT(SSH_PACKET_SF_CANCELED_BIT), "C" }, \
- + { BIT(SSH_PACKET_SF_COMPLETED_BIT), "F" } \
- + )
- +
- +#define ssam_show_packet_seq(seq) \
- + __print_symbolic(seq, \
- + { SSAM_SEQ_NOT_APPLICABLE, "N/A" } \
- + )
- +
- +
- +#define ssam_show_request_type(flags) \
- + __print_flags(flags & SSH_REQUEST_FLAGS_TY_MASK, "", \
- + { BIT(SSH_REQUEST_TY_FLUSH_BIT), "F" }, \
- + { BIT(SSH_REQUEST_TY_HAS_RESPONSE_BIT), "R" } \
- + )
- +
- +#define ssam_show_request_state(flags) \
- + __print_flags(flags & SSH_REQUEST_FLAGS_SF_MASK, "", \
- + { BIT(SSH_REQUEST_SF_LOCKED_BIT), "L" }, \
- + { BIT(SSH_REQUEST_SF_QUEUED_BIT), "Q" }, \
- + { BIT(SSH_REQUEST_SF_PENDING_BIT), "P" }, \
- + { BIT(SSH_REQUEST_SF_TRANSMITTING_BIT), "S" }, \
- + { BIT(SSH_REQUEST_SF_TRANSMITTED_BIT), "T" }, \
- + { BIT(SSH_REQUEST_SF_RSPRCVD_BIT), "A" }, \
- + { BIT(SSH_REQUEST_SF_CANCELED_BIT), "C" }, \
- + { BIT(SSH_REQUEST_SF_COMPLETED_BIT), "F" } \
- + )
- +
- +#define ssam_show_request_id(rqid) \
- + __print_symbolic(rqid, \
- + { SSAM_RQID_NOT_APPLICABLE, "N/A" } \
- + )
- +
- +#define ssam_show_ssh_tc(rqid) \
- + __print_symbolic(rqid, \
- + { SSAM_SSH_TC_NOT_APPLICABLE, "N/A" }, \
- + { SSAM_SSH_TC_SAM, "SAM" }, \
- + { SSAM_SSH_TC_BAT, "BAT" }, \
- + { SSAM_SSH_TC_TMP, "TMP" }, \
- + { SSAM_SSH_TC_PMC, "PMC" }, \
- + { SSAM_SSH_TC_FAN, "FAN" }, \
- + { SSAM_SSH_TC_PoM, "PoM" }, \
- + { SSAM_SSH_TC_DBG, "DBG" }, \
- + { SSAM_SSH_TC_KBD, "KBD" }, \
- + { SSAM_SSH_TC_FWU, "FWU" }, \
- + { SSAM_SSH_TC_UNI, "UNI" }, \
- + { SSAM_SSH_TC_LPC, "LPC" }, \
- + { SSAM_SSH_TC_TCL, "TCL" }, \
- + { SSAM_SSH_TC_SFL, "SFL" }, \
- + { SSAM_SSH_TC_KIP, "KIP" }, \
- + { SSAM_SSH_TC_EXT, "EXT" }, \
- + { SSAM_SSH_TC_BLD, "BLD" }, \
- + { SSAM_SSH_TC_BAS, "BAS" }, \
- + { SSAM_SSH_TC_SEN, "SEN" }, \
- + { SSAM_SSH_TC_SRQ, "SRQ" }, \
- + { SSAM_SSH_TC_MCU, "MCU" }, \
- + { SSAM_SSH_TC_HID, "HID" }, \
- + { SSAM_SSH_TC_TCH, "TCH" }, \
- + { SSAM_SSH_TC_BKL, "BKL" }, \
- + { SSAM_SSH_TC_TAM, "TAM" }, \
- + { SSAM_SSH_TC_ACC, "ACC" }, \
- + { SSAM_SSH_TC_UFI, "UFI" }, \
- + { SSAM_SSH_TC_USC, "USC" }, \
- + { SSAM_SSH_TC_PEN, "PEN" }, \
- + { SSAM_SSH_TC_VID, "VID" }, \
- + { SSAM_SSH_TC_AUD, "AUD" }, \
- + { SSAM_SSH_TC_SMC, "SMC" }, \
- + { SSAM_SSH_TC_KPD, "KPD" }, \
- + { SSAM_SSH_TC_REG, "REG" } \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_frame_class,
- + TP_PROTO(const struct ssh_frame *frame),
- +
- + TP_ARGS(frame),
- +
- + TP_STRUCT__entry(
- + __field(u8, type)
- + __field(u8, seq)
- + __field(u16, len)
- + ),
- +
- + TP_fast_assign(
- + __entry->type = frame->type;
- + __entry->seq = frame->seq;
- + __entry->len = get_unaligned_le16(&frame->len);
- + ),
- +
- + TP_printk("ty=%s, seq=0x%02x, len=%u",
- + ssam_show_frame_type(__entry->type),
- + __entry->seq,
- + __entry->len
- + )
- +);
- +
- +#define DEFINE_SSAM_FRAME_EVENT(name) \
- + DEFINE_EVENT(ssam_frame_class, ssam_##name, \
- + TP_PROTO(const struct ssh_frame *frame), \
- + TP_ARGS(frame) \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_command_class,
- + TP_PROTO(const struct ssh_command *cmd, u16 len),
- +
- + TP_ARGS(cmd, len),
- +
- + TP_STRUCT__entry(
- + __field(u16, rqid)
- + __field(u16, len)
- + __field(u8, tc)
- + __field(u8, cid)
- + __field(u8, iid)
- + ),
- +
- + TP_fast_assign(
- + __entry->rqid = get_unaligned_le16(&cmd->rqid);
- + __entry->tc = cmd->tc;
- + __entry->cid = cmd->cid;
- + __entry->iid = cmd->iid;
- + __entry->len = len;
- + ),
- +
- + TP_printk("rqid=0x%04x, tc=%s, cid=0x%02x, iid=0x%02x, len=%u",
- + __entry->rqid,
- + ssam_show_ssh_tc(__entry->tc),
- + __entry->cid,
- + __entry->iid,
- + __entry->len
- + )
- +);
- +
- +#define DEFINE_SSAM_COMMAND_EVENT(name) \
- + DEFINE_EVENT(ssam_command_class, ssam_##name, \
- + TP_PROTO(const struct ssh_command *cmd, u16 len), \
- + TP_ARGS(cmd, len) \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_packet_class,
- + TP_PROTO(const struct ssh_packet *packet),
- +
- + TP_ARGS(packet),
- +
- + TP_STRUCT__entry(
- + __array(char, uid, SSAM_PTR_UID_LEN)
- + __field(u8, type)
- + __field(u8, priority)
- + __field(u16, length)
- + __field(unsigned long, state)
- + __field(u16, seq)
- + ),
- +
- + TP_fast_assign(
- + ssam_trace_ptr_uid(packet, __entry->uid);
- + __entry->type = packet->type;
- + __entry->priority = READ_ONCE(packet->priority);
- + __entry->length = packet->data_length;
- + __entry->state = READ_ONCE(packet->state);
- + __entry->seq = ssam_trace_get_packet_seq(packet);
- + ),
- +
- + TP_printk("uid=%s, seq=%s, ty=%s, pri=0x%02x, len=%u, sta=%s",
- + __entry->uid,
- + ssam_show_packet_seq(__entry->seq),
- + ssam_show_packet_type(__entry->type),
- + __entry->priority,
- + __entry->length,
- + ssam_show_packet_state(__entry->state)
- + )
- +);
- +
- +#define DEFINE_SSAM_PACKET_EVENT(name) \
- + DEFINE_EVENT(ssam_packet_class, ssam_##name, \
- + TP_PROTO(const struct ssh_packet *packet), \
- + TP_ARGS(packet) \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_packet_status_class,
- + TP_PROTO(const struct ssh_packet *packet, int status),
- +
- + TP_ARGS(packet, status),
- +
- + TP_STRUCT__entry(
- + __array(char, uid, SSAM_PTR_UID_LEN)
- + __field(u8, type)
- + __field(u8, priority)
- + __field(u16, length)
- + __field(unsigned long, state)
- + __field(u16, seq)
- + __field(int, status)
- + ),
- +
- + TP_fast_assign(
- + ssam_trace_ptr_uid(packet, __entry->uid);
- + __entry->type = packet->type;
- + __entry->priority = READ_ONCE(packet->priority);
- + __entry->length = packet->data_length;
- + __entry->state = READ_ONCE(packet->state);
- + __entry->seq = ssam_trace_get_packet_seq(packet);
- + __entry->status = status;
- + ),
- +
- + TP_printk("uid=%s, seq=%s, ty=%s, pri=0x%02x, len=%u, sta=%s, status=%d",
- + __entry->uid,
- + ssam_show_packet_seq(__entry->seq),
- + ssam_show_packet_type(__entry->type),
- + __entry->priority,
- + __entry->length,
- + ssam_show_packet_state(__entry->state),
- + __entry->status
- + )
- +);
- +
- +#define DEFINE_SSAM_PACKET_STATUS_EVENT(name) \
- + DEFINE_EVENT(ssam_packet_status_class, ssam_##name, \
- + TP_PROTO(const struct ssh_packet *packet, int status), \
- + TP_ARGS(packet, status) \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_request_class,
- + TP_PROTO(const struct ssh_request *request),
- +
- + TP_ARGS(request),
- +
- + TP_STRUCT__entry(
- + __array(char, uid, SSAM_PTR_UID_LEN)
- + __field(unsigned long, state)
- + __field(u32, rqid)
- + __field(u8, tc)
- + __field(u16, cid)
- + __field(u16, iid)
- + ),
- +
- + TP_fast_assign(
- + const struct ssh_packet *p = &request->packet;
- +
- + // use packet for UID so we can match requests to packets
- + ssam_trace_ptr_uid(p, __entry->uid);
- + __entry->state = READ_ONCE(request->state);
- + __entry->rqid = ssam_trace_get_request_id(p);
- + __entry->tc = ssam_trace_get_request_tc(p);
- + __entry->cid = ssam_trace_get_command_field_u8(p, cid);
- + __entry->iid = ssam_trace_get_command_field_u8(p, iid);
- + ),
- +
- + TP_printk("uid=%s, rqid=%s, ty=%s, sta=%s, tc=%s, cid=%s, iid=%s",
- + __entry->uid,
- + ssam_show_request_id(__entry->rqid),
- + ssam_show_request_type(__entry->state),
- + ssam_show_request_state(__entry->state),
- + ssam_show_ssh_tc(__entry->tc),
- + ssam_show_generic_u8_field(__entry->cid),
- + ssam_show_generic_u8_field(__entry->iid)
- + )
- +);
- +
- +#define DEFINE_SSAM_REQUEST_EVENT(name) \
- + DEFINE_EVENT(ssam_request_class, ssam_##name, \
- + TP_PROTO(const struct ssh_request *request), \
- + TP_ARGS(request) \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_request_status_class,
- + TP_PROTO(const struct ssh_request *request, int status),
- +
- + TP_ARGS(request, status),
- +
- + TP_STRUCT__entry(
- + __array(char, uid, SSAM_PTR_UID_LEN)
- + __field(unsigned long, state)
- + __field(u32, rqid)
- + __field(u8, tc)
- + __field(u16, cid)
- + __field(u16, iid)
- + __field(int, status)
- + ),
- +
- + TP_fast_assign(
- + const struct ssh_packet *p = &request->packet;
- +
- + // use packet for UID so we can match requests to packets
- + ssam_trace_ptr_uid(p, __entry->uid);
- + __entry->state = READ_ONCE(request->state);
- + __entry->rqid = ssam_trace_get_request_id(p);
- + __entry->tc = ssam_trace_get_request_tc(p);
- + __entry->cid = ssam_trace_get_command_field_u8(p, cid);
- + __entry->iid = ssam_trace_get_command_field_u8(p, iid);
- + __entry->status = status;
- + ),
- +
- + TP_printk("uid=%s, rqid=%s, ty=%s, sta=%s, tc=%s, cid=%s, iid=%s, status=%d",
- + __entry->uid,
- + ssam_show_request_id(__entry->rqid),
- + ssam_show_request_type(__entry->state),
- + ssam_show_request_state(__entry->state),
- + ssam_show_ssh_tc(__entry->tc),
- + ssam_show_generic_u8_field(__entry->cid),
- + ssam_show_generic_u8_field(__entry->iid),
- + __entry->status
- + )
- +);
- +
- +#define DEFINE_SSAM_REQUEST_STATUS_EVENT(name) \
- + DEFINE_EVENT(ssam_request_status_class, ssam_##name, \
- + TP_PROTO(const struct ssh_request *request, int status),\
- + TP_ARGS(request, status) \
- + )
- +
- +
- +DECLARE_EVENT_CLASS(ssam_generic_uint_class,
- + TP_PROTO(const char* property, unsigned int value),
- +
- + TP_ARGS(property, value),
- +
- + TP_STRUCT__entry(
- + __string(property, property)
- + __field(unsigned int, value)
- + ),
- +
- + TP_fast_assign(
- + __assign_str(property, property);
- + __entry->value = value;
- + ),
- +
- + TP_printk("%s=%u", __get_str(property), __entry->value)
- +);
- +
- +#define DEFINE_SSAM_GENERIC_UINT_EVENT(name) \
- + DEFINE_EVENT(ssam_generic_uint_class, ssam_##name, \
- + TP_PROTO(const char* property, unsigned int value), \
- + TP_ARGS(property, value) \
- + )
- +
- +
- +DEFINE_SSAM_FRAME_EVENT(rx_frame_received);
- +DEFINE_SSAM_COMMAND_EVENT(rx_response_received);
- +DEFINE_SSAM_COMMAND_EVENT(rx_event_received);
- +
- +DEFINE_SSAM_PACKET_EVENT(packet_release);
- +DEFINE_SSAM_PACKET_EVENT(packet_submit);
- +DEFINE_SSAM_PACKET_EVENT(packet_resubmit);
- +DEFINE_SSAM_PACKET_EVENT(packet_timeout);
- +DEFINE_SSAM_PACKET_EVENT(packet_cancel);
- +DEFINE_SSAM_PACKET_STATUS_EVENT(packet_complete);
- +DEFINE_SSAM_GENERIC_UINT_EVENT(ptl_timeout_reap);
- +
- +DEFINE_SSAM_REQUEST_EVENT(request_submit);
- +DEFINE_SSAM_REQUEST_EVENT(request_timeout);
- +DEFINE_SSAM_REQUEST_EVENT(request_cancel);
- +DEFINE_SSAM_REQUEST_STATUS_EVENT(request_complete);
- +DEFINE_SSAM_GENERIC_UINT_EVENT(rtl_timeout_reap);
- +
- +DEFINE_SSAM_PACKET_EVENT(ei_tx_drop_ack_packet);
- +DEFINE_SSAM_PACKET_EVENT(ei_tx_drop_nak_packet);
- +DEFINE_SSAM_PACKET_EVENT(ei_tx_drop_dsq_packet);
- +DEFINE_SSAM_PACKET_STATUS_EVENT(ei_tx_fail_write);
- +DEFINE_SSAM_PACKET_EVENT(ei_tx_corrupt_data);
- +DEFINE_SSAM_GENERIC_UINT_EVENT(ei_rx_corrupt_syn);
- +DEFINE_SSAM_FRAME_EVENT(ei_rx_corrupt_data);
- +DEFINE_SSAM_REQUEST_EVENT(ei_rx_drop_response);
- +
- +#endif /* _SURFACE_SAM_SSH_TRACE_H */
- +
- +/* This part must be outside protection */
- +#undef TRACE_INCLUDE_PATH
- +#undef TRACE_INCLUDE_FILE
- +
- +#define TRACE_INCLUDE_PATH .
- +#define TRACE_INCLUDE_FILE surface_sam_ssh_trace
- +
- +#include <trace/define_trace.h>
- diff --git a/drivers/platform/x86/surface_sam/surface_sam_vhf.c b/drivers/platform/x86/surface_sam/surface_sam_vhf.c
- new file mode 100644
- index 000000000000..984035c55d63
- --- /dev/null
- +++ b/drivers/platform/x86/surface_sam/surface_sam_vhf.c
- @@ -0,0 +1,261 @@
- +// SPDX-License-Identifier: GPL-2.0-or-later
- +/*
- + * Virtual HID Framework (VHF) driver for input events via SAM.
- + * Used for keyboard input events on the Surface Laptops.
- + */
- +
- +#include <linux/acpi.h>
- +#include <linux/hid.h>
- +#include <linux/input.h>
- +#include <linux/platform_device.h>
- +#include <linux/types.h>
- +
- +#include "surface_sam_ssh.h"
- +
- +
- +#define USB_VENDOR_ID_MICROSOFT 0x045e
- +#define USB_DEVICE_ID_MS_VHF 0xf001
- +
- +#define VHF_INPUT_NAME "Microsoft Virtual HID Framework Device"
- +
- +
- +struct vhf_drvdata {
- + struct platform_device *dev;
- + struct hid_device *hid;
- + struct ssam_event_notifier notif;
- +};
- +
- +
- +/*
- + * These report descriptors have been extracted from a Surface Book 2.
- + * They seems to be similar enough to be usable on the Surface Laptop.
- + */
- +static const u8 vhf_hid_desc[] = {
- + // keyboard descriptor (event command ID 0x03)
- + 0x05, 0x01, /* Usage Page (Desktop), */
- + 0x09, 0x06, /* Usage (Keyboard), */
- + 0xA1, 0x01, /* Collection (Application), */
- + 0x85, 0x01, /* Report ID (1), */
- + 0x15, 0x00, /* Logical Minimum (0), */
- + 0x25, 0x01, /* Logical Maximum (1), */
- + 0x75, 0x01, /* Report Size (1), */
- + 0x95, 0x08, /* Report Count (8), */
- + 0x05, 0x07, /* Usage Page (Keyboard), */
- + 0x19, 0xE0, /* Usage Minimum (KB Leftcontrol), */
- + 0x29, 0xE7, /* Usage Maximum (KB Right GUI), */
- + 0x81, 0x02, /* Input (Variable), */
- + 0x75, 0x08, /* Report Size (8), */
- + 0x95, 0x0A, /* Report Count (10), */
- + 0x19, 0x00, /* Usage Minimum (None), */
- + 0x29, 0x91, /* Usage Maximum (KB LANG2), */
- + 0x26, 0xFF, 0x00, /* Logical Maximum (255), */
- + 0x81, 0x00, /* Input, */
- + 0x05, 0x0C, /* Usage Page (Consumer), */
- + 0x0A, 0xC0, 0x02, /* Usage (02C0h), */
- + 0xA1, 0x02, /* Collection (Logical), */
- + 0x1A, 0xC1, 0x02, /* Usage Minimum (02C1h), */
- + 0x2A, 0xC6, 0x02, /* Usage Maximum (02C6h), */
- + 0x95, 0x06, /* Report Count (6), */
- + 0xB1, 0x03, /* Feature (Constant, Variable), */
- + 0xC0, /* End Collection, */
- + 0x05, 0x08, /* Usage Page (LED), */
- + 0x19, 0x01, /* Usage Minimum (01h), */
- + 0x29, 0x03, /* Usage Maximum (03h), */
- + 0x75, 0x01, /* Report Size (1), */
- + 0x95, 0x03, /* Report Count (3), */
- + 0x25, 0x01, /* Logical Maximum (1), */
- + 0x91, 0x02, /* Output (Variable), */
- + 0x95, 0x05, /* Report Count (5), */
- + 0x91, 0x01, /* Output (Constant), */
- + 0xC0, /* End Collection, */
- +
- + // media key descriptor (event command ID 0x04)
- + 0x05, 0x0C, /* Usage Page (Consumer), */
- + 0x09, 0x01, /* Usage (Consumer Control), */
- + 0xA1, 0x01, /* Collection (Application), */
- + 0x85, 0x03, /* Report ID (3), */
- + 0x75, 0x10, /* Report Size (16), */
- + 0x15, 0x00, /* Logical Minimum (0), */
- + 0x26, 0xFF, 0x03, /* Logical Maximum (1023), */
- + 0x19, 0x00, /* Usage Minimum (00h), */
- + 0x2A, 0xFF, 0x03, /* Usage Maximum (03FFh), */
- + 0x81, 0x00, /* Input, */
- + 0xC0, /* End Collection, */
- +};
- +
- +
- +static int vhf_hid_start(struct hid_device *hid)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- + return 0;
- +}
- +
- +static void vhf_hid_stop(struct hid_device *hid)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- +}
- +
- +static int vhf_hid_open(struct hid_device *hid)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- + return 0;
- +}
- +
- +static void vhf_hid_close(struct hid_device *hid)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- +}
- +
- +static int vhf_hid_parse(struct hid_device *hid)
- +{
- + return hid_parse_report(hid, (u8 *)vhf_hid_desc, ARRAY_SIZE(vhf_hid_desc));
- +}
- +
- +static int vhf_hid_raw_request(struct hid_device *hid, unsigned char reportnum,
- + u8 *buf, size_t len, unsigned char rtype,
- + int reqtype)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- + return 0;
- +}
- +
- +static int vhf_hid_output_report(struct hid_device *hid, u8 *buf, size_t len)
- +{
- + hid_dbg(hid, "%s\n", __func__);
- + print_hex_dump_debug("report:", DUMP_PREFIX_OFFSET, 16, 1, buf, len, false);
- +
- + return len;
- +}
- +
- +static struct hid_ll_driver vhf_hid_ll_driver = {
- + .start = vhf_hid_start,
- + .stop = vhf_hid_stop,
- + .open = vhf_hid_open,
- + .close = vhf_hid_close,
- + .parse = vhf_hid_parse,
- + .raw_request = vhf_hid_raw_request,
- + .output_report = vhf_hid_output_report,
- +};
- +
- +
- +static struct hid_device *vhf_create_hid_device(struct platform_device *pdev)
- +{
- + struct hid_device *hid;
- +
- + hid = hid_allocate_device();
- + if (IS_ERR(hid))
- + return hid;
- +
- + hid->dev.parent = &pdev->dev;
- +
- + hid->bus = BUS_VIRTUAL;
- + hid->vendor = USB_VENDOR_ID_MICROSOFT;
- + hid->product = USB_DEVICE_ID_MS_VHF;
- +
- + hid->ll_driver = &vhf_hid_ll_driver;
- +
- + sprintf(hid->name, "%s", VHF_INPUT_NAME);
- +
- + return hid;
- +}
- +
- +static u32 vhf_event_handler(struct ssam_notifier_block *nb, const struct ssam_event *event)
- +{
- + struct vhf_drvdata *drvdata = container_of(nb, struct vhf_drvdata, notif.base);
- + int status;
- +
- + if (event->target_category != 0x08)
- + return 0;
- +
- + if (event->command_id == 0x03 || event->command_id == 0x04) {
- + status = hid_input_report(drvdata->hid, HID_INPUT_REPORT, (u8 *)&event->data[0], event->length, 1);
- + return ssam_notifier_from_errno(status) | SSAM_NOTIF_HANDLED;
- + }
- +
- + return 0;
- +}
- +
- +static int surface_sam_vhf_probe(struct platform_device *pdev)
- +{
- + struct vhf_drvdata *drvdata;
- + struct hid_device *hid;
- + int status;
- +
- + // add device link to EC
- + status = surface_sam_ssh_consumer_register(&pdev->dev);
- + if (status)
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- +
- + drvdata = kzalloc(sizeof(struct vhf_drvdata), GFP_KERNEL);
- + if (!drvdata)
- + return -ENOMEM;
- +
- + hid = vhf_create_hid_device(pdev);
- + if (IS_ERR(hid)) {
- + status = PTR_ERR(hid);
- + goto err_probe_hid;
- + }
- +
- + status = hid_add_device(hid);
- + if (status)
- + goto err_add_hid;
- +
- + drvdata->dev = pdev;
- + drvdata->hid = hid;
- +
- + drvdata->notif.base.priority = 1;
- + drvdata->notif.base.fn = vhf_event_handler;
- + drvdata->notif.event.reg = SSAM_EVENT_REGISTRY_SAM;
- + drvdata->notif.event.id.target_category = SSAM_SSH_TC_KBD;
- + drvdata->notif.event.id.instance = 0;
- + drvdata->notif.event.flags = 0;
- +
- + platform_set_drvdata(pdev, drvdata);
- +
- + status = surface_sam_ssh_notifier_register(&drvdata->notif);
- + if (status)
- + goto err_add_hid;
- +
- + return 0;
- +
- +err_add_hid:
- + hid_destroy_device(hid);
- + platform_set_drvdata(pdev, NULL);
- +err_probe_hid:
- + kfree(drvdata);
- + return status;
- +}
- +
- +static int surface_sam_vhf_remove(struct platform_device *pdev)
- +{
- + struct vhf_drvdata *drvdata = platform_get_drvdata(pdev);
- +
- + surface_sam_ssh_notifier_unregister(&drvdata->notif);
- + hid_destroy_device(drvdata->hid);
- + kfree(drvdata);
- +
- + platform_set_drvdata(pdev, NULL);
- + return 0;
- +}
- +
- +
- +static const struct acpi_device_id surface_sam_vhf_match[] = {
- + { "MSHW0096" },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surface_sam_vhf_match);
- +
- +static struct platform_driver surface_sam_vhf = {
- + .probe = surface_sam_vhf_probe,
- + .remove = surface_sam_vhf_remove,
- + .driver = {
- + .name = "surface_sam_vhf",
- + .acpi_match_table = surface_sam_vhf_match,
- + .probe_type = PROBE_PREFER_ASYNCHRONOUS,
- + },
- +};
- +module_platform_driver(surface_sam_vhf);
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("Virtual HID Framework Driver for 5th Generation Surface Devices");
- +MODULE_LICENSE("GPL");
- --
- 2.27.0
|