iwl-commands.h 129 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898
  1. /******************************************************************************
  2. *
  3. * This file is provided under a dual BSD/GPLv2 license. When using or
  4. * redistributing this file, you may do so under either license.
  5. *
  6. * GPL LICENSE SUMMARY
  7. *
  8. * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of version 2 of the GNU General Public License as
  12. * published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful, but
  15. * WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17. * General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22. * USA
  23. *
  24. * The full GNU General Public License is included in this distribution
  25. * in the file called LICENSE.GPL.
  26. *
  27. * Contact Information:
  28. * Intel Linux Wireless <ilw@linux.intel.com>
  29. * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30. *
  31. * BSD LICENSE
  32. *
  33. * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
  34. * All rights reserved.
  35. *
  36. * Redistribution and use in source and binary forms, with or without
  37. * modification, are permitted provided that the following conditions
  38. * are met:
  39. *
  40. * * Redistributions of source code must retain the above copyright
  41. * notice, this list of conditions and the following disclaimer.
  42. * * Redistributions in binary form must reproduce the above copyright
  43. * notice, this list of conditions and the following disclaimer in
  44. * the documentation and/or other materials provided with the
  45. * distribution.
  46. * * Neither the name Intel Corporation nor the names of its
  47. * contributors may be used to endorse or promote products derived
  48. * from this software without specific prior written permission.
  49. *
  50. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61. *
  62. *****************************************************************************/
  63. /*
  64. * Please use this file (iwl-commands.h) only for uCode API definitions.
  65. * Please use iwl-xxxx-hw.h for hardware-related definitions.
  66. * Please use iwl-dev.h for driver implementation definitions.
  67. */
  68. #ifndef __iwl_commands_h__
  69. #define __iwl_commands_h__
  70. struct iwl_priv;
  71. /* uCode version contains 4 values: Major/Minor/API/Serial */
  72. #define IWL_UCODE_MAJOR(ver) (((ver) & 0xFF000000) >> 24)
  73. #define IWL_UCODE_MINOR(ver) (((ver) & 0x00FF0000) >> 16)
  74. #define IWL_UCODE_API(ver) (((ver) & 0x0000FF00) >> 8)
  75. #define IWL_UCODE_SERIAL(ver) ((ver) & 0x000000FF)
  76. /* Tx rates */
  77. #define IWL_CCK_RATES 4
  78. #define IWL_OFDM_RATES 8
  79. #define IWL_MAX_RATES (IWL_CCK_RATES + IWL_OFDM_RATES)
  80. enum {
  81. REPLY_ALIVE = 0x1,
  82. REPLY_ERROR = 0x2,
  83. /* RXON and QOS commands */
  84. REPLY_RXON = 0x10,
  85. REPLY_RXON_ASSOC = 0x11,
  86. REPLY_QOS_PARAM = 0x13,
  87. REPLY_RXON_TIMING = 0x14,
  88. /* Multi-Station support */
  89. REPLY_ADD_STA = 0x18,
  90. REPLY_REMOVE_STA = 0x19,
  91. REPLY_REMOVE_ALL_STA = 0x1a, /* not used */
  92. REPLY_TXFIFO_FLUSH = 0x1e,
  93. /* Security */
  94. REPLY_WEPKEY = 0x20,
  95. /* RX, TX, LEDs */
  96. REPLY_TX = 0x1c,
  97. REPLY_LEDS_CMD = 0x48,
  98. REPLY_TX_LINK_QUALITY_CMD = 0x4e, /* for 4965 and up */
  99. /* WiMAX coexistence */
  100. COEX_PRIORITY_TABLE_CMD = 0x5a, /* for 5000 series and up */
  101. COEX_MEDIUM_NOTIFICATION = 0x5b,
  102. COEX_EVENT_CMD = 0x5c,
  103. /* Calibration */
  104. TEMPERATURE_NOTIFICATION = 0x62,
  105. CALIBRATION_CFG_CMD = 0x65,
  106. CALIBRATION_RES_NOTIFICATION = 0x66,
  107. CALIBRATION_COMPLETE_NOTIFICATION = 0x67,
  108. /* 802.11h related */
  109. REPLY_QUIET_CMD = 0x71, /* not used */
  110. REPLY_CHANNEL_SWITCH = 0x72,
  111. CHANNEL_SWITCH_NOTIFICATION = 0x73,
  112. REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74,
  113. SPECTRUM_MEASURE_NOTIFICATION = 0x75,
  114. /* Power Management */
  115. POWER_TABLE_CMD = 0x77,
  116. PM_SLEEP_NOTIFICATION = 0x7A,
  117. PM_DEBUG_STATISTIC_NOTIFIC = 0x7B,
  118. /* Scan commands and notifications */
  119. REPLY_SCAN_CMD = 0x80,
  120. REPLY_SCAN_ABORT_CMD = 0x81,
  121. SCAN_START_NOTIFICATION = 0x82,
  122. SCAN_RESULTS_NOTIFICATION = 0x83,
  123. SCAN_COMPLETE_NOTIFICATION = 0x84,
  124. /* IBSS/AP commands */
  125. BEACON_NOTIFICATION = 0x90,
  126. REPLY_TX_BEACON = 0x91,
  127. WHO_IS_AWAKE_NOTIFICATION = 0x94, /* not used */
  128. /* Miscellaneous commands */
  129. REPLY_TX_POWER_DBM_CMD = 0x95,
  130. QUIET_NOTIFICATION = 0x96, /* not used */
  131. REPLY_TX_PWR_TABLE_CMD = 0x97,
  132. REPLY_TX_POWER_DBM_CMD_V1 = 0x98, /* old version of API */
  133. TX_ANT_CONFIGURATION_CMD = 0x98,
  134. MEASURE_ABORT_NOTIFICATION = 0x99, /* not used */
  135. /* Bluetooth device coexistence config command */
  136. REPLY_BT_CONFIG = 0x9b,
  137. /* Statistics */
  138. REPLY_STATISTICS_CMD = 0x9c,
  139. STATISTICS_NOTIFICATION = 0x9d,
  140. /* RF-KILL commands and notifications */
  141. REPLY_CARD_STATE_CMD = 0xa0,
  142. CARD_STATE_NOTIFICATION = 0xa1,
  143. /* Missed beacons notification */
  144. MISSED_BEACONS_NOTIFICATION = 0xa2,
  145. REPLY_CT_KILL_CONFIG_CMD = 0xa4,
  146. SENSITIVITY_CMD = 0xa8,
  147. REPLY_PHY_CALIBRATION_CMD = 0xb0,
  148. REPLY_RX_PHY_CMD = 0xc0,
  149. REPLY_RX_MPDU_CMD = 0xc1,
  150. REPLY_RX = 0xc3,
  151. REPLY_COMPRESSED_BA = 0xc5,
  152. /* BT Coex */
  153. REPLY_BT_COEX_PRIO_TABLE = 0xcc,
  154. REPLY_BT_COEX_PROT_ENV = 0xcd,
  155. REPLY_BT_COEX_PROFILE_NOTIF = 0xce,
  156. /* PAN commands */
  157. REPLY_WIPAN_PARAMS = 0xb2,
  158. REPLY_WIPAN_RXON = 0xb3, /* use REPLY_RXON structure */
  159. REPLY_WIPAN_RXON_TIMING = 0xb4, /* use REPLY_RXON_TIMING structure */
  160. REPLY_WIPAN_RXON_ASSOC = 0xb6, /* use REPLY_RXON_ASSOC structure */
  161. REPLY_WIPAN_QOS_PARAM = 0xb7, /* use REPLY_QOS_PARAM structure */
  162. REPLY_WIPAN_WEPKEY = 0xb8, /* use REPLY_WEPKEY structure */
  163. REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9,
  164. REPLY_WIPAN_NOA_NOTIFICATION = 0xbc,
  165. REPLY_WIPAN_DEACTIVATION_COMPLETE = 0xbd,
  166. REPLY_MAX = 0xff
  167. };
  168. /******************************************************************************
  169. * (0)
  170. * Commonly used structures and definitions:
  171. * Command header, rate_n_flags, txpower
  172. *
  173. *****************************************************************************/
  174. /* iwl_cmd_header flags value */
  175. #define IWL_CMD_FAILED_MSK 0x40
  176. #define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
  177. #define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
  178. #define SEQ_TO_INDEX(s) ((s) & 0xff)
  179. #define INDEX_TO_SEQ(i) ((i) & 0xff)
  180. #define SEQ_RX_FRAME cpu_to_le16(0x8000)
  181. /**
  182. * struct iwl_cmd_header
  183. *
  184. * This header format appears in the beginning of each command sent from the
  185. * driver, and each response/notification received from uCode.
  186. */
  187. struct iwl_cmd_header {
  188. u8 cmd; /* Command ID: REPLY_RXON, etc. */
  189. u8 flags; /* 0:5 reserved, 6 abort, 7 internal */
  190. /*
  191. * The driver sets up the sequence number to values of its choosing.
  192. * uCode does not use this value, but passes it back to the driver
  193. * when sending the response to each driver-originated command, so
  194. * the driver can match the response to the command. Since the values
  195. * don't get used by uCode, the driver may set up an arbitrary format.
  196. *
  197. * There is one exception: uCode sets bit 15 when it originates
  198. * the response/notification, i.e. when the response/notification
  199. * is not a direct response to a command sent by the driver. For
  200. * example, uCode issues REPLY_RX when it sends a received frame
  201. * to the driver; it is not a direct response to any driver command.
  202. *
  203. * The Linux driver uses the following format:
  204. *
  205. * 0:7 tfd index - position within TX queue
  206. * 8:12 TX queue id
  207. * 13:14 reserved
  208. * 15 unsolicited RX or uCode-originated notification
  209. */
  210. __le16 sequence;
  211. /* command or response/notification data follows immediately */
  212. u8 data[0];
  213. } __packed;
  214. /**
  215. * iwlagn rate_n_flags bit fields
  216. *
  217. * rate_n_flags format is used in following iwlagn commands:
  218. * REPLY_RX (response only)
  219. * REPLY_RX_MPDU (response only)
  220. * REPLY_TX (both command and response)
  221. * REPLY_TX_LINK_QUALITY_CMD
  222. *
  223. * High-throughput (HT) rate format for bits 7:0 (bit 8 must be "1"):
  224. * 2-0: 0) 6 Mbps
  225. * 1) 12 Mbps
  226. * 2) 18 Mbps
  227. * 3) 24 Mbps
  228. * 4) 36 Mbps
  229. * 5) 48 Mbps
  230. * 6) 54 Mbps
  231. * 7) 60 Mbps
  232. *
  233. * 4-3: 0) Single stream (SISO)
  234. * 1) Dual stream (MIMO)
  235. * 2) Triple stream (MIMO)
  236. *
  237. * 5: Value of 0x20 in bits 7:0 indicates 6 Mbps HT40 duplicate data
  238. *
  239. * Legacy OFDM rate format for bits 7:0 (bit 8 must be "0", bit 9 "0"):
  240. * 3-0: 0xD) 6 Mbps
  241. * 0xF) 9 Mbps
  242. * 0x5) 12 Mbps
  243. * 0x7) 18 Mbps
  244. * 0x9) 24 Mbps
  245. * 0xB) 36 Mbps
  246. * 0x1) 48 Mbps
  247. * 0x3) 54 Mbps
  248. *
  249. * Legacy CCK rate format for bits 7:0 (bit 8 must be "0", bit 9 "1"):
  250. * 6-0: 10) 1 Mbps
  251. * 20) 2 Mbps
  252. * 55) 5.5 Mbps
  253. * 110) 11 Mbps
  254. */
  255. #define RATE_MCS_CODE_MSK 0x7
  256. #define RATE_MCS_SPATIAL_POS 3
  257. #define RATE_MCS_SPATIAL_MSK 0x18
  258. #define RATE_MCS_HT_DUP_POS 5
  259. #define RATE_MCS_HT_DUP_MSK 0x20
  260. /* Both legacy and HT use bits 7:0 as the CCK/OFDM rate or HT MCS */
  261. #define RATE_MCS_RATE_MSK 0xff
  262. /* Bit 8: (1) HT format, (0) legacy format in bits 7:0 */
  263. #define RATE_MCS_FLAGS_POS 8
  264. #define RATE_MCS_HT_POS 8
  265. #define RATE_MCS_HT_MSK 0x100
  266. /* Bit 9: (1) CCK, (0) OFDM. HT (bit 8) must be "0" for this bit to be valid */
  267. #define RATE_MCS_CCK_POS 9
  268. #define RATE_MCS_CCK_MSK 0x200
  269. /* Bit 10: (1) Use Green Field preamble */
  270. #define RATE_MCS_GF_POS 10
  271. #define RATE_MCS_GF_MSK 0x400
  272. /* Bit 11: (1) Use 40Mhz HT40 chnl width, (0) use 20 MHz legacy chnl width */
  273. #define RATE_MCS_HT40_POS 11
  274. #define RATE_MCS_HT40_MSK 0x800
  275. /* Bit 12: (1) Duplicate data on both 20MHz chnls. HT40 (bit 11) must be set. */
  276. #define RATE_MCS_DUP_POS 12
  277. #define RATE_MCS_DUP_MSK 0x1000
  278. /* Bit 13: (1) Short guard interval (0.4 usec), (0) normal GI (0.8 usec) */
  279. #define RATE_MCS_SGI_POS 13
  280. #define RATE_MCS_SGI_MSK 0x2000
  281. /**
  282. * rate_n_flags Tx antenna masks
  283. * 4965 has 2 transmitters
  284. * 5100 has 1 transmitter B
  285. * 5150 has 1 transmitter A
  286. * 5300 has 3 transmitters
  287. * 5350 has 3 transmitters
  288. * bit14:16
  289. */
  290. #define RATE_MCS_ANT_POS 14
  291. #define RATE_MCS_ANT_A_MSK 0x04000
  292. #define RATE_MCS_ANT_B_MSK 0x08000
  293. #define RATE_MCS_ANT_C_MSK 0x10000
  294. #define RATE_MCS_ANT_AB_MSK (RATE_MCS_ANT_A_MSK | RATE_MCS_ANT_B_MSK)
  295. #define RATE_MCS_ANT_ABC_MSK (RATE_MCS_ANT_AB_MSK | RATE_MCS_ANT_C_MSK)
  296. #define RATE_ANT_NUM 3
  297. #define POWER_TABLE_NUM_ENTRIES 33
  298. #define POWER_TABLE_NUM_HT_OFDM_ENTRIES 32
  299. #define POWER_TABLE_CCK_ENTRY 32
  300. #define IWL_PWR_NUM_HT_OFDM_ENTRIES 24
  301. #define IWL_PWR_CCK_ENTRIES 2
  302. /**
  303. * struct tx_power_dual_stream
  304. *
  305. * Table entries in REPLY_TX_PWR_TABLE_CMD, REPLY_CHANNEL_SWITCH
  306. *
  307. * Same format as iwl_tx_power_dual_stream, but __le32
  308. */
  309. struct tx_power_dual_stream {
  310. __le32 dw;
  311. } __packed;
  312. /**
  313. * Command REPLY_TX_POWER_DBM_CMD = 0x98
  314. * struct iwlagn_tx_power_dbm_cmd
  315. */
  316. #define IWLAGN_TX_POWER_AUTO 0x7f
  317. #define IWLAGN_TX_POWER_NO_CLOSED (0x1 << 6)
  318. struct iwlagn_tx_power_dbm_cmd {
  319. s8 global_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
  320. u8 flags;
  321. s8 srv_chan_lmt; /*in half-dBm (e.g. 30 = 15 dBm) */
  322. u8 reserved;
  323. } __packed;
  324. /**
  325. * Command TX_ANT_CONFIGURATION_CMD = 0x98
  326. * This command is used to configure valid Tx antenna.
  327. * By default uCode concludes the valid antenna according to the radio flavor.
  328. * This command enables the driver to override/modify this conclusion.
  329. */
  330. struct iwl_tx_ant_config_cmd {
  331. __le32 valid;
  332. } __packed;
  333. /******************************************************************************
  334. * (0a)
  335. * Alive and Error Commands & Responses:
  336. *
  337. *****************************************************************************/
  338. #define UCODE_VALID_OK cpu_to_le32(0x1)
  339. enum iwlagn_ucode_subtype {
  340. UCODE_SUBTYPE_REGULAR = 0,
  341. UCODE_SUBTYPE_REGULAR_NEW = 1,
  342. UCODE_SUBTYPE_INIT = 9,
  343. /*
  344. * Not a valid subtype, the ucode has just a u8, so
  345. * we can use something > 0xff for this value.
  346. */
  347. UCODE_SUBTYPE_NONE_LOADED = 0x100,
  348. };
  349. /**
  350. * REPLY_ALIVE = 0x1 (response only, not a command)
  351. *
  352. * uCode issues this "alive" notification once the runtime image is ready
  353. * to receive commands from the driver. This is the *second* "alive"
  354. * notification that the driver will receive after rebooting uCode;
  355. * this "alive" is indicated by subtype field != 9.
  356. *
  357. * See comments documenting "BSM" (bootstrap state machine).
  358. *
  359. * This response includes two pointers to structures within the device's
  360. * data SRAM (access via HBUS_TARG_MEM_* regs) that are useful for debugging:
  361. *
  362. * 1) log_event_table_ptr indicates base of the event log. This traces
  363. * a 256-entry history of uCode execution within a circular buffer.
  364. * Its header format is:
  365. *
  366. * __le32 log_size; log capacity (in number of entries)
  367. * __le32 type; (1) timestamp with each entry, (0) no timestamp
  368. * __le32 wraps; # times uCode has wrapped to top of circular buffer
  369. * __le32 write_index; next circular buffer entry that uCode would fill
  370. *
  371. * The header is followed by the circular buffer of log entries. Entries
  372. * with timestamps have the following format:
  373. *
  374. * __le32 event_id; range 0 - 1500
  375. * __le32 timestamp; low 32 bits of TSF (of network, if associated)
  376. * __le32 data; event_id-specific data value
  377. *
  378. * Entries without timestamps contain only event_id and data.
  379. *
  380. *
  381. * 2) error_event_table_ptr indicates base of the error log. This contains
  382. * information about any uCode error that occurs. For agn, the format
  383. * of the error log is defined by struct iwl_error_event_table.
  384. *
  385. * The Linux driver can print both logs to the system log when a uCode error
  386. * occurs.
  387. */
  388. /*
  389. * Note: This structure is read from the device with IO accesses,
  390. * and the reading already does the endian conversion. As it is
  391. * read with u32-sized accesses, any members with a different size
  392. * need to be ordered correctly though!
  393. */
  394. struct iwl_error_event_table {
  395. u32 valid; /* (nonzero) valid, (0) log is empty */
  396. u32 error_id; /* type of error */
  397. u32 pc; /* program counter */
  398. u32 blink1; /* branch link */
  399. u32 blink2; /* branch link */
  400. u32 ilink1; /* interrupt link */
  401. u32 ilink2; /* interrupt link */
  402. u32 data1; /* error-specific data */
  403. u32 data2; /* error-specific data */
  404. u32 line; /* source code line of error */
  405. u32 bcon_time; /* beacon timer */
  406. u32 tsf_low; /* network timestamp function timer */
  407. u32 tsf_hi; /* network timestamp function timer */
  408. u32 gp1; /* GP1 timer register */
  409. u32 gp2; /* GP2 timer register */
  410. u32 gp3; /* GP3 timer register */
  411. u32 ucode_ver; /* uCode version */
  412. u32 hw_ver; /* HW Silicon version */
  413. u32 brd_ver; /* HW board version */
  414. u32 log_pc; /* log program counter */
  415. u32 frame_ptr; /* frame pointer */
  416. u32 stack_ptr; /* stack pointer */
  417. u32 hcmd; /* last host command header */
  418. #if 0
  419. /* no need to read the remainder, we don't use the values */
  420. u32 isr0; /* isr status register LMPM_NIC_ISR0: rxtx_flag */
  421. u32 isr1; /* isr status register LMPM_NIC_ISR1: host_flag */
  422. u32 isr2; /* isr status register LMPM_NIC_ISR2: enc_flag */
  423. u32 isr3; /* isr status register LMPM_NIC_ISR3: time_flag */
  424. u32 isr4; /* isr status register LMPM_NIC_ISR4: wico interrupt */
  425. u32 isr_pref; /* isr status register LMPM_NIC_PREF_STAT */
  426. u32 wait_event; /* wait event() caller address */
  427. u32 l2p_control; /* L2pControlField */
  428. u32 l2p_duration; /* L2pDurationField */
  429. u32 l2p_mhvalid; /* L2pMhValidBits */
  430. u32 l2p_addr_match; /* L2pAddrMatchStat */
  431. u32 lmpm_pmg_sel; /* indicate which clocks are turned on (LMPM_PMG_SEL) */
  432. u32 u_timestamp; /* indicate when the date and time of the compilation */
  433. u32 flow_handler; /* FH read/write pointers, RX credit */
  434. #endif
  435. } __packed;
  436. struct iwl_alive_resp {
  437. u8 ucode_minor;
  438. u8 ucode_major;
  439. __le16 reserved1;
  440. u8 sw_rev[8];
  441. u8 ver_type;
  442. u8 ver_subtype; /* not "9" for runtime alive */
  443. __le16 reserved2;
  444. __le32 log_event_table_ptr; /* SRAM address for event log */
  445. __le32 error_event_table_ptr; /* SRAM address for error log */
  446. __le32 timestamp;
  447. __le32 is_valid;
  448. } __packed;
  449. /*
  450. * REPLY_ERROR = 0x2 (response only, not a command)
  451. */
  452. struct iwl_error_resp {
  453. __le32 error_type;
  454. u8 cmd_id;
  455. u8 reserved1;
  456. __le16 bad_cmd_seq_num;
  457. __le32 error_info;
  458. __le64 timestamp;
  459. } __packed;
  460. /******************************************************************************
  461. * (1)
  462. * RXON Commands & Responses:
  463. *
  464. *****************************************************************************/
  465. /*
  466. * Rx config defines & structure
  467. */
  468. /* rx_config device types */
  469. enum {
  470. RXON_DEV_TYPE_AP = 1,
  471. RXON_DEV_TYPE_ESS = 3,
  472. RXON_DEV_TYPE_IBSS = 4,
  473. RXON_DEV_TYPE_SNIFFER = 6,
  474. RXON_DEV_TYPE_CP = 7,
  475. RXON_DEV_TYPE_2STA = 8,
  476. RXON_DEV_TYPE_P2P = 9,
  477. };
  478. #define RXON_RX_CHAIN_DRIVER_FORCE_MSK cpu_to_le16(0x1 << 0)
  479. #define RXON_RX_CHAIN_DRIVER_FORCE_POS (0)
  480. #define RXON_RX_CHAIN_VALID_MSK cpu_to_le16(0x7 << 1)
  481. #define RXON_RX_CHAIN_VALID_POS (1)
  482. #define RXON_RX_CHAIN_FORCE_SEL_MSK cpu_to_le16(0x7 << 4)
  483. #define RXON_RX_CHAIN_FORCE_SEL_POS (4)
  484. #define RXON_RX_CHAIN_FORCE_MIMO_SEL_MSK cpu_to_le16(0x7 << 7)
  485. #define RXON_RX_CHAIN_FORCE_MIMO_SEL_POS (7)
  486. #define RXON_RX_CHAIN_CNT_MSK cpu_to_le16(0x3 << 10)
  487. #define RXON_RX_CHAIN_CNT_POS (10)
  488. #define RXON_RX_CHAIN_MIMO_CNT_MSK cpu_to_le16(0x3 << 12)
  489. #define RXON_RX_CHAIN_MIMO_CNT_POS (12)
  490. #define RXON_RX_CHAIN_MIMO_FORCE_MSK cpu_to_le16(0x1 << 14)
  491. #define RXON_RX_CHAIN_MIMO_FORCE_POS (14)
  492. /* rx_config flags */
  493. /* band & modulation selection */
  494. #define RXON_FLG_BAND_24G_MSK cpu_to_le32(1 << 0)
  495. #define RXON_FLG_CCK_MSK cpu_to_le32(1 << 1)
  496. /* auto detection enable */
  497. #define RXON_FLG_AUTO_DETECT_MSK cpu_to_le32(1 << 2)
  498. /* TGg protection when tx */
  499. #define RXON_FLG_TGG_PROTECT_MSK cpu_to_le32(1 << 3)
  500. /* cck short slot & preamble */
  501. #define RXON_FLG_SHORT_SLOT_MSK cpu_to_le32(1 << 4)
  502. #define RXON_FLG_SHORT_PREAMBLE_MSK cpu_to_le32(1 << 5)
  503. /* antenna selection */
  504. #define RXON_FLG_DIS_DIV_MSK cpu_to_le32(1 << 7)
  505. #define RXON_FLG_ANT_SEL_MSK cpu_to_le32(0x0f00)
  506. #define RXON_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
  507. #define RXON_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
  508. /* radar detection enable */
  509. #define RXON_FLG_RADAR_DETECT_MSK cpu_to_le32(1 << 12)
  510. #define RXON_FLG_TGJ_NARROW_BAND_MSK cpu_to_le32(1 << 13)
  511. /* rx response to host with 8-byte TSF
  512. * (according to ON_AIR deassertion) */
  513. #define RXON_FLG_TSF2HOST_MSK cpu_to_le32(1 << 15)
  514. /* HT flags */
  515. #define RXON_FLG_CTRL_CHANNEL_LOC_POS (22)
  516. #define RXON_FLG_CTRL_CHANNEL_LOC_HI_MSK cpu_to_le32(0x1 << 22)
  517. #define RXON_FLG_HT_OPERATING_MODE_POS (23)
  518. #define RXON_FLG_HT_PROT_MSK cpu_to_le32(0x1 << 23)
  519. #define RXON_FLG_HT40_PROT_MSK cpu_to_le32(0x2 << 23)
  520. #define RXON_FLG_CHANNEL_MODE_POS (25)
  521. #define RXON_FLG_CHANNEL_MODE_MSK cpu_to_le32(0x3 << 25)
  522. /* channel mode */
  523. enum {
  524. CHANNEL_MODE_LEGACY = 0,
  525. CHANNEL_MODE_PURE_40 = 1,
  526. CHANNEL_MODE_MIXED = 2,
  527. CHANNEL_MODE_RESERVED = 3,
  528. };
  529. #define RXON_FLG_CHANNEL_MODE_LEGACY cpu_to_le32(CHANNEL_MODE_LEGACY << RXON_FLG_CHANNEL_MODE_POS)
  530. #define RXON_FLG_CHANNEL_MODE_PURE_40 cpu_to_le32(CHANNEL_MODE_PURE_40 << RXON_FLG_CHANNEL_MODE_POS)
  531. #define RXON_FLG_CHANNEL_MODE_MIXED cpu_to_le32(CHANNEL_MODE_MIXED << RXON_FLG_CHANNEL_MODE_POS)
  532. /* CTS to self (if spec allows) flag */
  533. #define RXON_FLG_SELF_CTS_EN cpu_to_le32(0x1<<30)
  534. /* rx_config filter flags */
  535. /* accept all data frames */
  536. #define RXON_FILTER_PROMISC_MSK cpu_to_le32(1 << 0)
  537. /* pass control & management to host */
  538. #define RXON_FILTER_CTL2HOST_MSK cpu_to_le32(1 << 1)
  539. /* accept multi-cast */
  540. #define RXON_FILTER_ACCEPT_GRP_MSK cpu_to_le32(1 << 2)
  541. /* don't decrypt uni-cast frames */
  542. #define RXON_FILTER_DIS_DECRYPT_MSK cpu_to_le32(1 << 3)
  543. /* don't decrypt multi-cast frames */
  544. #define RXON_FILTER_DIS_GRP_DECRYPT_MSK cpu_to_le32(1 << 4)
  545. /* STA is associated */
  546. #define RXON_FILTER_ASSOC_MSK cpu_to_le32(1 << 5)
  547. /* transfer to host non bssid beacons in associated state */
  548. #define RXON_FILTER_BCON_AWARE_MSK cpu_to_le32(1 << 6)
  549. /**
  550. * REPLY_RXON = 0x10 (command, has simple generic response)
  551. *
  552. * RXON tunes the radio tuner to a service channel, and sets up a number
  553. * of parameters that are used primarily for Rx, but also for Tx operations.
  554. *
  555. * NOTE: When tuning to a new channel, driver must set the
  556. * RXON_FILTER_ASSOC_MSK to 0. This will clear station-dependent
  557. * info within the device, including the station tables, tx retry
  558. * rate tables, and txpower tables. Driver must build a new station
  559. * table and txpower table before transmitting anything on the RXON
  560. * channel.
  561. *
  562. * NOTE: All RXONs wipe clean the internal txpower table. Driver must
  563. * issue a new REPLY_TX_PWR_TABLE_CMD after each REPLY_RXON (0x10),
  564. * regardless of whether RXON_FILTER_ASSOC_MSK is set.
  565. */
  566. struct iwl_rxon_cmd {
  567. u8 node_addr[6];
  568. __le16 reserved1;
  569. u8 bssid_addr[6];
  570. __le16 reserved2;
  571. u8 wlap_bssid_addr[6];
  572. __le16 reserved3;
  573. u8 dev_type;
  574. u8 air_propagation;
  575. __le16 rx_chain;
  576. u8 ofdm_basic_rates;
  577. u8 cck_basic_rates;
  578. __le16 assoc_id;
  579. __le32 flags;
  580. __le32 filter_flags;
  581. __le16 channel;
  582. u8 ofdm_ht_single_stream_basic_rates;
  583. u8 ofdm_ht_dual_stream_basic_rates;
  584. u8 ofdm_ht_triple_stream_basic_rates;
  585. u8 reserved5;
  586. __le16 acquisition_data;
  587. __le16 reserved6;
  588. } __packed;
  589. /*
  590. * REPLY_RXON_ASSOC = 0x11 (command, has simple generic response)
  591. */
  592. struct iwl_rxon_assoc_cmd {
  593. __le32 flags;
  594. __le32 filter_flags;
  595. u8 ofdm_basic_rates;
  596. u8 cck_basic_rates;
  597. __le16 reserved1;
  598. u8 ofdm_ht_single_stream_basic_rates;
  599. u8 ofdm_ht_dual_stream_basic_rates;
  600. u8 ofdm_ht_triple_stream_basic_rates;
  601. u8 reserved2;
  602. __le16 rx_chain_select_flags;
  603. __le16 acquisition_data;
  604. __le32 reserved3;
  605. } __packed;
  606. #define IWL_CONN_MAX_LISTEN_INTERVAL 10
  607. #define IWL_MAX_UCODE_BEACON_INTERVAL 4 /* 4096 */
  608. #define IWL39_MAX_UCODE_BEACON_INTERVAL 1 /* 1024 */
  609. /*
  610. * REPLY_RXON_TIMING = 0x14 (command, has simple generic response)
  611. */
  612. struct iwl_rxon_time_cmd {
  613. __le64 timestamp;
  614. __le16 beacon_interval;
  615. __le16 atim_window;
  616. __le32 beacon_init_val;
  617. __le16 listen_interval;
  618. u8 dtim_period;
  619. u8 delta_cp_bss_tbtts;
  620. } __packed;
  621. /*
  622. * REPLY_CHANNEL_SWITCH = 0x72 (command, has simple generic response)
  623. */
  624. /**
  625. * struct iwl5000_channel_switch_cmd
  626. * @band: 0- 5.2GHz, 1- 2.4GHz
  627. * @expect_beacon: 0- resume transmits after channel switch
  628. * 1- wait for beacon to resume transmits
  629. * @channel: new channel number
  630. * @rxon_flags: Rx on flags
  631. * @rxon_filter_flags: filtering parameters
  632. * @switch_time: switch time in extended beacon format
  633. * @reserved: reserved bytes
  634. */
  635. struct iwl5000_channel_switch_cmd {
  636. u8 band;
  637. u8 expect_beacon;
  638. __le16 channel;
  639. __le32 rxon_flags;
  640. __le32 rxon_filter_flags;
  641. __le32 switch_time;
  642. __le32 reserved[2][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
  643. } __packed;
  644. /**
  645. * struct iwl6000_channel_switch_cmd
  646. * @band: 0- 5.2GHz, 1- 2.4GHz
  647. * @expect_beacon: 0- resume transmits after channel switch
  648. * 1- wait for beacon to resume transmits
  649. * @channel: new channel number
  650. * @rxon_flags: Rx on flags
  651. * @rxon_filter_flags: filtering parameters
  652. * @switch_time: switch time in extended beacon format
  653. * @reserved: reserved bytes
  654. */
  655. struct iwl6000_channel_switch_cmd {
  656. u8 band;
  657. u8 expect_beacon;
  658. __le16 channel;
  659. __le32 rxon_flags;
  660. __le32 rxon_filter_flags;
  661. __le32 switch_time;
  662. __le32 reserved[3][IWL_PWR_NUM_HT_OFDM_ENTRIES + IWL_PWR_CCK_ENTRIES];
  663. } __packed;
  664. /*
  665. * CHANNEL_SWITCH_NOTIFICATION = 0x73 (notification only, not a command)
  666. */
  667. struct iwl_csa_notification {
  668. __le16 band;
  669. __le16 channel;
  670. __le32 status; /* 0 - OK, 1 - fail */
  671. } __packed;
  672. /******************************************************************************
  673. * (2)
  674. * Quality-of-Service (QOS) Commands & Responses:
  675. *
  676. *****************************************************************************/
  677. /**
  678. * struct iwl_ac_qos -- QOS timing params for REPLY_QOS_PARAM
  679. * One for each of 4 EDCA access categories in struct iwl_qosparam_cmd
  680. *
  681. * @cw_min: Contention window, start value in numbers of slots.
  682. * Should be a power-of-2, minus 1. Device's default is 0x0f.
  683. * @cw_max: Contention window, max value in numbers of slots.
  684. * Should be a power-of-2, minus 1. Device's default is 0x3f.
  685. * @aifsn: Number of slots in Arbitration Interframe Space (before
  686. * performing random backoff timing prior to Tx). Device default 1.
  687. * @edca_txop: Length of Tx opportunity, in uSecs. Device default is 0.
  688. *
  689. * Device will automatically increase contention window by (2*CW) + 1 for each
  690. * transmission retry. Device uses cw_max as a bit mask, ANDed with new CW
  691. * value, to cap the CW value.
  692. */
  693. struct iwl_ac_qos {
  694. __le16 cw_min;
  695. __le16 cw_max;
  696. u8 aifsn;
  697. u8 reserved1;
  698. __le16 edca_txop;
  699. } __packed;
  700. /* QoS flags defines */
  701. #define QOS_PARAM_FLG_UPDATE_EDCA_MSK cpu_to_le32(0x01)
  702. #define QOS_PARAM_FLG_TGN_MSK cpu_to_le32(0x02)
  703. #define QOS_PARAM_FLG_TXOP_TYPE_MSK cpu_to_le32(0x10)
  704. /* Number of Access Categories (AC) (EDCA), queues 0..3 */
  705. #define AC_NUM 4
  706. /*
  707. * REPLY_QOS_PARAM = 0x13 (command, has simple generic response)
  708. *
  709. * This command sets up timings for each of the 4 prioritized EDCA Tx FIFOs
  710. * 0: Background, 1: Best Effort, 2: Video, 3: Voice.
  711. */
  712. struct iwl_qosparam_cmd {
  713. __le32 qos_flags;
  714. struct iwl_ac_qos ac[AC_NUM];
  715. } __packed;
  716. /******************************************************************************
  717. * (3)
  718. * Add/Modify Stations Commands & Responses:
  719. *
  720. *****************************************************************************/
  721. /*
  722. * Multi station support
  723. */
  724. /* Special, dedicated locations within device's station table */
  725. #define IWL_AP_ID 0
  726. #define IWL_AP_ID_PAN 1
  727. #define IWL_STA_ID 2
  728. #define IWLAGN_PAN_BCAST_ID 14
  729. #define IWLAGN_BROADCAST_ID 15
  730. #define IWLAGN_STATION_COUNT 16
  731. #define IWL_INVALID_STATION 255
  732. #define STA_FLG_TX_RATE_MSK cpu_to_le32(1 << 2)
  733. #define STA_FLG_PWR_SAVE_MSK cpu_to_le32(1 << 8)
  734. #define STA_FLG_PAN_STATION cpu_to_le32(1 << 13)
  735. #define STA_FLG_RTS_MIMO_PROT_MSK cpu_to_le32(1 << 17)
  736. #define STA_FLG_AGG_MPDU_8US_MSK cpu_to_le32(1 << 18)
  737. #define STA_FLG_MAX_AGG_SIZE_POS (19)
  738. #define STA_FLG_MAX_AGG_SIZE_MSK cpu_to_le32(3 << 19)
  739. #define STA_FLG_HT40_EN_MSK cpu_to_le32(1 << 21)
  740. #define STA_FLG_MIMO_DIS_MSK cpu_to_le32(1 << 22)
  741. #define STA_FLG_AGG_MPDU_DENSITY_POS (23)
  742. #define STA_FLG_AGG_MPDU_DENSITY_MSK cpu_to_le32(7 << 23)
  743. /* Use in mode field. 1: modify existing entry, 0: add new station entry */
  744. #define STA_CONTROL_MODIFY_MSK 0x01
  745. /* key flags __le16*/
  746. #define STA_KEY_FLG_ENCRYPT_MSK cpu_to_le16(0x0007)
  747. #define STA_KEY_FLG_NO_ENC cpu_to_le16(0x0000)
  748. #define STA_KEY_FLG_WEP cpu_to_le16(0x0001)
  749. #define STA_KEY_FLG_CCMP cpu_to_le16(0x0002)
  750. #define STA_KEY_FLG_TKIP cpu_to_le16(0x0003)
  751. #define STA_KEY_FLG_KEYID_POS 8
  752. #define STA_KEY_FLG_INVALID cpu_to_le16(0x0800)
  753. /* wep key is either from global key (0) or from station info array (1) */
  754. #define STA_KEY_FLG_MAP_KEY_MSK cpu_to_le16(0x0008)
  755. /* wep key in STA: 5-bytes (0) or 13-bytes (1) */
  756. #define STA_KEY_FLG_KEY_SIZE_MSK cpu_to_le16(0x1000)
  757. #define STA_KEY_MULTICAST_MSK cpu_to_le16(0x4000)
  758. #define STA_KEY_MAX_NUM 8
  759. #define STA_KEY_MAX_NUM_PAN 16
  760. /* Flags indicate whether to modify vs. don't change various station params */
  761. #define STA_MODIFY_KEY_MASK 0x01
  762. #define STA_MODIFY_TID_DISABLE_TX 0x02
  763. #define STA_MODIFY_TX_RATE_MSK 0x04
  764. #define STA_MODIFY_ADDBA_TID_MSK 0x08
  765. #define STA_MODIFY_DELBA_TID_MSK 0x10
  766. #define STA_MODIFY_SLEEP_TX_COUNT_MSK 0x20
  767. /* Receiver address (actually, Rx station's index into station table),
  768. * combined with Traffic ID (QOS priority), in format used by Tx Scheduler */
  769. #define BUILD_RAxTID(sta_id, tid) (((sta_id) << 4) + (tid))
  770. /* agn */
  771. struct iwl_keyinfo {
  772. __le16 key_flags;
  773. u8 tkip_rx_tsc_byte2; /* TSC[2] for key mix ph1 detection */
  774. u8 reserved1;
  775. __le16 tkip_rx_ttak[5]; /* 10-byte unicast TKIP TTAK */
  776. u8 key_offset;
  777. u8 reserved2;
  778. u8 key[16]; /* 16-byte unicast decryption key */
  779. __le64 tx_secur_seq_cnt;
  780. __le64 hw_tkip_mic_rx_key;
  781. __le64 hw_tkip_mic_tx_key;
  782. } __packed;
  783. /**
  784. * struct sta_id_modify
  785. * @addr[ETH_ALEN]: station's MAC address
  786. * @sta_id: index of station in uCode's station table
  787. * @modify_mask: STA_MODIFY_*, 1: modify, 0: don't change
  788. *
  789. * Driver selects unused table index when adding new station,
  790. * or the index to a pre-existing station entry when modifying that station.
  791. * Some indexes have special purposes (IWL_AP_ID, index 0, is for AP).
  792. *
  793. * modify_mask flags select which parameters to modify vs. leave alone.
  794. */
  795. struct sta_id_modify {
  796. u8 addr[ETH_ALEN];
  797. __le16 reserved1;
  798. u8 sta_id;
  799. u8 modify_mask;
  800. __le16 reserved2;
  801. } __packed;
  802. /*
  803. * REPLY_ADD_STA = 0x18 (command)
  804. *
  805. * The device contains an internal table of per-station information,
  806. * with info on security keys, aggregation parameters, and Tx rates for
  807. * initial Tx attempt and any retries (agn devices uses
  808. * REPLY_TX_LINK_QUALITY_CMD,
  809. *
  810. * REPLY_ADD_STA sets up the table entry for one station, either creating
  811. * a new entry, or modifying a pre-existing one.
  812. *
  813. * NOTE: RXON command (without "associated" bit set) wipes the station table
  814. * clean. Moving into RF_KILL state does this also. Driver must set up
  815. * new station table before transmitting anything on the RXON channel
  816. * (except active scans or active measurements; those commands carry
  817. * their own txpower/rate setup data).
  818. *
  819. * When getting started on a new channel, driver must set up the
  820. * IWL_BROADCAST_ID entry (last entry in the table). For a client
  821. * station in a BSS, once an AP is selected, driver sets up the AP STA
  822. * in the IWL_AP_ID entry (1st entry in the table). BROADCAST and AP
  823. * are all that are needed for a BSS client station. If the device is
  824. * used as AP, or in an IBSS network, driver must set up station table
  825. * entries for all STAs in network, starting with index IWL_STA_ID.
  826. */
  827. struct iwl_addsta_cmd {
  828. u8 mode; /* 1: modify existing, 0: add new station */
  829. u8 reserved[3];
  830. struct sta_id_modify sta;
  831. struct iwl_keyinfo key;
  832. __le32 station_flags; /* STA_FLG_* */
  833. __le32 station_flags_msk; /* STA_FLG_* */
  834. /* bit field to disable (1) or enable (0) Tx for Traffic ID (TID)
  835. * corresponding to bit (e.g. bit 5 controls TID 5).
  836. * Set modify_mask bit STA_MODIFY_TID_DISABLE_TX to use this field. */
  837. __le16 tid_disable_tx;
  838. __le16 rate_n_flags; /* 3945 only */
  839. /* TID for which to add block-ack support.
  840. * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
  841. u8 add_immediate_ba_tid;
  842. /* TID for which to remove block-ack support.
  843. * Set modify_mask bit STA_MODIFY_DELBA_TID_MSK to use this field. */
  844. u8 remove_immediate_ba_tid;
  845. /* Starting Sequence Number for added block-ack support.
  846. * Set modify_mask bit STA_MODIFY_ADDBA_TID_MSK to use this field. */
  847. __le16 add_immediate_ba_ssn;
  848. /*
  849. * Number of packets OK to transmit to station even though
  850. * it is asleep -- used to synchronise PS-poll and u-APSD
  851. * responses while ucode keeps track of STA sleep state.
  852. */
  853. __le16 sleep_tx_count;
  854. __le16 reserved2;
  855. } __packed;
  856. #define ADD_STA_SUCCESS_MSK 0x1
  857. #define ADD_STA_NO_ROOM_IN_TABLE 0x2
  858. #define ADD_STA_NO_BLOCK_ACK_RESOURCE 0x4
  859. #define ADD_STA_MODIFY_NON_EXIST_STA 0x8
  860. /*
  861. * REPLY_ADD_STA = 0x18 (response)
  862. */
  863. struct iwl_add_sta_resp {
  864. u8 status; /* ADD_STA_* */
  865. } __packed;
  866. #define REM_STA_SUCCESS_MSK 0x1
  867. /*
  868. * REPLY_REM_STA = 0x19 (response)
  869. */
  870. struct iwl_rem_sta_resp {
  871. u8 status;
  872. } __packed;
  873. /*
  874. * REPLY_REM_STA = 0x19 (command)
  875. */
  876. struct iwl_rem_sta_cmd {
  877. u8 num_sta; /* number of removed stations */
  878. u8 reserved[3];
  879. u8 addr[ETH_ALEN]; /* MAC addr of the first station */
  880. u8 reserved2[2];
  881. } __packed;
  882. #define IWL_TX_FIFO_BK_MSK cpu_to_le32(BIT(0))
  883. #define IWL_TX_FIFO_BE_MSK cpu_to_le32(BIT(1))
  884. #define IWL_TX_FIFO_VI_MSK cpu_to_le32(BIT(2))
  885. #define IWL_TX_FIFO_VO_MSK cpu_to_le32(BIT(3))
  886. #define IWL_AGG_TX_QUEUE_MSK cpu_to_le32(0xffc00)
  887. #define IWL_DROP_SINGLE 0
  888. #define IWL_DROP_SELECTED 1
  889. #define IWL_DROP_ALL 2
  890. /*
  891. * REPLY_TXFIFO_FLUSH = 0x1e(command and response)
  892. *
  893. * When using full FIFO flush this command checks the scheduler HW block WR/RD
  894. * pointers to check if all the frames were transferred by DMA into the
  895. * relevant TX FIFO queue. Only when the DMA is finished and the queue is
  896. * empty the command can finish.
  897. * This command is used to flush the TXFIFO from transmit commands, it may
  898. * operate on single or multiple queues, the command queue can't be flushed by
  899. * this command. The command response is returned when all the queue flush
  900. * operations are done. Each TX command flushed return response with the FLUSH
  901. * status set in the TX response status. When FIFO flush operation is used,
  902. * the flush operation ends when both the scheduler DMA done and TXFIFO empty
  903. * are set.
  904. *
  905. * @fifo_control: bit mask for which queues to flush
  906. * @flush_control: flush controls
  907. * 0: Dump single MSDU
  908. * 1: Dump multiple MSDU according to PS, INVALID STA, TTL, TID disable.
  909. * 2: Dump all FIFO
  910. */
  911. struct iwl_txfifo_flush_cmd {
  912. __le32 fifo_control;
  913. __le16 flush_control;
  914. __le16 reserved;
  915. } __packed;
  916. /*
  917. * REPLY_WEP_KEY = 0x20
  918. */
  919. struct iwl_wep_key {
  920. u8 key_index;
  921. u8 key_offset;
  922. u8 reserved1[2];
  923. u8 key_size;
  924. u8 reserved2[3];
  925. u8 key[16];
  926. } __packed;
  927. struct iwl_wep_cmd {
  928. u8 num_keys;
  929. u8 global_key_type;
  930. u8 flags;
  931. u8 reserved;
  932. struct iwl_wep_key key[0];
  933. } __packed;
  934. #define WEP_KEY_WEP_TYPE 1
  935. #define WEP_KEYS_MAX 4
  936. #define WEP_INVALID_OFFSET 0xff
  937. #define WEP_KEY_LEN_64 5
  938. #define WEP_KEY_LEN_128 13
  939. /******************************************************************************
  940. * (4)
  941. * Rx Responses:
  942. *
  943. *****************************************************************************/
  944. #define RX_RES_STATUS_NO_CRC32_ERROR cpu_to_le32(1 << 0)
  945. #define RX_RES_STATUS_NO_RXE_OVERFLOW cpu_to_le32(1 << 1)
  946. #define RX_RES_PHY_FLAGS_BAND_24_MSK cpu_to_le16(1 << 0)
  947. #define RX_RES_PHY_FLAGS_MOD_CCK_MSK cpu_to_le16(1 << 1)
  948. #define RX_RES_PHY_FLAGS_SHORT_PREAMBLE_MSK cpu_to_le16(1 << 2)
  949. #define RX_RES_PHY_FLAGS_NARROW_BAND_MSK cpu_to_le16(1 << 3)
  950. #define RX_RES_PHY_FLAGS_ANTENNA_MSK 0xf0
  951. #define RX_RES_PHY_FLAGS_ANTENNA_POS 4
  952. #define RX_RES_STATUS_SEC_TYPE_MSK (0x7 << 8)
  953. #define RX_RES_STATUS_SEC_TYPE_NONE (0x0 << 8)
  954. #define RX_RES_STATUS_SEC_TYPE_WEP (0x1 << 8)
  955. #define RX_RES_STATUS_SEC_TYPE_CCMP (0x2 << 8)
  956. #define RX_RES_STATUS_SEC_TYPE_TKIP (0x3 << 8)
  957. #define RX_RES_STATUS_SEC_TYPE_ERR (0x7 << 8)
  958. #define RX_RES_STATUS_STATION_FOUND (1<<6)
  959. #define RX_RES_STATUS_NO_STATION_INFO_MISMATCH (1<<7)
  960. #define RX_RES_STATUS_DECRYPT_TYPE_MSK (0x3 << 11)
  961. #define RX_RES_STATUS_NOT_DECRYPT (0x0 << 11)
  962. #define RX_RES_STATUS_DECRYPT_OK (0x3 << 11)
  963. #define RX_RES_STATUS_BAD_ICV_MIC (0x1 << 11)
  964. #define RX_RES_STATUS_BAD_KEY_TTAK (0x2 << 11)
  965. #define RX_MPDU_RES_STATUS_ICV_OK (0x20)
  966. #define RX_MPDU_RES_STATUS_MIC_OK (0x40)
  967. #define RX_MPDU_RES_STATUS_TTAK_OK (1 << 7)
  968. #define RX_MPDU_RES_STATUS_DEC_DONE_MSK (0x800)
  969. #define IWLAGN_RX_RES_PHY_CNT 8
  970. #define IWLAGN_RX_RES_AGC_IDX 1
  971. #define IWLAGN_RX_RES_RSSI_AB_IDX 2
  972. #define IWLAGN_RX_RES_RSSI_C_IDX 3
  973. #define IWLAGN_OFDM_AGC_MSK 0xfe00
  974. #define IWLAGN_OFDM_AGC_BIT_POS 9
  975. #define IWLAGN_OFDM_RSSI_INBAND_A_BITMSK 0x00ff
  976. #define IWLAGN_OFDM_RSSI_ALLBAND_A_BITMSK 0xff00
  977. #define IWLAGN_OFDM_RSSI_A_BIT_POS 0
  978. #define IWLAGN_OFDM_RSSI_INBAND_B_BITMSK 0xff0000
  979. #define IWLAGN_OFDM_RSSI_ALLBAND_B_BITMSK 0xff000000
  980. #define IWLAGN_OFDM_RSSI_B_BIT_POS 16
  981. #define IWLAGN_OFDM_RSSI_INBAND_C_BITMSK 0x00ff
  982. #define IWLAGN_OFDM_RSSI_ALLBAND_C_BITMSK 0xff00
  983. #define IWLAGN_OFDM_RSSI_C_BIT_POS 0
  984. struct iwlagn_non_cfg_phy {
  985. __le32 non_cfg_phy[IWLAGN_RX_RES_PHY_CNT]; /* up to 8 phy entries */
  986. } __packed;
  987. /*
  988. * REPLY_RX = 0xc3 (response only, not a command)
  989. * Used only for legacy (non 11n) frames.
  990. */
  991. struct iwl_rx_phy_res {
  992. u8 non_cfg_phy_cnt; /* non configurable DSP phy data byte count */
  993. u8 cfg_phy_cnt; /* configurable DSP phy data byte count */
  994. u8 stat_id; /* configurable DSP phy data set ID */
  995. u8 reserved1;
  996. __le64 timestamp; /* TSF at on air rise */
  997. __le32 beacon_time_stamp; /* beacon at on-air rise */
  998. __le16 phy_flags; /* general phy flags: band, modulation, ... */
  999. __le16 channel; /* channel number */
  1000. u8 non_cfg_phy_buf[32]; /* for various implementations of non_cfg_phy */
  1001. __le32 rate_n_flags; /* RATE_MCS_* */
  1002. __le16 byte_count; /* frame's byte-count */
  1003. __le16 frame_time; /* frame's time on the air */
  1004. } __packed;
  1005. struct iwl_rx_mpdu_res_start {
  1006. __le16 byte_count;
  1007. __le16 reserved;
  1008. } __packed;
  1009. /******************************************************************************
  1010. * (5)
  1011. * Tx Commands & Responses:
  1012. *
  1013. * Driver must place each REPLY_TX command into one of the prioritized Tx
  1014. * queues in host DRAM, shared between driver and device (see comments for
  1015. * SCD registers and Tx/Rx Queues). When the device's Tx scheduler and uCode
  1016. * are preparing to transmit, the device pulls the Tx command over the PCI
  1017. * bus via one of the device's Tx DMA channels, to fill an internal FIFO
  1018. * from which data will be transmitted.
  1019. *
  1020. * uCode handles all timing and protocol related to control frames
  1021. * (RTS/CTS/ACK), based on flags in the Tx command. uCode and Tx scheduler
  1022. * handle reception of block-acks; uCode updates the host driver via
  1023. * REPLY_COMPRESSED_BA.
  1024. *
  1025. * uCode handles retrying Tx when an ACK is expected but not received.
  1026. * This includes trying lower data rates than the one requested in the Tx
  1027. * command, as set up by the REPLY_RATE_SCALE (for 3945) or
  1028. * REPLY_TX_LINK_QUALITY_CMD (agn).
  1029. *
  1030. * Driver sets up transmit power for various rates via REPLY_TX_PWR_TABLE_CMD.
  1031. * This command must be executed after every RXON command, before Tx can occur.
  1032. *****************************************************************************/
  1033. /* REPLY_TX Tx flags field */
  1034. /*
  1035. * 1: Use RTS/CTS protocol or CTS-to-self if spec allows it
  1036. * before this frame. if CTS-to-self required check
  1037. * RXON_FLG_SELF_CTS_EN status.
  1038. * unused in 3945/4965, used in 5000 series and after
  1039. */
  1040. #define TX_CMD_FLG_PROT_REQUIRE_MSK cpu_to_le32(1 << 0)
  1041. /*
  1042. * 1: Use Request-To-Send protocol before this frame.
  1043. * Mutually exclusive vs. TX_CMD_FLG_CTS_MSK.
  1044. * used in 3945/4965, unused in 5000 series and after
  1045. */
  1046. #define TX_CMD_FLG_RTS_MSK cpu_to_le32(1 << 1)
  1047. /*
  1048. * 1: Transmit Clear-To-Send to self before this frame.
  1049. * Driver should set this for AUTH/DEAUTH/ASSOC-REQ/REASSOC mgmnt frames.
  1050. * Mutually exclusive vs. TX_CMD_FLG_RTS_MSK.
  1051. * used in 3945/4965, unused in 5000 series and after
  1052. */
  1053. #define TX_CMD_FLG_CTS_MSK cpu_to_le32(1 << 2)
  1054. /* 1: Expect ACK from receiving station
  1055. * 0: Don't expect ACK (MAC header's duration field s/b 0)
  1056. * Set this for unicast frames, but not broadcast/multicast. */
  1057. #define TX_CMD_FLG_ACK_MSK cpu_to_le32(1 << 3)
  1058. /* For agn devices:
  1059. * 1: Use rate scale table (see REPLY_TX_LINK_QUALITY_CMD).
  1060. * Tx command's initial_rate_index indicates first rate to try;
  1061. * uCode walks through table for additional Tx attempts.
  1062. * 0: Use Tx rate/MCS from Tx command's rate_n_flags field.
  1063. * This rate will be used for all Tx attempts; it will not be scaled. */
  1064. #define TX_CMD_FLG_STA_RATE_MSK cpu_to_le32(1 << 4)
  1065. /* 1: Expect immediate block-ack.
  1066. * Set when Txing a block-ack request frame. Also set TX_CMD_FLG_ACK_MSK. */
  1067. #define TX_CMD_FLG_IMM_BA_RSP_MASK cpu_to_le32(1 << 6)
  1068. /*
  1069. * 1: Frame requires full Tx-Op protection.
  1070. * Set this if either RTS or CTS Tx Flag gets set.
  1071. * used in 3945/4965, unused in 5000 series and after
  1072. */
  1073. #define TX_CMD_FLG_FULL_TXOP_PROT_MSK cpu_to_le32(1 << 7)
  1074. /* Tx antenna selection field; used only for 3945, reserved (0) for agn devices.
  1075. * Set field to "0" to allow 3945 uCode to select antenna (normal usage). */
  1076. #define TX_CMD_FLG_ANT_SEL_MSK cpu_to_le32(0xf00)
  1077. #define TX_CMD_FLG_ANT_A_MSK cpu_to_le32(1 << 8)
  1078. #define TX_CMD_FLG_ANT_B_MSK cpu_to_le32(1 << 9)
  1079. /* 1: Ignore Bluetooth priority for this frame.
  1080. * 0: Delay Tx until Bluetooth device is done (normal usage). */
  1081. #define TX_CMD_FLG_IGNORE_BT cpu_to_le32(1 << 12)
  1082. /* 1: uCode overrides sequence control field in MAC header.
  1083. * 0: Driver provides sequence control field in MAC header.
  1084. * Set this for management frames, non-QOS data frames, non-unicast frames,
  1085. * and also in Tx command embedded in REPLY_SCAN_CMD for active scans. */
  1086. #define TX_CMD_FLG_SEQ_CTL_MSK cpu_to_le32(1 << 13)
  1087. /* 1: This frame is non-last MPDU; more fragments are coming.
  1088. * 0: Last fragment, or not using fragmentation. */
  1089. #define TX_CMD_FLG_MORE_FRAG_MSK cpu_to_le32(1 << 14)
  1090. /* 1: uCode calculates and inserts Timestamp Function (TSF) in outgoing frame.
  1091. * 0: No TSF required in outgoing frame.
  1092. * Set this for transmitting beacons and probe responses. */
  1093. #define TX_CMD_FLG_TSF_MSK cpu_to_le32(1 << 16)
  1094. /* 1: Driver inserted 2 bytes pad after the MAC header, for (required) dword
  1095. * alignment of frame's payload data field.
  1096. * 0: No pad
  1097. * Set this for MAC headers with 26 or 30 bytes, i.e. those with QOS or ADDR4
  1098. * field (but not both). Driver must align frame data (i.e. data following
  1099. * MAC header) to DWORD boundary. */
  1100. #define TX_CMD_FLG_MH_PAD_MSK cpu_to_le32(1 << 20)
  1101. /* accelerate aggregation support
  1102. * 0 - no CCMP encryption; 1 - CCMP encryption */
  1103. #define TX_CMD_FLG_AGG_CCMP_MSK cpu_to_le32(1 << 22)
  1104. /* HCCA-AP - disable duration overwriting. */
  1105. #define TX_CMD_FLG_DUR_MSK cpu_to_le32(1 << 25)
  1106. /*
  1107. * TX command security control
  1108. */
  1109. #define TX_CMD_SEC_WEP 0x01
  1110. #define TX_CMD_SEC_CCM 0x02
  1111. #define TX_CMD_SEC_TKIP 0x03
  1112. #define TX_CMD_SEC_MSK 0x03
  1113. #define TX_CMD_SEC_SHIFT 6
  1114. #define TX_CMD_SEC_KEY128 0x08
  1115. /*
  1116. * security overhead sizes
  1117. */
  1118. #define WEP_IV_LEN 4
  1119. #define WEP_ICV_LEN 4
  1120. #define CCMP_MIC_LEN 8
  1121. #define TKIP_ICV_LEN 4
  1122. /*
  1123. * REPLY_TX = 0x1c (command)
  1124. */
  1125. /*
  1126. * 4965 uCode updates these Tx attempt count values in host DRAM.
  1127. * Used for managing Tx retries when expecting block-acks.
  1128. * Driver should set these fields to 0.
  1129. */
  1130. struct iwl_dram_scratch {
  1131. u8 try_cnt; /* Tx attempts */
  1132. u8 bt_kill_cnt; /* Tx attempts blocked by Bluetooth device */
  1133. __le16 reserved;
  1134. } __packed;
  1135. struct iwl_tx_cmd {
  1136. /*
  1137. * MPDU byte count:
  1138. * MAC header (24/26/30/32 bytes) + 2 bytes pad if 26/30 header size,
  1139. * + 8 byte IV for CCM or TKIP (not used for WEP)
  1140. * + Data payload
  1141. * + 8-byte MIC (not used for CCM/WEP)
  1142. * NOTE: Does not include Tx command bytes, post-MAC pad bytes,
  1143. * MIC (CCM) 8 bytes, ICV (WEP/TKIP/CKIP) 4 bytes, CRC 4 bytes.i
  1144. * Range: 14-2342 bytes.
  1145. */
  1146. __le16 len;
  1147. /*
  1148. * MPDU or MSDU byte count for next frame.
  1149. * Used for fragmentation and bursting, but not 11n aggregation.
  1150. * Same as "len", but for next frame. Set to 0 if not applicable.
  1151. */
  1152. __le16 next_frame_len;
  1153. __le32 tx_flags; /* TX_CMD_FLG_* */
  1154. /* uCode may modify this field of the Tx command (in host DRAM!).
  1155. * Driver must also set dram_lsb_ptr and dram_msb_ptr in this cmd. */
  1156. struct iwl_dram_scratch scratch;
  1157. /* Rate for *all* Tx attempts, if TX_CMD_FLG_STA_RATE_MSK is cleared. */
  1158. __le32 rate_n_flags; /* RATE_MCS_* */
  1159. /* Index of destination station in uCode's station table */
  1160. u8 sta_id;
  1161. /* Type of security encryption: CCM or TKIP */
  1162. u8 sec_ctl; /* TX_CMD_SEC_* */
  1163. /*
  1164. * Index into rate table (see REPLY_TX_LINK_QUALITY_CMD) for initial
  1165. * Tx attempt, if TX_CMD_FLG_STA_RATE_MSK is set. Normally "0" for
  1166. * data frames, this field may be used to selectively reduce initial
  1167. * rate (via non-0 value) for special frames (e.g. management), while
  1168. * still supporting rate scaling for all frames.
  1169. */
  1170. u8 initial_rate_index;
  1171. u8 reserved;
  1172. u8 key[16];
  1173. __le16 next_frame_flags;
  1174. __le16 reserved2;
  1175. union {
  1176. __le32 life_time;
  1177. __le32 attempt;
  1178. } stop_time;
  1179. /* Host DRAM physical address pointer to "scratch" in this command.
  1180. * Must be dword aligned. "0" in dram_lsb_ptr disables usage. */
  1181. __le32 dram_lsb_ptr;
  1182. u8 dram_msb_ptr;
  1183. u8 rts_retry_limit; /*byte 50 */
  1184. u8 data_retry_limit; /*byte 51 */
  1185. u8 tid_tspec;
  1186. union {
  1187. __le16 pm_frame_timeout;
  1188. __le16 attempt_duration;
  1189. } timeout;
  1190. /*
  1191. * Duration of EDCA burst Tx Opportunity, in 32-usec units.
  1192. * Set this if txop time is not specified by HCCA protocol (e.g. by AP).
  1193. */
  1194. __le16 driver_txop;
  1195. /*
  1196. * MAC header goes here, followed by 2 bytes padding if MAC header
  1197. * length is 26 or 30 bytes, followed by payload data
  1198. */
  1199. u8 payload[0];
  1200. struct ieee80211_hdr hdr[0];
  1201. } __packed;
  1202. /*
  1203. * TX command response is sent after *agn* transmission attempts.
  1204. *
  1205. * both postpone and abort status are expected behavior from uCode. there is
  1206. * no special operation required from driver; except for RFKILL_FLUSH,
  1207. * which required tx flush host command to flush all the tx frames in queues
  1208. */
  1209. enum {
  1210. TX_STATUS_SUCCESS = 0x01,
  1211. TX_STATUS_DIRECT_DONE = 0x02,
  1212. /* postpone TX */
  1213. TX_STATUS_POSTPONE_DELAY = 0x40,
  1214. TX_STATUS_POSTPONE_FEW_BYTES = 0x41,
  1215. TX_STATUS_POSTPONE_BT_PRIO = 0x42,
  1216. TX_STATUS_POSTPONE_QUIET_PERIOD = 0x43,
  1217. TX_STATUS_POSTPONE_CALC_TTAK = 0x44,
  1218. /* abort TX */
  1219. TX_STATUS_FAIL_INTERNAL_CROSSED_RETRY = 0x81,
  1220. TX_STATUS_FAIL_SHORT_LIMIT = 0x82,
  1221. TX_STATUS_FAIL_LONG_LIMIT = 0x83,
  1222. TX_STATUS_FAIL_FIFO_UNDERRUN = 0x84,
  1223. TX_STATUS_FAIL_DRAIN_FLOW = 0x85,
  1224. TX_STATUS_FAIL_RFKILL_FLUSH = 0x86,
  1225. TX_STATUS_FAIL_LIFE_EXPIRE = 0x87,
  1226. TX_STATUS_FAIL_DEST_PS = 0x88,
  1227. TX_STATUS_FAIL_HOST_ABORTED = 0x89,
  1228. TX_STATUS_FAIL_BT_RETRY = 0x8a,
  1229. TX_STATUS_FAIL_STA_INVALID = 0x8b,
  1230. TX_STATUS_FAIL_FRAG_DROPPED = 0x8c,
  1231. TX_STATUS_FAIL_TID_DISABLE = 0x8d,
  1232. TX_STATUS_FAIL_FIFO_FLUSHED = 0x8e,
  1233. TX_STATUS_FAIL_INSUFFICIENT_CF_POLL = 0x8f,
  1234. TX_STATUS_FAIL_PASSIVE_NO_RX = 0x90,
  1235. TX_STATUS_FAIL_NO_BEACON_ON_RADAR = 0x91,
  1236. };
  1237. #define TX_PACKET_MODE_REGULAR 0x0000
  1238. #define TX_PACKET_MODE_BURST_SEQ 0x0100
  1239. #define TX_PACKET_MODE_BURST_FIRST 0x0200
  1240. enum {
  1241. TX_POWER_PA_NOT_ACTIVE = 0x0,
  1242. };
  1243. enum {
  1244. TX_STATUS_MSK = 0x000000ff, /* bits 0:7 */
  1245. TX_STATUS_DELAY_MSK = 0x00000040,
  1246. TX_STATUS_ABORT_MSK = 0x00000080,
  1247. TX_PACKET_MODE_MSK = 0x0000ff00, /* bits 8:15 */
  1248. TX_FIFO_NUMBER_MSK = 0x00070000, /* bits 16:18 */
  1249. TX_RESERVED = 0x00780000, /* bits 19:22 */
  1250. TX_POWER_PA_DETECT_MSK = 0x7f800000, /* bits 23:30 */
  1251. TX_ABORT_REQUIRED_MSK = 0x80000000, /* bits 31:31 */
  1252. };
  1253. /* *******************************
  1254. * TX aggregation status
  1255. ******************************* */
  1256. enum {
  1257. AGG_TX_STATE_TRANSMITTED = 0x00,
  1258. AGG_TX_STATE_UNDERRUN_MSK = 0x01,
  1259. AGG_TX_STATE_BT_PRIO_MSK = 0x02,
  1260. AGG_TX_STATE_FEW_BYTES_MSK = 0x04,
  1261. AGG_TX_STATE_ABORT_MSK = 0x08,
  1262. AGG_TX_STATE_LAST_SENT_TTL_MSK = 0x10,
  1263. AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK = 0x20,
  1264. AGG_TX_STATE_LAST_SENT_BT_KILL_MSK = 0x40,
  1265. AGG_TX_STATE_SCD_QUERY_MSK = 0x80,
  1266. AGG_TX_STATE_TEST_BAD_CRC32_MSK = 0x100,
  1267. AGG_TX_STATE_RESPONSE_MSK = 0x1ff,
  1268. AGG_TX_STATE_DUMP_TX_MSK = 0x200,
  1269. AGG_TX_STATE_DELAY_TX_MSK = 0x400
  1270. };
  1271. #define AGG_TX_STATUS_MSK 0x00000fff /* bits 0:11 */
  1272. #define AGG_TX_TRY_MSK 0x0000f000 /* bits 12:15 */
  1273. #define AGG_TX_STATE_LAST_SENT_MSK (AGG_TX_STATE_LAST_SENT_TTL_MSK | \
  1274. AGG_TX_STATE_LAST_SENT_TRY_CNT_MSK | \
  1275. AGG_TX_STATE_LAST_SENT_BT_KILL_MSK)
  1276. /* # tx attempts for first frame in aggregation */
  1277. #define AGG_TX_STATE_TRY_CNT_POS 12
  1278. #define AGG_TX_STATE_TRY_CNT_MSK 0xf000
  1279. /* Command ID and sequence number of Tx command for this frame */
  1280. #define AGG_TX_STATE_SEQ_NUM_POS 16
  1281. #define AGG_TX_STATE_SEQ_NUM_MSK 0xffff0000
  1282. /*
  1283. * REPLY_TX = 0x1c (response)
  1284. *
  1285. * This response may be in one of two slightly different formats, indicated
  1286. * by the frame_count field:
  1287. *
  1288. * 1) No aggregation (frame_count == 1). This reports Tx results for
  1289. * a single frame. Multiple attempts, at various bit rates, may have
  1290. * been made for this frame.
  1291. *
  1292. * 2) Aggregation (frame_count > 1). This reports Tx results for
  1293. * 2 or more frames that used block-acknowledge. All frames were
  1294. * transmitted at same rate. Rate scaling may have been used if first
  1295. * frame in this new agg block failed in previous agg block(s).
  1296. *
  1297. * Note that, for aggregation, ACK (block-ack) status is not delivered here;
  1298. * block-ack has not been received by the time the agn device records
  1299. * this status.
  1300. * This status relates to reasons the tx might have been blocked or aborted
  1301. * within the sending station (this agn device), rather than whether it was
  1302. * received successfully by the destination station.
  1303. */
  1304. struct agg_tx_status {
  1305. __le16 status;
  1306. __le16 sequence;
  1307. } __packed;
  1308. /*
  1309. * definitions for initial rate index field
  1310. * bits [3:0] initial rate index
  1311. * bits [6:4] rate table color, used for the initial rate
  1312. * bit-7 invalid rate indication
  1313. * i.e. rate was not chosen from rate table
  1314. * or rate table color was changed during frame retries
  1315. * refer tlc rate info
  1316. */
  1317. #define IWL50_TX_RES_INIT_RATE_INDEX_POS 0
  1318. #define IWL50_TX_RES_INIT_RATE_INDEX_MSK 0x0f
  1319. #define IWL50_TX_RES_RATE_TABLE_COLOR_POS 4
  1320. #define IWL50_TX_RES_RATE_TABLE_COLOR_MSK 0x70
  1321. #define IWL50_TX_RES_INV_RATE_INDEX_MSK 0x80
  1322. /* refer to ra_tid */
  1323. #define IWLAGN_TX_RES_TID_POS 0
  1324. #define IWLAGN_TX_RES_TID_MSK 0x0f
  1325. #define IWLAGN_TX_RES_RA_POS 4
  1326. #define IWLAGN_TX_RES_RA_MSK 0xf0
  1327. struct iwlagn_tx_resp {
  1328. u8 frame_count; /* 1 no aggregation, >1 aggregation */
  1329. u8 bt_kill_count; /* # blocked by bluetooth (unused for agg) */
  1330. u8 failure_rts; /* # failures due to unsuccessful RTS */
  1331. u8 failure_frame; /* # failures due to no ACK (unused for agg) */
  1332. /* For non-agg: Rate at which frame was successful.
  1333. * For agg: Rate at which all frames were transmitted. */
  1334. __le32 rate_n_flags; /* RATE_MCS_* */
  1335. /* For non-agg: RTS + CTS + frame tx attempts time + ACK.
  1336. * For agg: RTS + CTS + aggregation tx time + block-ack time. */
  1337. __le16 wireless_media_time; /* uSecs */
  1338. u8 pa_status; /* RF power amplifier measurement (not used) */
  1339. u8 pa_integ_res_a[3];
  1340. u8 pa_integ_res_b[3];
  1341. u8 pa_integ_res_C[3];
  1342. __le32 tfd_info;
  1343. __le16 seq_ctl;
  1344. __le16 byte_cnt;
  1345. u8 tlc_info;
  1346. u8 ra_tid; /* tid (0:3), sta_id (4:7) */
  1347. __le16 frame_ctrl;
  1348. /*
  1349. * For non-agg: frame status TX_STATUS_*
  1350. * For agg: status of 1st frame, AGG_TX_STATE_*; other frame status
  1351. * fields follow this one, up to frame_count.
  1352. * Bit fields:
  1353. * 11- 0: AGG_TX_STATE_* status code
  1354. * 15-12: Retry count for 1st frame in aggregation (retries
  1355. * occur if tx failed for this frame when it was a
  1356. * member of a previous aggregation block). If rate
  1357. * scaling is used, retry count indicates the rate
  1358. * table entry used for all frames in the new agg.
  1359. * 31-16: Sequence # for this frame's Tx cmd (not SSN!)
  1360. */
  1361. struct agg_tx_status status; /* TX status (in aggregation -
  1362. * status of 1st frame) */
  1363. } __packed;
  1364. /*
  1365. * REPLY_COMPRESSED_BA = 0xc5 (response only, not a command)
  1366. *
  1367. * Reports Block-Acknowledge from recipient station
  1368. */
  1369. struct iwl_compressed_ba_resp {
  1370. __le32 sta_addr_lo32;
  1371. __le16 sta_addr_hi16;
  1372. __le16 reserved;
  1373. /* Index of recipient (BA-sending) station in uCode's station table */
  1374. u8 sta_id;
  1375. u8 tid;
  1376. __le16 seq_ctl;
  1377. __le64 bitmap;
  1378. __le16 scd_flow;
  1379. __le16 scd_ssn;
  1380. /* following only for 5000 series and up */
  1381. u8 txed; /* number of frames sent */
  1382. u8 txed_2_done; /* number of frames acked */
  1383. } __packed;
  1384. /*
  1385. * REPLY_TX_PWR_TABLE_CMD = 0x97 (command, has simple generic response)
  1386. *
  1387. */
  1388. /*RS_NEW_API: only TLC_RTS remains and moved to bit 0 */
  1389. #define LINK_QUAL_FLAGS_SET_STA_TLC_RTS_MSK (1 << 0)
  1390. /* # of EDCA prioritized tx fifos */
  1391. #define LINK_QUAL_AC_NUM AC_NUM
  1392. /* # entries in rate scale table to support Tx retries */
  1393. #define LINK_QUAL_MAX_RETRY_NUM 16
  1394. /* Tx antenna selection values */
  1395. #define LINK_QUAL_ANT_A_MSK (1 << 0)
  1396. #define LINK_QUAL_ANT_B_MSK (1 << 1)
  1397. #define LINK_QUAL_ANT_MSK (LINK_QUAL_ANT_A_MSK|LINK_QUAL_ANT_B_MSK)
  1398. /**
  1399. * struct iwl_link_qual_general_params
  1400. *
  1401. * Used in REPLY_TX_LINK_QUALITY_CMD
  1402. */
  1403. struct iwl_link_qual_general_params {
  1404. u8 flags;
  1405. /* No entries at or above this (driver chosen) index contain MIMO */
  1406. u8 mimo_delimiter;
  1407. /* Best single antenna to use for single stream (legacy, SISO). */
  1408. u8 single_stream_ant_msk; /* LINK_QUAL_ANT_* */
  1409. /* Best antennas to use for MIMO (unused for 4965, assumes both). */
  1410. u8 dual_stream_ant_msk; /* LINK_QUAL_ANT_* */
  1411. /*
  1412. * If driver needs to use different initial rates for different
  1413. * EDCA QOS access categories (as implemented by tx fifos 0-3),
  1414. * this table will set that up, by indicating the indexes in the
  1415. * rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table at which to start.
  1416. * Otherwise, driver should set all entries to 0.
  1417. *
  1418. * Entry usage:
  1419. * 0 = Background, 1 = Best Effort (normal), 2 = Video, 3 = Voice
  1420. * TX FIFOs above 3 use same value (typically 0) as TX FIFO 3.
  1421. */
  1422. u8 start_rate_index[LINK_QUAL_AC_NUM];
  1423. } __packed;
  1424. #define LINK_QUAL_AGG_TIME_LIMIT_DEF (4000) /* 4 milliseconds */
  1425. #define LINK_QUAL_AGG_TIME_LIMIT_MAX (8000)
  1426. #define LINK_QUAL_AGG_TIME_LIMIT_MIN (100)
  1427. #define LINK_QUAL_AGG_DISABLE_START_DEF (3)
  1428. #define LINK_QUAL_AGG_DISABLE_START_MAX (255)
  1429. #define LINK_QUAL_AGG_DISABLE_START_MIN (0)
  1430. #define LINK_QUAL_AGG_FRAME_LIMIT_DEF (63)
  1431. #define LINK_QUAL_AGG_FRAME_LIMIT_MAX (63)
  1432. #define LINK_QUAL_AGG_FRAME_LIMIT_MIN (0)
  1433. /**
  1434. * struct iwl_link_qual_agg_params
  1435. *
  1436. * Used in REPLY_TX_LINK_QUALITY_CMD
  1437. */
  1438. struct iwl_link_qual_agg_params {
  1439. /*
  1440. *Maximum number of uSec in aggregation.
  1441. * default set to 4000 (4 milliseconds) if not configured in .cfg
  1442. */
  1443. __le16 agg_time_limit;
  1444. /*
  1445. * Number of Tx retries allowed for a frame, before that frame will
  1446. * no longer be considered for the start of an aggregation sequence
  1447. * (scheduler will then try to tx it as single frame).
  1448. * Driver should set this to 3.
  1449. */
  1450. u8 agg_dis_start_th;
  1451. /*
  1452. * Maximum number of frames in aggregation.
  1453. * 0 = no limit (default). 1 = no aggregation.
  1454. * Other values = max # frames in aggregation.
  1455. */
  1456. u8 agg_frame_cnt_limit;
  1457. __le32 reserved;
  1458. } __packed;
  1459. /*
  1460. * REPLY_TX_LINK_QUALITY_CMD = 0x4e (command, has simple generic response)
  1461. *
  1462. * For agn devices only; 3945 uses REPLY_RATE_SCALE.
  1463. *
  1464. * Each station in the agn device's internal station table has its own table
  1465. * of 16
  1466. * Tx rates and modulation modes (e.g. legacy/SISO/MIMO) for retrying Tx when
  1467. * an ACK is not received. This command replaces the entire table for
  1468. * one station.
  1469. *
  1470. * NOTE: Station must already be in agn device's station table.
  1471. * Use REPLY_ADD_STA.
  1472. *
  1473. * The rate scaling procedures described below work well. Of course, other
  1474. * procedures are possible, and may work better for particular environments.
  1475. *
  1476. *
  1477. * FILLING THE RATE TABLE
  1478. *
  1479. * Given a particular initial rate and mode, as determined by the rate
  1480. * scaling algorithm described below, the Linux driver uses the following
  1481. * formula to fill the rs_table[LINK_QUAL_MAX_RETRY_NUM] rate table in the
  1482. * Link Quality command:
  1483. *
  1484. *
  1485. * 1) If using High-throughput (HT) (SISO or MIMO) initial rate:
  1486. * a) Use this same initial rate for first 3 entries.
  1487. * b) Find next lower available rate using same mode (SISO or MIMO),
  1488. * use for next 3 entries. If no lower rate available, switch to
  1489. * legacy mode (no HT40 channel, no MIMO, no short guard interval).
  1490. * c) If using MIMO, set command's mimo_delimiter to number of entries
  1491. * using MIMO (3 or 6).
  1492. * d) After trying 2 HT rates, switch to legacy mode (no HT40 channel,
  1493. * no MIMO, no short guard interval), at the next lower bit rate
  1494. * (e.g. if second HT bit rate was 54, try 48 legacy), and follow
  1495. * legacy procedure for remaining table entries.
  1496. *
  1497. * 2) If using legacy initial rate:
  1498. * a) Use the initial rate for only one entry.
  1499. * b) For each following entry, reduce the rate to next lower available
  1500. * rate, until reaching the lowest available rate.
  1501. * c) When reducing rate, also switch antenna selection.
  1502. * d) Once lowest available rate is reached, repeat this rate until
  1503. * rate table is filled (16 entries), switching antenna each entry.
  1504. *
  1505. *
  1506. * ACCUMULATING HISTORY
  1507. *
  1508. * The rate scaling algorithm for agn devices, as implemented in Linux driver,
  1509. * uses two sets of frame Tx success history: One for the current/active
  1510. * modulation mode, and one for a speculative/search mode that is being
  1511. * attempted. If the speculative mode turns out to be more effective (i.e.
  1512. * actual transfer rate is better), then the driver continues to use the
  1513. * speculative mode as the new current active mode.
  1514. *
  1515. * Each history set contains, separately for each possible rate, data for a
  1516. * sliding window of the 62 most recent tx attempts at that rate. The data
  1517. * includes a shifting bitmap of success(1)/failure(0), and sums of successful
  1518. * and attempted frames, from which the driver can additionally calculate a
  1519. * success ratio (success / attempted) and number of failures
  1520. * (attempted - success), and control the size of the window (attempted).
  1521. * The driver uses the bit map to remove successes from the success sum, as
  1522. * the oldest tx attempts fall out of the window.
  1523. *
  1524. * When the agn device makes multiple tx attempts for a given frame, each
  1525. * attempt might be at a different rate, and have different modulation
  1526. * characteristics (e.g. antenna, fat channel, short guard interval), as set
  1527. * up in the rate scaling table in the Link Quality command. The driver must
  1528. * determine which rate table entry was used for each tx attempt, to determine
  1529. * which rate-specific history to update, and record only those attempts that
  1530. * match the modulation characteristics of the history set.
  1531. *
  1532. * When using block-ack (aggregation), all frames are transmitted at the same
  1533. * rate, since there is no per-attempt acknowledgment from the destination
  1534. * station. The Tx response struct iwl_tx_resp indicates the Tx rate in
  1535. * rate_n_flags field. After receiving a block-ack, the driver can update
  1536. * history for the entire block all at once.
  1537. *
  1538. *
  1539. * FINDING BEST STARTING RATE:
  1540. *
  1541. * When working with a selected initial modulation mode (see below), the
  1542. * driver attempts to find a best initial rate. The initial rate is the
  1543. * first entry in the Link Quality command's rate table.
  1544. *
  1545. * 1) Calculate actual throughput (success ratio * expected throughput, see
  1546. * table below) for current initial rate. Do this only if enough frames
  1547. * have been attempted to make the value meaningful: at least 6 failed
  1548. * tx attempts, or at least 8 successes. If not enough, don't try rate
  1549. * scaling yet.
  1550. *
  1551. * 2) Find available rates adjacent to current initial rate. Available means:
  1552. * a) supported by hardware &&
  1553. * b) supported by association &&
  1554. * c) within any constraints selected by user
  1555. *
  1556. * 3) Gather measured throughputs for adjacent rates. These might not have
  1557. * enough history to calculate a throughput. That's okay, we might try
  1558. * using one of them anyway!
  1559. *
  1560. * 4) Try decreasing rate if, for current rate:
  1561. * a) success ratio is < 15% ||
  1562. * b) lower adjacent rate has better measured throughput ||
  1563. * c) higher adjacent rate has worse throughput, and lower is unmeasured
  1564. *
  1565. * As a sanity check, if decrease was determined above, leave rate
  1566. * unchanged if:
  1567. * a) lower rate unavailable
  1568. * b) success ratio at current rate > 85% (very good)
  1569. * c) current measured throughput is better than expected throughput
  1570. * of lower rate (under perfect 100% tx conditions, see table below)
  1571. *
  1572. * 5) Try increasing rate if, for current rate:
  1573. * a) success ratio is < 15% ||
  1574. * b) both adjacent rates' throughputs are unmeasured (try it!) ||
  1575. * b) higher adjacent rate has better measured throughput ||
  1576. * c) lower adjacent rate has worse throughput, and higher is unmeasured
  1577. *
  1578. * As a sanity check, if increase was determined above, leave rate
  1579. * unchanged if:
  1580. * a) success ratio at current rate < 70%. This is not particularly
  1581. * good performance; higher rate is sure to have poorer success.
  1582. *
  1583. * 6) Re-evaluate the rate after each tx frame. If working with block-
  1584. * acknowledge, history and statistics may be calculated for the entire
  1585. * block (including prior history that fits within the history windows),
  1586. * before re-evaluation.
  1587. *
  1588. * FINDING BEST STARTING MODULATION MODE:
  1589. *
  1590. * After working with a modulation mode for a "while" (and doing rate scaling),
  1591. * the driver searches for a new initial mode in an attempt to improve
  1592. * throughput. The "while" is measured by numbers of attempted frames:
  1593. *
  1594. * For legacy mode, search for new mode after:
  1595. * 480 successful frames, or 160 failed frames
  1596. * For high-throughput modes (SISO or MIMO), search for new mode after:
  1597. * 4500 successful frames, or 400 failed frames
  1598. *
  1599. * Mode switch possibilities are (3 for each mode):
  1600. *
  1601. * For legacy:
  1602. * Change antenna, try SISO (if HT association), try MIMO (if HT association)
  1603. * For SISO:
  1604. * Change antenna, try MIMO, try shortened guard interval (SGI)
  1605. * For MIMO:
  1606. * Try SISO antenna A, SISO antenna B, try shortened guard interval (SGI)
  1607. *
  1608. * When trying a new mode, use the same bit rate as the old/current mode when
  1609. * trying antenna switches and shortened guard interval. When switching to
  1610. * SISO from MIMO or legacy, or to MIMO from SISO or legacy, use a rate
  1611. * for which the expected throughput (under perfect conditions) is about the
  1612. * same or slightly better than the actual measured throughput delivered by
  1613. * the old/current mode.
  1614. *
  1615. * Actual throughput can be estimated by multiplying the expected throughput
  1616. * by the success ratio (successful / attempted tx frames). Frame size is
  1617. * not considered in this calculation; it assumes that frame size will average
  1618. * out to be fairly consistent over several samples. The following are
  1619. * metric values for expected throughput assuming 100% success ratio.
  1620. * Only G band has support for CCK rates:
  1621. *
  1622. * RATE: 1 2 5 11 6 9 12 18 24 36 48 54 60
  1623. *
  1624. * G: 7 13 35 58 40 57 72 98 121 154 177 186 186
  1625. * A: 0 0 0 0 40 57 72 98 121 154 177 186 186
  1626. * SISO 20MHz: 0 0 0 0 42 42 76 102 124 159 183 193 202
  1627. * SGI SISO 20MHz: 0 0 0 0 46 46 82 110 132 168 192 202 211
  1628. * MIMO 20MHz: 0 0 0 0 74 74 123 155 179 214 236 244 251
  1629. * SGI MIMO 20MHz: 0 0 0 0 81 81 131 164 188 222 243 251 257
  1630. * SISO 40MHz: 0 0 0 0 77 77 127 160 184 220 242 250 257
  1631. * SGI SISO 40MHz: 0 0 0 0 83 83 135 169 193 229 250 257 264
  1632. * MIMO 40MHz: 0 0 0 0 123 123 182 214 235 264 279 285 289
  1633. * SGI MIMO 40MHz: 0 0 0 0 131 131 191 222 242 270 284 289 293
  1634. *
  1635. * After the new mode has been tried for a short while (minimum of 6 failed
  1636. * frames or 8 successful frames), compare success ratio and actual throughput
  1637. * estimate of the new mode with the old. If either is better with the new
  1638. * mode, continue to use the new mode.
  1639. *
  1640. * Continue comparing modes until all 3 possibilities have been tried.
  1641. * If moving from legacy to HT, try all 3 possibilities from the new HT
  1642. * mode. After trying all 3, a best mode is found. Continue to use this mode
  1643. * for the longer "while" described above (e.g. 480 successful frames for
  1644. * legacy), and then repeat the search process.
  1645. *
  1646. */
  1647. struct iwl_link_quality_cmd {
  1648. /* Index of destination/recipient station in uCode's station table */
  1649. u8 sta_id;
  1650. u8 reserved1;
  1651. __le16 control; /* not used */
  1652. struct iwl_link_qual_general_params general_params;
  1653. struct iwl_link_qual_agg_params agg_params;
  1654. /*
  1655. * Rate info; when using rate-scaling, Tx command's initial_rate_index
  1656. * specifies 1st Tx rate attempted, via index into this table.
  1657. * agn devices works its way through table when retrying Tx.
  1658. */
  1659. struct {
  1660. __le32 rate_n_flags; /* RATE_MCS_*, IWL_RATE_* */
  1661. } rs_table[LINK_QUAL_MAX_RETRY_NUM];
  1662. __le32 reserved2;
  1663. } __packed;
  1664. /*
  1665. * BT configuration enable flags:
  1666. * bit 0 - 1: BT channel announcement enabled
  1667. * 0: disable
  1668. * bit 1 - 1: priority of BT device enabled
  1669. * 0: disable
  1670. * bit 2 - 1: BT 2 wire support enabled
  1671. * 0: disable
  1672. */
  1673. #define BT_COEX_DISABLE (0x0)
  1674. #define BT_ENABLE_CHANNEL_ANNOUNCE BIT(0)
  1675. #define BT_ENABLE_PRIORITY BIT(1)
  1676. #define BT_ENABLE_2_WIRE BIT(2)
  1677. #define BT_COEX_DISABLE (0x0)
  1678. #define BT_COEX_ENABLE (BT_ENABLE_CHANNEL_ANNOUNCE | BT_ENABLE_PRIORITY)
  1679. #define BT_LEAD_TIME_MIN (0x0)
  1680. #define BT_LEAD_TIME_DEF (0x1E)
  1681. #define BT_LEAD_TIME_MAX (0xFF)
  1682. #define BT_MAX_KILL_MIN (0x1)
  1683. #define BT_MAX_KILL_DEF (0x5)
  1684. #define BT_MAX_KILL_MAX (0xFF)
  1685. #define BT_DURATION_LIMIT_DEF 625
  1686. #define BT_DURATION_LIMIT_MAX 1250
  1687. #define BT_DURATION_LIMIT_MIN 625
  1688. #define BT_ON_THRESHOLD_DEF 4
  1689. #define BT_ON_THRESHOLD_MAX 1000
  1690. #define BT_ON_THRESHOLD_MIN 1
  1691. #define BT_FRAG_THRESHOLD_DEF 0
  1692. #define BT_FRAG_THRESHOLD_MAX 0
  1693. #define BT_FRAG_THRESHOLD_MIN 0
  1694. #define BT_AGG_THRESHOLD_DEF 1200
  1695. #define BT_AGG_THRESHOLD_MAX 8000
  1696. #define BT_AGG_THRESHOLD_MIN 400
  1697. /*
  1698. * REPLY_BT_CONFIG = 0x9b (command, has simple generic response)
  1699. *
  1700. * 3945 and agn devices support hardware handshake with Bluetooth device on
  1701. * same platform. Bluetooth device alerts wireless device when it will Tx;
  1702. * wireless device can delay or kill its own Tx to accommodate.
  1703. */
  1704. struct iwl_bt_cmd {
  1705. u8 flags;
  1706. u8 lead_time;
  1707. u8 max_kill;
  1708. u8 reserved;
  1709. __le32 kill_ack_mask;
  1710. __le32 kill_cts_mask;
  1711. } __packed;
  1712. #define IWLAGN_BT_FLAG_CHANNEL_INHIBITION BIT(0)
  1713. #define IWLAGN_BT_FLAG_COEX_MODE_MASK (BIT(3)|BIT(4)|BIT(5))
  1714. #define IWLAGN_BT_FLAG_COEX_MODE_SHIFT 3
  1715. #define IWLAGN_BT_FLAG_COEX_MODE_DISABLED 0
  1716. #define IWLAGN_BT_FLAG_COEX_MODE_LEGACY_2W 1
  1717. #define IWLAGN_BT_FLAG_COEX_MODE_3W 2
  1718. #define IWLAGN_BT_FLAG_COEX_MODE_4W 3
  1719. #define IWLAGN_BT_FLAG_UCODE_DEFAULT BIT(6)
  1720. /* Disable Sync PSPoll on SCO/eSCO */
  1721. #define IWLAGN_BT_FLAG_SYNC_2_BT_DISABLE BIT(7)
  1722. #define IWLAGN_BT_PRIO_BOOST_MAX 0xFF
  1723. #define IWLAGN_BT_PRIO_BOOST_MIN 0x00
  1724. #define IWLAGN_BT_PRIO_BOOST_DEFAULT 0xF0
  1725. #define IWLAGN_BT_MAX_KILL_DEFAULT 5
  1726. #define IWLAGN_BT3_T7_DEFAULT 1
  1727. #define IWLAGN_BT_KILL_ACK_MASK_DEFAULT cpu_to_le32(0xffff0000)
  1728. #define IWLAGN_BT_KILL_CTS_MASK_DEFAULT cpu_to_le32(0xffff0000)
  1729. #define IWLAGN_BT_KILL_ACK_CTS_MASK_SCO cpu_to_le32(0xffffffff)
  1730. #define IWLAGN_BT3_PRIO_SAMPLE_DEFAULT 2
  1731. #define IWLAGN_BT3_T2_DEFAULT 0xc
  1732. #define IWLAGN_BT_VALID_ENABLE_FLAGS cpu_to_le16(BIT(0))
  1733. #define IWLAGN_BT_VALID_BOOST cpu_to_le16(BIT(1))
  1734. #define IWLAGN_BT_VALID_MAX_KILL cpu_to_le16(BIT(2))
  1735. #define IWLAGN_BT_VALID_3W_TIMERS cpu_to_le16(BIT(3))
  1736. #define IWLAGN_BT_VALID_KILL_ACK_MASK cpu_to_le16(BIT(4))
  1737. #define IWLAGN_BT_VALID_KILL_CTS_MASK cpu_to_le16(BIT(5))
  1738. #define IWLAGN_BT_VALID_BT4_TIMES cpu_to_le16(BIT(6))
  1739. #define IWLAGN_BT_VALID_3W_LUT cpu_to_le16(BIT(7))
  1740. #define IWLAGN_BT_ALL_VALID_MSK (IWLAGN_BT_VALID_ENABLE_FLAGS | \
  1741. IWLAGN_BT_VALID_BOOST | \
  1742. IWLAGN_BT_VALID_MAX_KILL | \
  1743. IWLAGN_BT_VALID_3W_TIMERS | \
  1744. IWLAGN_BT_VALID_KILL_ACK_MASK | \
  1745. IWLAGN_BT_VALID_KILL_CTS_MASK | \
  1746. IWLAGN_BT_VALID_BT4_TIMES | \
  1747. IWLAGN_BT_VALID_3W_LUT)
  1748. struct iwl_basic_bt_cmd {
  1749. u8 flags;
  1750. u8 ledtime; /* unused */
  1751. u8 max_kill;
  1752. u8 bt3_timer_t7_value;
  1753. __le32 kill_ack_mask;
  1754. __le32 kill_cts_mask;
  1755. u8 bt3_prio_sample_time;
  1756. u8 bt3_timer_t2_value;
  1757. __le16 bt4_reaction_time; /* unused */
  1758. __le32 bt3_lookup_table[12];
  1759. __le16 bt4_decision_time; /* unused */
  1760. __le16 valid;
  1761. };
  1762. struct iwl6000_bt_cmd {
  1763. struct iwl_basic_bt_cmd basic;
  1764. u8 prio_boost;
  1765. /*
  1766. * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
  1767. * if configure the following patterns
  1768. */
  1769. u8 tx_prio_boost; /* SW boost of WiFi tx priority */
  1770. __le16 rx_prio_boost; /* SW boost of WiFi rx priority */
  1771. };
  1772. struct iwl2000_bt_cmd {
  1773. struct iwl_basic_bt_cmd basic;
  1774. __le32 prio_boost;
  1775. /*
  1776. * set IWLAGN_BT_VALID_BOOST to "1" in "valid" bitmask
  1777. * if configure the following patterns
  1778. */
  1779. u8 reserved;
  1780. u8 tx_prio_boost; /* SW boost of WiFi tx priority */
  1781. __le16 rx_prio_boost; /* SW boost of WiFi rx priority */
  1782. };
  1783. #define IWLAGN_BT_SCO_ACTIVE cpu_to_le32(BIT(0))
  1784. struct iwlagn_bt_sco_cmd {
  1785. __le32 flags;
  1786. };
  1787. /******************************************************************************
  1788. * (6)
  1789. * Spectrum Management (802.11h) Commands, Responses, Notifications:
  1790. *
  1791. *****************************************************************************/
  1792. /*
  1793. * Spectrum Management
  1794. */
  1795. #define MEASUREMENT_FILTER_FLAG (RXON_FILTER_PROMISC_MSK | \
  1796. RXON_FILTER_CTL2HOST_MSK | \
  1797. RXON_FILTER_ACCEPT_GRP_MSK | \
  1798. RXON_FILTER_DIS_DECRYPT_MSK | \
  1799. RXON_FILTER_DIS_GRP_DECRYPT_MSK | \
  1800. RXON_FILTER_ASSOC_MSK | \
  1801. RXON_FILTER_BCON_AWARE_MSK)
  1802. struct iwl_measure_channel {
  1803. __le32 duration; /* measurement duration in extended beacon
  1804. * format */
  1805. u8 channel; /* channel to measure */
  1806. u8 type; /* see enum iwl_measure_type */
  1807. __le16 reserved;
  1808. } __packed;
  1809. /*
  1810. * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (command)
  1811. */
  1812. struct iwl_spectrum_cmd {
  1813. __le16 len; /* number of bytes starting from token */
  1814. u8 token; /* token id */
  1815. u8 id; /* measurement id -- 0 or 1 */
  1816. u8 origin; /* 0 = TGh, 1 = other, 2 = TGk */
  1817. u8 periodic; /* 1 = periodic */
  1818. __le16 path_loss_timeout;
  1819. __le32 start_time; /* start time in extended beacon format */
  1820. __le32 reserved2;
  1821. __le32 flags; /* rxon flags */
  1822. __le32 filter_flags; /* rxon filter flags */
  1823. __le16 channel_count; /* minimum 1, maximum 10 */
  1824. __le16 reserved3;
  1825. struct iwl_measure_channel channels[10];
  1826. } __packed;
  1827. /*
  1828. * REPLY_SPECTRUM_MEASUREMENT_CMD = 0x74 (response)
  1829. */
  1830. struct iwl_spectrum_resp {
  1831. u8 token;
  1832. u8 id; /* id of the prior command replaced, or 0xff */
  1833. __le16 status; /* 0 - command will be handled
  1834. * 1 - cannot handle (conflicts with another
  1835. * measurement) */
  1836. } __packed;
  1837. enum iwl_measurement_state {
  1838. IWL_MEASUREMENT_START = 0,
  1839. IWL_MEASUREMENT_STOP = 1,
  1840. };
  1841. enum iwl_measurement_status {
  1842. IWL_MEASUREMENT_OK = 0,
  1843. IWL_MEASUREMENT_CONCURRENT = 1,
  1844. IWL_MEASUREMENT_CSA_CONFLICT = 2,
  1845. IWL_MEASUREMENT_TGH_CONFLICT = 3,
  1846. /* 4-5 reserved */
  1847. IWL_MEASUREMENT_STOPPED = 6,
  1848. IWL_MEASUREMENT_TIMEOUT = 7,
  1849. IWL_MEASUREMENT_PERIODIC_FAILED = 8,
  1850. };
  1851. #define NUM_ELEMENTS_IN_HISTOGRAM 8
  1852. struct iwl_measurement_histogram {
  1853. __le32 ofdm[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 0.8usec counts */
  1854. __le32 cck[NUM_ELEMENTS_IN_HISTOGRAM]; /* in 1usec counts */
  1855. } __packed;
  1856. /* clear channel availability counters */
  1857. struct iwl_measurement_cca_counters {
  1858. __le32 ofdm;
  1859. __le32 cck;
  1860. } __packed;
  1861. enum iwl_measure_type {
  1862. IWL_MEASURE_BASIC = (1 << 0),
  1863. IWL_MEASURE_CHANNEL_LOAD = (1 << 1),
  1864. IWL_MEASURE_HISTOGRAM_RPI = (1 << 2),
  1865. IWL_MEASURE_HISTOGRAM_NOISE = (1 << 3),
  1866. IWL_MEASURE_FRAME = (1 << 4),
  1867. /* bits 5:6 are reserved */
  1868. IWL_MEASURE_IDLE = (1 << 7),
  1869. };
  1870. /*
  1871. * SPECTRUM_MEASURE_NOTIFICATION = 0x75 (notification only, not a command)
  1872. */
  1873. struct iwl_spectrum_notification {
  1874. u8 id; /* measurement id -- 0 or 1 */
  1875. u8 token;
  1876. u8 channel_index; /* index in measurement channel list */
  1877. u8 state; /* 0 - start, 1 - stop */
  1878. __le32 start_time; /* lower 32-bits of TSF */
  1879. u8 band; /* 0 - 5.2GHz, 1 - 2.4GHz */
  1880. u8 channel;
  1881. u8 type; /* see enum iwl_measurement_type */
  1882. u8 reserved1;
  1883. /* NOTE: cca_ofdm, cca_cck, basic_type, and histogram are only only
  1884. * valid if applicable for measurement type requested. */
  1885. __le32 cca_ofdm; /* cca fraction time in 40Mhz clock periods */
  1886. __le32 cca_cck; /* cca fraction time in 44Mhz clock periods */
  1887. __le32 cca_time; /* channel load time in usecs */
  1888. u8 basic_type; /* 0 - bss, 1 - ofdm preamble, 2 -
  1889. * unidentified */
  1890. u8 reserved2[3];
  1891. struct iwl_measurement_histogram histogram;
  1892. __le32 stop_time; /* lower 32-bits of TSF */
  1893. __le32 status; /* see iwl_measurement_status */
  1894. } __packed;
  1895. /******************************************************************************
  1896. * (7)
  1897. * Power Management Commands, Responses, Notifications:
  1898. *
  1899. *****************************************************************************/
  1900. /**
  1901. * struct iwl_powertable_cmd - Power Table Command
  1902. * @flags: See below:
  1903. *
  1904. * POWER_TABLE_CMD = 0x77 (command, has simple generic response)
  1905. *
  1906. * PM allow:
  1907. * bit 0 - '0' Driver not allow power management
  1908. * '1' Driver allow PM (use rest of parameters)
  1909. *
  1910. * uCode send sleep notifications:
  1911. * bit 1 - '0' Don't send sleep notification
  1912. * '1' send sleep notification (SEND_PM_NOTIFICATION)
  1913. *
  1914. * Sleep over DTIM
  1915. * bit 2 - '0' PM have to walk up every DTIM
  1916. * '1' PM could sleep over DTIM till listen Interval.
  1917. *
  1918. * PCI power managed
  1919. * bit 3 - '0' (PCI_CFG_LINK_CTRL & 0x1)
  1920. * '1' !(PCI_CFG_LINK_CTRL & 0x1)
  1921. *
  1922. * Fast PD
  1923. * bit 4 - '1' Put radio to sleep when receiving frame for others
  1924. *
  1925. * Force sleep Modes
  1926. * bit 31/30- '00' use both mac/xtal sleeps
  1927. * '01' force Mac sleep
  1928. * '10' force xtal sleep
  1929. * '11' Illegal set
  1930. *
  1931. * NOTE: if sleep_interval[SLEEP_INTRVL_TABLE_SIZE-1] > DTIM period then
  1932. * ucode assume sleep over DTIM is allowed and we don't need to wake up
  1933. * for every DTIM.
  1934. */
  1935. #define IWL_POWER_VEC_SIZE 5
  1936. #define IWL_POWER_DRIVER_ALLOW_SLEEP_MSK cpu_to_le16(BIT(0))
  1937. #define IWL_POWER_POWER_SAVE_ENA_MSK cpu_to_le16(BIT(0))
  1938. #define IWL_POWER_POWER_MANAGEMENT_ENA_MSK cpu_to_le16(BIT(1))
  1939. #define IWL_POWER_SLEEP_OVER_DTIM_MSK cpu_to_le16(BIT(2))
  1940. #define IWL_POWER_PCI_PM_MSK cpu_to_le16(BIT(3))
  1941. #define IWL_POWER_FAST_PD cpu_to_le16(BIT(4))
  1942. #define IWL_POWER_BEACON_FILTERING cpu_to_le16(BIT(5))
  1943. #define IWL_POWER_SHADOW_REG_ENA cpu_to_le16(BIT(6))
  1944. #define IWL_POWER_CT_KILL_SET cpu_to_le16(BIT(7))
  1945. #define IWL_POWER_BT_SCO_ENA cpu_to_le16(BIT(8))
  1946. #define IWL_POWER_ADVANCE_PM_ENA_MSK cpu_to_le16(BIT(9))
  1947. struct iwl_powertable_cmd {
  1948. __le16 flags;
  1949. u8 keep_alive_seconds; /* 3945 reserved */
  1950. u8 debug_flags; /* 3945 reserved */
  1951. __le32 rx_data_timeout;
  1952. __le32 tx_data_timeout;
  1953. __le32 sleep_interval[IWL_POWER_VEC_SIZE];
  1954. __le32 keep_alive_beacons;
  1955. } __packed;
  1956. /*
  1957. * PM_SLEEP_NOTIFICATION = 0x7A (notification only, not a command)
  1958. * all devices identical.
  1959. */
  1960. struct iwl_sleep_notification {
  1961. u8 pm_sleep_mode;
  1962. u8 pm_wakeup_src;
  1963. __le16 reserved;
  1964. __le32 sleep_time;
  1965. __le32 tsf_low;
  1966. __le32 bcon_timer;
  1967. } __packed;
  1968. /* Sleep states. all devices identical. */
  1969. enum {
  1970. IWL_PM_NO_SLEEP = 0,
  1971. IWL_PM_SLP_MAC = 1,
  1972. IWL_PM_SLP_FULL_MAC_UNASSOCIATE = 2,
  1973. IWL_PM_SLP_FULL_MAC_CARD_STATE = 3,
  1974. IWL_PM_SLP_PHY = 4,
  1975. IWL_PM_SLP_REPENT = 5,
  1976. IWL_PM_WAKEUP_BY_TIMER = 6,
  1977. IWL_PM_WAKEUP_BY_DRIVER = 7,
  1978. IWL_PM_WAKEUP_BY_RFKILL = 8,
  1979. /* 3 reserved */
  1980. IWL_PM_NUM_OF_MODES = 12,
  1981. };
  1982. /*
  1983. * REPLY_CARD_STATE_CMD = 0xa0 (command, has simple generic response)
  1984. */
  1985. #define CARD_STATE_CMD_DISABLE 0x00 /* Put card to sleep */
  1986. #define CARD_STATE_CMD_ENABLE 0x01 /* Wake up card */
  1987. #define CARD_STATE_CMD_HALT 0x02 /* Power down permanently */
  1988. struct iwl_card_state_cmd {
  1989. __le32 status; /* CARD_STATE_CMD_* request new power state */
  1990. } __packed;
  1991. /*
  1992. * CARD_STATE_NOTIFICATION = 0xa1 (notification only, not a command)
  1993. */
  1994. struct iwl_card_state_notif {
  1995. __le32 flags;
  1996. } __packed;
  1997. #define HW_CARD_DISABLED 0x01
  1998. #define SW_CARD_DISABLED 0x02
  1999. #define CT_CARD_DISABLED 0x04
  2000. #define RXON_CARD_DISABLED 0x10
  2001. struct iwl_ct_kill_config {
  2002. __le32 reserved;
  2003. __le32 critical_temperature_M;
  2004. __le32 critical_temperature_R;
  2005. } __packed;
  2006. /* 1000, and 6x00 */
  2007. struct iwl_ct_kill_throttling_config {
  2008. __le32 critical_temperature_exit;
  2009. __le32 reserved;
  2010. __le32 critical_temperature_enter;
  2011. } __packed;
  2012. /******************************************************************************
  2013. * (8)
  2014. * Scan Commands, Responses, Notifications:
  2015. *
  2016. *****************************************************************************/
  2017. #define SCAN_CHANNEL_TYPE_PASSIVE cpu_to_le32(0)
  2018. #define SCAN_CHANNEL_TYPE_ACTIVE cpu_to_le32(1)
  2019. /**
  2020. * struct iwl_scan_channel - entry in REPLY_SCAN_CMD channel table
  2021. *
  2022. * One for each channel in the scan list.
  2023. * Each channel can independently select:
  2024. * 1) SSID for directed active scans
  2025. * 2) Txpower setting (for rate specified within Tx command)
  2026. * 3) How long to stay on-channel (behavior may be modified by quiet_time,
  2027. * quiet_plcp_th, good_CRC_th)
  2028. *
  2029. * To avoid uCode errors, make sure the following are true (see comments
  2030. * under struct iwl_scan_cmd about max_out_time and quiet_time):
  2031. * 1) If using passive_dwell (i.e. passive_dwell != 0):
  2032. * active_dwell <= passive_dwell (< max_out_time if max_out_time != 0)
  2033. * 2) quiet_time <= active_dwell
  2034. * 3) If restricting off-channel time (i.e. max_out_time !=0):
  2035. * passive_dwell < max_out_time
  2036. * active_dwell < max_out_time
  2037. */
  2038. struct iwl_scan_channel {
  2039. /*
  2040. * type is defined as:
  2041. * 0:0 1 = active, 0 = passive
  2042. * 1:20 SSID direct bit map; if a bit is set, then corresponding
  2043. * SSID IE is transmitted in probe request.
  2044. * 21:31 reserved
  2045. */
  2046. __le32 type;
  2047. __le16 channel; /* band is selected by iwl_scan_cmd "flags" field */
  2048. u8 tx_gain; /* gain for analog radio */
  2049. u8 dsp_atten; /* gain for DSP */
  2050. __le16 active_dwell; /* in 1024-uSec TU (time units), typ 5-50 */
  2051. __le16 passive_dwell; /* in 1024-uSec TU (time units), typ 20-500 */
  2052. } __packed;
  2053. /* set number of direct probes __le32 type */
  2054. #define IWL_SCAN_PROBE_MASK(n) cpu_to_le32((BIT(n) | (BIT(n) - BIT(1))))
  2055. /**
  2056. * struct iwl_ssid_ie - directed scan network information element
  2057. *
  2058. * Up to 20 of these may appear in REPLY_SCAN_CMD (Note: Only 4 are in
  2059. * 3945 SCAN api), selected by "type" bit field in struct iwl_scan_channel;
  2060. * each channel may select different ssids from among the 20 (4) entries.
  2061. * SSID IEs get transmitted in reverse order of entry.
  2062. */
  2063. struct iwl_ssid_ie {
  2064. u8 id;
  2065. u8 len;
  2066. u8 ssid[32];
  2067. } __packed;
  2068. #define PROBE_OPTION_MAX_3945 4
  2069. #define PROBE_OPTION_MAX 20
  2070. #define TX_CMD_LIFE_TIME_INFINITE cpu_to_le32(0xFFFFFFFF)
  2071. #define IWL_GOOD_CRC_TH_DISABLED 0
  2072. #define IWL_GOOD_CRC_TH_DEFAULT cpu_to_le16(1)
  2073. #define IWL_GOOD_CRC_TH_NEVER cpu_to_le16(0xffff)
  2074. #define IWL_MAX_SCAN_SIZE 1024
  2075. #define IWL_MAX_CMD_SIZE 4096
  2076. /*
  2077. * REPLY_SCAN_CMD = 0x80 (command)
  2078. *
  2079. * The hardware scan command is very powerful; the driver can set it up to
  2080. * maintain (relatively) normal network traffic while doing a scan in the
  2081. * background. The max_out_time and suspend_time control the ratio of how
  2082. * long the device stays on an associated network channel ("service channel")
  2083. * vs. how long it's away from the service channel, i.e. tuned to other channels
  2084. * for scanning.
  2085. *
  2086. * max_out_time is the max time off-channel (in usec), and suspend_time
  2087. * is how long (in "extended beacon" format) that the scan is "suspended"
  2088. * after returning to the service channel. That is, suspend_time is the
  2089. * time that we stay on the service channel, doing normal work, between
  2090. * scan segments. The driver may set these parameters differently to support
  2091. * scanning when associated vs. not associated, and light vs. heavy traffic
  2092. * loads when associated.
  2093. *
  2094. * After receiving this command, the device's scan engine does the following;
  2095. *
  2096. * 1) Sends SCAN_START notification to driver
  2097. * 2) Checks to see if it has time to do scan for one channel
  2098. * 3) Sends NULL packet, with power-save (PS) bit set to 1,
  2099. * to tell AP that we're going off-channel
  2100. * 4) Tunes to first channel in scan list, does active or passive scan
  2101. * 5) Sends SCAN_RESULT notification to driver
  2102. * 6) Checks to see if it has time to do scan on *next* channel in list
  2103. * 7) Repeats 4-6 until it no longer has time to scan the next channel
  2104. * before max_out_time expires
  2105. * 8) Returns to service channel
  2106. * 9) Sends NULL packet with PS=0 to tell AP that we're back
  2107. * 10) Stays on service channel until suspend_time expires
  2108. * 11) Repeats entire process 2-10 until list is complete
  2109. * 12) Sends SCAN_COMPLETE notification
  2110. *
  2111. * For fast, efficient scans, the scan command also has support for staying on
  2112. * a channel for just a short time, if doing active scanning and getting no
  2113. * responses to the transmitted probe request. This time is controlled by
  2114. * quiet_time, and the number of received packets below which a channel is
  2115. * considered "quiet" is controlled by quiet_plcp_threshold.
  2116. *
  2117. * For active scanning on channels that have regulatory restrictions against
  2118. * blindly transmitting, the scan can listen before transmitting, to make sure
  2119. * that there is already legitimate activity on the channel. If enough
  2120. * packets are cleanly received on the channel (controlled by good_CRC_th,
  2121. * typical value 1), the scan engine starts transmitting probe requests.
  2122. *
  2123. * Driver must use separate scan commands for 2.4 vs. 5 GHz bands.
  2124. *
  2125. * To avoid uCode errors, see timing restrictions described under
  2126. * struct iwl_scan_channel.
  2127. */
  2128. enum iwl_scan_flags {
  2129. /* BIT(0) currently unused */
  2130. IWL_SCAN_FLAGS_ACTION_FRAME_TX = BIT(1),
  2131. /* bits 2-7 reserved */
  2132. };
  2133. struct iwl_scan_cmd {
  2134. __le16 len;
  2135. u8 scan_flags; /* scan flags: see enum iwl_scan_flags */
  2136. u8 channel_count; /* # channels in channel list */
  2137. __le16 quiet_time; /* dwell only this # millisecs on quiet channel
  2138. * (only for active scan) */
  2139. __le16 quiet_plcp_th; /* quiet chnl is < this # pkts (typ. 1) */
  2140. __le16 good_CRC_th; /* passive -> active promotion threshold */
  2141. __le16 rx_chain; /* RXON_RX_CHAIN_* */
  2142. __le32 max_out_time; /* max usec to be away from associated (service)
  2143. * channel */
  2144. __le32 suspend_time; /* pause scan this long (in "extended beacon
  2145. * format") when returning to service chnl:
  2146. * 3945; 31:24 # beacons, 19:0 additional usec,
  2147. * 4965; 31:22 # beacons, 21:0 additional usec.
  2148. */
  2149. __le32 flags; /* RXON_FLG_* */
  2150. __le32 filter_flags; /* RXON_FILTER_* */
  2151. /* For active scans (set to all-0s for passive scans).
  2152. * Does not include payload. Must specify Tx rate; no rate scaling. */
  2153. struct iwl_tx_cmd tx_cmd;
  2154. /* For directed active scans (set to all-0s otherwise) */
  2155. struct iwl_ssid_ie direct_scan[PROBE_OPTION_MAX];
  2156. /*
  2157. * Probe request frame, followed by channel list.
  2158. *
  2159. * Size of probe request frame is specified by byte count in tx_cmd.
  2160. * Channel list follows immediately after probe request frame.
  2161. * Number of channels in list is specified by channel_count.
  2162. * Each channel in list is of type:
  2163. *
  2164. * struct iwl_scan_channel channels[0];
  2165. *
  2166. * NOTE: Only one band of channels can be scanned per pass. You
  2167. * must not mix 2.4GHz channels and 5.2GHz channels, and you must wait
  2168. * for one scan to complete (i.e. receive SCAN_COMPLETE_NOTIFICATION)
  2169. * before requesting another scan.
  2170. */
  2171. u8 data[0];
  2172. } __packed;
  2173. /* Can abort will notify by complete notification with abort status. */
  2174. #define CAN_ABORT_STATUS cpu_to_le32(0x1)
  2175. /* complete notification statuses */
  2176. #define ABORT_STATUS 0x2
  2177. /*
  2178. * REPLY_SCAN_CMD = 0x80 (response)
  2179. */
  2180. struct iwl_scanreq_notification {
  2181. __le32 status; /* 1: okay, 2: cannot fulfill request */
  2182. } __packed;
  2183. /*
  2184. * SCAN_START_NOTIFICATION = 0x82 (notification only, not a command)
  2185. */
  2186. struct iwl_scanstart_notification {
  2187. __le32 tsf_low;
  2188. __le32 tsf_high;
  2189. __le32 beacon_timer;
  2190. u8 channel;
  2191. u8 band;
  2192. u8 reserved[2];
  2193. __le32 status;
  2194. } __packed;
  2195. #define SCAN_OWNER_STATUS 0x1;
  2196. #define MEASURE_OWNER_STATUS 0x2;
  2197. #define IWL_PROBE_STATUS_OK 0
  2198. #define IWL_PROBE_STATUS_TX_FAILED BIT(0)
  2199. /* error statuses combined with TX_FAILED */
  2200. #define IWL_PROBE_STATUS_FAIL_TTL BIT(1)
  2201. #define IWL_PROBE_STATUS_FAIL_BT BIT(2)
  2202. #define NUMBER_OF_STATISTICS 1 /* first __le32 is good CRC */
  2203. /*
  2204. * SCAN_RESULTS_NOTIFICATION = 0x83 (notification only, not a command)
  2205. */
  2206. struct iwl_scanresults_notification {
  2207. u8 channel;
  2208. u8 band;
  2209. u8 probe_status;
  2210. u8 num_probe_not_sent; /* not enough time to send */
  2211. __le32 tsf_low;
  2212. __le32 tsf_high;
  2213. __le32 statistics[NUMBER_OF_STATISTICS];
  2214. } __packed;
  2215. /*
  2216. * SCAN_COMPLETE_NOTIFICATION = 0x84 (notification only, not a command)
  2217. */
  2218. struct iwl_scancomplete_notification {
  2219. u8 scanned_channels;
  2220. u8 status;
  2221. u8 bt_status; /* BT On/Off status */
  2222. u8 last_channel;
  2223. __le32 tsf_low;
  2224. __le32 tsf_high;
  2225. } __packed;
  2226. /******************************************************************************
  2227. * (9)
  2228. * IBSS/AP Commands and Notifications:
  2229. *
  2230. *****************************************************************************/
  2231. enum iwl_ibss_manager {
  2232. IWL_NOT_IBSS_MANAGER = 0,
  2233. IWL_IBSS_MANAGER = 1,
  2234. };
  2235. /*
  2236. * BEACON_NOTIFICATION = 0x90 (notification only, not a command)
  2237. */
  2238. struct iwlagn_beacon_notif {
  2239. struct iwlagn_tx_resp beacon_notify_hdr;
  2240. __le32 low_tsf;
  2241. __le32 high_tsf;
  2242. __le32 ibss_mgr_status;
  2243. } __packed;
  2244. /*
  2245. * REPLY_TX_BEACON = 0x91 (command, has simple generic response)
  2246. */
  2247. struct iwl_tx_beacon_cmd {
  2248. struct iwl_tx_cmd tx;
  2249. __le16 tim_idx;
  2250. u8 tim_size;
  2251. u8 reserved1;
  2252. struct ieee80211_hdr frame[0]; /* beacon frame */
  2253. } __packed;
  2254. /******************************************************************************
  2255. * (10)
  2256. * Statistics Commands and Notifications:
  2257. *
  2258. *****************************************************************************/
  2259. #define IWL_TEMP_CONVERT 260
  2260. #define SUP_RATE_11A_MAX_NUM_CHANNELS 8
  2261. #define SUP_RATE_11B_MAX_NUM_CHANNELS 4
  2262. #define SUP_RATE_11G_MAX_NUM_CHANNELS 12
  2263. /* Used for passing to driver number of successes and failures per rate */
  2264. struct rate_histogram {
  2265. union {
  2266. __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
  2267. __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
  2268. __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
  2269. } success;
  2270. union {
  2271. __le32 a[SUP_RATE_11A_MAX_NUM_CHANNELS];
  2272. __le32 b[SUP_RATE_11B_MAX_NUM_CHANNELS];
  2273. __le32 g[SUP_RATE_11G_MAX_NUM_CHANNELS];
  2274. } failed;
  2275. } __packed;
  2276. /* statistics command response */
  2277. struct statistics_dbg {
  2278. __le32 burst_check;
  2279. __le32 burst_count;
  2280. __le32 wait_for_silence_timeout_cnt;
  2281. __le32 reserved[3];
  2282. } __packed;
  2283. struct statistics_rx_phy {
  2284. __le32 ina_cnt;
  2285. __le32 fina_cnt;
  2286. __le32 plcp_err;
  2287. __le32 crc32_err;
  2288. __le32 overrun_err;
  2289. __le32 early_overrun_err;
  2290. __le32 crc32_good;
  2291. __le32 false_alarm_cnt;
  2292. __le32 fina_sync_err_cnt;
  2293. __le32 sfd_timeout;
  2294. __le32 fina_timeout;
  2295. __le32 unresponded_rts;
  2296. __le32 rxe_frame_limit_overrun;
  2297. __le32 sent_ack_cnt;
  2298. __le32 sent_cts_cnt;
  2299. __le32 sent_ba_rsp_cnt;
  2300. __le32 dsp_self_kill;
  2301. __le32 mh_format_err;
  2302. __le32 re_acq_main_rssi_sum;
  2303. __le32 reserved3;
  2304. } __packed;
  2305. struct statistics_rx_ht_phy {
  2306. __le32 plcp_err;
  2307. __le32 overrun_err;
  2308. __le32 early_overrun_err;
  2309. __le32 crc32_good;
  2310. __le32 crc32_err;
  2311. __le32 mh_format_err;
  2312. __le32 agg_crc32_good;
  2313. __le32 agg_mpdu_cnt;
  2314. __le32 agg_cnt;
  2315. __le32 unsupport_mcs;
  2316. } __packed;
  2317. #define INTERFERENCE_DATA_AVAILABLE cpu_to_le32(1)
  2318. struct statistics_rx_non_phy {
  2319. __le32 bogus_cts; /* CTS received when not expecting CTS */
  2320. __le32 bogus_ack; /* ACK received when not expecting ACK */
  2321. __le32 non_bssid_frames; /* number of frames with BSSID that
  2322. * doesn't belong to the STA BSSID */
  2323. __le32 filtered_frames; /* count frames that were dumped in the
  2324. * filtering process */
  2325. __le32 non_channel_beacons; /* beacons with our bss id but not on
  2326. * our serving channel */
  2327. __le32 channel_beacons; /* beacons with our bss id and in our
  2328. * serving channel */
  2329. __le32 num_missed_bcon; /* number of missed beacons */
  2330. __le32 adc_rx_saturation_time; /* count in 0.8us units the time the
  2331. * ADC was in saturation */
  2332. __le32 ina_detection_search_time;/* total time (in 0.8us) searched
  2333. * for INA */
  2334. __le32 beacon_silence_rssi_a; /* RSSI silence after beacon frame */
  2335. __le32 beacon_silence_rssi_b; /* RSSI silence after beacon frame */
  2336. __le32 beacon_silence_rssi_c; /* RSSI silence after beacon frame */
  2337. __le32 interference_data_flag; /* flag for interference data
  2338. * availability. 1 when data is
  2339. * available. */
  2340. __le32 channel_load; /* counts RX Enable time in uSec */
  2341. __le32 dsp_false_alarms; /* DSP false alarm (both OFDM
  2342. * and CCK) counter */
  2343. __le32 beacon_rssi_a;
  2344. __le32 beacon_rssi_b;
  2345. __le32 beacon_rssi_c;
  2346. __le32 beacon_energy_a;
  2347. __le32 beacon_energy_b;
  2348. __le32 beacon_energy_c;
  2349. } __packed;
  2350. struct statistics_rx_non_phy_bt {
  2351. struct statistics_rx_non_phy common;
  2352. /* additional stats for bt */
  2353. __le32 num_bt_kills;
  2354. __le32 reserved[2];
  2355. } __packed;
  2356. struct statistics_rx {
  2357. struct statistics_rx_phy ofdm;
  2358. struct statistics_rx_phy cck;
  2359. struct statistics_rx_non_phy general;
  2360. struct statistics_rx_ht_phy ofdm_ht;
  2361. } __packed;
  2362. struct statistics_rx_bt {
  2363. struct statistics_rx_phy ofdm;
  2364. struct statistics_rx_phy cck;
  2365. struct statistics_rx_non_phy_bt general;
  2366. struct statistics_rx_ht_phy ofdm_ht;
  2367. } __packed;
  2368. /**
  2369. * struct statistics_tx_power - current tx power
  2370. *
  2371. * @ant_a: current tx power on chain a in 1/2 dB step
  2372. * @ant_b: current tx power on chain b in 1/2 dB step
  2373. * @ant_c: current tx power on chain c in 1/2 dB step
  2374. */
  2375. struct statistics_tx_power {
  2376. u8 ant_a;
  2377. u8 ant_b;
  2378. u8 ant_c;
  2379. u8 reserved;
  2380. } __packed;
  2381. struct statistics_tx_non_phy_agg {
  2382. __le32 ba_timeout;
  2383. __le32 ba_reschedule_frames;
  2384. __le32 scd_query_agg_frame_cnt;
  2385. __le32 scd_query_no_agg;
  2386. __le32 scd_query_agg;
  2387. __le32 scd_query_mismatch;
  2388. __le32 frame_not_ready;
  2389. __le32 underrun;
  2390. __le32 bt_prio_kill;
  2391. __le32 rx_ba_rsp_cnt;
  2392. } __packed;
  2393. struct statistics_tx {
  2394. __le32 preamble_cnt;
  2395. __le32 rx_detected_cnt;
  2396. __le32 bt_prio_defer_cnt;
  2397. __le32 bt_prio_kill_cnt;
  2398. __le32 few_bytes_cnt;
  2399. __le32 cts_timeout;
  2400. __le32 ack_timeout;
  2401. __le32 expected_ack_cnt;
  2402. __le32 actual_ack_cnt;
  2403. __le32 dump_msdu_cnt;
  2404. __le32 burst_abort_next_frame_mismatch_cnt;
  2405. __le32 burst_abort_missing_next_frame_cnt;
  2406. __le32 cts_timeout_collision;
  2407. __le32 ack_or_ba_timeout_collision;
  2408. struct statistics_tx_non_phy_agg agg;
  2409. /*
  2410. * "tx_power" are optional parameters provided by uCode,
  2411. * 6000 series is the only device provide the information,
  2412. * Those are reserved fields for all the other devices
  2413. */
  2414. struct statistics_tx_power tx_power;
  2415. __le32 reserved1;
  2416. } __packed;
  2417. struct statistics_div {
  2418. __le32 tx_on_a;
  2419. __le32 tx_on_b;
  2420. __le32 exec_time;
  2421. __le32 probe_time;
  2422. __le32 reserved1;
  2423. __le32 reserved2;
  2424. } __packed;
  2425. struct statistics_general_common {
  2426. __le32 temperature; /* radio temperature */
  2427. __le32 temperature_m; /* for 5000 and up, this is radio voltage */
  2428. struct statistics_dbg dbg;
  2429. __le32 sleep_time;
  2430. __le32 slots_out;
  2431. __le32 slots_idle;
  2432. __le32 ttl_timestamp;
  2433. struct statistics_div div;
  2434. __le32 rx_enable_counter;
  2435. /*
  2436. * num_of_sos_states:
  2437. * count the number of times we have to re-tune
  2438. * in order to get out of bad PHY status
  2439. */
  2440. __le32 num_of_sos_states;
  2441. } __packed;
  2442. struct statistics_bt_activity {
  2443. /* Tx statistics */
  2444. __le32 hi_priority_tx_req_cnt;
  2445. __le32 hi_priority_tx_denied_cnt;
  2446. __le32 lo_priority_tx_req_cnt;
  2447. __le32 lo_priority_tx_denied_cnt;
  2448. /* Rx statistics */
  2449. __le32 hi_priority_rx_req_cnt;
  2450. __le32 hi_priority_rx_denied_cnt;
  2451. __le32 lo_priority_rx_req_cnt;
  2452. __le32 lo_priority_rx_denied_cnt;
  2453. } __packed;
  2454. struct statistics_general {
  2455. struct statistics_general_common common;
  2456. __le32 reserved2;
  2457. __le32 reserved3;
  2458. } __packed;
  2459. struct statistics_general_bt {
  2460. struct statistics_general_common common;
  2461. struct statistics_bt_activity activity;
  2462. __le32 reserved2;
  2463. __le32 reserved3;
  2464. } __packed;
  2465. #define UCODE_STATISTICS_CLEAR_MSK (0x1 << 0)
  2466. #define UCODE_STATISTICS_FREQUENCY_MSK (0x1 << 1)
  2467. #define UCODE_STATISTICS_NARROW_BAND_MSK (0x1 << 2)
  2468. /*
  2469. * REPLY_STATISTICS_CMD = 0x9c,
  2470. * all devices identical.
  2471. *
  2472. * This command triggers an immediate response containing uCode statistics.
  2473. * The response is in the same format as STATISTICS_NOTIFICATION 0x9d, below.
  2474. *
  2475. * If the CLEAR_STATS configuration flag is set, uCode will clear its
  2476. * internal copy of the statistics (counters) after issuing the response.
  2477. * This flag does not affect STATISTICS_NOTIFICATIONs after beacons (see below).
  2478. *
  2479. * If the DISABLE_NOTIF configuration flag is set, uCode will not issue
  2480. * STATISTICS_NOTIFICATIONs after received beacons (see below). This flag
  2481. * does not affect the response to the REPLY_STATISTICS_CMD 0x9c itself.
  2482. */
  2483. #define IWL_STATS_CONF_CLEAR_STATS cpu_to_le32(0x1) /* see above */
  2484. #define IWL_STATS_CONF_DISABLE_NOTIF cpu_to_le32(0x2)/* see above */
  2485. struct iwl_statistics_cmd {
  2486. __le32 configuration_flags; /* IWL_STATS_CONF_* */
  2487. } __packed;
  2488. /*
  2489. * STATISTICS_NOTIFICATION = 0x9d (notification only, not a command)
  2490. *
  2491. * By default, uCode issues this notification after receiving a beacon
  2492. * while associated. To disable this behavior, set DISABLE_NOTIF flag in the
  2493. * REPLY_STATISTICS_CMD 0x9c, above.
  2494. *
  2495. * Statistics counters continue to increment beacon after beacon, but are
  2496. * cleared when changing channels or when driver issues REPLY_STATISTICS_CMD
  2497. * 0x9c with CLEAR_STATS bit set (see above).
  2498. *
  2499. * uCode also issues this notification during scans. uCode clears statistics
  2500. * appropriately so that each notification contains statistics for only the
  2501. * one channel that has just been scanned.
  2502. */
  2503. #define STATISTICS_REPLY_FLG_BAND_24G_MSK cpu_to_le32(0x2)
  2504. #define STATISTICS_REPLY_FLG_HT40_MODE_MSK cpu_to_le32(0x8)
  2505. struct iwl_notif_statistics {
  2506. __le32 flag;
  2507. struct statistics_rx rx;
  2508. struct statistics_tx tx;
  2509. struct statistics_general general;
  2510. } __packed;
  2511. struct iwl_bt_notif_statistics {
  2512. __le32 flag;
  2513. struct statistics_rx_bt rx;
  2514. struct statistics_tx tx;
  2515. struct statistics_general_bt general;
  2516. } __packed;
  2517. /*
  2518. * MISSED_BEACONS_NOTIFICATION = 0xa2 (notification only, not a command)
  2519. *
  2520. * uCode send MISSED_BEACONS_NOTIFICATION to driver when detect beacon missed
  2521. * in regardless of how many missed beacons, which mean when driver receive the
  2522. * notification, inside the command, it can find all the beacons information
  2523. * which include number of total missed beacons, number of consecutive missed
  2524. * beacons, number of beacons received and number of beacons expected to
  2525. * receive.
  2526. *
  2527. * If uCode detected consecutive_missed_beacons > 5, it will reset the radio
  2528. * in order to bring the radio/PHY back to working state; which has no relation
  2529. * to when driver will perform sensitivity calibration.
  2530. *
  2531. * Driver should set it own missed_beacon_threshold to decide when to perform
  2532. * sensitivity calibration based on number of consecutive missed beacons in
  2533. * order to improve overall performance, especially in noisy environment.
  2534. *
  2535. */
  2536. #define IWL_MISSED_BEACON_THRESHOLD_MIN (1)
  2537. #define IWL_MISSED_BEACON_THRESHOLD_DEF (5)
  2538. #define IWL_MISSED_BEACON_THRESHOLD_MAX IWL_MISSED_BEACON_THRESHOLD_DEF
  2539. struct iwl_missed_beacon_notif {
  2540. __le32 consecutive_missed_beacons;
  2541. __le32 total_missed_becons;
  2542. __le32 num_expected_beacons;
  2543. __le32 num_recvd_beacons;
  2544. } __packed;
  2545. /******************************************************************************
  2546. * (11)
  2547. * Rx Calibration Commands:
  2548. *
  2549. * With the uCode used for open source drivers, most Tx calibration (except
  2550. * for Tx Power) and most Rx calibration is done by uCode during the
  2551. * "initialize" phase of uCode boot. Driver must calibrate only:
  2552. *
  2553. * 1) Tx power (depends on temperature), described elsewhere
  2554. * 2) Receiver gain balance (optimize MIMO, and detect disconnected antennas)
  2555. * 3) Receiver sensitivity (to optimize signal detection)
  2556. *
  2557. *****************************************************************************/
  2558. /**
  2559. * SENSITIVITY_CMD = 0xa8 (command, has simple generic response)
  2560. *
  2561. * This command sets up the Rx signal detector for a sensitivity level that
  2562. * is high enough to lock onto all signals within the associated network,
  2563. * but low enough to ignore signals that are below a certain threshold, so as
  2564. * not to have too many "false alarms". False alarms are signals that the
  2565. * Rx DSP tries to lock onto, but then discards after determining that they
  2566. * are noise.
  2567. *
  2568. * The optimum number of false alarms is between 5 and 50 per 200 TUs
  2569. * (200 * 1024 uSecs, i.e. 204.8 milliseconds) of actual Rx time (i.e.
  2570. * time listening, not transmitting). Driver must adjust sensitivity so that
  2571. * the ratio of actual false alarms to actual Rx time falls within this range.
  2572. *
  2573. * While associated, uCode delivers STATISTICS_NOTIFICATIONs after each
  2574. * received beacon. These provide information to the driver to analyze the
  2575. * sensitivity. Don't analyze statistics that come in from scanning, or any
  2576. * other non-associated-network source. Pertinent statistics include:
  2577. *
  2578. * From "general" statistics (struct statistics_rx_non_phy):
  2579. *
  2580. * (beacon_energy_[abc] & 0x0FF00) >> 8 (unsigned, higher value is lower level)
  2581. * Measure of energy of desired signal. Used for establishing a level
  2582. * below which the device does not detect signals.
  2583. *
  2584. * (beacon_silence_rssi_[abc] & 0x0FF00) >> 8 (unsigned, units in dB)
  2585. * Measure of background noise in silent period after beacon.
  2586. *
  2587. * channel_load
  2588. * uSecs of actual Rx time during beacon period (varies according to
  2589. * how much time was spent transmitting).
  2590. *
  2591. * From "cck" and "ofdm" statistics (struct statistics_rx_phy), separately:
  2592. *
  2593. * false_alarm_cnt
  2594. * Signal locks abandoned early (before phy-level header).
  2595. *
  2596. * plcp_err
  2597. * Signal locks abandoned late (during phy-level header).
  2598. *
  2599. * NOTE: Both false_alarm_cnt and plcp_err increment monotonically from
  2600. * beacon to beacon, i.e. each value is an accumulation of all errors
  2601. * before and including the latest beacon. Values will wrap around to 0
  2602. * after counting up to 2^32 - 1. Driver must differentiate vs.
  2603. * previous beacon's values to determine # false alarms in the current
  2604. * beacon period.
  2605. *
  2606. * Total number of false alarms = false_alarms + plcp_errs
  2607. *
  2608. * For OFDM, adjust the following table entries in struct iwl_sensitivity_cmd
  2609. * (notice that the start points for OFDM are at or close to settings for
  2610. * maximum sensitivity):
  2611. *
  2612. * START / MIN / MAX
  2613. * HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX 90 / 85 / 120
  2614. * HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX 170 / 170 / 210
  2615. * HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX 105 / 105 / 140
  2616. * HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX 220 / 220 / 270
  2617. *
  2618. * If actual rate of OFDM false alarms (+ plcp_errors) is too high
  2619. * (greater than 50 for each 204.8 msecs listening), reduce sensitivity
  2620. * by *adding* 1 to all 4 of the table entries above, up to the max for
  2621. * each entry. Conversely, if false alarm rate is too low (less than 5
  2622. * for each 204.8 msecs listening), *subtract* 1 from each entry to
  2623. * increase sensitivity.
  2624. *
  2625. * For CCK sensitivity, keep track of the following:
  2626. *
  2627. * 1). 20-beacon history of maximum background noise, indicated by
  2628. * (beacon_silence_rssi_[abc] & 0x0FF00), units in dB, across the
  2629. * 3 receivers. For any given beacon, the "silence reference" is
  2630. * the maximum of last 60 samples (20 beacons * 3 receivers).
  2631. *
  2632. * 2). 10-beacon history of strongest signal level, as indicated
  2633. * by (beacon_energy_[abc] & 0x0FF00) >> 8, across the 3 receivers,
  2634. * i.e. the strength of the signal through the best receiver at the
  2635. * moment. These measurements are "upside down", with lower values
  2636. * for stronger signals, so max energy will be *minimum* value.
  2637. *
  2638. * Then for any given beacon, the driver must determine the *weakest*
  2639. * of the strongest signals; this is the minimum level that needs to be
  2640. * successfully detected, when using the best receiver at the moment.
  2641. * "Max cck energy" is the maximum (higher value means lower energy!)
  2642. * of the last 10 minima. Once this is determined, driver must add
  2643. * a little margin by adding "6" to it.
  2644. *
  2645. * 3). Number of consecutive beacon periods with too few false alarms.
  2646. * Reset this to 0 at the first beacon period that falls within the
  2647. * "good" range (5 to 50 false alarms per 204.8 milliseconds rx).
  2648. *
  2649. * Then, adjust the following CCK table entries in struct iwl_sensitivity_cmd
  2650. * (notice that the start points for CCK are at maximum sensitivity):
  2651. *
  2652. * START / MIN / MAX
  2653. * HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX 125 / 125 / 200
  2654. * HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX 200 / 200 / 400
  2655. * HD_MIN_ENERGY_CCK_DET_INDEX 100 / 0 / 100
  2656. *
  2657. * If actual rate of CCK false alarms (+ plcp_errors) is too high
  2658. * (greater than 50 for each 204.8 msecs listening), method for reducing
  2659. * sensitivity is:
  2660. *
  2661. * 1) *Add* 3 to value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
  2662. * up to max 400.
  2663. *
  2664. * 2) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is < 160,
  2665. * sensitivity has been reduced a significant amount; bring it up to
  2666. * a moderate 161. Otherwise, *add* 3, up to max 200.
  2667. *
  2668. * 3) a) If current value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX is > 160,
  2669. * sensitivity has been reduced only a moderate or small amount;
  2670. * *subtract* 2 from value in HD_MIN_ENERGY_CCK_DET_INDEX,
  2671. * down to min 0. Otherwise (if gain has been significantly reduced),
  2672. * don't change the HD_MIN_ENERGY_CCK_DET_INDEX value.
  2673. *
  2674. * b) Save a snapshot of the "silence reference".
  2675. *
  2676. * If actual rate of CCK false alarms (+ plcp_errors) is too low
  2677. * (less than 5 for each 204.8 msecs listening), method for increasing
  2678. * sensitivity is used only if:
  2679. *
  2680. * 1a) Previous beacon did not have too many false alarms
  2681. * 1b) AND difference between previous "silence reference" and current
  2682. * "silence reference" (prev - current) is 2 or more,
  2683. * OR 2) 100 or more consecutive beacon periods have had rate of
  2684. * less than 5 false alarms per 204.8 milliseconds rx time.
  2685. *
  2686. * Method for increasing sensitivity:
  2687. *
  2688. * 1) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX,
  2689. * down to min 125.
  2690. *
  2691. * 2) *Subtract* 3 from value in HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX,
  2692. * down to min 200.
  2693. *
  2694. * 3) *Add* 2 to value in HD_MIN_ENERGY_CCK_DET_INDEX, up to max 100.
  2695. *
  2696. * If actual rate of CCK false alarms (+ plcp_errors) is within good range
  2697. * (between 5 and 50 for each 204.8 msecs listening):
  2698. *
  2699. * 1) Save a snapshot of the silence reference.
  2700. *
  2701. * 2) If previous beacon had too many CCK false alarms (+ plcp_errors),
  2702. * give some extra margin to energy threshold by *subtracting* 8
  2703. * from value in HD_MIN_ENERGY_CCK_DET_INDEX.
  2704. *
  2705. * For all cases (too few, too many, good range), make sure that the CCK
  2706. * detection threshold (energy) is below the energy level for robust
  2707. * detection over the past 10 beacon periods, the "Max cck energy".
  2708. * Lower values mean higher energy; this means making sure that the value
  2709. * in HD_MIN_ENERGY_CCK_DET_INDEX is at or *above* "Max cck energy".
  2710. *
  2711. */
  2712. /*
  2713. * Table entries in SENSITIVITY_CMD (struct iwl_sensitivity_cmd)
  2714. */
  2715. #define HD_TABLE_SIZE (11) /* number of entries */
  2716. #define HD_MIN_ENERGY_CCK_DET_INDEX (0) /* table indexes */
  2717. #define HD_MIN_ENERGY_OFDM_DET_INDEX (1)
  2718. #define HD_AUTO_CORR32_X1_TH_ADD_MIN_INDEX (2)
  2719. #define HD_AUTO_CORR32_X1_TH_ADD_MIN_MRC_INDEX (3)
  2720. #define HD_AUTO_CORR40_X4_TH_ADD_MIN_MRC_INDEX (4)
  2721. #define HD_AUTO_CORR32_X4_TH_ADD_MIN_INDEX (5)
  2722. #define HD_AUTO_CORR32_X4_TH_ADD_MIN_MRC_INDEX (6)
  2723. #define HD_BARKER_CORR_TH_ADD_MIN_INDEX (7)
  2724. #define HD_BARKER_CORR_TH_ADD_MIN_MRC_INDEX (8)
  2725. #define HD_AUTO_CORR40_X4_TH_ADD_MIN_INDEX (9)
  2726. #define HD_OFDM_ENERGY_TH_IN_INDEX (10)
  2727. /*
  2728. * Additional table entries in enhance SENSITIVITY_CMD
  2729. */
  2730. #define HD_INA_NON_SQUARE_DET_OFDM_INDEX (11)
  2731. #define HD_INA_NON_SQUARE_DET_CCK_INDEX (12)
  2732. #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_INDEX (13)
  2733. #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_INDEX (14)
  2734. #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_INDEX (15)
  2735. #define HD_OFDM_NON_SQUARE_DET_SLOPE_INDEX (16)
  2736. #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_INDEX (17)
  2737. #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_INDEX (18)
  2738. #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_INDEX (19)
  2739. #define HD_CCK_NON_SQUARE_DET_SLOPE_INDEX (20)
  2740. #define HD_CCK_NON_SQUARE_DET_INTERCEPT_INDEX (21)
  2741. #define HD_RESERVED (22)
  2742. /* number of entries for enhanced tbl */
  2743. #define ENHANCE_HD_TABLE_SIZE (23)
  2744. /* number of additional entries for enhanced tbl */
  2745. #define ENHANCE_HD_TABLE_ENTRIES (ENHANCE_HD_TABLE_SIZE - HD_TABLE_SIZE)
  2746. #define HD_INA_NON_SQUARE_DET_OFDM_DATA cpu_to_le16(0)
  2747. #define HD_INA_NON_SQUARE_DET_CCK_DATA cpu_to_le16(0)
  2748. #define HD_CORR_11_INSTEAD_OF_CORR_9_EN_DATA cpu_to_le16(0)
  2749. #define HD_OFDM_NON_SQUARE_DET_SLOPE_MRC_DATA cpu_to_le16(668)
  2750. #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_MRC_DATA cpu_to_le16(4)
  2751. #define HD_OFDM_NON_SQUARE_DET_SLOPE_DATA cpu_to_le16(486)
  2752. #define HD_OFDM_NON_SQUARE_DET_INTERCEPT_DATA cpu_to_le16(37)
  2753. #define HD_CCK_NON_SQUARE_DET_SLOPE_MRC_DATA cpu_to_le16(853)
  2754. #define HD_CCK_NON_SQUARE_DET_INTERCEPT_MRC_DATA cpu_to_le16(4)
  2755. #define HD_CCK_NON_SQUARE_DET_SLOPE_DATA cpu_to_le16(476)
  2756. #define HD_CCK_NON_SQUARE_DET_INTERCEPT_DATA cpu_to_le16(99)
  2757. /* Control field in struct iwl_sensitivity_cmd */
  2758. #define SENSITIVITY_CMD_CONTROL_DEFAULT_TABLE cpu_to_le16(0)
  2759. #define SENSITIVITY_CMD_CONTROL_WORK_TABLE cpu_to_le16(1)
  2760. /**
  2761. * struct iwl_sensitivity_cmd
  2762. * @control: (1) updates working table, (0) updates default table
  2763. * @table: energy threshold values, use HD_* as index into table
  2764. *
  2765. * Always use "1" in "control" to update uCode's working table and DSP.
  2766. */
  2767. struct iwl_sensitivity_cmd {
  2768. __le16 control; /* always use "1" */
  2769. __le16 table[HD_TABLE_SIZE]; /* use HD_* as index */
  2770. } __packed;
  2771. /*
  2772. *
  2773. */
  2774. struct iwl_enhance_sensitivity_cmd {
  2775. __le16 control; /* always use "1" */
  2776. __le16 enhance_table[ENHANCE_HD_TABLE_SIZE]; /* use HD_* as index */
  2777. } __packed;
  2778. /**
  2779. * REPLY_PHY_CALIBRATION_CMD = 0xb0 (command, has simple generic response)
  2780. *
  2781. * This command sets the relative gains of agn device's 3 radio receiver chains.
  2782. *
  2783. * After the first association, driver should accumulate signal and noise
  2784. * statistics from the STATISTICS_NOTIFICATIONs that follow the first 20
  2785. * beacons from the associated network (don't collect statistics that come
  2786. * in from scanning, or any other non-network source).
  2787. *
  2788. * DISCONNECTED ANTENNA:
  2789. *
  2790. * Driver should determine which antennas are actually connected, by comparing
  2791. * average beacon signal levels for the 3 Rx chains. Accumulate (add) the
  2792. * following values over 20 beacons, one accumulator for each of the chains
  2793. * a/b/c, from struct statistics_rx_non_phy:
  2794. *
  2795. * beacon_rssi_[abc] & 0x0FF (unsigned, units in dB)
  2796. *
  2797. * Find the strongest signal from among a/b/c. Compare the other two to the
  2798. * strongest. If any signal is more than 15 dB (times 20, unless you
  2799. * divide the accumulated values by 20) below the strongest, the driver
  2800. * considers that antenna to be disconnected, and should not try to use that
  2801. * antenna/chain for Rx or Tx. If both A and B seem to be disconnected,
  2802. * driver should declare the stronger one as connected, and attempt to use it
  2803. * (A and B are the only 2 Tx chains!).
  2804. *
  2805. *
  2806. * RX BALANCE:
  2807. *
  2808. * Driver should balance the 3 receivers (but just the ones that are connected
  2809. * to antennas, see above) for gain, by comparing the average signal levels
  2810. * detected during the silence after each beacon (background noise).
  2811. * Accumulate (add) the following values over 20 beacons, one accumulator for
  2812. * each of the chains a/b/c, from struct statistics_rx_non_phy:
  2813. *
  2814. * beacon_silence_rssi_[abc] & 0x0FF (unsigned, units in dB)
  2815. *
  2816. * Find the weakest background noise level from among a/b/c. This Rx chain
  2817. * will be the reference, with 0 gain adjustment. Attenuate other channels by
  2818. * finding noise difference:
  2819. *
  2820. * (accum_noise[i] - accum_noise[reference]) / 30
  2821. *
  2822. * The "30" adjusts the dB in the 20 accumulated samples to units of 1.5 dB.
  2823. * For use in diff_gain_[abc] fields of struct iwl_calibration_cmd, the
  2824. * driver should limit the difference results to a range of 0-3 (0-4.5 dB),
  2825. * and set bit 2 to indicate "reduce gain". The value for the reference
  2826. * (weakest) chain should be "0".
  2827. *
  2828. * diff_gain_[abc] bit fields:
  2829. * 2: (1) reduce gain, (0) increase gain
  2830. * 1-0: amount of gain, units of 1.5 dB
  2831. */
  2832. /* Phy calibration command for series */
  2833. /* The default calibrate table size if not specified by firmware */
  2834. #define IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE 18
  2835. enum {
  2836. IWL_PHY_CALIBRATE_DIFF_GAIN_CMD = 7,
  2837. IWL_PHY_CALIBRATE_DC_CMD = 8,
  2838. IWL_PHY_CALIBRATE_LO_CMD = 9,
  2839. IWL_PHY_CALIBRATE_TX_IQ_CMD = 11,
  2840. IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD = 15,
  2841. IWL_PHY_CALIBRATE_BASE_BAND_CMD = 16,
  2842. IWL_PHY_CALIBRATE_TX_IQ_PERD_CMD = 17,
  2843. IWL_PHY_CALIBRATE_TEMP_OFFSET_CMD = 18,
  2844. IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE = 19,
  2845. };
  2846. #define IWL_MAX_PHY_CALIBRATE_TBL_SIZE (253)
  2847. #define IWL_CALIB_INIT_CFG_ALL cpu_to_le32(0xffffffff)
  2848. /* This enum defines the bitmap of various calibrations to enable in both
  2849. * init ucode and runtime ucode through CALIBRATION_CFG_CMD.
  2850. */
  2851. enum iwl_ucode_calib_cfg {
  2852. IWL_CALIB_CFG_RX_BB_IDX,
  2853. IWL_CALIB_CFG_DC_IDX,
  2854. IWL_CALIB_CFG_TX_IQ_IDX,
  2855. IWL_CALIB_CFG_RX_IQ_IDX,
  2856. IWL_CALIB_CFG_NOISE_IDX,
  2857. IWL_CALIB_CFG_CRYSTAL_IDX,
  2858. IWL_CALIB_CFG_TEMPERATURE_IDX,
  2859. IWL_CALIB_CFG_PAPD_IDX,
  2860. };
  2861. struct iwl_calib_cfg_elmnt_s {
  2862. __le32 is_enable;
  2863. __le32 start;
  2864. __le32 send_res;
  2865. __le32 apply_res;
  2866. __le32 reserved;
  2867. } __packed;
  2868. struct iwl_calib_cfg_status_s {
  2869. struct iwl_calib_cfg_elmnt_s once;
  2870. struct iwl_calib_cfg_elmnt_s perd;
  2871. __le32 flags;
  2872. } __packed;
  2873. struct iwl_calib_cfg_cmd {
  2874. struct iwl_calib_cfg_status_s ucd_calib_cfg;
  2875. struct iwl_calib_cfg_status_s drv_calib_cfg;
  2876. __le32 reserved1;
  2877. } __packed;
  2878. struct iwl_calib_hdr {
  2879. u8 op_code;
  2880. u8 first_group;
  2881. u8 groups_num;
  2882. u8 data_valid;
  2883. } __packed;
  2884. struct iwl_calib_cmd {
  2885. struct iwl_calib_hdr hdr;
  2886. u8 data[0];
  2887. } __packed;
  2888. /* IWL_PHY_CALIBRATE_DIFF_GAIN_CMD (7) */
  2889. struct iwl_calib_diff_gain_cmd {
  2890. struct iwl_calib_hdr hdr;
  2891. s8 diff_gain_a; /* see above */
  2892. s8 diff_gain_b;
  2893. s8 diff_gain_c;
  2894. u8 reserved1;
  2895. } __packed;
  2896. struct iwl_calib_xtal_freq_cmd {
  2897. struct iwl_calib_hdr hdr;
  2898. u8 cap_pin1;
  2899. u8 cap_pin2;
  2900. u8 pad[2];
  2901. } __packed;
  2902. #define DEFAULT_RADIO_SENSOR_OFFSET 2700
  2903. struct iwl_calib_temperature_offset_cmd {
  2904. struct iwl_calib_hdr hdr;
  2905. s16 radio_sensor_offset;
  2906. s16 reserved;
  2907. } __packed;
  2908. /* IWL_PHY_CALIBRATE_CHAIN_NOISE_RESET_CMD */
  2909. struct iwl_calib_chain_noise_reset_cmd {
  2910. struct iwl_calib_hdr hdr;
  2911. u8 data[0];
  2912. };
  2913. /* IWL_PHY_CALIBRATE_CHAIN_NOISE_GAIN_CMD */
  2914. struct iwl_calib_chain_noise_gain_cmd {
  2915. struct iwl_calib_hdr hdr;
  2916. u8 delta_gain_1;
  2917. u8 delta_gain_2;
  2918. u8 pad[2];
  2919. } __packed;
  2920. /******************************************************************************
  2921. * (12)
  2922. * Miscellaneous Commands:
  2923. *
  2924. *****************************************************************************/
  2925. /*
  2926. * LEDs Command & Response
  2927. * REPLY_LEDS_CMD = 0x48 (command, has simple generic response)
  2928. *
  2929. * For each of 3 possible LEDs (Activity/Link/Tech, selected by "id" field),
  2930. * this command turns it on or off, or sets up a periodic blinking cycle.
  2931. */
  2932. struct iwl_led_cmd {
  2933. __le32 interval; /* "interval" in uSec */
  2934. u8 id; /* 1: Activity, 2: Link, 3: Tech */
  2935. u8 off; /* # intervals off while blinking;
  2936. * "0", with >0 "on" value, turns LED on */
  2937. u8 on; /* # intervals on while blinking;
  2938. * "0", regardless of "off", turns LED off */
  2939. u8 reserved;
  2940. } __packed;
  2941. /*
  2942. * station priority table entries
  2943. * also used as potential "events" value for both
  2944. * COEX_MEDIUM_NOTIFICATION and COEX_EVENT_CMD
  2945. */
  2946. /*
  2947. * COEX events entry flag masks
  2948. * RP - Requested Priority
  2949. * WP - Win Medium Priority: priority assigned when the contention has been won
  2950. */
  2951. #define COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG (0x1)
  2952. #define COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG (0x2)
  2953. #define COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG (0x4)
  2954. #define COEX_CU_UNASSOC_IDLE_RP 4
  2955. #define COEX_CU_UNASSOC_MANUAL_SCAN_RP 4
  2956. #define COEX_CU_UNASSOC_AUTO_SCAN_RP 4
  2957. #define COEX_CU_CALIBRATION_RP 4
  2958. #define COEX_CU_PERIODIC_CALIBRATION_RP 4
  2959. #define COEX_CU_CONNECTION_ESTAB_RP 4
  2960. #define COEX_CU_ASSOCIATED_IDLE_RP 4
  2961. #define COEX_CU_ASSOC_MANUAL_SCAN_RP 4
  2962. #define COEX_CU_ASSOC_AUTO_SCAN_RP 4
  2963. #define COEX_CU_ASSOC_ACTIVE_LEVEL_RP 4
  2964. #define COEX_CU_RF_ON_RP 6
  2965. #define COEX_CU_RF_OFF_RP 4
  2966. #define COEX_CU_STAND_ALONE_DEBUG_RP 6
  2967. #define COEX_CU_IPAN_ASSOC_LEVEL_RP 4
  2968. #define COEX_CU_RSRVD1_RP 4
  2969. #define COEX_CU_RSRVD2_RP 4
  2970. #define COEX_CU_UNASSOC_IDLE_WP 3
  2971. #define COEX_CU_UNASSOC_MANUAL_SCAN_WP 3
  2972. #define COEX_CU_UNASSOC_AUTO_SCAN_WP 3
  2973. #define COEX_CU_CALIBRATION_WP 3
  2974. #define COEX_CU_PERIODIC_CALIBRATION_WP 3
  2975. #define COEX_CU_CONNECTION_ESTAB_WP 3
  2976. #define COEX_CU_ASSOCIATED_IDLE_WP 3
  2977. #define COEX_CU_ASSOC_MANUAL_SCAN_WP 3
  2978. #define COEX_CU_ASSOC_AUTO_SCAN_WP 3
  2979. #define COEX_CU_ASSOC_ACTIVE_LEVEL_WP 3
  2980. #define COEX_CU_RF_ON_WP 3
  2981. #define COEX_CU_RF_OFF_WP 3
  2982. #define COEX_CU_STAND_ALONE_DEBUG_WP 6
  2983. #define COEX_CU_IPAN_ASSOC_LEVEL_WP 3
  2984. #define COEX_CU_RSRVD1_WP 3
  2985. #define COEX_CU_RSRVD2_WP 3
  2986. #define COEX_UNASSOC_IDLE_FLAGS 0
  2987. #define COEX_UNASSOC_MANUAL_SCAN_FLAGS \
  2988. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  2989. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
  2990. #define COEX_UNASSOC_AUTO_SCAN_FLAGS \
  2991. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  2992. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
  2993. #define COEX_CALIBRATION_FLAGS \
  2994. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  2995. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
  2996. #define COEX_PERIODIC_CALIBRATION_FLAGS 0
  2997. /*
  2998. * COEX_CONNECTION_ESTAB:
  2999. * we need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
  3000. */
  3001. #define COEX_CONNECTION_ESTAB_FLAGS \
  3002. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  3003. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
  3004. COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
  3005. #define COEX_ASSOCIATED_IDLE_FLAGS 0
  3006. #define COEX_ASSOC_MANUAL_SCAN_FLAGS \
  3007. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  3008. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
  3009. #define COEX_ASSOC_AUTO_SCAN_FLAGS \
  3010. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  3011. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
  3012. #define COEX_ASSOC_ACTIVE_LEVEL_FLAGS 0
  3013. #define COEX_RF_ON_FLAGS 0
  3014. #define COEX_RF_OFF_FLAGS 0
  3015. #define COEX_STAND_ALONE_DEBUG_FLAGS \
  3016. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  3017. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG)
  3018. #define COEX_IPAN_ASSOC_LEVEL_FLAGS \
  3019. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  3020. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
  3021. COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
  3022. #define COEX_RSRVD1_FLAGS 0
  3023. #define COEX_RSRVD2_FLAGS 0
  3024. /*
  3025. * COEX_CU_RF_ON is the event wrapping all radio ownership.
  3026. * We need DELAY_MEDIUM_FREE_NTFY to let WiMAX disconnect from network.
  3027. */
  3028. #define COEX_CU_RF_ON_FLAGS \
  3029. (COEX_EVT_FLAG_MEDIUM_FREE_NTFY_FLG | \
  3030. COEX_EVT_FLAG_MEDIUM_ACTV_NTFY_FLG | \
  3031. COEX_EVT_FLAG_DELAY_MEDIUM_FREE_NTFY_FLG)
  3032. enum {
  3033. /* un-association part */
  3034. COEX_UNASSOC_IDLE = 0,
  3035. COEX_UNASSOC_MANUAL_SCAN = 1,
  3036. COEX_UNASSOC_AUTO_SCAN = 2,
  3037. /* calibration */
  3038. COEX_CALIBRATION = 3,
  3039. COEX_PERIODIC_CALIBRATION = 4,
  3040. /* connection */
  3041. COEX_CONNECTION_ESTAB = 5,
  3042. /* association part */
  3043. COEX_ASSOCIATED_IDLE = 6,
  3044. COEX_ASSOC_MANUAL_SCAN = 7,
  3045. COEX_ASSOC_AUTO_SCAN = 8,
  3046. COEX_ASSOC_ACTIVE_LEVEL = 9,
  3047. /* RF ON/OFF */
  3048. COEX_RF_ON = 10,
  3049. COEX_RF_OFF = 11,
  3050. COEX_STAND_ALONE_DEBUG = 12,
  3051. /* IPAN */
  3052. COEX_IPAN_ASSOC_LEVEL = 13,
  3053. /* reserved */
  3054. COEX_RSRVD1 = 14,
  3055. COEX_RSRVD2 = 15,
  3056. COEX_NUM_OF_EVENTS = 16
  3057. };
  3058. /*
  3059. * Coexistence WIFI/WIMAX Command
  3060. * COEX_PRIORITY_TABLE_CMD = 0x5a
  3061. *
  3062. */
  3063. struct iwl_wimax_coex_event_entry {
  3064. u8 request_prio;
  3065. u8 win_medium_prio;
  3066. u8 reserved;
  3067. u8 flags;
  3068. } __packed;
  3069. /* COEX flag masks */
  3070. /* Station table is valid */
  3071. #define COEX_FLAGS_STA_TABLE_VALID_MSK (0x1)
  3072. /* UnMask wake up src at unassociated sleep */
  3073. #define COEX_FLAGS_UNASSOC_WA_UNMASK_MSK (0x4)
  3074. /* UnMask wake up src at associated sleep */
  3075. #define COEX_FLAGS_ASSOC_WA_UNMASK_MSK (0x8)
  3076. /* Enable CoEx feature. */
  3077. #define COEX_FLAGS_COEX_ENABLE_MSK (0x80)
  3078. struct iwl_wimax_coex_cmd {
  3079. u8 flags;
  3080. u8 reserved[3];
  3081. struct iwl_wimax_coex_event_entry sta_prio[COEX_NUM_OF_EVENTS];
  3082. } __packed;
  3083. /*
  3084. * Coexistence MEDIUM NOTIFICATION
  3085. * COEX_MEDIUM_NOTIFICATION = 0x5b
  3086. *
  3087. * notification from uCode to host to indicate medium changes
  3088. *
  3089. */
  3090. /*
  3091. * status field
  3092. * bit 0 - 2: medium status
  3093. * bit 3: medium change indication
  3094. * bit 4 - 31: reserved
  3095. */
  3096. /* status option values, (0 - 2 bits) */
  3097. #define COEX_MEDIUM_BUSY (0x0) /* radio belongs to WiMAX */
  3098. #define COEX_MEDIUM_ACTIVE (0x1) /* radio belongs to WiFi */
  3099. #define COEX_MEDIUM_PRE_RELEASE (0x2) /* received radio release */
  3100. #define COEX_MEDIUM_MSK (0x7)
  3101. /* send notification status (1 bit) */
  3102. #define COEX_MEDIUM_CHANGED (0x8)
  3103. #define COEX_MEDIUM_CHANGED_MSK (0x8)
  3104. #define COEX_MEDIUM_SHIFT (3)
  3105. struct iwl_coex_medium_notification {
  3106. __le32 status;
  3107. __le32 events;
  3108. } __packed;
  3109. /*
  3110. * Coexistence EVENT Command
  3111. * COEX_EVENT_CMD = 0x5c
  3112. *
  3113. * send from host to uCode for coex event request.
  3114. */
  3115. /* flags options */
  3116. #define COEX_EVENT_REQUEST_MSK (0x1)
  3117. struct iwl_coex_event_cmd {
  3118. u8 flags;
  3119. u8 event;
  3120. __le16 reserved;
  3121. } __packed;
  3122. struct iwl_coex_event_resp {
  3123. __le32 status;
  3124. } __packed;
  3125. /******************************************************************************
  3126. * Bluetooth Coexistence commands
  3127. *
  3128. *****************************************************************************/
  3129. /*
  3130. * BT Status notification
  3131. * REPLY_BT_COEX_PROFILE_NOTIF = 0xce
  3132. */
  3133. enum iwl_bt_coex_profile_traffic_load {
  3134. IWL_BT_COEX_TRAFFIC_LOAD_NONE = 0,
  3135. IWL_BT_COEX_TRAFFIC_LOAD_LOW = 1,
  3136. IWL_BT_COEX_TRAFFIC_LOAD_HIGH = 2,
  3137. IWL_BT_COEX_TRAFFIC_LOAD_CONTINUOUS = 3,
  3138. /*
  3139. * There are no more even though below is a u8, the
  3140. * indication from the BT device only has two bits.
  3141. */
  3142. };
  3143. #define BT_SESSION_ACTIVITY_1_UART_MSG 0x1
  3144. #define BT_SESSION_ACTIVITY_2_UART_MSG 0x2
  3145. /* BT UART message - Share Part (BT -> WiFi) */
  3146. #define BT_UART_MSG_FRAME1MSGTYPE_POS (0)
  3147. #define BT_UART_MSG_FRAME1MSGTYPE_MSK \
  3148. (0x7 << BT_UART_MSG_FRAME1MSGTYPE_POS)
  3149. #define BT_UART_MSG_FRAME1SSN_POS (3)
  3150. #define BT_UART_MSG_FRAME1SSN_MSK \
  3151. (0x3 << BT_UART_MSG_FRAME1SSN_POS)
  3152. #define BT_UART_MSG_FRAME1UPDATEREQ_POS (5)
  3153. #define BT_UART_MSG_FRAME1UPDATEREQ_MSK \
  3154. (0x1 << BT_UART_MSG_FRAME1UPDATEREQ_POS)
  3155. #define BT_UART_MSG_FRAME1RESERVED_POS (6)
  3156. #define BT_UART_MSG_FRAME1RESERVED_MSK \
  3157. (0x3 << BT_UART_MSG_FRAME1RESERVED_POS)
  3158. #define BT_UART_MSG_FRAME2OPENCONNECTIONS_POS (0)
  3159. #define BT_UART_MSG_FRAME2OPENCONNECTIONS_MSK \
  3160. (0x3 << BT_UART_MSG_FRAME2OPENCONNECTIONS_POS)
  3161. #define BT_UART_MSG_FRAME2TRAFFICLOAD_POS (2)
  3162. #define BT_UART_MSG_FRAME2TRAFFICLOAD_MSK \
  3163. (0x3 << BT_UART_MSG_FRAME2TRAFFICLOAD_POS)
  3164. #define BT_UART_MSG_FRAME2CHLSEQN_POS (4)
  3165. #define BT_UART_MSG_FRAME2CHLSEQN_MSK \
  3166. (0x1 << BT_UART_MSG_FRAME2CHLSEQN_POS)
  3167. #define BT_UART_MSG_FRAME2INBAND_POS (5)
  3168. #define BT_UART_MSG_FRAME2INBAND_MSK \
  3169. (0x1 << BT_UART_MSG_FRAME2INBAND_POS)
  3170. #define BT_UART_MSG_FRAME2RESERVED_POS (6)
  3171. #define BT_UART_MSG_FRAME2RESERVED_MSK \
  3172. (0x3 << BT_UART_MSG_FRAME2RESERVED_POS)
  3173. #define BT_UART_MSG_FRAME3SCOESCO_POS (0)
  3174. #define BT_UART_MSG_FRAME3SCOESCO_MSK \
  3175. (0x1 << BT_UART_MSG_FRAME3SCOESCO_POS)
  3176. #define BT_UART_MSG_FRAME3SNIFF_POS (1)
  3177. #define BT_UART_MSG_FRAME3SNIFF_MSK \
  3178. (0x1 << BT_UART_MSG_FRAME3SNIFF_POS)
  3179. #define BT_UART_MSG_FRAME3A2DP_POS (2)
  3180. #define BT_UART_MSG_FRAME3A2DP_MSK \
  3181. (0x1 << BT_UART_MSG_FRAME3A2DP_POS)
  3182. #define BT_UART_MSG_FRAME3ACL_POS (3)
  3183. #define BT_UART_MSG_FRAME3ACL_MSK \
  3184. (0x1 << BT_UART_MSG_FRAME3ACL_POS)
  3185. #define BT_UART_MSG_FRAME3MASTER_POS (4)
  3186. #define BT_UART_MSG_FRAME3MASTER_MSK \
  3187. (0x1 << BT_UART_MSG_FRAME3MASTER_POS)
  3188. #define BT_UART_MSG_FRAME3OBEX_POS (5)
  3189. #define BT_UART_MSG_FRAME3OBEX_MSK \
  3190. (0x1 << BT_UART_MSG_FRAME3OBEX_POS)
  3191. #define BT_UART_MSG_FRAME3RESERVED_POS (6)
  3192. #define BT_UART_MSG_FRAME3RESERVED_MSK \
  3193. (0x3 << BT_UART_MSG_FRAME3RESERVED_POS)
  3194. #define BT_UART_MSG_FRAME4IDLEDURATION_POS (0)
  3195. #define BT_UART_MSG_FRAME4IDLEDURATION_MSK \
  3196. (0x3F << BT_UART_MSG_FRAME4IDLEDURATION_POS)
  3197. #define BT_UART_MSG_FRAME4RESERVED_POS (6)
  3198. #define BT_UART_MSG_FRAME4RESERVED_MSK \
  3199. (0x3 << BT_UART_MSG_FRAME4RESERVED_POS)
  3200. #define BT_UART_MSG_FRAME5TXACTIVITY_POS (0)
  3201. #define BT_UART_MSG_FRAME5TXACTIVITY_MSK \
  3202. (0x3 << BT_UART_MSG_FRAME5TXACTIVITY_POS)
  3203. #define BT_UART_MSG_FRAME5RXACTIVITY_POS (2)
  3204. #define BT_UART_MSG_FRAME5RXACTIVITY_MSK \
  3205. (0x3 << BT_UART_MSG_FRAME5RXACTIVITY_POS)
  3206. #define BT_UART_MSG_FRAME5ESCORETRANSMIT_POS (4)
  3207. #define BT_UART_MSG_FRAME5ESCORETRANSMIT_MSK \
  3208. (0x3 << BT_UART_MSG_FRAME5ESCORETRANSMIT_POS)
  3209. #define BT_UART_MSG_FRAME5RESERVED_POS (6)
  3210. #define BT_UART_MSG_FRAME5RESERVED_MSK \
  3211. (0x3 << BT_UART_MSG_FRAME5RESERVED_POS)
  3212. #define BT_UART_MSG_FRAME6SNIFFINTERVAL_POS (0)
  3213. #define BT_UART_MSG_FRAME6SNIFFINTERVAL_MSK \
  3214. (0x1F << BT_UART_MSG_FRAME6SNIFFINTERVAL_POS)
  3215. #define BT_UART_MSG_FRAME6DISCOVERABLE_POS (5)
  3216. #define BT_UART_MSG_FRAME6DISCOVERABLE_MSK \
  3217. (0x1 << BT_UART_MSG_FRAME6DISCOVERABLE_POS)
  3218. #define BT_UART_MSG_FRAME6RESERVED_POS (6)
  3219. #define BT_UART_MSG_FRAME6RESERVED_MSK \
  3220. (0x3 << BT_UART_MSG_FRAME6RESERVED_POS)
  3221. #define BT_UART_MSG_FRAME7SNIFFACTIVITY_POS (0)
  3222. #define BT_UART_MSG_FRAME7SNIFFACTIVITY_MSK \
  3223. (0x7 << BT_UART_MSG_FRAME7SNIFFACTIVITY_POS)
  3224. #define BT_UART_MSG_FRAME7PAGE_POS (3)
  3225. #define BT_UART_MSG_FRAME7PAGE_MSK \
  3226. (0x1 << BT_UART_MSG_FRAME7PAGE_POS)
  3227. #define BT_UART_MSG_FRAME7INQUIRY_POS (4)
  3228. #define BT_UART_MSG_FRAME7INQUIRY_MSK \
  3229. (0x1 << BT_UART_MSG_FRAME7INQUIRY_POS)
  3230. #define BT_UART_MSG_FRAME7CONNECTABLE_POS (5)
  3231. #define BT_UART_MSG_FRAME7CONNECTABLE_MSK \
  3232. (0x1 << BT_UART_MSG_FRAME7CONNECTABLE_POS)
  3233. #define BT_UART_MSG_FRAME7RESERVED_POS (6)
  3234. #define BT_UART_MSG_FRAME7RESERVED_MSK \
  3235. (0x3 << BT_UART_MSG_FRAME7RESERVED_POS)
  3236. /* BT Session Activity 2 UART message (BT -> WiFi) */
  3237. #define BT_UART_MSG_2_FRAME1RESERVED1_POS (5)
  3238. #define BT_UART_MSG_2_FRAME1RESERVED1_MSK \
  3239. (0x1<<BT_UART_MSG_2_FRAME1RESERVED1_POS)
  3240. #define BT_UART_MSG_2_FRAME1RESERVED2_POS (6)
  3241. #define BT_UART_MSG_2_FRAME1RESERVED2_MSK \
  3242. (0x3<<BT_UART_MSG_2_FRAME1RESERVED2_POS)
  3243. #define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS (0)
  3244. #define BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_MSK \
  3245. (0x3F<<BT_UART_MSG_2_FRAME2AGGTRAFFICLOAD_POS)
  3246. #define BT_UART_MSG_2_FRAME2RESERVED_POS (6)
  3247. #define BT_UART_MSG_2_FRAME2RESERVED_MSK \
  3248. (0x3<<BT_UART_MSG_2_FRAME2RESERVED_POS)
  3249. #define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS (0)
  3250. #define BT_UART_MSG_2_FRAME3BRLASTTXPOWER_MSK \
  3251. (0xF<<BT_UART_MSG_2_FRAME3BRLASTTXPOWER_POS)
  3252. #define BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS (4)
  3253. #define BT_UART_MSG_2_FRAME3INQPAGESRMODE_MSK \
  3254. (0x1<<BT_UART_MSG_2_FRAME3INQPAGESRMODE_POS)
  3255. #define BT_UART_MSG_2_FRAME3LEMASTER_POS (5)
  3256. #define BT_UART_MSG_2_FRAME3LEMASTER_MSK \
  3257. (0x1<<BT_UART_MSG_2_FRAME3LEMASTER_POS)
  3258. #define BT_UART_MSG_2_FRAME3RESERVED_POS (6)
  3259. #define BT_UART_MSG_2_FRAME3RESERVED_MSK \
  3260. (0x3<<BT_UART_MSG_2_FRAME3RESERVED_POS)
  3261. #define BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS (0)
  3262. #define BT_UART_MSG_2_FRAME4LELASTTXPOWER_MSK \
  3263. (0xF<<BT_UART_MSG_2_FRAME4LELASTTXPOWER_POS)
  3264. #define BT_UART_MSG_2_FRAME4NUMLECONN_POS (4)
  3265. #define BT_UART_MSG_2_FRAME4NUMLECONN_MSK \
  3266. (0x3<<BT_UART_MSG_2_FRAME4NUMLECONN_POS)
  3267. #define BT_UART_MSG_2_FRAME4RESERVED_POS (6)
  3268. #define BT_UART_MSG_2_FRAME4RESERVED_MSK \
  3269. (0x3<<BT_UART_MSG_2_FRAME4RESERVED_POS)
  3270. #define BT_UART_MSG_2_FRAME5BTMINRSSI_POS (0)
  3271. #define BT_UART_MSG_2_FRAME5BTMINRSSI_MSK \
  3272. (0xF<<BT_UART_MSG_2_FRAME5BTMINRSSI_POS)
  3273. #define BT_UART_MSG_2_FRAME5LESCANINITMODE_POS (4)
  3274. #define BT_UART_MSG_2_FRAME5LESCANINITMODE_MSK \
  3275. (0x1<<BT_UART_MSG_2_FRAME5LESCANINITMODE_POS)
  3276. #define BT_UART_MSG_2_FRAME5LEADVERMODE_POS (5)
  3277. #define BT_UART_MSG_2_FRAME5LEADVERMODE_MSK \
  3278. (0x1<<BT_UART_MSG_2_FRAME5LEADVERMODE_POS)
  3279. #define BT_UART_MSG_2_FRAME5RESERVED_POS (6)
  3280. #define BT_UART_MSG_2_FRAME5RESERVED_MSK \
  3281. (0x3<<BT_UART_MSG_2_FRAME5RESERVED_POS)
  3282. #define BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS (0)
  3283. #define BT_UART_MSG_2_FRAME6LECONNINTERVAL_MSK \
  3284. (0x1F<<BT_UART_MSG_2_FRAME6LECONNINTERVAL_POS)
  3285. #define BT_UART_MSG_2_FRAME6RFU_POS (5)
  3286. #define BT_UART_MSG_2_FRAME6RFU_MSK \
  3287. (0x1<<BT_UART_MSG_2_FRAME6RFU_POS)
  3288. #define BT_UART_MSG_2_FRAME6RESERVED_POS (6)
  3289. #define BT_UART_MSG_2_FRAME6RESERVED_MSK \
  3290. (0x3<<BT_UART_MSG_2_FRAME6RESERVED_POS)
  3291. #define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS (0)
  3292. #define BT_UART_MSG_2_FRAME7LECONNSLAVELAT_MSK \
  3293. (0x7<<BT_UART_MSG_2_FRAME7LECONNSLAVELAT_POS)
  3294. #define BT_UART_MSG_2_FRAME7LEPROFILE1_POS (3)
  3295. #define BT_UART_MSG_2_FRAME7LEPROFILE1_MSK \
  3296. (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE1_POS)
  3297. #define BT_UART_MSG_2_FRAME7LEPROFILE2_POS (4)
  3298. #define BT_UART_MSG_2_FRAME7LEPROFILE2_MSK \
  3299. (0x1<<BT_UART_MSG_2_FRAME7LEPROFILE2_POS)
  3300. #define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS (5)
  3301. #define BT_UART_MSG_2_FRAME7LEPROFILEOTHER_MSK \
  3302. (0x1<<BT_UART_MSG_2_FRAME7LEPROFILEOTHER_POS)
  3303. #define BT_UART_MSG_2_FRAME7RESERVED_POS (6)
  3304. #define BT_UART_MSG_2_FRAME7RESERVED_MSK \
  3305. (0x3<<BT_UART_MSG_2_FRAME7RESERVED_POS)
  3306. struct iwl_bt_uart_msg {
  3307. u8 header;
  3308. u8 frame1;
  3309. u8 frame2;
  3310. u8 frame3;
  3311. u8 frame4;
  3312. u8 frame5;
  3313. u8 frame6;
  3314. u8 frame7;
  3315. } __attribute__((packed));
  3316. struct iwl_bt_coex_profile_notif {
  3317. struct iwl_bt_uart_msg last_bt_uart_msg;
  3318. u8 bt_status; /* 0 - off, 1 - on */
  3319. u8 bt_traffic_load; /* 0 .. 3? */
  3320. u8 bt_ci_compliance; /* 0 - not complied, 1 - complied */
  3321. u8 reserved;
  3322. } __attribute__((packed));
  3323. #define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS 0
  3324. #define IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_MSK 0x1
  3325. #define IWL_BT_COEX_PRIO_TBL_PRIO_POS 1
  3326. #define IWL_BT_COEX_PRIO_TBL_PRIO_MASK 0x0e
  3327. #define IWL_BT_COEX_PRIO_TBL_RESERVED_POS 4
  3328. #define IWL_BT_COEX_PRIO_TBL_RESERVED_MASK 0xf0
  3329. #define IWL_BT_COEX_PRIO_TBL_PRIO_SHIFT 1
  3330. /*
  3331. * BT Coexistence Priority table
  3332. * REPLY_BT_COEX_PRIO_TABLE = 0xcc
  3333. */
  3334. enum bt_coex_prio_table_events {
  3335. BT_COEX_PRIO_TBL_EVT_INIT_CALIB1 = 0,
  3336. BT_COEX_PRIO_TBL_EVT_INIT_CALIB2 = 1,
  3337. BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW1 = 2,
  3338. BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_LOW2 = 3, /* DC calib */
  3339. BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH1 = 4,
  3340. BT_COEX_PRIO_TBL_EVT_PERIODIC_CALIB_HIGH2 = 5,
  3341. BT_COEX_PRIO_TBL_EVT_DTIM = 6,
  3342. BT_COEX_PRIO_TBL_EVT_SCAN52 = 7,
  3343. BT_COEX_PRIO_TBL_EVT_SCAN24 = 8,
  3344. BT_COEX_PRIO_TBL_EVT_RESERVED0 = 9,
  3345. BT_COEX_PRIO_TBL_EVT_RESERVED1 = 10,
  3346. BT_COEX_PRIO_TBL_EVT_RESERVED2 = 11,
  3347. BT_COEX_PRIO_TBL_EVT_RESERVED3 = 12,
  3348. BT_COEX_PRIO_TBL_EVT_RESERVED4 = 13,
  3349. BT_COEX_PRIO_TBL_EVT_RESERVED5 = 14,
  3350. BT_COEX_PRIO_TBL_EVT_RESERVED6 = 15,
  3351. /* BT_COEX_PRIO_TBL_EVT_MAX should always be last */
  3352. BT_COEX_PRIO_TBL_EVT_MAX,
  3353. };
  3354. enum bt_coex_prio_table_priorities {
  3355. BT_COEX_PRIO_TBL_DISABLED = 0,
  3356. BT_COEX_PRIO_TBL_PRIO_LOW = 1,
  3357. BT_COEX_PRIO_TBL_PRIO_HIGH = 2,
  3358. BT_COEX_PRIO_TBL_PRIO_BYPASS = 3,
  3359. BT_COEX_PRIO_TBL_PRIO_COEX_OFF = 4,
  3360. BT_COEX_PRIO_TBL_PRIO_COEX_ON = 5,
  3361. BT_COEX_PRIO_TBL_PRIO_RSRVD1 = 6,
  3362. BT_COEX_PRIO_TBL_PRIO_RSRVD2 = 7,
  3363. BT_COEX_PRIO_TBL_MAX,
  3364. };
  3365. struct iwl_bt_coex_prio_table_cmd {
  3366. u8 prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX];
  3367. } __attribute__((packed));
  3368. #define IWL_BT_COEX_ENV_CLOSE 0
  3369. #define IWL_BT_COEX_ENV_OPEN 1
  3370. /*
  3371. * BT Protection Envelope
  3372. * REPLY_BT_COEX_PROT_ENV = 0xcd
  3373. */
  3374. struct iwl_bt_coex_prot_env_cmd {
  3375. u8 action; /* 0 = closed, 1 = open */
  3376. u8 type; /* 0 .. 15 */
  3377. u8 reserved[2];
  3378. } __attribute__((packed));
  3379. /******************************************************************************
  3380. * (13)
  3381. * Union of all expected notifications/responses:
  3382. *
  3383. *****************************************************************************/
  3384. struct iwl_rx_packet {
  3385. /*
  3386. * The first 4 bytes of the RX frame header contain both the RX frame
  3387. * size and some flags.
  3388. * Bit fields:
  3389. * 31: flag flush RB request
  3390. * 30: flag ignore TC (terminal counter) request
  3391. * 29: flag fast IRQ request
  3392. * 28-14: Reserved
  3393. * 13-00: RX frame size
  3394. */
  3395. __le32 len_n_flags;
  3396. struct iwl_cmd_header hdr;
  3397. union {
  3398. struct iwl_alive_resp alive_frame;
  3399. struct iwl_spectrum_notification spectrum_notif;
  3400. struct iwl_csa_notification csa_notif;
  3401. struct iwl_error_resp err_resp;
  3402. struct iwl_card_state_notif card_state_notif;
  3403. struct iwl_add_sta_resp add_sta;
  3404. struct iwl_rem_sta_resp rem_sta;
  3405. struct iwl_sleep_notification sleep_notif;
  3406. struct iwl_spectrum_resp spectrum;
  3407. struct iwl_notif_statistics stats;
  3408. struct iwl_bt_notif_statistics stats_bt;
  3409. struct iwl_compressed_ba_resp compressed_ba;
  3410. struct iwl_missed_beacon_notif missed_beacon;
  3411. struct iwl_coex_medium_notification coex_medium_notif;
  3412. struct iwl_coex_event_resp coex_event;
  3413. struct iwl_bt_coex_profile_notif bt_coex_profile_notif;
  3414. __le32 status;
  3415. u8 raw[0];
  3416. } u;
  3417. } __packed;
  3418. int iwl_agn_check_rxon_cmd(struct iwl_priv *priv);
  3419. /*
  3420. * REPLY_WIPAN_PARAMS = 0xb2 (Commands and Notification)
  3421. */
  3422. /*
  3423. * Minimum slot time in TU
  3424. */
  3425. #define IWL_MIN_SLOT_TIME 20
  3426. /**
  3427. * struct iwl_wipan_slot
  3428. * @width: Time in TU
  3429. * @type:
  3430. * 0 - BSS
  3431. * 1 - PAN
  3432. */
  3433. struct iwl_wipan_slot {
  3434. __le16 width;
  3435. u8 type;
  3436. u8 reserved;
  3437. } __packed;
  3438. #define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_CTS BIT(1) /* reserved */
  3439. #define IWL_WIPAN_PARAMS_FLG_LEAVE_CHANNEL_QUIET BIT(2) /* reserved */
  3440. #define IWL_WIPAN_PARAMS_FLG_SLOTTED_MODE BIT(3) /* reserved */
  3441. #define IWL_WIPAN_PARAMS_FLG_FILTER_BEACON_NOTIF BIT(4)
  3442. #define IWL_WIPAN_PARAMS_FLG_FULL_SLOTTED_MODE BIT(5)
  3443. /**
  3444. * struct iwl_wipan_params_cmd
  3445. * @flags:
  3446. * bit0: reserved
  3447. * bit1: CP leave channel with CTS
  3448. * bit2: CP leave channel qith Quiet
  3449. * bit3: slotted mode
  3450. * 1 - work in slotted mode
  3451. * 0 - work in non slotted mode
  3452. * bit4: filter beacon notification
  3453. * bit5: full tx slotted mode. if this flag is set,
  3454. * uCode will perform leaving channel methods in context switch
  3455. * also when working in same channel mode
  3456. * @num_slots: 1 - 10
  3457. */
  3458. struct iwl_wipan_params_cmd {
  3459. __le16 flags;
  3460. u8 reserved;
  3461. u8 num_slots;
  3462. struct iwl_wipan_slot slots[10];
  3463. } __packed;
  3464. /*
  3465. * REPLY_WIPAN_P2P_CHANNEL_SWITCH = 0xb9
  3466. *
  3467. * TODO: Figure out what this is used for,
  3468. * it can only switch between 2.4 GHz
  3469. * channels!!
  3470. */
  3471. struct iwl_wipan_p2p_channel_switch_cmd {
  3472. __le16 channel;
  3473. __le16 reserved;
  3474. };
  3475. /*
  3476. * REPLY_WIPAN_NOA_NOTIFICATION = 0xbc
  3477. *
  3478. * This is used by the device to notify us of the
  3479. * NoA schedule it determined so we can forward it
  3480. * to userspace for inclusion in probe responses.
  3481. *
  3482. * In beacons, the NoA schedule is simply appended
  3483. * to the frame we give the device.
  3484. */
  3485. struct iwl_wipan_noa_descriptor {
  3486. u8 count;
  3487. __le32 duration;
  3488. __le32 interval;
  3489. __le32 starttime;
  3490. } __packed;
  3491. struct iwl_wipan_noa_attribute {
  3492. u8 id;
  3493. __le16 length;
  3494. u8 index;
  3495. u8 ct_window;
  3496. struct iwl_wipan_noa_descriptor descr0, descr1;
  3497. u8 reserved;
  3498. } __packed;
  3499. struct iwl_wipan_noa_notification {
  3500. u32 noa_active;
  3501. struct iwl_wipan_noa_attribute noa_attribute;
  3502. } __packed;
  3503. #endif /* __iwl_commands_h__ */