PageRenderTime 24ms CodeModel.GetById 36ms RepoModel.GetById 1ms app.codeStats 0ms

/drivers/net/wireless/bcmdhd_b1/src/include/wlfc_proto.h

https://bitbucket.org/cyanogenmod/lge-kernel-iproj
C Header | 216 lines | 101 code | 38 blank | 77 comment | 4 complexity | 632219a4683daa4aa7597da208f55057 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.0, AGPL-1.0 
    

  1. /*
    2. 

  2. * Copyright (C) 1999-2012, Broadcom Corporation
    3. 

  3. * 
    4. 

  4. *      Unless you and Broadcom execute a separate written software license
    5. 

  5. * agreement governing use of this software, this software is licensed to you
    6. 

  6. * under the terms of the GNU General Public License version 2 (the "GPL"),
    7. 

  7. * available at http://www.broadcom.com/licenses/GPLv2.php, with the
    8. 

  8. * following added to such license:
    9. 

  9. * 
    10. 

  10. *      As a special exception, the copyright holders of this software give you
    11. 

  11. * permission to link this software with independent modules, and to copy and
    12. 

  12. * distribute the resulting executable under terms of your choice, provided that
    13. 

  13. * you also meet, for each linked independent module, the terms and conditions of
    14. 

  14. * the license of that module.  An independent module is a module which is not
    15. 

  15. * derived from this software.  The special exception does not apply to any
    16. 

  16. * modifications of the software.
    17. 

  17. * 
    18. 

  18. *      Notwithstanding the above, under no circumstances may you combine this
    19. 

  19. * software in any way with any other Broadcom software provided under a license
    20. 

  20. * other than the GPL, without Broadcom's express prior written consent.
    21. 

  21. * $Id: wlfc_proto.h 309193 2012-01-19 00:03:57Z $
    22. 

  22. *
    23. 

  23. */
    24. 

  24. #ifndef __wlfc_proto_definitions_h__
    25. 

  25. #define __wlfc_proto_definitions_h__
    26. 

  26. 

  27. 	/* Use TLV to convey WLFC information.
    28. 

  28. 	 ---------------------------------------------------------------------------
    29. 

  29. 	| Type |  Len | value                    | Description
    30. 

  30. 	 ---------------------------------------------------------------------------
    31. 

  31. 	|  1   |   1  | (handle)                 | MAC OPEN
    32. 

  32. 	 ---------------------------------------------------------------------------
    33. 

  33. 	|  2   |   1  | (handle)                 | MAC CLOSE
    34. 

  34. 	 ---------------------------------------------------------------------------
    35. 

  35. 	|  3   |   2  | (count, handle, prec_bmp)| Set the credit depth for a MAC dstn
    36. 

  36. 	 ---------------------------------------------------------------------------
    37. 

  37. 	|  4   |   4  | see pkttag comments      | TXSTATUS
    38. 

  38. 	 ---------------------------------------------------------------------------
    39. 

  39. 	|  5   |   4  | see pkttag comments      | PKKTTAG [host->firmware]
    40. 

  40. 	 ---------------------------------------------------------------------------
    41. 

  41. 	|  6   |   8  | (handle, ifid, MAC)      | MAC ADD
    42. 

  42. 	 ---------------------------------------------------------------------------
    43. 

  43. 	|  7   |   8  | (handle, ifid, MAC)      | MAC DEL
    44. 

  44. 	 ---------------------------------------------------------------------------
    45. 

  45. 	|  8   |   1  | (rssi)                   | RSSI - RSSI value for the packet.
    46. 

  46. 	 ---------------------------------------------------------------------------
    47. 

  47. 	|  9   |   1  | (interface ID)           | Interface OPEN
    48. 

  48. 	 ---------------------------------------------------------------------------
    49. 

  49. 	|  10  |   1  | (interface ID)           | Interface CLOSE
    50. 

  50. 	 ---------------------------------------------------------------------------
    51. 

  51. 	|  11  |   8  | fifo credit returns map  | FIFO credits back to the host
    52. 

  52. 	|      |      |                          |
    53. 

  53. 	|      |      |                          | --------------------------------------
    54. 

  54. 	|      |      |                          | | ac0 | ac1 | ac2 | ac3 | bcmc | atim |
    55. 

  55. 	|      |      |                          | --------------------------------------
    56. 

  56. 	|      |      |                          |
    57. 

  57. 	 ---------------------------------------------------------------------------
    58. 

  58. 	|  12  |   2  | MAC handle,              | Host provides a bitmap of pending
    59. 

  59. 	|      |      | AC[0-3] traffic bitmap   | unicast traffic for MAC-handle dstn.
    60. 

  60. 	|      |      |                          | [host->firmware]
    61. 

  61. 	 ---------------------------------------------------------------------------
    62. 

  62. 	|  13  |   3  | (count, handle, prec_bmp)| One time request for packet to a specific
    63. 

  63. 	|      |      |                          | MAC destination.
    64. 

  64. 	 ---------------------------------------------------------------------------
    65. 

  65. 	| 255  |  N/A |  N/A                     | FILLER - This is a special type
    66. 

  66. 	|      |      |                          | that has no length or value.
    67. 

  67. 	|      |      |                          | Typically used for padding.
    68. 

  68. 	 ---------------------------------------------------------------------------
    69. 

  69. 	*/
    70. 

  70. 

  71. #define WLFC_CTL_TYPE_MAC_OPEN			1
    72. 

  72. #define WLFC_CTL_TYPE_MAC_CLOSE			2
    73. 

  73. #define WLFC_CTL_TYPE_MAC_REQUEST_CREDIT        3
    74. 

  74. #define WLFC_CTL_TYPE_TXSTATUS			4
    75. 

  75. #define WLFC_CTL_TYPE_PKTTAG			5
    76. 

  76. 

  77. #define WLFC_CTL_TYPE_MACDESC_ADD		6
    78. 

  78. #define WLFC_CTL_TYPE_MACDESC_DEL		7
    79. 

  79. #define WLFC_CTL_TYPE_RSSI			8
    80. 

  80. 

  81. #define WLFC_CTL_TYPE_INTERFACE_OPEN		9
    82. 

  82. #define WLFC_CTL_TYPE_INTERFACE_CLOSE		10
    83. 

  83. 

  84. #define WLFC_CTL_TYPE_FIFO_CREDITBACK		11
    85. 

  85. 

  86. #define WLFC_CTL_TYPE_PENDING_TRAFFIC_BMP	12
    87. 

  87. #define WLFC_CTL_TYPE_MAC_REQUEST_PACKET	13
    88. 

  88. #define WLFC_CTL_TYPE_HOST_REORDER_RXPKTS	14
    89. 

  89. 

  90. #define WLFC_CTL_TYPE_FILLER				255
    91. 

  91. 

  92. #define WLFC_CTL_VALUE_LEN_MACDESC			8 /* handle, interface, MAC */
    93. 

  93. 

  94. #define WLFC_CTL_VALUE_LEN_MAC		1	/* MAC-handle */
    95. 

  95. #define WLFC_CTL_VALUE_LEN_RSSI		1
    96. 

  96. 

  97. #define WLFC_CTL_VALUE_LEN_INTERFACE	1
    98. 

  98. #define WLFC_CTL_VALUE_LEN_PENDING_TRAFFIC_BMP	2
    99. 

  99. 

  100. #define WLFC_CTL_VALUE_LEN_TXSTATUS	4
    101. 

  101. #define WLFC_CTL_VALUE_LEN_PKTTAG	4
    102. 

  102. 

  103. /* enough space to host all 4 ACs, bc/mc and atim fifo credit */
    104. 

  104. #define WLFC_CTL_VALUE_LEN_FIFO_CREDITBACK	6
    105. 

  105. 

  106. #define WLFC_CTL_VALUE_LEN_REQUEST_CREDIT 3 /* credit, MAC-handle, prec_bitmap */
    107. 

  107. #define WLFC_CTL_VALUE_LEN_REQUEST_PACKET 3 /* credit, MAC-handle, prec_bitmap */
    108. 

  108. 

  109. 

  110. 

  111. #define WLFC_PKTID_GEN_MASK		0x80000000
    112. 

  112. #define WLFC_PKTID_GEN_SHIFT	31
    113. 

  113. 

  114. #define WLFC_PKTID_GEN(x)	(((x) & WLFC_PKTID_GEN_MASK) >> WLFC_PKTID_GEN_SHIFT)
    115. 

  115. #define WLFC_PKTID_SETGEN(x, gen)	(x) = ((x) & ~WLFC_PKTID_GEN_MASK) | \
    116. 

  116. 	(((gen) << WLFC_PKTID_GEN_SHIFT) & WLFC_PKTID_GEN_MASK)
    117. 

  117. 

  118. #define WLFC_PKTFLAG_PKTFROMHOST	0x01
    119. 

  119. #define WLFC_PKTFLAG_PKT_REQUESTED	0x02
    120. 

  120. 

  121. #define WL_TXSTATUS_FLAGS_MASK			0xf /* allow 4 bits only */
    122. 

  122. #define WL_TXSTATUS_FLAGS_SHIFT			27
    123. 

  123. 

  124. #define WL_TXSTATUS_SET_FLAGS(x, flags)	((x)  = \
    125. 

  125. 	((x) & ~(WL_TXSTATUS_FLAGS_MASK << WL_TXSTATUS_FLAGS_SHIFT)) | \
    126. 

  126. 	(((flags) & WL_TXSTATUS_FLAGS_MASK) << WL_TXSTATUS_FLAGS_SHIFT))
    127. 

  127. #define WL_TXSTATUS_GET_FLAGS(x)		(((x) >> WL_TXSTATUS_FLAGS_SHIFT) & \
    128. 

  128. 	WL_TXSTATUS_FLAGS_MASK)
    129. 

  129. 

  130. #define WL_TXSTATUS_FIFO_MASK			0x7 /* allow 3 bits for FIFO ID */
    131. 

  131. #define WL_TXSTATUS_FIFO_SHIFT			24
    132. 

  132. 

  133. #define WL_TXSTATUS_SET_FIFO(x, flags)	((x)  = \
    134. 

  134. 	((x) & ~(WL_TXSTATUS_FIFO_MASK << WL_TXSTATUS_FIFO_SHIFT)) | \
    135. 

  135. 	(((flags) & WL_TXSTATUS_FIFO_MASK) << WL_TXSTATUS_FIFO_SHIFT))
    136. 

  136. #define WL_TXSTATUS_GET_FIFO(x)		(((x) >> WL_TXSTATUS_FIFO_SHIFT) & WL_TXSTATUS_FIFO_MASK)
    137. 

  137. 

  138. #define WL_TXSTATUS_PKTID_MASK			0xffffff /* allow 24 bits */
    139. 

  139. #define WL_TXSTATUS_SET_PKTID(x, num)	((x) = \
    140. 

  140. 	((x) & ~WL_TXSTATUS_PKTID_MASK) | (num))
    141. 

  141. #define WL_TXSTATUS_GET_PKTID(x)		((x) & WL_TXSTATUS_PKTID_MASK)
    142. 

  142. 

  143. /* 32 STA should be enough??, 6 bits; Must be power of 2 */
    144. 

  144. #define WLFC_MAC_DESC_TABLE_SIZE	32
    145. 

  145. #define WLFC_MAX_IFNUM				16
    146. 

  146. #define WLFC_MAC_DESC_ID_INVALID	0xff
    147. 

  147. 

  148. /* b[7:5] -reuse guard, b[4:0] -value */
    149. 

  149. #define WLFC_MAC_DESC_GET_LOOKUP_INDEX(x) ((x) & 0x1f)
    150. 

  150. 

  151. #define WLFC_PKTFLAG_SET_PKTREQUESTED(x)	(x) |= \
    152. 

  152. 	(WLFC_PKTFLAG_PKT_REQUESTED << WL_TXSTATUS_FLAGS_SHIFT)
    153. 

  153. 

  154. #define WLFC_PKTFLAG_CLR_PKTREQUESTED(x)	(x) &= \
    155. 

  155. 	~(WLFC_PKTFLAG_PKT_REQUESTED << WL_TXSTATUS_FLAGS_SHIFT)
    156. 

  156. 

  157. #define WL_TXSTATUS_GENERATION_MASK			1
    158. 

  158. #define WL_TXSTATUS_GENERATION_SHIFT		31
    159. 

  159. 

  160. #define WLFC_PKTFLAG_SET_GENERATION(x, gen)	((x) = \
    161. 

  161. 	((x) & ~(WL_TXSTATUS_GENERATION_MASK << WL_TXSTATUS_GENERATION_SHIFT)) | \
    162. 

  162. 	(((gen) & WL_TXSTATUS_GENERATION_MASK) << WL_TXSTATUS_GENERATION_SHIFT))
    163. 

  163. 

  164. #define WLFC_PKTFLAG_GENERATION(x)	(((x) >> WL_TXSTATUS_GENERATION_SHIFT) & \
    165. 

  165. 	WL_TXSTATUS_GENERATION_MASK)
    166. 

  166. 

  167. #define WLFC_MAX_PENDING_DATALEN	120
    168. 

  168. 

  169. /* host is free to discard the packet */
    170. 

  170. #define WLFC_CTL_PKTFLAG_DISCARD		0
    171. 

  171. /* D11 suppressed a packet */
    172. 

  172. #define WLFC_CTL_PKTFLAG_D11SUPPRESS	1
    173. 

  173. /* WL firmware suppressed a packet because MAC is
    174. 

  174. 	already in PSMode (short time window)
    175. 

  175. */
    176. 

  176. #define WLFC_CTL_PKTFLAG_WLSUPPRESS		2
    177. 

  177. /* Firmware tossed this packet */
    178. 

  178. #define WLFC_CTL_PKTFLAG_TOSSED_BYWLC	3
    179. 

  179. 

  180. #define WLFC_D11_STATUS_INTERPRET(txs)	\
    181. 

  181. 	(((txs)->status.suppr_ind != 0) ? WLFC_CTL_PKTFLAG_D11SUPPRESS : WLFC_CTL_PKTFLAG_DISCARD)
    182. 

  182. 

  183. #ifdef PROP_TXSTATUS_DEBUG
    184. 

  184. #define WLFC_DBGMESG(x) printf x
    185. 

  185. /* wlfc-breadcrumb */
    186. 

  186. #define WLFC_BREADCRUMB(x) do {if ((x) == NULL) \
    187. 

  187. 	{printf("WLFC: %s():%d:caller:%p\n", \
    188. 

  188. 	__FUNCTION__, __LINE__, __builtin_return_address(0));}} while (0)
    189. 

  189. #define WLFC_PRINTMAC(banner, ea) do {printf("%s MAC: [%02x:%02x:%02x:%02x:%02x:%02x]\n", \
    190. 

  190. 	banner, ea[0], 	ea[1], 	ea[2], 	ea[3], 	ea[4], 	ea[5]); } while (0)
    191. 

  191. #define WLFC_WHEREIS(s) printf("WLFC: at %s():%d, %s\n", __FUNCTION__, __LINE__, (s))
    192. 

  192. #else
    193. 

  193. #define WLFC_DBGMESG(x)
    194. 

  194. #define WLFC_BREADCRUMB(x)
    195. 

  195. #define WLFC_PRINTMAC(banner, ea)
    196. 

  196. #define WLFC_WHEREIS(s)
    197. 

  197. #endif
    198. 

  198. 

  199. /* AMPDU host reorder packet flags */
    200. 

  200. #define WLHOST_REORDERDATA_MAXFLOWS		256
    201. 

  201. #define WLHOST_REORDERDATA_LEN		 10
    202. 

  202. #define WLHOST_REORDERDATA_TOTLEN	(WLHOST_REORDERDATA_LEN + 1 + 1) /* +tag +len */
    203. 

  203. 

  204. #define WLHOST_REORDERDATA_FLOWID_OFFSET		0
    205. 

  205. #define WLHOST_REORDERDATA_MAXIDX_OFFSET		2
    206. 

  206. #define WLHOST_REORDERDATA_FLAGS_OFFSET			4
    207. 

  207. #define WLHOST_REORDERDATA_CURIDX_OFFSET		6
    208. 

  208. #define WLHOST_REORDERDATA_EXPIDX_OFFSET		8
    209. 

  209. 

  210. #define WLHOST_REORDERDATA_DEL_FLOW		0x01
    211. 

  211. #define WLHOST_REORDERDATA_FLUSH_ALL		0x02
    212. 

  212. #define WLHOST_REORDERDATA_CURIDX_VALID		0x04
    213. 

  213. #define WLHOST_REORDERDATA_EXPIDX_VALID		0x08
    214. 

  214. #define WLHOST_REORDERDATA_NEW_HOLE		0x10
    215. 

  215. 

  216. #endif /* __wlfc_proto_definitions_h__ */
    217. 

  217.