ah_osdep.c revision 227293
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 227293 2011-11-07 06:44:47Z ed $ 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> 41162413Ssam 42162413Ssam#include <machine/stdarg.h> 43162413Ssam 44162413Ssam#include <net/ethernet.h> /* XXX for ether_sprintf */ 45162413Ssam 46185522Ssam#include <dev/ath/ath_hal/ah.h> 47162413Ssam 48162413Ssam/* 49162413Ssam * WiSoC boards overload the bus tag with information about the 50162413Ssam * board layout. We must extract the bus space tag from that 51162413Ssam * indirect structure. For everyone else the tag is passed in 52162413Ssam * directly. 53162413Ssam * XXX cache indirect ref privately 54162413Ssam */ 55162413Ssam#ifdef AH_SUPPORT_AR5312 56162413Ssam#define BUSTAG(ah) \ 57162413Ssam ((bus_space_tag_t) ((struct ar531x_config *)((ah)->ah_st))->tag) 58162413Ssam#else 59185522Ssam#define BUSTAG(ah) ((ah)->ah_st) 60162413Ssam#endif 61162413Ssam 62162413Ssamextern void ath_hal_printf(struct ath_hal *, const char*, ...) 63162413Ssam __printflike(2,3); 64162413Ssamextern void ath_hal_vprintf(struct ath_hal *, const char*, __va_list) 65162413Ssam __printflike(2, 0); 66162413Ssamextern const char* ath_hal_ether_sprintf(const u_int8_t *mac); 67162413Ssamextern void *ath_hal_malloc(size_t); 68162413Ssamextern void ath_hal_free(void *); 69162413Ssam#ifdef AH_ASSERT 70162413Ssamextern void ath_hal_assert_failed(const char* filename, 71162413Ssam int lineno, const char* msg); 72162413Ssam#endif 73162413Ssam#ifdef AH_DEBUG 74219315Sadrianextern void DO_HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...); 75162413Ssam#endif /* AH_DEBUG */ 76162413Ssam 77162413Ssam/* NB: put this here instead of the driver to avoid circular references */ 78162413SsamSYSCTL_NODE(_hw, OID_AUTO, ath, CTLFLAG_RD, 0, "Atheros driver parameters"); 79223525SadrianSYSCTL_NODE(_hw_ath, OID_AUTO, hal, CTLFLAG_RD, 0, "Atheros HAL parameters"); 80162413Ssam 81223525Sadrian#ifdef AH_DEBUG 82223525Sadrianint ath_hal_debug = 0; 83223525SadrianSYSCTL_INT(_hw_ath_hal, OID_AUTO, debug, CTLFLAG_RW, &ath_hal_debug, 84223525Sadrian 0, "Atheros HAL debugging printfs"); 85223525SadrianTUNABLE_INT("hw.ath.hal.debug", &ath_hal_debug); 86223525Sadrian#endif /* AH_DEBUG */ 87223525Sadrian 88227293Sedstatic MALLOC_DEFINE(M_ATH_HAL, "ath_hal", "ath hal data"); 89162413Ssam 90162413Ssamvoid* 91162413Ssamath_hal_malloc(size_t size) 92162413Ssam{ 93162413Ssam return malloc(size, M_ATH_HAL, M_NOWAIT | M_ZERO); 94162413Ssam} 95162413Ssam 96162413Ssamvoid 97162413Ssamath_hal_free(void* p) 98162413Ssam{ 99196935Ssam free(p, M_ATH_HAL); 100162413Ssam} 101162413Ssam 102162413Ssamvoid 103162413Ssamath_hal_vprintf(struct ath_hal *ah, const char* fmt, va_list ap) 104162413Ssam{ 105162413Ssam vprintf(fmt, ap); 106162413Ssam} 107162413Ssam 108162413Ssamvoid 109162413Ssamath_hal_printf(struct ath_hal *ah, const char* fmt, ...) 110162413Ssam{ 111162413Ssam va_list ap; 112162413Ssam va_start(ap, fmt); 113162413Ssam ath_hal_vprintf(ah, fmt, ap); 114162413Ssam va_end(ap); 115162413Ssam} 116162413Ssam 117162413Ssamconst char* 118162413Ssamath_hal_ether_sprintf(const u_int8_t *mac) 119162413Ssam{ 120162413Ssam return ether_sprintf(mac); 121162413Ssam} 122162413Ssam 123162413Ssam#ifdef AH_DEBUG 124222031Sadrian 125222031Sadrian/* This must match the definition in ath_hal/ah_debug.h */ 126222031Sadrian#define HAL_DEBUG_UNMASKABLE 0xf0000000 127162413Ssamvoid 128219315SadrianDO_HALDEBUG(struct ath_hal *ah, u_int mask, const char* fmt, ...) 129184369Ssam{ 130224045Sadrian if ((mask == HAL_DEBUG_UNMASKABLE) || 131225883Sadrian (ah != NULL && ah->ah_config.ah_debug & mask) || 132224045Sadrian (ath_hal_debug & mask)) { 133184369Ssam __va_list ap; 134184369Ssam va_start(ap, fmt); 135184369Ssam ath_hal_vprintf(ah, fmt, ap); 136184369Ssam va_end(ap); 137184369Ssam } 138184369Ssam} 139222031Sadrian#undef HAL_DEBUG_UNMASKABLE 140162413Ssam#endif /* AH_DEBUG */ 141162413Ssam 142162413Ssam#ifdef AH_DEBUG_ALQ 143162413Ssam/* 144162413Ssam * ALQ register tracing support. 145162413Ssam * 146162413Ssam * Setting hw.ath.hal.alq=1 enables tracing of all register reads and 147162413Ssam * writes to the file /tmp/ath_hal.log. The file format is a simple 148162413Ssam * fixed-size array of records. When done logging set hw.ath.hal.alq=0 149162413Ssam * and then decode the file with the arcode program (that is part of the 150162413Ssam * HAL). If you start+stop tracing the data will be appended to an 151162413Ssam * existing file. 152162413Ssam * 153162413Ssam * NB: doesn't handle multiple devices properly; only one DEVICE record 154162413Ssam * is emitted and the different devices are not identified. 155162413Ssam */ 156162413Ssam#include <sys/alq.h> 157162413Ssam#include <sys/pcpu.h> 158185522Ssam#include <dev/ath/ath_hal/ah_decode.h> 159162413Ssam 160162413Ssamstatic struct alq *ath_hal_alq; 161162413Ssamstatic int ath_hal_alq_emitdev; /* need to emit DEVICE record */ 162162413Ssamstatic u_int ath_hal_alq_lost; /* count of lost records */ 163220367Sadrianstatic char ath_hal_logfile[MAXPATHLEN] = "/tmp/ath_hal.log"; 164220367Sadrian 165220367SadrianSYSCTL_STRING(_hw_ath_hal, OID_AUTO, alq_logfile, CTLFLAG_RW, 166220367Sadrian &ath_hal_logfile, sizeof(kernelname), "Name of ALQ logfile"); 167220367Sadrian 168162413Ssamstatic u_int ath_hal_alq_qsize = 64*1024; 169162413Ssam 170162413Ssamstatic int 171162413Ssamath_hal_setlogging(int enable) 172162413Ssam{ 173162413Ssam int error; 174162413Ssam 175162413Ssam if (enable) { 176168589Srwatson error = alq_open(&ath_hal_alq, ath_hal_logfile, 177168589Srwatson curthread->td_ucred, ALQ_DEFAULT_CMODE, 178168589Srwatson sizeof (struct athregrec), ath_hal_alq_qsize); 179168589Srwatson ath_hal_alq_lost = 0; 180168589Srwatson ath_hal_alq_emitdev = 1; 181168589Srwatson printf("ath_hal: logging to %s enabled\n", 182168589Srwatson ath_hal_logfile); 183162413Ssam } else { 184162413Ssam if (ath_hal_alq) 185162413Ssam alq_close(ath_hal_alq); 186162413Ssam ath_hal_alq = NULL; 187162413Ssam printf("ath_hal: logging disabled\n"); 188162413Ssam error = 0; 189162413Ssam } 190162413Ssam return (error); 191162413Ssam} 192162413Ssam 193162413Ssamstatic int 194162413Ssamsysctl_hw_ath_hal_log(SYSCTL_HANDLER_ARGS) 195162413Ssam{ 196162413Ssam int error, enable; 197162413Ssam 198162413Ssam enable = (ath_hal_alq != NULL); 199162413Ssam error = sysctl_handle_int(oidp, &enable, 0, req); 200162413Ssam if (error || !req->newptr) 201162413Ssam return (error); 202162413Ssam else 203162413Ssam return (ath_hal_setlogging(enable)); 204162413Ssam} 205162413SsamSYSCTL_PROC(_hw_ath_hal, OID_AUTO, alq, CTLTYPE_INT|CTLFLAG_RW, 206162413Ssam 0, 0, sysctl_hw_ath_hal_log, "I", "Enable HAL register logging"); 207162413SsamSYSCTL_INT(_hw_ath_hal, OID_AUTO, alq_size, CTLFLAG_RW, 208162413Ssam &ath_hal_alq_qsize, 0, "In-memory log size (#records)"); 209162413SsamSYSCTL_INT(_hw_ath_hal, OID_AUTO, alq_lost, CTLFLAG_RW, 210162413Ssam &ath_hal_alq_lost, 0, "Register operations not logged"); 211162413Ssam 212162413Ssamstatic struct ale * 213162413Ssamath_hal_alq_get(struct ath_hal *ah) 214162413Ssam{ 215162413Ssam struct ale *ale; 216162413Ssam 217162413Ssam if (ath_hal_alq_emitdev) { 218162413Ssam ale = alq_get(ath_hal_alq, ALQ_NOWAIT); 219162413Ssam if (ale) { 220162413Ssam struct athregrec *r = 221162413Ssam (struct athregrec *) ale->ae_data; 222162413Ssam r->op = OP_DEVICE; 223162413Ssam r->reg = 0; 224162413Ssam r->val = ah->ah_devid; 225162413Ssam alq_post(ath_hal_alq, ale); 226162413Ssam ath_hal_alq_emitdev = 0; 227162413Ssam } else 228162413Ssam ath_hal_alq_lost++; 229162413Ssam } 230162413Ssam ale = alq_get(ath_hal_alq, ALQ_NOWAIT); 231162413Ssam if (!ale) 232162413Ssam ath_hal_alq_lost++; 233162413Ssam return ale; 234162413Ssam} 235162413Ssam 236162413Ssamvoid 237162413Ssamath_hal_reg_write(struct ath_hal *ah, u_int32_t reg, u_int32_t val) 238162413Ssam{ 239162413Ssam bus_space_tag_t tag = BUSTAG(ah); 240185522Ssam bus_space_handle_t h = ah->ah_sh; 241162413Ssam 242162413Ssam if (ath_hal_alq) { 243162413Ssam struct ale *ale = ath_hal_alq_get(ah); 244162413Ssam if (ale) { 245162413Ssam struct athregrec *r = (struct athregrec *) ale->ae_data; 246162413Ssam r->op = OP_WRITE; 247162413Ssam r->reg = reg; 248162413Ssam r->val = val; 249162413Ssam alq_post(ath_hal_alq, ale); 250162413Ssam } 251162413Ssam } 252162413Ssam#if _BYTE_ORDER == _BIG_ENDIAN 253195418Ssam if (OS_REG_UNSWAPPED(reg)) 254162413Ssam bus_space_write_4(tag, h, reg, val); 255162413Ssam else 256162413Ssam#endif 257162413Ssam bus_space_write_stream_4(tag, h, reg, val); 258162413Ssam} 259162413Ssam 260162413Ssamu_int32_t 261162413Ssamath_hal_reg_read(struct ath_hal *ah, u_int32_t reg) 262162413Ssam{ 263162413Ssam bus_space_tag_t tag = BUSTAG(ah); 264185522Ssam bus_space_handle_t h = ah->ah_sh; 265162413Ssam u_int32_t val; 266162413Ssam 267162413Ssam#if _BYTE_ORDER == _BIG_ENDIAN 268195418Ssam if (OS_REG_UNSWAPPED(reg)) 269162413Ssam val = bus_space_read_4(tag, h, reg); 270162413Ssam else 271162413Ssam#endif 272162413Ssam val = bus_space_read_stream_4(tag, h, reg); 273162413Ssam if (ath_hal_alq) { 274162413Ssam struct ale *ale = ath_hal_alq_get(ah); 275162413Ssam if (ale) { 276162413Ssam struct athregrec *r = (struct athregrec *) ale->ae_data; 277162413Ssam r->op = OP_READ; 278162413Ssam r->reg = reg; 279162413Ssam r->val = val; 280162413Ssam alq_post(ath_hal_alq, ale); 281162413Ssam } 282162413Ssam } 283162413Ssam return val; 284162413Ssam} 285162413Ssam 286162413Ssamvoid 287162413SsamOS_MARK(struct ath_hal *ah, u_int id, u_int32_t v) 288162413Ssam{ 289162413Ssam if (ath_hal_alq) { 290162413Ssam struct ale *ale = ath_hal_alq_get(ah); 291162413Ssam if (ale) { 292162413Ssam struct athregrec *r = (struct athregrec *) ale->ae_data; 293162413Ssam r->op = OP_MARK; 294162413Ssam r->reg = id; 295162413Ssam r->val = v; 296162413Ssam alq_post(ath_hal_alq, ale); 297162413Ssam } 298162413Ssam } 299162413Ssam} 300162413Ssam#elif defined(AH_DEBUG) || defined(AH_REGOPS_FUNC) 301162413Ssam/* 302162413Ssam * Memory-mapped device register read/write. These are here 303162413Ssam * as routines when debugging support is enabled and/or when 304162413Ssam * explicitly configured to use function calls. The latter is 305162413Ssam * for architectures that might need to do something before 306162413Ssam * referencing memory (e.g. remap an i/o window). 307162413Ssam * 308162413Ssam * NB: see the comments in ah_osdep.h about byte-swapping register 309162413Ssam * reads and writes to understand what's going on below. 310162413Ssam */ 311162413Ssam 312162413Ssamvoid 313162413Ssamath_hal_reg_write(struct ath_hal *ah, u_int32_t reg, u_int32_t val) 314162413Ssam{ 315162413Ssam bus_space_tag_t tag = BUSTAG(ah); 316185522Ssam bus_space_handle_t h = ah->ah_sh; 317162413Ssam 318162413Ssam#if _BYTE_ORDER == _BIG_ENDIAN 319195418Ssam if (OS_REG_UNSWAPPED(reg)) 320162413Ssam bus_space_write_4(tag, h, reg, val); 321162413Ssam else 322162413Ssam#endif 323162413Ssam bus_space_write_stream_4(tag, h, reg, val); 324162413Ssam} 325162413Ssam 326162413Ssamu_int32_t 327162413Ssamath_hal_reg_read(struct ath_hal *ah, u_int32_t reg) 328162413Ssam{ 329162413Ssam bus_space_tag_t tag = BUSTAG(ah); 330185522Ssam bus_space_handle_t h = ah->ah_sh; 331162413Ssam u_int32_t val; 332162413Ssam 333162413Ssam#if _BYTE_ORDER == _BIG_ENDIAN 334195418Ssam if (OS_REG_UNSWAPPED(reg)) 335162413Ssam val = bus_space_read_4(tag, h, reg); 336162413Ssam else 337162413Ssam#endif 338162413Ssam val = bus_space_read_stream_4(tag, h, reg); 339162413Ssam return val; 340162413Ssam} 341162413Ssam#endif /* AH_DEBUG || AH_REGOPS_FUNC */ 342162413Ssam 343162413Ssam#ifdef AH_ASSERT 344162413Ssamvoid 345162413Ssamath_hal_assert_failed(const char* filename, int lineno, const char *msg) 346162413Ssam{ 347162413Ssam printf("Atheros HAL assertion failure: %s: line %u: %s\n", 348162413Ssam filename, lineno, msg); 349162413Ssam panic("ath_hal_assert"); 350162413Ssam} 351162413Ssam#endif /* AH_ASSERT */ 352