hc
2024-12-19 9370bb92b2d16684ee45cf24e879c93c509162da
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
/* SPDX-License-Identifier: GPL-2.0 */
/*
 * @file Broadcom Dongle Host Driver (DHD), Flow ring specific code at top level
 *
 * Flow rings are transmit traffic (=propagating towards antenna) related entities
 *
 *
 * Copyright (C) 1999-2017, Broadcom Corporation
 * 
 *      Unless you and Broadcom execute a separate written software license
 * agreement governing use of this software, this software is licensed to you
 * under the terms of the GNU General Public License version 2 (the "GPL"),
 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
 * following added to such license:
 * 
 *      As a special exception, the copyright holders of this software give you
 * permission to link this software with independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions of
 * the license of that module.  An independent module is a module which is not
 * derived from this software.  The special exception does not apply to any
 * modifications of the software.
 * 
 *      Notwithstanding the above, under no circumstances may you combine this
 * software in any way with any other Broadcom software provided under a license
 * other than the GPL, without Broadcom's express prior written consent.
 *
 *
 * <<Broadcom-WL-IPTag/Open:>>
 *
 * $Id: dhd_flowring.c 710862 2017-07-14 07:43:59Z $
 */
 
 
#include <typedefs.h>
#include <bcmutils.h>
#include <bcmendian.h>
#include <bcmdevs.h>
 
#include <ethernet.h>
#include <bcmevent.h>
#include <dngl_stats.h>
 
#include <dhd.h>
 
#include <dhd_flowring.h>
#include <dhd_bus.h>
#include <dhd_proto.h>
#include <dhd_dbg.h>
#include <802.1d.h>
#include <pcie_core.h>
#include <bcmmsgbuf.h>
#include <dhd_pcie.h>
 
static INLINE int dhd_flow_queue_throttle(flow_queue_t *queue);
 
static INLINE uint16 dhd_flowid_find(dhd_pub_t *dhdp, uint8 ifindex,
                                     uint8 prio, char *sa, char *da);
 
static INLINE uint16 dhd_flowid_alloc(dhd_pub_t *dhdp, uint8 ifindex,
                                      uint8 prio, char *sa, char *da);
 
static INLINE int dhd_flowid_lookup(dhd_pub_t *dhdp, uint8 ifindex,
                                uint8 prio, char *sa, char *da, uint16 *flowid);
int BCMFASTPATH dhd_flow_queue_overflow(flow_queue_t *queue, void *pkt);
 
#define FLOW_QUEUE_PKT_NEXT(p)          PKTLINK(p)
#define FLOW_QUEUE_PKT_SETNEXT(p, x)    PKTSETLINK((p), (x))
 
#if defined(EAPOL_PKT_PRIO) || defined(DHD_LOSSLESS_ROAMING)
const uint8 prio2ac[8] = { 0, 1, 1, 0, 2, 2, 3, 7 };
#else
const uint8 prio2ac[8] = { 0, 1, 1, 0, 2, 2, 3, 3 };
#endif /* EAPOL_PKT_PRIO || DHD_LOSSLESS_ROAMING */
const uint8 prio2tid[8] = { 0, 1, 2, 3, 4, 5, 6, 7 };
 
/** Queue overflow throttle. Return value: TRUE if throttle needs to be applied */
static INLINE int
dhd_flow_queue_throttle(flow_queue_t *queue)
{
   return DHD_FLOW_QUEUE_FULL(queue);
}
 
int BCMFASTPATH
dhd_flow_queue_overflow(flow_queue_t *queue, void *pkt)
{
   return BCME_NORESOURCE;
}
 
/** Returns flow ring given a flowid */
flow_ring_node_t *
dhd_flow_ring_node(dhd_pub_t *dhdp, uint16 flowid)
{
   flow_ring_node_t * flow_ring_node;
 
   ASSERT(dhdp != (dhd_pub_t*)NULL);
   ASSERT(flowid < dhdp->num_flow_rings);
 
   flow_ring_node = &(((flow_ring_node_t*)(dhdp->flow_ring_table))[flowid]);
 
   ASSERT(flow_ring_node->flowid == flowid);
   return flow_ring_node;
}
 
/** Returns 'backup' queue given a flowid */
flow_queue_t *
dhd_flow_queue(dhd_pub_t *dhdp, uint16 flowid)
{
   flow_ring_node_t * flow_ring_node;
 
   flow_ring_node = dhd_flow_ring_node(dhdp, flowid);
   return &flow_ring_node->queue;
}
 
/* Flow ring's queue management functions */
 
/** Reinitialize a flow ring's queue. */
void
dhd_flow_queue_reinit(dhd_pub_t *dhdp, flow_queue_t *queue, int max)
{
   ASSERT((queue != NULL) && (max > 0));
 
   queue->head = queue->tail = NULL;
   queue->len = 0;
 
   /* Set queue's threshold and queue's parent cummulative length counter */
   ASSERT(max > 1);
   DHD_FLOW_QUEUE_SET_MAX(queue, max);
   DHD_FLOW_QUEUE_SET_THRESHOLD(queue, max);
   DHD_FLOW_QUEUE_SET_CLEN(queue, &dhdp->cumm_ctr);
   DHD_FLOW_QUEUE_SET_L2CLEN(queue, &dhdp->l2cumm_ctr);
 
   queue->failures = 0U;
   queue->cb = &dhd_flow_queue_overflow;
}
 
