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