GNU Linux-libre 4.19.268-gnu1
[releases.git] / drivers / net / wireless / broadcom / brcm80211 / brcmfmac / proto.h
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 (*debugfs_create)(struct brcmf_pub *drvr);
52         void *pd;
53 };
54
55
56 int brcmf_proto_attach(struct brcmf_pub *drvr);
57 void brcmf_proto_detach_pre_delif(struct brcmf_pub *drvr);
58 void brcmf_proto_detach_post_delif(struct brcmf_pub *drvr);
59
60 static inline int brcmf_proto_hdrpull(struct brcmf_pub *drvr, bool do_fws,
61                                       struct sk_buff *skb,
62                                       struct brcmf_if **ifp)
63 {
64         struct brcmf_if *tmp = NULL;
65
66         /* assure protocol is always called with
67          * non-null initialized pointer.
68          */
69         if (ifp)
70                 *ifp = NULL;
71         else
72                 ifp = &tmp;
73         return drvr->proto->hdrpull(drvr, do_fws, skb, ifp);
74 }
75 static inline int brcmf_proto_query_dcmd(struct brcmf_pub *drvr, int ifidx,
76                                          uint cmd, void *buf, uint len,
77                                          int *fwerr)
78 {
79         return drvr->proto->query_dcmd(drvr, ifidx, cmd, buf, len,fwerr);
80 }
81 static inline int brcmf_proto_set_dcmd(struct brcmf_pub *drvr, int ifidx,
82                                        uint cmd, void *buf, uint len,
83                                        int *fwerr)
84 {
85         return drvr->proto->set_dcmd(drvr, ifidx, cmd, buf, len, fwerr);
86 }
87
88 static inline int brcmf_proto_tx_queue_data(struct brcmf_pub *drvr, int ifidx,
89                                             struct sk_buff *skb)
90 {
91         return drvr->proto->tx_queue_data(drvr, ifidx, skb);
92 }
93
94 static inline int brcmf_proto_txdata(struct brcmf_pub *drvr, int ifidx,
95                                      u8 offset, struct sk_buff *skb)
96 {
97         return drvr->proto->txdata(drvr, ifidx, offset, skb);
98 }
99 static inline void
100 brcmf_proto_configure_addr_mode(struct brcmf_pub *drvr, int ifidx,
101                                 enum proto_addr_mode addr_mode)
102 {
103         drvr->proto->configure_addr_mode(drvr, ifidx, addr_mode);
104 }
105 static inline void
106 brcmf_proto_delete_peer(struct brcmf_pub *drvr, int ifidx, u8 peer[ETH_ALEN])
107 {
108         drvr->proto->delete_peer(drvr, ifidx, peer);
109 }
110 static inline void
111 brcmf_proto_add_tdls_peer(struct brcmf_pub *drvr, int ifidx, u8 peer[ETH_ALEN])
112 {
113         drvr->proto->add_tdls_peer(drvr, ifidx, peer);
114 }
115 static inline bool brcmf_proto_is_reorder_skb(struct sk_buff *skb)
116 {
117         struct brcmf_skb_reorder_data *rd;
118
119         rd = (struct brcmf_skb_reorder_data *)skb->cb;
120         return !!rd->reorder;
121 }
122
123 static inline void
124 brcmf_proto_rxreorder(struct brcmf_if *ifp, struct sk_buff *skb)
125 {
126         ifp->drvr->proto->rxreorder(ifp, skb);
127 }
128
129 static inline void
130 brcmf_proto_add_if(struct brcmf_pub *drvr, struct brcmf_if *ifp)
131 {
132         if (!drvr->proto->add_if)
133                 return;
134         drvr->proto->add_if(ifp);
135 }
136
137 static inline void
138 brcmf_proto_del_if(struct brcmf_pub *drvr, struct brcmf_if *ifp)
139 {
140         if (!drvr->proto->del_if)
141                 return;
142         drvr->proto->del_if(ifp);
143 }
144
145 static inline void
146 brcmf_proto_reset_if(struct brcmf_pub *drvr, struct brcmf_if *ifp)
147 {
148         if (!drvr->proto->reset_if)
149                 return;
150         drvr->proto->reset_if(ifp);
151 }
152
153 static inline int
154 brcmf_proto_init_done(struct brcmf_pub *drvr)
155 {
156         if (!drvr->proto->init_done)
157                 return 0;
158         return drvr->proto->init_done(drvr);
159 }
160
161 static inline void
162 brcmf_proto_debugfs_create(struct brcmf_pub *drvr)
163 {
164         drvr->proto->debugfs_create(drvr);
165 }
166
167 #endif /* BRCMFMAC_PROTO_H */