/** Initialize a flow ring's queue, called on driver initialization. */
void
dhd_flow_queue_init(dhd_pub_t *dhdp, flow_queue_t *queue, int max)
{
   ASSERT((queue != NULL) && (max > 0));
 
   dll_init(&queue->list);
   dhd_flow_queue_reinit(dhdp, queue, max);
}
 
/** Register an enqueue overflow callback handler */
void
dhd_flow_queue_register(flow_queue_t *queue, flow_queue_cb_t cb)
{
   ASSERT(queue != NULL);
   queue->cb = cb;
}
 
/**
 * Enqueue an 802.3 packet at the back of a flow ring's queue. From there, it will travel later on
 * to the flow ring itself.
 */
int BCMFASTPATH
dhd_flow_queue_enqueue(dhd_pub_t *dhdp, flow_queue_t *queue, void *pkt)
{
   int ret = BCME_OK;
 
   ASSERT(queue != NULL);
 
   if (dhd_flow_queue_throttle(queue)) {
       queue->failures++;
       ret = (*queue->cb)(queue, pkt);
       goto done;
   }
 
   if (queue->head) {
       FLOW_QUEUE_PKT_SETNEXT(queue->tail, pkt);
   } else {
       queue->head = pkt;
   }
 
   FLOW_QUEUE_PKT_SETNEXT(pkt, NULL);
 
   queue->tail = pkt; /* at tail */
 
   queue->len++;
   /* increment parent's cummulative length */
   DHD_CUMM_CTR_INCR(DHD_FLOW_QUEUE_CLEN_PTR(queue));
   /* increment grandparent's cummulative length */
   DHD_CUMM_CTR_INCR(DHD_FLOW_QUEUE_L2CLEN_PTR(queue));
 
done:
   return ret;
}
 
/** Dequeue an 802.3 packet from a flow ring's queue, from head (FIFO) */
void * BCMFASTPATH
dhd_flow_queue_dequeue(dhd_pub_t *dhdp, flow_queue_t *queue)
{
   void * pkt;
 
   ASSERT(queue != NULL);
 
   pkt = queue->head; /* from head */
 
   if (pkt == NULL) {
       ASSERT((queue->len == 0) && (queue->tail == NULL));
       goto done;
   }
 
   queue->head = FLOW_QUEUE_PKT_NEXT(pkt);
   if (queue->head == NULL)
       queue->tail = NULL;
 
   queue->len--;
   /* decrement parent's cummulative length */
   DHD_CUMM_CTR_DECR(DHD_FLOW_QUEUE_CLEN_PTR(queue));
   /* decrement grandparent's cummulative length */
   DHD_CUMM_CTR_DECR(DHD_FLOW_QUEUE_L2CLEN_PTR(queue));
 
   FLOW_QUEUE_PKT_SETNEXT(pkt, NULL); /* dettach packet from queue */
 
done:
   return pkt;
}
 
/** Reinsert a dequeued 802.3 packet back at the head */
void BCMFASTPATH
dhd_flow_queue_reinsert(dhd_pub_t *dhdp, flow_queue_t *queue, void *pkt)
{
   if (queue->head == NULL) {
       queue->tail = pkt;
   }
 
   FLOW_QUEUE_PKT_SETNEXT(pkt, queue->head);
   queue->head = pkt;
   queue->len++;
   /* increment parent's cummulative length */
   DHD_CUMM_CTR_INCR(DHD_FLOW_QUEUE_CLEN_PTR(queue));
   /* increment grandparent's cummulative length */
   DHD_CUMM_CTR_INCR(DHD_FLOW_QUEUE_L2CLEN_PTR(queue));
}
 
/** Fetch the backup queue for a flowring, and assign flow control thresholds */
void
dhd_flow_ring_config_thresholds(dhd_pub_t *dhdp, uint16 flowid,
                     int queue_budget, int cumm_threshold, void *cumm_ctr,
                     int l2cumm_threshold, void *l2cumm_ctr)
{
   flow_queue_t * queue;
 
   ASSERT(dhdp != (dhd_pub_t*)NULL);
   ASSERT(queue_budget > 1);
   ASSERT(cumm_threshold > 1);
   ASSERT(cumm_ctr != (void*)NULL);
   ASSERT(l2cumm_threshold > 1);
   ASSERT(l2cumm_ctr != (void*)NULL);
 
   queue = dhd_flow_queue(dhdp, flowid);
 
   DHD_FLOW_QUEUE_SET_MAX(queue, queue_budget); /* Max queue length */
 
   /* Set the queue's parent threshold and cummulative counter */
   DHD_FLOW_QUEUE_SET_THRESHOLD(queue, cumm_threshold);
   DHD_FLOW_QUEUE_SET_CLEN(queue, cumm_ctr);
 
   /* Set the queue's grandparent threshold and cummulative counter */
   DHD_FLOW_QUEUE_SET_L2THRESHOLD(queue, l2cumm_threshold);
   DHD_FLOW_QUEUE_SET_L2CLEN(queue, l2cumm_ctr);
}
 
