123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350 |
- From fe620408edbe977514da914279f549e7d8fb036a Mon Sep 17 00:00:00 2001
- From: Maximilian Luz <luzmaximilian@gmail.com>
- Date: Wed, 2 Oct 2019 22:36:03 +0200
- Subject: [PATCH 01/12] surface-acpi
- ---
- drivers/acpi/acpica/dsopcode.c | 2 +-
- drivers/acpi/acpica/exfield.c | 12 +-
- drivers/platform/x86/Kconfig | 97 +
- drivers/platform/x86/Makefile | 1 +
- drivers/platform/x86/surface_acpi.c | 4010 +++++++++++++++++++++++++++
- drivers/tty/serdev/core.c | 111 +-
- 6 files changed, 4217 insertions(+), 16 deletions(-)
- create mode 100644 drivers/platform/x86/surface_acpi.c
- diff --git a/drivers/acpi/acpica/dsopcode.c b/drivers/acpi/acpica/dsopcode.c
- index 10f32b62608e..7b2a4987f050 100644
- --- a/drivers/acpi/acpica/dsopcode.c
- +++ b/drivers/acpi/acpica/dsopcode.c
- @@ -123,7 +123,7 @@ acpi_ds_init_buffer_field(u16 aml_opcode,
-
- /* Offset is in bits, count is in bits */
-
- - field_flags = AML_FIELD_ACCESS_BYTE;
- + field_flags = AML_FIELD_ACCESS_BUFFER;
- bit_offset = offset;
- bit_count = (u32) length_desc->integer.value;
-
- diff --git a/drivers/acpi/acpica/exfield.c b/drivers/acpi/acpica/exfield.c
- index d3d2dbfba680..0b7f617a6e9b 100644
- --- a/drivers/acpi/acpica/exfield.c
- +++ b/drivers/acpi/acpica/exfield.c
- @@ -109,6 +109,7 @@ acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
- union acpi_operand_object *buffer_desc;
- void *buffer;
- u32 buffer_length;
- + u8 field_flags;
-
- ACPI_FUNCTION_TRACE_PTR(ex_read_data_from_field, obj_desc);
-
- @@ -157,11 +158,16 @@ acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
- * Note: Field.length is in bits.
- */
- buffer_length =
- - (acpi_size)ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);
- + (acpi_size)ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length);
- + field_flags = obj_desc->common_field.field_flags;
-
- - if (buffer_length > acpi_gbl_integer_byte_width) {
- + if (buffer_length > acpi_gbl_integer_byte_width ||
- + (field_flags & AML_FIELD_ACCESS_TYPE_MASK) == AML_FIELD_ACCESS_BUFFER) {
-
- - /* Field is too large for an Integer, create a Buffer instead */
- + /*
- + * Field is either too large for an Integer, or a actually of type
- + * buffer, so create a Buffer.
- + */
-
- buffer_desc = acpi_ut_create_buffer_object(buffer_length);
- if (!buffer_desc) {
- diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
- index 7c2fd1d72e18..c00cb830914a 100644
- --- a/drivers/platform/x86/Kconfig
- +++ b/drivers/platform/x86/Kconfig
- @@ -623,6 +623,103 @@ config THINKPAD_ACPI_HOTKEY_POLL
- If you are not sure, say Y here. The driver enables polling only if
- it is strictly necessary to do so.
-
- +config SURFACE_ACPI
- + depends on ACPI
- + tristate "Microsoft Surface ACPI/Platform Drivers"
- + ---help---
- + ACPI and platform drivers for Microsoft Surface devices.
- +
- +config SURFACE_ACPI_SSH
- + bool "Surface Serial Hub Driver"
- + depends on SURFACE_ACPI
- + depends on X86_INTEL_LPSS
- + depends on SERIAL_8250_DW
- + depends on SERIAL_8250_DMA
- + depends on SERIAL_DEV_CTRL_TTYPORT
- + select CRC_CCITT
- + default y
- + ---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 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_ACPI_SSH_DEBUG_DEVICE
- + bool "Surface Serial Hub Debug Device"
- + depends on SURFACE_ACPI_SSH
- + 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_ACPI_SAN
- + bool "Surface ACPI Notify Driver"
- + depends on SURFACE_ACPI_SSH
- + default y
- + ---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 Y here.
- +
- +config SURFACE_ACPI_VHF
- + bool "Surface Virtual HID Framework Driver"
- + depends on SURFACE_ACPI_SSH
- + depends on HID
- + default y
- + ---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 the Surface Laptop (1 and newer) keyboard.
- +
- + If you are not sure, say Y here.
- +
- +config SURFACE_ACPI_DTX
- + bool "Surface Detachment System (DTX) Driver"
- + depends on SURFACE_ACPI_SSH
- + depends on INPUT
- + default y
- + ---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 Y here.
- +
- +config SURFACE_ACPI_SID
- + bool "Surface Platform Integration Driver"
- + depends on SURFACE_ACPI_SSH
- + default y
- + ---help---
- + Surface Platform Integration Driver for the Microsoft Surface Devices.
- + Currently only supports the Surface Book 2. This driver provides suport
- + for setting performance-modes via the perf_mode sysfs attribute.
- + 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 Y here.
- +
- config SENSORS_HDAPS
- tristate "Thinkpad Hard Drive Active Protection System (hdaps)"
- depends on INPUT
- diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile
- index 87b0069bd781..8b12c19dc165 100644
- --- a/drivers/platform/x86/Makefile
- +++ b/drivers/platform/x86/Makefile
- @@ -39,6 +39,7 @@ obj-$(CONFIG_TC1100_WMI) += tc1100-wmi.o
- obj-$(CONFIG_SONY_LAPTOP) += sony-laptop.o
- obj-$(CONFIG_IDEAPAD_LAPTOP) += ideapad-laptop.o
- obj-$(CONFIG_THINKPAD_ACPI) += thinkpad_acpi.o
- +obj-$(CONFIG_SURFACE_ACPI) += surface_acpi.o
- obj-$(CONFIG_SENSORS_HDAPS) += hdaps.o
- obj-$(CONFIG_FUJITSU_LAPTOP) += fujitsu-laptop.o
- obj-$(CONFIG_FUJITSU_TABLET) += fujitsu-tablet.o
- diff --git a/drivers/platform/x86/surface_acpi.c b/drivers/platform/x86/surface_acpi.c
- new file mode 100644
- index 000000000000..5dbf48a3d9b3
- --- /dev/null
- +++ b/drivers/platform/x86/surface_acpi.c
- @@ -0,0 +1,4010 @@
- +#include <asm/unaligned.h>
- +#include <linux/acpi.h>
- +#include <linux/completion.h>
- +#include <linux/crc-ccitt.h>
- +#include <linux/delay.h>
- +#include <linux/device.h>
- +#include <linux/dmaengine.h>
- +#include <linux/dmi.h>
- +#include <linux/fs.h>
- +#include <linux/hid.h>
- +#include <linux/input.h>
- +#include <linux/ioctl.h>
- +#include <linux/jiffies.h>
- +#include <linux/kernel.h>
- +#include <linux/kfifo.h>
- +#include <linux/miscdevice.h>
- +#include <linux/module.h>
- +#include <linux/moduleparam.h>
- +#include <linux/mutex.h>
- +#include <linux/platform_device.h>
- +#include <linux/pm.h>
- +#include <linux/poll.h>
- +#include <linux/rculist.h>
- +#include <linux/refcount.h>
- +#include <linux/serdev.h>
- +#include <linux/spinlock.h>
- +#include <linux/sysfs.h>
- +#include <linux/types.h>
- +#include <linux/workqueue.h>
- +
- +
- +#define USB_VENDOR_ID_MICROSOFT 0x045e
- +#define USB_DEVICE_ID_MS_VHF 0xf001
- +#define USB_DEVICE_ID_MS_SURFACE_BASE_2_INTEGRATION 0x0922
- +
- +#define SG5_PARAM_PERM (S_IRUGO | S_IWUSR)
- +
- +
- +/*************************************************************************
- + * Surface Serial Hub driver (cross-driver interface)
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_SSH
- +
- +/*
- + * Maximum request payload size in bytes.
- + * Value based on ACPI (255 bytes minus header/status bytes).
- + */
- +#define SURFACEGEN5_MAX_RQST_PAYLOAD (255 - 10)
- +
- +/*
- + * Maximum response payload size in bytes.
- + * Value based on ACPI (255 bytes minus header/status bytes).
- + */
- +#define SURFACEGEN5_MAX_RQST_RESPONSE (255 - 4)
- +
- +#define SURFACEGEN5_RQID_EVENT_BITS 5
- +
- +#define SURFACEGEN5_EVENT_IMMEDIATE ((unsigned long) -1)
- +
- +
- +struct surfacegen5_buf {
- + u8 cap;
- + u8 len;
- + u8 *data;
- +};
- +
- +struct surfacegen5_rqst {
- + u8 tc;
- + u8 iid;
- + u8 cid;
- + u8 snc;
- + u8 cdl;
- + u8 *pld;
- +};
- +
- +struct surfacegen5_event {
- + u16 rqid;
- + u8 tc;
- + u8 iid;
- + u8 cid;
- + u8 len;
- + u8 *pld;
- +};
- +
- +
- +typedef int (*surfacegen5_ec_event_handler_fn)(struct surfacegen5_event *event, void *data);
- +typedef unsigned long (*surfacegen5_ec_event_handler_delay)(struct surfacegen5_event *event, void *data);
- +
- +int surfacegen5_ec_consumer_register(struct device *consumer);
- +
- +int surfacegen5_ec_rqst(const struct surfacegen5_rqst *rqst, struct surfacegen5_buf *result);
- +
- +int surfacegen5_ec_enable_event_source(u8 tc, u8 unknown, u16 rqid);
- +int surfacegen5_ec_disable_event_source(u8 tc, u8 unknown, u16 rqid);
- +int surfacegen5_ec_remove_event_handler(u16 rqid);
- +int surfacegen5_ec_set_event_handler(u16 rqid, surfacegen5_ec_event_handler_fn fn, void *data);
- +int surfacegen5_ec_set_delayed_event_handler(u16 rqid,
- + surfacegen5_ec_event_handler_fn fn,
- + surfacegen5_ec_event_handler_delay delay, void *data);
- +
- +#endif /* CONFIG_SURFACE_ACPI_SSH */
- +
- +
- +/*************************************************************************
- + * Surface Serial Hub Debug Device (cross-driver interface)
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_SSH
- +
- +int surfacegen5_ssh_sysfs_register(struct device *dev);
- +void surfacegen5_ssh_sysfs_unregister(struct device *dev);
- +
- +#endif /* CONFIG_SURFACE_ACPI_SSH */
- +
- +
- +/*************************************************************************
- + * Surface Serial Hub driver (private implementation)
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_SSH
- +
- +#define SG5_RQST_TAG_FULL "surfacegen5_ec_rqst: "
- +#define SG5_RQST_TAG "rqst: "
- +#define SG5_EVENT_TAG "event: "
- +#define SG5_RECV_TAG "recv: "
- +
- +#define SG5_SUPPORTED_FLOW_CONTROL_MASK (~((u8) ACPI_UART_FLOW_CONTROL_HW))
- +
- +#define SG5_BYTELEN_SYNC 2
- +#define SG5_BYTELEN_TERM 2
- +#define SG5_BYTELEN_CRC 2
- +#define SG5_BYTELEN_CTRL 4 // command-header, ACK, or RETRY
- +#define SG5_BYTELEN_CMDFRAME 8 // without payload
- +
- +#define SG5_MAX_WRITE ( \
- + SG5_BYTELEN_SYNC \
- + + SG5_BYTELEN_CTRL \
- + + SG5_BYTELEN_CRC \
- + + SG5_BYTELEN_CMDFRAME \
- + + SURFACEGEN5_MAX_RQST_PAYLOAD \
- + + SG5_BYTELEN_CRC \
- +)
- +
- +#define SG5_MSG_LEN_CTRL ( \
- + SG5_BYTELEN_SYNC \
- + + SG5_BYTELEN_CTRL \
- + + SG5_BYTELEN_CRC \
- + + SG5_BYTELEN_TERM \
- +)
- +
- +#define SG5_MSG_LEN_CMD_BASE ( \
- + SG5_BYTELEN_SYNC \
- + + SG5_BYTELEN_CTRL \
- + + SG5_BYTELEN_CRC \
- + + SG5_BYTELEN_CRC \
- +) // without payload and command-frame
- +
- +#define SG5_WRITE_TIMEOUT msecs_to_jiffies(1000)
- +#define SG5_READ_TIMEOUT msecs_to_jiffies(1000)
- +#define SG5_NUM_RETRY 3
- +
- +#define SG5_WRITE_BUF_LEN SG5_MAX_WRITE
- +#define SG5_READ_BUF_LEN 512 // must be power of 2
- +#define SG5_EVAL_BUF_LEN SG5_MAX_WRITE // also works for reading
- +
- +#define SG5_FRAME_TYPE_CMD 0x80
- +#define SG5_FRAME_TYPE_ACK 0x40
- +#define SG5_FRAME_TYPE_RETRY 0x04
- +
- +#define SG5_FRAME_OFFS_CTRL SG5_BYTELEN_SYNC
- +#define SG5_FRAME_OFFS_CTRL_CRC (SG5_FRAME_OFFS_CTRL + SG5_BYTELEN_CTRL)
- +#define SG5_FRAME_OFFS_TERM (SG5_FRAME_OFFS_CTRL_CRC + SG5_BYTELEN_CRC)
- +#define SG5_FRAME_OFFS_CMD SG5_FRAME_OFFS_TERM // either TERM or CMD
- +#define SG5_FRAME_OFFS_CMD_PLD (SG5_FRAME_OFFS_CMD + SG5_BYTELEN_CMDFRAME)
- +
- +/*
- + * A note on Request IDs (RQIDs):
- + * 0x0000 is not a valid RQID
- + * 0x0001 is valid, but reserved for Surface Laptop keyboard events
- + */
- +#define SG5_NUM_EVENT_TYPES ((1 << SURFACEGEN5_RQID_EVENT_BITS) - 1)
- +
- +/*
- + * Sync: aa 55
- + * Terminate: ff ff
- + *
- + * Request Message: sync cmd-hdr crc(cmd-hdr) cmd-rqst-frame crc(cmd-rqst-frame)
- + * Ack Message: sync ack crc(ack) terminate
- + * Retry Message: sync retry crc(retry) terminate
- + * Response Message: sync cmd-hdr crc(cmd-hdr) cmd-resp-frame crc(cmd-resp-frame)
- + *
- + * Command Header: 80 LEN 00 SEQ
- + * Ack: 40 00 00 SEQ
- + * Retry: 04 00 00 00
- + * Command Request Frame: 80 RTC 01 00 RIID RQID RCID PLD
- + * Command Response Frame: 80 RTC 00 01 RIID RQID RCID PLD
- + */
- +
- +struct surfacegen5_frame_ctrl {
- + u8 type;
- + u8 len; // without crc
- + u8 pad;
- + u8 seq;
- +} __packed;
- +
- +struct surfacegen5_frame_cmd {
- + u8 type;
- + u8 tc;
- + u8 unknown1;
- + u8 unknown2;
- + u8 iid;
- + u8 rqid_lo; // id for request/response matching (low byte)
- + u8 rqid_hi; // id for request/response matching (high byte)
- + u8 cid;
- +} __packed;
- +
- +
- +enum surfacegen5_ec_state {
- + SG5_EC_UNINITIALIZED,
- + SG5_EC_INITIALIZED,
- + SG5_EC_SUSPENDED,
- +};
- +
- +struct surfacegen5_ec_counters {
- + u8 seq; // control sequence id
- + u16 rqid; // id for request/response matching
- +};
- +
- +struct surfacegen5_ec_writer {
- + u8 *data;
- + u8 *ptr;
- +} __packed;
- +
- +enum surfacegen5_ec_receiver_state {
- + SG5_RCV_DISCARD,
- + SG5_RCV_CONTROL,
- + SG5_RCV_COMMAND,
- +};
- +
- +struct surfacegen5_ec_receiver {
- + spinlock_t lock;
- + enum surfacegen5_ec_receiver_state state;
- + struct completion signal;
- + struct kfifo fifo;
- + struct {
- + bool pld;
- + u8 seq;
- + u16 rqid;
- + } expect;
- + struct {
- + u16 cap;
- + u16 len;
- + u8 *ptr;
- + } eval_buf;
- +};
- +
- +struct surfacegen5_ec_event_handler {
- + surfacegen5_ec_event_handler_fn handler;
- + surfacegen5_ec_event_handler_delay delay;
- + void *data;
- +};
- +
- +struct surfacegen5_ec_events {
- + spinlock_t lock;
- + struct workqueue_struct *queue_ack;
- + struct workqueue_struct *queue_evt;
- + struct surfacegen5_ec_event_handler handler[SG5_NUM_EVENT_TYPES];
- +};
- +
- +struct surfacegen5_ec {
- + struct mutex lock;
- + enum surfacegen5_ec_state state;
- + struct serdev_device *serdev;
- + struct surfacegen5_ec_counters counter;
- + struct surfacegen5_ec_writer writer;
- + struct surfacegen5_ec_receiver receiver;
- + struct surfacegen5_ec_events events;
- +};
- +
- +struct surfacegen5_fifo_packet {
- + u8 type; // packet type (ACK/RETRY/CMD)
- + u8 seq;
- + u8 len;
- +};
- +
- +struct surfacegen5_event_work {
- + refcount_t refcount;
- + struct surfacegen5_ec *ec;
- + struct work_struct work_ack;
- + struct delayed_work work_evt;
- + struct surfacegen5_event event;
- + u8 seq;
- +};
- +
- +
- +static struct surfacegen5_ec surfacegen5_ec = {
- + .lock = __MUTEX_INITIALIZER(surfacegen5_ec.lock),
- + .state = SG5_EC_UNINITIALIZED,
- + .serdev = NULL,
- + .counter = {
- + .seq = 0,
- + .rqid = 0,
- + },
- + .writer = {
- + .data = NULL,
- + .ptr = NULL,
- + },
- + .receiver = {
- + .lock = __SPIN_LOCK_UNLOCKED(),
- + .state = SG5_RCV_DISCARD,
- + .expect = {},
- + },
- + .events = {
- + .lock = __SPIN_LOCK_UNLOCKED(),
- + .handler = {},
- + }
- +};
- +
- +
- +static int surfacegen5_ec_rqst_unlocked(struct surfacegen5_ec *ec,
- + const struct surfacegen5_rqst *rqst,
- + struct surfacegen5_buf *result);
- +
- +
- +inline static struct surfacegen5_ec *surfacegen5_ec_acquire(void)
- +{
- + struct surfacegen5_ec *ec = &surfacegen5_ec;
- +
- + mutex_lock(&ec->lock);
- + return ec;
- +}
- +
- +inline static void surfacegen5_ec_release(struct surfacegen5_ec *ec)
- +{
- + mutex_unlock(&ec->lock);
- +}
- +
- +inline static struct surfacegen5_ec *surfacegen5_ec_acquire_init(void)
- +{
- + struct surfacegen5_ec *ec = surfacegen5_ec_acquire();
- +
- + if (ec->state == SG5_EC_UNINITIALIZED) {
- + surfacegen5_ec_release(ec);
- + return NULL;
- + }
- +
- + return ec;
- +}
- +
- +int surfacegen5_ec_consumer_register(struct device *consumer)
- +{
- + u32 flags = DL_FLAG_PM_RUNTIME | DL_FLAG_AUTOREMOVE_CONSUMER;
- + struct surfacegen5_ec *ec;
- + struct device_link *link;
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + return -ENXIO;
- + }
- +
- + link = device_link_add(consumer, &ec->serdev->dev, flags);
- + if (!link) {
- + return -EFAULT;
- + }
- +
- + surfacegen5_ec_release(ec);
- + return 0;
- +}
- +
- +
- +inline static u16 surfacegen5_rqid_to_rqst(u16 rqid) {
- + return rqid << SURFACEGEN5_RQID_EVENT_BITS;
- +}
- +
- +inline static bool surfacegen5_rqid_is_event(u16 rqid) {
- + const u16 mask = (1 << SURFACEGEN5_RQID_EVENT_BITS) - 1;
- + return rqid != 0 && (rqid | mask) == mask;
- +}
- +
- +int surfacegen5_ec_enable_event_source(u8 tc, u8 unknown, u16 rqid)
- +{
- + struct surfacegen5_ec *ec;
- +
- + u8 pld[4] = { tc, unknown, rqid & 0xff, rqid >> 8 };
- + u8 buf[1] = { 0x00 };
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = 0x01,
- + .iid = 0x00,
- + .cid = 0x0b,
- + .snc = 0x01,
- + .cdl = 0x04,
- + .pld = pld,
- + };
- +
- + struct surfacegen5_buf result = {
- + result.cap = ARRAY_SIZE(buf),
- + result.len = 0,
- + result.data = buf,
- + };
- +
- + int status;
- +
- + // only allow RQIDs that lie within event spectrum
- + if (!surfacegen5_rqid_is_event(rqid)) {
- + return -EINVAL;
- + }
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + printk(KERN_WARNING SG5_RQST_TAG_FULL "embedded controller is uninitialized\n");
- + return -ENXIO;
- + }
- +
- + if (ec->state == SG5_EC_SUSPENDED) {
- + dev_warn(&ec->serdev->dev, SG5_RQST_TAG "embedded controller is suspended\n");
- +
- + surfacegen5_ec_release(ec);
- + return -EPERM;
- + }
- +
- + status = surfacegen5_ec_rqst_unlocked(ec, &rqst, &result);
- +
- + if (buf[0] != 0x00) {
- + dev_warn(&ec->serdev->dev,
- + "unexpected result while enabling event source: 0x%02x\n",
- + buf[0]);
- + }
- +
- + surfacegen5_ec_release(ec);
- + return status;
- +
- +}
- +
- +int surfacegen5_ec_disable_event_source(u8 tc, u8 unknown, u16 rqid)
- +{
- + struct surfacegen5_ec *ec;
- +
- + u8 pld[4] = { tc, unknown, rqid & 0xff, rqid >> 8 };
- + u8 buf[1] = { 0x00 };
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = 0x01,
- + .iid = 0x00,
- + .cid = 0x0c,
- + .snc = 0x01,
- + .cdl = 0x04,
- + .pld = pld,
- + };
- +
- + struct surfacegen5_buf result = {
- + result.cap = ARRAY_SIZE(buf),
- + result.len = 0,
- + result.data = buf,
- + };
- +
- + int status;
- +
- + // only allow RQIDs that lie within event spectrum
- + if (!surfacegen5_rqid_is_event(rqid)) {
- + return -EINVAL;
- + }
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + printk(KERN_WARNING SG5_RQST_TAG_FULL "embedded controller is uninitialized\n");
- + return -ENXIO;
- + }
- +
- + if (ec->state == SG5_EC_SUSPENDED) {
- + dev_warn(&ec->serdev->dev, SG5_RQST_TAG "embedded controller is suspended\n");
- +
- + surfacegen5_ec_release(ec);
- + return -EPERM;
- + }
- +
- + status = surfacegen5_ec_rqst_unlocked(ec, &rqst, &result);
- +
- + if (buf[0] != 0x00) {
- + dev_warn(&ec->serdev->dev,
- + "unexpected result while disabling event source: 0x%02x\n",
- + buf[0]);
- + }
- +
- + surfacegen5_ec_release(ec);
- + return status;
- +}
- +
- +int surfacegen5_ec_set_delayed_event_handler(
- + u16 rqid, surfacegen5_ec_event_handler_fn fn,
- + surfacegen5_ec_event_handler_delay delay,
- + void *data)
- +{
- + struct surfacegen5_ec *ec;
- + unsigned long flags;
- +
- + if (!surfacegen5_rqid_is_event(rqid)) {
- + return -EINVAL;
- + }
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + return -ENXIO;
- + }
- +
- + spin_lock_irqsave(&ec->events.lock, flags);
- +
- + // 0 is not a valid event RQID
- + ec->events.handler[rqid - 1].handler = fn;
- + ec->events.handler[rqid - 1].delay = delay;
- + ec->events.handler[rqid - 1].data = data;
- +
- + spin_unlock_irqrestore(&ec->events.lock, flags);
- + surfacegen5_ec_release(ec);
- +
- + return 0;
- +}
- +
- +int surfacegen5_ec_set_event_handler(
- + u16 rqid, surfacegen5_ec_event_handler_fn fn, void *data)
- +{
- + return surfacegen5_ec_set_delayed_event_handler(rqid, fn, NULL, data);
- +}
- +
- +int surfacegen5_ec_remove_event_handler(u16 rqid)
- +{
- + struct surfacegen5_ec *ec;
- + unsigned long flags;
- +
- + if (!surfacegen5_rqid_is_event(rqid)) {
- + return -EINVAL;
- + }
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + return -ENXIO;
- + }
- +
- + spin_lock_irqsave(&ec->events.lock, flags);
- +
- + // 0 is not a valid event RQID
- + ec->events.handler[rqid - 1].handler = NULL;
- + ec->events.handler[rqid - 1].delay = NULL;
- + ec->events.handler[rqid - 1].data = NULL;
- +
- + spin_unlock_irqrestore(&ec->events.lock, flags);
- + surfacegen5_ec_release(ec);
- +
- + /*
- + * Make sure that the handler is not in use any more after we've
- + * removed it.
- + */
- + flush_workqueue(ec->events.queue_evt);
- +
- + return 0;
- +}
- +
- +
- +inline static u16 surfacegen5_ssh_crc(const u8 *buf, size_t size)
- +{
- + return crc_ccitt_false(0xffff, buf, size);
- +}
- +
- +inline static void surfacegen5_ssh_write_u16(struct surfacegen5_ec_writer *writer, u16 in)
- +{
- + put_unaligned_le16(in, writer->ptr);
- + writer->ptr += 2;
- +}
- +
- +inline static void surfacegen5_ssh_write_crc(struct surfacegen5_ec_writer *writer,
- + const u8 *buf, size_t size)
- +{
- + surfacegen5_ssh_write_u16(writer, surfacegen5_ssh_crc(buf, size));
- +}
- +
- +inline static void surfacegen5_ssh_write_syn(struct surfacegen5_ec_writer *writer)
- +{
- + u8 *w = writer->ptr;
- +
- + *w++ = 0xaa;
- + *w++ = 0x55;
- +
- + writer->ptr = w;
- +}
- +
- +inline static void surfacegen5_ssh_write_ter(struct surfacegen5_ec_writer *writer)
- +{
- + u8 *w = writer->ptr;
- +
- + *w++ = 0xff;
- + *w++ = 0xff;
- +
- + writer->ptr = w;
- +}
- +
- +inline static void surfacegen5_ssh_write_buf(struct surfacegen5_ec_writer *writer,
- + u8 *in, size_t len)
- +{
- + writer->ptr = memcpy(writer->ptr, in, len) + len;
- +}
- +
- +inline static void surfacegen5_ssh_write_hdr(struct surfacegen5_ec_writer *writer,
- + const struct surfacegen5_rqst *rqst,
- + struct surfacegen5_ec *ec)
- +{
- + struct surfacegen5_frame_ctrl *hdr = (struct surfacegen5_frame_ctrl *)writer->ptr;
- + u8 *begin = writer->ptr;
- +
- + hdr->type = SG5_FRAME_TYPE_CMD;
- + hdr->len = SG5_BYTELEN_CMDFRAME + rqst->cdl; // without CRC
- + hdr->pad = 0x00;
- + hdr->seq = ec->counter.seq;
- +
- + writer->ptr += sizeof(*hdr);
- +
- + surfacegen5_ssh_write_crc(writer, begin, writer->ptr - begin);
- +}
- +
- +inline static void surfacegen5_ssh_write_cmd(struct surfacegen5_ec_writer *writer,
- + const struct surfacegen5_rqst *rqst,
- + struct surfacegen5_ec *ec)
- +{
- + struct surfacegen5_frame_cmd *cmd = (struct surfacegen5_frame_cmd *)writer->ptr;
- + u8 *begin = writer->ptr;
- +
- + u16 rqid = surfacegen5_rqid_to_rqst(ec->counter.rqid);
- + u8 rqid_lo = rqid & 0xFF;
- + u8 rqid_hi = rqid >> 8;
- +
- + cmd->type = SG5_FRAME_TYPE_CMD;
- + cmd->tc = rqst->tc;
- + cmd->unknown1 = 0x01;
- + cmd->unknown2 = 0x00;
- + cmd->iid = rqst->iid;
- + cmd->rqid_lo = rqid_lo;
- + cmd->rqid_hi = rqid_hi;
- + cmd->cid = rqst->cid;
- +
- + writer->ptr += sizeof(*cmd);
- +
- + surfacegen5_ssh_write_buf(writer, rqst->pld, rqst->cdl);
- + surfacegen5_ssh_write_crc(writer, begin, writer->ptr - begin);
- +}
- +
- +inline static void surfacegen5_ssh_write_ack(struct surfacegen5_ec_writer *writer, u8 seq)
- +{
- + struct surfacegen5_frame_ctrl *ack = (struct surfacegen5_frame_ctrl *)writer->ptr;
- + u8 *begin = writer->ptr;
- +
- + ack->type = SG5_FRAME_TYPE_ACK;
- + ack->len = 0x00;
- + ack->pad = 0x00;
- + ack->seq = seq;
- +
- + writer->ptr += sizeof(*ack);
- +
- + surfacegen5_ssh_write_crc(writer, begin, writer->ptr - begin);
- +}
- +
- +inline static void surfacegen5_ssh_writer_reset(struct surfacegen5_ec_writer *writer)
- +{
- + writer->ptr = writer->data;
- +}
- +
- +inline static int surfacegen5_ssh_writer_flush(struct surfacegen5_ec *ec)
- +{
- + struct surfacegen5_ec_writer *writer = &ec->writer;
- + struct serdev_device *serdev = ec->serdev;
- + int status;
- +
- + size_t len = writer->ptr - writer->data;
- +
- + dev_dbg(&ec->serdev->dev, "sending message\n");
- + print_hex_dump_debug("send: ", DUMP_PREFIX_OFFSET, 16, 1,
- + writer->data, writer->ptr - writer->data, false);
- +
- + status = serdev_device_write(serdev, writer->data, len, SG5_WRITE_TIMEOUT);
- + return status >= 0 ? 0 : status;
- +}
- +
- +inline static void surfacegen5_ssh_write_msg_cmd(struct surfacegen5_ec *ec,
- + const struct surfacegen5_rqst *rqst)
- +{
- + surfacegen5_ssh_writer_reset(&ec->writer);
- + surfacegen5_ssh_write_syn(&ec->writer);
- + surfacegen5_ssh_write_hdr(&ec->writer, rqst, ec);
- + surfacegen5_ssh_write_cmd(&ec->writer, rqst, ec);
- +}
- +
- +inline static void surfacegen5_ssh_write_msg_ack(struct surfacegen5_ec *ec, u8 seq)
- +{
- + surfacegen5_ssh_writer_reset(&ec->writer);
- + surfacegen5_ssh_write_syn(&ec->writer);
- + surfacegen5_ssh_write_ack(&ec->writer, seq);
- + surfacegen5_ssh_write_ter(&ec->writer);
- +}
- +
- +inline static void surfacegen5_ssh_receiver_restart(struct surfacegen5_ec *ec,
- + const struct surfacegen5_rqst *rqst)
- +{
- + unsigned long flags;
- +
- + spin_lock_irqsave(&ec->receiver.lock, flags);
- + reinit_completion(&ec->receiver.signal);
- + ec->receiver.state = SG5_RCV_CONTROL;
- + ec->receiver.expect.pld = rqst->snc;
- + ec->receiver.expect.seq = ec->counter.seq;
- + ec->receiver.expect.rqid = surfacegen5_rqid_to_rqst(ec->counter.rqid);
- + ec->receiver.eval_buf.len = 0;
- + spin_unlock_irqrestore(&ec->receiver.lock, flags);
- +}
- +
- +inline static void surfacegen5_ssh_receiver_discard(struct surfacegen5_ec *ec)
- +{
- + unsigned long flags;
- +
- + spin_lock_irqsave(&ec->receiver.lock, flags);
- + ec->receiver.state = SG5_RCV_DISCARD;
- + ec->receiver.eval_buf.len = 0;
- + kfifo_reset(&ec->receiver.fifo);
- + spin_unlock_irqrestore(&ec->receiver.lock, flags);
- +}
- +
- +static int surfacegen5_ec_rqst_unlocked(struct surfacegen5_ec *ec,
- + const struct surfacegen5_rqst *rqst,
- + struct surfacegen5_buf *result)
- +{
- + struct device *dev = &ec->serdev->dev;
- + struct surfacegen5_fifo_packet packet = {};
- + int status;
- + int try;
- + unsigned int rem;
- +
- + if (rqst->cdl > SURFACEGEN5_MAX_RQST_PAYLOAD) {
- + dev_err(dev, SG5_RQST_TAG "request payload too large\n");
- + return -EINVAL;
- + }
- +
- + // write command in buffer, we may need it multiple times
- + surfacegen5_ssh_write_msg_cmd(ec, rqst);
- + surfacegen5_ssh_receiver_restart(ec, rqst);
- +
- + // send command, try to get an ack response
- + for (try = 0; try < SG5_NUM_RETRY; try++) {
- + status = surfacegen5_ssh_writer_flush(ec);
- + if (status) {
- + goto ec_rqst_out;
- + }
- +
- + rem = wait_for_completion_timeout(&ec->receiver.signal, SG5_READ_TIMEOUT);
- + if (rem) {
- + // completion assures valid packet, thus ignore returned length
- + (void) !kfifo_out(&ec->receiver.fifo, &packet, sizeof(packet));
- +
- + if (packet.type == SG5_FRAME_TYPE_ACK) {
- + break;
- + }
- + }
- + }
- +
- + // check if we ran out of tries?
- + if (try >= SG5_NUM_RETRY) {
- + dev_err(dev, SG5_RQST_TAG "communication failed %d times, giving up\n", try);
- + status = -EIO;
- + goto ec_rqst_out;
- + }
- +
- + ec->counter.seq += 1;
- + ec->counter.rqid += 1;
- +
- + // get command response/payload
- + if (rqst->snc && result) {
- + rem = wait_for_completion_timeout(&ec->receiver.signal, SG5_READ_TIMEOUT);
- + if (rem) {
- + // completion assures valid packet, thus ignore returned length
- + (void) !kfifo_out(&ec->receiver.fifo, &packet, sizeof(packet));
- +
- + if (result->cap < packet.len) {
- + status = -EINVAL;
- + goto ec_rqst_out;
- + }
- +
- + // completion assures valid packet, thus ignore returned length
- + (void) !kfifo_out(&ec->receiver.fifo, result->data, packet.len);
- + result->len = packet.len;
- + } else {
- + dev_err(dev, SG5_RQST_TAG "communication timed out\n");
- + status = -EIO;
- + goto ec_rqst_out;
- + }
- +
- + // send ACK
- + surfacegen5_ssh_write_msg_ack(ec, packet.seq);
- + status = surfacegen5_ssh_writer_flush(ec);
- + if (status) {
- + goto ec_rqst_out;
- + }
- + }
- +
- +ec_rqst_out:
- + surfacegen5_ssh_receiver_discard(ec);
- + return status;
- +}
- +
- +int surfacegen5_ec_rqst(const struct surfacegen5_rqst *rqst, struct surfacegen5_buf *result)
- +{
- + struct surfacegen5_ec *ec;
- + int status;
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + printk(KERN_WARNING SG5_RQST_TAG_FULL "embedded controller is uninitialized\n");
- + return -ENXIO;
- + }
- +
- + if (ec->state == SG5_EC_SUSPENDED) {
- + dev_warn(&ec->serdev->dev, SG5_RQST_TAG "embedded controller is suspended\n");
- +
- + surfacegen5_ec_release(ec);
- + return -EPERM;
- + }
- +
- + status = surfacegen5_ec_rqst_unlocked(ec, rqst, result);
- +
- + surfacegen5_ec_release(ec);
- + return status;
- +}
- +
- +
- +static int surfacegen5_ssh_ec_resume(struct surfacegen5_ec *ec)
- +{
- + u8 buf[1] = { 0x00 };
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = 0x01,
- + .iid = 0x00,
- + .cid = 0x16,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surfacegen5_buf result = {
- + result.cap = ARRAY_SIZE(buf),
- + result.len = 0,
- + result.data = buf,
- + };
- +
- + int status = surfacegen5_ec_rqst_unlocked(ec, &rqst, &result);
- + if (status) {
- + return status;
- + }
- +
- + if (buf[0] != 0x00) {
- + dev_warn(&ec->serdev->dev,
- + "unexpected result while trying to resume EC: 0x%02x\n",
- + buf[0]);
- + }
- +
- + return 0;
- +}
- +
- +static int surfacegen5_ssh_ec_suspend(struct surfacegen5_ec *ec)
- +{
- + u8 buf[1] = { 0x00 };
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = 0x01,
- + .iid = 0x00,
- + .cid = 0x15,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surfacegen5_buf result = {
- + result.cap = ARRAY_SIZE(buf),
- + result.len = 0,
- + result.data = buf,
- + };
- +
- + int status = surfacegen5_ec_rqst_unlocked(ec, &rqst, &result);
- + if (status) {
- + return status;
- + }
- +
- + if (buf[0] != 0x00) {
- + dev_warn(&ec->serdev->dev,
- + "unexpected result while trying to suspend EC: 0x%02x\n",
- + buf[0]);
- + }
- +
- + return 0;
- +}
- +
- +
- +inline static bool surfacegen5_ssh_is_valid_syn(const u8 *ptr)
- +{
- + return ptr[0] == 0xaa && ptr[1] == 0x55;
- +}
- +
- +inline static bool surfacegen5_ssh_is_valid_ter(const u8 *ptr)
- +{
- + return ptr[0] == 0xff && ptr[1] == 0xff;
- +}
- +
- +inline static bool surfacegen5_ssh_is_valid_crc(const u8 *begin, const u8 *end)
- +{
- + u16 crc = surfacegen5_ssh_crc(begin, end - begin);
- + return (end[0] == (crc & 0xff)) && (end[1] == (crc >> 8));
- +}
- +
- +
- +static int surfacegen5_ssh_send_ack(struct surfacegen5_ec *ec, u8 seq)
- +{
- + int status;
- + u8 buf[SG5_MSG_LEN_CTRL];
- + u16 crc;
- +
- + buf[0] = 0xaa;
- + buf[1] = 0x55;
- + buf[2] = 0x40;
- + buf[3] = 0x00;
- + buf[4] = 0x00;
- + buf[5] = seq;
- +
- + crc = surfacegen5_ssh_crc(buf + SG5_FRAME_OFFS_CTRL, SG5_BYTELEN_CTRL);
- + buf[6] = crc & 0xff;
- + buf[7] = crc >> 8;
- +
- + buf[8] = 0xff;
- + buf[9] = 0xff;
- +
- + dev_dbg(&ec->serdev->dev, "sending message\n");
- + print_hex_dump_debug("send: ", DUMP_PREFIX_OFFSET, 16, 1,
- + buf, SG5_MSG_LEN_CTRL, false);
- +
- + status = serdev_device_write(ec->serdev, buf, SG5_MSG_LEN_CTRL, SG5_WRITE_TIMEOUT);
- + return status >= 0 ? 0 : status;
- +}
- +
- +static void surfacegen5_event_work_ack_handler(struct work_struct *_work)
- +{
- + struct surfacegen5_event_work *work;
- + struct surfacegen5_event *event;
- + struct surfacegen5_ec *ec;
- + struct device *dev;
- + int status;
- +
- + work = container_of(_work, struct surfacegen5_event_work, work_ack);
- + event = &work->event;
- + ec = work->ec;
- + dev = &ec->serdev->dev;
- +
- + // make sure we load a fresh ec state
- + smp_mb();
- +
- + if (ec->state == SG5_EC_INITIALIZED) {
- + status = surfacegen5_ssh_send_ack(ec, work->seq);
- + if (status) {
- + dev_err(dev, SG5_EVENT_TAG "failed to send ACK: %d\n", status);
- + }
- + }
- +
- + if (refcount_dec_and_test(&work->refcount)) {
- + kfree(work);
- + }
- +}
- +
- +static void surfacegen5_event_work_evt_handler(struct work_struct *_work)
- +{
- + struct delayed_work *dwork = (struct delayed_work *)_work;
- + struct surfacegen5_event_work *work;
- + struct surfacegen5_event *event;
- + struct surfacegen5_ec *ec;
- + struct device *dev;
- + unsigned long flags;
- +
- + surfacegen5_ec_event_handler_fn handler;
- + void *handler_data;
- +
- + int status = 0;
- +
- + work = container_of(dwork, struct surfacegen5_event_work, work_evt);
- + event = &work->event;
- + ec = work->ec;
- + dev = &ec->serdev->dev;
- +
- + spin_lock_irqsave(&ec->events.lock, flags);
- + handler = ec->events.handler[event->rqid - 1].handler;
- + handler_data = ec->events.handler[event->rqid - 1].data;
- + spin_unlock_irqrestore(&ec->events.lock, flags);
- +
- + /*
- + * During handler removal or driver release, we ensure every event gets
- + * handled before return of that function. Thus a handler obtained here is
- + * guaranteed to be valid at least until this function returns.
- + */
- +
- + if (handler) {
- + status = handler(event, handler_data);
- + } else {
- + dev_warn(dev, SG5_EVENT_TAG "unhandled event (rqid: %04x)\n", event->rqid);
- + }
- +
- + if (status) {
- + dev_err(dev, SG5_EVENT_TAG "error handling event: %d\n", status);
- + }
- +
- + if (refcount_dec_and_test(&work->refcount)) {
- + kfree(work);
- + }
- +}
- +
- +static void surfacegen5_ssh_handle_event(struct surfacegen5_ec *ec, const u8 *buf)
- +{
- + struct device *dev = &ec->serdev->dev;
- + const struct surfacegen5_frame_ctrl *ctrl;
- + const struct surfacegen5_frame_cmd *cmd;
- + struct surfacegen5_event_work *work;
- + unsigned long flags;
- + u16 pld_len;
- +
- + surfacegen5_ec_event_handler_delay delay_fn;
- + void *handler_data;
- + unsigned long delay = 0;
- +
- + ctrl = (const struct surfacegen5_frame_ctrl *)(buf + SG5_FRAME_OFFS_CTRL);
- + cmd = (const struct surfacegen5_frame_cmd *)(buf + SG5_FRAME_OFFS_CMD);
- +
- + pld_len = ctrl->len - SG5_BYTELEN_CMDFRAME;
- +
- + work = kzalloc(sizeof(struct surfacegen5_event_work) + pld_len, GFP_ATOMIC);
- + if (!work) {
- + dev_warn(dev, SG5_EVENT_TAG "failed to allocate memory, dropping event\n");
- + return;
- + }
- +
- + refcount_set(&work->refcount, 2);
- + work->ec = ec;
- + work->seq = ctrl->seq;
- + work->event.rqid = (cmd->rqid_hi << 8) | cmd->rqid_lo;
- + work->event.tc = cmd->tc;
- + work->event.iid = cmd->iid;
- + work->event.cid = cmd->cid;
- + work->event.len = pld_len;
- + work->event.pld = ((u8*) work) + sizeof(struct surfacegen5_event_work);
- +
- + memcpy(work->event.pld, buf + SG5_FRAME_OFFS_CMD_PLD, pld_len);
- +
- + INIT_WORK(&work->work_ack, surfacegen5_event_work_ack_handler);
- + queue_work(ec->events.queue_ack, &work->work_ack);
- +
- + spin_lock_irqsave(&ec->events.lock, flags);
- + handler_data = ec->events.handler[work->event.rqid - 1].data;
- + delay_fn = ec->events.handler[work->event.rqid - 1].delay;
- + if (delay_fn) {
- + delay = delay_fn(&work->event, handler_data);
- + }
- + spin_unlock_irqrestore(&ec->events.lock, flags);
- +
- + // immediate execution for high priority events (e.g. keyboard)
- + if (delay == SURFACEGEN5_EVENT_IMMEDIATE) {
- + surfacegen5_event_work_evt_handler(&work->work_evt.work);
- + } else {
- + INIT_DELAYED_WORK(&work->work_evt, surfacegen5_event_work_evt_handler);
- + queue_delayed_work(ec->events.queue_evt, &work->work_evt, delay);
- + }
- +}
- +
- +static int surfacegen5_ssh_receive_msg_ctrl(struct surfacegen5_ec *ec,
- + const u8 *buf, size_t size)
- +{
- + struct device *dev = &ec->serdev->dev;
- + struct surfacegen5_ec_receiver *rcv = &ec->receiver;
- + const struct surfacegen5_frame_ctrl *ctrl;
- + struct surfacegen5_fifo_packet packet;
- +
- + const u8 *ctrl_begin = buf + SG5_FRAME_OFFS_CTRL;
- + const u8 *ctrl_end = buf + SG5_FRAME_OFFS_CTRL_CRC;
- +
- + ctrl = (const struct surfacegen5_frame_ctrl *)(ctrl_begin);
- +
- + // actual length check
- + if (size < SG5_MSG_LEN_CTRL) {
- + return 0; // need more bytes
- + }
- +
- + // validate TERM
- + if (!surfacegen5_ssh_is_valid_ter(buf + SG5_FRAME_OFFS_TERM)) {
- + dev_err(dev, SG5_RECV_TAG "invalid end of message\n");
- + return size; // discard everything
- + }
- +
- + // validate CRC
- + if (!surfacegen5_ssh_is_valid_crc(ctrl_begin, ctrl_end)) {
- + dev_err(dev, SG5_RECV_TAG "invalid checksum (ctrl)\n");
- + return SG5_MSG_LEN_CTRL; // only discard message
- + }
- +
- + // check if we expect the message
- + if (rcv->state != SG5_RCV_CONTROL) {
- + dev_err(dev, SG5_RECV_TAG "discarding message: ctrl not expected\n");
- + return SG5_MSG_LEN_CTRL; // discard message
- + }
- +
- + // check if it is for our request
- + if (ctrl->type == SG5_FRAME_TYPE_ACK && ctrl->seq != rcv->expect.seq) {
- + dev_err(dev, SG5_RECV_TAG "discarding message: ack does not match\n");
- + return SG5_MSG_LEN_CTRL; // discard message
- + }
- +
- + // we now have a valid & expected ACK/RETRY message
- + dev_dbg(dev, SG5_RECV_TAG "valid control message received (type: 0x%02x)\n", ctrl->type);
- +
- + packet.type = ctrl->type;
- + packet.seq = ctrl->seq;
- + packet.len = 0;
- +
- + if (kfifo_avail(&rcv->fifo) >= sizeof(packet)) {
- + kfifo_in(&rcv->fifo, (u8 *) &packet, sizeof(packet));
- +
- + } else {
- + dev_warn(dev, SG5_RECV_TAG
- + "dropping frame: not enough space in fifo (type = %d)\n",
- + SG5_FRAME_TYPE_CMD);
- +
- + return SG5_MSG_LEN_CTRL; // discard message
- + }
- +
- + // update decoder state
- + if (ctrl->type == SG5_FRAME_TYPE_ACK) {
- + rcv->state = rcv->expect.pld
- + ? SG5_RCV_COMMAND
- + : SG5_RCV_DISCARD;
- + }
- +
- + complete(&rcv->signal);
- + return SG5_MSG_LEN_CTRL; // handled message
- +}
- +
- +static int surfacegen5_ssh_receive_msg_cmd(struct surfacegen5_ec *ec,
- + const u8 *buf, size_t size)
- +{
- + struct device *dev = &ec->serdev->dev;
- + struct surfacegen5_ec_receiver *rcv = &ec->receiver;
- + const struct surfacegen5_frame_ctrl *ctrl;
- + const struct surfacegen5_frame_cmd *cmd;
- + struct surfacegen5_fifo_packet packet;
- +
- + const u8 *ctrl_begin = buf + SG5_FRAME_OFFS_CTRL;
- + const u8 *ctrl_end = buf + SG5_FRAME_OFFS_CTRL_CRC;
- + const u8 *cmd_begin = buf + SG5_FRAME_OFFS_CMD;
- + const u8 *cmd_begin_pld = buf + SG5_FRAME_OFFS_CMD_PLD;
- + const u8 *cmd_end;
- +
- + size_t msg_len;
- +
- + ctrl = (const struct surfacegen5_frame_ctrl *)(ctrl_begin);
- + cmd = (const struct surfacegen5_frame_cmd *)(cmd_begin);
- +
- + // we need at least a full control frame
- + if (size < (SG5_BYTELEN_SYNC + SG5_BYTELEN_CTRL + SG5_BYTELEN_CRC)) {
- + return 0; // need more bytes
- + }
- +
- + // validate control-frame CRC
- + if (!surfacegen5_ssh_is_valid_crc(ctrl_begin, ctrl_end)) {
- + dev_err(dev, SG5_RECV_TAG "invalid checksum (cmd-ctrl)\n");
- + /*
- + * We can't be sure here if length is valid, thus
- + * discard everything.
- + */
- + return size;
- + }
- +
- + // actual length check (ctrl->len contains command-frame but not crc)
- + msg_len = SG5_MSG_LEN_CMD_BASE + ctrl->len;
- + if (size < msg_len) {
- + return 0; // need more bytes
- + }
- +
- + cmd_end = cmd_begin + ctrl->len;
- +
- + // validate command-frame type
- + if (cmd->type != SG5_FRAME_TYPE_CMD) {
- + dev_err(dev, SG5_RECV_TAG "expected command frame type but got 0x%02x\n", cmd->type);
- + return size; // discard everything
- + }
- +
- + // validate command-frame CRC
- + if (!surfacegen5_ssh_is_valid_crc(cmd_begin, cmd_end)) {
- + dev_err(dev, SG5_RECV_TAG "invalid checksum (cmd-pld)\n");
- +
- + /*
- + * The message length is provided in the control frame. As we
- + * already validated that, we can be sure here that it's
- + * correct, so we only need to discard the message.
- + */
- + return msg_len;
- + }
- +
- + // check if we received an event notification
- + if (surfacegen5_rqid_is_event((cmd->rqid_hi << 8) | cmd->rqid_lo)) {
- + surfacegen5_ssh_handle_event(ec, buf);
- + return msg_len; // handled message
- + }
- +
- + // check if we expect the message
- + if (rcv->state != SG5_RCV_COMMAND) {
- + dev_dbg(dev, SG5_RECV_TAG "discarding message: command not expected\n");
- + return msg_len; // discard message
- + }
- +
- + // check if response is for our request
- + if (rcv->expect.rqid != (cmd->rqid_lo | (cmd->rqid_hi << 8))) {
- + dev_dbg(dev, SG5_RECV_TAG "discarding message: command not a match\n");
- + return msg_len; // discard message
- + }
- +
- + // we now have a valid & expected command message
- + dev_dbg(dev, SG5_RECV_TAG "valid command message received\n");
- +
- + packet.type = ctrl->type;
- + packet.seq = ctrl->seq;
- + packet.len = cmd_end - cmd_begin_pld;
- +
- + if (kfifo_avail(&rcv->fifo) >= sizeof(packet) + packet.len) {
- + kfifo_in(&rcv->fifo, &packet, sizeof(packet));
- + kfifo_in(&rcv->fifo, cmd_begin_pld, packet.len);
- +
- + } else {
- + dev_warn(dev, SG5_RECV_TAG
- + "dropping frame: not enough space in fifo (type = %d)\n",
- + SG5_FRAME_TYPE_CMD);
- +
- + return SG5_MSG_LEN_CTRL; // discard message
- + }
- +
- + rcv->state = SG5_RCV_DISCARD;
- +
- + complete(&rcv->signal);
- + return msg_len; // handled message
- +}
- +
- +static int surfacegen5_ssh_eval_buf(struct surfacegen5_ec *ec,
- + const u8 *buf, size_t size)
- +{
- + struct device *dev = &ec->serdev->dev;
- + struct surfacegen5_frame_ctrl *ctrl;
- +
- + // we need at least a control frame to check what to do
- + if (size < (SG5_BYTELEN_SYNC + SG5_BYTELEN_CTRL)) {
- + return 0; // need more bytes
- + }
- +
- + // make sure we're actually at the start of a new message
- + if (!surfacegen5_ssh_is_valid_syn(buf)) {
- + dev_err(dev, SG5_RECV_TAG "invalid start of message\n");
- + return size; // discard everything
- + }
- +
- + // handle individual message types seperately
- + ctrl = (struct surfacegen5_frame_ctrl *)(buf + SG5_FRAME_OFFS_CTRL);
- +
- + switch (ctrl->type) {
- + case SG5_FRAME_TYPE_ACK:
- + case SG5_FRAME_TYPE_RETRY:
- + return surfacegen5_ssh_receive_msg_ctrl(ec, buf, size);
- +
- + case SG5_FRAME_TYPE_CMD:
- + return surfacegen5_ssh_receive_msg_cmd(ec, buf, size);
- +
- + default:
- + dev_err(dev, SG5_RECV_TAG "unknown frame type 0x%02x\n", ctrl->type);
- + return size; // discard everything
- + }
- +}
- +
- +static int surfacegen5_ssh_receive_buf(struct serdev_device *serdev,
- + const unsigned char *buf, size_t size)
- +{
- + struct surfacegen5_ec *ec = serdev_device_get_drvdata(serdev);
- + struct surfacegen5_ec_receiver *rcv = &ec->receiver;
- + unsigned long flags;
- + int offs = 0;
- + int used, n;
- +
- + dev_dbg(&serdev->dev, SG5_RECV_TAG "received buffer (size: %zu)\n", size);
- + print_hex_dump_debug(SG5_RECV_TAG, DUMP_PREFIX_OFFSET, 16, 1, buf, size, false);
- +
- + /*
- + * The battery _BIX message gets a bit long, thus we have to add some
- + * additional buffering here.
- + */
- +
- + spin_lock_irqsave(&rcv->lock, flags);
- +
- + // copy to eval-buffer
- + used = min(size, (size_t)(rcv->eval_buf.cap - rcv->eval_buf.len));
- + memcpy(rcv->eval_buf.ptr + rcv->eval_buf.len, buf, used);
- + rcv->eval_buf.len += used;
- +
- + // evaluate buffer until we need more bytes or eval-buf is empty
- + while (offs < rcv->eval_buf.len) {
- + n = rcv->eval_buf.len - offs;
- + n = surfacegen5_ssh_eval_buf(ec, rcv->eval_buf.ptr + offs, n);
- + if (n <= 0) break; // need more bytes
- +
- + offs += n;
- + }
- +
- + // throw away the evaluated parts
- + rcv->eval_buf.len -= offs;
- + memmove(rcv->eval_buf.ptr, rcv->eval_buf.ptr + offs, rcv->eval_buf.len);
- +
- + spin_unlock_irqrestore(&rcv->lock, flags);
- +
- + return used;
- +}
- +
- +
- +static acpi_status
- +surfacegen5_ssh_setup_from_resource(struct acpi_resource *resource, void *context)
- +{
- + struct serdev_device *serdev = context;
- + struct acpi_resource_common_serialbus *serial;
- + struct acpi_resource_uart_serialbus *uart;
- + int status = 0;
- +
- + if (resource->type != ACPI_RESOURCE_TYPE_SERIAL_BUS) {
- + return AE_OK;
- + }
- +
- + serial = &resource->data.common_serial_bus;
- + if (serial->type != ACPI_RESOURCE_SERIAL_TYPE_UART) {
- + return AE_OK;
- + }
- +
- + uart = &resource->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 & SG5_SUPPORTED_FLOW_CONTROL_MASK) {
- + dev_warn(&serdev->dev, "unsupported flow control (value: 0x%02x)\n", uart->flow_control);
- + }
- +
- + // set RTSCTS flow control
- + serdev_device_set_flow_control(serdev, uart->flow_control & ACPI_UART_FLOW_CONTROL_HW);
- +
- + // 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, "unsupported parity (value: 0x%02x)\n", uart->parity);
- + break;
- + }
- +
- + if (status) {
- + dev_err(&serdev->dev, "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 bool surfacegen5_idma_filter(struct dma_chan *chan, void *param)
- +{
- + // see dw8250_idma_filter
- + return param == chan->device->dev;
- +}
- +
- +static int surfacegen5_ssh_check_dma(struct serdev_device *serdev)
- +{
- + struct device *dev = serdev->ctrl->dev.parent;
- + struct dma_chan *rx, *tx;
- + dma_cap_mask_t mask;
- + int status = 0;
- +
- + /*
- + * The EC UART requires DMA for proper communication. If we don't use DMA,
- + * we'll drop bytes when the system has high load, e.g. during boot. This
- + * causes some ugly behaviour, i.e. battery information (_BIX) messages
- + * failing frequently. We're making sure the required DMA channels are
- + * available here so serial8250_do_startup is able to grab them later
- + * instead of silently falling back to a non-DMA approach.
- + */
- +
- + dma_cap_zero(mask);
- + dma_cap_set(DMA_SLAVE, mask);
- +
- + rx = dma_request_slave_channel_compat(mask, surfacegen5_idma_filter, dev->parent, dev, "rx");
- + if (IS_ERR_OR_NULL(rx)) {
- + status = rx ? PTR_ERR(rx) : -EPROBE_DEFER;
- + if (status != -EPROBE_DEFER) {
- + dev_err(&serdev->dev, "sg5_dma: error requesting rx channel: %d\n", status);
- + } else {
- + dev_dbg(&serdev->dev, "sg5_dma: rx channel not found, deferring probe\n");
- + }
- + goto check_dma_out;
- + }
- +
- + tx = dma_request_slave_channel_compat(mask, surfacegen5_idma_filter, dev->parent, dev, "tx");
- + if (IS_ERR_OR_NULL(tx)) {
- + status = tx ? PTR_ERR(tx) : -EPROBE_DEFER;
- + if (status != -EPROBE_DEFER) {
- + dev_err(&serdev->dev, "sg5_dma: error requesting tx channel: %d\n", status);
- + } else {
- + dev_dbg(&serdev->dev, "sg5_dma: tx channel not found, deferring probe\n");
- + }
- + goto check_dma_release_rx;
- + }
- +
- + dma_release_channel(tx);
- +check_dma_release_rx:
- + dma_release_channel(rx);
- +check_dma_out:
- + return status;
- +}
- +
- +
- +static int surfacegen5_ssh_suspend(struct device *dev)
- +{
- + struct surfacegen5_ec *ec;
- + int status = 0;
- +
- + dev_dbg(dev, "suspending\n");
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (ec) {
- + status = surfacegen5_ssh_ec_suspend(ec);
- + if (status) {
- + dev_err(dev, "failed to suspend EC: %d\n", status);
- + }
- +
- + ec->state = SG5_EC_SUSPENDED;
- + surfacegen5_ec_release(ec);
- + }
- +
- + return status;
- +}
- +
- +static int surfacegen5_ssh_resume(struct device *dev)
- +{
- + struct surfacegen5_ec *ec;
- + int status = 0;
- +
- + dev_dbg(dev, "resuming\n");
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (ec) {
- + ec->state = SG5_EC_INITIALIZED;
- +
- + status = surfacegen5_ssh_ec_resume(ec);
- + if (status) {
- + dev_err(dev, "failed to resume EC: %d\n", status);
- + }
- +
- + surfacegen5_ec_release(ec);
- + }
- +
- + return status;
- +}
- +
- +static SIMPLE_DEV_PM_OPS(surfacegen5_ssh_pm_ops, surfacegen5_ssh_suspend, surfacegen5_ssh_resume);
- +
- +
- +static const struct serdev_device_ops surfacegen5_ssh_device_ops = {
- + .receive_buf = surfacegen5_ssh_receive_buf,
- + .write_wakeup = serdev_device_write_wakeup,
- +};
- +
- +static int surfacegen5_acpi_ssh_probe(struct serdev_device *serdev)
- +{
- + struct surfacegen5_ec *ec;
- + struct workqueue_struct *event_queue_ack;
- + struct workqueue_struct *event_queue_evt;
- + u8 *write_buf;
- + u8 *read_buf;
- + u8 *eval_buf;
- + acpi_handle *ssh = ACPI_HANDLE(&serdev->dev);
- + acpi_status status;
- +
- + dev_dbg(&serdev->dev, "probing\n");
- +
- + // ensure DMA is ready before we set up the device
- + status = surfacegen5_ssh_check_dma(serdev);
- + if (status) {
- + return status;
- + }
- +
- + // allocate buffers
- + write_buf = kzalloc(SG5_WRITE_BUF_LEN, GFP_KERNEL);
- + if (!write_buf) {
- + status = -ENOMEM;
- + goto err_probe_write_buf;
- + }
- +
- + read_buf = kzalloc(SG5_READ_BUF_LEN, GFP_KERNEL);
- + if (!read_buf) {
- + status = -ENOMEM;
- + goto err_probe_read_buf;
- + }
- +
- + eval_buf = kzalloc(SG5_EVAL_BUF_LEN, GFP_KERNEL);
- + if (!eval_buf) {
- + status = -ENOMEM;
- + goto err_probe_eval_buf;
- + }
- +
- + event_queue_ack = create_singlethread_workqueue("sg5_ackq");
- + if (!event_queue_ack) {
- + status = -ENOMEM;
- + goto err_probe_ackq;
- + }
- +
- + event_queue_evt = create_workqueue("sg5_evtq");
- + if (!event_queue_evt) {
- + status = -ENOMEM;
- + goto err_probe_evtq;
- + }
- +
- + // set up EC
- + ec = surfacegen5_ec_acquire();
- + if (ec->state != SG5_EC_UNINITIALIZED) {
- + dev_err(&serdev->dev, "embedded controller already initialized\n");
- + surfacegen5_ec_release(ec);
- +
- + status = -EBUSY;
- + goto err_probe_busy;
- + }
- +
- + ec->serdev = serdev;
- + ec->writer.data = write_buf;
- + ec->writer.ptr = write_buf;
- +
- + // initialize receiver
- + init_completion(&ec->receiver.signal);
- + kfifo_init(&ec->receiver.fifo, read_buf, SG5_READ_BUF_LEN);
- + ec->receiver.eval_buf.ptr = eval_buf;
- + ec->receiver.eval_buf.cap = SG5_EVAL_BUF_LEN;
- + ec->receiver.eval_buf.len = 0;
- +
- + // initialize event handling
- + ec->events.queue_ack = event_queue_ack;
- + ec->events.queue_evt = event_queue_evt;
- +
- + ec->state = SG5_EC_INITIALIZED;
- +
- + serdev_device_set_drvdata(serdev, ec);
- +
- + // ensure everything is properly set-up before we open the device
- + smp_mb();
- +
- + serdev_device_set_client_ops(serdev, &surfacegen5_ssh_device_ops);
- + status = serdev_device_open(serdev);
- + if (status) {
- + goto err_probe_open;
- + }
- +
- + status = acpi_walk_resources(ssh, METHOD_NAME__CRS,
- + surfacegen5_ssh_setup_from_resource, serdev);
- + if (ACPI_FAILURE(status)) {
- + goto err_probe_devinit;
- + }
- +
- + status = surfacegen5_ssh_ec_resume(ec);
- + if (status) {
- + goto err_probe_devinit;
- + }
- +
- + status = surfacegen5_ssh_sysfs_register(&serdev->dev);
- + if (status) {
- + goto err_probe_devinit;
- + }
- +
- + surfacegen5_ec_release(ec);
- +
- + acpi_walk_dep_device_list(ssh);
- +
- + return 0;
- +
- +err_probe_devinit:
- + serdev_device_close(serdev);
- +err_probe_open:
- + ec->state = SG5_EC_UNINITIALIZED;
- + serdev_device_set_drvdata(serdev, NULL);
- + surfacegen5_ec_release(ec);
- +err_probe_busy:
- + destroy_workqueue(event_queue_evt);
- +err_probe_evtq:
- + destroy_workqueue(event_queue_ack);
- +err_probe_ackq:
- + kfree(eval_buf);
- +err_probe_eval_buf:
- + kfree(read_buf);
- +err_probe_read_buf:
- + kfree(write_buf);
- +err_probe_write_buf:
- + return status;
- +}
- +
- +static void surfacegen5_acpi_ssh_remove(struct serdev_device *serdev)
- +{
- + struct surfacegen5_ec *ec;
- + unsigned long flags;
- + int status;
- +
- + ec = surfacegen5_ec_acquire_init();
- + if (!ec) {
- + return;
- + }
- +
- + surfacegen5_ssh_sysfs_unregister(&serdev->dev);
- +
- + // suspend EC and disable events
- + status = surfacegen5_ssh_ec_suspend(ec);
- + if (status) {
- + dev_err(&serdev->dev, "failed to suspend EC: %d\n", status);
- + }
- +
- + // make sure all events (received up to now) have been properly handled
- + flush_workqueue(ec->events.queue_ack);
- + flush_workqueue(ec->events.queue_evt);
- +
- + // remove event handlers
- + spin_lock_irqsave(&ec->events.lock, flags);
- + memset(ec->events.handler, 0,
- + sizeof(struct surfacegen5_ec_event_handler)
- + * SG5_NUM_EVENT_TYPES);
- + spin_unlock_irqrestore(&ec->events.lock, flags);
- +
- + // set device to deinitialized state
- + ec->state = SG5_EC_UNINITIALIZED;
- + ec->serdev = NULL;
- +
- + // ensure state and serdev get set before continuing
- + smp_mb();
- +
- + /*
- + * Flush any event that has not been processed yet to ensure we're not going to
- + * use the serial device any more (e.g. for ACKing).
- + */
- + flush_workqueue(ec->events.queue_ack);
- + flush_workqueue(ec->events.queue_evt);
- +
- + serdev_device_close(serdev);
- +
- + /*
- + * Only at this point, no new events can be received. Destroying the
- + * workqueue here flushes all remaining events. Those events will be
- + * silently ignored and neither ACKed nor any handler gets called.
- + */
- + destroy_workqueue(ec->events.queue_ack);
- + destroy_workqueue(ec->events.queue_evt);
- +
- + // free writer
- + kfree(ec->writer.data);
- + ec->writer.data = NULL;
- + ec->writer.ptr = NULL;
- +
- + // free receiver
- + spin_lock_irqsave(&ec->receiver.lock, flags);
- + ec->receiver.state = SG5_RCV_DISCARD;
- + kfifo_free(&ec->receiver.fifo);
- +
- + kfree(ec->receiver.eval_buf.ptr);
- + ec->receiver.eval_buf.ptr = NULL;
- + ec->receiver.eval_buf.cap = 0;
- + ec->receiver.eval_buf.len = 0;
- + spin_unlock_irqrestore(&ec->receiver.lock, flags);
- +
- + serdev_device_set_drvdata(serdev, NULL);
- + surfacegen5_ec_release(ec);
- +}
- +
- +
- +static const struct acpi_device_id surfacegen5_acpi_ssh_match[] = {
- + { "MSHW0084", 0 },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surfacegen5_acpi_ssh_match);
- +
- +struct serdev_device_driver surfacegen5_acpi_ssh = {
- + .probe = surfacegen5_acpi_ssh_probe,
- + .remove = surfacegen5_acpi_ssh_remove,
- + .driver = {
- + .name = "surfacegen5_acpi_ssh",
- + .acpi_match_table = ACPI_PTR(surfacegen5_acpi_ssh_match),
- + .pm = &surfacegen5_ssh_pm_ops,
- + },
- +};
- +
- +inline int surfacegen5_acpi_ssh_register(void)
- +{
- + return serdev_device_driver_register(&surfacegen5_acpi_ssh);
- +}
- +
- +inline void surfacegen5_acpi_ssh_unregister(void)
- +{
- + serdev_device_driver_unregister(&surfacegen5_acpi_ssh);
- +}
- +
- +#else /* CONFIG_SURFACE_ACPI_SSH */
- +
- +inline int surfacegen5_acpi_ssh_register(void)
- +{
- + return 0;
- +}
- +
- +inline void surfacegen5_acpi_ssh_unregister(void)
- +{
- +}
- +
- +
- +#endif /* CONFIG_SURFACE_ACPI_SSH */
- +
- +
- +/*************************************************************************
- + * Surface Serial Hub Debug Device (private implementation)
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_SSH_DEBUG_DEVICE
- +
- +static char sg5_ssh_debug_rqst_buf_sysfs[SURFACEGEN5_MAX_RQST_RESPONSE + 1] = { 0 };
- +static char sg5_ssh_debug_rqst_buf_pld[SURFACEGEN5_MAX_RQST_PAYLOAD] = { 0 };
- +static char sg5_ssh_debug_rqst_buf_res[SURFACEGEN5_MAX_RQST_RESPONSE] = { 0 };
- +
- +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 > SURFACEGEN5_MAX_RQST_RESPONSE) {
- + return -EINVAL;
- + }
- +
- + memcpy(buf, sg5_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 surfacegen5_rqst rqst = {};
- + struct surfacegen5_buf result = {};
- + int status;
- +
- + // check basic write constriants
- + if (offs != 0 || count > SURFACEGEN5_MAX_RQST_PAYLOAD + 5) {
- + return -EINVAL;
- + }
- +
- + // payload length should be consistent with data provided
- + if (buf[4] + 5 != count) {
- + return -EINVAL;
- + }
- +
- + rqst.tc = buf[0];
- + rqst.iid = buf[1];
- + rqst.cid = buf[2];
- + rqst.snc = buf[3];
- + rqst.cdl = buf[4];
- + rqst.pld = sg5_ssh_debug_rqst_buf_pld;
- + memcpy(sg5_ssh_debug_rqst_buf_pld, buf + 5, count - 5);
- +
- + result.cap = SURFACEGEN5_MAX_RQST_RESPONSE;
- + result.len = 0;
- + result.data = sg5_ssh_debug_rqst_buf_res;
- +
- + status = surfacegen5_ec_rqst(&rqst, &result);
- + if (status) {
- + return status;
- + }
- +
- + sg5_ssh_debug_rqst_buf_sysfs[0] = result.len;
- + memcpy(sg5_ssh_debug_rqst_buf_sysfs + 1, result.data, result.len);
- + memset(sg5_ssh_debug_rqst_buf_sysfs + result.len + 1, 0,
- + SURFACEGEN5_MAX_RQST_RESPONSE + 1 - result.len);
- +
- + return count;
- +}
- +
- +static const BIN_ATTR_RW(rqst, SURFACEGEN5_MAX_RQST_RESPONSE + 1);
- +
- +
- +inline int surfacegen5_ssh_sysfs_register(struct device *dev)
- +{
- + return sysfs_create_bin_file(&dev->kobj, &bin_attr_rqst);
- +}
- +
- +inline void surfacegen5_ssh_sysfs_unregister(struct device *dev)
- +{
- + sysfs_remove_bin_file(&dev->kobj, &bin_attr_rqst);
- +}
- +
- +#elif defined(CONFIG_SURFACE_ACPI_SSH)
- +
- +inline int surfacegen5_ssh_sysfs_register(struct device *dev)
- +{
- + return 0;
- +}
- +
- +inline void surfacegen5_ssh_sysfs_unregister(struct device *dev)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_ACPI_SSH_DEBUG_DEVICE*/
- +
- +
- +/*************************************************************************
- + * Surface ACPI Notify driver
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_SAN
- +
- +#define SG5_SAN_RQST_RETRY 5
- +
- +#define SG5_SAN_DSM_REVISION 0
- +#define SG5_SAN_DSM_FN_NOTIFY_SENSOR_TRIP_POINT 0x09
- +
- +static const guid_t SG5_SAN_DSM_UUID =
- + GUID_INIT(0x93b666c5, 0x70c6, 0x469f, 0xa2, 0x15, 0x3d,
- + 0x48, 0x7c, 0x91, 0xab, 0x3c);
- +
- +#define SG5_EVENT_DELAY_POWER msecs_to_jiffies(5000)
- +
- +#define SG5_EVENT_PWR_TC 0x02
- +#define SG5_EVENT_PWR_RQID 0x0002
- +#define SG5_EVENT_PWR_CID_HWCHANGE 0x15
- +#define SG5_EVENT_PWR_CID_CHARGING 0x16
- +#define SG5_EVENT_PWR_CID_ADAPTER 0x17
- +#define SG5_EVENT_PWR_CID_STATE 0x4f
- +
- +#define SG5_EVENT_TEMP_TC 0x03
- +#define SG5_EVENT_TEMP_RQID 0x0003
- +#define SG5_EVENT_TEMP_CID_NOTIFY_SENSOR_TRIP_POINT 0x0b
- +
- +#define SG5_SAN_RQST_TAG "surfacegen5_ec_rqst: "
- +
- +#define SG5_QUIRK_BASE_STATE_DELAY 1000
- +
- +
- +struct surfacegen5_san_acpi_consumer {
- + char *path;
- + bool required;
- + u32 flags;
- +};
- +
- +struct surfacegen5_san_opreg_context {
- + struct acpi_connection_info connection;
- + struct device *dev;
- +};
- +
- +struct surfacegen5_san_consumer_link {
- + const struct surfacegen5_san_acpi_consumer *properties;
- + struct device_link *link;
- +};
- +
- +struct surfacegen5_san_consumers {
- + u32 num;
- + struct surfacegen5_san_consumer_link *links;
- +};
- +
- +struct surfacegen5_san_drvdata {
- + struct surfacegen5_san_opreg_context opreg_ctx;
- + struct surfacegen5_san_consumers consumers;
- +};
- +
- +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; // expected to be 0x01, could be revision
- + 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 surfacegen5_pwr_event {
- + SURFACEGEN5_PWR_EVENT_BAT1_STAT = 0x03,
- + SURFACEGEN5_PWR_EVENT_BAT1_INFO = 0x04,
- + SURFACEGEN5_PWR_EVENT_ADP1_STAT = 0x05,
- + SURFACEGEN5_PWR_EVENT_ADP1_INFO = 0x06,
- + SURFACEGEN5_PWR_EVENT_BAT2_STAT = 0x07,
- + SURFACEGEN5_PWR_EVENT_BAT2_INFO = 0x08,
- +};
- +
- +
- +static int surfacegen5_acpi_notify_power_event(struct device *dev, enum surfacegen5_pwr_event event)
- +{
- + acpi_handle san = ACPI_HANDLE(dev);
- + union acpi_object *obj;
- +
- + obj = acpi_evaluate_dsm_typed(san, &SG5_SAN_DSM_UUID, SG5_SAN_DSM_REVISION,
- + (u8) 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 surfacegen5_acpi_notify_sensor_trip_point(struct device *dev, u8 iid)
- +{
- + acpi_handle san = ACPI_HANDLE(dev);
- + union acpi_object *obj;
- + union acpi_object param;
- +
- + param.type = ACPI_TYPE_INTEGER;
- + param.integer.value = iid;
- +
- + obj = acpi_evaluate_dsm_typed(san, &SG5_SAN_DSM_UUID, SG5_SAN_DSM_REVISION,
- + SG5_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;
- +}
- +
- +
- +inline static int surfacegen5_evt_power_adapter(struct device *dev, struct surfacegen5_event *event)
- +{
- + int status;
- +
- + status = surfacegen5_acpi_notify_power_event(dev, SURFACEGEN5_PWR_EVENT_ADP1_STAT);
- + if (status) {
- + dev_err(dev, "error handling power event (cid = %x)\n", event->cid);
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +inline static int surfacegen5_evt_power_hwchange(struct device *dev, struct surfacegen5_event *event)
- +{
- + enum surfacegen5_pwr_event evcode;
- + int status;
- +
- + if (event->iid == 0x02) {
- + evcode = SURFACEGEN5_PWR_EVENT_BAT2_INFO;
- + } else {
- + evcode = SURFACEGEN5_PWR_EVENT_BAT1_INFO;
- + }
- +
- + status = surfacegen5_acpi_notify_power_event(dev, evcode);
- + if (status) {
- + dev_err(dev, "error handling power event (cid = %x)\n", event->cid);
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +inline static int surfacegen5_evt_power_state(struct device *dev, struct surfacegen5_event *event)
- +{
- + int status;
- +
- + status = surfacegen5_acpi_notify_power_event(dev, SURFACEGEN5_PWR_EVENT_BAT1_STAT);
- + if (status) {
- + dev_err(dev, "error handling power event (cid = %x)\n", event->cid);
- + return status;
- + }
- +
- + status = surfacegen5_acpi_notify_power_event(dev, SURFACEGEN5_PWR_EVENT_BAT2_STAT);
- + if (status) {
- + dev_err(dev, "error handling power event (cid = %x)\n", event->cid);
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +static unsigned long surfacegen5_evt_power_delay(struct surfacegen5_event *event, void *data)
- +{
- + switch (event->cid) {
- + case SG5_EVENT_PWR_CID_CHARGING:
- + case SG5_EVENT_PWR_CID_STATE:
- + return SG5_EVENT_DELAY_POWER;
- +
- + case SG5_EVENT_PWR_CID_ADAPTER:
- + case SG5_EVENT_PWR_CID_HWCHANGE:
- + default:
- + return 0;
- + }
- +}
- +
- +static int surfacegen5_evt_power(struct surfacegen5_event *event, void *data)
- +{
- + struct device *dev = (struct device *)data;
- +
- + switch (event->cid) {
- + case SG5_EVENT_PWR_CID_HWCHANGE:
- + return surfacegen5_evt_power_hwchange(dev, event);
- +
- + case SG5_EVENT_PWR_CID_ADAPTER:
- + return surfacegen5_evt_power_adapter(dev, event);
- +
- + case SG5_EVENT_PWR_CID_CHARGING:
- + case SG5_EVENT_PWR_CID_STATE:
- + return surfacegen5_evt_power_state(dev, event);
- +
- + default:
- + dev_warn(dev, "unhandled power event (cid = %x)\n", event->cid);
- + }
- +
- + return 0;
- +}
- +
- +
- +inline static int surfacegen5_evt_thermal_notify(struct device *dev, struct surfacegen5_event *event)
- +{
- + int status;
- +
- + status = surfacegen5_acpi_notify_sensor_trip_point(dev, event->iid);
- + if (status) {
- + dev_err(dev, "error handling thermal event (cid = %x)\n", event->cid);
- + return status;
- + }
- +
- + return 0;
- +}
- +
- +static int surfacegen5_evt_thermal(struct surfacegen5_event *event, void *data)
- +{
- + struct device *dev = (struct device *)data;
- +
- + switch (event->cid) {
- + case SG5_EVENT_TEMP_CID_NOTIFY_SENSOR_TRIP_POINT:
- + return surfacegen5_evt_thermal_notify(dev, event);
- +
- + default:
- + dev_warn(dev, "unhandled thermal event (cid = %x)\n", event->cid);
- + }
- +
- + return 0;
- +}
- +
- +
- +static struct gsb_data_rqsx *surfacegen5_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
- +surfacegen5_san_etwl(struct surfacegen5_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
- +surfacegen5_san_rqst(struct surfacegen5_san_opreg_context *ctx, struct gsb_buffer *buffer)
- +{
- + struct gsb_data_rqsx *gsb_rqst = surfacegen5_san_validate_rqsx(ctx->dev, "RQST", buffer);
- + struct surfacegen5_rqst rqst = {};
- + struct surfacegen5_buf result = {};
- + int status = 0;
- + int try;
- +
- + if (!gsb_rqst) {
- + return AE_OK;
- + }
- +
- + rqst.tc = gsb_rqst->tc;
- + rqst.iid = gsb_rqst->iid;
- + rqst.cid = gsb_rqst->cid;
- + rqst.snc = gsb_rqst->snc;
- + rqst.cdl = gsb_rqst->cdl;
- + rqst.pld = &gsb_rqst->pld[0];
- +
- + result.cap = SURFACEGEN5_MAX_RQST_RESPONSE;
- + result.len = 0;
- + result.data = kzalloc(result.cap, GFP_KERNEL);
- +
- + if (!result.data) {
- + return AE_NO_MEMORY;
- + }
- +
- + for (try = 0; try < SG5_SAN_RQST_RETRY; try++) {
- + if (try) {
- + dev_warn(ctx->dev, SG5_SAN_RQST_TAG "IO error occured, trying again\n");
- + }
- +
- + status = surfacegen5_ec_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, SG5_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
- +surfacegen5_san_rqsg(struct surfacegen5_san_opreg_context *ctx, struct gsb_buffer *buffer)
- +{
- + struct gsb_data_rqsx *rqsg = surfacegen5_san_validate_rqsx(ctx->dev, "RQSG", buffer);
- +
- + if (!rqsg) {
- + return AE_OK;
- + }
- +
- + // TODO: RQSG handler
- +
- + dev_warn(ctx->dev, "unsupported request: RQSG(0x%02x, 0x%02x, 0x%02x)\n",
- + rqsg->tc, rqsg->cid, rqsg->iid);
- +
- + return AE_OK;
- +}
- +
- +
- +static acpi_status
- +surfacegen5_san_opreg_handler(u32 function, acpi_physical_address command,
- + u32 bits, u64 *value64,
- + void *opreg_context, void *region_context)
- +{
- + struct surfacegen5_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 surfacegen5_san_rqst(context, buffer);
- + case 0x02: return surfacegen5_san_etwl(context, buffer);
- + case 0x03: return surfacegen5_san_rqsg(context, buffer);
- + }
- +
- + dev_warn(context->dev, "unsupported SAN0 request (cv: 0x%02x)\n", buffer->data.in.cv);
- + return AE_OK;
- +}
- +
- +static int surfacegen5_san_enable_events(struct device *dev)
- +{
- + int status;
- +
- + status = surfacegen5_ec_set_delayed_event_handler(
- + SG5_EVENT_PWR_RQID, surfacegen5_evt_power,
- + surfacegen5_evt_power_delay, dev);
- + if (status) {
- + goto err_event_handler_power;
- + }
- +
- + status = surfacegen5_ec_set_event_handler(
- + SG5_EVENT_TEMP_RQID, surfacegen5_evt_thermal,
- + dev);
- + if (status) {
- + goto err_event_handler_thermal;
- + }
- +
- + status = surfacegen5_ec_enable_event_source(SG5_EVENT_PWR_TC, 0x01, SG5_EVENT_PWR_RQID);
- + if (status) {
- + goto err_event_source_power;
- + }
- +
- + status = surfacegen5_ec_enable_event_source(SG5_EVENT_TEMP_TC, 0x01, SG5_EVENT_TEMP_RQID);
- + if (status) {
- + goto err_event_source_thermal;
- + }
- +
- + return 0;
- +
- +err_event_source_thermal:
- + surfacegen5_ec_disable_event_source(SG5_EVENT_PWR_TC, 0x01, SG5_EVENT_PWR_RQID);
- +err_event_source_power:
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_TEMP_RQID);
- +err_event_handler_thermal:
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_PWR_RQID);
- +err_event_handler_power:
- + return status;
- +}
- +
- +static void surfacegen5_san_disable_events(void)
- +{
- + surfacegen5_ec_disable_event_source(SG5_EVENT_TEMP_TC, 0x01, SG5_EVENT_TEMP_RQID);
- + surfacegen5_ec_disable_event_source(SG5_EVENT_PWR_TC, 0x01, SG5_EVENT_PWR_RQID);
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_TEMP_RQID);
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_PWR_RQID);
- +}
- +
- +
- +static int surfacegen5_san_consumers_link(struct platform_device *pdev,
- + const struct surfacegen5_san_acpi_consumer *cons,
- + struct surfacegen5_san_consumers *out)
- +{
- + const struct surfacegen5_san_acpi_consumer *con;
- + struct surfacegen5_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 = kzalloc(max_links * sizeof(struct surfacegen5_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 consumers_link_cleanup;
- + } else {
- + continue;
- + }
- + }
- +
- + status = acpi_bus_get_device(handle, &adev);
- + if (status) {
- + goto consumers_link_cleanup;
- + }
- +
- + link->link = device_link_add(&adev->dev, &pdev->dev, con->flags);
- + if (!(link->link)) {
- + status = -EFAULT;
- + goto consumers_link_cleanup;
- + }
- + link->properties = con;
- +
- + link += 1;
- + }
- +
- + out->num = link - links;
- + out->links = links;
- +
- + return 0;
- +
- +consumers_link_cleanup:
- + for (link = link - 1; link >= links; --link) {
- + if (link->properties->flags & DL_FLAG_STATELESS) {
- + device_link_del(link->link);
- + }
- + }
- +
- + return status;
- +}
- +
- +static void surfacegen5_san_consumers_unlink(struct surfacegen5_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 surfacegen5_acpi_san_probe(struct platform_device *pdev)
- +{
- + const struct surfacegen5_san_acpi_consumer *cons;
- + struct surfacegen5_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 = surfacegen5_ec_consumer_register(&pdev->dev);
- + if (status) {
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- + }
- +
- + drvdata = kzalloc(sizeof(struct surfacegen5_san_drvdata), GFP_KERNEL);
- + if (!drvdata) {
- + return -ENOMEM;
- + }
- +
- + drvdata->opreg_ctx.dev = &pdev->dev;
- +
- + cons = acpi_device_get_match_data(&pdev->dev);
- + status = surfacegen5_san_consumers_link(pdev, cons, &drvdata->consumers);
- + if (status) {
- + goto err_probe_consumers;
- + }
- +
- + platform_set_drvdata(pdev, drvdata);
- +
- + status = acpi_install_address_space_handler(san,
- + ACPI_ADR_SPACE_GSBUS,
- + &surfacegen5_san_opreg_handler,
- + NULL, &drvdata->opreg_ctx);
- +
- + if (ACPI_FAILURE(status)) {
- + status = -ENODEV;
- + goto err_probe_install_handler;
- + }
- +
- + status = surfacegen5_san_enable_events(&pdev->dev);
- + if (status) {
- + goto err_probe_enable_events;
- + }
- +
- + acpi_walk_dep_device_list(san);
- + return 0;
- +
- +err_probe_enable_events:
- + acpi_remove_address_space_handler(san, ACPI_ADR_SPACE_GSBUS, &surfacegen5_san_opreg_handler);
- +err_probe_install_handler:
- + platform_set_drvdata(san, NULL);
- + surfacegen5_san_consumers_unlink(&drvdata->consumers);
- +err_probe_consumers:
- + kfree(drvdata);
- + return status;
- +}
- +
- +static int surfacegen5_acpi_san_remove(struct platform_device *pdev)
- +{
- + struct surfacegen5_san_drvdata *drvdata = platform_get_drvdata(pdev);
- + acpi_handle san = ACPI_HANDLE(&pdev->dev); // _SAN device node
- + acpi_status status = AE_OK;
- +
- + acpi_remove_address_space_handler(san, ACPI_ADR_SPACE_GSBUS, &surfacegen5_san_opreg_handler);
- + surfacegen5_san_disable_events();
- +
- + surfacegen5_san_consumers_unlink(&drvdata->consumers);
- + kfree(drvdata);
- +
- + platform_set_drvdata(pdev, NULL);
- + return status;
- +}
- +
- +
- +static const struct surfacegen5_san_acpi_consumer surfacegen5_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 surfacegen5_acpi_san_match[] = {
- + { "MSHW0091", (long unsigned int) surfacegen5_mshw0091_consumers },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surfacegen5_acpi_san_match);
- +
- +struct platform_driver surfacegen5_acpi_san = {
- + .probe = surfacegen5_acpi_san_probe,
- + .remove = surfacegen5_acpi_san_remove,
- + .driver = {
- + .name = "surfacegen5_acpi_san",
- + .acpi_match_table = ACPI_PTR(surfacegen5_acpi_san_match),
- + },
- +};
- +
- +
- +inline int surfacegen5_acpi_san_register(void)
- +{
- + return platform_driver_register(&surfacegen5_acpi_san);
- +}
- +
- +inline void surfacegen5_acpi_san_unregister(void)
- +{
- + platform_driver_unregister(&surfacegen5_acpi_san);
- +}
- +
- +#else /* CONFIG_SURFACE_ACPI_SAN */
- +
- +inline int surfacegen5_acpi_san_register(void)
- +{
- + return 0;
- +}
- +
- +inline void surfacegen5_acpi_san_unregister(void)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_ACPI_SAN */
- +
- +
- +/*************************************************************************
- + * Virtual HID Framework driver
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_VHF
- +
- +#define SG5_VHF_INPUT_NAME "Microsoft Virtual HID Framework Device"
- +
- +/*
- + * Request ID for VHF events. This value is based on the output of the Surface
- + * EC and should not be changed.
- + */
- +#define SG5_EVENT_VHF_RQID 0x0001
- +#define SG5_EVENT_VHF_TC 0x08
- +
- +
- +struct surfacegen5_vhf_evtctx {
- + struct device *dev;
- + struct hid_device *hid;
- +};
- +
- +struct surfacegen5_vhf_drvdata {
- + struct surfacegen5_vhf_evtctx event_ctx;
- +};
- +
- +
- +/*
- + * 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 *surfacegen5_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", SG5_VHF_INPUT_NAME);
- +
- + return hid;
- +}
- +
- +static int surfacegen5_vhf_event_handler(struct surfacegen5_event *event, void *data)
- +{
- + struct surfacegen5_vhf_evtctx *ctx = (struct surfacegen5_vhf_evtctx *)data;
- +
- + if (event->tc == 0x08 && (event->cid == 0x03 || event->cid == 0x04)) {
- + return hid_input_report(ctx->hid, HID_INPUT_REPORT, event->pld, event->len, 1);
- + }
- +
- + dev_warn(ctx->dev, "unsupported event (tc = %d, cid = %d)\n", event->tc, event->cid);
- + return 0;
- +}
- +
- +static unsigned long surfacegen5_vhf_event_delay(struct surfacegen5_event *event, void *data)
- +{
- + // high priority immediate execution for keyboard events
- + if (event->tc == 0x08 && (event->cid == 0x03 || event->cid == 0x04)) {
- + return SURFACEGEN5_EVENT_IMMEDIATE;
- + }
- +
- + return 0;
- +}
- +
- +static int surfacegen5_acpi_vhf_probe(struct platform_device *pdev)
- +{
- + struct surfacegen5_vhf_drvdata *drvdata;
- + struct hid_device *hid;
- + int status;
- +
- + // add device link to EC
- + status = surfacegen5_ec_consumer_register(&pdev->dev);
- + if (status) {
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- + }
- +
- + drvdata = kzalloc(sizeof(struct surfacegen5_vhf_drvdata), GFP_KERNEL);
- + if (!drvdata) {
- + return -ENOMEM;
- + }
- +
- + hid = surfacegen5_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->event_ctx.dev = &pdev->dev;
- + drvdata->event_ctx.hid = hid;
- +
- + platform_set_drvdata(pdev, drvdata);
- +
- + /*
- + * Set event hanlder for VHF events. They seem to be enabled by
- + * default, thus there should be no need to explicitly enable them.
- + */
- + status = surfacegen5_ec_set_delayed_event_handler(
- + SG5_EVENT_VHF_RQID,
- + surfacegen5_vhf_event_handler,
- + surfacegen5_vhf_event_delay,
- + &drvdata->event_ctx);
- + if (status) {
- + goto err_add_hid;
- + }
- +
- + status = surfacegen5_ec_enable_event_source(SG5_EVENT_VHF_TC, 0x01, SG5_EVENT_VHF_RQID);
- + if (status) {
- + goto err_event_source;
- + }
- +
- + return 0;
- +
- +err_event_source:
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_VHF_RQID);
- +err_add_hid:
- + hid_destroy_device(hid);
- + platform_set_drvdata(pdev, NULL);
- +err_probe_hid:
- + kfree(drvdata);
- + return status;
- +}
- +
- +static int surfacegen5_acpi_vhf_remove(struct platform_device *pdev)
- +{
- + struct surfacegen5_vhf_drvdata *drvdata = platform_get_drvdata(pdev);
- +
- + surfacegen5_ec_disable_event_source(SG5_EVENT_VHF_TC, 0x01, SG5_EVENT_VHF_RQID);
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_VHF_RQID);
- +
- + hid_destroy_device(drvdata->event_ctx.hid);
- + kfree(drvdata);
- +
- + platform_set_drvdata(pdev, NULL);
- + return 0;
- +}
- +
- +
- +static const struct acpi_device_id surfacegen5_acpi_vhf_match[] = {
- + { "MSHW0096" },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surfacegen5_acpi_vhf_match);
- +
- +struct platform_driver surfacegen5_acpi_vhf = {
- + .probe = surfacegen5_acpi_vhf_probe,
- + .remove = surfacegen5_acpi_vhf_remove,
- + .driver = {
- + .name = "surfacegen5_acpi_vhf",
- + .acpi_match_table = ACPI_PTR(surfacegen5_acpi_vhf_match),
- + },
- +};
- +
- +
- +inline int surfacegen5_acpi_vhf_register(void)
- +{
- + return platform_driver_register(&surfacegen5_acpi_vhf);
- +}
- +
- +inline void surfacegen5_acpi_vhf_unregister(void)
- +{
- + platform_driver_unregister(&surfacegen5_acpi_vhf);
- +}
- +
- +#else /* CONFIG_SURFACE_ACPI_VHF */
- +
- +inline int surfacegen5_acpi_vhf_register(void)
- +{
- + return 0;
- +}
- +
- +inline void surfacegen5_acpi_vhf_unregister(void)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_ACPI_VHF */
- +
- +
- +/*************************************************************************
- + * Detachment System Driver (DTX)
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_DTX
- +
- +#define SG5_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 SG5_RQST_DTX_TC 0x11
- +#define SG5_RQST_DTX_CID_LATCH_LOCK 0x06
- +#define SG5_RQST_DTX_CID_LATCH_UNLOCK 0x07
- +#define SG5_RQST_DTX_CID_LATCH_REQUEST 0x08
- +#define SG5_RQST_DTX_CID_LATCH_OPEN 0x09
- +#define SG5_RQST_DTX_CID_GET_OPMODE 0x0D
- +
- +#define SG5_EVENT_DTX_TC 0x11
- +#define SG5_EVENT_DTX_RQID 0x0011
- +#define SG5_EVENT_DTX_CID_CONNECTION 0x0c
- +#define SG5_EVENT_DTX_CID_BUTTON 0x0e
- +#define SG5_EVENT_DTX_CID_ERROR 0x0f
- +#define SG5_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 SURFACE_DTX_CLIENT_BUF_SIZE 16
- +
- +#define SG5_DTX_CONNECT_OPMODE_DELAY 1000
- +
- +#define DTX_ERR KERN_ERR "surfacegen5_acpi_dtx: "
- +#define DTX_WARN KERN_WARNING "surfacegen5_acpi_dtx: "
- +
- +
- +struct surface_dtx_event {
- + u8 type;
- + u8 code;
- + u8 arg0;
- + u8 arg1;
- +} __packed;
- +
- +struct surface_dtx_dev {
- + 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[SURFACE_DTX_CLIENT_BUF_SIZE];
- +};
- +
- +
- +static struct surface_dtx_dev surface_dtx_dev;
- +
- +
- +static int sg5_ec_query_opmpde(void)
- +{
- + u8 result_buf[1];
- + int status;
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = SG5_RQST_DTX_TC,
- + .iid = 0,
- + .cid = SG5_RQST_DTX_CID_GET_OPMODE,
- + .snc = 1,
- + .cdl = 0,
- + .pld = NULL,
- + };
- +
- + struct surfacegen5_buf result = {
- + .cap = 1,
- + .len = 0,
- + .data = result_buf,
- + };
- +
- + status = surfacegen5_ec_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 surfacegen5_rqst rqst = {
- + .tc = SG5_RQST_DTX_TC,
- + .iid = 0,
- + .cid = cid,
- + .snc = 0,
- + .cdl = 0,
- + .pld = NULL,
- + };
- +
- + return surfacegen5_ec_rqst(&rqst, NULL);
- +}
- +
- +static int dtx_cmd_get_opmode(int __user *buf)
- +{
- + int opmode = sg5_ec_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) & (SURFACE_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(SG5_RQST_DTX_CID_LATCH_LOCK);
- + break;
- +
- + case DTX_CMD_LATCH_UNLOCK:
- + status = dtx_cmd_simple(SG5_RQST_DTX_CID_LATCH_UNLOCK);
- + break;
- +
- + case DTX_CMD_LATCH_REQUEST:
- + status = dtx_cmd_simple(SG5_RQST_DTX_CID_LATCH_REQUEST);
- + break;
- +
- + case DTX_CMD_LATCH_OPEN:
- + status = dtx_cmd_simple(SG5_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 &= SURFACE_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) & (SURFACE_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 = sg5_ec_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 == 0x00);
- + input_sync(ddev->input_dev);
- + spin_unlock(&ddev->input_lock);
- +}
- +
- +static int surface_dtx_evt_dtx(struct surfacegen5_event *in_event, void *data)
- +{
- + struct surface_dtx_dev *ddev = data;
- + struct surface_dtx_event event;
- +
- + switch (in_event->cid) {
- + case SG5_EVENT_DTX_CID_CONNECTION:
- + case SG5_EVENT_DTX_CID_BUTTON:
- + case SG5_EVENT_DTX_CID_ERROR:
- + case SG5_EVENT_DTX_CID_LATCH_STATUS:
- + if (in_event->len > 2) {
- + printk(DTX_ERR "unexpected payload size (cid: %x, len: %u)\n",
- + in_event->cid, in_event->len);
- + return 0;
- + }
- +
- + event.type = in_event->tc;
- + event.code = in_event->cid;
- + event.arg0 = in_event->len >= 1 ? in_event->pld[0] : 0x00;
- + event.arg1 = in_event->len >= 2 ? in_event->pld[1] : 0x00;
- + surface_dtx_push_event(ddev, &event);
- + break;
- +
- + default:
- + printk(DTX_WARN "unhandled dtx event (cid: %x)\n", in_event->cid);
- + }
- +
- + // update device mode
- + if (in_event->cid == SG5_EVENT_DTX_CID_CONNECTION) {
- + if (in_event->pld[0]) {
- + // Note: we're already in a workqueue task
- + msleep(SG5_DTX_CONNECT_OPMODE_DELAY);
- + }
- +
- + surface_dtx_update_opmpde(ddev);
- + }
- +
- + return 0;
- +}
- +
- +static int surface_dtx_events_setup(struct surface_dtx_dev *ddev)
- +{
- + int status;
- +
- + status = surfacegen5_ec_set_event_handler(SG5_EVENT_DTX_RQID, surface_dtx_evt_dtx, ddev);
- + if (status) {
- + goto err_event_handler;
- + }
- +
- + status = surfacegen5_ec_enable_event_source(SG5_EVENT_DTX_TC, 0x01, SG5_EVENT_DTX_RQID);
- + if (status) {
- + goto err_event_source;
- + }
- +
- + return 0;
- +
- +err_event_source:
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_DTX_RQID);
- +err_event_handler:
- + return status;
- +}
- +
- +static void surface_dtx_events_disable(void)
- +{
- + surfacegen5_ec_disable_event_source(SG5_EVENT_DTX_TC, 0x01, SG5_EVENT_DTX_RQID);
- + surfacegen5_ec_remove_event_handler(SG5_EVENT_DTX_RQID);
- +}
- +
- +
- +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 = SG5_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 = sg5_ec_query_opmpde();
- + if (status < 0) {
- + input_free_device(input_dev);
- + return ERR_PTR(status);
- + }
- +
- + input_report_switch(input_dev, SW_TABLET_MODE, status == 0x00);
- +
- + status = input_register_device(input_dev);
- + if (status) {
- + input_unregister_device(input_dev);
- + return ERR_PTR(status);
- + }
- +
- + return input_dev;
- +}
- +
- +
- +static int surfacegen5_acpi_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 = surfacegen5_ec_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_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;
- + }
- +
- + // enable events
- + status = surface_dtx_events_setup(ddev);
- + 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 surfacegen5_acpi_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_dtx_events_disable();
- +
- + // 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 surfacegen5_acpi_dtx_match[] = {
- + { "MSHW0133", 0 },
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surfacegen5_acpi_dtx_match);
- +
- +struct platform_driver surfacegen5_acpi_dtx = {
- + .probe = surfacegen5_acpi_dtx_probe,
- + .remove = surfacegen5_acpi_dtx_remove,
- + .driver = {
- + .name = "surfacegen5_acpi_dtx",
- + .acpi_match_table = ACPI_PTR(surfacegen5_acpi_dtx_match),
- + },
- +};
- +
- +
- +inline int surfacegen5_acpi_dtx_register(void)
- +{
- + return platform_driver_register(&surfacegen5_acpi_dtx);
- +}
- +
- +inline void surfacegen5_acpi_dtx_unregister(void)
- +{
- + platform_driver_unregister(&surfacegen5_acpi_dtx);
- +}
- +
- +#else /* CONFIG_SURFACE_ACPI_DTX */
- +
- +inline int surfacegen5_acpi_dtx_register(void)
- +{
- + return 0;
- +}
- +
- +inline void surfacegen5_acpi_dtx_unregister(void)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_ACPI_DTX */
- +
- +
- +/*************************************************************************
- + * Surface Platform Integration Driver
- + */
- +
- +#ifdef CONFIG_SURFACE_ACPI_SID
- +
- +struct si_lid_device {
- + const char *acpi_path;
- + const u32 gpe_number;
- +};
- +
- +struct si_device_info {
- + const bool has_perf_mode;
- + const struct si_lid_device *lid_device;
- +};
- +
- +
- +static const struct si_lid_device lid_device_l17 = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x17,
- +};
- +
- +static const struct si_lid_device lid_device_l4F = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x4F,
- +};
- +
- +static const struct si_lid_device lid_device_l57 = {
- + .acpi_path = "\\_SB.LID0",
- + .gpe_number = 0x57,
- +};
- +
- +
- +static const struct si_device_info si_device_pro_4 = {
- + .has_perf_mode = false,
- + .lid_device = &lid_device_l17,
- +};
- +
- +static const struct si_device_info si_device_pro_5 = {
- + .has_perf_mode = false,
- + .lid_device = &lid_device_l4F,
- +};
- +
- +static const struct si_device_info si_device_pro_6 = {
- + .has_perf_mode = false,
- + .lid_device = &lid_device_l4F,
- +};
- +
- +static const struct si_device_info si_device_book_1 = {
- + .has_perf_mode = false,
- + .lid_device = &lid_device_l17,
- +};
- +
- +static const struct si_device_info si_device_book_2 = {
- + .has_perf_mode = true,
- + .lid_device = &lid_device_l17,
- +};
- +
- +static const struct si_device_info si_device_laptop_1 = {
- + .has_perf_mode = false,
- + .lid_device = &lid_device_l57,
- +};
- +
- +static const struct si_device_info si_device_laptop_2 = {
- + .has_perf_mode = false,
- + .lid_device = &lid_device_l57,
- +};
- +
- +
- +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 *)&si_device_pro_4,
- + },
- + {
- + .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 *)&si_device_pro_5,
- + },
- + {
- + .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 *)&si_device_pro_5,
- + },
- + {
- + .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 *)&si_device_pro_6,
- + },
- + {
- + .ident = "Surface Book 1",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book"),
- + },
- + .driver_data = (void *)&si_device_book_1,
- + },
- + {
- + .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 *)&si_device_book_2,
- + },
- + {
- + .ident = "Surface Laptop 1",
- + .matches = {
- + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
- + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop"),
- + },
- + .driver_data = (void *)&si_device_laptop_1,
- + },
- + {
- + .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 *)&si_device_laptop_2,
- + },
- + { }
- +};
- +
- +#define SG5_PARAM_PERM (S_IRUGO | S_IWUSR)
- +
- +enum sg5_perf_mode {
- + SG5_PERF_MODE_NORMAL = 1,
- + SG5_PERF_MODE_BATTERY = 2,
- + SG5_PERF_MODE_PERF1 = 3,
- + SG5_PERF_MODE_PERF2 = 4,
- +
- + __SG5_PERF_MODE__START = 1,
- + __SG5_PERF_MODE__END = 4,
- +};
- +
- +enum sg5_param_perf_mode {
- + SG5_PARAM_PERF_MODE_AS_IS = 0,
- + SG5_PARAM_PERF_MODE_NORMAL = SG5_PERF_MODE_NORMAL,
- + SG5_PARAM_PERF_MODE_BATTERY = SG5_PERF_MODE_BATTERY,
- + SG5_PARAM_PERF_MODE_PERF1 = SG5_PERF_MODE_PERF1,
- + SG5_PARAM_PERF_MODE_PERF2 = SG5_PERF_MODE_PERF2,
- +
- + __SG5_PARAM_PERF_MODE__START = 0,
- + __SG5_PARAM_PERF_MODE__END = 4,
- +};
- +
- +
- +static int sg5_ec_perf_mode_get(void)
- +{
- + u8 result_buf[8] = { 0 };
- + int status;
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = 0x03,
- + .iid = 0x00,
- + .cid = 0x02,
- + .snc = 0x01,
- + .cdl = 0x00,
- + .pld = NULL,
- + };
- +
- + struct surfacegen5_buf result = {
- + .cap = ARRAY_SIZE(result_buf),
- + .len = 0,
- + .data = result_buf,
- + };
- +
- + status = surfacegen5_ec_rqst(&rqst, &result);
- + if (status) {
- + return status;
- + }
- +
- + if (result.len != 8) {
- + return -EFAULT;
- + }
- +
- + return get_unaligned_le32(&result.data[0]);
- +}
- +
- +static int sg5_ec_perf_mode_set(int perf_mode)
- +{
- + u8 payload[4] = { 0 };
- +
- + struct surfacegen5_rqst rqst = {
- + .tc = 0x03,
- + .iid = 0x00,
- + .cid = 0x03,
- + .snc = 0x00,
- + .cdl = ARRAY_SIZE(payload),
- + .pld = payload,
- + };
- +
- + if (perf_mode < __SG5_PERF_MODE__START || perf_mode > __SG5_PERF_MODE__END) {
- + return -EINVAL;
- + }
- +
- + put_unaligned_le32(perf_mode, &rqst.pld[0]);
- + return surfacegen5_ec_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 < __SG5_PARAM_PERF_MODE__START || perf_mode > __SG5_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 = SG5_PARAM_PERF_MODE_AS_IS;
- +static int param_perf_mode_exit = SG5_PARAM_PERF_MODE_AS_IS;
- +
- +module_param_cb(perf_mode_init, ¶m_perf_mode_ops, ¶m_perf_mode_init, SG5_PARAM_PERM);
- +module_param_cb(perf_mode_exit, ¶m_perf_mode_ops, ¶m_perf_mode_exit, SG5_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 = sg5_ec_perf_mode_get();
- + if (perf_mode < 0) {
- + dev_err(dev, "failed to get current performance mode: %d", 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 = sg5_ec_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;
- +}
- +
- +const static DEVICE_ATTR_RW(perf_mode);
- +
- +static int sid_perf_mode_setup(struct platform_device *pdev, const struct si_device_info *info)
- +{
- + int status;
- +
- + if (!info->has_perf_mode)
- + return 0;
- +
- + // link to ec
- + status = surfacegen5_ec_consumer_register(&pdev->dev);
- + if (status) {
- + return status == -ENXIO ? -EPROBE_DEFER : status;
- + }
- +
- + // set initial perf_mode
- + if (param_perf_mode_init != SG5_PARAM_PERF_MODE_AS_IS) {
- + status = sg5_ec_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:
- + sg5_ec_perf_mode_set(param_perf_mode_exit);
- + return status;
- +}
- +
- +static void sid_perf_mode_remove(struct platform_device *pdev, const struct si_device_info *info)
- +{
- + if (!info->has_perf_mode)
- + return;
- +
- + // remove perf_mode attribute
- + sysfs_remove_file(&pdev->dev.kobj, &dev_attr_perf_mode.attr);
- +
- + // set exit perf_mode
- + sg5_ec_perf_mode_set(param_perf_mode_exit);
- +}
- +
- +
- +static int sid_lid_enable_wakeup(const struct si_device_info *info, bool enable)
- +{
- + int action = enable ? ACPI_GPE_ENABLE : ACPI_GPE_DISABLE;
- + int status;
- +
- + if (!info->lid_device)
- + return 0;
- +
- + status = acpi_set_gpe_wake_mask(NULL, info->lid_device->gpe_number, action);
- + if (status)
- + return -EFAULT;
- +
- + return 0;
- +}
- +
- +static int sid_lid_device_setup(const struct si_device_info *info)
- +{
- + acpi_handle lid_handle;
- + int status;
- +
- + if (!info->lid_device)
- + return 0;
- +
- + status = acpi_get_handle(NULL, (acpi_string)info->lid_device->acpi_path, &lid_handle);
- + if (status)
- + return -EFAULT;
- +
- + status = acpi_setup_gpe_for_wake(lid_handle, NULL, info->lid_device->gpe_number);
- + if (status)
- + return -EFAULT;
- +
- + status = acpi_enable_gpe(NULL, info->lid_device->gpe_number);
- + if (status)
- + return -EFAULT;
- +
- + return sid_lid_enable_wakeup(info, false);
- +}
- +
- +static void sid_lid_device_remove(const struct si_device_info *info)
- +{
- + /* restore default behavior without this module */
- + sid_lid_enable_wakeup(info, false);
- +}
- +
- +
- +static int surfacegen5_acpi_sid_suspend(struct device *dev)
- +{
- + const struct si_device_info *info = dev_get_drvdata(dev);
- + return sid_lid_enable_wakeup(info, true);
- +}
- +
- +static int surfacegen5_acpi_sid_resume(struct device *dev)
- +{
- + const struct si_device_info *info = dev_get_drvdata(dev);
- + return sid_lid_enable_wakeup(info, false);
- +}
- +
- +static SIMPLE_DEV_PM_OPS(surfacegen5_acpi_sid_pm, surfacegen5_acpi_sid_suspend, surfacegen5_acpi_sid_resume);
- +
- +
- +static int surfacegen5_acpi_sid_probe(struct platform_device *pdev)
- +{
- + const struct dmi_system_id *dmi_match;
- + struct si_device_info *info;
- + int status;
- +
- + dmi_match = dmi_first_match(dmi_lid_device_table);
- + if (!dmi_match)
- + return -ENODEV;
- +
- + info = dmi_match->driver_data;
- +
- + platform_set_drvdata(pdev, info);
- +
- + status = sid_perf_mode_setup(pdev, info);
- + if (status)
- + goto err_perf_mode;
- +
- + status = sid_lid_device_setup(info);
- + if (status)
- + goto err_lid;
- +
- + return 0;
- +
- +err_lid:
- + sid_perf_mode_remove(pdev, info);
- +err_perf_mode:
- + return status;
- +}
- +
- +static int surfacegen5_acpi_sid_remove(struct platform_device *pdev)
- +{
- + const struct si_device_info *info = platform_get_drvdata(pdev);
- +
- + sid_perf_mode_remove(pdev, info);
- + sid_lid_device_remove(info);
- +
- + platform_set_drvdata(pdev, NULL);
- + return 0;
- +}
- +
- +static const struct acpi_device_id surfacegen5_acpi_sid_match[] = {
- + { "MSHW0081", }, /* Surface Pro 4, 5, and 6 */
- + { "MSHW0080", }, /* Surface Book 1 */
- + { "MSHW0107", }, /* Surface Book 2 */
- + { "MSHW0086", }, /* Surface Laptop 1 */
- + { "MSHW0112", }, /* Surface Laptop 2 */
- + { },
- +};
- +MODULE_DEVICE_TABLE(acpi, surfacegen5_acpi_sid_match);
- +
- +struct platform_driver surfacegen5_acpi_sid = {
- + .probe = surfacegen5_acpi_sid_probe,
- + .remove = surfacegen5_acpi_sid_remove,
- + .driver = {
- + .name = "surfacegen5_acpi_sid",
- + .acpi_match_table = ACPI_PTR(surfacegen5_acpi_sid_match),
- + .pm = &surfacegen5_acpi_sid_pm,
- + },
- +};
- +
- +inline int surfacegen5_acpi_sid_register(void)
- +{
- + return platform_driver_register(&surfacegen5_acpi_sid);
- +}
- +
- +inline void surfacegen5_acpi_sid_unregister(void)
- +{
- + platform_driver_unregister(&surfacegen5_acpi_sid);
- +}
- +
- +#else /* CONFIG_SURFACE_ACPI_SID */
- +
- +inline int surfacegen5_acpi_sid_register(void)
- +{
- + return 0;
- +}
- +
- +inline void surfacegen5_acpi_sid_unregister(void)
- +{
- +}
- +
- +#endif /* CONFIG_SURFACE_ACPI_SID */
- +
- +
- +/*************************************************************************
- + * Module initialization
- + */
- +
- +int __init surface_acpi_init(void)
- +{
- + int status;
- +
- + status = surfacegen5_acpi_ssh_register();
- + if (status) {
- + goto err_ssh;
- + }
- +
- + status = surfacegen5_acpi_san_register();
- + if (status) {
- + goto err_san;
- + }
- +
- + status = surfacegen5_acpi_vhf_register();
- + if (status) {
- + goto err_vhf;
- + }
- +
- + status = surfacegen5_acpi_dtx_register();
- + if (status) {
- + goto err_dtx;
- + }
- +
- + status = surfacegen5_acpi_sid_register();
- + if (status) {
- + goto err_sid;
- + }
- +
- + return 0;
- +
- +err_sid:
- + surfacegen5_acpi_sid_unregister();
- +err_dtx:
- + surfacegen5_acpi_vhf_unregister();
- +err_vhf:
- + surfacegen5_acpi_san_unregister();
- +err_san:
- + surfacegen5_acpi_ssh_unregister();
- +err_ssh:
- + return status;
- +}
- +
- +void __exit surface_acpi_exit(void)
- +{
- + surfacegen5_acpi_sid_unregister();
- + surfacegen5_acpi_dtx_unregister();
- + surfacegen5_acpi_vhf_unregister();
- + surfacegen5_acpi_san_unregister();
- + surfacegen5_acpi_ssh_unregister();
- +}
- +
- +module_init(surface_acpi_init)
- +module_exit(surface_acpi_exit)
- +
- +MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
- +MODULE_DESCRIPTION("ACPI/Platform Drivers for Microsoft Surface Devices");
- +MODULE_LICENSE("GPL v2");
- diff --git a/drivers/tty/serdev/core.c b/drivers/tty/serdev/core.c
- index a0ac16ee6575..226adeec2aed 100644
- --- a/drivers/tty/serdev/core.c
- +++ b/drivers/tty/serdev/core.c
- @@ -552,16 +552,97 @@ static int of_serdev_register_devices(struct serdev_controller *ctrl)
- }
-
- #ifdef CONFIG_ACPI
- +
- +#define SERDEV_ACPI_MAX_SCAN_DEPTH 32
- +
- +struct acpi_serdev_lookup {
- + acpi_handle device_handle;
- + acpi_handle controller_handle;
- + int n;
- + int index;
- +};
- +
- +static int acpi_serdev_parse_resource(struct acpi_resource *ares, void *data)
- +{
- + struct acpi_serdev_lookup *lookup = data;
- + struct acpi_resource_uart_serialbus *sb;
- + acpi_status status;
- +
- + if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
- + return 1;
- +
- + if (ares->data.common_serial_bus.type != ACPI_RESOURCE_SERIAL_TYPE_UART)
- + return 1;
- +
- + if (lookup->index != -1 && lookup->n++ != lookup->index)
- + return 1;
- +
- + sb = &ares->data.uart_serial_bus;
- +
- + status = acpi_get_handle(lookup->device_handle,
- + sb->resource_source.string_ptr,
- + &lookup->controller_handle);
- + if (ACPI_FAILURE(status))
- + return 1;
- +
- + /*
- + * NOTE: Ideally, we would also want to retreive other properties here,
- + * once setting them before opening the device is supported by serdev.
- + */
- +
- + return 1;
- +}
- +
- +static int acpi_serdev_do_lookup(struct acpi_device *adev,
- + struct acpi_serdev_lookup *lookup)
- +{
- + struct list_head resource_list;
- + int ret;
- +
- + lookup->device_handle = acpi_device_handle(adev);
- + lookup->controller_handle = NULL;
- + lookup->n = 0;
- +
- + INIT_LIST_HEAD(&resource_list);
- + ret = acpi_dev_get_resources(adev, &resource_list,
- + acpi_serdev_parse_resource, lookup);
- + acpi_dev_free_resource_list(&resource_list);
- +
- + if (ret < 0)
- + return -EINVAL;
- +
- + return 0;
- +}
- +
- +static int acpi_serdev_check_resources(struct serdev_controller *ctrl,
- + struct acpi_device *adev)
- +{
- + struct acpi_serdev_lookup lookup;
- + int ret;
- +
- + if (acpi_bus_get_status(adev) || !adev->status.present)
- + return -EINVAL;
- +
- + /* Look for UARTSerialBusV2 resource */
- + lookup.index = -1; // we only care for the last device
- +
- + ret = acpi_serdev_do_lookup(adev, &lookup);
- + if (ret)
- + return ret;
- +
- + /* Make sure controller and ResourceSource handle match */
- + if (ACPI_HANDLE(ctrl->dev.parent) != lookup.controller_handle)
- + return -ENODEV;
- +
- + return 0;
- +}
- +
- static acpi_status acpi_serdev_register_device(struct serdev_controller *ctrl,
- - struct acpi_device *adev)
- + struct acpi_device *adev)
- {
- - struct serdev_device *serdev = NULL;
- + struct serdev_device *serdev;
- int err;
-
- - if (acpi_bus_get_status(adev) || !adev->status.present ||
- - acpi_device_enumerated(adev))
- - return AE_OK;
- -
- serdev = serdev_device_alloc(ctrl);
- if (!serdev) {
- dev_err(&ctrl->dev, "failed to allocate serdev device for %s\n",
- @@ -583,7 +664,7 @@ static acpi_status acpi_serdev_register_device(struct serdev_controller *ctrl,
- }
-
- static acpi_status acpi_serdev_add_device(acpi_handle handle, u32 level,
- - void *data, void **return_value)
- + void *data, void **return_value)
- {
- struct serdev_controller *ctrl = data;
- struct acpi_device *adev;
- @@ -591,22 +672,28 @@ static acpi_status acpi_serdev_add_device(acpi_handle handle, u32 level,
- if (acpi_bus_get_device(handle, &adev))
- return AE_OK;
-
- + if (acpi_device_enumerated(adev))
- + return AE_OK;
- +
- + if (acpi_serdev_check_resources(ctrl, adev))
- + return AE_OK;
- +
- return acpi_serdev_register_device(ctrl, adev);
- }
-
- +
- static int acpi_serdev_register_devices(struct serdev_controller *ctrl)
- {
- acpi_status status;
- - acpi_handle handle;
-
- - handle = ACPI_HANDLE(ctrl->dev.parent);
- - if (!handle)
- + if (!has_acpi_companion(ctrl->dev.parent))
- return -ENODEV;
-
- - status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
- + status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
- + SERDEV_ACPI_MAX_SCAN_DEPTH,
- acpi_serdev_add_device, NULL, ctrl, NULL);
- if (ACPI_FAILURE(status))
- - dev_dbg(&ctrl->dev, "failed to enumerate serdev slaves\n");
- + dev_warn(&ctrl->dev, "failed to enumerate serdev slaves\n");
-
- if (!ctrl->serdev)
- return -ENODEV;
- --
- 2.23.0
|