xref: /openbmc/linux/drivers/net/wireless/broadcom/brcm80211/brcmfmac/proto.h (revision 9977a8c3497a8f7f7f951994f298a8e4d961234f)
1 /*
2  * Copyright (c) 2013 Broadcom Corporation
3  *
4  * Permission to use, copy, modify, and/or distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16 #ifndef BRCMFMAC_PROTO_H
17 #define BRCMFMAC_PROTO_H
18 
19 
20 enum proto_addr_mode {
21 	ADDR_INDIRECT	= 0,
22 	ADDR_DIRECT
23 };
24 
25 struct brcmf_skb_reorder_data {
26 	u8 *reorder;
27 };
28 
29 struct brcmf_proto {
30 	int (*hdrpull)(struct brcmf_pub *drvr, bool do_fws,
31 		       struct sk_buff *skb, struct brcmf_if **ifp);
32 	int (*query_dcmd)(struct brcmf_pub *drvr, int ifidx, uint cmd,
33 			  void *buf, uint len, int *fwerr);
34 	int (*set_dcmd)(struct brcmf_pub *drvr, int ifidx, uint cmd, void *buf,
35 			uint len, int *fwerr);
36 	int (*tx_queue_data)(struct brcmf_pub *drvr, int ifidx,
37 			     struct sk_buff *skb);
38 	int (*txdata)(struct brcmf_pub *drvr, int ifidx, u8 offset,
39 		      struct sk_buff *skb);
40 	void (*configure_addr_mode)(struct brcmf_pub *drvr, int ifidx,
41 				    enum proto_addr_mode addr_mode);
42 	void (*delete_peer)(struct brcmf_pub *drvr, int ifidx,
43 			    u8 peer[ETH_ALEN]);
44 	void (*add_tdls_peer)(struct brcmf_pub *drvr, int ifidx,
45 			      u8 peer[ETH_ALEN]);
46 	void (*rxreorder)(struct brcmf_if *ifp, struct sk_buff *skb);
47 	void (*add_if)(struct brcmf_if *ifp);
48 	void (*del_if)(struct brcmf_if *ifp);
49 	void (*reset_if)(struct brcmf_if *ifp);
50 	int (*init_done)(struct brcmf_pub *drvr);
51 	void *pd;
52 };
53 
54 
55 int brcmf_proto_attach(struct brcmf_pub *drvr);
56 void brcmf_proto_detach(struct brcmf_pub *drvr);
57 
58 static inline int brcmf_proto_hdrpull(struct brcmf_pub *drvr, bool do_fws,
59 				      struct sk_buff *skb,
60 				      struct brcmf_if **ifp)
61 {
62 	struct brcmf_if *tmp = NULL;
63 
64 	/* assure protocol is always called with
65 	 * non-null initialized pointer.
66 	 */
67 	if (ifp)
68 		*ifp = NULL;
69 	else
70 		ifp = &tmp;
71 	return drvr->proto->hdrpull(drvr, do_fws, skb, ifp);
72 }
73 static inline int brcmf_proto_query_dcmd(struct brcmf_pub *drvr, int ifidx,
74 					 uint cmd, void *buf, uint len,
75 					 int *fwerr)
76 {
77 	return drvr->proto->query_dcmd(drvr, ifidx, cmd, buf, len,fwerr);
78 }
79 static inline int brcmf_proto_set_dcmd(struct brcmf_pub *drvr, int ifidx,
80 				       uint cmd, void *buf, uint len,
81 				       int *fwerr)
82 {
83 	return drvr->proto->set_dcmd(drvr, ifidx, cmd, buf, len, fwerr);
84 }
85 
86 static inline int brcmf_proto_tx_queue_data(struct brcmf_pub *drvr, int ifidx,
87 					    struct sk_buff *skb)
88 {
89 	return drvr->proto->tx_queue_data(drvr, ifidx, skb);
90 }
91 
92 static inline int brcmf_proto_txdata(struct brcmf_pub *drvr, int ifidx,
93 				     u8 offset, struct sk_buff *skb)
94 {
95 	return drvr->proto->txdata(drvr, ifidx, offset, skb);
96 }
97 static inline void
98 brcmf_proto_configure_addr_mode(struct brcmf_pub *drvr, int ifidx,
99 				enum proto_addr_mode addr_mode)
100 {
101 	drvr->proto->configure_addr_mode(drvr, ifidx, addr_mode);
102 }
103 static inline void
104 brcmf_proto_delete_peer(struct brcmf_pub *drvr, int ifidx, u8 peer[ETH_ALEN])
105 {
106 	drvr->proto->delete_peer(drvr, ifidx, peer);
107 }
108 static inline void
109 brcmf_proto_add_tdls_peer(struct brcmf_pub *drvr, int ifidx, u8 peer[ETH_ALEN])
110 {
111 	drvr->proto->add_tdls_peer(drvr, ifidx, peer);
112 }
113 static inline bool brcmf_proto_is_reorder_skb(struct sk_buff *skb)
114 {
115 	struct brcmf_skb_reorder_data *rd;
116 
117 	rd = (struct brcmf_skb_reorder_data *)skb->cb;
118 	return !!rd->reorder;
119 }
120 
121 static inline void
122 brcmf_proto_rxreorder(struct brcmf_if *ifp, struct sk_buff *skb)
123 {
124 	ifp->drvr->proto->rxreorder(ifp, skb);
125 }
126 
127 static inline void
128 brcmf_proto_add_if(struct brcmf_pub *drvr, struct brcmf_if *ifp)
129 {
130 	if (!drvr->proto->add_if)
131 		return;
132 	drvr->proto->add_if(ifp);
133 }
134 
135 static inline void
136 brcmf_proto_del_if(struct brcmf_pub *drvr, struct brcmf_if *ifp)
137 {
138 	if (!drvr->proto->del_if)
139 		return;
140 	drvr->proto->del_if(ifp);
141 }
142 
143 static inline void
144 brcmf_proto_reset_if(struct brcmf_pub *drvr, struct brcmf_if *ifp)
145 {
146 	if (!drvr->proto->reset_if)
147 		return;
148 	drvr->proto->reset_if(ifp);
149 }
150 
151 static inline int
152 brcmf_proto_init_done(struct brcmf_pub *drvr)
153 {
154 	if (!drvr->proto->init_done)
155 		return 0;
156 	return drvr->proto->init_done(drvr);
157 }
158 
159 #endif /* BRCMFMAC_PROTO_H */
160