/** Initializes data structures of multiple flow rings */
int
dhd_flow_rings_init(dhd_pub_t *dhdp, uint32 num_flow_rings)
{
   uint32 idx;
   uint32 flow_ring_table_sz;
   uint32 if_flow_lkup_sz = 0;
   void * flowid_allocator;
   flow_ring_table_t *flow_ring_table = NULL;
   if_flow_lkup_t *if_flow_lkup = NULL;
   void *lock = NULL;
   void *list_lock = NULL;
   unsigned long flags;
 
   DHD_INFO(("%s\n", __FUNCTION__));
 
   /* Construct a 16bit flowid allocator */
   flowid_allocator = id16_map_init(dhdp->osh,
                          num_flow_rings - dhdp->bus->max_cmn_rings, FLOWID_RESERVED);
   if (flowid_allocator == NULL) {
       DHD_ERROR(("%s: flowid allocator init failure\n", __FUNCTION__));
       return BCME_NOMEM;
   }
 
   /* Allocate a flow ring table, comprising of requested number of rings */
   flow_ring_table_sz = (num_flow_rings * sizeof(flow_ring_node_t));
   flow_ring_table = (flow_ring_table_t *)MALLOCZ(dhdp->osh, flow_ring_table_sz);
   if (flow_ring_table == NULL) {
       DHD_ERROR(("%s: flow ring table alloc failure\n", __FUNCTION__));
       goto fail;
   }
 
   /* Initialize flow ring table state */
   DHD_CUMM_CTR_INIT(&dhdp->cumm_ctr);
   DHD_CUMM_CTR_INIT(&dhdp->l2cumm_ctr);
   bzero((uchar *)flow_ring_table, flow_ring_table_sz);
   for (idx = 0; idx < num_flow_rings; idx++) {
       flow_ring_table[idx].status = FLOW_RING_STATUS_CLOSED;
       flow_ring_table[idx].flowid = (uint16)idx;
       flow_ring_table[idx].lock = dhd_os_spin_lock_init(dhdp->osh);
#ifdef IDLE_TX_FLOW_MGMT
       flow_ring_table[idx].last_active_ts = OSL_SYSUPTIME();
#endif /* IDLE_TX_FLOW_MGMT */
       if (flow_ring_table[idx].lock == NULL) {
           DHD_ERROR(("%s: Failed to init spinlock for queue!\n", __FUNCTION__));
           goto fail;
       }
 
       dll_init(&flow_ring_table[idx].list);
 
       /* Initialize the per flow ring backup queue */
       dhd_flow_queue_init(dhdp, &flow_ring_table[idx].queue,
                           FLOW_RING_QUEUE_THRESHOLD);
   }
 
   /* Allocate per interface hash table (for fast lookup from interface to flow ring) */
   if_flow_lkup_sz = sizeof(if_flow_lkup_t) * DHD_MAX_IFS;
   if_flow_lkup = (if_flow_lkup_t *)DHD_OS_PREALLOC(dhdp,
       DHD_PREALLOC_IF_FLOW_LKUP, if_flow_lkup_sz);
   if (if_flow_lkup == NULL) {
       DHD_ERROR(("%s: if flow lkup alloc failure\n", __FUNCTION__));
       goto fail;
   }
 
   /* Initialize per interface hash table */
   for (idx = 0; idx < DHD_MAX_IFS; idx++) {
       int hash_ix;
       if_flow_lkup[idx].status = 0;
       if_flow_lkup[idx].role = 0;
       for (hash_ix = 0; hash_ix < DHD_FLOWRING_HASH_SIZE; hash_ix++)
           if_flow_lkup[idx].fl_hash[hash_ix] = NULL;
   }
 
   lock = dhd_os_spin_lock_init(dhdp->osh);
   if (lock == NULL)
       goto fail;
 
   list_lock = dhd_os_spin_lock_init(dhdp->osh);
   if (list_lock == NULL)
       goto lock_fail;
 
   dhdp->flow_prio_map_type = DHD_FLOW_PRIO_AC_MAP;
   bcopy(prio2ac, dhdp->flow_prio_map, sizeof(uint8) * NUMPRIO);
#ifdef DHD_LOSSLESS_ROAMING
   dhdp->dequeue_prec_map = ALLPRIO;
#endif
   /* Now populate into dhd pub */
   DHD_FLOWID_LOCK(lock, flags);
   dhdp->num_flow_rings = num_flow_rings;
   dhdp->flowid_allocator = (void *)flowid_allocator;
   dhdp->flow_ring_table = (void *)flow_ring_table;
   dhdp->if_flow_lkup = (void *)if_flow_lkup;
   dhdp->flowid_lock = lock;
   dhdp->flow_rings_inited = TRUE;
   dhdp->flowring_list_lock = list_lock;
   DHD_FLOWID_UNLOCK(lock, flags);
 
   DHD_INFO(("%s done\n", __FUNCTION__));
   return BCME_OK;
 
lock_fail:
   /* deinit the spinlock */
   dhd_os_spin_lock_deinit(dhdp->osh, lock);
 
fail:
   /* Destruct the per interface flow lkup table */
   if (if_flow_lkup != NULL) {
       DHD_OS_PREFREE(dhdp, if_flow_lkup, if_flow_lkup_sz);
   }
   if (flow_ring_table != NULL) {
       for (idx = 0; idx < num_flow_rings; idx++) {
           if (flow_ring_table[idx].lock != NULL)
               dhd_os_spin_lock_deinit(dhdp->osh, flow_ring_table[idx].lock);
       }
       MFREE(dhdp->osh, flow_ring_table, flow_ring_table_sz);
   }
   id16_map_fini(dhdp->osh, flowid_allocator);
 
   return BCME_NOMEM;
}
 
