1 /*
2  * Copyright (c) 2010 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 
17 /****************
18  * Common types *
19  */
20 
21 #ifndef BRCMFMAC_CORE_H
22 #define BRCMFMAC_CORE_H
23 
24 #include <net/cfg80211.h>
25 #include "fweh.h"
26 
27 #define TOE_TX_CSUM_OL		0x00000001
28 #define TOE_RX_CSUM_OL		0x00000002
29 
30 /* For supporting multiple interfaces */
31 #define BRCMF_MAX_IFS	16
32 
33 /* Small, medium and maximum buffer size for dcmd
34  */
35 #define BRCMF_DCMD_SMLEN	256
36 #define BRCMF_DCMD_MEDLEN	1536
37 #define BRCMF_DCMD_MAXLEN	8192
38 
39 /* IOCTL from host to device are limited in lenght. A device can only handle
40  * ethernet frame size. This limitation is to be applied by protocol layer.
41  */
42 #define BRCMF_TX_IOCTL_MAX_MSG_SIZE	(ETH_FRAME_LEN+ETH_FCS_LEN)
43 
44 #define BRCMF_AMPDU_RX_REORDER_MAXFLOWS		256
45 
46 /* Length of firmware version string stored for
47  * ethtool driver info which uses 32 bytes as well.
48  */
49 #define BRCMF_DRIVER_FIRMWARE_VERSION_LEN	32
50 
51 #define NDOL_MAX_ENTRIES	8
52 
53 /**
54  * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
55  *
56  * @pktslots: dynamic allocated array for ordering AMPDU packets.
57  * @flow_id: AMPDU flow identifier.
58  * @cur_idx: last AMPDU index from firmware.
59  * @exp_idx: expected next AMPDU index.
60  * @max_idx: maximum amount of packets per AMPDU.
61  * @pend_pkts: number of packets currently in @pktslots.
62  */
63 struct brcmf_ampdu_rx_reorder {
64 	struct sk_buff **pktslots;
65 	u8 flow_id;
66 	u8 cur_idx;
67 	u8 exp_idx;
68 	u8 max_idx;
69 	u8 pend_pkts;
70 };
71 
72 /* Forward decls for struct brcmf_pub (see below) */
73 struct brcmf_proto;	/* device communication protocol info */
74 struct brcmf_fws_info;	/* firmware signalling info */
75 struct brcmf_mp_device;	/* module paramateres, device specific */
76 
77 /*
78  * struct brcmf_rev_info
79  *
80  * The result field stores the error code of the
81  * revision info request from firmware. For the
82  * other fields see struct brcmf_rev_info_le in
83  * fwil_types.h
84  */
85 struct brcmf_rev_info {
86 	int result;
87 	u32 vendorid;
88 	u32 deviceid;
89 	u32 radiorev;
90 	u32 corerev;
91 	u32 boardid;
92 	u32 boardvendor;
93 	u32 boardrev;
94 	u32 driverrev;
95 	u32 ucoderev;
96 	u32 bus;
97 	char chipname[12];
98 	u32 phytype;
99 	u32 phyrev;
100 	u32 anarev;
101 	u32 chippkg;
102 	u32 nvramrev;
103 };
104 
105 /* Common structure for module and instance linkage */
106 struct brcmf_pub {
107 	/* Linkage ponters */
108 	struct brcmf_bus *bus_if;
109 	struct brcmf_proto *proto;
110 	struct brcmf_cfg80211_info *config;
111 
112 	/* Internal brcmf items */
113 	uint hdrlen;		/* Total BRCMF header length (proto + bus) */
114 
115 	/* Dongle media info */
116 	char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
117 	u8 mac[ETH_ALEN];		/* MAC address obtained from dongle */
118 
119 	struct mac_address addresses[BRCMF_MAX_IFS];
120 
121 	struct brcmf_if *iflist[BRCMF_MAX_IFS];
122 	s32 if2bss[BRCMF_MAX_IFS];
123 
124 	struct mutex proto_block;
125 	unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
126 
127 	struct brcmf_fweh_info fweh;
128 
129 	struct brcmf_ampdu_rx_reorder
130 		*reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];
131 
132 	u32 feat_flags;
133 	u32 chip_quirks;
134 
135 	struct brcmf_rev_info revinfo;
136 #ifdef DEBUG
137 	struct dentry *dbgfs_dir;
138 #endif
139 
140 	struct notifier_block inetaddr_notifier;
141 	struct notifier_block inet6addr_notifier;
142 	struct brcmf_mp_device *settings;
143 
144 	u8 clmver[BRCMF_DCMD_SMLEN];
145 };
146 
147 /* forward declarations */
148 struct brcmf_cfg80211_vif;
149 struct brcmf_fws_mac_descriptor;
150 
151 /**
152  * enum brcmf_netif_stop_reason - reason for stopping netif queue.
153  *
154  * @BRCMF_NETIF_STOP_REASON_FWS_FC:
155  *	netif stopped due to firmware signalling flow control.
156  * @BRCMF_NETIF_STOP_REASON_FLOW:
157  *	netif stopped due to flowring full.
158  * @BRCMF_NETIF_STOP_REASON_DISCONNECTED:
159  *	netif stopped due to not being connected (STA mode).
160  */
161 enum brcmf_netif_stop_reason {
162 	BRCMF_NETIF_STOP_REASON_FWS_FC = BIT(0),
163 	BRCMF_NETIF_STOP_REASON_FLOW = BIT(1),
164 	BRCMF_NETIF_STOP_REASON_DISCONNECTED = BIT(2)
165 };
166 
167 /**
168  * struct brcmf_if - interface control information.
169  *
170  * @drvr: points to device related information.
171  * @vif: points to cfg80211 specific interface information.
172  * @ndev: associated network device.
173  * @multicast_work: worker object for multicast provisioning.
174  * @ndoffload_work: worker object for neighbor discovery offload configuration.
175  * @fws_desc: interface specific firmware-signalling descriptor.
176  * @ifidx: interface index in device firmware.
177  * @bsscfgidx: index of bss associated with this interface.
178  * @mac_addr: assigned mac address.
179  * @netif_stop: bitmap indicates reason why netif queues are stopped.
180  * @netif_stop_lock: spinlock for update netif_stop from multiple sources.
181  * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
182  * @pend_8021x_wait: used for signalling change in count.
183  * @fwil_fwerr: flag indicating fwil layer should return firmware error codes.
184  */
185 struct brcmf_if {
186 	struct brcmf_pub *drvr;
187 	struct brcmf_cfg80211_vif *vif;
188 	struct net_device *ndev;
189 	struct work_struct multicast_work;
190 	struct work_struct ndoffload_work;
191 	struct brcmf_fws_mac_descriptor *fws_desc;
192 	int ifidx;
193 	s32 bsscfgidx;
194 	u8 mac_addr[ETH_ALEN];
195 	u8 netif_stop;
196 	spinlock_t netif_stop_lock;
197 	atomic_t pend_8021x_cnt;
198 	wait_queue_head_t pend_8021x_wait;
199 	struct in6_addr ipv6_addr_tbl[NDOL_MAX_ENTRIES];
200 	u8 ipv6addr_idx;
201 	bool fwil_fwerr;
202 };
203 
204 int brcmf_netdev_wait_pend8021x(struct brcmf_if *ifp);
205 
206 /* Return pointer to interface name */
207 char *brcmf_ifname(struct brcmf_if *ifp);
208 struct brcmf_if *brcmf_get_ifp(struct brcmf_pub *drvr, int ifidx);
209 void brcmf_configure_arp_nd_offload(struct brcmf_if *ifp, bool enable);
210 int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
211 struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bsscfgidx, s32 ifidx,
212 			      bool is_p2pdev, const char *name, u8 *mac_addr);
213 void brcmf_remove_interface(struct brcmf_if *ifp, bool rtnl_locked);
214 void brcmf_txflowblock_if(struct brcmf_if *ifp,
215 			  enum brcmf_netif_stop_reason reason, bool state);
216 void brcmf_txfinalize(struct brcmf_if *ifp, struct sk_buff *txp, bool success);
217 void brcmf_netif_rx(struct brcmf_if *ifp, struct sk_buff *skb);
218 void brcmf_net_setcarrier(struct brcmf_if *ifp, bool on);
219 int __init brcmf_core_init(void);
220 void __exit brcmf_core_exit(void);
221 
222 #endif /* BRCMFMAC_CORE_H */
223