xref: /OK3568_Linux_fs/external/rkwifibt/drivers/infineon/dhd_wlfc.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Portions of this code are copyright (c) 2021 Cypress Semiconductor Corporation
3  *
4  * Copyright (C) 1999-2017, Broadcom Corporation
5  *
6  *      Unless you and Broadcom execute a separate written software license
7  * agreement governing use of this software, this software is licensed to you
8  * under the terms of the GNU General Public License version 2 (the "GPL"),
9  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
10  * following added to such license:
11  *
12  *      As a special exception, the copyright holders of this software give you
13  * permission to link this software with independent modules, and to copy and
14  * distribute the resulting executable under terms of your choice, provided that
15  * you also meet, for each linked independent module, the terms and conditions of
16  * the license of that module.  An independent module is a module which is not
17  * derived from this software.  The special exception does not apply to any
18  * modifications of the software.
19  *
20  *      Notwithstanding the above, under no circumstances may you combine this
21  * software in any way with any other Broadcom software provided under a license
22  * other than the GPL, without Broadcom's express prior written consent.
23  *
24  *
25  * <<Broadcom-WL-IPTag/Open:>>
26  *
27  * $Id: dhd_wlfc.h 690477 2017-03-16 10:17:17Z $
28  *
29  */
30 #ifndef __wlfc_host_driver_definitions_h__
31 #define __wlfc_host_driver_definitions_h__
32 
33 /* #define OOO_DEBUG */
34 
35 #define KERNEL_THREAD_RETURN_TYPE int
36 
37 typedef int (*f_commitpkt_t)(void* ctx, void* p);
38 typedef bool (*f_processpkt_t)(void* p, void* arg);
39 
40 #define WLFC_UNSUPPORTED -9999
41 
42 #define WLFC_NO_TRAFFIC	-1
43 #define WLFC_MULTI_TRAFFIC 0
44 
45 #define BUS_RETRIES 1	/* # of retries before aborting a bus tx operation */
46 
47 /** 16 bits will provide an absolute max of 65536 slots */
48 #define WLFC_HANGER_MAXITEMS 3072
49 
50 #define WLFC_HANGER_ITEM_STATE_FREE			1
51 #define WLFC_HANGER_ITEM_STATE_INUSE			2
52 #define WLFC_HANGER_ITEM_STATE_INUSE_SUPPRESSED		3
53 #define WLFC_HANGER_ITEM_STATE_FLUSHED			4
54 
55 #define WLFC_HANGER_PKT_STATE_TXSTATUS			1
56 #define WLFC_HANGER_PKT_STATE_BUSRETURNED		2
57 #define WLFC_HANGER_PKT_STATE_COMPLETE			\
58 	(WLFC_HANGER_PKT_STATE_TXSTATUS | WLFC_HANGER_PKT_STATE_BUSRETURNED)
59 
60 typedef enum {
61 	Q_TYPE_PSQ, /**< Power Save Queue, contains both delayed and suppressed packets */
62 	Q_TYPE_AFQ  /**< At Firmware Queue */
63 } q_type_t;
64 
65 typedef enum ewlfc_packet_state {
66 	eWLFC_PKTTYPE_NEW,        /**< unused in the code (Jan 2015) */
67 	eWLFC_PKTTYPE_DELAYED,    /**< packet did not enter wlfc yet */
68 	eWLFC_PKTTYPE_SUPPRESSED, /**< packet entered wlfc and was suppressed by the dongle */
69 	eWLFC_PKTTYPE_MAX
70 } ewlfc_packet_state_t;
71 
72 typedef enum ewlfc_mac_entry_action {
73 	eWLFC_MAC_ENTRY_ACTION_ADD,
74 	eWLFC_MAC_ENTRY_ACTION_DEL,
75 	eWLFC_MAC_ENTRY_ACTION_UPDATE,
76 	eWLFC_MAC_ENTRY_ACTION_MAX
77 } ewlfc_mac_entry_action_t;
78 
79 typedef struct wlfc_hanger_item {
80 	uint8	state;
81 	uint8   gen;
82 	uint8	pkt_state;     /**< bitmask containing eg WLFC_HANGER_PKT_STATE_TXCOMPLETE */
83 	uint8	pkt_txstatus;
84 	uint32	identifier;
85 	void*	pkt;
86 #ifdef PROP_TXSTATUS_DEBUG
87 	uint32	push_time;
88 #endif // endif
89 	struct wlfc_hanger_item *next;
90 } wlfc_hanger_item_t;
91 
92 /** hanger contains packets that have been posted by the dhd to the dongle and are expected back */
93 typedef struct wlfc_hanger {
94 	int max_items;
95 	uint32 pushed;
96 	uint32 popped;
97 	uint32 failed_to_push;
98 	uint32 failed_to_pop;
99 	uint32 failed_slotfind;
100 	uint32 slot_pos;
101 	wlfc_hanger_item_t items[1];
102 } wlfc_hanger_t;
103 
104 #define WLFC_HANGER_SIZE(n)	((sizeof(wlfc_hanger_t) - \
105 	sizeof(wlfc_hanger_item_t)) + ((n)*sizeof(wlfc_hanger_item_t)))
106 
107 #define WLFC_STATE_OPEN		1	/**< remote MAC is able to receive packets */
108 #define WLFC_STATE_CLOSE	2	/**< remote MAC is in power save mode */
109 
110 #define WLFC_PSQ_PREC_COUNT		((AC_COUNT + 1) * 2) /**< 2 for each AC traffic and bc/mc */
111 #define WLFC_AFQ_PREC_COUNT		(AC_COUNT + 1)
112 
113 #define WLFC_PSQ_LEN			(4096 * 8)
114 
115 #define WLFC_FLOWCONTROL_HIWATER	((4096 * 8) - 256)
116 #define WLFC_FLOWCONTROL_LOWATER	256
117 
118 #if (WLFC_FLOWCONTROL_HIWATER >= (WLFC_PSQ_LEN - 256))
119 #undef WLFC_FLOWCONTROL_HIWATER
120 #define WLFC_FLOWCONTROL_HIWATER	(WLFC_PSQ_LEN - 256)
121 #undef WLFC_FLOWCONTROL_LOWATER
122 #define WLFC_FLOWCONTROL_LOWATER	(WLFC_FLOWCONTROL_HIWATER / 4)
123 #endif // endif
124 
125 #define WLFC_LOG_BUF_SIZE		(1024*1024)
126 
127 /** Properties related to a remote MAC entity */
128 typedef struct wlfc_mac_descriptor {
129 	uint8 occupied;         /**< if 0, this descriptor is unused and thus can be (re)used */
130 	uint8 interface_id;
131 	uint8 iftype;           /**< eg WLC_E_IF_ROLE_STA */
132 	uint8 state;            /**< eg WLFC_STATE_OPEN */
133 	uint8 ac_bitmap;        /**< automatic power save delivery (APSD) */
134 	uint8 requested_credit;
135 	uint8 requested_packet; /**< unit: [number of packets] */
136 	uint8 ea[ETHER_ADDR_LEN];
137 
138 	/** maintain (MAC,AC) based seq count for packets going to the device. As well as bc/mc. */
139 	uint8 seq[AC_COUNT + 1];
140 	uint8 generation;       /**< toggles between 0 and 1 */
141 	struct pktq	psq;    /**< contains both 'delayed' and 'suppressed' packets */
142 	/** packets at firmware queue */
143 	struct pktq	afq;
144 	/** The AC pending bitmap that was reported to the fw at last change */
145 	uint8 traffic_lastreported_bmp;
146 	/** The new AC pending bitmap */
147 	uint8 traffic_pending_bmp;
148 	/** 1= send on next opportunity */
149 	uint8 send_tim_signal;
150 	uint8 mac_handle;          /**< mac handles are assigned by the dongle */
151 	/** Number of packets at dongle for this entry. */
152 	int transit_count;
153 	/** Number of suppression to wait before evict from delayQ */
154 	int suppr_transit_count;
155 	/** pkt sent to bus but no bus TX complete yet */
156 	int onbus_pkts_count;
157 	/** flag. TRUE when remote MAC is in suppressed state */
158 	uint8 suppressed;
159 
160 #ifdef PROP_TXSTATUS_DEBUG
161 	uint32 dstncredit_sent_packets;
162 	uint32 dstncredit_acks;
163 	uint32 opened_ct;
164 	uint32 closed_ct;
165 #endif // endif
166 	struct wlfc_mac_descriptor* prev;
167 	struct wlfc_mac_descriptor* next;
168 } wlfc_mac_descriptor_t;
169 
170 /** A 'commit' is the hand over of a packet from the host OS layer to the layer below (eg DBUS) */
171 typedef struct dhd_wlfc_commit_info {
172 	uint8					needs_hdr;
173 	uint8					ac_fifo_credit_spent;
174 	ewlfc_packet_state_t	pkt_type;
175 	wlfc_mac_descriptor_t*	mac_entry;
176 	void*					p;
177 } dhd_wlfc_commit_info_t;
178 
179 #define WLFC_DECR_SEQCOUNT(entry, prec) do { if (entry->seq[(prec)] == 0) {\
180 	entry->seq[prec] = 0xff; } else entry->seq[prec]--;} while (0)
181 
182 #define WLFC_INCR_SEQCOUNT(entry, prec) entry->seq[(prec)]++
183 #define WLFC_SEQCOUNT(entry, prec) entry->seq[(prec)]
184 
185 typedef struct athost_wl_stat_counters {
186 	uint32	pktin;
187 	uint32	pktout;
188 	uint32	pkt2bus;
189 	uint32	pktdropped;
190 	uint32	tlv_parse_failed;
191 	uint32	rollback;
192 	uint32	rollback_failed;
193 	uint32	delayq_full_error;
194 	uint32	credit_request_failed;
195 	uint32	packet_request_failed;
196 	uint32	mac_update_failed;
197 	uint32	psmode_update_failed;
198 	uint32	interface_update_failed;
199 	uint32	wlfc_header_only_pkt;
200 	uint32	txstatus_in;
201 	uint32	d11_suppress;
202 	uint32	wl_suppress;
203 	uint32	bad_suppress;
204 	uint32	pkt_dropped;
205 	uint32	pkt_exptime;
206 	uint32	pkt_freed;
207 	uint32	pkt_free_err;
208 	uint32	psq_wlsup_retx;
209 	uint32	psq_wlsup_enq;
210 	uint32	psq_d11sup_retx;
211 	uint32	psq_d11sup_enq;
212 	uint32	psq_hostq_retx;
213 	uint32	psq_hostq_enq;
214 	uint32	mac_handle_notfound;
215 	uint32	wlc_tossed_pkts;
216 	uint32	dhd_hdrpulls;
217 	uint32	generic_error;
218 	/* an extra one for bc/mc traffic */
219 	uint32	send_pkts[AC_COUNT + 1];
220 	uint32	drop_pkts[WLFC_PSQ_PREC_COUNT];
221 	uint32	ooo_pkts[AC_COUNT + 1];
222 #ifdef PROP_TXSTATUS_DEBUG
223 	/** all pkt2bus -> txstatus latency accumulated */
224 	uint32	latency_sample_count;
225 	uint32	total_status_latency;
226 	uint32	latency_most_recent;
227 	int	idx_delta;
228 	uint32	deltas[10];
229 	uint32	fifo_credits_sent[6];
230 	uint32	fifo_credits_back[6];
231 	uint32	dropped_qfull[6];
232 	uint32	signal_only_pkts_sent;
233 	uint32	signal_only_pkts_freed;
234 #endif // endif
235 	uint32	cleanup_txq_cnt;
236 	uint32	cleanup_psq_cnt;
237 	uint32	cleanup_fw_cnt;
238 } athost_wl_stat_counters_t;
239 
240 #ifdef PROP_TXSTATUS_DEBUG
241 #define WLFC_HOST_FIFO_CREDIT_INC_SENTCTRS(ctx, ac) do { \
242 	(ctx)->stats.fifo_credits_sent[(ac)]++;} while (0)
243 #define WLFC_HOST_FIFO_CREDIT_INC_BACKCTRS(ctx, ac) do { \
244 	(ctx)->stats.fifo_credits_back[(ac)]++;} while (0)
245 #define WLFC_HOST_FIFO_DROPPEDCTR_INC(ctx, ac) do { \
246 	(ctx)->stats.dropped_qfull[(ac)]++;} while (0)
247 #else
248 #define WLFC_HOST_FIFO_CREDIT_INC_SENTCTRS(ctx, ac) do {} while (0)
249 #define WLFC_HOST_FIFO_CREDIT_INC_BACKCTRS(ctx, ac) do {} while (0)
250 #define WLFC_HOST_FIFO_DROPPEDCTR_INC(ctx, ac) do {} while (0)
251 #endif // endif
252 #define WLFC_PACKET_BOUND              10
253 #define WLFC_FCMODE_NONE				0
254 #define WLFC_FCMODE_IMPLIED_CREDIT		1
255 #define WLFC_FCMODE_EXPLICIT_CREDIT		2
256 #define WLFC_ONLY_AMPDU_HOSTREORDER		3
257 
258 /** Reserved credits ratio when borrowed by hihger priority */
259 #define WLFC_BORROW_LIMIT_RATIO		4
260 
261 /** How long to defer borrowing in milliseconds */
262 #define WLFC_BORROW_DEFER_PERIOD_MS 100
263 
264 /** How long to defer flow control in milliseconds */
265 #define WLFC_FC_DEFER_PERIOD_MS 200
266 
267 /** How long to detect occurance per AC in miliseconds */
268 #define WLFC_RX_DETECTION_THRESHOLD_MS	100
269 
270 /** Mask to represent available ACs (note: BC/MC is ignored) */
271 #define WLFC_AC_MASK 0xF
272 
273 /** flow control specific information, only 1 instance during driver lifetime */
274 typedef struct athost_wl_status_info {
275 	uint8	last_seqid_to_wlc;
276 
277 	/** OSL handle */
278 	osl_t *osh;
279 	/** dhd public struct pointer */
280 	void *dhdp;
281 
282 	f_commitpkt_t fcommit;
283 	void* commit_ctx;
284 
285 	/** statistics */
286 	athost_wl_stat_counters_t stats;
287 
288 	/** incremented on eg receiving a credit map event from the dongle */
289 	int		Init_FIFO_credit[AC_COUNT + 2];
290 	/** the additional ones are for bc/mc and ATIM FIFO */
291 	int		FIFO_credit[AC_COUNT + 2];
292 	/** Credit borrow counts for each FIFO from each of the other FIFOs */
293 	int		credits_borrowed[AC_COUNT + 2][AC_COUNT + 2];
294 
295 	/** packet hanger and MAC->handle lookup table */
296 	void *hanger;
297 
298 	struct {
299 		/** table for individual nodes */
300 		wlfc_mac_descriptor_t	nodes[WLFC_MAC_DESC_TABLE_SIZE];
301 		/** table for interfaces */
302 		wlfc_mac_descriptor_t	interfaces[WLFC_MAX_IFNUM];
303 		/* OS may send packets to unknown (unassociated) destinations */
304 		/** A place holder for bc/mc and packets to unknown destinations */
305 		wlfc_mac_descriptor_t	other;
306 	} destination_entries;
307 
308 	wlfc_mac_descriptor_t *active_entry_head; /**< a chain of MAC descriptors */
309 	int active_entry_count;
310 
311 	wlfc_mac_descriptor_t *requested_entry[WLFC_MAC_DESC_TABLE_SIZE];
312 	int requested_entry_count;
313 
314 	/* pkt counts for each interface and ac */
315 	int	pkt_cnt_in_q[WLFC_MAX_IFNUM][AC_COUNT+1];
316 	int	pkt_cnt_per_ac[AC_COUNT+1];
317 	int	pkt_cnt_in_drv[WLFC_MAX_IFNUM][AC_COUNT+1];
318 	int	pkt_cnt_in_psq;
319 	uint8	allow_fc;              /**< Boolean */
320 	uint32  fc_defer_timestamp;
321 	uint32	rx_timestamp[AC_COUNT+1];
322 
323 	/** ON/OFF state for flow control to the host network interface */
324 	uint8	hostif_flow_state[WLFC_MAX_IFNUM];
325 	uint8	host_ifidx;
326 
327 	/** to flow control an OS interface */
328 	uint8	toggle_host_if;
329 
330 	/** To borrow credits */
331 	uint8   allow_credit_borrow;
332 
333 	/** ac number for the first single ac traffic */
334 	uint8	single_ac;
335 
336 	/** Timestamp for the first single ac traffic */
337 	uint32  single_ac_timestamp;
338 
339 	bool	bcmc_credit_supported;
340 
341 } athost_wl_status_info_t;
342 
343 /** Please be mindful that total pkttag space is 32 octets only */
344 typedef struct dhd_pkttag {
345 
346 #ifdef BCM_OBJECT_TRACE
347 	/* if use this field, keep it at the first 4 bytes */
348 	uint32 sn;
349 #endif /* BCM_OBJECT_TRACE */
350 
351 	/**
352 	b[15]  - 1 = wlfc packet
353 	b[14:13]  - encryption exemption
354 	b[12 ] - 1 = event channel
355 	b[11 ] - 1 = this packet was sent in response to one time packet request,
356 	do not increment credit on status for this one. [WLFC_CTL_TYPE_MAC_REQUEST_PACKET].
357 	b[10 ] - 1 = signal-only-packet to firmware [i.e. nothing to piggyback on]
358 	b[9  ] - 1 = packet is host->firmware (transmit direction)
359 	       - 0 = packet received from firmware (firmware->host)
360 	b[8  ] - 1 = packet was sent due to credit_request (pspoll),
361 	             packet does not count against FIFO credit.
362 	       - 0 = normal transaction, packet counts against FIFO credit
363 	b[7  ] - 1 = AP, 0 = STA
364 	b[6:4] - AC FIFO number
365 	b[3:0] - interface index
366 	*/
367 	uint16	if_flags;
368 
369 	/**
370 	 * destination MAC address for this packet so that not every module needs to open the packet
371 	 * to find this
372 	 */
373 	uint8	dstn_ether[ETHER_ADDR_LEN];
374 
375 	/** This 32-bit goes from host to device for every packet. */
376 	uint32	htod_tag;
377 
378 	/** This 16-bit is original d11seq number for every suppressed packet. */
379 	uint16	htod_seq;
380 
381 	/** This address is mac entry for every packet. */
382 	void *entry;
383 
384 	/** bus specific stuff */
385 	union {
386 		struct {
387 			void *stuff;
388 			uint32 thing1;
389 			uint32 thing2;
390 		} sd;
391 
392 		struct {
393 			void *bus;
394 			void *urb;
395 		} usb;
396 	} bus_specific;
397 } dhd_pkttag_t;
398 
399 #define DHD_PKTTAG_WLFCPKT_MASK			0x1
400 #define DHD_PKTTAG_WLFCPKT_SHIFT		15
401 #define DHD_PKTTAG_WLFCPKT_SET(tag, value)	((dhd_pkttag_t*)(tag))->if_flags = \
402 	(((dhd_pkttag_t*)(tag))->if_flags & \
403 	~(DHD_PKTTAG_WLFCPKT_MASK << DHD_PKTTAG_WLFCPKT_SHIFT)) | \
404 	(((value) & DHD_PKTTAG_WLFCPKT_MASK) << DHD_PKTTAG_WLFCPKT_SHIFT)
405 #define DHD_PKTTAG_WLFCPKT(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
406 	DHD_PKTTAG_WLFCPKT_SHIFT) & DHD_PKTTAG_WLFCPKT_MASK)
407 
408 #define DHD_PKTTAG_EXEMPT_MASK			0x3
409 #define DHD_PKTTAG_EXEMPT_SHIFT			13
410 #define DHD_PKTTAG_EXEMPT_SET(tag, value)	((dhd_pkttag_t*)(tag))->if_flags = \
411 	(((dhd_pkttag_t*)(tag))->if_flags & \
412 	~(DHD_PKTTAG_EXEMPT_MASK << DHD_PKTTAG_EXEMPT_SHIFT)) | \
413 	(((value) & DHD_PKTTAG_EXEMPT_MASK) << DHD_PKTTAG_EXEMPT_SHIFT)
414 #define DHD_PKTTAG_EXEMPT(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
415 	DHD_PKTTAG_EXEMPT_SHIFT) & DHD_PKTTAG_EXEMPT_MASK)
416 
417 #define DHD_PKTTAG_EVENT_MASK			0x1
418 #define DHD_PKTTAG_EVENT_SHIFT			12
419 #define DHD_PKTTAG_SETEVENT(tag, event)	((dhd_pkttag_t*)(tag))->if_flags = \
420 	(((dhd_pkttag_t*)(tag))->if_flags & \
421 	~(DHD_PKTTAG_EVENT_MASK << DHD_PKTTAG_EVENT_SHIFT)) | \
422 	(((event) & DHD_PKTTAG_EVENT_MASK) << DHD_PKTTAG_EVENT_SHIFT)
423 #define DHD_PKTTAG_EVENT(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
424 	DHD_PKTTAG_EVENT_SHIFT) & DHD_PKTTAG_EVENT_MASK)
425 
426 #define DHD_PKTTAG_ONETIMEPKTRQST_MASK		0x1
427 #define DHD_PKTTAG_ONETIMEPKTRQST_SHIFT		11
428 #define DHD_PKTTAG_SETONETIMEPKTRQST(tag)	((dhd_pkttag_t*)(tag))->if_flags = \
429 	(((dhd_pkttag_t*)(tag))->if_flags & \
430 	~(DHD_PKTTAG_ONETIMEPKTRQST_MASK << DHD_PKTTAG_ONETIMEPKTRQST_SHIFT)) | \
431 	(1 << DHD_PKTTAG_ONETIMEPKTRQST_SHIFT)
432 #define DHD_PKTTAG_ONETIMEPKTRQST(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
433 	DHD_PKTTAG_ONETIMEPKTRQST_SHIFT) & DHD_PKTTAG_ONETIMEPKTRQST_MASK)
434 
435 #define DHD_PKTTAG_SIGNALONLY_MASK		0x1
436 #define DHD_PKTTAG_SIGNALONLY_SHIFT		10
437 #define DHD_PKTTAG_SETSIGNALONLY(tag, signalonly)	((dhd_pkttag_t*)(tag))->if_flags = \
438 	(((dhd_pkttag_t*)(tag))->if_flags & \
439 	~(DHD_PKTTAG_SIGNALONLY_MASK << DHD_PKTTAG_SIGNALONLY_SHIFT)) | \
440 	(((signalonly) & DHD_PKTTAG_SIGNALONLY_MASK) << DHD_PKTTAG_SIGNALONLY_SHIFT)
441 #define DHD_PKTTAG_SIGNALONLY(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
442 	DHD_PKTTAG_SIGNALONLY_SHIFT) & DHD_PKTTAG_SIGNALONLY_MASK)
443 
444 #define DHD_PKTTAG_PKTDIR_MASK			0x1
445 #define DHD_PKTTAG_PKTDIR_SHIFT			9
446 #define DHD_PKTTAG_SETPKTDIR(tag, dir)	((dhd_pkttag_t*)(tag))->if_flags = \
447 	(((dhd_pkttag_t*)(tag))->if_flags & \
448 	~(DHD_PKTTAG_PKTDIR_MASK << DHD_PKTTAG_PKTDIR_SHIFT)) | \
449 	(((dir) & DHD_PKTTAG_PKTDIR_MASK) << DHD_PKTTAG_PKTDIR_SHIFT)
450 #define DHD_PKTTAG_PKTDIR(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
451 	DHD_PKTTAG_PKTDIR_SHIFT) & DHD_PKTTAG_PKTDIR_MASK)
452 
453 #define DHD_PKTTAG_CREDITCHECK_MASK		0x1
454 #define DHD_PKTTAG_CREDITCHECK_SHIFT		8
455 #define DHD_PKTTAG_SETCREDITCHECK(tag, check)	((dhd_pkttag_t*)(tag))->if_flags = \
456 	(((dhd_pkttag_t*)(tag))->if_flags & \
457 	~(DHD_PKTTAG_CREDITCHECK_MASK << DHD_PKTTAG_CREDITCHECK_SHIFT)) | \
458 	(((check) & DHD_PKTTAG_CREDITCHECK_MASK) << DHD_PKTTAG_CREDITCHECK_SHIFT)
459 #define DHD_PKTTAG_CREDITCHECK(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
460 	DHD_PKTTAG_CREDITCHECK_SHIFT) & DHD_PKTTAG_CREDITCHECK_MASK)
461 
462 #define DHD_PKTTAG_IFTYPE_MASK			0x1
463 #define DHD_PKTTAG_IFTYPE_SHIFT			7
464 #define DHD_PKTTAG_SETIFTYPE(tag, isAP)	((dhd_pkttag_t*)(tag))->if_flags = \
465 	(((dhd_pkttag_t*)(tag))->if_flags & \
466 	~(DHD_PKTTAG_IFTYPE_MASK << DHD_PKTTAG_IFTYPE_SHIFT)) | \
467 	(((isAP) & DHD_PKTTAG_IFTYPE_MASK) << DHD_PKTTAG_IFTYPE_SHIFT)
468 #define DHD_PKTTAG_IFTYPE(tag)	((((dhd_pkttag_t*)(tag))->if_flags >> \
469 	DHD_PKTTAG_IFTYPE_SHIFT) & DHD_PKTTAG_IFTYPE_MASK)
470 
471 #define DHD_PKTTAG_FIFO_MASK			0x7
472 #define DHD_PKTTAG_FIFO_SHIFT			4
473 #define DHD_PKTTAG_SETFIFO(tag, fifo)	((dhd_pkttag_t*)(tag))->if_flags = \
474 	(((dhd_pkttag_t*)(tag))->if_flags & ~(DHD_PKTTAG_FIFO_MASK << DHD_PKTTAG_FIFO_SHIFT)) | \
475 	(((fifo) & DHD_PKTTAG_FIFO_MASK) << DHD_PKTTAG_FIFO_SHIFT)
476 #define DHD_PKTTAG_FIFO(tag)		((((dhd_pkttag_t*)(tag))->if_flags >> \
477 	DHD_PKTTAG_FIFO_SHIFT) & DHD_PKTTAG_FIFO_MASK)
478 
479 #define DHD_PKTTAG_IF_MASK			0xf
480 #define DHD_PKTTAG_IF_SHIFT			0
481 #define DHD_PKTTAG_SETIF(tag, if)	((dhd_pkttag_t*)(tag))->if_flags = \
482 	(((dhd_pkttag_t*)(tag))->if_flags & ~(DHD_PKTTAG_IF_MASK << DHD_PKTTAG_IF_SHIFT)) | \
483 	(((if) & DHD_PKTTAG_IF_MASK) << DHD_PKTTAG_IF_SHIFT)
484 #define DHD_PKTTAG_IF(tag)		((((dhd_pkttag_t*)(tag))->if_flags >> \
485 	DHD_PKTTAG_IF_SHIFT) & DHD_PKTTAG_IF_MASK)
486 
487 #define DHD_PKTTAG_SETDSTN(tag, dstn_MAC_ea)	memcpy(((dhd_pkttag_t*)((tag)))->dstn_ether, \
488 	(dstn_MAC_ea), ETHER_ADDR_LEN)
489 #define DHD_PKTTAG_DSTN(tag)	((dhd_pkttag_t*)(tag))->dstn_ether
490 
491 #define DHD_PKTTAG_SET_H2DTAG(tag, h2dvalue)	((dhd_pkttag_t*)(tag))->htod_tag = (h2dvalue)
492 #define DHD_PKTTAG_H2DTAG(tag)			(((dhd_pkttag_t*)(tag))->htod_tag)
493 
494 #define DHD_PKTTAG_SET_H2DSEQ(tag, seq)		((dhd_pkttag_t*)(tag))->htod_seq = (seq)
495 #define DHD_PKTTAG_H2DSEQ(tag)			(((dhd_pkttag_t*)(tag))->htod_seq)
496 
497 #define DHD_PKTTAG_SET_ENTRY(tag, entry)	((dhd_pkttag_t*)(tag))->entry = (entry)
498 #define DHD_PKTTAG_ENTRY(tag)			(((dhd_pkttag_t*)(tag))->entry)
499 
500 #define PSQ_SUP_IDX(x) (x * 2 + 1)
501 #define PSQ_DLY_IDX(x) (x * 2)
502 
503 #ifdef PROP_TXSTATUS_DEBUG
504 #define DHD_WLFC_CTRINC_MAC_CLOSE(entry)	do { (entry)->closed_ct++; } while (0)
505 #define DHD_WLFC_CTRINC_MAC_OPEN(entry)		do { (entry)->opened_ct++; } while (0)
506 #else
507 #define DHD_WLFC_CTRINC_MAC_CLOSE(entry)	do {} while (0)
508 #define DHD_WLFC_CTRINC_MAC_OPEN(entry)		do {} while (0)
509 #endif // endif
510 
511 #ifdef BCM_OBJECT_TRACE
512 #define DHD_PKTTAG_SET_SN(tag, val)		((dhd_pkttag_t*)(tag))->sn = (val)
513 #define DHD_PKTTAG_SN(tag)			(((dhd_pkttag_t*)(tag))->sn)
514 #endif /* BCM_OBJECT_TRACE */
515 
516 /* public functions */
517 int dhd_wlfc_parse_header_info(dhd_pub_t *dhd, void* pktbuf, int tlv_hdr_len,
518 	uchar *reorder_info_buf, uint *reorder_info_len);
519 KERNEL_THREAD_RETURN_TYPE dhd_wlfc_transfer_packets(void *data);
520 int dhd_wlfc_commit_packets(dhd_pub_t *dhdp, f_commitpkt_t fcommit,
521 	void* commit_ctx, void *pktbuf, bool need_toggle_host_if);
522 int dhd_wlfc_txcomplete(dhd_pub_t *dhd, void *txp, bool success);
523 int dhd_wlfc_init(dhd_pub_t *dhd);
524 #ifdef SUPPORT_P2P_GO_PS
525 int dhd_wlfc_suspend(dhd_pub_t *dhd);
526 int dhd_wlfc_resume(dhd_pub_t *dhd);
527 #endif /* SUPPORT_P2P_GO_PS */
528 int dhd_wlfc_hostreorder_init(dhd_pub_t *dhd);
529 int dhd_wlfc_cleanup_txq(dhd_pub_t *dhd, f_processpkt_t fn, void *arg);
530 int dhd_wlfc_cleanup(dhd_pub_t *dhd, f_processpkt_t fn, void* arg);
531 int dhd_wlfc_deinit(dhd_pub_t *dhd);
532 int dhd_wlfc_interface_event(dhd_pub_t *dhdp, uint8 action, uint8 ifid, uint8 iftype, uint8* ea);
533 int dhd_wlfc_FIFOcreditmap_event(dhd_pub_t *dhdp, uint8* event_data);
534 #ifdef LIMIT_BORROW
535 int dhd_wlfc_disable_credit_borrow_event(dhd_pub_t *dhdp, uint8* event_data);
536 #endif /* LIMIT_BORROW */
537 int dhd_wlfc_BCMCCredit_support_event(dhd_pub_t *dhdp);
538 int dhd_wlfc_enable(dhd_pub_t *dhdp);
539 int dhd_wlfc_dump(dhd_pub_t *dhdp, struct bcmstrbuf *strbuf);
540 int dhd_wlfc_clear_counts(dhd_pub_t *dhd);
541 int dhd_wlfc_get_enable(dhd_pub_t *dhd, bool *val);
542 int dhd_wlfc_get_mode(dhd_pub_t *dhd, int *val);
543 int dhd_wlfc_set_mode(dhd_pub_t *dhd, int val);
544 bool dhd_wlfc_is_supported(dhd_pub_t *dhd);
545 bool dhd_wlfc_is_header_only_pkt(dhd_pub_t * dhd, void *pktbuf);
546 int dhd_wlfc_flowcontrol(dhd_pub_t *dhdp, bool state, bool bAcquireLock);
547 int dhd_wlfc_save_rxpath_ac_time(dhd_pub_t * dhd, uint8 prio);
548 
549 int dhd_wlfc_get_module_ignore(dhd_pub_t *dhd, int *val);
550 int dhd_wlfc_set_module_ignore(dhd_pub_t *dhd, int val);
551 int dhd_wlfc_get_credit_ignore(dhd_pub_t *dhd, int *val);
552 int dhd_wlfc_set_credit_ignore(dhd_pub_t *dhd, int val);
553 int dhd_wlfc_get_txstatus_ignore(dhd_pub_t *dhd, int *val);
554 int dhd_wlfc_set_txstatus_ignore(dhd_pub_t *dhd, int val);
555 
556 int dhd_wlfc_get_rxpkt_chk(dhd_pub_t *dhd, int *val);
557 int dhd_wlfc_set_rxpkt_chk(dhd_pub_t *dhd, int val);
558 
559 #endif /* __wlfc_host_driver_definitions_h__ */
560