/** Deinit Flow Ring specific data structures */
void dhd_flow_rings_deinit(dhd_pub_t *dhdp)
{
   uint16 idx;
   uint32 flow_ring_table_sz;
   uint32 if_flow_lkup_sz;
   flow_ring_table_t *flow_ring_table;
   unsigned long flags;
   void *lock;
 
   DHD_INFO(("dhd_flow_rings_deinit\n"));
 
   if (!(dhdp->flow_rings_inited)) {
       DHD_ERROR(("dhd_flow_rings not initialized!\n"));
       return;
   }
 
   if (dhdp->flow_ring_table != NULL) {
 
       ASSERT(dhdp->num_flow_rings > 0);
 
       DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
       flow_ring_table = (flow_ring_table_t *)dhdp->flow_ring_table;
       dhdp->flow_ring_table = NULL;
       DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
       for (idx = 0; idx < dhdp->num_flow_rings; idx++) {
           if (flow_ring_table[idx].active) {
               dhd_bus_clean_flow_ring(dhdp->bus, &flow_ring_table[idx]);
           }
           ASSERT(DHD_FLOW_QUEUE_EMPTY(&flow_ring_table[idx].queue));
 
           /* Deinit flow ring queue locks before destroying flow ring table */
           if (flow_ring_table[idx].lock != NULL) {
               dhd_os_spin_lock_deinit(dhdp->osh, flow_ring_table[idx].lock);
           }
           flow_ring_table[idx].lock = NULL;
 
       }
 
       /* Destruct the flow ring table */
       flow_ring_table_sz = dhdp->num_flow_rings * sizeof(flow_ring_table_t);
       MFREE(dhdp->osh, flow_ring_table, flow_ring_table_sz);
   }
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
 
   /* Destruct the per interface flow lkup table */
   if (dhdp->if_flow_lkup != NULL) {
       if_flow_lkup_sz = sizeof(if_flow_lkup_t) * DHD_MAX_IFS;
       bzero((uchar *)dhdp->if_flow_lkup, if_flow_lkup_sz);
       DHD_OS_PREFREE(dhdp, dhdp->if_flow_lkup, if_flow_lkup_sz);
       dhdp->if_flow_lkup = NULL;
   }
 
   /* Destruct the flowid allocator */
   if (dhdp->flowid_allocator != NULL)
       dhdp->flowid_allocator = id16_map_fini(dhdp->osh, dhdp->flowid_allocator);
 
   dhdp->num_flow_rings = 0U;
   bzero(dhdp->flow_prio_map, sizeof(uint8) * NUMPRIO);
 
   lock = dhdp->flowid_lock;
   dhdp->flowid_lock = NULL;
 
   if (lock) {
       DHD_FLOWID_UNLOCK(lock, flags);
       dhd_os_spin_lock_deinit(dhdp->osh, lock);
   }
 
   dhd_os_spin_lock_deinit(dhdp->osh, dhdp->flowring_list_lock);
   dhdp->flowring_list_lock = NULL;
 
   ASSERT(dhdp->if_flow_lkup == NULL);
   ASSERT(dhdp->flowid_allocator == NULL);
   ASSERT(dhdp->flow_ring_table == NULL);
   dhdp->flow_rings_inited = FALSE;
}
 
/** Uses hash table to quickly map from ifindex to a flow ring 'role' (STA/AP) */
uint8
dhd_flow_rings_ifindex2role(dhd_pub_t *dhdp, uint8 ifindex)
{
   if_flow_lkup_t *if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
   ASSERT(if_flow_lkup);
   return if_flow_lkup[ifindex].role;
}
 
#ifdef WLTDLS
bool is_tdls_destination(dhd_pub_t *dhdp, uint8 *da)
{
   unsigned long flags;
   tdls_peer_node_t *cur = NULL;
 
   DHD_TDLS_LOCK(&dhdp->tdls_lock, flags);
   cur = dhdp->peer_tbl.node;
 
   while (cur != NULL) {
       if (!memcmp(da, cur->addr, ETHER_ADDR_LEN)) {
           DHD_TDLS_UNLOCK(&dhdp->tdls_lock, flags);
           return TRUE;
       }
       cur = cur->next;
   }
   DHD_TDLS_UNLOCK(&dhdp->tdls_lock, flags);
   return FALSE;
}
#endif /* WLTDLS */
 
/** Uses hash table to quickly map from ifindex+prio+da to a flow ring id */
static INLINE uint16
dhd_flowid_find(dhd_pub_t *dhdp, uint8 ifindex, uint8 prio, char *sa, char *da)
{
   int hash;
   bool ismcast = FALSE;
   flow_hash_info_t *cur;
   if_flow_lkup_t *if_flow_lkup;
   unsigned long flags;
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
   if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
 
   ASSERT(if_flow_lkup);
 
   if ((if_flow_lkup[ifindex].role == WLC_E_IF_ROLE_STA) ||
           (if_flow_lkup[ifindex].role == WLC_E_IF_ROLE_WDS)) {
#ifdef WLTDLS
       if (dhdp->peer_tbl.tdls_peer_count && !(ETHER_ISMULTI(da)) &&
           is_tdls_destination(dhdp, da)) {
           hash = DHD_FLOWRING_HASHINDEX(da, prio);
           cur = if_flow_lkup[ifindex].fl_hash[hash];
           while (cur != NULL) {
               if (!memcmp(cur->flow_info.da, da, ETHER_ADDR_LEN)) {
                   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
                   return cur->flowid;
               }
               cur = cur->next;
           }
           DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
           return FLOWID_INVALID;
       }
#endif /* WLTDLS */
       /* For STA non TDLS dest and WDS dest flow ring id is mapped based on prio only */
       cur = if_flow_lkup[ifindex].fl_hash[prio];
       if (cur) {
           DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
           return cur->flowid;
       }
   } else {
 
       if (ETHER_ISMULTI(da)) {
           ismcast = TRUE;
           hash = 0;
       } else {
           hash = DHD_FLOWRING_HASHINDEX(da, prio);
       }
 
       cur = if_flow_lkup[ifindex].fl_hash[hash];
 
       while (cur) {
           if ((ismcast && ETHER_ISMULTI(cur->flow_info.da)) ||
               (!memcmp(cur->flow_info.da, da, ETHER_ADDR_LEN) &&
               (cur->flow_info.tid == prio))) {
               DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
               return cur->flowid;
           }
           cur = cur->next;
       }
   }
   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
 
   DHD_INFO(("%s: cannot find flowid\n", __FUNCTION__));
   return FLOWID_INVALID;
} /* dhd_flowid_find */
 
