0
|
1 |
/*
|
|
2 |
* TWDriver.h
|
|
3 |
*
|
|
4 |
* Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.
|
|
5 |
* All rights reserved.
|
|
6 |
*
|
|
7 |
* This program and the accompanying materials are made available under the
|
|
8 |
* terms of the Eclipse Public License v1.0 or BSD License which accompanies
|
|
9 |
* this distribution. The Eclipse Public License is available at
|
|
10 |
* http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.
|
|
11 |
*
|
|
12 |
* Redistribution and use in source and binary forms, with or without
|
|
13 |
* modification, are permitted provided that the following conditions
|
|
14 |
* are met:
|
|
15 |
*
|
|
16 |
* * Redistributions of source code must retain the above copyright
|
|
17 |
* notice, this list of conditions and the following disclaimer.
|
|
18 |
* * Redistributions in binary form must reproduce the above copyright
|
|
19 |
* notice, this list of conditions and the following disclaimer in
|
|
20 |
* the documentation and/or other materials provided with the
|
|
21 |
* distribution.
|
|
22 |
* * Neither the name Texas Instruments nor the names of its
|
|
23 |
* contributors may be used to endorse or promote products derived
|
|
24 |
* from this software without specific prior written permission.
|
|
25 |
*
|
|
26 |
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
27 |
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
28 |
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
29 |
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
30 |
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
31 |
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
32 |
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
33 |
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
34 |
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
35 |
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
36 |
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
37 |
*/
|
|
38 |
|
|
39 |
|
|
40 |
/** \file TWDriver.h
|
|
41 |
* \brief TWDriver APIs
|
|
42 |
*
|
|
43 |
* \see
|
|
44 |
*/
|
|
45 |
|
|
46 |
/** @defgroup Control Control group
|
|
47 |
* \brief The Control group includes the list of functions which perform TWD Control
|
|
48 |
*/
|
|
49 |
/** @defgroup Measurement Measurement group
|
|
50 |
* \brief The Measurement group includes the list of functions which gets measurements from FW / TWD
|
|
51 |
*/
|
|
52 |
/** @defgroup Data_Path Data Path group
|
|
53 |
* \brief The Data Path group includes the list of functions which perform the TWD Data Path
|
|
54 |
*/
|
|
55 |
/** @defgroup Power_Management Power Management group
|
|
56 |
* \brief The Power Management group includes the list of functions which set the power management mode
|
|
57 |
*/
|
|
58 |
/** @defgroup QoS Quality Of Service group
|
|
59 |
* \brief The Quality of Service group includes the list of functions which perform the TWD QoS
|
|
60 |
*/
|
|
61 |
/** @defgroup Radio Radio (PHY) group
|
|
62 |
* \brief The Radio group includes the list of functions which handle the Radio
|
|
63 |
*/
|
|
64 |
/** @defgroup BSS BSS group
|
|
65 |
* \brief The BSS group includes the list of functions which handle the Basic Service Set
|
|
66 |
*/
|
|
67 |
/** @defgroup Misc Miscellaneous group
|
|
68 |
* \brief The Miscellaneous group includes the list of functions which handle miscellaneous issues
|
|
69 |
*/
|
|
70 |
#ifdef TI_DBG
|
|
71 |
/** @defgroup Test Debug Test group
|
|
72 |
* \brief The Debug Test group includes the list of functions which Test the TWD and FW
|
|
73 |
*/
|
|
74 |
#endif
|
|
75 |
|
|
76 |
#ifndef TWDRIVER_H
|
|
77 |
#define TWDRIVER_H
|
|
78 |
|
|
79 |
#define MAX_NUM_OF_802_1d_TAGS 8
|
|
80 |
|
|
81 |
#include "802_11Defs.h"
|
|
82 |
#include "TWDriverMsr.h"
|
|
83 |
#include "TWDriverScan.h"
|
|
84 |
#include "TWDriverRate.h"
|
|
85 |
#include "fwDebug_api.h"
|
|
86 |
#include "TwIf.h"
|
|
87 |
/*
|
|
88 |
* original firmware h-files
|
|
89 |
*/
|
|
90 |
#include "public_commands.h"
|
|
91 |
#include "public_event_mbox.h"
|
|
92 |
#include "public_infoele.h"
|
|
93 |
#include "public_host_int.h"
|
|
94 |
#include "public_descriptors.h"
|
|
95 |
#include "public_radio.h"
|
|
96 |
|
|
97 |
/*
|
|
98 |
* Firmware types defintions
|
|
99 |
*/
|
|
100 |
#ifndef uint8
|
|
101 |
#define uint8 TI_UINT8
|
|
102 |
#endif
|
|
103 |
#ifndef uint16
|
|
104 |
#define uint16 TI_UINT16
|
|
105 |
#endif
|
|
106 |
#ifndef uint32
|
|
107 |
#define uint32 TI_UINT32
|
|
108 |
#endif
|
|
109 |
#ifndef int8
|
|
110 |
#define int8 TI_INT8
|
|
111 |
#endif
|
|
112 |
#ifndef int16
|
|
113 |
#define int16 TI_INT16
|
|
114 |
#endif
|
|
115 |
#ifndef int32
|
|
116 |
#define int32 TI_INT32
|
|
117 |
#endif
|
|
118 |
|
|
119 |
|
|
120 |
|
|
121 |
/*
|
|
122 |
* --------------------------------------------------------------
|
|
123 |
* Definitions
|
|
124 |
* --------------------------------------------------------------
|
|
125 |
*/
|
|
126 |
|
|
127 |
/* PALAU Group Address Default Values */
|
|
128 |
#define NUM_GROUP_ADDRESS_VALUE_DEF 4
|
|
129 |
#define NUM_GROUP_ADDRESS_VALUE_MIN 0
|
|
130 |
#define NUM_GROUP_ADDRESS_VALUE_MAX 8
|
|
131 |
|
|
132 |
/* Early Wakeup Default Values */
|
|
133 |
#define EARLY_WAKEUP_ENABLE_MIN (TI_FALSE)
|
|
134 |
#define EARLY_WAKEUP_ENABLE_MAX (TI_TRUE)
|
|
135 |
#define EARLY_WAKEUP_ENABLE_DEF (TI_TRUE)
|
|
136 |
|
|
137 |
/* ARP IP Filter Default Values */
|
|
138 |
#define MIN_FILTER_ENABLE_VALUE 0
|
|
139 |
#define MAX_FILTER_ENABLE_VALUE 3
|
|
140 |
#define DEF_FILTER_ENABLE_VALUE 0
|
|
141 |
#define FILTER_ENABLE_FLAG_LEN 1
|
|
142 |
|
|
143 |
/* Beacon filter Deafult Values */
|
|
144 |
#define DEF_BEACON_FILTER_ENABLE_VALUE 1
|
|
145 |
#define DEF_BEACON_FILTER_IE_TABLE_NUM 16
|
|
146 |
#define MIN_BEACON_FILTER_ENABLE_VALUE 0
|
|
147 |
#define MAX_BEACON_FILTER_ENABLE_VALUE 1
|
|
148 |
#define BEACON_FILTER_IE_TABLE_DEF_SIZE 37
|
|
149 |
#define BEACON_FILTER_IE_TABLE_MAX_SIZE 100
|
|
150 |
#define BEACON_FILTER_IE_TABLE_MIN_SIZE 0
|
|
151 |
#define BEACON_FILTER_IE_TABLE_MAX_NUM (6+32)
|
|
152 |
#define BEACON_FILTER_IE_TABLE_MIN_NUM 0
|
|
153 |
|
|
154 |
/* CoexActivity Table Deafult Values */
|
|
155 |
#define COEX_ACTIVITY_TABLE_DEF_NUM 0
|
|
156 |
#define COEX_ACTIVITY_TABLE_MIN_NUM 0
|
|
157 |
#define COEX_ACTIVITY_TABLE_MAX_NUM 24*2
|
|
158 |
#define COEX_ACTIVITY_TABLE_SIZE ((2+1)+(2+1)+(2+1)+(2+1)+(4+1)+(4+1)) /* includes spaces between bytes */
|
|
159 |
|
|
160 |
#define DEF_NUM_STORED_FILTERS 1
|
|
161 |
#define MIN_NUM_STORED_FILTERS 1
|
|
162 |
#define MAX_NUM_STORED_FILTERS 8
|
|
163 |
|
|
164 |
#define TWD_HW_ACCESS_METHOD_MIN 0
|
|
165 |
#define TWD_HW_ACCESS_METHOD_MAX 2
|
|
166 |
#define TWD_HW_ACCESS_METHOD_DEF 1
|
|
167 |
|
|
168 |
#define TWD_SITE_FRAG_COLLECT_MIN 2
|
|
169 |
#define TWD_SITE_FRAG_COLLECT_MAX 10
|
|
170 |
#define TWD_SITE_FRAG_COLLECT_DEF 3
|
|
171 |
|
|
172 |
#define TWD_RX_MEM_BLKS_NUM 40 /* The number of Rx memory blocks configured to FW */
|
|
173 |
#define TWD_TX_MIN_MEM_BLKS_NUM 107 /* The MINIMUM number of Tx memory blocks configured to FW */
|
|
174 |
|
|
175 |
#define TWD_RX_BLOCKS_RATIO_MIN 0
|
|
176 |
#define TWD_RX_BLOCKS_RATIO_MAX 100
|
|
177 |
#define TWD_RX_BLOCKS_RATIO_DEF 50
|
|
178 |
|
|
179 |
#define TWD_TX_FLASH_ENABLE_MIN TI_FALSE
|
|
180 |
#define TWD_TX_FLASH_ENABLE_MAX TI_TRUE
|
|
181 |
#define TWD_TX_FLASH_ENABLE_DEF TI_TRUE
|
|
182 |
|
|
183 |
#define TWD_USE_INTR_TRHESHOLD_MIN 0
|
|
184 |
#define TWD_USE_INTR_TRHESHOLD_MAX 1
|
|
185 |
#define TWD_USE_INTR_TRHESHOLD_DEF 0
|
|
186 |
|
|
187 |
#define TWD_USE_TX_DATA_INTR_MIN 0
|
|
188 |
#define TWD_USE_TX_DATA_INTR_MAX 1
|
|
189 |
|
|
190 |
#define NUM_OF_CHANNELS_24 14
|
|
191 |
#define NUM_OF_CHANNELS_5 180
|
|
192 |
|
|
193 |
#define TWD_CALIBRATION_CHANNEL_2_4_MIN 1
|
|
194 |
#define TWD_CALIBRATION_CHANNEL_2_4_MAX NUM_OF_CHANNELS_24
|
|
195 |
#define TWD_CALIBRATION_CHANNEL_2_4_DEF 1
|
|
196 |
|
|
197 |
#define A_5G_BAND_MIN_CHANNEL 36
|
|
198 |
#define A_5G_BAND_MAX_CHANNEL 180
|
|
199 |
#define A_5G_BAND_NUM_CHANNELS (A_5G_BAND_MAX_CHANNEL-A_5G_BAND_MIN_CHANNEL+1)
|
|
200 |
|
|
201 |
#define TWD_CALIBRATION_CHANNEL_5_0_MIN 34
|
|
202 |
#define TWD_CALIBRATION_CHANNEL_5_0_MAX A_5G_BAND_MAX_CHANNEL
|
|
203 |
#define TWD_CALIBRATION_CHANNEL_5_0_DEF 36
|
|
204 |
|
|
205 |
#define TWD_CALIBRATION_CHANNEL_4_9_MIN 8
|
|
206 |
#define TWD_CALIBRATION_CHANNEL_4_9_MAX 16
|
|
207 |
#define TWD_CALIBRATION_CHANNEL_4_9_DEF 12
|
|
208 |
|
|
209 |
#define TWD_RTS_THRESHOLD_MIN 0
|
|
210 |
#define TWD_RTS_THRESHOLD_MAX 4096
|
|
211 |
#define TWD_RTS_THRESHOLD_DEF 4096
|
|
212 |
|
|
213 |
#define TWD_BCN_RX_TIME_OUT_MIN 10 /* ms */
|
|
214 |
#define TWD_BCN_RX_TIME_OUT_MAX 1000 /* ms */
|
|
215 |
#define TWD_BCN_RX_TIME_OUT_DEF 10 /* ms */
|
|
216 |
|
|
217 |
#define TWD_RX_DISABLE_BROADCAST_MIN TI_FALSE
|
|
218 |
#define TWD_RX_DISABLE_BROADCAST_MAX TI_TRUE
|
|
219 |
#define TWD_RX_DISABLE_BROADCAST_DEF TI_FALSE
|
|
220 |
|
|
221 |
/* Indicate if the recovery process is active or not */
|
|
222 |
#define TWD_RECOVERY_ENABLE_MIN TI_FALSE
|
|
223 |
#define TWD_RECOVERY_ENABLE_MAX TI_TRUE
|
|
224 |
#define TWD_RECOVERY_ENABLE_DEF TI_TRUE
|
|
225 |
|
|
226 |
/* Indicate if working with Burst Mode or not */
|
|
227 |
#define BURST_MODE_ENABLE_MIN TI_FALSE
|
|
228 |
#define BURST_MODE_ENABLE_MAX TI_TRUE
|
|
229 |
#define BURST_MODE_ENABLE_DEF TI_FALSE
|
|
230 |
|
|
231 |
#define SMART_REFLEX_STATE_MIN TI_FALSE
|
|
232 |
#define SMART_REFLEX_STATE_MAX TI_TRUE
|
|
233 |
#define SMART_REFLEX_STATE_DEF TI_TRUE
|
|
234 |
|
|
235 |
#define SMART_REFLEX_DEBUG_MIN 0
|
|
236 |
#define SMART_REFLEX_DEBUG_MAX 0xFFFF
|
|
237 |
#define SMART_REFLEX_DEBUG_DEF 0
|
|
238 |
|
|
239 |
#define SMART_REFLEX_CONFIG_PARAMS_DEF_TABLE "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
|
|
240 |
|
|
241 |
#define TWD_FRAG_THRESHOLD_MIN 256
|
|
242 |
#define TWD_FRAG_THRESHOLD_MAX 4096
|
|
243 |
#define TWD_FRAG_THRESHOLD_DEF 4096
|
|
244 |
|
|
245 |
#define TWD_MAX_TX_MSDU_LIFETIME_MIN 0
|
|
246 |
#define TWD_MAX_TX_MSDU_LIFETIME_MAX 3000
|
|
247 |
#define TWD_MAX_TX_MSDU_LIFETIME_DEF 512
|
|
248 |
|
|
249 |
#define TWD_MAX_RX_MSDU_LIFETIME_MIN 0
|
|
250 |
#define TWD_MAX_RX_MSDU_LIFETIME_MAX 0xFFFFFFFF
|
|
251 |
#define TWD_MAX_RX_MSDU_LIFETIME_DEF 512000
|
|
252 |
|
|
253 |
|
|
254 |
#define TWD_LISTEN_INTERVAL_MIN 1
|
|
255 |
#define TWD_LISTEN_INTERVAL_MAX 10
|
|
256 |
#define TWD_LISTEN_INTERVAL_DEF 3
|
|
257 |
|
|
258 |
/* This field indicates the number of transmit retries to attempt at
|
|
259 |
the rate specified in the TNETW Tx descriptor before
|
|
260 |
falling back to the next lowest rate.
|
|
261 |
If this field is set to 0xff, then rate fallback is disabled.
|
|
262 |
If this field is 0, then there will be 0 retries before starting fallback.*/
|
|
263 |
#define TWD_RATE_FB_RETRY_LIMIT_MIN 0 /* => No retries before starting RateFallBack */
|
|
264 |
#define TWD_RATE_FB_RETRY_LIMIT_MAX 255 /* =>0xff for disabling Rate fallback */
|
|
265 |
#define TWD_RATE_FB_RETRY_LIMIT_DEF 0
|
|
266 |
|
|
267 |
#define TWD_TX_ANTENNA_MIN TX_ANTENNA_2
|
|
268 |
#define TWD_TX_ANTENNA_MAX TX_ANTENNA_1
|
|
269 |
#define TWD_TX_ANTENNA_DEF TX_ANTENNA_1
|
|
270 |
|
|
271 |
#define TWD_RX_ANTENNA_MIN RX_ANTENNA_1
|
|
272 |
#define TWD_RX_ANTENNA_MAX RX_ANTENNA_PARTIAL
|
|
273 |
#define TWD_RX_ANTENNA_DEF RX_ANTENNA_FULL
|
|
274 |
|
|
275 |
/*
|
|
276 |
* Tx and Rx interrupts pacing (threshold in packets, timeouts in milliseconds)
|
|
277 |
*/
|
|
278 |
#define TWD_TX_CMPLT_THRESHOLD_DEF 5 /* 0 means no pacing so send interrupt on every event */
|
|
279 |
#define TWD_TX_CMPLT_THRESHOLD_MIN 0
|
|
280 |
#define TWD_TX_CMPLT_THRESHOLD_MAX 30
|
|
281 |
|
|
282 |
#define TWD_TX_CMPLT_TIMEOUT_DEF 3000
|
|
283 |
#define TWD_TX_CMPLT_TIMEOUT_MIN 100
|
|
284 |
#define TWD_TX_CMPLT_TIMEOUT_MAX 50000
|
|
285 |
|
|
286 |
#define TWD_RX_INTR_THRESHOLD_DEF 0 /* 0 means no pacing so send interrupt on every event */
|
|
287 |
#define TWD_RX_INTR_THRESHOLD_MIN 0
|
|
288 |
#define TWD_RX_INTR_THRESHOLD_MAX 30
|
|
289 |
|
|
290 |
#define TWD_RX_INTR_TIMEOUT_DEF 2000
|
|
291 |
#define TWD_RX_INTR_TIMEOUT_MIN 1
|
|
292 |
#define TWD_RX_INTR_TIMEOUT_MAX 50000
|
|
293 |
|
|
294 |
/*
|
|
295 |
* Tx power level
|
|
296 |
*/
|
|
297 |
#define TWD_TX_POWER_LEVEL_MIN MAX_POWER_LEVEL /* registry needs the lower number */
|
|
298 |
#define TWD_TX_POWER_LEVEL_MAX MIN_POWER_LEVEL /* registry needs the hifger number */
|
|
299 |
#define TWD_TX_POWER_LEVEL_DEF MAX_POWER_LEVEL
|
|
300 |
|
|
301 |
#define DBM_TO_TX_POWER_FACTOR 10
|
|
302 |
|
|
303 |
/* TX_POWER is in Dbm/10 units */
|
|
304 |
#define MAX_TX_POWER 205
|
|
305 |
#define MIN_TX_POWER 0
|
|
306 |
#define DEF_TX_POWER 70
|
|
307 |
|
|
308 |
|
|
309 |
#define MIN_DEFAULT_KEY_ID 0
|
|
310 |
#define MAX_DEFAULT_KEY_ID 3
|
|
311 |
|
|
312 |
#define KEY_RSC_LEN 8
|
|
313 |
#define MIN_KEY_LEN 5
|
|
314 |
#define MAX_KEY_LEN 32
|
|
315 |
|
|
316 |
#define TWD_RSSI_WEIGHT_MIN 0
|
|
317 |
#define TWD_RSSI_WEIGHT_MAX 100
|
|
318 |
#define TWD_RSSI_WEIGHT_DEF 20
|
|
319 |
|
|
320 |
#define TWD_DCO_ITRIM_ENABLE_MIN TI_FALSE
|
|
321 |
#define TWD_DCO_ITRIM_ENABLE_MAX TI_TRUE
|
|
322 |
#define TWD_DCO_ITRIM_ENABLE_DEF TI_FALSE
|
|
323 |
|
|
324 |
#define TWD_DCO_ITRIM_MODERATION_TIMEOUT_MIN 10000
|
|
325 |
#define TWD_DCO_ITRIM_MODERATION_TIMEOUT_MAX 1000000
|
|
326 |
#define TWD_DCO_ITRIM_MODERATION_TIMEOUT_DEF 50000
|
|
327 |
|
|
328 |
|
|
329 |
#define MAX_NUM_OF_AC 4
|
|
330 |
|
|
331 |
/************************************/
|
|
332 |
/* Rates values */
|
|
333 |
/************************************/
|
|
334 |
/* The next definitions are used to decide which encryption is used by the Rx flags */
|
|
335 |
#define RX_FLAGS_NO_SECURITY 0
|
|
336 |
#define RX_FLAGS_WEP 1
|
|
337 |
#define RX_FLAGS_TKIP 2
|
|
338 |
#define RX_FLAGS_AES 3
|
|
339 |
|
|
340 |
|
|
341 |
#define RX_DESC_FLAGS_ENCRYPTION 8
|
|
342 |
#define RX_PACKET_FLAGS_ENCRYPTION_SHIFT 16
|
|
343 |
#define RX_PACKET_FLAGS_ENCRYPTION_SHIFT_FROM_DESC (RX_PACKET_FLAGS_ENCRYPTION_SHIFT - RX_DESC_FLAGS_ENCRYPTION)
|
|
344 |
|
|
345 |
/* Tx packet Control-Block flags bit-mask. */
|
|
346 |
#define TX_CTRL_FLAG_XFER_DONE_ISSUED 0x0001 /* Xfer-Done already issued to upper driver - for WHA. */
|
|
347 |
#define TX_CTRL_FLAG_TX_COMPLETE_ISSUED 0x0002 /* Tx-Complete already issued to upper driver - for WHA. */
|
|
348 |
#define TX_CTRL_FLAG_LINK_TEST 0x0004 /* XCC link test packet */
|
|
349 |
#define TX_CTRL_FLAG_SENT_TO_FW 0x0008 /* Set after the packet is allowed to be sent to FW (by TxHwQueue) */
|
|
350 |
#define TX_CTRL_FLAG_PKT_IN_RAW_BUF 0x0010 /* The input packet is in a raw buffer (as opposed to OS packet) */
|
|
351 |
#define TX_CTRL_FLAG_MULTICAST 0x0020 /* A multicast ethernet packet */
|
|
352 |
#define TX_CTRL_FLAG_BROADCAST 0x0040 /* A broadcast ethernet packet */
|
|
353 |
|
|
354 |
#define TX_PKT_TYPE_MGMT 1 /* Management Packet */
|
|
355 |
#define TX_PKT_TYPE_EAPOL 2 /* EAPOL packet (Ethernet) */
|
|
356 |
#define TX_PKT_TYPE_ETHER 3 /* Data packet from the Network interface */
|
|
357 |
#define TX_PKT_TYPE_WLAN_DATA 4 /* Driver generated WLAN Data Packet (currently used for IAPP packet) */
|
|
358 |
|
|
359 |
|
|
360 |
#define ALIGN_4BYTE_MASK 0x3 /* Masked LS bits for 4-bytes aligned addresses or lengths. */
|
|
361 |
#define SHIFT_BETWEEN_TU_AND_USEC 10 /* Shift factor to convert between TU (1024 uSec) and uSec. */
|
|
362 |
|
|
363 |
/* Packet header + extensions structure ranges between 24 and 48 bytes as follows:
|
|
364 |
* ------------------------------------------------------------------------------
|
|
365 |
* Alignment Padding: 0/2 bytes, added for 4 bytes alignment of this structure.
|
|
366 |
* Mac-Header: 24 bytes, 802.11 basic header.
|
|
367 |
* Qos header: 0/2 bytes, for QoS-data or QoS-Null the two QoS bytes are added.
|
|
368 |
* Security Pad: 0/0/4/8/18 bytes, for None/WEP/TKIP/AES/GEM.
|
|
369 |
* LLC/SNAP: 0/8 bytes, added only for data packets.
|
|
370 |
* HT control: 0/4 added only for packte support QoS and HT
|
|
371 |
*/
|
|
372 |
#define MAX_HEADER_SIZE 48
|
|
373 |
|
|
374 |
/* Data body max length */
|
|
375 |
#define MAX_DATA_BODY_LENGTH 4096
|
|
376 |
|
|
377 |
|
|
378 |
|
|
379 |
/* The weight in % of the new packet relative to the previous average value of RSSI */
|
|
380 |
#define RSSI_DEFAULT_WEIGHT 20
|
|
381 |
|
|
382 |
#define RSSI_DEFAULT_THRESHOLD -80
|
|
383 |
#define SNR_DEFAULT_THRESHOLD 0
|
|
384 |
|
|
385 |
/*
|
|
386 |
* 'No beacon' roaming trigger configuration
|
|
387 |
* Number of consecutive beacons (or DTIM periods) missed before
|
|
388 |
* 'Out of Sync' event is raised
|
|
389 |
*/
|
|
390 |
#define OUT_OF_SYNC_DEFAULT_THRESHOLD 10
|
|
391 |
/*
|
|
392 |
* IBSS - Number of consecutive beacons (or DTIM periods) missed before
|
|
393 |
* 'Out of Sync' event is raised
|
|
394 |
*/
|
|
395 |
#define OUT_OF_SYNC_IBSS_THRESHOLD 200
|
|
396 |
/* Period of time between 'Out of sync' and 'No beacon' events */
|
|
397 |
#define NO_BEACON_DEFAULT_TIMEOUT 100 /* in tu-s*/
|
|
398 |
|
|
399 |
/* Consecutive NACK roaming trigger configuration */
|
|
400 |
#define NO_ACK_DEFAULT_THRESHOLD 20
|
|
401 |
|
|
402 |
/* Low Rx rate roaming trigger configuration */
|
|
403 |
#define LOW_RATE_DEFAULT_THRESHOLD 2
|
|
404 |
|
|
405 |
#define MEASUREMENT_NOISE_HISTOGRAM_NUM_OF_RANGES 8
|
|
406 |
#define MAX_CHANNELS_IN_REG_DOMAIN 40
|
|
407 |
|
|
408 |
#define CTS_TO_SELF_DISABLE 0
|
|
409 |
#define CTS_TO_SELF_ENABLE 1
|
|
410 |
|
|
411 |
#define MAX_TEMPLATE_SIZE 256
|
|
412 |
|
|
413 |
/* Scan constants */
|
|
414 |
#define MAX_NUMBER_OF_CHANNELS_PER_SCAN 16
|
|
415 |
#define SCAN_MAX_NUM_OF_NORMAL_CHANNELS_PER_COMMAND MAX_NUMBER_OF_CHANNELS_PER_SCAN
|
|
416 |
#define SCAN_MAX_NUM_OF_SPS_CHANNELS_PER_COMMAND 16
|
|
417 |
#define SCAN_DEFAULT_MIN_CHANNEL_DWELL_TIME 30000
|
|
418 |
#define SCAN_DEFAULT_MAX_CHANNEL_DWELL_TIME 60000
|
|
419 |
#define SCAN_DEFAULT_EARLY_TERMINATION_EVENT SCAN_ET_COND_DISABLE
|
|
420 |
#define SCAN_DEFAULT_EARLY_TERMINATION_NUM_OF_FRAMES 0
|
|
421 |
|
|
422 |
#define NUM_OF_NOISE_HISTOGRAM_COUNTERS 8
|
|
423 |
|
|
424 |
#define TX_DESCRIPTOR_SIZE sizeof(TxIfDescriptor_t)
|
|
425 |
|
|
426 |
#define CTRL_BLK_ENTRIES_NUM 128
|
|
427 |
|
|
428 |
#define HT_CAP_AMPDU_PARAMETERS_FIELD_OFFSET 2
|
|
429 |
#define HT_CAP_HT_EXTENDED_FIELD_OFFSET 19
|
|
430 |
#define HT_CAP_AMPDU_MAX_RX_FACTOR_BITMASK 0x3
|
|
431 |
#define HT_CAP_AMPDU_MIN_START_SPACING_BITMASK 0x7
|
|
432 |
#define HT_CAP_GREENFIELD_FRAME_FORMAT_BITMASK 0x0010
|
|
433 |
#define HT_CAP_SHORT_GI_FOR_20MHZ_BITMASK 0x0020
|
|
434 |
#define HT_CAP_LSIG_TXOP_PROTECTION_BITMASK 0x8000
|
|
435 |
#define HT_EXT_HT_CONTROL_FIELDS_BITMASK 0x0400
|
|
436 |
#define HT_EXT_RD_INITIATION_BITMASK 0x0800
|
|
437 |
#define HT_INF_RIFS_MOD_BITMASK 0x08
|
|
438 |
#define HT_INF_OPERATION_MOD_BITMASK 0x03
|
|
439 |
#define HT_INF_NON_GF_PRES_BITMASK 0x04
|
|
440 |
#define HT_INF_TX_BURST_LIMIT_BITMASK 0x08
|
|
441 |
#define HT_INF_DUAL_BEACON_BITMASK 0x40
|
|
442 |
|
|
443 |
/*
|
|
444 |
* TWD HT capabilities, physical capabilities of the STA.
|
|
445 |
* The structure is defined like that in order to simplify the interface with WHA layer.
|
|
446 |
*/
|
|
447 |
#define RX_TX_MCS_BITMASK_SIZE 10
|
|
448 |
|
|
449 |
#define DSSS_CCK_MODE 1
|
|
450 |
|
|
451 |
#define MCS_HIGHEST_SUPPORTED_RECEPTION_DATA_RATE_IN_MBIT_S 0x48
|
|
452 |
|
|
453 |
#define IMPLICIT_TXBF_REC_CAPABLE 1
|
|
454 |
#define TRANSMIT_STAGGERED_SOUNDING_CAPABLE 1
|
|
455 |
|
|
456 |
/* Firmware version name length */
|
|
457 |
#define FW_VERSION_LEN 20
|
|
458 |
|
|
459 |
/*the max table sized is : ( number of 221 * 8 bytes ) + ( non-221 * 2 bytes )
|
|
460 |
Must be synchronized with the size of ACX defined in public_infoele.h interface
|
|
461 |
with the FW
|
|
462 |
*/
|
|
463 |
#define MIB_MAX_SIZE_OF_IE_TABLE 112
|
|
464 |
#define MIB_TEMPLATE_DATA_MAX_LEN 256
|
|
465 |
#define MIB_MAX_MULTICAST_GROUP_ADDRS 8
|
|
466 |
|
|
467 |
#define MAX_MULTICAST_GROUP_ADDRS 8
|
|
468 |
|
|
469 |
/* Max numver of policies */
|
|
470 |
#define MAX_NUM_OF_TX_RATE_CLASS_POLICIES 8
|
|
471 |
|
|
472 |
#define NUM_POWER_LEVELS 4
|
|
473 |
#define MAX_POWER_LEVEL 1
|
|
474 |
#define MIN_POWER_LEVEL NUM_POWER_LEVELS
|
|
475 |
|
|
476 |
/*
|
|
477 |
* --------------------------------------------------------------
|
|
478 |
* Enumerations
|
|
479 |
* --------------------------------------------------------------
|
|
480 |
*/
|
|
481 |
/** \enum EFileType
|
|
482 |
* \brief TWD input/output files
|
|
483 |
*
|
|
484 |
* \par Description
|
|
485 |
* Indicates which File (or part of file) to read or write
|
|
486 |
*
|
|
487 |
* \sa TFileInfo
|
|
488 |
*/
|
|
489 |
typedef enum
|
|
490 |
{
|
|
491 |
FILE_TYPE_INI = 0, /**< */
|
|
492 |
FILE_TYPE_NVS, /**< */
|
|
493 |
FILE_TYPE_FW, /**< */
|
|
494 |
FILE_TYPE_FW_NEXT /**< */
|
|
495 |
} EFileType;
|
|
496 |
|
|
497 |
/** \enum EKeepAliveTriggerType
|
|
498 |
* \brief Keep Alive Trigger Types
|
|
499 |
*
|
|
500 |
* \par Description
|
|
501 |
* Indicates when to trigger Keep Alive
|
|
502 |
*
|
|
503 |
* \sa TKeepAliveParams
|
|
504 |
*
|
|
505 |
*/
|
|
506 |
|
|
507 |
typedef enum
|
|
508 |
{
|
|
509 |
KEEP_ALIVE_TRIG_TYPE_NO_TX = 0, /**< */
|
|
510 |
KEEP_ALIVE_TRIG_TYPE_PERIOD_ONLY /**< */
|
|
511 |
|
|
512 |
} EKeepAliveTriggerType;
|
|
513 |
|
|
514 |
/** \enum ESlotTime
|
|
515 |
* \brief Radio (PHY) Slot Time Type
|
|
516 |
*
|
|
517 |
* \par Description
|
|
518 |
* Used for configuring PHY Slot Time for FW
|
|
519 |
*
|
|
520 |
* \sa TWD_CfgPreamble
|
|
521 |
*/
|
|
522 |
typedef enum
|
|
523 |
{
|
|
524 |
PHY_SLOT_TIME_LONG = 0, /**< Long PHY Slot Time */
|
|
525 |
PHY_SLOT_TIME_SHORT = 1 /**< Short PHY Slot Time */
|
|
526 |
|
|
527 |
} ESlotTime;
|
|
528 |
|
|
529 |
/** \enum EMib
|
|
530 |
* \brief MIB Element Type
|
|
531 |
*
|
|
532 |
* \par Description
|
|
533 |
* Used for R/W MIB to FW
|
|
534 |
*
|
|
535 |
* \sa TMib
|
|
536 |
*/
|
|
537 |
typedef enum
|
|
538 |
{
|
|
539 |
/* 0x00 */ MIB_dot11MaxReceiveLifetime = 0, /**< */
|
|
540 |
/* 0x01 */ MIB_dot11SlotTime, /**< */
|
|
541 |
/* 0x02 */ MIB_dot11GroupAddressesTable, /**< */
|
|
542 |
/* 0x03 */ MIB_dot11WepDefaultKeyId, /**< */
|
|
543 |
/* 0x04 */ MIB_dot11CurrentTxPowerLevel, /**< */
|
|
544 |
/* 0x05 */ MIB_dot11RTSThreshold, /**< */
|
|
545 |
/* 0x06 */ MIB_ctsToSelf, /**< */
|
|
546 |
/* 0x07 */ MIB_arpIpAddressesTable, /**< */
|
|
547 |
/* 0x08 */ MIB_templateFrame, /**< */
|
|
548 |
/* 0x09 */ MIB_rxFilter, /**< */
|
|
549 |
/* 0x0A */ MIB_beaconFilterIETable, /**< */
|
|
550 |
/* 0x0B */ MIB_beaconFilterEnable, /**< */
|
|
551 |
/* 0x0C */ MIB_sleepMode, /**< */
|
|
552 |
/* 0x0D */ MIB_wlanWakeUpInterval, /**< */
|
|
553 |
/* 0x0E */ MIB_beaconLostCount, /**< */
|
|
554 |
/* 0x0F */ MIB_rcpiThreshold, /**< */
|
|
555 |
/* 0x10 */ MIB_statisticsTable, /**< */
|
|
556 |
/* 0x11 */ MIB_ibssPsConfig, /**< */
|
|
557 |
/* 0x12 */ MIB_txRatePolicy, /**< */
|
|
558 |
/* 0x13 */ MIB_countersTable, /**< */
|
|
559 |
/* 0x14 */ MIB_btCoexsitenceMode, /**< */
|
|
560 |
/* 0x15 */ MIB_btCoexistenceParameters, /**< */
|
|
561 |
|
|
562 |
/* must be last!!! */
|
|
563 |
MIB_lastElem = 0xFFFF /**< */
|
|
564 |
|
|
565 |
} EMib;
|
|
566 |
|
|
567 |
/** \enum ETwdParam
|
|
568 |
* \brief TWD Control parameter ID
|
|
569 |
*
|
|
570 |
* \par Description
|
|
571 |
* FW Parmaeter Information Identifier
|
|
572 |
*
|
|
573 |
* \sa TWD_SetParam, TWD_GetParam
|
|
574 |
*/
|
|
575 |
typedef enum
|
|
576 |
{
|
|
577 |
/* 0x01 */ TWD_RTS_THRESHOLD_PARAM_ID = 0x01, /**< */
|
|
578 |
/* 0x02 */ TWD_FRAG_THRESHOLD_PARAM_ID, /**< */
|
|
579 |
/* 0x03 */ TWD_COUNTERS_PARAM_ID, /**< */
|
|
580 |
/* 0x04 */ TWD_LISTEN_INTERVAL_PARAM_ID, /**< */
|
|
581 |
/* 0x05 */ TWD_BEACON_INTERVAL_PARAM_ID, /**< */
|
|
582 |
/* 0x06 */ TWD_TX_POWER_PARAM_ID, /**< */
|
|
583 |
/* 0x07 */ TWD_CLK_RUN_ENABLE_PARAM_ID, /**< */
|
|
584 |
/* 0x08 */ TWD_QUEUES_PARAM_ID, /**< */
|
|
585 |
/* 0x09 */ TWD_TX_RATE_CLASS_PARAM_ID, /**< */
|
|
586 |
/* 0x0A */ TWD_MAX_TX_MSDU_LIFE_TIME_PARAM_ID, /**< */
|
|
587 |
/* 0x0B */ TWD_MAX_RX_MSDU_LIFE_TIME_PARAM_ID, /**< */
|
|
588 |
/* 0x0C */ TWD_CTS_TO_SELF_PARAM_ID, /**< */
|
|
589 |
/* 0x0D */ TWD_RX_TIME_OUT_PARAM_ID, /**< */
|
|
590 |
/* 0x0E */ TWD_BCN_BRC_OPTIONS_PARAM_ID, /**< */
|
|
591 |
/* 0x0F */ TWD_AID_PARAM_ID, /**< */
|
|
592 |
/* 0x10 */ TWD_RSN_HW_ENC_DEC_ENABLE_PARAM_ID, /**< */
|
|
593 |
/* 0x11 */ TWD_RSN_KEY_ADD_PARAM_ID, /**< */
|
|
594 |
/* 0x12 */ TWD_RSN_KEY_REMOVE_PARAM_ID, /**< */
|
|
595 |
/* 0x13 */ TWD_RSN_DEFAULT_KEY_ID_PARAM_ID, /**< */
|
|
596 |
/* 0x14 */ TWD_RSN_SECURITY_MODE_PARAM_ID, /**< */
|
|
597 |
/* 0x15 */ TWD_RSN_SECURITY_ALARM_CB_SET_PARAM_ID, /**< */
|
|
598 |
/* 0x16 */ TWD_ACX_STATISTICS_PARAM_ID, /**< */
|
|
599 |
/* 0x17 */ TWD_MEDIUM_OCCUPANCY_PARAM_ID, /**< */
|
|
600 |
/* 0x18 */ TWD_DISABLE_POWER_MANAGEMENT_AUTO_CONFIG_PARAM_ID, /**< */
|
|
601 |
/* 0x19 */ TWD_ENABLE_POWER_MANAGEMENT_AUTO_CONFIG_PARAM_ID, /**< */
|
|
602 |
/* 0x1A */ TWD_SG_ENABLE_PARAM_ID, /**< */
|
|
603 |
/* 0x1B */ TWD_SG_CONFIG_PARAM_ID, /**< */
|
|
604 |
#ifdef XCC_MODULE_INCLUDED
|
|
605 |
/* 0x1C */ TWD_RSN_XCC_SW_ENC_ENABLE_PARAM_ID, /**< */
|
|
606 |
/* 0x1D */ TWD_RSN_XCC_MIC_FIELD_ENABLE_PARAM_ID, /**< */
|
|
607 |
#endif /* XCC_MODULE_INCLUDED*/
|
|
608 |
/* 0x1E */ TWD_TX_OP_LIMIT_PARAM_ID, /**< */
|
|
609 |
/* 0x1F */ TWD_NOISE_HISTOGRAM_PARAM_ID, /**< */
|
|
610 |
/* 0x20 */ TWD_TSF_DTIM_MIB_PARAM_ID, /**< */
|
|
611 |
/* 0x21 */ TWD_REVISION_PARAM_ID, /**< */
|
|
612 |
/* 0x22 */ TWD_CURRENT_CHANNEL_PARAM_ID, /**< */
|
|
613 |
/* 0x23 */ TWD_RADIO_TEST_PARAM_ID, /**< */
|
|
614 |
/* 0x24 */ TWD_RSSI_LEVEL_PARAM_ID, /**< */
|
|
615 |
/* 0x25 */ TWD_SNR_RATIO_PARAM_ID, /**< */
|
|
616 |
/* 0x26 */ TWD_COEX_ACTIVITY_PARAM_ID, /**< */
|
|
617 |
/* 0x27 */ TWD_FM_COEX_PARAM_ID, /**< */
|
|
618 |
/* 0x28 */ TWD_DCO_ITRIM_PARAMS_ID, /**< */
|
|
619 |
|
|
620 |
/* must be last!!! */
|
|
621 |
/* 0x29 */ TWD_LAST_PARAM_ID /**< */
|
|
622 |
} ETwdParam;
|
|
623 |
|
|
624 |
/** \enum ETwdCallbackOwner
|
|
625 |
* \brief TWD Callback Module owner ID
|
|
626 |
*
|
|
627 |
* \par Description
|
|
628 |
* The Owner ID defines a specific TWD Module
|
|
629 |
*
|
|
630 |
* \sa ETwdEventId, TWD_RegisterCb
|
|
631 |
*/
|
|
632 |
typedef enum
|
|
633 |
{
|
|
634 |
TWD_OWNER_DRIVER_TX_XFER = 0x0100, /**< TX Xfer Owner ID */
|
|
635 |
TWD_OWNER_RX_XFER = 0x0200, /**< RX Xfer Owner ID */
|
|
636 |
TWD_OWNER_SELF = 0x0300, /**< Self Owner ID */
|
|
637 |
TWD_OWNER_MAC_SERVICES = 0x0400, /**< MAC Services Owner ID */
|
|
638 |
TWD_OWNER_TX_RESULT = 0x0500, /**< TX Result Owner ID */
|
|
639 |
TWD_OWNER_SELF_CONFIG = 0x0600, /**< Self configuration of Owner ID */
|
|
640 |
TWD_OWNER_RX_QUEUE = 0x0700, /**< RX Queue Owner ID */
|
|
641 |
TWD_OWNER_TX_HW_QUEUE = 0x0800 /**< TX HW Queue Owner ID */
|
|
642 |
|
|
643 |
} ETwdCallbackOwner;
|
|
644 |
|
|
645 |
/** \enum ETwdIntCallbackId
|
|
646 |
* \brief TWD Internal Callbacks ID
|
|
647 |
*
|
|
648 |
* \par Description
|
|
649 |
* The Owner ID defines a specific TWD Internal CB
|
|
650 |
*
|
|
651 |
* \sa ETwdEventId
|
|
652 |
*/
|
|
653 |
typedef enum
|
|
654 |
{
|
|
655 |
TWD_INT_SEND_PACKET_TRANSFER = 0x00 , /**< Tx Data Path Send Callback */
|
|
656 |
TWD_INT_SEND_PACKET_COMPLETE , /**< Tx Data Path Complete Callback */
|
|
657 |
TWD_INT_UPDATE_BUSY_MAP , /**< Tx Data Path Update-Busy-Map Callback */
|
|
658 |
|
|
659 |
/* Rx Data Path Callbacks */
|
|
660 |
TWD_INT_RECEIVE_PACKET = 0x10 , /**< Rx Data Path Receive Packet Callback */
|
|
661 |
TWD_INT_REQUEST_FOR_BUFFER , /**< Rx Data Path Request for buffer Callback */
|
|
662 |
|
|
663 |
/* TWD Callbacks */
|
|
664 |
TWD_INT_COMMAND_COMPLETE = 0x20 , /**< TWD internal Command Complete Callback */
|
|
665 |
TWD_INT_EVENT_FAILURE /**< TWD internal Event Failure handle Callback */
|
|
666 |
|
|
667 |
} ETwdIntCallbackId;
|
|
668 |
|
|
669 |
/** \enum ETwdOwnEventId
|
|
670 |
* \brief Event Mail Box ID
|
|
671 |
*
|
|
672 |
* \par Description
|
|
673 |
* Clients That expects an event should register for it,
|
|
674 |
* and Mask/UnMask Events with this ID
|
|
675 |
*
|
|
676 |
* \sa
|
|
677 |
*/
|
|
678 |
/* Note: changes here should be reflected also in eventTable in eventMbox.c !!! */
|
|
679 |
typedef enum
|
|
680 |
{
|
|
681 |
/*Regular events*/
|
|
682 |
/* 0 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_0 = 0, /**< */
|
|
683 |
/* 1 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_1, /**< */
|
|
684 |
/* 2 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_2, /**< */
|
|
685 |
/* 3 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_3, /**< */
|
|
686 |
/* 4 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_4, /**< */
|
|
687 |
/* 5 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_5, /**< */
|
|
688 |
/* 6 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_6, /**< */
|
|
689 |
/* 7 */ TWD_OWN_EVENT_RSSI_SNR_TRIGGER_7, /**< */
|
|
690 |
/* 8 */ TWD_OWN_EVENT_MEASUREMENT_START, /**< */
|
|
691 |
/* 9 */ TWD_OWN_EVENT_MEASUREMENT_COMPLETE, /**< */
|
|
692 |
/* 10 */ TWD_OWN_EVENT_SCAN_CMPLT, /**< */
|
|
693 |
/* 11 */ TWD_OWN_EVENT_SPS_SCAN_CMPLT, /**< */
|
|
694 |
/* 12 */ TWD_OWN_EVENT_AP_DISCOVERY_COMPLETE, /**< */
|
|
695 |
/* 13 */ TWD_OWN_EVENT_PS_REPORT, /**< */
|
|
696 |
/* 14 */ TWD_OWN_EVENT_PSPOLL_DELIVERY_FAILURE, /**< */
|
|
697 |
/* 15 */ TWD_OWN_EVENT_DISCONNECT_COMPLETE, /**< */
|
|
698 |
/* 16 */ TWD_OWN_EVENT_JOIN_CMPLT, /**< */
|
|
699 |
/* 17 */ TWD_OWN_EVENT_SWITCH_CHANNEL_CMPLT, /**< */
|
|
700 |
/* 18 */ TWD_OWN_EVENT_BSS_LOSE, /**< */
|
|
701 |
/* 19 */ TWD_OWN_EVENT_BSS_REGAIN, /**< */
|
|
702 |
/* 20 */ TWD_OWN_EVENT_MAX_TX_RETRY, /**< */
|
|
703 |
/* 21 */ RESERVED21, /**< */
|
|
704 |
/* 22 */ TWD_OWN_EVENT_SOFT_GEMINI_SENSE, /**< */
|
|
705 |
/* 23 */ TWD_OWN_EVENT_SOFT_GEMINI_PREDIC, /**< */
|
|
706 |
/* 24 */ TWD_OWN_EVENT_SOFT_GEMINI_AVALANCHE, /**< */
|
|
707 |
/* 25 */ TWD_OWN_EVENT_PLT_RX_CALIBRATION_COMPLETE, /**< */
|
|
708 |
/* 26 */ TWD_DBG_EVENT, /**< */
|
|
709 |
/* 27 */ TWD_HEALTH_CHECK_REPLY_EVENT, /**< */
|
|
710 |
/* 28 */ TWD_OWN_EVENT_PERIODIC_SCAN_COMPLETE, /**< */
|
|
711 |
/* 29 */ TWD_OWN_EVENT_PERIODIC_SCAN_REPORT, /**< */
|
|
712 |
/* 30 */ TWD_BA_SESSION_TEAR_DOWN_EVENT, /**< */
|
|
713 |
/* 31 */ TWD_OWN_EVENT_ALL, /**< */
|
|
714 |
/* 32 */ TWD_OWN_EVENT_MAX /**< */
|
|
715 |
|
|
716 |
} ETwdOwnEventId;
|
|
717 |
|
|
718 |
/** \enum ETwdEventId
|
|
719 |
* \brief TNETW Driver Event ID
|
|
720 |
*
|
|
721 |
* \par Description
|
|
722 |
* The TWD Event ID is used by user for registering a TWD Internal CB
|
|
723 |
* which will handle a TWD Event.
|
|
724 |
* Each field in this enum is an ID of TWD Event, and is combined of two IDs:
|
|
725 |
* TWD CB Owner (Module) ID and TWD Internal CB ID. Therefore, the CB is registered accordeing to
|
|
726 |
* Module (Owner) and Internal CB Id.
|
|
727 |
*
|
|
728 |
* \sa TWD_RegisterCb, ETwdCallbackOwner, ETwdIntCallbackId
|
|
729 |
*/
|
|
730 |
typedef enum
|
|
731 |
{
|
|
732 |
/* Internal Failure Event Callbacks */
|
|
733 |
TWD_EVENT_FAILURE = TWD_OWNER_SELF | TWD_INT_EVENT_FAILURE, /**< Failure Internal Event ID */
|
|
734 |
TWD_EVENT_COMMAND_COMPLETE = TWD_OWNER_SELF | TWD_INT_COMMAND_COMPLETE, /**< Command Complete Internal Event ID */
|
|
735 |
|
|
736 |
/* Tx Data Path Callbacks */
|
|
737 |
TWD_EVENT_TX_XFER_SEND_PKT_TRANSFER = TWD_OWNER_DRIVER_TX_XFER | TWD_INT_SEND_PACKET_TRANSFER, /**< TX Data Path Send Packet Event ID */
|
|
738 |
TWD_EVENT_TX_RESULT_SEND_PKT_COMPLETE = TWD_OWNER_TX_RESULT | TWD_INT_SEND_PACKET_COMPLETE, /**< TX Data Path Send Packet Complete Event ID */
|
|
739 |
TWD_EVENT_TX_HW_QUEUE_UPDATE_BUSY_MAP = TWD_OWNER_TX_HW_QUEUE | TWD_INT_UPDATE_BUSY_MAP, /**< TX Data Path Update-Busy-Map Event ID */
|
|
740 |
|
|
741 |
/* Rx Data Path Callbacks */
|
|
742 |
TWD_EVENT_RX_REQUEST_FOR_BUFFER = TWD_OWNER_RX_XFER | TWD_INT_REQUEST_FOR_BUFFER, /**< RX Data Path Request for Buffer Internal Event ID */
|
|
743 |
TWD_EVENT_RX_RECEIVE_PACKET = TWD_OWNER_RX_QUEUE | TWD_INT_RECEIVE_PACKET /**< RX Data Path Receive Packet Internal Event ID */
|
|
744 |
|
|
745 |
} ETwdEventId;
|
|
746 |
|
|
747 |
#ifdef TI_DBG
|
|
748 |
/** \enum ETwdPrintInfoType
|
|
749 |
* \brief TWD print functions codes
|
|
750 |
*
|
|
751 |
* \par Description
|
|
752 |
* Used for Debug - determines which Tx Info to print
|
|
753 |
*
|
|
754 |
* \sa TWD_PrintTxInfo
|
|
755 |
*/
|
|
756 |
typedef enum
|
|
757 |
{
|
|
758 |
/* 0 */ TWD_PRINT_TX_CTRL_BLK_TBL = 0, /**< Print TX Control Block Information */
|
|
759 |
/* 1 */ TWD_PRINT_TX_HW_QUEUE_INFO, /**< Print TX HW Queue Information */
|
|
760 |
/* 2 */ TWD_PRINT_TX_XFER_INFO, /**< Print TX XFER Information */
|
|
761 |
/* 3 */ TWD_PRINT_TX_RESULT_INFO, /**< Print TX Result Information */
|
|
762 |
/* 4 */ TWD_CLEAR_TX_RESULT_INFO /**< Clear TX Result Information */
|
|
763 |
|
|
764 |
} ETwdPrintInfoType;
|
|
765 |
#endif
|
|
766 |
|
|
767 |
/** \enum EIpVer
|
|
768 |
* \brief IP Version
|
|
769 |
*
|
|
770 |
* \par Description
|
|
771 |
*
|
|
772 |
* \sa TWD_PrintTxInfo
|
|
773 |
*/
|
|
774 |
typedef enum
|
|
775 |
{
|
|
776 |
/* 0 */ IP_VER_4 = 0, /**< */
|
|
777 |
/* 1 */ IP_VER_6 /**< */
|
|
778 |
|
|
779 |
} EIpVer;
|
|
780 |
|
|
781 |
/** \enum EKeyType
|
|
782 |
* \brief Key Type
|
|
783 |
*
|
|
784 |
* \par Description
|
|
785 |
* Security Key Type
|
|
786 |
*
|
|
787 |
* \sa TSecurityKeys
|
|
788 |
*/
|
|
789 |
typedef enum
|
|
790 |
{
|
|
791 |
/* 0 */ KEY_NULL = 0, /**< */
|
|
792 |
/* 1 */ KEY_WEP, /**< */
|
|
793 |
/* 2 */ KEY_TKIP, /**< */
|
|
794 |
/* 3 */ KEY_AES, /**< */
|
|
795 |
/* 4 */ KEY_XCC, /**< */
|
|
796 |
#ifdef GEM_SUPPORT
|
|
797 |
/* 5 */ KEY_GEM
|
|
798 |
#endif
|
|
799 |
|
|
800 |
} EKeyType;
|
|
801 |
|
|
802 |
/** \enum ERegistryTxRate
|
|
803 |
* \brief TX Rate Type
|
|
804 |
*
|
|
805 |
* \par Description
|
|
806 |
*
|
|
807 |
* \sa
|
|
808 |
*/
|
|
809 |
/* Make it same as "rate_e" */
|
|
810 |
typedef enum
|
|
811 |
{
|
|
812 |
/* This value is reserved if this enum is used for MgmtCtrlTxRate - the auto mode is only valid for data packets */
|
|
813 |
/* 0 */ REG_RATE_AUTO_BIT = 0, /**< */
|
|
814 |
/* 1 */ REG_RATE_1M_BIT, /**< */
|
|
815 |
/* 2 */ REG_RATE_2M_BIT, /**< */
|
|
816 |
/* 3 */ REG_RATE_5_5M_CCK_BIT, /**< */
|
|
817 |
/* 4 */ REG_RATE_11M_CCK_BIT, /**< */
|
|
818 |
/* 5 */ REG_RATE_22M_PBCC_BIT, /**< */
|
|
819 |
/* 6 */ REG_RATE_6M_OFDM_BIT, /**< */
|
|
820 |
/* 7 */ REG_RATE_9M_OFDM_BIT, /**< */
|
|
821 |
/* 8 */ REG_RATE_12M_OFDM_BIT, /**< */
|
|
822 |
/* 9 */ REG_RATE_18M_OFDM_BIT, /**< */
|
|
823 |
/* 10 */ REG_RATE_24M_OFDM_BIT, /**< */
|
|
824 |
/* 11 */ REG_RATE_36M_OFDM_BIT, /**< */
|
|
825 |
/* 12 */ REG_RATE_48M_OFDM_BIT, /**< */
|
|
826 |
/* 13 */ REG_RATE_54M_OFDM_BIT, /**< */
|
|
827 |
/* 14 */ REG_RATE_MCS0_OFDM_BIT, /**< */
|
|
828 |
/* 15 */ REG_RATE_MCS1_OFDM_BIT, /**< */
|
|
829 |
/* 16 */ REG_RATE_MCS2_OFDM_BIT, /**< */
|
|
830 |
/* 17 */ REG_RATE_MCS3_OFDM_BIT, /**< */
|
|
831 |
/* 18 */ REG_RATE_MCS4_OFDM_BIT, /**< */
|
|
832 |
/* 19 */ REG_RATE_MCS5_OFDM_BIT, /**< */
|
|
833 |
/* 20 */ REG_RATE_MCS6_OFDM_BIT, /**< */
|
|
834 |
/* 21 */ REG_RATE_MCS7_OFDM_BIT /**< */
|
|
835 |
|
|
836 |
} ERegistryTxRate;
|
|
837 |
|
|
838 |
/** \enum EFailureEvent
|
|
839 |
* \brief Failure Event
|
|
840 |
*
|
|
841 |
* \par Description
|
|
842 |
* Used as a parameter for Failure Event CB -
|
|
843 |
* Inicates Failure Event ID, according which the Failure
|
|
844 |
* Event's data is driven
|
|
845 |
*
|
|
846 |
* \sa TWD_RegisterOwnCb, TFailureEventCb
|
|
847 |
*/
|
|
848 |
typedef enum
|
|
849 |
{
|
|
850 |
/* -1 */ NO_FAILURE = -1, /**< No Failure Event */
|
|
851 |
/* 0 */ NO_SCAN_COMPLETE_FAILURE = 0, /**< No Scan Complete Failure Event */
|
|
852 |
/* 1 */ MBOX_FAILURE, /**< Mail Box Failure Event */
|
|
853 |
/* 2 */ HW_AWAKE_FAILURE, /**< HW Awake Failure Event */
|
|
854 |
/* 3 */ TX_STUCK, /**< TX STUCK Failure Event */
|
|
855 |
/* 4 */ DISCONNECT_TIMEOUT, /**< Disconnect Timeout Failure Event */
|
|
856 |
/* 5 */ POWER_SAVE_FAILURE, /**< Power Save Failure Event */
|
|
857 |
/* 6 */ MEASUREMENT_FAILURE, /**< Measurement Failure Event */
|
|
858 |
/* 7 */ BUS_FAILURE, /**< Bus Failure Event */
|
|
859 |
/* 8 */ HW_WD_EXPIRE, /**< HW Watchdog Expire Event */
|
|
860 |
|
|
861 |
/* must be last!!! */
|
|
862 |
/* 9 */ MAX_FAILURE_EVENTS /**< Maximum number of Failure Events */
|
|
863 |
|
|
864 |
} EFailureEvent;
|
|
865 |
|
|
866 |
/** \enum ETemplateType
|
|
867 |
* \brief Template Type
|
|
868 |
*
|
|
869 |
* \par Description
|
|
870 |
* Used for setting/Getting a Template to/from FW
|
|
871 |
*
|
|
872 |
* \sa TWD_CmdTemplate, TWD_WriteMibTemplateFrame, TSetTemplate TWD_GetTemplate
|
|
873 |
*/
|
|
874 |
typedef enum
|
|
875 |
{
|
|
876 |
/* 0 */ NULL_DATA_TEMPLATE = 0, /**< NULL Data Template */
|
|
877 |
/* 1 */ BEACON_TEMPLATE, /**< Beacon Template */
|
|
878 |
/* 2 */ PROBE_REQUEST_TEMPLATE, /**< PROBE Request Template */
|
|
879 |
/* 3 */ PROBE_RESPONSE_TEMPLATE, /**< PROBE Response Template */
|
|
880 |
/* 4 */ QOS_NULL_DATA_TEMPLATE, /**< Quality Of Service NULL Data Template */
|
|
881 |
/* 5 */ PS_POLL_TEMPLATE, /**< Power Save Poll Template */
|
|
882 |
/* 6 */ KEEP_ALIVE_TEMPLATE, /**< Keep Alive Template */
|
|
883 |
/* 7 */ DISCONN_TEMPLATE /**< Disconn (Deauth/Disassoc) Template */
|
|
884 |
} ETemplateType;
|
|
885 |
|
|
886 |
|
|
887 |
|
|
888 |
|
|
889 |
typedef enum
|
|
890 |
{
|
|
891 |
KEY_WEP_DEFAULT = 0,
|
|
892 |
KEY_WEP_ADDR = 1,
|
|
893 |
KEY_AES_GROUP = 4,
|
|
894 |
KEY_AES_PAIRWISE = 5,
|
|
895 |
KEY_WEP_GROUP = 6,
|
|
896 |
KEY_TKIP_MIC_GROUP = 10,
|
|
897 |
KEY_TKIP_MIC_PAIRWISE = 11
|
|
898 |
} KeyType_enum;
|
|
899 |
|
|
900 |
|
|
901 |
/** \enum ECipherSuite
|
|
902 |
* \brief CHIPHER Suite
|
|
903 |
*
|
|
904 |
* \par Description
|
|
905 |
* Available cipher suites for admission control
|
|
906 |
*
|
|
907 |
* \sa
|
|
908 |
*/
|
|
909 |
typedef enum
|
|
910 |
{
|
|
911 |
/* 0 */ TWD_CIPHER_NONE = 0, /**< no cipher suite */
|
|
912 |
/* 1 */ TWD_CIPHER_WEP, /**< WEP-40 cipher suite */
|
|
913 |
/* 2 */ TWD_CIPHER_TKIP, /**< TKIP cipher suite */
|
|
914 |
/* 3 */ TWD_CIPHER_AES_WRAP, /**< AES WRAP cipher suite */
|
|
915 |
/* 4 */ TWD_CIPHER_AES_CCMP, /**< AES CCMP cipher suite */
|
|
916 |
/* 5 */ TWD_CIPHER_WEP104, /**< WEP-104 cipher suite */
|
|
917 |
/* 6 */ TWD_CIPHER_CKIP, /**< CKIP cipher suite */
|
|
918 |
#ifdef GEM_SUPPORT
|
|
919 |
/* 7 */ TWD_CIPHER_GEM, /**< GEM cipher suite */
|
|
920 |
#endif
|
|
921 |
TWD_CIPHER_MAX,
|
|
922 |
|
|
923 |
TWD_CIPHER_UNKNOWN = 255 /**< UNKNOWN chpiher suite */
|
|
924 |
|
|
925 |
} ECipherSuite;
|
|
926 |
|
|
927 |
/** \enum E80211PsMode
|
|
928 |
* \brief 802.11 Power Save Mode
|
|
929 |
*
|
|
930 |
* \par Description
|
|
931 |
*
|
|
932 |
* \sa TWD_Scan, TWD_SetPsMode
|
|
933 |
*/
|
|
934 |
typedef enum
|
|
935 |
{
|
|
936 |
/* 0 */ POWER_SAVE_OFF = 0, /**< power save 802.11 OFF */
|
|
937 |
/* 1 */ POWER_SAVE_ON, /**< power save 802.11 ON */
|
|
938 |
/* 2 */ POWER_SAVE_KEEP_CURRENT /**< power save 802.11 don't change */
|
|
939 |
|
|
940 |
} E80211PsMode;
|
|
941 |
|
|
942 |
/** \enum E80211PsStatus
|
|
943 |
* \brief Set Power Save mode status
|
|
944 |
*
|
|
945 |
* \par Description
|
|
946 |
*
|
|
947 |
* \sa
|
|
948 |
*/
|
|
949 |
typedef enum
|
|
950 |
{
|
|
951 |
/* 1 */ POWER_SAVE_802_11_SUCCESS = 1, /**< power save mode Success */
|
|
952 |
/* 2 */ POWER_SAVE_802_11_FAIL, /**< power save mode Fail */
|
|
953 |
/* 3 */ POWER_SAVE_802_11_NOT_ALLOWED, /**< power save mode Not Allowed */
|
|
954 |
/* 4 */ POWER_SAVE_802_11_PENDING, /**< power save mode Pending */
|
|
955 |
/* 5 */ POWER_SAVE_802_11_IS_CURRENT /**< power save mode Is Current */
|
|
956 |
|
|
957 |
} E80211PsStatus;
|
|
958 |
|
|
959 |
/** \enum EElpCtrlMode
|
|
960 |
* \brief ELP Control Mode
|
|
961 |
*
|
|
962 |
* \par Description
|
|
963 |
*
|
|
964 |
* \sa
|
|
965 |
*/
|
|
966 |
typedef enum
|
|
967 |
{
|
|
968 |
/* 0 */ ELPCTRL_MODE_NORMAL = 0, /**< ALP Control mode Normal */
|
|
969 |
/* 1 */ ELPCTRL_MODE_KEEP_AWAKE /**< ALP Control mode Keep Awake */
|
|
970 |
|
|
971 |
} EElpCtrlMode;
|
|
972 |
|
|
973 |
/** \enum EPreamble
|
|
974 |
* \brief Preamble Type
|
|
975 |
*
|
|
976 |
* \par Description
|
|
977 |
*
|
|
978 |
* \sa TWD_CfgPreamble
|
|
979 |
*/
|
|
980 |
typedef enum
|
|
981 |
{
|
|
982 |
PREAMBLE_LONG = 0, /**< Preamble type Long */
|
|
983 |
PREAMBLE_SHORT = 1, /**< Preamble type Short */
|
|
984 |
|
|
985 |
PREAMBLE_UNSPECIFIED = 0xFF /**< Preamble type Not Specified */
|
|
986 |
|
|
987 |
} EPreamble;
|
|
988 |
|
|
989 |
/** \enum ENoiseHistogramCmd
|
|
990 |
* \brief Noise Histogram Type
|
|
991 |
*
|
|
992 |
* \par Description
|
|
993 |
*
|
|
994 |
* \sa TNoiseHistogram, TWD_CmdNoiseHistogram
|
|
995 |
*/
|
|
996 |
typedef enum
|
|
997 |
{
|
|
998 |
STOP_NOISE_HIST = 0, /**< Stop Noise Histogram */
|
|
999 |
START_NOISE_HIST = 1 /**< Start Noise Histogram */
|
|
1000 |
|
|
1001 |
} ENoiseHistogramCmd;
|
|
1002 |
|
|
1003 |
/** \enum ETnetWakeOn
|
|
1004 |
* \brief ACX Wake Up Condition
|
|
1005 |
*
|
|
1006 |
* \par Description
|
|
1007 |
*
|
|
1008 |
* \sa TPowerMgmtConfig, TWD_CfgWakeUpCondition
|
|
1009 |
*/
|
|
1010 |
typedef enum
|
|
1011 |
{
|
|
1012 |
|
|
1013 |
/* 0 */ TNET_WAKE_ON_BEACON = 0, /**< Indicate the wake on event of the HW - beacon.
|
|
1014 |
* In this event the HW configure to be awake on every beacon.
|
|
1015 |
*/
|
|
1016 |
|
|
1017 |
/* 1 */ TNET_WAKE_ON_DTIM, /**< Indicate the wake on event of the HW - DTIM. In this event
|
|
1018 |
* the HW configure to be awake on every DITM (configure by the AP).
|
|
1019 |
*/
|
|
1020 |
|
|
1021 |
/* 2 */ TNET_WAKE_ON_N_BEACON, /**< Indicate the wake on event of the HW - listen interval.
|
|
1022 |
* In this event the HW configure to be awake on every
|
|
1023 |
* configured number of beacons.
|
|
1024 |
*/
|
|
1025 |
|
|
1026 |
/* 3 */ TNET_WAKE_ON_N_DTIM, /**< Indicate the wake on event of the HW - listen interval.
|
|
1027 |
* In this event the HW configure to be awake on every
|
|
1028 |
* configured number of beacons.
|
|
1029 |
*/
|
|
1030 |
|
|
1031 |
/* 4 */ TNET_WAKE_ON_HOST /**< Indicate the wake on event of the HW - Host access only
|
|
1032 |
*/
|
|
1033 |
|
|
1034 |
} ETnetWakeOn;
|
|
1035 |
|
|
1036 |
/** \enum ETxAntenna
|
|
1037 |
* \brief TX Antenna Types
|
|
1038 |
*
|
|
1039 |
* \par Description
|
|
1040 |
*
|
|
1041 |
* \sa TGeneralInitParams, TTwdParamContents
|
|
1042 |
*/
|
|
1043 |
typedef enum
|
|
1044 |
{
|
|
1045 |
TX_ANTENNA_2 = 0, /**< */
|
|
1046 |
TX_ANTENNA_1 = 1 /**< */
|
|
1047 |
|
|
1048 |
} ETxAntenna;
|
|
1049 |
|
|
1050 |
/** \enum ERxAntenna
|
|
1051 |
* \brief RX Antenna Types
|
|
1052 |
*
|
|
1053 |
* \par Description
|
|
1054 |
*
|
|
1055 |
* \sa TGeneralInitParams, TTwdParamContents
|
|
1056 |
*/
|
|
1057 |
typedef enum
|
|
1058 |
{
|
|
1059 |
/* 0 */ RX_ANTENNA_1 = 0, /**< */
|
|
1060 |
/* 1 */ RX_ANTENNA_2, /**< */
|
|
1061 |
/* 2 */ RX_ANTENNA_FULL, /**< */
|
|
1062 |
/* 3 */ RX_ANTENNA_PARTIAL /**< */
|
|
1063 |
|
|
1064 |
} ERxAntenna;
|
|
1065 |
|
|
1066 |
/** \enum EPowerPolicy
|
|
1067 |
* \brief Save Power Level Policy
|
|
1068 |
*
|
|
1069 |
* \par Description
|
|
1070 |
*
|
|
1071 |
* \sa TWD_CfgSleepAuth
|
|
1072 |
*/
|
|
1073 |
typedef enum
|
|
1074 |
{
|
|
1075 |
/* 0 */ POWERAUTHO_POLICY_ELP = 0, /**< */
|
|
1076 |
/* 1 */ POWERAUTHO_POLICY_PD, /**< */
|
|
1077 |
/* 2 */ POWERAUTHO_POLICY_AWAKE, /**< */
|
|
1078 |
/* 3 */ POWERAUTHO_POLICY_NUM /**< */
|
|
1079 |
|
|
1080 |
} EPowerPolicy;
|
|
1081 |
|
|
1082 |
/** \enum ESoftGeminiEnableModes
|
|
1083 |
* \brief Soft-Gemini Enable Modes
|
|
1084 |
*
|
|
1085 |
* \par Description
|
|
1086 |
*
|
|
1087 |
* \sa
|
|
1088 |
*/
|
|
1089 |
typedef enum
|
|
1090 |
{
|
|
1091 |
/* 0 */ SG_DISABLE = 0, /**< */
|
|
1092 |
/* 1 */ SG_PROTECTIVE, /**< */
|
|
1093 |
/* 2 */ SG_OPPORTUNISTIC, /**< */
|
|
1094 |
|
|
1095 |
|
|
1096 |
} ESoftGeminiEnableModes;
|
|
1097 |
/** \enum ESoftGeminiEnableProfile
|
|
1098 |
* \brief Soft-Gemini Profile Modes for Symbian configuration
|
|
1099 |
*
|
|
1100 |
* \par Description
|
|
1101 |
*
|
|
1102 |
* \sa
|
|
1103 |
*/
|
|
1104 |
typedef enum
|
|
1105 |
{
|
|
1106 |
BtCoexProfData = 0,
|
|
1107 |
BtCoexProfDataLowLatency,
|
|
1108 |
BtCoexProfA2DP
|
|
1109 |
}ESoftGeminiEnableProfile;
|
|
1110 |
|
|
1111 |
|
|
1112 |
/** \enum EMibTemplateType
|
|
1113 |
* \brief MIB Template type
|
|
1114 |
*
|
|
1115 |
* \par Description
|
|
1116 |
*
|
|
1117 |
* \sa
|
|
1118 |
*/
|
|
1119 |
typedef enum
|
|
1120 |
{
|
|
1121 |
/* 0 */ TEMPLATE_TYPE_BEACON = 0, /**< BEACON template */
|
|
1122 |
/* 1 */ TEMPLATE_TYPE_PROBE_REQUEST, /**< PROB template */
|
|
1123 |
/* 2 */ TEMPLATE_TYPE_NULL_FRAME, /**< NULL FRAM template */
|
|
1124 |
/* 3 */ TEMPLATE_TYPE_PROBE_RESPONSE, /**< PROB Response template */
|
|
1125 |
/* 4 */ TEMPLATE_TYPE_QOS_NULL_FRAME, /**< QOS Null Frame template */
|
|
1126 |
/* 5 */ TEMPLATE_TYPE_PS_POLL /**< Power Save Poll template */
|
|
1127 |
|
|
1128 |
} EMibTemplateType;
|
|
1129 |
|
|
1130 |
|
|
1131 |
/** \enum ERxFailure
|
|
1132 |
* \brief RX Failure/Error
|
|
1133 |
*
|
|
1134 |
* \par Description
|
|
1135 |
*
|
|
1136 |
* \sa
|
|
1137 |
*/
|
|
1138 |
typedef enum
|
|
1139 |
{
|
|
1140 |
/* 0 */ RX_FAILURE_NONE = 0, /**< No Failure */
|
|
1141 |
/* 1 */ RX_FAILURE_DECRYPT, /**< DeCrypt Failure */
|
|
1142 |
/* 2 */ RX_FAILURE_MIC_ERROR, /**< MIC Error */
|
|
1143 |
} ERxFailure;
|
|
1144 |
|
|
1145 |
/** \enum ETwdChannelWidth
|
|
1146 |
* \brief TWD Channel Width
|
|
1147 |
*
|
|
1148 |
* \par Description
|
|
1149 |
* Used for Configure HT Capabilities Settings
|
|
1150 |
*
|
|
1151 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1152 |
*/
|
|
1153 |
typedef enum
|
|
1154 |
{
|
|
1155 |
/* 0 */ CHANNEL_WIDTH_20MHZ = 0, /**< 20MHZ Channel Width */
|
|
1156 |
/* 1 */ CHANNEL_WIDTH_40MHZ_20MHZ /**< 40-20MHZ Channel Width */
|
|
1157 |
} ETwdChannelWidth;
|
|
1158 |
|
|
1159 |
/** \enum ETwdRxSTBC
|
|
1160 |
* \brief RX STBC Spatial Stream Supported
|
|
1161 |
*
|
|
1162 |
* \par Description
|
|
1163 |
* Indicates how many RX STBC Spatial Stream are Supported
|
|
1164 |
* Used for Configure HT Capabilities Settings
|
|
1165 |
*
|
|
1166 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1167 |
*/
|
|
1168 |
typedef enum
|
|
1169 |
{
|
|
1170 |
/* 0 */ RXSTBC_NOT_SUPPORTED = 0, /**< No Spatial Stream Supported */
|
|
1171 |
/* 1 */ RXSTBC_SUPPORTED_ONE_SPATIAL_STREAM, /**< One Spatial Stream Supported */
|
|
1172 |
/* 2 */ RXSTBC_SUPPORTED_ONE_AND_TWO_SPATIAL_STREAMS, /**< One and Two Spatial Stream Supported */
|
|
1173 |
/* 3 */ RXSTBC_SUPPORTED_ONE_TWO_AND_THREE_SPATIAL_STREAMS /**< One, Two and Three Spatial Stream Supported */
|
|
1174 |
|
|
1175 |
} ETwdRxSTBC;
|
|
1176 |
|
|
1177 |
/** \enum ETwdMaxAMSDU
|
|
1178 |
* \brief Maximum MSDU Octets
|
|
1179 |
*
|
|
1180 |
* \par Description
|
|
1181 |
* Used for Configure HT Capabilities Settings
|
|
1182 |
*
|
|
1183 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1184 |
*/
|
|
1185 |
typedef enum
|
|
1186 |
{
|
|
1187 |
/* 0 */ MAX_MSDU_3839_OCTETS = 0, /**< Maximum MSDU Octets Number: 3839 */
|
|
1188 |
/* 1 */ MAX_MSDU_7935_OCTETS /**< Maximum MSDU Octets Number: 7935 */
|
|
1189 |
|
|
1190 |
} ETwdMaxAMSDU;
|
|
1191 |
|
|
1192 |
/** \enum ETwdMaxAMPDU
|
|
1193 |
* \brief Maximum MPDU Octets
|
|
1194 |
*
|
|
1195 |
* \par Description
|
|
1196 |
* Indicates What is the Maximum MPDU Octets Number
|
|
1197 |
* Used for Configure HT Capabilities Settings
|
|
1198 |
*
|
|
1199 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1200 |
*/
|
|
1201 |
typedef enum
|
|
1202 |
{
|
|
1203 |
/* 0 */ MAX_MPDU_8191_OCTETS = 0, /**< Maximum MPDU Octets Number: 8191 */
|
|
1204 |
/* 1 */ MAX_MPDU_16383_OCTETS, /**< Maximum MPDU Octets Number: 16383 */
|
|
1205 |
/* 2 */ MAX_MPDU_32767_OCTETS, /**< Maximum MPDU Octets Number: 32767 */
|
|
1206 |
/* 3 */ MAX_MPDU_65535_OCTETS /**< Maximum MPDU Octets Number: 65535 */
|
|
1207 |
|
|
1208 |
} ETwdMaxAMPDU;
|
|
1209 |
|
|
1210 |
/** \enum ETwdAMPDUSpacing
|
|
1211 |
* \brief TWD AMPDU Spacing
|
|
1212 |
*
|
|
1213 |
* \par Description
|
|
1214 |
* Indicates What is the Time Spacing of AMPDU
|
|
1215 |
* Used for Configure HT Capabilities Settings
|
|
1216 |
*
|
|
1217 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1218 |
*/
|
|
1219 |
typedef enum
|
|
1220 |
{
|
|
1221 |
/* 0 */ AMPDU_SPC_NO_RESTRCITION = 0, /**< No Restriction on AMPDU Time Spacing */
|
|
1222 |
/* 1 */ AMPDU_SPC_1_4_MICROSECONDS, /**< 1/4 Microsecond AMPDU Time Spacing */
|
|
1223 |
/* 2 */ AMPDU_SPC_1_2_MICROSECONDS, /**< 1/2 Microsecond AMPDU Time Spacing */
|
|
1224 |
/* 3 */ AMPDU_SPC_1_MICROSECOND, /**< 1 Microsecond AMPDU Time Spacing */
|
|
1225 |
/* 4 */ AMPDU_SPC_2_MICROSECONDS, /**< 2 Microsecond AMPDU Time Spacing */
|
|
1226 |
/* 5 */ AMPDU_SPC_4_MICROSECONDS, /**< 4 Microsecond AMPDU Time Spacing */
|
|
1227 |
/* 6 */ AMPDU_SPC_8_MICROSECONDS, /**< 8 Microsecond AMPDU Time Spacing */
|
|
1228 |
/* 7 */ AMPDU_SPC_16_MICROSECONDS /**< 16 Microsecond AMPDU Time Spacing */
|
|
1229 |
|
|
1230 |
} ETwdAMPDUSpacing;
|
|
1231 |
|
|
1232 |
/** \enum ETwdMcsSupport
|
|
1233 |
* \brief TWD MCS Support
|
|
1234 |
*
|
|
1235 |
* \par Description
|
|
1236 |
* BIT Mapp which Indicates What is the Tx/rx MCS Support Enabled
|
|
1237 |
* Used for Configure HT Capabilities Settings
|
|
1238 |
*
|
|
1239 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1240 |
*/
|
|
1241 |
typedef enum
|
|
1242 |
{
|
|
1243 |
/* 1 */ MCS_SUPPORT_MCS_0 = BIT_0, /**< BIT 0 */
|
|
1244 |
/* 2 */ MCS_SUPPORT_MCS_1 = BIT_1, /**< BIT 1 */
|
|
1245 |
/* 3 */ MCS_SUPPORT_MCS_2 = BIT_2, /**< BIT 2 */
|
|
1246 |
/* 4 */ MCS_SUPPORT_MCS_3 = BIT_3, /**< BIT 3 */
|
|
1247 |
/* 5 */ MCS_SUPPORT_MCS_4 = BIT_4, /**< BIT 4 */
|
|
1248 |
/* 6 */ MCS_SUPPORT_MCS_5 = BIT_5, /**< BIT 5 */
|
|
1249 |
/* 7 */ MCS_SUPPORT_MCS_6 = BIT_6, /**< BIT 6 */
|
|
1250 |
/* 8 */ MCS_SUPPORT_MCS_7 = BIT_7 /**< BIT 7 */
|
|
1251 |
|
|
1252 |
} ETwdMcsSupport;
|
|
1253 |
|
|
1254 |
/** \enum ETwdPCOTransTime
|
|
1255 |
* \brief TWD PCO Transition Time
|
|
1256 |
*
|
|
1257 |
* \par Description
|
|
1258 |
* Indicates What is the PCO Transition Time
|
|
1259 |
* Used for Configure HT Capabilities Settings
|
|
1260 |
*
|
|
1261 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1262 |
*/
|
|
1263 |
typedef enum
|
|
1264 |
{
|
|
1265 |
/* 0 */ PCO_TRANS_TIME_NO_TRANSITION = 0, /**< No PCO Transition Time */
|
|
1266 |
/* 1 */ PCO_TRANS_TIME_400_MICROSECONDS, /**< PCO Transition Time: 400 Microsecond */
|
|
1267 |
/* 2 */ PCO_TRANS_TIME_1_5_MILLISECONDS, /**< PCO Transition Time: 1.5 Millisecond */
|
|
1268 |
/* 3 */ PCO_TRANS_TIME_5_MILLISECONDS /**< PCO Transition Time: 5 Millisecond */
|
|
1269 |
|
|
1270 |
} ETwdPCOTransTime;
|
|
1271 |
|
|
1272 |
/** \enum ETwdHTCapabilitiesBitMask
|
|
1273 |
* \brief TWD HT Capabilities Bit Mask Mapping
|
|
1274 |
*
|
|
1275 |
* \par Description
|
|
1276 |
* Mapps the Bit Mask which are used for Making (Enabling/Disabling)
|
|
1277 |
* HT Capabilities
|
|
1278 |
*
|
|
1279 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1280 |
*/
|
|
1281 |
typedef enum
|
|
1282 |
{
|
|
1283 |
/* 1 */ CAP_BIT_MASK_GREENFIELD_FRAME_FORMAT = BIT_0, /**< BIT 0 */
|
|
1284 |
/* 2 */ CAP_BIT_MASK_SHORT_GI_FOR_20MHZ_PACKETS = BIT_1, /**< BIT 1 */
|
|
1285 |
/* 3 */ CAP_BIT_MASK_SHORT_GI_FOR_40MHZ_PACKETS = BIT_2, /**< BIT 2 */
|
|
1286 |
/* 4 */ CAP_BIT_MASK_SUPPORT_FOR_STBC_IN_TRANSMISSION = BIT_3, /**< BIT 3 */
|
|
1287 |
/* 5 */ CAP_BIT_MASK_DELAYED_BLOCK_ACK = BIT_4, /**< BIT 4 */
|
|
1288 |
/* 6 */ CAP_BIT_MASK_DSSS_CCK_IN_40_MHZ = BIT_5, /**< BIT 5 */
|
|
1289 |
/* 7 */ CAP_BIT_MASK_LSIG_TXOP_PROTECTION = BIT_6, /**< BIT 6 */
|
|
1290 |
/* 8 */ CAP_BIT_MASK_PCO = BIT_7, /**< BIT 7 */
|
|
1291 |
/* 9 */ CAP_BIT_MASK_LDPC_CODING = BIT_8 /**< BIT 8 */
|
|
1292 |
|
|
1293 |
} ETwdHTCapabilitiesBitMask;
|
|
1294 |
|
|
1295 |
/** \enum ETwdMCSFeedback
|
|
1296 |
* \brief TWD MCS FeedBack
|
|
1297 |
*
|
|
1298 |
* \par Description
|
|
1299 |
* Indicates what is the MCS FeedBack Policy
|
|
1300 |
* Used for Configure HT Capabilities Settings
|
|
1301 |
*
|
|
1302 |
* \sa TWD_SetDefaults, TTwdHtCapabilities
|
|
1303 |
*/
|
|
1304 |
typedef enum
|
|
1305 |
{
|
|
1306 |
/* 0 */ MCS_FEEDBACK_NO = 0, /**< */
|
|
1307 |
/* 1 */ MCS_FEEDBACK_RESERVED, /**< */
|
|
1308 |
/* 2 */ MCS_FEEDBACK_UNSOLICTED_ONLY, /**< */
|
|
1309 |
/* 3 */ MCS_FEEDBACK_BOTH_SOLICTED_AND_UNSOLICTED /**< */
|
|
1310 |
} ETwdMCSFeedback;
|
|
1311 |
|
|
1312 |
/** \enum ETwdTxMcsSet
|
|
1313 |
* \brief TWD TX MCS Set
|
|
1314 |
*
|
|
1315 |
* \par Description
|
|
1316 |
* Indicates Whether to set Tx MCS
|
|
1317 |
*
|
|
1318 |
* \sa
|
|
1319 |
*/
|
|
1320 |
typedef enum
|
|
1321 |
{
|
|
1322 |
TX_MCS_SET_NO = 0, /**< Don't Set Tx MCS */
|
|
1323 |
TX_MCS_SET_YES = 1 /**< Set Tx MCS */
|
|
1324 |
} ETwdTxMcsSet;
|
|
1325 |
|
|
1326 |
/** \enum ETwdTxRxNotEqual
|
|
1327 |
* \brief TWD TX RX Not Equal
|
|
1328 |
*
|
|
1329 |
* \par Description
|
|
1330 |
* Indicates Whether the TX and RX channels are equal
|
|
1331 |
*
|
|
1332 |
* \sa
|
|
1333 |
*/
|
|
1334 |
typedef enum
|
|
1335 |
{
|
|
1336 |
TX_RX_NOT_EQUAL_NO = 0, /**< TX and RX Channels are not equal */
|
|
1337 |
TX_RX_NOT_EQUAL_YES = 1 /**< TX and RX Channels are equal */
|
|
1338 |
} ETwdTxRxNotEqual;
|
|
1339 |
|
|
1340 |
/** \enum ETwdHtcSupport
|
|
1341 |
* \brief TWD HTc Support
|
|
1342 |
*
|
|
1343 |
* \par Description
|
|
1344 |
* Indicates Whether the HT Capability is Supported
|
|
1345 |
*
|
|
1346 |
* \sa
|
|
1347 |
*/
|
|
1348 |
typedef enum
|
|
1349 |
{
|
|
1350 |
HTC_SUPPORT_NO = 0, /**< HT Capability is not Supported */
|
|
1351 |
HTC_SUPPORT_YES = 1 /**< HT Capability is Supported */
|
|
1352 |
} ETwdHtcSupport;
|
|
1353 |
|
|
1354 |
/** \enum ESendCompleteStatus
|
|
1355 |
* \brief Send complete status
|
|
1356 |
*
|
|
1357 |
* \par Description
|
|
1358 |
* Indicates the current Success/Failure Status of Completion of Send Operation
|
|
1359 |
*
|
|
1360 |
* \sa
|
|
1361 |
*/
|
|
1362 |
typedef enum
|
|
1363 |
{
|
|
1364 |
/* 0 */ SEND_COMPLETE_SUCCESS = 0, /**< Send Complete Success: Completion of Send Operation is OK
|
|
1365 |
*/
|
|
1366 |
/* 1 */ SEND_COMPLETE_RETRY_EXCEEDED, /**< Send Complete Retry Exceeded:
|
|
1367 |
* Completion of Send Operation filed because it Exceeded Allowed retries Number
|
|
1368 |
*/
|
|
1369 |
/* 2 */ SEND_COMPLETE_LIFETIME_EXCEEDED, /**< Send Complete Lifetiem Exceeded:
|
|
1370 |
* Completion of Send Operation failed because it Exceeded Allowed Lifetime
|
|
1371 |
*/
|
|
1372 |
/* 3 */ SEND_COMPLETE_NO_LINK, /**< Send Complete No Link:
|
|
1373 |
* Completion of Send Operation failed because No Link was found
|
|
1374 |
*/
|
|
1375 |
/* 4 */ SEND_COMPLETE_MAC_CRASHED /**< Send Complete MAC Crashed:
|
|
1376 |
* Completion of Send Operation failed because MAC Crashed
|
|
1377 |
*/
|
|
1378 |
} ESendCompleteStatus;
|
|
1379 |
|
|
1380 |
/** \enum EPacketType
|
|
1381 |
* \brief Packet type
|
|
1382 |
*
|
|
1383 |
* \par Description
|
|
1384 |
*
|
|
1385 |
* \sa
|
|
1386 |
*/
|
|
1387 |
typedef enum
|
|
1388 |
{
|
|
1389 |
/* 0 */ PACKET_DATA = 0, /**< */
|
|
1390 |
/* 1 */ PACKET_CTRL, /**< */
|
|
1391 |
/* 2 */ PACKET_MGMT /**< */
|
|
1392 |
|
|
1393 |
} EPacketType;
|
|
1394 |
|
|
1395 |
/** \enum ETxHwQueStatus
|
|
1396 |
* \brief Status returned by txHwQueue_AllocResources
|
|
1397 |
*
|
|
1398 |
* \par Description
|
|
1399 |
*
|
|
1400 |
* \sa
|
|
1401 |
*/
|
|
1402 |
typedef enum
|
|
1403 |
{
|
|
1404 |
TX_HW_QUE_STATUS_SUCCESS, /* Resources available on current queue */
|
|
1405 |
TX_HW_QUE_STATUS_STOP_CURRENT, /* No resources, stop current queue and requeue the packet */
|
|
1406 |
TX_HW_QUE_STATUS_STOP_NEXT /* Resources available for this packet but not for another one,
|
|
1407 |
so just stop the current queue */
|
|
1408 |
} ETxHwQueStatus;
|
|
1409 |
|
|
1410 |
/** \enum ERxBufferStatus
|
|
1411 |
* \brief Status returned by TRequestForBufferCb
|
|
1412 |
*
|
|
1413 |
* \par Description
|
|
1414 |
*
|
|
1415 |
* \sa
|
|
1416 |
*/
|
|
1417 |
typedef enum
|
|
1418 |
{
|
|
1419 |
RX_BUF_ALLOC_PENDING,
|
|
1420 |
RX_BUF_ALLOC_COMPLETE,
|
|
1421 |
RX_BUF_ALLOC_OUT_OF_MEM
|
|
1422 |
|
|
1423 |
}ERxBufferStatus;
|
|
1424 |
|
|
1425 |
|
|
1426 |
/*
|
|
1427 |
* --------------------------------------------------------------
|
|
1428 |
* Structures
|
|
1429 |
* --------------------------------------------------------------
|
|
1430 |
*/
|
|
1431 |
/**
|
|
1432 |
* \brief Get File Callback
|
|
1433 |
*
|
|
1434 |
* \param hCbHndl - Handle to CB Object
|
|
1435 |
* \return void
|
|
1436 |
*
|
|
1437 |
* \par Description
|
|
1438 |
* The callback function type for GetFile users
|
|
1439 |
*
|
|
1440 |
* \sa TFileInfo
|
|
1441 |
*/
|
|
1442 |
typedef void (*TGetFileCbFunc)(TI_HANDLE hCbHndl);
|
|
1443 |
|
|
1444 |
/** \struct TFileInfo
|
|
1445 |
* \brief File Information
|
|
1446 |
*
|
|
1447 |
* \par Description
|
|
1448 |
* Contains all needed information and structures for Getting file
|
|
1449 |
*
|
|
1450 |
* \sa TWD_InitFw
|
|
1451 |
*/
|
|
1452 |
typedef struct
|
|
1453 |
{
|
|
1454 |
EFileType eFileType; /**< Requested file type */
|
|
1455 |
TI_UINT8 *pBuffer; /**< Pointer to Buffer into the file (or file portion) is copied from user space */
|
|
1456 |
TI_UINT32 uLength; /**< Length of data currently held in pBuffer */
|
|
1457 |
TI_UINT32 uOffset; /**< Offset in File of data currently held in pBuffer */
|
|
1458 |
TI_UINT32 uAddress; /**< Offset in File of data currently held in pBuffer */
|
|
1459 |
TI_BOOL bLast; /**< TRUE indicates that we reached end of file */
|
|
1460 |
void *hOsFileDesc; /**< OAL file-descriptor handle for repeated access to same file (FW) */
|
|
1461 |
TGetFileCbFunc fCbFunc; /**< CB function to call if file read is finished in a later context (future option) */
|
|
1462 |
TI_HANDLE hCbHndl; /**< Handle to provide when calling fCbFunc */
|
|
1463 |
TI_UINT32 uChunksLeft; /**< Chunks Left to read from File (used if file is read in chunks) */
|
|
1464 |
TI_UINT32 uChunkBytesLeft; /**< Number of bytes of Last read chunk, which were not yet handled */
|
|
1465 |
TI_UINT32 uCrcCalc; /**< Current Calculated CRC */
|
|
1466 |
} TFileInfo;
|
|
1467 |
|
|
1468 |
/** \struct T80211Header
|
|
1469 |
* \brief 802.11 MAC header
|
|
1470 |
*
|
|
1471 |
* \par Description
|
|
1472 |
*
|
|
1473 |
* \sa
|
|
1474 |
*/
|
|
1475 |
typedef struct
|
|
1476 |
{
|
|
1477 |
TI_UINT16 fc; /**< */
|
|
1478 |
TI_UINT16 dur; /**< */
|
|
1479 |
TMacAddr address1; /**< */
|
|
1480 |
TMacAddr address2; /**< */
|
|
1481 |
TMacAddr address3; /**< */
|
|
1482 |
TI_UINT16 seq; /**< */
|
|
1483 |
TI_UINT16 qos; /**< */
|
|
1484 |
|
|
1485 |
} T80211Header;
|
|
1486 |
|
|
1487 |
/** \struct TKeepAliveParams
|
|
1488 |
* \brief Keep Alive Parameters
|
|
1489 |
*
|
|
1490 |
* \par Description
|
|
1491 |
*
|
|
1492 |
* \sa TWD_CfgKeepAlive
|
|
1493 |
*/
|
|
1494 |
typedef struct
|
|
1495 |
{
|
|
1496 |
TI_UINT8 index; /**< */
|
|
1497 |
TI_UINT8 enaDisFlag; /**< */
|
|
1498 |
TI_UINT32 interval; /**< */
|
|
1499 |
EKeepAliveTriggerType trigType; /**< */
|
|
1500 |
|
|
1501 |
} TKeepAliveParams;
|
|
1502 |
|
|
1503 |
/** \struct TPsRxStreaming
|
|
1504 |
* \brief Power Save RX Streaming
|
|
1505 |
*
|
|
1506 |
* \par Description
|
|
1507 |
* The configuration of Rx streaming delivery in PS mode per TID
|
|
1508 |
*
|
|
1509 |
* \sa TWD_CfgKeepAlive
|
|
1510 |
*/
|
|
1511 |
typedef struct
|
|
1512 |
{
|
|
1513 |
TI_UINT32 uTid; /**< The configured TID (0-7) */
|
|
1514 |
TI_UINT32 uStreamPeriod; /**< The expected period between two packets of the delivered stream */
|
|
1515 |
TI_UINT32 uTxTimeout; /**< Start sending triggers if no Tx traffic triggers arrive for this priod */
|
|
1516 |
TI_BOOL bEnabled; /**< If TRUE enable this TID streaming, if FALSE disable it. */
|
|
1517 |
|
|
1518 |
} TPsRxStreaming;
|
|
1519 |
|
|
1520 |
/** \struct TDmaParams
|
|
1521 |
* \brief DMA Parameters
|
|
1522 |
*
|
|
1523 |
* \par Description
|
|
1524 |
* Struct which holds DMA Rx/Tx Queues and Bufffers params
|
|
1525 |
*
|
|
1526 |
* \sa
|
|
1527 |
*/
|
|
1528 |
typedef struct
|
|
1529 |
{
|
|
1530 |
TI_UINT32 NumRxBlocks; /**< Allocated RX memory blocks number */
|
|
1531 |
TI_UINT32 NumTxBlocks; /**< Allocated TX memory blocks number */
|
|
1532 |
TI_UINT8 NumStations; /**< Number of Stations */
|
|
1533 |
void *fwTxResultInterface; /**< RX minimum Memory block number */
|
|
1534 |
TI_UINT8 *fwRxCBufPtr; /**< Pointer to FW RX Control Buffer */
|
|
1535 |
TI_UINT8 *fwTxCBufPtr; /**< Pointer to FW TX Control Buffer */
|
|
1536 |
void *fwRxControlPtr; /**< Pointer to FW TX Control */
|
|
1537 |
void *fwTxControlPtr; /**< Pointer to FW RX Control */
|
|
1538 |
TI_UINT32 PacketMemoryPoolStart; /**< RX Memory block offset */
|
|
1539 |
} TDmaParams;
|
|
1540 |
|
|
1541 |
/** \struct TSecurityKeys
|
|
1542 |
* \brief Security Key
|
|
1543 |
*
|
|
1544 |
* \par Description
|
|
1545 |
* Struct which holds Security Key Parameters
|
|
1546 |
* Used for handling DMA
|
|
1547 |
*
|
|
1548 |
* \sa
|
|
1549 |
*/
|
|
1550 |
typedef struct
|
|
1551 |
{
|
|
1552 |
EKeyType keyType; /**< Security Key Type (WEP, TKIP etc.) */
|
|
1553 |
TI_UINT32 encLen; /**< Security Key length in bytes */
|
|
1554 |
TI_UINT8 encKey[MAX_KEY_LEN]; /**< Security Key Encoding */
|
|
1555 |
TI_UINT8 micRxKey[MAX_KEY_LEN]; /**< MIC RX Security Key */
|
|
1556 |
TI_UINT8 micTxKey[MAX_KEY_LEN]; /**< MIC TX Security Key */
|
|
1557 |
TI_UINT32 keyIndex; /**< Security Key Index (id=0 is broadcast key) */
|
|
1558 |
TMacAddr macAddress; /**< Security Key MAC Address */
|
|
1559 |
TI_UINT8 keyRsc[KEY_RSC_LEN]; /**< Security Key RSC */
|
|
1560 |
|
|
1561 |
} TSecurityKeys;
|
|
1562 |
|
|
1563 |
/** \struct TxPktParams_t
|
|
1564 |
* \brief TX Packet Parameters
|
|
1565 |
*
|
|
1566 |
* \par Description
|
|
1567 |
* Tx Control-Block Packet parameters that are not included in the Tx-descriptor
|
|
1568 |
*
|
|
1569 |
* \sa
|
|
1570 |
*/
|
|
1571 |
typedef struct
|
|
1572 |
{
|
|
1573 |
void * pInputPkt; /**< The input packet to the Tx path, either OS packet or raw buffer (see RAW_BUF_PKT flag) */
|
|
1574 |
TI_UINT32 uInputPktLen; /**< The input packet length in bytes (for freeing it in case of raw buffer) */
|
|
1575 |
TI_UINT32 uDriverDelay; /**< The time in uSec the pkt was delayed in the driver until Xfer */
|
|
1576 |
TI_UINT8 uPktType; /**< See TX_PKT_TYPE_xxxx above */
|
|
1577 |
TI_UINT8 uHeadroomSize; /**< Only for WHA - headroom in bytes before the payload in the packet buffer */
|
|
1578 |
TI_UINT16 uFlags; /**< See TX_CTRL_FLAG__xxxx above */
|
|
1579 |
|
|
1580 |
} TTxPktParams;
|
|
1581 |
|
|
1582 |
|
|
1583 |
/** \struct TTxCtrlBlk
|
|
1584 |
* \brief TX Control Block Entry
|
|
1585 |
*
|
|
1586 |
* \par Description
|
|
1587 |
* Contains the Tx packet parameters required for the Tx process, including
|
|
1588 |
* the Tx descriptor and the attributes required for HW-queue calculations.
|
|
1589 |
* TX Control Block Entry is allocated for each packet sent from the upper
|
|
1590 |
* driver and freed upon Tx-complete.
|
|
1591 |
* The entry index is the descriptor-ID. It is written in the descriptor and
|
|
1592 |
* copied back into the tx-complete results
|
|
1593 |
*
|
|
1594 |
* \sa SendPacketTranferCB_t, SendPacketDebugCB_t, TWD_txCtrlBlk_alloc, TWD_txCtrlBlk_free, TWD_txCtrlBlk_GetPointer, TWD_txXfer_sendPacket
|
|
1595 |
*/
|
|
1596 |
typedef struct _TTxCtrlBlk
|
|
1597 |
{
|
|
1598 |
TTxnStruct tTxnStruct; /**< The transaction structure for packet queueing and transaction via the bus driver */
|
|
1599 |
TxIfDescriptor_t tTxDescriptor; /**< The packet descriptor copied to the FW */
|
|
1600 |
TI_UINT8 aPktHdr[MAX_HEADER_SIZE]; /**< The packet header + extensions (see description of MAX_HEADER_SIZE above) */
|
|
1601 |
TTxPktParams tTxPktParams; /**< Per packet parameters not included in the descriptor */
|
|
1602 |
struct _TTxCtrlBlk *pNextFreeEntry; /**< Pointer to the next free entry */
|
|
1603 |
|
|
1604 |
} TTxCtrlBlk;
|
|
1605 |
|
|
1606 |
|
|
1607 |
/** \struct TTemplateParams
|
|
1608 |
* \brief Template Parameters
|
|
1609 |
*
|
|
1610 |
* \par Description
|
|
1611 |
*
|
|
1612 |
* \sa TWD_GetTemplate
|
|
1613 |
*/
|
|
1614 |
typedef struct
|
|
1615 |
{
|
|
1616 |
TI_UINT32 Size; /**< Template size */
|
|
1617 |
TI_UINT32 uRateMask; /**< The rates bitmap for the frame */
|
|
1618 |
TI_UINT8 Buffer[MAX_TEMPLATE_SIZE]; /**< Buffer which holds Template */
|
|
1619 |
|
|
1620 |
} TTemplateParams;
|
|
1621 |
|
|
1622 |
/** \struct TFwInfo
|
|
1623 |
* \brief FW Information
|
|
1624 |
*
|
|
1625 |
* \par Description
|
|
1626 |
*
|
|
1627 |
* \sa TWD_GetFWInfo
|
|
1628 |
*/
|
|
1629 |
typedef struct
|
|
1630 |
{
|
|
1631 |
TI_UINT8 fwVer[FW_VERSION_LEN]; /**< Firmware version - null terminated string */
|
|
1632 |
TMacAddr macAddress; /**< MAC Address */
|
|
1633 |
TI_UINT8 txPowerTable[NUMBER_OF_SUB_BANDS_E][NUM_OF_POWER_LEVEL]; /**< Maximun Dbm in Dbm/10 units */
|
|
1634 |
TI_UINT32 uHardWareVersion; /**< HW Version */
|
|
1635 |
|
|
1636 |
} TFwInfo;
|
|
1637 |
|
|
1638 |
/** \struct TJoinBss
|
|
1639 |
* \brief Join BSS Parameters
|
|
1640 |
*
|
|
1641 |
* \par Description
|
|
1642 |
*
|
|
1643 |
* \sa TWD_CmdJoinBss
|
|
1644 |
*/
|
|
1645 |
typedef struct
|
|
1646 |
{
|
|
1647 |
ScanBssType_e bssType; /**< */
|
|
1648 |
TI_UINT16 beaconInterval; /**< */
|
|
1649 |
TI_UINT16 dtimInterval; /**< */
|
|
1650 |
TI_UINT8 channel; /**< */
|
|
1651 |
TI_UINT8* pBSSID; /**< */
|
|
1652 |
TI_UINT8* pSSID; /**< */
|
|
1653 |
TI_UINT8 ssidLength; /**< */
|
|
1654 |
TI_UINT32 basicRateSet; /**< */
|
|
1655 |
ERadioBand radioBand; /**< */
|
|
1656 |
/* Current Tx-Session index as configured to FW in last Join command */
|
|
1657 |
TI_UINT16 txSessionCount; /**< */
|
|
1658 |
|
|
1659 |
} TJoinBss;
|
|
1660 |
|
|
1661 |
/** \struct TSetTemplate
|
|
1662 |
* \brief Set Template Parameters
|
|
1663 |
*
|
|
1664 |
* \par Description
|
|
1665 |
*
|
|
1666 |
* \sa TWD_CmdTemplate, TWD_WriteMibTemplateFrame
|
|
1667 |
*/
|
|
1668 |
typedef struct
|
|
1669 |
{
|
|
1670 |
ETemplateType type; /**< Template Type */
|
|
1671 |
TI_UINT8 index; /**< only valid for keep-alive templates */
|
|
1672 |
TI_UINT8* ptr; /**< Pointer to Template Data */
|
|
1673 |
TI_UINT32 len; /**< Pointer to Template Length */
|
|
1674 |
ERadioBand eBand; /**< only valid for probe request templates */
|
|
1675 |
TI_UINT32 uRateMask;/**< The rate mask to use for this frame */
|
|
1676 |
|
|
1677 |
} TSetTemplate;
|
|
1678 |
|
|
1679 |
/** \struct TNoiseHistogram
|
|
1680 |
* \brief Noise Histogram Parameters
|
|
1681 |
*
|
|
1682 |
* \par Description
|
|
1683 |
*
|
|
1684 |
* \sa TWD_CmdNoiseHistogram
|
|
1685 |
*/
|
|
1686 |
typedef struct
|
|
1687 |
{
|
|
1688 |
ENoiseHistogramCmd cmd; /**< Noise Histogram Command (Start/Atop) */
|
|
1689 |
TI_UINT16 sampleInterval; /**< Sample Interval (in microsec) */
|
|
1690 |
TI_UINT8 ranges [MEASUREMENT_NOISE_HISTOGRAM_NUM_OF_RANGES]; /**< Noise Histogram Ranges */
|
|
1691 |
|
|
1692 |
} TNoiseHistogram;
|
|
1693 |
|
|
1694 |
/** \struct TInterogateCmdHdr
|
|
1695 |
* \brief Interrogate Command Header
|
|
1696 |
*
|
|
1697 |
* \par Description
|
|
1698 |
*
|
|
1699 |
* \sa TNoiseHistogramResults, TMediumOccupancy, TTsfDtim
|
|
1700 |
*/
|
|
1701 |
typedef struct
|
|
1702 |
{
|
|
1703 |
TI_UINT16 id; /**< */
|
|
1704 |
TI_UINT16 len; /**< */
|
|
1705 |
|
|
1706 |
} TInterogateCmdHdr;
|
|
1707 |
|
|
1708 |
/** \struct TNoiseHistogramResults
|
|
1709 |
* \brief Noise Histogram Results
|
|
1710 |
*
|
|
1711 |
* \par Description
|
|
1712 |
* Used for Getting Noise Histogram Parameters from FW
|
|
1713 |
*
|
|
1714 |
* \sa
|
|
1715 |
*/
|
|
1716 |
typedef struct
|
|
1717 |
{
|
|
1718 |
TInterogateCmdHdr noiseHistResCmdHdr; /**< Results Header */
|
|
1719 |
TI_UINT32 counters[NUM_OF_NOISE_HISTOGRAM_COUNTERS]; /**< Counters */
|
|
1720 |
TI_UINT32 numOfLostCycles; /**< Number of Lost Cycles */
|
|
1721 |
TI_UINT32 numOfTxHwGenLostCycles; /**< Number of Tx Hw Gen Lost Cycles */
|
|
1722 |
TI_UINT32 numOfRxLostCycles; /**< Number of RX Hw Gen Lost Cycles */
|
|
1723 |
|
|
1724 |
} TNoiseHistogramResults;
|
|
1725 |
|
|
1726 |
/** \struct TMediumOccupancy
|
|
1727 |
* \brief Medium Occupancy Parameters
|
|
1728 |
*
|
|
1729 |
* \par Description
|
|
1730 |
* Used for Getting Medium Occupancy (Channal Load) from FW
|
|
1731 |
* or print Medium Occupancy (Channal Load) Debug Information
|
|
1732 |
*
|
|
1733 |
* \sa
|
|
1734 |
*/
|
|
1735 |
typedef struct
|
|
1736 |
{
|
|
1737 |
TInterogateCmdHdr mediumOccupCmdHdr; /**< Command Header */
|
|
1738 |
TI_UINT32 MediumUsage; /**< Medium Occupancy Usage Time */
|
|
1739 |
TI_UINT32 Period; /**< Medium Occupancy Period Time */
|
|
1740 |
|
|
1741 |
} TMediumOccupancy;
|
|
1742 |
|
|
1743 |
/** \struct TTsfDtim
|
|
1744 |
* \brief Beacon TSF and DTIM count
|
|
1745 |
*
|
|
1746 |
* \par Description
|
|
1747 |
* Used for Getting updated current TSF and last Beacon TSF and DTIM Count from FW
|
|
1748 |
* for Scan Purposes
|
|
1749 |
*
|
|
1750 |
* \sa
|
|
1751 |
*/
|
|
1752 |
typedef struct
|
|
1753 |
{
|
|
1754 |
TInterogateCmdHdr tsf_dtim_mibCmdHdr; /**< Command Header */
|
|
1755 |
TI_UINT32 CurrentTSFHigh; /**< Current TSF High (of INT64) Value */
|
|
1756 |
TI_UINT32 CurrentTSFLow; /**< Current TSF Low (of INT64) Value */
|
|
1757 |
TI_UINT32 lastTBTTHigh; /**< Last TBTT High (of INT64) Value */
|
|
1758 |
TI_UINT32 lastTBTTLow; /**< Last TBTT Low (of INT64) Value */
|
|
1759 |
TI_UINT8 LastDTIMCount; /**< Last DTIM Count */
|
|
1760 |
TI_UINT8 Reserved[3]; /**< Reserved */
|
|
1761 |
|
|
1762 |
} TTsfDtim;
|
|
1763 |
|
|
1764 |
/** \struct TBcnBrcOptions
|
|
1765 |
* \brief Beacon broadcast options
|
|
1766 |
*
|
|
1767 |
* \par Description
|
|
1768 |
* Used for Getting/Configuring updated Beacon broadcast options from/to FW
|
|
1769 |
*
|
|
1770 |
* \sa TWD_SetDefaults
|
|
1771 |
*/
|
|
1772 |
typedef struct
|
|
1773 |
{
|
|
1774 |
TI_UINT16 BeaconRxTimeout; /**< Beacon RX Timeout */
|
|
1775 |
TI_UINT16 BroadcastRxTimeout; /**< Broadcast RX Timeout */
|
|
1776 |
TI_UINT8 RxBroadcastInPs; /**< RX Broadcast In Power Save */
|
|
1777 |
|
|
1778 |
} TBcnBrcOptions;
|
|
1779 |
|
|
1780 |
/** \struct TBeaconFilterIeTable
|
|
1781 |
* \brief Beacon Filter Information Elements Table
|
|
1782 |
*
|
|
1783 |
* \par Description
|
|
1784 |
* Used for Getting/Configuring Beacon Filter IE Table From/To FW
|
|
1785 |
*
|
|
1786 |
* \sa TWD_SetDefaults
|
|
1787 |
*/
|
|
1788 |
typedef struct
|
|
1789 |
{
|
|
1790 |
TI_UINT8 numberOfIEs; /**< Number of IE Tables */
|
|
1791 |
TI_UINT8 IETable[BEACON_FILTER_TABLE_MAX_SIZE]; /**< The IE table */
|
|
1792 |
TI_UINT8 IETableSize; /**< number of elements in IE table */
|
|
1793 |
|
|
1794 |
} TBeaconFilterIeTable;
|
|
1795 |
|
|
1796 |
/** \struct TBeaconFilterInitParams
|
|
1797 |
* \brief Beacon Filter Init Parameters
|
|
1798 |
*
|
|
1799 |
* \par Description
|
|
1800 |
* Used for Init Beacon Filter IE Table in FW
|
|
1801 |
*
|
|
1802 |
* \sa
|
|
1803 |
*/
|
|
1804 |
typedef struct
|
|
1805 |
{
|
|
1806 |
TI_UINT8 desiredState; /**< Desigred state (required/not required) */
|
|
1807 |
TI_UINT8 numOfStored; /**< Number of desigred Beacon Filters stored in FW */
|
|
1808 |
TI_UINT8 numOfElements; /**< Number of Beacon Filter Elements stored in FW */
|
|
1809 |
TI_UINT8 IETableSize; /**< The IE Table size */
|
|
1810 |
TI_UINT8 reserve[3]; /**< Reserved */
|
|
1811 |
TI_UINT8 IETable[BEACON_FILTER_IE_TABLE_MAX_SIZE]; /**< The IE table */
|
|
1812 |
|
|
1813 |
} TBeaconFilterInitParams;
|
|
1814 |
|
|
1815 |
/** \struct TPowerMgmtConfig
|
|
1816 |
* \brief Power Management Configuration Parameters
|
|
1817 |
*
|
|
1818 |
* \par Description
|
|
1819 |
* Used for Configuring Wake-Up Conditions or Beacon Broadcast Options to FW
|
|
1820 |
*
|
|
1821 |
* \sa TWD_CfgWakeUpCondition, TWD_CfgBcnBrcOptions
|
|
1822 |
*/
|
|
1823 |
typedef struct
|
|
1824 |
{
|
|
1825 |
/* power management options */
|
|
1826 |
TI_UINT8 beaconListenInterval; /**< Beacon Listen Interavl:
|
|
1827 |
* specify how often the TNET wakes up to listen to beacon frames.
|
|
1828 |
* the value is expressed in units of "beacon interval"
|
|
1829 |
*/
|
|
1830 |
TI_UINT8 beaconFiltering; /**< Beacon Filtering Desigred state (required/not required) */
|
|
1831 |
TI_UINT8 DTIMListenInterval; /**< DTIM Listen Interavl:
|
|
1832 |
* specify how often the TNET wakes up to listen to DTIM frames. the value
|
|
1833 |
* is expressed in units of "dtim interval"
|
|
1834 |
*/
|
|
1835 |
TI_UINT8 NConsecutiveBeaconMiss; /**< Consecutive Beacon Miss */
|
|
1836 |
TI_UINT8 hangoverPeriod; /**< Hang Over Period */
|
|
1837 |
TI_UINT8 HwPsPollResponseTimeout; /**< Power-Save Polling Response Time Out */
|
|
1838 |
TI_UINT32 BaseBandWakeUpTime; /**< Base Band Wakeup Time */
|
|
1839 |
TI_UINT32 beaconReceiveTime; /**< Beacon Receive Time */
|
|
1840 |
TI_BOOL beaconMissInterruptEnable; /**< Enable/Disable Beacon Miss Interrupt */
|
|
1841 |
TI_BOOL rxBroadcast; /**< Enable/Disable receive of broadcast packets in Power-Save mode */
|
|
1842 |
TI_BOOL hwPsPoll; /**< Enable/Disable Power-Save Polling */
|
|
1843 |
/* Power Management Configuration IE */
|
|
1844 |
TI_BOOL ps802_11Enable; /**< Enable/Disable 802.11 Power-Save */
|
|
1845 |
TI_UINT8 needToSendNullData; /**< Indicates if need to send NULL data */
|
|
1846 |
TI_UINT8 numNullPktRetries; /**< Number of NULL Packets allowed retries */
|
|
1847 |
TI_UINT8 hangOverPeriod; /**< HangOver period:
|
|
1848 |
* Indicates what is the time in TUs during which the WiLink remains awake
|
|
1849 |
* after sending an MPDU with the Power Save bit set (indicating that the
|
|
1850 |
* station is to go into Power Save mode). Setting bit 0 does not affect
|
|
1851 |
* the hangover period
|
|
1852 |
*/
|
|
1853 |
TI_UINT16 NullPktRateModulation; /**< Null Packet Rate Modulation */
|
|
1854 |
/* PMConfigStruct */
|
|
1855 |
TI_BOOL ELPEnable; /**< Enable/Disable ELP */
|
|
1856 |
TI_UINT32 BBWakeUpTime; /**< Base Band Wakeup Time */
|
|
1857 |
TI_UINT32 PLLlockTime; /**< PLL Lock Time */
|
|
1858 |
/* AcxBcnBrcOptions */
|
|
1859 |
TBcnBrcOptions BcnBrcOptions; /**< Beacon broadcast options */
|
|
1860 |
/* ACXWakeUpCondition */
|
|
1861 |
ETnetWakeOn tnetWakeupOn; /**< ACX Wake Up Condition */
|
|
1862 |
TI_UINT8 listenInterval; /**< ACX Listen Interval */
|
|
1863 |
/* No answer after Ps-Poll work-around */
|
|
1864 |
TI_UINT8 ConsecutivePsPollDeliveryFailureThreshold; /**< Power-Save Polling Delivery Failure Threshold */
|
|
1865 |
|
|
1866 |
} TPowerMgmtConfig;
|
|
1867 |
|
|
1868 |
/** \struct TPowerSaveParams
|
|
1869 |
* \brief Power Save Parameters
|
|
1870 |
*
|
|
1871 |
* \par Description
|
|
1872 |
*
|
|
1873 |
* \sa TWD_CmdPSMode
|
|
1874 |
*/
|
|
1875 |
typedef struct
|
|
1876 |
{
|
|
1877 |
/* powerMgmtConfig IE */
|
|
1878 |
TI_BOOL ps802_11Enable; /**< Enable/Disable 802.11 Power-Save */
|
|
1879 |
TI_UINT8 needToSendNullData; /**< Indicates if need to send NULL data */
|
|
1880 |
TI_UINT8 numNullPktRetries; /**< Number of NULL Packets allowed retries */
|
|
1881 |
TI_UINT8 hangOverPeriod; /**< HangOver period:
|
|
1882 |
* Indicates what is the time in TUs during which the WiLink remains awake
|
|
1883 |
* after sending an MPDU with the Power Save bit set (indicating that the
|
|
1884 |
* station is to go into Power Save mode). Setting bit 0 does not affect
|
|
1885 |
* the hangover period
|
|
1886 |
*/
|
|
1887 |
EHwRateBitFiled NullPktRateModulation; /**< Null Packet Rate Modulation */
|
|
1888 |
|
|
1889 |
} TPowerSaveParams;
|
|
1890 |
|
|
1891 |
/** \struct TAcQosParams
|
|
1892 |
* \brief AC QoS Parameters
|
|
1893 |
*
|
|
1894 |
* \par Description
|
|
1895 |
* Used for Configuring AC Parameters (For Quality Of Service) to FW
|
|
1896 |
*
|
|
1897 |
* \sa TWD_CfgAcParams
|
|
1898 |
*/
|
|
1899 |
typedef struct
|
|
1900 |
{
|
|
1901 |
TI_UINT8 ac; /**< Access Category - The TX queue's access category */
|
|
1902 |
TI_UINT8 cwMin; /**< The contention window minimum size (in slots) */
|
|
1903 |
TI_UINT16 cwMax; /**< The contention window maximum size (in slots) */
|
|
1904 |
TI_UINT8 aifsn; /**< The AIF value (in slots) */
|
|
1905 |
TI_UINT16 txopLimit; /**< The TX Op Limit (in microseconds) */
|
|
1906 |
|
|
1907 |
} TAcQosParams;
|
|
1908 |
|
|
1909 |
/** \struct TMeasurementParams
|
|
1910 |
* \brief AC Queues Parameters
|
|
1911 |
*
|
|
1912 |
* \par Description
|
|
1913 |
* Used When Send Start Measurment Command to FW
|
|
1914 |
*
|
|
1915 |
* \sa TWD_CmdMeasurement
|
|
1916 |
*/
|
|
1917 |
typedef struct
|
|
1918 |
{
|
|
1919 |
TI_UINT32 ConfigOptions; /**< RX Filter Configuration Options */
|
|
1920 |
TI_UINT32 FilterOptions; /**< RX Filter Options */
|
|
1921 |
TI_UINT32 duration; /**< Specifies the measurement process duration in microseconds. The value of 0 means
|
|
1922 |
* infinite duration in which only a STOP_MEASUREMENT command can stop the measurement
|
|
1923 |
* process
|
|
1924 |
*/
|
|
1925 |
Channel_e channel; /**< Channel number on which the measurement is performed */
|
|
1926 |
RadioBand_e band; /**< Specifies the band to which the channel belongs */
|
|
1927 |
EScanResultTag eTag; /**< Scan Result Tag */
|
|
1928 |
|
|
1929 |
} TMeasurementParams;
|
|
1930 |
|
|
1931 |
/** \struct TApDiscoveryParams
|
|
1932 |
* \brief AP Discovery Parameters
|
|
1933 |
*
|
|
1934 |
* \par Description
|
|
1935 |
* Used When Performing AP Discovery
|
|
1936 |
*
|
|
1937 |
* \sa TWD_CmdApDiscovery
|
|
1938 |
*/
|
|
1939 |
typedef struct
|
|
1940 |
{
|
|
1941 |
TI_UINT32 ConfigOptions; /**< RX Configuration Options for measurement */
|
|
1942 |
TI_UINT32 FilterOptions; /**< RX Filter Configuration Options for measurement */
|
|
1943 |
TI_UINT32 scanDuration; /**< This field specifies the amount of time, in time units (TUs), to perform the AP discovery */
|
|
1944 |
TI_UINT16 scanOptions; /**< This field specifies whether the AP discovery is performed by an active scan or a passive scan
|
|
1945 |
* 0 - ACTIVE, 1 - PASSIVE
|
|
1946 |
*/
|
|
1947 |
TI_UINT8 numOfProbRqst; /**< This field indicates the number of probe requests to send per channel, when active scan is specified
|
|
1948 |
* Note: for XCC measurement this value should be set to 1
|
|
1949 |
*/
|
|
1950 |
TI_UINT8 txPowerDbm; /**< TX power level to be used for sending probe requests when active scan is specified.
|
|
1951 |
* If 0, leave normal TX power level for this channel
|
|
1952 |
*/
|
|
1953 |
EHwRateBitFiled txdRateSet; /**< This EHwBitRate format field specifies the rate and modulation to transmit the probe request when
|
|
1954 |
* an active scan is specifie
|
|
1955 |
*/
|
|
1956 |
ERadioBand eBand; /**< Specifies the band to which the channel belongs */
|
|
1957 |
} TApDiscoveryParams;
|
|
1958 |
|
|
1959 |
/** \struct TRroamingTriggerParams
|
|
1960 |
* \brief Roaming Trigger Parameters
|
|
1961 |
*
|
|
1962 |
* \par Description
|
|
1963 |
*
|
|
1964 |
* \sa TWD_CfgMaxTxRetry, TWD_CfgConnMonitParams
|
|
1965 |
*/
|
|
1966 |
typedef struct
|
|
1967 |
{
|
|
1968 |
/* ACXConsNackTriggerParameters */
|
|
1969 |
TI_UINT8 maxTxRetry; /**< The number of frames transmission failures before issuing the "Max Tx Retry" event */
|
|
1970 |
|
|
1971 |
/* ACXBssLossTsfSynchronize */
|
|
1972 |
TI_UINT16 TsfMissThreshold; /**< The number of consecutive beacons that can be lost before the WiLink raises the
|
|
1973 |
* SYNCHRONIZATION_TIMEOUT event
|
|
1974 |
*/
|
|
1975 |
TI_UINT16 BssLossTimeout; /**< The delay (in time units) between the time at which the device issues the SYNCHRONIZATION_TIMEOUT
|
|
1976 |
* event until, if no probe response or beacon is received a BSS_LOSS event is issued
|
|
1977 |
*/
|
|
1978 |
} TRroamingTriggerParams;
|
|
1979 |
|
|
1980 |
/** \struct TSwitchChannelParams
|
|
1981 |
* \brief Switch Channel Parameters
|
|
1982 |
*
|
|
1983 |
* \par Description
|
|
1984 |
* Used for Switch channel Command
|
|
1985 |
*
|
|
1986 |
* \sa TWD_CmdSwitchChannel
|
|
1987 |
*/
|
|
1988 |
typedef struct
|
|
1989 |
{
|
|
1990 |
TI_UINT8 channelNumber; /**< The new serving channel */
|
|
1991 |
TI_UINT8 switchTime; /**< Relative time of the serving channel switch in TBTT units */
|
|
1992 |
TI_UINT8 txFlag; /**< 1: Suspend TX till switch time; 0: Do not suspend TX */
|
|
1993 |
TI_UINT8 flush; /**< 1: Flush TX at switch time; 0: Do not flush */
|
|
1994 |
|
|
1995 |
} TSwitchChannelParams;
|
|
1996 |
|
|
1997 |
/** \struct TRxCounters
|
|
1998 |
* \brief RX Counters
|
|
1999 |
*
|
|
2000 |
* \par Description
|
|
2001 |
* Used for Getting RX Counters from FW
|
|
2002 |
*
|
|
2003 |
* \sa
|
|
2004 |
*/
|
|
2005 |
typedef struct
|
|
2006 |
{
|
|
2007 |
TI_UINT32 RecvError; /**< Number of frames that a NIC receives but does not indicate to the protocols due to errors */
|
|
2008 |
TI_UINT32 RecvNoBuffer; /**< Number of frames that the NIC cannot receive due to lack of NIC receive buffer space */
|
|
2009 |
TI_UINT32 FragmentsRecv; /**< Number of Fragments Received */
|
|
2010 |
TI_UINT32 FrameDuplicates; /**< Number of Farme Duplicates */
|
|
2011 |
TI_UINT32 FcsErrors; /**< Number of frames that a NIC receives but does not indicate to the protocols due to errors */
|
|
2012 |
|
|
2013 |
} TRxCounters;
|
|
2014 |
|
|
2015 |
/** \struct TApPowerConstraint
|
|
2016 |
* \brief AP Power Constraint
|
|
2017 |
*
|
|
2018 |
* \par Description
|
|
2019 |
*
|
|
2020 |
* \sa
|
|
2021 |
*/
|
|
2022 |
typedef struct
|
|
2023 |
{
|
|
2024 |
INFO_ELE_HDR /**< Information Element Header */
|
|
2025 |
int8 powerConstraintOnBss; /**< The attenuation from the regulatory power constraint as declared by the AP
|
|
2026 |
* Units: dBm ; Range: -20 - 30
|
|
2027 |
*/
|
|
2028 |
} TApPowerConstraint;
|
|
2029 |
|
|
2030 |
/*
|
|
2031 |
* TConfigCmdCbParams, TInterrogateCmdCbParams:
|
|
2032 |
* Note that this structure is used by the GWSI
|
|
2033 |
* both for setting (writing to the device) and
|
|
2034 |
* for retreiving (Reading from the device),
|
|
2035 |
* while being called with a completion CB
|
|
2036 |
*/
|
|
2037 |
/** \struct TConfigCmdCbParams
|
|
2038 |
* \brief Config Command CB Parameters
|
|
2039 |
*
|
|
2040 |
* \par Description
|
|
2041 |
* The CB Parameters (Completino CB, Handle to CB Parameters and buffer of Input/Output Parameters)
|
|
2042 |
* are used for Setting Parameters
|
|
2043 |
*
|
|
2044 |
* \sa TWD_SetParam
|
|
2045 |
*/
|
|
2046 |
typedef struct
|
|
2047 |
{
|
|
2048 |
void* fCb; /**< Completion CB function */
|
|
2049 |
TI_HANDLE hCb; /**< CB handle */
|
|
2050 |
void* pCb; /**< CBuffer contains the content to be written or the retrieved content */
|
|
2051 |
|
|
2052 |
} TConfigCmdCbParams;
|
|
2053 |
|
|
2054 |
/** \struct TInterrogateCmdCbParams
|
|
2055 |
* \brief Interrogate Command Parameters
|
|
2056 |
*
|
|
2057 |
* \par Description
|
|
2058 |
* Interrogate Command Parameters are the same as configuration Command CB Parameters
|
|
2059 |
*
|
|
2060 |
* \sa TWD_SetParam
|
|
2061 |
*/
|
|
2062 |
typedef TConfigCmdCbParams TInterrogateCmdCbParams;
|
|
2063 |
|
|
2064 |
/** \struct TRxTimeOut
|
|
2065 |
* \brief RX Time Out
|
|
2066 |
*
|
|
2067 |
* \par Description
|
|
2068 |
*
|
|
2069 |
* \sa
|
|
2070 |
*/
|
|
2071 |
typedef struct
|
|
2072 |
{
|
|
2073 |
TI_UINT16 psPoll; /**< The maximum time that the device will wait to receive traffic from the AP after transmission of PS-poll */
|
|
2074 |
TI_UINT16 UPSD; /**< The maximum time that the device will wait to receive traffic from the AP after transmission from UPSD
|
|
2075 |
* enabled queue
|
|
2076 |
*/
|
|
2077 |
} TRxTimeOut;
|
|
2078 |
|
|
2079 |
/** \struct TQueueTrafficParams
|
|
2080 |
* \brief RX Time Out
|
|
2081 |
*
|
|
2082 |
* \par Description
|
|
2083 |
*
|
|
2084 |
* \sa
|
|
2085 |
*/
|
|
2086 |
typedef struct
|
|
2087 |
{
|
|
2088 |
TI_UINT8 queueID; /**< The TX queue ID number (0-7) */
|
|
2089 |
TI_UINT8 channelType; /**< Channel access type for the queue Refer to ChannelType_enum */
|
|
2090 |
TI_UINT8 tsid; /**< for EDCA - the AC Index (0-3, refer to AccessCategory_enum).
|
|
2091 |
* For HCCA - HCCA Traffic Stream ID (TSID) of the queue (8-15)
|
|
2092 |
*/
|
|
2093 |
TI_UINT32 dot11EDCATableMSDULifeTime; /**< 802.11 EDCA Table MSDU Life Time */
|
|
2094 |
TI_UINT8 psScheme; /**< The power save scheme of the specified queue. Refer to PSScheme_enum */
|
|
2095 |
TI_UINT8 ackPolicy; /**< ACK policy per AC */
|
|
2096 |
TI_UINT32 APSDConf[2]; /**< APSD Configuration */
|
|
2097 |
|
|
2098 |
} TQueueTrafficParams;
|
|
2099 |
|
|
2100 |
|
|
2101 |
/** \struct TFmCoexParams
|
|
2102 |
* \brief FM Coexistence Parameters
|
|
2103 |
*
|
|
2104 |
* \par Description
|
|
2105 |
* Used for Setting/Printing FM Coexistence Parameters
|
|
2106 |
*
|
|
2107 |
* \sa
|
|
2108 |
*/
|
|
2109 |
typedef struct
|
|
2110 |
{
|
|
2111 |
TI_UINT8 uEnable; /* enable(1) / disable(0) the FM Coex feature */
|
|
2112 |
|
|
2113 |
TI_UINT8 uSwallowPeriod; /* Swallow period used in COEX PLL swallowing mechanism,
|
|
2114 |
Range: 0-0xFF, 0xFF = use FW default
|
|
2115 |
*/
|
|
2116 |
|
|
2117 |
TI_UINT8 uNDividerFrefSet1; /* The N divider used in COEX PLL swallowing mechanism for Fref of 38.4/19.2 Mhz.
|
|
2118 |
Range: 0-0xFF, 0xFF = use FW default
|
|
2119 |
*/
|
|
2120 |
|
|
2121 |
TI_UINT8 uNDividerFrefSet2; /* The N divider used in COEX PLL swallowing mechanism for Fref of 26/52 Mhz.
|
|
2122 |
Range: 0-0xFF, 0xFF = use FW default
|
|
2123 |
*/
|
|
2124 |
|
|
2125 |
TI_UINT16 uMDividerFrefSet1; /* The M divider used in COEX PLL swallowing mechanism for Fref of 38.4/19.2 Mhz.
|
|
2126 |
Range: 0-0x1FF, 0xFFFF = use FW default
|
|
2127 |
*/
|
|
2128 |
|
|
2129 |
TI_UINT16 uMDividerFrefSet2; /* The M divider used in COEX PLL swallowing mechanism for Fref of 26/52 Mhz.
|
|
2130 |
Range: 0-0x1FF, 0xFFFF = use FW default
|
|
2131 |
*/
|
|
2132 |
|
|
2133 |
TI_UINT32 uCoexPllStabilizationTime;/* The time duration in uSec required for COEX PLL to stabilize.
|
|
2134 |
0xFFFFFFFF = use FW default
|
|
2135 |
*/
|
|
2136 |
|
|
2137 |
TI_UINT16 uLdoStabilizationTime; /* The time duration in uSec required for LDO to stabilize.
|
|
2138 |
0xFFFFFFFF = use FW default
|
|
2139 |
*/
|
|
2140 |
|
|
2141 |
TI_UINT8 uFmDisturbedBandMargin; /* The disturbed frequency band margin around the disturbed
|
|
2142 |
frequency center (single sided).
|
|
2143 |
For example, if 2 is configured, the following channels
|
|
2144 |
will be considered disturbed channel:
|
|
2145 |
80 +- 0.1 MHz, 91 +- 0.1 MHz, 98 +- 0.1 MHz, 102 +- 0.1 MHz
|
|
2146 |
0xFF = use FW default
|
|
2147 |
*/
|
|
2148 |
|
|
2149 |
TI_UINT8 uSwallowClkDif; /* The swallow clock difference of the swallowing mechanism.
|
|
2150 |
0xFF = use FW default
|
|
2151 |
*/
|
|
2152 |
|
|
2153 |
} TFmCoexParams;
|
|
2154 |
|
|
2155 |
|
|
2156 |
/** \struct TMibBeaconFilterIeTable
|
|
2157 |
* \brief MIB Beacon Filter IE table
|
|
2158 |
*
|
|
2159 |
* \par Description
|
|
2160 |
* Used for Read/Write the MIB/IE Beacon Filter
|
|
2161 |
* NOTE: This struct is only meant to be used as a pointer reference to an actual buffer.
|
|
2162 |
* Table size is not a constant and is derived from the buffer size given with the
|
|
2163 |
* user command
|
|
2164 |
*
|
|
2165 |
* \sa TWD_WriteMibBeaconFilterIETable
|
|
2166 |
*/
|
|
2167 |
typedef struct
|
|
2168 |
{
|
|
2169 |
/* Number of information elements in table */
|
|
2170 |
TI_UINT8 iNumberOfIEs; /**< Input Number of IE Tables */
|
|
2171 |
TI_UINT8 iIETable[MIB_MAX_SIZE_OF_IE_TABLE]; /**< Input IE Table */
|
|
2172 |
|
|
2173 |
} TMibBeaconFilterIeTable;
|
|
2174 |
|
|
2175 |
/** \struct TMibCounterTable
|
|
2176 |
* \brief MIB Counter Table
|
|
2177 |
*
|
|
2178 |
* \par Description
|
|
2179 |
* Used for Getting Counters of MIB Table
|
|
2180 |
*
|
|
2181 |
* \sa
|
|
2182 |
*/
|
|
2183 |
typedef struct
|
|
2184 |
{
|
|
2185 |
TI_UINT32 PLCPErrorCount; /**< The number of PLCP errors since the last time this information element was interrogated.
|
|
2186 |
* This field is automatically cleared when it is interrogated
|
|
2187 |
*/
|
|
2188 |
TI_UINT32 FCSErrorCount; /**< The number of FCS errors since the last time this information element was interrogated.
|
|
2189 |
* This field is automatically cleared when it is interrogated
|
|
2190 |
*/
|
|
2191 |
TI_UINT32 SeqNumMissCount; /**< The number of missed sequence numbers in the squentially values of frames seq numbers */
|
|
2192 |
} TMibCounterTable;
|
|
2193 |
|
|
2194 |
/** \struct TMibWlanWakeUpInterval
|
|
2195 |
* \brief MIB WLAN Wake-Up Interval
|
|
2196 |
*
|
|
2197 |
* \par Description
|
|
2198 |
*
|
|
2199 |
* \sa
|
|
2200 |
*/
|
|
2201 |
typedef struct
|
|
2202 |
{
|
|
2203 |
TI_UINT32 WakeUpInterval; /**< Wake Up Interval */
|
|
2204 |
TI_UINT8 ListenInterval; /**< Listen interval in unit of the beacon/DTIM */
|
|
2205 |
|
|
2206 |
} TMibWlanWakeUpInterval;
|
|
2207 |
|
|
2208 |
/** \struct TMibTemplateFrame
|
|
2209 |
* \brief MIB Template Frame
|
|
2210 |
*
|
|
2211 |
* \par Description
|
|
2212 |
* Used for Writing MIB Frame Template to FW
|
|
2213 |
*
|
|
2214 |
* \sa TWD_WriteMibTemplateFrame
|
|
2215 |
*/
|
|
2216 |
typedef struct
|
|
2217 |
{
|
|
2218 |
EMibTemplateType FrameType; /**< MIB Farme Template type */
|
|
2219 |
TI_UINT32 Rate; /**< Frame Rate */
|
|
2220 |
TI_UINT16 Length; /**< Frame Length */
|
|
2221 |
TI_UINT8 Data [MIB_TEMPLATE_DATA_MAX_LEN]; /**< Frame Template Data */
|
|
2222 |
|
|
2223 |
} TMibTemplateFrame;
|
|
2224 |
|
|
2225 |
/** \struct TMibArpIpAddressesTable
|
|
2226 |
* \brief MIB ARP Address Table
|
|
2227 |
*
|
|
2228 |
* \par Description
|
|
2229 |
* Used for Writing MIB ARP Table Template to FW
|
|
2230 |
*
|
|
2231 |
* \sa TWD_WriteMib
|
|
2232 |
*/
|
|
2233 |
typedef struct
|
|
2234 |
{
|
|
2235 |
TI_UINT32 FilteringEnable; /**< Enable/Disable Filtering */
|
|
2236 |
TIpAddr addr; /**< IP Address Table */
|
|
2237 |
|
|
2238 |
} TMibArpIpAddressesTable;
|
|
2239 |
|
|
2240 |
/** \struct TMibGroupAdressTable
|
|
2241 |
* \brief MIB Group Address Table
|
|
2242 |
*
|
|
2243 |
* \par Description
|
|
2244 |
* Used for Writing MIB Group Table Template to FW
|
|
2245 |
*
|
|
2246 |
* \sa TWD_WriteMib
|
|
2247 |
*/
|
|
2248 |
typedef struct
|
|
2249 |
{
|
|
2250 |
TMacAddr aGroupTable[MIB_MAX_MULTICAST_GROUP_ADDRS]; /**< Table of Multicast Group Addresses */
|
|
2251 |
TI_UINT8 bFilteringEnable; /**< Enable/Disable Filtering */
|
|
2252 |
TI_UINT8 nNumberOfAddresses; /**< Number of Multicast Addresses */
|
|
2253 |
|
|
2254 |
} TMibGroupAdressTable;
|
|
2255 |
|
|
2256 |
/** \struct TTxRateClass
|
|
2257 |
* \brief TX Rate Class
|
|
2258 |
*
|
|
2259 |
* \par Description
|
|
2260 |
* Used for Set/Get TX Rate Policy Class to/from FW
|
|
2261 |
*
|
|
2262 |
* \sa
|
|
2263 |
*/
|
|
2264 |
typedef struct
|
|
2265 |
{
|
|
2266 |
TI_UINT32 txEnabledRates; /**< A Bit Mask which indicates which Rates are enabled */
|
|
2267 |
TI_UINT8 shortRetryLimit; /**< */
|
|
2268 |
TI_UINT8 longRetryLimit; /**< */
|
|
2269 |
TI_UINT8 flags; /**< */
|
|
2270 |
TI_UINT8 reserved; /**< for alignment with the FW API */
|
|
2271 |
|
|
2272 |
} TTxRateClass;
|
|
2273 |
|
|
2274 |
/** \struct TTxRatePolicy
|
|
2275 |
* \brief TX Rate Policy
|
|
2276 |
*
|
|
2277 |
* \par Description
|
|
2278 |
* Used for Set/Get TX Rate Policy to/from FW
|
|
2279 |
*
|
|
2280 |
* \sa
|
|
2281 |
*/
|
|
2282 |
typedef struct
|
|
2283 |
{
|
|
2284 |
TI_UINT32 numOfRateClasses; /**< */
|
|
2285 |
TTxRateClass rateClass[MAX_NUM_OF_TX_RATE_CLASS_POLICIES]; /**< */
|
|
2286 |
|
|
2287 |
} TTxRatePolicy;
|
|
2288 |
|
|
2289 |
/** \struct TCoexActivity
|
|
2290 |
* \brief CoexActivity Parameters
|
|
2291 |
*
|
|
2292 |
* \par Description
|
|
2293 |
*
|
|
2294 |
* \sa
|
|
2295 |
*/
|
|
2296 |
typedef struct {
|
|
2297 |
uint8 coexIp; /* 0-BT, 1-WLAN (according to CoexIp_e in FW) */
|
|
2298 |
uint8 activityId; /* According to BT/WLAN activity numbering in FW */
|
|
2299 |
uint8 defaultPriority; /* 0-255, activity default priority */
|
|
2300 |
uint8 raisedPriority; /* 0-255, activity raised priority */
|
|
2301 |
uint16 minService; /* 0-65535, The minimum service requested either in
|
|
2302 |
requests or in milliseconds depending on activity ID */
|
|
2303 |
uint16 maxService; /* 0-65535, The maximum service allowed either in
|
|
2304 |
requests or in milliseconds depending on activity ID */
|
|
2305 |
} TCoexActivity;
|
|
2306 |
|
|
2307 |
/** \struct THalCoexActivityTable
|
|
2308 |
* \brief CoexActivity Table Initialization Parameters
|
|
2309 |
*
|
|
2310 |
* \par Description
|
|
2311 |
*
|
|
2312 |
* \sa
|
|
2313 |
*/
|
|
2314 |
typedef struct
|
|
2315 |
{
|
|
2316 |
uint32 numOfElements;
|
|
2317 |
TCoexActivity entry[COEX_ACTIVITY_TABLE_MAX_NUM];
|
|
2318 |
|
|
2319 |
} THalCoexActivityTable;
|
|
2320 |
|
|
2321 |
/** \struct DcoItrimParams_t
|
|
2322 |
* \brief DCO Itrim params structure
|
|
2323 |
*
|
|
2324 |
* \par Description
|
|
2325 |
*
|
|
2326 |
* \sa
|
|
2327 |
*/
|
|
2328 |
typedef struct
|
|
2329 |
{
|
|
2330 |
Bool_e enable;
|
|
2331 |
uint32 moderationTimeoutUsec;
|
|
2332 |
}DcoItrimParams_t;
|
|
2333 |
|
|
2334 |
/** \union TMibData
|
|
2335 |
* \brief MIB Data
|
|
2336 |
*
|
|
2337 |
* \par Description
|
|
2338 |
* Union which defines all MIB Data types
|
|
2339 |
* Used for write MIB Configuration to FW
|
|
2340 |
*
|
|
2341 |
* \sa TWD_WriteMib
|
|
2342 |
*/
|
|
2343 |
typedef union
|
|
2344 |
{
|
|
2345 |
TMacAddr StationId; /**< Station ID MAC Address */
|
|
2346 |
TI_UINT32 MaxReceiveLifeTime; /**< HAl Control Max Rx MSDU Life Time, in TUs Units */
|
|
2347 |
TI_UINT32 SlotTime; /**< Radio (PHY) Slot Time Type */
|
|
2348 |
TMibGroupAdressTable GroupAddressTable; /**< MIB Group Address Table */
|
|
2349 |
TI_UINT8 WepDefaultKeyId; /**< WEP Defualt Security Key ID */
|
|
2350 |
TI_UINT8 PowerLevel; /**< */
|
|
2351 |
TI_UINT16 RTSThreshold; /**< */
|
|
2352 |
TI_UINT32 CTSToSelfEnable; /**< Enable/Disable CTS to Self */
|
|
2353 |
TMibArpIpAddressesTable ArpIpAddressesTable; /**< MIB ARP Address Table */
|
|
2354 |
TMibTemplateFrame TemplateFrame; /**< MIB Template Frame */
|
|
2355 |
TI_UINT8 RxFilter; /**< */
|
|
2356 |
TMibWlanWakeUpInterval WlanWakeUpInterval; /**< MIB WLAN Wake-Up Interval */
|
|
2357 |
TMibCounterTable CounterTable; /**< MIB Counter Table */
|
|
2358 |
TMibBeaconFilterIeTable BeaconFilter; /**< MIB Beacon Filter IE table */
|
|
2359 |
TTxRatePolicy txRatePolicy; /**< TX Rate Policy */
|
|
2360 |
|
|
2361 |
} TMibData;
|
|
2362 |
|
|
2363 |
/** \struct TMib
|
|
2364 |
* \brief MIB Structure
|
|
2365 |
*
|
|
2366 |
* \par Description
|
|
2367 |
* Used for writing MIB Configuration to FW
|
|
2368 |
*
|
|
2369 |
* \sa TWD_WriteMib, TWD_WriteMibTemplateFrame, TWD_WriteMibBeaconFilterIETable, TWD_WriteMibTxRatePolicy
|
|
2370 |
*/
|
|
2371 |
typedef struct
|
|
2372 |
{
|
|
2373 |
EMib aMib; /**< MIB Element Type */
|
|
2374 |
TI_UINT16 Length; /**< MIB Data Length */
|
|
2375 |
TMibData aData; /**< MIB Data */
|
|
2376 |
|
|
2377 |
} TMib;
|
|
2378 |
|
|
2379 |
/** \union TTwdParamContents
|
|
2380 |
* \brief TWD Parameters Content
|
|
2381 |
*
|
|
2382 |
* \par Description
|
|
2383 |
* All FW Parameters contents
|
|
2384 |
*
|
|
2385 |
* \sa TWD_SetParam
|
|
2386 |
*/
|
|
2387 |
typedef union
|
|
2388 |
{
|
|
2389 |
TI_UINT16 halCtrlRtsThreshold; /**< */
|
|
2390 |
TI_UINT8 halCtrlCtsToSelf; /**< */
|
|
2391 |
TRxTimeOut halCtrlRxTimeOut; /**< */
|
|
2392 |
TI_UINT16 halCtrlFragThreshold; /**< */
|
|
2393 |
TI_UINT16 halCtrlListenInterval; /**< */
|
|
2394 |
TI_UINT16 halCtrlCurrentBeaconInterval; /**< */
|
|
2395 |
TI_UINT8 halCtrlTxPowerDbm; /**< */
|
|
2396 |
ETxAntenna halCtrlTxAntenna; /**< */
|
|
2397 |
ERxAntenna halCtrlRxAntenna; /**< */
|
|
2398 |
TI_UINT8 halCtrlAifs; /**< */
|
|
2399 |
TI_BOOL halCtrlTxMemPoolQosAlgo; /**< */
|
|
2400 |
TI_BOOL halCtrlClkRunEnable; /**< */
|
|
2401 |
TRxCounters halCtrlCounters; /**< */
|
|
2402 |
|
|
2403 |
TMib* pMib; /**< */
|
|
2404 |
TI_UINT8 halCtrlCurrentChannel; /**< */
|
|
2405 |
|
|
2406 |
/* AC Qos parameters */
|
|
2407 |
TQueueTrafficParams *pQueueTrafficParams; /**< */
|
|
2408 |
|
|
2409 |
/* Security related parameters */
|
|
2410 |
#ifdef XCC_MODULE_INCLUDED
|
|
2411 |
TI_BOOL rsnXCCSwEncFlag; /**< */
|
|
2412 |
TI_BOOL rsnXCCMicFieldFlag; /**< */
|
|
2413 |
#endif
|
|
2414 |
ECipherSuite rsnEncryptionStatus; /**< */
|
|
2415 |
TI_UINT8 rsnHwEncDecrEnable; /**< 0- disable, 1- enable */
|
|
2416 |
TSecurityKeys *pRsnKey; /**< */
|
|
2417 |
TI_UINT8 rsnDefaultKeyID; /**< */
|
|
2418 |
|
|
2419 |
/* Measurements section */
|
|
2420 |
TMediumOccupancy mediumOccupancy; /**< */
|
|
2421 |
TI_BOOL halTxOpContinuation; /**< */
|
|
2422 |
|
|
2423 |
TTsfDtim fwTsfDtimInfo; /**< */
|
|
2424 |
|
|
2425 |
TInterrogateCmdCbParams interogateCmdCBParams; /**< */
|
|
2426 |
TConfigCmdCbParams configureCmdCBParams; /**< */
|
|
2427 |
|
|
2428 |
TTxRatePolicy *pTxRatePlicy; /**< */
|
|
2429 |
|
|
2430 |
/* WARNING!!! This section is used to set/get internal params only. */
|
|
2431 |
TI_UINT16 halCtrlAid; /**< */
|
|
2432 |
|
|
2433 |
ESoftGeminiEnableModes SoftGeminiEnable; /**< */
|
|
2434 |
TSoftGeminiParams SoftGeminiParam; /**< */
|
|
2435 |
|
|
2436 |
TFmCoexParams tFmCoexParams; /**< */
|
|
2437 |
|
|
2438 |
TI_UINT32 halCtrlMaxRxMsduLifetime; /**< */
|
|
2439 |
|
|
2440 |
/* Beacon Broadcast options */
|
|
2441 |
TBcnBrcOptions BcnBrcOptions; /**< */
|
|
2442 |
|
|
2443 |
/* PLT tests */
|
|
2444 |
TI_STATUS PltRxCalibrationStatus; /**< */
|
|
2445 |
|
|
2446 |
/* CoexActivity */
|
|
2447 |
THalCoexActivityTable tTwdParamsCoexActivityTable; /**< */
|
|
2448 |
|
|
2449 |
/* DCO Itrim */
|
|
2450 |
DcoItrimParams_t tDcoItrimParams; /**< */
|
|
2451 |
|
|
2452 |
} TTwdParamContents;
|
|
2453 |
|
|
2454 |
/** \struct TTwdParamInfo
|
|
2455 |
* \brief TWD Parameters Information
|
|
2456 |
*
|
|
2457 |
* \par Description
|
|
2458 |
*
|
|
2459 |
* \sa TWD_SetParam
|
|
2460 |
*/
|
|
2461 |
typedef struct
|
|
2462 |
{
|
|
2463 |
TI_UINT32 paramType; /**< FW Parameter Information Identifier */
|
|
2464 |
TI_UINT32 paramLength; /**< FW Parameter Length */
|
|
2465 |
TTwdParamContents content; /**< FW Parameter content */
|
|
2466 |
|
|
2467 |
} TTwdParamInfo;
|
|
2468 |
|
|
2469 |
/** \struct TRxXferReserved
|
|
2470 |
* \brief RX Xfer Reserved
|
|
2471 |
*
|
|
2472 |
* \par Description
|
|
2473 |
*
|
|
2474 |
* \sa
|
|
2475 |
*/
|
|
2476 |
typedef struct
|
|
2477 |
{
|
|
2478 |
ProcessIDTag_e packetType; /**< */
|
|
2479 |
TI_UINT8 rxLevel; /**< */
|
|
2480 |
TI_INT8 rssi; /**< */
|
|
2481 |
TI_UINT8 SNR; /**< */
|
|
2482 |
TI_UINT8 band; /**< */
|
|
2483 |
TI_UINT32 TimeStamp; /**< */
|
|
2484 |
EScanResultTag eScanTag; /**< */
|
|
2485 |
|
|
2486 |
} TRxXferReserved;
|
|
2487 |
|
|
2488 |
/** \struct TRxAttr
|
|
2489 |
* \brief RX Attributes
|
|
2490 |
*
|
|
2491 |
* \par Description
|
|
2492 |
*
|
|
2493 |
* \sa
|
|
2494 |
*/
|
|
2495 |
typedef struct
|
|
2496 |
{
|
|
2497 |
PacketClassTag_enum ePacketType; /**< */
|
|
2498 |
TI_STATUS status; /**< */
|
|
2499 |
ERate Rate; /**< */
|
|
2500 |
TI_UINT8 SNR; /**< */
|
|
2501 |
TI_INT8 Rssi; /**< */
|
|
2502 |
TI_UINT8 channel; /**< */
|
|
2503 |
TI_UINT32 packetInfo; /**< */
|
|
2504 |
ERadioBand band; /**< */
|
|
2505 |
TI_UINT32 TimeStamp; /**< */
|
|
2506 |
EScanResultTag eScanTag; /**< */
|
|
2507 |
|
|
2508 |
} TRxAttr;
|
|
2509 |
|
|
2510 |
|
|
2511 |
/** \struct TGeneralInitParams
|
|
2512 |
* \brief General Initialization Parameters
|
|
2513 |
*
|
|
2514 |
* \par Description
|
|
2515 |
*
|
|
2516 |
* \sa
|
|
2517 |
*/
|
|
2518 |
typedef struct
|
|
2519 |
{
|
|
2520 |
TI_UINT16 halCtrlListenInterval; /**< */
|
|
2521 |
TI_UINT8 halCtrlCalibrationChannel2_4; /**< */
|
|
2522 |
TI_UINT8 halCtrlCalibrationChannel5_0; /**< */
|
|
2523 |
TI_UINT16 halCtrlRtsThreshold; /**< */
|
|
2524 |
TI_UINT16 halCtrlFragThreshold; /**< */
|
|
2525 |
TI_UINT32 halCtrlMaxTxMsduLifetime; /**< */
|
|
2526 |
TI_UINT32 halCtrlMaxRxMsduLifetime; /**< */
|
|
2527 |
ETxAntenna halCtrlTxAntenna; /**< */
|
|
2528 |
ERxAntenna halCtrlRxAntenna; /**< */
|
|
2529 |
TI_UINT8 halCtrlMacClock; /**< */
|
|
2530 |
TI_UINT8 halCtrlArmClock; /**< */
|
|
2531 |
TI_UINT16 halCtrlBcnRxTime; /**< */
|
|
2532 |
TI_BOOL halCtrlRxEnergyDetection; /**< */
|
|
2533 |
TI_BOOL halCtrlTxEnergyDetection; /**< */
|
|
2534 |
TI_BOOL halCtrlEepromLessEnable; /**< */
|
|
2535 |
TI_BOOL halCtrlRxDisableBroadcast; /**< */
|
|
2536 |
TI_BOOL halCtrlRecoveryEnable; /**< */
|
|
2537 |
TI_BOOL halCtrlFirmwareDebug; /**< */
|
|
2538 |
TI_BOOL WiFiWmmPS; /**< */
|
|
2539 |
TRxTimeOut rxTimeOut; /**< */
|
|
2540 |
TI_UINT8 halCtrlRateFallbackRetry; /**< */
|
|
2541 |
TI_BOOL b11nEnable; /**< */
|
|
2542 |
|
|
2543 |
TI_UINT16 TxCompletePacingThreshold; /**< */
|
|
2544 |
TI_UINT16 TxCompletePacingTimeout; /**< */
|
|
2545 |
TI_UINT16 RxIntrPacingThreshold; /**< */
|
|
2546 |
TI_UINT16 RxIntrPacingTimeout; /**< */
|
|
2547 |
|
|
2548 |
TI_UINT8 hwAccessMethod; /**< */
|
|
2549 |
TI_UINT8 maxSitesFragCollect; /**< */
|
|
2550 |
TI_UINT8 packetDetectionThreshold; /**< */
|
|
2551 |
TI_UINT32 nullTemplateSize; /**< */
|
|
2552 |
TI_UINT32 disconnTemplateSize; /**< */
|
|
2553 |
TI_UINT32 beaconTemplateSize; /**< */
|
|
2554 |
TI_UINT32 probeRequestTemplateSize; /**< */
|
|
2555 |
TI_UINT32 probeResponseTemplateSize; /**< */
|
|
2556 |
TI_UINT32 PsPollTemplateSize; /**< */
|
|
2557 |
TI_UINT32 qosNullDataTemplateSize; /**< */
|
|
2558 |
TI_UINT32 tddRadioCalTimout; /**< */
|
|
2559 |
TI_UINT32 CrtRadioCalTimout; /**< */
|
|
2560 |
TI_UINT32 UseMboxInterrupt; /**< */
|
|
2561 |
TI_UINT32 TraceBufferSize; /**< */
|
|
2562 |
TI_BOOL bDoPrint; /**< */
|
|
2563 |
TI_UINT8 StaMacAddress[MAC_ADDR_LEN]; /**< */
|
|
2564 |
TI_BOOL TxFlashEnable; /**< */
|
|
2565 |
TI_UINT8 RxBroadcastInPs; /**< */
|
|
2566 |
TI_UINT8 ConsecutivePsPollDeliveryFailureThreshold; /**< */
|
|
2567 |
TI_UINT8 TxBlocksThresholdPerAc[MAX_NUM_OF_AC];/**< */
|
|
2568 |
TI_UINT16 BeaconRxTimeout; /**< */
|
|
2569 |
TI_UINT16 BroadcastRxTimeout; /**< */
|
|
2570 |
|
|
2571 |
TI_UINT8 uRssiBeaconAverageWeight; /**< */
|
|
2572 |
TI_UINT8 uRssiPacketAverageWeight; /**< */
|
|
2573 |
TI_UINT8 uSnrBeaconAverageWeight; /**< */
|
|
2574 |
TI_UINT8 uSnrPacketAverageWeight; /**< */
|
|
2575 |
|
|
2576 |
TI_UINT32 uHostClkSettlingTime; /**< */
|
|
2577 |
TI_UINT8 uHostFastWakeupSupport; /**< */
|
|
2578 |
THalCoexActivityTable halCoexActivityTable; /**< */
|
|
2579 |
TFmCoexParams tFmCoexParams; /**< */
|
|
2580 |
|
|
2581 |
} TGeneralInitParams;
|
|
2582 |
|
|
2583 |
/** \struct TPowerSrvInitParams
|
|
2584 |
* \brief Power Service Init Parameters
|
|
2585 |
*
|
|
2586 |
* \par Description
|
|
2587 |
*
|
|
2588 |
* \sa
|
|
2589 |
*/
|
|
2590 |
typedef struct
|
|
2591 |
{
|
|
2592 |
TI_UINT8 numNullPktRetries; /**< */
|
|
2593 |
TI_UINT8 hangOverPeriod; /**< */
|
|
2594 |
TI_UINT16 reserve; /**< */
|
|
2595 |
|
|
2596 |
} TPowerSrvInitParams;
|
|
2597 |
|
|
2598 |
/** \struct TScanSrvInitParams
|
|
2599 |
* \brief Scan Service Init Parameters
|
|
2600 |
*
|
|
2601 |
* \par Description
|
|
2602 |
*
|
|
2603 |
* \sa
|
|
2604 |
*/
|
|
2605 |
typedef struct
|
|
2606 |
{
|
|
2607 |
TI_UINT32 numberOfNoScanCompleteToRecovery; /**< The number of consecutive no scan complete that will trigger a recovery notification */
|
|
2608 |
TI_UINT32 uTriggeredScanTimeOut; /**< i.e. split scan. Time out for starting triggered scan between 2 channels */
|
|
2609 |
|
|
2610 |
} TScanSrvInitParams;
|
|
2611 |
|
|
2612 |
|
|
2613 |
|
|
2614 |
|
|
2615 |
/** \struct TArpIpFilterInitParams
|
|
2616 |
* \brief ARP IP Filter Init Parameters
|
|
2617 |
*
|
|
2618 |
* \par Description
|
|
2619 |
*
|
|
2620 |
* \sa
|
|
2621 |
*/
|
|
2622 |
typedef struct
|
|
2623 |
{
|
|
2624 |
TI_UINT32 isFilterEnabled; /**< */
|
|
2625 |
TIpAddr addr; /**< */
|
|
2626 |
|
|
2627 |
} TArpIpFilterInitParams;
|
|
2628 |
|
|
2629 |
/** \struct TMacAddrFilterInitParams
|
|
2630 |
* \brief AMC Address Filter Init Parameters
|
|
2631 |
*
|
|
2632 |
* \par Description
|
|
2633 |
*
|
|
2634 |
* \sa
|
|
2635 |
*/
|
|
2636 |
typedef struct
|
|
2637 |
{
|
|
2638 |
TI_UINT8 isFilterEnabled; /**< */
|
|
2639 |
TI_UINT8 numOfMacAddresses; /**< */
|
|
2640 |
TI_UINT16 reserve; /**< */
|
|
2641 |
TMacAddr macAddrTable[MAX_MULTICAST_GROUP_ADDRS]; /**< */
|
|
2642 |
|
|
2643 |
} TMacAddrFilterInitParams;
|
|
2644 |
|
|
2645 |
/** \struct RateMangeParams_t
|
|
2646 |
* \brief Rate Maangement params structure
|
|
2647 |
*
|
|
2648 |
* \par Description
|
|
2649 |
*
|
|
2650 |
* \sa
|
|
2651 |
*/
|
|
2652 |
typedef struct
|
|
2653 |
{
|
|
2654 |
rateAdaptParam_e paramIndex;
|
|
2655 |
uint16 RateRetryScore;
|
|
2656 |
uint16 PerAdd;
|
|
2657 |
uint16 PerTh1;
|
|
2658 |
uint16 PerTh2;
|
|
2659 |
uint16 MaxPer;
|
|
2660 |
uint8 InverseCuriosityFactor[RATE_MGMT_NUM_OF_UC];
|
|
2661 |
uint8 TxFailLowTh;
|
|
2662 |
uint8 TxFailHighTh;
|
|
2663 |
uint8 PerAlphaShift;
|
|
2664 |
uint8 PerAddShift;
|
|
2665 |
uint8 PerBeta1Shift;
|
|
2666 |
uint8 PerBeta2Shift;
|
|
2667 |
uint8 RateCheckUp;
|
|
2668 |
uint8 RateCheckDown;
|
|
2669 |
uint8 RateRetryPolicy[RATE_MGMT_NUM_OF_RATES];
|
|
2670 |
uint8 PerWeightShift[RATE_MGMT_NUM_OF_UC]; // 2 weights, 1 per UC
|
|
2671 |
uint8 TpWeightShift[RATE_MGMT_NUM_OF_UC]; // 2 weights, 1 per UC
|
|
2672 |
}RateMangeParams_t;
|
|
2673 |
|
|
2674 |
/*
|
|
2675 |
* IMPORTANT NOTE:
|
|
2676 |
* ===============
|
|
2677 |
* This structure encapsulates the initialization data required by the TnetwDrv layer.
|
|
2678 |
* All structures in it are arranged so no padding will be added by the compiler!!
|
|
2679 |
* This is required to avoid missalignment when compiled by customers using GWSI API!!
|
|
2680 |
*/
|
|
2681 |
/** \struct TTwdInitParams
|
|
2682 |
* \brief TWD Init Parameters
|
|
2683 |
*
|
|
2684 |
* \par Description
|
|
2685 |
* All TWD Initialization Parameters
|
|
2686 |
*
|
|
2687 |
* \sa TWD_SetDefaults
|
|
2688 |
*/
|
|
2689 |
typedef struct
|
|
2690 |
{
|
|
2691 |
TGeneralInitParams tGeneral; /**< General Initialization Parameters */
|
|
2692 |
TPowerSrvInitParams tPowerSrv; /**< Power Service Initialization Parameters */
|
|
2693 |
TScanSrvInitParams tScanSrv; /**< Scan Service Initialization Parameters */
|
|
2694 |
TArpIpFilterInitParams tArpIpFilter; /**< ARP IP filter Initialization Parameters */
|
|
2695 |
TMacAddrFilterInitParams tMacAddrFilter; /**< MAC Address Initialization Parameters */
|
|
2696 |
IniFileRadioParam tIniFileRadioParams; /**< Radio Initialization Parameters */
|
|
2697 |
IniFileGeneralParam tPlatformGenParams; /**< Radio Initialization Parameters */
|
|
2698 |
ACXSmartReflexConfigParams_t tSmartReflexParams; /**< Smart Refelx Parameters */
|
|
2699 |
ACXSmartReflexDebugParams_t tSmartReflexDebugParams; /**< Smart Refelx Debug Parameters */
|
|
2700 |
ACXSmartReflexState_t tSmartReflexState; /**< Smart Refelx state */
|
|
2701 |
RateMangeParams_t tRateMngParams; /**< Rate Managment Parameters */
|
|
2702 |
DcoItrimParams_t tDcoItrimParams; /**< Dco Itrim Parameters */
|
|
2703 |
|
|
2704 |
} TTwdInitParams;
|
|
2705 |
|
|
2706 |
/** \struct TTwdHtCapabilities
|
|
2707 |
* \brief TWD HT Capabilities
|
|
2708 |
*
|
|
2709 |
* \par Description
|
|
2710 |
*
|
|
2711 |
* \sa TWD_SetDefaults, TWD_GetTwdHtCapabilities
|
|
2712 |
*/
|
|
2713 |
typedef struct
|
|
2714 |
{
|
|
2715 |
TI_BOOL b11nEnable; /**< Enable/Disable 802.11n flag */
|
|
2716 |
TI_UINT8 uChannelWidth; /**< */
|
|
2717 |
TI_UINT8 uRxSTBC; /**< */
|
|
2718 |
TI_UINT8 uMaxAMSDU; /**< */
|
|
2719 |
TI_UINT8 uMaxAMPDU; /**< */
|
|
2720 |
TI_UINT8 uAMPDUSpacing; /**< */
|
|
2721 |
TI_UINT8 aRxMCS[RX_TX_MCS_BITMASK_SIZE]; /**< */
|
|
2722 |
TI_UINT8 aTxMCS[RX_TX_MCS_BITMASK_SIZE]; /**< */
|
|
2723 |
TI_UINT16 uRxMaxDataRate; /**< */
|
|
2724 |
TI_UINT8 uPCOTransTime; /**< */
|
|
2725 |
TI_UINT32 uHTCapabilitiesBitMask; /**< */
|
|
2726 |
TI_UINT8 uMCSFeedback; /**< */
|
|
2727 |
} TTwdHtCapabilities;
|
|
2728 |
|
|
2729 |
typedef struct
|
|
2730 |
{
|
|
2731 |
int32 SNRCorrectionHighLimit;
|
|
2732 |
int32 SNRCorrectionLowLimit;
|
|
2733 |
int32 PERErrorTH;
|
|
2734 |
int32 attemptEvaluateTH;
|
|
2735 |
int32 goodAttemptTH;
|
|
2736 |
int32 curveCorrectionStep;
|
|
2737 |
|
|
2738 |
}RateMangeReadParams_t;
|
|
2739 |
|
|
2740 |
|
|
2741 |
/*
|
|
2742 |
* --------------------------------------------------------------
|
|
2743 |
* APIs
|
|
2744 |
* --------------------------------------------------------------
|
|
2745 |
*/
|
|
2746 |
/** @ingroup Control
|
|
2747 |
* \brief Send Packet Transfer CB
|
|
2748 |
*
|
|
2749 |
* \param CBObj - object handle
|
|
2750 |
* \param pPktCtrlBlk - Pointer to Input Packet Control Block
|
|
2751 |
* \return void
|
|
2752 |
*
|
|
2753 |
* \par Description
|
|
2754 |
* The Transfer-Done callback
|
|
2755 |
* User registers the CB for Send Packet Transfer done
|
|
2756 |
*
|
|
2757 |
* \sa TWD_RegisterCb
|
|
2758 |
*/
|
|
2759 |
typedef void (* TSendPacketTranferCb)(TI_HANDLE CBObj, TTxCtrlBlk *pPktCtrlBlk);
|
|
2760 |
/** @ingroup Control
|
|
2761 |
* \brief Send Packet Debug CB
|
|
2762 |
*
|
|
2763 |
* \param CBObj - object handle
|
|
2764 |
* \param pPktCtrlBlk - Pointer to Input Packet Control Block
|
|
2765 |
* uDebugInfo - Debug Information
|
|
2766 |
* \return void
|
|
2767 |
*
|
|
2768 |
* \par Description
|
|
2769 |
* The Transfer-Done Debug callback
|
|
2770 |
*
|
|
2771 |
* \sa
|
|
2772 |
*/
|
|
2773 |
typedef void (* TSendPacketDebugCb) (TI_HANDLE CBObj, TTxCtrlBlk *pPktCtrlBlk, TI_UINT32 uDebugInfo);
|
|
2774 |
/** @ingroup Control
|
|
2775 |
* \brief Send Packet Debug CB
|
|
2776 |
*
|
|
2777 |
* \param CBObj - object handle
|
|
2778 |
* \param pPktCtrlBlk - Pointer to Input Packet Control Block
|
|
2779 |
* uDebugInfo - Debug Information
|
|
2780 |
* \return void
|
|
2781 |
*
|
|
2782 |
* \par Description
|
|
2783 |
*
|
|
2784 |
* \sa TWD_RegisterCb
|
|
2785 |
*/
|
|
2786 |
typedef ERxBufferStatus (*TRequestForBufferCb) (TI_HANDLE hObj, void **pRxBuffer, TI_UINT16 aLength, TI_UINT32 uEncryptionFlag);
|
|
2787 |
/** @ingroup Control
|
|
2788 |
* \brief Send Packet Debug CB
|
|
2789 |
*
|
|
2790 |
* \param hObj - object handle
|
|
2791 |
* \param pBuffer - Pointer to Received buffer frame
|
|
2792 |
* \return void
|
|
2793 |
*
|
|
2794 |
* \par Description
|
|
2795 |
* This function CB will be called when Received packet from RX Queue
|
|
2796 |
* User registers the CB for RX Buffer Request
|
|
2797 |
*
|
|
2798 |
* \sa TWD_RegisterCb
|
|
2799 |
*/
|
|
2800 |
typedef void (*TPacketReceiveCb) (TI_HANDLE hObj,
|
|
2801 |
const void *pBuffer);
|
|
2802 |
/** @ingroup Control
|
|
2803 |
* \brief Failure Event CB
|
|
2804 |
*
|
|
2805 |
* \param handle - object handle
|
|
2806 |
* \param eFailureEvent - Failure Event Type
|
|
2807 |
* \return void
|
|
2808 |
*
|
|
2809 |
* \par Description
|
|
2810 |
* Callback clled for Failure event
|
|
2811 |
* User registers the CB for Health-Moitoring
|
|
2812 |
*
|
|
2813 |
* \sa TWD_RegisterCb
|
|
2814 |
*/
|
|
2815 |
typedef void (*TFailureEventCb) (TI_HANDLE handle, EFailureEvent eFailureEvent);
|
|
2816 |
|
|
2817 |
/** \union TTwdCB
|
|
2818 |
* \brief TWD Callback
|
|
2819 |
*
|
|
2820 |
* \par Description
|
|
2821 |
* Union which holds all TWD Internal Callbacks which are registered by user
|
|
2822 |
* per Module and Event IDs
|
|
2823 |
*
|
|
2824 |
* \sa TWD_RegisterCb
|
|
2825 |
*/
|
|
2826 |
typedef union
|
|
2827 |
{
|
|
2828 |
TSendPacketTranferCb sendPacketCB; /**< Transfer-Done callback */
|
|
2829 |
TSendPacketDebugCb sendPacketDbgCB; /**< Transfer-Done Debug callback */
|
|
2830 |
TRequestForBufferCb requestBufferCB; /**< Transfer-Done Debug callback */
|
|
2831 |
TPacketReceiveCb recvPacketCB; /**< RX Buffer Request callback */
|
|
2832 |
TFailureEventCb failureEventCB; /**< Failure Event callback */
|
|
2833 |
}TTwdCB;
|
|
2834 |
|
|
2835 |
|
|
2836 |
/** @ingroup Control
|
|
2837 |
* \brief Scan Service complete CB
|
|
2838 |
*
|
|
2839 |
* \param hCb - handle to the scan object
|
|
2840 |
* \param eTag - the scan results type tag
|
|
2841 |
* \param uResultCount - number of results received during this scan
|
|
2842 |
* \param SPSStatus - bitmap indicating which channels were attempted (if this is an SPS scan)
|
|
2843 |
* \param TSFError - whether a TSF error occurred (if this is an SPS scan)
|
|
2844 |
* \param ScanStatus - scan SRV status (OK / NOK)
|
|
2845 |
* \param PSMode - Power Save Mode
|
|
2846 |
* \return void
|
|
2847 |
*
|
|
2848 |
* \par Description
|
|
2849 |
* This function CB will be called when Scan Service is complete
|
|
2850 |
* User registers the Scan Service Complete CB
|
|
2851 |
*
|
|
2852 |
* \sa TWD_RegisterScanCompleteCb
|
|
2853 |
*/
|
|
2854 |
typedef void (*TScanSrvCompleteCb) (TI_HANDLE hCb,
|
|
2855 |
EScanResultTag eTag,
|
|
2856 |
TI_UINT32 uResultCount,
|
|
2857 |
TI_UINT16 SPSStatus,
|
|
2858 |
TI_BOOL TSFError,
|
|
2859 |
TI_STATUS ScanStatus,
|
|
2860 |
TI_STATUS PSMode);
|
|
2861 |
/** @ingroup Control
|
|
2862 |
* \brief TWD Callback
|
|
2863 |
*
|
|
2864 |
* \param hCb - handle to object
|
|
2865 |
* \param status - completion status
|
|
2866 |
* \return void
|
|
2867 |
*
|
|
2868 |
* \par Description
|
|
2869 |
* Initialising Complete Callaback (exapmle: Init HW/FW CB etc.)
|
|
2870 |
* User can use its own Complete CB which will be called when
|
|
2871 |
* the suitable module id & event number will arrive
|
|
2872 |
*
|
|
2873 |
* \sa TWD_Init
|
|
2874 |
*/
|
|
2875 |
typedef void (*TTwdCallback) (TI_HANDLE hCb, TI_STATUS status);
|
|
2876 |
/** @ingroup Control
|
|
2877 |
* \brief TWD Callback
|
|
2878 |
*
|
|
2879 |
* \param hCb - handle to object
|
|
2880 |
* \param msrReply - Pointer to input measurement (which ended) Reply
|
|
2881 |
* \return void
|
|
2882 |
*
|
|
2883 |
* \par Description
|
|
2884 |
* The function prototype for the measurement complete callback
|
|
2885 |
* User can use its own measurement complete CB
|
|
2886 |
* which will be called when measurement end
|
|
2887 |
*
|
|
2888 |
* \sa TWD_StartMeasurement
|
|
2889 |
*/
|
|
2890 |
typedef void (*TMeasurementSrvCompleteCb) (TI_HANDLE hCb, TMeasurementReply* msrReply);
|
|
2891 |
/** @ingroup Control
|
|
2892 |
* \brief Command Response Callback
|
|
2893 |
*
|
|
2894 |
* \param hCb - handle to object
|
|
2895 |
* \param status - status of Command ended
|
|
2896 |
* \return void
|
|
2897 |
*
|
|
2898 |
* \par Description
|
|
2899 |
* The function prototype for the Command Response CB
|
|
2900 |
* Enables user to implement and use its own Response CB
|
|
2901 |
* which will be called when TWD Command end
|
|
2902 |
*
|
|
2903 |
* \sa TWD_StartMeasurement, TWD_StopMeasurement, TWD_Scan, TWD_StopScan, TWD_StartPeriodicScan, TWD_StopPeriodicScan
|
|
2904 |
*/
|
|
2905 |
typedef void (*TCmdResponseCb) (TI_HANDLE hCb, TI_UINT16 status);
|
|
2906 |
/** @ingroup Control
|
|
2907 |
* \brief Command Response Callback
|
|
2908 |
*
|
|
2909 |
* \param hCb - handle to object
|
|
2910 |
* \param status - status of Command ended
|
|
2911 |
* \return void
|
|
2912 |
*
|
|
2913 |
* \par Description
|
|
2914 |
* The function prototype for the Power Save Set Response CB
|
|
2915 |
* Enables user to implement and use its own Response CB which
|
|
2916 |
* will be called when Power Save Set Command end
|
|
2917 |
*
|
|
2918 |
* \sa TWD_SetPsMode
|
|
2919 |
*/
|
|
2920 |
typedef void (*TPowerSaveResponseCb)(TI_HANDLE hCb, TI_UINT8 status);
|
|
2921 |
/** @ingroup Control
|
|
2922 |
* \brief Command Complete Callback
|
|
2923 |
*
|
|
2924 |
* \param hCb - handle to object
|
|
2925 |
* \param PsMode - Power Save Mode
|
|
2926 |
* \param status - status of Command ended
|
|
2927 |
* \return void
|
|
2928 |
*
|
|
2929 |
* \par Description
|
|
2930 |
* The function prototype for the Power Save Set Complete CB
|
|
2931 |
* Enables user to implement and use its own Complete CB which
|
|
2932 |
* will be called when Power Save Set Command end (for success/faild notification)
|
|
2933 |
*
|
|
2934 |
* \sa TWD_SetPsMode
|
|
2935 |
*/
|
|
2936 |
typedef void (*TPowerSaveCompleteCb )(TI_HANDLE hCb, TI_UINT8 PsMode, TI_UINT8 status);
|
|
2937 |
/** @ingroup Control
|
|
2938 |
* \brief Create TWD Module
|
|
2939 |
*
|
|
2940 |
* \param hOs - OS module object handle
|
|
2941 |
* \return TWD Module object handle on success or NULL on failure
|
|
2942 |
*
|
|
2943 |
* \par Description
|
|
2944 |
* Calling this function Creates a TWD object and all its sub-modules.
|
|
2945 |
*
|
|
2946 |
* \sa TWD_Destroy, TWD_Init
|
|
2947 |
*/
|
|
2948 |
TI_HANDLE TWD_Create (TI_HANDLE hOs);
|
|
2949 |
/** @ingroup Control
|
|
2950 |
* \brief Destroy TWD Module
|
|
2951 |
*
|
|
2952 |
* \param hTWD - hTWD module object handle
|
|
2953 |
* \return TI_OK on success or TI_NOK on failure
|
|
2954 |
*
|
|
2955 |
* \par Description
|
|
2956 |
* Calling this function Destroys TWD object and all its sub-modules.
|
|
2957 |
*
|
|
2958 |
* \sa TWD_Create
|
|
2959 |
*/
|
|
2960 |
TI_STATUS TWD_Destroy (TI_HANDLE hTWD);
|
|
2961 |
/** Control
|
|
2962 |
* \brief Init TWD module
|
|
2963 |
*
|
|
2964 |
* \param hTWD - TWD module object handle
|
|
2965 |
* \param hReport - Report module object handle
|
|
2966 |
* \param hUser - Master (User) module object handle
|
|
2967 |
* \param hTimer - Timer module object handle
|
|
2968 |
* \param hContext - context-engine module object handle
|
|
2969 |
* \param hTxnQ - TxnQueue module object handle
|
|
2970 |
* \param fInitHwCb - Init HW callback called when init HW phase is done
|
|
2971 |
* \param fInitFwCb - Init FW callback called when init FW phase is done
|
|
2972 |
* \param fConfigFwCb - Configuration FW callback called when configuring FW phase is done
|
|
2973 |
* \param fStopCb - Stop callback called when TWD is stopped
|
|
2974 |
* \param fInitFailCb - Fail callback called when TWD is Failed
|
|
2975 |
* \return void
|
|
2976 |
*
|
|
2977 |
* \par Description
|
|
2978 |
* Start hardware Init and Config process.
|
|
2979 |
* This is the first function that must be called after TWD_Create.
|
|
2980 |
*
|
|
2981 |
* \sa TWD_Create, TWD_Stop
|
|
2982 |
*/
|
|
2983 |
void TWD_Init (TI_HANDLE hTWD,
|
|
2984 |
TI_HANDLE hReport,
|
|
2985 |
TI_HANDLE hUser,
|
|
2986 |
TI_HANDLE hTimer,
|
|
2987 |
TI_HANDLE hContext,
|
|
2988 |
TI_HANDLE hTxnQ,
|
|
2989 |
TTwdCallback fInitHwCb,
|
|
2990 |
TTwdCallback fInitFwCb,
|
|
2991 |
TTwdCallback fConfigFwCb,
|
|
2992 |
TTwdCallback fStopCb,
|
|
2993 |
TTwdCallback fInitFailCb);
|
|
2994 |
/** @ingroup Control
|
|
2995 |
* \brief Init HW module
|
|
2996 |
*
|
|
2997 |
* \param hTWD - TWD module object handle
|
|
2998 |
* \param pbuf - Pointer to Input NVS Buffer
|
|
2999 |
* \param length - Length of NVS Buffer
|
|
3000 |
* \return TI_OK on success or TI_NOK on failure
|
|
3001 |
*
|
|
3002 |
* \par Description
|
|
3003 |
* Performs the HW init process.
|
|
3004 |
*
|
|
3005 |
* \sa
|
|
3006 |
*/
|
|
3007 |
TI_STATUS TWD_InitHw (TI_HANDLE hTWD, TI_UINT8 *pbuf, TI_UINT32 length);
|
|
3008 |
/** @ingroup Control
|
|
3009 |
* \brief Set Defults to TWD Init Params
|
|
3010 |
*
|
|
3011 |
* \param hTWD - TWD module object handle
|
|
3012 |
* \param pInitParams - Pointer to Input init default parameters
|
|
3013 |
* \return TI_OK on success or TI_NOK on failure
|
|
3014 |
*
|
|
3015 |
* \par Description
|
|
3016 |
*
|
|
3017 |
* \sa
|
|
3018 |
*/
|
|
3019 |
TI_STATUS TWD_SetDefaults (TI_HANDLE hTWD, TTwdInitParams *pInitParams);
|
|
3020 |
/** @ingroup Control
|
|
3021 |
* \brief Init FW
|
|
3022 |
*
|
|
3023 |
* \param hTWD - TWD module object handle
|
|
3024 |
* \param pFileInfo - Pointer to Input Buffer contains part of FW Image to Download
|
|
3025 |
* The Following Field should be filled:
|
|
3026 |
* pFileInfo->pBuffer
|
|
3027 |
* pFileInfo->uLength
|
|
3028 |
* pFileInfo->uAddress
|
|
3029 |
* pFileInfo->bLast
|
|
3030 |
* \return TI_OK on success or TI_NOK on failure
|
|
3031 |
*
|
|
3032 |
* \par Description
|
|
3033 |
* Performs FW Download, and Run FW
|
|
3034 |
*
|
|
3035 |
* \sa
|
|
3036 |
*/
|
|
3037 |
TI_STATUS TWD_InitFw (TI_HANDLE hTWD, TFileInfo *pFileInfo);
|
|
3038 |
/** @ingroup Control
|
|
3039 |
* \brief Open UART Bus Txn
|
|
3040 |
*
|
|
3041 |
* \param hTWD - TWD module object handle
|
|
3042 |
* \param pParams - Pointer to Input parameters
|
|
3043 |
* \return TI_OK on success or TI_NOK on failure
|
|
3044 |
*
|
|
3045 |
* \par Description
|
|
3046 |
*
|
|
3047 |
* \sa
|
|
3048 |
*/
|
|
3049 |
TI_STATUS TWD_BusOpen (TI_HANDLE hTWD, void* pParams);
|
|
3050 |
/** @ingroup Control
|
|
3051 |
* \brief Close UART Bus Txn
|
|
3052 |
*
|
|
3053 |
* \param hTWD - TWD module object handle
|
|
3054 |
* \return TI_OK on success or TI_NOK on failure
|
|
3055 |
*
|
|
3056 |
* \par Description
|
|
3057 |
*
|
|
3058 |
* \sa
|
|
3059 |
*/
|
|
3060 |
TI_STATUS TWD_BusClose (TI_HANDLE hTWD);
|
|
3061 |
/** @ingroup Control
|
|
3062 |
* \brief Halt firmware
|
|
3063 |
*
|
|
3064 |
* \param hTWD - TWD module object handle
|
|
3065 |
* \return TI_OK on success or TI_NOK on failure
|
|
3066 |
*
|
|
3067 |
* \par Description
|
|
3068 |
*
|
|
3069 |
* \sa
|
|
3070 |
*/
|
|
3071 |
TI_STATUS TWD_Stop (TI_HANDLE hTWD);
|
|
3072 |
/** @ingroup Control
|
|
3073 |
* \brief Enable external events from FW
|
|
3074 |
*
|
|
3075 |
* \param hTWD - TWD module object handle
|
|
3076 |
* \return void
|
|
3077 |
*
|
|
3078 |
* \par Description
|
|
3079 |
* Enable external events from FW upon driver start or recovery completion
|
|
3080 |
*
|
|
3081 |
* \sa
|
|
3082 |
*/
|
|
3083 |
void TWD_EnableExternalEvents (TI_HANDLE hTWD);
|
|
3084 |
/** @ingroup Control
|
|
3085 |
* \brief Registers TWD internal callback function
|
|
3086 |
*
|
|
3087 |
* \param hTWD - TWD module object handle
|
|
3088 |
* \param event - event on which the registrated CB will be called
|
|
3089 |
* \param fCb - Pointer to Registered CB function
|
|
3090 |
* \param pData - Pointer to Registered CB data
|
|
3091 |
* \return TI_OK on success or TI_NOK on failure
|
|
3092 |
*
|
|
3093 |
* \par Description
|
|
3094 |
* This CB enables user to register TWD Internal CB functions of different Modules,
|
|
3095 |
* with their data.
|
|
3096 |
* The function identifies which TWD Module owns the Registered CB, and what the specific Registered CB
|
|
3097 |
* according to event input parameter.
|
|
3098 |
* Once the Module and specific CB function are identified, the CB is registerd in the TWD Module
|
|
3099 |
* by calling suitable registration CB function
|
|
3100 |
*
|
|
3101 |
* \sa
|
|
3102 |
*/
|
|
3103 |
TI_STATUS TWD_RegisterCb (TI_HANDLE hTWD, TI_UINT32 event, TTwdCB *fCb, void *pData);
|
|
3104 |
/** @ingroup Control
|
|
3105 |
* \brief Exit from init mode
|
|
3106 |
*
|
|
3107 |
* \param hTWD - TWD module object handle
|
|
3108 |
* \return TI_OK on success or TI_NOK on failure
|
|
3109 |
*
|
|
3110 |
* \par Description
|
|
3111 |
* Exit From Init Mode enable sending command to the MboxQueue (which store a command),
|
|
3112 |
* while the interrupts are masked.
|
|
3113 |
* The interrupt would be enable at the end of the init process
|
|
3114 |
*
|
|
3115 |
* \sa
|
|
3116 |
*/
|
|
3117 |
TI_STATUS TWD_ExitFromInitMode (TI_HANDLE hTWD);
|
|
3118 |
/** @ingroup Control
|
|
3119 |
* \brief Finalize FW init and download
|
|
3120 |
*
|
|
3121 |
* \param hTWD - TWD module object handle
|
|
3122 |
* \return void
|
|
3123 |
*
|
|
3124 |
* \par Description
|
|
3125 |
* Init all the remaining initialization after the FW download has finished
|
|
3126 |
*
|
|
3127 |
* \sa
|
|
3128 |
*/
|
|
3129 |
void TWD_FinalizeDownload (TI_HANDLE hTWD);
|
|
3130 |
/** @ingroup Control
|
|
3131 |
* \brief Finalize of faulty FW init and download
|
|
3132 |
*
|
|
3133 |
* \param hTWD - TWD module object handle
|
|
3134 |
* \return void
|
|
3135 |
*
|
|
3136 |
* \par Description
|
|
3137 |
* Call the upper layer failure callback after Init or FW download has finished with failure.
|
|
3138 |
*
|
|
3139 |
* \sa
|
|
3140 |
*/
|
|
3141 |
void TWD_FinalizeOnFailure (TI_HANDLE hTWD);
|
|
3142 |
/** @ingroup Control
|
|
3143 |
* \brief Perform FW Configuration
|
|
3144 |
*
|
|
3145 |
* \param hTWD - TWD module object handle
|
|
3146 |
* \return TI_OK on success or TI_NOK on failure
|
|
3147 |
*
|
|
3148 |
* \par Description
|
|
3149 |
* Configure the FW from the TWD DB - after configuring all HW objects
|
|
3150 |
*
|
|
3151 |
* \sa
|
|
3152 |
*/
|
|
3153 |
TI_STATUS TWD_ConfigFw (TI_HANDLE hTWD);
|
|
3154 |
/** @ingroup Control
|
|
3155 |
* \brief Handle FW interrupt from ISR context
|
|
3156 |
*
|
|
3157 |
* \param hTWD - TWD module object handle
|
|
3158 |
* \return TI_OK on success or TI_NOK on failure
|
|
3159 |
*
|
|
3160 |
* \par Description
|
|
3161 |
* This is the FW-interrupt ISR context. The driver task is scheduled to hadnle FW-Events
|
|
3162 |
*
|
|
3163 |
* \sa
|
|
3164 |
*/
|
|
3165 |
TI_STATUS TWD_InterruptRequest (TI_HANDLE hTWD);
|
|
3166 |
/** @ingroup Control
|
|
3167 |
* \brief Enable Recovery
|
|
3168 |
*
|
|
3169 |
* \param hTWD - TWD module object handle
|
|
3170 |
* \return TRUE if recovery Enables, FALSE otherwise
|
|
3171 |
*
|
|
3172 |
* \par Description
|
|
3173 |
* Return Recovery E/D status
|
|
3174 |
*
|
|
3175 |
* \sa
|
|
3176 |
*/
|
|
3177 |
TI_BOOL TWD_RecoveryEnabled (TI_HANDLE hTWD);
|
|
3178 |
/** @ingroup Measurement
|
|
3179 |
* \brief Starts a measurement
|
|
3180 |
*
|
|
3181 |
* \param hTWD - TWD module object handle
|
|
3182 |
* \param pMsrRequest - Pointer to Input structure which contains the measurement parameters
|
|
3183 |
* \param uTimeToRequestExpiryMs - The time (in milliseconds) the measurement SRV has to start the request
|
|
3184 |
* \param fResponseCb - The Command response CB Function
|
|
3185 |
* \param hResponseCb - Handle to Command response CB Function Obj
|
|
3186 |
* \param fCompleteCb - The Command Complete CB Function
|
|
3187 |
* \param hCompleteCb - Handle to Command Complete CB Function Obj
|
|
3188 |
* \return TI_OK on success or TI_NOK on failure
|
|
3189 |
*
|
|
3190 |
* \par Description
|
|
3191 |
* Starts a measurement operation
|
|
3192 |
*
|
|
3193 |
* \sa
|
|
3194 |
*/
|
|
3195 |
TI_STATUS TWD_StartMeasurement (TI_HANDLE hTWD,
|
|
3196 |
TMeasurementRequest *pMsrRequest,
|
|
3197 |
TI_UINT32 uTimeToRequestExpiryMs,
|
|
3198 |
TCmdResponseCb fResponseCb,
|
|
3199 |
TI_HANDLE hResponseCb,
|
|
3200 |
TMeasurementSrvCompleteCb fCompleteCb,
|
|
3201 |
TI_HANDLE hCompleteCb);
|
|
3202 |
/** @ingroup Measurement
|
|
3203 |
* \brief Stops a measurement
|
|
3204 |
*
|
|
3205 |
* \param hTWD - TWD module object handle
|
|
3206 |
* \param bSendNullData - Indicates whether to send NULL data when exiting driver mode
|
|
3207 |
* \param fResponseCb - Pointer to Command response CB function
|
|
3208 |
* \param hResponseCb - Handle to Command response CB parameters
|
|
3209 |
* \return TI_OK on success or TI_NOK on failure
|
|
3210 |
*
|
|
3211 |
* \par Description
|
|
3212 |
* Stops a measurement operation in progress
|
|
3213 |
*
|
|
3214 |
* \sa
|
|
3215 |
*/
|
|
3216 |
TI_STATUS TWD_StopMeasurement (TI_HANDLE hTWD,
|
|
3217 |
TI_BOOL bSendNullData,
|
|
3218 |
TCmdResponseCb fResponseCb,
|
|
3219 |
TI_HANDLE hResponseCb);
|
|
3220 |
/** @ingroup Measurement
|
|
3221 |
* \brief Start scan
|
|
3222 |
*
|
|
3223 |
* \param hTWD - TWD module object handle
|
|
3224 |
* \param pScanParams - Pointer to Input Scan specific parameters
|
|
3225 |
* \param eScanTag - Scan tag, used for result and scan complete tracking
|
|
3226 |
* \param bHighPriority - Indicates whether to perform a high priority (overlaps DTIM) scan
|
|
3227 |
* \param bDriverMode - Indicates whether to try to enter driver mode (with PS on) before issuing the scan command
|
|
3228 |
* \param bScanOnDriverModeError - Indicates whether to proceed with the scan if requested to enter driver mode and failed
|
|
3229 |
* \param ePsRequest - Parameter sent to PowerSaveServer.
|
|
3230 |
* Should indicates PS ON or "keep current" only when driver mode is requested,
|
|
3231 |
* Otherwise should indicate OFF
|
|
3232 |
* \param bSendNullData - Indicates whether to send Null data when exiting driver mode on scan complete
|
|
3233 |
* \param fResponseCb - The Response CB Function which called after downloading the command
|
|
3234 |
* \param hResponseCb - Handle to the Response CB Function Obj (Notice : last 2 params are NULL in Legacy run)
|
|
3235 |
* \return TI_OK on success or TI_NOK on failure
|
|
3236 |
*
|
|
3237 |
* \par Description
|
|
3238 |
* Start scan. enter driver mode (PS) only if station is connected
|
|
3239 |
*
|
|
3240 |
* \sa
|
|
3241 |
*/
|
|
3242 |
TI_STATUS TWD_Scan (TI_HANDLE hTWD,
|
|
3243 |
TScanParams *pScanParams,
|
|
3244 |
EScanResultTag eScanTag,
|
|
3245 |
TI_BOOL bHighPriority,
|
|
3246 |
TI_BOOL bDriverMode,
|
|
3247 |
TI_BOOL bScanOnDriverModeError,
|
|
3248 |
E80211PsMode ePsRequest,
|
|
3249 |
TI_BOOL bSendNullData,
|
|
3250 |
TCmdResponseCb fResponseCb,
|
|
3251 |
TI_HANDLE hResponseCb);
|
|
3252 |
/** @ingroup Measurement
|
|
3253 |
* \brief Stop scan
|
|
3254 |
*
|
|
3255 |
* \param hTWD - TWD module object handle
|
|
3256 |
* \param eScanTag - Scan tag, used to track scan complete and result
|
|
3257 |
* \param bSendNullData - Indicates whether to send Null data when exiting driver mode
|
|
3258 |
* \param fScanCommandResponseCb - The Response CB Function which called after downloading the command
|
|
3259 |
* \param hCb - Handle to the Response CB Function Obj (Notice : last 2 params are NULL in Legacy run)
|
|
3260 |
* \return TI_OK on success or TI_NOK on failure
|
|
3261 |
*
|
|
3262 |
* \par Description
|
|
3263 |
* Sends a Stop Scan command to FW, no matter if we are in scan progress or not
|
|
3264 |
*
|
|
3265 |
* \sa
|
|
3266 |
*/
|
|
3267 |
TI_STATUS TWD_StopScan (TI_HANDLE hTWD,
|
|
3268 |
EScanResultTag eScanTag,
|
|
3269 |
TI_BOOL bSendNullData,
|
|
3270 |
TCmdResponseCb fScanCommandResponseCb,
|
|
3271 |
TI_HANDLE hCb);
|
|
3272 |
/** @ingroup Measurement
|
|
3273 |
* \brief Stop Scan on FW Reset
|
|
3274 |
*
|
|
3275 |
* \param hTWD - TWD module object handle
|
|
3276 |
* \return TI_OK on success or TI_NOK on failure
|
|
3277 |
*
|
|
3278 |
* \par Description
|
|
3279 |
* Stop scan operation when a FW reset (recovery) situation is detected (by all processes
|
|
3280 |
* other than scan)
|
|
3281 |
*
|
|
3282 |
* \sa
|
|
3283 |
*/
|
|
3284 |
TI_STATUS TWD_StopScanOnFWReset (TI_HANDLE hTWD);
|
|
3285 |
/** @ingroup Measurement
|
|
3286 |
* \brief Start Connection Periodic Scan operation
|
|
3287 |
*
|
|
3288 |
* \param hTWD - TWD module object handle
|
|
3289 |
* \param pPeriodicScanParams - Pointer to Input Parameters Structures for the Periodic Scan operation
|
|
3290 |
* \param eScanTag - Scan tag, used for scan complete and result tracking
|
|
3291 |
* \param uPassiveScanDfsDwellTimeMs - Passive dwell time for DFS channels (in milli-secs)
|
|
3292 |
* \param fResponseCb - Response CB Function which is called after downloading the command
|
|
3293 |
* \param hResponseCb - Handle to Response CB Function Obj (Notice : last 2 params are NULL in Legacy run)
|
|
3294 |
* \return TI_OK on success or TI_NOK on failure
|
|
3295 |
*
|
|
3296 |
* \par Description
|
|
3297 |
* Perform Connection Scan periodically
|
|
3298 |
*
|
|
3299 |
* \sa
|
|
3300 |
*/
|
|
3301 |
TI_STATUS TWD_StartConnectionScan (TI_HANDLE hTWD,
|
|
3302 |
TPeriodicScanParams *pPeriodicScanParams,
|
|
3303 |
EScanResultTag eScanTag,
|
|
3304 |
TI_UINT32 uPassiveScanDfsDwellTimeMs,
|
|
3305 |
TCmdResponseCb fResponseCb,
|
|
3306 |
TI_HANDLE hResponseCb);
|
|
3307 |
/** @ingroup Measurement
|
|
3308 |
* \brief Stop Periodic Scan operation
|
|
3309 |
*
|
|
3310 |
* \param hTWD - TWD module object handle
|
|
3311 |
* \param eScanTag - scan tag, used for scan complete and result tracking
|
|
3312 |
* \param fResponseCb - Response CB Function which is called after downloading the command
|
|
3313 |
* \param hResponseCb - Handle to Response CB Function Obj (Notice : last 2 params are NULL in Legacy run)
|
|
3314 |
* \return TI_OK on success or TI_NOK on failure
|
|
3315 |
*
|
|
3316 |
* \par Description
|
|
3317 |
* Stop Periodic Connection Scan
|
|
3318 |
*
|
|
3319 |
* \sa
|
|
3320 |
*/
|
|
3321 |
TI_STATUS TWD_StopPeriodicScan (TI_HANDLE hTWD,
|
|
3322 |
EScanResultTag eScanTag,
|
|
3323 |
TCmdResponseCb fResponseCb,
|
|
3324 |
TI_HANDLE hResponseCb);
|
|
3325 |
/** @ingroup Measurement
|
|
3326 |
* \brief Register CB for Scan Complete
|
|
3327 |
*
|
|
3328 |
* \param hTWD - TWD module object handle
|
|
3329 |
* \param fScanCompleteCb - The Complete CB Function
|
|
3330 |
* \param hScanCompleteCb - Handle to the Complete CB Function Obj
|
|
3331 |
* \return TI_OK on success or TI_NOK on failure
|
|
3332 |
*
|
|
3333 |
* \par Description
|
|
3334 |
* Registers a Complete CB Function for Scan Complete notifications
|
|
3335 |
*
|
|
3336 |
* \sa
|
|
3337 |
*/
|
|
3338 |
TI_STATUS TWD_RegisterScanCompleteCb (TI_HANDLE hTWD,
|
|
3339 |
TScanSrvCompleteCb fScanCompleteCb,
|
|
3340 |
TI_HANDLE hScanCompleteCb);
|
|
3341 |
/** @ingroup Misc
|
|
3342 |
* \brief Set Parameters in FW
|
|
3343 |
*
|
|
3344 |
* \param hTWD - TWD module object handle
|
|
3345 |
* \param pParamInfo - Pointer to Input TWD Parameters Information Structure
|
|
3346 |
* \return TI_OK on success or TI_NOK on failure
|
|
3347 |
*
|
|
3348 |
* \par Description
|
|
3349 |
* Set/Configure Parameters Information in FW via Mail BOX
|
|
3350 |
*
|
|
3351 |
* \sa TTwdParamInfo
|
|
3352 |
*/
|
|
3353 |
TI_STATUS TWD_SetParam (TI_HANDLE hTWD, TTwdParamInfo *pParamInfo);
|
|
3354 |
/** @ingroup Misc
|
|
3355 |
* \brief Get Parameters from FW
|
|
3356 |
*
|
|
3357 |
* \param hTWD - TWD module object handle
|
|
3358 |
* \param pParamInfo - Pointer to Input TWD Parameters Information Structure
|
|
3359 |
* \return TI_OK on success or TI_NOK on failure
|
|
3360 |
*
|
|
3361 |
* \par Description
|
|
3362 |
* Get Parameters Information from FW via Mail BOX
|
|
3363 |
*
|
|
3364 |
* \sa
|
|
3365 |
*/
|
|
3366 |
TI_STATUS TWD_GetParam (TI_HANDLE hTWD, TTwdParamInfo *pParamInfo);
|
|
3367 |
/** @ingroup Control
|
|
3368 |
* \brief Callback which Checks MBOX
|
|
3369 |
*
|
|
3370 |
* \param hTWD - TWD module object handle
|
|
3371 |
* \param uMboxStatus - Mailbox status
|
|
3372 |
* \param pItrParamBuf - Pointer to Interrogate parameters buffer
|
|
3373 |
* \return TI_OK on success or TI_NOK on failure
|
|
3374 |
*
|
|
3375 |
* \par Description
|
|
3376 |
* Perform FW validation by calling CB function which is used for handling MBOX error.
|
|
3377 |
* If command MBOX queue identify MBOX error or timeout, it will call
|
|
3378 |
* a failure-callback with MBOX_FAILURE type (FW failed)
|
|
3379 |
*
|
|
3380 |
* \sa
|
|
3381 |
*/
|
|
3382 |
TI_STATUS TWD_CheckMailboxCb (TI_HANDLE hTWD, TI_UINT16 uMboxStatus, void *pItrParamBuf);
|
|
3383 |
/** @ingroup Control
|
|
3384 |
* \brief Write MIB
|
|
3385 |
*
|
|
3386 |
* \param hTWD - TWD module object handle
|
|
3387 |
* \param pMib - Pointer to Input MIB Structure
|
|
3388 |
* \return TI_OK on success or TI_NOK on failure
|
|
3389 |
*
|
|
3390 |
* \par Description
|
|
3391 |
* Write configuration information to FW
|
|
3392 |
*
|
|
3393 |
* \sa TWD_ReadMib
|
|
3394 |
*/
|
|
3395 |
TI_STATUS TWD_WriteMib (TI_HANDLE hTWD, TMib* pMib);
|
|
3396 |
/** @ingroup Control
|
|
3397 |
* \brief Read MIB
|
|
3398 |
*
|
|
3399 |
* \param hTWD - TWD module object handle
|
|
3400 |
* \param hCb - Handle to Request MIB CB Function Obj
|
|
3401 |
* \param fCb - Pinter to Request MIB CB Function
|
|
3402 |
* \param pCb - Pointer to read parameters
|
|
3403 |
* \return TI_OK on success or TI_NOK on failure
|
|
3404 |
*
|
|
3405 |
* \par Description
|
|
3406 |
* Read configuration information from FW
|
|
3407 |
*
|
|
3408 |
* \sa TWD_WriteMib
|
|
3409 |
*/
|
|
3410 |
TI_STATUS TWD_ReadMib (TI_HANDLE hTWD, TI_HANDLE hCb, void* fCb, void* pCb);
|
|
3411 |
/** @ingroup Control
|
|
3412 |
* \brief TWD Debug
|
|
3413 |
*
|
|
3414 |
* \param hTWD - TWD module object handle
|
|
3415 |
* \param funcType - TWD Function Debuged
|
|
3416 |
* \param pParam - Pointer to Input parameters of Debug function
|
|
3417 |
* \return TI_OK on success or TI_NOK on failure
|
|
3418 |
*
|
|
3419 |
* \par Description
|
|
3420 |
* Use for Debug TWD
|
|
3421 |
*
|
|
3422 |
* \sa
|
|
3423 |
*/
|
|
3424 |
TI_STATUS TWD_Debug (TI_HANDLE hTWD, TI_UINT32 funcType, void *pParam);
|
|
3425 |
/** @ingroup Control
|
|
3426 |
* \brief Register event
|
|
3427 |
*
|
|
3428 |
* \param hTWD - TWD module object handle
|
|
3429 |
* \param event - Event ID
|
|
3430 |
* \param fCb - Event Callback function pointer
|
|
3431 |
* \param hCb - Event Callback object handle
|
|
3432 |
* \return TI_OK on success or TI_NOK on failure
|
|
3433 |
*
|
|
3434 |
* \par Description
|
|
3435 |
* Register FW event callback function
|
|
3436 |
*
|
|
3437 |
* \sa
|
|
3438 |
*/
|
|
3439 |
TI_STATUS TWD_RegisterEvent (TI_HANDLE hTWD, TI_UINT32 event, void *fCb, TI_HANDLE hCb);
|
|
3440 |
/** @ingroup Control
|
|
3441 |
* \brief Disable event
|
|
3442 |
*
|
|
3443 |
* \param hTWD - TWD module object handle
|
|
3444 |
* \param event - Event ID
|
|
3445 |
* \return TI_OK on success or TI_NOK on failure
|
|
3446 |
*
|
|
3447 |
* \par Description
|
|
3448 |
* Disable specific FW event
|
|
3449 |
* Note: Currently not in use
|
|
3450 |
*
|
|
3451 |
* \sa
|
|
3452 |
*/
|
|
3453 |
TI_STATUS TWD_DisableEvent (TI_HANDLE hTWD, TI_UINT32 event);
|
|
3454 |
/** @ingroup Control
|
|
3455 |
* \brief Enable event
|
|
3456 |
*
|
|
3457 |
* \param hTWD - TWD module object handle
|
|
3458 |
* \param event - Event ID
|
|
3459 |
* \return TI_OK on success or TI_NOK on failure
|
|
3460 |
*
|
|
3461 |
* \par Description
|
|
3462 |
* Enable specific FW event
|
|
3463 |
*
|
|
3464 |
* \sa
|
|
3465 |
*/
|
|
3466 |
TI_STATUS TWD_EnableEvent (TI_HANDLE hTWD, TI_UINT32 event);
|
|
3467 |
TI_STATUS TWD_dbgRoamingCommands (TI_HANDLE hTWD);
|
|
3468 |
/** @ingroup Control
|
|
3469 |
* \brief Convert RSSI to RX Level
|
|
3470 |
*
|
|
3471 |
* \param hTWD - TWD module object handle
|
|
3472 |
* \param iRssiVal - RSSI Input Value
|
|
3473 |
* \return TI_OK on success or TI_NOK on failure
|
|
3474 |
*
|
|
3475 |
* \par Description
|
|
3476 |
* Note: Currently not in use!
|
|
3477 |
*
|
|
3478 |
* \sa
|
|
3479 |
*/
|
|
3480 |
TI_INT8 TWD_ConvertRSSIToRxLevel (TI_HANDLE hTWD, TI_INT32 iRssiVal);
|
|
3481 |
/** @ingroup Control
|
|
3482 |
* \brief Complete TWD Stop
|
|
3483 |
*
|
|
3484 |
* \param hTWD - TWD module object handle
|
|
3485 |
* \return void
|
|
3486 |
*
|
|
3487 |
* \par Description
|
|
3488 |
*
|
|
3489 |
* \sa TWD_Stop, TWD_Init
|
|
3490 |
*/
|
|
3491 |
void TWD_StopComplete (TI_HANDLE hTWD);
|
|
3492 |
/** @ingroup Control
|
|
3493 |
* \brief Disable Interrupts
|
|
3494 |
*
|
|
3495 |
* \param hTWD - TWD module object handle
|
|
3496 |
* \return void
|
|
3497 |
*
|
|
3498 |
* \par Description
|
|
3499 |
* Disable the FW Event client of the context thread handler
|
|
3500 |
*
|
|
3501 |
* \sa
|
|
3502 |
*/
|
|
3503 |
void TWD_DisableInterrupts (TI_HANDLE hTWD);
|
|
3504 |
/** @ingroup Control
|
|
3505 |
* \brief Enable Interrupts
|
|
3506 |
*
|
|
3507 |
* \param hTWD - TWD module object handle
|
|
3508 |
* \return void
|
|
3509 |
*
|
|
3510 |
* \par Description
|
|
3511 |
* Enable the FW Event client of the context thread handler
|
|
3512 |
*
|
|
3513 |
* \sa
|
|
3514 |
*/
|
|
3515 |
void TWD_EnableInterrupts (TI_HANDLE hTWD);
|
|
3516 |
/** @ingroup Control
|
|
3517 |
* \brief Translate host to FW time (Usec)
|
|
3518 |
*
|
|
3519 |
* \param hTWD - TWD module object handle
|
|
3520 |
* \param uHostTime - The host time in MS to translate
|
|
3521 |
*
|
|
3522 |
* \return FW Time in Usec
|
|
3523 |
*
|
|
3524 |
* \par Description
|
|
3525 |
*
|
|
3526 |
* \sa
|
|
3527 |
*/
|
|
3528 |
TI_UINT32 TWD_TranslateToFwTime (TI_HANDLE hTWD, TI_UINT32 uHostTime);
|
|
3529 |
/** @ingroup BSS
|
|
3530 |
* \brief Get TWD HT Capabilities
|
|
3531 |
*
|
|
3532 |
* \param hTWD - TWD module object handle
|
|
3533 |
* \param pTwdHtCapabilities - Pointer read structure Output
|
|
3534 |
* \return TI_OK
|
|
3535 |
*
|
|
3536 |
* \par Description
|
|
3537 |
*
|
|
3538 |
*
|
|
3539 |
* \sa
|
|
3540 |
*/
|
|
3541 |
void TWD_GetTwdHtCapabilities (TI_HANDLE hTWD, TTwdHtCapabilities **pTwdHtCapabilities);
|
|
3542 |
#ifdef TI_DBG
|
|
3543 |
/** @ingroup Measurement
|
|
3544 |
* \brief Prints Scan Server Debug status
|
|
3545 |
*
|
|
3546 |
* \param hTWD - TWD module object handle
|
|
3547 |
* \return TI_OK on success or TI_NOK on failure
|
|
3548 |
*
|
|
3549 |
* \par Description
|
|
3550 |
*
|
|
3551 |
* \sa
|
|
3552 |
*/
|
|
3553 |
TI_STATUS TWD_PrintMacServDebugStatus (TI_HANDLE hTWD);
|
|
3554 |
|
|
3555 |
/** @ingroup Test
|
|
3556 |
* \brief Prints Tx Info
|
|
3557 |
*
|
|
3558 |
* \param hTWD - TWD module object handle
|
|
3559 |
* \param ePrintInfo - Information type
|
|
3560 |
* \return TI_OK on success or TI_NOK on failure
|
|
3561 |
*
|
|
3562 |
* \par Description
|
|
3563 |
* Call the requested print function - used for Debug Test
|
|
3564 |
*
|
|
3565 |
* \sa
|
|
3566 |
*/
|
|
3567 |
TI_STATUS TWD_PrintTxInfo (TI_HANDLE hTWD, ETwdPrintInfoType ePrintInfo);
|
|
3568 |
#endif
|
|
3569 |
|
|
3570 |
/*-----*/
|
|
3571 |
/* Get */
|
|
3572 |
/*-----*/
|
|
3573 |
|
|
3574 |
/** @ingroup Control
|
|
3575 |
* \brief Get number of Commands in CMD Queue
|
|
3576 |
*
|
|
3577 |
* \param hTWD - TWD module object handle
|
|
3578 |
* \return Maximum Number of Commands currently in CMD Queue
|
|
3579 |
*
|
|
3580 |
* \par Description
|
|
3581 |
*
|
|
3582 |
* \sa
|
|
3583 |
*/
|
|
3584 |
TI_UINT32 TWD_GetMaxNumberOfCommandsInQueue (TI_HANDLE hTWD);
|
|
3585 |
/** @ingroup Power_Management
|
|
3586 |
* \brief Get Power Save Status
|
|
3587 |
*
|
|
3588 |
* \param hTWD - TWD module object handle
|
|
3589 |
* \return TI_OK on success or TI_NOK on failure
|
|
3590 |
*
|
|
3591 |
* \par Description
|
|
3592 |
*
|
|
3593 |
* \sa
|
|
3594 |
*/
|
|
3595 |
TI_BOOL TWD_GetPsStatus (TI_HANDLE hTWD);
|
|
3596 |
|
|
3597 |
TI_STATUS TWD_GetRxFilters (TI_HANDLE hTWD, TI_UINT32 *pRxConfigOption, TI_UINT32* pRxFilterOption);
|
|
3598 |
TI_STATUS TWD_GetRadioStandByState (TI_HANDLE hTWD);
|
|
3599 |
|
|
3600 |
/** @ingroup Control
|
|
3601 |
* \brief Get FW Information
|
|
3602 |
*
|
|
3603 |
* \param hTWD - TWD module object handle
|
|
3604 |
* \return TFwInfo - Pointer to Output FW Information Structure
|
|
3605 |
*
|
|
3606 |
* \par Description
|
|
3607 |
* Gets the TFwInfo pointer
|
|
3608 |
*
|
|
3609 |
* \sa TFwInfo
|
|
3610 |
*/
|
|
3611 |
TFwInfo* TWD_GetFWInfo (TI_HANDLE hTWD);
|
|
3612 |
/** @ingroup BSS
|
|
3613 |
* \brief Get Group Address Table
|
|
3614 |
*
|
|
3615 |
* \param hTWD - TWD module object handle
|
|
3616 |
* \param pEnabled - Pointer to Output Indicatore if MAC Address Filter is Enabled
|
|
3617 |
* \param pNumGroupAddrs - Pointer to Output Number of Group Address
|
|
3618 |
* \param pGroupAddr - Pointer to Output Group Address Table
|
|
3619 |
* \return TI_OK on success or TI_NOK on failure
|
|
3620 |
*
|
|
3621 |
* \par Description
|
|
3622 |
*
|
|
3623 |
* \sa TWD_WriteMib, TMacAddr
|
|
3624 |
*/
|
|
3625 |
TI_STATUS TWD_GetGroupAddressTable (TI_HANDLE hTWD, TI_UINT8* pEnabled, TI_UINT8* pNumGroupAddrs, TMacAddr *pGroupAddr);
|
|
3626 |
/** @ingroup Control
|
|
3627 |
* \brief Read Memory
|
|
3628 |
*
|
|
3629 |
* \param hTWD - TWD module object handle
|
|
3630 |
* \param pMemDebug - Pointer to read Output
|
|
3631 |
* \param fCb - Pointer to function Callback
|
|
3632 |
* \param hCb - Handle to function Callback Parameters
|
|
3633 |
* \return TI_OK on success or TI_NOK on failure
|
|
3634 |
*
|
|
3635 |
* \par Description
|
|
3636 |
*
|
|
3637 |
* \sa
|
|
3638 |
*/
|
|
3639 |
TI_STATUS TWD_readMem (TI_HANDLE hTWD, TFwDebugParams* pMemDebug, void* fCb, TI_HANDLE hCb);
|
|
3640 |
/** @ingroup Control
|
|
3641 |
* \brief Write Memory
|
|
3642 |
*
|
|
3643 |
* \param hTWD - TWD module object handle
|
|
3644 |
* \param pMemDebug - Pointer to write Input
|
|
3645 |
* \param fCb - Pointer to function Callback
|
|
3646 |
* \param hCb - Handle to function Callback Parameters
|
|
3647 |
* \return TI_OK on success or TI_NOK on failure
|
|
3648 |
*
|
|
3649 |
* \par Description
|
|
3650 |
*
|
|
3651 |
* \sa
|
|
3652 |
*/
|
|
3653 |
TI_STATUS TWD_writeMem (TI_HANDLE hTWD, TFwDebugParams* pMemDebug, void* fCb, TI_HANDLE hCb);
|
|
3654 |
|
|
3655 |
/** @ingroup Control
|
|
3656 |
* \brief Check if addr is a valid memory address
|
|
3657 |
*
|
|
3658 |
* \param hTWD - TWD module object handle
|
|
3659 |
* \param pMemDebug - Pointer to addr & length
|
|
3660 |
* \return TI_TRUE on success or TI_FALSE on failure
|
|
3661 |
*
|
|
3662 |
* \par Description
|
|
3663 |
*
|
|
3664 |
* \sa
|
|
3665 |
*/
|
|
3666 |
TI_BOOL TWD_isValidMemoryAddr (TI_HANDLE hTWD, TFwDebugParams* pMemDebug);
|
|
3667 |
|
|
3668 |
/** @ingroup Control
|
|
3669 |
* \brief Check if addr is a valid register address
|
|
3670 |
*
|
|
3671 |
* \param hTWD - TWD module object handle
|
|
3672 |
* \param pMemDebug - Pointer to addr & length
|
|
3673 |
* \return TI_TRUE on success or TI_FALSE on failure
|
|
3674 |
*
|
|
3675 |
* \par Description
|
|
3676 |
*
|
|
3677 |
* \sa
|
|
3678 |
*/
|
|
3679 |
TI_BOOL TWD_isValidRegAddr (TI_HANDLE hTWD, TFwDebugParams* pMemDebug);
|
|
3680 |
|
|
3681 |
/*-----*/
|
|
3682 |
/* Set */
|
|
3683 |
/*-----*/
|
|
3684 |
|
|
3685 |
/** @ingroup Power_Management
|
|
3686 |
* \brief Set Power Save Mode
|
|
3687 |
*
|
|
3688 |
* \param hTWD - TWD module object handle
|
|
3689 |
* \param ePsMode - Power Save Mode
|
|
3690 |
* \param bSendNullDataOnExit - Indicates whether to send NULL data when exiting driver mode
|
|
3691 |
* \param hPowerSaveCompleteCb - Handle to PS Complete CB Parameters Obj
|
|
3692 |
* \param fPowerSaveCompleteCb - The PS Complete CB function
|
|
3693 |
* \param fPowerSaveResponseCb - The PS Response CB function
|
|
3694 |
* \return TI_OK on success or TI_NOK on failure
|
|
3695 |
*
|
|
3696 |
* \par Description
|
|
3697 |
*
|
|
3698 |
* \sa
|
|
3699 |
*/
|
|
3700 |
TI_STATUS TWD_SetPsMode (TI_HANDLE hTWD,
|
|
3701 |
E80211PsMode ePsMode,
|
|
3702 |
TI_BOOL bSendNullDataOnExit,
|
|
3703 |
TI_HANDLE hPowerSaveCompleteCb,
|
|
3704 |
TPowerSaveCompleteCb fPowerSaveCompleteCb,
|
|
3705 |
TPowerSaveResponseCb fPowerSaveResponseCb);
|
|
3706 |
/** @ingroup Radio
|
|
3707 |
* \brief Set Rate Modulation
|
|
3708 |
*
|
|
3709 |
* \param hTWD - TWD module object handle
|
|
3710 |
* \param rate - Rate Modulation Value
|
|
3711 |
* \return TRUE if Power Service State is Pwer Save, FALSE otherwise
|
|
3712 |
*
|
|
3713 |
* \par Description
|
|
3714 |
*
|
|
3715 |
* \sa
|
|
3716 |
*/
|
|
3717 |
TI_STATUS TWD_SetNullRateModulation (TI_HANDLE hTWD, TI_UINT16 rate);
|
|
3718 |
/** @ingroup Radio
|
|
3719 |
* \brief Set Radio Band
|
|
3720 |
*
|
|
3721 |
* \param hTWD - TWD module object handle
|
|
3722 |
* \param eRadioBand - Radio Band Type
|
|
3723 |
* \return TI_OK on success or TI_NOK on failure
|
|
3724 |
*
|
|
3725 |
* \par Description
|
|
3726 |
*
|
|
3727 |
* \sa
|
|
3728 |
*/
|
|
3729 |
TI_STATUS TWD_SetRadioBand (TI_HANDLE hTWD, ERadioBand eRadioBand);
|
|
3730 |
/** @ingroup Data_Path
|
|
3731 |
* \brief Set Security Sequance Number
|
|
3732 |
*
|
|
3733 |
* \param hTWD - TWD module object handle
|
|
3734 |
* \param securitySeqNumLsByte - LS Byte of Security Sequance Number
|
|
3735 |
* \return TI_OK on success or TI_NOK on failure
|
|
3736 |
*
|
|
3737 |
* \par Description
|
|
3738 |
* Update the TKIP/AES sequence-number according to the Tx data packet security-sequance-number
|
|
3739 |
* Note: The FW always provides the last used sequance-number so no need to check if the current
|
|
3740 |
* packet is data and WEP is on
|
|
3741 |
*
|
|
3742 |
* \sa
|
|
3743 |
*/
|
|
3744 |
TI_STATUS TWD_SetSecuritySeqNum (TI_HANDLE hTWD, TI_UINT8 securitySeqNumLsByte);
|
|
3745 |
/** @ingroup BSS
|
|
3746 |
* \brief Update DTIM & TBTT
|
|
3747 |
*
|
|
3748 |
* \param hTWD - TWD module object handle
|
|
3749 |
* \param uDtimPeriod - DTIM period in number of beacons
|
|
3750 |
* \param uBeaconInterval - Beacon perios in TUs (1024 msec)
|
|
3751 |
* \return void
|
|
3752 |
*
|
|
3753 |
* \par Description
|
|
3754 |
* Update DTIM and Beacon periods for scan timeout calculations
|
|
3755 |
*
|
|
3756 |
* \sa
|
|
3757 |
*/
|
|
3758 |
void TWD_UpdateDtimTbtt (TI_HANDLE hTWD, TI_UINT8 uDtimPeriod, TI_UINT16 uBeaconInterval);
|
|
3759 |
|
|
3760 |
/*---------*/
|
|
3761 |
/* Command */
|
|
3762 |
/*---------*/
|
|
3763 |
|
|
3764 |
|
|
3765 |
TI_STATUS TWD_CmdStartScan (TI_HANDLE hTWD,
|
|
3766 |
TScanParams *pScanVals,
|
|
3767 |
TI_BOOL bHighPriority,
|
|
3768 |
void* fScanCommandResponseCb,
|
|
3769 |
TI_HANDLE hCb);
|
|
3770 |
TI_STATUS TWD_CmdStartSPSScan (TI_HANDLE hTWD,
|
|
3771 |
TScanParams *pScanVals,
|
|
3772 |
void *fScanCommandResponseCb,
|
|
3773 |
TI_HANDLE hCb);
|
|
3774 |
TI_STATUS TWD_CmdStopScan (TI_HANDLE hTWD, void *fScanCommandResponseCb, TI_HANDLE hCb);
|
|
3775 |
|
|
3776 |
TI_STATUS TWD_CmdStopSPSScan (TI_HANDLE hTWD, void *fScanCommandResponseCb, TI_HANDLE hCb);
|
|
3777 |
|
|
3778 |
/** @ingroup Measurement
|
|
3779 |
* \brief Set Split scan time out
|
|
3780 |
*
|
|
3781 |
* \param hTWD - TWD module object handle
|
|
3782 |
* \param uTimeOut - Scan Time Out
|
|
3783 |
* \return TI_OK on success or TI_NOK on failure
|
|
3784 |
*
|
|
3785 |
* \par Description
|
|
3786 |
* Set Triggered scan time out per channel
|
|
3787 |
*
|
|
3788 |
* \sa
|
|
3789 |
*/
|
|
3790 |
TI_STATUS TWD_CmdSetSplitScanTimeOut (TI_HANDLE hTWD, TI_UINT32 uTimeOut);
|
|
3791 |
/** @ingroup BSS
|
|
3792 |
* \brief Join BSS
|
|
3793 |
*
|
|
3794 |
* \param hTWD - TWD module object handle
|
|
3795 |
* \param pJoinBssParams - Pointer to Join BSS Input parameters structure
|
|
3796 |
* \return TI_OK on success or TI_NOK on failure
|
|
3797 |
*
|
|
3798 |
* \par Description
|
|
3799 |
*
|
|
3800 |
* \sa
|
|
3801 |
*/
|
|
3802 |
TI_STATUS TWD_CmdJoinBss (TI_HANDLE hTWD, TJoinBss *pJoinBssParams);
|
|
3803 |
/** @ingroup Control
|
|
3804 |
* \brief Command Template
|
|
3805 |
*
|
|
3806 |
* \param hTWD - TWD module object handle
|
|
3807 |
* \param pTemplateParams - Pointer to Input Template Parameters Structure
|
|
3808 |
* \param fCb - Pointer to Command Callback Function
|
|
3809 |
* \param hCb - Handle to Command Callback Function Obj. Parameters
|
|
3810 |
* \return TI_OK on success or TI_NOK on failure
|
|
3811 |
*
|
|
3812 |
* \par Description
|
|
3813 |
* Sets a template to the FW
|
|
3814 |
*
|
|
3815 |
* \sa
|
|
3816 |
*/
|
|
3817 |
/* 6.1.08 - for future WHA measurement command */
|
|
3818 |
TI_STATUS TWD_CmdTemplate (TI_HANDLE hTWD, TSetTemplate *pTemplateParams, void *fCb, TI_HANDLE hCb);
|
|
3819 |
/** @ingroup Data_Path
|
|
3820 |
* \brief Enable Tx path
|
|
3821 |
*
|
|
3822 |
* \param hTWD - TWD module object handle
|
|
3823 |
* \param channel - Channel Number
|
|
3824 |
* \return TI_OK on success or TI_NOK on failure
|
|
3825 |
*
|
|
3826 |
* \par Description
|
|
3827 |
* Enable tx path on the hardware
|
|
3828 |
*
|
|
3829 |
* \sa
|
|
3830 |
*/
|
|
3831 |
TI_STATUS TWD_CmdEnableTx (TI_HANDLE hTWD, TI_UINT8 channel);
|
|
3832 |
/** @ingroup Data_Path
|
|
3833 |
* \brief Disable Tx path
|
|
3834 |
*
|
|
3835 |
* \param hTWD - TWD module object handle
|
|
3836 |
* \return TI_OK on success or TI_NOK on failure
|
|
3837 |
*
|
|
3838 |
* \par Description
|
|
3839 |
*
|
|
3840 |
* \sa
|
|
3841 |
*/
|
|
3842 |
TI_STATUS TWD_CmdDisableTx (TI_HANDLE hTWD);
|
|
3843 |
/** @ingroup Measurement
|
|
3844 |
* \brief Command Noise Histogram
|
|
3845 |
*
|
|
3846 |
* \param hTWD - TWD module object handle
|
|
3847 |
* \param pNoiseHistParams - Pointer Input Noise Histogram Parameters:
|
|
3848 |
* holds Start/Stop Noise Histogram Measure Indication,
|
|
3849 |
* Sample Interval & Sample Ranges
|
|
3850 |
* \return TI_OK on success or TI_NOK on failure
|
|
3851 |
*
|
|
3852 |
* \par Description
|
|
3853 |
* Send a Start/Stop Noise Histogram Measure Command to the FW with measure parameters
|
|
3854 |
*
|
|
3855 |
* \sa TNoiseHistogram
|
|
3856 |
*/
|
|
3857 |
TI_STATUS TWD_CmdNoiseHistogram (TI_HANDLE hTWD, TNoiseHistogram *pNoiseHistParams);
|
|
3858 |
|
|
3859 |
TI_STATUS TWD_CmdPSMode (TI_HANDLE hTWD, TPowerSaveParams *pPowerSaveParams);
|
|
3860 |
/** @ingroup Radio
|
|
3861 |
* \brief Command Switch Channel
|
|
3862 |
*
|
|
3863 |
* \param hTWD - TWD module object handle
|
|
3864 |
* \param pSwitchChannelCmd - Pointer to Switch Channel Parameters Structure
|
|
3865 |
* \return TI_OK on success or TI_NOK on failure
|
|
3866 |
*
|
|
3867 |
* \par Description
|
|
3868 |
*
|
|
3869 |
* \sa TSwitchChannelParams
|
|
3870 |
*/
|
|
3871 |
TI_STATUS TWD_CmdSwitchChannel (TI_HANDLE hTWD, TSwitchChannelParams *pSwitchChannelCmd);
|
|
3872 |
/** @ingroup Radio
|
|
3873 |
* \brief Command Switch Channel Cancel
|
|
3874 |
*
|
|
3875 |
* \param hTWD - TWD module object handle
|
|
3876 |
* \param channel - Channek Number
|
|
3877 |
* \return TI_OK on success or TI_NOK on failure
|
|
3878 |
*
|
|
3879 |
* \par Description
|
|
3880 |
*
|
|
3881 |
* \sa
|
|
3882 |
*/
|
|
3883 |
TI_STATUS TWD_CmdSwitchChannelCancel (TI_HANDLE hTWD, TI_UINT8 channel);
|
|
3884 |
/** @ingroup Control
|
|
3885 |
* \brief FW Disconnect
|
|
3886 |
*
|
|
3887 |
* \param hTWD - TWD module object handle
|
|
3888 |
* \return TI_OK on success or TI_NOK on failure
|
|
3889 |
*
|
|
3890 |
* \par Description
|
|
3891 |
*
|
|
3892 |
* \sa
|
|
3893 |
*/
|
|
3894 |
TI_STATUS TWD_CmdFwDisconnect (TI_HANDLE hTWD, DisconnectType_e uDisconType, TI_UINT16 uDisconReason);
|
|
3895 |
/** @ingroup Measurement
|
|
3896 |
* \brief Start Measurement Command
|
|
3897 |
*
|
|
3898 |
* \param hTWD - TWD module object handle
|
|
3899 |
* \param uDisconReason - 2 bytes of disconnect reason to be use in deauth/disassoc frmaes
|
|
3900 |
* \param uDisconType - Immediate (dont send frames) or send Deauth or send Disassoc frmae
|
|
3901 |
* \return TI_OK on success or TI_NOK on failure
|
|
3902 |
*
|
|
3903 |
* \par Description
|
|
3904 |
* send Command for start measurement to FW
|
|
3905 |
*
|
|
3906 |
* \sa TMeasurementParams
|
|
3907 |
*/
|
|
3908 |
TI_STATUS TWD_CmdMeasurement (TI_HANDLE hTWD,
|
|
3909 |
TMeasurementParams *pMeasurementParams,
|
|
3910 |
void *fCommandResponseCb,
|
|
3911 |
TI_HANDLE hCb);
|
|
3912 |
/** @ingroup Measurement
|
|
3913 |
* \brief Stop Measurement Command
|
|
3914 |
*
|
|
3915 |
* \param hTWD - TWD module object handle
|
|
3916 |
* \param fCb - Pointer to Callback Function
|
|
3917 |
* \param hCb - Handle to Callback Function Object Parameters
|
|
3918 |
* \return TI_OK on success or TI_NOK on failure
|
|
3919 |
*
|
|
3920 |
* \par Description
|
|
3921 |
* send Command for stop measurement to FW
|
|
3922 |
*
|
|
3923 |
* \sa
|
|
3924 |
*/
|
|
3925 |
TI_STATUS TWD_CmdMeasurementStop (TI_HANDLE hTWD, void* fCb, TI_HANDLE hCb);
|
|
3926 |
/** @ingroup UnKnown
|
|
3927 |
* \brief AP Discovery
|
|
3928 |
*
|
|
3929 |
* \param hTWD - TWD module object handle
|
|
3930 |
* \param pApDiscoveryParams - Pointer to Input AP Discovery Parameters Structure
|
|
3931 |
* \return TI_OK on success or TI_NOK on failure
|
|
3932 |
*
|
|
3933 |
* \par Description
|
|
3934 |
*
|
|
3935 |
* \sa
|
|
3936 |
*/
|
|
3937 |
TI_STATUS TWD_CmdApDiscovery (TI_HANDLE hTWD, TApDiscoveryParams *pApDiscoveryParams);
|
|
3938 |
/** @ingroup UnKnown
|
|
3939 |
* \brief AP Discovery Stop
|
|
3940 |
*
|
|
3941 |
* \param hTWD - TWD module object handle
|
|
3942 |
* \return TI_OK on success or TI_NOK on failure
|
|
3943 |
*
|
|
3944 |
* \par Description
|
|
3945 |
*
|
|
3946 |
* \sa
|
|
3947 |
*/
|
|
3948 |
TI_STATUS TWD_CmdApDiscoveryStop (TI_HANDLE hTWD);
|
|
3949 |
|
|
3950 |
TI_STATUS TWD_CmdTest (TI_HANDLE hTWD, void *fCb, TI_HANDLE hCb, TTestCmd* pTestCmd);
|
|
3951 |
/** @ingroup Control
|
|
3952 |
* \brief Helth Check
|
|
3953 |
*
|
|
3954 |
* \param hTWD - TWD module object handle
|
|
3955 |
* \return TI_OK on success or TI_NOK on failure
|
|
3956 |
*
|
|
3957 |
* \par Description
|
|
3958 |
* Trigger the FW health test command and wait for results
|
|
3959 |
*
|
|
3960 |
* \sa
|
|
3961 |
*/
|
|
3962 |
TI_STATUS TWD_CmdHealthCheck (TI_HANDLE hTWD);
|
|
3963 |
/** @ingroup UnKnown
|
|
3964 |
* \brief AP Discovery
|
|
3965 |
*
|
|
3966 |
* \param hTWD - TWD module object handle
|
|
3967 |
* \param staState - stat of the station (CONNECTED)
|
|
3968 |
* \return TI_OK on success or TI_NOK on failure
|
|
3969 |
*
|
|
3970 |
* \par Description
|
|
3971 |
*
|
|
3972 |
* \sa
|
|
3973 |
*/
|
|
3974 |
TI_STATUS TWD_CmdSetStaState (TI_HANDLE hTWD, TI_UINT8 staState, void *fCb, TI_HANDLE hCb);
|
|
3975 |
|
|
3976 |
/*-----------*/
|
|
3977 |
/* Configure */
|
|
3978 |
/*-----------*/
|
|
3979 |
|
|
3980 |
/** @ingroup UnKnown
|
|
3981 |
* \brief Configure ARP table
|
|
3982 |
*
|
|
3983 |
* \param hTWD - TWD module object handle
|
|
3984 |
* \param tIpAddr - IP Address Input Buffer
|
|
3985 |
* \param bEnabled - Indicates if ARP filtering is Enabled (1) or Disabled (0)
|
|
3986 |
* \param eIpVer - IP Version
|
|
3987 |
* \return TI_OK on success or TI_NOK on failure
|
|
3988 |
*
|
|
3989 |
* \par Description
|
|
3990 |
* Configure ARP IP Address table
|
|
3991 |
*
|
|
3992 |
* \sa
|
|
3993 |
*/
|
|
3994 |
TI_STATUS TWD_CfgArpIpAddrTable (TI_HANDLE hTWD,
|
|
3995 |
TIpAddr tIpAddr,
|
|
3996 |
TI_BOOL bEnabled,
|
|
3997 |
EIpVer eIpVer);
|
|
3998 |
/** @ingroup BSS
|
|
3999 |
* \brief Configure Group Address Table
|
|
4000 |
*
|
|
4001 |
* \param hTWD - TWD module object handle
|
|
4002 |
* \param uNumGroupAddrs - Number of Group Address
|
|
4003 |
* \param pGroupAddr - Pointer to Input Group Address Table
|
|
4004 |
* \param bEnabled - Indicates if MAC Address Filter is Enabled
|
|
4005 |
* \return TI_OK on success or TI_NOK on failure
|
|
4006 |
*
|
|
4007 |
* \par Description
|
|
4008 |
*
|
|
4009 |
* \sa TWD_WriteMib
|
|
4010 |
*/
|
|
4011 |
TI_STATUS TWD_CfgGroupAddressTable (TI_HANDLE hTWD,
|
|
4012 |
TI_UINT8 uNumGroupAddrs,
|
|
4013 |
TMacAddr *pGroupAddr,
|
|
4014 |
TI_BOOL bEnabled);
|
|
4015 |
/** @ingroup Data_Path
|
|
4016 |
* \brief Configure RX Filters
|
|
4017 |
*
|
|
4018 |
* \param hTWD - TWD module object handle
|
|
4019 |
* \param uRxConfigOption - RX Configuration Option
|
|
4020 |
* \param uRxFilterOption - RX Filter Option
|
|
4021 |
* \return TI_OK on success or TI_NOK on failure
|
|
4022 |
*
|
|
4023 |
* \par Description
|
|
4024 |
*
|
|
4025 |
* \sa TWD_WriteMib
|
|
4026 |
*/
|
|
4027 |
TI_STATUS TWD_CfgRx (TI_HANDLE hTWD, TI_UINT32 uRxConfigOption, TI_UINT32 uRxFilterOption);
|
|
4028 |
/** @ingroup UnKnown
|
|
4029 |
* \brief Configure Packet Detection Threshold
|
|
4030 |
*
|
|
4031 |
* \param hTWD - TWD module object handle
|
|
4032 |
* \param threshold - Threshold Value
|
|
4033 |
* \return TI_OK on success or TI_NOK on failure
|
|
4034 |
*
|
|
4035 |
* \par Description
|
|
4036 |
*
|
|
4037 |
* \sa ERate
|
|
4038 |
*/
|
|
4039 |
TI_STATUS TWD_CfgPacketDetectionThreshold (TI_HANDLE hTWD, TI_UINT32 threshold);
|
|
4040 |
/** @ingroup Radio
|
|
4041 |
* \brief Configure Slot Time
|
|
4042 |
*
|
|
4043 |
* \param hTWD - TWD module object handle
|
|
4044 |
* \param eSlotTimeVal - Slot Time Value
|
|
4045 |
* \return TI_OK on success or TI_NOK on failure
|
|
4046 |
*
|
|
4047 |
* \par Description
|
|
4048 |
*
|
|
4049 |
* \sa
|
|
4050 |
*/
|
|
4051 |
TI_STATUS TWD_CfgSlotTime (TI_HANDLE hTWD, ESlotTime eSlotTimeVal);
|
|
4052 |
/** @ingroup Radio
|
|
4053 |
* \brief Configure Preamble
|
|
4054 |
*
|
|
4055 |
* \param hTWD - TWD module object handle
|
|
4056 |
* \param ePreamble - Preamble Value
|
|
4057 |
* \return TI_OK on success or TI_NOK on failure
|
|
4058 |
*
|
|
4059 |
* \par Description
|
|
4060 |
*
|
|
4061 |
* \sa
|
|
4062 |
*/
|
|
4063 |
TI_STATUS TWD_CfgPreamble (TI_HANDLE hTWD, EPreamble ePreamble);
|
|
4064 |
/** @ingroup Power_Management
|
|
4065 |
* \brief Configure Beacon Filter State
|
|
4066 |
*
|
|
4067 |
* \param hTWD - TWD module object handle
|
|
4068 |
* \param uBeaconFilteringStatus - Beacon Filtering Status. Indicates whether the filter is enabled:
|
|
4069 |
* 1 - enabled, 0 - disabled
|
|
4070 |
* \param uNumOfBeaconsToBuffer - Determines the number of beacons without the unicast TIM bit set,
|
|
4071 |
* that the firmware buffers before signaling the host about ready frames.
|
|
4072 |
* When thi snumber is set to 0 and the filter is enabled, beacons without
|
|
4073 |
* the unicast TIM bit set are dropped.
|
|
4074 |
* \return TI_OK on success or TI_NOK on failure
|
|
4075 |
*
|
|
4076 |
* \par Description
|
|
4077 |
* Configure Beacon Filter State to the FW
|
|
4078 |
*
|
|
4079 |
* \sa
|
|
4080 |
*/
|
|
4081 |
TI_STATUS TWD_CfgBeaconFilterOpt (TI_HANDLE hTWD, TI_UINT8 uBeaconFilteringStatus, TI_UINT8 uNumOfBeaconsToBuffer);
|
|
4082 |
/** @ingroup Power_Management
|
|
4083 |
* \brief Configure Beacon Filter Table
|
|
4084 |
*
|
|
4085 |
* \param hTWD - TWD module object handle
|
|
4086 |
* \param uNumOfIe - The number of IE's in the table
|
|
4087 |
* \param pIeTable - Pointer to Input IE Table
|
|
4088 |
* \param uIeTableSize - Size of Input IE Table
|
|
4089 |
* \return TI_OK on success or TI_NOK on failure
|
|
4090 |
*
|
|
4091 |
* \par Description
|
|
4092 |
* Configure Beacon Filter Table to the FW
|
|
4093 |
*
|
|
4094 |
* \sa
|
|
4095 |
*/
|
|
4096 |
TI_STATUS TWD_CfgBeaconFilterTable (TI_HANDLE hTWD, TI_UINT8 uNumOfIe, TI_UINT8 *pIeTable, TI_UINT8 uIeTableSize);
|
|
4097 |
/** @ingroup Power_Management
|
|
4098 |
* \brief Configure Wake Up Condition
|
|
4099 |
*
|
|
4100 |
* \param hTWD - TWD module object handle
|
|
4101 |
* \param pPowerMgmtConfig - Pointer to Input Power Management Configuration Parameters
|
|
4102 |
* \return TI_OK on success or TI_NOK on failure
|
|
4103 |
*
|
|
4104 |
* \par Description
|
|
4105 |
* Configure Power Manager's Wake Up Condition
|
|
4106 |
*
|
|
4107 |
* \sa
|
|
4108 |
*/
|
|
4109 |
TI_STATUS TWD_CfgWakeUpCondition (TI_HANDLE hTWD, TPowerMgmtConfig *pPowerMgmtConfig);
|
|
4110 |
/** @ingroup UnKnown
|
|
4111 |
* \brief Configure Beacon Broadcast Options
|
|
4112 |
*
|
|
4113 |
* \param hTWD - TWD module object handle
|
|
4114 |
* \param pPowerMgmtConfig - Pointer to Input Power Management Configuration Parameters Structure
|
|
4115 |
* The Following Field should be filled:
|
|
4116 |
* pPowerMgmtConfig->BcnBrcOptions.BeaconRxTimeout
|
|
4117 |
* pPowerMgmtConfig->BcnBrcOptions.BroadcastRxTimeout
|
|
4118 |
* pPowerMgmtConfig->BcnBrcOptions.RxBroadcastInPs - if set, enables receive of broadcast packets in Power-Save mode
|
|
4119 |
* pPowerMgmtConfig->ConsecutivePsPollDeliveryFailureThreshold - No answer after Ps-Poll work-around
|
|
4120 |
* \return TI_OK on success or TI_NOK on failure
|
|
4121 |
*
|
|
4122 |
* \par Description
|
|
4123 |
* Configure Power Manager's Beacon Broadcast Options:
|
|
4124 |
* Beacon RX time Out, Broadcast RX Timeout, RX Broadcast In Power Save,
|
|
4125 |
* Consecutive Power Save Poll Delivery Failure Threshold
|
|
4126 |
*
|
|
4127 |
*
|
|
4128 |
* \sa TPowerMgmtConfig, TBcnBrcOptions
|
|
4129 |
*/
|
|
4130 |
TI_STATUS TWD_CfgBcnBrcOptions (TI_HANDLE hTWD, TPowerMgmtConfig *pPowerMgmtConfig);
|
|
4131 |
|
|
4132 |
/** @ingroup BSS
|
|
4133 |
* \brief Configure Max TX Retry
|
|
4134 |
*
|
|
4135 |
* \param hTWD - TWD module object handle
|
|
4136 |
* \param pRoamingTriggerCmd - Pointer to Input Configuration Parameters Structure
|
|
4137 |
* The Following Field should be filled:
|
|
4138 |
* pRoamingTriggerCmd->maxTxRetry
|
|
4139 |
* \return TI_OK on success or TI_NOK on failure
|
|
4140 |
*
|
|
4141 |
* \par Description
|
|
4142 |
* Configure the Max Tx Retry parameters
|
|
4143 |
*
|
|
4144 |
* \sa
|
|
4145 |
*/
|
|
4146 |
TI_STATUS TWD_CfgMaxTxRetry (TI_HANDLE hTWD, TRroamingTriggerParams *pRoamingTriggerCmd);
|
|
4147 |
/** @ingroup BSS
|
|
4148 |
* \brief Configure Connection Monitoring
|
|
4149 |
*
|
|
4150 |
* \param hTWD - TWD module object handle
|
|
4151 |
* \param pRoamingTriggerCmd - Pointer to Input Configuration Parameters Structure
|
|
4152 |
* The Following Field should be filled:
|
|
4153 |
* pRoamingTriggerCmd->BssLossTimeout
|
|
4154 |
* pRoamingTriggerCmd->TsfMissThreshold
|
|
4155 |
* \return TI_OK on success or TI_NOK on failure
|
|
4156 |
*
|
|
4157 |
* \par Description
|
|
4158 |
* Configure the Bss Lost Timeout & TSF miss threshold Parameters
|
|
4159 |
*
|
|
4160 |
* \sa
|
|
4161 |
*/
|
|
4162 |
TI_STATUS TWD_CfgConnMonitParams (TI_HANDLE hTWD, TRroamingTriggerParams *pRoamingTriggerCmd);
|
|
4163 |
/** @ingroup Power_Management
|
|
4164 |
* \brief Configure Sleep Auth
|
|
4165 |
*
|
|
4166 |
* \param hTWD - TWD module object handle
|
|
4167 |
* \param eMinPowerPolicy - Minimum Power Policy Type
|
|
4168 |
* \return TI_OK on success or TI_NOK on failure
|
|
4169 |
*
|
|
4170 |
* \par Description
|
|
4171 |
* Configure the minimum power policy to the FW
|
|
4172 |
*
|
|
4173 |
* \sa EPowerPolicy
|
|
4174 |
*/
|
|
4175 |
TI_STATUS TWD_CfgSleepAuth (TI_HANDLE hTWD, EPowerPolicy eMinPowerPolicy);
|
|
4176 |
/** @ingroup Control
|
|
4177 |
* \brief Configure MAC Clock
|
|
4178 |
*
|
|
4179 |
* \param hTWD - TWD module object handle
|
|
4180 |
* \param uMacClock - MAC Clock value
|
|
4181 |
* \return TI_OK on success or TI_NOK on failure
|
|
4182 |
*
|
|
4183 |
* \par Description
|
|
4184 |
*
|
|
4185 |
* \sa
|
|
4186 |
*/
|
|
4187 |
TI_STATUS TWD_CfgMacClock (TI_HANDLE hTWD, TI_UINT32 uMacClock);
|
|
4188 |
/** @ingroup Control
|
|
4189 |
* \brief Configure ARM Clock
|
|
4190 |
*
|
|
4191 |
* \param hTWD - TWD module object handle
|
|
4192 |
* \param uArmClock - ARM Clock value
|
|
4193 |
* \return TI_OK on success or TI_NOK on failure
|
|
4194 |
*
|
|
4195 |
* \par Description
|
|
4196 |
*
|
|
4197 |
* \sa
|
|
4198 |
*/
|
|
4199 |
TI_STATUS TWD_CfgArmClock (TI_HANDLE hTWD, TI_UINT32 uArmClock);
|
|
4200 |
/** @ingroup Data_Path
|
|
4201 |
* \brief Configure RX Data Filter
|
|
4202 |
*
|
|
4203 |
* \param hTWD - TWD module object handle
|
|
4204 |
* \param index - Index of the Rx Data filter
|
|
4205 |
* \param command - Command: Add/remove the filter
|
|
4206 |
* \param eAction - Action to take when packets match the pattern
|
|
4207 |
* \param uNumFieldPatterns - Number of field patterns in the filter
|
|
4208 |
* \param uLenFieldPatterns - Length of the field pattern series
|
|
4209 |
* \param pFieldPatterns - Series of field patterns
|
|
4210 |
* \return TI_OK on success or TI_NOK on failure
|
|
4211 |
*
|
|
4212 |
* \par Description
|
|
4213 |
* Add/remove Rx Data filter information element
|
|
4214 |
*
|
|
4215 |
* \sa
|
|
4216 |
*/
|
|
4217 |
TI_STATUS TWD_CfgRxDataFilter (TI_HANDLE hTWD,
|
|
4218 |
TI_UINT8 index,
|
|
4219 |
TI_UINT8 command,
|
|
4220 |
filter_e eAction,
|
|
4221 |
TI_UINT8 uNumFieldPatterns,
|
|
4222 |
TI_UINT8 uLenFieldPatterns,
|
|
4223 |
TI_UINT8 *pFieldPatterns);
|
|
4224 |
/** @ingroup Data_Path
|
|
4225 |
* \brief Configure Enable RX Data Filter
|
|
4226 |
*
|
|
4227 |
* \param hTWD - TWD module object handle
|
|
4228 |
* \param bEnabled - Indicates if Rx data filtering is enabled or Disabled
|
|
4229 |
* (0: data filtering disabled, Otherwise: enabled)
|
|
4230 |
* \param eDefaultAction - The default action taken on non-matching packets
|
|
4231 |
* \return TI_OK on success or TI_NOK on failure
|
|
4232 |
*
|
|
4233 |
* \par Description
|
|
4234 |
* Configure Enable/Disable RX Data Filter, and which default action to perform if it is enabled
|
|
4235 |
*
|
|
4236 |
* \sa
|
|
4237 |
*/
|
|
4238 |
TI_STATUS TWD_CfgEnableRxDataFilter (TI_HANDLE hTWD, TI_BOOL bEnabled, filter_e eDefaultAction);
|
|
4239 |
/** @ingroup BSS
|
|
4240 |
* \brief Configure RRSSI/SNR Trigger parameters
|
|
4241 |
*
|
|
4242 |
* \param hTWD - TWD module object handle
|
|
4243 |
* \param pRssiSnrTrigger - Pointer to RRSSI/SNR Input parameter Structure
|
|
4244 |
* \return TI_OK on success or TI_NOK on failure
|
|
4245 |
*
|
|
4246 |
* \par Description
|
|
4247 |
*
|
|
4248 |
* \sa
|
|
4249 |
*/
|
|
4250 |
TI_STATUS TWD_CfgRssiSnrTrigger (TI_HANDLE hTWD, RssiSnrTriggerCfg_t* pRssiSnrTrigger);
|
|
4251 |
/** @ingroup QoS
|
|
4252 |
* \brief Configure AC parameters
|
|
4253 |
*
|
|
4254 |
* \param hTWD - TWD module object handle
|
|
4255 |
* \param pAcQosParams - Pointer to Input AC Quality Of Service Parameters Structure
|
|
4256 |
* Fields that should be filled:
|
|
4257 |
* pAcQosParams->ac
|
|
4258 |
* pAcQosParams->aifsn
|
|
4259 |
* pAcQosParams->cwMax
|
|
4260 |
* pAcQosParams->cwMin
|
|
4261 |
* pAcQosParams->txopLimit
|
|
4262 |
* \param fCb - Pointer to Command CB Function
|
|
4263 |
* \param hCb - Handle to Command CB Function Obj Parameters
|
|
4264 |
* \return TI_OK on success or TI_NOK on failure
|
|
4265 |
*
|
|
4266 |
* \par Description
|
|
4267 |
*
|
|
4268 |
* \sa
|
|
4269 |
*/
|
|
4270 |
TI_STATUS TWD_CfgAcParams (TI_HANDLE hTWD, TAcQosParams *pAcQosParams, void *fCb, TI_HANDLE hCb);
|
|
4271 |
/** @ingroup QoS
|
|
4272 |
* \brief Configure Power Save RX Streaming
|
|
4273 |
*
|
|
4274 |
* \param hTWD - TWD module object handle
|
|
4275 |
* \param pPsRxStreaming - Pointer to Input Power Save RX Straeming Parameters Structure
|
|
4276 |
* Fields that should be filled:
|
|
4277 |
* pPsRxStreaming->uTid
|
|
4278 |
* pPsRxStreaming->bEnabled
|
|
4279 |
* pPsRxStreaming->uStreamPeriod
|
|
4280 |
* pPsRxStreaming->uTxTimeout
|
|
4281 |
* \param fCb - Pointer to Command CB Function
|
|
4282 |
* \param hCb - Handle to Command CB Function Obj Parameters
|
|
4283 |
* \return TI_OK on success or TI_NOK on failure
|
|
4284 |
*
|
|
4285 |
* \par Description
|
|
4286 |
*
|
|
4287 |
* \sa TPsRxStreaming
|
|
4288 |
*/
|
|
4289 |
TI_STATUS TWD_CfgPsRxStreaming (TI_HANDLE hTWD, TPsRxStreaming *pPsRxStreaming, void *fCb, TI_HANDLE hCb);
|
|
4290 |
/** @ingroup Power_Management
|
|
4291 |
* \brief Configure BET
|
|
4292 |
*
|
|
4293 |
* \param hTWD - TWD module object handle
|
|
4294 |
* \param Enable - 0: disable BET, Otherwirs: Enable BET
|
|
4295 |
* \param MaximumConsecutiveET - Max number of consecutive beacons that may be early terminated
|
|
4296 |
* \return TI_OK on success or TI_NOK on failure
|
|
4297 |
*
|
|
4298 |
* \par Description
|
|
4299 |
*
|
|
4300 |
* \sa
|
|
4301 |
*/
|
|
4302 |
TI_STATUS TWD_CfgBet (TI_HANDLE hTWD, TI_UINT8 Enable, TI_UINT8 MaximumConsecutiveET);
|
|
4303 |
/** @ingroup UnKnown
|
|
4304 |
* \brief Configure Keep Alive
|
|
4305 |
*
|
|
4306 |
* \param hTWD - TWD module object handle
|
|
4307 |
* \param pKeepAliveParams - Pointer to Keep Alive parameters structure
|
|
4308 |
* \return TI_OK on success or TI_NOK on failure
|
|
4309 |
*
|
|
4310 |
* \par Description
|
|
4311 |
* Configures the keep-alive paramters
|
|
4312 |
*
|
|
4313 |
* \sa
|
|
4314 |
*/
|
|
4315 |
TI_STATUS TWD_CfgKeepAlive (TI_HANDLE hTWD, TKeepAliveParams *pKeepAliveParams);
|
|
4316 |
/** @ingroup Power_Management
|
|
4317 |
* \brief Configure Keep Alive Enable/Disable flag
|
|
4318 |
*
|
|
4319 |
* \param hTWD - TWD module object handle
|
|
4320 |
* \param enaDisFlag - Indicates whether to Enable (TI_TRUE) or Disable Keep Alive
|
|
4321 |
* \return TI_OK on success or TI_NOK on failure
|
|
4322 |
*
|
|
4323 |
* \par Description
|
|
4324 |
*
|
|
4325 |
* \sa
|
|
4326 |
*/
|
|
4327 |
TI_STATUS TWD_CfgKeepAliveEnaDis (TI_HANDLE hTWD, TI_UINT8 enaDisFlag);
|
|
4328 |
/** @ingroup Data_Path
|
|
4329 |
* \brief Configure Set BA Initiator
|
|
4330 |
*
|
|
4331 |
* \param hTWD - TWD module object handle
|
|
4332 |
* \param uTid - TID number
|
|
4333 |
* \param uState - Policy : Enable / Disable
|
|
4334 |
* \param tRa - Mac address of: SA as receiver / RA as initiator
|
|
4335 |
* \param uWinSize - windows size in number of packet
|
|
4336 |
* \param uInactivityTimeout - as initiator inactivity timeout in time units(TU) of 1024us / as receiver reserved
|
|
4337 |
* \return TI_OK on success or TI_NOK on failure
|
|
4338 |
*
|
|
4339 |
* \par Description
|
|
4340 |
* configure BA session initiator parameters setting in the FW
|
|
4341 |
* called after join in order to init the parameters for negotiating BA sessions as initiator.
|
|
4342 |
* Parameters initialized: RA, TID, WinSize, Inactivity Timeout and state = Enable/Disable.
|
|
4343 |
* In case the host sends a broadcast address as RA the FW is allowed to Set or Deleted BA sessions
|
|
4344 |
* to any receiver for that TID.
|
|
4345 |
* In case of disassociate the FW allowed to establish BA session just after get that command.
|
|
4346 |
* That command will not need any respond from the FW. In case DELBA send to STA or from the
|
|
4347 |
* STA as initiator the FW doesn't send event to the host
|
|
4348 |
*
|
|
4349 |
* \sa
|
|
4350 |
*/
|
|
4351 |
TI_STATUS TWD_CfgSetBaInitiator (TI_HANDLE hTWD,
|
|
4352 |
TI_UINT8 uTid,
|
|
4353 |
TI_UINT8 uState,
|
|
4354 |
TMacAddr tRa,
|
|
4355 |
TI_UINT16 uWinSize,
|
|
4356 |
TI_UINT16 uInactivityTimeout);
|
|
4357 |
/** @ingroup Data_Path
|
|
4358 |
* \brief Configure Set BA Receiver
|
|
4359 |
*
|
|
4360 |
* \param hTWD - TWD module object handle
|
|
4361 |
* \param uTid - TID number
|
|
4362 |
* \param uState - Policy : Enable / Disable
|
|
4363 |
* \param tRa - Mac address of: SA as receiver / RA as initiator
|
|
4364 |
* \param uWinSize - windows size in number of packet
|
|
4365 |
* \return TI_OK on success or TI_NOK on failure
|
|
4366 |
*
|
|
4367 |
* \par Description
|
|
4368 |
* configure BA session receiver parameters setting in the FW
|
|
4369 |
* called after join in order to init the parameters for incoming BA session, as a responder.
|
|
4370 |
* Parameters initialized: SA, TID, winSize and state = Enable/Disable.
|
|
4371 |
* In case the host sends a broadcast address as SA the FW is allowed to Set/Deleted BA sessions
|
|
4372 |
* to any sender for that TID.
|
|
4373 |
* In case of disassociate the FW allowed to establish BA session just after get that command.
|
|
4374 |
* The events of that command will respond via the RX path from the FW: ADDBA, DELBA, BAR packets.
|
|
4375 |
*
|
|
4376 |
* \sa
|
|
4377 |
*/
|
|
4378 |
TI_STATUS TWD_CfgSetBaReceiver (TI_HANDLE hTWD,
|
|
4379 |
TI_UINT8 uTid,
|
|
4380 |
TI_UINT8 uState,
|
|
4381 |
TMacAddr tRa,
|
|
4382 |
TI_UINT16 uWinSize);
|
|
4383 |
|
|
4384 |
/** @ingroup Data_Path
|
|
4385 |
* \brief Close all BA receiver sessions
|
|
4386 |
*
|
|
4387 |
* \param hTWD - TWD module object handle
|
|
4388 |
* \return None
|
|
4389 |
*
|
|
4390 |
* \par Description
|
|
4391 |
* Close all BA receiver sessions and pass all packets in the TID queue to upper layer.
|
|
4392 |
*
|
|
4393 |
* \sa
|
|
4394 |
*/
|
|
4395 |
void TWD_CloseAllBaSessions(TI_HANDLE hTWD);
|
|
4396 |
|
|
4397 |
/** @ingroup BSS
|
|
4398 |
* \brief Set FW HT Capabilities
|
|
4399 |
*
|
|
4400 |
* \param hTWD - TWD module object handle
|
|
4401 |
* \param pHtCapabilitiesIe - Pointer to string of HT capability IE unparsed
|
|
4402 |
* \param bAllowHtOperation - TI_TRUE: HT operation allowed, Otherwise: HT operation NOT allowed
|
|
4403 |
* \return TI_OK on success or TI_NOK on failure
|
|
4404 |
*
|
|
4405 |
* \par Description
|
|
4406 |
* Parse HT capability IE and set the current AP HT Capabilities to the FW
|
|
4407 |
*
|
|
4408 |
* \sa
|
|
4409 |
*/
|
|
4410 |
TI_STATUS TWD_CfgSetFwHtCapabilities (TI_HANDLE hTWD,
|
|
4411 |
Tdot11HtCapabilitiesUnparse *pHtCapabilitiesIe,
|
|
4412 |
TI_BOOL bAllowHtOperation);
|
|
4413 |
/** @ingroup BSS
|
|
4414 |
* \brief Set FW HT Information
|
|
4415 |
*
|
|
4416 |
* \param hTWD - TWD module object handle
|
|
4417 |
* \param pHtInformationIe - Pointer to string of HT information IE unparsed
|
|
4418 |
* \return TI_OK on success or TI_NOK on failure
|
|
4419 |
*
|
|
4420 |
* \par Description
|
|
4421 |
* Parse HT Information IE and set the current AP HT Information to the FW
|
|
4422 |
*
|
|
4423 |
* \sa
|
|
4424 |
*/
|
|
4425 |
TI_STATUS TWD_CfgSetFwHtInformation (TI_HANDLE hTWD, Tdot11HtInformationUnparse *pHtInformationIe);
|
|
4426 |
|
|
4427 |
|
|
4428 |
/** @ingroup UnKnown
|
|
4429 |
* \brief Enable/Disabel burst mode
|
|
4430 |
*
|
|
4431 |
* \param hTWD - TWD module object handle
|
|
4432 |
* \param bEnabled - burst mode: Enable/Disable
|
|
4433 |
* \return TI_OK
|
|
4434 |
*
|
|
4435 |
* \par Description
|
|
4436 |
*
|
|
4437 |
* \sa
|
|
4438 |
*/
|
|
4439 |
TI_STATUS TWD_CfgBurstMode (TI_HANDLE hTWD, TI_BOOL bEnabled);
|
|
4440 |
|
|
4441 |
|
|
4442 |
/*-------------*/
|
|
4443 |
/* Interrogate */
|
|
4444 |
/*-------------*/
|
|
4445 |
|
|
4446 |
/** @ingroup UnKnown
|
|
4447 |
* \brief Interrogate Roamming Statistics
|
|
4448 |
*
|
|
4449 |
* \param hTWD - TWD module object handle
|
|
4450 |
* \param fCb - Pointer to Command CB Function
|
|
4451 |
* \param hCb - Handle to Command CB Function Obj Parameters
|
|
4452 |
* \param pCb - Pointer to read parameters
|
|
4453 |
* \return TI_OK on success or TI_NOK on failure
|
|
4454 |
*
|
|
4455 |
* \par Description
|
|
4456 |
* Interrogate ACX Roamming Statistics
|
|
4457 |
*
|
|
4458 |
* \sa
|
|
4459 |
*/
|
|
4460 |
TI_STATUS TWD_ItrRoammingStatisitics (TI_HANDLE hTWD, void *fCb, TI_HANDLE hCb, void *pCb);
|
|
4461 |
/** @ingroup UnKnown
|
|
4462 |
* \brief Configure/Interrogate RSSI
|
|
4463 |
*
|
|
4464 |
* \param hTWD - TWD module object handle
|
|
4465 |
* \param fCb - Pointer to Command CB Function
|
|
4466 |
* \param hCb - Handle to Command CB Function Obj Parameters
|
|
4467 |
* \param pCb - Pointer to read parameters
|
|
4468 |
* \return TI_OK on success or TI_NOK on failure
|
|
4469 |
*
|
|
4470 |
* \par Description
|
|
4471 |
* Configure/Interrogate StationId information element to/from FW
|
|
4472 |
* This information element specifies the MAC Address assigned to the STATION or AP.
|
|
4473 |
* The RSSI is Configed to default value which is the permanent MAC address which
|
|
4474 |
* is stored in the adaptor's non-volatile memory.
|
|
4475 |
*
|
|
4476 |
* \sa
|
|
4477 |
*/
|
|
4478 |
TI_STATUS TWD_ItrRSSI (TI_HANDLE hTWD, void *fCb, TI_HANDLE hCb, void *pCb);
|
|
4479 |
/** @ingroup UnKnown
|
|
4480 |
* \brief Interrogate Memory Map
|
|
4481 |
*
|
|
4482 |
* \param hTWD - TWD module object handle
|
|
4483 |
* \param pMap - Pointer to Output Memory Map
|
|
4484 |
* \param fCb - Pointer to Callback Function
|
|
4485 |
* \param hCb - Handle to Callback Function Parameters Object
|
|
4486 |
* \return TI_OK on success or TI_NOK on failure
|
|
4487 |
*
|
|
4488 |
* \par Description
|
|
4489 |
* Interrogate Memory Map from FW
|
|
4490 |
*
|
|
4491 |
* \sa MemoryMap_t
|
|
4492 |
*/TI_STATUS TWD_ItrMemoryMap (TI_HANDLE hTWD, MemoryMap_t *pMap, void *fCb, TI_HANDLE hCb);
|
|
4493 |
/** @ingroup UnKnown
|
|
4494 |
* \brief Interrogate Statistics
|
|
4495 |
*
|
|
4496 |
* \param hTWD - TWD module object handle
|
|
4497 |
* \param fCb - Pointer to Command CB Function
|
|
4498 |
* \param hCb - Handle to Command CB Function Obj Parameters
|
|
4499 |
* \param pCb - Pointer to read parameters
|
|
4500 |
* \return TI_OK on success or TI_NOK on failure
|
|
4501 |
*
|
|
4502 |
* \par Description
|
|
4503 |
*
|
|
4504 |
* \sa
|
|
4505 |
*/
|
|
4506 |
TI_STATUS TWD_ItrStatistics (TI_HANDLE hTWD, void *fCb, TI_HANDLE hCb, void *pCb);
|
|
4507 |
/** @ingroup Data_Path
|
|
4508 |
* \brief Interrogate Data Filter Statistics
|
|
4509 |
*
|
|
4510 |
* \param hTWD - TWD module object handle
|
|
4511 |
* \param fCb - Pointer to Command CB Function
|
|
4512 |
* \param hCb - Handle to Command CB Function Obj Parameters
|
|
4513 |
* \param pCb - Pointer to read parameters
|
|
4514 |
* \return TI_OK on success or TI_NOK on failure
|
|
4515 |
*
|
|
4516 |
* \par Description
|
|
4517 |
*
|
|
4518 |
* \sa
|
|
4519 |
*/TI_STATUS TWD_ItrDataFilterStatistics (TI_HANDLE hTWD, void *fCb, TI_HANDLE hCb, void *pCb);
|
|
4520 |
|
|
4521 |
/*
|
|
4522 |
* --------------------------------------------------------------
|
|
4523 |
* TNETW-Driver Tx API Functions
|
|
4524 |
* --------------------------------------------------------------
|
|
4525 |
*/
|
|
4526 |
|
|
4527 |
/** @ingroup Data_Path
|
|
4528 |
* \brief TWD TX Control Block Allocation
|
|
4529 |
*
|
|
4530 |
* \param hTWD - TWD module object handle
|
|
4531 |
* \return Pointer to Control Block Entry on success or NULL on failure
|
|
4532 |
*
|
|
4533 |
* \par Description
|
|
4534 |
* Use this function for Allocate a Control-Block for the packet Tx parameters and descriptor
|
|
4535 |
*
|
|
4536 |
* \sa
|
|
4537 |
*/
|
|
4538 |
TTxCtrlBlk *TWD_txCtrlBlk_Alloc (TI_HANDLE hTWD);
|
|
4539 |
/** @ingroup Data_Path
|
|
4540 |
* \brief TWD TX Control Block Free
|
|
4541 |
*
|
|
4542 |
* \param hTWD - TWD module object handle
|
|
4543 |
* \param pCurrentEntry - Pointer to TX Control Block Entry to Free
|
|
4544 |
* \return void
|
|
4545 |
*
|
|
4546 |
* \par Description
|
|
4547 |
* Use this function for Free a Control-Block of packet Tx parameters and descriptor
|
|
4548 |
*
|
|
4549 |
* \sa
|
|
4550 |
*/
|
|
4551 |
void TWD_txCtrlBlk_Free (TI_HANDLE hTWD, TTxCtrlBlk *pCurrentEntry);
|
|
4552 |
/** @ingroup Data_Path
|
|
4553 |
* \brief TWD TX Control Get Pointer
|
|
4554 |
*
|
|
4555 |
* \param hTWD - TWD module object handle
|
|
4556 |
* \param descId - Id of TX Control Block Descriptor
|
|
4557 |
* \return Pointer to Control Block Entry on success or NULL on failure
|
|
4558 |
*
|
|
4559 |
* \par Description
|
|
4560 |
* Use this function for Get a Pointer to a Control-Block of packet Tx parameters and descriptor
|
|
4561 |
*
|
|
4562 |
* \sa
|
|
4563 |
*/
|
|
4564 |
TTxCtrlBlk *TWD_txCtrlBlk_GetPointer (TI_HANDLE hTWD, TI_UINT8 descId);
|
|
4565 |
|
|
4566 |
/** @ingroup Data_Path
|
|
4567 |
* \brief Allocate Resources for TX HW Queue
|
|
4568 |
*
|
|
4569 |
* \param hTWD - TWD module object handle
|
|
4570 |
* \param pTxCtrlBlk - The Tx packet control block
|
|
4571 |
* \return see - ETxHwQueStatus
|
|
4572 |
*
|
|
4573 |
* \par Description
|
|
4574 |
* Allocates Resources (HW-blocks number required) for TX HW Queue
|
|
4575 |
*
|
|
4576 |
* \sa
|
|
4577 |
*/
|
|
4578 |
ETxHwQueStatus TWD_txHwQueue_AllocResources (TI_HANDLE hTWD, TTxCtrlBlk *pTxCtrlBlk);
|
|
4579 |
|
|
4580 |
/** @ingroup Data_Path
|
|
4581 |
* \brief TX Xfer Send Packet
|
|
4582 |
*
|
|
4583 |
* \param hTWD - TWD module object handle
|
|
4584 |
* \param pPktCtrlBlk - Pointer to TX Control Block Entry to Free
|
|
4585 |
* \return see ETxnStatus
|
|
4586 |
*
|
|
4587 |
* \par Description
|
|
4588 |
* Send Packet via TX Xfer
|
|
4589 |
*
|
|
4590 |
* \sa
|
|
4591 |
*/
|
|
4592 |
ETxnStatus TWD_txXfer_SendPacket (TI_HANDLE hTWD, TTxCtrlBlk *pPktCtrlBlk);
|
|
4593 |
/** @ingroup Control
|
|
4594 |
* \brief Watch Dog Expire Event
|
|
4595 |
*
|
|
4596 |
* \param hTWD - TWD module object handle
|
|
4597 |
* \return TI_OK on success or TI_NOK on failure
|
|
4598 |
*
|
|
4599 |
* \par Description
|
|
4600 |
* This function handles the Event of Watch Dog Expire (FW stopped)
|
|
4601 |
*
|
|
4602 |
* \sa
|
|
4603 |
*/
|
|
4604 |
TI_STATUS TWD_WdExpireEvent (TI_HANDLE hTWD);
|
|
4605 |
/*
|
|
4606 |
* --------------------------------------------------------------
|
|
4607 |
* BIT API Functions
|
|
4608 |
* --------------------------------------------------------------
|
|
4609 |
*/
|
|
4610 |
/** @ingroup Control
|
|
4611 |
* \brief TWD Test Command Complete CB
|
|
4612 |
*
|
|
4613 |
* \param Handle - handle to object
|
|
4614 |
* \param eStatus - Status of Driver Test Performed
|
|
4615 |
* \param pTestCmdParams - Pointer to Output of Test Command Parameters
|
|
4616 |
* \return void
|
|
4617 |
*
|
|
4618 |
* \par Description
|
|
4619 |
* The function prototype for the BIT Test Command Complete CB
|
|
4620 |
* Enables user to implement and use its own BIT Test Command Complete CB
|
|
4621 |
* which will be called when Driver Test end
|
|
4622 |
*
|
|
4623 |
* \sa TWDriverTest
|
|
4624 |
*/
|
|
4625 |
typedef void (*TTestCmdCB)(TI_HANDLE Handle,
|
|
4626 |
TI_STATUS eStatus,
|
|
4627 |
TI_HANDLE pTestCmdParams);
|
|
4628 |
/** @ingroup Control
|
|
4629 |
* \brief TWD Test Command Complete CB
|
|
4630 |
*
|
|
4631 |
* \param Handle - handle to object
|
|
4632 |
* \param eStatus - Status of Driver Test Performed (Complete/Pending/Error)
|
|
4633 |
* \param pTestCmdParams - Pointer to Output of Test Command Parameters
|
|
4634 |
* \return void
|
|
4635 |
*
|
|
4636 |
* \par Description
|
|
4637 |
* The function implementation for the BIT Test Command Complete CB
|
|
4638 |
*
|
|
4639 |
* \sa
|
|
4640 |
*/
|
|
4641 |
void TWDriverTestCB(TI_HANDLE Handle,
|
|
4642 |
TI_STATUS eStatus,
|
|
4643 |
TI_HANDLE pTestCmdParams);
|
|
4644 |
/** @ingroup Control
|
|
4645 |
* \brief TWD Driver Test
|
|
4646 |
*
|
|
4647 |
* \param hTWD - handle to TWD object
|
|
4648 |
* \param eTestCmd - Identifier of test Command to Perform
|
|
4649 |
* \param pTestCmdParams - Pointer to Input/Output Test Command Parameters
|
|
4650 |
* \param fCb - Test Command Complete CB
|
|
4651 |
* \param hCb - Handle to Test Command Complete CB Parameters
|
|
4652 |
* \return TI_OK on success or TI_NOK on failure
|
|
4653 |
*
|
|
4654 |
* \par Description
|
|
4655 |
* The implementation of the BIT Test Command
|
|
4656 |
*
|
|
4657 |
* \sa
|
|
4658 |
*/
|
|
4659 |
TI_STATUS TWDriverTest(TI_HANDLE hTWD,
|
|
4660 |
TestCmdID_enum eTestCmd,
|
|
4661 |
void* pTestCmdParams,
|
|
4662 |
TTestCmdCB fCb,
|
|
4663 |
TI_HANDLE hCb);
|
|
4664 |
|
|
4665 |
|
|
4666 |
|
|
4667 |
/**
|
|
4668 |
* \brief TWD get FEM type
|
|
4669 |
* *
|
|
4670 |
* \param Handle - handle to object
|
|
4671 |
* \return uint8
|
|
4672 |
*
|
|
4673 |
* \par Description
|
|
4674 |
* The function return the Front end module that was read frm FW register *
|
|
4675 |
* \sa
|
|
4676 |
*/
|
|
4677 |
|
|
4678 |
TI_UINT8 TWD_GetFEMType (TI_HANDLE hTWD);
|
|
4679 |
|
|
4680 |
|
|
4681 |
/**
|
|
4682 |
* \brief TWD end function of read radio state machine
|
|
4683 |
* * *
|
|
4684 |
* \param Handle - handle to object
|
|
4685 |
* \return void
|
|
4686 |
*
|
|
4687 |
* \par Description
|
|
4688 |
* The function calling to HwInit call back function, after finish reading FEM registers *
|
|
4689 |
* \sa
|
|
4690 |
*/
|
|
4691 |
|
|
4692 |
void TWD_FinalizeFEMRead(TI_HANDLE hTWD);
|
|
4693 |
void TWD_FinalizePolarityRead(TI_HANDLE hTWD);
|
|
4694 |
|
|
4695 |
/**
|
|
4696 |
* \function TWD_rxXfer_Handle
|
|
4697 |
*
|
|
4698 |
* Handle Rx buffers read in case we delayed it from upper layer
|
|
4699 |
*
|
|
4700 |
* \param hTWD - TWD module object handle
|
|
4701 |
*
|
|
4702 |
* \sa
|
|
4703 |
*/
|
|
4704 |
void TWD_rxXfer_Handle (TI_HANDLE hTWD);
|
|
4705 |
|
|
4706 |
TI_STATUS TWD_SetRateMngDebug(TI_HANDLE hTWD, RateMangeParams_t *pRateMngParams);
|
|
4707 |
TI_STATUS TWD_GetRateMngDebug(TI_HANDLE hTWD, RateMangeReadParams_t *pParamInfo);
|
|
4708 |
|
|
4709 |
#endif /* TWDRIVER_H */
|