xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/broadcom/brcm80211/brcmfmac/commonring.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: ISC
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2014 Broadcom Corporation
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #include <linux/types.h>
7*4882a593Smuzhiyun #include <linux/netdevice.h>
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <brcmu_utils.h>
10*4882a593Smuzhiyun #include <brcmu_wifi.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include "core.h"
13*4882a593Smuzhiyun #include "commonring.h"
14*4882a593Smuzhiyun 
brcmf_commonring_register_cb(struct brcmf_commonring * commonring,int (* cr_ring_bell)(void * ctx),int (* cr_update_rptr)(void * ctx),int (* cr_update_wptr)(void * ctx),int (* cr_write_rptr)(void * ctx),int (* cr_write_wptr)(void * ctx),void * ctx)15*4882a593Smuzhiyun void brcmf_commonring_register_cb(struct brcmf_commonring *commonring,
16*4882a593Smuzhiyun 				  int (*cr_ring_bell)(void *ctx),
17*4882a593Smuzhiyun 				  int (*cr_update_rptr)(void *ctx),
18*4882a593Smuzhiyun 				  int (*cr_update_wptr)(void *ctx),
19*4882a593Smuzhiyun 				  int (*cr_write_rptr)(void *ctx),
20*4882a593Smuzhiyun 				  int (*cr_write_wptr)(void *ctx), void *ctx)
21*4882a593Smuzhiyun {
22*4882a593Smuzhiyun 	commonring->cr_ring_bell = cr_ring_bell;
23*4882a593Smuzhiyun 	commonring->cr_update_rptr = cr_update_rptr;
24*4882a593Smuzhiyun 	commonring->cr_update_wptr = cr_update_wptr;
25*4882a593Smuzhiyun 	commonring->cr_write_rptr = cr_write_rptr;
26*4882a593Smuzhiyun 	commonring->cr_write_wptr = cr_write_wptr;
27*4882a593Smuzhiyun 	commonring->cr_ctx = ctx;
28*4882a593Smuzhiyun }
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun 
brcmf_commonring_config(struct brcmf_commonring * commonring,u16 depth,u16 item_len,void * buf_addr)31*4882a593Smuzhiyun void brcmf_commonring_config(struct brcmf_commonring *commonring, u16 depth,
32*4882a593Smuzhiyun 			     u16 item_len, void *buf_addr)
33*4882a593Smuzhiyun {
34*4882a593Smuzhiyun 	commonring->depth = depth;
35*4882a593Smuzhiyun 	commonring->item_len = item_len;
36*4882a593Smuzhiyun 	commonring->buf_addr = buf_addr;
37*4882a593Smuzhiyun 	if (!commonring->inited) {
38*4882a593Smuzhiyun 		spin_lock_init(&commonring->lock);
39*4882a593Smuzhiyun 		commonring->inited = true;
40*4882a593Smuzhiyun 	}
41*4882a593Smuzhiyun 	commonring->r_ptr = 0;
42*4882a593Smuzhiyun 	if (commonring->cr_write_rptr)
43*4882a593Smuzhiyun 		commonring->cr_write_rptr(commonring->cr_ctx);
44*4882a593Smuzhiyun 	commonring->w_ptr = 0;
45*4882a593Smuzhiyun 	if (commonring->cr_write_wptr)
46*4882a593Smuzhiyun 		commonring->cr_write_wptr(commonring->cr_ctx);
47*4882a593Smuzhiyun 	commonring->f_ptr = 0;
48*4882a593Smuzhiyun }
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun 
brcmf_commonring_lock(struct brcmf_commonring * commonring)51*4882a593Smuzhiyun void brcmf_commonring_lock(struct brcmf_commonring *commonring)
52*4882a593Smuzhiyun 		__acquires(&commonring->lock)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	unsigned long flags;
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	spin_lock_irqsave(&commonring->lock, flags);
57*4882a593Smuzhiyun 	commonring->flags = flags;
58*4882a593Smuzhiyun }
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 
brcmf_commonring_unlock(struct brcmf_commonring * commonring)61*4882a593Smuzhiyun void brcmf_commonring_unlock(struct brcmf_commonring *commonring)
62*4882a593Smuzhiyun 		__releases(&commonring->lock)
63*4882a593Smuzhiyun {
64*4882a593Smuzhiyun 	spin_unlock_irqrestore(&commonring->lock, commonring->flags);
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 
brcmf_commonring_write_available(struct brcmf_commonring * commonring)68*4882a593Smuzhiyun bool brcmf_commonring_write_available(struct brcmf_commonring *commonring)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun 	u16 available;
71*4882a593Smuzhiyun 	bool retry = true;
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun again:
74*4882a593Smuzhiyun 	if (commonring->r_ptr <= commonring->w_ptr)
75*4882a593Smuzhiyun 		available = commonring->depth - commonring->w_ptr +
76*4882a593Smuzhiyun 			    commonring->r_ptr;
77*4882a593Smuzhiyun 	else
78*4882a593Smuzhiyun 		available = commonring->r_ptr - commonring->w_ptr;
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	if (available > 1) {
81*4882a593Smuzhiyun 		if (!commonring->was_full)
82*4882a593Smuzhiyun 			return true;
83*4882a593Smuzhiyun 		if (available > commonring->depth / 8) {
84*4882a593Smuzhiyun 			commonring->was_full = false;
85*4882a593Smuzhiyun 			return true;
86*4882a593Smuzhiyun 		}
87*4882a593Smuzhiyun 		if (retry) {
88*4882a593Smuzhiyun 			if (commonring->cr_update_rptr)
89*4882a593Smuzhiyun 				commonring->cr_update_rptr(commonring->cr_ctx);
90*4882a593Smuzhiyun 			retry = false;
91*4882a593Smuzhiyun 			goto again;
92*4882a593Smuzhiyun 		}
93*4882a593Smuzhiyun 		return false;
94*4882a593Smuzhiyun 	}
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	if (retry) {
97*4882a593Smuzhiyun 		if (commonring->cr_update_rptr)
98*4882a593Smuzhiyun 			commonring->cr_update_rptr(commonring->cr_ctx);
99*4882a593Smuzhiyun 		retry = false;
100*4882a593Smuzhiyun 		goto again;
101*4882a593Smuzhiyun 	}
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 	commonring->was_full = true;
104*4882a593Smuzhiyun 	return false;
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 
brcmf_commonring_reserve_for_write(struct brcmf_commonring * commonring)108*4882a593Smuzhiyun void *brcmf_commonring_reserve_for_write(struct brcmf_commonring *commonring)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun 	void *ret_ptr;
111*4882a593Smuzhiyun 	u16 available;
112*4882a593Smuzhiyun 	bool retry = true;
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun again:
115*4882a593Smuzhiyun 	if (commonring->r_ptr <= commonring->w_ptr)
116*4882a593Smuzhiyun 		available = commonring->depth - commonring->w_ptr +
117*4882a593Smuzhiyun 			    commonring->r_ptr;
118*4882a593Smuzhiyun 	else
119*4882a593Smuzhiyun 		available = commonring->r_ptr - commonring->w_ptr;
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	if (available > 1) {
122*4882a593Smuzhiyun 		ret_ptr = commonring->buf_addr +
123*4882a593Smuzhiyun 			  (commonring->w_ptr * commonring->item_len);
124*4882a593Smuzhiyun 		commonring->w_ptr++;
125*4882a593Smuzhiyun 		if (commonring->w_ptr == commonring->depth)
126*4882a593Smuzhiyun 			commonring->w_ptr = 0;
127*4882a593Smuzhiyun 		return ret_ptr;
128*4882a593Smuzhiyun 	}
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	if (retry) {
131*4882a593Smuzhiyun 		if (commonring->cr_update_rptr)
132*4882a593Smuzhiyun 			commonring->cr_update_rptr(commonring->cr_ctx);
133*4882a593Smuzhiyun 		retry = false;
134*4882a593Smuzhiyun 		goto again;
135*4882a593Smuzhiyun 	}
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	commonring->was_full = true;
138*4882a593Smuzhiyun 	return NULL;
139*4882a593Smuzhiyun }
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun void *
brcmf_commonring_reserve_for_write_multiple(struct brcmf_commonring * commonring,u16 n_items,u16 * alloced)143*4882a593Smuzhiyun brcmf_commonring_reserve_for_write_multiple(struct brcmf_commonring *commonring,
144*4882a593Smuzhiyun 					    u16 n_items, u16 *alloced)
145*4882a593Smuzhiyun {
146*4882a593Smuzhiyun 	void *ret_ptr;
147*4882a593Smuzhiyun 	u16 available;
148*4882a593Smuzhiyun 	bool retry = true;
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun again:
151*4882a593Smuzhiyun 	if (commonring->r_ptr <= commonring->w_ptr)
152*4882a593Smuzhiyun 		available = commonring->depth - commonring->w_ptr +
153*4882a593Smuzhiyun 			    commonring->r_ptr;
154*4882a593Smuzhiyun 	else
155*4882a593Smuzhiyun 		available = commonring->r_ptr - commonring->w_ptr;
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun 	if (available > 1) {
158*4882a593Smuzhiyun 		ret_ptr = commonring->buf_addr +
159*4882a593Smuzhiyun 			  (commonring->w_ptr * commonring->item_len);
160*4882a593Smuzhiyun 		*alloced = min_t(u16, n_items, available - 1);
161*4882a593Smuzhiyun 		if (*alloced + commonring->w_ptr > commonring->depth)
162*4882a593Smuzhiyun 			*alloced = commonring->depth - commonring->w_ptr;
163*4882a593Smuzhiyun 		commonring->w_ptr += *alloced;
164*4882a593Smuzhiyun 		if (commonring->w_ptr == commonring->depth)
165*4882a593Smuzhiyun 			commonring->w_ptr = 0;
166*4882a593Smuzhiyun 		return ret_ptr;
167*4882a593Smuzhiyun 	}
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 	if (retry) {
170*4882a593Smuzhiyun 		if (commonring->cr_update_rptr)
171*4882a593Smuzhiyun 			commonring->cr_update_rptr(commonring->cr_ctx);
172*4882a593Smuzhiyun 		retry = false;
173*4882a593Smuzhiyun 		goto again;
174*4882a593Smuzhiyun 	}
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 	commonring->was_full = true;
177*4882a593Smuzhiyun 	return NULL;
178*4882a593Smuzhiyun }
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun 
brcmf_commonring_write_complete(struct brcmf_commonring * commonring)181*4882a593Smuzhiyun int brcmf_commonring_write_complete(struct brcmf_commonring *commonring)
182*4882a593Smuzhiyun {
183*4882a593Smuzhiyun 	if (commonring->f_ptr > commonring->w_ptr)
184*4882a593Smuzhiyun 		commonring->f_ptr = 0;
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	commonring->f_ptr = commonring->w_ptr;
187*4882a593Smuzhiyun 
188*4882a593Smuzhiyun 	if (commonring->cr_write_wptr)
189*4882a593Smuzhiyun 		commonring->cr_write_wptr(commonring->cr_ctx);
190*4882a593Smuzhiyun 	if (commonring->cr_ring_bell)
191*4882a593Smuzhiyun 		return commonring->cr_ring_bell(commonring->cr_ctx);
192*4882a593Smuzhiyun 
193*4882a593Smuzhiyun 	return -EIO;
194*4882a593Smuzhiyun }
195*4882a593Smuzhiyun 
196*4882a593Smuzhiyun 
brcmf_commonring_write_cancel(struct brcmf_commonring * commonring,u16 n_items)197*4882a593Smuzhiyun void brcmf_commonring_write_cancel(struct brcmf_commonring *commonring,
198*4882a593Smuzhiyun 				   u16 n_items)
199*4882a593Smuzhiyun {
200*4882a593Smuzhiyun 	if (commonring->w_ptr == 0)
201*4882a593Smuzhiyun 		commonring->w_ptr = commonring->depth - n_items;
202*4882a593Smuzhiyun 	else
203*4882a593Smuzhiyun 		commonring->w_ptr -= n_items;
204*4882a593Smuzhiyun }
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 
brcmf_commonring_get_read_ptr(struct brcmf_commonring * commonring,u16 * n_items)207*4882a593Smuzhiyun void *brcmf_commonring_get_read_ptr(struct brcmf_commonring *commonring,
208*4882a593Smuzhiyun 				    u16 *n_items)
209*4882a593Smuzhiyun {
210*4882a593Smuzhiyun 	if (commonring->cr_update_wptr)
211*4882a593Smuzhiyun 		commonring->cr_update_wptr(commonring->cr_ctx);
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun 	*n_items = (commonring->w_ptr >= commonring->r_ptr) ?
214*4882a593Smuzhiyun 				(commonring->w_ptr - commonring->r_ptr) :
215*4882a593Smuzhiyun 				(commonring->depth - commonring->r_ptr);
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun 	if (*n_items == 0)
218*4882a593Smuzhiyun 		return NULL;
219*4882a593Smuzhiyun 
220*4882a593Smuzhiyun 	return commonring->buf_addr +
221*4882a593Smuzhiyun 	       (commonring->r_ptr * commonring->item_len);
222*4882a593Smuzhiyun }
223*4882a593Smuzhiyun 
224*4882a593Smuzhiyun 
brcmf_commonring_read_complete(struct brcmf_commonring * commonring,u16 n_items)225*4882a593Smuzhiyun int brcmf_commonring_read_complete(struct brcmf_commonring *commonring,
226*4882a593Smuzhiyun 				   u16 n_items)
227*4882a593Smuzhiyun {
228*4882a593Smuzhiyun 	commonring->r_ptr += n_items;
229*4882a593Smuzhiyun 	if (commonring->r_ptr == commonring->depth)
230*4882a593Smuzhiyun 		commonring->r_ptr = 0;
231*4882a593Smuzhiyun 
232*4882a593Smuzhiyun 	if (commonring->cr_write_rptr)
233*4882a593Smuzhiyun 		return commonring->cr_write_rptr(commonring->cr_ctx);
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun 	return -EIO;
236*4882a593Smuzhiyun }
237