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