apr_audio-v2.h 391 KB

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