1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * O(1) TX queue with built-in allocator for ST-Ericsson CW1200 drivers
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (c) 2010, ST-Ericsson
6*4882a593Smuzhiyun * Author: Dmitry Tarnyagin <dmitry.tarnyagin@lockless.no>
7*4882a593Smuzhiyun */
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #ifndef CW1200_QUEUE_H_INCLUDED
10*4882a593Smuzhiyun #define CW1200_QUEUE_H_INCLUDED
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun /* private */ struct cw1200_queue_item;
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun /* extern */ struct sk_buff;
15*4882a593Smuzhiyun /* extern */ struct wsm_tx;
16*4882a593Smuzhiyun /* extern */ struct cw1200_common;
17*4882a593Smuzhiyun /* extern */ struct ieee80211_tx_queue_stats;
18*4882a593Smuzhiyun /* extern */ struct cw1200_txpriv;
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun /* forward */ struct cw1200_queue_stats;
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun typedef void (*cw1200_queue_skb_dtor_t)(struct cw1200_common *priv,
23*4882a593Smuzhiyun struct sk_buff *skb,
24*4882a593Smuzhiyun const struct cw1200_txpriv *txpriv);
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun struct cw1200_queue {
27*4882a593Smuzhiyun struct cw1200_queue_stats *stats;
28*4882a593Smuzhiyun size_t capacity;
29*4882a593Smuzhiyun size_t num_queued;
30*4882a593Smuzhiyun size_t num_pending;
31*4882a593Smuzhiyun size_t num_sent;
32*4882a593Smuzhiyun struct cw1200_queue_item *pool;
33*4882a593Smuzhiyun struct list_head queue;
34*4882a593Smuzhiyun struct list_head free_pool;
35*4882a593Smuzhiyun struct list_head pending;
36*4882a593Smuzhiyun int tx_locked_cnt;
37*4882a593Smuzhiyun int *link_map_cache;
38*4882a593Smuzhiyun bool overfull;
39*4882a593Smuzhiyun spinlock_t lock; /* Protect queue entry */
40*4882a593Smuzhiyun u8 queue_id;
41*4882a593Smuzhiyun u8 generation;
42*4882a593Smuzhiyun struct timer_list gc;
43*4882a593Smuzhiyun unsigned long ttl;
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun struct cw1200_queue_stats {
47*4882a593Smuzhiyun spinlock_t lock; /* Protect stats entry */
48*4882a593Smuzhiyun int *link_map_cache;
49*4882a593Smuzhiyun int num_queued;
50*4882a593Smuzhiyun size_t map_capacity;
51*4882a593Smuzhiyun wait_queue_head_t wait_link_id_empty;
52*4882a593Smuzhiyun cw1200_queue_skb_dtor_t skb_dtor;
53*4882a593Smuzhiyun struct cw1200_common *priv;
54*4882a593Smuzhiyun };
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun struct cw1200_txpriv {
57*4882a593Smuzhiyun u8 link_id;
58*4882a593Smuzhiyun u8 raw_link_id;
59*4882a593Smuzhiyun u8 tid;
60*4882a593Smuzhiyun u8 rate_id;
61*4882a593Smuzhiyun u8 offset;
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun int cw1200_queue_stats_init(struct cw1200_queue_stats *stats,
65*4882a593Smuzhiyun size_t map_capacity,
66*4882a593Smuzhiyun cw1200_queue_skb_dtor_t skb_dtor,
67*4882a593Smuzhiyun struct cw1200_common *priv);
68*4882a593Smuzhiyun int cw1200_queue_init(struct cw1200_queue *queue,
69*4882a593Smuzhiyun struct cw1200_queue_stats *stats,
70*4882a593Smuzhiyun u8 queue_id,
71*4882a593Smuzhiyun size_t capacity,
72*4882a593Smuzhiyun unsigned long ttl);
73*4882a593Smuzhiyun int cw1200_queue_clear(struct cw1200_queue *queue);
74*4882a593Smuzhiyun void cw1200_queue_stats_deinit(struct cw1200_queue_stats *stats);
75*4882a593Smuzhiyun void cw1200_queue_deinit(struct cw1200_queue *queue);
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun size_t cw1200_queue_get_num_queued(struct cw1200_queue *queue,
78*4882a593Smuzhiyun u32 link_id_map);
79*4882a593Smuzhiyun int cw1200_queue_put(struct cw1200_queue *queue,
80*4882a593Smuzhiyun struct sk_buff *skb,
81*4882a593Smuzhiyun struct cw1200_txpriv *txpriv);
82*4882a593Smuzhiyun int cw1200_queue_get(struct cw1200_queue *queue,
83*4882a593Smuzhiyun u32 link_id_map,
84*4882a593Smuzhiyun struct wsm_tx **tx,
85*4882a593Smuzhiyun struct ieee80211_tx_info **tx_info,
86*4882a593Smuzhiyun const struct cw1200_txpriv **txpriv);
87*4882a593Smuzhiyun int cw1200_queue_requeue(struct cw1200_queue *queue, u32 packet_id);
88*4882a593Smuzhiyun int cw1200_queue_requeue_all(struct cw1200_queue *queue);
89*4882a593Smuzhiyun int cw1200_queue_remove(struct cw1200_queue *queue,
90*4882a593Smuzhiyun u32 packet_id);
91*4882a593Smuzhiyun int cw1200_queue_get_skb(struct cw1200_queue *queue, u32 packet_id,
92*4882a593Smuzhiyun struct sk_buff **skb,
93*4882a593Smuzhiyun const struct cw1200_txpriv **txpriv);
94*4882a593Smuzhiyun void cw1200_queue_lock(struct cw1200_queue *queue);
95*4882a593Smuzhiyun void cw1200_queue_unlock(struct cw1200_queue *queue);
96*4882a593Smuzhiyun bool cw1200_queue_get_xmit_timestamp(struct cw1200_queue *queue,
97*4882a593Smuzhiyun unsigned long *timestamp,
98*4882a593Smuzhiyun u32 pending_frame_id);
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun bool cw1200_queue_stats_is_empty(struct cw1200_queue_stats *stats,
101*4882a593Smuzhiyun u32 link_id_map);
102*4882a593Smuzhiyun
cw1200_queue_get_queue_id(u32 packet_id)103*4882a593Smuzhiyun static inline u8 cw1200_queue_get_queue_id(u32 packet_id)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun return (packet_id >> 16) & 0xFF;
106*4882a593Smuzhiyun }
107*4882a593Smuzhiyun
cw1200_queue_get_generation(u32 packet_id)108*4882a593Smuzhiyun static inline u8 cw1200_queue_get_generation(u32 packet_id)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun return (packet_id >> 8) & 0xFF;
111*4882a593Smuzhiyun }
112*4882a593Smuzhiyun
113*4882a593Smuzhiyun #endif /* CW1200_QUEUE_H_INCLUDED */
114