xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/broadcom/brcm80211/brcmfmac/commonring.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: ISC
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2014 Broadcom Corporation
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun #ifndef BRCMFMAC_COMMONRING_H
6*4882a593Smuzhiyun #define BRCMFMAC_COMMONRING_H
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun struct brcmf_commonring {
10*4882a593Smuzhiyun 	u16 r_ptr;
11*4882a593Smuzhiyun 	u16 w_ptr;
12*4882a593Smuzhiyun 	u16 f_ptr;
13*4882a593Smuzhiyun 	u16 depth;
14*4882a593Smuzhiyun 	u16 item_len;
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun 	void *buf_addr;
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun 	int (*cr_ring_bell)(void *ctx);
19*4882a593Smuzhiyun 	int (*cr_update_rptr)(void *ctx);
20*4882a593Smuzhiyun 	int (*cr_update_wptr)(void *ctx);
21*4882a593Smuzhiyun 	int (*cr_write_rptr)(void *ctx);
22*4882a593Smuzhiyun 	int (*cr_write_wptr)(void *ctx);
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun 	void *cr_ctx;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	spinlock_t lock;
27*4882a593Smuzhiyun 	unsigned long flags;
28*4882a593Smuzhiyun 	bool inited;
29*4882a593Smuzhiyun 	bool was_full;
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun 	atomic_t outstanding_tx;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun void brcmf_commonring_register_cb(struct brcmf_commonring *commonring,
36*4882a593Smuzhiyun 				  int (*cr_ring_bell)(void *ctx),
37*4882a593Smuzhiyun 				  int (*cr_update_rptr)(void *ctx),
38*4882a593Smuzhiyun 				  int (*cr_update_wptr)(void *ctx),
39*4882a593Smuzhiyun 				  int (*cr_write_rptr)(void *ctx),
40*4882a593Smuzhiyun 				  int (*cr_write_wptr)(void *ctx), void *ctx);
41*4882a593Smuzhiyun void brcmf_commonring_config(struct brcmf_commonring *commonring, u16 depth,
42*4882a593Smuzhiyun 			     u16 item_len, void *buf_addr);
43*4882a593Smuzhiyun void brcmf_commonring_lock(struct brcmf_commonring *commonring);
44*4882a593Smuzhiyun void brcmf_commonring_unlock(struct brcmf_commonring *commonring);
45*4882a593Smuzhiyun bool brcmf_commonring_write_available(struct brcmf_commonring *commonring);
46*4882a593Smuzhiyun void *brcmf_commonring_reserve_for_write(struct brcmf_commonring *commonring);
47*4882a593Smuzhiyun void *
48*4882a593Smuzhiyun brcmf_commonring_reserve_for_write_multiple(struct brcmf_commonring *commonring,
49*4882a593Smuzhiyun 					    u16 n_items, u16 *alloced);
50*4882a593Smuzhiyun int brcmf_commonring_write_complete(struct brcmf_commonring *commonring);
51*4882a593Smuzhiyun void brcmf_commonring_write_cancel(struct brcmf_commonring *commonring,
52*4882a593Smuzhiyun 				   u16 n_items);
53*4882a593Smuzhiyun void *brcmf_commonring_get_read_ptr(struct brcmf_commonring *commonring,
54*4882a593Smuzhiyun 				    u16 *n_items);
55*4882a593Smuzhiyun int brcmf_commonring_read_complete(struct brcmf_commonring *commonring,
56*4882a593Smuzhiyun 				   u16 n_items);
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun #define brcmf_commonring_n_items(commonring) (commonring->depth)
59*4882a593Smuzhiyun #define brcmf_commonring_len_item(commonring) (commonring->item_len)
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun #endif /* BRCMFMAC_COMMONRING_H */
63