/** Create unique Flow ID, called when a flow ring is created. */
static INLINE uint16
dhd_flowid_alloc(dhd_pub_t *dhdp, uint8 ifindex, uint8 prio, char *sa, char *da)
{
   flow_hash_info_t *fl_hash_node, *cur;
   if_flow_lkup_t *if_flow_lkup;
   int hash;
   uint16 flowid;
   unsigned long flags;
 
   fl_hash_node = (flow_hash_info_t *) MALLOCZ(dhdp->osh, sizeof(flow_hash_info_t));
   if (fl_hash_node == NULL) {
       DHD_ERROR(("%s: flow_hash_info_t memory allocation failed \n", __FUNCTION__));
       return FLOWID_INVALID;
   }
   memcpy(fl_hash_node->flow_info.da, da, sizeof(fl_hash_node->flow_info.da));
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
   ASSERT(dhdp->flowid_allocator != NULL);
   flowid = id16_map_alloc(dhdp->flowid_allocator);
   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
 
   if (flowid == FLOWID_INVALID) {
       MFREE(dhdp->osh, fl_hash_node,  sizeof(flow_hash_info_t));
       DHD_ERROR(("%s: cannot get free flowid \n", __FUNCTION__));
       return FLOWID_INVALID;
   }
 
   fl_hash_node->flowid = flowid;
   fl_hash_node->flow_info.tid = prio;
   fl_hash_node->flow_info.ifindex = ifindex;
   fl_hash_node->next = NULL;
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
   if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
 
   if ((if_flow_lkup[ifindex].role == WLC_E_IF_ROLE_STA) ||
           (if_flow_lkup[ifindex].role == WLC_E_IF_ROLE_WDS)) {
       /* For STA non TDLS dest and WDS dest we allocate entry based on prio only */
#ifdef WLTDLS
       if (dhdp->peer_tbl.tdls_peer_count &&
           (is_tdls_destination(dhdp, da))) {
           hash = DHD_FLOWRING_HASHINDEX(da, prio);
           cur = if_flow_lkup[ifindex].fl_hash[hash];
           if (cur) {
               while (cur->next) {
                   cur = cur->next;
               }
               cur->next = fl_hash_node;
           } else {
               if_flow_lkup[ifindex].fl_hash[hash] = fl_hash_node;
           }
       } else
#endif /* WLTDLS */
           if_flow_lkup[ifindex].fl_hash[prio] = fl_hash_node;
   } else {
 
       /* For bcast/mcast assign first slot in in interface */
       hash = ETHER_ISMULTI(da) ? 0 : DHD_FLOWRING_HASHINDEX(da, prio);
       cur = if_flow_lkup[ifindex].fl_hash[hash];
       if (cur) {
           while (cur->next) {
               cur = cur->next;
           }
           cur->next = fl_hash_node;
       } else
           if_flow_lkup[ifindex].fl_hash[hash] = fl_hash_node;
   }
   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
 
   DHD_INFO(("%s: allocated flowid %d\n", __FUNCTION__, fl_hash_node->flowid));
 
   return fl_hash_node->flowid;
} /* dhd_flowid_alloc */
 
