apr_audio-v2.h 373 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (c) 2012-2019, The Linux Foundation. All rights reserved.
  4. */
  5. #ifndef _APR_AUDIO_V2_H_
  6. #define _APR_AUDIO_V2_H_
  7. #include <ipc/apr.h>
  8. #include <linux/msm_audio.h>
  9. /* size of header needed for passing data out of band */
  10. #define APR_CMD_OB_HDR_SZ 12
  11. /* size of header needed for getting data */
  12. #define APR_CMD_GET_HDR_SZ 16
  13. struct param_outband {
  14. size_t size;
  15. void *kvaddr;
  16. phys_addr_t paddr;
  17. };
  18. /* Common structures and definitions used for instance ID support */
  19. /* Instance ID definitions */
  20. #define INSTANCE_ID_0 0x0000
  21. struct mem_mapping_hdr {
  22. /*
  23. * LSW of parameter data payload address. Supported values: any.
  24. * - Must be set to zero for in-band data.
  25. */
  26. u32 data_payload_addr_lsw;
  27. /*
  28. * MSW of Parameter data payload address. Supported values: any.
  29. * - Must be set to zero for in-band data.
  30. * - In the case of 32 bit Shared memory address, MSW field must be
  31. * set to zero.
  32. * - In the case of 36 bit shared memory address, bit 31 to bit 4 of
  33. * MSW must be set to zero.
  34. */
  35. u32 data_payload_addr_msw;
  36. /*
  37. * Memory map handle returned by DSP through
  38. * ASM_CMD_SHARED_MEM_MAP_REGIONS command.
  39. * Supported Values: Any.
  40. * If memory map handle is NULL, the parameter data payloads are
  41. * within the message payload (in-band).
  42. * If memory map handle is non-NULL, the parameter data payloads begin
  43. * at the address specified in the address MSW and LSW (out-of-band).
  44. */
  45. u32 mem_map_handle;
  46. } __packed;
  47. /*
  48. * Payload format for parameter data.
  49. * Immediately following these structures are param_size bytes of parameter
  50. * data.
  51. */
  52. struct param_hdr_v1 {
  53. /* Valid ID of the module. */
  54. uint32_t module_id;
  55. /* Valid ID of the parameter. */
  56. uint32_t param_id;
  57. /* The size of the parameter specified by the module/param ID combo */
  58. uint16_t param_size;
  59. /* This field must be set to zero. */
  60. uint16_t reserved;
  61. } __packed;
  62. struct param_hdr_v2 {
  63. /* Valid ID of the module. */
  64. uint32_t module_id;
  65. /* Valid ID of the parameter. */
  66. uint32_t param_id;
  67. /* The size of the parameter specified by the module/param ID combo */
  68. uint32_t param_size;
  69. } __packed;
  70. struct param_hdr_v3 {
  71. /* Valid ID of the module. */
  72. uint32_t module_id;
  73. /* Instance of the module. */
  74. uint16_t instance_id;
  75. /* This field must be set to zero. */
  76. uint16_t reserved;
  77. /* Valid ID of the parameter. */
  78. uint32_t param_id;
  79. /* The size of the parameter specified by the module/param ID combo */
  80. uint32_t param_size;
  81. } __packed;
  82. /* A union of all param_hdr versions for versitility and max size */
  83. union param_hdrs {
  84. struct param_hdr_v1 v1;
  85. struct param_hdr_v2 v2;
  86. struct param_hdr_v3 v3;
  87. };
  88. struct module_instance_info {
  89. /* Module ID. */
  90. u32 module_id;
  91. /* Instance of the module */
  92. u16 instance_id;
  93. /* Reserved. This field must be set to zero. */
  94. u16 reserved;
  95. } __packed;
  96. /* Begin service specific definitions and structures */
  97. #define ADSP_ADM_VERSION 0x00070000
  98. #define ADM_CMD_SHARED_MEM_MAP_REGIONS 0x00010322
  99. #define ADM_CMDRSP_SHARED_MEM_MAP_REGIONS 0x00010323
  100. #define ADM_CMD_SHARED_MEM_UNMAP_REGIONS 0x00010324
  101. #define ADM_CMD_MATRIX_MAP_ROUTINGS_V5 0x00010325
  102. #define ADM_CMD_STREAM_DEVICE_MAP_ROUTINGS_V5 0x0001033D
  103. /* Enumeration for an audio Rx matrix ID.*/
  104. #define ADM_MATRIX_ID_AUDIO_RX 0
  105. #define ADM_MATRIX_ID_AUDIO_TX 1
  106. #define ADM_MATRIX_ID_COMPRESSED_AUDIO_RX 2
  107. #define ADM_MATRIX_ID_COMPRESSED_AUDIO_TX 3
  108. #define ADM_MATRIX_ID_LISTEN_TX 4
  109. /* Enumeration for an audio Tx matrix ID.*/
  110. #define ADM_MATRIX_ID_AUDIOX 1
  111. #define ADM_MAX_COPPS 5
  112. /* make sure this matches with msm_audio_calibration */
  113. #define SP_V2_NUM_MAX_SPKR 2
  114. /* Session map node structure.
  115. * Immediately following this structure are num_copps
  116. * entries of COPP IDs. The COPP IDs are 16 bits, so
  117. * there might be a padding 16-bit field if num_copps
  118. * is odd.
  119. */
  120. struct adm_session_map_node_v5 {
  121. u16 session_id;
  122. /* Handle of the ASM session to be routed. Supported values: 1
  123. * to 8.
  124. */
  125. u16 num_copps;
  126. /* Number of COPPs to which this session is to be routed.
  127. * Supported values: 0 < num_copps <= ADM_MAX_COPPS.
  128. */
  129. } __packed;
  130. /* Payload of the #ADM_CMD_MATRIX_MAP_ROUTINGS_V5 command.
  131. * Immediately following this structure are num_sessions of the session map
  132. * node payload (adm_session_map_node_v5).
  133. */
  134. struct adm_cmd_matrix_map_routings_v5 {
  135. struct apr_hdr hdr;
  136. u32 matrix_id;
  137. /* Specifies whether the matrix ID is Audio Rx (0) or Audio Tx
  138. * (1). Use the ADM_MATRIX_ID_AUDIO_RX or ADM_MATRIX_ID_AUDIOX
  139. * macros to set this field.
  140. */
  141. u32 num_sessions;
  142. /* Number of sessions being updated by this command (optional). */
  143. } __packed;
  144. /* This command allows a client to open a COPP/Voice Proc. TX module
  145. * and sets up the device session: Matrix -> COPP -> AFE on the RX
  146. * and AFE -> COPP -> Matrix on the TX. This enables PCM data to
  147. * be transferred to/from the endpoint (AFEPortID).
  148. *
  149. * @return
  150. * #ADM_CMDRSP_DEVICE_OPEN_V5 with the resulting status and COPP ID.
  151. */
  152. #define ADM_CMD_DEVICE_OPEN_V5 0x00010326
  153. /* This command allows a client to open a COPP/Voice Proc the
  154. * way as ADM_CMD_DEVICE_OPEN_V5 but supports multiple endpoint2
  155. * channels.
  156. *
  157. * @return
  158. * #ADM_CMDRSP_DEVICE_OPEN_V6 with the resulting status and
  159. * COPP ID.
  160. */
  161. #define ADM_CMD_DEVICE_OPEN_V6 0x00010356
  162. /* This command allows a client to open a COPP/Voice Proc the
  163. * way as ADM_CMD_DEVICE_OPEN_V8 but supports any number channel
  164. * of configuration.
  165. *
  166. * @return
  167. * #ADM_CMDRSP_DEVICE_OPEN_V8 with the resulting status and
  168. * COPP ID.
  169. */
  170. #define ADM_CMD_DEVICE_OPEN_V8 0x0001036A
  171. /* Definition for a low latency stream session. */
  172. #define ADM_LOW_LATENCY_DEVICE_SESSION 0x2000
  173. /* Definition for a ultra low latency stream session. */
  174. #define ADM_ULTRA_LOW_LATENCY_DEVICE_SESSION 0x4000
  175. /* Definition for a ultra low latency with Post Processing stream session. */
  176. #define ADM_ULL_POST_PROCESSING_DEVICE_SESSION 0x8000
  177. /* Definition for a legacy device session. */
  178. #define ADM_LEGACY_DEVICE_SESSION 0
  179. /* Indicates that endpoint_id_2 is to be ignored.*/
  180. #define ADM_CMD_COPP_OPEN_END_POINT_ID_2_IGNORE 0xFFFF
  181. #define ADM_CMD_COPP_OPEN_MODE_OF_OPERATION_RX_PATH_COPP 1
  182. #define ADM_CMD_COPP_OPEN_MODE_OF_OPERATIONX_PATH_LIVE_COPP 2
  183. #define ADM_CMD_COPP_OPEN_MODE_OF_OPERATIONX_PATH_NON_LIVE_COPP 3
  184. /* Indicates that an audio COPP is to send/receive a mono PCM
  185. * stream to/from
  186. * END_POINT_ID_1.
  187. */
  188. #define ADM_CMD_COPP_OPEN_CHANNEL_CONFIG_MONO 1
  189. /* Indicates that an audio COPP is to send/receive a
  190. * stereo PCM stream to/from END_POINT_ID_1.
  191. */
  192. #define ADM_CMD_COPP_OPEN_CHANNEL_CONFIG_STEREO 2
  193. /* Sample rate is 8000 Hz.*/
  194. #define ADM_CMD_COPP_OPEN_SAMPLE_RATE_8K 8000
  195. /* Sample rate is 16000 Hz.*/
  196. #define ADM_CMD_COPP_OPEN_SAMPLE_RATE_16K 16000
  197. /* Sample rate is 32000 Hz.*/
  198. #define ADM_CMD_COPP_OPEN_SAMPLE_RATE_32K 32000
  199. /* Sample rate is 48000 Hz.*/
  200. #define ADM_CMD_COPP_OPEN_SAMPLE_RATE_48K 48000
  201. /* Definition for a COPP live input flag bitmask.*/
  202. #define ADM_BIT_MASK_COPP_LIVE_INPUT_FLAG (0x0001U)
  203. /* Definition for a COPP live shift value bitmask.*/
  204. #define ADM_SHIFT_COPP_LIVE_INPUT_FLAG 0
  205. /* Definition for the COPP ID bitmask.*/
  206. #define ADM_BIT_MASK_COPP_ID (0x0000FFFFUL)
  207. /* Definition for the COPP ID shift value.*/
  208. #define ADM_SHIFT_COPP_ID 0
  209. /* Definition for the service ID bitmask.*/
  210. #define ADM_BIT_MASK_SERVICE_ID (0x00FF0000UL)
  211. /* Definition for the service ID shift value.*/
  212. #define ADM_SHIFT_SERVICE_ID 16
  213. /* Definition for the domain ID bitmask.*/
  214. #define ADM_BIT_MASK_DOMAIN_ID (0xFF000000UL)
  215. /* Definition for the domain ID shift value.*/
  216. #define ADM_SHIFT_DOMAIN_ID 24
  217. /* ADM device open command payload of the
  218. * #ADM_CMD_DEVICE_OPEN_V5 command.
  219. */
  220. struct adm_cmd_device_open_v5 {
  221. struct apr_hdr hdr;
  222. u16 flags;
  223. /* Reserved for future use. Clients must set this field
  224. * to zero.
  225. */
  226. u16 mode_of_operation;
  227. /* Specifies whether the COPP must be opened on the Tx or Rx
  228. * path. Use the ADM_CMD_COPP_OPEN_MODE_OF_OPERATION_* macros for
  229. * supported values and interpretation.
  230. * Supported values:
  231. * - 0x1 -- Rx path COPP
  232. * - 0x2 -- Tx path live COPP
  233. * - 0x3 -- Tx path nonlive COPP
  234. * Live connections cause sample discarding in the Tx device
  235. * matrix if the destination output ports do not pull them
  236. * fast enough. Nonlive connections queue the samples
  237. * indefinitely.
  238. */
  239. u16 endpoint_id_1;
  240. /* Logical and physical endpoint ID of the audio path.
  241. * If the ID is a voice processor Tx block, it receives near
  242. * samples. Supported values: Any pseudoport, AFE Rx port,
  243. * or AFE Tx port For a list of valid IDs, refer to
  244. * @xhyperref{Q4,[Q4]}.
  245. * Q4 = Hexagon Multimedia: AFE Interface Specification
  246. */
  247. u16 endpoint_id_2;
  248. /* Logical and physical endpoint ID 2 for a voice processor
  249. * Tx block.
  250. * This is not applicable to audio COPP.
  251. * Supported values:
  252. * - AFE Rx port
  253. * - 0xFFFF -- Endpoint 2 is unavailable and the voice
  254. * processor Tx
  255. * block ignores this endpoint
  256. * When the voice processor Tx block is created on the audio
  257. * record path,
  258. * it can receive far-end samples from an AFE Rx port if the
  259. * voice call
  260. * is active. The ID of the AFE port is provided in this
  261. * field.
  262. * For a list of valid IDs, refer @xhyperref{Q4,[Q4]}.
  263. */
  264. u32 topology_id;
  265. /* Audio COPP topology ID; 32-bit GUID. */
  266. u16 dev_num_channel;
  267. /* Number of channels the audio COPP sends to/receives from
  268. * the endpoint.
  269. * Supported values: 1 to 8.
  270. * The value is ignored for the voice processor Tx block,
  271. * where channel
  272. * configuration is derived from the topology ID.
  273. */
  274. u16 bit_width;
  275. /* Bit width (in bits) that the audio COPP sends to/receives
  276. * from the
  277. * endpoint. The value is ignored for the voice processing
  278. * Tx block,
  279. * where the PCM width is 16 bits.
  280. */
  281. u32 sample_rate;
  282. /* Sampling rate at which the audio COPP/voice processor
  283. * Tx block
  284. * interfaces with the endpoint.
  285. * Supported values for voice processor Tx: 8000, 16000,
  286. * 48000 Hz
  287. * Supported values for audio COPP: >0 and <=192 kHz
  288. */
  289. u8 dev_channel_mapping[8];
  290. /* Array of channel mapping of buffers that the audio COPP
  291. * sends to the endpoint. Channel[i] mapping describes channel
  292. * I inside the buffer, where 0 < i < dev_num_channel.
  293. * This value is relevant only for an audio Rx COPP.
  294. * For the voice processor block and Tx audio block, this field
  295. * is set to zero and is ignored.
  296. */
  297. } __packed;
  298. /* ADM device open command payload of the
  299. * #ADM_CMD_DEVICE_OPEN_V6 command.
  300. */
  301. struct adm_cmd_device_open_v6 {
  302. struct apr_hdr hdr;
  303. u16 flags;
  304. /* Reserved for future use. Clients must set this field
  305. * to zero.
  306. */
  307. u16 mode_of_operation;
  308. /* Specifies whether the COPP must be opened on the Tx or Rx
  309. * path. Use the ADM_CMD_COPP_OPEN_MODE_OF_OPERATION_* macros for
  310. * supported values and interpretation.
  311. * Supported values:
  312. * - 0x1 -- Rx path COPP
  313. * - 0x2 -- Tx path live COPP
  314. * - 0x3 -- Tx path nonlive COPP
  315. * Live connections cause sample discarding in the Tx device
  316. * matrix if the destination output ports do not pull them
  317. * fast enough. Nonlive connections queue the samples
  318. * indefinitely.
  319. */
  320. u16 endpoint_id_1;
  321. /* Logical and physical endpoint ID of the audio path.
  322. * If the ID is a voice processor Tx block, it receives near
  323. * samples. Supported values: Any pseudoport, AFE Rx port,
  324. * or AFE Tx port For a list of valid IDs, refer to
  325. * @xhyperref{Q4,[Q4]}.
  326. * Q4 = Hexagon Multimedia: AFE Interface Specification
  327. */
  328. u16 endpoint_id_2;
  329. /* Logical and physical endpoint ID 2 for a voice processor
  330. * Tx block.
  331. * This is not applicable to audio COPP.
  332. * Supported values:
  333. * - AFE Rx port
  334. * - 0xFFFF -- Endpoint 2 is unavailable and the voice
  335. * processor Tx
  336. * block ignores this endpoint
  337. * When the voice processor Tx block is created on the audio
  338. * record path,
  339. * it can receive far-end samples from an AFE Rx port if the
  340. * voice call
  341. * is active. The ID of the AFE port is provided in this
  342. * field.
  343. * For a list of valid IDs, refer @xhyperref{Q4,[Q4]}.
  344. */
  345. u32 topology_id;
  346. /* Audio COPP topology ID; 32-bit GUID. */
  347. u16 dev_num_channel;
  348. /* Number of channels the audio COPP sends to/receives from
  349. * the endpoint.
  350. * Supported values: 1 to 8.
  351. * The value is ignored for the voice processor Tx block,
  352. * where channel
  353. * configuration is derived from the topology ID.
  354. */
  355. u16 bit_width;
  356. /* Bit width (in bits) that the audio COPP sends to/receives
  357. * from the
  358. * endpoint. The value is ignored for the voice processing
  359. * Tx block,
  360. * where the PCM width is 16 bits.
  361. */
  362. u32 sample_rate;
  363. /* Sampling rate at which the audio COPP/voice processor
  364. * Tx block
  365. * interfaces with the endpoint.
  366. * Supported values for voice processor Tx: 8000, 16000,
  367. * 48000 Hz
  368. * Supported values for audio COPP: >0 and <=192 kHz
  369. */
  370. u8 dev_channel_mapping[8];
  371. /* Array of channel mapping of buffers that the audio COPP
  372. * sends to the endpoint. Channel[i] mapping describes channel
  373. * I inside the buffer, where 0 < i < dev_num_channel.
  374. * This value is relevant only for an audio Rx COPP.
  375. * For the voice processor block and Tx audio block, this field
  376. * is set to zero and is ignored.
  377. */
  378. u16 dev_num_channel_eid2;
  379. /* Number of channels the voice processor block sends
  380. * to/receives from the endpoint2.
  381. * Supported values: 1 to 8.
  382. * The value is ignored for audio COPP or if endpoint_id_2 is
  383. * set to 0xFFFF.
  384. */
  385. u16 bit_width_eid2;
  386. /* Bit width (in bits) that the voice processor sends
  387. * to/receives from the endpoint2.
  388. * Supported values: 16 and 24.
  389. * The value is ignored for audio COPP or if endpoint_id_2 is
  390. * set to 0xFFFF.
  391. */
  392. u32 sample_rate_eid2;
  393. /* Sampling rate at which the voice processor Tx block
  394. * interfaces with the endpoint2.
  395. * Supported values for Tx voice processor: >0 and <=384 kHz
  396. * The value is ignored for audio COPP or if endpoint_id_2 is
  397. * set to 0xFFFF.
  398. */
  399. u8 dev_channel_mapping_eid2[8];
  400. /* Array of channel mapping of buffers that the voice processor
  401. * sends to the endpoint. Channel[i] mapping describes channel
  402. * I inside the buffer, where 0 < i < dev_num_channel.
  403. * This value is relevant only for the Tx voice processor.
  404. * The values are ignored for audio COPP or if endpoint_id_2 is
  405. * set to 0xFFFF.
  406. */
  407. } __packed;
  408. /* ADM device open endpoint payload the
  409. * #ADM_CMD_DEVICE_OPEN_V8 command.
  410. */
  411. struct adm_device_endpoint_payload {
  412. u16 dev_num_channel;
  413. /* Number of channels the audio COPP sends to/receives from
  414. * the endpoint.
  415. * Supported values: 1 to 32.
  416. * The value is ignored for the voice processor Tx block,
  417. * where channel
  418. * configuration is derived from the topology ID.
  419. */
  420. u16 bit_width;
  421. /* Bit width (in bits) that the audio COPP sends to/receives
  422. * from the
  423. * endpoint. The value is ignored for the voice processing
  424. * Tx block,
  425. * where the PCM width is 16 bits.
  426. */
  427. u32 sample_rate;
  428. /* Sampling rate at which the audio COPP/voice processor
  429. * Tx block
  430. * interfaces with the endpoint.
  431. * Supported values for voice processor Tx: 8000, 16000,
  432. * 48000 Hz
  433. * Supported values for audio COPP: >0 and <=192 kHz
  434. */
  435. u8 dev_channel_mapping[32];
  436. } __packed;
  437. /* ADM device open command payload of the
  438. * #ADM_CMD_DEVICE_OPEN_V8 command.
  439. */
  440. struct adm_cmd_device_open_v8 {
  441. struct apr_hdr hdr;
  442. u16 flags;
  443. /* Bit width Native mode enabled : 11th bit of flag parameter
  444. * If 11th bit of flag is set then that means matrix mixer will be
  445. * running in native mode for bit width for this device session.
  446. *
  447. * Channel Native mode enabled : 12th bit of flag parameter
  448. * If 12th bit of flag is set then that means matrix mixer will be
  449. * running in native mode for channel configuration for this device session.
  450. * All other bits are reserved; clients must set them to 0.
  451. */
  452. u16 mode_of_operation;
  453. /* Specifies whether the COPP must be opened on the Tx or Rx
  454. * path. Use the ADM_CMD_COPP_OPEN_MODE_OF_OPERATION_* macros for
  455. * supported values and interpretation.
  456. * Supported values:
  457. * - 0x1 -- Rx path COPP
  458. * - 0x2 -- Tx path live COPP
  459. * - 0x3 -- Tx path nonlive COPP
  460. * Live connections cause sample discarding in the Tx device
  461. * matrix if the destination output ports do not pull them
  462. * fast enough. Nonlive connections queue the samples
  463. * indefinitely.
  464. */
  465. u32 topology_id;
  466. /* Audio COPP topology ID; 32-bit GUID. */
  467. u16 endpoint_id_1;
  468. /* Logical and physical endpoint ID of the audio path.
  469. * If the ID is a voice processor Tx block, it receives near
  470. * samples.
  471. * Supported values: Any pseudoport, AFE Rx port,
  472. * or AFE Tx port For a list of valid IDs, refer to
  473. * @xhyperref{Q4,[Q4]}.
  474. * Q4 = Hexagon Multimedia: AFE Interface Specification
  475. */
  476. u16 endpoint_id_2;
  477. /* Logical and physical endpoint ID 2 for a voice processor
  478. * Tx block.
  479. * This is not applicable to audio COPP.
  480. * Supported values:
  481. * - AFE Rx port
  482. * - 0xFFFF -- Endpoint 2 is unavailable and the voice
  483. * processor Tx
  484. * block ignores this endpoint
  485. * When the voice processor Tx block is created on the audio
  486. * record path,
  487. * it can receive far-end samples from an AFE Rx port if the
  488. * voice call
  489. * is active. The ID of the AFE port is provided in this
  490. * field.
  491. * For a list of valid IDs, refer @xhyperref{Q4,[Q4]}.
  492. */
  493. u16 endpoint_id_3;
  494. /*
  495. * Logical and physical endpoint ID of the audio path.
  496. * This indicated afe rx port in ADM loopback use cases.
  497. * In all other use cases this should be set to 0xffff
  498. */
  499. u16 reserved;
  500. } __packed;
  501. /*
  502. * This command allows the client to close a COPP and disconnect
  503. * the device session.
  504. */
  505. #define ADM_CMD_DEVICE_CLOSE_V5 0x00010327
  506. /* Sets one or more parameters to a COPP. */
  507. #define ADM_CMD_SET_PP_PARAMS_V5 0x00010328
  508. #define ADM_CMD_SET_PP_PARAMS_V6 0x0001035D
  509. /*
  510. * Structure of the ADM Set PP Params command. Parameter data must be
  511. * pre-packed with correct header for either V2 or V3 when sent in-band.
  512. * Use q6core_pack_pp_params to pack the header and data correctly depending on
  513. * Instance ID support.
  514. */
  515. struct adm_cmd_set_pp_params {
  516. /* APR Header */
  517. struct apr_hdr apr_hdr;
  518. /* The memory mapping header to be used when sending out of band */
  519. struct mem_mapping_hdr mem_hdr;
  520. /*
  521. * Size in bytes of the variable payload accompanying this
  522. * message or
  523. * in shared memory. This is used for parsing the parameter
  524. * payload.
  525. */
  526. u32 payload_size;
  527. /*
  528. * Parameter data for in band payload. This should be structured as the
  529. * parameter header immediately followed by the parameter data. Multiple
  530. * parameters can be set in one command by repeating the header followed
  531. * by the data for as many parameters as need to be set.
  532. * Use q6core_pack_pp_params to pack the header and data correctly
  533. * depending on Instance ID support.
  534. */
  535. u8 param_data[0];
  536. } __packed;
  537. #define ASM_STREAM_CMD_REGISTER_PP_EVENTS 0x00013213
  538. #define ASM_STREAM_PP_EVENT 0x00013214
  539. #define ASM_STREAM_CMD_REGISTER_IEC_61937_FMT_UPDATE 0x1321C
  540. #define ASM_IEC_61937_MEDIA_FMT_EVENT 0x1321D
  541. #define DSP_STREAM_CMD "ADSP Stream Cmd"
  542. #define DSP_STREAM_CALLBACK "ADSP Stream Callback Event"
  543. #define DSP_STREAM_CALLBACK_QUEUE_SIZE 1024
  544. struct dsp_stream_callback_list {
  545. struct list_head list;
  546. struct msm_adsp_event_data event;
  547. };
  548. struct dsp_stream_callback_prtd {
  549. uint16_t event_count;
  550. struct list_head event_queue;
  551. spinlock_t prtd_spin_lock;
  552. };
  553. /* set customized mixing on matrix mixer */
  554. #define ADM_CMD_SET_PSPD_MTMX_STRTR_PARAMS_V5 0x00010344
  555. struct adm_cmd_set_pspd_mtmx_strtr_params_v5 {
  556. struct apr_hdr hdr;
  557. /* LSW of parameter data payload address.*/
  558. u32 payload_addr_lsw;
  559. /* MSW of parameter data payload address.*/
  560. u32 payload_addr_msw;
  561. /* Memory map handle returned by ADM_CMD_SHARED_MEM_MAP_REGIONS */
  562. /* command. If mem_map_handle is zero implies the message is in */
  563. /* the payload */
  564. u32 mem_map_handle;
  565. /* Size in bytes of the variable payload accompanying this */
  566. /* message or in shared memory. This is used for parsing the */
  567. /* parameter payload. */
  568. u32 payload_size;
  569. u16 direction;
  570. u16 sessionid;
  571. u16 deviceid;
  572. u16 reserved;
  573. } __packed;
  574. /* set customized mixing on matrix mixer.
  575. * Updated to account for both LSM as well as ASM path.
  576. */
  577. #define ADM_CMD_SET_PSPD_MTMX_STRTR_PARAMS_V6 0x00010364
  578. struct adm_cmd_set_pspd_mtmx_strtr_params_v6 {
  579. struct apr_hdr hdr;
  580. /* LSW of parameter data payload address.*/
  581. u32 payload_addr_lsw;
  582. /* MSW of parameter data payload address.*/
  583. u32 payload_addr_msw;
  584. /* Memory map handle returned by ADM_CMD_SHARED_MEM_MAP_REGIONS */
  585. /* command. If mem_map_handle is zero implies the message is in */
  586. /* the payload */
  587. u32 mem_map_handle;
  588. /* Size in bytes of the variable payload accompanying this */
  589. /* message or in shared memory. This is used for parsing the */
  590. /* parameter payload. */
  591. u32 payload_size;
  592. u16 direction;
  593. u16 sessionid;
  594. u16 deviceid;
  595. u16 stream_type;
  596. } __packed;
  597. /* Returns the status and COPP ID to an #ADM_CMD_DEVICE_OPEN_V5 command.
  598. */
  599. #define ADM_CMDRSP_DEVICE_OPEN_V5 0x00010329
  600. /* Payload of the #ADM_CMDRSP_DEVICE_OPEN_V5 message,
  601. * which returns the
  602. * status and COPP ID to an #ADM_CMD_DEVICE_OPEN_V5 command.
  603. */
  604. struct adm_cmd_rsp_device_open_v5 {
  605. u32 status;
  606. /* Status message (error code).*/
  607. u16 copp_id;
  608. /* COPP ID: Supported values: 0 <= copp_id < ADM_MAX_COPPS*/
  609. u16 reserved;
  610. /* Reserved. This field must be set to zero.*/
  611. } __packed;
  612. /* Returns the status and COPP ID to an #ADM_CMD_DEVICE_OPEN_V6 command. */
  613. #define ADM_CMDRSP_DEVICE_OPEN_V6 0x00010357
  614. /* Returns the status and COPP ID to an #ADM_CMD_DEVICE_OPEN_V8 command. */
  615. #define ADM_CMDRSP_DEVICE_OPEN_V8 0x0001036B
  616. /* Payload of the #ADM_CMDRSP_DEVICE_OPEN_V6 message,
  617. * which returns the
  618. * status and COPP ID to an #ADM_CMD_DEVICE_OPEN_V6 command
  619. * is the exact same as ADM_CMDRSP_DEVICE_OPEN_V5.
  620. */
  621. /* This command allows a query of one COPP parameter. */
  622. #define ADM_CMD_GET_PP_PARAMS_V5 0x0001032A
  623. #define ADM_CMD_GET_PP_PARAMS_V6 0x0001035E
  624. /*
  625. * Structure of the ADM Get PP Params command. Parameter header must be
  626. * packed correctly for either V2 or V3. Use q6core_pack_pp_params to pack the
  627. * header correctly depending on Instance ID support.
  628. */
  629. struct adm_cmd_get_pp_params {
  630. struct apr_hdr apr_hdr;
  631. /* The memory mapping header to be used when requesting outband */
  632. struct mem_mapping_hdr mem_hdr;
  633. /* Parameter header for in band payload. */
  634. union param_hdrs param_hdr;
  635. } __packed;
  636. /* Returns parameter values
  637. * in response to an #ADM_CMD_GET_PP_PARAMS_V5 command.
  638. */
  639. #define ADM_CMDRSP_GET_PP_PARAMS_V5 0x0001032B
  640. /* Payload of the #ADM_CMDRSP_GET_PP_PARAMS_V5 message,
  641. * which returns parameter values in response
  642. * to an #ADM_CMD_GET_PP_PARAMS_V5 command.
  643. * Immediately following this
  644. * structure is the param_hdr_v1
  645. * structure containing the pre/postprocessing
  646. * parameter data. For an in-band
  647. * scenario, the variable payload depends
  648. * on the size of the parameter.
  649. */
  650. struct adm_cmd_rsp_get_pp_params_v5 {
  651. /* Status message (error code).*/
  652. u32 status;
  653. /* The header that identifies the subsequent parameter data */
  654. struct param_hdr_v1 param_hdr;
  655. /* The parameter data returned */
  656. u32 param_data[0];
  657. } __packed;
  658. /*
  659. * Returns parameter values in response to an #ADM_CMD_GET_PP_PARAMS_V5/6
  660. * command.
  661. */
  662. #define ADM_CMDRSP_GET_PP_PARAMS_V6 0x0001035F
  663. /*
  664. * Payload of the #ADM_CMDRSP_GET_PP_PARAMS_V6 message,
  665. * which returns parameter values in response
  666. * to an #ADM_CMD_GET_PP_PARAMS_V6 command.
  667. * Immediately following this
  668. * structure is the param_hdr_v3
  669. * structure containing the pre/postprocessing
  670. * parameter data. For an in-band
  671. * scenario, the variable payload depends
  672. * on the size of the parameter.
  673. */
  674. struct adm_cmd_rsp_get_pp_params_v6 {
  675. /* Status message (error code).*/
  676. u32 status;
  677. /* The header that identifies the subsequent parameter data */
  678. struct param_hdr_v3 param_hdr;
  679. /* The parameter data returned */
  680. u32 param_data[0];
  681. } __packed;
  682. /* Structure for holding soft stepping volume parameters. */
  683. /*
  684. * Payload of the #ASM_PARAM_ID_SOFT_VOL_STEPPING_PARAMETERS
  685. * parameters used by the Volume Control module.
  686. */
  687. struct audproc_softvolume_params {
  688. u32 period;
  689. u32 step;
  690. u32 rampingcurve;
  691. } __packed;
  692. /*
  693. * ID of the Media Format Converter (MFC) module.
  694. * This module supports the following parameter IDs:
  695. * #AUDPROC_PARAM_ID_MFC_OUTPUT_MEDIA_FORMAT
  696. * #AUDPROC_CHMIXER_PARAM_ID_COEFF
  697. */
  698. #define AUDPROC_MODULE_ID_MFC 0x00010912
  699. /* ID of the Output Media Format parameters used by AUDPROC_MODULE_ID_MFC.
  700. *
  701. */
  702. #define AUDPROC_PARAM_ID_MFC_OUTPUT_MEDIA_FORMAT 0x00010913
  703. /* Param ID of Channel Mixer used by AUDPROC_MODULE_ID_MFC */
  704. #define AUDPROC_CHMIXER_PARAM_ID_COEFF 0x00010342
  705. /*
  706. * ID of the Media Format Converter (MFC) module present in EC REF COPP.
  707. * This module supports the all param IDs supported by AUDPROC_MODULE_ID_MFC.
  708. */
  709. #define AUDPROC_MODULE_ID_MFC_EC_REF 0x0001092C
  710. struct adm_cmd_set_pp_params_v5 {
  711. struct apr_hdr hdr;
  712. u32 payload_addr_lsw;
  713. /* LSW of parameter data payload address.*/
  714. u32 payload_addr_msw;
  715. /* MSW of parameter data payload address.*/
  716. u32 mem_map_handle;
  717. /*
  718. * Memory map handle returned by ADM_CMD_SHARED_MEM_MAP_REGIONS
  719. * command.
  720. * If mem_map_handle is zero implies the message is in
  721. * the payload
  722. */
  723. u32 payload_size;
  724. /*
  725. * Size in bytes of the variable payload accompanying this
  726. * message or
  727. * in shared memory. This is used for parsing the parameter
  728. * payload.
  729. */
  730. } __packed;
  731. /* Maximum number of channels supported by MFC media fmt params */
  732. #define AUDPROC_MFC_OUT_CHANNELS_MAX 8
  733. struct audproc_mfc_param_media_fmt {
  734. uint32_t sampling_rate;
  735. uint16_t bits_per_sample;
  736. uint16_t num_channels;
  737. uint16_t channel_type[AUDPROC_MFC_OUT_CHANNELS_MAX];
  738. } __packed;
  739. struct audproc_volume_ctrl_master_gain {
  740. /* Linear gain in Q13 format. */
  741. uint16_t master_gain;
  742. /* Clients must set this field to zero. */
  743. uint16_t reserved;
  744. } __packed;
  745. struct audproc_soft_step_volume_params {
  746. /*
  747. * Period in milliseconds.
  748. * Supported values: 0 to 15000
  749. */
  750. uint32_t period;
  751. /*
  752. * Step in microseconds.
  753. * Supported values: 0 to 15000000
  754. */
  755. uint32_t step;
  756. /*
  757. * Ramping curve type.
  758. * Supported values:
  759. * - #AUDPROC_PARAM_SVC_RAMPINGCURVE_LINEAR
  760. * - #AUDPROC_PARAM_SVC_RAMPINGCURVE_EXP
  761. * - #AUDPROC_PARAM_SVC_RAMPINGCURVE_LOG
  762. */
  763. uint32_t ramping_curve;
  764. } __packed;
  765. struct audproc_enable_param_t {
  766. /*
  767. * Specifies whether the Audio processing module is enabled.
  768. * This parameter is generic/common parameter to configure or
  769. * determine the state of any audio processing module.
  770. * @values 0 : Disable 1: Enable
  771. */
  772. uint32_t enable;
  773. };
  774. /*
  775. * Allows a client to control the gains on various session-to-COPP paths.
  776. */
  777. #define ADM_CMD_MATRIX_RAMP_GAINS_V5 0x0001032C
  778. /*
  779. * Allows a client to control the gains on various session-to-COPP paths.
  780. * Maximum support 32 channels
  781. */
  782. #define ADM_CMD_MATRIX_RAMP_GAINS_V7 0x0001036C
  783. /* Indicates that the target gain in the
  784. * current adm_session_copp_gain_v5
  785. * structure is to be applied to all
  786. * the session-to-COPP paths that exist for
  787. * the specified session.
  788. */
  789. #define ADM_CMD_MATRIX_RAMP_GAINS_COPP_ID_ALL_CONNECTED_COPPS 0xFFFF
  790. /* Indicates that the target gain is
  791. * to be immediately applied to the
  792. * specified session-to-COPP path,
  793. * without a ramping fashion.
  794. */
  795. #define ADM_CMD_MATRIX_RAMP_GAINS_RAMP_DURATION_IMMEDIATE 0x0000
  796. /* Enumeration for a linear ramping curve.*/
  797. #define ADM_CMD_MATRIX_RAMP_GAINS_RAMP_CURVE_LINEAR 0x0000
  798. /* Payload of the #ADM_CMD_MATRIX_RAMP_GAINS_V5 command.
  799. * Immediately following this structure are num_gains of the
  800. * adm_session_copp_gain_v5structure.
  801. */
  802. struct adm_cmd_matrix_ramp_gains_v5 {
  803. u32 matrix_id;
  804. /* Specifies whether the matrix ID is Audio Rx (0) or Audio Tx (1).
  805. * Use the ADM_MATRIX_ID_AUDIO_RX or ADM_MATRIX_ID_AUDIOX
  806. * macros to set this field.
  807. */
  808. u16 num_gains;
  809. /* Number of gains being applied. */
  810. u16 reserved_for_align;
  811. /* Reserved. This field must be set to zero.*/
  812. } __packed;
  813. /* Session-to-COPP path gain structure, used by the
  814. * #ADM_CMD_MATRIX_RAMP_GAINS_V5 command.
  815. * This structure specifies the target
  816. * gain (per channel) that must be applied
  817. * to a particular session-to-COPP path in
  818. * the audio matrix. The structure can
  819. * also be used to apply the gain globally
  820. * to all session-to-COPP paths that
  821. * exist for the given session.
  822. * The aDSP uses device channel mapping to
  823. * determine which channel gains to
  824. * use from this command. For example,
  825. * if the device is configured as stereo,
  826. * the aDSP uses only target_gain_ch_1 and
  827. * target_gain_ch_2, and it ignores
  828. * the others.
  829. */
  830. struct adm_session_copp_gain_v5 {
  831. u16 session_id;
  832. /* Handle of the ASM session.
  833. * Supported values: 1 to 8.
  834. */
  835. u16 copp_id;
  836. /* Handle of the COPP. Gain will be applied on the Session ID
  837. * COPP ID path.
  838. */
  839. u16 ramp_duration;
  840. /* Duration (in milliseconds) of the ramp over
  841. * which target gains are
  842. * to be applied. Use
  843. * #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_DURATION_IMMEDIATE
  844. * to indicate that gain must be applied immediately.
  845. */
  846. u16 step_duration;
  847. /* Duration (in milliseconds) of each step in the ramp.
  848. * This parameter is ignored if ramp_duration is equal to
  849. * #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_DURATION_IMMEDIATE.
  850. * Supported value: 1
  851. */
  852. u16 ramp_curve;
  853. /* Type of ramping curve.
  854. * Supported value: #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_CURVE_LINEAR
  855. */
  856. u16 reserved_for_align;
  857. /* Reserved. This field must be set to zero. */
  858. u16 target_gain_ch_1;
  859. /* Target linear gain for channel 1 in Q13 format; */
  860. u16 target_gain_ch_2;
  861. /* Target linear gain for channel 2 in Q13 format; */
  862. u16 target_gain_ch_3;
  863. /* Target linear gain for channel 3 in Q13 format; */
  864. u16 target_gain_ch_4;
  865. /* Target linear gain for channel 4 in Q13 format; */
  866. u16 target_gain_ch_5;
  867. /* Target linear gain for channel 5 in Q13 format; */
  868. u16 target_gain_ch_6;
  869. /* Target linear gain for channel 6 in Q13 format; */
  870. u16 target_gain_ch_7;
  871. /* Target linear gain for channel 7 in Q13 format; */
  872. u16 target_gain_ch_8;
  873. /* Target linear gain for channel 8 in Q13 format; */
  874. } __packed;
  875. /* Payload of the #ADM_CMD_MATRIX_RAMP_GAINS_V7 command.
  876. * Immediately following this structure are num_gains of the
  877. * adm_session_copp_gain_v5structure.
  878. */
  879. struct adm_cmd_matrix_ramp_gains_v7 {
  880. struct apr_hdr hdr;
  881. u32 matrix_id;
  882. /* Specifies whether the matrix ID is Audio Rx (0) or Audio Tx (1).
  883. * Use the ADM_MATRIX_ID_AUDIO_RX or ADM_MATRIX_ID_AUDIOX
  884. * macros to set this field.
  885. */
  886. u16 num_gains;
  887. /* Number of gains being applied. */
  888. u16 reserved_for_align;
  889. /* Reserved. This field must be set to zero.*/
  890. } __packed;
  891. /* Session-to-COPP path gain structure, used by the
  892. * #ADM_CMD_MATRIX_RAMP_GAINS_V7 command.
  893. * This structure specifies the target
  894. * gain (per channel) that must be applied
  895. * to a particular session-to-COPP path in
  896. * the audio matrix. The structure can
  897. * also be used to apply the gain globally
  898. * to all session-to-COPP paths that
  899. * exist for the given session.
  900. * The aDSP uses device channel mapping to
  901. * determine which channel gains to
  902. * use from this command. For example,
  903. * if the device is configured as stereo,
  904. * the aDSP uses only target_gain_ch_1 and
  905. * target_gain_ch_2, and it ignores
  906. * the others.
  907. */
  908. struct adm_session_copp_gain_v7 {
  909. u16 session_id;
  910. /* Handle of the ASM session.
  911. * Supported values: 1 to 8.
  912. */
  913. u16 copp_id;
  914. /* Handle of the COPP. Gain will be applied on the Session ID
  915. * COPP ID path.
  916. */
  917. u16 ramp_duration;
  918. /* Duration (in milliseconds) of the ramp over
  919. * which target gains are
  920. * to be applied. Use
  921. * #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_DURATION_IMMEDIATE
  922. * to indicate that gain must be applied immediately.
  923. */
  924. u16 step_duration;
  925. /* Duration (in milliseconds) of each step in the ramp.
  926. * This parameter is ignored if ramp_duration is equal to
  927. * #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_DURATION_IMMEDIATE.
  928. * Supported value: 1
  929. */
  930. u16 ramp_curve;
  931. /* Type of ramping curve.
  932. * Supported value: #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_CURVE_LINEAR
  933. */
  934. u16 stream_type;
  935. /* Type of stream_type.
  936. * Supported value: #STREAM_TYPE_ASM STREAM_TYPE_LSM
  937. */
  938. u16 num_channels;
  939. /* Number of channels on which gain needs to be applied.
  940. * Supported value: 1 to 32.
  941. */
  942. u16 reserved_for_align;
  943. /* Reserved. This field must be set to zero. */
  944. } __packed;
  945. /* Allows to set mute/unmute on various session-to-COPP paths.
  946. * For every session-to-COPP path (stream-device interconnection),
  947. * mute/unmute can be set individually on the output channels.
  948. */
  949. #define ADM_CMD_MATRIX_MUTE_V5 0x0001032D
  950. /* Allows to set mute/unmute on various session-to-COPP paths.
  951. * For every session-to-COPP path (stream-device interconnection),
  952. * mute/unmute can be set individually on the output channels.
  953. */
  954. #define ADM_CMD_MATRIX_MUTE_V7 0x0001036D
  955. /* Indicates that mute/unmute in the
  956. * current adm_session_copp_mute_v5structure
  957. * is to be applied to all the session-to-COPP
  958. * paths that exist for the specified session.
  959. */
  960. #define ADM_CMD_MATRIX_MUTE_COPP_ID_ALL_CONNECTED_COPPS 0xFFFF
  961. /* Payload of the #ADM_CMD_MATRIX_MUTE_V5 command*/
  962. struct adm_cmd_matrix_mute_v5 {
  963. u32 matrix_id;
  964. /* Specifies whether the matrix ID is Audio Rx (0) or Audio Tx (1).
  965. * Use the ADM_MATRIX_ID_AUDIO_RX or ADM_MATRIX_ID_AUDIOX
  966. * macros to set this field.
  967. */
  968. u16 session_id;
  969. /* Handle of the ASM session.
  970. * Supported values: 1 to 8.
  971. */
  972. u16 copp_id;
  973. /* Handle of the COPP.
  974. * Use ADM_CMD_MATRIX_MUTE_COPP_ID_ALL_CONNECTED_COPPS
  975. * to indicate that mute/unmute must be applied to
  976. * all the COPPs connected to session_id.
  977. * Supported values:
  978. * - 0xFFFF -- Apply mute/unmute to all connected COPPs
  979. * - Other values -- Valid COPP ID
  980. */
  981. u8 mute_flag_ch_1;
  982. /* Mute flag for channel 1 is set to unmute (0) or mute (1). */
  983. u8 mute_flag_ch_2;
  984. /* Mute flag for channel 2 is set to unmute (0) or mute (1). */
  985. u8 mute_flag_ch_3;
  986. /* Mute flag for channel 3 is set to unmute (0) or mute (1). */
  987. u8 mute_flag_ch_4;
  988. /* Mute flag for channel 4 is set to unmute (0) or mute (1). */
  989. u8 mute_flag_ch_5;
  990. /* Mute flag for channel 5 is set to unmute (0) or mute (1). */
  991. u8 mute_flag_ch_6;
  992. /* Mute flag for channel 6 is set to unmute (0) or mute (1). */
  993. u8 mute_flag_ch_7;
  994. /* Mute flag for channel 7 is set to unmute (0) or mute (1). */
  995. u8 mute_flag_ch_8;
  996. /* Mute flag for channel 8 is set to unmute (0) or mute (1). */
  997. u16 ramp_duration;
  998. /* Period (in milliseconds) over which the soft mute/unmute will be
  999. * applied.
  1000. * Supported values: 0 (Default) to 0xFFFF
  1001. * The default of 0 means mute/unmute will be applied immediately.
  1002. */
  1003. u16 reserved_for_align;
  1004. /* Clients must set this field to zero.*/
  1005. } __packed;
  1006. /* Payload of the #ADM_CMD_MATRIX_MUTE_V7 command*/
  1007. struct adm_cmd_matrix_mute_v7 {
  1008. struct apr_hdr hdr;
  1009. u32 matrix_id;
  1010. /* Specifies whether the matrix ID is Audio Rx (0) or Audio Tx (1).
  1011. * Use the ADM_MATRIX_ID_AUDIO_RX or ADM_MATRIX_ID_AUDIOX
  1012. * macros to set this field.
  1013. */
  1014. u16 session_id;
  1015. /* Handle of the ASM session.
  1016. * Supported values: 1 to .
  1017. */
  1018. u16 copp_id;
  1019. /* Handle of the COPP.
  1020. * Use ADM_CMD_MATRIX_MUTE_COPP_ID_ALL_CONNECTED_COPPS
  1021. * to indicate that mute/unmute must be applied to
  1022. * all the COPPs connected to session_id.
  1023. * Supported values:
  1024. * - 0xFFFF -- Apply mute/unmute to all connected COPPs
  1025. * - Other values -- Valid COPP ID
  1026. */
  1027. u16 ramp_duration;
  1028. /* Duration (in milliseconds) of the ramp over
  1029. * which target gains are
  1030. * to be applied. Use
  1031. * #ADM_CMD_MATRIX_RAMP_GAINS_RAMP_DURATION_IMMEDIATE
  1032. * to indicate that gain must be applied immediately.
  1033. */
  1034. u16 stream_type;
  1035. /* Specify whether the stream type is connectedon the ASM or LSM
  1036. * Supported value: 1
  1037. */
  1038. u16 num_channels;
  1039. /* Number of channels on which gain needs to be applied
  1040. * Supported value: 1 to 32
  1041. */
  1042. } __packed;
  1043. #define ASM_PARAM_ID_AAC_STEREO_MIX_COEFF_SELECTION_FLAG_V2 (0x00010DD8)
  1044. struct asm_aac_stereo_mix_coeff_selection_param_v2 {
  1045. struct apr_hdr hdr;
  1046. u32 param_id;
  1047. u32 param_size;
  1048. u32 aac_stereo_mix_coeff_flag;
  1049. } __packed;
  1050. /* Allows a client to connect the desired stream to
  1051. * the desired AFE port through the stream router
  1052. *
  1053. * This command allows the client to connect specified session to
  1054. * specified AFE port. This is used for compressed streams only
  1055. * opened using the #ASM_STREAM_CMD_OPEN_WRITE_COMPRESSED or
  1056. * #ASM_STREAM_CMD_OPEN_READ_COMPRESSED command.
  1057. *
  1058. * @prerequisites
  1059. * Session ID and AFE Port ID must be valid.
  1060. * #ASM_STREAM_CMD_OPEN_WRITE_COMPRESSED or
  1061. * #ASM_STREAM_CMD_OPEN_READ_COMPRESSED
  1062. * must have been called on this session.
  1063. */
  1064. #define ADM_CMD_CONNECT_AFE_PORT_V5 0x0001032E
  1065. #define ADM_CMD_DISCONNECT_AFE_PORT_V5 0x0001032F
  1066. /* Enumeration for the Rx stream router ID.*/
  1067. #define ADM_STRTR_ID_RX 0
  1068. /* Enumeration for the Tx stream router ID.*/
  1069. #define ADM_STRTR_IDX 1
  1070. /* Payload of the #ADM_CMD_CONNECT_AFE_PORT_V5 command.*/
  1071. struct adm_cmd_connect_afe_port_v5 {
  1072. struct apr_hdr hdr;
  1073. u8 mode;
  1074. /* ID of the stream router (RX/TX). Use the
  1075. * ADM_STRTR_ID_RX or ADM_STRTR_IDX macros
  1076. * to set this field.
  1077. */
  1078. u8 session_id;
  1079. /* Session ID of the stream to connect */
  1080. u16 afe_port_id;
  1081. /* Port ID of the AFE port to connect to.*/
  1082. u32 num_channels;
  1083. /* Number of device channels
  1084. * Supported values: 2(Audio Sample Packet),
  1085. * 8 (HBR Audio Stream Sample Packet)
  1086. */
  1087. u32 sampling_rate;
  1088. /* Device sampling rate
  1089. * Supported values: Any
  1090. */
  1091. } __packed;
  1092. /* adsp_adm_api.h */
  1093. /* Port ID. Update afe_get_port_index
  1094. * when a new port is added here.
  1095. */
  1096. #define PRIMARY_I2S_RX 0
  1097. #define PRIMARY_I2S_TX 1
  1098. #define SECONDARY_I2S_RX 4
  1099. #define SECONDARY_I2S_TX 5
  1100. #define MI2S_RX 6
  1101. #define MI2S_TX 7
  1102. #define HDMI_RX 8
  1103. #define RSVD_2 9
  1104. #define RSVD_3 10
  1105. #define DIGI_MIC_TX 11
  1106. #define VOICE2_PLAYBACK_TX 0x8002
  1107. #define VOICE_RECORD_RX 0x8003
  1108. #define VOICE_RECORD_TX 0x8004
  1109. #define VOICE_PLAYBACK_TX 0x8005
  1110. /* Slimbus Multi channel port id pool */
  1111. #define SLIMBUS_0_RX 0x4000
  1112. #define SLIMBUS_0_TX 0x4001
  1113. #define SLIMBUS_1_RX 0x4002
  1114. #define SLIMBUS_1_TX 0x4003
  1115. #define SLIMBUS_2_RX 0x4004
  1116. #define SLIMBUS_2_TX 0x4005
  1117. #define SLIMBUS_3_RX 0x4006
  1118. #define SLIMBUS_3_TX 0x4007
  1119. #define SLIMBUS_4_RX 0x4008
  1120. #define SLIMBUS_4_TX 0x4009
  1121. #define SLIMBUS_5_RX 0x400a
  1122. #define SLIMBUS_5_TX 0x400b
  1123. #define SLIMBUS_6_RX 0x400c
  1124. #define SLIMBUS_6_TX 0x400d
  1125. #define SLIMBUS_7_RX 0x400e
  1126. #define SLIMBUS_7_TX 0x400f
  1127. #define SLIMBUS_8_RX 0x4010
  1128. #define SLIMBUS_8_TX 0x4011
  1129. #define SLIMBUS_9_RX 0x4012
  1130. #define SLIMBUS_9_TX 0x4013
  1131. #define SLIMBUS_PORT_LAST SLIMBUS_9_TX
  1132. #define INT_BT_SCO_RX 0x3000
  1133. #define INT_BT_SCO_TX 0x3001
  1134. #define INT_BT_A2DP_RX 0x3002
  1135. #define INT_FM_RX 0x3004
  1136. #define INT_FM_TX 0x3005
  1137. #define RT_PROXY_PORT_001_RX 0x2000
  1138. #define RT_PROXY_PORT_001_TX 0x2001
  1139. #define AFE_LOOPBACK_TX 0x6001
  1140. #define DISPLAY_PORT_RX 0x6020
  1141. #define AFE_LANE_MASK_INVALID 0
  1142. #define AFE_PORT_INVALID 0xFFFF
  1143. #define SLIMBUS_INVALID AFE_PORT_INVALID
  1144. #define AFE_PORT_CMD_START 0x000100ca
  1145. #define AFE_EVENT_RTPORT_START 0
  1146. #define AFE_EVENT_RTPORT_STOP 1
  1147. #define AFE_EVENT_RTPORT_LOW_WM 2
  1148. #define AFE_EVENT_RTPORT_HI_WM 3
  1149. #define ADSP_AFE_VERSION 0x00200000
  1150. /* Size of the range of port IDs for the audio interface. */
  1151. #define AFE_PORT_ID_AUDIO_IF_PORT_RANGE_SIZE 0xF
  1152. /* Size of the range of port IDs for internal BT-FM ports. */
  1153. #define AFE_PORT_ID_INTERNAL_BT_FM_RANGE_SIZE 0x6
  1154. /* Size of the range of port IDs for SLIMbus<sup>&reg;
  1155. * </sup> multichannel
  1156. * ports.
  1157. */
  1158. #define AFE_PORT_ID_SLIMBUS_RANGE_SIZE 0xA
  1159. /* Size of the range of port IDs for real-time proxy ports. */
  1160. #define AFE_PORT_ID_RT_PROXY_PORT_RANGE_SIZE 0x2
  1161. /* Size of the range of port IDs for pseudoports. */
  1162. #define AFE_PORT_ID_PSEUDOPORT_RANGE_SIZE 0x5
  1163. /* Start of the range of port IDs for the audio interface. */
  1164. #define AFE_PORT_ID_AUDIO_IF_PORT_RANGE_START 0x1000
  1165. /* End of the range of port IDs for the audio interface. */
  1166. #define AFE_PORT_ID_AUDIO_IF_PORT_RANGE_END \
  1167. (AFE_PORT_ID_AUDIO_IF_PORT_RANGE_START +\
  1168. AFE_PORT_ID_AUDIO_IF_PORT_RANGE_SIZE - 1)
  1169. /* Start of the range of port IDs for real-time proxy ports. */
  1170. #define AFE_PORT_ID_RT_PROXY_PORT_RANGE_START 0x2000
  1171. /* End of the range of port IDs for real-time proxy ports. */
  1172. #define AFE_PORT_ID_RT_PROXY_PORT_RANGE_END \
  1173. (AFE_PORT_ID_RT_PROXY_PORT_RANGE_START +\
  1174. AFE_PORT_ID_RT_PROXY_PORT_RANGE_SIZE-1)
  1175. /* Start of the range of port IDs for internal BT-FM devices. */
  1176. #define AFE_PORT_ID_INTERNAL_BT_FM_RANGE_START 0x3000
  1177. /* End of the range of port IDs for internal BT-FM devices. */
  1178. #define AFE_PORT_ID_INTERNAL_BT_FM_RANGE_END \
  1179. (AFE_PORT_ID_INTERNAL_BT_FM_RANGE_START +\
  1180. AFE_PORT_ID_INTERNAL_BT_FM_RANGE_SIZE-1)
  1181. /* Start of the range of port IDs for SLIMbus devices. */
  1182. #define AFE_PORT_ID_SLIMBUS_RANGE_START 0x4000
  1183. /* End of the range of port IDs for SLIMbus devices. */
  1184. #define AFE_PORT_ID_SLIMBUS_RANGE_END \
  1185. (AFE_PORT_ID_SLIMBUS_RANGE_START +\
  1186. AFE_PORT_ID_SLIMBUS_RANGE_SIZE-1)
  1187. /* Start of the range of port IDs for pseudoports. */
  1188. #define AFE_PORT_ID_PSEUDOPORT_RANGE_START 0x8001
  1189. /* End of the range of port IDs for pseudoports. */
  1190. #define AFE_PORT_ID_PSEUDOPORT_RANGE_END \
  1191. (AFE_PORT_ID_PSEUDOPORT_RANGE_START +\
  1192. AFE_PORT_ID_PSEUDOPORT_RANGE_SIZE-1)
  1193. /* Start of the range of port IDs for TDM devices. */
  1194. #define AFE_PORT_ID_TDM_PORT_RANGE_START 0x9000
  1195. /* End of the range of port IDs for TDM devices. */
  1196. #define AFE_PORT_ID_TDM_PORT_RANGE_END \
  1197. (AFE_PORT_ID_TDM_PORT_RANGE_START+0x60-1)
  1198. /* Size of the range of port IDs for TDM ports. */
  1199. #define AFE_PORT_ID_TDM_PORT_RANGE_SIZE \
  1200. (AFE_PORT_ID_TDM_PORT_RANGE_END - \
  1201. AFE_PORT_ID_TDM_PORT_RANGE_START+1)
  1202. #define AFE_PORT_ID_PRIMARY_MI2S_RX 0x1000
  1203. #define AFE_PORT_ID_PRIMARY_MI2S_TX 0x1001
  1204. #define AFE_PORT_ID_SECONDARY_MI2S_RX 0x1002
  1205. #define AFE_PORT_ID_SECONDARY_MI2S_TX 0x1003
  1206. #define AFE_PORT_ID_TERTIARY_MI2S_RX 0x1004
  1207. #define AFE_PORT_ID_TERTIARY_MI2S_TX 0x1005
  1208. #define AFE_PORT_ID_QUATERNARY_MI2S_RX 0x1006
  1209. #define AFE_PORT_ID_QUATERNARY_MI2S_TX 0x1007
  1210. #define AUDIO_PORT_ID_I2S_RX 0x1008
  1211. #define AFE_PORT_ID_DIGITAL_MIC_TX 0x1009
  1212. #define AFE_PORT_ID_PRIMARY_PCM_RX 0x100A
  1213. #define AFE_PORT_ID_PRIMARY_PCM_TX 0x100B
  1214. #define AFE_PORT_ID_SECONDARY_PCM_RX 0x100C
  1215. #define AFE_PORT_ID_SECONDARY_PCM_TX 0x100D
  1216. #define AFE_PORT_ID_MULTICHAN_HDMI_RX 0x100E
  1217. #define AFE_PORT_ID_SECONDARY_MI2S_RX_SD1 0x1010
  1218. #define AFE_PORT_ID_TERTIARY_PCM_RX 0x1012
  1219. #define AFE_PORT_ID_TERTIARY_PCM_TX 0x1013
  1220. #define AFE_PORT_ID_QUATERNARY_PCM_RX 0x1014
  1221. #define AFE_PORT_ID_QUATERNARY_PCM_TX 0x1015
  1222. #define AFE_PORT_ID_QUINARY_MI2S_RX 0x1016
  1223. #define AFE_PORT_ID_QUINARY_MI2S_TX 0x1017
  1224. /* ID of the senary MI2S Rx port. */
  1225. #define AFE_PORT_ID_SENARY_MI2S_RX 0x1018
  1226. /* ID of the senary MI2S Tx port. */
  1227. #define AFE_PORT_ID_SENARY_MI2S_TX 0x1019
  1228. /* ID of the Internal 0 MI2S Rx port */
  1229. #define AFE_PORT_ID_INT0_MI2S_RX 0x102E
  1230. /* ID of the Internal 0 MI2S Tx port */
  1231. #define AFE_PORT_ID_INT0_MI2S_TX 0x102F
  1232. /* ID of the Internal 1 MI2S Rx port */
  1233. #define AFE_PORT_ID_INT1_MI2S_RX 0x1030
  1234. /* ID of the Internal 1 MI2S Tx port */
  1235. #define AFE_PORT_ID_INT1_MI2S_TX 0x1031
  1236. /* ID of the Internal 2 MI2S Rx port */
  1237. #define AFE_PORT_ID_INT2_MI2S_RX 0x1032
  1238. /* ID of the Internal 2 MI2S Tx port */
  1239. #define AFE_PORT_ID_INT2_MI2S_TX 0x1033
  1240. /* ID of the Internal 3 MI2S Rx port */
  1241. #define AFE_PORT_ID_INT3_MI2S_RX 0x1034
  1242. /* ID of the Internal 3 MI2S Tx port */
  1243. #define AFE_PORT_ID_INT3_MI2S_TX 0x1035
  1244. /* ID of the Internal 4 MI2S Rx port */
  1245. #define AFE_PORT_ID_INT4_MI2S_RX 0x1036
  1246. /* ID of the Internal 4 MI2S Tx port */
  1247. #define AFE_PORT_ID_INT4_MI2S_TX 0x1037
  1248. /* ID of the Internal 5 MI2S Rx port */
  1249. #define AFE_PORT_ID_INT5_MI2S_RX 0x1038
  1250. /* ID of the Internal 5 MI2S Tx port */
  1251. #define AFE_PORT_ID_INT5_MI2S_TX 0x1039
  1252. /* ID of the Internal 6 MI2S Rx port */
  1253. #define AFE_PORT_ID_INT6_MI2S_RX 0x103A
  1254. /* ID of the Internal 6 MI2S Tx port */
  1255. #define AFE_PORT_ID_INT6_MI2S_TX 0x103B
  1256. #define AFE_PORT_ID_QUINARY_PCM_RX 0x103C
  1257. #define AFE_PORT_ID_QUINARY_PCM_TX 0x103D
  1258. /* ID of the senary auxiliary PCM Rx port. */
  1259. #define AFE_PORT_ID_SENARY_PCM_RX 0x103E
  1260. /* ID of the senary auxiliary PCM Tx port. */
  1261. #define AFE_PORT_ID_SENARY_PCM_TX 0x103F
  1262. #define AFE_PORT_ID_PRIMARY_SPDIF_RX 0x5000
  1263. #define AFE_PORT_ID_PRIMARY_SPDIF_TX 0x5001
  1264. #define AFE_PORT_ID_SECONDARY_SPDIF_RX 0x5002
  1265. #define AFE_PORT_ID_SECONDARY_SPDIF_TX 0x5003
  1266. #define AFE_PORT_ID_SPDIF_RX AFE_PORT_ID_PRIMARY_SPDIF_RX
  1267. #define AFE_PORT_ID_RT_PROXY_PORT_001_RX 0x2000
  1268. #define AFE_PORT_ID_RT_PROXY_PORT_001_TX 0x2001
  1269. #define AFE_PORT_ID_INTERNAL_BT_SCO_RX 0x3000
  1270. #define AFE_PORT_ID_INTERNAL_BT_SCO_TX 0x3001
  1271. #define AFE_PORT_ID_INTERNAL_BT_A2DP_RX 0x3002
  1272. #define AFE_PORT_ID_INTERNAL_FM_RX 0x3004
  1273. #define AFE_PORT_ID_INTERNAL_FM_TX 0x3005
  1274. /* SLIMbus Rx port on channel 0. */
  1275. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_0_RX 0x4000
  1276. /* SLIMbus Tx port on channel 0. */
  1277. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_0_TX 0x4001
  1278. /* SLIMbus Rx port on channel 1. */
  1279. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_1_RX 0x4002
  1280. /* SLIMbus Tx port on channel 1. */
  1281. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_1_TX 0x4003
  1282. /* SLIMbus Rx port on channel 2. */
  1283. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_2_RX 0x4004
  1284. /* SLIMbus Tx port on channel 2. */
  1285. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_2_TX 0x4005
  1286. /* SLIMbus Rx port on channel 3. */
  1287. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_3_RX 0x4006
  1288. /* SLIMbus Tx port on channel 3. */
  1289. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_3_TX 0x4007
  1290. /* SLIMbus Rx port on channel 4. */
  1291. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_4_RX 0x4008
  1292. /* SLIMbus Tx port on channel 4. */
  1293. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_4_TX 0x4009
  1294. /* SLIMbus Rx port on channel 5. */
  1295. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_5_RX 0x400a
  1296. /* SLIMbus Tx port on channel 5. */
  1297. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_5_TX 0x400b
  1298. /* SLIMbus Rx port on channel 6. */
  1299. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_6_RX 0x400c
  1300. /* SLIMbus Tx port on channel 6. */
  1301. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_6_TX 0x400d
  1302. /* SLIMbus Rx port on channel 7. */
  1303. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_7_RX 0x400e
  1304. /* SLIMbus Tx port on channel 7. */
  1305. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_7_TX 0x400f
  1306. /* SLIMbus Rx port on channel 8. */
  1307. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_8_RX 0x4010
  1308. /* SLIMbus Tx port on channel 8. */
  1309. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_8_TX 0x4011
  1310. /* SLIMbus Rx port on channel 9. */
  1311. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_9_RX 0x4012
  1312. /* SLIMbus Tx port on channel 9. */
  1313. #define AFE_PORT_ID_SLIMBUS_MULTI_CHAN_9_TX 0x4013
  1314. /* AFE Rx port for audio over Display port */
  1315. #define AFE_PORT_ID_HDMI_OVER_DP_RX 0x6020
  1316. /*USB AFE port */
  1317. #define AFE_PORT_ID_USB_RX 0x7000
  1318. #define AFE_PORT_ID_USB_TX 0x7001
  1319. /* AFE WSA Codec DMA Rx port 0 */
  1320. #define AFE_PORT_ID_WSA_CODEC_DMA_RX_0 0xB000
  1321. /* AFE WSA Codec DMA Tx port 0 */
  1322. #define AFE_PORT_ID_WSA_CODEC_DMA_TX_0 0xB001
  1323. /* AFE WSA Codec DMA Rx port 1 */
  1324. #define AFE_PORT_ID_WSA_CODEC_DMA_RX_1 0xB002
  1325. /* AFE WSA Codec DMA Tx port 1 */
  1326. #define AFE_PORT_ID_WSA_CODEC_DMA_TX_1 0xB003
  1327. /* AFE WSA Codec DMA Tx port 2 */
  1328. #define AFE_PORT_ID_WSA_CODEC_DMA_TX_2 0xB005
  1329. /* AFE VA Codec DMA Tx port 0 */
  1330. #define AFE_PORT_ID_VA_CODEC_DMA_TX_0 0xB021
  1331. /* AFE VA Codec DMA Tx port 1 */
  1332. #define AFE_PORT_ID_VA_CODEC_DMA_TX_1 0xB023
  1333. /* AFE VA Codec DMA Tx port 2 */
  1334. #define AFE_PORT_ID_VA_CODEC_DMA_TX_2 0xB025
  1335. /* AFE Rx Codec DMA Rx port 0 */
  1336. #define AFE_PORT_ID_RX_CODEC_DMA_RX_0 0xB030
  1337. /* AFE Tx Codec DMA Tx port 0 */
  1338. #define AFE_PORT_ID_TX_CODEC_DMA_TX_0 0xB031
  1339. /* AFE Rx Codec DMA Rx port 1 */
  1340. #define AFE_PORT_ID_RX_CODEC_DMA_RX_1 0xB032
  1341. /* AFE Tx Codec DMA Tx port 1 */
  1342. #define AFE_PORT_ID_TX_CODEC_DMA_TX_1 0xB033
  1343. /* AFE Rx Codec DMA Rx port 2 */
  1344. #define AFE_PORT_ID_RX_CODEC_DMA_RX_2 0xB034
  1345. /* AFE Tx Codec DMA Tx port 2 */
  1346. #define AFE_PORT_ID_TX_CODEC_DMA_TX_2 0xB035
  1347. /* AFE Rx Codec DMA Rx port 3 */
  1348. #define AFE_PORT_ID_RX_CODEC_DMA_RX_3 0xB036
  1349. /* AFE Tx Codec DMA Tx port 3 */
  1350. #define AFE_PORT_ID_TX_CODEC_DMA_TX_3 0xB037
  1351. /* AFE Rx Codec DMA Rx port 4 */
  1352. #define AFE_PORT_ID_RX_CODEC_DMA_RX_4 0xB038
  1353. /* AFE Tx Codec DMA Tx port 4 */
  1354. #define AFE_PORT_ID_TX_CODEC_DMA_TX_4 0xB039
  1355. /* AFE Rx Codec DMA Rx port 5 */
  1356. #define AFE_PORT_ID_RX_CODEC_DMA_RX_5 0xB03A
  1357. /* AFE Tx Codec DMA Tx port 5 */
  1358. #define AFE_PORT_ID_TX_CODEC_DMA_TX_5 0xB03B
  1359. /* AFE Rx Codec DMA Rx port 6 */
  1360. #define AFE_PORT_ID_RX_CODEC_DMA_RX_6 0xB03C
  1361. /* AFE Rx Codec DMA Rx port 7 */
  1362. #define AFE_PORT_ID_RX_CODEC_DMA_RX_7 0xB03E
  1363. /* Generic pseudoport 1. */
  1364. #define AFE_PORT_ID_PSEUDOPORT_01 0x8001
  1365. /* Generic pseudoport 2. */
  1366. #define AFE_PORT_ID_PSEUDOPORT_02 0x8002
  1367. /* @xreflabel{hdr:AfePortIdPrimaryAuxPcmTx}
  1368. * Primary Aux PCM Tx port ID.
  1369. */
  1370. #define AFE_PORT_ID_PRIMARY_PCM_TX 0x100B
  1371. /* Pseudoport that corresponds to the voice Rx path.
  1372. * For recording, the voice Rx path samples are written to this
  1373. * port and consumed by the audio path.
  1374. */
  1375. #define AFE_PORT_ID_VOICE_RECORD_RX 0x8003
  1376. /* Pseudoport that corresponds to the voice Tx path.
  1377. * For recording, the voice Tx path samples are written to this
  1378. * port and consumed by the audio path.
  1379. */
  1380. #define AFE_PORT_ID_VOICE_RECORD_TX 0x8004
  1381. /* Pseudoport that corresponds to in-call voice delivery samples.
  1382. * During in-call audio delivery, the audio path delivers samples
  1383. * to this port from where the voice path delivers them on the
  1384. * Rx path.
  1385. */
  1386. #define AFE_PORT_ID_VOICE2_PLAYBACK_TX 0x8002
  1387. #define AFE_PORT_ID_VOICE_PLAYBACK_TX 0x8005
  1388. #define AFE_PORT_ID_PRIMARY_TDM_RX \
  1389. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x00)
  1390. #define AFE_PORT_ID_PRIMARY_TDM_RX_1 \
  1391. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x02)
  1392. #define AFE_PORT_ID_PRIMARY_TDM_RX_2 \
  1393. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x04)
  1394. #define AFE_PORT_ID_PRIMARY_TDM_RX_3 \
  1395. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x06)
  1396. #define AFE_PORT_ID_PRIMARY_TDM_RX_4 \
  1397. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x08)
  1398. #define AFE_PORT_ID_PRIMARY_TDM_RX_5 \
  1399. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x0A)
  1400. #define AFE_PORT_ID_PRIMARY_TDM_RX_6 \
  1401. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x0C)
  1402. #define AFE_PORT_ID_PRIMARY_TDM_RX_7 \
  1403. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x0E)
  1404. #define AFE_PORT_ID_PRIMARY_TDM_TX \
  1405. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x01)
  1406. #define AFE_PORT_ID_PRIMARY_TDM_TX_1 \
  1407. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x02)
  1408. #define AFE_PORT_ID_PRIMARY_TDM_TX_2 \
  1409. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x04)
  1410. #define AFE_PORT_ID_PRIMARY_TDM_TX_3 \
  1411. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x06)
  1412. #define AFE_PORT_ID_PRIMARY_TDM_TX_4 \
  1413. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x08)
  1414. #define AFE_PORT_ID_PRIMARY_TDM_TX_5 \
  1415. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x0A)
  1416. #define AFE_PORT_ID_PRIMARY_TDM_TX_6 \
  1417. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x0C)
  1418. #define AFE_PORT_ID_PRIMARY_TDM_TX_7 \
  1419. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x0E)
  1420. #define AFE_PORT_ID_SECONDARY_TDM_RX \
  1421. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x10)
  1422. #define AFE_PORT_ID_SECONDARY_TDM_RX_1 \
  1423. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x02)
  1424. #define AFE_PORT_ID_SECONDARY_TDM_RX_2 \
  1425. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x04)
  1426. #define AFE_PORT_ID_SECONDARY_TDM_RX_3 \
  1427. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x06)
  1428. #define AFE_PORT_ID_SECONDARY_TDM_RX_4 \
  1429. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x08)
  1430. #define AFE_PORT_ID_SECONDARY_TDM_RX_5 \
  1431. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x0A)
  1432. #define AFE_PORT_ID_SECONDARY_TDM_RX_6 \
  1433. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x0C)
  1434. #define AFE_PORT_ID_SECONDARY_TDM_RX_7 \
  1435. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x0E)
  1436. #define AFE_PORT_ID_SECONDARY_TDM_TX \
  1437. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x11)
  1438. #define AFE_PORT_ID_SECONDARY_TDM_TX_1 \
  1439. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x02)
  1440. #define AFE_PORT_ID_SECONDARY_TDM_TX_2 \
  1441. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x04)
  1442. #define AFE_PORT_ID_SECONDARY_TDM_TX_3 \
  1443. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x06)
  1444. #define AFE_PORT_ID_SECONDARY_TDM_TX_4 \
  1445. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x08)
  1446. #define AFE_PORT_ID_SECONDARY_TDM_TX_5 \
  1447. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x0A)
  1448. #define AFE_PORT_ID_SECONDARY_TDM_TX_6 \
  1449. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x0C)
  1450. #define AFE_PORT_ID_SECONDARY_TDM_TX_7 \
  1451. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x0E)
  1452. #define AFE_PORT_ID_TERTIARY_TDM_RX \
  1453. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x20)
  1454. #define AFE_PORT_ID_TERTIARY_TDM_RX_1 \
  1455. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x02)
  1456. #define AFE_PORT_ID_TERTIARY_TDM_RX_2 \
  1457. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x04)
  1458. #define AFE_PORT_ID_TERTIARY_TDM_RX_3 \
  1459. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x06)
  1460. #define AFE_PORT_ID_TERTIARY_TDM_RX_4 \
  1461. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x08)
  1462. #define AFE_PORT_ID_TERTIARY_TDM_RX_5 \
  1463. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x0A)
  1464. #define AFE_PORT_ID_TERTIARY_TDM_RX_6 \
  1465. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x0C)
  1466. #define AFE_PORT_ID_TERTIARY_TDM_RX_7 \
  1467. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x0E)
  1468. #define AFE_PORT_ID_TERTIARY_TDM_TX \
  1469. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x21)
  1470. #define AFE_PORT_ID_TERTIARY_TDM_TX_1 \
  1471. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x02)
  1472. #define AFE_PORT_ID_TERTIARY_TDM_TX_2 \
  1473. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x04)
  1474. #define AFE_PORT_ID_TERTIARY_TDM_TX_3 \
  1475. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x06)
  1476. #define AFE_PORT_ID_TERTIARY_TDM_TX_4 \
  1477. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x08)
  1478. #define AFE_PORT_ID_TERTIARY_TDM_TX_5 \
  1479. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x0A)
  1480. #define AFE_PORT_ID_TERTIARY_TDM_TX_6 \
  1481. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x0C)
  1482. #define AFE_PORT_ID_TERTIARY_TDM_TX_7 \
  1483. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x0E)
  1484. #define AFE_PORT_ID_QUATERNARY_TDM_RX \
  1485. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x30)
  1486. #define AFE_PORT_ID_QUATERNARY_TDM_RX_1 \
  1487. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x02)
  1488. #define AFE_PORT_ID_QUATERNARY_TDM_RX_2 \
  1489. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x04)
  1490. #define AFE_PORT_ID_QUATERNARY_TDM_RX_3 \
  1491. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x06)
  1492. #define AFE_PORT_ID_QUATERNARY_TDM_RX_4 \
  1493. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x08)
  1494. #define AFE_PORT_ID_QUATERNARY_TDM_RX_5 \
  1495. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x0A)
  1496. #define AFE_PORT_ID_QUATERNARY_TDM_RX_6 \
  1497. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x0C)
  1498. #define AFE_PORT_ID_QUATERNARY_TDM_RX_7 \
  1499. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x0E)
  1500. #define AFE_PORT_ID_QUATERNARY_TDM_TX \
  1501. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x31)
  1502. #define AFE_PORT_ID_QUATERNARY_TDM_TX_1 \
  1503. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x02)
  1504. #define AFE_PORT_ID_QUATERNARY_TDM_TX_2 \
  1505. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x04)
  1506. #define AFE_PORT_ID_QUATERNARY_TDM_TX_3 \
  1507. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x06)
  1508. #define AFE_PORT_ID_QUATERNARY_TDM_TX_4 \
  1509. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x08)
  1510. #define AFE_PORT_ID_QUATERNARY_TDM_TX_5 \
  1511. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x0A)
  1512. #define AFE_PORT_ID_QUATERNARY_TDM_TX_6 \
  1513. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x0C)
  1514. #define AFE_PORT_ID_QUATERNARY_TDM_TX_7 \
  1515. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x0E)
  1516. #define AFE_PORT_ID_QUINARY_TDM_RX \
  1517. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x40)
  1518. #define AFE_PORT_ID_QUINARY_TDM_RX_1 \
  1519. (AFE_PORT_ID_QUINARY_TDM_RX + 0x02)
  1520. #define AFE_PORT_ID_QUINARY_TDM_RX_2 \
  1521. (AFE_PORT_ID_QUINARY_TDM_RX + 0x04)
  1522. #define AFE_PORT_ID_QUINARY_TDM_RX_3 \
  1523. (AFE_PORT_ID_QUINARY_TDM_RX + 0x06)
  1524. #define AFE_PORT_ID_QUINARY_TDM_RX_4 \
  1525. (AFE_PORT_ID_QUINARY_TDM_RX + 0x08)
  1526. #define AFE_PORT_ID_QUINARY_TDM_RX_5 \
  1527. (AFE_PORT_ID_QUINARY_TDM_RX + 0x0A)
  1528. #define AFE_PORT_ID_QUINARY_TDM_RX_6 \
  1529. (AFE_PORT_ID_QUINARY_TDM_RX + 0x0C)
  1530. #define AFE_PORT_ID_QUINARY_TDM_RX_7 \
  1531. (AFE_PORT_ID_QUINARY_TDM_RX + 0x0E)
  1532. #define AFE_PORT_ID_QUINARY_TDM_TX \
  1533. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x41)
  1534. #define AFE_PORT_ID_QUINARY_TDM_TX_1 \
  1535. (AFE_PORT_ID_QUINARY_TDM_TX + 0x02)
  1536. #define AFE_PORT_ID_QUINARY_TDM_TX_2 \
  1537. (AFE_PORT_ID_QUINARY_TDM_TX + 0x04)
  1538. #define AFE_PORT_ID_QUINARY_TDM_TX_3 \
  1539. (AFE_PORT_ID_QUINARY_TDM_TX + 0x06)
  1540. #define AFE_PORT_ID_QUINARY_TDM_TX_4 \
  1541. (AFE_PORT_ID_QUINARY_TDM_TX + 0x08)
  1542. #define AFE_PORT_ID_QUINARY_TDM_TX_5 \
  1543. (AFE_PORT_ID_QUINARY_TDM_TX + 0x0A)
  1544. #define AFE_PORT_ID_QUINARY_TDM_TX_6 \
  1545. (AFE_PORT_ID_QUINARY_TDM_TX + 0x0C)
  1546. #define AFE_PORT_ID_QUINARY_TDM_TX_7 \
  1547. (AFE_PORT_ID_QUINARY_TDM_TX + 0x0E)
  1548. #define AFE_PORT_ID_SENARY_TDM_RX \
  1549. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x50)
  1550. #define AFE_PORT_ID_SENARY_TDM_RX_1 \
  1551. (AFE_PORT_ID_SENARY_TDM_RX + 0x02)
  1552. #define AFE_PORT_ID_SENARY_TDM_RX_2 \
  1553. (AFE_PORT_ID_SENARY_TDM_RX + 0x04)
  1554. #define AFE_PORT_ID_SENARY_TDM_RX_3 \
  1555. (AFE_PORT_ID_SENARY_TDM_RX + 0x06)
  1556. #define AFE_PORT_ID_SENARY_TDM_RX_4 \
  1557. (AFE_PORT_ID_SENARY_TDM_RX + 0x08)
  1558. #define AFE_PORT_ID_SENARY_TDM_RX_5 \
  1559. (AFE_PORT_ID_SENARY_TDM_RX + 0x0A)
  1560. #define AFE_PORT_ID_SENARY_TDM_RX_6 \
  1561. (AFE_PORT_ID_SENARY_TDM_RX + 0x0C)
  1562. #define AFE_PORT_ID_SENARY_TDM_RX_7 \
  1563. (AFE_PORT_ID_SENARY_TDM_RX + 0x0E)
  1564. #define AFE_PORT_ID_SENARY_TDM_TX \
  1565. (AFE_PORT_ID_TDM_PORT_RANGE_START + 0x51)
  1566. #define AFE_PORT_ID_SENARY_TDM_TX_1 \
  1567. (AFE_PORT_ID_SENARY_TDM_TX + 0x02)
  1568. #define AFE_PORT_ID_SENARY_TDM_TX_2 \
  1569. (AFE_PORT_ID_SENARY_TDM_TX + 0x04)
  1570. #define AFE_PORT_ID_SENARY_TDM_TX_3 \
  1571. (AFE_PORT_ID_SENARY_TDM_TX + 0x06)
  1572. #define AFE_PORT_ID_SENARY_TDM_TX_4 \
  1573. (AFE_PORT_ID_SENARY_TDM_TX + 0x08)
  1574. #define AFE_PORT_ID_SENARY_TDM_TX_5 \
  1575. (AFE_PORT_ID_SENARY_TDM_TX + 0x0A)
  1576. #define AFE_PORT_ID_SENARY_TDM_TX_6 \
  1577. (AFE_PORT_ID_SENARY_TDM_TX + 0x0C)
  1578. #define AFE_PORT_ID_SENARY_TDM_TX_7 \
  1579. (AFE_PORT_ID_SENARY_TDM_TX + 0x0E)
  1580. #define AFE_PORT_ID_INVALID 0xFFFF
  1581. #define AAC_ENC_MODE_AAC_LC 0x02
  1582. #define AAC_ENC_MODE_AAC_P 0x05
  1583. #define AAC_ENC_MODE_EAAC_P 0x1D
  1584. #define AFE_PSEUDOPORT_CMD_START 0x000100cf
  1585. struct afe_pseudoport_start_command {
  1586. struct apr_hdr hdr;
  1587. u16 port_id; /* Pseudo Port 1 = 0x8000 */
  1588. /* Pseudo Port 2 = 0x8001 */
  1589. /* Pseudo Port 3 = 0x8002 */
  1590. u16 timing; /* FTRT = 0 , AVTimer = 1, */
  1591. } __packed;
  1592. #define AFE_PSEUDOPORT_CMD_STOP 0x000100d0
  1593. struct afe_pseudoport_stop_command {
  1594. struct apr_hdr hdr;
  1595. u16 port_id; /* Pseudo Port 1 = 0x8000 */
  1596. /* Pseudo Port 2 = 0x8001 */
  1597. /* Pseudo Port 3 = 0x8002 */
  1598. u16 reserved;
  1599. } __packed;
  1600. #define AFE_MODULE_SIDETONE_IIR_FILTER 0x00010202
  1601. #define AFE_PARAM_ID_ENABLE 0x00010203
  1602. /* Payload of the #AFE_PARAM_ID_ENABLE
  1603. * parameter, which enables or
  1604. * disables any module.
  1605. * The fixed size of this structure is four bytes.
  1606. */
  1607. struct afe_mod_enable_param {
  1608. u16 enable;
  1609. /* Enables (1) or disables (0) the module. */
  1610. u16 reserved;
  1611. /* This field must be set to zero. */
  1612. } __packed;
  1613. /* ID of the configuration parameter used by the
  1614. * #AFE_MODULE_SIDETONE_IIR_FILTER module.
  1615. */
  1616. #define AFE_PARAM_ID_SIDETONE_IIR_FILTER_CONFIG 0x00010204
  1617. #define MAX_SIDETONE_IIR_DATA_SIZE 224
  1618. #define MAX_NO_IIR_FILTER_STAGE 10
  1619. struct afe_sidetone_iir_filter_config_params {
  1620. u16 num_biquad_stages;
  1621. /* Number of stages.
  1622. * Supported values: Minimum of 5 and maximum of 10
  1623. */
  1624. u16 pregain;
  1625. /* Pregain for the compensating filter response.
  1626. * Supported values: Any number in Q13 format
  1627. */
  1628. uint8_t iir_config[MAX_SIDETONE_IIR_DATA_SIZE];
  1629. } __packed;
  1630. #define AFE_MODULE_LOOPBACK 0x00010205
  1631. #define AFE_PARAM_ID_LOOPBACK_GAIN_PER_PATH 0x00010206
  1632. /* Used by RTAC */
  1633. struct afe_rtac_user_data_set_v2 {
  1634. /* Port interface and direction (Rx or Tx) to start. */
  1635. u16 port_id;
  1636. /* Actual size of the payload in bytes.
  1637. * This is used for parsing the parameter payload.
  1638. * Supported values: > 0
  1639. */
  1640. u16 payload_size;
  1641. /* The header detailing the memory mapping for out of band. */
  1642. struct mem_mapping_hdr mem_hdr;
  1643. /* The parameter header for the parameter data to set */
  1644. struct param_hdr_v1 param_hdr;
  1645. /* The parameter data to be filled when sent inband */
  1646. u32 *param_data;
  1647. } __packed;
  1648. struct afe_rtac_user_data_set_v3 {
  1649. /* Port interface and direction (Rx or Tx) to start. */
  1650. u16 port_id;
  1651. /* Reserved for future enhancements. Must be 0. */
  1652. u16 reserved;
  1653. /* The header detailing the memory mapping for out of band. */
  1654. struct mem_mapping_hdr mem_hdr;
  1655. /* The size of the parameter header and parameter data */
  1656. u32 payload_size;
  1657. /* The parameter header for the parameter data to set */
  1658. struct param_hdr_v3 param_hdr;
  1659. /* The parameter data to be filled when sent inband */
  1660. u32 *param_data;
  1661. } __packed;
  1662. struct afe_rtac_user_data_get_v2 {
  1663. /* Port interface and direction (Rx or Tx) to start. */
  1664. u16 port_id;
  1665. /* Actual size of the payload in bytes.
  1666. * This is used for parsing the parameter payload.
  1667. * Supported values: > 0
  1668. */
  1669. u16 payload_size;
  1670. /* The header detailing the memory mapping for out of band. */
  1671. struct mem_mapping_hdr mem_hdr;
  1672. /* The module ID of the parameter to get */
  1673. u32 module_id;
  1674. /* The parameter ID of the parameter to get */
  1675. u32 param_id;
  1676. /* The parameter data to be filled when sent inband */
  1677. struct param_hdr_v1 param_hdr;
  1678. } __packed;
  1679. struct afe_rtac_user_data_get_v3 {
  1680. /* Port interface and direction (Rx or Tx) to start. */
  1681. u16 port_id;
  1682. /* Reserved for future enhancements. Must be 0. */
  1683. u16 reserved;
  1684. /* The header detailing the memory mapping for out of band. */
  1685. struct mem_mapping_hdr mem_hdr;
  1686. /* The parameter data to be filled when sent inband */
  1687. struct param_hdr_v3 param_hdr;
  1688. } __packed;
  1689. #define AFE_PORT_CMD_SET_PARAM_V2 0x000100EF
  1690. struct afe_port_cmd_set_param_v2 {
  1691. /* APR Header */
  1692. struct apr_hdr apr_hdr;
  1693. /* Port interface and direction (Rx or Tx) to start. */
  1694. u16 port_id;
  1695. /*
  1696. * Actual size of the payload in bytes.
  1697. * This is used for parsing the parameter payload.
  1698. * Supported values: > 0
  1699. */
  1700. u16 payload_size;
  1701. /* The header detailing the memory mapping for out of band. */
  1702. struct mem_mapping_hdr mem_hdr;
  1703. /* The parameter data to be filled when sent inband */
  1704. u8 param_data[0];
  1705. } __packed;
  1706. #define AFE_PORT_CMD_SET_PARAM_V3 0x000100FA
  1707. struct afe_port_cmd_set_param_v3 {
  1708. /* APR Header */
  1709. struct apr_hdr apr_hdr;
  1710. /* Port ID of the AFE port to configure. Port interface and direction
  1711. * (Rx or Tx) to configure. An even number represents the Rx direction,
  1712. * and an odd number represents the Tx direction.
  1713. */
  1714. u16 port_id;
  1715. /* Reserved. This field must be set to zero. */
  1716. u16 reserved;
  1717. /* The memory mapping header to be used when sending outband */
  1718. struct mem_mapping_hdr mem_hdr;
  1719. /* The total size of the payload, including param_hdr_v3 */
  1720. u32 payload_size;
  1721. /*
  1722. * The parameter data to be filled when sent inband.
  1723. * Must include param_hdr packed correctly.
  1724. */
  1725. u8 param_data[0];
  1726. } __packed;
  1727. /* Payload of the #AFE_PARAM_ID_LOOPBACK_GAIN_PER_PATH parameter,
  1728. * which gets/sets loopback gain of a port to an Rx port.
  1729. * The Tx port ID of the loopback is part of the set_param command.
  1730. */
  1731. struct afe_loopback_gain_per_path_param {
  1732. u16 rx_port_id;
  1733. /* Rx port of the loopback. */
  1734. u16 gain;
  1735. /* Loopback gain per path of the port.
  1736. * Supported values: Any number in Q13 format
  1737. */
  1738. } __packed;
  1739. /* Parameter ID used to configure and enable/disable the
  1740. * loopback path. The difference with respect to the existing
  1741. * API, AFE_PORT_CMD_LOOPBACK, is that it allows Rx port to be
  1742. * configured as source port in loopback path. Port-id in
  1743. * AFE_PORT_CMD_SET_PARAM cmd is the source port which can be
  1744. * Tx or Rx port. In addition, we can configure the type of
  1745. * routing mode to handle different use cases.
  1746. */
  1747. #define AFE_PARAM_ID_LOOPBACK_CONFIG 0x0001020B
  1748. #define AFE_API_VERSION_LOOPBACK_CONFIG 0x1
  1749. enum afe_loopback_routing_mode {
  1750. LB_MODE_DEFAULT = 1,
  1751. /* Regular loopback from source to destination port */
  1752. LB_MODE_SIDETONE,
  1753. /* Sidetone feed from Tx source to Rx destination port */
  1754. LB_MODE_EC_REF_VOICE_AUDIO,
  1755. /* Echo canceller reference, voice + audio + DTMF */
  1756. LB_MODE_EC_REF_VOICE
  1757. /* Echo canceller reference, voice alone */
  1758. } __packed;
  1759. /* Payload of the #AFE_PARAM_ID_LOOPBACK_CONFIG ,
  1760. * which enables/disables one AFE loopback.
  1761. */
  1762. struct afe_loopback_cfg_v1 {
  1763. u32 loopback_cfg_minor_version;
  1764. /* Minor version used for tracking the version of the RMC module
  1765. * configuration interface.
  1766. * Supported values: #AFE_API_VERSION_LOOPBACK_CONFIG
  1767. */
  1768. u16 dst_port_id;
  1769. /* Destination Port Id. */
  1770. u16 routing_mode;
  1771. /* Specifies data path type from src to dest port.
  1772. * Supported values:
  1773. * #LB_MODE_DEFAULT
  1774. * #LB_MODE_SIDETONE
  1775. * #LB_MODE_EC_REF_VOICE_AUDIO
  1776. * #LB_MODE_EC_REF_VOICE_A
  1777. * #LB_MODE_EC_REF_VOICE
  1778. */
  1779. u16 enable;
  1780. /* Specifies whether to enable (1) or
  1781. * disable (0) an AFE loopback.
  1782. */
  1783. u16 reserved;
  1784. /* Reserved for 32-bit alignment. This field must be set to 0.
  1785. */
  1786. } __packed;
  1787. struct afe_loopback_sidetone_gain {
  1788. u16 rx_port_id;
  1789. u16 gain;
  1790. } __packed;
  1791. struct afe_display_stream_idx {
  1792. u32 minor_version;
  1793. u32 stream_idx;
  1794. } __packed;
  1795. struct afe_display_ctl_idx {
  1796. u32 minor_version;
  1797. u32 ctl_idx;
  1798. } __packed;
  1799. struct loopback_cfg_data {
  1800. u32 loopback_cfg_minor_version;
  1801. /* Minor version used for tracking the version of the RMC module
  1802. * configuration interface.
  1803. * Supported values: #AFE_API_VERSION_LOOPBACK_CONFIG
  1804. */
  1805. u16 dst_port_id;
  1806. /* Destination Port Id. */
  1807. u16 routing_mode;
  1808. /* Specifies data path type from src to dest port.
  1809. * Supported values:
  1810. * #LB_MODE_DEFAULT
  1811. * #LB_MODE_SIDETONE
  1812. * #LB_MODE_EC_REF_VOICE_AUDIO
  1813. * #LB_MODE_EC_REF_VOICE_A
  1814. * #LB_MODE_EC_REF_VOICE
  1815. */
  1816. u16 enable;
  1817. /* Specifies whether to enable (1) or
  1818. * disable (0) an AFE loopback.
  1819. */
  1820. u16 reserved;
  1821. /* Reserved for 32-bit alignment. This field must be set to 0.
  1822. */
  1823. } __packed;
  1824. struct afe_st_loopback_cfg_v1 {
  1825. struct apr_hdr hdr;
  1826. struct mem_mapping_hdr mem_hdr;
  1827. struct param_hdr_v1 gain_pdata;
  1828. struct afe_loopback_sidetone_gain gain_data;
  1829. struct param_hdr_v1 cfg_pdata;
  1830. struct loopback_cfg_data cfg_data;
  1831. } __packed;
  1832. struct afe_loopback_iir_cfg_v2 {
  1833. struct apr_hdr hdr;
  1834. struct mem_mapping_hdr param;
  1835. struct param_hdr_v1 st_iir_enable_pdata;
  1836. struct afe_mod_enable_param st_iir_mode_enable_data;
  1837. struct param_hdr_v1 st_iir_filter_config_pdata;
  1838. struct afe_sidetone_iir_filter_config_params st_iir_filter_config_data;
  1839. } __packed;
  1840. /*
  1841. * Param ID and related structures for AFE event
  1842. * registration.
  1843. */
  1844. #define AFE_PORT_CMD_MOD_EVENT_CFG 0x000100FD
  1845. struct afe_port_cmd_event_cfg {
  1846. struct apr_hdr hdr;
  1847. uint32_t version;
  1848. /* Version number. The current version is 0 */
  1849. uint32_t port_id;
  1850. /*
  1851. * Port ID for the AFE port hosting the modules
  1852. * being registered for the events
  1853. */
  1854. uint32_t num_events;
  1855. /*
  1856. * Number of events to be registered with the service
  1857. * Each event has the structure of
  1858. * afe_port_cmd_mod_evt_cfg_payload.
  1859. */
  1860. uint8_t payload[0];
  1861. };
  1862. /** Event registration for a module. */
  1863. #define AFE_MODULE_REGISTER_EVENT_FLAG 1
  1864. /** Event de-registration for a module. */
  1865. #define AFE_MODULE_DEREGISTER_EVENT_FLAG 0
  1866. struct afe_port_cmd_mod_evt_cfg_payload {
  1867. uint32_t module_id;
  1868. /* Valid ID of the module. */
  1869. uint16_t instance_id;
  1870. /*
  1871. * Valid ID of the module instance in the current topology.
  1872. * If both module_id and instance_id ID are set to 0, the event is
  1873. * registered with all modules and instances in the topology.
  1874. * If module_id is set to 0 and instance_id is set to a non-zero value,
  1875. * the payload is considered to be invalid.
  1876. */
  1877. uint16_t reserved;
  1878. /* Used for alignment; must be set to 0.*/
  1879. uint32_t event_id;
  1880. /* Unique ID of the event. */
  1881. uint32_t reg_flag;
  1882. /*
  1883. * Bit field for enabling or disabling event registration.
  1884. * values
  1885. * - #AFE_MODULE_REGISTER_EVENT_FLAG
  1886. * - #AFE_MODULE_DEREGISTER_EVENT_FLAG
  1887. */
  1888. } __packed;
  1889. #define AFE_PORT_MOD_EVENT 0x0001010C
  1890. struct afe_port_mod_evt_rsp_hdr {
  1891. uint32_t minor_version;
  1892. /* This indicates the minor version of the payload */
  1893. uint32_t port_id;
  1894. /* AFE port hosting this module */
  1895. uint32_t module_id;
  1896. /* Module ID which is raising the event */
  1897. uint16_t instance_id;
  1898. /* Instance ID of the module which is raising the event */
  1899. uint16_t reserved;
  1900. /* For alignment purpose, should be set to 0 */
  1901. uint32_t event_id;
  1902. /* Valid event ID registered by client */
  1903. uint32_t payload_size;
  1904. /*
  1905. * Size of the event payload
  1906. * This is followed by actual payload corresponding to the event
  1907. */
  1908. } __packed;
  1909. #define AFE_PORT_SP_DC_DETECTION_EVENT 0x0001010D
  1910. #define AFE_MODULE_SPEAKER_PROTECTION 0x00010209
  1911. #define AFE_PARAM_ID_SPKR_PROT_CONFIG 0x0001020a
  1912. #define AFE_API_VERSION_SPKR_PROT_CONFIG 0x1
  1913. #define AFE_SPKR_PROT_EXCURSIONF_LEN 512
  1914. struct afe_spkr_prot_cfg_param_v1 {
  1915. u32 spkr_prot_minor_version;
  1916. /*
  1917. * Minor version used for tracking the version of the
  1918. * speaker protection module configuration interface.
  1919. * Supported values: #AFE_API_VERSION_SPKR_PROT_CONFIG
  1920. */
  1921. int16_t win_size;
  1922. /* Analysis and synthesis window size (nWinSize).
  1923. * Supported values: 1024, 512, 256 samples
  1924. */
  1925. int16_t margin;
  1926. /* Allowable margin for excursion prediction,
  1927. * in L16Q15 format. This is a
  1928. * control parameter to allow
  1929. * for overestimation of peak excursion.
  1930. */
  1931. int16_t spkr_exc_limit;
  1932. /* Speaker excursion limit, in L16Q15 format.*/
  1933. int16_t spkr_resonance_freq;
  1934. /* Resonance frequency of the speaker; used
  1935. * to define a frequency range
  1936. * for signal modification.
  1937. *
  1938. * Supported values: 0 to 2000 Hz
  1939. */
  1940. int16_t limhresh;
  1941. /* Threshold of the hard limiter; used to
  1942. * prevent overshooting beyond a
  1943. * signal level that was set by the limiter
  1944. * prior to speaker protection.
  1945. * Supported values: 0 to 32767
  1946. */
  1947. int16_t hpf_cut_off_freq;
  1948. /* High pass filter cutoff frequency.
  1949. * Supported values: 100, 200, 300 Hz
  1950. */
  1951. int16_t hpf_enable;
  1952. /* Specifies whether the high pass filter
  1953. * is enabled (0) or disabled (1).
  1954. */
  1955. int16_t reserved;
  1956. /* This field must be set to zero. */
  1957. int32_t amp_gain;
  1958. /* Amplifier gain in L32Q15 format.
  1959. * This is the RMS voltage at the
  1960. * loudspeaker when a 0dBFS tone
  1961. * is played in the digital domain.
  1962. */
  1963. int16_t excursionf[AFE_SPKR_PROT_EXCURSIONF_LEN];
  1964. /* Array of the excursion transfer function.
  1965. * The peak excursion of the
  1966. * loudspeaker diaphragm is
  1967. * measured in millimeters for 1 Vrms Sine
  1968. * tone at all FFT bin frequencies.
  1969. * Supported values: Q15 format
  1970. */
  1971. } __packed;
  1972. #define AFE_SERVICE_CMD_REGISTER_RT_PORT_DRIVER 0x000100E0
  1973. /* Payload of the #AFE_SERVICE_CMD_REGISTER_RT_PORT_DRIVER
  1974. * command, which registers a real-time port driver
  1975. * with the AFE service.
  1976. */
  1977. struct afe_service_cmd_register_rt_port_driver {
  1978. struct apr_hdr hdr;
  1979. u16 port_id;
  1980. /* Port ID with which the real-time driver exchanges data
  1981. * (registers for events).
  1982. * Supported values: #AFE_PORT_ID_RT_PROXY_PORT_RANGE_START to
  1983. * #AFE_PORT_ID_RT_PROXY_PORT_RANGE_END
  1984. */
  1985. u16 reserved;
  1986. /* This field must be set to zero. */
  1987. } __packed;
  1988. #define AFE_SERVICE_CMD_UNREGISTER_RT_PORT_DRIVER 0x000100E1
  1989. /* Payload of the #AFE_SERVICE_CMD_UNREGISTER_RT_PORT_DRIVER
  1990. * command, which unregisters a real-time port driver from
  1991. * the AFE service.
  1992. */
  1993. struct afe_service_cmd_unregister_rt_port_driver {
  1994. struct apr_hdr hdr;
  1995. u16 port_id;
  1996. /* Port ID from which the real-time
  1997. * driver unregisters for events.
  1998. * Supported values: #AFE_PORT_ID_RT_PROXY_PORT_RANGE_START to
  1999. * #AFE_PORT_ID_RT_PROXY_PORT_RANGE_END
  2000. */
  2001. u16 reserved;
  2002. /* This field must be set to zero. */
  2003. } __packed;
  2004. #define AFE_EVENT_RT_PROXY_PORT_STATUS 0x00010105
  2005. #define AFE_EVENTYPE_RT_PROXY_PORT_START 0
  2006. #define AFE_EVENTYPE_RT_PROXY_PORT_STOP 1
  2007. #define AFE_EVENTYPE_RT_PROXY_PORT_LOW_WATER_MARK 2
  2008. #define AFE_EVENTYPE_RT_PROXY_PORT_HIGH_WATER_MARK 3
  2009. #define AFE_EVENTYPE_RT_PROXY_PORT_INVALID 0xFFFF
  2010. /* Payload of the #AFE_EVENT_RT_PROXY_PORT_STATUS
  2011. * message, which sends an event from the AFE service
  2012. * to a registered client.
  2013. */
  2014. struct afe_event_rt_proxy_port_status {
  2015. u16 port_id;
  2016. /* Port ID to which the event is sent.
  2017. * Supported values: #AFE_PORT_ID_RT_PROXY_PORT_RANGE_START to
  2018. * #AFE_PORT_ID_RT_PROXY_PORT_RANGE_END
  2019. */
  2020. u16 eventype;
  2021. /* Type of event.
  2022. * Supported values:
  2023. * - #AFE_EVENTYPE_RT_PROXY_PORT_START
  2024. * - #AFE_EVENTYPE_RT_PROXY_PORT_STOP
  2025. * - #AFE_EVENTYPE_RT_PROXY_PORT_LOW_WATER_MARK
  2026. * - #AFE_EVENTYPE_RT_PROXY_PORT_HIGH_WATER_MARK
  2027. */
  2028. } __packed;
  2029. #define AFE_PORT_DATA_CMD_RT_PROXY_PORT_WRITE_V2 0x000100ED
  2030. struct afe_port_data_cmd_rt_proxy_port_write_v2 {
  2031. struct apr_hdr hdr;
  2032. u16 port_id;
  2033. /* Tx (mic) proxy port ID with which the real-time
  2034. * driver exchanges data.
  2035. * Supported values: #AFE_PORT_ID_RT_PROXY_PORT_RANGE_START to
  2036. * #AFE_PORT_ID_RT_PROXY_PORT_RANGE_END
  2037. */
  2038. u16 reserved;
  2039. /* This field must be set to zero. */
  2040. u32 buffer_address_lsw;
  2041. /* LSW Address of the buffer containing the
  2042. * data from the real-time source
  2043. * device on a client.
  2044. */
  2045. u32 buffer_address_msw;
  2046. /* MSW Address of the buffer containing the
  2047. * data from the real-time source
  2048. * device on a client.
  2049. */
  2050. u32 mem_map_handle;
  2051. /* A memory map handle encapsulating shared memory
  2052. * attributes is returned if
  2053. * AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS
  2054. * command is successful.
  2055. * Supported Values:
  2056. * - Any 32 bit value
  2057. */
  2058. u32 available_bytes;
  2059. /* Number of valid bytes available
  2060. * in the buffer (including all
  2061. * channels: number of bytes per
  2062. * channel = availableBytesumChannels).
  2063. * Supported values: > 0
  2064. *
  2065. * This field must be equal to the frame
  2066. * size specified in the #AFE_PORT_AUDIO_IF_CONFIG
  2067. * command that was sent to configure this
  2068. * port.
  2069. */
  2070. } __packed;
  2071. #define AFE_PORT_DATA_CMD_RT_PROXY_PORT_READ_V2 0x000100EE
  2072. /* Payload of the
  2073. * #AFE_PORT_DATA_CMD_RT_PROXY_PORT_READ_V2 command, which
  2074. * delivers an empty buffer to the AFE service. On
  2075. * acknowledgment, data is filled in the buffer.
  2076. */
  2077. struct afe_port_data_cmd_rt_proxy_port_read_v2 {
  2078. struct apr_hdr hdr;
  2079. u16 port_id;
  2080. /* Rx proxy port ID with which the real-time
  2081. * driver exchanges data.
  2082. * Supported values: #AFE_PORT_ID_RT_PROXY_PORT_RANGE_START to
  2083. * #AFE_PORT_ID_RT_PROXY_PORT_RANGE_END
  2084. * (This must be an Rx (speaker) port.)
  2085. */
  2086. u16 reserved;
  2087. /* This field must be set to zero. */
  2088. u32 buffer_address_lsw;
  2089. /* LSW Address of the buffer containing the data sent from the AFE
  2090. * service to a real-time sink device on the client.
  2091. */
  2092. u32 buffer_address_msw;
  2093. /* MSW Address of the buffer containing the data sent from the AFE
  2094. * service to a real-time sink device on the client.
  2095. */
  2096. u32 mem_map_handle;
  2097. /* A memory map handle encapsulating shared memory attributes is
  2098. * returned if AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS command is
  2099. * successful.
  2100. * Supported Values:
  2101. * - Any 32 bit value
  2102. */
  2103. u32 available_bytes;
  2104. /* Number of valid bytes available in the buffer (including all
  2105. * channels).
  2106. * Supported values: > 0
  2107. * This field must be equal to the frame size specified in the
  2108. * #AFE_PORT_AUDIO_IF_CONFIG command that was sent to configure
  2109. * this port.
  2110. */
  2111. } __packed;
  2112. /* This module ID is related to device configuring like I2S,PCM,
  2113. * HDMI, SLIMBus etc. This module supports following parameter ids.
  2114. * - #AFE_PARAM_ID_I2S_CONFIG
  2115. * - #AFE_PARAM_ID_PCM_CONFIG
  2116. * - #AFE_PARAM_ID_DIGI_MIC_CONFIG
  2117. * - #AFE_PARAM_ID_HDMI_CONFIG
  2118. * - #AFE_PARAM_ID_INTERNAL_BT_FM_CONFIG
  2119. * - #AFE_PARAM_ID_SLIMBUS_CONFIG
  2120. * - #AFE_PARAM_ID_RT_PROXY_CONFIG
  2121. */
  2122. #define AFE_MODULE_AUDIO_DEV_INTERFACE 0x0001020C
  2123. #define AFE_PORT_SAMPLE_RATE_8K 8000
  2124. #define AFE_PORT_SAMPLE_RATE_16K 16000
  2125. #define AFE_PORT_SAMPLE_RATE_32K 32000
  2126. #define AFE_PORT_SAMPLE_RATE_44_1K 44100
  2127. #define AFE_PORT_SAMPLE_RATE_48K 48000
  2128. #define AFE_PORT_SAMPLE_RATE_96K 96000
  2129. #define AFE_PORT_SAMPLE_RATE_176P4K 176400
  2130. #define AFE_PORT_SAMPLE_RATE_192K 192000
  2131. #define AFE_PORT_SAMPLE_RATE_352P8K 352800
  2132. #define AFE_LINEAR_PCM_DATA 0x0
  2133. #define AFE_NON_LINEAR_DATA 0x1
  2134. #define AFE_LINEAR_PCM_DATA_PACKED_60958 0x2
  2135. #define AFE_NON_LINEAR_DATA_PACKED_60958 0x3
  2136. #define AFE_GENERIC_COMPRESSED 0x8
  2137. #define AFE_LINEAR_PCM_DATA_PACKED_16BIT 0X6
  2138. /* This param id is used to configure I2S interface */
  2139. #define AFE_PARAM_ID_I2S_CONFIG 0x0001020D
  2140. #define AFE_API_VERSION_I2S_CONFIG 0x1
  2141. /* Enumeration for setting the I2S configuration
  2142. * channel_mode parameter to
  2143. * serial data wire number 1-3 (SD3).
  2144. */
  2145. #define AFE_PORT_I2S_SD0 0x1
  2146. #define AFE_PORT_I2S_SD1 0x2
  2147. #define AFE_PORT_I2S_SD2 0x3
  2148. #define AFE_PORT_I2S_SD3 0x4
  2149. #define AFE_PORT_I2S_QUAD01 0x5
  2150. #define AFE_PORT_I2S_QUAD23 0x6
  2151. #define AFE_PORT_I2S_6CHS 0x7
  2152. #define AFE_PORT_I2S_8CHS 0x8
  2153. #define AFE_PORT_I2S_10CHS 0x9
  2154. #define AFE_PORT_I2S_12CHS 0xA
  2155. #define AFE_PORT_I2S_14CHS 0xB
  2156. #define AFE_PORT_I2S_16CHS 0xC
  2157. #define AFE_PORT_I2S_SD4 0xD
  2158. #define AFE_PORT_I2S_SD5 0xE
  2159. #define AFE_PORT_I2S_SD6 0xF
  2160. #define AFE_PORT_I2S_SD7 0x10
  2161. #define AFE_PORT_I2S_QUAD45 0x11
  2162. #define AFE_PORT_I2S_QUAD67 0x12
  2163. #define AFE_PORT_I2S_8CHS_2 0x13
  2164. #define AFE_PORT_I2S_MONO 0x0
  2165. #define AFE_PORT_I2S_STEREO 0x1
  2166. #define AFE_PORT_CONFIG_I2S_WS_SRC_EXTERNAL 0x0
  2167. #define AFE_PORT_CONFIG_I2S_WS_SRC_INTERNAL 0x1
  2168. /* Payload of the #AFE_PARAM_ID_I2S_CONFIG
  2169. * command's (I2S configuration
  2170. * parameter).
  2171. */
  2172. struct afe_param_id_i2s_cfg {
  2173. u32 i2s_cfg_minor_version;
  2174. /* Minor version used for tracking the version of the I2S
  2175. * configuration interface.
  2176. * Supported values: #AFE_API_VERSION_I2S_CONFIG
  2177. */
  2178. u16 bit_width;
  2179. /* Bit width of the sample.
  2180. * Supported values: 16, 24
  2181. */
  2182. u16 channel_mode;
  2183. /* I2S lines and multichannel operation.
  2184. * Supported values:
  2185. * - #AFE_PORT_I2S_SD0
  2186. * - #AFE_PORT_I2S_SD1
  2187. * - #AFE_PORT_I2S_SD2
  2188. * - #AFE_PORT_I2S_SD3
  2189. * - #AFE_PORT_I2S_QUAD01
  2190. * - #AFE_PORT_I2S_QUAD23
  2191. * - #AFE_PORT_I2S_6CHS
  2192. * - #AFE_PORT_I2S_8CHS
  2193. * - #AFE_PORT_I2S_10CHS
  2194. * - #AFE_PORT_I2S_12CHS
  2195. * - #AFE_PORT_I2S_14CHS
  2196. * - #AFE_PORT_I2S_16CHS
  2197. * - #AFE_PORT_I2S_SD4
  2198. * - #AFE_PORT_I2S_SD5
  2199. * - #AFE_PORT_I2S_SD6
  2200. * - #AFE_PORT_I2S_SD7
  2201. * - #AFE_PORT_I2S_QUAD45
  2202. * - #AFE_PORT_I2S_QUAD67
  2203. * - #AFE_PORT_I2S_8CHS_2
  2204. */
  2205. u16 mono_stereo;
  2206. /* Specifies mono or stereo. This applies only when
  2207. * a single I2S line is used.
  2208. * Supported values:
  2209. * - #AFE_PORT_I2S_MONO
  2210. * - #AFE_PORT_I2S_STEREO
  2211. */
  2212. u16 ws_src;
  2213. /* Word select source: internal or external.
  2214. * Supported values:
  2215. * - #AFE_PORT_CONFIG_I2S_WS_SRC_EXTERNAL
  2216. * - #AFE_PORT_CONFIG_I2S_WS_SRC_INTERNAL
  2217. */
  2218. u32 sample_rate;
  2219. /* Sampling rate of the port.
  2220. * Supported values:
  2221. * - #AFE_PORT_SAMPLE_RATE_8K
  2222. * - #AFE_PORT_SAMPLE_RATE_16K
  2223. * - #AFE_PORT_SAMPLE_RATE_48K
  2224. * - #AFE_PORT_SAMPLE_RATE_96K
  2225. * - #AFE_PORT_SAMPLE_RATE_192K
  2226. */
  2227. u16 data_format;
  2228. /* data format
  2229. * Supported values:
  2230. * - #LINEAR_PCM_DATA
  2231. * - #NON_LINEAR_DATA
  2232. * - #LINEAR_PCM_DATA_PACKED_IN_60958
  2233. * - #NON_LINEAR_DATA_PACKED_IN_60958
  2234. */
  2235. u16 reserved;
  2236. /* This field must be set to zero. */
  2237. } __packed;
  2238. /*
  2239. * This param id is used to configure PCM interface
  2240. */
  2241. #define AFE_API_VERSION_SPDIF_CONFIG_V2 0x2
  2242. #define AFE_API_VERSION_SPDIF_CONFIG 0x1
  2243. #define AFE_API_VERSION_SPDIF_CH_STATUS_CONFIG 0x1
  2244. #define AFE_API_VERSION_SPDIF_CLK_CONFIG 0x1
  2245. #define AFE_CH_STATUS_A 1
  2246. #define AFE_CH_STATUS_B 2
  2247. #define AFE_PARAM_ID_SPDIF_CONFIG 0x00010244
  2248. #define AFE_PARAM_ID_CH_STATUS_CONFIG 0x00010245
  2249. #define AFE_PARAM_ID_SPDIF_CLK_CONFIG 0x00010246
  2250. #define AFE_PORT_CLK_ROOT_LPAPLL 0x3
  2251. #define AFE_PORT_CLK_ROOT_LPAQ6PLL 0x4
  2252. #define AFE_MODULE_CUSTOM_EVENTS 0x00010251
  2253. #define AFE_PORT_FMT_UPDATE_EVENT 0x0001010E
  2254. #define AFE_API_VERSION_EVENT_FMT_UPDATE 0x1
  2255. #define AFE_PORT_STATUS_NO_SIGNAL 0
  2256. #define AFE_PORT_STATUS_AUDIO_ACTIVE 1
  2257. #define AFE_PORT_STATUS_AUDIO_EOS 2
  2258. struct afe_param_id_spdif_cfg_v2 {
  2259. /* Minor version used for tracking the version of the SPDIF
  2260. * configuration interface.
  2261. * Supported values: #AFE_API_VERSION_SPDIF_CONFIG,
  2262. * #AFE_API_VERSION_SPDIF_CONFIG_V2
  2263. */
  2264. u32 spdif_cfg_minor_version;
  2265. /* Sampling rate of the port.
  2266. * Supported values:
  2267. * - #AFE_PORT_SAMPLE_RATE_22_05K
  2268. * - #AFE_PORT_SAMPLE_RATE_32K
  2269. * - #AFE_PORT_SAMPLE_RATE_44_1K
  2270. * - #AFE_PORT_SAMPLE_RATE_48K
  2271. * - #AFE_PORT_SAMPLE_RATE_96K
  2272. * - #AFE_PORT_SAMPLE_RATE_176_4K
  2273. * - #AFE_PORT_SAMPLE_RATE_192K
  2274. */
  2275. u32 sample_rate;
  2276. /* data format
  2277. * Supported values:
  2278. * - #AFE_LINEAR_PCM_DATA
  2279. * - #AFE_NON_LINEAR_DATA
  2280. */
  2281. u16 data_format;
  2282. /* Number of channels supported by the port
  2283. * - PCM - 1, Compressed Case - 2
  2284. */
  2285. u16 num_channels;
  2286. /* Bit width of the sample.
  2287. * Supported values: 16, 24
  2288. */
  2289. u16 bit_width;
  2290. /* This field must be set to zero. */
  2291. u16 reserved;
  2292. /* Input select for spdif input, must be set to 0 for spdif output. */
  2293. u32 src_sel;
  2294. } __packed;
  2295. struct afe_param_id_spdif_ch_status_cfg {
  2296. u32 ch_status_cfg_minor_version;
  2297. /* Minor version used for tracking the version of channel
  2298. * status configuration. Current supported version is 1
  2299. */
  2300. u32 status_type;
  2301. /* Indicate if the channel status is for channel A or B
  2302. * Supported values:
  2303. * - #AFE_CH_STATUS_A
  2304. * - #AFE_CH_STATUS_B
  2305. */
  2306. u8 status_bits[24];
  2307. /* Channel status - 192 bits for channel
  2308. * Byte ordering as defined by IEC60958-3
  2309. */
  2310. u8 status_mask[24];
  2311. /* Channel status with mask bits 1 will be applied.
  2312. * Byte ordering as defined by IEC60958-3
  2313. */
  2314. } __packed;
  2315. /* deprecated */
  2316. struct afe_param_id_spdif_clk_cfg {
  2317. u32 clk_cfg_minor_version;
  2318. /* Minor version used for tracking the version of SPDIF
  2319. * interface clock configuration. Current supported version
  2320. * is 1
  2321. */
  2322. u32 clk_value;
  2323. /* Specifies the clock frequency in Hz to set
  2324. * Supported values:
  2325. * 0 - Disable the clock
  2326. * 2 (byphase) * 32 (60958 subframe size) * sampling rate * 2
  2327. * (channels A and B)
  2328. */
  2329. u32 clk_root;
  2330. /* Specifies SPDIF root clk source
  2331. * Supported Values:
  2332. * - #AFE_PORT_CLK_ROOT_LPAPLL
  2333. * - #AFE_PORT_CLK_ROOT_LPAQ6PLL
  2334. */
  2335. } __packed;
  2336. struct afe_event_fmt_update {
  2337. /* Tracks the configuration of this event. */
  2338. u32 minor_version;
  2339. /* Detected port status.
  2340. * Supported values:
  2341. * - #AFE_PORT_STATUS_NO_SIGNAL
  2342. * - #AFE_PORT_STATUS_AUDIO_ACTIVE
  2343. * - #AFE_PORT_STATUS_AUDIO_EOS
  2344. */
  2345. u32 status;
  2346. /* Sampling rate of the port.
  2347. * Supported values:
  2348. * - #AFE_PORT_SAMPLE_RATE_32K
  2349. * - #AFE_PORT_SAMPLE_RATE_44_1K
  2350. * - #AFE_PORT_SAMPLE_RATE_48K
  2351. * - #AFE_PORT_SAMPLE_RATE_88_2K
  2352. * - #AFE_PORT_SAMPLE_RATE_96K
  2353. * - #AFE_PORT_SAMPLE_RATE_176_4K
  2354. * - #AFE_PORT_SAMPLE_RATE_192K
  2355. */
  2356. u32 sample_rate;
  2357. /* Data format of the port.
  2358. * Supported values:
  2359. * - #AFE_LINEAR_PCM_DATA
  2360. * - #AFE_NON_LINEAR_DATA
  2361. */
  2362. u16 data_format;
  2363. /* First 6 bytes of channel status bits */
  2364. u8 channel_status[6];
  2365. } __packed;
  2366. struct afe_spdif_port_config {
  2367. struct afe_param_id_spdif_cfg_v2 cfg;
  2368. struct afe_param_id_spdif_ch_status_cfg ch_status;
  2369. } __packed;
  2370. #define AFE_PARAM_ID_PCM_CONFIG 0x0001020E
  2371. #define AFE_API_VERSION_PCM_CONFIG 0x1
  2372. /* Enumeration for the auxiliary PCM synchronization signal
  2373. * provided by an external source.
  2374. */
  2375. #define AFE_PORT_PCM_SYNC_SRC_EXTERNAL 0x0
  2376. /* Enumeration for the auxiliary PCM synchronization signal
  2377. * provided by an internal source.
  2378. */
  2379. #define AFE_PORT_PCM_SYNC_SRC_INTERNAL 0x1
  2380. /* Enumeration for the PCM configuration aux_mode parameter,
  2381. * which configures the auxiliary PCM interface to use
  2382. * short synchronization.
  2383. */
  2384. #define AFE_PORT_PCM_AUX_MODE_PCM 0x0
  2385. /*
  2386. * Enumeration for the PCM configuration aux_mode parameter,
  2387. * which configures the auxiliary PCM interface to use long
  2388. * synchronization.
  2389. */
  2390. #define AFE_PORT_PCM_AUX_MODE_AUX 0x1
  2391. /*
  2392. * Enumeration for setting the PCM configuration frame to 8.
  2393. */
  2394. #define AFE_PORT_PCM_BITS_PER_FRAME_8 0x0
  2395. /*
  2396. * Enumeration for setting the PCM configuration frame to 16.
  2397. */
  2398. #define AFE_PORT_PCM_BITS_PER_FRAME_16 0x1
  2399. /* Enumeration for setting the PCM configuration frame to 32.*/
  2400. #define AFE_PORT_PCM_BITS_PER_FRAME_32 0x2
  2401. /* Enumeration for setting the PCM configuration frame to 64.*/
  2402. #define AFE_PORT_PCM_BITS_PER_FRAME_64 0x3
  2403. /* Enumeration for setting the PCM configuration frame to 128.*/
  2404. #define AFE_PORT_PCM_BITS_PER_FRAME_128 0x4
  2405. /* Enumeration for setting the PCM configuration frame to 256.*/
  2406. #define AFE_PORT_PCM_BITS_PER_FRAME_256 0x5
  2407. /* Enumeration for setting the PCM configuration
  2408. * quantype parameter to A-law with no padding.
  2409. */
  2410. #define AFE_PORT_PCM_ALAW_NOPADDING 0x0
  2411. /* Enumeration for setting the PCM configuration quantype
  2412. * parameter to mu-law with no padding.
  2413. */
  2414. #define AFE_PORT_PCM_MULAW_NOPADDING 0x1
  2415. /* Enumeration for setting the PCM configuration quantype
  2416. * parameter to linear with no padding.
  2417. */
  2418. #define AFE_PORT_PCM_LINEAR_NOPADDING 0x2
  2419. /* Enumeration for setting the PCM configuration quantype
  2420. * parameter to A-law with padding.
  2421. */
  2422. #define AFE_PORT_PCM_ALAW_PADDING 0x3
  2423. /* Enumeration for setting the PCM configuration quantype
  2424. * parameter to mu-law with padding.
  2425. */
  2426. #define AFE_PORT_PCM_MULAW_PADDING 0x4
  2427. /* Enumeration for setting the PCM configuration quantype
  2428. * parameter to linear with padding.
  2429. */
  2430. #define AFE_PORT_PCM_LINEAR_PADDING 0x5
  2431. /* Enumeration for disabling the PCM configuration
  2432. * ctrl_data_out_enable parameter.
  2433. * The PCM block is the only master.
  2434. */
  2435. #define AFE_PORT_PCM_CTRL_DATA_OE_DISABLE 0x0
  2436. /*
  2437. * Enumeration for enabling the PCM configuration
  2438. * ctrl_data_out_enable parameter. The PCM block shares
  2439. * the signal with other masters.
  2440. */
  2441. #define AFE_PORT_PCM_CTRL_DATA_OE_ENABLE 0x1
  2442. /* Payload of the #AFE_PARAM_ID_PCM_CONFIG command's
  2443. * (PCM configuration parameter).
  2444. */
  2445. struct afe_param_id_pcm_cfg {
  2446. u32 pcm_cfg_minor_version;
  2447. /* Minor version used for tracking the version of the AUX PCM
  2448. * configuration interface.
  2449. * Supported values: #AFE_API_VERSION_PCM_CONFIG
  2450. */
  2451. u16 aux_mode;
  2452. /* PCM synchronization setting.
  2453. * Supported values:
  2454. * - #AFE_PORT_PCM_AUX_MODE_PCM
  2455. * - #AFE_PORT_PCM_AUX_MODE_AUX
  2456. */
  2457. u16 sync_src;
  2458. /* Synchronization source.
  2459. * Supported values:
  2460. * - #AFE_PORT_PCM_SYNC_SRC_EXTERNAL
  2461. * - #AFE_PORT_PCM_SYNC_SRC_INTERNAL
  2462. */
  2463. u16 frame_setting;
  2464. /* Number of bits per frame.
  2465. * Supported values:
  2466. * - #AFE_PORT_PCM_BITS_PER_FRAME_8
  2467. * - #AFE_PORT_PCM_BITS_PER_FRAME_16
  2468. * - #AFE_PORT_PCM_BITS_PER_FRAME_32
  2469. * - #AFE_PORT_PCM_BITS_PER_FRAME_64
  2470. * - #AFE_PORT_PCM_BITS_PER_FRAME_128
  2471. * - #AFE_PORT_PCM_BITS_PER_FRAME_256
  2472. */
  2473. u16 quantype;
  2474. /* PCM quantization type.
  2475. * Supported values:
  2476. * - #AFE_PORT_PCM_ALAW_NOPADDING
  2477. * - #AFE_PORT_PCM_MULAW_NOPADDING
  2478. * - #AFE_PORT_PCM_LINEAR_NOPADDING
  2479. * - #AFE_PORT_PCM_ALAW_PADDING
  2480. * - #AFE_PORT_PCM_MULAW_PADDING
  2481. * - #AFE_PORT_PCM_LINEAR_PADDING
  2482. */
  2483. u16 ctrl_data_out_enable;
  2484. /* Specifies whether the PCM block shares the data-out
  2485. * signal to the drive with other masters.
  2486. * Supported values:
  2487. * - #AFE_PORT_PCM_CTRL_DATA_OE_DISABLE
  2488. * - #AFE_PORT_PCM_CTRL_DATA_OE_ENABLE
  2489. */
  2490. u16 reserved;
  2491. /* This field must be set to zero. */
  2492. u32 sample_rate;
  2493. /* Sampling rate of the port.
  2494. * Supported values:
  2495. * - #AFE_PORT_SAMPLE_RATE_8K
  2496. * - #AFE_PORT_SAMPLE_RATE_16K
  2497. */
  2498. u16 bit_width;
  2499. /* Bit width of the sample.
  2500. * Supported values: 16
  2501. */
  2502. u16 num_channels;
  2503. /* Number of channels.
  2504. * Supported values: 1 to 4
  2505. */
  2506. u16 slot_number_mapping[4];
  2507. /* Specifies the slot number for the each channel in
  2508. * multi channel scenario.
  2509. * Supported values: 1 to 32
  2510. */
  2511. } __packed;
  2512. /*
  2513. * This param id is used to configure DIGI MIC interface
  2514. */
  2515. #define AFE_PARAM_ID_DIGI_MIC_CONFIG 0x0001020F
  2516. /* This version information is used to handle the new
  2517. * additions to the config interface in future in backward
  2518. * compatible manner.
  2519. */
  2520. #define AFE_API_VERSION_DIGI_MIC_CONFIG 0x1
  2521. /* Enumeration for setting the digital mic configuration
  2522. * channel_mode parameter to left 0.
  2523. */
  2524. #define AFE_PORT_DIGI_MIC_MODE_LEFT0 0x1
  2525. /*Enumeration for setting the digital mic configuration
  2526. * channel_mode parameter to right 0.
  2527. */
  2528. #define AFE_PORT_DIGI_MIC_MODE_RIGHT0 0x2
  2529. /* Enumeration for setting the digital mic configuration
  2530. * channel_mode parameter to left 1.
  2531. */
  2532. #define AFE_PORT_DIGI_MIC_MODE_LEFT1 0x3
  2533. /* Enumeration for setting the digital mic configuration
  2534. * channel_mode parameter to right 1.
  2535. */
  2536. #define AFE_PORT_DIGI_MIC_MODE_RIGHT1 0x4
  2537. /* Enumeration for setting the digital mic configuration
  2538. * channel_mode parameter to stereo 0.
  2539. */
  2540. #define AFE_PORT_DIGI_MIC_MODE_STEREO0 0x5
  2541. /* Enumeration for setting the digital mic configuration
  2542. * channel_mode parameter to stereo 1.
  2543. */
  2544. #define AFE_PORT_DIGI_MIC_MODE_STEREO1 0x6
  2545. /* Enumeration for setting the digital mic configuration
  2546. * channel_mode parameter to quad.
  2547. */
  2548. #define AFE_PORT_DIGI_MIC_MODE_QUAD 0x7
  2549. /* Payload of the #AFE_PARAM_ID_DIGI_MIC_CONFIG command's
  2550. * (DIGI MIC configuration
  2551. * parameter).
  2552. */
  2553. struct afe_param_id_digi_mic_cfg {
  2554. u32 digi_mic_cfg_minor_version;
  2555. /* Minor version used for tracking the version of the DIGI Mic
  2556. * configuration interface.
  2557. * Supported values: #AFE_API_VERSION_DIGI_MIC_CONFIG
  2558. */
  2559. u16 bit_width;
  2560. /* Bit width of the sample.
  2561. * Supported values: 16
  2562. */
  2563. u16 channel_mode;
  2564. /* Digital mic and multichannel operation.
  2565. * Supported values:
  2566. * - #AFE_PORT_DIGI_MIC_MODE_LEFT0
  2567. * - #AFE_PORT_DIGI_MIC_MODE_RIGHT0
  2568. * - #AFE_PORT_DIGI_MIC_MODE_LEFT1
  2569. * - #AFE_PORT_DIGI_MIC_MODE_RIGHT1
  2570. * - #AFE_PORT_DIGI_MIC_MODE_STEREO0
  2571. * - #AFE_PORT_DIGI_MIC_MODE_STEREO1
  2572. * - #AFE_PORT_DIGI_MIC_MODE_QUAD
  2573. */
  2574. u32 sample_rate;
  2575. /* Sampling rate of the port.
  2576. * Supported values:
  2577. * - #AFE_PORT_SAMPLE_RATE_8K
  2578. * - #AFE_PORT_SAMPLE_RATE_16K
  2579. * - #AFE_PORT_SAMPLE_RATE_48K
  2580. */
  2581. } __packed;
  2582. /* This param id is used to configure HDMI interface */
  2583. #define AFE_PARAM_ID_HDMI_CONFIG 0x00010210
  2584. #define AFE_PARAM_ID_HDMI_DP_MST_VID_IDX_CFG 0x000102b5
  2585. #define AFE_PARAM_ID_HDMI_DPTX_IDX_CFG 0x000102b6
  2586. /* This version information is used to handle the new
  2587. * additions to the config interface in future in backward
  2588. * compatible manner.
  2589. */
  2590. #define AFE_API_VERSION_HDMI_CONFIG 0x1
  2591. /* Payload of the #AFE_PARAM_ID_HDMI_CONFIG command,
  2592. * which configures a multichannel HDMI audio interface.
  2593. */
  2594. struct afe_param_id_hdmi_multi_chan_audio_cfg {
  2595. u32 hdmi_cfg_minor_version;
  2596. /* Minor version used for tracking the version of the HDMI
  2597. * configuration interface.
  2598. * Supported values: #AFE_API_VERSION_HDMI_CONFIG
  2599. */
  2600. u16 datatype;
  2601. /* data type
  2602. * Supported values:
  2603. * - #LINEAR_PCM_DATA
  2604. * - #NON_LINEAR_DATA
  2605. * - #LINEAR_PCM_DATA_PACKED_IN_60958
  2606. * - #NON_LINEAR_DATA_PACKED_IN_60958
  2607. */
  2608. u16 channel_allocation;
  2609. /* HDMI channel allocation information for programming an HDMI
  2610. * frame. The default is 0 (Stereo).
  2611. *
  2612. * This information is defined in the HDMI standard, CEA 861-D
  2613. * (refer to @xhyperref{S1,[S1]}). The number of channels is also
  2614. * inferred from this parameter.
  2615. */
  2616. u32 sample_rate;
  2617. /* Sampling rate of the port.
  2618. * Supported values:
  2619. * - #AFE_PORT_SAMPLE_RATE_8K
  2620. * - #AFE_PORT_SAMPLE_RATE_16K
  2621. * - #AFE_PORT_SAMPLE_RATE_48K
  2622. * - #AFE_PORT_SAMPLE_RATE_96K
  2623. * - 22050, 44100, 176400 for compressed streams
  2624. */
  2625. u16 bit_width;
  2626. /* Bit width of the sample.
  2627. * Supported values: 16, 24
  2628. */
  2629. u16 reserved;
  2630. /* This field must be set to zero. */
  2631. } __packed;
  2632. /* This param id is used to configure BT or FM(RIVA) interface */
  2633. #define AFE_PARAM_ID_INTERNAL_BT_FM_CONFIG 0x00010211
  2634. /* This version information is used to handle the new
  2635. * additions to the config interface in future in backward
  2636. * compatible manner.
  2637. */
  2638. #define AFE_API_VERSION_INTERNAL_BT_FM_CONFIG 0x1
  2639. /* Payload of the #AFE_PARAM_ID_INTERNAL_BT_FM_CONFIG
  2640. * command's BT voice/BT audio/FM configuration parameter.
  2641. */
  2642. struct afe_param_id_internal_bt_fm_cfg {
  2643. u32 bt_fm_cfg_minor_version;
  2644. /* Minor version used for tracking the version of the BT and FM
  2645. * configuration interface.
  2646. * Supported values: #AFE_API_VERSION_INTERNAL_BT_FM_CONFIG
  2647. */
  2648. u16 num_channels;
  2649. /* Number of channels.
  2650. * Supported values: 1 to 2
  2651. */
  2652. u16 bit_width;
  2653. /* Bit width of the sample.
  2654. * Supported values: 16
  2655. */
  2656. u32 sample_rate;
  2657. /* Sampling rate of the port.
  2658. * Supported values:
  2659. * - #AFE_PORT_SAMPLE_RATE_8K (only for BTSCO)
  2660. * - #AFE_PORT_SAMPLE_RATE_16K (only for BTSCO)
  2661. * - #AFE_PORT_SAMPLE_RATE_48K (FM and A2DP)
  2662. */
  2663. } __packed;
  2664. /* This param id is used to configure SLIMBUS interface using
  2665. * shared channel approach.
  2666. */
  2667. /* ID of the parameter used to set the latency mode of the
  2668. * USB audio device.
  2669. */
  2670. #define AFE_PARAM_ID_PORT_LATENCY_MODE_CONFIG 0x000102B3
  2671. /* Minor version used for tracking USB audio latency mode */
  2672. #define AFE_API_MINOR_VERSION_USB_AUDIO_LATENCY_MODE 0x1
  2673. /* Supported AFE port latency modes */
  2674. #define AFE_PORT_DEFAULT_LATENCY_MODE 0x0
  2675. #define AFE_PORT_LOW_LATENCY_MODE 0x1
  2676. #define AFE_PARAM_ID_SLIMBUS_CONFIG 0x00010212
  2677. /* This version information is used to handle the new
  2678. * additions to the config interface in future in backward
  2679. * compatible manner.
  2680. */
  2681. #define AFE_API_VERSION_SLIMBUS_CONFIG 0x1
  2682. /* Enumeration for setting SLIMbus device ID 1. */
  2683. #define AFE_SLIMBUS_DEVICE_1 0x0
  2684. /* Enumeration for setting SLIMbus device ID 2. */
  2685. #define AFE_SLIMBUS_DEVICE_2 0x1
  2686. /* Enumeration for setting the SLIMbus data formats. */
  2687. #define AFE_SB_DATA_FORMAT_NOT_INDICATED 0x0
  2688. /* Enumeration for setting the maximum number of streams per
  2689. * device.
  2690. */
  2691. #define AFE_PORT_MAX_AUDIO_CHAN_CNT 0x8
  2692. /* Payload of the #AFE_PORT_CMD_SLIMBUS_CONFIG command's SLIMbus
  2693. * port configuration parameter.
  2694. */
  2695. struct afe_param_id_slimbus_cfg {
  2696. u32 sb_cfg_minor_version;
  2697. /* Minor version used for tracking the version of the SLIMBUS
  2698. * configuration interface.
  2699. * Supported values: #AFE_API_VERSION_SLIMBUS_CONFIG
  2700. */
  2701. u16 slimbus_dev_id;
  2702. /* SLIMbus hardware device ID, which is required to handle
  2703. * multiple SLIMbus hardware blocks.
  2704. * Supported values: - #AFE_SLIMBUS_DEVICE_1 - #AFE_SLIMBUS_DEVICE_2
  2705. */
  2706. u16 bit_width;
  2707. /* Bit width of the sample.
  2708. * Supported values: 16, 24
  2709. */
  2710. u16 data_format;
  2711. /* Data format supported by the SLIMbus hardware. The default is
  2712. * 0 (#AFE_SB_DATA_FORMAT_NOT_INDICATED), which indicates the
  2713. * hardware does not perform any format conversions before the data
  2714. * transfer.
  2715. */
  2716. u16 num_channels;
  2717. /* Number of channels.
  2718. * Supported values: 1 to #AFE_PORT_MAX_AUDIO_CHAN_CNT
  2719. */
  2720. u8 shared_ch_mapping[AFE_PORT_MAX_AUDIO_CHAN_CNT];
  2721. /* Mapping of shared channel IDs (128 to 255) to which the
  2722. * master port is to be connected.
  2723. * Shared_channel_mapping[i] represents the shared channel assigned
  2724. * for audio channel i in multichannel audio data.
  2725. */
  2726. u32 sample_rate;
  2727. /* Sampling rate of the port.
  2728. * Supported values:
  2729. * - #AFE_PORT_SAMPLE_RATE_8K
  2730. * - #AFE_PORT_SAMPLE_RATE_16K
  2731. * - #AFE_PORT_SAMPLE_RATE_48K
  2732. * - #AFE_PORT_SAMPLE_RATE_96K
  2733. * - #AFE_PORT_SAMPLE_RATE_192K
  2734. */
  2735. } __packed;
  2736. /* ID of the parameter used by AFE_PARAM_ID_USB_AUDIO_DEV_PARAMS to configure
  2737. * USB audio device parameter. It should be used with
  2738. * AFE_MODULE_AUDIO_DEV_INTERFACE
  2739. */
  2740. #define AFE_PARAM_ID_USB_AUDIO_DEV_PARAMS 0x000102A5
  2741. /* ID of the parameter used to set the endianness value for the
  2742. * USB audio device. It should be used with
  2743. * AFE_MODULE_AUDIO_DEV_INTERFACE
  2744. */
  2745. #define AFE_PARAM_ID_USB_AUDIO_DEV_LPCM_FMT 0x000102AA
  2746. /* Minor version used for tracking USB audio configuration */
  2747. #define AFE_API_MINOR_VERSION_USB_AUDIO_CONFIG 0x1
  2748. /* Payload of the AFE_PARAM_ID_USB_AUDIO_DEV_PARAMS parameter used by
  2749. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  2750. */
  2751. struct afe_param_id_usb_audio_dev_params {
  2752. /* Minor version used for tracking USB audio device parameter.
  2753. * Supported values: AFE_API_MINOR_VERSION_USB_AUDIO_CONFIG
  2754. */
  2755. u32 cfg_minor_version;
  2756. /* Token of actual end USB aduio device */
  2757. u32 dev_token;
  2758. } __packed;
  2759. struct afe_param_id_usb_audio_dev_lpcm_fmt {
  2760. /* Minor version used for tracking USB audio device parameter.
  2761. * Supported values: AFE_API_MINOR_VERSION_USB_AUDIO_CONFIG
  2762. */
  2763. u32 cfg_minor_version;
  2764. /* Endianness of actual end USB audio device */
  2765. u32 endian;
  2766. } __packed;
  2767. struct afe_param_id_usb_audio_dev_latency_mode {
  2768. /* Minor version used for tracking USB audio device parameter.
  2769. * Supported values: AFE_API_MINOR_VERSION_USB_AUDIO_LATENCY_MODE
  2770. */
  2771. u32 minor_version;
  2772. /* latency mode for the USB audio device */
  2773. u32 mode;
  2774. } __packed;
  2775. #define AFE_PARAM_ID_USB_AUDIO_SVC_INTERVAL 0x000102B7
  2776. struct afe_param_id_usb_audio_svc_interval {
  2777. /* Minor version used for tracking USB audio device parameter.
  2778. * Supported values: AFE_API_MINOR_VERSION_USB_AUDIO_CONFIG
  2779. */
  2780. u32 cfg_minor_version;
  2781. /* Endianness of actual end USB audio device */
  2782. u32 svc_interval;
  2783. } __packed;
  2784. /* ID of the parameter used by AFE_PARAM_ID_USB_AUDIO_CONFIG to configure
  2785. * USB audio interface. It should be used with AFE_MODULE_AUDIO_DEV_INTERFACE
  2786. */
  2787. #define AFE_PARAM_ID_USB_AUDIO_CONFIG 0x000102A4
  2788. /* Payload of the AFE_PARAM_ID_USB_AUDIO_CONFIG parameter used by
  2789. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  2790. */
  2791. struct afe_param_id_usb_audio_cfg {
  2792. /* Minor version used for tracking USB audio device configuration.
  2793. * Supported values: AFE_API_MINOR_VERSION_USB_AUDIO_CONFIG
  2794. */
  2795. u32 cfg_minor_version;
  2796. /* Sampling rate of the port.
  2797. * Supported values:
  2798. * - AFE_PORT_SAMPLE_RATE_8K
  2799. * - AFE_PORT_SAMPLE_RATE_11025
  2800. * - AFE_PORT_SAMPLE_RATE_12K
  2801. * - AFE_PORT_SAMPLE_RATE_16K
  2802. * - AFE_PORT_SAMPLE_RATE_22050
  2803. * - AFE_PORT_SAMPLE_RATE_24K
  2804. * - AFE_PORT_SAMPLE_RATE_32K
  2805. * - AFE_PORT_SAMPLE_RATE_44P1K
  2806. * - AFE_PORT_SAMPLE_RATE_48K
  2807. * - AFE_PORT_SAMPLE_RATE_96K
  2808. * - AFE_PORT_SAMPLE_RATE_192K
  2809. */
  2810. u32 sample_rate;
  2811. /* Bit width of the sample.
  2812. * Supported values: 16, 24
  2813. */
  2814. u16 bit_width;
  2815. /* Number of channels.
  2816. * Supported values: 1 and 2
  2817. */
  2818. u16 num_channels;
  2819. /* Data format supported by the USB. The supported value is
  2820. * 0 (#AFE_USB_AUDIO_DATA_FORMAT_LINEAR_PCM).
  2821. */
  2822. u16 data_format;
  2823. /* this field must be 0 */
  2824. u16 reserved;
  2825. /* device token of actual end USB aduio device */
  2826. u32 dev_token;
  2827. /* endianness of this interface */
  2828. u32 endian;
  2829. /* service interval */
  2830. u32 service_interval;
  2831. } __packed;
  2832. /* This param id is used to configure Real Time Proxy interface. */
  2833. #define AFE_PARAM_ID_RT_PROXY_CONFIG 0x00010213
  2834. /* This version information is used to handle the new
  2835. * additions to the config interface in future in backward
  2836. * compatible manner.
  2837. */
  2838. #define AFE_API_VERSION_RT_PROXY_CONFIG 0x1
  2839. /* Payload of the #AFE_PARAM_ID_RT_PROXY_CONFIG
  2840. * command (real-time proxy port configuration parameter).
  2841. */
  2842. struct afe_param_id_rt_proxy_port_cfg {
  2843. u32 rt_proxy_cfg_minor_version;
  2844. /* Minor version used for tracking the version of rt-proxy
  2845. * config interface.
  2846. */
  2847. u16 bit_width;
  2848. /* Bit width of the sample.
  2849. * Supported values: 16
  2850. */
  2851. u16 interleaved;
  2852. /* Specifies whether the data exchanged between the AFE
  2853. * interface and real-time port is interleaved.
  2854. * Supported values: - 0 -- Non-interleaved (samples from each
  2855. * channel are contiguous in the buffer) - 1 -- Interleaved
  2856. * (corresponding samples from each input channel are interleaved
  2857. * within the buffer)
  2858. */
  2859. u16 frame_size;
  2860. /* Size of the frames that are used for PCM exchanges with this
  2861. * port.
  2862. * Supported values: > 0, in bytes
  2863. * For example, 5 ms buffers of 16 bits and 16 kHz stereo samples
  2864. * is 5 ms * 16 samples/ms * 2 bytes/sample * 2 channels = 320
  2865. * bytes.
  2866. */
  2867. u16 jitter_allowance;
  2868. /* Configures the amount of jitter that the port will allow.
  2869. * Supported values: > 0
  2870. * For example, if +/-10 ms of jitter is anticipated in the timing
  2871. * of sending frames to the port, and the configuration is 16 kHz
  2872. * mono with 16-bit samples, this field is 10 ms * 16 samples/ms * 2
  2873. * bytes/sample = 320.
  2874. */
  2875. u16 low_water_mark;
  2876. /* Low watermark in bytes (including all channels).
  2877. * Supported values:
  2878. * - 0 -- Do not send any low watermark events
  2879. * - > 0 -- Low watermark for triggering an event
  2880. * If the number of bytes in an internal circular buffer is lower
  2881. * than this low_water_mark parameter, a LOW_WATER_MARK event is
  2882. * sent to applications (via the #AFE_EVENT_RT_PROXY_PORT_STATUS
  2883. * event).
  2884. * Use of watermark events is optional for debugging purposes.
  2885. */
  2886. u16 high_water_mark;
  2887. /* High watermark in bytes (including all channels).
  2888. * Supported values:
  2889. * - 0 -- Do not send any high watermark events
  2890. * - > 0 -- High watermark for triggering an event
  2891. * If the number of bytes in an internal circular buffer exceeds
  2892. * TOTAL_CIRC_BUF_SIZE minus high_water_mark, a high watermark event
  2893. * is sent to applications (via the #AFE_EVENT_RT_PROXY_PORT_STATUS
  2894. * event).
  2895. * The use of watermark events is optional and for debugging
  2896. * purposes.
  2897. */
  2898. u32 sample_rate;
  2899. /* Sampling rate of the port.
  2900. * Supported values:
  2901. * - #AFE_PORT_SAMPLE_RATE_8K
  2902. * - #AFE_PORT_SAMPLE_RATE_16K
  2903. * - #AFE_PORT_SAMPLE_RATE_48K
  2904. */
  2905. u16 num_channels;
  2906. /* Number of channels.
  2907. * Supported values: 1 to #AFE_PORT_MAX_AUDIO_CHAN_CNT
  2908. */
  2909. u16 reserved;
  2910. /* For 32 bit alignment. */
  2911. } __packed;
  2912. /* This param id is used to configure the Pseudoport interface */
  2913. #define AFE_PARAM_ID_PSEUDO_PORT_CONFIG 0x00010219
  2914. /* Version information used to handle future additions to the configuration
  2915. * interface (for backward compatibility).
  2916. */
  2917. #define AFE_API_VERSION_PSEUDO_PORT_CONFIG 0x1
  2918. /* Enumeration for setting the timing_mode parameter to faster than real
  2919. * time.
  2920. */
  2921. #define AFE_PSEUDOPORT_TIMING_MODE_FTRT 0x0
  2922. /* Enumeration for setting the timing_mode parameter to real time using
  2923. * timers.
  2924. */
  2925. #define AFE_PSEUDOPORT_TIMING_MODE_TIMER 0x1
  2926. /* Payload of the AFE_PARAM_ID_PSEUDO_PORT_CONFIG parameter used by
  2927. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  2928. */
  2929. struct afe_param_id_pseudo_port_cfg {
  2930. u32 pseud_port_cfg_minor_version;
  2931. /*
  2932. * Minor version used for tracking the version of the pseudoport
  2933. * configuration interface.
  2934. */
  2935. u16 bit_width;
  2936. /* Bit width of the sample at values 16, 24 */
  2937. u16 num_channels;
  2938. /* Number of channels at values 1 to 8 */
  2939. u16 data_format;
  2940. /* Non-linear data format supported by the pseudoport (for future use).
  2941. * At values #AFE_LINEAR_PCM_DATA
  2942. */
  2943. u16 timing_mode;
  2944. /* Indicates whether the pseudoport synchronizes to the clock or
  2945. * operates faster than real time.
  2946. * at values
  2947. * - #AFE_PSEUDOPORT_TIMING_MODE_FTRT
  2948. * - #AFE_PSEUDOPORT_TIMING_MODE_TIMER @tablebulletend
  2949. */
  2950. u32 sample_rate;
  2951. /* Sample rate at which the pseudoport will run.
  2952. * at values
  2953. * - #AFE_PORT_SAMPLE_RATE_8K
  2954. * - #AFE_PORT_SAMPLE_RATE_32K
  2955. * - #AFE_PORT_SAMPLE_RATE_48K
  2956. * - #AFE_PORT_SAMPLE_RATE_96K
  2957. * - #AFE_PORT_SAMPLE_RATE_192K @tablebulletend
  2958. */
  2959. } __packed;
  2960. #define AFE_PARAM_ID_TDM_CONFIG 0x0001029D
  2961. #define AFE_API_VERSION_TDM_CONFIG 1
  2962. #define AFE_PORT_TDM_SHORT_SYNC_BIT_MODE 0
  2963. #define AFE_PORT_TDM_LONG_SYNC_MODE 1
  2964. #define AFE_PORT_TDM_SHORT_SYNC_SLOT_MODE 2
  2965. #define AFE_PORT_TDM_SYNC_SRC_EXTERNAL 0
  2966. #define AFE_PORT_TDM_SYNC_SRC_INTERNAL 1
  2967. #define AFE_PORT_TDM_CTRL_DATA_OE_DISABLE 0
  2968. #define AFE_PORT_TDM_CTRL_DATA_OE_ENABLE 1
  2969. #define AFE_PORT_TDM_SYNC_NORMAL 0
  2970. #define AFE_PORT_TDM_SYNC_INVERT 1
  2971. #define AFE_PORT_TDM_DATA_DELAY_0_BCLK_CYCLE 0
  2972. #define AFE_PORT_TDM_DATA_DELAY_1_BCLK_CYCLE 1
  2973. #define AFE_PORT_TDM_DATA_DELAY_2_BCLK_CYCLE 2
  2974. /* Payload of the AFE_PARAM_ID_TDM_CONFIG parameter used by
  2975. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  2976. */
  2977. struct afe_param_id_tdm_cfg {
  2978. u32 tdm_cfg_minor_version;
  2979. /* < Minor version used to track TDM configuration.
  2980. * @values #AFE_API_VERSION_TDM_CONFIG
  2981. */
  2982. u32 num_channels;
  2983. /* < Number of enabled slots for TDM frame.
  2984. * @values 1 to 8
  2985. */
  2986. u32 sample_rate;
  2987. /* < Sampling rate of the port.
  2988. * @values
  2989. * - #AFE_PORT_SAMPLE_RATE_8K
  2990. * - #AFE_PORT_SAMPLE_RATE_16K
  2991. * - #AFE_PORT_SAMPLE_RATE_24K
  2992. * - #AFE_PORT_SAMPLE_RATE_32K
  2993. * - #AFE_PORT_SAMPLE_RATE_48K
  2994. * - #AFE_PORT_SAMPLE_RATE_176P4K
  2995. * - #AFE_PORT_SAMPLE_RATE_352P8K @tablebulletend
  2996. */
  2997. u32 bit_width;
  2998. /* < Bit width of the sample.
  2999. * @values 16, 24
  3000. */
  3001. u16 data_format;
  3002. /* < Data format: linear ,compressed, generic compresssed
  3003. * @values
  3004. * - #AFE_LINEAR_PCM_DATA
  3005. * - #AFE_NON_LINEAR_DATA
  3006. * - #AFE_GENERIC_COMPRESSED
  3007. */
  3008. u16 sync_mode;
  3009. /* < TDM synchronization setting.
  3010. * @values (short, long, slot) sync mode
  3011. * - #AFE_PORT_TDM_SHORT_SYNC_BIT_MODE
  3012. * - #AFE_PORT_TDM_LONG_SYNC_MODE
  3013. * - #AFE_PORT_TDM_SHORT_SYNC_SLOT_MODE @tablebulletend
  3014. */
  3015. u16 sync_src;
  3016. /* < Synchronization source.
  3017. * @values
  3018. * - #AFE_PORT_TDM_SYNC_SRC_EXTERNAL
  3019. * - #AFE_PORT_TDM_SYNC_SRC_INTERNAL @tablebulletend
  3020. */
  3021. u16 nslots_per_frame;
  3022. /* < Number of slots per frame. Typical : 1, 2, 4, 8, 16, 32.
  3023. * @values 1 - 32
  3024. */
  3025. u16 ctrl_data_out_enable;
  3026. /* < Specifies whether the TDM block shares the data-out signal to the
  3027. * drive with other masters.
  3028. * @values
  3029. * - #AFE_PORT_TDM_CTRL_DATA_OE_DISABLE
  3030. * - #AFE_PORT_TDM_CTRL_DATA_OE_ENABLE @tablebulletend
  3031. */
  3032. u16 ctrl_invert_sync_pulse;
  3033. /* < Specifies whether to invert the sync or not.
  3034. * @values
  3035. * - #AFE_PORT_TDM_SYNC_NORMAL
  3036. * - #AFE_PORT_TDM_SYNC_INVERT @tablebulletend
  3037. */
  3038. u16 ctrl_sync_data_delay;
  3039. /* < Specifies the number of bit clock to delay data with respect to
  3040. * sync edge.
  3041. * @values
  3042. * - #AFE_PORT_TDM_DATA_DELAY_0_BCLK_CYCLE
  3043. * - #AFE_PORT_TDM_DATA_DELAY_1_BCLK_CYCLE
  3044. * - #AFE_PORT_TDM_DATA_DELAY_2_BCLK_CYCLE @tablebulletend
  3045. */
  3046. u16 slot_width;
  3047. /* < Slot width of the slot in a TDM frame. (slot_width >= bit_width)
  3048. * have to be satisfied.
  3049. * @values 16, 24, 32
  3050. */
  3051. u32 slot_mask;
  3052. /* < Position of active slots. When that bit is set,
  3053. * that paricular slot is active.
  3054. * Number of active slots can be inferred by number of
  3055. * bits set in the mask. Only 8 individual bits can be enabled.
  3056. * Bits 0..31 corresponding to slot 0..31
  3057. * @values 1 to 2^32 - 1
  3058. */
  3059. } __packed;
  3060. /* ID of Time Divsion Multiplexing (TDM) module,
  3061. * which is used for configuring the AFE TDM.
  3062. *
  3063. * This module supports following parameter IDs:
  3064. * - #AFE_PORT_TDM_SLOT_CONFIG
  3065. *
  3066. * To configure the TDM interface, the client must use the
  3067. * #AFE_PORT_CMD_SET_PARAM command, and fill the module ID with the
  3068. * respective parameter IDs as listed above.
  3069. */
  3070. #define AFE_MODULE_TDM 0x0001028A
  3071. /* ID of the parameter used by #AFE_MODULE_TDM to configure
  3072. * the TDM slot mapping. #AFE_PORT_CMD_SET_PARAM can use this parameter ID.
  3073. */
  3074. #define AFE_PARAM_ID_PORT_SLOT_MAPPING_CONFIG 0x00010297
  3075. /* Version information used to handle future additions to slot mapping
  3076. * configuration (for backward compatibility).
  3077. */
  3078. #define AFE_API_VERSION_SLOT_MAPPING_CONFIG 0x1
  3079. /* Data align type */
  3080. #define AFE_SLOT_MAPPING_DATA_ALIGN_MSB 0
  3081. #define AFE_SLOT_MAPPING_DATA_ALIGN_LSB 1
  3082. #define AFE_SLOT_MAPPING_OFFSET_INVALID 0xFFFF
  3083. /* Payload of the AFE_PARAM_ID_PORT_SLOT_MAPPING_CONFIG
  3084. * command's TDM configuration parameter.
  3085. */
  3086. struct afe_param_id_slot_mapping_cfg {
  3087. u32 minor_version;
  3088. /* < Minor version used for tracking TDM slot configuration.
  3089. * @values #AFE_API_VERSION_TDM_SLOT_CONFIG
  3090. */
  3091. u16 num_channel;
  3092. /* < number of channel of the audio sample.
  3093. * @values 1, 2, 4, 6, 8 @tablebulletend
  3094. */
  3095. u16 bitwidth;
  3096. /* < Slot bit width for each channel
  3097. * @values 16, 24, 32
  3098. */
  3099. u32 data_align_type;
  3100. /* < indicate how data packed from slot_offset for 32 slot bit width
  3101. * in case of sample bit width is 24.
  3102. * @values
  3103. * #AFE_SLOT_MAPPING_DATA_ALIGN_MSB
  3104. * #AFE_SLOT_MAPPING_DATA_ALIGN_LSB
  3105. */
  3106. u16 offset[AFE_PORT_MAX_AUDIO_CHAN_CNT];
  3107. /* < Array of the slot mapping start offset in bytes for this frame.
  3108. * The bytes is counted from 0. The 0 is mapped to the 1st byte
  3109. * in or out of the digital serial data line this sub-frame belong to.
  3110. * slot_offset[] setting is per-channel based.
  3111. * The max num of channel supported is 8.
  3112. * The valid offset value must always be continuly placed in from
  3113. * index 0.
  3114. * Set offset as AFE_SLOT_MAPPING_OFFSET_INVALID for not used arrays.
  3115. * If "slot_bitwidth_per_channel" is 32 and "sample_bitwidth" is 24,
  3116. * "data_align_type" is used to indicate how 24 bit sample data in
  3117. * aligning with 32 bit slot width per-channel.
  3118. * @values, in byte
  3119. */
  3120. } __packed;
  3121. /* ID of the parameter used by #AFE_MODULE_TDM to configure
  3122. * the customer TDM header. #AFE_PORT_CMD_SET_PARAM can use this parameter ID.
  3123. */
  3124. #define AFE_PARAM_ID_CUSTOM_TDM_HEADER_CONFIG 0x00010298
  3125. /* Version information used to handle future additions to custom TDM header
  3126. * configuration (for backward compatibility).
  3127. */
  3128. #define AFE_API_VERSION_CUSTOM_TDM_HEADER_CONFIG 0x1
  3129. #define AFE_CUSTOM_TDM_HEADER_TYPE_INVALID 0x0
  3130. #define AFE_CUSTOM_TDM_HEADER_TYPE_DEFAULT 0x1
  3131. #define AFE_CUSTOM_TDM_HEADER_TYPE_ENTERTAINMENT_MOST 0x2
  3132. #define AFE_CUSTOM_TDM_HEADER_MAX_CNT 0x8
  3133. /* Payload of the AFE_PARAM_ID_CUSTOM_TDM_HEADER_CONFIG parameter ID */
  3134. struct afe_param_id_custom_tdm_header_cfg {
  3135. u32 minor_version;
  3136. /* < Minor version used for tracking custom TDM header configuration.
  3137. * @values #AFE_API_VERSION_CUSTOM_TDM_HEADER_CONFIG
  3138. */
  3139. u16 start_offset;
  3140. /* < the slot mapping start offset in bytes from this sub-frame
  3141. * The bytes is counted from 0. The 0 is mapped to the 1st byte in or
  3142. * out of the digital serial data line this sub-frame belong to.
  3143. * @values, in byte,
  3144. * supported values are 0, 4, 8
  3145. */
  3146. u16 header_width;
  3147. /* < the header width per-frame followed.
  3148. * 2 bytes for MOST/TDM case
  3149. * @values, in byte
  3150. * supported value is 2
  3151. */
  3152. u16 header_type;
  3153. /* < Indicate what kind of custom TDM header it is.
  3154. * @values #AFE_CUSTOM_TDM_HEADER_TYPE_INVALID = 0
  3155. * #AFE_CUSTOM_TDM_HEADER_TYPE_DEFAULT = 1 (for AAN channel per MOST)
  3156. * #AFE_CUSTOM_TDM_HEADER_TYPE_ENTERTAINMENT_MOST = 2
  3157. * (for entertainment channel, which will overwrite
  3158. * AFE_API_VERSION_TDM_SAD_HEADER_TYPE_DEFAULT per MOST)
  3159. */
  3160. u16 num_frame_repeat;
  3161. /* < num of header followed.
  3162. * @values, supported value is 8
  3163. */
  3164. u16 header[AFE_CUSTOM_TDM_HEADER_MAX_CNT];
  3165. /* < SAD header for MOST/TDM case is followed as payload as below.
  3166. * The size of followed SAD header in bytes is num_of_frame_repeat *
  3167. * header_width_per_frame, which is 2 * 8 = 16 bytes here.
  3168. * the supported payload format is in uint16_t as below
  3169. * uint16_t header0; SyncHi 0x3C Info[4] - CodecType -> 0x3C00
  3170. * uint16_t header1; SyncLo 0xB2 Info[5] - SampleWidth -> 0xB218
  3171. * uint16_t header2; DTCP Info Info[6] - unused -> 0x0
  3172. * uint16_t header3; Extension Info[7] - ASAD-Value -> 0xC0
  3173. * uint16_t header4; Reserved Info[0] - Num of bytes following -> 0x7
  3174. * uint16_t header5; Reserved Info[1] - Media Type -> 0x0
  3175. * uint16_t header6; Reserved Info[2] - Bitrate[kbps] - High Byte -> 0x0
  3176. * uint16_t header7; Reserved Info[3] - Bitrate[kbps] - Low Byte -> 0x0
  3177. */
  3178. } __packed;
  3179. struct afe_tdm_port_config {
  3180. struct afe_param_id_tdm_cfg tdm;
  3181. struct afe_param_id_slot_mapping_cfg slot_mapping;
  3182. struct afe_param_id_custom_tdm_header_cfg custom_tdm_header;
  3183. } __packed;
  3184. #define AFE_PARAM_ID_DEVICE_HW_DELAY 0x00010243
  3185. #define AFE_API_VERSION_DEVICE_HW_DELAY 0x1
  3186. struct afe_param_id_device_hw_delay_cfg {
  3187. uint32_t device_hw_delay_minor_version;
  3188. uint32_t delay_in_us;
  3189. } __packed;
  3190. #define AFE_PARAM_ID_SET_TOPOLOGY 0x0001025A
  3191. #define AFE_API_VERSION_TOPOLOGY_V1 0x1
  3192. struct afe_param_id_set_topology_cfg {
  3193. /*
  3194. * Minor version used for tracking afe topology id configuration.
  3195. * @values #AFE_API_VERSION_TOPOLOGY_V1
  3196. */
  3197. u32 minor_version;
  3198. /*
  3199. * Id of the topology for the afe session.
  3200. * @values Any valid AFE topology ID
  3201. */
  3202. u32 topology_id;
  3203. } __packed;
  3204. #define MAX_ABR_LEVELS 5
  3205. struct afe_bit_rate_level_map_t {
  3206. /*
  3207. * Key value pair for link quality level to bitrate
  3208. * mapping in AFE
  3209. */
  3210. uint32_t link_quality_level;
  3211. uint32_t bitrate;
  3212. } __packed;
  3213. struct afe_quality_level_to_bitrate_info {
  3214. /*
  3215. * Number of quality levels being mapped.
  3216. * This will be equal to the size of mapping table.
  3217. */
  3218. uint32_t num_levels;
  3219. /*
  3220. * Quality level to bitrate mapping table
  3221. */
  3222. struct afe_bit_rate_level_map_t bit_rate_level_map[MAX_ABR_LEVELS];
  3223. } __packed;
  3224. struct afe_imc_dec_enc_info {
  3225. /*
  3226. * Decoder to encoder communication direction.
  3227. * Transmit = 0 / Receive = 1
  3228. */
  3229. uint32_t direction;
  3230. /*
  3231. * Enable / disable IMC between decoder and encoder
  3232. */
  3233. uint32_t enable;
  3234. /*
  3235. * Purpose of IMC being set up between decoder and encoder.
  3236. * Param ID defined for link quality feedback in LPASS will
  3237. * be the default value sent as purpose.
  3238. * Supported values:
  3239. * AFE_ENCDEC_PURPOSE_ID_BT_INFO
  3240. */
  3241. uint32_t purpose;
  3242. /*
  3243. * Unique communication instance ID.
  3244. * Data type a2dp_abr_instance used to set instance ID.
  3245. * purpose and comm_instance together form the actual key
  3246. * used in IMC registration, which must be the same for
  3247. * encoder and decoder for which IMC is being set up.
  3248. */
  3249. uint32_t comm_instance;
  3250. } __packed;
  3251. struct afe_abr_dec_cfg_t {
  3252. struct afe_imc_dec_enc_info imc_info;
  3253. bool is_abr_enabled;
  3254. } __packed;
  3255. struct afe_abr_enc_cfg_t {
  3256. /*
  3257. * Link quality level to bitrate mapping info sent to DSP.
  3258. */
  3259. struct afe_quality_level_to_bitrate_info mapping_info;
  3260. /*
  3261. * Information to set up IMC between decoder and encoder.
  3262. */
  3263. struct afe_imc_dec_enc_info imc_info;
  3264. /*
  3265. * Flag to indicate whether ABR is enabled.
  3266. */
  3267. bool is_abr_enabled;
  3268. } __packed;
  3269. #define AFE_PARAM_ID_APTX_SYNC_MODE 0x00013205
  3270. struct afe_param_id_aptx_sync_mode {
  3271. /*
  3272. * sync mode: 0x0 = stereo sync mode (default)
  3273. * 0x01 = dual mono sync mode
  3274. * 0x02 = dual mono with no sync on either L or R
  3275. */
  3276. uint32_t sync_mode;
  3277. } __packed;
  3278. #define AFE_ID_APTX_ADAPTIVE_ENC_INIT 0x00013324
  3279. struct afe_id_aptx_adaptive_enc_init
  3280. {
  3281. uint32_t sampling_freq;
  3282. uint32_t mtu;
  3283. uint32_t channel_mode;
  3284. uint32_t min_sink_modeA;
  3285. uint32_t max_sink_modeA;
  3286. uint32_t min_sink_modeB;
  3287. uint32_t max_sink_modeB;
  3288. uint32_t min_sink_modeC;
  3289. uint32_t max_sink_modeC;
  3290. uint32_t mode;
  3291. uint32_t input_mode;
  3292. uint32_t fade_duration;
  3293. uint8_t sink_cap[11];
  3294. } __attribute__ ((packed));
  3295. /*
  3296. * Generic encoder module ID.
  3297. * This module supports the following parameter IDs:
  3298. * #AVS_ENCODER_PARAM_ID_ENC_FMT_ID (cannot be set run time)
  3299. * #AVS_ENCODER_PARAM_ID_ENC_CFG_BLK (may be set run time)
  3300. * #AVS_ENCODER_PARAM_ID_ENC_BITRATE (may be set run time)
  3301. * #AVS_ENCODER_PARAM_ID_PACKETIZER_ID (cannot be set run time)
  3302. * Opcode - AVS_MODULE_ID_ENCODER
  3303. * AFE Command AFE_PORT_CMD_SET_PARAM_V2 supports this module ID.
  3304. */
  3305. #define AFE_MODULE_ID_ENCODER 0x00013229
  3306. /* Macro for defining the packetizer ID: COP. */
  3307. #define AFE_MODULE_ID_PACKETIZER_COP 0x0001322A
  3308. /*
  3309. * Packetizer type parameter for the #AVS_MODULE_ID_ENCODER module.
  3310. * This parameter cannot be set runtime.
  3311. */
  3312. #define AFE_ENCODER_PARAM_ID_PACKETIZER_ID 0x0001322E
  3313. /*
  3314. * Encoder config block parameter for the #AVS_MODULE_ID_ENCODER module.
  3315. * This parameter may be set runtime.
  3316. */
  3317. #define AFE_ENCODER_PARAM_ID_ENC_CFG_BLK 0x0001322C
  3318. /*
  3319. * Encoder format ID parameter for the #AVS_MODULE_ID_ENCODER module.
  3320. * This parameter cannot be set runtime.
  3321. */
  3322. #define AFE_ENCODER_PARAM_ID_ENC_FMT_ID 0x0001322B
  3323. /*
  3324. * Decoder format ID parameter for the #AVS_MODULE_ID_DECODER module.
  3325. * This parameter cannot be set runtime.
  3326. */
  3327. #define AFE_DECODER_PARAM_ID_DEC_FMT_ID 0x00013234
  3328. /*
  3329. * Encoder scrambler parameter for the #AVS_MODULE_ID_ENCODER module.
  3330. * This parameter cannot be set runtime.
  3331. */
  3332. #define AFE_ENCODER_PARAM_ID_ENABLE_SCRAMBLING 0x0001323C
  3333. /*
  3334. * Link quality level to bitrate mapping info sent to AFE Encoder.
  3335. * This parameter may be set runtime.
  3336. */
  3337. #define AFE_ENCODER_PARAM_ID_BIT_RATE_LEVEL_MAP 0x000132E1
  3338. /*
  3339. * Parameter to set up Inter Module Communication (IMC) between
  3340. * AFE Decoder and Encoder.
  3341. * This parameter may be set runtime.
  3342. */
  3343. #define AFE_ENCDEC_PARAM_ID_DEC_TO_ENC_COMMUNICATION 0x0001323D
  3344. /*
  3345. * This is needed to be used only for SWB voice call use case.
  3346. * This is needed to be issued for each direction (RX AFE and TX AFE)
  3347. * along with AFE_PARAM_ID_PORT_MEDIA_TYPE
  3348. * (Issuing AF_PARAM_ID_RATE_MATCHED_PORT param alone is not useful).
  3349. */
  3350. #define AFE_PARAM_ID_RATE_MATCHED_PORT 0x000102BE
  3351. /*
  3352. * Purpose of IMC set up between encoder and decoder.
  3353. * Communication instance and purpose together form the
  3354. * actual key used for IMC registration.
  3355. */
  3356. #define AFE_ENCDEC_PURPOSE_ID_BT_INFO 0x000132E2
  3357. #define AFE_MODULE_ID_DECODER 0x00013231
  3358. /*
  3359. * Macro for defining the depacketizer ID: COP.
  3360. */
  3361. #define AFE_MODULE_ID_DEPACKETIZER_COP 0x00013233
  3362. #define AFE_MODULE_ID_DEPACKETIZER_COP_V1 0x000132E9
  3363. /*
  3364. * Depacketizer type parameter for the #AVS_MODULE_ID_DECODER module.
  3365. * This parameter cannot be set runtime.
  3366. */
  3367. #define AFE_DECODER_PARAM_ID_DEPACKETIZER_ID 0x00013235
  3368. #define CAPI_V2_PARAM_ID_APTX_ENC_SWITCH_TO_MONO 0x0001332A
  3369. struct aptx_channel_mode_param_t {
  3370. u32 channel_mode;
  3371. } __packed;
  3372. /*
  3373. * Decoder buffer ID parameter for the #AVS_MODULE_ID_DECODER module.
  3374. * This parameter cannot be set runtime.
  3375. */
  3376. #define AFE_DECODER_PARAM_ID_CONGESTION_BUFFER_SIZE 0x000132ec
  3377. /*
  3378. * Data format to send compressed data
  3379. * is transmitted/received over Slimbus lines.
  3380. */
  3381. #define AFE_SB_DATA_FORMAT_GENERIC_COMPRESSED 0x3
  3382. /*
  3383. * Parameter to send frame control size
  3384. * to DSP for AAC encoder in AFE.
  3385. */
  3386. #define AFE_PARAM_ID_AAC_FRM_SIZE_CONTROL 0x000132EA
  3387. /*
  3388. * ID for AFE port module. This will be used to define port properties.
  3389. * This module supports following parameter IDs:
  3390. * #AFE_PARAM_ID_PORT_MEDIA_TYPE
  3391. * To configure the port property, the client must use the
  3392. * #AFE_PORT_CMD_SET_PARAM_V2 command,
  3393. * and fill the module ID with the respective parameter IDs as listed above.
  3394. * @apr_hdr_fields
  3395. * Opcode -- AFE_MODULE_PORT
  3396. */
  3397. #define AFE_MODULE_PORT 0x000102a6
  3398. /*
  3399. * ID of the parameter used by #AFE_MODULE_PORT to set the port media type.
  3400. * parameter ID is currently supported using#AFE_PORT_CMD_SET_PARAM_V2 command.
  3401. */
  3402. #define AFE_PARAM_ID_PORT_MEDIA_TYPE 0x000102a7
  3403. /*
  3404. * Macros for defining the "data_format" field in the
  3405. * #AFE_PARAM_ID_PORT_MEDIA_TYPE
  3406. */
  3407. #define AFE_PORT_DATA_FORMAT_PCM 0x0
  3408. #define AFE_PORT_DATA_FORMAT_GENERIC_COMPRESSED 0x1
  3409. /*
  3410. * Macro for defining the "minor_version" field in the
  3411. * #AFE_PARAM_ID_PORT_MEDIA_TYPE
  3412. */
  3413. #define AFE_API_VERSION_PORT_MEDIA_TYPE 0x1
  3414. #define ASM_MEDIA_FMT_NONE 0x0
  3415. /*
  3416. * Media format ID for SBC encode configuration.
  3417. * @par SBC encode configuration (asm_sbc_enc_cfg_t)
  3418. * @table{weak__asm__sbc__enc__cfg__t}
  3419. */
  3420. #define ASM_MEDIA_FMT_SBC 0x00010BF2
  3421. /* SBC channel Mono mode.*/
  3422. #define ASM_MEDIA_FMT_SBC_CHANNEL_MODE_MONO 1
  3423. /* SBC channel Stereo mode. */
  3424. #define ASM_MEDIA_FMT_SBC_CHANNEL_MODE_STEREO 2
  3425. /* SBC channel Dual Mono mode. */
  3426. #define ASM_MEDIA_FMT_SBC_CHANNEL_MODE_DUAL_MONO 8
  3427. /* SBC channel Joint Stereo mode. */
  3428. #define ASM_MEDIA_FMT_SBC_CHANNEL_MODE_JOINT_STEREO 9
  3429. /* SBC bit allocation method = loudness. */
  3430. #define ASM_MEDIA_FMT_SBC_ALLOCATION_METHOD_LOUDNESS 0
  3431. /* SBC bit allocation method = SNR. */
  3432. #define ASM_MEDIA_FMT_SBC_ALLOCATION_METHOD_SNR 1
  3433. /*
  3434. * Payload of the SBC encoder configuration parameters in the
  3435. * #ASM_MEDIA_FMT_SBC media format.
  3436. */
  3437. struct asm_sbc_enc_cfg_t {
  3438. /*
  3439. * Number of subbands.
  3440. * @values 4, 8
  3441. */
  3442. uint32_t num_subbands;
  3443. /*
  3444. * Size of the encoded block in samples.
  3445. * @values 4, 8, 12, 16
  3446. */
  3447. uint32_t blk_len;
  3448. /*
  3449. * Mode used to allocate bits between channels.
  3450. * @values
  3451. * 0 (Native mode)
  3452. * #ASM_MEDIA_FMT_SBC_CHANNEL_MODE_MONO
  3453. * #ASM_MEDIA_FMT_SBC_CHANNEL_MODE_STEREO
  3454. * #ASM_MEDIA_FMT_SBC_CHANNEL_MODE_DUAL_MONO
  3455. * #ASM_MEDIA_FMT_SBC_CHANNEL_MODE_JOINT_STEREO
  3456. * Native mode indicates that encoding must be performed with the number
  3457. * of channels at the input.
  3458. * If postprocessing outputs one-channel data, Mono mode is used. If
  3459. * postprocessing outputs two-channel data, Stereo mode is used.
  3460. * The number of channels must not change during encoding.
  3461. */
  3462. uint32_t channel_mode;
  3463. /*
  3464. * Encoder bit allocation method.
  3465. * @values
  3466. * #ASM_MEDIA_FMT_SBC_ALLOCATION_METHOD_LOUDNESS
  3467. * #ASM_MEDIA_FMT_SBC_ALLOCATION_METHOD_SNR @tablebulletend
  3468. */
  3469. uint32_t alloc_method;
  3470. /*
  3471. * Number of encoded bits per second.
  3472. * @values
  3473. * Mono channel -- Maximum of 320 kbps
  3474. * Stereo channel -- Maximum of 512 kbps @tablebulletend
  3475. */
  3476. uint32_t bit_rate;
  3477. /*
  3478. * Number of samples per second.
  3479. * @values 0 (Native mode), 16000, 32000, 44100, 48000&nbsp;Hz
  3480. * Native mode indicates that encoding must be performed with the
  3481. * sampling rate at the input.
  3482. * The sampling rate must not change during encoding.
  3483. */
  3484. uint32_t sample_rate;
  3485. };
  3486. #define ASM_MEDIA_FMT_AAC_AOT_LC 2
  3487. #define ASM_MEDIA_FMT_AAC_AOT_SBR 5
  3488. #define ASM_MEDIA_FMT_AAC_AOT_PS 29
  3489. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADTS 0
  3490. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_RAW 3
  3491. struct asm_aac_enc_cfg_v2_t {
  3492. /* Encoding rate in bits per second.*/
  3493. uint32_t bit_rate;
  3494. /*
  3495. * Encoding mode.
  3496. * Supported values:
  3497. * #ASM_MEDIA_FMT_AAC_AOT_LC
  3498. * #ASM_MEDIA_FMT_AAC_AOT_SBR
  3499. * #ASM_MEDIA_FMT_AAC_AOT_PS
  3500. */
  3501. uint32_t enc_mode;
  3502. /*
  3503. * AAC format flag.
  3504. * Supported values:
  3505. * #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADTS
  3506. * #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_RAW
  3507. */
  3508. uint16_t aac_fmt_flag;
  3509. /*
  3510. * Number of channels to encode.
  3511. * Supported values:
  3512. * 0 - Native mode
  3513. * 1 - Mono
  3514. * 2 - Stereo
  3515. * Other values are not supported.
  3516. * @note1hang The eAAC+ encoder mode supports only stereo.
  3517. * Native mode indicates that encoding must be performed with the
  3518. * number of channels at the input.
  3519. * The number of channels must not change during encoding.
  3520. */
  3521. uint16_t channel_cfg;
  3522. /*
  3523. * Number of samples per second.
  3524. * Supported values: - 0 -- Native mode - For other values,
  3525. * Native mode indicates that encoding must be performed with the
  3526. * sampling rate at the input.
  3527. * The sampling rate must not change during encoding.
  3528. */
  3529. uint32_t sample_rate;
  3530. } __packed;
  3531. /* Structure to control frame size of AAC encoded frames. */
  3532. struct asm_aac_frame_size_control_t {
  3533. /* Type of frame size control: MTU_SIZE / PEAK_BIT_RATE*/
  3534. uint32_t ctl_type;
  3535. /*
  3536. * Control value
  3537. * MTU_SIZE: MTU size in bytes
  3538. * PEAK_BIT_RATE: Peak bitrate in bits per second.
  3539. */
  3540. uint32_t ctl_value;
  3541. } __packed;
  3542. struct asm_aac_enc_cfg_t {
  3543. struct asm_aac_enc_cfg_v2_t aac_cfg;
  3544. struct asm_aac_frame_size_control_t frame_ctl;
  3545. } __packed;
  3546. /* FMT ID for apt-X Classic */
  3547. #define ASM_MEDIA_FMT_APTX 0x000131ff
  3548. /* FMT ID for apt-X HD */
  3549. #define ASM_MEDIA_FMT_APTX_HD 0x00013200
  3550. /* FMT ID for apt-X Adaptive */
  3551. #define ASM_MEDIA_FMT_APTX_ADAPTIVE 0x00013204
  3552. /* FMT ID for apt-X Adaptive speech */
  3553. #define ASM_MEDIA_FMT_APTX_AD_SPEECH 0x00013208
  3554. #define PCM_CHANNEL_L 1
  3555. #define PCM_CHANNEL_R 2
  3556. #define PCM_CHANNEL_C 3
  3557. struct asm_custom_enc_cfg_t {
  3558. uint32_t sample_rate;
  3559. /* Mono or stereo */
  3560. uint16_t num_channels;
  3561. uint16_t reserved;
  3562. /* num_ch == 1, then PCM_CHANNEL_C,
  3563. * num_ch == 2, then {PCM_CHANNEL_L, PCM_CHANNEL_R}
  3564. */
  3565. uint8_t channel_mapping[8];
  3566. uint32_t custom_size;
  3567. } __packed;
  3568. struct asm_aptx_ad_speech_mode_cfg_t
  3569. {
  3570. uint32_t speech_mode;
  3571. /*
  3572. * speech mode of codec.
  3573. *
  3574. * @values 0x0(swb), 0x4(sswb)
  3575. */
  3576. uint32_t swapping;
  3577. /*
  3578. * byte swapping of codec.
  3579. *
  3580. * @values 0x1, enable swapping
  3581. */
  3582. } __packed;
  3583. struct asm_aptx_v2_enc_cfg_ext_t {
  3584. /*
  3585. * sync mode: 0x0 = stereo sync mode (default)
  3586. * 0x01 = dual mono sync mode
  3587. * 0x02 = dual mono with no sync on either L or R
  3588. */
  3589. uint32_t sync_mode;
  3590. } __packed;
  3591. struct asm_aptx_enc_cfg_t {
  3592. struct asm_custom_enc_cfg_t custom_cfg;
  3593. struct asm_aptx_v2_enc_cfg_ext_t aptx_v2_cfg;
  3594. } __packed;
  3595. struct asm_aptx_ad_enc_cfg_t
  3596. {
  3597. struct asm_custom_enc_cfg_t custom_cfg;
  3598. struct afe_id_aptx_adaptive_enc_init aptx_ad_cfg;
  3599. struct afe_abr_enc_cfg_t abr_cfg;
  3600. } __attribute__ ((packed));
  3601. struct asm_aptx_ad_speech_enc_cfg_t
  3602. {
  3603. struct asm_custom_enc_cfg_t custom_cfg;
  3604. struct afe_imc_dec_enc_info imc_info;
  3605. struct asm_aptx_ad_speech_mode_cfg_t speech_mode;
  3606. } __attribute__ ((packed));
  3607. struct afe_matched_port_t
  3608. {
  3609. uint32_t minor_version;
  3610. uint32_t enable;
  3611. } __attribute__ ((packed));
  3612. #define ASM_MEDIA_FMT_CELT 0x00013221
  3613. struct asm_celt_specific_enc_cfg_t {
  3614. /*
  3615. * Bit rate used for encoding.
  3616. * This is used to calculate the upper threshold
  3617. * for bytes per frame if vbr_flag is 1.
  3618. * Or else, this will be used as a regular constant
  3619. * bit rate for encoder output.
  3620. * @Range : 32000 to 1536000
  3621. * @Default: 128
  3622. */
  3623. uint32_t bit_rate;
  3624. /*
  3625. * Frame size used for encoding.
  3626. * @Range : 64, 128, 256, 512
  3627. * @Default: 256
  3628. */
  3629. uint16_t frame_size;
  3630. /*
  3631. * complexity of algorithm.
  3632. * @Range : 0-10
  3633. * @Default: 3
  3634. */
  3635. uint16_t complexity;
  3636. /*
  3637. * Switch variable for prediction feature.
  3638. * Used to choose between the level of interframe
  3639. * predictions allowed while encoding.
  3640. * @Range:
  3641. * 0: Independent Frames.
  3642. * 1: Short Term interframe prediction allowed.
  3643. * 2: Long term prediction allowed.
  3644. * @Default: 2
  3645. */
  3646. uint16_t prediction_mode;
  3647. /*
  3648. * Variable Bit Rate flag.
  3649. * @Default: 0
  3650. */
  3651. uint16_t vbr_flag;
  3652. } __packed;
  3653. struct asm_celt_enc_cfg_t {
  3654. struct asm_custom_enc_cfg_t custom_config;
  3655. struct asm_celt_specific_enc_cfg_t celt_specific_config;
  3656. } __packed;
  3657. #define ASM_MEDIA_FMT_LDAC 0x00013224
  3658. #define ENC_CODEC_TYPE_LDAC 0x23000000
  3659. struct asm_ldac_specific_enc_cfg_t {
  3660. /*
  3661. * This is used to calculate the encoder output
  3662. * bytes per frame (i.e. bytes per packet).
  3663. * Bit rate also configures the EQMID.
  3664. * The min bit rate 303000 bps is calculated for
  3665. * 44.1 kHz and 88.2 KHz sampling frequencies with
  3666. * Mobile use Quality.
  3667. * The max bit rate of 990000 bps is calculated for
  3668. * 96kHz and 48 KHz with High Quality
  3669. * @Range(in bits per second)
  3670. * 303000 for Mobile use Quality
  3671. * 606000 for standard Quality
  3672. * 909000 for High Quality
  3673. */
  3674. uint32_t bit_rate;
  3675. /*
  3676. * The channel setting information for LDAC specification
  3677. * of Bluetooth A2DP which is determined by SRC and SNK
  3678. * devices in Bluetooth transmission.
  3679. * @Range:
  3680. * 0 for native mode
  3681. * 4 for mono
  3682. * 2 for dual channel
  3683. * 1 for stereo
  3684. */
  3685. uint16_t channel_mode;
  3686. /*
  3687. * Maximum Transmission Unit (MTU).
  3688. * The minimum MTU that a L2CAP implementation for LDAC shall
  3689. * support is 679 bytes, because LDAC is optimized with 2-DH5
  3690. * packet as its target.
  3691. * @Range : 679
  3692. * @Default: 679 for LDACBT_MTU_2DH5
  3693. */
  3694. uint16_t mtu;
  3695. } __packed;
  3696. struct asm_ldac_enc_cfg_t {
  3697. struct asm_custom_enc_cfg_t custom_config;
  3698. struct asm_ldac_specific_enc_cfg_t ldac_specific_config;
  3699. struct afe_abr_enc_cfg_t abr_config;
  3700. } __packed;
  3701. struct afe_enc_fmt_id_param_t {
  3702. /*
  3703. * Supported values:
  3704. * #ASM_MEDIA_FMT_SBC
  3705. * #ASM_MEDIA_FMT_AAC_V2
  3706. * Any OpenDSP supported values
  3707. */
  3708. uint32_t fmt_id;
  3709. } __packed;
  3710. struct afe_port_media_type_t {
  3711. /*
  3712. * Minor version
  3713. * @values #AFE_API_VERSION_PORT_MEDIA_TYPE.
  3714. */
  3715. uint32_t minor_version;
  3716. /*
  3717. * Sampling rate of the port.
  3718. * @values
  3719. * #AFE_PORT_SAMPLE_RATE_8K
  3720. * #AFE_PORT_SAMPLE_RATE_11_025K
  3721. * #AFE_PORT_SAMPLE_RATE_12K
  3722. * #AFE_PORT_SAMPLE_RATE_16K
  3723. * #AFE_PORT_SAMPLE_RATE_22_05K
  3724. * #AFE_PORT_SAMPLE_RATE_24K
  3725. * #AFE_PORT_SAMPLE_RATE_32K
  3726. * #AFE_PORT_SAMPLE_RATE_44_1K
  3727. * #AFE_PORT_SAMPLE_RATE_48K
  3728. * #AFE_PORT_SAMPLE_RATE_88_2K
  3729. * #AFE_PORT_SAMPLE_RATE_96K
  3730. * #AFE_PORT_SAMPLE_RATE_176_4K
  3731. * #AFE_PORT_SAMPLE_RATE_192K
  3732. * #AFE_PORT_SAMPLE_RATE_352_8K
  3733. * #AFE_PORT_SAMPLE_RATE_384K
  3734. */
  3735. uint32_t sample_rate;
  3736. /*
  3737. * Bit width of the sample.
  3738. * @values 16, 24
  3739. */
  3740. uint16_t bit_width;
  3741. /*
  3742. * Number of channels.
  3743. * @values 1 to #AFE_PORT_MAX_AUDIO_CHAN_CNT
  3744. */
  3745. uint16_t num_channels;
  3746. /*
  3747. * Data format supported by this port.
  3748. * If the port media type and device media type are different,
  3749. * it signifies a encoding/decoding use case
  3750. * @values
  3751. * #AFE_PORT_DATA_FORMAT_PCM
  3752. * #AFE_PORT_DATA_FORMAT_GENERIC_COMPRESSED
  3753. */
  3754. uint16_t data_format;
  3755. /*This field must be set to zero.*/
  3756. uint16_t reserved;
  3757. } __packed;
  3758. /*
  3759. * Payload of the SBC decoder configuration parameters in the
  3760. * #ASM_MEDIA_FMT_SBC media format.
  3761. */
  3762. struct asm_sbc_dec_cfg_t {
  3763. uint16_t channels;
  3764. /*
  3765. * Number of channels present in the SBC stream.
  3766. *
  3767. * @values
  3768. * - 1 -- Mono
  3769. * - 2 -- Stereo
  3770. */
  3771. uint32_t sample_rate;
  3772. /*
  3773. * Number of samples per second.
  3774. *
  3775. * @values 8000, 11025, 12000, 16000, 22050, 24000, 32000,
  3776. * 44100, 48000, 64000, 88200, 96000 Hz
  3777. */
  3778. } __packed;
  3779. /*
  3780. * Payload of the MP3 decoder configuration parameters in the
  3781. * #ASM_MEDIA_FMT_MP3 media format.
  3782. */
  3783. struct asm_mp3_dec_cfg_t {
  3784. /* All configuration is extracted from the stream */
  3785. } __packed;
  3786. struct asm_aac_dec_cfg_v2_t {
  3787. uint16_t aac_fmt_flag;
  3788. /*
  3789. * Bit stream format option.
  3790. *
  3791. * @values
  3792. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADTS
  3793. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_LOAS
  3794. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADIF
  3795. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_RAW
  3796. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_LATM
  3797. */
  3798. uint16_t audio_obj_type;
  3799. /*
  3800. * Audio Object Type (AOT) present in the AAC stream.
  3801. *
  3802. * @values
  3803. * - #ASM_MEDIA_FMT_AAC_AOT_LC
  3804. * - #ASM_MEDIA_FMT_AAC_AOT_SBR
  3805. * - #ASM_MEDIA_FMT_AAC_AOT_BSAC
  3806. * - #ASM_MEDIA_FMT_AAC_AOT_PS
  3807. *
  3808. * Other values are not supported.
  3809. */
  3810. uint16_t channel_config;
  3811. /*
  3812. * Number of channels present in the AAC stream.
  3813. *
  3814. * @values
  3815. * - 0 -- PCE
  3816. * - 1 -- Mono
  3817. * - 2 -- Stereo
  3818. * - 6 -- 5.1 content
  3819. */
  3820. uint16_t total_size_of_PCE_bits;
  3821. /*
  3822. * For RAW formats and if channel_config=0 (PCE),
  3823. * the client can send the bit stream containing PCE
  3824. * immediately following this structure (in band).
  3825. *
  3826. * @values @ge 0 (does not include the bits required
  3827. * for 32-bit alignment)
  3828. *
  3829. * If this field is set to 0, the PCE information is
  3830. * assumed to be available in the audio bit stream
  3831. * and not in band.
  3832. *
  3833. * If this field is greater than 0, the PCE information
  3834. * follows this structure. Additional bits might
  3835. * be required for 32-bit alignment.
  3836. */
  3837. uint32_t sample_rate;
  3838. /*
  3839. * Number of samples per second.
  3840. *
  3841. * @values 8000, 11025, 12000, 16000, 22050, 24000, 32000,
  3842. * 44100, 48000, 64000, 88200, 96000 Hz
  3843. *
  3844. * This field must be equal to the sample rate of the
  3845. * AAC-LC decoder output.
  3846. * - For MP4 or 3GP containers, this sample rate
  3847. * is indicated by the
  3848. * samplingFrequencyIndex field in the
  3849. * AudioSpecificConfig element.
  3850. * - For ADTS format, this sample rate is indicated by the
  3851. * samplingFrequencyIndex in the ADTS fixed header.
  3852. * - For ADIF format, this sample rate is indicated by the
  3853. * samplingFrequencyIndex in the program_config_element
  3854. * present in the ADIF header.
  3855. */
  3856. } __packed;
  3857. /*
  3858. * Payload of the APTX AD decoder configuration parameters in the
  3859. * #ASM_MEDIA_FMT_APTX_ADAPTIVE media format.
  3860. */
  3861. struct asm_aptx_ad_dec_cfg_t {
  3862. uint32_t sample_rate;
  3863. /*
  3864. * Number of samples per second.
  3865. *
  3866. * @values 0x0(48000Hz), 0x1(44100Hz)
  3867. */
  3868. } __packed;
  3869. struct asm_aptx_ad_speech_dec_cfg_t {
  3870. struct asm_aptx_ad_speech_mode_cfg_t speech_mode;
  3871. };
  3872. union afe_enc_config_data {
  3873. struct asm_sbc_enc_cfg_t sbc_config;
  3874. struct asm_aac_enc_cfg_t aac_config;
  3875. struct asm_custom_enc_cfg_t custom_config;
  3876. struct asm_celt_enc_cfg_t celt_config;
  3877. struct asm_aptx_enc_cfg_t aptx_config;
  3878. struct asm_ldac_enc_cfg_t ldac_config;
  3879. struct asm_aptx_ad_enc_cfg_t aptx_ad_config;
  3880. struct asm_aptx_ad_speech_enc_cfg_t aptx_ad_speech_config;
  3881. };
  3882. struct afe_enc_config {
  3883. u32 format;
  3884. u32 scrambler_mode;
  3885. u32 mono_mode;
  3886. union afe_enc_config_data data;
  3887. };
  3888. union afe_dec_config_data {
  3889. struct asm_sbc_dec_cfg_t sbc_config;
  3890. struct asm_aac_dec_cfg_v2_t aac_config;
  3891. struct asm_mp3_dec_cfg_t mp3_config;
  3892. struct asm_aptx_ad_dec_cfg_t aptx_ad_config;
  3893. struct asm_aptx_ad_speech_dec_cfg_t aptx_ad_speech_config;
  3894. };
  3895. struct afe_dec_config {
  3896. u32 format;
  3897. struct afe_abr_dec_cfg_t abr_dec_cfg;
  3898. union afe_dec_config_data data;
  3899. };
  3900. struct afe_enc_cfg_blk_param_t {
  3901. uint32_t enc_cfg_blk_size;
  3902. /*
  3903. *Size of the encoder configuration block that follows this member
  3904. */
  3905. union afe_enc_config_data enc_blk_config;
  3906. };
  3907. struct afe_enc_aptx_ad_speech_cfg_blk_param_t {
  3908. uint32_t enc_cfg_blk_size;
  3909. /*
  3910. * Size of the encoder configuration block that follows this member
  3911. */
  3912. struct asm_custom_enc_cfg_t custom_cfg;
  3913. };
  3914. /*
  3915. * Payload of the AVS_DECODER_PARAM_ID_DEC_MEDIA_FMT parameter used by
  3916. * AVS_MODULE_ID_DECODER.
  3917. */
  3918. struct afe_dec_media_fmt_t {
  3919. union afe_dec_config_data dec_media_config;
  3920. } __packed;
  3921. /*
  3922. * Payload of the AVS_ENCODER_PARAM_ID_PACKETIZER_ID parameter.
  3923. */
  3924. struct avs_enc_packetizer_id_param_t {
  3925. /*
  3926. * Supported values:
  3927. * #AVS_MODULE_ID_PACKETIZER_COP
  3928. * Any OpenDSP supported values
  3929. */
  3930. uint32_t enc_packetizer_id;
  3931. };
  3932. /*
  3933. * Payload of the AVS_ENCODER_PARAM_ID_ENABLE_SCRAMBLING parameter.
  3934. */
  3935. struct avs_enc_set_scrambler_param_t {
  3936. /*
  3937. * Supported values:
  3938. * 1 : enable scrambler
  3939. * 0 : disable scrambler
  3940. */
  3941. uint32_t enable_scrambler;
  3942. };
  3943. /*
  3944. * Payload of the AVS_ENCODER_PARAM_ID_BIT_RATE_LEVEL_MAP parameter.
  3945. */
  3946. struct afe_enc_level_to_bitrate_map_param_t {
  3947. /*
  3948. * Parameter for mapping link quality level to bitrate.
  3949. */
  3950. struct afe_quality_level_to_bitrate_info mapping_table;
  3951. };
  3952. /*
  3953. * Payload of the AVS_ENCDEC_PARAM_ID_DEC_TO_ENC_COMMUNICATION parameter.
  3954. */
  3955. struct afe_enc_dec_imc_info_param_t {
  3956. /*
  3957. * Parameter to set up Inter Module Communication (IMC) between
  3958. * AFE Decoder and Encoder.
  3959. */
  3960. struct afe_imc_dec_enc_info imc_info;
  3961. };
  3962. /*
  3963. * Payload of the AVS_DECODER_PARAM_ID_DEPACKETIZER_ID parameter.
  3964. */
  3965. struct avs_dec_depacketizer_id_param_t {
  3966. /*
  3967. * Supported values:
  3968. * #AFE_MODULE_ID_DEPACKETIZER_COP
  3969. * #AFE_MODULE_ID_DEPACKETIZER_COP_V1
  3970. * Any OpenDSP supported values
  3971. */
  3972. uint32_t dec_depacketizer_id;
  3973. };
  3974. struct avs_dec_congestion_buffer_param_t {
  3975. uint32_t version;
  3976. uint16_t max_nr_buffers;
  3977. /*
  3978. * Maximum number of 1ms buffers:
  3979. * 0 - 256
  3980. */
  3981. uint16_t pre_buffer_size;
  3982. /*
  3983. * Pre-buffering size in 1ms:
  3984. * 1 - 128
  3985. */
  3986. };
  3987. /*
  3988. * ID of the parameter used by #AVS_MODULE_ID_DECODER to configure
  3989. * the decoder mode for the AFE module.
  3990. * This parameter cannot be set at runtime.
  3991. */
  3992. #define AVS_DECODER_PARAM_ID_DEC_MEDIA_FMT 0x00013232
  3993. /*
  3994. * ID of the parameter used by #AVS_MODULE_ID_DECODER to configure
  3995. * the decoder mode of adaptive speech and byte swap mode
  3996. */
  3997. #define AVS_DECODER_PARAM_ID_APTX_AD_SPEECH_DEC_INIT 0x0001334D
  3998. /*
  3999. * ID of the parameter used by #AVS_MODULE_ID_ENCODER to configure
  4000. * the encoder mode of adaptive speech and byte swap mode
  4001. */
  4002. #define AVS_DECODER_PARAM_ID_APTX_AD_SPEECH_ENC_INIT 0x0001332B
  4003. /* ID of the parameter used by #AFE_MODULE_AUDIO_DEV_INTERFACE to configure
  4004. * the island mode for a given AFE port.
  4005. */
  4006. #define AFE_PARAM_ID_ISLAND_CONFIG 0x000102B4
  4007. /* Version information used to handle future additions to codec DMA
  4008. * configuration (for backward compatibility).
  4009. */
  4010. #define AFE_API_VERSION_ISLAND_CONFIG 0x1
  4011. /* Payload of the AFE_PARAM_ID_ISLAND_CONFIG parameter used by
  4012. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  4013. */
  4014. struct afe_param_id_island_cfg_t {
  4015. uint32_t island_cfg_minor_version;
  4016. /* Tracks the configuration of this parameter.
  4017. * Supported values: #AFE_API_VERSION_ISLAND_CONFIG
  4018. */
  4019. uint32_t island_enable;
  4020. /* Specifies whether island mode should be enabled or disabled for the
  4021. * use-case being setup.
  4022. * Supported values: 0 - Disable, 1 - Enable
  4023. */
  4024. } __packed;
  4025. /* ID of the parameter used by #AFE_MODULE_AUDIO_DEV_INTERFACE to configure
  4026. * the Codec DMA interface.
  4027. */
  4028. #define AFE_PARAM_ID_CODEC_DMA_CONFIG 0x000102B8
  4029. /* Version information used to handle future additions to codec DMA
  4030. * configuration (for backward compatibility).
  4031. */
  4032. #define AFE_API_VERSION_CODEC_DMA_CONFIG 0x1
  4033. /* Payload of the AFE_PARAM_ID_CODEC_DMA_CONFIG parameter used by
  4034. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  4035. */
  4036. struct afe_param_id_cdc_dma_cfg_t {
  4037. uint32_t cdc_dma_cfg_minor_version;
  4038. /* Tracks the configuration of this parameter.
  4039. * Supported values: #AFE_API_VERSION_CODEC_DMA_CONFIG
  4040. */
  4041. uint32_t sample_rate;
  4042. /* Sampling rate of the port.
  4043. * Supported values:
  4044. * - #AFE_PORT_SAMPLE_RATE_8K
  4045. * - #AFE_PORT_SAMPLE_RATE_11_025K
  4046. * - #AFE_PORT_SAMPLE_RATE_12K
  4047. * - #AFE_PORT_SAMPLE_RATE_16K
  4048. * - #AFE_PORT_SAMPLE_RATE_22_05K
  4049. * - #AFE_PORT_SAMPLE_RATE_24K
  4050. * - #AFE_PORT_SAMPLE_RATE_32K
  4051. * - #AFE_PORT_SAMPLE_RATE_44_1K
  4052. * - #AFE_PORT_SAMPLE_RATE_48K
  4053. * - #AFE_PORT_SAMPLE_RATE_88_2K
  4054. * - #AFE_PORT_SAMPLE_RATE_96K
  4055. * - #AFE_PORT_SAMPLE_RATE_176_4K
  4056. * - #AFE_PORT_SAMPLE_RATE_192K
  4057. * - #AFE_PORT_SAMPLE_RATE_352_8K
  4058. * - #AFE_PORT_SAMPLE_RATE_384K
  4059. */
  4060. uint16_t bit_width;
  4061. /* Bit width of the sample.
  4062. * Supported values: 16, 24, 32
  4063. */
  4064. uint16_t data_format;
  4065. /* Data format supported by the codec DMA interface.
  4066. * Supported values:
  4067. * - #AFE_LINEAR_PCM_DATA
  4068. * - #AFE_LINEAR_PCM_DATA_PACKED_16BIT
  4069. */
  4070. uint16_t num_channels;
  4071. /* Number of channels.
  4072. * Supported values: 1 to Maximum number of channels supported
  4073. * for each interface
  4074. */
  4075. uint16_t active_channels_mask;
  4076. /* Active channels mask to denote the bit mask for active channels.
  4077. * Bits 0 to 7 denote channels 0 to 7. A 1 denotes the channel is active
  4078. * while a 0 denotes a channel is inactive.
  4079. * Supported values:
  4080. * Any mask with number of active bits equal to num_channels
  4081. */
  4082. } __packed;
  4083. union afe_port_config {
  4084. struct afe_param_id_pcm_cfg pcm;
  4085. struct afe_param_id_i2s_cfg i2s;
  4086. struct afe_param_id_hdmi_multi_chan_audio_cfg hdmi_multi_ch;
  4087. struct afe_param_id_slimbus_cfg slim_sch;
  4088. struct afe_param_id_rt_proxy_port_cfg rtproxy;
  4089. struct afe_param_id_internal_bt_fm_cfg int_bt_fm;
  4090. struct afe_param_id_pseudo_port_cfg pseudo_port;
  4091. struct afe_param_id_device_hw_delay_cfg hw_delay;
  4092. struct afe_param_id_spdif_cfg_v2 spdif;
  4093. struct afe_param_id_set_topology_cfg topology;
  4094. struct afe_param_id_tdm_cfg tdm;
  4095. struct afe_param_id_usb_audio_cfg usb_audio;
  4096. struct afe_param_id_aptx_sync_mode sync_mode_param;
  4097. struct asm_aac_frame_size_control_t frame_ctl_param;
  4098. struct afe_enc_fmt_id_param_t enc_fmt;
  4099. struct afe_port_media_type_t media_type;
  4100. struct afe_enc_cfg_blk_param_t enc_blk_param;
  4101. struct avs_enc_packetizer_id_param_t enc_pkt_id_param;
  4102. struct avs_enc_set_scrambler_param_t enc_set_scrambler_param;
  4103. struct avs_dec_depacketizer_id_param_t dec_depkt_id_param;
  4104. struct afe_dec_media_fmt_t dec_media_fmt;
  4105. struct afe_enc_level_to_bitrate_map_param_t map_param;
  4106. struct afe_enc_dec_imc_info_param_t imc_info_param;
  4107. struct afe_param_id_cdc_dma_cfg_t cdc_dma;
  4108. } __packed;
  4109. /*
  4110. * AFE event registration related APIs and corresponding payloads
  4111. */
  4112. #define AFE_SVC_CMD_EVENT_CFG 0x000100FE
  4113. #define AFE_CMD_APPS_WAKEUP_IRQ_REGISTER_MINOR_VERSION 0x1
  4114. /* Flag to indicate AFE to register APPS wakeup Interrupt */
  4115. #define AFE_APPS_WAKEUP_IRQ_REGISTER_FLAG 1
  4116. /* Flag to indicate AFE to de-register APPS wakeup Interrupt */
  4117. #define AFE_APPS_WAKEUP_IRQ_DEREGISTER_FLAG 0
  4118. /* Default interrupt trigger value. */
  4119. #define DEFAULT_SETTINGS 0x00000001
  4120. /* Interrupt is triggered only if the input signal at the source is high. */
  4121. #define LEVEL_HIGH_TRIGGER 0x00000002
  4122. /* Interrupt is triggered only if the input signal at the source is low. */
  4123. #define LEVEL_LOW_TRIGGER 0x00000003
  4124. /* Interrupt is triggered only if the input signal at the source transitions
  4125. *from low to high.
  4126. */
  4127. #define RISING_EDGE_TRIGGER 0x00000004
  4128. /* Interrupt is triggered only if the input signal at the source transitions
  4129. *from high to low.
  4130. */
  4131. #define FALLING_EDGE_TRIGGER 0x00000005
  4132. /* Macro for invalid trigger type. This should not be used. */
  4133. #define INVALID_TRIGGER 0x00000006
  4134. #define AFE_EVENT_ID_MBHC_DETECTION_SW_WA 0x1
  4135. /* @weakgroup weak_afe_svc_cmd_evt_cfg_payload
  4136. *
  4137. * This is payload of each event that is to be
  4138. * registered with AFE service.
  4139. */
  4140. struct afe_svc_cmd_evt_cfg_payload {
  4141. struct apr_hdr hdr;
  4142. uint32_t event_id;
  4143. /* Unique ID of the event.
  4144. *
  4145. * @values
  4146. * -# AFE_EVENT_ID_MBHC_DETECTION_SW_WA
  4147. */
  4148. uint32_t reg_flag;
  4149. /* Flag for registering or de-registering an event.
  4150. * @values
  4151. * - #AFE_SVC_REGISTER_EVENT_FLAG
  4152. * - #AFE_SVC_DEREGISTER_EVENT_FLAG
  4153. */
  4154. } __packed;
  4155. #define AFE_EVENT_MBHC_DETECTION_SW_WA 0x0001010F
  4156. #define AFE_PORT_CMD_DEVICE_START 0x000100E5
  4157. /* Payload of the #AFE_PORT_CMD_DEVICE_START.*/
  4158. struct afe_port_cmd_device_start {
  4159. struct apr_hdr hdr;
  4160. u16 port_id;
  4161. /* Port interface and direction (Rx or Tx) to start. An even
  4162. * number represents the Rx direction, and an odd number represents
  4163. * the Tx direction.
  4164. */
  4165. u16 reserved;
  4166. /* Reserved for 32-bit alignment. This field must be set to 0.*/
  4167. } __packed;
  4168. #define AFE_PORT_CMD_DEVICE_STOP 0x000100E6
  4169. /* Payload of the #AFE_PORT_CMD_DEVICE_STOP. */
  4170. struct afe_port_cmd_device_stop {
  4171. struct apr_hdr hdr;
  4172. u16 port_id;
  4173. /* Port interface and direction (Rx or Tx) to start. An even
  4174. * number represents the Rx direction, and an odd number represents
  4175. * the Tx direction.
  4176. */
  4177. u16 reserved;
  4178. /* Reserved for 32-bit alignment. This field must be set to 0.*/
  4179. } __packed;
  4180. #define AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS 0x000100EA
  4181. /* Memory map regions command payload used by the
  4182. * #AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS .
  4183. * This structure allows clients to map multiple shared memory
  4184. * regions in a single command. Following this structure are
  4185. * num_regions of afe_service_shared_map_region_payload.
  4186. */
  4187. struct afe_service_cmd_shared_mem_map_regions {
  4188. struct apr_hdr hdr;
  4189. u16 mem_pool_id;
  4190. /* Type of memory on which this memory region is mapped.
  4191. * Supported values:
  4192. * - #ADSP_MEMORY_MAP_EBI_POOL
  4193. * - #ADSP_MEMORY_MAP_SMI_POOL
  4194. * - #ADSP_MEMORY_MAP_SHMEM8_4K_POOL
  4195. * - Other values are reserved
  4196. *
  4197. * The memory pool ID implicitly defines the characteristics of the
  4198. * memory. Characteristics may include alignment type, permissions,
  4199. * etc.
  4200. *
  4201. * ADSP_MEMORY_MAP_EBI_POOL is External Buffer Interface type memory
  4202. * ADSP_MEMORY_MAP_SMI_POOL is Shared Memory Interface type memory
  4203. * ADSP_MEMORY_MAP_SHMEM8_4K_POOL is shared memory, byte
  4204. * addressable, and 4 KB aligned.
  4205. */
  4206. u16 num_regions;
  4207. /* Number of regions to map.
  4208. * Supported values:
  4209. * - Any value greater than zero
  4210. */
  4211. u32 property_flag;
  4212. /* Configures one common property for all the regions in the
  4213. * payload.
  4214. *
  4215. * Supported values: - 0x00000000 to 0x00000001
  4216. *
  4217. * b0 - bit 0 indicates physical or virtual mapping 0 Shared memory
  4218. * address provided in afe_service_shared_map_region_payloadis a
  4219. * physical address. The shared memory needs to be mapped( hardware
  4220. * TLB entry) and a software entry needs to be added for internal
  4221. * book keeping.
  4222. *
  4223. * 1 Shared memory address provided in
  4224. * afe_service_shared_map_region_payloadis a virtual address. The
  4225. * shared memory must not be mapped (since hardware TLB entry is
  4226. * already available) but a software entry needs to be added for
  4227. * internal book keeping. This can be useful if two services with in
  4228. * ADSP is communicating via APR. They can now directly communicate
  4229. * via the Virtual address instead of Physical address. The virtual
  4230. * regions must be contiguous. num_regions must be 1 in this case.
  4231. *
  4232. * b31-b1 - reserved bits. must be set to zero
  4233. */
  4234. } __packed;
  4235. /* Map region payload used by the
  4236. * afe_service_shared_map_region_payloadstructure.
  4237. */
  4238. struct afe_service_shared_map_region_payload {
  4239. u32 shm_addr_lsw;
  4240. /* least significant word of starting address in the memory
  4241. * region to map. It must be contiguous memory, and it must be 4 KB
  4242. * aligned.
  4243. * Supported values: - Any 32 bit value
  4244. */
  4245. u32 shm_addr_msw;
  4246. /* most significant word of startng address in the memory region
  4247. * to map. For 32 bit shared memory address, this field must be set
  4248. * to zero. For 36 bit shared memory address, bit31 to bit 4 must be
  4249. * set to zero
  4250. *
  4251. * Supported values: - For 32 bit shared memory address, this field
  4252. * must be set to zero. - For 36 bit shared memory address, bit31 to
  4253. * bit 4 must be set to zero - For 64 bit shared memory address, any
  4254. * 32 bit value
  4255. */
  4256. u32 mem_size_bytes;
  4257. /* Number of bytes in the region. The aDSP will always map the
  4258. * regions as virtual contiguous memory, but the memory size must be
  4259. * in multiples of 4 KB to avoid gaps in the virtually contiguous
  4260. * mapped memory.
  4261. *
  4262. * Supported values: - multiples of 4KB
  4263. */
  4264. } __packed;
  4265. #define AFE_SERVICE_CMDRSP_SHARED_MEM_MAP_REGIONS 0x000100EB
  4266. struct afe_service_cmdrsp_shared_mem_map_regions {
  4267. u32 mem_map_handle;
  4268. /* A memory map handle encapsulating shared memory attributes is
  4269. * returned iff AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS command is
  4270. * successful. In the case of failure , a generic APR error response
  4271. * is returned to the client.
  4272. *
  4273. * Supported Values: - Any 32 bit value
  4274. */
  4275. } __packed;
  4276. #define AFE_SERVICE_CMD_SHARED_MEM_UNMAP_REGIONS 0x000100EC
  4277. /* Memory unmap regions command payload used by the
  4278. * #AFE_SERVICE_CMD_SHARED_MEM_UNMAP_REGIONS
  4279. *
  4280. * This structure allows clients to unmap multiple shared memory
  4281. * regions in a single command.
  4282. */
  4283. struct afe_service_cmd_shared_mem_unmap_regions {
  4284. struct apr_hdr hdr;
  4285. u32 mem_map_handle;
  4286. /* memory map handle returned by
  4287. * AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS commands
  4288. *
  4289. * Supported Values:
  4290. * - Any 32 bit value
  4291. */
  4292. } __packed;
  4293. /* Used by RTAC */
  4294. struct afe_rtac_get_param_v2 {
  4295. u16 port_id;
  4296. /* Port interface and direction (Rx or Tx) to start. */
  4297. u16 payload_size;
  4298. /* Maximum data size of the parameter ID/module ID combination.
  4299. * This is a multiple of four bytes
  4300. * Supported values: > 0
  4301. */
  4302. u32 payload_address_lsw;
  4303. /* LSW of 64 bit Payload address. Address should be 32-byte,
  4304. * 4kbyte aligned and must be contig memory.
  4305. */
  4306. u32 payload_address_msw;
  4307. /* MSW of 64 bit Payload address. In case of 32-bit shared
  4308. * memory address, this field must be set to zero. In case of 36-bit
  4309. * shared memory address, bit-4 to bit-31 must be set to zero.
  4310. * Address should be 32-byte, 4kbyte aligned and must be contiguous
  4311. * memory.
  4312. */
  4313. u32 mem_map_handle;
  4314. /* Memory map handle returned by
  4315. * AFE_SERVICE_CMD_SHARED_MEM_MAP_REGIONS commands.
  4316. * Supported Values: - NULL -- Message. The parameter data is
  4317. * in-band. - Non-NULL -- The parameter data is Out-band.Pointer to
  4318. * - the physical address in shared memory of the payload data.
  4319. * For detailed payload content, see the afe_port_param_data_v2
  4320. * structure
  4321. */
  4322. u32 module_id;
  4323. /* ID of the module to be queried.
  4324. * Supported values: Valid module ID
  4325. */
  4326. u32 param_id;
  4327. /* ID of the parameter to be queried.
  4328. * Supported values: Valid parameter ID
  4329. */
  4330. } __packed;
  4331. #define AFE_PORT_CMD_GET_PARAM_V2 0x000100F0
  4332. /* Payload of the #AFE_PORT_CMD_GET_PARAM_V2 command,
  4333. * which queries for one post/preprocessing parameter of a
  4334. * stream.
  4335. */
  4336. struct afe_port_cmd_get_param_v2 {
  4337. struct apr_hdr apr_hdr;
  4338. /* Port interface and direction (Rx or Tx) to start. */
  4339. u16 port_id;
  4340. /* Maximum data size of the parameter ID/module ID combination.
  4341. * This is a multiple of four bytes
  4342. * Supported values: > 0
  4343. */
  4344. u16 payload_size;
  4345. /* The memory mapping header to be used when requesting outband */
  4346. struct mem_mapping_hdr mem_hdr;
  4347. /* The module ID of the parameter data requested */
  4348. u32 module_id;
  4349. /* The parameter ID of the parameter data requested */
  4350. u32 param_id;
  4351. /* The header information for the parameter data */
  4352. struct param_hdr_v1 param_hdr;
  4353. } __packed;
  4354. #define AFE_PORT_CMDRSP_GET_PARAM_V2 0x00010106
  4355. /* Payload of the #AFE_PORT_CMDRSP_GET_PARAM_V2 message, which
  4356. * responds to an #AFE_PORT_CMD_GET_PARAM_V2 command.
  4357. *
  4358. * Immediately following this structure is the parameters structure
  4359. * (afe_port_param_data) containing the response(acknowledgment)
  4360. * parameter payload. This payload is included for an in-band
  4361. * scenario. For an address/shared memory-based set parameter, this
  4362. * payload is not needed.
  4363. */
  4364. struct afe_port_cmdrsp_get_param_v2 {
  4365. u32 status;
  4366. struct param_hdr_v1 param_hdr;
  4367. u8 param_data[0];
  4368. } __packed;
  4369. #define AFE_PORT_CMD_GET_PARAM_V3 0x000100FB
  4370. struct afe_port_cmd_get_param_v3 {
  4371. /* APR Header */
  4372. struct apr_hdr apr_hdr;
  4373. /* Port ID of the AFE port to configure. Port interface and direction
  4374. * (Rx or Tx) to configure. An even number represents the Rx direction,
  4375. * and an odd number represents the Tx direction.
  4376. */
  4377. u16 port_id;
  4378. /* Reserved. This field must be set to zero. */
  4379. u16 reserved;
  4380. /* The memory mapping header to be used when requesting outband */
  4381. struct mem_mapping_hdr mem_hdr;
  4382. /* The header information for the parameter data */
  4383. struct param_hdr_v3 param_hdr;
  4384. } __packed;
  4385. #define AFE_PORT_CMDRSP_GET_PARAM_V3 0x00010108
  4386. struct afe_port_cmdrsp_get_param_v3 {
  4387. /* The status of the command */
  4388. uint32_t status;
  4389. /* The header information for the parameter data */
  4390. struct param_hdr_v3 param_hdr;
  4391. /* The parameter data to be filled when sent inband */
  4392. u8 param_data[0];
  4393. } __packed;
  4394. #define AFE_PARAM_ID_LPASS_CORE_SHARED_CLOCK_CONFIG 0x0001028C
  4395. #define AFE_API_VERSION_LPASS_CORE_SHARED_CLK_CONFIG 0x1
  4396. /* Payload of the AFE_PARAM_ID_LPASS_CORE_SHARED_CLOCK_CONFIG parameter used by
  4397. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  4398. */
  4399. struct afe_param_id_lpass_core_shared_clk_cfg {
  4400. u32 lpass_core_shared_clk_cfg_minor_version;
  4401. /*
  4402. * Minor version used for lpass core shared clock configuration
  4403. * Supported value: AFE_API_VERSION_LPASS_CORE_SHARED_CLK_CONFIG
  4404. */
  4405. u32 enable;
  4406. /*
  4407. * Specifies whether the lpass core shared clock is
  4408. * enabled (1) or disabled (0).
  4409. */
  4410. } __packed;
  4411. /* adsp_afe_service_commands.h */
  4412. #define ADSP_MEMORY_MAP_EBI_POOL 0
  4413. #define ADSP_MEMORY_MAP_SMI_POOL 1
  4414. #define ADSP_MEMORY_MAP_IMEM_POOL 2
  4415. #define ADSP_MEMORY_MAP_SHMEM8_4K_POOL 3
  4416. #define ADSP_MEMORY_MAP_MDF_SHMEM_4K_POOL 4
  4417. /* Definition of virtual memory flag */
  4418. #define ADSP_MEMORY_MAP_VIRTUAL_MEMORY 1
  4419. /* Definition of physical memory flag */
  4420. #define ADSP_MEMORY_MAP_PHYSICAL_MEMORY 0
  4421. #define NULL_POPP_TOPOLOGY 0x00010C68
  4422. #define NULL_COPP_TOPOLOGY 0x00010312
  4423. #define DEFAULT_COPP_TOPOLOGY 0x00010314
  4424. #define DEFAULT_POPP_TOPOLOGY 0x00010BE4
  4425. #define COMPRESSED_PASSTHROUGH_DEFAULT_TOPOLOGY 0x0001076B
  4426. #define COMPRESSED_PASSTHROUGH_NONE_TOPOLOGY 0x00010774
  4427. #define VPM_TX_SM_ECNS_V2_COPP_TOPOLOGY 0x00010F89
  4428. #define VPM_TX_VOICE_SMECNS_V2_COPP_TOPOLOGY 0x10000003
  4429. #define VPM_TX_DM_FLUENCE_COPP_TOPOLOGY 0x00010F72
  4430. #define VPM_TX_QMIC_FLUENCE_COPP_TOPOLOGY 0x00010F75
  4431. #define VPM_TX_DM_RFECNS_COPP_TOPOLOGY 0x00010F86
  4432. #define ADM_CMD_COPP_OPEN_TOPOLOGY_ID_DTS_HPX 0x10015002
  4433. #define ADM_CMD_COPP_OPEN_TOPOLOGY_ID_AUDIOSPHERE 0x10028000
  4434. #define VPM_TX_DM_FLUENCE_EF_COPP_TOPOLOGY 0x10000005
  4435. /* Memory map regions command payload used by the
  4436. * #ASM_CMD_SHARED_MEM_MAP_REGIONS ,#ADM_CMD_SHARED_MEM_MAP_REGIONS
  4437. * commands.
  4438. *
  4439. * This structure allows clients to map multiple shared memory
  4440. * regions in a single command. Following this structure are
  4441. * num_regions of avs_shared_map_region_payload.
  4442. */
  4443. struct avs_cmd_shared_mem_map_regions {
  4444. struct apr_hdr hdr;
  4445. u16 mem_pool_id;
  4446. /* Type of memory on which this memory region is mapped.
  4447. *
  4448. * Supported values: - #ADSP_MEMORY_MAP_EBI_POOL -
  4449. * #ADSP_MEMORY_MAP_SMI_POOL - #ADSP_MEMORY_MAP_IMEM_POOL
  4450. * (unsupported) - #ADSP_MEMORY_MAP_SHMEM8_4K_POOL - Other values
  4451. * are reserved
  4452. *
  4453. * The memory ID implicitly defines the characteristics of the
  4454. * memory. Characteristics may include alignment type, permissions,
  4455. * etc.
  4456. *
  4457. * SHMEM8_4K is shared memory, byte addressable, and 4 KB aligned.
  4458. */
  4459. u16 num_regions;
  4460. /* Number of regions to map.*/
  4461. u32 property_flag;
  4462. /* Configures one common property for all the regions in the
  4463. * payload. No two regions in the same memory map regions cmd can
  4464. * have differnt property. Supported values: - 0x00000000 to
  4465. * 0x00000001
  4466. *
  4467. * b0 - bit 0 indicates physical or virtual mapping 0 shared memory
  4468. * address provided in avs_shared_map_regions_payload is physical
  4469. * address. The shared memory needs to be mapped( hardware TLB
  4470. * entry)
  4471. *
  4472. * and a software entry needs to be added for internal book keeping.
  4473. *
  4474. * 1 Shared memory address provided in MayPayload[usRegions] is
  4475. * virtual address. The shared memory must not be mapped (since
  4476. * hardware TLB entry is already available) but a software entry
  4477. * needs to be added for internal book keeping. This can be useful
  4478. * if two services with in ADSP is communicating via APR. They can
  4479. * now directly communicate via the Virtual address instead of
  4480. * Physical address. The virtual regions must be contiguous.
  4481. *
  4482. * b31-b1 - reserved bits. must be set to zero
  4483. */
  4484. } __packed;
  4485. struct avs_shared_map_region_payload {
  4486. u32 shm_addr_lsw;
  4487. /* least significant word of shared memory address of the memory
  4488. * region to map. It must be contiguous memory, and it must be 4 KB
  4489. * aligned.
  4490. */
  4491. u32 shm_addr_msw;
  4492. /* most significant word of shared memory address of the memory
  4493. * region to map. For 32 bit shared memory address, this field must
  4494. * tbe set to zero. For 36 bit shared memory address, bit31 to bit 4
  4495. * must be set to zero
  4496. */
  4497. u32 mem_size_bytes;
  4498. /* Number of bytes in the region.
  4499. *
  4500. * The aDSP will always map the regions as virtual contiguous
  4501. * memory, but the memory size must be in multiples of 4 KB to avoid
  4502. * gaps in the virtually contiguous mapped memory.
  4503. */
  4504. } __packed;
  4505. struct avs_cmd_shared_mem_unmap_regions {
  4506. struct apr_hdr hdr;
  4507. u32 mem_map_handle;
  4508. /* memory map handle returned by ASM_CMD_SHARED_MEM_MAP_REGIONS
  4509. * , ADM_CMD_SHARED_MEM_MAP_REGIONS, commands
  4510. */
  4511. } __packed;
  4512. /* Memory map command response payload used by the
  4513. * #ASM_CMDRSP_SHARED_MEM_MAP_REGIONS
  4514. * ,#ADM_CMDRSP_SHARED_MEM_MAP_REGIONS
  4515. */
  4516. struct avs_cmdrsp_shared_mem_map_regions {
  4517. u32 mem_map_handle;
  4518. /* A memory map handle encapsulating shared memory attributes is
  4519. * returned
  4520. */
  4521. } __packed;
  4522. #define AVS_MDF_MDSP_PROC_ID 0x2
  4523. #define AVS_MDF_SSC_PROC_ID 0x3
  4524. #define AVS_MDF_CDSP_PROC_ID 0x4
  4525. /* Shared memory map command payload used by the
  4526. * #AVCS_CMD_MAP_MDF_SHARED_MEMORY.
  4527. *
  4528. * This structure allows clients to map multiple shared memory
  4529. * regions with remote processor ID. All mapped regions must be
  4530. * from the same memory pool. Following this structure are
  4531. * num_regions of avs_shared_map_region_payload.
  4532. */
  4533. struct avs_cmd_map_mdf_shared_memory {
  4534. struct apr_hdr hdr;
  4535. uint32_t mem_map_handle;
  4536. /* Unique identifier for the shared memory address.
  4537. *
  4538. * The aDSP returns this handle for
  4539. * #AVCS_CMD_SHARED_MEM_MAP_REGIONS
  4540. *
  4541. * Supported values:
  4542. * Any 32-bit value
  4543. *
  4544. * The aDSP uses this handle to retrieve the shared memory
  4545. * attributes. This handle can be an abstract representation
  4546. * of the shared memory regions that are being mapped.
  4547. */
  4548. uint32_t proc_id;
  4549. /* Supported values:
  4550. * #AVS_MDF_MDSP_PROC_ID
  4551. * #AVS_MDF_SSC_PROC_ID
  4552. * #AVS_MDF_CDSP_PROC_ID
  4553. */
  4554. uint32_t num_regions;
  4555. /* Number of regions to be mapped with the remote DSP processor
  4556. * mentioned by proc_id field.
  4557. *
  4558. * Array of structures of avs_shared_map_region_payload will follow.
  4559. * The address fields in those arrays should correspond to the remote
  4560. * processor mentioned by proc_id.
  4561. * In case of DSPs with SMMU enabled, the address should be IOVA.
  4562. * And for DSPs without SMMU, the address should be physical address.
  4563. */
  4564. } __packed;
  4565. /*adsp_audio_memmap_api.h*/
  4566. /* ASM related data structures */
  4567. struct asm_wma_cfg {
  4568. u16 format_tag;
  4569. u16 ch_cfg;
  4570. u32 sample_rate;
  4571. u32 avg_bytes_per_sec;
  4572. u16 block_align;
  4573. u16 valid_bits_per_sample;
  4574. u32 ch_mask;
  4575. u16 encode_opt;
  4576. u16 adv_encode_opt;
  4577. u32 adv_encode_opt2;
  4578. u32 drc_peak_ref;
  4579. u32 drc_peak_target;
  4580. u32 drc_ave_ref;
  4581. u32 drc_ave_target;
  4582. } __packed;
  4583. struct asm_wmapro_cfg {
  4584. u16 format_tag;
  4585. u16 ch_cfg;
  4586. u32 sample_rate;
  4587. u32 avg_bytes_per_sec;
  4588. u16 block_align;
  4589. u16 valid_bits_per_sample;
  4590. u32 ch_mask;
  4591. u16 encode_opt;
  4592. u16 adv_encode_opt;
  4593. u32 adv_encode_opt2;
  4594. u32 drc_peak_ref;
  4595. u32 drc_peak_target;
  4596. u32 drc_ave_ref;
  4597. u32 drc_ave_target;
  4598. } __packed;
  4599. struct asm_aac_cfg {
  4600. u16 format;
  4601. u16 aot;
  4602. u16 ep_config;
  4603. u16 section_data_resilience;
  4604. u16 scalefactor_data_resilience;
  4605. u16 spectral_data_resilience;
  4606. u16 ch_cfg;
  4607. u16 reserved;
  4608. u32 sample_rate;
  4609. } __packed;
  4610. struct asm_amrwbplus_cfg {
  4611. u32 size_bytes;
  4612. u32 version;
  4613. u32 num_channels;
  4614. u32 amr_band_mode;
  4615. u32 amr_dtx_mode;
  4616. u32 amr_frame_fmt;
  4617. u32 amr_lsf_idx;
  4618. } __packed;
  4619. struct asm_flac_cfg {
  4620. u32 sample_rate;
  4621. u32 ext_sample_rate;
  4622. u32 min_frame_size;
  4623. u32 max_frame_size;
  4624. u16 stream_info_present;
  4625. u16 min_blk_size;
  4626. u16 max_blk_size;
  4627. u16 ch_cfg;
  4628. u16 sample_size;
  4629. u16 md5_sum;
  4630. };
  4631. struct asm_alac_cfg {
  4632. u32 frame_length;
  4633. u8 compatible_version;
  4634. u8 bit_depth;
  4635. u8 pb;
  4636. u8 mb;
  4637. u8 kb;
  4638. u8 num_channels;
  4639. u16 max_run;
  4640. u32 max_frame_bytes;
  4641. u32 avg_bit_rate;
  4642. u32 sample_rate;
  4643. u32 channel_layout_tag;
  4644. };
  4645. struct asm_g711_dec_cfg {
  4646. u32 sample_rate;
  4647. };
  4648. struct asm_vorbis_cfg {
  4649. u32 bit_stream_fmt;
  4650. };
  4651. struct asm_ape_cfg {
  4652. u16 compatible_version;
  4653. u16 compression_level;
  4654. u32 format_flags;
  4655. u32 blocks_per_frame;
  4656. u32 final_frame_blocks;
  4657. u32 total_frames;
  4658. u16 bits_per_sample;
  4659. u16 num_channels;
  4660. u32 sample_rate;
  4661. u32 seek_table_present;
  4662. };
  4663. struct asm_dsd_cfg {
  4664. u16 num_version;
  4665. u16 is_bitwise_big_endian;
  4666. u16 dsd_channel_block_size;
  4667. u16 num_channels;
  4668. u8 channel_mapping[8];
  4669. u32 dsd_data_rate;
  4670. };
  4671. struct asm_softpause_params {
  4672. u32 enable;
  4673. u32 period;
  4674. u32 step;
  4675. u32 rampingcurve;
  4676. } __packed;
  4677. struct asm_softvolume_params {
  4678. u32 period;
  4679. u32 step;
  4680. u32 rampingcurve;
  4681. } __packed;
  4682. #define ASM_END_POINT_DEVICE_MATRIX 0
  4683. #define PCM_CHANNEL_NULL 0
  4684. /* Front left channel. */
  4685. #define PCM_CHANNEL_FL 1
  4686. /* Front right channel. */
  4687. #define PCM_CHANNEL_FR 2
  4688. /* Front center channel. */
  4689. #define PCM_CHANNEL_FC 3
  4690. /* Left surround channel.*/
  4691. #define PCM_CHANNEL_LS 4
  4692. /* Right surround channel.*/
  4693. #define PCM_CHANNEL_RS 5
  4694. /* Low frequency effect channel. */
  4695. #define PCM_CHANNEL_LFE 6
  4696. /* Center surround channel; Rear center channel. */
  4697. #define PCM_CHANNEL_CS 7
  4698. /* Left back channel; Rear left channel. */
  4699. #define PCM_CHANNEL_LB 8
  4700. /* Right back channel; Rear right channel. */
  4701. #define PCM_CHANNEL_RB 9
  4702. /* Top surround channel. */
  4703. #define PCM_CHANNEL_TS 10
  4704. /* Center vertical height channel.*/
  4705. #define PCM_CHANNEL_CVH 11
  4706. /* Mono surround channel.*/
  4707. #define PCM_CHANNEL_MS 12
  4708. /* Front left of center. */
  4709. #define PCM_CHANNEL_FLC 13
  4710. /* Front right of center. */
  4711. #define PCM_CHANNEL_FRC 14
  4712. /* Rear left of center. */
  4713. #define PCM_CHANNEL_RLC 15
  4714. /* Rear right of center. */
  4715. #define PCM_CHANNEL_RRC 16
  4716. /* Second low frequency channel. */
  4717. #define PCM_CHANNEL_LFE2 17
  4718. /* Side left channel. */
  4719. #define PCM_CHANNEL_SL 18
  4720. /* Side right channel. */
  4721. #define PCM_CHANNEL_SR 19
  4722. /* Top front left channel. */
  4723. #define PCM_CHANNEL_TFL 20
  4724. /* Left vertical height channel. */
  4725. #define PCM_CHANNEL_LVH 20
  4726. /* Top front right channel. */
  4727. #define PCM_CHANNEL_TFR 21
  4728. /* Right vertical height channel. */
  4729. #define PCM_CHANNEL_RVH 21
  4730. /* Top center channel. */
  4731. #define PCM_CHANNEL_TC 22
  4732. /* Top back left channel. */
  4733. #define PCM_CHANNEL_TBL 23
  4734. /* Top back right channel. */
  4735. #define PCM_CHANNEL_TBR 24
  4736. /* Top side left channel. */
  4737. #define PCM_CHANNEL_TSL 25
  4738. /* Top side right channel. */
  4739. #define PCM_CHANNEL_TSR 26
  4740. /* Top back center channel. */
  4741. #define PCM_CHANNEL_TBC 27
  4742. /* Bottom front center channel. */
  4743. #define PCM_CHANNEL_BFC 28
  4744. /* Bottom front left channel. */
  4745. #define PCM_CHANNEL_BFL 29
  4746. /* Bottom front right channel. */
  4747. #define PCM_CHANNEL_BFR 30
  4748. /* Left wide channel. */
  4749. #define PCM_CHANNEL_LW 31
  4750. /* Right wide channel. */
  4751. #define PCM_CHANNEL_RW 32
  4752. /* Left side direct channel. */
  4753. #define PCM_CHANNEL_LSD 33
  4754. /* Right side direct channel. Update PCM_MAX_CHMAP_ID when
  4755. * this list is extended.
  4756. */
  4757. #define PCM_CHANNEL_RSD 34
  4758. /* Mark unused channel. */
  4759. #define PCM_CHANNEL_UNUSED 47
  4760. /* Max valid channel map index */
  4761. #define PCM_MAX_CHMAP_ID PCM_CHANNEL_RSD
  4762. #define PCM_FORMAT_MAX_NUM_CHANNEL 8
  4763. #define PCM_FORMAT_MAX_CHANNELS_9 9
  4764. /* Used for ADM_CMD_DEVICE_OPEN_V8 */
  4765. #define PCM_FORMAT_MAX_NUM_CHANNEL_V8 32
  4766. #define ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2 0x00010DA5
  4767. #define ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V3 0x00010DDC
  4768. #define ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V4 0x0001320C
  4769. #define ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V5 0x00013222
  4770. #define ASM_MEDIA_FMT_EVRCB_FS 0x00010BEF
  4771. #define ASM_MEDIA_FMT_EVRCWB_FS 0x00010BF0
  4772. #define ASM_MEDIA_FMT_GENERIC_COMPRESSED 0x00013212
  4773. #define ASM_MAX_EQ_BANDS 12
  4774. #define ASM_DATA_CMD_MEDIA_FMT_UPDATE_V2 0x00010D98
  4775. struct asm_data_cmd_media_fmt_update_v2 {
  4776. u32 fmt_blk_size;
  4777. /* Media format block size in bytes.*/
  4778. } __packed;
  4779. struct asm_generic_compressed_fmt_blk_t {
  4780. struct apr_hdr hdr;
  4781. struct asm_data_cmd_media_fmt_update_v2 fmt_blk;
  4782. /*
  4783. * Channel mapping array of bitstream output.
  4784. * Channel[i] mapping describes channel i inside the buffer, where
  4785. * i < num_channels. All valid used channels must be
  4786. * present at the beginning of the array.
  4787. */
  4788. uint8_t channel_mapping[8];
  4789. /*
  4790. * Number of channels of the incoming bitstream.
  4791. * Supported values: 1,2,3,4,5,6,7,8
  4792. */
  4793. uint16_t num_channels;
  4794. /*
  4795. * Nominal bits per sample value of the incoming bitstream.
  4796. * Supported values: 16, 32
  4797. */
  4798. uint16_t bits_per_sample;
  4799. /*
  4800. * Nominal sampling rate of the incoming bitstream.
  4801. * Supported values: 8000, 11025, 16000, 22050, 24000, 32000,
  4802. * 44100, 48000, 88200, 96000, 176400, 192000,
  4803. * 352800, 384000
  4804. */
  4805. uint32_t sampling_rate;
  4806. } __packed;
  4807. /* Command to send sample rate & channels for IEC61937 (compressed) or IEC60958
  4808. * (pcm) streams. Both audio standards use the same format and are used for
  4809. * HDMI or SPDIF output.
  4810. */
  4811. #define ASM_DATA_CMD_IEC_60958_MEDIA_FMT 0x0001321E
  4812. struct asm_iec_compressed_fmt_blk_t {
  4813. struct apr_hdr hdr;
  4814. /*
  4815. * Nominal sampling rate of the incoming bitstream.
  4816. * Supported values: 8000, 11025, 16000, 22050, 24000, 32000,
  4817. * 44100, 48000, 88200, 96000, 176400, 192000,
  4818. * 352800, 384000
  4819. */
  4820. uint32_t sampling_rate;
  4821. /*
  4822. * Number of channels of the incoming bitstream.
  4823. * Supported values: 1,2,3,4,5,6,7,8
  4824. */
  4825. uint32_t num_channels;
  4826. } __packed;
  4827. struct asm_multi_channel_pcm_fmt_blk_v2 {
  4828. struct apr_hdr hdr;
  4829. struct asm_data_cmd_media_fmt_update_v2 fmt_blk;
  4830. u16 num_channels;
  4831. /* Number of channels. Supported values: 1 to 8 */
  4832. u16 bits_per_sample;
  4833. /* Number of bits per sample per channel. * Supported values:
  4834. * 16, 24 * When used for playback, the client must send 24-bit
  4835. * samples packed in 32-bit words. The 24-bit samples must be placed
  4836. * in the most significant 24 bits of the 32-bit word. When used for
  4837. * recording, the aDSP sends 24-bit samples packed in 32-bit words.
  4838. * The 24-bit samples are placed in the most significant 24 bits of
  4839. * the 32-bit word.
  4840. */
  4841. u32 sample_rate;
  4842. /* Number of samples per second (in Hertz).
  4843. * Supported values: 2000 to 48000
  4844. */
  4845. u16 is_signed;
  4846. /* Flag that indicates the samples are signed (1). */
  4847. u16 reserved;
  4848. /* reserved field for 32 bit alignment. must be set to zero. */
  4849. u8 channel_mapping[8];
  4850. /* Channel array of size 8.
  4851. * Supported values:
  4852. * - #PCM_CHANNEL_L
  4853. * - #PCM_CHANNEL_R
  4854. * - #PCM_CHANNEL_C
  4855. * - #PCM_CHANNEL_LS
  4856. * - #PCM_CHANNEL_RS
  4857. * - #PCM_CHANNEL_LFE
  4858. * - #PCM_CHANNEL_CS
  4859. * - #PCM_CHANNEL_LB
  4860. * - #PCM_CHANNEL_RB
  4861. * - #PCM_CHANNEL_TS
  4862. * - #PCM_CHANNEL_CVH
  4863. * - #PCM_CHANNEL_MS
  4864. * - #PCM_CHANNEL_FLC
  4865. * - #PCM_CHANNEL_FRC
  4866. * - #PCM_CHANNEL_RLC
  4867. * - #PCM_CHANNEL_RRC
  4868. *
  4869. * Channel[i] mapping describes channel I. Each element i of the
  4870. * array describes channel I inside the buffer where 0 @le I <
  4871. * num_channels. An unused channel is set to zero.
  4872. */
  4873. } __packed;
  4874. struct asm_multi_channel_pcm_fmt_blk_v3 {
  4875. uint16_t num_channels;
  4876. /*
  4877. * Number of channels
  4878. * Supported values: 1 to 8
  4879. */
  4880. uint16_t bits_per_sample;
  4881. /*
  4882. * Number of bits per sample per channel
  4883. * Supported values: 16, 24
  4884. */
  4885. uint32_t sample_rate;
  4886. /*
  4887. * Number of samples per second
  4888. * Supported values: 2000 to 48000, 96000,192000 Hz
  4889. */
  4890. uint16_t is_signed;
  4891. /* Flag that indicates that PCM samples are signed (1) */
  4892. uint16_t sample_word_size;
  4893. /*
  4894. * Size in bits of the word that holds a sample of a channel.
  4895. * Supported values: 12,24,32
  4896. */
  4897. uint8_t channel_mapping[8];
  4898. /*
  4899. * Each element, i, in the array describes channel i inside the buffer where
  4900. * 0 <= i < num_channels. Unused channels are set to 0.
  4901. */
  4902. } __packed;
  4903. struct asm_multi_channel_pcm_fmt_blk_v4 {
  4904. uint16_t num_channels;
  4905. /*
  4906. * Number of channels
  4907. * Supported values: 1 to 8
  4908. */
  4909. uint16_t bits_per_sample;
  4910. /*
  4911. * Number of bits per sample per channel
  4912. * Supported values: 16, 24, 32
  4913. */
  4914. uint32_t sample_rate;
  4915. /*
  4916. * Number of samples per second
  4917. * Supported values: 2000 to 48000, 96000,192000 Hz
  4918. */
  4919. uint16_t is_signed;
  4920. /* Flag that indicates that PCM samples are signed (1) */
  4921. uint16_t sample_word_size;
  4922. /*
  4923. * Size in bits of the word that holds a sample of a channel.
  4924. * Supported values: 12,24,32
  4925. */
  4926. uint8_t channel_mapping[8];
  4927. /*
  4928. * Each element, i, in the array describes channel i inside the buffer where
  4929. * 0 <= i < num_channels. Unused channels are set to 0.
  4930. */
  4931. uint16_t endianness;
  4932. /*
  4933. * Flag to indicate the endianness of the pcm sample
  4934. * Supported values: 0 - Little endian (all other formats)
  4935. * 1 - Big endian (AIFF)
  4936. */
  4937. uint16_t mode;
  4938. /*
  4939. * Mode to provide additional info about the pcm input data.
  4940. * Supported values: 0 - Default QFs (Q15 for 16b, Q23 for packed 24b,
  4941. * Q31 for unpacked 24b or 32b)
  4942. * 15 - for 16 bit
  4943. * 23 - for 24b packed or 8.24 format
  4944. * 31 - for 24b unpacked or 32bit
  4945. */
  4946. } __packed;
  4947. struct asm_multi_channel_pcm_fmt_blk_v5 {
  4948. uint16_t num_channels;
  4949. /*
  4950. * Number of channels
  4951. * Supported values: 1 to 32
  4952. */
  4953. uint16_t bits_per_sample;
  4954. /*
  4955. * Number of bits per sample per channel
  4956. * Supported values: 16, 24, 32
  4957. */
  4958. uint32_t sample_rate;
  4959. /*
  4960. * Number of samples per second
  4961. * Supported values: 2000 to 48000, 96000,192000 Hz
  4962. */
  4963. uint16_t is_signed;
  4964. /* Flag that indicates that PCM samples are signed (1) */
  4965. uint16_t sample_word_size;
  4966. /*
  4967. * Size in bits of the word that holds a sample of a channel.
  4968. * Supported values: 12,24,32
  4969. */
  4970. uint16_t endianness;
  4971. /*
  4972. * Flag to indicate the endianness of the pcm sample
  4973. * Supported values: 0 - Little endian (all other formats)
  4974. * 1 - Big endian (AIFF)
  4975. */
  4976. uint16_t mode;
  4977. /*
  4978. * Mode to provide additional info about the pcm input data.
  4979. * Supported values: 0 - Default QFs (Q15 for 16b, Q23 for packed 24b,
  4980. * Q31 for unpacked 24b or 32b)
  4981. * 15 - for 16 bit
  4982. * 23 - for 24b packed or 8.24 format
  4983. * 31 - for 24b unpacked or 32bit
  4984. */
  4985. uint8_t channel_mapping[32];
  4986. /*
  4987. * Each element, i, in the array describes channel i inside the buffer where
  4988. * 0 <= i < num_channels. Unused channels are set to 0.
  4989. */
  4990. } __packed;
  4991. /*
  4992. * Payload of the multichannel PCM configuration parameters in
  4993. * the ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V3 media format.
  4994. */
  4995. struct asm_multi_channel_pcm_fmt_blk_param_v3 {
  4996. struct apr_hdr hdr;
  4997. struct asm_data_cmd_media_fmt_update_v2 fmt_blk;
  4998. struct asm_multi_channel_pcm_fmt_blk_v3 param;
  4999. } __packed;
  5000. /*
  5001. * Payload of the multichannel PCM configuration parameters in
  5002. * the ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V4 media format.
  5003. */
  5004. struct asm_multi_channel_pcm_fmt_blk_param_v4 {
  5005. struct apr_hdr hdr;
  5006. struct asm_data_cmd_media_fmt_update_v2 fmt_blk;
  5007. struct asm_multi_channel_pcm_fmt_blk_v4 param;
  5008. } __packed;
  5009. /*
  5010. * Payload of the multichannel PCM configuration parameters in
  5011. * the ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V5 media format.
  5012. */
  5013. struct asm_multi_channel_pcm_fmt_blk_param_v5 {
  5014. struct apr_hdr hdr;
  5015. struct asm_data_cmd_media_fmt_update_v2 fmt_blk;
  5016. struct asm_multi_channel_pcm_fmt_blk_v5 param;
  5017. } __packed;
  5018. struct asm_stream_cmd_set_encdec_param {
  5019. u32 param_id;
  5020. /* ID of the parameter. */
  5021. u32 param_size;
  5022. /* Data size of this parameter, in bytes. The size is a multiple
  5023. * of 4 bytes.
  5024. */
  5025. } __packed;
  5026. struct asm_enc_cfg_blk_param_v2 {
  5027. u32 frames_per_buf;
  5028. /* Number of encoded frames to pack into each buffer.
  5029. *
  5030. * @note1hang This is only guidance information for the aDSP. The
  5031. * number of encoded frames put into each buffer (specified by the
  5032. * client) is less than or equal to this number.
  5033. */
  5034. u32 enc_cfg_blk_size;
  5035. /* Size in bytes of the encoder configuration block that follows
  5036. * this member.
  5037. */
  5038. } __packed;
  5039. struct asm_custom_enc_cfg_t_v2 {
  5040. struct apr_hdr hdr;
  5041. struct asm_stream_cmd_set_encdec_param encdec;
  5042. struct asm_enc_cfg_blk_param_v2 encblk;
  5043. uint32_t sample_rate;
  5044. uint16_t num_channels;
  5045. uint16_t reserved;
  5046. /* num_ch == 1, then PCM_CHANNEL_C,
  5047. * num_ch == 2, then {PCM_CHANNEL_L, PCM_CHANNEL_R}
  5048. */
  5049. uint8_t channel_mapping[8];
  5050. uint32_t custom_size;
  5051. uint8_t custom_data[15];
  5052. } __packed;
  5053. /* @brief Dolby Digital Plus end point configuration structure
  5054. */
  5055. struct asm_dec_ddp_endp_param_v2 {
  5056. struct apr_hdr hdr;
  5057. struct asm_stream_cmd_set_encdec_param encdec;
  5058. int endp_param_value;
  5059. } __packed;
  5060. /*
  5061. * Payload of the multichannel PCM encoder configuration parameters in
  5062. * the ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V5 media format.
  5063. */
  5064. struct asm_multi_channel_pcm_enc_cfg_v5 {
  5065. struct apr_hdr hdr;
  5066. struct asm_stream_cmd_set_encdec_param encdec;
  5067. struct asm_enc_cfg_blk_param_v2 encblk;
  5068. uint16_t num_channels;
  5069. /*
  5070. * Number of PCM channels.
  5071. * @values
  5072. * - 0 -- Native mode
  5073. * - 1 -- 8 channels
  5074. * Native mode indicates that encoding must be performed with the number
  5075. * of channels at the input.
  5076. */
  5077. uint16_t bits_per_sample;
  5078. /*
  5079. * Number of bits per sample per channel.
  5080. * @values 16, 24
  5081. */
  5082. uint32_t sample_rate;
  5083. /*
  5084. * Number of samples per second.
  5085. * @values 0, 8000 to 48000 Hz
  5086. * A value of 0 indicates the native sampling rate. Encoding is
  5087. * performed at the input sampling rate.
  5088. */
  5089. uint16_t is_signed;
  5090. /*
  5091. * Flag that indicates the PCM samples are signed (1). Currently, only
  5092. * signed PCM samples are supported.
  5093. */
  5094. uint16_t sample_word_size;
  5095. /*
  5096. * The size in bits of the word that holds a sample of a channel.
  5097. * @values 16, 24, 32
  5098. * 16-bit samples are always placed in 16-bit words:
  5099. * sample_word_size = 1.
  5100. * 24-bit samples can be placed in 32-bit words or in consecutive
  5101. * 24-bit words.
  5102. * - If sample_word_size = 32, 24-bit samples are placed in the
  5103. * most significant 24 bits of a 32-bit word.
  5104. * - If sample_word_size = 24, 24-bit samples are placed in
  5105. * 24-bit words. @tablebulletend
  5106. */
  5107. uint16_t endianness;
  5108. /*
  5109. * Flag to indicate the endianness of the pcm sample
  5110. * Supported values: 0 - Little endian (all other formats)
  5111. * 1 - Big endian (AIFF)
  5112. */
  5113. uint16_t mode;
  5114. /*
  5115. * Mode to provide additional info about the pcm input data.
  5116. * Supported values: 0 - Default QFs (Q15 for 16b, Q23 for packed 24b,
  5117. * Q31 for unpacked 24b or 32b)
  5118. * 15 - for 16 bit
  5119. * 23 - for 24b packed or 8.24 format
  5120. */
  5121. uint8_t channel_mapping[PCM_FORMAT_MAX_NUM_CHANNEL_V8];
  5122. /*
  5123. * Channel mapping array expected at the encoder output.
  5124. * Channel[i] mapping describes channel i inside the buffer, where
  5125. * 0 @le i < num_channels. All valid used channels must be present at
  5126. * the beginning of the array.
  5127. * If Native mode is set for the channels, this field is ignored.
  5128. * @values See Section @xref{dox:PcmChannelDefs}
  5129. */
  5130. } __packed;
  5131. /*
  5132. * Payload of the multichannel PCM encoder configuration parameters in
  5133. * the ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V4 media format.
  5134. */
  5135. struct asm_multi_channel_pcm_enc_cfg_v4 {
  5136. struct apr_hdr hdr;
  5137. struct asm_stream_cmd_set_encdec_param encdec;
  5138. struct asm_enc_cfg_blk_param_v2 encblk;
  5139. uint16_t num_channels;
  5140. /*
  5141. * Number of PCM channels.
  5142. * @values
  5143. * - 0 -- Native mode
  5144. * - 1 -- 8 channels
  5145. * Native mode indicates that encoding must be performed with the number
  5146. * of channels at the input.
  5147. */
  5148. uint16_t bits_per_sample;
  5149. /*
  5150. * Number of bits per sample per channel.
  5151. * @values 16, 24
  5152. */
  5153. uint32_t sample_rate;
  5154. /*
  5155. * Number of samples per second.
  5156. * @values 0, 8000 to 48000 Hz
  5157. * A value of 0 indicates the native sampling rate. Encoding is
  5158. * performed at the input sampling rate.
  5159. */
  5160. uint16_t is_signed;
  5161. /*
  5162. * Flag that indicates the PCM samples are signed (1). Currently, only
  5163. * signed PCM samples are supported.
  5164. */
  5165. uint16_t sample_word_size;
  5166. /*
  5167. * The size in bits of the word that holds a sample of a channel.
  5168. * @values 16, 24, 32
  5169. * 16-bit samples are always placed in 16-bit words:
  5170. * sample_word_size = 1.
  5171. * 24-bit samples can be placed in 32-bit words or in consecutive
  5172. * 24-bit words.
  5173. * - If sample_word_size = 32, 24-bit samples are placed in the
  5174. * most significant 24 bits of a 32-bit word.
  5175. * - If sample_word_size = 24, 24-bit samples are placed in
  5176. * 24-bit words. @tablebulletend
  5177. */
  5178. uint8_t channel_mapping[8];
  5179. /*
  5180. * Channel mapping array expected at the encoder output.
  5181. * Channel[i] mapping describes channel i inside the buffer, where
  5182. * 0 @le i < num_channels. All valid used channels must be present at
  5183. * the beginning of the array.
  5184. * If Native mode is set for the channels, this field is ignored.
  5185. * @values See Section @xref{dox:PcmChannelDefs}
  5186. */
  5187. uint16_t endianness;
  5188. /*
  5189. * Flag to indicate the endianness of the pcm sample
  5190. * Supported values: 0 - Little endian (all other formats)
  5191. * 1 - Big endian (AIFF)
  5192. */
  5193. uint16_t mode;
  5194. /*
  5195. * Mode to provide additional info about the pcm input data.
  5196. * Supported values: 0 - Default QFs (Q15 for 16b, Q23 for packed 24b,
  5197. * Q31 for unpacked 24b or 32b)
  5198. * 15 - for 16 bit
  5199. * 23 - for 24b packed or 8.24 format
  5200. * 31 - for 24b unpacked or 32bit
  5201. */
  5202. } __packed;
  5203. /*
  5204. * Payload of the multichannel PCM encoder configuration parameters in
  5205. * the ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V3 media format.
  5206. */
  5207. struct asm_multi_channel_pcm_enc_cfg_v3 {
  5208. struct apr_hdr hdr;
  5209. struct asm_stream_cmd_set_encdec_param encdec;
  5210. struct asm_enc_cfg_blk_param_v2 encblk;
  5211. uint16_t num_channels;
  5212. /*
  5213. * Number of PCM channels.
  5214. * @values
  5215. * - 0 -- Native mode
  5216. * - 1 -- 8 channels
  5217. * Native mode indicates that encoding must be performed with the number
  5218. * of channels at the input.
  5219. */
  5220. uint16_t bits_per_sample;
  5221. /*
  5222. * Number of bits per sample per channel.
  5223. * @values 16, 24
  5224. */
  5225. uint32_t sample_rate;
  5226. /*
  5227. * Number of samples per second.
  5228. * @values 0, 8000 to 48000 Hz
  5229. * A value of 0 indicates the native sampling rate. Encoding is
  5230. * performed at the input sampling rate.
  5231. */
  5232. uint16_t is_signed;
  5233. /*
  5234. * Flag that indicates the PCM samples are signed (1). Currently, only
  5235. * signed PCM samples are supported.
  5236. */
  5237. uint16_t sample_word_size;
  5238. /*
  5239. * The size in bits of the word that holds a sample of a channel.
  5240. * @values 16, 24, 32
  5241. * 16-bit samples are always placed in 16-bit words:
  5242. * sample_word_size = 1.
  5243. * 24-bit samples can be placed in 32-bit words or in consecutive
  5244. * 24-bit words.
  5245. * - If sample_word_size = 32, 24-bit samples are placed in the
  5246. * most significant 24 bits of a 32-bit word.
  5247. * - If sample_word_size = 24, 24-bit samples are placed in
  5248. * 24-bit words. @tablebulletend
  5249. */
  5250. uint8_t channel_mapping[8];
  5251. /*
  5252. * Channel mapping array expected at the encoder output.
  5253. * Channel[i] mapping describes channel i inside the buffer, where
  5254. * 0 @le i < num_channels. All valid used channels must be present at
  5255. * the beginning of the array.
  5256. * If Native mode is set for the channels, this field is ignored.
  5257. * @values See Section @xref{dox:PcmChannelDefs}
  5258. */
  5259. };
  5260. /* @brief Multichannel PCM encoder configuration structure used
  5261. * in the #ASM_PARAM_ID_ENCDEC_ENC_CFG_BLK_V2 command.
  5262. */
  5263. struct asm_multi_channel_pcm_enc_cfg_v2 {
  5264. struct apr_hdr hdr;
  5265. struct asm_stream_cmd_set_encdec_param encdec;
  5266. struct asm_enc_cfg_blk_param_v2 encblk;
  5267. uint16_t num_channels;
  5268. /*< Number of PCM channels.
  5269. *
  5270. * Supported values: - 0 -- Native mode - 1 -- 8 Native mode
  5271. * indicates that encoding must be performed with the number of
  5272. * channels at the input.
  5273. */
  5274. uint16_t bits_per_sample;
  5275. /*< Number of bits per sample per channel.
  5276. * Supported values: 16, 24
  5277. */
  5278. uint32_t sample_rate;
  5279. /*< Number of samples per second (in Hertz).
  5280. *
  5281. * Supported values: 0, 8000 to 48000 A value of 0 indicates the
  5282. * native sampling rate. Encoding is performed at the input sampling
  5283. * rate.
  5284. */
  5285. uint16_t is_signed;
  5286. /*< Specifies whether the samples are signed (1). Currently,
  5287. * only signed samples are supported.
  5288. */
  5289. uint16_t reserved;
  5290. /*< reserved field for 32 bit alignment. must be set to zero.*/
  5291. uint8_t channel_mapping[8];
  5292. } __packed;
  5293. #define ASM_MEDIA_FMT_MP3 0x00010BE9
  5294. #define ASM_MEDIA_FMT_AAC_V2 0x00010DA6
  5295. /* @xreflabel
  5296. * {hdr:AsmMediaFmtDolbyAac} Media format ID for the
  5297. * Dolby AAC decoder. This format ID is be used if the client wants
  5298. * to use the Dolby AAC decoder to decode MPEG2 and MPEG4 AAC
  5299. * contents.
  5300. */
  5301. #define ASM_MEDIA_FMT_DOLBY_AAC 0x00010D86
  5302. /* Enumeration for the audio data transport stream AAC format. */
  5303. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADTS 0
  5304. /* Enumeration for low overhead audio stream AAC format. */
  5305. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_LOAS 1
  5306. /* Enumeration for the audio data interchange format
  5307. * AAC format.
  5308. */
  5309. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADIF 2
  5310. /* Enumeration for the raw AAC format. */
  5311. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_RAW 3
  5312. /* Enumeration for the AAC LATM format. */
  5313. #define ASM_MEDIA_FMT_AAC_FORMAT_FLAG_LATM 4
  5314. #define ASM_MEDIA_FMT_AAC_AOT_LC 2
  5315. #define ASM_MEDIA_FMT_AAC_AOT_SBR 5
  5316. #define ASM_MEDIA_FMT_AAC_AOT_PS 29
  5317. #define ASM_MEDIA_FMT_AAC_AOT_BSAC 22
  5318. struct asm_aac_fmt_blk_v2 {
  5319. struct apr_hdr hdr;
  5320. struct asm_data_cmd_media_fmt_update_v2 fmt_blk;
  5321. u16 aac_fmt_flag;
  5322. /* Bitstream format option.
  5323. * Supported values:
  5324. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADTS
  5325. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_LOAS
  5326. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADIF
  5327. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_RAW
  5328. */
  5329. u16 audio_objype;
  5330. /* Audio Object Type (AOT) present in the AAC stream.
  5331. * Supported values:
  5332. * - #ASM_MEDIA_FMT_AAC_AOT_LC
  5333. * - #ASM_MEDIA_FMT_AAC_AOT_SBR
  5334. * - #ASM_MEDIA_FMT_AAC_AOT_BSAC
  5335. * - #ASM_MEDIA_FMT_AAC_AOT_PS
  5336. * - Otherwise -- Not supported
  5337. */
  5338. u16 channel_config;
  5339. /* Number of channels present in the AAC stream.
  5340. * Supported values:
  5341. * - 1 -- Mono
  5342. * - 2 -- Stereo
  5343. * - 6 -- 5.1 content
  5344. */
  5345. u16 total_size_of_PCE_bits;
  5346. /* greater or equal to zero. * -In case of RAW formats and
  5347. * channel config = 0 (PCE), client can send * the bit stream
  5348. * containing PCE immediately following this structure * (in-band).
  5349. * -This number does not include bits included for 32 bit alignment.
  5350. * -If zero, then the PCE info is assumed to be available in the
  5351. * audio -bit stream & not in-band.
  5352. */
  5353. u32 sample_rate;
  5354. /* Number of samples per second (in Hertz).
  5355. *
  5356. * Supported values: 8000, 11025, 12000, 16000, 22050, 24000, 32000,
  5357. * 44100, 48000
  5358. *
  5359. * This field must be equal to the sample rate of the AAC-LC
  5360. * decoder's output. - For MP4 or 3GP containers, this is indicated
  5361. * by the samplingFrequencyIndex field in the AudioSpecificConfig
  5362. * element. - For ADTS format, this is indicated by the
  5363. * samplingFrequencyIndex in the ADTS fixed header. - For ADIF
  5364. * format, this is indicated by the samplingFrequencyIndex in the
  5365. * program_config_element present in the ADIF header.
  5366. */
  5367. } __packed;
  5368. struct asm_aac_enc_cfg_v2 {
  5369. struct apr_hdr hdr;
  5370. struct asm_stream_cmd_set_encdec_param encdec;
  5371. struct asm_enc_cfg_blk_param_v2 encblk;
  5372. u32 bit_rate;
  5373. /* Encoding rate in bits per second. */
  5374. u32 enc_mode;
  5375. /* Encoding mode.
  5376. * Supported values:
  5377. * - #ASM_MEDIA_FMT_AAC_AOT_LC
  5378. * - #ASM_MEDIA_FMT_AAC_AOT_SBR
  5379. * - #ASM_MEDIA_FMT_AAC_AOT_PS
  5380. */
  5381. u16 aac_fmt_flag;
  5382. /* AAC format flag.
  5383. * Supported values:
  5384. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_ADTS
  5385. * - #ASM_MEDIA_FMT_AAC_FORMAT_FLAG_RAW
  5386. */
  5387. u16 channel_cfg;
  5388. /* Number of channels to encode.
  5389. * Supported values:
  5390. * - 0 -- Native mode
  5391. * - 1 -- Mono
  5392. * - 2 -- Stereo
  5393. * - Other values are not supported.
  5394. * @note1hang The eAAC+ encoder mode supports only stereo.
  5395. * Native mode indicates that encoding must be performed with the
  5396. * number of channels at the input.
  5397. * The number of channels must not change during encoding.
  5398. */
  5399. u32 sample_rate;
  5400. /* Number of samples per second.
  5401. * Supported values: - 0 -- Native mode - For other values,
  5402. * Native mode indicates that encoding must be performed with the
  5403. * sampling rate at the input.
  5404. * The sampling rate must not change during encoding.
  5405. */
  5406. } __packed;
  5407. #define ASM_MEDIA_FMT_G711_ALAW_FS 0x00010BF7
  5408. #define ASM_MEDIA_FMT_G711_MLAW_FS 0x00010C2E
  5409. struct asm_g711_enc_cfg_v2 {
  5410. struct apr_hdr hdr;
  5411. struct asm_stream_cmd_set_encdec_param encdec;
  5412. struct asm_enc_cfg_blk_param_v2 encblk;
  5413. u32 sample_rate;
  5414. /*
  5415. * Number of samples per second.
  5416. * Supported values: 8000, 16000 Hz
  5417. */
  5418. } __packed;
  5419. struct asm_vorbis_fmt_blk_v2 {
  5420. struct apr_hdr hdr;
  5421. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5422. u32 bit_stream_fmt;
  5423. /* Bit stream format.
  5424. * Supported values:
  5425. * - 0 -- Raw bitstream
  5426. * - 1 -- Transcoded bitstream
  5427. *
  5428. * Transcoded bitstream containing the size of the frame as the first
  5429. * word in each frame.
  5430. */
  5431. } __packed;
  5432. struct asm_flac_fmt_blk_v2 {
  5433. struct apr_hdr hdr;
  5434. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5435. u16 is_stream_info_present;
  5436. /* Specifies whether stream information is present in the FLAC format
  5437. * block.
  5438. *
  5439. * Supported values:
  5440. * - 0 -- Stream information is not present in this message
  5441. * - 1 -- Stream information is present in this message
  5442. *
  5443. * When set to 1, the FLAC bitstream was successfully parsed by the
  5444. * client, and other fields in the FLAC format block can be read by the
  5445. * decoder to get metadata stream information.
  5446. */
  5447. u16 num_channels;
  5448. /* Number of channels for decoding.
  5449. * Supported values: 1 to 2
  5450. */
  5451. u16 min_blk_size;
  5452. /* Minimum block size (in samples) used in the stream. It must be less
  5453. * than or equal to max_blk_size.
  5454. */
  5455. u16 max_blk_size;
  5456. /* Maximum block size (in samples) used in the stream. If the
  5457. * minimum block size equals the maximum block size, a fixed block
  5458. * size stream is implied.
  5459. */
  5460. u16 md5_sum[8];
  5461. /* MD5 signature array of the unencoded audio data. This allows the
  5462. * decoder to determine if an error exists in the audio data, even when
  5463. * the error does not result in an invalid bitstream.
  5464. */
  5465. u32 sample_rate;
  5466. /* Number of samples per second.
  5467. * Supported values: 8000 to 48000 Hz
  5468. */
  5469. u32 min_frame_size;
  5470. /* Minimum frame size used in the stream.
  5471. * Supported values:
  5472. * - > 0 bytes
  5473. * - 0 -- The value is unknown
  5474. */
  5475. u32 max_frame_size;
  5476. /* Maximum frame size used in the stream.
  5477. * Supported values:
  5478. * -- > 0 bytes
  5479. * -- 0 . The value is unknown
  5480. */
  5481. u16 sample_size;
  5482. /* Bits per sample.Supported values: 8, 16 */
  5483. u16 reserved;
  5484. /* Clients must set this field to zero
  5485. */
  5486. } __packed;
  5487. struct asm_alac_fmt_blk_v2 {
  5488. struct apr_hdr hdr;
  5489. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5490. u32 frame_length;
  5491. u8 compatible_version;
  5492. u8 bit_depth;
  5493. u8 pb;
  5494. u8 mb;
  5495. u8 kb;
  5496. u8 num_channels;
  5497. u16 max_run;
  5498. u32 max_frame_bytes;
  5499. u32 avg_bit_rate;
  5500. u32 sample_rate;
  5501. u32 channel_layout_tag;
  5502. } __packed;
  5503. struct asm_g711_dec_fmt_blk_v2 {
  5504. struct apr_hdr hdr;
  5505. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5506. u32 sample_rate;
  5507. } __packed;
  5508. struct asm_ape_fmt_blk_v2 {
  5509. struct apr_hdr hdr;
  5510. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5511. u16 compatible_version;
  5512. u16 compression_level;
  5513. u32 format_flags;
  5514. u32 blocks_per_frame;
  5515. u32 final_frame_blocks;
  5516. u32 total_frames;
  5517. u16 bits_per_sample;
  5518. u16 num_channels;
  5519. u32 sample_rate;
  5520. u32 seek_table_present;
  5521. } __packed;
  5522. struct asm_dsd_fmt_blk_v2 {
  5523. struct apr_hdr hdr;
  5524. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5525. u16 num_version;
  5526. u16 is_bitwise_big_endian;
  5527. u16 dsd_channel_block_size;
  5528. u16 num_channels;
  5529. u8 channel_mapping[8];
  5530. u32 dsd_data_rate;
  5531. } __packed;
  5532. #define ASM_MEDIA_FMT_AMRNB_FS 0x00010BEB
  5533. /* Enumeration for 4.75 kbps AMR-NB Encoding mode. */
  5534. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MR475 0
  5535. /* Enumeration for 5.15 kbps AMR-NB Encoding mode. */
  5536. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MR515 1
  5537. /* Enumeration for 5.90 kbps AMR-NB Encoding mode. */
  5538. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MMR59 2
  5539. /* Enumeration for 6.70 kbps AMR-NB Encoding mode. */
  5540. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MMR67 3
  5541. /* Enumeration for 7.40 kbps AMR-NB Encoding mode. */
  5542. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MMR74 4
  5543. /* Enumeration for 7.95 kbps AMR-NB Encoding mode. */
  5544. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MMR795 5
  5545. /* Enumeration for 10.20 kbps AMR-NB Encoding mode. */
  5546. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MMR102 6
  5547. /* Enumeration for 12.20 kbps AMR-NB Encoding mode. */
  5548. #define ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_MMR122 7
  5549. /* Enumeration for AMR-NB Discontinuous Transmission mode off. */
  5550. #define ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_OFF 0
  5551. /* Enumeration for AMR-NB DTX mode VAD1. */
  5552. #define ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_VAD1 1
  5553. /* Enumeration for AMR-NB DTX mode VAD2. */
  5554. #define ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_VAD2 2
  5555. /* Enumeration for AMR-NB DTX mode auto. */
  5556. #define ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_AUTO 3
  5557. struct asm_amrnb_enc_cfg {
  5558. struct apr_hdr hdr;
  5559. struct asm_stream_cmd_set_encdec_param encdec;
  5560. struct asm_enc_cfg_blk_param_v2 encblk;
  5561. u16 enc_mode;
  5562. /* AMR-NB encoding rate.
  5563. * Supported values:
  5564. * Use the ASM_MEDIA_FMT_AMRNB_FS_ENCODE_MODE_*
  5565. * macros
  5566. */
  5567. u16 dtx_mode;
  5568. /* Specifies whether DTX mode is disabled or enabled.
  5569. * Supported values:
  5570. * - #ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_OFF
  5571. * - #ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_VAD1
  5572. */
  5573. } __packed;
  5574. #define ASM_MEDIA_FMT_AMRWB_FS 0x00010BEC
  5575. /* Enumeration for 6.6 kbps AMR-WB Encoding mode. */
  5576. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR66 0
  5577. /* Enumeration for 8.85 kbps AMR-WB Encoding mode. */
  5578. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR885 1
  5579. /* Enumeration for 12.65 kbps AMR-WB Encoding mode. */
  5580. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR1265 2
  5581. /* Enumeration for 14.25 kbps AMR-WB Encoding mode. */
  5582. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR1425 3
  5583. /* Enumeration for 15.85 kbps AMR-WB Encoding mode. */
  5584. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR1585 4
  5585. /* Enumeration for 18.25 kbps AMR-WB Encoding mode. */
  5586. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR1825 5
  5587. /* Enumeration for 19.85 kbps AMR-WB Encoding mode. */
  5588. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR1985 6
  5589. /* Enumeration for 23.05 kbps AMR-WB Encoding mode. */
  5590. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR2305 7
  5591. /* Enumeration for 23.85 kbps AMR-WB Encoding mode. */
  5592. #define ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_MR2385 8
  5593. struct asm_amrwb_enc_cfg {
  5594. struct apr_hdr hdr;
  5595. struct asm_stream_cmd_set_encdec_param encdec;
  5596. struct asm_enc_cfg_blk_param_v2 encblk;
  5597. u16 enc_mode;
  5598. /* AMR-WB encoding rate.
  5599. * Suupported values:
  5600. * Use the ASM_MEDIA_FMT_AMRWB_FS_ENCODE_MODE_*
  5601. * macros
  5602. */
  5603. u16 dtx_mode;
  5604. /* Specifies whether DTX mode is disabled or enabled.
  5605. * Supported values:
  5606. * - #ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_OFF
  5607. * - #ASM_MEDIA_FMT_AMRNB_FS_DTX_MODE_VAD1
  5608. */
  5609. } __packed;
  5610. #define ASM_MEDIA_FMT_V13K_FS 0x00010BED
  5611. /* Enumeration for 14.4 kbps V13K Encoding mode. */
  5612. #define ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR1440 0
  5613. /* Enumeration for 12.2 kbps V13K Encoding mode. */
  5614. #define ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR1220 1
  5615. /* Enumeration for 11.2 kbps V13K Encoding mode. */
  5616. #define ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR1120 2
  5617. /* Enumeration for 9.0 kbps V13K Encoding mode. */
  5618. #define ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR90 3
  5619. /* Enumeration for 7.2 kbps V13K eEncoding mode. */
  5620. #define ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR720 4
  5621. /* Enumeration for 1/8 vocoder rate.*/
  5622. #define ASM_MEDIA_FMT_VOC_ONE_EIGHTH_RATE 1
  5623. /* Enumeration for 1/4 vocoder rate. */
  5624. #define ASM_MEDIA_FMT_VOC_ONE_FOURTH_RATE 2
  5625. /* Enumeration for 1/2 vocoder rate. */
  5626. #define ASM_MEDIA_FMT_VOC_HALF_RATE 3
  5627. /* Enumeration for full vocoder rate. */
  5628. #define ASM_MEDIA_FMT_VOC_FULL_RATE 4
  5629. struct asm_v13k_enc_cfg {
  5630. struct apr_hdr hdr;
  5631. struct asm_stream_cmd_set_encdec_param encdec;
  5632. struct asm_enc_cfg_blk_param_v2 encblk;
  5633. u16 max_rate;
  5634. /* Maximum allowed encoder frame rate.
  5635. * Supported values:
  5636. * - #ASM_MEDIA_FMT_VOC_ONE_EIGHTH_RATE
  5637. * - #ASM_MEDIA_FMT_VOC_ONE_FOURTH_RATE
  5638. * - #ASM_MEDIA_FMT_VOC_HALF_RATE
  5639. * - #ASM_MEDIA_FMT_VOC_FULL_RATE
  5640. */
  5641. u16 min_rate;
  5642. /* Minimum allowed encoder frame rate.
  5643. * Supported values:
  5644. * - #ASM_MEDIA_FMT_VOC_ONE_EIGHTH_RATE
  5645. * - #ASM_MEDIA_FMT_VOC_ONE_FOURTH_RATE
  5646. * - #ASM_MEDIA_FMT_VOC_HALF_RATE
  5647. * - #ASM_MEDIA_FMT_VOC_FULL_RATE
  5648. */
  5649. u16 reduced_rate_cmd;
  5650. /* Reduced rate command, used to change
  5651. * the average bitrate of the V13K
  5652. * vocoder.
  5653. * Supported values:
  5654. * - #ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR1440 (Default)
  5655. * - #ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR1220
  5656. * - #ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR1120
  5657. * - #ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR90
  5658. * - #ASM_MEDIA_FMT_V13K_FS_ENCODE_MODE_MR720
  5659. */
  5660. u16 rate_mod_cmd;
  5661. /* Rate modulation command. Default = 0.
  5662. *- If bit 0=1, rate control is enabled.
  5663. *- If bit 1=1, the maximum number of consecutive full rate
  5664. * frames is limited with numbers supplied in
  5665. * bits 2 to 10.
  5666. *- If bit 1=0, the minimum number of non-full rate frames
  5667. * in between two full rate frames is forced to
  5668. * the number supplied in bits 2 to 10. In both cases, if necessary,
  5669. * half rate is used to substitute full rate. - Bits 15 to 10 are
  5670. * reserved and must all be set to zero.
  5671. */
  5672. } __packed;
  5673. #define ASM_MEDIA_FMT_EVRC_FS 0x00010BEE
  5674. /* EVRC encoder configuration structure used in the
  5675. * #ASM_PARAM_ID_ENCDEC_ENC_CFG_BLK_V2 command.
  5676. */
  5677. struct asm_evrc_enc_cfg {
  5678. struct apr_hdr hdr;
  5679. struct asm_stream_cmd_set_encdec_param encdec;
  5680. struct asm_enc_cfg_blk_param_v2 encblk;
  5681. u16 max_rate;
  5682. /* Maximum allowed encoder frame rate.
  5683. * Supported values:
  5684. * - #ASM_MEDIA_FMT_VOC_ONE_EIGHTH_RATE
  5685. * - #ASM_MEDIA_FMT_VOC_ONE_FOURTH_RATE
  5686. * - #ASM_MEDIA_FMT_VOC_HALF_RATE
  5687. * - #ASM_MEDIA_FMT_VOC_FULL_RATE
  5688. */
  5689. u16 min_rate;
  5690. /* Minimum allowed encoder frame rate.
  5691. * Supported values:
  5692. * - #ASM_MEDIA_FMT_VOC_ONE_EIGHTH_RATE
  5693. * - #ASM_MEDIA_FMT_VOC_ONE_FOURTH_RATE
  5694. * - #ASM_MEDIA_FMT_VOC_HALF_RATE
  5695. * - #ASM_MEDIA_FMT_VOC_FULL_RATE
  5696. */
  5697. u16 rate_mod_cmd;
  5698. /* Rate modulation command. Default: 0.
  5699. * - If bit 0=1, rate control is enabled.
  5700. * - If bit 1=1, the maximum number of consecutive full rate frames
  5701. * is limited with numbers supplied in bits 2 to 10.
  5702. *
  5703. * - If bit 1=0, the minimum number of non-full rate frames in
  5704. * between two full rate frames is forced to the number supplied in
  5705. * bits 2 to 10. In both cases, if necessary, half rate is used to
  5706. * substitute full rate.
  5707. *
  5708. * - Bits 15 to 10 are reserved and must all be set to zero.
  5709. */
  5710. u16 reserved;
  5711. /* Reserved. Clients must set this field to zero. */
  5712. } __packed;
  5713. #define ASM_MEDIA_FMT_WMA_V10PRO_V2 0x00010DA7
  5714. struct asm_wmaprov10_fmt_blk_v2 {
  5715. struct apr_hdr hdr;
  5716. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5717. u16 fmtag;
  5718. /* WMA format type.
  5719. * Supported values:
  5720. * - 0x162 -- WMA 9 Pro
  5721. * - 0x163 -- WMA 9 Pro Lossless
  5722. * - 0x166 -- WMA 10 Pro
  5723. * - 0x167 -- WMA 10 Pro Lossless
  5724. */
  5725. u16 num_channels;
  5726. /* Number of channels encoded in the input stream.
  5727. * Supported values: 1 to 8
  5728. */
  5729. u32 sample_rate;
  5730. /* Number of samples per second (in Hertz).
  5731. * Supported values: 11025, 16000, 22050, 32000, 44100, 48000,
  5732. * 88200, 96000
  5733. */
  5734. u32 avg_bytes_per_sec;
  5735. /* Bitrate expressed as the average bytes per second.
  5736. * Supported values: 2000 to 96000
  5737. */
  5738. u16 blk_align;
  5739. /* Size of the bitstream packet size in bytes. WMA Pro files
  5740. * have a payload of one block per bitstream packet.
  5741. * Supported values: @le 13376
  5742. */
  5743. u16 bits_per_sample;
  5744. /* Number of bits per sample in the encoded WMA stream.
  5745. * Supported values: 16, 24
  5746. */
  5747. u32 channel_mask;
  5748. /* Bit-packed double word (32-bits) that indicates the
  5749. * recommended speaker positions for each source channel.
  5750. */
  5751. u16 enc_options;
  5752. /* Bit-packed word with values that indicate whether certain
  5753. * features of the bitstream are used.
  5754. * Supported values: - 0x0001 -- ENCOPT3_PURE_LOSSLESS - 0x0006 --
  5755. * ENCOPT3_FRM_SIZE_MOD - 0x0038 -- ENCOPT3_SUBFRM_DIV - 0x0040 --
  5756. * ENCOPT3_WRITE_FRAMESIZE_IN_HDR - 0x0080 --
  5757. * ENCOPT3_GENERATE_DRC_PARAMS - 0x0100 -- ENCOPT3_RTMBITS
  5758. */
  5759. u16 usAdvancedEncodeOpt;
  5760. /* Advanced encoding option. */
  5761. u32 advanced_enc_options2;
  5762. /* Advanced encoding option 2. */
  5763. } __packed;
  5764. #define ASM_MEDIA_FMT_WMA_V9_V2 0x00010DA8
  5765. struct asm_wmastdv9_fmt_blk_v2 {
  5766. struct apr_hdr hdr;
  5767. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5768. u16 fmtag;
  5769. /* WMA format tag.
  5770. * Supported values: 0x161 (WMA 9 standard)
  5771. */
  5772. u16 num_channels;
  5773. /* Number of channels in the stream.
  5774. * Supported values: 1, 2
  5775. */
  5776. u32 sample_rate;
  5777. /* Number of samples per second (in Hertz).
  5778. * Supported values: 48000
  5779. */
  5780. u32 avg_bytes_per_sec;
  5781. /* Bitrate expressed as the average bytes per second. */
  5782. u16 blk_align;
  5783. /* Block align. All WMA files with a maximum packet size of
  5784. * 13376 are supported.
  5785. */
  5786. u16 bits_per_sample;
  5787. /* Number of bits per sample in the output.
  5788. * Supported values: 16
  5789. */
  5790. u32 channel_mask;
  5791. /* Channel mask.
  5792. * Supported values:
  5793. * - 3 -- Stereo (front left/front right)
  5794. * - 4 -- Mono (center)
  5795. */
  5796. u16 enc_options;
  5797. /* Options used during encoding. */
  5798. u16 reserved;
  5799. } __packed;
  5800. #define ASM_MEDIA_FMT_WMA_V8 0x00010D91
  5801. struct asm_wmastdv8_enc_cfg {
  5802. struct apr_hdr hdr;
  5803. struct asm_stream_cmd_set_encdec_param encdec;
  5804. struct asm_enc_cfg_blk_param_v2 encblk;
  5805. u32 bit_rate;
  5806. /* Encoding rate in bits per second. */
  5807. u32 sample_rate;
  5808. /* Number of samples per second.
  5809. *
  5810. * Supported values:
  5811. * - 0 -- Native mode
  5812. * - Other Supported values are 22050, 32000, 44100, and 48000.
  5813. *
  5814. * Native mode indicates that encoding must be performed with the
  5815. * sampling rate at the input.
  5816. * The sampling rate must not change during encoding.
  5817. */
  5818. u16 channel_cfg;
  5819. /* Number of channels to encode.
  5820. * Supported values:
  5821. * - 0 -- Native mode
  5822. * - 1 -- Mono
  5823. * - 2 -- Stereo
  5824. * - Other values are not supported.
  5825. *
  5826. * Native mode indicates that encoding must be performed with the
  5827. * number of channels at the input.
  5828. * The number of channels must not change during encoding.
  5829. */
  5830. u16 reserved;
  5831. /* Reserved. Clients must set this field to zero.*/
  5832. } __packed;
  5833. #define ASM_MEDIA_FMT_AMR_WB_PLUS_V2 0x00010DA9
  5834. struct asm_amrwbplus_fmt_blk_v2 {
  5835. struct apr_hdr hdr;
  5836. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  5837. u32 amr_frame_fmt;
  5838. /* AMR frame format.
  5839. * Supported values:
  5840. * - 6 -- Transport Interface Format (TIF)
  5841. * - Any other value -- File storage format (FSF)
  5842. *
  5843. * TIF stream contains 2-byte header for each frame within the
  5844. * superframe. FSF stream contains one 2-byte header per superframe.
  5845. */
  5846. } __packed;
  5847. #define ASM_MEDIA_FMT_AC3 0x00010DEE
  5848. #define ASM_MEDIA_FMT_EAC3 0x00010DEF
  5849. #define ASM_MEDIA_FMT_DTS 0x00010D88
  5850. #define ASM_MEDIA_FMT_MP2 0x00010DE9
  5851. #define ASM_MEDIA_FMT_FLAC 0x00010C16
  5852. #define ASM_MEDIA_FMT_ALAC 0x00012F31
  5853. #define ASM_MEDIA_FMT_VORBIS 0x00010C15
  5854. #define ASM_MEDIA_FMT_APE 0x00012F32
  5855. #define ASM_MEDIA_FMT_DSD 0x00012F3E
  5856. #define ASM_MEDIA_FMT_TRUEHD 0x00013215
  5857. /* 0x0 is used for fomat ID since ADSP dynamically determines the
  5858. * format encapsulated in the IEC61937 (compressed) or IEC60958
  5859. * (pcm) packets.
  5860. */
  5861. #define ASM_MEDIA_FMT_IEC 0x00000000
  5862. /* Media format ID for adaptive transform acoustic coding. This
  5863. * ID is used by the #ASM_STREAM_CMD_OPEN_WRITE_COMPRESSED command
  5864. * only.
  5865. */
  5866. #define ASM_MEDIA_FMT_ATRAC 0x00010D89
  5867. /* Media format ID for metadata-enhanced audio transmission.
  5868. * This ID is used by the #ASM_STREAM_CMD_OPEN_WRITE_COMPRESSED
  5869. * command only.
  5870. */
  5871. #define ASM_MEDIA_FMT_MAT 0x00010D8A
  5872. /* adsp_media_fmt.h */
  5873. #define ASM_DATA_CMD_WRITE_V2 0x00010DAB
  5874. struct asm_data_cmd_write_v2 {
  5875. struct apr_hdr hdr;
  5876. u32 buf_addr_lsw;
  5877. /* The 64 bit address msw-lsw should be a valid, mapped address.
  5878. * 64 bit address should be a multiple of 32 bytes
  5879. */
  5880. u32 buf_addr_msw;
  5881. /* The 64 bit address msw-lsw should be a valid, mapped address.
  5882. * 64 bit address should be a multiple of 32 bytes.
  5883. * -Address of the buffer containing the data to be decoded.
  5884. * The buffer should be aligned to a 32 byte boundary.
  5885. * -In the case of 32 bit Shared memory address, msw field must
  5886. * -be set to zero.
  5887. * -In the case of 36 bit shared memory address, bit 31 to bit 4
  5888. * -of msw must be set to zero.
  5889. */
  5890. u32 mem_map_handle;
  5891. /* memory map handle returned by DSP through
  5892. * ASM_CMD_SHARED_MEM_MAP_REGIONS command
  5893. */
  5894. u32 buf_size;
  5895. /* Number of valid bytes available in the buffer for decoding. The
  5896. * first byte starts at buf_addr.
  5897. */
  5898. u32 seq_id;
  5899. /* Optional buffer sequence ID. */
  5900. u32 timestamp_lsw;
  5901. /* Lower 32 bits of the 64-bit session time in microseconds of the
  5902. * first buffer sample.
  5903. */
  5904. u32 timestamp_msw;
  5905. /* Upper 32 bits of the 64-bit session time in microseconds of the
  5906. * first buffer sample.
  5907. */
  5908. u32 flags;
  5909. /* Bitfield of flags.
  5910. * Supported values for bit 31:
  5911. * - 1 -- Valid timestamp.
  5912. * - 0 -- Invalid timestamp.
  5913. * - Use #ASM_BIT_MASKIMESTAMP_VALID_FLAG as the bitmask and
  5914. * #ASM_SHIFTIMESTAMP_VALID_FLAG as the shift value to set this bit.
  5915. * Supported values for bit 30:
  5916. * - 1 -- Last buffer.
  5917. * - 0 -- Not the last buffer.
  5918. *
  5919. * Supported values for bit 29:
  5920. * - 1 -- Continue the timestamp from the previous buffer.
  5921. * - 0 -- Timestamp of the current buffer is not related
  5922. * to the timestamp of the previous buffer.
  5923. * - Use #ASM_BIT_MASKS_CONTINUE_FLAG and #ASM_SHIFTS_CONTINUE_FLAG
  5924. * to set this bit.
  5925. *
  5926. * Supported values for bit 4:
  5927. * - 1 -- End of the frame.
  5928. * - 0 -- Not the end of frame, or this information is not known.
  5929. * - Use #ASM_BIT_MASK_EOF_FLAG as the bitmask and #ASM_SHIFT_EOF_FLAG
  5930. * as the shift value to set this bit.
  5931. *
  5932. * All other bits are reserved and must be set to 0.
  5933. *
  5934. * If bit 31=0 and bit 29=1: The timestamp of the first sample in
  5935. * this buffer continues from the timestamp of the last sample in
  5936. * the previous buffer. If there is no previous buffer (i.e., this
  5937. * is the first buffer sent after opening the stream or after a
  5938. * flush operation), or if the previous buffer does not have a valid
  5939. * timestamp, the samples in the current buffer also do not have a
  5940. * valid timestamp. They are played out as soon as possible.
  5941. *
  5942. *
  5943. * If bit 31=0 and bit 29=0: No timestamp is associated with the
  5944. * first sample in this buffer. The samples are played out as soon
  5945. * as possible.
  5946. *
  5947. *
  5948. * If bit 31=1 and bit 29 is ignored: The timestamp specified in
  5949. * this payload is honored.
  5950. *
  5951. *
  5952. * If bit 30=0: Not the last buffer in the stream. This is useful
  5953. * in removing trailing samples.
  5954. *
  5955. *
  5956. * For bit 4: The client can set this flag for every buffer sent in
  5957. * which the last byte is the end of a frame. If this flag is set,
  5958. * the buffer can contain data from multiple frames, but it should
  5959. * always end at a frame boundary. Restrictions allow the aDSP to
  5960. * detect an end of frame without requiring additional processing.
  5961. */
  5962. } __packed;
  5963. #define ASM_DATA_CMD_READ_V2 0x00010DAC
  5964. struct asm_data_cmd_read_v2 {
  5965. struct apr_hdr hdr;
  5966. u32 buf_addr_lsw;
  5967. /* the 64 bit address msw-lsw should be a valid mapped address
  5968. * and should be a multiple of 32 bytes
  5969. */
  5970. u32 buf_addr_msw;
  5971. /* the 64 bit address msw-lsw should be a valid mapped address
  5972. * and should be a multiple of 32 bytes.
  5973. * - Address of the buffer where the DSP puts the encoded data,
  5974. * potentially, at an offset specified by the uOffset field in
  5975. * ASM_DATA_EVENT_READ_DONE structure. The buffer should be aligned
  5976. * to a 32 byte boundary.
  5977. * - In the case of 32 bit Shared memory address, msw field must
  5978. * - be set to zero.
  5979. * - In the case of 36 bit shared memory address, bit 31 to bit
  5980. * - 4 of msw must be set to zero.
  5981. */
  5982. u32 mem_map_handle;
  5983. /* memory map handle returned by DSP through
  5984. * ASM_CMD_SHARED_MEM_MAP_REGIONS command.
  5985. */
  5986. u32 buf_size;
  5987. /* Number of bytes available for the aDSP to write. The aDSP
  5988. * starts writing from buf_addr.
  5989. */
  5990. u32 seq_id;
  5991. /* Optional buffer sequence ID. */
  5992. } __packed;
  5993. #define ASM_DATA_CMD_EOS 0x00010BDB
  5994. #define ASM_DATA_EVENT_RENDERED_EOS 0x00010C1C
  5995. #define ASM_DATA_EVENT_EOS 0x00010BDD
  5996. #define ASM_DATA_EVENT_WRITE_DONE_V2 0x00010D99
  5997. struct asm_data_event_write_done_v2 {
  5998. u32 buf_addr_lsw;
  5999. /* lsw of the 64 bit address */
  6000. u32 buf_addr_msw;
  6001. /* msw of the 64 bit address. address given by the client in
  6002. * ASM_DATA_CMD_WRITE_V2 command.
  6003. */
  6004. u32 mem_map_handle;
  6005. /* memory map handle in the ASM_DATA_CMD_WRITE_V2 */
  6006. u32 status;
  6007. /* Status message (error code) that indicates whether the
  6008. * referenced buffer has been successfully consumed.
  6009. * Supported values: Refer to @xhyperref{Q3,[Q3]}
  6010. */
  6011. } __packed;
  6012. #define ASM_DATA_EVENT_READ_DONE_V2 0x00010D9A
  6013. /* Definition of the frame metadata flag bitmask.*/
  6014. #define ASM_BIT_MASK_FRAME_METADATA_FLAG (0x40000000UL)
  6015. /* Definition of the frame metadata flag shift value. */
  6016. #define ASM_SHIFT_FRAME_METADATA_FLAG 30
  6017. struct asm_data_event_read_done_v2 {
  6018. u32 status;
  6019. /* Status message (error code).
  6020. * Supported values: Refer to @xhyperref{Q3,[Q3]}
  6021. */
  6022. u32 buf_addr_lsw;
  6023. /* 64 bit address msw-lsw is a valid, mapped address. 64 bit
  6024. * address is a multiple of 32 bytes.
  6025. */
  6026. u32 buf_addr_msw;
  6027. /* 64 bit address msw-lsw is a valid, mapped address. 64 bit
  6028. * address is a multiple of 32 bytes.
  6029. *
  6030. * -Same address provided by the client in ASM_DATA_CMD_READ_V2
  6031. * -In the case of 32 bit Shared memory address, msw field is set to
  6032. * zero.
  6033. * -In the case of 36 bit shared memory address, bit 31 to bit 4
  6034. * -of msw is set to zero.
  6035. */
  6036. u32 mem_map_handle;
  6037. /* memory map handle in the ASM_DATA_CMD_READ_V2 */
  6038. u32 enc_framesotal_size;
  6039. /* Total size of the encoded frames in bytes.
  6040. * Supported values: >0
  6041. */
  6042. u32 offset;
  6043. /* Offset (from buf_addr) to the first byte of the first encoded
  6044. * frame. All encoded frames are consecutive, starting from this
  6045. * offset.
  6046. * Supported values: > 0
  6047. */
  6048. u32 timestamp_lsw;
  6049. /* Lower 32 bits of the 64-bit session time in microseconds of
  6050. * the first sample in the buffer. If Bit 5 of mode_flags flag of
  6051. * ASM_STREAM_CMD_OPEN_READ_V2 is 1 then the 64 bit timestamp is
  6052. * absolute capture time otherwise it is relative session time. The
  6053. * absolute timestamp doesn't reset unless the system is reset.
  6054. */
  6055. u32 timestamp_msw;
  6056. /* Upper 32 bits of the 64-bit session time in microseconds of
  6057. * the first sample in the buffer.
  6058. */
  6059. u32 flags;
  6060. /* Bitfield of flags. Bit 30 indicates whether frame metadata is
  6061. * present. If frame metadata is present, num_frames consecutive
  6062. * instances of @xhyperref{hdr:FrameMetaData,Frame metadata} start
  6063. * at the buffer address.
  6064. * Supported values for bit 31:
  6065. * - 1 -- Timestamp is valid.
  6066. * - 0 -- Timestamp is invalid.
  6067. * - Use #ASM_BIT_MASKIMESTAMP_VALID_FLAG and
  6068. * #ASM_SHIFTIMESTAMP_VALID_FLAG to set this bit.
  6069. *
  6070. * Supported values for bit 30:
  6071. * - 1 -- Frame metadata is present.
  6072. * - 0 -- Frame metadata is absent.
  6073. * - Use #ASM_BIT_MASK_FRAME_METADATA_FLAG and
  6074. * #ASM_SHIFT_FRAME_METADATA_FLAG to set this bit.
  6075. *
  6076. * All other bits are reserved; the aDSP sets them to 0.
  6077. */
  6078. u32 num_frames;
  6079. /* Number of encoded frames in the buffer. */
  6080. u32 seq_id;
  6081. /* Optional buffer sequence ID. */
  6082. } __packed;
  6083. struct asm_data_read_buf_metadata_v2 {
  6084. u32 offset;
  6085. /* Offset from buf_addr in #ASM_DATA_EVENT_READ_DONE_PAYLOAD to
  6086. * the frame associated with this metadata.
  6087. * Supported values: > 0
  6088. */
  6089. u32 frm_size;
  6090. /* Size of the encoded frame in bytes.
  6091. * Supported values: > 0
  6092. */
  6093. u32 num_encoded_pcm_samples;
  6094. /* Number of encoded PCM samples (per channel) in the frame
  6095. * associated with this metadata.
  6096. * Supported values: > 0
  6097. */
  6098. u32 timestamp_lsw;
  6099. /* Lower 32 bits of the 64-bit session time in microseconds of the
  6100. * first sample for this frame.
  6101. * If Bit 5 of mode_flags flag of ASM_STREAM_CMD_OPEN_READ_V2 is 1
  6102. * then the 64 bit timestamp is absolute capture time otherwise it
  6103. * is relative session time. The absolute timestamp doesn't reset
  6104. * unless the system is reset.
  6105. */
  6106. u32 timestamp_msw;
  6107. /* Lower 32 bits of the 64-bit session time in microseconds of the
  6108. * first sample for this frame.
  6109. */
  6110. u32 flags;
  6111. /* Frame flags.
  6112. * Supported values for bit 31:
  6113. * - 1 -- Time stamp is valid
  6114. * - 0 -- Time stamp is not valid
  6115. * - All other bits are reserved; the aDSP sets them to 0.
  6116. */
  6117. } __packed;
  6118. /* Notifies the client of a change in the data sampling rate or
  6119. * Channel mode. This event is raised by the decoder service. The
  6120. * event is enabled through the mode flags of
  6121. * #ASM_STREAM_CMD_OPEN_WRITE_V2 or
  6122. * #ASM_STREAM_CMD_OPEN_READWRITE_V2. - The decoder detects a change
  6123. * in the output sampling frequency or the number/positioning of
  6124. * output channels, or if it is the first frame decoded.The new
  6125. * sampling frequency or the new channel configuration is
  6126. * communicated back to the client asynchronously.
  6127. */
  6128. #define ASM_DATA_EVENT_SR_CM_CHANGE_NOTIFY 0x00010C65
  6129. /* Payload of the #ASM_DATA_EVENT_SR_CM_CHANGE_NOTIFY event.
  6130. * This event is raised when the following conditions are both true:
  6131. * - The event is enabled through the mode_flags of
  6132. * #ASM_STREAM_CMD_OPEN_WRITE_V2 or
  6133. * #ASM_STREAM_CMD_OPEN_READWRITE_V2. - The decoder detects a change
  6134. * in either the output sampling frequency or the number/positioning
  6135. * of output channels, or if it is the first frame decoded.
  6136. * This event is not raised (even if enabled) if the decoder is
  6137. * MIDI, because
  6138. */
  6139. struct asm_data_event_sr_cm_change_notify {
  6140. u32 sample_rate;
  6141. /* New sampling rate (in Hertz) after detecting a change in the
  6142. * bitstream.
  6143. * Supported values: 2000 to 48000
  6144. */
  6145. u16 num_channels;
  6146. /* New number of channels after detecting a change in the
  6147. * bitstream.
  6148. * Supported values: 1 to 8
  6149. */
  6150. u16 reserved;
  6151. /* Reserved for future use. This field must be set to 0.*/
  6152. u8 channel_mapping[8];
  6153. } __packed;
  6154. /* Notifies the client of a data sampling rate or channel mode
  6155. * change. This event is raised by the encoder service.
  6156. * This event is raised when :
  6157. * - Native mode encoding was requested in the encoder
  6158. * configuration (i.e., the channel number was 0), the sample rate
  6159. * was 0, or both were 0.
  6160. *
  6161. * - The input data frame at the encoder is the first one, or the
  6162. * sampling rate/channel mode is different from the previous input
  6163. * data frame.
  6164. *
  6165. */
  6166. #define ASM_DATA_EVENT_ENC_SR_CM_CHANGE_NOTIFY 0x00010BDE
  6167. struct asm_data_event_enc_sr_cm_change_notify {
  6168. u32 sample_rate;
  6169. /* New sampling rate (in Hertz) after detecting a change in the
  6170. * input data.
  6171. * Supported values: 2000 to 48000
  6172. */
  6173. u16 num_channels;
  6174. /* New number of channels after detecting a change in the input
  6175. * data. Supported values: 1 to 8
  6176. */
  6177. u16 bits_per_sample;
  6178. /* New bits per sample after detecting a change in the input
  6179. * data.
  6180. * Supported values: 16, 24
  6181. */
  6182. u8 channel_mapping[8];
  6183. } __packed;
  6184. #define ASM_DATA_CMD_IEC_60958_FRAME_RATE 0x00010D87
  6185. /* Payload of the #ASM_DATA_CMD_IEC_60958_FRAME_RATE command,
  6186. * which is used to indicate the IEC 60958 frame rate of a given
  6187. * packetized audio stream.
  6188. */
  6189. struct asm_data_cmd_iec_60958_frame_rate {
  6190. u32 frame_rate;
  6191. /* IEC 60958 frame rate of the incoming IEC 61937 packetized stream.
  6192. * Supported values: Any valid frame rate
  6193. */
  6194. } __packed;
  6195. /* adsp_asm_data_commands.h*/
  6196. /* Definition of the stream ID bitmask.*/
  6197. #define ASM_BIT_MASK_STREAM_ID (0x000000FFUL)
  6198. /* Definition of the stream ID shift value.*/
  6199. #define ASM_SHIFT_STREAM_ID 0
  6200. /* Definition of the session ID bitmask.*/
  6201. #define ASM_BIT_MASK_SESSION_ID (0x0000FF00UL)
  6202. /* Definition of the session ID shift value.*/
  6203. #define ASM_SHIFT_SESSION_ID 8
  6204. /* Definition of the service ID bitmask.*/
  6205. #define ASM_BIT_MASK_SERVICE_ID (0x00FF0000UL)
  6206. /* Definition of the service ID shift value.*/
  6207. #define ASM_SHIFT_SERVICE_ID 16
  6208. /* Definition of the domain ID bitmask.*/
  6209. #define ASM_BIT_MASK_DOMAIN_ID (0xFF000000UL)
  6210. /* Definition of the domain ID shift value.*/
  6211. #define ASM_SHIFT_DOMAIN_ID 24
  6212. #define ASM_CMD_SHARED_MEM_MAP_REGIONS 0x00010D92
  6213. #define ASM_CMDRSP_SHARED_MEM_MAP_REGIONS 0x00010D93
  6214. #define ASM_CMD_SHARED_MEM_UNMAP_REGIONS 0x00010D94
  6215. /* adsp_asm_service_commands.h */
  6216. #define ASM_MAX_SESSION_ID (15)
  6217. /* Maximum number of sessions.*/
  6218. #define ASM_MAX_NUM_SESSIONS ASM_MAX_SESSION_ID
  6219. /* Maximum number of streams per session.*/
  6220. #define ASM_MAX_STREAMS_PER_SESSION (8)
  6221. #define ASM_SESSION_CMD_RUN_V2 0x00010DAA
  6222. #define ASM_SESSION_CMD_RUN_STARTIME_RUN_IMMEDIATE 0
  6223. #define ASM_SESSION_CMD_RUN_STARTIME_RUN_AT_ABSOLUTEIME 1
  6224. #define ASM_SESSION_CMD_RUN_STARTIME_RUN_AT_RELATIVEIME 2
  6225. #define ASM_SESSION_CMD_RUN_STARTIME_RUN_WITH_DELAY 3
  6226. #define ASM_BIT_MASK_RUN_STARTIME (0x00000003UL)
  6227. /* Bit shift value used to specify the start time for the
  6228. * ASM_SESSION_CMD_RUN_V2 command.
  6229. */
  6230. #define ASM_SHIFT_RUN_STARTIME 0
  6231. struct asm_session_cmd_run_v2 {
  6232. struct apr_hdr hdr;
  6233. u32 flags;
  6234. /* Specifies whether to run immediately or at a specific
  6235. * rendering time or with a specified delay. Run with delay is
  6236. * useful for delaying in case of ASM loopback opened through
  6237. * ASM_STREAM_CMD_OPEN_LOOPBACK_V2. Use #ASM_BIT_MASK_RUN_STARTIME
  6238. * and #ASM_SHIFT_RUN_STARTIME to set this 2-bit flag.
  6239. *
  6240. *
  6241. *Bits 0 and 1 can take one of four possible values:
  6242. *
  6243. *- #ASM_SESSION_CMD_RUN_STARTIME_RUN_IMMEDIATE
  6244. *- #ASM_SESSION_CMD_RUN_STARTIME_RUN_AT_ABSOLUTEIME
  6245. *- #ASM_SESSION_CMD_RUN_STARTIME_RUN_AT_RELATIVEIME
  6246. *- #ASM_SESSION_CMD_RUN_STARTIME_RUN_WITH_DELAY
  6247. *
  6248. *All other bits are reserved; clients must set them to zero.
  6249. */
  6250. u32 time_lsw;
  6251. /* Lower 32 bits of the time in microseconds used to align the
  6252. * session origin time. When bits 0-1 of flags is
  6253. * ASM_SESSION_CMD_RUN_START_RUN_WITH_DELAY, time lsw is the lsw of
  6254. * the delay in us. For ASM_SESSION_CMD_RUN_START_RUN_WITH_DELAY,
  6255. * maximum value of the 64 bit delay is 150 ms.
  6256. */
  6257. u32 time_msw;
  6258. /* Upper 32 bits of the time in microseconds used to align the
  6259. * session origin time. When bits 0-1 of flags is
  6260. * ASM_SESSION_CMD_RUN_START_RUN_WITH_DELAY, time msw is the msw of
  6261. * the delay in us. For ASM_SESSION_CMD_RUN_START_RUN_WITH_DELAY,
  6262. * maximum value of the 64 bit delay is 150 ms.
  6263. */
  6264. } __packed;
  6265. #define ASM_SESSION_CMD_PAUSE 0x00010BD3
  6266. #define ASM_SESSION_CMD_SUSPEND 0x00010DEC
  6267. #define ASM_SESSION_CMD_GET_SESSIONTIME_V3 0x00010D9D
  6268. #define ASM_SESSION_CMD_REGISTER_FOR_RX_UNDERFLOW_EVENTS 0x00010BD5
  6269. struct asm_session_cmd_rgstr_rx_underflow {
  6270. struct apr_hdr hdr;
  6271. u16 enable_flag;
  6272. /* Specifies whether a client is to receive events when an Rx
  6273. * session underflows.
  6274. * Supported values:
  6275. * - 0 -- Do not send underflow events
  6276. * - 1 -- Send underflow events
  6277. */
  6278. u16 reserved;
  6279. /* Reserved. This field must be set to zero.*/
  6280. } __packed;
  6281. #define ASM_SESSION_CMD_REGISTER_FORX_OVERFLOW_EVENTS 0x00010BD6
  6282. struct asm_session_cmd_regx_overflow {
  6283. struct apr_hdr hdr;
  6284. u16 enable_flag;
  6285. /* Specifies whether a client is to receive events when a Tx
  6286. * session overflows.
  6287. * Supported values:
  6288. * - 0 -- Do not send overflow events
  6289. * - 1 -- Send overflow events
  6290. */
  6291. u16 reserved;
  6292. /* Reserved. This field must be set to zero.*/
  6293. } __packed;
  6294. #define ASM_SESSION_EVENT_RX_UNDERFLOW 0x00010C17
  6295. #define ASM_SESSION_EVENTX_OVERFLOW 0x00010C18
  6296. #define ASM_SESSION_CMDRSP_GET_SESSIONTIME_V3 0x00010D9E
  6297. struct asm_session_cmdrsp_get_sessiontime_v3 {
  6298. u32 status;
  6299. /* Status message (error code).
  6300. * Supported values: Refer to @xhyperref{Q3,[Q3]}
  6301. */
  6302. u32 sessiontime_lsw;
  6303. /* Lower 32 bits of the current session time in microseconds.*/
  6304. u32 sessiontime_msw;
  6305. /* Upper 32 bits of the current session time in microseconds.*/
  6306. u32 absolutetime_lsw;
  6307. /* Lower 32 bits in micro seconds of the absolute time at which
  6308. * the * sample corresponding to the above session time gets
  6309. * rendered * to hardware. This absolute time may be slightly in the
  6310. * future or past.
  6311. */
  6312. u32 absolutetime_msw;
  6313. /* Upper 32 bits in micro seconds of the absolute time at which
  6314. * the * sample corresponding to the above session time gets
  6315. * rendered to * hardware. This absolute time may be slightly in the
  6316. * future or past.
  6317. */
  6318. } __packed;
  6319. #define ASM_SESSION_CMD_ADJUST_SESSION_CLOCK_V2 0x00010D9F
  6320. struct asm_session_cmd_adjust_session_clock_v2 {
  6321. struct apr_hdr hdr;
  6322. u32 adjustime_lsw;
  6323. /* Lower 32 bits of the signed 64-bit quantity that specifies the
  6324. * adjustment time in microseconds to the session clock.
  6325. *
  6326. * Positive values indicate advancement of the session clock.
  6327. * Negative values indicate delay of the session clock.
  6328. */
  6329. u32 adjustime_msw;
  6330. /* Upper 32 bits of the signed 64-bit quantity that specifies
  6331. * the adjustment time in microseconds to the session clock.
  6332. * Positive values indicate advancement of the session clock.
  6333. * Negative values indicate delay of the session clock.
  6334. */
  6335. } __packed;
  6336. #define ASM_SESSION_CMDRSP_ADJUST_SESSION_CLOCK_V2 0x00010DA0
  6337. struct asm_session_cmdrsp_adjust_session_clock_v2 {
  6338. u32 status;
  6339. /* Status message (error code).
  6340. * Supported values: Refer to @xhyperref{Q3,[Q3]}
  6341. * An error means the session clock is not adjusted. In this case,
  6342. * the next two fields are irrelevant.
  6343. */
  6344. u32 actual_adjustime_lsw;
  6345. /* Lower 32 bits of the signed 64-bit quantity that specifies
  6346. * the actual adjustment in microseconds performed by the aDSP.
  6347. * A positive value indicates advancement of the session clock. A
  6348. * negative value indicates delay of the session clock.
  6349. */
  6350. u32 actual_adjustime_msw;
  6351. /* Upper 32 bits of the signed 64-bit quantity that specifies
  6352. * the actual adjustment in microseconds performed by the aDSP.
  6353. * A positive value indicates advancement of the session clock. A
  6354. * negative value indicates delay of the session clock.
  6355. */
  6356. u32 cmd_latency_lsw;
  6357. /* Lower 32 bits of the unsigned 64-bit quantity that specifies
  6358. * the amount of time in microseconds taken to perform the session
  6359. * clock adjustment.
  6360. */
  6361. u32 cmd_latency_msw;
  6362. /* Upper 32 bits of the unsigned 64-bit quantity that specifies
  6363. * the amount of time in microseconds taken to perform the session
  6364. * clock adjustment.
  6365. */
  6366. } __packed;
  6367. #define ASM_SESSION_CMD_GET_PATH_DELAY_V2 0x00010DAF
  6368. #define ASM_SESSION_CMDRSP_GET_PATH_DELAY_V2 0x00010DB0
  6369. struct asm_session_cmdrsp_get_path_delay_v2 {
  6370. u32 status;
  6371. /* Status message (error code). Whether this get delay operation
  6372. * is successful or not. Delay value is valid only if status is
  6373. * success.
  6374. * Supported values: Refer to @xhyperref{Q5,[Q5]}
  6375. */
  6376. u32 audio_delay_lsw;
  6377. /* Upper 32 bits of the aDSP delay in microseconds. */
  6378. u32 audio_delay_msw;
  6379. /* Lower 32 bits of the aDSP delay in microseconds. */
  6380. } __packed;
  6381. /* adsp_asm_session_command.h*/
  6382. #define ASM_STREAM_CMD_OPEN_WRITE_V3 0x00010DB3
  6383. #define ASM_LOW_LATENCY_STREAM_SESSION 0x10000000
  6384. #define ASM_ULTRA_LOW_LATENCY_STREAM_SESSION 0x20000000
  6385. #define ASM_ULL_POST_PROCESSING_STREAM_SESSION 0x40000000
  6386. #define ASM_LEGACY_STREAM_SESSION 0
  6387. struct asm_stream_cmd_open_write_v3 {
  6388. struct apr_hdr hdr;
  6389. uint32_t mode_flags;
  6390. /* Mode flags that configure the stream to notify the client
  6391. * whenever it detects an SR/CM change at the input to its POPP.
  6392. * Supported values for bits 0 to 1:
  6393. * - Reserved; clients must set them to zero.
  6394. * Supported values for bit 2:
  6395. * - 0 -- SR/CM change notification event is disabled.
  6396. * - 1 -- SR/CM change notification event is enabled.
  6397. * - Use #ASM_BIT_MASK_SR_CM_CHANGE_NOTIFY_FLAG and
  6398. * #ASM_SHIFT_SR_CM_CHANGE_NOTIFY_FLAG to set or get this bit.
  6399. *
  6400. * Supported values for bit 31:
  6401. * - 0 -- Stream to be opened in on-Gapless mode.
  6402. * - 1 -- Stream to be opened in Gapless mode. In Gapless mode,
  6403. * successive streams must be opened with same session ID but
  6404. * different stream IDs.
  6405. *
  6406. * - Use #ASM_BIT_MASK_GAPLESS_MODE_FLAG and
  6407. * #ASM_SHIFT_GAPLESS_MODE_FLAG to set or get this bit.
  6408. *
  6409. *
  6410. * @note1hang MIDI and DTMF streams cannot be opened in Gapless mode.
  6411. */
  6412. uint16_t sink_endpointype;
  6413. /*< Sink point type.
  6414. * Supported values:
  6415. * - 0 -- Device matrix
  6416. * - Other values are reserved.
  6417. *
  6418. * The device matrix is the gateway to the hardware ports.
  6419. */
  6420. uint16_t bits_per_sample;
  6421. /*< Number of bits per sample processed by ASM modules.
  6422. * Supported values: 16 and 24 bits per sample
  6423. */
  6424. uint32_t postprocopo_id;
  6425. /*< Specifies the topology (order of processing) of
  6426. * postprocessing algorithms. <i>None</i> means no postprocessing.
  6427. * Supported values:
  6428. * - #ASM_STREAM_POSTPROCOPO_ID_DEFAULT
  6429. * - #ASM_STREAM_POSTPROCOPO_ID_MCH_PEAK_VOL
  6430. * - #ASM_STREAM_POSTPROCOPO_ID_NONE
  6431. *
  6432. * This field can also be enabled through SetParams flags.
  6433. */
  6434. uint32_t dec_fmt_id;
  6435. /*< Configuration ID of the decoder media format.
  6436. *
  6437. * Supported values:
  6438. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2
  6439. * - #ASM_MEDIA_FMT_ADPCM
  6440. * - #ASM_MEDIA_FMT_MP3
  6441. * - #ASM_MEDIA_FMT_AAC_V2
  6442. * - #ASM_MEDIA_FMT_DOLBY_AAC
  6443. * - #ASM_MEDIA_FMT_AMRNB_FS
  6444. * - #ASM_MEDIA_FMT_AMRWB_FS
  6445. * - #ASM_MEDIA_FMT_AMR_WB_PLUS_V2
  6446. * - #ASM_MEDIA_FMT_V13K_FS
  6447. * - #ASM_MEDIA_FMT_EVRC_FS
  6448. * - #ASM_MEDIA_FMT_EVRCB_FS
  6449. * - #ASM_MEDIA_FMT_EVRCWB_FS
  6450. * - #ASM_MEDIA_FMT_SBC
  6451. * - #ASM_MEDIA_FMT_WMA_V10PRO_V2
  6452. * - #ASM_MEDIA_FMT_WMA_V9_V2
  6453. * - #ASM_MEDIA_FMT_AC3
  6454. * - #ASM_MEDIA_FMT_EAC3
  6455. * - #ASM_MEDIA_FMT_G711_ALAW_FS
  6456. * - #ASM_MEDIA_FMT_G711_MLAW_FS
  6457. * - #ASM_MEDIA_FMT_G729A_FS
  6458. * - #ASM_MEDIA_FMT_FR_FS
  6459. * - #ASM_MEDIA_FMT_VORBIS
  6460. * - #ASM_MEDIA_FMT_FLAC
  6461. * - #ASM_MEDIA_FMT_ALAC
  6462. * - #ASM_MEDIA_FMT_APE
  6463. * - #ASM_MEDIA_FMT_EXAMPLE
  6464. */
  6465. } __packed;
  6466. #define ASM_STREAM_CMD_OPEN_PULL_MODE_WRITE 0x00010DD9
  6467. /* Bitmask for the stream_perf_mode subfield. */
  6468. #define ASM_BIT_MASK_STREAM_PERF_FLAG_PULL_MODE_WRITE 0xE0000000UL
  6469. /* Bitmask for the stream_perf_mode subfield. */
  6470. #define ASM_SHIFT_STREAM_PERF_FLAG_PULL_MODE_WRITE 29
  6471. #define ASM_STREAM_CMD_OPEN_PUSH_MODE_READ 0x00010DDA
  6472. #define ASM_BIT_MASK_STREAM_PERF_FLAG_PUSH_MODE_READ 0xE0000000UL
  6473. #define ASM_SHIFT_STREAM_PERF_FLAG_PUSH_MODE_READ 29
  6474. #define ASM_DATA_EVENT_WATERMARK 0x00010DDB
  6475. struct asm_shared_position_buffer {
  6476. volatile uint32_t frame_counter;
  6477. /* Counter used to handle interprocessor synchronization issues.
  6478. * When frame_counter is 0: read_index, wall_clock_us_lsw, and
  6479. * wall_clock_us_msw are invalid.
  6480. * Supported values: >= 0.
  6481. */
  6482. volatile uint32_t index;
  6483. /* Index in bytes from where the aDSP is reading/writing.
  6484. * Supported values: 0 to circular buffer size - 1
  6485. */
  6486. volatile uint32_t wall_clock_us_lsw;
  6487. /* Lower 32 bits of the 64-bit wall clock time in microseconds when the
  6488. * read index was updated.
  6489. * Supported values: >= 0
  6490. */
  6491. volatile uint32_t wall_clock_us_msw;
  6492. /* Upper 32 bits of the 64 bit wall clock time in microseconds when the
  6493. * read index was updated
  6494. * Supported values: >= 0
  6495. */
  6496. } __packed;
  6497. struct asm_shared_watermark_level {
  6498. uint32_t watermark_level_bytes;
  6499. } __packed;
  6500. struct asm_stream_cmd_open_shared_io {
  6501. struct apr_hdr hdr;
  6502. uint32_t mode_flags;
  6503. uint16_t endpoint_type;
  6504. uint16_t topo_bits_per_sample;
  6505. uint32_t topo_id;
  6506. uint32_t fmt_id;
  6507. uint32_t shared_pos_buf_phy_addr_lsw;
  6508. uint32_t shared_pos_buf_phy_addr_msw;
  6509. uint16_t shared_pos_buf_mem_pool_id;
  6510. uint16_t shared_pos_buf_num_regions;
  6511. uint32_t shared_pos_buf_property_flag;
  6512. uint32_t shared_circ_buf_start_phy_addr_lsw;
  6513. uint32_t shared_circ_buf_start_phy_addr_msw;
  6514. uint32_t shared_circ_buf_size;
  6515. uint16_t shared_circ_buf_mem_pool_id;
  6516. uint16_t shared_circ_buf_num_regions;
  6517. uint32_t shared_circ_buf_property_flag;
  6518. uint32_t num_watermark_levels;
  6519. struct asm_multi_channel_pcm_fmt_blk_v3 fmt;
  6520. struct avs_shared_map_region_payload map_region_pos_buf;
  6521. struct avs_shared_map_region_payload map_region_circ_buf;
  6522. struct asm_shared_watermark_level watermark[0];
  6523. } __packed;
  6524. #define ASM_STREAM_CMD_OPEN_READ_V3 0x00010DB4
  6525. /* Definition of the timestamp type flag bitmask */
  6526. #define ASM_BIT_MASKIMESTAMPYPE_FLAG (0x00000020UL)
  6527. /* Definition of the timestamp type flag shift value. */
  6528. #define ASM_SHIFTIMESTAMPYPE_FLAG 5
  6529. /* Relative timestamp is identified by this value.*/
  6530. #define ASM_RELATIVEIMESTAMP 0
  6531. /* Absolute timestamp is identified by this value.*/
  6532. #define ASM_ABSOLUTEIMESTAMP 1
  6533. /* Bit value for Low Latency Tx stream subfield */
  6534. #define ASM_LOW_LATENCY_TX_STREAM_SESSION 1
  6535. /* Bit shift for the stream_perf_mode subfield. */
  6536. #define ASM_SHIFT_STREAM_PERF_MODE_FLAG_IN_OPEN_READ 29
  6537. struct asm_stream_cmd_open_read_v3 {
  6538. struct apr_hdr hdr;
  6539. u32 mode_flags;
  6540. /* Mode flags that indicate whether meta information per encoded
  6541. * frame is to be provided.
  6542. * Supported values for bit 4:
  6543. *
  6544. * - 0 -- Return data buffer contains all encoded frames only; it
  6545. * does not contain frame metadata.
  6546. *
  6547. * - 1 -- Return data buffer contains an array of metadata and
  6548. * encoded frames.
  6549. *
  6550. * - Use #ASM_BIT_MASK_META_INFO_FLAG as the bitmask and
  6551. * #ASM_SHIFT_META_INFO_FLAG as the shift value for this bit.
  6552. *
  6553. *
  6554. * Supported values for bit 5:
  6555. *
  6556. * - ASM_RELATIVEIMESTAMP -- ASM_DATA_EVENT_READ_DONE_V2 will have
  6557. * - relative time-stamp.
  6558. * - ASM_ABSOLUTEIMESTAMP -- ASM_DATA_EVENT_READ_DONE_V2 will
  6559. * - have absolute time-stamp.
  6560. *
  6561. * - Use #ASM_BIT_MASKIMESTAMPYPE_FLAG as the bitmask and
  6562. * #ASM_SHIFTIMESTAMPYPE_FLAG as the shift value for this bit.
  6563. *
  6564. * All other bits are reserved; clients must set them to zero.
  6565. */
  6566. u32 src_endpointype;
  6567. /* Specifies the endpoint providing the input samples.
  6568. * Supported values:
  6569. * - 0 -- Device matrix
  6570. * - All other values are reserved; clients must set them to zero.
  6571. * Otherwise, an error is returned.
  6572. * The device matrix is the gateway from the tunneled Tx ports.
  6573. */
  6574. u32 preprocopo_id;
  6575. /* Specifies the topology (order of processing) of preprocessing
  6576. * algorithms. <i>None</i> means no preprocessing.
  6577. * Supported values:
  6578. * - #ASM_STREAM_PREPROCOPO_ID_DEFAULT
  6579. * - #ASM_STREAM_PREPROCOPO_ID_NONE
  6580. *
  6581. * This field can also be enabled through SetParams flags.
  6582. */
  6583. u32 enc_cfg_id;
  6584. /* Media configuration ID for encoded output.
  6585. * Supported values:
  6586. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2
  6587. * - #ASM_MEDIA_FMT_AAC_V2
  6588. * - #ASM_MEDIA_FMT_AMRNB_FS
  6589. * - #ASM_MEDIA_FMT_AMRWB_FS
  6590. * - #ASM_MEDIA_FMT_V13K_FS
  6591. * - #ASM_MEDIA_FMT_EVRC_FS
  6592. * - #ASM_MEDIA_FMT_EVRCB_FS
  6593. * - #ASM_MEDIA_FMT_EVRCWB_FS
  6594. * - #ASM_MEDIA_FMT_SBC
  6595. * - #ASM_MEDIA_FMT_G711_ALAW_FS
  6596. * - #ASM_MEDIA_FMT_G711_MLAW_FS
  6597. * - #ASM_MEDIA_FMT_G729A_FS
  6598. * - #ASM_MEDIA_FMT_EXAMPLE
  6599. * - #ASM_MEDIA_FMT_WMA_V8
  6600. */
  6601. u16 bits_per_sample;
  6602. /* Number of bits per sample processed by ASM modules.
  6603. * Supported values: 16 and 24 bits per sample
  6604. */
  6605. u16 reserved;
  6606. /* Reserved for future use. This field must be set to zero.*/
  6607. } __packed;
  6608. #define ASM_POPP_OUTPUT_SR_NATIVE_RATE 0
  6609. /* Enumeration for the maximum sampling rate at the POPP output.*/
  6610. #define ASM_POPP_OUTPUT_SR_MAX_RATE 48000
  6611. #define ASM_STREAM_CMD_OPEN_READWRITE_V2 0x00010D8D
  6612. #define ASM_STREAM_CMD_OPEN_READWRITE_V2 0x00010D8D
  6613. struct asm_stream_cmd_open_readwrite_v2 {
  6614. struct apr_hdr hdr;
  6615. u32 mode_flags;
  6616. /* Mode flags.
  6617. * Supported values for bit 2:
  6618. * - 0 -- SR/CM change notification event is disabled.
  6619. * - 1 -- SR/CM change notification event is enabled. Use
  6620. * #ASM_BIT_MASK_SR_CM_CHANGE_NOTIFY_FLAG and
  6621. * #ASM_SHIFT_SR_CM_CHANGE_NOTIFY_FLAG to set or
  6622. * getting this flag.
  6623. *
  6624. * Supported values for bit 4:
  6625. * - 0 -- Return read data buffer contains all encoded frames only; it
  6626. * does not contain frame metadata.
  6627. * - 1 -- Return read data buffer contains an array of metadata and
  6628. * encoded frames.
  6629. *
  6630. * All other bits are reserved; clients must set them to zero.
  6631. */
  6632. u32 postprocopo_id;
  6633. /* Specifies the topology (order of processing) of postprocessing
  6634. * algorithms. <i>None</i> means no postprocessing.
  6635. *
  6636. * Supported values:
  6637. * - #ASM_STREAM_POSTPROCOPO_ID_DEFAULT
  6638. * - #ASM_STREAM_POSTPROCOPO_ID_MCH_PEAK_VOL
  6639. * - #ASM_STREAM_POSTPROCOPO_ID_NONE
  6640. */
  6641. u32 dec_fmt_id;
  6642. /* Specifies the media type of the input data. PCM indicates that
  6643. * no decoding must be performed, e.g., this is an NT encoder
  6644. * session.
  6645. * Supported values:
  6646. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2
  6647. * - #ASM_MEDIA_FMT_ADPCM
  6648. * - #ASM_MEDIA_FMT_MP3
  6649. * - #ASM_MEDIA_FMT_AAC_V2
  6650. * - #ASM_MEDIA_FMT_DOLBY_AAC
  6651. * - #ASM_MEDIA_FMT_AMRNB_FS
  6652. * - #ASM_MEDIA_FMT_AMRWB_FS
  6653. * - #ASM_MEDIA_FMT_V13K_FS
  6654. * - #ASM_MEDIA_FMT_EVRC_FS
  6655. * - #ASM_MEDIA_FMT_EVRCB_FS
  6656. * - #ASM_MEDIA_FMT_EVRCWB_FS
  6657. * - #ASM_MEDIA_FMT_SBC
  6658. * - #ASM_MEDIA_FMT_WMA_V10PRO_V2
  6659. * - #ASM_MEDIA_FMT_WMA_V9_V2
  6660. * - #ASM_MEDIA_FMT_AMR_WB_PLUS_V2
  6661. * - #ASM_MEDIA_FMT_AC3
  6662. * - #ASM_MEDIA_FMT_G711_ALAW_FS
  6663. * - #ASM_MEDIA_FMT_G711_MLAW_FS
  6664. * - #ASM_MEDIA_FMT_G729A_FS
  6665. * - #ASM_MEDIA_FMT_EXAMPLE
  6666. */
  6667. u32 enc_cfg_id;
  6668. /* Specifies the media type for the output of the stream. PCM
  6669. * indicates that no encoding must be performed, e.g., this is an NT
  6670. * decoder session.
  6671. * Supported values:
  6672. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2
  6673. * - #ASM_MEDIA_FMT_AAC_V2
  6674. * - #ASM_MEDIA_FMT_AMRNB_FS
  6675. * - #ASM_MEDIA_FMT_AMRWB_FS
  6676. * - #ASM_MEDIA_FMT_V13K_FS
  6677. * - #ASM_MEDIA_FMT_EVRC_FS
  6678. * - #ASM_MEDIA_FMT_EVRCB_FS
  6679. * - #ASM_MEDIA_FMT_EVRCWB_FS
  6680. * - #ASM_MEDIA_FMT_SBC
  6681. * - #ASM_MEDIA_FMT_G711_ALAW_FS
  6682. * - #ASM_MEDIA_FMT_G711_MLAW_FS
  6683. * - #ASM_MEDIA_FMT_G729A_FS
  6684. * - #ASM_MEDIA_FMT_EXAMPLE
  6685. * - #ASM_MEDIA_FMT_WMA_V8
  6686. */
  6687. u16 bits_per_sample;
  6688. /* Number of bits per sample processed by ASM modules.
  6689. * Supported values: 16 and 24 bits per sample
  6690. */
  6691. u16 reserved;
  6692. /* Reserved for future use. This field must be set to zero.*/
  6693. } __packed;
  6694. #define ASM_STREAM_CMD_OPEN_LOOPBACK_V2 0x00010D8E
  6695. struct asm_stream_cmd_open_loopback_v2 {
  6696. struct apr_hdr hdr;
  6697. u32 mode_flags;
  6698. /* Mode flags.
  6699. * Bit 0-31: reserved; client should set these bits to 0
  6700. */
  6701. u16 src_endpointype;
  6702. /* Endpoint type. 0 = Tx Matrix */
  6703. u16 sink_endpointype;
  6704. /* Endpoint type. 0 = Rx Matrix */
  6705. u32 postprocopo_id;
  6706. /* Postprocessor topology ID. Specifies the topology of
  6707. * postprocessing algorithms.
  6708. */
  6709. u16 bits_per_sample;
  6710. /* The number of bits per sample processed by ASM modules
  6711. * Supported values: 16 and 24 bits per sample
  6712. */
  6713. u16 reserved;
  6714. /* Reserved for future use. This field must be set to zero. */
  6715. } __packed;
  6716. #define ASM_STREAM_CMD_OPEN_TRANSCODE_LOOPBACK 0x00010DBA
  6717. /* Bitmask for the stream's Performance mode. */
  6718. #define ASM_BIT_MASK_STREAM_PERF_MODE_FLAG_IN_OPEN_TRANSCODE_LOOPBACK \
  6719. (0x70000000UL)
  6720. /* Bit shift for the stream's Performance mode. */
  6721. #define ASM_SHIFT_STREAM_PERF_MODE_FLAG_IN_OPEN_TRANSCODE_LOOPBACK 28
  6722. /* Bitmask for the decoder converter enable flag. */
  6723. #define ASM_BIT_MASK_DECODER_CONVERTER_FLAG (0x00000078UL)
  6724. /* Shift value for the decoder converter enable flag. */
  6725. #define ASM_SHIFT_DECODER_CONVERTER_FLAG 3
  6726. /* Converter mode is None (Default). */
  6727. #define ASM_CONVERTER_MODE_NONE 0
  6728. /* Converter mode is DDP-to-DD. */
  6729. #define ASM_DDP_DD_CONVERTER_MODE 1
  6730. /* Identifies a special converter mode where source and sink formats
  6731. * are the same but postprocessing must applied. Therefore, Decode
  6732. * @rarrow Re-encode is necessary.
  6733. */
  6734. #define ASM_POST_PROCESS_CONVERTER_MODE 2
  6735. struct asm_stream_cmd_open_transcode_loopback_t {
  6736. struct apr_hdr hdr;
  6737. u32 mode_flags;
  6738. /* Mode Flags specifies the performance mode in which this stream
  6739. * is to be opened.
  6740. * Supported values{for bits 30 to 28}(stream_perf_mode flag)
  6741. *
  6742. * #ASM_LEGACY_STREAM_SESSION -- This mode ensures backward
  6743. * compatibility to the original behavior
  6744. * of ASM_STREAM_CMD_OPEN_TRANSCODE_LOOPBACK
  6745. *
  6746. * #ASM_LOW_LATENCY_STREAM_SESSION -- Opens a loopback session by using
  6747. * shortened buffers in low latency POPP
  6748. * - Recommendation: Do not enable high latency algorithms. They might
  6749. * negate the benefits of opening a low latency stream, and they
  6750. * might also suffer quality degradation from unexpected jitter.
  6751. * - This Low Latency mode is supported only for PCM In and PCM Out
  6752. * loopbacks. An error is returned if Low Latency mode is opened for
  6753. * other transcode loopback modes.
  6754. * - To configure this subfield, use
  6755. * ASM_BIT_MASK_STREAM_PERF_MODE_FLAG_IN_OPEN_TRANSCODE_LOOPBACK and
  6756. * ASM_SHIFT_STREAM_PERF_MODE_FLAG_IN_OPEN_TRANSCODE_LOOPBACK.
  6757. *
  6758. * Supported values{for bits 6 to 3} (decoder-converter compatibility)
  6759. * #ASM_CONVERTER_MODE_NONE (0x0) -- Default
  6760. * #ASM_DDP_DD_CONVERTER_MODE (0x1)
  6761. * #ASM_POST_PROCESS_CONVERTER_MODE (0x2)
  6762. * 0x3-0xF -- Reserved for future use
  6763. * - Use #ASM_BIT_MASK_DECODER_CONVERTER_FLAG and
  6764. * ASM_SHIFT_DECODER_CONVERTER_FLAG to set this bit
  6765. * All other bits are reserved; clients must set them to 0.
  6766. */
  6767. u32 src_format_id;
  6768. /* Specifies the media format of the input audio stream.
  6769. *
  6770. * Supported values
  6771. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2
  6772. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V3
  6773. * - #ASM_MEDIA_FMT_DTS
  6774. * - #ASM_MEDIA_FMT_EAC3_DEC
  6775. * - #ASM_MEDIA_FMT_EAC3
  6776. * - #ASM_MEDIA_FMT_AC3_DEC
  6777. * - #ASM_MEDIA_FMT_AC3
  6778. */
  6779. u32 sink_format_id;
  6780. /* Specifies the media format of the output stream.
  6781. *
  6782. * Supported values
  6783. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V2
  6784. * - #ASM_MEDIA_FMT_MULTI_CHANNEL_PCM_V3
  6785. * - #ASM_MEDIA_FMT_DTS (not supported in Low Latency mode)
  6786. * - #ASM_MEDIA_FMT_EAC3_DEC (not supported in Low Latency mode)
  6787. * - #ASM_MEDIA_FMT_EAC3 (not supported in Low Latency mode)
  6788. * - #ASM_MEDIA_FMT_AC3_DEC (not supported in Low Latency mode)
  6789. * - #ASM_MEDIA_FMT_AC3 (not supported in Low Latency mode)
  6790. */
  6791. u32 audproc_topo_id;
  6792. /* Postprocessing topology ID, which specifies the topology (order of
  6793. * processing) of postprocessing algorithms.
  6794. *
  6795. * Supported values
  6796. * - #ASM_STREAM_POSTPROC_TOPO_ID_DEFAULT
  6797. * - #ASM_STREAM_POSTPROC_TOPO_ID_PEAKMETER
  6798. * - #ASM_STREAM_POSTPROC_TOPO_ID_MCH_PEAK_VOL
  6799. * - #ASM_STREAM_POSTPROC_TOPO_ID_NONE
  6800. * Topologies can be added through #ASM_CMD_ADD_TOPOLOGIES.
  6801. * This field is ignored for the Converter mode, in which no
  6802. * postprocessing is performed.
  6803. */
  6804. u16 src_endpoint_type;
  6805. /* Specifies the source endpoint that provides the input samples.
  6806. *
  6807. * Supported values
  6808. * - 0 -- Tx device matrix or stream router (gateway to the hardware
  6809. * ports)
  6810. * - All other values are reserved
  6811. * Clients must set this field to 0. Otherwise, an error is returned.
  6812. */
  6813. u16 sink_endpoint_type;
  6814. /* Specifies the sink endpoint type.
  6815. *
  6816. * Supported values
  6817. * - 0 -- Rx device matrix or stream router (gateway to the hardware
  6818. * ports)
  6819. * - All other values are reserved
  6820. * Clients must set this field to 0. Otherwise, an error is returned.
  6821. */
  6822. u16 bits_per_sample;
  6823. /* Number of bits per sample processed by the ASM modules.
  6824. * Supported values 16, 24
  6825. */
  6826. u16 reserved;
  6827. /* This field must be set to 0.
  6828. */
  6829. } __packed;
  6830. #define ASM_STREAM_CMD_CLOSE 0x00010BCD
  6831. #define ASM_STREAM_CMD_FLUSH 0x00010BCE
  6832. #define ASM_STREAM_CMD_FLUSH_READBUFS 0x00010C09
  6833. #define ASM_STREAM_CMD_SET_PP_PARAMS_V2 0x00010DA1
  6834. #define ASM_STREAM_CMD_SET_PP_PARAMS_V3 0x0001320D
  6835. /*
  6836. * Structure for the ASM Stream Set PP Params command. Parameter data must be
  6837. * pre-packed with the correct header for either V2 or V3 when sent in-band.
  6838. * Use q6core_pack_pp_params to pack the header and data correctly depending on
  6839. * Instance ID support.
  6840. */
  6841. struct asm_stream_cmd_set_pp_params {
  6842. /* APR Header */
  6843. struct apr_hdr apr_hdr;
  6844. /* The memory mapping header to be used when sending out of band */
  6845. struct mem_mapping_hdr mem_hdr;
  6846. /* The total size of the payload, including the parameter header */
  6847. u32 payload_size;
  6848. /* The parameter data to be filled when sent inband. Parameter data
  6849. * must be pre-packed with parameter header and then copied here. Use
  6850. * q6core_pack_pp_params to pack the header and param data correctly.
  6851. */
  6852. u32 param_data[0];
  6853. } __packed;
  6854. #define ASM_STREAM_CMD_GET_PP_PARAMS_V2 0x00010DA2
  6855. #define ASM_STREAM_CMD_GET_PP_PARAMS_V3 0x0001320E
  6856. struct asm_stream_cmd_get_pp_params_v2 {
  6857. u32 data_payload_addr_lsw;
  6858. /* LSW of the parameter data payload address. */
  6859. u32 data_payload_addr_msw;
  6860. /* MSW of the parameter data payload address.
  6861. * - Size of the shared memory, if specified, shall be large enough
  6862. * to contain the whole ParamData payload, including Module ID,
  6863. * Param ID, Param Size, and Param Values
  6864. * - Must be set to zero for in-band data
  6865. * - In the case of 32 bit Shared memory address, msw field must be
  6866. * set to zero.
  6867. * - In the case of 36 bit shared memory address, bit 31 to bit 4 of
  6868. * msw must be set to zero.
  6869. */
  6870. u32 mem_map_handle;
  6871. /* Supported Values: Any.
  6872. * memory map handle returned by DSP through ASM_CMD_SHARED_MEM_MAP_REGIONS
  6873. * command.
  6874. * if mmhandle is NULL, the ParamData payloads in the ACK are within the
  6875. * message payload (in-band).
  6876. * If mmhandle is non-NULL, the ParamData payloads in the ACK begin at the
  6877. * address specified in the address msw and lsw.
  6878. * (out-of-band).
  6879. */
  6880. u32 module_id;
  6881. /* Unique module ID. */
  6882. u32 param_id;
  6883. /* Unique parameter ID. */
  6884. u16 param_max_size;
  6885. /* Maximum data size of the module_id/param_id combination. This
  6886. * is a multiple of 4 bytes.
  6887. */
  6888. u16 reserved;
  6889. /* Reserved for backward compatibility. Clients must set this
  6890. * field to zero.
  6891. */
  6892. } __packed;
  6893. #define ASM_STREAM_CMD_SET_ENCDEC_PARAM 0x00010C10
  6894. #define ASM_STREAM_CMD_SET_ENCDEC_PARAM_V2 0x00013218
  6895. struct asm_stream_cmd_set_encdec_param_v2 {
  6896. u16 service_id;
  6897. /* 0 - ASM_ENCODER_SVC; 1 - ASM_DECODER_SVC */
  6898. u16 reserved;
  6899. u32 param_id;
  6900. /* ID of the parameter. */
  6901. u32 param_size;
  6902. /*
  6903. * Data size of this parameter, in bytes. The size is a multiple
  6904. * of 4 bytes.
  6905. */
  6906. } __packed;
  6907. #define ASM_STREAM_CMD_REGISTER_ENCDEC_EVENTS 0x00013219
  6908. #define ASM_STREAM_CMD_ENCDEC_EVENTS 0x0001321A
  6909. #define AVS_PARAM_ID_RTIC_SHARED_MEMORY_ADDR 0x00013237
  6910. struct avs_rtic_shared_mem_addr {
  6911. struct apr_hdr hdr;
  6912. struct asm_stream_cmd_set_encdec_param_v2 encdec;
  6913. u32 shm_buf_addr_lsw;
  6914. /* Lower 32 bit of the RTIC shared memory */
  6915. u32 shm_buf_addr_msw;
  6916. /* Upper 32 bit of the RTIC shared memory */
  6917. u32 buf_size;
  6918. /* Size of buffer */
  6919. u16 shm_buf_mem_pool_id;
  6920. /* ADSP_MEMORY_MAP_SHMEM8_4K_POOL */
  6921. u16 shm_buf_num_regions;
  6922. /* number of regions to map */
  6923. u32 shm_buf_flag;
  6924. /* buffer property flag */
  6925. struct avs_shared_map_region_payload map_region;
  6926. /* memory map region*/
  6927. } __packed;
  6928. #define AVS_PARAM_ID_RTIC_EVENT_ACK 0x00013238
  6929. struct avs_param_rtic_event_ack {
  6930. struct apr_hdr hdr;
  6931. struct asm_stream_cmd_set_encdec_param_v2 encdec;
  6932. } __packed;
  6933. #define ASM_PARAM_ID_ENCDEC_BITRATE 0x00010C13
  6934. struct asm_bitrate_param {
  6935. u32 bitrate;
  6936. /* Maximum supported bitrate. Only the AAC encoder is supported.*/
  6937. } __packed;
  6938. #define ASM_PARAM_ID_ENCDEC_ENC_CFG_BLK_V2 0x00010DA3
  6939. #define ASM_PARAM_ID_AAC_SBR_PS_FLAG 0x00010C63
  6940. /* Flag to turn off both SBR and PS processing, if they are
  6941. * present in the bitstream.
  6942. */
  6943. #define ASM_AAC_SBR_OFF_PS_OFF (2)
  6944. /* Flag to turn on SBR but turn off PS processing,if they are
  6945. * present in the bitstream.
  6946. */
  6947. #define ASM_AAC_SBR_ON_PS_OFF (1)
  6948. /* Flag to turn on both SBR and PS processing, if they are
  6949. * present in the bitstream (default behavior).
  6950. */
  6951. #define ASM_AAC_SBR_ON_PS_ON (0)
  6952. /* Structure for an AAC SBR PS processing flag. */
  6953. /* Payload of the #ASM_PARAM_ID_AAC_SBR_PS_FLAG parameter in the
  6954. * #ASM_STREAM_CMD_SET_ENCDEC_PARAM command.
  6955. */
  6956. struct asm_aac_sbr_ps_flag_param {
  6957. struct apr_hdr hdr;
  6958. struct asm_stream_cmd_set_encdec_param encdec;
  6959. struct asm_enc_cfg_blk_param_v2 encblk;
  6960. u32 sbr_ps_flag;
  6961. /* Control parameter to enable or disable SBR/PS processing in
  6962. * the AAC bitstream. Use the following macros to set this field:
  6963. * - #ASM_AAC_SBR_OFF_PS_OFF -- Turn off both SBR and PS
  6964. * processing, if they are present in the bitstream.
  6965. * - #ASM_AAC_SBR_ON_PS_OFF -- Turn on SBR processing, but not PS
  6966. * processing, if they are present in the bitstream.
  6967. * - #ASM_AAC_SBR_ON_PS_ON -- Turn on both SBR and PS processing,
  6968. * if they are present in the bitstream (default behavior).
  6969. * - All other values are invalid.
  6970. * Changes are applied to the next decoded frame.
  6971. */
  6972. } __packed;
  6973. #define ASM_PARAM_ID_AAC_DUAL_MONO_MAPPING 0x00010C64
  6974. /* First single channel element in a dual mono bitstream.*/
  6975. #define ASM_AAC_DUAL_MONO_MAP_SCE_1 (1)
  6976. /* Second single channel element in a dual mono bitstream.*/
  6977. #define ASM_AAC_DUAL_MONO_MAP_SCE_2 (2)
  6978. /* Structure for AAC decoder dual mono channel mapping. */
  6979. struct asm_aac_dual_mono_mapping_param {
  6980. struct apr_hdr hdr;
  6981. struct asm_stream_cmd_set_encdec_param encdec;
  6982. u16 left_channel_sce;
  6983. u16 right_channel_sce;
  6984. } __packed;
  6985. #define ASM_STREAM_CMDRSP_GET_PP_PARAMS_V2 0x00010DA4
  6986. #define ASM_STREAM_CMDRSP_GET_PP_PARAMS_V3 0x0001320F
  6987. struct asm_stream_cmdrsp_get_pp_params_v2 {
  6988. u32 status;
  6989. } __packed;
  6990. #define ASM_PARAM_ID_AC3_KARAOKE_MODE 0x00010D73
  6991. /* Enumeration for both vocals in a karaoke stream.*/
  6992. #define AC3_KARAOKE_MODE_NO_VOCAL (0)
  6993. /* Enumeration for only the left vocal in a karaoke stream.*/
  6994. #define AC3_KARAOKE_MODE_LEFT_VOCAL (1)
  6995. /* Enumeration for only the right vocal in a karaoke stream.*/
  6996. #define AC3_KARAOKE_MODE_RIGHT_VOCAL (2)
  6997. /* Enumeration for both vocal channels in a karaoke stream.*/
  6998. #define AC3_KARAOKE_MODE_BOTH_VOCAL (3)
  6999. #define ASM_PARAM_ID_AC3_DRC_MODE 0x00010D74
  7000. /* Enumeration for the Custom Analog mode.*/
  7001. #define AC3_DRC_MODE_CUSTOM_ANALOG (0)
  7002. /* Enumeration for the Custom Digital mode.*/
  7003. #define AC3_DRC_MODE_CUSTOM_DIGITAL (1)
  7004. /* Enumeration for the Line Out mode (light compression).*/
  7005. #define AC3_DRC_MODE_LINE_OUT (2)
  7006. /* Enumeration for the RF remodulation mode (heavy compression).*/
  7007. #define AC3_DRC_MODE_RF_REMOD (3)
  7008. #define ASM_PARAM_ID_AC3_DUAL_MONO_MODE 0x00010D75
  7009. /* Enumeration for playing dual mono in stereo mode.*/
  7010. #define AC3_DUAL_MONO_MODE_STEREO (0)
  7011. /* Enumeration for playing left mono.*/
  7012. #define AC3_DUAL_MONO_MODE_LEFT_MONO (1)
  7013. /* Enumeration for playing right mono.*/
  7014. #define AC3_DUAL_MONO_MODE_RIGHT_MONO (2)
  7015. /* Enumeration for mixing both dual mono channels and playing them.*/
  7016. #define AC3_DUAL_MONO_MODE_MIXED_MONO (3)
  7017. #define ASM_PARAM_ID_AC3_STEREO_DOWNMIX_MODE 0x00010D76
  7018. /* Enumeration for using the Downmix mode indicated in the bitstream. */
  7019. #define AC3_STEREO_DOWNMIX_MODE_AUTO_DETECT (0)
  7020. /* Enumeration for Surround Compatible mode (preserves the
  7021. * surround information).
  7022. */
  7023. #define AC3_STEREO_DOWNMIX_MODE_LT_RT (1)
  7024. /* Enumeration for Mono Compatible mode (if the output is to be
  7025. * further downmixed to mono).
  7026. */
  7027. #define AC3_STEREO_DOWNMIX_MODE_LO_RO (2)
  7028. /* ID of the AC3 PCM scale factor parameter in the
  7029. * #ASM_STREAM_CMD_SET_ENCDEC_PARAM command.
  7030. */
  7031. #define ASM_PARAM_ID_AC3_PCM_SCALEFACTOR 0x00010D78
  7032. /* ID of the AC3 DRC boost scale factor parameter in the
  7033. * #ASM_STREAM_CMD_SET_ENCDEC_PARAM command.
  7034. */
  7035. #define ASM_PARAM_ID_AC3_DRC_BOOST_SCALEFACTOR 0x00010D79
  7036. /* ID of the AC3 DRC cut scale factor parameter in the
  7037. * #ASM_STREAM_CMD_SET_ENCDEC_PARAM command.
  7038. */
  7039. #define ASM_PARAM_ID_AC3_DRC_CUT_SCALEFACTOR 0x00010D7A
  7040. /* Structure for AC3 Generic Parameter. */
  7041. /* Payload of the AC3 parameters in the
  7042. * #ASM_STREAM_CMD_SET_ENCDEC_PARAM command.
  7043. */
  7044. struct asm_ac3_generic_param {
  7045. struct apr_hdr hdr;
  7046. struct asm_stream_cmd_set_encdec_param encdec;
  7047. struct asm_enc_cfg_blk_param_v2 encblk;
  7048. u32 generic_parameter;
  7049. /* AC3 generic parameter. Select from one of the following
  7050. * possible values.
  7051. *
  7052. * For #ASM_PARAM_ID_AC3_KARAOKE_MODE, supported values are:
  7053. * - AC3_KARAOKE_MODE_NO_VOCAL
  7054. * - AC3_KARAOKE_MODE_LEFT_VOCAL
  7055. * - AC3_KARAOKE_MODE_RIGHT_VOCAL
  7056. * - AC3_KARAOKE_MODE_BOTH_VOCAL
  7057. *
  7058. * For #ASM_PARAM_ID_AC3_DRC_MODE, supported values are:
  7059. * - AC3_DRC_MODE_CUSTOM_ANALOG
  7060. * - AC3_DRC_MODE_CUSTOM_DIGITAL
  7061. * - AC3_DRC_MODE_LINE_OUT
  7062. * - AC3_DRC_MODE_RF_REMOD
  7063. *
  7064. * For #ASM_PARAM_ID_AC3_DUAL_MONO_MODE, supported values are:
  7065. * - AC3_DUAL_MONO_MODE_STEREO
  7066. * - AC3_DUAL_MONO_MODE_LEFT_MONO
  7067. * - AC3_DUAL_MONO_MODE_RIGHT_MONO
  7068. * - AC3_DUAL_MONO_MODE_MIXED_MONO
  7069. *
  7070. * For #ASM_PARAM_ID_AC3_STEREO_DOWNMIX_MODE, supported values are:
  7071. * - AC3_STEREO_DOWNMIX_MODE_AUTO_DETECT
  7072. * - AC3_STEREO_DOWNMIX_MODE_LT_RT
  7073. * - AC3_STEREO_DOWNMIX_MODE_LO_RO
  7074. *
  7075. * For #ASM_PARAM_ID_AC3_PCM_SCALEFACTOR, supported values are
  7076. * 0 to 1 in Q31 format.
  7077. *
  7078. * For #ASM_PARAM_ID_AC3_DRC_BOOST_SCALEFACTOR, supported values are
  7079. * 0 to 1 in Q31 format.
  7080. *
  7081. * For #ASM_PARAM_ID_AC3_DRC_CUT_SCALEFACTOR, supported values are
  7082. * 0 to 1 in Q31 format.
  7083. */
  7084. } __packed;
  7085. /* Enumeration for Raw mode (no downmixing), which specifies
  7086. * that all channels in the bitstream are to be played out as is
  7087. * without any downmixing. (Default)
  7088. */
  7089. #define WMAPRO_CHANNEL_MASK_RAW (-1)
  7090. /* Enumeration for setting the channel mask to 0. The 7.1 mode
  7091. * (Home Theater) is assigned.
  7092. */
  7093. #define WMAPRO_CHANNEL_MASK_ZERO 0x0000
  7094. /* Speaker layout mask for one channel (Home Theater, mono).
  7095. * - Speaker front center
  7096. */
  7097. #define WMAPRO_CHANNEL_MASK_1_C 0x0004
  7098. /* Speaker layout mask for two channels (Home Theater, stereo).
  7099. * - Speaker front left
  7100. * - Speaker front right
  7101. */
  7102. #define WMAPRO_CHANNEL_MASK_2_L_R 0x0003
  7103. /* Speaker layout mask for three channels (Home Theater).
  7104. * - Speaker front left
  7105. * - Speaker front right
  7106. * - Speaker front center
  7107. */
  7108. #define WMAPRO_CHANNEL_MASK_3_L_C_R 0x0007
  7109. /* Speaker layout mask for two channels (stereo).
  7110. * - Speaker back left
  7111. * - Speaker back right
  7112. */
  7113. #define WMAPRO_CHANNEL_MASK_2_Bl_Br 0x0030
  7114. /* Speaker layout mask for four channels.
  7115. * - Speaker front left
  7116. * - Speaker front right
  7117. * - Speaker back left
  7118. * - Speaker back right
  7119. */
  7120. #define WMAPRO_CHANNEL_MASK_4_L_R_Bl_Br 0x0033
  7121. /* Speaker layout mask for four channels (Home Theater).
  7122. * - Speaker front left
  7123. * - Speaker front right
  7124. * - Speaker front center
  7125. * - Speaker back center
  7126. */
  7127. #define WMAPRO_CHANNEL_MASK_4_L_R_C_Bc_HT 0x0107
  7128. /* Speaker layout mask for five channels.
  7129. * - Speaker front left
  7130. * - Speaker front right
  7131. * - Speaker front center
  7132. * - Speaker back left
  7133. * - Speaker back right
  7134. */
  7135. #define WMAPRO_CHANNEL_MASK_5_L_C_R_Bl_Br 0x0037
  7136. /* Speaker layout mask for five channels (5 mode, Home Theater).
  7137. * - Speaker front left
  7138. * - Speaker front right
  7139. * - Speaker front center
  7140. * - Speaker side left
  7141. * - Speaker side right
  7142. */
  7143. #define WMAPRO_CHANNEL_MASK_5_L_C_R_Sl_Sr_HT 0x0607
  7144. /* Speaker layout mask for six channels (5.1 mode).
  7145. * - Speaker front left
  7146. * - Speaker front right
  7147. * - Speaker front center
  7148. * - Speaker low frequency
  7149. * - Speaker back left
  7150. * - Speaker back right
  7151. */
  7152. #define WMAPRO_CHANNEL_MASK_5DOT1_L_C_R_Bl_Br_SLF 0x003F
  7153. /* Speaker layout mask for six channels (5.1 mode, Home Theater).
  7154. * - Speaker front left
  7155. * - Speaker front right
  7156. * - Speaker front center
  7157. * - Speaker low frequency
  7158. * - Speaker side left
  7159. * - Speaker side right
  7160. */
  7161. #define WMAPRO_CHANNEL_MASK_5DOT1_L_C_R_Sl_Sr_SLF_HT 0x060F
  7162. /* Speaker layout mask for six channels (5.1 mode, no LFE).
  7163. * - Speaker front left
  7164. * - Speaker front right
  7165. * - Speaker front center
  7166. * - Speaker back left
  7167. * - Speaker back right
  7168. * - Speaker back center
  7169. */
  7170. #define WMAPRO_CHANNEL_MASK_5DOT1_L_C_R_Bl_Br_Bc 0x0137
  7171. /* Speaker layout mask for six channels (5.1 mode, Home Theater,
  7172. * no LFE).
  7173. * - Speaker front left
  7174. * - Speaker front right
  7175. * - Speaker front center
  7176. * - Speaker back center
  7177. * - Speaker side left
  7178. * - Speaker side right
  7179. */
  7180. #define WMAPRO_CHANNEL_MASK_5DOT1_L_C_R_Sl_Sr_Bc_HT 0x0707
  7181. /* Speaker layout mask for seven channels (6.1 mode).
  7182. * - Speaker front left
  7183. * - Speaker front right
  7184. * - Speaker front center
  7185. * - Speaker low frequency
  7186. * - Speaker back left
  7187. * - Speaker back right
  7188. * - Speaker back center
  7189. */
  7190. #define WMAPRO_CHANNEL_MASK_6DOT1_L_C_R_Bl_Br_Bc_SLF 0x013F
  7191. /* Speaker layout mask for seven channels (6.1 mode, Home
  7192. * Theater).
  7193. * - Speaker front left
  7194. * - Speaker front right
  7195. * - Speaker front center
  7196. * - Speaker low frequency
  7197. * - Speaker back center
  7198. * - Speaker side left
  7199. * - Speaker side right
  7200. */
  7201. #define WMAPRO_CHANNEL_MASK_6DOT1_L_C_R_Sl_Sr_Bc_SLF_HT 0x070F
  7202. /* Speaker layout mask for seven channels (6.1 mode, no LFE).
  7203. * - Speaker front left
  7204. * - Speaker front right
  7205. * - Speaker front center
  7206. * - Speaker back left
  7207. * - Speaker back right
  7208. * - Speaker front left of center
  7209. * - Speaker front right of center
  7210. */
  7211. #define WMAPRO_CHANNEL_MASK_6DOT1_L_C_R_Bl_Br_SFLOC_SFROC 0x00F7
  7212. /* Speaker layout mask for seven channels (6.1 mode, Home
  7213. * Theater, no LFE).
  7214. * - Speaker front left
  7215. * - Speaker front right
  7216. * - Speaker front center
  7217. * - Speaker side left
  7218. * - Speaker side right
  7219. * - Speaker front left of center
  7220. * - Speaker front right of center
  7221. */
  7222. #define WMAPRO_CHANNEL_MASK_6DOT1_L_C_R_Sl_Sr_SFLOC_SFROC_HT 0x0637
  7223. /* Speaker layout mask for eight channels (7.1 mode).
  7224. * - Speaker front left
  7225. * - Speaker front right
  7226. * - Speaker front center
  7227. * - Speaker back left
  7228. * - Speaker back right
  7229. * - Speaker low frequency
  7230. * - Speaker front left of center
  7231. * - Speaker front right of center
  7232. */
  7233. #define WMAPRO_CHANNEL_MASK_7DOT1_L_C_R_Bl_Br_SLF_SFLOC_SFROC \
  7234. 0x00FF
  7235. /* Speaker layout mask for eight channels (7.1 mode, Home Theater).
  7236. * - Speaker front left
  7237. * - Speaker front right
  7238. * - Speaker front center
  7239. * - Speaker side left
  7240. * - Speaker side right
  7241. * - Speaker low frequency
  7242. * - Speaker front left of center
  7243. * - Speaker front right of center
  7244. *
  7245. */
  7246. #define WMAPRO_CHANNEL_MASK_7DOT1_L_C_R_Sl_Sr_SLF_SFLOC_SFROC_HT \
  7247. 0x063F
  7248. #define ASM_PARAM_ID_DEC_OUTPUT_CHAN_MAP 0x00010D82
  7249. /* Maximum number of decoder output channels. */
  7250. #define MAX_CHAN_MAP_CHANNELS 16
  7251. /* Structure for decoder output channel mapping. */
  7252. /* Payload of the #ASM_PARAM_ID_DEC_OUTPUT_CHAN_MAP parameter in the
  7253. * #ASM_STREAM_CMD_SET_ENCDEC_PARAM command.
  7254. */
  7255. struct asm_dec_out_chan_map_param {
  7256. struct apr_hdr hdr;
  7257. struct asm_stream_cmd_set_encdec_param encdec;
  7258. u32 num_channels;
  7259. /* Number of decoder output channels.
  7260. * Supported values: 0 to #MAX_CHAN_MAP_CHANNELS
  7261. *
  7262. * A value of 0 indicates native channel mapping, which is valid
  7263. * only for NT mode. This means the output of the decoder is to be
  7264. * preserved as is.
  7265. */
  7266. u8 channel_mapping[MAX_CHAN_MAP_CHANNELS];
  7267. } __packed;
  7268. #define ASM_STREAM_CMD_OPEN_WRITE_COMPRESSED 0x00010D84
  7269. /* Bitmask for the IEC 61937 enable flag.*/
  7270. #define ASM_BIT_MASK_IEC_61937_STREAM_FLAG (0x00000001UL)
  7271. /* Shift value for the IEC 61937 enable flag.*/
  7272. #define ASM_SHIFT_IEC_61937_STREAM_FLAG 0
  7273. /* Bitmask for the IEC 60958 enable flag.*/
  7274. #define ASM_BIT_MASK_IEC_60958_STREAM_FLAG (0x00000002UL)
  7275. /* Shift value for the IEC 60958 enable flag.*/
  7276. #define ASM_SHIFT_IEC_60958_STREAM_FLAG 1
  7277. /* Payload format for open write compressed command */
  7278. /* Payload format for the #ASM_STREAM_CMD_OPEN_WRITE_COMPRESSED
  7279. * command, which opens a stream for a given session ID and stream ID
  7280. * to be rendered in the compressed format.
  7281. */
  7282. struct asm_stream_cmd_open_write_compressed {
  7283. struct apr_hdr hdr;
  7284. u32 flags;
  7285. /* Mode flags that configure the stream for a specific format.
  7286. * Supported values:
  7287. * - Bit 0 -- IEC 61937 compatibility
  7288. * - 0 -- Stream is not in IEC 61937 format
  7289. * - 1 -- Stream is in IEC 61937 format
  7290. * - Bit 1 -- IEC 60958 compatibility
  7291. * - 0 -- Stream is not in IEC 60958 format
  7292. * - 1 -- Stream is in IEC 60958 format
  7293. * - Bits 2 to 31 -- 0 (Reserved)
  7294. *
  7295. * For the same stream, bit 0 cannot be set to 0 and bit 1 cannot
  7296. * be set to 1. A compressed stream connot have IEC 60958
  7297. * packetization applied without IEC 61937 packetization.
  7298. * @note1hang Currently, IEC 60958 packetized input streams are not
  7299. * supported.
  7300. */
  7301. u32 fmt_id;
  7302. /* Specifies the media type of the HDMI stream to be opened.
  7303. * Supported values:
  7304. * - #ASM_MEDIA_FMT_AC3
  7305. * - #ASM_MEDIA_FMT_EAC3
  7306. * - #ASM_MEDIA_FMT_DTS
  7307. * - #ASM_MEDIA_FMT_ATRAC
  7308. * - #ASM_MEDIA_FMT_MAT
  7309. *
  7310. * @note1hang This field must be set to a valid media type even if
  7311. * IEC 61937 packetization is not performed by the aDSP.
  7312. */
  7313. } __packed;
  7314. /* Indicates the number of samples per channel to be removed from the
  7315. * beginning of the stream.
  7316. */
  7317. #define ASM_DATA_CMD_REMOVE_INITIAL_SILENCE 0x00010D67
  7318. /* Indicates the number of samples per channel to be removed from
  7319. * the end of the stream.
  7320. */
  7321. #define ASM_DATA_CMD_REMOVE_TRAILING_SILENCE 0x00010D68
  7322. struct asm_data_cmd_remove_silence {
  7323. struct apr_hdr hdr;
  7324. u32 num_samples_to_remove;
  7325. /* < Number of samples per channel to be removed.
  7326. * @values 0 to (2@sscr{32}-1)
  7327. */
  7328. } __packed;
  7329. #define ASM_STREAM_CMD_OPEN_READ_COMPRESSED 0x00010D95
  7330. /* Bitmask for the IEC 61937 to 61937 pass-through capture. */
  7331. #define ASM_BIT_MASK_IEC_61937_PASS_THROUGH_FLAG (0x00000001UL)
  7332. /* Shift value for the IEC 61937 to 61937 pass-through capture. */
  7333. #define ASM_SHIFT_IEC_61937_PASS_THROUGH_FLAG 0
  7334. struct asm_stream_cmd_open_read_compressed {
  7335. struct apr_hdr hdr;
  7336. u32 mode_flags;
  7337. /* Mode flags that indicate whether meta information per encoded
  7338. * frame is to be provided and packaging.
  7339. * Supported values for bit 0: (IEC 61937 pass-through mode)
  7340. * - 0 -- Unpack the IEC 61937 format stream to RAW compressed format
  7341. * - 1 -- Pass-through transfer of the IEC 61937 format stream
  7342. * - Use #ASM_BIT_MASK_IEC_61937_PASS_THROUGH_FLAG to set the bitmask
  7343. * and #ASM_SHIFT_IEC_61937_PASS_THROUGH_FLAG to set the shift value
  7344. * for this bit.
  7345. * Supported values for bit 4:
  7346. * - 0 -- Return data buffer contains all encoded frames only; it does
  7347. * not contain frame metadata.
  7348. * - 1 -- Return data buffer contains an array of metadata and encoded
  7349. * frames.
  7350. * - Use #ASM_BIT_MASK_META_INFO_FLAG to set the bitmask and
  7351. * #ASM_SHIFT_META_INFO_FLAG to set the shift value for this bit.
  7352. * All other bits are reserved; clients must set them to zero.
  7353. */
  7354. u32 frames_per_buf;
  7355. /* Indicates the number of frames that need to be returned per
  7356. * read buffer
  7357. * Supported values: should be greater than 0 for IEC to RAW compressed
  7358. * unpack mode.
  7359. * Value is don't care for IEC 61937 pass-through mode.
  7360. */
  7361. } __packed;
  7362. /* adsp_asm_stream_commands.h*/
  7363. /* adsp_asm_api.h (no changes)*/
  7364. #define ASM_STREAM_POSTPROCOPO_ID_DEFAULT \
  7365. 0x00010BE4
  7366. #define ASM_STREAM_POSTPROCOPO_ID_PEAKMETER \
  7367. 0x00010D83
  7368. #define ASM_STREAM_POSTPROCOPO_ID_NONE \
  7369. 0x00010C68
  7370. #define ASM_STREAM_POSTPROCOPO_ID_MCH_PEAK_VOL \
  7371. 0x00010D8B
  7372. #define ASM_STREAM_PREPROCOPO_ID_DEFAULT \
  7373. ASM_STREAM_POSTPROCOPO_ID_DEFAULT
  7374. #define ASM_STREAM_PREPROCOPO_ID_NONE \
  7375. ASM_STREAM_POSTPROCOPO_ID_NONE
  7376. #define ADM_CMD_COPP_OPENOPOLOGY_ID_NONE_AUDIO_COPP \
  7377. 0x00010312
  7378. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_MONO_AUDIO_COPP \
  7379. 0x00010313
  7380. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_STEREO_AUDIO_COPP \
  7381. 0x00010314
  7382. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_STEREO_IIR_AUDIO_COPP\
  7383. 0x00010704
  7384. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_MONO_AUDIO_COPP_MBDRCV2\
  7385. 0x0001070D
  7386. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_STEREO_AUDIO_COPP_MBDRCV2\
  7387. 0x0001070E
  7388. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_STEREO_IIR_AUDIO_COPP_MBDRCV2\
  7389. 0x0001070F
  7390. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_STEREO_AUDIO_COPP_MBDRC_V3 \
  7391. 0x11000000
  7392. #define ADM_CMD_COPP_OPENOPOLOGY_ID_SPEAKER_MCH_PEAK_VOL \
  7393. 0x0001031B
  7394. #define ADM_CMD_COPP_OPENOPOLOGY_ID_MIC_MONO_AUDIO_COPP 0x00010315
  7395. #define ADM_CMD_COPP_OPENOPOLOGY_ID_MIC_STEREO_AUDIO_COPP 0x00010316
  7396. #define AUDPROC_COPPOPOLOGY_ID_MCHAN_IIR_AUDIO 0x00010715
  7397. #define ADM_CMD_COPP_OPENOPOLOGY_ID_DEFAULT_AUDIO_COPP 0x00010BE3
  7398. #define ADM_CMD_COPP_OPENOPOLOGY_ID_PEAKMETER_AUDIO_COPP 0x00010317
  7399. #define AUDPROC_MODULE_ID_AIG 0x00010716
  7400. #define AUDPROC_PARAM_ID_AIG_ENABLE 0x00010717
  7401. #define AUDPROC_PARAM_ID_AIG_CONFIG 0x00010718
  7402. struct Audio_AigParam {
  7403. uint16_t mode;
  7404. /*< Mode word for enabling AIG/SIG mode .
  7405. * Byte offset: 0
  7406. */
  7407. int16_t staticGainL16Q12;
  7408. /*< Static input gain when aigMode is set to 1.
  7409. * Byte offset: 2
  7410. */
  7411. int16_t initialGainDBL16Q7;
  7412. /*<Initial value that the adaptive gain update starts from dB
  7413. * Q7 Byte offset: 4
  7414. */
  7415. int16_t idealRMSDBL16Q7;
  7416. /*<Average RMS level that AIG attempts to achieve Q8.7
  7417. * Byte offset: 6
  7418. */
  7419. int32_t noiseGateL32;
  7420. /*Threshold below which signal is considered as noise and AIG
  7421. * Byte offset: 8
  7422. */
  7423. int32_t minGainL32Q15;
  7424. /*Minimum gain that can be provided by AIG Q16.15
  7425. * Byte offset: 12
  7426. */
  7427. int32_t maxGainL32Q15;
  7428. /*Maximum gain that can be provided by AIG Q16.15
  7429. * Byte offset: 16
  7430. */
  7431. uint32_t gainAtRtUL32Q31;
  7432. /*Attack/release time for AIG update Q1.31
  7433. * Byte offset: 20
  7434. */
  7435. uint32_t longGainAtRtUL32Q31;
  7436. /*Long attack/release time while updating gain for
  7437. * noise/silence Q1.31 Byte offset: 24
  7438. */
  7439. uint32_t rmsTavUL32Q32;
  7440. /* RMS smoothing time constant used for long-term RMS estimate
  7441. * Q0.32 Byte offset: 28
  7442. */
  7443. uint32_t gainUpdateStartTimMsUL32Q0;
  7444. /* The waiting time before which AIG starts to apply adaptive
  7445. * gain update Q32.0 Byte offset: 32
  7446. */
  7447. } __packed;
  7448. #define ADM_MODULE_ID_EANS 0x00010C4A
  7449. #define ADM_PARAM_ID_EANS_ENABLE 0x00010C4B
  7450. #define ADM_PARAM_ID_EANS_PARAMS 0x00010C4C
  7451. struct adm_eans_enable {
  7452. uint32_t enable_flag;
  7453. /*< Specifies whether EANS is disabled (0) or enabled
  7454. * (nonzero).
  7455. * This is supported only for sampling rates of 8, 12, 16, 24, 32,
  7456. * and 48 kHz. It is not supported for sampling rates of 11.025,
  7457. * 22.05, or 44.1 kHz.
  7458. */
  7459. } __packed;
  7460. struct adm_eans_params {
  7461. int16_t eans_mode;
  7462. /*< Mode word for enabling/disabling submodules.
  7463. * Byte offset: 0
  7464. */
  7465. int16_t eans_input_gain;
  7466. /*< Q2.13 input gain to the EANS module.
  7467. * Byte offset: 2
  7468. */
  7469. int16_t eans_output_gain;
  7470. /*< Q2.13 output gain to the EANS module.
  7471. * Byte offset: 4
  7472. */
  7473. int16_t eansarget_ns;
  7474. /*< Target noise suppression level in dB.
  7475. * Byte offset: 6
  7476. */
  7477. int16_t eans_s_alpha;
  7478. /*< Q3.12 over-subtraction factor for stationary noise
  7479. * suppression.
  7480. * Byte offset: 8
  7481. */
  7482. int16_t eans_n_alpha;
  7483. /* < Q3.12 over-subtraction factor for nonstationary noise
  7484. * suppression.
  7485. * Byte offset: 10
  7486. */
  7487. int16_t eans_n_alphamax;
  7488. /*< Q3.12 maximum over-subtraction factor for nonstationary
  7489. * noise suppression.
  7490. * Byte offset: 12
  7491. */
  7492. int16_t eans_e_alpha;
  7493. /*< Q15 scaling factor for excess noise suppression.
  7494. * Byte offset: 14
  7495. */
  7496. int16_t eans_ns_snrmax;
  7497. /*< Upper boundary in dB for SNR estimation.
  7498. * Byte offset: 16
  7499. */
  7500. int16_t eans_sns_block;
  7501. /*< Quarter block size for stationary noise suppression.
  7502. * Byte offset: 18
  7503. */
  7504. int16_t eans_ns_i;
  7505. /*< Initialization block size for noise suppression.
  7506. * Byte offset: 20
  7507. */
  7508. int16_t eans_np_scale;
  7509. /*< Power scale factor for nonstationary noise update.
  7510. * Byte offset: 22
  7511. */
  7512. int16_t eans_n_lambda;
  7513. /*< Smoothing factor for higher level nonstationary noise
  7514. * update.
  7515. * Byte offset: 24
  7516. */
  7517. int16_t eans_n_lambdaf;
  7518. /*< Medium averaging factor for noise update.
  7519. * Byte offset: 26
  7520. */
  7521. int16_t eans_gs_bias;
  7522. /*< Bias factor in dB for gain calculation.
  7523. * Byte offset: 28
  7524. */
  7525. int16_t eans_gs_max;
  7526. /*< SNR lower boundary in dB for aggressive gain calculation.
  7527. * Byte offset: 30
  7528. */
  7529. int16_t eans_s_alpha_hb;
  7530. /*< Q3.12 over-subtraction factor for high-band stationary
  7531. * noise suppression.
  7532. * Byte offset: 32
  7533. */
  7534. int16_t eans_n_alphamax_hb;
  7535. /*< Q3.12 maximum over-subtraction factor for high-band
  7536. * nonstationary noise suppression.
  7537. * Byte offset: 34
  7538. */
  7539. int16_t eans_e_alpha_hb;
  7540. /*< Q15 scaling factor for high-band excess noise suppression.
  7541. * Byte offset: 36
  7542. */
  7543. int16_t eans_n_lambda0;
  7544. /*< Smoothing factor for nonstationary noise update during
  7545. * speech activity.
  7546. * Byte offset: 38
  7547. */
  7548. int16_t thresh;
  7549. /*< Threshold for generating a binary VAD decision.
  7550. * Byte offset: 40
  7551. */
  7552. int16_t pwr_scale;
  7553. /*< Indirect lower boundary of the noise level estimate.
  7554. * Byte offset: 42
  7555. */
  7556. int16_t hangover_max;
  7557. /*< Avoids mid-speech clipping and reliably detects weak speech
  7558. * bursts at the end of speech activity.
  7559. * Byte offset: 44
  7560. */
  7561. int16_t alpha_snr;
  7562. /*< Controls responsiveness of the VAD.
  7563. * Byte offset: 46
  7564. */
  7565. int16_t snr_diff_max;
  7566. /*< Maximum SNR difference. Decreasing this parameter value may
  7567. * help in making correct decisions during abrupt changes; however,
  7568. * decreasing too much may increase false alarms during long
  7569. * pauses/silences.
  7570. * Byte offset: 48
  7571. */
  7572. int16_t snr_diff_min;
  7573. /*< Minimum SNR difference. Decreasing this parameter value may
  7574. * help in making correct decisions during abrupt changes; however,
  7575. * decreasing too much may increase false alarms during long
  7576. * pauses/silences.
  7577. * Byte offset: 50
  7578. */
  7579. int16_t init_length;
  7580. /*< Defines the number of frames for which a noise level
  7581. * estimate is set to a fixed value.
  7582. * Byte offset: 52
  7583. */
  7584. int16_t max_val;
  7585. /*< Defines the upper limit of the noise level.
  7586. * Byte offset: 54
  7587. */
  7588. int16_t init_bound;
  7589. /*< Defines the initial bounding value for the noise level
  7590. * estimate. This is used during the initial segment defined by the
  7591. * init_length parameter.
  7592. * Byte offset: 56
  7593. */
  7594. int16_t reset_bound;
  7595. /*< Reset boundary for noise tracking.
  7596. * Byte offset: 58
  7597. */
  7598. int16_t avar_scale;
  7599. /*< Defines the bias factor in noise estimation.
  7600. * Byte offset: 60
  7601. */
  7602. int16_t sub_nc;
  7603. /*< Defines the window length for noise estimation.
  7604. * Byte offset: 62
  7605. */
  7606. int16_t spow_min;
  7607. /*< Defines the minimum signal power required to update the
  7608. * boundaries for the noise floor estimate.
  7609. * Byte offset: 64
  7610. */
  7611. int16_t eans_gs_fast;
  7612. /*< Fast smoothing factor for postprocessor gain.
  7613. * Byte offset: 66
  7614. */
  7615. int16_t eans_gs_med;
  7616. /*< Medium smoothing factor for postprocessor gain.
  7617. * Byte offset: 68
  7618. */
  7619. int16_t eans_gs_slow;
  7620. /*< Slow smoothing factor for postprocessor gain.
  7621. * Byte offset: 70
  7622. */
  7623. int16_t eans_swb_salpha;
  7624. /*< Q3.12 super wideband aggressiveness factor for stationary
  7625. * noise suppression.
  7626. * Byte offset: 72
  7627. */
  7628. int16_t eans_swb_nalpha;
  7629. /*< Q3.12 super wideband aggressiveness factor for
  7630. * nonstationary noise suppression.
  7631. * Byte offset: 74
  7632. */
  7633. } __packed;
  7634. #define ADM_MODULE_IDX_MIC_GAIN_CTRL 0x00010C35
  7635. /* @addtogroup audio_pp_param_ids
  7636. * ID of the Tx mic gain control parameter used by the
  7637. * #ADM_MODULE_IDX_MIC_GAIN_CTRL module.
  7638. * @messagepayload
  7639. * @structure{admx_mic_gain}
  7640. * @tablespace
  7641. * @inputtable{Audio_Postproc_ADM_PARAM_IDX_MIC_GAIN.tex}
  7642. */
  7643. #define ADM_PARAM_IDX_MIC_GAIN 0x00010C36
  7644. /* Structure for a Tx mic gain parameter for the mic gain
  7645. * control module.
  7646. */
  7647. /* @brief Payload of the #ADM_PARAM_IDX_MIC_GAIN parameter in the
  7648. * Tx Mic Gain Control module.
  7649. */
  7650. struct admx_mic_gain {
  7651. uint16_t tx_mic_gain;
  7652. /*< Linear gain in Q13 format. */
  7653. uint16_t reserved;
  7654. /*< Clients must set this field to zero. */
  7655. } __packed;
  7656. /* end_addtogroup audio_pp_param_ids */
  7657. /* @ingroup audio_pp_module_ids
  7658. * ID of the Rx Codec Gain Control module.
  7659. *
  7660. * This module supports the following parameter ID:
  7661. * - #ADM_PARAM_ID_RX_CODEC_GAIN
  7662. */
  7663. #define ADM_MODULE_ID_RX_CODEC_GAIN_CTRL 0x00010C37
  7664. /* @addtogroup audio_pp_param_ids
  7665. * ID of the Rx codec gain control parameter used by the
  7666. * #ADM_MODULE_ID_RX_CODEC_GAIN_CTRL module.
  7667. *
  7668. * @messagepayload
  7669. * @structure{adm_rx_codec_gain}
  7670. * @tablespace
  7671. * @inputtable{Audio_Postproc_ADM_PARAM_ID_RX_CODEC_GAIN.tex}
  7672. */
  7673. #define ADM_PARAM_ID_RX_CODEC_GAIN 0x00010C38
  7674. /* Structure for the Rx common codec gain control module. */
  7675. /* @brief Payload of the #ADM_PARAM_ID_RX_CODEC_GAIN parameter
  7676. * in the Rx Codec Gain Control module.
  7677. */
  7678. struct adm_rx_codec_gain {
  7679. uint16_t rx_codec_gain;
  7680. /* Linear gain in Q13 format. */
  7681. uint16_t reserved;
  7682. /* Clients must set this field to zero.*/
  7683. } __packed;
  7684. /* end_addtogroup audio_pp_param_ids */
  7685. /* @ingroup audio_pp_module_ids
  7686. * ID of the HPF Tuning Filter module on the Tx path.
  7687. * This module supports the following parameter IDs:
  7688. * - #ADM_PARAM_ID_HPF_IIRX_FILTER_ENABLE_CONFIG
  7689. * - #ADM_PARAM_ID_HPF_IIRX_FILTER_PRE_GAIN
  7690. * - #ADM_PARAM_ID_HPF_IIRX_FILTER_CONFIG_PARAMS
  7691. */
  7692. #define ADM_MODULE_ID_HPF_IIRX_FILTER 0x00010C3D
  7693. /* @addtogroup audio_pp_param_ids */
  7694. /* ID of the Tx HPF IIR filter enable parameter used by the
  7695. * #ADM_MODULE_ID_HPF_IIRX_FILTER module.
  7696. * @parspace Message payload
  7697. * @structure{adm_hpfx_iir_filter_enable_cfg}
  7698. * @tablespace
  7699. * @inputtable{Audio_Postproc_ADM_PARAM_ID_HPF_IIRX_FILTER_ENABLE_CONFIG.tex}
  7700. */
  7701. #define ADM_PARAM_ID_HPF_IIRX_FILTER_ENABLE_CONFIG 0x00010C3E
  7702. /* ID of the Tx HPF IIR filter pregain parameter used by the
  7703. * #ADM_MODULE_ID_HPF_IIRX_FILTER module.
  7704. * @parspace Message payload
  7705. * @structure{adm_hpfx_iir_filter_pre_gain}
  7706. * @tablespace
  7707. * @inputtable{Audio_Postproc_ADM_PARAM_ID_HPF_IIRX_FILTER_PRE_GAIN.tex}
  7708. */
  7709. #define ADM_PARAM_ID_HPF_IIRX_FILTER_PRE_GAIN 0x00010C3F
  7710. /* ID of the Tx HPF IIR filter configuration parameters used by the
  7711. * #ADM_MODULE_ID_HPF_IIRX_FILTER module.
  7712. * @parspace Message payload
  7713. * @structure{adm_hpfx_iir_filter_cfg_params}
  7714. * @tablespace
  7715. * @inputtable{Audio_Postproc_ADM_PARAM_ID_HPF_IIRX_FILTER_CONFIG_PA
  7716. * RAMS.tex}
  7717. */
  7718. #define ADM_PARAM_ID_HPF_IIRX_FILTER_CONFIG_PARAMS 0x00010C40
  7719. /* Structure for enabling a configuration parameter for
  7720. * the HPF IIR tuning filter module on the Tx path.
  7721. */
  7722. /* @brief Payload of the #ADM_PARAM_ID_HPF_IIRX_FILTER_ENABLE_CONFIG
  7723. * parameter in the Tx path HPF Tuning Filter module.
  7724. */
  7725. struct adm_hpfx_iir_filter_enable_cfg {
  7726. uint32_t enable_flag;
  7727. /* Specifies whether the HPF tuning filter is disabled (0) or
  7728. * enabled (nonzero).
  7729. */
  7730. } __packed;
  7731. /* Structure for the pregain parameter for the HPF
  7732. * IIR tuning filter module on the Tx path.
  7733. */
  7734. /* @brief Payload of the #ADM_PARAM_ID_HPF_IIRX_FILTER_PRE_GAIN parameter
  7735. * in the Tx path HPF Tuning Filter module.
  7736. */
  7737. struct adm_hpfx_iir_filter_pre_gain {
  7738. uint16_t pre_gain;
  7739. /* Linear gain in Q13 format. */
  7740. uint16_t reserved;
  7741. /* Clients must set this field to zero.*/
  7742. } __packed;
  7743. /* Structure for the configuration parameter for the
  7744. * HPF IIR tuning filter module on the Tx path.
  7745. */
  7746. /* @brief Payload of the #ADM_PARAM_ID_HPF_IIRX_FILTER_CONFIG_PARAMS
  7747. * parameters in the Tx path HPF Tuning Filter module. \n
  7748. * \n
  7749. * This structure is followed by tuning filter coefficients as follows: \n
  7750. * - Sequence of int32_t FilterCoeffs.
  7751. * Each band has five coefficients, each in int32_t format in the order of
  7752. * b0, b1, b2, a1, a2.
  7753. * - Sequence of int16_t NumShiftFactor.
  7754. * One int16_t per band. The numerator shift factor is related to the Q
  7755. * factor of the filter coefficients.
  7756. * - Sequence of uint16_t PanSetting.
  7757. * One uint16_t for each band to indicate application of the filter to
  7758. * left (0), right (1), or both (2) channels.
  7759. */
  7760. struct adm_hpfx_iir_filter_cfg_params {
  7761. uint16_t num_biquad_stages;
  7762. /*< Number of bands.
  7763. * Supported values: 0 to 20
  7764. */
  7765. uint16_t reserved;
  7766. /*< Clients must set this field to zero.*/
  7767. } __packed;
  7768. /* end_addtogroup audio_pp_module_ids */
  7769. /* @addtogroup audio_pp_module_ids */
  7770. /* ID of the Tx path IIR Tuning Filter module.
  7771. * This module supports the following parameter IDs:
  7772. * - #ADM_PARAM_IDX_IIR_FILTER_ENABLE_CONFIG
  7773. */
  7774. #define ADM_MODULE_IDX_IIR_FILTER 0x00010C41
  7775. /* ID of the Rx path IIR Tuning Filter module for the left channel.
  7776. * The parameter IDs of the IIR tuning filter module
  7777. * (#ASM_MODULE_ID_IIRUNING_FILTER) are used for the left IIR Rx tuning
  7778. * filter.
  7779. *
  7780. * Pan parameters are not required for this per-channel IIR filter; the pan
  7781. * parameters are ignored by this module.
  7782. */
  7783. #define ADM_MODULE_ID_LEFT_IIRUNING_FILTER 0x00010705
  7784. /* ID of the the Rx path IIR Tuning Filter module for the right
  7785. * channel.
  7786. * The parameter IDs of the IIR tuning filter module
  7787. * (#ASM_MODULE_ID_IIRUNING_FILTER) are used for the right IIR Rx
  7788. * tuning filter.
  7789. *
  7790. * Pan parameters are not required for this per-channel IIR filter;
  7791. * the pan parameters are ignored by this module.
  7792. */
  7793. #define ADM_MODULE_ID_RIGHT_IIRUNING_FILTER 0x00010706
  7794. /* end_addtogroup audio_pp_module_ids */
  7795. /* @addtogroup audio_pp_param_ids */
  7796. /* ID of the Tx IIR filter enable parameter used by the
  7797. * #ADM_MODULE_IDX_IIR_FILTER module.
  7798. * @parspace Message payload
  7799. * @structure{admx_iir_filter_enable_cfg}
  7800. * @tablespace
  7801. * @inputtable{Audio_Postproc_ADM_PARAM_IDX_IIR_FILTER_ENABLE_CONFIG.tex}
  7802. */
  7803. #define ADM_PARAM_IDX_IIR_FILTER_ENABLE_CONFIG 0x00010C42
  7804. /* ID of the Tx IIR filter pregain parameter used by the
  7805. * #ADM_MODULE_IDX_IIR_FILTER module.
  7806. * @parspace Message payload
  7807. * @structure{admx_iir_filter_pre_gain}
  7808. * @tablespace
  7809. * @inputtable{Audio_Postproc_ADM_PARAM_IDX_IIR_FILTER_PRE_GAIN.tex}
  7810. */
  7811. #define ADM_PARAM_IDX_IIR_FILTER_PRE_GAIN 0x00010C43
  7812. /* ID of the Tx IIR filter configuration parameters used by the
  7813. * #ADM_MODULE_IDX_IIR_FILTER module.
  7814. * @parspace Message payload
  7815. * @structure{admx_iir_filter_cfg_params}
  7816. * @tablespace
  7817. * @inputtable{Audio_Postproc_ADM_PARAM_IDX_IIR_FILTER_CONFIG_PARAMS.tex}
  7818. */
  7819. #define ADM_PARAM_IDX_IIR_FILTER_CONFIG_PARAMS 0x00010C44
  7820. /* Structure for enabling the configuration parameter for the
  7821. * IIR filter module on the Tx path.
  7822. */
  7823. /* @brief Payload of the #ADM_PARAM_IDX_IIR_FILTER_ENABLE_CONFIG
  7824. * parameter in the Tx Path IIR Tuning Filter module.
  7825. */
  7826. struct admx_iir_filter_enable_cfg {
  7827. uint32_t enable_flag;
  7828. /*< Specifies whether the IIR tuning filter is disabled (0) or
  7829. * enabled (nonzero).
  7830. */
  7831. } __packed;
  7832. /* Structure for the pregain parameter for the
  7833. * IIR filter module on the Tx path.
  7834. */
  7835. /* @brief Payload of the #ADM_PARAM_IDX_IIR_FILTER_PRE_GAIN
  7836. * parameter in the Tx Path IIR Tuning Filter module.
  7837. */
  7838. struct admx_iir_filter_pre_gain {
  7839. uint16_t pre_gain;
  7840. /*< Linear gain in Q13 format. */
  7841. uint16_t reserved;
  7842. /*< Clients must set this field to zero.*/
  7843. } __packed;
  7844. /* Structure for the configuration parameter for the
  7845. * IIR filter module on the Tx path.
  7846. */
  7847. /* @brief Payload of the #ADM_PARAM_IDX_IIR_FILTER_CONFIG_PARAMS
  7848. * parameter in the Tx Path IIR Tuning Filter module. \n
  7849. * \n
  7850. * This structure is followed by the HPF IIR filter coefficients on
  7851. * the Tx path as follows: \n
  7852. * - Sequence of int32_t ulFilterCoeffs. Each band has five
  7853. * coefficients, each in int32_t format in the order of b0, b1, b2,
  7854. * a1, a2.
  7855. * - Sequence of int16_t sNumShiftFactor. One int16_t per band. The
  7856. * numerator shift factor is related to the Q factor of the filter
  7857. * coefficients.
  7858. * - Sequence of uint16_t usPanSetting. One uint16_t for each band
  7859. * to indicate if the filter is applied to left (0), right (1), or
  7860. * both (2) channels.
  7861. */
  7862. struct admx_iir_filter_cfg_params {
  7863. uint16_t num_biquad_stages;
  7864. /*< Number of bands.
  7865. * Supported values: 0 to 20
  7866. */
  7867. uint16_t reserved;
  7868. /*< Clients must set this field to zero.*/
  7869. } __packed;
  7870. /* end_addtogroup audio_pp_module_ids */
  7871. /* @ingroup audio_pp_module_ids
  7872. * ID of the QEnsemble module.
  7873. * This module supports the following parameter IDs:
  7874. * - #ADM_PARAM_ID_QENSEMBLE_ENABLE
  7875. * - #ADM_PARAM_ID_QENSEMBLE_BACKGAIN
  7876. * - #ADM_PARAM_ID_QENSEMBLE_SET_NEW_ANGLE
  7877. */
  7878. #define ADM_MODULE_ID_QENSEMBLE 0x00010C59
  7879. /* @addtogroup audio_pp_param_ids */
  7880. /* ID of the QEnsemble enable parameter used by the
  7881. * #ADM_MODULE_ID_QENSEMBLE module.
  7882. * @messagepayload
  7883. * @structure{adm_qensemble_enable}
  7884. * @tablespace
  7885. * @inputtable{Audio_Postproc_ADM_PARAM_ID_QENSEMBLE_ENABLE.tex}
  7886. */
  7887. #define ADM_PARAM_ID_QENSEMBLE_ENABLE 0x00010C60
  7888. /* ID of the QEnsemble back gain parameter used by the
  7889. * #ADM_MODULE_ID_QENSEMBLE module.
  7890. * @messagepayload
  7891. * @structure{adm_qensemble_param_backgain}
  7892. * @tablespace
  7893. * @inputtable{Audio_Postproc_ADM_PARAM_ID_QENSEMBLE_BACKGAIN.tex}
  7894. */
  7895. #define ADM_PARAM_ID_QENSEMBLE_BACKGAIN 0x00010C61
  7896. /* ID of the QEnsemble new angle parameter used by the
  7897. * #ADM_MODULE_ID_QENSEMBLE module.
  7898. * @messagepayload
  7899. * @structure{adm_qensemble_param_set_new_angle}
  7900. * @tablespace
  7901. * @inputtable{Audio_Postproc_ADM_PARAM_ID_QENSEMBLE_SET_NEW_ANGLE.tex}
  7902. */
  7903. #define ADM_PARAM_ID_QENSEMBLE_SET_NEW_ANGLE 0x00010C62
  7904. /* Structure for enabling the configuration parameter for the
  7905. * QEnsemble module.
  7906. */
  7907. /* @brief Payload of the #ADM_PARAM_ID_QENSEMBLE_ENABLE
  7908. * parameter used by the QEnsemble module.
  7909. */
  7910. struct adm_qensemble_enable {
  7911. uint32_t enable_flag;
  7912. /*< Specifies whether the QEnsemble module is disabled (0) or enabled
  7913. * (nonzero).
  7914. */
  7915. } __packed;
  7916. /* Structure for the background gain for the QEnsemble module. */
  7917. /* @brief Payload of the #ADM_PARAM_ID_QENSEMBLE_BACKGAIN
  7918. * parameter used by
  7919. * the QEnsemble module.
  7920. */
  7921. struct adm_qensemble_param_backgain {
  7922. int16_t back_gain;
  7923. /*< Linear gain in Q15 format.
  7924. * Supported values: 0 to 32767
  7925. */
  7926. uint16_t reserved;
  7927. /*< Clients must set this field to zero.*/
  7928. } __packed;
  7929. /* Structure for setting a new angle for the QEnsemble module. */
  7930. /* @brief Payload of the #ADM_PARAM_ID_QENSEMBLE_SET_NEW_ANGLE
  7931. * parameter used
  7932. * by the QEnsemble module.
  7933. */
  7934. struct adm_qensemble_param_set_new_angle {
  7935. int16_t new_angle;
  7936. /*< New angle in degrees.
  7937. * Supported values: 0 to 359
  7938. */
  7939. int16_t time_ms;
  7940. /*< Transition time in milliseconds to set the new angle.
  7941. * Supported values: 0 to 32767
  7942. */
  7943. } __packed;
  7944. #define ADM_CMD_GET_PP_TOPO_MODULE_LIST 0x00010349
  7945. #define ADM_CMDRSP_GET_PP_TOPO_MODULE_LIST 0x00010350
  7946. #define ADM_CMD_GET_PP_TOPO_MODULE_LIST_V2 0x00010360
  7947. #define ADM_CMDRSP_GET_PP_TOPO_MODULE_LIST_V2 0x00010361
  7948. #define AUDPROC_PARAM_ID_ENABLE 0x00010904
  7949. /*
  7950. * Payload of the ADM_CMD_GET_PP_TOPO_MODULE_LIST command.
  7951. */
  7952. struct adm_cmd_get_pp_topo_module_list {
  7953. struct apr_hdr apr_hdr;
  7954. /* The memory mapping header to be used when requesting out of band */
  7955. struct mem_mapping_hdr mem_hdr;
  7956. /*
  7957. * Maximum data size of the list of modules. This
  7958. * field is a multiple of 4 bytes.
  7959. */
  7960. uint32_t param_max_size;
  7961. } __packed;
  7962. struct audproc_topology_module_id_info_t {
  7963. uint32_t num_modules;
  7964. } __packed;
  7965. /* end_addtogroup audio_pp_module_ids */
  7966. /* @ingroup audio_pp_module_ids
  7967. * ID of the Volume Control module pre/postprocessing block.
  7968. * This module supports the following parameter IDs:
  7969. * - #ASM_PARAM_ID_VOL_CTRL_MASTER_GAIN
  7970. * - #ASM_PARAM_ID_MULTICHANNEL_GAIN
  7971. * - #ASM_PARAM_ID_VOL_CTRL_MUTE_CONFIG
  7972. * - #ASM_PARAM_ID_SOFT_VOL_STEPPING_PARAMETERS
  7973. * - #ASM_PARAM_ID_SOFT_PAUSE_PARAMETERS
  7974. * - #ASM_PARAM_ID_MULTICHANNEL_GAIN
  7975. * - #ASM_PARAM_ID_MULTICHANNEL_MUTE
  7976. */
  7977. #define ASM_MODULE_ID_VOL_CTRL 0x00010BFE
  7978. #define ASM_MODULE_ID_VOL_CTRL2 0x00010910
  7979. #define AUDPROC_MODULE_ID_VOL_CTRL ASM_MODULE_ID_VOL_CTRL
  7980. /* @addtogroup audio_pp_param_ids */
  7981. /* ID of the master gain parameter used by the #ASM_MODULE_ID_VOL_CTRL
  7982. * module.
  7983. * @messagepayload
  7984. * @structure{asm_volume_ctrl_master_gain}
  7985. * @tablespace
  7986. * @inputtable{Audio_Postproc_ASM_PARAM_ID_VOL_CTRL_MASTER_GAIN.tex}
  7987. */
  7988. #define ASM_PARAM_ID_VOL_CTRL_MASTER_GAIN 0x00010BFF
  7989. #define AUDPROC_PARAM_ID_VOL_CTRL_MASTER_GAIN ASM_PARAM_ID_VOL_CTRL_MASTER_GAIN
  7990. /* ID of the left/right channel gain parameter used by the
  7991. * #ASM_MODULE_ID_VOL_CTRL module.
  7992. * @messagepayload
  7993. * @structure{asm_volume_ctrl_lr_chan_gain}
  7994. * @tablespace
  7995. * @inputtable{Audio_Postproc_ASM_PARAM_ID_MULTICHANNEL_GAIN.tex}
  7996. */
  7997. #define ASM_PARAM_ID_VOL_CTRL_LR_CHANNEL_GAIN 0x00010C00
  7998. /* ID of the mute configuration parameter used by the
  7999. * #ASM_MODULE_ID_VOL_CTRL module.
  8000. * @messagepayload
  8001. * @structure{asm_volume_ctrl_mute_config}
  8002. * @tablespace
  8003. * @inputtable{Audio_Postproc_ASM_PARAM_ID_VOL_CTRL_MUTE_CONFIG.tex}
  8004. */
  8005. #define ASM_PARAM_ID_VOL_CTRL_MUTE_CONFIG 0x00010C01
  8006. /* ID of the soft stepping volume parameters used by the
  8007. * #ASM_MODULE_ID_VOL_CTRL module.
  8008. * @messagepayload
  8009. * @structure{asm_soft_step_volume_params}
  8010. * @tablespace
  8011. * @inputtable{Audio_Postproc_ASM_PARAM_ID_SOFT_VOL_STEPPING_PARAMET
  8012. * ERS.tex}
  8013. */
  8014. #define ASM_PARAM_ID_SOFT_VOL_STEPPING_PARAMETERS 0x00010C29
  8015. #define AUDPROC_PARAM_ID_SOFT_VOL_STEPPING_PARAMETERS\
  8016. ASM_PARAM_ID_SOFT_VOL_STEPPING_PARAMETERS
  8017. /* ID of the soft pause parameters used by the #ASM_MODULE_ID_VOL_CTRL
  8018. * module.
  8019. */
  8020. #define ASM_PARAM_ID_SOFT_PAUSE_PARAMETERS 0x00010D6A
  8021. /* ID of the multiple-channel volume control parameters used by the
  8022. * #ASM_MODULE_ID_VOL_CTRL module.
  8023. */
  8024. #define ASM_PARAM_ID_MULTICHANNEL_GAIN 0x00010713
  8025. /* ID of the multiple-channel mute configuration parameters used by the
  8026. * #ASM_MODULE_ID_VOL_CTRL module.
  8027. */
  8028. #define ASM_PARAM_ID_MULTICHANNEL_MUTE 0x00010714
  8029. /* Structure for the master gain parameter for a volume control
  8030. * module.
  8031. */
  8032. /* @brief Payload of the #ASM_PARAM_ID_VOL_CTRL_MASTER_GAIN
  8033. * parameter used by the Volume Control module.
  8034. */
  8035. struct asm_volume_ctrl_master_gain {
  8036. uint16_t master_gain;
  8037. /* Linear gain in Q13 format. */
  8038. uint16_t reserved;
  8039. /* Clients must set this field to zero. */
  8040. } __packed;
  8041. struct asm_volume_ctrl_lr_chan_gain {
  8042. uint16_t l_chan_gain;
  8043. /*< Linear gain in Q13 format for the left channel. */
  8044. uint16_t r_chan_gain;
  8045. /*< Linear gain in Q13 format for the right channel.*/
  8046. } __packed;
  8047. /* Structure for the mute configuration parameter for a
  8048. * volume control module.
  8049. */
  8050. /* @brief Payload of the #ASM_PARAM_ID_VOL_CTRL_MUTE_CONFIG
  8051. * parameter used by the Volume Control module.
  8052. */
  8053. struct asm_volume_ctrl_mute_config {
  8054. uint32_t mute_flag;
  8055. /*< Specifies whether mute is disabled (0) or enabled (nonzero).*/
  8056. } __packed;
  8057. /*
  8058. * Supported parameters for a soft stepping linear ramping curve.
  8059. */
  8060. #define ASM_PARAM_SVC_RAMPINGCURVE_LINEAR 0
  8061. /*
  8062. * Exponential ramping curve.
  8063. */
  8064. #define ASM_PARAM_SVC_RAMPINGCURVE_EXP 1
  8065. /*
  8066. * Logarithmic ramping curve.
  8067. */
  8068. #define ASM_PARAM_SVC_RAMPINGCURVE_LOG 2
  8069. /* Structure for holding soft stepping volume parameters. */
  8070. /* Payload of the #ASM_PARAM_ID_SOFT_VOL_STEPPING_PARAMETERS
  8071. * parameters used by the Volume Control module.
  8072. */
  8073. struct asm_soft_step_volume_params {
  8074. uint32_t period;
  8075. /*< Period in milliseconds.
  8076. * Supported values: 0 to 15000
  8077. */
  8078. uint32_t step;
  8079. /*< Step in microseconds.
  8080. * Supported values: 0 to 15000000
  8081. */
  8082. uint32_t ramping_curve;
  8083. /*< Ramping curve type.
  8084. * Supported values:
  8085. * - #ASM_PARAM_SVC_RAMPINGCURVE_LINEAR
  8086. * - #ASM_PARAM_SVC_RAMPINGCURVE_EXP
  8087. * - #ASM_PARAM_SVC_RAMPINGCURVE_LOG
  8088. */
  8089. } __packed;
  8090. /* Structure for holding soft pause parameters. */
  8091. /* Payload of the #ASM_PARAM_ID_SOFT_PAUSE_PARAMETERS
  8092. * parameters used by the Volume Control module.
  8093. */
  8094. struct asm_soft_pause_params {
  8095. uint32_t enable_flag;
  8096. /*< Specifies whether soft pause is disabled (0) or enabled
  8097. * (nonzero).
  8098. */
  8099. uint32_t period;
  8100. /*< Period in milliseconds.
  8101. * Supported values: 0 to 15000
  8102. */
  8103. uint32_t step;
  8104. /*< Step in microseconds.
  8105. * Supported values: 0 to 15000000
  8106. */
  8107. uint32_t ramping_curve;
  8108. /*< Ramping curve.
  8109. * Supported values:
  8110. * - #ASM_PARAM_SVC_RAMPINGCURVE_LINEAR
  8111. * - #ASM_PARAM_SVC_RAMPINGCURVE_EXP
  8112. * - #ASM_PARAM_SVC_RAMPINGCURVE_LOG
  8113. */
  8114. } __packed;
  8115. /* Maximum number of channels.*/
  8116. #define VOLUME_CONTROL_MAX_CHANNELS 8
  8117. /* Structure for holding one channel type - gain pair. */
  8118. /* Payload of the #ASM_PARAM_ID_MULTICHANNEL_GAIN channel
  8119. * type/gain pairs used by the Volume Control module. \n \n This
  8120. * structure immediately follows the
  8121. * asm_volume_ctrl_multichannel_gain structure.
  8122. */
  8123. struct asm_volume_ctrl_channeltype_gain_pair {
  8124. uint8_t channeltype;
  8125. /*
  8126. * Channel type for which the gain setting is to be applied.
  8127. * Supported values:
  8128. * - #PCM_CHANNEL_L
  8129. * - #PCM_CHANNEL_R
  8130. * - #PCM_CHANNEL_C
  8131. * - #PCM_CHANNEL_LS
  8132. * - #PCM_CHANNEL_RS
  8133. * - #PCM_CHANNEL_LFE
  8134. * - #PCM_CHANNEL_CS
  8135. * - #PCM_CHANNEL_LB
  8136. * - #PCM_CHANNEL_RB
  8137. * - #PCM_CHANNEL_TS
  8138. * - #PCM_CHANNEL_CVH
  8139. * - #PCM_CHANNEL_MS
  8140. * - #PCM_CHANNEL_FLC
  8141. * - #PCM_CHANNEL_FRC
  8142. * - #PCM_CHANNEL_RLC
  8143. * - #PCM_CHANNEL_RRC
  8144. */
  8145. uint8_t reserved1;
  8146. /* Clients must set this field to zero. */
  8147. uint8_t reserved2;
  8148. /* Clients must set this field to zero. */
  8149. uint8_t reserved3;
  8150. /* Clients must set this field to zero. */
  8151. uint32_t gain;
  8152. /*
  8153. * Gain value for this channel in Q28 format.
  8154. * Supported values: Any
  8155. */
  8156. } __packed;
  8157. /* Structure for the multichannel gain command */
  8158. /* Payload of the #ASM_PARAM_ID_MULTICHANNEL_GAIN
  8159. * parameters used by the Volume Control module.
  8160. */
  8161. struct asm_volume_ctrl_multichannel_gain {
  8162. uint32_t num_channels;
  8163. /*
  8164. * Number of channels for which gain values are provided. Any
  8165. * channels present in the data for which gain is not provided are
  8166. * set to unity gain.
  8167. * Supported values: 1 to 8
  8168. */
  8169. struct asm_volume_ctrl_channeltype_gain_pair
  8170. gain_data[VOLUME_CONTROL_MAX_CHANNELS];
  8171. /* Array of channel type/gain pairs.*/
  8172. } __packed;
  8173. /* Structure for holding one channel type - mute pair. */
  8174. /* Payload of the #ASM_PARAM_ID_MULTICHANNEL_MUTE channel
  8175. * type/mute setting pairs used by the Volume Control module. \n \n
  8176. * This structure immediately follows the
  8177. * asm_volume_ctrl_multichannel_mute structure.
  8178. */
  8179. struct asm_volume_ctrl_channelype_mute_pair {
  8180. uint8_t channelype;
  8181. /*< Channel type for which the mute setting is to be applied.
  8182. * Supported values:
  8183. * - #PCM_CHANNEL_L
  8184. * - #PCM_CHANNEL_R
  8185. * - #PCM_CHANNEL_C
  8186. * - #PCM_CHANNEL_LS
  8187. * - #PCM_CHANNEL_RS
  8188. * - #PCM_CHANNEL_LFE
  8189. * - #PCM_CHANNEL_CS
  8190. * - #PCM_CHANNEL_LB
  8191. * - #PCM_CHANNEL_RB
  8192. * - #PCM_CHANNEL_TS
  8193. * - #PCM_CHANNEL_CVH
  8194. * - #PCM_CHANNEL_MS
  8195. * - #PCM_CHANNEL_FLC
  8196. * - #PCM_CHANNEL_FRC
  8197. * - #PCM_CHANNEL_RLC
  8198. * - #PCM_CHANNEL_RRC
  8199. */
  8200. uint8_t reserved1;
  8201. /*< Clients must set this field to zero. */
  8202. uint8_t reserved2;
  8203. /*< Clients must set this field to zero. */
  8204. uint8_t reserved3;
  8205. /*< Clients must set this field to zero. */
  8206. uint32_t mute;
  8207. /*< Mute setting for this channel.
  8208. * Supported values:
  8209. * - 0 = Unmute
  8210. * - Nonzero = Mute
  8211. */
  8212. } __packed;
  8213. /* Structure for the multichannel mute command */
  8214. /* @brief Payload of the #ASM_PARAM_ID_MULTICHANNEL_MUTE
  8215. * parameters used by the Volume Control module.
  8216. */
  8217. struct asm_volume_ctrl_multichannel_mute {
  8218. uint32_t num_channels;
  8219. /*< Number of channels for which mute configuration is
  8220. * provided. Any channels present in the data for which mute
  8221. * configuration is not provided are set to unmute.
  8222. * Supported values: 1 to 8
  8223. */
  8224. struct asm_volume_ctrl_channelype_mute_pair
  8225. mute_data[VOLUME_CONTROL_MAX_CHANNELS];
  8226. /*< Array of channel type/mute setting pairs.*/
  8227. } __packed;
  8228. /* end_addtogroup audio_pp_param_ids */
  8229. /* audio_pp_module_ids
  8230. * ID of the IIR Tuning Filter module.
  8231. * This module supports the following parameter IDs:
  8232. * - #ASM_PARAM_ID_IIRUNING_FILTER_ENABLE_CONFIG
  8233. * - #ASM_PARAM_ID_IIRUNING_FILTER_PRE_GAIN
  8234. * - #ASM_PARAM_ID_IIRUNING_FILTER_CONFIG_PARAMS
  8235. */
  8236. #define ASM_MODULE_ID_IIRUNING_FILTER 0x00010C02
  8237. /* @addtogroup audio_pp_param_ids */
  8238. /* ID of the IIR tuning filter enable parameter used by the
  8239. * #ASM_MODULE_ID_IIRUNING_FILTER module.
  8240. * @messagepayload
  8241. * @structure{asm_iiruning_filter_enable}
  8242. * @tablespace
  8243. * @inputtable{Audio_Postproc_ASM_PARAM_ID_IIRUNING_FILTER_ENABLE_CO
  8244. * NFIG.tex}
  8245. */
  8246. #define ASM_PARAM_ID_IIRUNING_FILTER_ENABLE_CONFIG 0x00010C03
  8247. /* ID of the IIR tuning filter pregain parameter used by the
  8248. * #ASM_MODULE_ID_IIRUNING_FILTER module.
  8249. */
  8250. #define ASM_PARAM_ID_IIRUNING_FILTER_PRE_GAIN 0x00010C04
  8251. /* ID of the IIR tuning filter configuration parameters used by the
  8252. * #ASM_MODULE_ID_IIRUNING_FILTER module.
  8253. */
  8254. #define ASM_PARAM_ID_IIRUNING_FILTER_CONFIG_PARAMS 0x00010C05
  8255. /* Structure for an enable configuration parameter for an
  8256. * IIR tuning filter module.
  8257. */
  8258. /* @brief Payload of the #ASM_PARAM_ID_IIRUNING_FILTER_ENABLE_CONFIG
  8259. * parameter used by the IIR Tuning Filter module.
  8260. */
  8261. struct asm_iiruning_filter_enable {
  8262. uint32_t enable_flag;
  8263. /*< Specifies whether the IIR tuning filter is disabled (0) or
  8264. * enabled (1).
  8265. */
  8266. } __packed;
  8267. /* Structure for the pregain parameter for an IIR tuning filter module. */
  8268. /* Payload of the #ASM_PARAM_ID_IIRUNING_FILTER_PRE_GAIN
  8269. * parameters used by the IIR Tuning Filter module.
  8270. */
  8271. struct asm_iiruning_filter_pregain {
  8272. uint16_t pregain;
  8273. /*< Linear gain in Q13 format. */
  8274. uint16_t reserved;
  8275. /*< Clients must set this field to zero.*/
  8276. } __packed;
  8277. /* Structure for the configuration parameter for an IIR tuning filter
  8278. * module.
  8279. */
  8280. /* @brief Payload of the #ASM_PARAM_ID_IIRUNING_FILTER_CONFIG_PARAMS
  8281. * parameters used by the IIR Tuning Filter module. \n
  8282. * \n
  8283. * This structure is followed by the IIR filter coefficients: \n
  8284. * - Sequence of int32_t FilterCoeffs \n
  8285. * Five coefficients for each band. Each coefficient is in int32_t format, in
  8286. * the order of b0, b1, b2, a1, a2.
  8287. * - Sequence of int16_t NumShiftFactor \n
  8288. * One int16_t per band. The numerator shift factor is related to the Q
  8289. * factor of the filter coefficients.
  8290. * - Sequence of uint16_t PanSetting \n
  8291. * One uint16_t per band, indicating if the filter is applied to left (0),
  8292. * right (1), or both (2) channels.
  8293. */
  8294. struct asm_iir_filter_config_params {
  8295. uint16_t num_biquad_stages;
  8296. /*< Number of bands.
  8297. * Supported values: 0 to 20
  8298. */
  8299. uint16_t reserved;
  8300. /*< Clients must set this field to zero.*/
  8301. } __packed;
  8302. /* audio_pp_module_ids
  8303. * ID of the Multiband Dynamic Range Control (MBDRC) module on the Tx/Rx
  8304. * paths.
  8305. * This module supports the following parameter IDs:
  8306. * - #ASM_PARAM_ID_MBDRC_ENABLE
  8307. * - #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS
  8308. */
  8309. #define ASM_MODULE_ID_MBDRC 0x00010C06
  8310. /* audio_pp_param_ids */
  8311. /* ID of the MBDRC enable parameter used by the #ASM_MODULE_ID_MBDRC module.
  8312. * @messagepayload
  8313. * @structure{asm_mbdrc_enable}
  8314. * @tablespace
  8315. * @inputtable{Audio_Postproc_ASM_PARAM_ID_MBDRC_ENABLE.tex}
  8316. */
  8317. #define ASM_PARAM_ID_MBDRC_ENABLE 0x00010C07
  8318. /* ID of the MBDRC configuration parameters used by the
  8319. * #ASM_MODULE_ID_MBDRC module.
  8320. * @messagepayload
  8321. * @structure{asm_mbdrc_config_params}
  8322. * @tablespace
  8323. * @inputtable{Audio_Postproc_ASM_PARAM_ID_MBDRC_CONFIG_PARAMS.tex}
  8324. *
  8325. * @parspace Sub-band DRC configuration parameters
  8326. * @structure{asm_subband_drc_config_params}
  8327. * @tablespace
  8328. * @inputtable{Audio_Postproc_ASM_PARAM_ID_MBDRC_CONFIG_PARAMS_subband_DRC.tex}
  8329. *
  8330. * @keep{6}
  8331. * To obtain legacy ADRC from MBDRC, use the calibration tool to:
  8332. *
  8333. * - Enable MBDRC (EnableFlag = TRUE)
  8334. * - Set number of bands to 1 (uiNumBands = 1)
  8335. * - Enable the first MBDRC band (DrcMode[0] = DRC_ENABLED = 1)
  8336. * - Clear the first band mute flag (MuteFlag[0] = 0)
  8337. * - Set the first band makeup gain to unity (compMakeUpGain[0] = 0x2000)
  8338. * - Use the legacy ADRC parameters to calibrate the rest of the MBDRC
  8339. * parameters.
  8340. */
  8341. #define ASM_PARAM_ID_MBDRC_CONFIG_PARAMS 0x00010C08
  8342. /* end_addtogroup audio_pp_param_ids */
  8343. /* audio_pp_module_ids
  8344. * ID of the MMBDRC module version 2 pre/postprocessing block.
  8345. * This module differs from the original MBDRC (#ASM_MODULE_ID_MBDRC) in
  8346. * the length of the filters used in each sub-band.
  8347. * This module supports the following parameter ID:
  8348. * - #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS_IMPROVED_FILTBANK_V2
  8349. */
  8350. #define ASM_MODULE_ID_MBDRCV2 0x0001070B
  8351. /* @addtogroup audio_pp_param_ids */
  8352. /* ID of the configuration parameters used by the
  8353. * #ASM_MODULE_ID_MBDRCV2 module for the improved filter structure
  8354. * of the MBDRC v2 pre/postprocessing block.
  8355. * The update to this configuration structure from the original
  8356. * MBDRC is the number of filter coefficients in the filter
  8357. * structure. The sequence for is as follows:
  8358. * - 1 band = 0 FIR coefficient + 1 mute flag + uint16_t padding
  8359. * - 2 bands = 141 FIR coefficients + 2 mute flags + uint16_t padding
  8360. * - 3 bands = 141+81 FIR coefficients + 3 mute flags + uint16_t padding
  8361. * - 4 bands = 141+81+61 FIR coefficients + 4 mute flags + uint16_t
  8362. * padding
  8363. * - 5 bands = 141+81+61+61 FIR coefficients + 5 mute flags +
  8364. * uint16_t padding
  8365. * This block uses the same parameter structure as
  8366. * #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS.
  8367. */
  8368. #define ASM_PARAM_ID_MBDRC_CONFIG_PARAMS_IMPROVED_FILTBANK_V2 \
  8369. 0x0001070C
  8370. #define ASM_MODULE_ID_MBDRCV3 0x0001090B
  8371. /*
  8372. * ID of the MMBDRC module version 3 pre/postprocessing block.
  8373. * This module differs from MBDRCv2 (#ASM_MODULE_ID_MBDRCV2) in
  8374. * that it supports both 16- and 24-bit data.
  8375. * This module supports the following parameter ID:
  8376. * - #ASM_PARAM_ID_MBDRC_ENABLE
  8377. * - #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS
  8378. * - #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS_V3
  8379. * - #ASM_PARAM_ID_MBDRC_FILTER_XOVER_FREQS
  8380. */
  8381. /* Structure for the enable parameter for an MBDRC module. */
  8382. /* Payload of the #ASM_PARAM_ID_MBDRC_ENABLE parameter used by the
  8383. * MBDRC module.
  8384. */
  8385. struct asm_mbdrc_enable {
  8386. uint32_t enable_flag;
  8387. /*< Specifies whether MBDRC is disabled (0) or enabled (nonzero).*/
  8388. } __packed;
  8389. /* Structure for the configuration parameters for an MBDRC module. */
  8390. /* Payload of the #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS
  8391. * parameters used by the MBDRC module. \n \n Following this
  8392. * structure is the payload for sub-band DRC configuration
  8393. * parameters (asm_subband_drc_config_params). This sub-band
  8394. * structure must be repeated for each band.
  8395. */
  8396. struct asm_mbdrc_config_params {
  8397. uint16_t num_bands;
  8398. /*< Number of bands.
  8399. * Supported values: 1 to 5
  8400. */
  8401. int16_t limiterhreshold;
  8402. /*< Threshold in decibels for the limiter output.
  8403. * Supported values: -72 to 18 \n
  8404. * Recommended value: 3994 (-0.22 db in Q3.12 format)
  8405. */
  8406. int16_t limiter_makeup_gain;
  8407. /*< Makeup gain in decibels for the limiter output.
  8408. * Supported values: -42 to 42 \n
  8409. * Recommended value: 256 (0 dB in Q7.8 format)
  8410. */
  8411. int16_t limiter_gc;
  8412. /*< Limiter gain recovery coefficient.
  8413. * Supported values: 0.5 to 0.99 \n
  8414. * Recommended value: 32440 (0.99 in Q15 format)
  8415. */
  8416. int16_t limiter_delay;
  8417. /*< Limiter delay in samples.
  8418. * Supported values: 0 to 10 \n
  8419. * Recommended value: 262 (0.008 samples in Q15 format)
  8420. */
  8421. int16_t limiter_max_wait;
  8422. /*< Maximum limiter waiting time in samples.
  8423. * Supported values: 0 to 10 \n
  8424. * Recommended value: 262 (0.008 samples in Q15 format)
  8425. */
  8426. } __packed;
  8427. /* DRC configuration structure for each sub-band of an MBDRC module. */
  8428. /* Payload of the #ASM_PARAM_ID_MBDRC_CONFIG_PARAMS DRC
  8429. * configuration parameters for each sub-band in the MBDRC module.
  8430. * After this DRC structure is configured for valid bands, the next
  8431. * MBDRC setparams expects the sequence of sub-band MBDRC filter
  8432. * coefficients (the length depends on the number of bands) plus the
  8433. * mute flag for that band plus uint16_t padding.
  8434. *
  8435. * @keep{10}
  8436. * The filter coefficient and mute flag are of type int16_t:
  8437. * - FIR coefficient = int16_t firFilter
  8438. * - Mute flag = int16_t fMuteFlag
  8439. *
  8440. * The sequence is as follows:
  8441. * - 1 band = 0 FIR coefficient + 1 mute flag + uint16_t padding
  8442. * - 2 bands = 97 FIR coefficients + 2 mute flags + uint16_t padding
  8443. * - 3 bands = 97+33 FIR coefficients + 3 mute flags + uint16_t padding
  8444. * - 4 bands = 97+33+33 FIR coefficients + 4 mute flags + uint16_t padding
  8445. * - 5 bands = 97+33+33+33 FIR coefficients + 5 mute flags + uint16_t padding
  8446. *
  8447. * For improved filterbank, the sequence is as follows:
  8448. * - 1 band = 0 FIR coefficient + 1 mute flag + uint16_t padding
  8449. * - 2 bands = 141 FIR coefficients + 2 mute flags + uint16_t padding
  8450. * - 3 bands = 141+81 FIR coefficients + 3 mute flags + uint16_t padding
  8451. * - 4 bands = 141+81+61 FIR coefficients + 4 mute flags + uint16_t padding
  8452. * - 5 bands = 141+81+61+61 FIR coefficients + 5 mute flags + uint16_t padding
  8453. */
  8454. struct asm_subband_drc_config_params {
  8455. int16_t drc_stereo_linked_flag;
  8456. /*< Specifies whether all stereo channels have the same applied
  8457. * dynamics (1) or if they process their dynamics independently (0).
  8458. * Supported values:
  8459. * - 0 -- Not linked
  8460. * - 1 -- Linked
  8461. */
  8462. int16_t drc_mode;
  8463. /*< Specifies whether DRC mode is bypassed for sub-bands.
  8464. * Supported values:
  8465. * - 0 -- Disabled
  8466. * - 1 -- Enabled
  8467. */
  8468. int16_t drc_down_sample_level;
  8469. /*< DRC down sample level.
  8470. * Supported values: @ge 1
  8471. */
  8472. int16_t drc_delay;
  8473. /*< DRC delay in samples.
  8474. * Supported values: 0 to 1200
  8475. */
  8476. uint16_t drc_rmsime_avg_const;
  8477. /*< RMS signal energy time-averaging constant.
  8478. * Supported values: 0 to 2^16-1
  8479. */
  8480. uint16_t drc_makeup_gain;
  8481. /*< DRC makeup gain in decibels.
  8482. * Supported values: 258 to 64917
  8483. */
  8484. /* Down expander settings */
  8485. int16_t down_expdrhreshold;
  8486. /*< Down expander threshold.
  8487. * Supported Q7 format values: 1320 to up_cmpsrhreshold
  8488. */
  8489. int16_t down_expdr_slope;
  8490. /*< Down expander slope.
  8491. * Supported Q8 format values: -32768 to 0.
  8492. */
  8493. uint32_t down_expdr_attack;
  8494. /*< Down expander attack constant.
  8495. * Supported Q31 format values: 196844 to 2^31.
  8496. */
  8497. uint32_t down_expdr_release;
  8498. /*< Down expander release constant.
  8499. * Supported Q31 format values: 19685 to 2^31
  8500. */
  8501. uint16_t down_expdr_hysteresis;
  8502. /*< Down expander hysteresis constant.
  8503. * Supported Q14 format values: 1 to 32690
  8504. */
  8505. uint16_t reserved;
  8506. /*< Clients must set this field to zero. */
  8507. int32_t down_expdr_min_gain_db;
  8508. /*< Down expander minimum gain.
  8509. * Supported Q23 format values: -805306368 to 0.
  8510. */
  8511. /* Up compressor settings */
  8512. int16_t up_cmpsrhreshold;
  8513. /*< Up compressor threshold.
  8514. * Supported Q7 format values: down_expdrhreshold to
  8515. * down_cmpsrhreshold.
  8516. */
  8517. uint16_t up_cmpsr_slope;
  8518. /*< Up compressor slope.
  8519. * Supported Q16 format values: 0 to 64881.
  8520. */
  8521. uint32_t up_cmpsr_attack;
  8522. /*< Up compressor attack constant.
  8523. * Supported Q31 format values: 196844 to 2^31.
  8524. */
  8525. uint32_t up_cmpsr_release;
  8526. /*< Up compressor release constant.
  8527. * Supported Q31 format values: 19685 to 2^31.
  8528. */
  8529. uint16_t up_cmpsr_hysteresis;
  8530. /*< Up compressor hysteresis constant.
  8531. * Supported Q14 format values: 1 to 32690.
  8532. */
  8533. /* Down compressor settings */
  8534. int16_t down_cmpsrhreshold;
  8535. /*< Down compressor threshold.
  8536. * Supported Q7 format values: up_cmpsrhreshold to 11560.
  8537. */
  8538. uint16_t down_cmpsr_slope;
  8539. /*< Down compressor slope.
  8540. * Supported Q16 format values: 0 to 64881.
  8541. */
  8542. uint16_t reserved1;
  8543. /*< Clients must set this field to zero. */
  8544. uint32_t down_cmpsr_attack;
  8545. /*< Down compressor attack constant.
  8546. * Supported Q31 format values: 196844 to 2^31.
  8547. */
  8548. uint32_t down_cmpsr_release;
  8549. /*< Down compressor release constant.
  8550. * Supported Q31 format values: 19685 to 2^31.
  8551. */
  8552. uint16_t down_cmpsr_hysteresis;
  8553. /*< Down compressor hysteresis constant.
  8554. * Supported Q14 values: 1 to 32690.
  8555. */
  8556. uint16_t reserved2;
  8557. /*< Clients must set this field to zero.*/
  8558. } __packed;
  8559. #define ASM_MODULE_ID_EQUALIZER 0x00010C27
  8560. #define ASM_PARAM_ID_EQUALIZER_PARAMETERS 0x00010C28
  8561. #define ASM_MAX_EQ_BANDS 12
  8562. struct asm_eq_per_band_params {
  8563. uint32_t band_idx;
  8564. /*< Band index.
  8565. * Supported values: 0 to 11
  8566. */
  8567. uint32_t filterype;
  8568. /*< Type of filter.
  8569. * Supported values:
  8570. * - #ASM_PARAM_EQYPE_NONE
  8571. * - #ASM_PARAM_EQ_BASS_BOOST
  8572. * - #ASM_PARAM_EQ_BASS_CUT
  8573. * - #ASM_PARAM_EQREBLE_BOOST
  8574. * - #ASM_PARAM_EQREBLE_CUT
  8575. * - #ASM_PARAM_EQ_BAND_BOOST
  8576. * - #ASM_PARAM_EQ_BAND_CUT
  8577. */
  8578. uint32_t center_freq_hz;
  8579. /*< Filter band center frequency in Hertz. */
  8580. int32_t filter_gain;
  8581. /*< Filter band initial gain.
  8582. * Supported values: +12 to -12 dB in 1 dB increments
  8583. */
  8584. int32_t q_factor;
  8585. /*< Filter band quality factor expressed as a Q8 number, i.e., a
  8586. * fixed-point number with q factor of 8. For example, 3000/(2^8).
  8587. */
  8588. } __packed;
  8589. struct asm_eq_params {
  8590. uint32_t enable_flag;
  8591. /*< Specifies whether the equalizer module is disabled (0) or enabled
  8592. * (nonzero).
  8593. */
  8594. uint32_t num_bands;
  8595. /*< Number of bands.
  8596. * Supported values: 1 to 12
  8597. */
  8598. struct asm_eq_per_band_params eq_bands[ASM_MAX_EQ_BANDS];
  8599. } __packed;
  8600. /* No equalizer effect.*/
  8601. #define ASM_PARAM_EQYPE_NONE 0
  8602. /* Bass boost equalizer effect.*/
  8603. #define ASM_PARAM_EQ_BASS_BOOST 1
  8604. /*Bass cut equalizer effect.*/
  8605. #define ASM_PARAM_EQ_BASS_CUT 2
  8606. /* Treble boost equalizer effect */
  8607. #define ASM_PARAM_EQREBLE_BOOST 3
  8608. /* Treble cut equalizer effect.*/
  8609. #define ASM_PARAM_EQREBLE_CUT 4
  8610. /* Band boost equalizer effect.*/
  8611. #define ASM_PARAM_EQ_BAND_BOOST 5
  8612. /* Band cut equalizer effect.*/
  8613. #define ASM_PARAM_EQ_BAND_CUT 6
  8614. /* Get & set params */
  8615. #define VSS_ICOMMON_CMD_SET_PARAM_V2 0x0001133D
  8616. #define VSS_ICOMMON_CMD_GET_PARAM_V2 0x0001133E
  8617. #define VSS_ICOMMON_RSP_GET_PARAM 0x00011008
  8618. #define VSS_ICOMMON_CMD_SET_PARAM_V3 0x00013245
  8619. #define VSS_ICOMMON_CMD_GET_PARAM_V3 0x00013246
  8620. #define VSS_ICOMMON_RSP_GET_PARAM_V3 0x00013247
  8621. #define VSS_MAX_AVCS_NUM_SERVICES 25
  8622. /* ID of the Bass Boost module.
  8623. * This module supports the following parameter IDs:
  8624. * - #AUDPROC_PARAM_ID_BASS_BOOST_ENABLE
  8625. * - #AUDPROC_PARAM_ID_BASS_BOOST_MODE
  8626. * - #AUDPROC_PARAM_ID_BASS_BOOST_STRENGTH
  8627. */
  8628. #define AUDPROC_MODULE_ID_BASS_BOOST 0x000108A1
  8629. /* ID of the Bass Boost enable parameter used by
  8630. * AUDPROC_MODULE_ID_BASS_BOOST.
  8631. */
  8632. #define AUDPROC_PARAM_ID_BASS_BOOST_ENABLE 0x000108A2
  8633. /* ID of the Bass Boost mode parameter used by
  8634. * AUDPROC_MODULE_ID_BASS_BOOST.
  8635. */
  8636. #define AUDPROC_PARAM_ID_BASS_BOOST_MODE 0x000108A3
  8637. /* ID of the Bass Boost strength parameter used by
  8638. * AUDPROC_MODULE_ID_BASS_BOOST.
  8639. */
  8640. #define AUDPROC_PARAM_ID_BASS_BOOST_STRENGTH 0x000108A4
  8641. /* ID of the PBE module.
  8642. * This module supports the following parameter IDs:
  8643. * - #AUDPROC_PARAM_ID_PBE_ENABLE
  8644. * - #AUDPROC_PARAM_ID_PBE_PARAM_CONFIG
  8645. */
  8646. #define AUDPROC_MODULE_ID_PBE 0x00010C2A
  8647. /* ID of the Bass Boost enable parameter used by
  8648. * AUDPROC_MODULE_ID_BASS_BOOST.
  8649. */
  8650. #define AUDPROC_PARAM_ID_PBE_ENABLE 0x00010C2B
  8651. /* ID of the Bass Boost mode parameter used by
  8652. * AUDPROC_MODULE_ID_BASS_BOOST.
  8653. */
  8654. #define AUDPROC_PARAM_ID_PBE_PARAM_CONFIG 0x00010C49
  8655. /* ID of the Virtualizer module. This module supports the
  8656. * following parameter IDs:
  8657. * - #AUDPROC_PARAM_ID_VIRTUALIZER_ENABLE
  8658. * - #AUDPROC_PARAM_ID_VIRTUALIZER_STRENGTH
  8659. * - #AUDPROC_PARAM_ID_VIRTUALIZER_OUT_TYPE
  8660. * - #AUDPROC_PARAM_ID_VIRTUALIZER_GAIN_ADJUST
  8661. */
  8662. #define AUDPROC_MODULE_ID_VIRTUALIZER 0x000108A5
  8663. /* ID of the Virtualizer enable parameter used by
  8664. * AUDPROC_MODULE_ID_VIRTUALIZER.
  8665. */
  8666. #define AUDPROC_PARAM_ID_VIRTUALIZER_ENABLE 0x000108A6
  8667. /* ID of the Virtualizer strength parameter used by
  8668. * AUDPROC_MODULE_ID_VIRTUALIZER.
  8669. */
  8670. #define AUDPROC_PARAM_ID_VIRTUALIZER_STRENGTH 0x000108A7
  8671. /* ID of the Virtualizer out type parameter used by
  8672. * AUDPROC_MODULE_ID_VIRTUALIZER.
  8673. */
  8674. #define AUDPROC_PARAM_ID_VIRTUALIZER_OUT_TYPE 0x000108A8
  8675. /* ID of the Virtualizer out type parameter used by
  8676. * AUDPROC_MODULE_ID_VIRTUALIZER.
  8677. */
  8678. #define AUDPROC_PARAM_ID_VIRTUALIZER_GAIN_ADJUST 0x000108A9
  8679. /* ID of the Reverb module. This module supports the following
  8680. * parameter IDs:
  8681. * - #AUDPROC_PARAM_ID_REVERB_ENABLE
  8682. * - #AUDPROC_PARAM_ID_REVERB_MODE
  8683. * - #AUDPROC_PARAM_ID_REVERB_PRESET
  8684. * - #AUDPROC_PARAM_ID_REVERB_WET_MIX
  8685. * - #AUDPROC_PARAM_ID_REVERB_GAIN_ADJUST
  8686. * - #AUDPROC_PARAM_ID_REVERB_ROOM_LEVEL
  8687. * - #AUDPROC_PARAM_ID_REVERB_ROOM_HF_LEVEL
  8688. * - #AUDPROC_PARAM_ID_REVERB_DECAY_TIME
  8689. * - #AUDPROC_PARAM_ID_REVERB_DECAY_HF_RATIO
  8690. * - #AUDPROC_PARAM_ID_REVERB_REFLECTIONS_LEVEL
  8691. * - #AUDPROC_PARAM_ID_REVERB_REFLECTIONS_DELAY
  8692. * - #AUDPROC_PARAM_ID_REVERB_LEVEL
  8693. * - #AUDPROC_PARAM_ID_REVERB_DELAY
  8694. * - #AUDPROC_PARAM_ID_REVERB_DIFFUSION
  8695. * - #AUDPROC_PARAM_ID_REVERB_DENSITY
  8696. */
  8697. #define AUDPROC_MODULE_ID_REVERB 0x000108AA
  8698. /* ID of the Reverb enable parameter used by
  8699. * AUDPROC_MODULE_ID_REVERB.
  8700. */
  8701. #define AUDPROC_PARAM_ID_REVERB_ENABLE 0x000108AB
  8702. /* ID of the Reverb mode parameter used by
  8703. * AUDPROC_MODULE_ID_REVERB.
  8704. */
  8705. #define AUDPROC_PARAM_ID_REVERB_MODE 0x000108AC
  8706. /* ID of the Reverb preset parameter used by
  8707. * AUDPROC_MODULE_ID_REVERB.
  8708. */
  8709. #define AUDPROC_PARAM_ID_REVERB_PRESET 0x000108AD
  8710. /* ID of the Reverb wet mix parameter used by
  8711. * AUDPROC_MODULE_ID_REVERB.
  8712. */
  8713. #define AUDPROC_PARAM_ID_REVERB_WET_MIX 0x000108AE
  8714. /* ID of the Reverb gain adjust parameter used by
  8715. * AUDPROC_MODULE_ID_REVERB.
  8716. */
  8717. #define AUDPROC_PARAM_ID_REVERB_GAIN_ADJUST 0x000108AF
  8718. /* ID of the Reverb room level parameter used by
  8719. * AUDPROC_MODULE_ID_REVERB.
  8720. */
  8721. #define AUDPROC_PARAM_ID_REVERB_ROOM_LEVEL 0x000108B0
  8722. /* ID of the Reverb room hf level parameter used by
  8723. * AUDPROC_MODULE_ID_REVERB.
  8724. */
  8725. #define AUDPROC_PARAM_ID_REVERB_ROOM_HF_LEVEL 0x000108B1
  8726. /* ID of the Reverb decay time parameter used by
  8727. * AUDPROC_MODULE_ID_REVERB.
  8728. */
  8729. #define AUDPROC_PARAM_ID_REVERB_DECAY_TIME 0x000108B2
  8730. /* ID of the Reverb decay hf ratio parameter used by
  8731. * AUDPROC_MODULE_ID_REVERB.
  8732. */
  8733. #define AUDPROC_PARAM_ID_REVERB_DECAY_HF_RATIO 0x000108B3
  8734. /* ID of the Reverb reflections level parameter used by
  8735. * AUDPROC_MODULE_ID_REVERB.
  8736. */
  8737. #define AUDPROC_PARAM_ID_REVERB_REFLECTIONS_LEVEL 0x000108B4
  8738. /* ID of the Reverb reflections delay parameter used by
  8739. * AUDPROC_MODULE_ID_REVERB.
  8740. */
  8741. #define AUDPROC_PARAM_ID_REVERB_REFLECTIONS_DELAY 0x000108B5
  8742. /* ID of the Reverb level parameter used by
  8743. * AUDPROC_MODULE_ID_REVERB.
  8744. */
  8745. #define AUDPROC_PARAM_ID_REVERB_LEVEL 0x000108B6
  8746. /* ID of the Reverb delay parameter used by
  8747. * AUDPROC_MODULE_ID_REVERB.
  8748. */
  8749. #define AUDPROC_PARAM_ID_REVERB_DELAY 0x000108B7
  8750. /* ID of the Reverb diffusion parameter used by
  8751. * AUDPROC_MODULE_ID_REVERB.
  8752. */
  8753. #define AUDPROC_PARAM_ID_REVERB_DIFFUSION 0x000108B8
  8754. /* ID of the Reverb density parameter used by
  8755. * AUDPROC_MODULE_ID_REVERB.
  8756. */
  8757. #define AUDPROC_PARAM_ID_REVERB_DENSITY 0x000108B9
  8758. /* ID of the Popless Equalizer module. This module supports the
  8759. * following parameter IDs:
  8760. * - #AUDPROC_PARAM_ID_EQ_ENABLE
  8761. * - #AUDPROC_PARAM_ID_EQ_CONFIG
  8762. * - #AUDPROC_PARAM_ID_EQ_NUM_BANDS
  8763. * - #AUDPROC_PARAM_ID_EQ_BAND_LEVELS
  8764. * - #AUDPROC_PARAM_ID_EQ_BAND_LEVEL_RANGE
  8765. * - #AUDPROC_PARAM_ID_EQ_BAND_FREQS
  8766. * - #AUDPROC_PARAM_ID_EQ_SINGLE_BAND_FREQ_RANGE
  8767. * - #AUDPROC_PARAM_ID_EQ_SINGLE_BAND_FREQ
  8768. * - #AUDPROC_PARAM_ID_EQ_BAND_INDEX
  8769. * - #AUDPROC_PARAM_ID_EQ_PRESET_ID
  8770. * - #AUDPROC_PARAM_ID_EQ_NUM_PRESETS
  8771. * - #AUDPROC_PARAM_ID_EQ_GET_PRESET_NAME
  8772. */
  8773. #define AUDPROC_MODULE_ID_POPLESS_EQUALIZER 0x000108BA
  8774. /* ID of the Popless Equalizer enable parameter used by
  8775. * AUDPROC_MODULE_ID_POPLESS_EQUALIZER.
  8776. */
  8777. #define AUDPROC_PARAM_ID_EQ_ENABLE 0x000108BB
  8778. /* ID of the Popless Equalizer config parameter used by
  8779. * AUDPROC_MODULE_ID_POPLESS_EQUALIZER.
  8780. */
  8781. #define AUDPROC_PARAM_ID_EQ_CONFIG 0x000108BC
  8782. /* ID of the Popless Equalizer number of bands parameter used
  8783. * by AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is
  8784. * used for get param only.
  8785. */
  8786. #define AUDPROC_PARAM_ID_EQ_NUM_BANDS 0x000108BD
  8787. /* ID of the Popless Equalizer band levels parameter used by
  8788. * AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is
  8789. * used for get param only.
  8790. */
  8791. #define AUDPROC_PARAM_ID_EQ_BAND_LEVELS 0x000108BE
  8792. /* ID of the Popless Equalizer band level range parameter used
  8793. * by AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is
  8794. * used for get param only.
  8795. */
  8796. #define AUDPROC_PARAM_ID_EQ_BAND_LEVEL_RANGE 0x000108BF
  8797. /* ID of the Popless Equalizer band frequencies parameter used
  8798. * by AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is
  8799. * used for get param only.
  8800. */
  8801. #define AUDPROC_PARAM_ID_EQ_BAND_FREQS 0x000108C0
  8802. /* ID of the Popless Equalizer single band frequency range
  8803. * parameter used by AUDPROC_MODULE_ID_POPLESS_EQUALIZER.
  8804. * This param ID is used for get param only.
  8805. */
  8806. #define AUDPROC_PARAM_ID_EQ_SINGLE_BAND_FREQ_RANGE 0x000108C1
  8807. /* ID of the Popless Equalizer single band frequency parameter
  8808. * used by AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID
  8809. * is used for set param only.
  8810. */
  8811. #define AUDPROC_PARAM_ID_EQ_SINGLE_BAND_FREQ 0x000108C2
  8812. /* ID of the Popless Equalizer band index parameter used by
  8813. * AUDPROC_MODULE_ID_POPLESS_EQUALIZER.
  8814. */
  8815. #define AUDPROC_PARAM_ID_EQ_BAND_INDEX 0x000108C3
  8816. /* ID of the Popless Equalizer preset id parameter used by
  8817. * AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is used
  8818. * for get param only.
  8819. */
  8820. #define AUDPROC_PARAM_ID_EQ_PRESET_ID 0x000108C4
  8821. /* ID of the Popless Equalizer number of presets parameter used
  8822. * by AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is used
  8823. * for get param only.
  8824. */
  8825. #define AUDPROC_PARAM_ID_EQ_NUM_PRESETS 0x000108C5
  8826. /* ID of the Popless Equalizer preset name parameter used by
  8827. * AUDPROC_MODULE_ID_POPLESS_EQUALIZER. This param ID is used
  8828. * for get param only.
  8829. */
  8830. #define AUDPROC_PARAM_ID_EQ_PRESET_NAME 0x000108C6
  8831. /* Set Q6 topologies */
  8832. #define ASM_CMD_ADD_TOPOLOGIES 0x00010DBE
  8833. #define ADM_CMD_ADD_TOPOLOGIES 0x00010335
  8834. #define AFE_CMD_ADD_TOPOLOGIES 0x000100f8
  8835. /* structure used for both ioctls */
  8836. struct cmd_set_topologies {
  8837. struct apr_hdr hdr;
  8838. u32 payload_addr_lsw;
  8839. /* LSW of parameter data payload address.*/
  8840. u32 payload_addr_msw;
  8841. /* MSW of parameter data payload address.*/
  8842. u32 mem_map_handle;
  8843. /* Memory map handle returned by mem map command */
  8844. u32 payload_size;
  8845. /* Size in bytes of the variable payload in shared memory */
  8846. } __packed;
  8847. /* This module represents the Rx processing of Feedback speaker protection.
  8848. * It contains the excursion control, thermal protection,
  8849. * analog clip manager features in it.
  8850. * This module id will support following param ids.
  8851. * - AFE_PARAM_ID_FBSP_MODE_RX_CFG
  8852. */
  8853. #define AFE_MODULE_FB_SPKR_PROT_RX 0x0001021C
  8854. #define AFE_MODULE_FB_SPKR_PROT_V2_RX 0x0001025F
  8855. #define AFE_PARAM_ID_SP_RX_LIMITER_TH 0x000102B1
  8856. #define AFE_PARAM_ID_FBSP_MODE_RX_CFG 0x0001021D
  8857. #define AFE_PARAM_ID_FBSP_PTONE_RAMP_CFG 0x00010260
  8858. #define AFE_PARAM_ID_SP_RX_TMAX_XMAX_LOGGING 0x000102BC
  8859. struct asm_fbsp_mode_rx_cfg {
  8860. uint32_t minor_version;
  8861. uint32_t mode;
  8862. } __packed;
  8863. /* This module represents the VI processing of feedback speaker protection.
  8864. * It will receive Vsens and Isens from codec and generates necessary
  8865. * parameters needed by Rx processing.
  8866. * This module id will support following param ids.
  8867. * - AFE_PARAM_ID_SPKR_CALIB_VI_PROC_CFG
  8868. * - AFE_PARAM_ID_CALIB_RES_CFG
  8869. * - AFE_PARAM_ID_FEEDBACK_PATH_CFG
  8870. */
  8871. #define AFE_MODULE_FB_SPKR_PROT_VI_PROC 0x00010226
  8872. #define AFE_MODULE_FB_SPKR_PROT_VI_PROC_V2 0x0001026A
  8873. #define AFE_PARAM_ID_SPKR_CALIB_VI_PROC_CFG 0x0001022A
  8874. #define AFE_PARAM_ID_SPKR_CALIB_VI_PROC_CFG_V2 0x0001026B
  8875. struct asm_spkr_calib_vi_proc_cfg {
  8876. uint32_t minor_version;
  8877. uint32_t operation_mode;
  8878. uint32_t r0_t0_selection_flag[SP_V2_NUM_MAX_SPKR];
  8879. int32_t r0_cali_q24[SP_V2_NUM_MAX_SPKR];
  8880. int16_t t0_cali_q6[SP_V2_NUM_MAX_SPKR];
  8881. uint32_t quick_calib_flag;
  8882. } __packed;
  8883. #define AFE_PARAM_ID_CALIB_RES_CFG 0x0001022B
  8884. #define AFE_PARAM_ID_CALIB_RES_CFG_V2 0x0001026E
  8885. struct asm_calib_res_cfg {
  8886. uint32_t minor_version;
  8887. int32_t r0_cali_q24[SP_V2_NUM_MAX_SPKR];
  8888. uint32_t th_vi_ca_state;
  8889. } __packed;
  8890. #define AFE_PARAM_ID_FEEDBACK_PATH_CFG 0x0001022C
  8891. #define AFE_MODULE_FEEDBACK 0x00010257
  8892. struct asm_feedback_path_cfg {
  8893. uint32_t minor_version;
  8894. int32_t dst_portid;
  8895. int32_t num_channels;
  8896. int32_t chan_info[4];
  8897. } __packed;
  8898. #define AFE_PARAM_ID_MODE_VI_PROC_CFG 0x00010227
  8899. struct asm_mode_vi_proc_cfg {
  8900. uint32_t minor_version;
  8901. uint32_t cal_mode;
  8902. } __packed;
  8903. #define AFE_MODULE_SPEAKER_PROTECTION_V2_TH_VI 0x0001026A
  8904. #define AFE_PARAM_ID_SP_V2_TH_VI_MODE_CFG 0x0001026B
  8905. #define AFE_PARAM_ID_SP_V2_TH_VI_FTM_CFG 0x0001029F
  8906. #define AFE_PARAM_ID_SP_V2_TH_VI_FTM_PARAMS 0x000102A0
  8907. #define AFE_PARAM_ID_SP_V2_TH_VI_V_VALI_CFG 0x000102BF
  8908. #define AFE_PARAM_ID_SP_V2_TH_VI_V_VALI_PARAMS 0x000102C0
  8909. struct afe_sp_th_vi_mode_cfg {
  8910. uint32_t minor_version;
  8911. uint32_t operation_mode;
  8912. /*
  8913. * Operation mode of thermal VI module.
  8914. * 0 -- Normal Running mode
  8915. * 1 -- Calibration mode
  8916. * 2 -- FTM mode
  8917. */
  8918. uint32_t r0t0_selection_flag[SP_V2_NUM_MAX_SPKR];
  8919. /*
  8920. * Specifies which set of R0, T0 values the algorithm will use.
  8921. * This field is valid only in Normal mode (operation_mode = 0).
  8922. * 0 -- Use calibrated R0, T0 value
  8923. * 1 -- Use safe R0, T0 value
  8924. */
  8925. int32_t r0_cali_q24[SP_V2_NUM_MAX_SPKR];
  8926. /*
  8927. * Calibration point resistance per device. This field is valid
  8928. * only in Normal mode (operation_mode = 0).
  8929. * values 33554432 to 1073741824 Ohms (in Q24 format)
  8930. */
  8931. int16_t t0_cali_q6[SP_V2_NUM_MAX_SPKR];
  8932. /*
  8933. * Calibration point temperature per device. This field is valid
  8934. * in both Normal mode and Calibration mode.
  8935. * values -1920 to 5120 degrees C (in Q6 format)
  8936. */
  8937. uint32_t quick_calib_flag;
  8938. /*
  8939. * Indicates whether calibration is to be done in quick mode or not.
  8940. * This field is valid only in Calibration mode (operation_mode = 1).
  8941. * 0 -- Disabled
  8942. * 1 -- Enabled
  8943. */
  8944. } __packed;
  8945. struct afe_sp_th_vi_ftm_cfg {
  8946. uint32_t minor_version;
  8947. uint32_t wait_time_ms[SP_V2_NUM_MAX_SPKR];
  8948. /*
  8949. * Wait time to heat up speaker before collecting statistics
  8950. * for ftm mode in ms.
  8951. * values 0 to 4294967295 ms
  8952. */
  8953. uint32_t ftm_time_ms[SP_V2_NUM_MAX_SPKR];
  8954. /*
  8955. * duration for which FTM statistics are collected in ms.
  8956. * values 0 to 2000 ms
  8957. */
  8958. } __packed;
  8959. struct afe_sp_th_vi_ftm_params {
  8960. uint32_t minor_version;
  8961. int32_t dc_res_q24[SP_V2_NUM_MAX_SPKR];
  8962. /*
  8963. * DC resistance value in q24 format
  8964. * values 0 to 2147483647 Ohms (in Q24 format)
  8965. */
  8966. int32_t temp_q22[SP_V2_NUM_MAX_SPKR];
  8967. /*
  8968. * temperature value in q22 format
  8969. * values -125829120 to 2147483647 degC (in Q22 format)
  8970. */
  8971. uint32_t status[SP_V2_NUM_MAX_SPKR];
  8972. /*
  8973. * FTM packet status
  8974. * 0 - Incorrect operation mode.This status is returned
  8975. * when GET_PARAM is called in non FTM Mode
  8976. * 1 - Inactive mode -- Port is not yet started.
  8977. * 2 - Wait state. wait_time_ms has not yet elapsed
  8978. * 3 - In progress state. ftm_time_ms has not yet elapsed.
  8979. * 4 - Success.
  8980. * 5 - Failed.
  8981. */
  8982. } __packed;
  8983. struct afe_sp_th_vi_get_param {
  8984. struct param_hdr_v3 pdata;
  8985. struct afe_sp_th_vi_ftm_params param;
  8986. } __packed;
  8987. struct afe_sp_th_vi_get_param_resp {
  8988. uint32_t status;
  8989. struct param_hdr_v3 pdata;
  8990. struct afe_sp_th_vi_ftm_params param;
  8991. } __packed;
  8992. struct afe_sp_th_vi_v_vali_cfg {
  8993. uint32_t minor_version;
  8994. uint32_t wait_time_ms[SP_V2_NUM_MAX_SPKR];
  8995. /*
  8996. * Wait time to heat up speaker before collecting statistics
  8997. * for V validation mode in ms.
  8998. * values 100 to 1000 ms
  8999. */
  9000. uint32_t vali_time_ms[SP_V2_NUM_MAX_SPKR];
  9001. /*
  9002. * duration for which V VALIDATION statistics are collected in ms.
  9003. * values 1000 to 3000 ms
  9004. */
  9005. } __packed;
  9006. struct afe_sp_th_vi_v_vali_params {
  9007. uint32_t minor_version;
  9008. uint32_t vrms_q24[SP_V2_NUM_MAX_SPKR];
  9009. /*
  9010. * Vrms value in q24 format
  9011. * values [0 33554432] Q24 (0 - 2Vrms)
  9012. */
  9013. uint32_t status[SP_V2_NUM_MAX_SPKR];
  9014. /*
  9015. * v-vali packet status
  9016. * 0 - Failed.
  9017. * 1 - Success.
  9018. * 2 - Incorrect operation mode.This status is returned
  9019. * when GET_PARAM is called in non v-vali Mode
  9020. * 3 - Inactive mode -- Port is not yet started.
  9021. * 4 - Wait state. wait_time_ms has not yet elapsed
  9022. * 5 - In progress state. ftm_time_ms has not yet elapsed.
  9023. */
  9024. } __packed;
  9025. struct afe_sp_th_vi_v_vali_get_param {
  9026. struct param_hdr_v3 pdata;
  9027. struct afe_sp_th_vi_v_vali_params param;
  9028. } __packed;
  9029. struct afe_sp_th_vi_v_vali_get_param_resp {
  9030. uint32_t status;
  9031. struct param_hdr_v3 pdata;
  9032. struct afe_sp_th_vi_v_vali_params param;
  9033. } __packed;
  9034. #define AFE_MODULE_SPEAKER_PROTECTION_V2_EX_VI 0x0001026F
  9035. #define AFE_PARAM_ID_SP_V2_EX_VI_MODE_CFG 0x000102A1
  9036. #define AFE_PARAM_ID_SP_V2_EX_VI_FTM_CFG 0x000102A2
  9037. #define AFE_PARAM_ID_SP_V2_EX_VI_FTM_PARAMS 0x000102A3
  9038. struct afe_sp_ex_vi_mode_cfg {
  9039. uint32_t minor_version;
  9040. uint32_t operation_mode;
  9041. /*
  9042. * Operation mode of Excursion VI module.
  9043. * 0 - Normal Running mode
  9044. * 2 - FTM mode
  9045. */
  9046. } __packed;
  9047. struct afe_sp_ex_vi_ftm_cfg {
  9048. uint32_t minor_version;
  9049. uint32_t wait_time_ms[SP_V2_NUM_MAX_SPKR];
  9050. /*
  9051. * Wait time to heat up speaker before collecting statistics
  9052. * for ftm mode in ms.
  9053. * values 0 to 4294967295 ms
  9054. */
  9055. uint32_t ftm_time_ms[SP_V2_NUM_MAX_SPKR];
  9056. /*
  9057. * duration for which FTM statistics are collected in ms.
  9058. * values 0 to 2000 ms
  9059. */
  9060. } __packed;
  9061. struct afe_sp_ex_vi_ftm_params {
  9062. uint32_t minor_version;
  9063. int32_t freq_q20[SP_V2_NUM_MAX_SPKR];
  9064. /*
  9065. * Resonance frequency in q20 format
  9066. * values 0 to 2147483647 Hz (in Q20 format)
  9067. */
  9068. int32_t resis_q24[SP_V2_NUM_MAX_SPKR];
  9069. /*
  9070. * Mechanical resistance in q24 format
  9071. * values 0 to 2147483647 Ohms (in Q24 format)
  9072. */
  9073. int32_t qmct_q24[SP_V2_NUM_MAX_SPKR];
  9074. /*
  9075. * Mechanical Qfactor in q24 format
  9076. * values 0 to 2147483647 (in Q24 format)
  9077. */
  9078. uint32_t status[SP_V2_NUM_MAX_SPKR];
  9079. /*
  9080. * FTM packet status
  9081. * 0 - Incorrect operation mode.This status is returned
  9082. * when GET_PARAM is called in non FTM Mode.
  9083. * 1 - Inactive mode -- Port is not yet started.
  9084. * 2 - Wait state. wait_time_ms has not yet elapsed
  9085. * 3 - In progress state. ftm_time_ms has not yet elapsed.
  9086. * 4 - Success.
  9087. * 5 - Failed.
  9088. */
  9089. } __packed;
  9090. struct afe_sp_rx_tmax_xmax_logging_param {
  9091. /*
  9092. * Maximum excursion since the last grasp of xmax in mm.
  9093. */
  9094. int32_t max_excursion[SP_V2_NUM_MAX_SPKR];
  9095. /*
  9096. * Number of periods when the monitored excursion exceeds to and
  9097. * stays at Xmax during logging_count_period.
  9098. */
  9099. uint32_t count_exceeded_excursion[SP_V2_NUM_MAX_SPKR];
  9100. /*
  9101. * Maximum temperature since the last grasp of tmax in C.
  9102. */
  9103. int32_t max_temperature[SP_V2_NUM_MAX_SPKR];
  9104. /*
  9105. * Number of periods when the monitored temperature exceeds to and
  9106. * stays at Tmax during logging_count_period
  9107. */
  9108. uint32_t count_exceeded_temperature[SP_V2_NUM_MAX_SPKR];
  9109. } __packed;
  9110. struct afe_sp_rx_tmax_xmax_logging_resp {
  9111. uint32_t status;
  9112. struct param_hdr_v3 pdata;
  9113. struct afe_sp_rx_tmax_xmax_logging_param param;
  9114. } __packed;
  9115. struct afe_sp_ex_vi_get_param {
  9116. struct param_hdr_v3 pdata;
  9117. struct afe_sp_ex_vi_ftm_params param;
  9118. } __packed;
  9119. struct afe_sp_ex_vi_get_param_resp {
  9120. uint32_t status;
  9121. struct param_hdr_v3 pdata;
  9122. struct afe_sp_ex_vi_ftm_params param;
  9123. } __packed;
  9124. struct afe_sp_rx_limiter_th_param {
  9125. uint32_t minor_version;
  9126. uint32_t lim_thr_per_calib_q27[SP_V2_NUM_MAX_SPKR];
  9127. } __packed;
  9128. union afe_spkr_prot_config {
  9129. struct asm_fbsp_mode_rx_cfg mode_rx_cfg;
  9130. struct asm_spkr_calib_vi_proc_cfg vi_proc_cfg;
  9131. struct asm_feedback_path_cfg feedback_path_cfg;
  9132. struct asm_mode_vi_proc_cfg mode_vi_proc_cfg;
  9133. struct afe_sp_th_vi_mode_cfg th_vi_mode_cfg;
  9134. struct afe_sp_th_vi_ftm_cfg th_vi_ftm_cfg;
  9135. struct afe_sp_th_vi_v_vali_cfg th_vi_v_vali_cfg;
  9136. struct afe_sp_ex_vi_mode_cfg ex_vi_mode_cfg;
  9137. struct afe_sp_ex_vi_ftm_cfg ex_vi_ftm_cfg;
  9138. struct afe_sp_rx_limiter_th_param limiter_th_cfg;
  9139. } __packed;
  9140. struct afe_spkr_prot_get_vi_calib {
  9141. struct apr_hdr hdr;
  9142. struct mem_mapping_hdr mem_hdr;
  9143. struct param_hdr_v3 pdata;
  9144. struct asm_calib_res_cfg res_cfg;
  9145. } __packed;
  9146. struct afe_spkr_prot_calib_get_resp {
  9147. uint32_t status;
  9148. struct param_hdr_v3 pdata;
  9149. struct asm_calib_res_cfg res_cfg;
  9150. } __packed;
  9151. /* SRS TRUMEDIA start */
  9152. /* topology */
  9153. #define SRS_TRUMEDIA_TOPOLOGY_ID 0x00010D90
  9154. /* module */
  9155. #define SRS_TRUMEDIA_MODULE_ID 0x10005010
  9156. /* parameters */
  9157. #define SRS_TRUMEDIA_PARAMS 0x10005011
  9158. #define SRS_TRUMEDIA_PARAMS_WOWHD 0x10005012
  9159. #define SRS_TRUMEDIA_PARAMS_CSHP 0x10005013
  9160. #define SRS_TRUMEDIA_PARAMS_HPF 0x10005014
  9161. #define SRS_TRUMEDIA_PARAMS_AEQ 0x10005015
  9162. #define SRS_TRUMEDIA_PARAMS_HL 0x10005016
  9163. #define SRS_TRUMEDIA_PARAMS_GEQ 0x10005017
  9164. #define SRS_ID_GLOBAL 0x00000001
  9165. #define SRS_ID_WOWHD 0x00000002
  9166. #define SRS_ID_CSHP 0x00000003
  9167. #define SRS_ID_HPF 0x00000004
  9168. #define SRS_ID_AEQ 0x00000005
  9169. #define SRS_ID_HL 0x00000006
  9170. #define SRS_ID_GEQ 0x00000007
  9171. #define SRS_CMD_UPLOAD 0x7FFF0000
  9172. #define SRS_PARAM_OFFSET_MASK 0x3FFF0000
  9173. #define SRS_PARAM_VALUE_MASK 0x0000FFFF
  9174. struct srs_trumedia_params_GLOBAL {
  9175. uint8_t v1;
  9176. uint8_t v2;
  9177. uint8_t v3;
  9178. uint8_t v4;
  9179. uint8_t v5;
  9180. uint8_t v6;
  9181. uint8_t v7;
  9182. uint8_t v8;
  9183. uint16_t v9;
  9184. } __packed;
  9185. struct srs_trumedia_params_WOWHD {
  9186. uint32_t v1;
  9187. uint16_t v2;
  9188. uint16_t v3;
  9189. uint16_t v4;
  9190. uint16_t v5;
  9191. uint16_t v6;
  9192. uint16_t v7;
  9193. uint16_t v8;
  9194. uint16_t v____A1;
  9195. uint32_t v9;
  9196. uint16_t v10;
  9197. uint16_t v11;
  9198. uint32_t v12[16];
  9199. uint32_t v13[16];
  9200. uint32_t v14[16];
  9201. uint32_t v15[16];
  9202. uint32_t v16;
  9203. uint16_t v17;
  9204. uint16_t v18;
  9205. } __packed;
  9206. struct srs_trumedia_params_CSHP {
  9207. uint32_t v1;
  9208. uint16_t v2;
  9209. uint16_t v3;
  9210. uint16_t v4;
  9211. uint16_t v5;
  9212. uint16_t v6;
  9213. uint16_t v____A1;
  9214. uint32_t v7;
  9215. uint16_t v8;
  9216. uint16_t v9;
  9217. uint32_t v10[16];
  9218. } __packed;
  9219. struct srs_trumedia_params_HPF {
  9220. uint32_t v1;
  9221. uint32_t v2[26];
  9222. } __packed;
  9223. struct srs_trumedia_params_AEQ {
  9224. uint32_t v1;
  9225. uint16_t v2;
  9226. uint16_t v3;
  9227. uint16_t v4;
  9228. uint16_t v____A1;
  9229. uint32_t v5[74];
  9230. uint32_t v6[74];
  9231. uint16_t v7[2048];
  9232. } __packed;
  9233. struct srs_trumedia_params_HL {
  9234. uint16_t v1;
  9235. uint16_t v2;
  9236. uint16_t v3;
  9237. uint16_t v____A1;
  9238. int32_t v4;
  9239. uint32_t v5;
  9240. uint16_t v6;
  9241. uint16_t v____A2;
  9242. uint32_t v7;
  9243. } __packed;
  9244. struct srs_trumedia_params_GEQ {
  9245. int16_t v1[10];
  9246. } __packed;
  9247. struct srs_trumedia_params {
  9248. struct srs_trumedia_params_GLOBAL global;
  9249. struct srs_trumedia_params_WOWHD wowhd;
  9250. struct srs_trumedia_params_CSHP cshp;
  9251. struct srs_trumedia_params_HPF hpf;
  9252. struct srs_trumedia_params_AEQ aeq;
  9253. struct srs_trumedia_params_HL hl;
  9254. struct srs_trumedia_params_GEQ geq;
  9255. } __packed;
  9256. /* SRS TruMedia end */
  9257. #define AUDPROC_PARAM_ID_ENABLE 0x00010904
  9258. #define ASM_STREAM_POSTPROC_TOPO_ID_SA_PLUS 0x1000FFFF
  9259. /* DTS Eagle */
  9260. #define AUDPROC_MODULE_ID_DTS_HPX_PREMIX 0x0001077C
  9261. #define AUDPROC_MODULE_ID_DTS_HPX_POSTMIX 0x0001077B
  9262. #define ASM_STREAM_POSTPROC_TOPO_ID_DTS_HPX 0x00010DED
  9263. #define ASM_STREAM_POSTPROC_TOPO_ID_HPX_PLUS 0x10015000
  9264. #define ASM_STREAM_POSTPROC_TOPO_ID_HPX_MASTER 0x10015001
  9265. /* Opcode to set BT address and license for aptx decoder */
  9266. #define APTX_DECODER_BT_ADDRESS 0x00013201
  9267. #define APTX_CLASSIC_DEC_LICENSE_ID 0x00013202
  9268. struct aptx_dec_bt_addr_cfg {
  9269. uint32_t lap;
  9270. uint32_t uap;
  9271. uint32_t nap;
  9272. } __packed;
  9273. struct aptx_dec_bt_dev_addr {
  9274. struct apr_hdr hdr;
  9275. struct asm_stream_cmd_set_encdec_param encdec;
  9276. struct aptx_dec_bt_addr_cfg bt_addr_cfg;
  9277. } __packed;
  9278. struct asm_aptx_dec_fmt_blk_v2 {
  9279. struct apr_hdr hdr;
  9280. struct asm_data_cmd_media_fmt_update_v2 fmtblk;
  9281. u32 sample_rate;
  9282. /* Number of samples per second.
  9283. * Supported values: 44100 and 48000 Hz
  9284. */
  9285. } __packed;
  9286. /* Q6Core Specific */
  9287. #define AVCS_CMD_GET_FWK_VERSION (0x0001292C)
  9288. #define AVCS_CMDRSP_GET_FWK_VERSION (0x0001292D)
  9289. #define AVCS_SERVICE_ID_ALL (0xFFFFFFFF)
  9290. #define APRV2_IDS_SERVICE_ID_ADSP_CVP_V (0xB)
  9291. #define APRV2_IDS_SERVICE_ID_ADSP_AFE_V (0x4)
  9292. struct avcs_get_fwk_version {
  9293. /*
  9294. * Indicates the major version of the AVS build.
  9295. * This value is incremented on chipset family boundaries.
  9296. */
  9297. uint32_t build_major_version;
  9298. /*
  9299. * Minor version of the AVS build.
  9300. * This value represents the mainline to which the AVS build belongs.
  9301. */
  9302. uint32_t build_minor_version;
  9303. /* Indicates the AVS branch version to which the image belongs. */
  9304. uint32_t build_branch_version;
  9305. /* Indicates the AVS sub-branch or customer product line information. */
  9306. uint32_t build_subbranch_version;
  9307. /* Number of supported AVS services in the current build. */
  9308. uint32_t num_services;
  9309. };
  9310. struct avs_svc_api_info {
  9311. /*
  9312. * APRV2 service IDs for the individual static services.
  9313. *
  9314. * @values
  9315. * - APRV2_IDS_SERVICE_ID_ADSP_CORE_V
  9316. * - APRV2_IDS_SERVICE_ID_ADSP_AFE_V
  9317. * - APRV2_IDS_SERVICE_ID_ADSP_ASM_V
  9318. * - APRV2_IDS_SERVICE_ID_ADSP_ADM_V
  9319. * - APRV2_IDS_SERVICE_ID_ADSP_MVM_V
  9320. * - APRV2_IDS_SERVICE_ID_ADSP_CVS_V
  9321. * - APRV2_IDS_SERVICE_ID_ADSP_CVP_V
  9322. * - APRV2_IDS_SERVICE_ID_ADSP_LSM_V
  9323. */
  9324. uint32_t service_id;
  9325. /*
  9326. * Indicates the API version of the service.
  9327. *
  9328. * Each new API update that warrants a change on the HLOS side triggers
  9329. * an increment in the version.
  9330. */
  9331. uint32_t api_version;
  9332. /*
  9333. * Indicates the API increments on a sub-branch (not on the mainline).
  9334. *
  9335. * API branch version numbers can increment independently on different
  9336. * sub-branches.
  9337. */
  9338. uint32_t api_branch_version;
  9339. };
  9340. struct avcs_fwk_ver_info {
  9341. struct avcs_get_fwk_version avcs_fwk_version;
  9342. struct avs_svc_api_info services[0];
  9343. } __packed;
  9344. /* LSM Specific */
  9345. #define VW_FEAT_DIM (39)
  9346. #define APRV2_IDS_SERVICE_ID_ADSP_ASM_V (0x7)
  9347. #define APRV2_IDS_SERVICE_ID_ADSP_ADM_V (0x8)
  9348. #define APRV2_IDS_SERVICE_ID_ADSP_LSM_V (0xD)
  9349. #define APRV2_IDS_DOMAIN_ID_ADSP_V (0x4)
  9350. #define APRV2_IDS_DOMAIN_ID_APPS_V (0x5)
  9351. #define LSM_SESSION_CMD_SHARED_MEM_MAP_REGIONS (0x00012A7F)
  9352. #define LSM_SESSION_CMDRSP_SHARED_MEM_MAP_REGIONS (0x00012A80)
  9353. #define LSM_SESSION_CMD_SHARED_MEM_UNMAP_REGIONS (0x00012A81)
  9354. #define LSM_SESSION_CMD_OPEN_TX (0x00012A82)
  9355. #define LSM_SESSION_CMD_CLOSE_TX (0x00012A88)
  9356. #define LSM_SESSION_CMD_SET_PARAMS (0x00012A83)
  9357. #define LSM_SESSION_CMD_SET_PARAMS_V2 (0x00012A8F)
  9358. #define LSM_SESSION_CMD_SET_PARAMS_V3 (0x00012A92)
  9359. #define LSM_SESSION_CMD_REGISTER_SOUND_MODEL (0x00012A84)
  9360. #define LSM_SESSION_CMD_DEREGISTER_SOUND_MODEL (0x00012A85)
  9361. #define LSM_SESSION_CMD_START (0x00012A86)
  9362. #define LSM_SESSION_CMD_STOP (0x00012A87)
  9363. #define LSM_SESSION_CMD_EOB (0x00012A89)
  9364. #define LSM_SESSION_CMD_READ (0x00012A8A)
  9365. #define LSM_SESSION_CMD_OPEN_TX_V2 (0x00012A8B)
  9366. #define LSM_SESSION_CMD_OPEN_TX_V3 (0x00012A95)
  9367. #define LSM_CMD_ADD_TOPOLOGIES (0x00012A8C)
  9368. #define LSM_SESSION_EVENT_DETECTION_STATUS (0x00012B00)
  9369. #define LSM_SESSION_EVENT_DETECTION_STATUS_V2 (0x00012B01)
  9370. #define LSM_DATA_EVENT_READ_DONE (0x00012B02)
  9371. #define LSM_DATA_EVENT_STATUS (0x00012B03)
  9372. #define LSM_SESSION_EVENT_DETECTION_STATUS_V3 (0x00012B04)
  9373. #define LSM_SESSION_DETECTION_ENGINE_GENERIC_EVENT (0x00012B06)
  9374. #define LSM_MODULE_ID_VOICE_WAKEUP (0x00012C00)
  9375. #define LSM_PARAM_ID_ENDPOINT_DETECT_THRESHOLD (0x00012C01)
  9376. #define LSM_PARAM_ID_OPERATION_MODE (0x00012C02)
  9377. #define LSM_PARAM_ID_GAIN (0x00012C03)
  9378. #define LSM_PARAM_ID_CONNECT_TO_PORT (0x00012C04)
  9379. #define LSM_PARAM_ID_FEATURE_COMPENSATION_DATA (0x00012C07)
  9380. #define LSM_PARAM_ID_MIN_CONFIDENCE_LEVELS (0x00012C07)
  9381. #define LSM_MODULE_ID_LAB (0x00012C08)
  9382. #define LSM_PARAM_ID_LAB_ENABLE (0x00012C09)
  9383. #define LSM_PARAM_ID_LAB_CONFIG (0x00012C0A)
  9384. #define LSM_MODULE_ID_FRAMEWORK (0x00012C0E)
  9385. #define LSM_PARAM_ID_SWMAD_CFG (0x00012C18)
  9386. #define LSM_PARAM_ID_SWMAD_MODEL (0x00012C19)
  9387. #define LSM_PARAM_ID_SWMAD_ENABLE (0x00012C1A)
  9388. #define LSM_PARAM_ID_POLLING_ENABLE (0x00012C1B)
  9389. #define LSM_PARAM_ID_MEDIA_FMT (0x00012C1E)
  9390. #define LSM_PARAM_ID_FWK_MODE_CONFIG (0x00012C27)
  9391. #define LSM_PARAM_ID_MEDIA_FMT_V2 (0x00012C32)
  9392. #define LSM_PARAM_ID_LAB_OUTPUT_CHANNEL_CONFIG (0x00012C2D)
  9393. /* HW MAD specific */
  9394. #define AFE_MODULE_HW_MAD (0x00010230)
  9395. #define AFE_PARAM_ID_HW_MAD_CFG (0x00010231)
  9396. #define AFE_PARAM_ID_HW_MAD_CTRL (0x00010232)
  9397. #define AFE_PARAM_ID_SLIMBUS_SLAVE_PORT_CFG (0x00010233)
  9398. /* SW MAD specific */
  9399. #define AFE_MODULE_SW_MAD (0x0001022D)
  9400. #define AFE_PARAM_ID_SW_MAD_CFG (0x0001022E)
  9401. #define AFE_PARAM_ID_SVM_MODEL (0x0001022F)
  9402. /* Commands/Params to pass the codec/slimbus data to DSP */
  9403. #define AFE_SVC_CMD_SET_PARAM (0x000100f3)
  9404. #define AFE_SVC_CMD_SET_PARAM_V2 (0x000100fc)
  9405. #define AFE_MODULE_CDC_DEV_CFG (0x00010234)
  9406. #define AFE_PARAM_ID_CDC_SLIMBUS_SLAVE_CFG (0x00010235)
  9407. #define AFE_PARAM_ID_CDC_REG_CFG (0x00010236)
  9408. #define AFE_PARAM_ID_CDC_REG_CFG_INIT (0x00010237)
  9409. #define AFE_PARAM_ID_CDC_REG_PAGE_CFG (0x00010296)
  9410. #define AFE_MAX_CDC_REGISTERS_TO_CONFIG (20)
  9411. /* AANC Port Config Specific */
  9412. #define AFE_PARAM_ID_AANC_PORT_CONFIG (0x00010215)
  9413. #define AFE_API_VERSION_AANC_PORT_CONFIG (0x1)
  9414. #define AANC_TX_MIC_UNUSED (0)
  9415. #define AANC_TX_VOICE_MIC (1)
  9416. #define AANC_TX_ERROR_MIC (2)
  9417. #define AANC_TX_NOISE_MIC (3)
  9418. #define AFE_PORT_MAX_CHANNEL_CNT (8)
  9419. #define AFE_MODULE_AANC (0x00010214)
  9420. #define AFE_PARAM_ID_CDC_AANC_VERSION (0x0001023A)
  9421. #define AFE_API_VERSION_CDC_AANC_VERSION (0x1)
  9422. #define AANC_HW_BLOCK_VERSION_1 (1)
  9423. #define AANC_HW_BLOCK_VERSION_2 (2)
  9424. /*Clip bank selection*/
  9425. #define AFE_API_VERSION_CLIP_BANK_SEL_CFG 0x1
  9426. #define AFE_CLIP_MAX_BANKS 4
  9427. #define AFE_PARAM_ID_CLIP_BANK_SEL_CFG 0x00010242
  9428. struct afe_param_aanc_port_cfg {
  9429. /* Minor version used for tracking the version of the module's
  9430. * source port configuration.
  9431. */
  9432. uint32_t aanc_port_cfg_minor_version;
  9433. /* Sampling rate of the source Tx port. 8k - 192k*/
  9434. uint32_t tx_port_sample_rate;
  9435. /* Channel mapping for the Tx port signal carrying Noise (X),
  9436. * Error (E), and Voice (V) signals.
  9437. */
  9438. uint8_t tx_port_channel_map[AFE_PORT_MAX_CHANNEL_CNT];
  9439. /* Number of channels on the source Tx port. */
  9440. uint16_t tx_port_num_channels;
  9441. /* Port ID of the Rx path reference signal. */
  9442. uint16_t rx_path_ref_port_id;
  9443. /* Sampling rate of the reference port. 8k - 192k*/
  9444. uint32_t ref_port_sample_rate;
  9445. } __packed;
  9446. struct afe_param_id_cdc_aanc_version {
  9447. /* Minor version used for tracking the version of the module's
  9448. * hw version
  9449. */
  9450. uint32_t cdc_aanc_minor_version;
  9451. /* HW version. */
  9452. uint32_t aanc_hw_version;
  9453. } __packed;
  9454. #define AFE_PARAM_ID_AANC_NOISE_REDUCTION 0x000102AB
  9455. struct afe_param_id_aanc_noise_reduction {
  9456. /* Minor version used for tracking the version of the module's
  9457. * hw version
  9458. */
  9459. uint32_t minor_version;
  9460. /* Target noise level */
  9461. int32_t ad_beta;
  9462. } __packed;
  9463. struct afe_param_id_clip_bank_sel {
  9464. /* Minor version used for tracking the version of the module's
  9465. * hw version
  9466. */
  9467. uint32_t minor_version;
  9468. /* Number of banks to be read */
  9469. uint32_t num_banks;
  9470. uint32_t bank_map[AFE_CLIP_MAX_BANKS];
  9471. } __packed;
  9472. /* ERROR CODES */
  9473. /* Success. The operation completed with no errors. */
  9474. #define ADSP_EOK 0x00000000
  9475. /* General failure. */
  9476. #define ADSP_EFAILED 0x00000001
  9477. /* Bad operation parameter. */
  9478. #define ADSP_EBADPARAM 0x00000002
  9479. /* Unsupported routine or operation. */
  9480. #define ADSP_EUNSUPPORTED 0x00000003
  9481. /* Unsupported version. */
  9482. #define ADSP_EVERSION 0x00000004
  9483. /* Unexpected problem encountered. */
  9484. #define ADSP_EUNEXPECTED 0x00000005
  9485. /* Unhandled problem occurred. */
  9486. #define ADSP_EPANIC 0x00000006
  9487. /* Unable to allocate resource. */
  9488. #define ADSP_ENORESOURCE 0x00000007
  9489. /* Invalid handle. */
  9490. #define ADSP_EHANDLE 0x00000008
  9491. /* Operation is already processed. */
  9492. #define ADSP_EALREADY 0x00000009
  9493. /* Operation is not ready to be processed. */
  9494. #define ADSP_ENOTREADY 0x0000000A
  9495. /* Operation is pending completion. */
  9496. #define ADSP_EPENDING 0x0000000B
  9497. /* Operation could not be accepted or processed. */
  9498. #define ADSP_EBUSY 0x0000000C
  9499. /* Operation aborted due to an error. */
  9500. #define ADSP_EABORTED 0x0000000D
  9501. /* Operation preempted by a higher priority. */
  9502. #define ADSP_EPREEMPTED 0x0000000E
  9503. /* Operation requests intervention to complete. */
  9504. #define ADSP_ECONTINUE 0x0000000F
  9505. /* Operation requests immediate intervention to complete. */
  9506. #define ADSP_EIMMEDIATE 0x00000010
  9507. /* Operation is not implemented. */
  9508. #define ADSP_ENOTIMPL 0x00000011
  9509. /* Operation needs more data or resources. */
  9510. #define ADSP_ENEEDMORE 0x00000012
  9511. /* Operation does not have memory. */
  9512. #define ADSP_ENOMEMORY 0x00000014
  9513. /* Item does not exist. */
  9514. #define ADSP_ENOTEXIST 0x00000015
  9515. /* Max count for adsp error code sent to HLOS*/
  9516. #define ADSP_ERR_MAX (ADSP_ENOTEXIST + 1)
  9517. /* Operation is finished. */
  9518. #define ADSP_ETERMINATED 0x00011174
  9519. /*bharath, adsp_error_codes.h */
  9520. /* LPASS clock for I2S Interface */
  9521. /* Supported OSR clock values */
  9522. #define Q6AFE_LPASS_OSR_CLK_12_P288_MHZ 0xBB8000
  9523. #define Q6AFE_LPASS_OSR_CLK_11_P2896_MHZ 0xAC4400
  9524. #define Q6AFE_LPASS_OSR_CLK_9_P600_MHZ 0x927C00
  9525. #define Q6AFE_LPASS_OSR_CLK_8_P192_MHZ 0x7D0000
  9526. #define Q6AFE_LPASS_OSR_CLK_6_P144_MHZ 0x5DC000
  9527. #define Q6AFE_LPASS_OSR_CLK_4_P096_MHZ 0x3E8000
  9528. #define Q6AFE_LPASS_OSR_CLK_3_P072_MHZ 0x2EE000
  9529. #define Q6AFE_LPASS_OSR_CLK_2_P048_MHZ 0x1F4000
  9530. #define Q6AFE_LPASS_OSR_CLK_1_P536_MHZ 0x177000
  9531. #define Q6AFE_LPASS_OSR_CLK_1_P024_MHZ 0xFA000
  9532. #define Q6AFE_LPASS_OSR_CLK_768_kHZ 0xBB800
  9533. #define Q6AFE_LPASS_OSR_CLK_512_kHZ 0x7D000
  9534. #define Q6AFE_LPASS_OSR_CLK_DISABLE 0x0
  9535. /* Supported Bit clock values */
  9536. #define Q6AFE_LPASS_IBIT_CLK_12_P288_MHZ 0xBB8000
  9537. #define Q6AFE_LPASS_IBIT_CLK_11_P2896_MHZ 0xAC4400
  9538. #define Q6AFE_LPASS_IBIT_CLK_8_P192_MHZ 0x7D0000
  9539. #define Q6AFE_LPASS_IBIT_CLK_6_P144_MHZ 0x5DC000
  9540. #define Q6AFE_LPASS_IBIT_CLK_4_P096_MHZ 0x3E8000
  9541. #define Q6AFE_LPASS_IBIT_CLK_3_P072_MHZ 0x2EE000
  9542. #define Q6AFE_LPASS_IBIT_CLK_2_P8224_MHZ 0x2b1100
  9543. #define Q6AFE_LPASS_IBIT_CLK_2_P048_MHZ 0x1F4000
  9544. #define Q6AFE_LPASS_IBIT_CLK_1_P536_MHZ 0x177000
  9545. #define Q6AFE_LPASS_IBIT_CLK_1_P4112_MHZ 0x158880
  9546. #define Q6AFE_LPASS_IBIT_CLK_1_P024_MHZ 0xFA000
  9547. #define Q6AFE_LPASS_IBIT_CLK_768_KHZ 0xBB800
  9548. #define Q6AFE_LPASS_IBIT_CLK_512_KHZ 0x7D000
  9549. #define Q6AFE_LPASS_IBIT_CLK_256_KHZ 0x3E800
  9550. #define Q6AFE_LPASS_IBIT_CLK_DISABLE 0x0
  9551. /* Supported LPASS CLK sources */
  9552. #define Q6AFE_LPASS_CLK_SRC_EXTERNAL 0
  9553. #define Q6AFE_LPASS_CLK_SRC_INTERNAL 1
  9554. /* Supported LPASS CLK root*/
  9555. #define Q6AFE_LPASS_CLK_ROOT_DEFAULT 0
  9556. enum afe_lpass_clk_mode {
  9557. Q6AFE_LPASS_MODE_BOTH_INVALID,
  9558. Q6AFE_LPASS_MODE_CLK1_VALID,
  9559. Q6AFE_LPASS_MODE_CLK2_VALID,
  9560. Q6AFE_LPASS_MODE_BOTH_VALID,
  9561. } __packed;
  9562. /* Clock ID Enumeration Define. */
  9563. /* Clock ID for Primary I2S IBIT */
  9564. #define Q6AFE_LPASS_CLK_ID_PRI_MI2S_IBIT 0x100
  9565. /* Clock ID for Primary I2S EBIT */
  9566. #define Q6AFE_LPASS_CLK_ID_PRI_MI2S_EBIT 0x101
  9567. /* Clock ID for Secondary I2S IBIT */
  9568. #define Q6AFE_LPASS_CLK_ID_SEC_MI2S_IBIT 0x102
  9569. /* Clock ID for Secondary I2S EBIT */
  9570. #define Q6AFE_LPASS_CLK_ID_SEC_MI2S_EBIT 0x103
  9571. /* Clock ID for Tertiary I2S IBIT */
  9572. #define Q6AFE_LPASS_CLK_ID_TER_MI2S_IBIT 0x104
  9573. /* Clock ID for Tertiary I2S EBIT */
  9574. #define Q6AFE_LPASS_CLK_ID_TER_MI2S_EBIT 0x105
  9575. /* Clock ID for Quartnery I2S IBIT */
  9576. #define Q6AFE_LPASS_CLK_ID_QUAD_MI2S_IBIT 0x106
  9577. /* Clock ID for Quartnery I2S EBIT */
  9578. #define Q6AFE_LPASS_CLK_ID_QUAD_MI2S_EBIT 0x107
  9579. /* Clock ID for Speaker I2S IBIT */
  9580. #define Q6AFE_LPASS_CLK_ID_SPEAKER_I2S_IBIT 0x108
  9581. /* Clock ID for Speaker I2S EBIT */
  9582. #define Q6AFE_LPASS_CLK_ID_SPEAKER_I2S_EBIT 0x109
  9583. /* Clock ID for Speaker I2S OSR */
  9584. #define Q6AFE_LPASS_CLK_ID_SPEAKER_I2S_OSR 0x10A
  9585. /* Clock ID for QUINARY I2S IBIT */
  9586. #define Q6AFE_LPASS_CLK_ID_QUI_MI2S_IBIT 0x10B
  9587. /* Clock ID for QUINARY I2S EBIT */
  9588. #define Q6AFE_LPASS_CLK_ID_QUI_MI2S_EBIT 0x10C
  9589. /* Clock ID for SENARY I2S IBIT */
  9590. #define Q6AFE_LPASS_CLK_ID_SEN_MI2S_IBIT 0x10D
  9591. /* Clock ID for SENARY I2S EBIT */
  9592. #define Q6AFE_LPASS_CLK_ID_SEN_MI2S_EBIT 0x10E
  9593. /* Clock ID for INT0 I2S IBIT */
  9594. #define Q6AFE_LPASS_CLK_ID_INT0_MI2S_IBIT 0x10F
  9595. /* Clock ID for INT1 I2S IBIT */
  9596. #define Q6AFE_LPASS_CLK_ID_INT1_MI2S_IBIT 0x110
  9597. /* Clock ID for INT2 I2S IBIT */
  9598. #define Q6AFE_LPASS_CLK_ID_INT2_MI2S_IBIT 0x111
  9599. /* Clock ID for INT3 I2S IBIT */
  9600. #define Q6AFE_LPASS_CLK_ID_INT3_MI2S_IBIT 0x112
  9601. /* Clock ID for INT4 I2S IBIT */
  9602. #define Q6AFE_LPASS_CLK_ID_INT4_MI2S_IBIT 0x113
  9603. /* Clock ID for INT5 I2S IBIT */
  9604. #define Q6AFE_LPASS_CLK_ID_INT5_MI2S_IBIT 0x114
  9605. /* Clock ID for INT6 I2S IBIT */
  9606. #define Q6AFE_LPASS_CLK_ID_INT6_MI2S_IBIT 0x115
  9607. /* Clock ID for QUINARY MI2S OSR CLK */
  9608. #define Q6AFE_LPASS_CLK_ID_QUI_MI2S_OSR 0x116
  9609. /* Clock ID for Primary PCM IBIT */
  9610. #define Q6AFE_LPASS_CLK_ID_PRI_PCM_IBIT 0x200
  9611. /* Clock ID for Primary PCM EBIT */
  9612. #define Q6AFE_LPASS_CLK_ID_PRI_PCM_EBIT 0x201
  9613. /* Clock ID for Secondary PCM IBIT */
  9614. #define Q6AFE_LPASS_CLK_ID_SEC_PCM_IBIT 0x202
  9615. /* Clock ID for Secondary PCM EBIT */
  9616. #define Q6AFE_LPASS_CLK_ID_SEC_PCM_EBIT 0x203
  9617. /* Clock ID for Tertiary PCM IBIT */
  9618. #define Q6AFE_LPASS_CLK_ID_TER_PCM_IBIT 0x204
  9619. /* Clock ID for Tertiary PCM EBIT */
  9620. #define Q6AFE_LPASS_CLK_ID_TER_PCM_EBIT 0x205
  9621. /* Clock ID for Quartery PCM IBIT */
  9622. #define Q6AFE_LPASS_CLK_ID_QUAD_PCM_IBIT 0x206
  9623. /* Clock ID for Quartery PCM EBIT */
  9624. #define Q6AFE_LPASS_CLK_ID_QUAD_PCM_EBIT 0x207
  9625. /* Clock ID for Quinary PCM IBIT */
  9626. #define Q6AFE_LPASS_CLK_ID_QUIN_PCM_IBIT 0x208
  9627. /* Clock ID for Quinary PCM EBIT */
  9628. #define Q6AFE_LPASS_CLK_ID_QUIN_PCM_EBIT 0x209
  9629. /* Clock ID for QUINARY PCM OSR */
  9630. #define Q6AFE_LPASS_CLK_ID_QUI_PCM_OSR 0x20A
  9631. /* Clock ID for Senary PCM IBIT */
  9632. #define Q6AFE_LPASS_CLK_ID_SEN_PCM_IBIT 0x20B
  9633. /* Clock ID for Senary PCM EBIT */
  9634. #define Q6AFE_LPASS_CLK_ID_SEN_PCM_EBIT 0x20C
  9635. /** Clock ID for Primary TDM IBIT */
  9636. #define Q6AFE_LPASS_CLK_ID_PRI_TDM_IBIT 0x200
  9637. /** Clock ID for Primary TDM EBIT */
  9638. #define Q6AFE_LPASS_CLK_ID_PRI_TDM_EBIT 0x201
  9639. /** Clock ID for Secondary TDM IBIT */
  9640. #define Q6AFE_LPASS_CLK_ID_SEC_TDM_IBIT 0x202
  9641. /** Clock ID for Secondary TDM EBIT */
  9642. #define Q6AFE_LPASS_CLK_ID_SEC_TDM_EBIT 0x203
  9643. /** Clock ID for Tertiary TDM IBIT */
  9644. #define Q6AFE_LPASS_CLK_ID_TER_TDM_IBIT 0x204
  9645. /** Clock ID for Tertiary TDM EBIT */
  9646. #define Q6AFE_LPASS_CLK_ID_TER_TDM_EBIT 0x205
  9647. /** Clock ID for Quartery TDM IBIT */
  9648. #define Q6AFE_LPASS_CLK_ID_QUAD_TDM_IBIT 0x206
  9649. /** Clock ID for Quartery TDM EBIT */
  9650. #define Q6AFE_LPASS_CLK_ID_QUAD_TDM_EBIT 0x207
  9651. /** Clock ID for Quinary TDM IBIT */
  9652. #define Q6AFE_LPASS_CLK_ID_QUIN_TDM_IBIT 0x208
  9653. /** Clock ID for Quinary TDM EBIT */
  9654. #define Q6AFE_LPASS_CLK_ID_QUIN_TDM_EBIT 0x209
  9655. /** Clock ID for Quinary TDM OSR */
  9656. #define Q6AFE_LPASS_CLK_ID_QUIN_TDM_OSR 0x20A
  9657. /** Clock ID for Senary TDM IBIT */
  9658. #define Q6AFE_LPASS_CLK_ID_SEN_TDM_IBIT 0x20B
  9659. /** Clock ID for Senary TDM EBIT */
  9660. #define Q6AFE_LPASS_CLK_ID_SEN_TDM_EBIT 0x20C
  9661. /* Clock ID for MCLK1 */
  9662. #define Q6AFE_LPASS_CLK_ID_MCLK_1 0x300
  9663. /* Clock ID for MCLK2 */
  9664. #define Q6AFE_LPASS_CLK_ID_MCLK_2 0x301
  9665. /* Clock ID for MCLK3 */
  9666. #define Q6AFE_LPASS_CLK_ID_MCLK_3 0x302
  9667. /* Clock ID for MCLK4 */
  9668. #define Q6AFE_LPASS_CLK_ID_MCLK_4 0x304
  9669. /* Clock ID for Internal Digital Codec Core */
  9670. #define Q6AFE_LPASS_CLK_ID_INTERNAL_DIGITAL_CODEC_CORE 0x303
  9671. /* Clock ID for INT MCLK0 */
  9672. #define Q6AFE_LPASS_CLK_ID_INT_MCLK_0 0x305
  9673. /* Clock ID for INT MCLK1 */
  9674. #define Q6AFE_LPASS_CLK_ID_INT_MCLK_1 0x306
  9675. /*
  9676. * Clock ID for soundwire NPL.
  9677. * This is the clock to be used to enable NPL clock for internal Soundwire.
  9678. */
  9679. #define AFE_CLOCK_SET_CLOCK_ID_SWR_NPL_CLK 0x307
  9680. /* Clock ID for MCLK5 */
  9681. #define Q6AFE_LPASS_CLK_ID_MCLK_5 0x308
  9682. /* Clock ID for AHB HDMI input */
  9683. #define Q6AFE_LPASS_CLK_ID_AHB_HDMI_INPUT 0x400
  9684. /* Clock ID for the primary SPDIF output core. */
  9685. #define AFE_CLOCK_SET_CLOCK_ID_PRI_SPDIF_OUTPUT_CORE 0x500
  9686. /* Clock ID for the secondary SPDIF output core. */
  9687. #define AFE_CLOCK_SET_CLOCK_ID_SEC_SPDIF_OUTPUT_CORE 0x501
  9688. /* Clock ID for the primary SPDIF input core. */
  9689. #define AFE_CLOCK_SET_CLOCK_ID_PRI_SPDIF_INPUT_CORE 0x502
  9690. /* Clock ID for the secondary SPDIF input core. */
  9691. #define AFE_CLOCK_SET_CLOCK_ID_SEC_SPDIF_INPUT_CORE 0x503
  9692. /* Clock ID for the secondary SPDIF output NPL clk. */
  9693. #define AFE_CLOCK_SET_CLOCK_ID_PRI_SPDIF_OUTPUT_NPL 0x504
  9694. /* Clock ID for the primary SPDIF output NPL clk. */
  9695. #define AFE_CLOCK_SET_CLOCK_ID_SEC_SPDIF_OUTPUT_NPL 0x505
  9696. /* Clock attribute for invalid use (reserved for internal usage) */
  9697. #define Q6AFE_LPASS_CLK_ATTRIBUTE_INVALID 0x0
  9698. /* Clock attribute for no couple case */
  9699. #define Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_NO 0x1
  9700. /* Clock attribute for dividend couple case */
  9701. #define Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_DIVIDEND 0x2
  9702. /* Clock attribute for divisor couple case */
  9703. #define Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_DIVISOR 0x3
  9704. /* Clock attribute for invert and no couple case */
  9705. #define Q6AFE_LPASS_CLK_ATTRIBUTE_INVERT_COUPLE_NO 0x4
  9706. /* Clock set API version */
  9707. #define Q6AFE_LPASS_CLK_CONFIG_API_VERSION 0x1
  9708. struct afe_clk_set {
  9709. /*
  9710. * Minor version used for tracking clock set.
  9711. * @values #AFE_API_VERSION_CLOCK_SET
  9712. */
  9713. uint32_t clk_set_minor_version;
  9714. /*
  9715. * Clock ID
  9716. * @values
  9717. * - 0x100 to 0x10A - MSM8996
  9718. * - 0x200 to 0x207 - MSM8996
  9719. * - 0x300 to 0x302 - MSM8996 @tablebulletend
  9720. */
  9721. uint32_t clk_id;
  9722. /*
  9723. * Clock frequency (in Hertz) to be set.
  9724. * @values
  9725. * - >= 0 for clock frequency to set @tablebulletend
  9726. */
  9727. uint32_t clk_freq_in_hz;
  9728. /* Use to specific divider for two clocks if needed.
  9729. * Set to Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_NO for no divider
  9730. * relation clocks
  9731. * @values
  9732. * - #Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_NO
  9733. * - #Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_DIVIDEND
  9734. * - #Q6AFE_LPASS_CLK_ATTRIBUTE_COUPLE_DIVISOR @tablebulletend
  9735. */
  9736. uint16_t clk_attri;
  9737. /*
  9738. * Specifies the root clock source.
  9739. * Currently, only Q6AFE_LPASS_CLK_ROOT_DEFAULT is valid
  9740. * @values
  9741. * - 0 @tablebulletend
  9742. */
  9743. uint16_t clk_root;
  9744. /*
  9745. * for enable and disable clock.
  9746. * "clk_freq_in_hz", "clk_attri", and "clk_root"
  9747. * are ignored in disable clock case.
  9748. * @values 
  9749. * - 0 -- Disabled
  9750. * - 1 -- Enabled @tablebulletend
  9751. */
  9752. uint32_t enable;
  9753. };
  9754. struct afe_clk_cfg {
  9755. /* Minor version used for tracking the version of the I2S
  9756. * configuration interface.
  9757. * Supported values: #AFE_API_VERSION_I2S_CONFIG
  9758. */
  9759. u32 i2s_cfg_minor_version;
  9760. /* clk value 1 in MHz. */
  9761. u32 clk_val1;
  9762. /* clk value 2 in MHz. */
  9763. u32 clk_val2;
  9764. /* clk_src
  9765. * #Q6AFE_LPASS_CLK_SRC_EXTERNAL
  9766. * #Q6AFE_LPASS_CLK_SRC_INTERNAL
  9767. */
  9768. u16 clk_src;
  9769. /* clk_root -0 for default */
  9770. u16 clk_root;
  9771. /* clk_set_mode
  9772. * #Q6AFE_LPASS_MODE_BOTH_INVALID
  9773. * #Q6AFE_LPASS_MODE_CLK1_VALID
  9774. * #Q6AFE_LPASS_MODE_CLK2_VALID
  9775. * #Q6AFE_LPASS_MODE_BOTH_VALID
  9776. */
  9777. u16 clk_set_mode;
  9778. /* This param id is used to configure I2S clk */
  9779. u16 reserved;
  9780. } __packed;
  9781. /* This param id is used to configure I2S clk */
  9782. #define AFE_PARAM_ID_LPAIF_CLK_CONFIG 0x00010238
  9783. #define AFE_MODULE_CLOCK_SET 0x0001028F
  9784. #define AFE_PARAM_ID_CLOCK_SET 0x00010290
  9785. enum afe_lpass_digital_clk_src {
  9786. Q6AFE_LPASS_DIGITAL_ROOT_INVALID,
  9787. Q6AFE_LPASS_DIGITAL_ROOT_PRI_MI2S_OSR,
  9788. Q6AFE_LPASS_DIGITAL_ROOT_SEC_MI2S_OSR,
  9789. Q6AFE_LPASS_DIGITAL_ROOT_TER_MI2S_OSR,
  9790. Q6AFE_LPASS_DIGITAL_ROOT_QUAD_MI2S_OSR,
  9791. Q6AFE_LPASS_DIGITAL_ROOT_CDC_ROOT_CLK,
  9792. } __packed;
  9793. /* This param id is used to configure internal clk */
  9794. #define AFE_PARAM_ID_INTERNAL_DIGIATL_CDC_CLK_CONFIG 0x00010239
  9795. struct afe_digital_clk_cfg {
  9796. /* Minor version used for tracking the version of the I2S
  9797. * configuration interface.
  9798. * Supported values: #AFE_API_VERSION_I2S_CONFIG
  9799. */
  9800. u32 i2s_cfg_minor_version;
  9801. /* clk value in MHz. */
  9802. u32 clk_val;
  9803. /* INVALID
  9804. * PRI_MI2S_OSR
  9805. * SEC_MI2S_OSR
  9806. * TER_MI2S_OSR
  9807. * QUAD_MI2S_OSR
  9808. * DIGT_CDC_ROOT
  9809. */
  9810. u16 clk_root;
  9811. /* This field must be set to zero. */
  9812. u16 reserved;
  9813. } __packed;
  9814. /*
  9815. * Opcode for AFE to start DTMF.
  9816. */
  9817. #define AFE_PORTS_CMD_DTMF_CTL 0x00010102
  9818. /** DTMF payload.*/
  9819. struct afe_dtmf_generation_command {
  9820. struct apr_hdr hdr;
  9821. /*
  9822. * Duration of the DTMF tone in ms.
  9823. * -1 -> continuous,
  9824. * 0 -> disable
  9825. */
  9826. int64_t duration_in_ms;
  9827. /*
  9828. * The DTMF high tone frequency.
  9829. */
  9830. uint16_t high_freq;
  9831. /*
  9832. * The DTMF low tone frequency.
  9833. */
  9834. uint16_t low_freq;
  9835. /*
  9836. * The DTMF volume setting
  9837. */
  9838. uint16_t gain;
  9839. /*
  9840. * The number of ports to enable/disable on.
  9841. */
  9842. uint16_t num_ports;
  9843. /*
  9844. * The Destination ports - array .
  9845. * For DTMF on multiple ports, portIds needs to
  9846. * be populated numPorts times.
  9847. */
  9848. uint16_t port_ids;
  9849. /*
  9850. * variable for 32 bit alignment of APR packet.
  9851. */
  9852. uint16_t reserved;
  9853. } __packed;
  9854. enum afe_config_type {
  9855. AFE_SLIMBUS_SLAVE_PORT_CONFIG,
  9856. AFE_SLIMBUS_SLAVE_CONFIG,
  9857. AFE_CDC_REGISTERS_CONFIG,
  9858. AFE_AANC_VERSION,
  9859. AFE_CDC_CLIP_REGISTERS_CONFIG,
  9860. AFE_CLIP_BANK_SEL,
  9861. AFE_CDC_REGISTER_PAGE_CONFIG,
  9862. AFE_MAX_CONFIG_TYPES,
  9863. };
  9864. struct afe_param_slimbus_slave_port_cfg {
  9865. uint32_t minor_version;
  9866. uint16_t slimbus_dev_id;
  9867. uint16_t slave_dev_pgd_la;
  9868. uint16_t slave_dev_intfdev_la;
  9869. uint16_t bit_width;
  9870. uint16_t data_format;
  9871. uint16_t num_channels;
  9872. uint16_t slave_port_mapping[AFE_PORT_MAX_AUDIO_CHAN_CNT];
  9873. } __packed;
  9874. struct afe_param_cdc_slimbus_slave_cfg {
  9875. uint32_t minor_version;
  9876. uint32_t device_enum_addr_lsw;
  9877. uint32_t device_enum_addr_msw;
  9878. uint16_t tx_slave_port_offset;
  9879. uint16_t rx_slave_port_offset;
  9880. } __packed;
  9881. struct afe_param_cdc_reg_cfg {
  9882. uint32_t minor_version;
  9883. uint32_t reg_logical_addr;
  9884. uint32_t reg_field_type;
  9885. uint32_t reg_field_bit_mask;
  9886. uint16_t reg_bit_width;
  9887. uint16_t reg_offset_scale;
  9888. } __packed;
  9889. #define AFE_API_VERSION_CDC_REG_PAGE_CFG 1
  9890. enum {
  9891. AFE_CDC_REG_PAGE_ASSIGN_PROC_ID_0 = 0,
  9892. AFE_CDC_REG_PAGE_ASSIGN_PROC_ID_1,
  9893. AFE_CDC_REG_PAGE_ASSIGN_PROC_ID_2,
  9894. AFE_CDC_REG_PAGE_ASSIGN_PROC_ID_3,
  9895. };
  9896. struct afe_param_cdc_reg_page_cfg {
  9897. uint32_t minor_version;
  9898. uint32_t enable;
  9899. uint32_t proc_id;
  9900. } __packed;
  9901. struct afe_param_cdc_reg_cfg_data {
  9902. uint32_t num_registers;
  9903. struct afe_param_cdc_reg_cfg *reg_data;
  9904. } __packed;
  9905. struct afe_svc_cmd_set_param_v1 {
  9906. /* APR Header */
  9907. struct apr_hdr apr_hdr;
  9908. /* The total size of the payload, including param_hdr_v3 */
  9909. uint32_t payload_size;
  9910. /* The memory mapping header to be used when sending outband */
  9911. struct mem_mapping_hdr mem_hdr;
  9912. /* The parameter data to be filled when sent inband */
  9913. u32 param_data[0];
  9914. } __packed;
  9915. struct afe_svc_cmd_set_param_v2 {
  9916. /* APR Header */
  9917. struct apr_hdr apr_hdr;
  9918. /* The memory mapping header to be used when sending outband */
  9919. struct mem_mapping_hdr mem_hdr;
  9920. /* The total size of the payload, including param_hdr_v3 */
  9921. u32 payload_size;
  9922. /* The parameter data to be filled when sent inband */
  9923. u32 param_data[0];
  9924. } __packed;
  9925. struct afe_param_hw_mad_ctrl {
  9926. uint32_t minor_version;
  9927. uint16_t mad_type;
  9928. uint16_t mad_enable;
  9929. } __packed;
  9930. struct afe_port_cmd_set_aanc_acdb_table {
  9931. struct apr_hdr hdr;
  9932. struct mem_mapping_hdr mem_hdr;
  9933. } __packed;
  9934. /* Dolby DAP topology */
  9935. #define DOLBY_ADM_COPP_TOPOLOGY_ID 0x0001033B
  9936. #define DS2_ADM_COPP_TOPOLOGY_ID 0x1301033B
  9937. /* RMS value from DSP */
  9938. #define RMS_MODULEID_APPI_PASSTHRU 0x10009011
  9939. #define RMS_PARAM_FIRST_SAMPLE 0x10009012
  9940. #define RMS_PAYLOAD_LEN 4
  9941. /* Customized mixing in matix mixer */
  9942. #define MTMX_MODULE_ID_DEFAULT_CHMIXER 0x00010341
  9943. #define DEFAULT_CHMIXER_PARAM_ID_COEFF 0x00010342
  9944. #define CUSTOM_STEREO_PAYLOAD_SIZE 9
  9945. #define CUSTOM_STEREO_CMD_PARAM_SIZE 24
  9946. #define CUSTOM_STEREO_NUM_OUT_CH 0x0002
  9947. #define CUSTOM_STEREO_NUM_IN_CH 0x0002
  9948. #define CUSTOM_STEREO_INDEX_PARAM 0x0002
  9949. #define Q14_GAIN_ZERO_POINT_FIVE 0x2000
  9950. #define Q14_GAIN_UNITY 0x4000
  9951. /* Ultrasound supported formats */
  9952. #define US_POINT_EPOS_FORMAT_V2 0x0001272D
  9953. #define US_RAW_FORMAT_V2 0x0001272C
  9954. #define US_PROX_FORMAT_V4 0x0001273B
  9955. #define US_RAW_SYNC_FORMAT 0x0001272F
  9956. #define US_GES_SYNC_FORMAT 0x00012730
  9957. #define AFE_MODULE_GROUP_DEVICE 0x00010254
  9958. #define AFE_PARAM_ID_GROUP_DEVICE_CFG 0x00010255
  9959. #define AFE_PARAM_ID_GROUP_DEVICE_ENABLE 0x00010256
  9960. #define AFE_GROUP_DEVICE_ID_SECONDARY_MI2S_RX 0x1102
  9961. /* Payload of the #AFE_PARAM_ID_GROUP_DEVICE_CFG
  9962. * parameter, which configures max of 8 AFE ports
  9963. * into a group.
  9964. * The fixed size of this structure is sixteen bytes.
  9965. */
  9966. struct afe_group_device_group_cfg {
  9967. u32 minor_version;
  9968. u16 group_id;
  9969. u16 num_channels;
  9970. u16 port_id[8];
  9971. } __packed;
  9972. #define AFE_GROUP_DEVICE_ID_PRIMARY_TDM_RX \
  9973. (AFE_PORT_ID_PRIMARY_TDM_RX + 0x100)
  9974. #define AFE_GROUP_DEVICE_ID_PRIMARY_TDM_TX \
  9975. (AFE_PORT_ID_PRIMARY_TDM_TX + 0x100)
  9976. #define AFE_GROUP_DEVICE_ID_SECONDARY_TDM_RX \
  9977. (AFE_PORT_ID_SECONDARY_TDM_RX + 0x100)
  9978. #define AFE_GROUP_DEVICE_ID_SECONDARY_TDM_TX \
  9979. (AFE_PORT_ID_SECONDARY_TDM_TX + 0x100)
  9980. #define AFE_GROUP_DEVICE_ID_TERTIARY_TDM_RX \
  9981. (AFE_PORT_ID_TERTIARY_TDM_RX + 0x100)
  9982. #define AFE_GROUP_DEVICE_ID_TERTIARY_TDM_TX \
  9983. (AFE_PORT_ID_TERTIARY_TDM_TX + 0x100)
  9984. #define AFE_GROUP_DEVICE_ID_QUATERNARY_TDM_RX \
  9985. (AFE_PORT_ID_QUATERNARY_TDM_RX + 0x100)
  9986. #define AFE_GROUP_DEVICE_ID_QUATERNARY_TDM_TX \
  9987. (AFE_PORT_ID_QUATERNARY_TDM_TX + 0x100)
  9988. #define AFE_GROUP_DEVICE_ID_QUINARY_TDM_RX \
  9989. (AFE_PORT_ID_QUINARY_TDM_RX + 0x100)
  9990. #define AFE_GROUP_DEVICE_ID_QUINARY_TDM_TX \
  9991. (AFE_PORT_ID_QUINARY_TDM_TX + 0x100)
  9992. #define AFE_GROUP_DEVICE_ID_SENARY_TDM_RX \
  9993. (AFE_PORT_ID_SENARY_TDM_RX + 0x100)
  9994. #define AFE_GROUP_DEVICE_ID_SENARY_TDM_TX \
  9995. (AFE_PORT_ID_SENARY_TDM_TX + 0x100)
  9996. /* ID of the parameter used by #AFE_MODULE_GROUP_DEVICE to configure the
  9997. * group device. #AFE_SVC_CMD_SET_PARAM can use this parameter ID.
  9998. *
  9999. * Requirements:
  10000. * - Configure the group before the member ports in the group are
  10001. * configured and started.
  10002. * - Enable the group only after it is configured.
  10003. * - Stop all member ports in the group before disabling the group.
  10004. */
  10005. #define AFE_PARAM_ID_GROUP_DEVICE_TDM_CONFIG 0x0001029E
  10006. /* Version information used to handle future additions to
  10007. * AFE_PARAM_ID_GROUP_DEVICE_TDM_CONFIG processing (for backward compatibility).
  10008. */
  10009. #define AFE_API_VERSION_GROUP_DEVICE_TDM_CONFIG 0x1
  10010. /* Number of AFE ports in group device */
  10011. #define AFE_GROUP_DEVICE_NUM_PORTS 8
  10012. /* Payload of the AFE_PARAM_ID_GROUP_DEVICE_TDM_CONFIG parameter ID
  10013. * used by AFE_MODULE_GROUP_DEVICE.
  10014. */
  10015. struct afe_param_id_group_device_tdm_cfg {
  10016. u32 group_device_cfg_minor_version;
  10017. /* Minor version used to track group device configuration.
  10018. * @values #AFE_API_VERSION_GROUP_DEVICE_TDM_CONFIG
  10019. */
  10020. u16 group_id;
  10021. /* ID for the group device.
  10022. * @values
  10023. * - #AFE_GROUP_DEVICE_ID_PRIMARY_TDM_RX
  10024. * - #AFE_GROUP_DEVICE_ID_PRIMARY_TDM_TX
  10025. * - #AFE_GROUP_DEVICE_ID_SECONDARY_TDM_RX
  10026. * - #AFE_GROUP_DEVICE_ID_SECONDARY_TDM_TX
  10027. * - #AFE_GROUP_DEVICE_ID_TERTIARY_TDM_RX
  10028. * - #AFE_GROUP_DEVICE_ID_TERTIARY_TDM_TX
  10029. * - #AFE_GROUP_DEVICE_ID_QUATERNARY_TDM_RX
  10030. * - #AFE_GROUP_DEVICE_ID_QUATERNARY_TDM_TX
  10031. */
  10032. u16 reserved;
  10033. /* 0 */
  10034. u16 port_id[AFE_GROUP_DEVICE_NUM_PORTS];
  10035. /* Array of member port IDs of this group.
  10036. * @values
  10037. * - #AFE_PORT_ID_PRIMARY_TDM_RX
  10038. * - #AFE_PORT_ID_PRIMARY_TDM_RX_1
  10039. * - #AFE_PORT_ID_PRIMARY_TDM_RX_2
  10040. * - #AFE_PORT_ID_PRIMARY_TDM_RX_3
  10041. * - #AFE_PORT_ID_PRIMARY_TDM_RX_4
  10042. * - #AFE_PORT_ID_PRIMARY_TDM_RX_5
  10043. * - #AFE_PORT_ID_PRIMARY_TDM_RX_6
  10044. * - #AFE_PORT_ID_PRIMARY_TDM_RX_7
  10045. * - #AFE_PORT_ID_PRIMARY_TDM_TX
  10046. * - #AFE_PORT_ID_PRIMARY_TDM_TX_1
  10047. * - #AFE_PORT_ID_PRIMARY_TDM_TX_2
  10048. * - #AFE_PORT_ID_PRIMARY_TDM_TX_3
  10049. * - #AFE_PORT_ID_PRIMARY_TDM_TX_4
  10050. * - #AFE_PORT_ID_PRIMARY_TDM_TX_5
  10051. * - #AFE_PORT_ID_PRIMARY_TDM_TX_6
  10052. * - #AFE_PORT_ID_PRIMARY_TDM_TX_7
  10053. * - #AFE_PORT_ID_SECONDARY_TDM_RX
  10054. * - #AFE_PORT_ID_SECONDARY_TDM_RX_1
  10055. * - #AFE_PORT_ID_SECONDARY_TDM_RX_2
  10056. * - #AFE_PORT_ID_SECONDARY_TDM_RX_3
  10057. * - #AFE_PORT_ID_SECONDARY_TDM_RX_4
  10058. * - #AFE_PORT_ID_SECONDARY_TDM_RX_5
  10059. * - #AFE_PORT_ID_SECONDARY_TDM_RX_6
  10060. * - #AFE_PORT_ID_SECONDARY_TDM_RX_7
  10061. * - #AFE_PORT_ID_SECONDARY_TDM_TX
  10062. * - #AFE_PORT_ID_SECONDARY_TDM_TX_1
  10063. * - #AFE_PORT_ID_SECONDARY_TDM_TX_2
  10064. * - #AFE_PORT_ID_SECONDARY_TDM_TX_3
  10065. * - #AFE_PORT_ID_SECONDARY_TDM_TX_4
  10066. * - #AFE_PORT_ID_SECONDARY_TDM_TX_5
  10067. * - #AFE_PORT_ID_SECONDARY_TDM_TX_6
  10068. * - #AFE_PORT_ID_SECONDARY_TDM_TX_7
  10069. * - #AFE_PORT_ID_TERTIARY_TDM_RX
  10070. * - #AFE_PORT_ID_TERTIARY_TDM_RX_1
  10071. * - #AFE_PORT_ID_TERTIARY_TDM_RX_2
  10072. * - #AFE_PORT_ID_TERTIARY_TDM_RX_3
  10073. * - #AFE_PORT_ID_TERTIARY_TDM_RX_4
  10074. * - #AFE_PORT_ID_TERTIARY_TDM_RX_5
  10075. * - #AFE_PORT_ID_TERTIARY_TDM_RX_6
  10076. * - #AFE_PORT_ID_TERTIARY_TDM_RX_7
  10077. * - #AFE_PORT_ID_TERTIARY_TDM_TX
  10078. * - #AFE_PORT_ID_TERTIARY_TDM_TX_1
  10079. * - #AFE_PORT_ID_TERTIARY_TDM_TX_2
  10080. * - #AFE_PORT_ID_TERTIARY_TDM_TX_3
  10081. * - #AFE_PORT_ID_TERTIARY_TDM_TX_4
  10082. * - #AFE_PORT_ID_TERTIARY_TDM_TX_5
  10083. * - #AFE_PORT_ID_TERTIARY_TDM_TX_6
  10084. * - #AFE_PORT_ID_TERTIARY_TDM_TX_7
  10085. * - #AFE_PORT_ID_QUATERNARY_TDM_RX
  10086. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_1
  10087. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_2
  10088. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_3
  10089. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_4
  10090. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_5
  10091. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_6
  10092. * - #AFE_PORT_ID_QUATERNARY_TDM_RX_7
  10093. * - #AFE_PORT_ID_QUATERNARY_TDM_TX
  10094. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_1
  10095. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_2
  10096. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_3
  10097. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_4
  10098. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_5
  10099. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_6
  10100. * - #AFE_PORT_ID_QUATERNARY_TDM_TX_7
  10101. * @tablebulletend
  10102. */
  10103. u32 num_channels;
  10104. /* Number of enabled slots for TDM frame.
  10105. * @values 1 to 8
  10106. */
  10107. u32 sample_rate;
  10108. /* Sampling rate of the port.
  10109. * @values
  10110. * - #AFE_PORT_SAMPLE_RATE_8K
  10111. * - #AFE_PORT_SAMPLE_RATE_16K
  10112. * - #AFE_PORT_SAMPLE_RATE_24K
  10113. * - #AFE_PORT_SAMPLE_RATE_32K
  10114. * - #AFE_PORT_SAMPLE_RATE_48K @tablebulletend
  10115. */
  10116. u32 bit_width;
  10117. /* Bit width of the sample.
  10118. * @values 16, 24, (32)
  10119. */
  10120. u16 nslots_per_frame;
  10121. /* Number of slots per frame. Typical : 1, 2, 4, 8, 16, 32.
  10122. * @values 1 - 32
  10123. */
  10124. u16 slot_width;
  10125. /* Slot width of the slot in a TDM frame. (slot_width >= bit_width)
  10126. * have to be satisfied.
  10127. * @values 16, 24, 32
  10128. */
  10129. u32 slot_mask;
  10130. /* Position of active slots. When that bit is set, that paricular
  10131. * slot is active.
  10132. * Number of active slots can be inferred by number of bits set in
  10133. * the mask. Only 8 individual bits can be enabled.
  10134. * Bits 0..31 corresponding to slot 0..31
  10135. * @values 1 to 2^32 -1
  10136. */
  10137. } __packed;
  10138. /* Payload of the #AFE_PARAM_ID_GROUP_DEVICE_ENABLE
  10139. * parameter, which enables or
  10140. * disables any module.
  10141. * The fixed size of this structure is four bytes.
  10142. */
  10143. struct afe_group_device_enable {
  10144. u16 group_id;
  10145. /* valid value is AFE_GROUP_DEVICE_ID_SECONDARY_MI2S_RX */
  10146. u16 enable;
  10147. /* Enables (1) or disables (0) the module. */
  10148. } __packed;
  10149. union afe_port_group_config {
  10150. struct afe_group_device_group_cfg group_cfg;
  10151. struct afe_group_device_enable group_enable;
  10152. struct afe_param_id_group_device_tdm_cfg tdm_cfg;
  10153. } __packed;
  10154. /* ID of the parameter used by #AFE_MODULE_AUDIO_DEV_INTERFACE to specify
  10155. * the timing statistics of the corresponding device interface.
  10156. * Client can periodically query for the device time statistics to help adjust
  10157. * the PLL based on the drift value. The get param command must be sent to
  10158. * AFE port ID corresponding to device interface
  10159. * This parameter ID supports following get param commands:
  10160. * #AFE_PORT_CMD_GET_PARAM_V2 and
  10161. * #AFE_PORT_CMD_GET_PARAM_V3.
  10162. */
  10163. #define AFE_PARAM_ID_DEV_TIMING_STATS 0x000102AD
  10164. /* Version information used to handle future additions to AFE device
  10165. * interface timing statistics (for backward compatibility).
  10166. */
  10167. #define AFE_API_VERSION_DEV_TIMING_STATS 0x1
  10168. /* Enumeration for specifying a sink(Rx) device */
  10169. #define AFE_SINK_DEVICE 0x0
  10170. /* Enumeration for specifying a source(Tx) device */
  10171. #define AFE_SOURCE_DEVICE 0x1
  10172. /* Enumeration for specifying the drift reference is of type AV Timer */
  10173. #define AFE_REF_TIMER_TYPE_AVTIMER 0x0
  10174. /* Message payload structure for the
  10175. * AFE_PARAM_ID_DEV_TIMING_STATS parameter.
  10176. */
  10177. struct afe_param_id_dev_timing_stats {
  10178. /* Minor version used to track the version of device interface timing
  10179. * statistics. Currently, the supported version is 1.
  10180. * @values #AFE_API_VERSION_DEV_TIMING_STATS
  10181. */
  10182. u32 minor_version;
  10183. /* Indicates the device interface direction as either
  10184. * source (Tx) or sink (Rx).
  10185. * @values
  10186. * #AFE_SINK_DEVICE
  10187. * #AFE_SOURCE_DEVICE
  10188. */
  10189. u16 device_direction;
  10190. /* Reference timer for drift accumulation and time stamp information.
  10191. * @values
  10192. * #AFE_REF_TIMER_TYPE_AVTIMER @tablebulletend
  10193. */
  10194. u16 reference_timer;
  10195. /*
  10196. * Flag to indicate if resync is required on the client side for
  10197. * drift correction. Flag is set to TRUE for the first get_param
  10198. * response after device interface starts. This flag value can be
  10199. * used by client to identify if device interface restart has
  10200. * happened and if any re-sync is required at their end for drift
  10201. * correction.
  10202. * @values
  10203. * 0: FALSE (Resync not required)
  10204. * 1: TRUE (Resync required) @tablebulletend
  10205. */
  10206. u32 resync_flag;
  10207. /* Accumulated drift value in microseconds. This value is updated
  10208. * every 100th ms.
  10209. * Positive drift value indicates AV timer is running faster than device
  10210. * Negative drift value indicates AV timer is running slower than device
  10211. * @values Any valid int32 number
  10212. */
  10213. s32 acc_drift_value;
  10214. /* Lower 32 bits of the 64-bit absolute timestamp of reference
  10215. * timer in microseconds.
  10216. * This timestamp corresponds to the time when the drift values
  10217. * are accumlated for every 100th ms.
  10218. * @values Any valid uint32 number
  10219. */
  10220. u32 ref_timer_abs_ts_lsw;
  10221. /* Upper 32 bits of the 64-bit absolute timestamp of reference
  10222. * timer in microseconds.
  10223. * This timestamp corresponds to the time when the drift values
  10224. * are accumlated for every 100th ms.
  10225. * @values Any valid uint32 number
  10226. */
  10227. u32 ref_timer_abs_ts_msw;
  10228. } __packed;
  10229. struct afe_av_dev_drift_get_param_resp {
  10230. uint32_t status;
  10231. struct param_hdr_v3 pdata;
  10232. struct afe_param_id_dev_timing_stats timing_stats;
  10233. } __packed;
  10234. /* Command for Matrix or Stream Router */
  10235. #define ASM_SESSION_CMD_SET_MTMX_STRTR_PARAMS_V2 0x00010DCE
  10236. /* Module for AVSYNC */
  10237. #define ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC 0x00010DC6
  10238. /* Parameter used by #ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC to specify the
  10239. * render window start value. This parameter is supported only for a Set
  10240. * command (not a Get command) in the Rx direction
  10241. * (#ASM_SESSION_CMD_SET_MTMX_STRTR_PARAMS_V2).
  10242. * Render window start is a value (session time minus timestamp, or ST-TS)
  10243. * below which frames are held, and after which frames are immediately
  10244. * rendered.
  10245. */
  10246. #define ASM_SESSION_MTMX_STRTR_PARAM_RENDER_WINDOW_START_V2 0x00010DD1
  10247. /* Parameter used by #ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC to specify the
  10248. * render window end value. This parameter is supported only for a Set
  10249. * command (not a Get command) in the Rx direction
  10250. * (#ASM_SESSION_CMD_SET_MTMX_STRTR_PARAMS_V2). Render window end is a value
  10251. * (session time minus timestamp) above which frames are dropped, and below
  10252. * which frames are immediately rendered.
  10253. */
  10254. #define ASM_SESSION_MTMX_STRTR_PARAM_RENDER_WINDOW_END_V2 0x00010DD2
  10255. /* Generic payload of the window parameters in the
  10256. * #ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC module.
  10257. * This payload is supported only for a Set command
  10258. * (not a Get command) on the Rx path.
  10259. */
  10260. struct asm_session_mtmx_strtr_param_window_v2_t {
  10261. u32 window_lsw;
  10262. /* Lower 32 bits of the render window start value. */
  10263. u32 window_msw;
  10264. /* Upper 32 bits of the render window start value.
  10265. *
  10266. * The 64-bit number formed by window_lsw and window_msw specifies a
  10267. * signed 64-bit window value in microseconds. The sign extension is
  10268. * necessary. This value is used by the following parameter IDs:
  10269. * #ASM_SESSION_MTMX_STRTR_PARAM_RENDER_WINDOW_START_V2
  10270. * #ASM_SESSION_MTMX_STRTR_PARAM_RENDER_WINDOW_END_V2
  10271. * #ASM_SESSION_MTMX_STRTR_PARAM_STAT_WINDOW_START_V2
  10272. * #ASM_SESSION_MTMX_STRTR_PARAM_STAT_WINDOW_END_V2
  10273. * The value depends on which parameter ID is used.
  10274. * The aDSP honors the windows at a granularity of 1 ms.
  10275. */
  10276. };
  10277. struct asm_session_cmd_set_mtmx_strstr_params_v2 {
  10278. uint32_t data_payload_addr_lsw;
  10279. /* Lower 32 bits of the 64-bit data payload address. */
  10280. uint32_t data_payload_addr_msw;
  10281. /* Upper 32 bits of the 64-bit data payload address.
  10282. * If the address is not sent (NULL), the message is in the payload.
  10283. * If the address is sent (non-NULL), the parameter data payloads
  10284. * begin at the specified address.
  10285. */
  10286. uint32_t mem_map_handle;
  10287. /* Unique identifier for an address. This memory map handle is returned
  10288. * by the aDSP through the #ASM_CMD_SHARED_MEM_MAP_REGIONS command.
  10289. * values
  10290. * - NULL -- Parameter data payloads are within the message payload
  10291. * (in-band).
  10292. * - Non-NULL -- Parameter data payloads begin at the address specified
  10293. * in the data_payload_addr_lsw and data_payload_addr_msw fields
  10294. * (out-of-band).
  10295. */
  10296. uint32_t data_payload_size;
  10297. /* Actual size of the variable payload accompanying the message, or in
  10298. * shared memory. This field is used for parsing the parameter payload.
  10299. * values > 0 bytes
  10300. */
  10301. uint32_t direction;
  10302. /* Direction of the entity (matrix mixer or stream router) on which
  10303. * the parameter is to be set.
  10304. * values
  10305. * - 0 -- Rx (for Rx stream router or Rx matrix mixer)
  10306. * - 1 -- Tx (for Tx stream router or Tx matrix mixer)
  10307. */
  10308. };
  10309. /* Parameter used by #ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC which allows the
  10310. * audio client choose the rendering decision that the audio DSP should use.
  10311. */
  10312. #define ASM_SESSION_MTMX_STRTR_PARAM_RENDER_MODE_CMD 0x00012F0D
  10313. /* Indicates that rendering decision will be based on default rate
  10314. * (session clock based rendering, device driven).
  10315. * 1. The default session clock based rendering is inherently driven
  10316. * by the timing of the device.
  10317. * 2. After the initial decision is made (first buffer after a run
  10318. * command), subsequent data rendering decisions are made with
  10319. * respect to the rate at which the device is rendering, thus deriving
  10320. * its timing from the device.
  10321. * 3. While this decision making is simple, it has some inherent limitations
  10322. * (mentioned in the next section).
  10323. * 4. If this API is not set, the session clock based rendering will be assumed
  10324. * and this will ensure that the DSP is backward compatible.
  10325. */
  10326. #define ASM_SESSION_MTMX_STRTR_PARAM_RENDER_DEFAULT 0
  10327. /* Indicates that rendering decision will be based on local clock rate.
  10328. * 1. In the DSP loopback/client loopback use cases (frame based
  10329. * inputs), the incoming data into audio DSP is time-stamped at the
  10330. * local clock rate (STC).
  10331. * 2. This TS rate may match the incoming data rate or maybe different
  10332. * from the incoming data rate.
  10333. * 3. Regardless, the data will be time-stamped with local STC and
  10334. * therefore, the client is recommended to set this mode for these
  10335. * use cases. This method is inherently more robust to sequencing
  10336. * (AFE Start/Stop) and device switches, among other benefits.
  10337. * 4. This API will inform the DSP to compare every incoming buffer TS
  10338. * against local STC.
  10339. * 5. DSP will continue to honor render windows APIs, as before.
  10340. */
  10341. #define ASM_SESSION_MTMX_STRTR_PARAM_RENDER_LOCAL_STC 1
  10342. /* Structure for rendering decision parameter */
  10343. struct asm_session_mtmx_strtr_param_render_mode_t {
  10344. /* Specifies the type of rendering decision the audio DSP should use.
  10345. *
  10346. * @values
  10347. * - #ASM_SESSION_MTMX_STRTR_PARAM_RENDER_DEFAULT
  10348. * - #ASM_SESSION_MTMX_STRTR_PARAM_RENDER_LOCAL_STC
  10349. */
  10350. u32 flags;
  10351. } __packed;
  10352. /* Parameter used by #ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC which allows the
  10353. * audio client to specify the clock recovery mechanism that the audio DSP
  10354. * should use.
  10355. */
  10356. #define ASM_SESSION_MTMX_STRTR_PARAM_CLK_REC_CMD 0x00012F0E
  10357. /* Indicates that default clock recovery will be used (no clock recovery).
  10358. * If the client wishes that no clock recovery be done, the client can
  10359. * choose this. This means that no attempt will made by the DSP to try and
  10360. * match the rates of the input and output audio.
  10361. */
  10362. #define ASM_SESSION_MTMX_STRTR_PARAM_CLK_REC_NONE 0
  10363. /* Indicates that independent clock recovery needs to be used.
  10364. * 1. In the DSP loopback/client loopback use cases (frame based inputs),
  10365. * the client should choose the independent clock recovery option.
  10366. * 2. This basically de-couples the audio and video from knowing each others
  10367. * clock sources and lets the audio DSP independently rate match the input
  10368. * and output rates.
  10369. * 3. After drift detection, the drift correction is achieved by either pulling
  10370. * the PLLs (if applicable) or by stream to device rate matching
  10371. * (for PCM use cases) by comparing drift with respect to STC.
  10372. * 4. For passthrough use cases, since the PLL pulling is the only option,
  10373. * a best effort will be made.
  10374. * If PLL pulling is not possible / available, the rendering will be
  10375. * done without rate matching.
  10376. */
  10377. #define ASM_SESSION_MTMX_STRTR_PARAM_CLK_REC_AUTO 1
  10378. /* Payload of the #ASM_SESSION_MTMX_STRTR_PARAM_CLK_REC parameter.
  10379. */
  10380. struct asm_session_mtmx_strtr_param_clk_rec_t {
  10381. /* Specifies the type of clock recovery that the audio DSP should
  10382. * use for rate matching.
  10383. */
  10384. /* @values
  10385. * #ASM_SESSION_MTMX_STRTR_PARAM_CLK_REC_DEFAULT
  10386. * #ASM_SESSION_MTMX_STRTR_PARAM_CLK_REC_INDEPENDENT
  10387. */
  10388. u32 flags;
  10389. } __packed;
  10390. /* Parameter used by #ASM_SESSION_MTMX_STRTR_MODULE_ID_AVSYNC to
  10391. * realize smoother adjustment of audio session clock for a specified session.
  10392. * The desired audio session clock adjustment(in micro seconds) is specified
  10393. * using the command #ASM_SESSION_CMD_ADJUST_SESSION_CLOCK_V2.
  10394. * Delaying/Advancing the session clock would be implemented by inserting
  10395. * interpolated/dropping audio samples in the playback path respectively.
  10396. * Also, this parameter has to be configured before the Audio Session is put
  10397. * to RUN state to avoid cold start latency/glitches in the playback.
  10398. */
  10399. #define ASM_SESSION_MTMX_PARAM_ADJUST_SESSION_TIME_CTL 0x00013217
  10400. struct asm_session_mtmx_param_adjust_session_time_ctl_t {
  10401. /* Specifies whether the module is enabled or not
  10402. * @values
  10403. * 0 -- disabled
  10404. * 1 -- enabled
  10405. */
  10406. u32 enable;
  10407. };
  10408. union asm_session_mtmx_strtr_param_config {
  10409. struct asm_session_mtmx_strtr_param_window_v2_t window_param;
  10410. struct asm_session_mtmx_strtr_param_render_mode_t render_param;
  10411. struct asm_session_mtmx_strtr_param_clk_rec_t clk_rec_param;
  10412. struct asm_session_mtmx_param_adjust_session_time_ctl_t adj_time_param;
  10413. } __packed;
  10414. struct asm_mtmx_strtr_params {
  10415. struct apr_hdr hdr;
  10416. struct asm_session_cmd_set_mtmx_strstr_params_v2 param;
  10417. struct param_hdr_v1 data;
  10418. union asm_session_mtmx_strtr_param_config config;
  10419. } __packed;
  10420. #define ASM_SESSION_CMD_GET_MTMX_STRTR_PARAMS_V2 0x00010DCF
  10421. #define ASM_SESSION_CMDRSP_GET_MTMX_STRTR_PARAMS_V2 0x00010DD0
  10422. #define ASM_SESSION_MTMX_STRTR_PARAM_SESSION_TIME_V3 0x00012F0B
  10423. #define ASM_SESSION_MTMX_STRTR_PARAM_STIME_TSTMP_FLG_BMASK (0x80000000UL)
  10424. struct asm_session_cmd_get_mtmx_strstr_params_v2 {
  10425. uint32_t data_payload_addr_lsw;
  10426. /* Lower 32 bits of the 64-bit data payload address. */
  10427. uint32_t data_payload_addr_msw;
  10428. /*
  10429. * Upper 32 bits of the 64-bit data payload address.
  10430. * If the address is not sent (NULL), the message is in the payload.
  10431. * If the address is sent (non-NULL), the parameter data payloads
  10432. * begin at the specified address.
  10433. */
  10434. uint32_t mem_map_handle;
  10435. /*
  10436. * Unique identifier for an address. This memory map handle is returned
  10437. * by the aDSP through the #ASM_CMD_SHARED_MEM_MAP_REGIONS command.
  10438. * values
  10439. * - NULL -- Parameter data payloads are within the message payload
  10440. * (in-band).
  10441. * - Non-NULL -- Parameter data payloads begin at the address specified
  10442. * in the data_payload_addr_lsw and data_payload_addr_msw fields
  10443. * (out-of-band).
  10444. */
  10445. uint32_t direction;
  10446. /*
  10447. * Direction of the entity (matrix mixer or stream router) on which
  10448. * the parameter is to be set.
  10449. * values
  10450. * - 0 -- Rx (for Rx stream router or Rx matrix mixer)
  10451. * - 1 -- Tx (for Tx stream router or Tx matrix mixer)
  10452. */
  10453. uint32_t module_id;
  10454. /* Unique module ID. */
  10455. uint32_t param_id;
  10456. /* Unique parameter ID. */
  10457. uint32_t param_max_size;
  10458. };
  10459. struct asm_session_mtmx_strtr_param_session_time_v3_t {
  10460. uint32_t session_time_lsw;
  10461. /* Lower 32 bits of the current session time in microseconds */
  10462. uint32_t session_time_msw;
  10463. /*
  10464. * Upper 32 bits of the current session time in microseconds.
  10465. * The 64-bit number formed by session_time_lsw and session_time_msw
  10466. * is treated as signed.
  10467. */
  10468. uint32_t absolute_time_lsw;
  10469. /*
  10470. * Lower 32 bits of the 64-bit absolute time in microseconds.
  10471. * This is the time when the sample corresponding to the
  10472. * session_time_lsw is rendered to the hardware. This absolute
  10473. * time can be slightly in the future or past.
  10474. */
  10475. uint32_t absolute_time_msw;
  10476. /*
  10477. * Upper 32 bits of the 64-bit absolute time in microseconds.
  10478. * This is the time when the sample corresponding to the
  10479. * session_time_msw is rendered to hardware. This absolute
  10480. * time can be slightly in the future or past. The 64-bit number
  10481. * formed by absolute_time_lsw and absolute_time_msw is treated as
  10482. * unsigned.
  10483. */
  10484. uint32_t time_stamp_lsw;
  10485. /* Lower 32 bits of the last processed timestamp in microseconds */
  10486. uint32_t time_stamp_msw;
  10487. /*
  10488. * Upper 32 bits of the last processed timestamp in microseconds.
  10489. * The 64-bit number formed by time_stamp_lsw and time_stamp_lsw
  10490. * is treated as unsigned.
  10491. */
  10492. uint32_t flags;
  10493. /*
  10494. * Keeps track of any additional flags needed.
  10495. * @values{for bit 31}
  10496. * - 0 -- Uninitialized/invalid
  10497. * - 1 -- Valid
  10498. * All other bits are reserved; clients must set them to zero.
  10499. */
  10500. };
  10501. union asm_session_mtmx_strtr_data_type {
  10502. struct asm_session_mtmx_strtr_param_session_time_v3_t session_time;
  10503. };
  10504. struct asm_mtmx_strtr_get_params {
  10505. struct apr_hdr hdr;
  10506. struct asm_session_cmd_get_mtmx_strstr_params_v2 param_info;
  10507. } __packed;
  10508. struct asm_mtmx_strtr_get_params_cmdrsp {
  10509. uint32_t err_code;
  10510. struct param_hdr_v1 param_info;
  10511. union asm_session_mtmx_strtr_data_type param_data;
  10512. } __packed;
  10513. #define AUDPROC_MODULE_ID_RESAMPLER 0x00010719
  10514. enum {
  10515. LEGACY_PCM = 0,
  10516. COMPRESSED_PASSTHROUGH,
  10517. COMPRESSED_PASSTHROUGH_CONVERT,
  10518. COMPRESSED_PASSTHROUGH_DSD,
  10519. LISTEN,
  10520. COMPRESSED_PASSTHROUGH_GEN,
  10521. COMPRESSED_PASSTHROUGH_IEC61937
  10522. };
  10523. #define AUDPROC_MODULE_ID_COMPRESSED_MUTE 0x00010770
  10524. #define AUDPROC_PARAM_ID_COMPRESSED_MUTE 0x00010771
  10525. struct adm_set_compressed_device_mute {
  10526. u32 mute_on;
  10527. } __packed;
  10528. #define AUDPROC_MODULE_ID_COMPRESSED_LATENCY 0x0001076E
  10529. #define AUDPROC_PARAM_ID_COMPRESSED_LATENCY 0x0001076F
  10530. struct adm_set_compressed_device_latency {
  10531. u32 latency;
  10532. } __packed;
  10533. #define VOICEPROC_MODULE_ID_GENERIC_TX 0x00010EF6
  10534. #define VOICEPROC_MODULE_ID_FLUENCE_PRO_VC_TX 0x00010F35
  10535. #define VOICEPROC_PARAM_ID_FLUENCE_SOUNDFOCUS 0x00010E37
  10536. #define VOICEPROC_PARAM_ID_FLUENCE_SOURCETRACKING 0x00010E38
  10537. #define MAX_SECTORS 8
  10538. #define MAX_NOISE_SOURCE_INDICATORS 3
  10539. #define MAX_POLAR_ACTIVITY_INDICATORS 360
  10540. #define MAX_DOA_TRACKING_ANGLES 2
  10541. struct sound_focus_param {
  10542. uint16_t start_angle[MAX_SECTORS];
  10543. uint8_t enable[MAX_SECTORS];
  10544. uint16_t gain_step;
  10545. } __packed;
  10546. struct source_tracking_param {
  10547. uint8_t vad[MAX_SECTORS];
  10548. uint16_t doa_speech;
  10549. uint16_t doa_noise[MAX_NOISE_SOURCE_INDICATORS];
  10550. uint8_t polar_activity[MAX_POLAR_ACTIVITY_INDICATORS];
  10551. } __packed;
  10552. struct doa_tracking_mon_param {
  10553. uint16_t target_angle_L16[MAX_DOA_TRACKING_ANGLES];
  10554. uint16_t interf_angle_L16[MAX_DOA_TRACKING_ANGLES];
  10555. uint8_t polar_activity[MAX_POLAR_ACTIVITY_INDICATORS];
  10556. } __packed;
  10557. struct adm_param_fluence_soundfocus_t {
  10558. uint16_t start_angles[MAX_SECTORS];
  10559. uint8_t enables[MAX_SECTORS];
  10560. uint16_t gain_step;
  10561. uint16_t reserved;
  10562. } __packed;
  10563. struct adm_param_fluence_sourcetracking_t {
  10564. uint8_t vad[MAX_SECTORS];
  10565. uint16_t doa_speech;
  10566. uint16_t doa_noise[MAX_NOISE_SOURCE_INDICATORS];
  10567. uint8_t polar_activity[MAX_POLAR_ACTIVITY_INDICATORS];
  10568. } __packed;
  10569. struct adm_param_doa_tracking_mon_t {
  10570. uint16_t target_angle_L16[MAX_DOA_TRACKING_ANGLES];
  10571. uint16_t interf_angle_L16[MAX_DOA_TRACKING_ANGLES];
  10572. uint8_t polar_activity[MAX_POLAR_ACTIVITY_INDICATORS];
  10573. } __packed;
  10574. struct afe_doa_tracking_mon_get_param_resp {
  10575. uint32_t status;
  10576. struct param_hdr_v3 pdata;
  10577. struct doa_tracking_mon_param doa;
  10578. } __packed;
  10579. #define AUDPROC_MODULE_ID_AUDIOSPHERE 0x00010916
  10580. #define AUDPROC_PARAM_ID_AUDIOSPHERE_ENABLE 0x00010917
  10581. #define AUDPROC_PARAM_ID_AUDIOSPHERE_STRENGTH 0x00010918
  10582. #define AUDPROC_PARAM_ID_AUDIOSPHERE_CONFIG_MODE 0x00010919
  10583. #define AUDPROC_PARAM_ID_AUDIOSPHERE_COEFFS_STEREO_INPUT 0x0001091A
  10584. #define AUDPROC_PARAM_ID_AUDIOSPHERE_COEFFS_MULTICHANNEL_INPUT 0x0001091B
  10585. #define AUDPROC_PARAM_ID_AUDIOSPHERE_DESIGN_STEREO_INPUT 0x0001091C
  10586. #define AUDPROC_PARAM_ID_AUDIOSPHERE_DESIGN_MULTICHANNEL_INPUT 0x0001091D
  10587. #define AUDPROC_PARAM_ID_AUDIOSPHERE_OPERATING_INPUT_MEDIA_INFO 0x0001091E
  10588. #define AUDPROC_MODULE_ID_VOICE_TX_SECNS 0x10027059
  10589. #define AUDPROC_PARAM_IDX_SEC_PRIMARY_MIC_CH 0x10014444
  10590. #define AUDPROC_MODULE_ID_FFECNS 0x00010952
  10591. #define AUDPROC_MODULE_ID_FFNS 0x00010962
  10592. #define AUDPROC_PARAM_ID_FFV_DOA_TRACKING_PARAM 0x11003
  10593. #define AUDPROC_PARAM_ID_FFV_DOA_TRACKING_MONITOR 0x11004
  10594. struct admx_sec_primary_mic_ch {
  10595. uint16_t version;
  10596. uint16_t reserved;
  10597. uint16_t sec_primary_mic_ch;
  10598. uint16_t reserved1;
  10599. } __packed;
  10600. #define FFECNS_MODULE_ID 0x00010952
  10601. #define FLUENCE_CMN_GLOBAL_EFFECT_PARAM_ID 0x00010EAF
  10602. #define FFECNS_TOPOLOGY 0X10028003
  10603. struct ffecns_effect {
  10604. uint32_t payload;
  10605. };
  10606. /** ID of the Voice Activity Detection (VAD) module, which is used to
  10607. * configure AFE VAD.
  10608. */
  10609. #define AFE_MODULE_VAD 0x000102B9
  10610. /** ID of the parameter used by #AFE_MODULE_VAD to configure the VAD.
  10611. */
  10612. #define AFE_PARAM_ID_VAD_CFG 0x000102BA
  10613. #define AFE_API_VERSION_VAD_CFG 0x1
  10614. /* Payload of the AFE_PARAM_ID_VAD_CONFIG parameter used by
  10615. * AFE_MODULE_VAD.
  10616. */
  10617. struct afe_param_id_vad_cfg_t {
  10618. uint32_t vad_cfg_minor_version;
  10619. /** Tracks the configuration of this parameter.
  10620. * Supported Values: #AFE_API_VERSION_VAD_CFG
  10621. */
  10622. uint32_t pre_roll_in_ms;
  10623. /** Pre-roll period in ms.
  10624. * Supported Values: 0x0 to 0x3E8
  10625. */
  10626. } __packed;
  10627. #define AFE_PARAM_ID_VAD_CORE_CFG 0x000102BB
  10628. /**
  10629. * This parameter is should be used to configure the AFE TDM
  10630. * interface lane configuration.
  10631. * Regular TDM interface ports:
  10632. * This parameter ID must be used with module ID
  10633. * AFE_MODULE_AUDIO_DEV_INTERFACE and set using the AFE_PORT_CMD_SET_PARAM_V3
  10634. * command for the AFE TDM interface port IDs.
  10635. * Group device TDM interface ports:
  10636. * This parameter ID must be used with module ID AFE_MODULE_GROUP_DEVICE
  10637. * and set using the AFE_SVC_CMD_SET_PARAM_V2 command for the AFE TDM group IDs.
  10638. */
  10639. #define AFE_PARAM_ID_TDM_LANE_CONFIG 0x000102C1
  10640. /* Payload of the AFE_PARAM_ID_TDM_LANE_CONFIG parameter used by
  10641. * AFE_MODULE_AUDIO_DEV_INTERFACE.
  10642. */
  10643. struct afe_param_id_tdm_lane_cfg {
  10644. uint16_t port_id;
  10645. /** ID of the TDM interface.
  10646. * For regular TDM interfaces value corresponds to valid port ID.
  10647. * For group devices TDM interface value corresponds to valid group device ID.
  10648. */
  10649. uint16_t lane_mask;
  10650. /** Position of the active lanes. Bits 0 to N correspond to lanes 0 to N.
  10651. * 1 to 2^N-1 When a bit is set, the corresponding lane is active.
  10652. * The number of active lanes can be inferred from the number of bits
  10653. * set in the mask.
  10654. */
  10655. };
  10656. #endif /*_APR_AUDIO_V2_H_ */