ah_osdep.c revision 237864
1162413Ssam/*- 2178354Ssam * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting 3162413Ssam * All rights reserved. 4162413Ssam * 5162413Ssam * Redistribution and use in source and binary forms, with or without 6162413Ssam * modification, are permitted provided that the following conditions 7162413Ssam * are met: 8162413Ssam * 1. Redistributions of source code must retain the above copyright 9162413Ssam * notice, this list of conditions and the following disclaimer, 10162413Ssam * without modification. 11162413Ssam * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12162413Ssam * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 13162413Ssam * redistribution must be conditioned upon including a substantially 14162413Ssam * similar Disclaimer requirement for further binary redistribution. 15162413Ssam * 16162413Ssam * NO WARRANTY 17162413Ssam * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18162413Ssam * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19162413Ssam * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 20162413Ssam * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 21162413Ssam * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 22162413Ssam * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23162413Ssam * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24162413Ssam * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25162413Ssam * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26162413Ssam * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 27162413Ssam * THE POSSIBILITY OF SUCH DAMAGES. 28162413Ssam * 29162413Ssam * $FreeBSD: head/sys/dev/ath/ah_osdep.c 237864 2012-07-01 02:34:32Z adrian $ 30162413Ssam */ 31162413Ssam#include "opt_ah.h" 32162413Ssam 33162413Ssam#include <sys/param.h> 34162413Ssam#include <sys/systm.h> 35162413Ssam#include <sys/kernel.h> 36162413Ssam#include <sys/module.h> 37162413Ssam#include <sys/sysctl.h> 38162413Ssam#include <sys/bus.h> 39162413Ssam#include <sys/malloc.h> 40162413Ssam#include <sys/proc.h> 41233887Sadrian#include <sys/pcpu.h> 42227410Sadrian#include <sys/lock.h> 43227410Sadrian#include <sys/mutex.h> 44162413Ssam 45162413Ssam#include <machine/stdarg.h> 46162413Ssam 47162413Ssam#include <net/ethernet.h> /* XXX for ether_sprintf */ 48162413Ssam 49185522Ssam#include <dev/ath/ath_hal/ah.h> 50237864Sadrian#include <dev/ath/ath_hal/ah_debug.h> 51162413Ssam 52162413Ssam/* 53162413Ssam * WiSoC boards overload the bus tag with information about the 54162413Ssam * board layout. We must extract the bus space tag from that 55162413Ssam * indirect structure. For everyone else the tag is passed in 56162413Ssam * directly. 57162413Ssam * XXX cache indirect ref privately 58162413Ssam */ 59162413Ssam#ifdef AH_SUPPORT_AR5312 60162413Ssam#define BUSTAG(ah) \ 61162413Ssam ((bus_space_tag_t) ((struct ar531x_config *)((ah)->ah_st))->tag) 62162413Ssam#else 63185522Ssam#define BUSTAG(ah) ((ah)->ah_st) 64162413Ssam#endif 65162413Ssam 66227410Sadrian/* 67227410Sadrian * This lock is used to seralise register access for chips which have 68227410Sadrian * problems w/ SMP CPUs issuing concurrent PCI transactions. 69227410Sadrian * 70227410Sadrian * XXX This is a global lock for now; it should be pushed to 71227410Sadrian * a per-device lock in some platform-independent fashion. 72227410Sadrian */ 73227410Sadrianstruct mtx ah_regser_mtx; 74227410SadrianMTX_SYSINIT(ah_regser, &ah_regser_mtx, "Atheros register access mutex", 75227410Sadrian MTX_SPIN); 76227410Sadrian 77162413Ssamextern void ath_hal_printf(struct ath_hal *, const char*, ...) 78162413Ssam __printflike(2,3); 79162413Ssamextern void ath_hal_vprintf(struct ath_hal *, const char*, __va_list) 80162413Ssam __printflike(2, 0); 81162413Ssamextern const char* ath_hal_ether_sprintf(const u_int8_t *mac); 82162413Ssamextern void *ath_hal_malloc(size_t); 83162413Ssamextern void ath_hal_free(void *); 84162413Ssam#ifdef AH_ASSERT 85162413Ssamextern void ath_hal_assert_failed(const char* filename, 86162413Ssam int lineno, const char* msg); 87162413Ssam#endif 88162413Ssam#ifdef AH_DEBUG 89219315Sadrianextern void DO_HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...); 90162413Ssam#endif /* AH_DEBUG */ 91162413Ssam 92162413Ssam/* NB: put this here instead of the driver to avoid circular references */ 93162413SsamSYSCTL_NODE(_hw, OID_AUTO, ath, CTLFLAG_RD, 0, "Atheros driver parameters"); 94227309Sedstatic SYSCTL_NODE(_hw_ath, OID_AUTO, hal, CTLFLAG_RD, 0, 95227309Sed "Atheros HAL parameters"); 96162413Ssam 97223525Sadrian#ifdef AH_DEBUG 98223525Sadrianint ath_hal_debug = 0; 99223525SadrianSYSCTL_INT(_hw_ath_hal, OID_AUTO, debug, CTLFLAG_RW, &ath_hal_debug, 100223525Sadrian 0, "Atheros HAL debugging printfs"); 101223525SadrianTUNABLE_INT("hw.ath.hal.debug", &ath_hal_debug); 102223525Sadrian#endif /* AH_DEBUG */ 103223525Sadrian 104227293Sedstatic MALLOC_DEFINE(M_ATH_HAL, "ath_hal", "ath hal data"); 105162413Ssam 106162413Ssamvoid* 107162413Ssamath_hal_malloc(size_t size) 108162413Ssam{ 109162413Ssam return malloc(size, M_ATH_HAL, M_NOWAIT | M_ZERO); 110162413Ssam} 111162413Ssam 112162413Ssamvoid 113162413Ssamath_hal_free(void* p) 114162413Ssam{ 115196935Ssam free(p, M_ATH_HAL); 116162413Ssam} 117162413Ssam 118162413Ssamvoid 119162413Ssamath_hal_vprintf(struct ath_hal *ah, const char* fmt, va_list ap) 120162413Ssam{ 121162413Ssam vprintf(fmt, ap); 122162413Ssam} 123162413Ssam 124162413Ssamvoid 125162413Ssamath_hal_printf(struct ath_hal *ah, const char* fmt, ...) 126162413Ssam{ 127162413Ssam va_list ap; 128162413Ssam va_start(ap, fmt); 129162413Ssam ath_hal_vprintf(ah, fmt, ap); 130162413Ssam va_end(ap); 131162413Ssam} 132162413Ssam 133162413Ssamconst char* 134162413Ssamath_hal_ether_sprintf(const u_int8_t *mac) 135162413Ssam{ 136162413Ssam return ether_sprintf(mac); 137162413Ssam} 138162413Ssam 139162413Ssam#ifdef AH_DEBUG 140222031Sadrian 141162413Ssamvoid 142219315SadrianDO_HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...) 143184369Ssam{ 144224045Sadrian if ((mask == HAL_DEBUG_UNMASKABLE) || 145225883Sadrian (ah != NULL && ah->ah_config.ah_debug & mask) || 146224045Sadrian (ath_hal_debug & mask)) { 147184369Ssam __va_list ap; 148184369Ssam va_start(ap, fmt); 149184369Ssam ath_hal_vprintf(ah, fmt, ap); 150184369Ssam va_end(ap); 151184369Ssam } 152184369Ssam} 153222031Sadrian#undef HAL_DEBUG_UNMASKABLE 154162413Ssam#endif /* AH_DEBUG */ 155162413Ssam 156162413Ssam#ifdef AH_DEBUG_ALQ 157162413Ssam/* 158162413Ssam * ALQ register tracing support. 159162413Ssam * 160162413Ssam * Setting hw.ath.hal.alq=1 enables tracing of all register reads and 161162413Ssam * writes to the file /tmp/ath_hal.log. The file format is a simple 162162413Ssam * fixed-size array of records. When done logging set hw.ath.hal.alq=0 163162413Ssam * and then decode the file with the arcode program (that is part of the 164162413Ssam * HAL). If you start+stop tracing the data will be appended to an 165162413Ssam * existing file. 166162413Ssam * 167162413Ssam * NB: doesn't handle multiple devices properly; only one DEVICE record 168162413Ssam * is emitted and the different devices are not identified. 169162413Ssam */ 170162413Ssam#include <sys/alq.h> 171162413Ssam#include <sys/pcpu.h> 172185522Ssam#include <dev/ath/ath_hal/ah_decode.h> 173162413Ssam 174162413Ssamstatic struct alq *ath_hal_alq; 175162413Ssamstatic int ath_hal_alq_emitdev; /* need to emit DEVICE record */ 176162413Ssamstatic u_int ath_hal_alq_lost; /* count of lost records */ 177220367Sadrianstatic char ath_hal_logfile[MAXPATHLEN] = "/tmp/ath_hal.log"; 178220367Sadrian 179220367SadrianSYSCTL_STRING(_hw_ath_hal, OID_AUTO, alq_logfile, CTLFLAG_RW, 180220367Sadrian &ath_hal_logfile, sizeof(kernelname), "Name of ALQ logfile"); 181220367Sadrian 182162413Ssamstatic u_int ath_hal_alq_qsize = 64*1024; 183162413Ssam 184162413Ssamstatic int 185162413Ssamath_hal_setlogging(int enable) 186162413Ssam{ 187162413Ssam int error; 188162413Ssam 189162413Ssam if (enable) { 190168589Srwatson error = alq_open(&ath_hal_alq, ath_hal_logfile, 191168589Srwatson curthread->td_ucred, ALQ_DEFAULT_CMODE, 192168589Srwatson sizeof (struct athregrec), ath_hal_alq_qsize); 193168589Srwatson ath_hal_alq_lost = 0; 194168589Srwatson ath_hal_alq_emitdev = 1; 195168589Srwatson printf("ath_hal: logging to %s enabled\n", 196168589Srwatson ath_hal_logfile); 197162413Ssam } else { 198162413Ssam if (ath_hal_alq) 199162413Ssam alq_close(ath_hal_alq); 200162413Ssam ath_hal_alq = NULL; 201162413Ssam printf("ath_hal: logging disabled\n"); 202162413Ssam error = 0; 203162413Ssam } 204162413Ssam return (error); 205162413Ssam} 206162413Ssam 207162413Ssamstatic int 208162413Ssamsysctl_hw_ath_hal_log(SYSCTL_HANDLER_ARGS) 209162413Ssam{ 210162413Ssam int error, enable; 211162413Ssam 212162413Ssam enable = (ath_hal_alq != NULL); 213162413Ssam error = sysctl_handle_int(oidp, &enable, 0, req); 214162413Ssam if (error || !req->newptr) 215162413Ssam return (error); 216162413Ssam else 217162413Ssam return (ath_hal_setlogging(enable)); 218162413Ssam} 219162413SsamSYSCTL_PROC(_hw_ath_hal, OID_AUTO, alq, CTLTYPE_INT|CTLFLAG_RW, 220162413Ssam 0, 0, sysctl_hw_ath_hal_log, "I", "Enable HAL register logging"); 221162413SsamSYSCTL_INT(_hw_ath_hal, OID_AUTO, alq_size, CTLFLAG_RW, 222162413Ssam &ath_hal_alq_qsize, 0, "In-memory log size (#records)"); 223162413SsamSYSCTL_INT(_hw_ath_hal, OID_AUTO, alq_lost, CTLFLAG_RW, 224162413Ssam &ath_hal_alq_lost, 0, "Register operations not logged"); 225162413Ssam 226162413Ssamstatic struct ale * 227162413Ssamath_hal_alq_get(struct ath_hal *ah) 228162413Ssam{ 229162413Ssam struct ale *ale; 230162413Ssam 231162413Ssam if (ath_hal_alq_emitdev) { 232162413Ssam ale = alq_get(ath_hal_alq, ALQ_NOWAIT); 233162413Ssam if (ale) { 234162413Ssam struct athregrec *r = 235162413Ssam (struct athregrec *) ale->ae_data; 236162413Ssam r->op = OP_DEVICE; 237162413Ssam r->reg = 0; 238162413Ssam r->val = ah->ah_devid; 239162413Ssam alq_post(ath_hal_alq, ale); 240162413Ssam ath_hal_alq_emitdev = 0; 241162413Ssam } else 242162413Ssam ath_hal_alq_lost++; 243162413Ssam } 244162413Ssam ale = alq_get(ath_hal_alq, ALQ_NOWAIT); 245162413Ssam if (!ale) 246162413Ssam ath_hal_alq_lost++; 247162413Ssam return ale; 248162413Ssam} 249162413Ssam 250162413Ssamvoid 251162413Ssamath_hal_reg_write(struct ath_hal *ah, u_int32_t reg, u_int32_t val) 252162413Ssam{ 253162413Ssam bus_space_tag_t tag = BUSTAG(ah); 254185522Ssam bus_space_handle_t h = ah->ah_sh; 255162413Ssam 256162413Ssam if (ath_hal_alq) { 257162413Ssam struct ale *ale = ath_hal_alq_get(ah); 258162413Ssam if (ale) { 259162413Ssam struct athregrec *r = (struct athregrec *) ale->ae_data; 260233887Sadrian r->threadid = curthread->td_tid; 261162413Ssam r->op = OP_WRITE; 262162413Ssam r->reg = reg; 263162413Ssam r->val = val; 264162413Ssam alq_post(ath_hal_alq, ale); 265162413Ssam } 266162413Ssam } 267227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 268227410Sadrian mtx_lock_spin(&ah_regser_mtx); 269234450Sadrian bus_space_write_4(tag, h, reg, val); 270227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 271227410Sadrian mtx_unlock_spin(&ah_regser_mtx); 272162413Ssam} 273162413Ssam 274162413Ssamu_int32_t 275162413Ssamath_hal_reg_read(struct ath_hal *ah, u_int32_t reg) 276162413Ssam{ 277162413Ssam bus_space_tag_t tag = BUSTAG(ah); 278185522Ssam bus_space_handle_t h = ah->ah_sh; 279162413Ssam u_int32_t val; 280162413Ssam 281227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 282227410Sadrian mtx_lock_spin(&ah_regser_mtx); 283234450Sadrian val = bus_space_read_4(tag, h, reg); 284227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 285227410Sadrian mtx_unlock_spin(&ah_regser_mtx); 286162413Ssam if (ath_hal_alq) { 287162413Ssam struct ale *ale = ath_hal_alq_get(ah); 288162413Ssam if (ale) { 289162413Ssam struct athregrec *r = (struct athregrec *) ale->ae_data; 290233887Sadrian r->threadid = curthread->td_tid; 291162413Ssam r->op = OP_READ; 292162413Ssam r->reg = reg; 293162413Ssam r->val = val; 294162413Ssam alq_post(ath_hal_alq, ale); 295162413Ssam } 296162413Ssam } 297162413Ssam return val; 298162413Ssam} 299162413Ssam 300162413Ssamvoid 301162413SsamOS_MARK(struct ath_hal *ah, u_int id, u_int32_t v) 302162413Ssam{ 303162413Ssam if (ath_hal_alq) { 304162413Ssam struct ale *ale = ath_hal_alq_get(ah); 305162413Ssam if (ale) { 306162413Ssam struct athregrec *r = (struct athregrec *) ale->ae_data; 307233887Sadrian r->threadid = curthread->td_tid; 308162413Ssam r->op = OP_MARK; 309162413Ssam r->reg = id; 310162413Ssam r->val = v; 311162413Ssam alq_post(ath_hal_alq, ale); 312162413Ssam } 313162413Ssam } 314162413Ssam} 315162413Ssam#elif defined(AH_DEBUG) || defined(AH_REGOPS_FUNC) 316162413Ssam/* 317162413Ssam * Memory-mapped device register read/write. These are here 318162413Ssam * as routines when debugging support is enabled and/or when 319162413Ssam * explicitly configured to use function calls. The latter is 320162413Ssam * for architectures that might need to do something before 321162413Ssam * referencing memory (e.g. remap an i/o window). 322162413Ssam * 323162413Ssam * NB: see the comments in ah_osdep.h about byte-swapping register 324162413Ssam * reads and writes to understand what's going on below. 325162413Ssam */ 326162413Ssam 327162413Ssamvoid 328162413Ssamath_hal_reg_write(struct ath_hal *ah, u_int32_t reg, u_int32_t val) 329162413Ssam{ 330162413Ssam bus_space_tag_t tag = BUSTAG(ah); 331185522Ssam bus_space_handle_t h = ah->ah_sh; 332162413Ssam 333227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 334227410Sadrian mtx_lock_spin(&ah_regser_mtx); 335234450Sadrian bus_space_write_4(tag, h, reg, val); 336227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 337227410Sadrian mtx_unlock_spin(&ah_regser_mtx); 338162413Ssam} 339162413Ssam 340162413Ssamu_int32_t 341162413Ssamath_hal_reg_read(struct ath_hal *ah, u_int32_t reg) 342162413Ssam{ 343162413Ssam bus_space_tag_t tag = BUSTAG(ah); 344185522Ssam bus_space_handle_t h = ah->ah_sh; 345162413Ssam u_int32_t val; 346162413Ssam 347227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 348227410Sadrian mtx_lock_spin(&ah_regser_mtx); 349234450Sadrian val = bus_space_read_4(tag, h, reg); 350227410Sadrian if (ah->ah_config.ah_serialise_reg_war) 351227410Sadrian mtx_unlock_spin(&ah_regser_mtx); 352162413Ssam return val; 353162413Ssam} 354162413Ssam#endif /* AH_DEBUG || AH_REGOPS_FUNC */ 355162413Ssam 356162413Ssam#ifdef AH_ASSERT 357162413Ssamvoid 358162413Ssamath_hal_assert_failed(const char* filename, int lineno, const char *msg) 359162413Ssam{ 360162413Ssam printf("Atheros HAL assertion failure: %s: line %u: %s\n", 361162413Ssam filename, lineno, msg); 362162413Ssam panic("ath_hal_assert"); 363162413Ssam} 364162413Ssam#endif /* AH_ASSERT */ 365