/** Get flow ring ID, if not present try to create one */
static INLINE int
dhd_flowid_lookup(dhd_pub_t *dhdp, uint8 ifindex,
                  uint8 prio, char *sa, char *da, uint16 *flowid)
{
   uint16 id;
   flow_ring_node_t *flow_ring_node;
   flow_ring_table_t *flow_ring_table;
   unsigned long flags;
   int ret;
   bool is_sta_assoc;
 
   DHD_INFO(("%s\n", __FUNCTION__));
   if (!dhdp->flow_ring_table) {
       return BCME_ERROR;
   }
 
   flow_ring_table = (flow_ring_table_t *)dhdp->flow_ring_table;
 
   id = dhd_flowid_find(dhdp, ifindex, prio, sa, da);
 
   if (id == FLOWID_INVALID) {
 
       if_flow_lkup_t *if_flow_lkup;
       if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
 
       if (!if_flow_lkup[ifindex].status)
           return BCME_ERROR;
       BCM_REFERENCE(is_sta_assoc);
#if defined(PCIE_FULL_DONGLE)
       is_sta_assoc = dhd_sta_associated(dhdp, ifindex, (uint8 *)da);
       DHD_ERROR(("%s: multi %x ifindex %d role %x assoc %d\n", __FUNCTION__,
           ETHER_ISMULTI(da), ifindex, if_flow_lkup[ifindex].role,
           is_sta_assoc));
       if (!ETHER_ISMULTI(da) &&
           ((if_flow_lkup[ifindex].role == WLC_E_IF_ROLE_AP) ||
           (if_flow_lkup[ifindex].role == WLC_E_IF_ROLE_P2P_GO)) &&
           (!is_sta_assoc))
           return BCME_ERROR;
#endif /* (linux || LINUX) && PCIE_FULL_DONGLE */
 
       id = dhd_flowid_alloc(dhdp, ifindex, prio, sa, da);
       if (id == FLOWID_INVALID) {
           DHD_ERROR(("%s: alloc flowid ifindex %u status %u\n",
                      __FUNCTION__, ifindex, if_flow_lkup[ifindex].status));
           return BCME_ERROR;
       }
 
       ASSERT(id < dhdp->num_flow_rings);
 
       /* register this flowid in dhd_pub */
       dhd_add_flowid(dhdp, ifindex, prio, da, id);
 
       flow_ring_node = (flow_ring_node_t *) &flow_ring_table[id];
 
       DHD_FLOWRING_LOCK(flow_ring_node->lock, flags);
 
       /* Init Flow info */
       memcpy(flow_ring_node->flow_info.sa, sa, sizeof(flow_ring_node->flow_info.sa));
       memcpy(flow_ring_node->flow_info.da, da, sizeof(flow_ring_node->flow_info.da));
       flow_ring_node->flow_info.tid = prio;
       flow_ring_node->flow_info.ifindex = ifindex;
       flow_ring_node->active = TRUE;
       flow_ring_node->status = FLOW_RING_STATUS_CREATE_PENDING;
 
#ifdef DEVICE_TX_STUCK_DETECT
       flow_ring_node->tx_cmpl = flow_ring_node->tx_cmpl_prev = OSL_SYSUPTIME();
       flow_ring_node->stuck_count = 0;
#endif /* DEVICE_TX_STUCK_DETECT */
 
       DHD_FLOWRING_UNLOCK(flow_ring_node->lock, flags);
 
       /* Create and inform device about the new flow */
       if (dhd_bus_flow_ring_create_request(dhdp->bus, (void *)flow_ring_node)
               != BCME_OK) {
           DHD_ERROR(("%s: create error %d\n", __FUNCTION__, id));
           return BCME_ERROR;
       }
 
       *flowid = id;
       return BCME_OK;
   } else {
       /* if the Flow id was found in the hash */
       ASSERT(id < dhdp->num_flow_rings);
 
       flow_ring_node = (flow_ring_node_t *) &flow_ring_table[id];
       DHD_FLOWRING_LOCK(flow_ring_node->lock, flags);
 
       /*
        * If the flow_ring_node is in Open State or Status pending state then
        * we can return the Flow id to the caller.If the flow_ring_node is in
        * FLOW_RING_STATUS_PENDING this means the creation is in progress and
        * hence the packets should be queued.
        *
        * If the flow_ring_node is in FLOW_RING_STATUS_DELETE_PENDING Or
        * FLOW_RING_STATUS_CLOSED, then we should return Error.
        * Note that if the flowing is being deleted we would mark it as
        * FLOW_RING_STATUS_DELETE_PENDING.  Now before Dongle could respond and
        * before we mark it as FLOW_RING_STATUS_CLOSED we could get tx packets.
        * We should drop the packets in that case.
        * The decission to return OK should NOT be based on 'active' variable, beause
        * active is made TRUE when a flow_ring_node gets allocated and is made
        * FALSE when the flow ring gets removed and does not reflect the True state
        * of the Flow ring.
        * In case if IDLE_TX_FLOW_MGMT is defined, we have to handle two more flowring
        * states. If the flow_ring_node's status is FLOW_RING_STATUS_SUSPENDED, the flowid
        * is to be returned and from dhd_bus_txdata, the flowring would be resumed again.
        * The status FLOW_RING_STATUS_RESUME_PENDING, is equivalent to
        * FLOW_RING_STATUS_CREATE_PENDING.
        */
       if (flow_ring_node->status == FLOW_RING_STATUS_DELETE_PENDING ||
           flow_ring_node->status == FLOW_RING_STATUS_CLOSED) {
           *flowid = FLOWID_INVALID;
           ret = BCME_ERROR;
       } else {
           *flowid = id;
           ret = BCME_OK;
       }
 
       DHD_FLOWRING_UNLOCK(flow_ring_node->lock, flags);
       return ret;
   } /* Flow Id found in the hash */
} /* dhd_flowid_lookup */
 
/**
 * Assign existing or newly created flowid to an 802.3 packet. This flowid is later on used to
 * select the flowring to send the packet to the dongle.
 */
int BCMFASTPATH
dhd_flowid_update(dhd_pub_t *dhdp, uint8 ifindex, uint8 prio, void *pktbuf)
{
   uint8 *pktdata = (uint8 *)PKTDATA(dhdp->osh, pktbuf);
   struct ether_header *eh = (struct ether_header *)pktdata;
   uint16 flowid;
 
   ASSERT(ifindex < DHD_MAX_IFS);
 
   if (ifindex >= DHD_MAX_IFS) {
       return BCME_BADARG;
   }
 
   if (!dhdp->flowid_allocator) {
       DHD_ERROR(("%s: Flow ring not intited yet  \n", __FUNCTION__));
       return BCME_ERROR;
   }
 
   if (dhd_flowid_lookup(dhdp, ifindex, prio, (char *)eh->ether_shost, (char *)eh->ether_dhost,
       &flowid) != BCME_OK) {
       return BCME_ERROR;
   }
 
   DHD_INFO(("%s: prio %d flowid %d\n", __FUNCTION__, prio, flowid));
 
   /* Tag the packet with flowid */
   DHD_PKT_SET_FLOWID(pktbuf, flowid);
   return BCME_OK;
}
 
