wbm_release_ring_rx.h 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101
  1. /*
  2. * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
  3. *
  4. * Permission to use, copy, modify, and/or distribute this software for any
  5. * purpose with or without fee is hereby granted, provided that the above
  6. * copyright notice and this permission notice appear in all copies.
  7. *
  8. * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9. * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10. * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11. * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12. * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13. * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14. * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15. */
  16. #ifndef _WBM_RELEASE_RING_RX_H_
  17. #define _WBM_RELEASE_RING_RX_H_
  18. #if !defined(__ASSEMBLER__)
  19. #endif
  20. #include "rx_msdu_desc_info.h"
  21. #include "rx_mpdu_desc_info.h"
  22. #include "buffer_addr_info.h"
  23. #define NUM_OF_DWORDS_WBM_RELEASE_RING_RX 8
  24. struct wbm_release_ring_rx {
  25. #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
  26. struct buffer_addr_info released_buff_or_desc_addr_info;
  27. uint32_t release_source_module : 3, // [2:0]
  28. bm_action : 3, // [5:3]
  29. buffer_or_desc_type : 3, // [8:6]
  30. first_msdu_index : 4, // [12:9]
  31. reserved_2a : 2, // [14:13]
  32. cache_id : 1, // [15:15]
  33. cookie_conversion_status : 1, // [16:16]
  34. rxdma_push_reason : 2, // [18:17]
  35. rxdma_error_code : 5, // [23:19]
  36. reo_push_reason : 2, // [25:24]
  37. reo_error_code : 5, // [30:26]
  38. wbm_internal_error : 1; // [31:31]
  39. struct rx_mpdu_desc_info rx_mpdu_desc_info_details;
  40. struct rx_msdu_desc_info rx_msdu_desc_info_details;
  41. uint32_t reserved_6a : 32; // [31:0]
  42. uint32_t reserved_7a : 20, // [19:0]
  43. ring_id : 8, // [27:20]
  44. looping_count : 4; // [31:28]
  45. #else
  46. struct buffer_addr_info released_buff_or_desc_addr_info;
  47. uint32_t wbm_internal_error : 1, // [31:31]
  48. reo_error_code : 5, // [30:26]
  49. reo_push_reason : 2, // [25:24]
  50. rxdma_error_code : 5, // [23:19]
  51. rxdma_push_reason : 2, // [18:17]
  52. cookie_conversion_status : 1, // [16:16]
  53. cache_id : 1, // [15:15]
  54. reserved_2a : 2, // [14:13]
  55. first_msdu_index : 4, // [12:9]
  56. buffer_or_desc_type : 3, // [8:6]
  57. bm_action : 3, // [5:3]
  58. release_source_module : 3; // [2:0]
  59. struct rx_mpdu_desc_info rx_mpdu_desc_info_details;
  60. struct rx_msdu_desc_info rx_msdu_desc_info_details;
  61. uint32_t reserved_6a : 32; // [31:0]
  62. uint32_t looping_count : 4, // [31:28]
  63. ring_id : 8, // [27:20]
  64. reserved_7a : 20; // [19:0]
  65. #endif
  66. };
  67. /* Description RELEASED_BUFF_OR_DESC_ADDR_INFO
  68. Consumer: WBM/SW/FW
  69. Producer: SW/TQM/RXDMA/REO/SWITCH
  70. Details of the physical address of the buffer or link descriptor
  71. that is being released. Note that within this descriptor,
  72. WBM will look at the 'owner' of the released buffer/descriptor
  73. and forward it to SW/FW is WBM is not the owner.
  74. */
  75. /* Description BUFFER_ADDR_31_0
  76. Address (lower 32 bits) of the MSDU buffer OR MSDU_EXTENSION
  77. descriptor OR Link Descriptor
  78. In case of 'NULL' pointer, this field is set to 0
  79. <legal all>
  80. */
  81. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET 0x00000000
  82. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_LSB 0
  83. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MSB 31
  84. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_31_0_MASK 0xffffffff
  85. /* Description BUFFER_ADDR_39_32
  86. Address (upper 8 bits) of the MSDU buffer OR MSDU_EXTENSION
  87. descriptor OR Link Descriptor
  88. In case of 'NULL' pointer, this field is set to 0
  89. <legal all>
  90. */
  91. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET 0x00000004
  92. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_LSB 0
  93. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MSB 7
  94. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_BUFFER_ADDR_39_32_MASK 0x000000ff
  95. /* Description RETURN_BUFFER_MANAGER
  96. Consumer: WBM
  97. Producer: SW/FW
  98. In case of 'NULL' pointer, this field is set to 0
  99. Indicates to which buffer manager the buffer OR MSDU_EXTENSION
  100. descriptor OR link descriptor that is being pointed to
  101. shall be returned after the frame has been processed. It
  102. is used by WBM for routing purposes.
  103. <enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
  104. to the WMB buffer idle list
  105. <enum 1 WBM_CHIP0_IDLE_DESC_LIST> This buffer shall be returned
  106. to the WBM idle link descriptor idle list, where the chip
  107. 0 WBM is chosen in case of a multi-chip config
  108. <enum 2 WBM_CHIP1_IDLE_DESC_LIST> This buffer shall be returned
  109. to the chip 1 WBM idle link descriptor idle list
  110. <enum 3 WBM_CHIP2_IDLE_DESC_LIST> This buffer shall be returned
  111. to the chip 2 WBM idle link descriptor idle list
  112. <enum 12 WBM_CHIP3_IDLE_DESC_LIST> This buffer shall be
  113. returned to chip 3 WBM idle link descriptor idle list
  114. <enum 4 FW_BM> This buffer shall be returned to the FW
  115. <enum 5 SW0_BM> This buffer shall be returned to the SW,
  116. ring 0
  117. <enum 6 SW1_BM> This buffer shall be returned to the SW,
  118. ring 1
  119. <enum 7 SW2_BM> This buffer shall be returned to the SW,
  120. ring 2
  121. <enum 8 SW3_BM> This buffer shall be returned to the SW,
  122. ring 3
  123. <enum 9 SW4_BM> This buffer shall be returned to the SW,
  124. ring 4
  125. <enum 10 SW5_BM> This buffer shall be returned to the SW,
  126. ring 5
  127. <enum 11 SW6_BM> This buffer shall be returned to the SW,
  128. ring 6
  129. <legal 0-12>
  130. */
  131. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET 0x00000004
  132. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB 8
  133. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MSB 11
  134. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK 0x00000f00
  135. /* Description SW_BUFFER_COOKIE
  136. Cookie field exclusively used by SW.
  137. In case of 'NULL' pointer, this field is set to 0
  138. HW ignores the contents, accept that it passes the programmed
  139. value on to other descriptors together with the physical
  140. address
  141. Field can be used by SW to for example associate the buffers
  142. physical address with the virtual address
  143. The bit definitions as used by SW are within SW HLD specification
  144. NOTE1:
  145. The three most significant bits can have a special meaning
  146. in case this struct is embedded in a TX_MPDU_DETAILS STRUCT,
  147. and field transmit_bw_restriction is set
  148. In case of NON punctured transmission:
  149. Sw_buffer_cookie[19:17] = 3'b000: 20 MHz TX only
  150. Sw_buffer_cookie[19:17] = 3'b001: 40 MHz TX only
  151. Sw_buffer_cookie[19:17] = 3'b010: 80 MHz TX only
  152. Sw_buffer_cookie[19:17] = 3'b011: 160 MHz TX only
  153. Sw_buffer_cookie[19:17] = 3'b101: 240 MHz TX only
  154. Sw_buffer_cookie[19:17] = 3'b100: 320 MHz TX only
  155. Sw_buffer_cookie[19:18] = 2'b11: reserved
  156. In case of punctured transmission:
  157. Sw_buffer_cookie[19:16] = 4'b0000: pattern 0 only
  158. Sw_buffer_cookie[19:16] = 4'b0001: pattern 1 only
  159. Sw_buffer_cookie[19:16] = 4'b0010: pattern 2 only
  160. Sw_buffer_cookie[19:16] = 4'b0011: pattern 3 only
  161. Sw_buffer_cookie[19:16] = 4'b0100: pattern 4 only
  162. Sw_buffer_cookie[19:16] = 4'b0101: pattern 5 only
  163. Sw_buffer_cookie[19:16] = 4'b0110: pattern 6 only
  164. Sw_buffer_cookie[19:16] = 4'b0111: pattern 7 only
  165. Sw_buffer_cookie[19:16] = 4'b1000: pattern 8 only
  166. Sw_buffer_cookie[19:16] = 4'b1001: pattern 9 only
  167. Sw_buffer_cookie[19:16] = 4'b1010: pattern 10 only
  168. Sw_buffer_cookie[19:16] = 4'b1011: pattern 11 only
  169. Sw_buffer_cookie[19:18] = 2'b11: reserved
  170. Note: a punctured transmission is indicated by the presence
  171. of TLV TX_PUNCTURE_SETUP embedded in the scheduler TLV
  172. <legal all>
  173. */
  174. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET 0x00000004
  175. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_LSB 12
  176. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MSB 31
  177. #define WBM_RELEASE_RING_RX_RELEASED_BUFF_OR_DESC_ADDR_INFO_SW_BUFFER_COOKIE_MASK 0xfffff000
  178. /* Description RELEASE_SOURCE_MODULE
  179. Indicates which module initiated the release of this buffer
  180. or descriptor
  181. <enum 1 release_source_RXDMA> RXDMA released this buffer
  182. or descriptor
  183. <enum 2 release_source_REO> REO released this buffer or
  184. descriptor
  185. <enum 5 release_source_FW_RX> FW released this buffer or
  186. descriptor
  187. <enum 4 release_source_SW_RX> SW released this buffer or
  188. descriptor
  189. <enum 0 release_source_TQM> DO NOT USE
  190. <enum 3 release_source_FW_TX> DO NOT USE
  191. <enum 6 release_source_SW_TX> DO NOT USE
  192. <legal 0-6>
  193. */
  194. #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_OFFSET 0x00000008
  195. #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_LSB 0
  196. #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_MSB 2
  197. #define WBM_RELEASE_RING_RX_RELEASE_SOURCE_MODULE_MASK 0x00000007
  198. /* Description BM_ACTION
  199. Consumer: WBM/SW/FW
  200. Producer: SW/TQM/RXDMA/REO/SWITCH
  201. Field only valid when the field return_buffer_manager in
  202. the Released_buff_or_desc_addr_info indicates:
  203. WBM_IDLE_BUF_LIST or
  204. WBM_IDLE_DESC_LIST
  205. An MSDU extension descriptor shall never be marked as WBM
  206. being the 'owner', and thus WBM will forward it to FW/SW
  207. <enum 0 Put_in_idle_list> Put the buffer or descriptor back
  208. in the idle list. In case of MSDU or MDPU link descriptor,
  209. BM does not need to check to release any individual MSDU
  210. buffers
  211. <enum 1 release_msdu_list > This BM action can only be used
  212. in combination with buffer_or_desc_type being msdu_link_descriptor.
  213. Field first_msdu_index points out which MSDU pointer in
  214. the MSDU link descriptor is the first of an MPDU that is
  215. released.
  216. BM shall release all the MSDU buffers linked to this first
  217. MSDU buffer pointer. All related MSDU buffer pointer entries
  218. shall be set to value 0, which represents the 'NULL" pointer.
  219. When all MSDU buffer pointers in the MSDU link descriptor
  220. are 'NULL', the MSDU link descriptor itself shall also
  221. be released.
  222. <enum 2 Put_in_idle_list_expanded> CURRENTLY NOT IMPLEMENTED....
  223. Put the buffer or descriptor back in the idle list. Only
  224. valid in combination with buffer_or_desc_type indicating
  225. MDPU_link_descriptor.
  226. BM shall release the MPDU link descriptor as well as all
  227. MSDUs that are linked to the MPDUs in this descriptor.
  228. TODO: Any restrictions?
  229. <legal 0-2>
  230. */
  231. #define WBM_RELEASE_RING_RX_BM_ACTION_OFFSET 0x00000008
  232. #define WBM_RELEASE_RING_RX_BM_ACTION_LSB 3
  233. #define WBM_RELEASE_RING_RX_BM_ACTION_MSB 5
  234. #define WBM_RELEASE_RING_RX_BM_ACTION_MASK 0x00000038
  235. /* Description BUFFER_OR_DESC_TYPE
  236. Consumer: WBM/SW/FW
  237. Producer: SW/TQM/RXDMA/REO/SWITCH
  238. Field only valid when WBM is marked as the return_buffer_manager
  239. in the Released_Buffer_address_info
  240. Indicates that type of buffer or descriptor is being released
  241. <enum 0 MSDU_rel_buffer> The address points to an MSDU buffer
  242. <enum 1 msdu_link_descriptor> The address points to an TX
  243. MSDU link descriptor
  244. <enum 2 mpdu_link_descriptor> The address points to an MPDU
  245. link descriptor
  246. <enum 3 msdu_ext_descriptor > The address points to an MSDU
  247. extension descriptor.
  248. In case BM finds this one in a release ring, it passes it
  249. on to FW...
  250. <enum 4 queue_ext_descriptor> The address points to an TQM
  251. queue extension descriptor. WBM should treat this is the
  252. same way as a link descriptor. That is, put the 128 byte
  253. buffer back in the link buffer idle list.
  254. TODO: Any restrictions?
  255. <legal 0-4>
  256. */
  257. #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_OFFSET 0x00000008
  258. #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_LSB 6
  259. #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_MSB 8
  260. #define WBM_RELEASE_RING_RX_BUFFER_OR_DESC_TYPE_MASK 0x000001c0
  261. /* Description FIRST_MSDU_INDEX
  262. Consumer: WBM/SW/FW
  263. Producer: SW/TQM/RXDMA/REO/SWITCH
  264. Field only valid for the bm_action release_msdu_list.
  265. The index of the first MSDU in an MSDU link descriptor all
  266. belonging to the same MPDU.
  267. TODO: Any restrictions?
  268. <legal 0-6>
  269. */
  270. #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_OFFSET 0x00000008
  271. #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_LSB 9
  272. #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_MSB 12
  273. #define WBM_RELEASE_RING_RX_FIRST_MSDU_INDEX_MASK 0x00001e00
  274. /* Description RESERVED_2A
  275. <legal 0>
  276. */
  277. #define WBM_RELEASE_RING_RX_RESERVED_2A_OFFSET 0x00000008
  278. #define WBM_RELEASE_RING_RX_RESERVED_2A_LSB 13
  279. #define WBM_RELEASE_RING_RX_RESERVED_2A_MSB 14
  280. #define WBM_RELEASE_RING_RX_RESERVED_2A_MASK 0x00006000
  281. /* Description CACHE_ID
  282. Indicates the WBM cache the MSDU was released from
  283. <legal all>
  284. */
  285. #define WBM_RELEASE_RING_RX_CACHE_ID_OFFSET 0x00000008
  286. #define WBM_RELEASE_RING_RX_CACHE_ID_LSB 15
  287. #define WBM_RELEASE_RING_RX_CACHE_ID_MSB 15
  288. #define WBM_RELEASE_RING_RX_CACHE_ID_MASK 0x00008000
  289. /* Description COOKIE_CONVERSION_STATUS
  290. 0: 'Sw_buffer_cookie' not converted to 'Buffer_virt_addr'
  291. 1: 'Sw_buffer_cookie' coverted to 'Buffer_virt_addr'
  292. <legal 0>
  293. */
  294. #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_OFFSET 0x00000008
  295. #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_LSB 16
  296. #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_MSB 16
  297. #define WBM_RELEASE_RING_RX_COOKIE_CONVERSION_STATUS_MASK 0x00010000
  298. /* Description RXDMA_PUSH_REASON
  299. Field only valid when Release_source_module is set to release_source_RXDMA
  300. Indicates why rxdma pushed the frame to this ring
  301. <enum 0 rxdma_error_detected> RXDMA detected an error an
  302. pushed this frame to this queue
  303. <enum 1 rxdma_routing_instruction> RXDMA pushed the frame
  304. to this queue per received routing instructions. No error
  305. within RXDMA was detected
  306. <enum 2 rxdma_rx_flush> RXDMA received an RX_FLUSH. As a
  307. result the MSDU link descriptor might not have the "last_msdu_in_mpdu_flag"
  308. set, but instead WBM might just see a NULL pointer in the
  309. MSDU link descriptor. This is to be considered a normal
  310. condition for this scenario.
  311. <legal 0 - 2>
  312. */
  313. #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_OFFSET 0x00000008
  314. #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_LSB 17
  315. #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_MSB 18
  316. #define WBM_RELEASE_RING_RX_RXDMA_PUSH_REASON_MASK 0x00060000
  317. #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_OFFSET 0x00000008
  318. #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_LSB 19
  319. #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_MSB 23
  320. #define WBM_RELEASE_RING_RX_RXDMA_ERROR_CODE_MASK 0x00f80000
  321. /* Description REO_PUSH_REASON
  322. Field only valid when Release_source_module is set to release_source_REO
  323. Indicates why REO pushed the frame to this release ring
  324. <enum 0 reo_error_detected> Reo detected an error an pushed
  325. this frame to this queue
  326. <enum 1 reo_routing_instruction> Reo pushed the frame to
  327. this queue per received routing instructions. No error
  328. within REO was detected
  329. <legal 0 - 1>
  330. */
  331. #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_OFFSET 0x00000008
  332. #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_LSB 24
  333. #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_MSB 25
  334. #define WBM_RELEASE_RING_RX_REO_PUSH_REASON_MASK 0x03000000
  335. /* Description REO_ERROR_CODE
  336. Field only valid when 'Reo_push_reason' set to 'reo_error_detected'.
  337. <enum 0 reo_queue_desc_addr_zero> Reo queue descriptor provided
  338. in the REO_ENTRANCE ring is set to 0
  339. <enum 1 reo_queue_desc_not_valid> Reo queue descriptor valid
  340. bit is NOT set
  341. <enum 2 ampdu_in_non_ba> AMPDU frame received without BA
  342. session having been setup.
  343. <enum 3 non_ba_duplicate> Non-BA session, SN equal to SSN,
  344. Retry bit set: duplicate frame
  345. <enum 4 ba_duplicate> BA session, duplicate frame
  346. <enum 5 regular_frame_2k_jump> A normal (management/data
  347. frame) received with 2K jump in SN
  348. <enum 6 bar_frame_2k_jump> A bar received with 2K jump in
  349. SSN
  350. <enum 7 regular_frame_OOR> A normal (management/data frame)
  351. received with SN falling within the OOR window
  352. <enum 8 bar_frame_OOR> A bar received with SSN falling within
  353. the OOR window
  354. <enum 9 bar_frame_no_ba_session> A bar received without
  355. a BA session
  356. <enum 10 bar_frame_sn_equals_ssn> A bar received with SSN
  357. equal to SN
  358. <enum 11 pn_check_failed> PN Check Failed packet.
  359. <enum 12 2k_error_handling_flag_set> Frame is forwarded
  360. as a result of the 'Seq_2k_error_detected_flag' been set
  361. in the REO Queue descriptor
  362. <enum 13 pn_error_handling_flag_set> Frame is forwarded
  363. as a result of the 'pn_error_detected_flag' been set in
  364. the REO Queue descriptor
  365. <enum 14 queue_descriptor_blocked_set> Frame is forwarded
  366. as a result of the queue descriptor(address) being blocked
  367. as SW/FW seems to be currently in the process of making
  368. updates to this descriptor...
  369. <legal 0-14>
  370. */
  371. #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_OFFSET 0x00000008
  372. #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_LSB 26
  373. #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_MSB 30
  374. #define WBM_RELEASE_RING_RX_REO_ERROR_CODE_MASK 0x7c000000
  375. /* Description WBM_INTERNAL_ERROR
  376. Can only be set by WBM.
  377. Is set when WBM got a buffer pointer but the action was
  378. to push it to the idle link descriptor ring or do link related
  379. activity
  380. OR
  381. Is set when WBM got a link buffer pointer but the action
  382. was to push it to the buffer descriptor ring
  383. <legal all>
  384. */
  385. #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_OFFSET 0x00000008
  386. #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_LSB 31
  387. #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_MSB 31
  388. #define WBM_RELEASE_RING_RX_WBM_INTERNAL_ERROR_MASK 0x80000000
  389. /* Description RX_MPDU_DESC_INFO_DETAILS
  390. Consumer: REO/SW/FW
  391. Producer: RXDMA
  392. General information related to the MPDU whose link descriptors
  393. are being released from Rx DMA or REO
  394. When enabled in REO, REO will overwrite this structure to
  395. have only the 'Msdu_count' field and 56 bits of the previous
  396. PN from 'RX_REO_QUEUE'
  397. */
  398. /* Description MSDU_COUNT
  399. Consumer: REO/SW/FW
  400. Producer: RXDMA
  401. The number of MSDUs within the MPDU
  402. <legal all>
  403. */
  404. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_OFFSET 0x0000000c
  405. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_LSB 0
  406. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MSB 7
  407. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MSDU_COUNT_MASK 0x000000ff
  408. /* Description FRAGMENT_FLAG
  409. Consumer: REO/SW/FW
  410. Producer: RXDMA
  411. When set, this MPDU is a fragment and REO should forward
  412. this fragment MPDU to the REO destination ring without
  413. any reorder checks, pn checks or bitmap update. This implies
  414. that REO is forwarding the pointer to the MSDU link descriptor.
  415. The destination ring is coming from a programmable register
  416. setting in REO
  417. <legal all>
  418. */
  419. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_OFFSET 0x0000000c
  420. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_LSB 8
  421. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MSB 8
  422. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_FRAGMENT_FLAG_MASK 0x00000100
  423. /* Description MPDU_RETRY_BIT
  424. Consumer: REO/SW/FW
  425. Producer: RXDMA
  426. The retry bit setting from the MPDU header of the received
  427. frame
  428. <legal all>
  429. */
  430. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_OFFSET 0x0000000c
  431. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_LSB 9
  432. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MSB 9
  433. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_RETRY_BIT_MASK 0x00000200
  434. /* Description AMPDU_FLAG
  435. Consumer: REO/SW/FW
  436. Producer: RXDMA
  437. When set, the MPDU was received as part of an A-MPDU.
  438. <legal all>
  439. */
  440. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_OFFSET 0x0000000c
  441. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_LSB 10
  442. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MSB 10
  443. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_AMPDU_FLAG_MASK 0x00000400
  444. /* Description BAR_FRAME
  445. Consumer: REO/SW/FW
  446. Producer: RXDMA
  447. When set, the received frame is a BAR frame. After processing,
  448. this frame shall be pushed to SW or deleted.
  449. <legal all>
  450. */
  451. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_OFFSET 0x0000000c
  452. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_LSB 11
  453. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MSB 11
  454. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_BAR_FRAME_MASK 0x00000800
  455. /* Description PN_FIELDS_CONTAIN_VALID_INFO
  456. Consumer: REO/SW/FW
  457. Producer: RXDMA
  458. Copied here by RXDMA from RX_MPDU_END
  459. When not set, REO will Not perform a PN sequence number
  460. check
  461. */
  462. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET 0x0000000c
  463. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_LSB 12
  464. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MSB 12
  465. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PN_FIELDS_CONTAIN_VALID_INFO_MASK 0x00001000
  466. /* Description RAW_MPDU
  467. Field only valid when first_msdu_in_mpdu_flag is set.
  468. When set, the contents in the MSDU buffer contains a 'RAW'
  469. MPDU. This 'RAW' MPDU might be spread out over multiple
  470. MSDU buffers.
  471. <legal all>
  472. */
  473. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_OFFSET 0x0000000c
  474. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_LSB 13
  475. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MSB 13
  476. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_RAW_MPDU_MASK 0x00002000
  477. /* Description MORE_FRAGMENT_FLAG
  478. The More Fragment bit setting from the MPDU header of the
  479. received frame
  480. <legal all>
  481. */
  482. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_OFFSET 0x0000000c
  483. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_LSB 14
  484. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MSB 14
  485. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MORE_FRAGMENT_FLAG_MASK 0x00004000
  486. /* Description SRC_INFO
  487. Source (virtual) device/interface info. associated with
  488. this peer
  489. This field gets passed on by REO to PPE in the EDMA descriptor
  490. ('REO_TO_PPE_RING').
  491. <legal all>
  492. */
  493. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_OFFSET 0x0000000c
  494. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_LSB 15
  495. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_MSB 26
  496. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_SRC_INFO_MASK 0x07ff8000
  497. /* Description MPDU_QOS_CONTROL_VALID
  498. When set, the MPDU has a QoS control field.
  499. In case of ndp or phy_err, this field will never be set.
  500. <legal all>
  501. */
  502. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_OFFSET 0x0000000c
  503. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_LSB 27
  504. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_MSB 27
  505. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_MPDU_QOS_CONTROL_VALID_MASK 0x08000000
  506. /* Description TID
  507. Field only valid when mpdu_qos_control_valid is set
  508. The TID field in the QoS control field
  509. <legal all>
  510. */
  511. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_OFFSET 0x0000000c
  512. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_LSB 28
  513. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_MSB 31
  514. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_TID_MASK 0xf0000000
  515. /* Description PEER_META_DATA
  516. Meta data that SW has programmed in the Peer table entry
  517. of the transmitting STA.
  518. <legal all>
  519. */
  520. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_OFFSET 0x00000010
  521. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_LSB 0
  522. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MSB 31
  523. #define WBM_RELEASE_RING_RX_RX_MPDU_DESC_INFO_DETAILS_PEER_META_DATA_MASK 0xffffffff
  524. /* Description RX_MSDU_DESC_INFO_DETAILS
  525. Consumer: TQM/SW
  526. Producer: SW/SCH(from TXPCU, PDG) /WBM (from RXDMA)
  527. In case of RXDMA or REO releasing Rx MSDU link descriptors,'
  528. WBM fills this field with Rx_msdu_desc_info_details when
  529. releasing the MSDUs to SW.
  530. */
  531. /* Description FIRST_MSDU_IN_MPDU_FLAG
  532. Parsed from RX_MSDU_END TLV . In the case MSDU spans over
  533. multiple buffers, this field will be valid in the Last
  534. buffer used by the MSDU
  535. <enum 0 Not_first_msdu> This is not the first MSDU in the
  536. MPDU.
  537. <enum 1 first_msdu> This MSDU is the first one in the MPDU.
  538. <legal all>
  539. */
  540. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000014
  541. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_LSB 0
  542. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_MSB 0
  543. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FIRST_MSDU_IN_MPDU_FLAG_MASK 0x00000001
  544. /* Description LAST_MSDU_IN_MPDU_FLAG
  545. Consumer: WBM/REO/SW/FW
  546. Producer: RXDMA
  547. Parsed from RX_MSDU_END TLV . In the case MSDU spans over
  548. multiple buffers, this field will be valid in the Last
  549. buffer used by the MSDU
  550. <enum 0 Not_last_msdu> There are more MSDUs linked to this
  551. MSDU that belongs to this MPDU
  552. <enum 1 Last_msdu> this MSDU is the last one in the MPDU.
  553. This setting is only allowed in combination with 'Msdu_continuation'
  554. set to 0. This implies that when an msdu is spread out over
  555. multiple buffers and thus msdu_continuation is set, only
  556. for the very last buffer of the msdu, can the 'last_msdu_in_mpdu_flag'
  557. be set.
  558. When both first_msdu_in_mpdu_flag and last_msdu_in_mpdu_flag
  559. are set, the MPDU that this MSDU belongs to only contains
  560. a single MSDU.
  561. <legal all>
  562. */
  563. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000014
  564. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_LSB 1
  565. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_MSB 1
  566. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_LAST_MSDU_IN_MPDU_FLAG_MASK 0x00000002
  567. /* Description MSDU_CONTINUATION
  568. When set, this MSDU buffer was not able to hold the entire
  569. MSDU. The next buffer will therefor contain additional
  570. information related to this MSDU.
  571. <legal all>
  572. */
  573. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_OFFSET 0x00000014
  574. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_LSB 2
  575. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_MSB 2
  576. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_CONTINUATION_MASK 0x00000004
  577. /* Description MSDU_LENGTH
  578. Parsed from RX_MSDU_START TLV . In the case MSDU spans over
  579. multiple buffers, this field will be valid in the First
  580. buffer used by MSDU.
  581. Full MSDU length in bytes after decapsulation.
  582. This field is still valid for MPDU frames without A-MSDU.
  583. It still represents MSDU length after decapsulation
  584. Or in case of RAW MPDUs, it indicates the length of the
  585. entire MPDU (without FCS field)
  586. <legal all>
  587. */
  588. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_OFFSET 0x00000014
  589. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_LSB 3
  590. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_MSB 16
  591. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_LENGTH_MASK 0x0001fff8
  592. /* Description MSDU_DROP
  593. Parsed from RX_MSDU_END TLV . In the case MSDU spans over
  594. multiple buffers, this field will be valid in the Last
  595. buffer used by the MSDU
  596. When set, REO shall drop this MSDU and not forward it to
  597. any other ring...
  598. <legal all>
  599. */
  600. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_OFFSET 0x00000014
  601. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_LSB 17
  602. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_MSB 17
  603. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_MSDU_DROP_MASK 0x00020000
  604. /* Description SA_IS_VALID
  605. Parsed from RX_MSDU_END TLV . In the case MSDU spans over
  606. multiple buffers, this field will be valid in the Last
  607. buffer used by the MSDU
  608. Indicates that OLE found a valid SA entry for this MSDU
  609. <legal all>
  610. */
  611. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_OFFSET 0x00000014
  612. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_LSB 18
  613. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_MSB 18
  614. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_SA_IS_VALID_MASK 0x00040000
  615. /* Description DA_IS_VALID
  616. Parsed from RX_MSDU_END TLV . In the case MSDU spans over
  617. multiple buffers, this field will be valid in the Last
  618. buffer used by the MSDU
  619. Indicates that OLE found a valid DA entry for this MSDU
  620. <legal all>
  621. */
  622. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_OFFSET 0x00000014
  623. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_LSB 19
  624. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_MSB 19
  625. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_VALID_MASK 0x00080000
  626. /* Description DA_IS_MCBC
  627. Field Only valid if "da_is_valid" is set
  628. Indicates the DA address was a Multicast of Broadcast address
  629. for this MSDU
  630. <legal all>
  631. */
  632. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_OFFSET 0x00000014
  633. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_LSB 20
  634. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_MSB 20
  635. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DA_IS_MCBC_MASK 0x00100000
  636. /* Description L3_HEADER_PADDING_MSB
  637. Passed on from 'RX_MSDU_END' TLV (only the MSB is reported
  638. as the LSB is always zero)
  639. Number of bytes padded to make sure that the L3 header will
  640. always start of a Dword boundary
  641. <legal all>
  642. */
  643. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_OFFSET 0x00000014
  644. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_LSB 21
  645. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_MSB 21
  646. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_L3_HEADER_PADDING_MSB_MASK 0x00200000
  647. /* Description TCP_UDP_CHKSUM_FAIL
  648. Passed on from 'RX_ATTENTION' TLV
  649. Indicates that the computed checksum did not match the checksum
  650. in the TCP/UDP header.
  651. <legal all>
  652. */
  653. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_OFFSET 0x00000014
  654. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_LSB 22
  655. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_MSB 22
  656. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TCP_UDP_CHKSUM_FAIL_MASK 0x00400000
  657. /* Description IP_CHKSUM_FAIL
  658. Passed on from 'RX_ATTENTION' TLV
  659. Indicates that the computed checksum did not match the checksum
  660. in the IP header.
  661. <legal all>
  662. */
  663. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_OFFSET 0x00000014
  664. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_LSB 23
  665. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_MSB 23
  666. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_IP_CHKSUM_FAIL_MASK 0x00800000
  667. /* Description FR_DS
  668. Passed on from 'RX_MPDU_INFO' structure in 'RX_MPDU_START'
  669. TLV
  670. Set if the 'from DS' bit is set in the frame control.
  671. <legal all>
  672. */
  673. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_OFFSET 0x00000014
  674. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_LSB 24
  675. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_MSB 24
  676. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_FR_DS_MASK 0x01000000
  677. /* Description TO_DS
  678. Passed on from 'RX_MPDU_INFO' structure in 'RX_MPDU_START'
  679. TLV
  680. Set if the 'to DS' bit is set in the frame control.
  681. <legal all>
  682. */
  683. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_OFFSET 0x00000014
  684. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_LSB 25
  685. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_MSB 25
  686. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_TO_DS_MASK 0x02000000
  687. /* Description INTRA_BSS
  688. This packet needs intra-BSS routing by SW as the 'vdev_id'
  689. for the destination is the same as the 'vdev_id' (from 'RX_MPDU_PCU_START')
  690. that this MSDU was got in.
  691. <legal all>
  692. */
  693. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_OFFSET 0x00000014
  694. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_LSB 26
  695. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_MSB 26
  696. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_INTRA_BSS_MASK 0x04000000
  697. /* Description DEST_CHIP_ID
  698. If intra_bss is set, copied by RXOLE/RXDMA from 'ADDR_SEARCH_ENTRY'
  699. to support intra-BSS routing with multi-chip multi-link
  700. operation.
  701. This indicates into which chip's TCL the packet should be
  702. queued.
  703. <legal all>
  704. */
  705. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_OFFSET 0x00000014
  706. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_LSB 27
  707. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_MSB 28
  708. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_ID_MASK 0x18000000
  709. /* Description DECAP_FORMAT
  710. Indicates the format after decapsulation:
  711. <enum 0 RAW> No encapsulation
  712. <enum 1 Native_WiFi>
  713. <enum 2 Ethernet> Ethernet 2 (DIX) or 802.3 (uses SNAP/LLC)
  714. <enum 3 802_3> Indicate Ethernet
  715. <legal all>
  716. */
  717. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_OFFSET 0x00000014
  718. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_LSB 29
  719. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_MSB 30
  720. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DECAP_FORMAT_MASK 0x60000000
  721. /* Description DEST_CHIP_PMAC_ID
  722. If intra_bss is set, copied by RXOLE/RXDMA from 'ADDR_SEARCH_ENTRY'
  723. to support intra-BSS routing with multi-chip multi-link
  724. operation.
  725. This indicates into which link/'vdev' the packet should
  726. be queued in TCL.
  727. <legal all>
  728. */
  729. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_OFFSET 0x00000014
  730. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_LSB 31
  731. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_MSB 31
  732. #define WBM_RELEASE_RING_RX_RX_MSDU_DESC_INFO_DETAILS_DEST_CHIP_PMAC_ID_MASK 0x80000000
  733. /* Description RESERVED_6A
  734. <legal 0>
  735. */
  736. #define WBM_RELEASE_RING_RX_RESERVED_6A_OFFSET 0x00000018
  737. #define WBM_RELEASE_RING_RX_RESERVED_6A_LSB 0
  738. #define WBM_RELEASE_RING_RX_RESERVED_6A_MSB 31
  739. #define WBM_RELEASE_RING_RX_RESERVED_6A_MASK 0xffffffff
  740. /* Description RESERVED_7A
  741. For debugging, RXDMA and REO may fill the Rx MPDU sequence
  742. number in bits [11:0] and WBM may copy over when it releases
  743. Rx MSDUs.
  744. <legal 0-4095>
  745. */
  746. #define WBM_RELEASE_RING_RX_RESERVED_7A_OFFSET 0x0000001c
  747. #define WBM_RELEASE_RING_RX_RESERVED_7A_LSB 0
  748. #define WBM_RELEASE_RING_RX_RESERVED_7A_MSB 19
  749. #define WBM_RELEASE_RING_RX_RESERVED_7A_MASK 0x000fffff
  750. /* Description RING_ID
  751. Consumer: TQM/REO/RXDMA/SW
  752. Producer: SRNG (of RXDMA)
  753. For debugging.
  754. This field is filled in by the SRNG module.
  755. It help to identify the ring that is being looked <legal
  756. all>
  757. */
  758. #define WBM_RELEASE_RING_RX_RING_ID_OFFSET 0x0000001c
  759. #define WBM_RELEASE_RING_RX_RING_ID_LSB 20
  760. #define WBM_RELEASE_RING_RX_RING_ID_MSB 27
  761. #define WBM_RELEASE_RING_RX_RING_ID_MASK 0x0ff00000
  762. /* Description LOOPING_COUNT
  763. Consumer: WBM/SW/FW
  764. Producer: SW/TQM/RXDMA/REO/SWITCH
  765. If WBM_internal_error is set, this descriptor is sent to
  766. the dedicated 'WBM_ERROR_RELEASE' ring and Looping_count
  767. is used to indicate an error code.
  768. The values reported are documented further in the WBM MLD
  769. doc.
  770. If WBM_internal_error is not set, the following holds.
  771. A count value that indicates the number of times the producer
  772. of entries into the Buffer Manager Ring has looped around
  773. the ring.
  774. At initialization time, this value is set to 0. On the first
  775. loop, this value is set to 1. After the max value is reached
  776. allowed by the number of bits for this field, the count
  777. value continues with 0 again.
  778. In case SW is the consumer of the ring entries, it can use
  779. this field to figure out up to where the producer of entries
  780. has created new entries. This eliminates the need to check
  781. where the "head pointer' of the ring is located once the
  782. SW starts processing an interrupt indicating that new entries
  783. have been put into this ring...
  784. Also note that SW if it wants only needs to look at the
  785. LSB bit of this count value.
  786. <legal all>
  787. */
  788. #define WBM_RELEASE_RING_RX_LOOPING_COUNT_OFFSET 0x0000001c
  789. #define WBM_RELEASE_RING_RX_LOOPING_COUNT_LSB 28
  790. #define WBM_RELEASE_RING_RX_LOOPING_COUNT_MSB 31
  791. #define WBM_RELEASE_RING_RX_LOOPING_COUNT_MASK 0xf0000000
  792. #endif // WBM_RELEASE_RING_RX