27005dc2d591057d55d52da0d9289f33d0c5ac40
[dragonfly.git] / sys / dev / netif / ath / ath / if_ath_btcoex.c
1 /*-
2  * Copyright (c) 2013 Adrian Chadd <adrian@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
30  */
31 #include <sys/cdefs.h>
32
33 /*
34  * This implements some very basic bluetooth coexistence methods for
35  * the ath(4) hardware.
36  */
37 #include "opt_ath.h"
38 #include "opt_inet.h"
39 #include "opt_wlan.h"
40
41 #include <sys/param.h>
42 #include <sys/systm.h> 
43 #include <sys/sysctl.h>
44 #include <sys/kernel.h>
45 #include <sys/lock.h>
46 #include <sys/malloc.h>
47 #include <sys/mutex.h>
48 #include <sys/errno.h>
49 #include <sys/bus.h>
50 #include <sys/socket.h>
51  
52 #include <net/if.h>
53 #include <net/if_var.h>
54 #include <net/if_media.h>
55 #include <net/if_arp.h>
56 #include <net/ethernet.h>               /* XXX for ether_sprintf */
57
58 #include <netproto/802_11/ieee80211_var.h>
59
60 #include <net/bpf.h>
61
62 #ifdef INET
63 #include <netinet/in.h>
64 #include <netinet/if_ether.h>
65 #endif
66
67 #include <machine/resource.h>
68
69 #include <dev/netif/ath/ath/if_athvar.h>
70 #include <dev/netif/ath/ath/if_ath_btcoex.h>
71
72 /*
73  * Initial AR9285 / (WB195) bluetooth coexistence settings,
74  * just for experimentation.
75  *
76  * Return 0 for OK; errno for error.
77  *
78  * XXX TODO: There needs to be a PCIe workaround to disable ASPM if
79  * bluetooth coexistence is enabled.
80  */
81 static int
82 ath_btcoex_cfg_wb195(struct ath_softc *sc)
83 {
84         HAL_BT_COEX_INFO btinfo;
85         HAL_BT_COEX_CONFIG btconfig;
86         struct ath_hal *ah = sc->sc_ah;
87
88         if (! ath_hal_btcoex_supported(ah))
89                 return (EINVAL);
90
91         bzero(&btinfo, sizeof(btinfo));
92         bzero(&btconfig, sizeof(btconfig));
93
94         device_printf(sc->sc_dev, "Enabling WB195 BTCOEX\n");
95
96         btinfo.bt_module = HAL_BT_MODULE_JANUS;
97         btinfo.bt_coex_config = HAL_BT_COEX_CFG_3WIRE;
98         /*
99          * These are the three GPIO pins hooked up between the AR9285 and
100          * the AR3011.
101          */
102         btinfo.bt_gpio_bt_active = 6;
103         btinfo.bt_gpio_bt_priority = 7;
104         btinfo.bt_gpio_wlan_active = 5;
105         btinfo.bt_active_polarity = 1;  /* XXX not used */
106         btinfo.bt_single_ant = 1;       /* 1 antenna on ar9285 ? */
107         btinfo.bt_isolation = 0;        /* in dB, not used */
108
109         ath_hal_btcoex_set_info(ah, &btinfo);
110
111         btconfig.bt_time_extend = 0;
112         btconfig.bt_txstate_extend = 1; /* true */
113         btconfig.bt_txframe_extend = 1; /* true */
114         btconfig.bt_mode = HAL_BT_COEX_MODE_SLOTTED;
115         btconfig.bt_quiet_collision = 1;        /* true */
116         btconfig.bt_rxclear_polarity = 1;       /* true */
117         btconfig.bt_priority_time = 2;
118         btconfig.bt_first_slot_time = 5;
119         btconfig.bt_hold_rxclear = 1;   /* true */
120
121         ath_hal_btcoex_set_config(ah, &btconfig);
122
123         /*
124          * Enable antenna diversity.
125          */
126         ath_hal_btcoex_set_parameter(ah, HAL_BT_COEX_ANTENNA_DIVERSITY, 1);
127
128         return (0);
129 }
130
131 /*
132  * Initial AR9485 / (WB225) bluetooth coexistence settings,
133  * just for experimentation.
134  *
135  * Return 0 for OK; errno for error.
136  */
137 static int
138 ath_btcoex_cfg_wb225(struct ath_softc *sc)
139 {
140         HAL_BT_COEX_INFO btinfo;
141         HAL_BT_COEX_CONFIG btconfig;
142         struct ath_hal *ah = sc->sc_ah;
143
144         if (! ath_hal_btcoex_supported(ah))
145                 return (EINVAL);
146
147         bzero(&btinfo, sizeof(btinfo));
148         bzero(&btconfig, sizeof(btconfig));
149
150         device_printf(sc->sc_dev, "Enabling WB225 BTCOEX\n");
151
152         btinfo.bt_module = HAL_BT_MODULE_JANUS; /* XXX not used? */
153         btinfo.bt_coex_config = HAL_BT_COEX_CFG_3WIRE;
154         /*
155          * These are the three GPIO pins hooked up between the AR9485 and
156          * the bluetooth module.
157          */
158         btinfo.bt_gpio_bt_active = 4;
159         btinfo.bt_gpio_bt_priority = 8;
160         btinfo.bt_gpio_wlan_active = 5;
161
162         btinfo.bt_active_polarity = 1;  /* XXX not used */
163         btinfo.bt_single_ant = 1;       /* 1 antenna on ar9285 ? */
164         btinfo.bt_isolation = 0;        /* in dB, not used */
165
166         ath_hal_btcoex_set_info(ah, &btinfo);
167
168         btconfig.bt_time_extend = 0;
169         btconfig.bt_txstate_extend = 1; /* true */
170         btconfig.bt_txframe_extend = 1; /* true */
171         btconfig.bt_mode = HAL_BT_COEX_MODE_SLOTTED;
172         btconfig.bt_quiet_collision = 1;        /* true */
173         btconfig.bt_rxclear_polarity = 1;       /* true */
174         btconfig.bt_priority_time = 2;
175         btconfig.bt_first_slot_time = 5;
176         btconfig.bt_hold_rxclear = 1;   /* true */
177
178         ath_hal_btcoex_set_config(ah, &btconfig);
179
180         /*
181          * Enable antenna diversity.
182          */
183         ath_hal_btcoex_set_parameter(ah, HAL_BT_COEX_ANTENNA_DIVERSITY, 1);
184
185         return (0);
186 }
187
188
189 #if 0
190 /*
191  * When using bluetooth coexistence, ASPM needs to be disabled
192  * otherwise the sleeping interferes with the bluetooth (USB)
193  * operation and the MAC sleep/wakeup hardware.
194  *
195  * The PCIe powersave routine also needs to not be called
196  * by the driver during suspend/resume, else things will get
197  * a little odd.  Check Linux ath9k for more details.
198  */
199 static int
200 ath_btcoex_aspm_wb195(struct ath_softc *sc)
201 {
202
203         /* XXX TODO: clear device ASPM L0S and L1 */
204         /* XXX TODO: clear _parent_ ASPM L0S and L1 */
205 }
206 #endif
207
208 /*
209  * Methods which are required
210  */
211
212 /*
213  * Attach btcoex to the given interface
214  */
215 int
216 ath_btcoex_attach(struct ath_softc *sc)
217 {
218         int ret;
219         struct ath_hal *ah = sc->sc_ah;
220         const char *profname;
221
222         /*
223          * No chipset bluetooth coexistence? Then do nothing.
224          */
225         if (! ath_hal_btcoex_supported(ah))
226                 return (0);
227
228         /*
229          * Look at the hints to determine which bluetooth
230          * profile to configure.
231          */
232         ret = resource_string_value(device_get_name(sc->sc_dev),
233             device_get_unit(sc->sc_dev),
234             "btcoex_profile",
235             &profname);
236         if (ret != 0) {
237                 /* nothing to do */
238                 return (0);
239         }
240
241         if (strncmp(profname, "wb195", 5) == 0) {
242                 ret = ath_btcoex_cfg_wb195(sc);
243         } else if (strncmp(profname, "wb225", 5) == 0) {
244                 ret = ath_btcoex_cfg_wb225(sc);
245         } else {
246                 return (0);
247         }
248
249         /*
250          * Propagate up failure from the actual attach phase.
251          */
252         if (ret != 0)
253                 return (ret);
254
255         return (0);
256 }
257
258 /*
259  * Detach btcoex from the given interface
260  */
261 int
262 ath_btcoex_detach(struct ath_softc *sc)
263 {
264
265         return (0);
266 }
267
268 /*
269  * Configure or disable bluetooth coexistence on the given channel.
270  *
271  * For AR9285/AR9287/AR9485, we'll never see a 5GHz channel, so we just
272  * assume bluetooth coexistence is always on.
273  *
274  * For AR9462, we may see a 5GHz channel; bluetooth coexistence should
275  * not be enabled on those channels.
276  */
277 int
278 ath_btcoex_enable(struct ath_softc *sc, const struct ieee80211_channel *chan)
279 {
280
281         return (0);
282 }
283
284 /*
285  * Handle ioctl requests from the diagnostic interface.
286  *
287  * The initial part of this code resembles ath_ioctl_diag();
288  * it's likely a good idea to reduce duplication between
289  * these two routines.
290  */
291 int
292 ath_btcoex_ioctl(struct ath_softc *sc, struct ath_diag *ad)
293 {
294         unsigned int id = ad->ad_id & ATH_DIAG_ID;
295         void *indata = NULL;
296         void *outdata = NULL;
297         u_int32_t insize = ad->ad_in_size;
298         u_int32_t outsize = ad->ad_out_size;
299         int error = 0;
300 //      int val;
301
302         if (ad->ad_id & ATH_DIAG_IN) {
303                 /*
304                  * Copy in data.
305                  */
306                 indata = malloc(insize, M_TEMP, M_NOWAIT);
307                 if (indata == NULL) {
308                         error = ENOMEM;
309                         goto bad;
310                 }
311                 error = copyin(ad->ad_in_data, indata, insize);
312                 if (error)
313                         goto bad;
314         }
315         if (ad->ad_id & ATH_DIAG_DYN) {
316                 /*
317                  * Allocate a buffer for the results (otherwise the HAL
318                  * returns a pointer to a buffer where we can read the
319                  * results).  Note that we depend on the HAL leaving this
320                  * pointer for us to use below in reclaiming the buffer;
321                  * may want to be more defensive.
322                  */
323                 outdata = malloc(outsize, M_TEMP, M_NOWAIT);
324                 if (outdata == NULL) {
325                         error = ENOMEM;
326                         goto bad;
327                 }
328         }
329         switch (id) {
330                 default:
331                         error = EINVAL;
332         }
333         if (outsize < ad->ad_out_size)
334                 ad->ad_out_size = outsize;
335         if (outdata && copyout(outdata, ad->ad_out_data, ad->ad_out_size))
336                 error = EFAULT;
337 bad:
338         if ((ad->ad_id & ATH_DIAG_IN) && indata != NULL)
339                 free(indata, M_TEMP);
340         if ((ad->ad_id & ATH_DIAG_DYN) && outdata != NULL)
341                 free(outdata, M_TEMP);
342         return (error);
343 }
344