void
dhd_flowid_free(dhd_pub_t *dhdp, uint8 ifindex, uint16 flowid)
{
   int hashix;
   bool found = FALSE;
   flow_hash_info_t *cur, *prev;
   if_flow_lkup_t *if_flow_lkup;
   unsigned long flags;
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
   if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
 
   for (hashix = 0; hashix < DHD_FLOWRING_HASH_SIZE; hashix++) {
 
       cur = if_flow_lkup[ifindex].fl_hash[hashix];
 
       if (cur) {
           if (cur->flowid == flowid) {
               found = TRUE;
           }
 
           prev = NULL;
           while (!found && cur) {
               if (cur->flowid == flowid) {
                   found = TRUE;
                   break;
               }
               prev = cur;
               cur = cur->next;
           }
           if (found) {
               if (!prev) {
                   if_flow_lkup[ifindex].fl_hash[hashix] = cur->next;
               } else {
                   prev->next = cur->next;
               }
 
               /* deregister flowid from dhd_pub. */
               dhd_del_flowid(dhdp, ifindex, flowid);
 
               id16_map_free(dhdp->flowid_allocator, flowid);
               DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
               MFREE(dhdp->osh, cur, sizeof(flow_hash_info_t));
 
               return;
           }
       }
   }
 
   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
   DHD_ERROR(("%s: could not free flow ring hash entry flowid %d\n",
              __FUNCTION__, flowid));
} /* dhd_flowid_free */
 
/**
 * Delete all Flow rings associated with the given interface. Is called when eg the dongle
 * indicates that a wireless link has gone down.
 */
void
dhd_flow_rings_delete(dhd_pub_t *dhdp, uint8 ifindex)
{
   uint32 id;
   flow_ring_table_t *flow_ring_table;
 
   DHD_ERROR(("%s: ifindex %u\n", __FUNCTION__, ifindex));
 
   ASSERT(ifindex < DHD_MAX_IFS);
   if (ifindex >= DHD_MAX_IFS)
       return;
 
   if (!dhdp->flow_ring_table)
       return;
 
   flow_ring_table = (flow_ring_table_t *)dhdp->flow_ring_table;
   for (id = 0; id < dhdp->num_flow_rings; id++) {
       if (flow_ring_table[id].active &&
           (flow_ring_table[id].flow_info.ifindex == ifindex) &&
           (flow_ring_table[id].status == FLOW_RING_STATUS_OPEN)) {
           dhd_bus_flow_ring_delete_request(dhdp->bus,
                                            (void *) &flow_ring_table[id]);
       }
   }
}
 
void
dhd_flow_rings_flush(dhd_pub_t *dhdp, uint8 ifindex)
{
   uint32 id;
   flow_ring_table_t *flow_ring_table;
 
   DHD_INFO(("%s: ifindex %u\n", __FUNCTION__, ifindex));
 
   ASSERT(ifindex < DHD_MAX_IFS);
   if (ifindex >= DHD_MAX_IFS)
       return;
 
   if (!dhdp->flow_ring_table)
       return;
   flow_ring_table = (flow_ring_table_t *)dhdp->flow_ring_table;
 
   for (id = 0; id <= dhdp->num_flow_rings; id++) {
       if (flow_ring_table[id].active &&
           (flow_ring_table[id].flow_info.ifindex == ifindex) &&
           (flow_ring_table[id].status == FLOW_RING_STATUS_OPEN)) {
           dhd_bus_flow_ring_flush_request(dhdp->bus,
                                            (void *) &flow_ring_table[id]);
       }
   }
}
 
 
/** Delete flow ring(s) for given peer address. Related to AP/AWDL/TDLS functionality. */
void
dhd_flow_rings_delete_for_peer(dhd_pub_t *dhdp, uint8 ifindex, char *addr)
{
   uint32 id;
   flow_ring_table_t *flow_ring_table;
 
   DHD_ERROR(("%s: ifindex %u\n", __FUNCTION__, ifindex));
 
   ASSERT(ifindex < DHD_MAX_IFS);
   if (ifindex >= DHD_MAX_IFS)
       return;
 
   if (!dhdp->flow_ring_table)
       return;
 
   flow_ring_table = (flow_ring_table_t *)dhdp->flow_ring_table;
   for (id = 0; id < dhdp->num_flow_rings; id++) {
       if (flow_ring_table[id].active &&
           (flow_ring_table[id].flow_info.ifindex == ifindex) &&
           (!memcmp(flow_ring_table[id].flow_info.da, addr, ETHER_ADDR_LEN)) &&
           (flow_ring_table[id].status == FLOW_RING_STATUS_OPEN)) {
           DHD_ERROR(("%s: deleting flowid %d\n",
               __FUNCTION__, flow_ring_table[id].flowid));
           dhd_bus_flow_ring_delete_request(dhdp->bus,
               (void *) &flow_ring_table[id]);
       }
   }
}
 
