sys/dev/netif/ath/hal/ah_osdep.c

   1 /*-
   2  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
   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: head/sys/dev/ath/ah_osdep.c 196970 2009-09-08 13:19:05Z phk $
  30  */
  31 #include "opt_ah.h"
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/module.h>
  37 #include <sys/sysctl.h>
  38 #include <sys/bus.h>
  39 #include <sys/malloc.h>
  40 #include <sys/proc.h>
  41
  42 #include <machine/stdarg.h>
  43
  44 #include <net/ethernet.h>               /* XXX for ether_sprintf */
  45
  46 #include <dev/netif/ath/hal/ath_hal/ah.h>
  47
  48 /*
  49  * WiSoC boards overload the bus tag with information about the
  50  * board layout.  We must extract the bus space tag from that
  51  * indirect structure.  For everyone else the tag is passed in
  52  * directly.
  53  * XXX cache indirect ref privately
  54  */
  55 #ifdef AH_SUPPORT_AR5312
  56 #define BUSTAG(ah) \
  57         ((bus_space_tag_t) ((struct ar531x_config *)((ah)->ah_st))->tag)
  58 #else
  59 #define BUSTAG(ah)      ((ah)->ah_st)
  60 #endif
  61
  62 extern  void ath_hal_printf(struct ath_hal *, const char*, ...)
  63                 __printflike(2,3);
  64 extern  void ath_hal_vprintf(struct ath_hal *, const char*, __va_list)
  65                 __printflike(2, 0);
  66 extern  const char* ath_hal_ether_sprintf(const u_int8_t *mac);
  67 extern  void *ath_hal_malloc(size_t);
  68 extern  void ath_hal_free(void *);
  69 #ifdef AH_ASSERT
  70 extern  void ath_hal_assert_failed(const char* filename,
  71                 int lineno, const char* msg);
  72 #endif
  73 #ifdef AH_DEBUG
  74 extern  void HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...);
  75 #endif /* AH_DEBUG */
  76
  77 /* NB: put this here instead of the driver to avoid circular references */
  78 SYSCTL_NODE(_hw, OID_AUTO, ath, CTLFLAG_RD, 0, "Atheros driver parameters");
  79 SYSCTL_NODE(_hw_ath, OID_AUTO, hal, CTLFLAG_RD, 0, "Atheros HAL parameters");
  80
  81 #ifdef AH_DEBUG
  82 static  int ath_hal_debug = 0xffffffff;
  83 SYSCTL_INT(_hw_ath_hal, OID_AUTO, debug, CTLFLAG_RW, &ath_hal_debug,
  84             0, "Atheros HAL debugging printfs");
  85 TUNABLE_INT("hw.ath.hal.debug", &ath_hal_debug);
  86 #endif /* AH_DEBUG */
  87
  88 /* NB: these are deprecated; they exist for now for compatibility */
  89 int     ath_hal_dma_beacon_response_time = 2;   /* in TU's */
  90 SYSCTL_INT(_hw_ath_hal, OID_AUTO, dma_brt, CTLFLAG_RW,
  91            &ath_hal_dma_beacon_response_time, 0,
  92            "Atheros HAL DMA beacon response time");
  93 int     ath_hal_sw_beacon_response_time = 10;   /* in TU's */
  94 SYSCTL_INT(_hw_ath_hal, OID_AUTO, sw_brt, CTLFLAG_RW,
  95            &ath_hal_sw_beacon_response_time, 0,
  96            "Atheros HAL software beacon response time");
  97 int     ath_hal_additional_swba_backoff = 0;    /* in TU's */
  98 SYSCTL_INT(_hw_ath_hal, OID_AUTO, swba_backoff, CTLFLAG_RW,
  99            &ath_hal_additional_swba_backoff, 0,
 100            "Atheros HAL additional SWBA backoff time");
 101
 102 MALLOC_DEFINE(M_ATH_HAL, "ath_hal", "ath hal data");
 103
 104 void*
 105 ath_hal_malloc(size_t size)
 106 {
 107         return kmalloc(size, M_ATH_HAL, M_NOWAIT | M_ZERO);
 108 }
 109
 110 void
 111 ath_hal_free(void* p)
 112 {
 113         kfree(p, M_ATH_HAL);
 114 }
 115
 116 void
 117 ath_hal_vprintf(struct ath_hal *ah, const char* fmt, __va_list ap)
 118 {
 119         kvprintf(fmt, ap);
 120 }
 121
 122 void
 123 ath_hal_printf(struct ath_hal *ah, const char* fmt, ...)
 124 {
 125         __va_list ap;
 126         __va_start(ap, fmt);
 127         ath_hal_vprintf(ah, fmt, ap);
 128         __va_end(ap);
 129 }
 130
 131 const char*
 132 ath_hal_ether_sprintf(const u_int8_t *mac)
 133 {
 134         static char etherbuf[18];
 135
 136         ksnprintf(etherbuf, sizeof(etherbuf), "%6D", mac, ":");
 137         return etherbuf;
 138 }
 139
 140 #ifdef AH_DEBUG
 141 void
 142 HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...)
 143 {
 144         if (ath_hal_debug & mask) {
 145                 __va_list ap;
 146                 __va_start(ap, fmt);
 147                 ath_hal_vprintf(ah, fmt, ap);
 148                 __va_end(ap);
 149         }
 150 }
 151 #endif /* AH_DEBUG */
 152
 153 #ifdef AH_DEBUG_ALQ
 154 /*
 155  * ALQ register tracing support.
 156  *
 157  * Setting hw.ath.hal.alq=1 enables tracing of all register reads and
 158  * writes to the file /tmp/ath_hal.log.  The file format is a simple
 159  * fixed-size array of records.  When done logging set hw.ath.hal.alq=0
 160  * and then decode the file with the arcode program (that is part of the
 161  * HAL).  If you start+stop tracing the data will be appended to an
 162  * existing file.
 163  *
 164  * NB: doesn't handle multiple devices properly; only one DEVICE record
 165  *     is emitted and the different devices are not identified.
 166  */
 167 #include <sys/alq.h>
 168 #include <sys/pcpu.h>
 169 #include <dev/netif/ath/hal/ath_hal/ah_decode.h>
 170
 171 static  struct alq *ath_hal_alq;
 172 static  int ath_hal_alq_emitdev;        /* need to emit DEVICE record */
 173 static  u_int ath_hal_alq_lost;         /* count of lost records */
 174 static  const char *ath_hal_logfile = "/tmp/ath_hal.log";
 175 static  u_int ath_hal_alq_qsize = 64*1024;
 176
 177 static int
 178 ath_hal_setlogging(int enable)
 179 {
 180         int error;
 181
 182         if (enable) {
 183                 error = alq_open(&ath_hal_alq, ath_hal_logfile,
 184                         curthread->td_ucred, ALQ_DEFAULT_CMODE,
 185                         sizeof (struct athregrec), ath_hal_alq_qsize);
 186                 ath_hal_alq_lost = 0;
 187                 ath_hal_alq_emitdev = 1;
 188                 printf("ath_hal: logging to %s enabled\n",
 189                         ath_hal_logfile);
 190         } else {
 191                 if (ath_hal_alq)
 192                         alq_close(ath_hal_alq);
 193                 ath_hal_alq = NULL;
 194                 printf("ath_hal: logging disabled\n");
 195                 error = 0;
 196         }
 197         return (error);
 198 }
 199
 200 static int
 201 sysctl_hw_ath_hal_log(SYSCTL_HANDLER_ARGS)
 202 {
 203         int error, enable;
 204
 205         enable = (ath_hal_alq != NULL);
 206         error = sysctl_handle_int(oidp, &enable, 0, req);
 207         if (error || !req->newptr)
 208                 return (error);
 209         else
 210                 return (ath_hal_setlogging(enable));
 211 }
 212 SYSCTL_PROC(_hw_ath_hal, OID_AUTO, alq, CTLTYPE_INT|CTLFLAG_RW,
 213         0, 0, sysctl_hw_ath_hal_log, "I", "Enable HAL register logging");
 214 SYSCTL_INT(_hw_ath_hal, OID_AUTO, alq_size, CTLFLAG_RW,
 215         &ath_hal_alq_qsize, 0, "In-memory log size (#records)");
 216 SYSCTL_INT(_hw_ath_hal, OID_AUTO, alq_lost, CTLFLAG_RW,
 217         &ath_hal_alq_lost, 0, "Register operations not logged");
 218
 219 static struct ale *
 220 ath_hal_alq_get(struct ath_hal *ah)
 221 {
 222         struct ale *ale;
 223
 224         if (ath_hal_alq_emitdev) {
 225                 ale = alq_get(ath_hal_alq, ALQ_NOWAIT);
 226                 if (ale) {
 227                         struct athregrec *r =
 228                                 (struct athregrec *) ale->ae_data;
 229                         r->op = OP_DEVICE;
 230                         r->reg = 0;
 231                         r->val = ah->ah_devid;
 232                         alq_post(ath_hal_alq, ale);
 233                         ath_hal_alq_emitdev = 0;
 234                 } else
 235                         ath_hal_alq_lost++;
 236         }
 237         ale = alq_get(ath_hal_alq, ALQ_NOWAIT);
 238         if (!ale)
 239                 ath_hal_alq_lost++;
 240         return ale;
 241 }
 242
 243 void
 244 ath_hal_reg_write(struct ath_hal *ah, u_int32_t reg, u_int32_t val)
 245 {
 246         bus_space_tag_t tag = BUSTAG(ah);
 247         bus_space_handle_t h = ah->ah_sh;
 248
 249         if (ath_hal_alq) {
 250                 struct ale *ale = ath_hal_alq_get(ah);
 251                 if (ale) {
 252                         struct athregrec *r = (struct athregrec *) ale->ae_data;
 253                         r->op = OP_WRITE;
 254                         r->reg = reg;
 255                         r->val = val;
 256                         alq_post(ath_hal_alq, ale);
 257                 }
 258         }
 259 #if _BYTE_ORDER == _BIG_ENDIAN
 260         if (OS_REG_UNSWAPPED(reg))
 261                 bus_space_write_4(tag, h, reg, val);
 262         else
 263 #endif
 264                 bus_space_write_stream_4(tag, h, reg, val);
 265 }
 266
 267 u_int32_t
 268 ath_hal_reg_read(struct ath_hal *ah, u_int32_t reg)
 269 {
 270         bus_space_tag_t tag = BUSTAG(ah);
 271         bus_space_handle_t h = ah->ah_sh;
 272         u_int32_t val;
 273
 274 #if _BYTE_ORDER == _BIG_ENDIAN
 275         if (OS_REG_UNSWAPPED(reg))
 276                 val = bus_space_read_4(tag, h, reg);
 277         else
 278 #endif
 279                 val = bus_space_read_stream_4(tag, h, reg);
 280         if (ath_hal_alq) {
 281                 struct ale *ale = ath_hal_alq_get(ah);
 282                 if (ale) {
 283                         struct athregrec *r = (struct athregrec *) ale->ae_data;
 284                         r->op = OP_READ;
 285                         r->reg = reg;
 286                         r->val = val;
 287                         alq_post(ath_hal_alq, ale);
 288                 }
 289         }
 290         return val;
 291 }
 292
 293 void
 294 OS_MARK(struct ath_hal *ah, u_int id, u_int32_t v)
 295 {
 296         if (ath_hal_alq) {
 297                 struct ale *ale = ath_hal_alq_get(ah);
 298                 if (ale) {
 299                         struct athregrec *r = (struct athregrec *) ale->ae_data;
 300                         r->op = OP_MARK;
 301                         r->reg = id;
 302                         r->val = v;
 303                         alq_post(ath_hal_alq, ale);
 304                 }
 305         }
 306 }
 307 #elif defined(AH_DEBUG) || defined(AH_REGOPS_FUNC)
 308 /*
 309  * Memory-mapped device register read/write.  These are here
 310  * as routines when debugging support is enabled and/or when
 311  * explicitly configured to use function calls.  The latter is
 312  * for architectures that might need to do something before
 313  * referencing memory (e.g. remap an i/o window).
 314  *
 315  * NB: see the comments in ah_osdep.h about byte-swapping register
 316  *     reads and writes to understand what's going on below.
 317  */
 318
 319 void
 320 ath_hal_reg_write(struct ath_hal *ah, u_int32_t reg, u_int32_t val)
 321 {
 322         bus_space_tag_t tag = BUSTAG(ah);
 323         bus_space_handle_t h = ah->ah_sh;
 324
 325 #if _BYTE_ORDER == _BIG_ENDIAN
 326         if (OS_REG_UNSWAPPED(reg))
 327                 bus_space_write_4(tag, h, reg, val);
 328         else
 329 #endif
 330                 bus_space_write_stream_4(tag, h, reg, val);
 331 }
 332
 333 u_int32_t
 334 ath_hal_reg_read(struct ath_hal *ah, u_int32_t reg)
 335 {
 336         bus_space_tag_t tag = BUSTAG(ah);
 337         bus_space_handle_t h = ah->ah_sh;
 338         u_int32_t val;
 339
 340 #if _BYTE_ORDER == _BIG_ENDIAN
 341         if (OS_REG_UNSWAPPED(reg))
 342                 val = bus_space_read_4(tag, h, reg);
 343         else
 344 #endif
 345                 val = bus_space_read_stream_4(tag, h, reg);
 346         return val;
 347 }
 348 #endif /* AH_DEBUG || AH_REGOPS_FUNC */
 349
 350 #ifdef AH_ASSERT
 351 void
 352 ath_hal_assert_failed(const char* filename, int lineno, const char *msg)
 353 {
 354         printf("Atheros HAL assertion failure: %s: line %u: %s\n",
 355                 filename, lineno, msg);
 356         panic("ath_hal_assert");
 357 }
 358 #endif /* AH_ASSERT */
 359
 360 /*
 361  * Module glue.
 362  */
 363 static int
 364 ath_hal_modevent(module_t mod, int type, void *unused)
 365 {
 366         switch (type) {
 367         case MOD_LOAD:
 368                 return 0;
 369         case MOD_UNLOAD:
 370                 return 0;
 371         }
 372
 373         return EINVAL;
 374 }
 375
 376 static moduledata_t ath_hal_mod = {
 377         "ath_hal",
 378         ath_hal_modevent,
 379         0
 380 };
 381
 382 DECLARE_MODULE(ath_hal, ath_hal_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
 383 MODULE_VERSION(ath_hal, 1);