/** Handles interface ADD, CHANGE, DEL indications from the dongle */
void
dhd_update_interface_flow_info(dhd_pub_t *dhdp, uint8 ifindex,
                               uint8 op, uint8 role)
{
   if_flow_lkup_t *if_flow_lkup;
   unsigned long flags;
 
   ASSERT(ifindex < DHD_MAX_IFS);
   if (ifindex >= DHD_MAX_IFS)
       return;
 
   DHD_ERROR(("%s: ifindex %u op %u role is %u \n",
             __FUNCTION__, ifindex, op, role));
   if (!dhdp->flowid_allocator) {
       DHD_ERROR(("%s: Flow ring not intited yet  \n", __FUNCTION__));
       return;
   }
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
   if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
 
   if (op == WLC_E_IF_ADD || op == WLC_E_IF_CHANGE) {
 
       if_flow_lkup[ifindex].role = role;
 
       if (role == WLC_E_IF_ROLE_WDS) {
           /**
            * WDS role does not send WLC_E_LINK event after interface is up.
            * So to create flowrings for WDS, make status as TRUE in WLC_E_IF itself.
            * same is true while making the status as FALSE.
            * TODO: Fix FW to send WLC_E_LINK for WDS role aswell. So that all the
            * interfaces are handled uniformly.
            */
           if_flow_lkup[ifindex].status = TRUE;
           DHD_INFO(("%s: Mcast Flow ring for ifindex %d role is %d \n",
                     __FUNCTION__, ifindex, role));
       }
   } else    if ((op == WLC_E_IF_DEL) && (role == WLC_E_IF_ROLE_WDS)) {
       if_flow_lkup[ifindex].status = FALSE;
       DHD_INFO(("%s: cleanup all Flow rings for ifindex %d role is %d \n",
                 __FUNCTION__, ifindex, role));
   }
   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
}
 
/** Handles a STA 'link' indication from the dongle */
int
dhd_update_interface_link_status(dhd_pub_t *dhdp, uint8 ifindex, uint8 status)
{
   if_flow_lkup_t *if_flow_lkup;
   unsigned long flags;
 
   ASSERT(ifindex < DHD_MAX_IFS);
   if (ifindex >= DHD_MAX_IFS)
       return BCME_BADARG;
 
   DHD_ERROR(("%s: ifindex %d status %d\n", __FUNCTION__, ifindex, status));
 
   DHD_FLOWID_LOCK(dhdp->flowid_lock, flags);
   if_flow_lkup = (if_flow_lkup_t *)dhdp->if_flow_lkup;
 
   if (status) {
       if_flow_lkup[ifindex].status = TRUE;
   } else {
       if_flow_lkup[ifindex].status = FALSE;
   }
 
   DHD_FLOWID_UNLOCK(dhdp->flowid_lock, flags);
 
   return BCME_OK;
}
 
/** Update flow priority mapping, called on IOVAR */
int dhd_update_flow_prio_map(dhd_pub_t *dhdp, uint8 map)
{
   uint16 flowid;
   flow_ring_node_t *flow_ring_node;
 
   if (map > DHD_FLOW_PRIO_LLR_MAP)
       return BCME_BADOPTION;
 
   /* Check if we need to change prio map */
   if (map == dhdp->flow_prio_map_type)
       return BCME_OK;
 
   /* If any ring is active we cannot change priority mapping for flow rings */
   for (flowid = 0; flowid < dhdp->num_flow_rings; flowid++) {
       flow_ring_node = DHD_FLOW_RING(dhdp, flowid);
       if (flow_ring_node->active)
           return BCME_EPERM;
   }
 
   /* Inform firmware about new mapping type */
   if (BCME_OK != dhd_flow_prio_map(dhdp, &map, TRUE))
       return BCME_ERROR;
 
   /* update internal structures */
   dhdp->flow_prio_map_type = map;
   if (dhdp->flow_prio_map_type == DHD_FLOW_PRIO_TID_MAP)
       bcopy(prio2tid, dhdp->flow_prio_map, sizeof(uint8) * NUMPRIO);
   else
       bcopy(prio2ac, dhdp->flow_prio_map, sizeof(uint8) * NUMPRIO);
 
   return BCME_OK;
}
 
/** Inform firmware on updated flow priority mapping, called on IOVAR */
int dhd_flow_prio_map(dhd_pub_t *dhd, uint8 *map, bool set)
{
   uint8 iovbuf[24] = {0};
   if (!set) {
       bcm_mkiovar("bus:fl_prio_map", NULL, 0, (char*)iovbuf, sizeof(iovbuf));
       if (dhd_wl_ioctl_cmd(dhd, WLC_GET_VAR, iovbuf, sizeof(iovbuf), FALSE, 0) < 0) {
           DHD_ERROR(("%s: failed to get fl_prio_map\n", __FUNCTION__));
           return BCME_ERROR;
       }
       *map = iovbuf[0];
       return BCME_OK;
   }
   bcm_mkiovar("bus:fl_prio_map", (char *)map, 4, (char*)iovbuf, sizeof(iovbuf));
   if (dhd_wl_ioctl_cmd(dhd, WLC_SET_VAR, iovbuf, sizeof(iovbuf), TRUE, 0) < 0) {
       DHD_ERROR(("%s: failed to set fl_prio_map \n",
           __FUNCTION__));
       return BCME_ERROR;
   }
   return BCME_OK;
}