[deliverable/linux.git] / drivers / net / wireless / ath5k / debug.c

/*
 * Copyright (c) 2007-2008 Bruno Randolf <bruno@thinktube.com>
 *
 *  This file is free software: you may copy, redistribute and/or modify it
 *  under the terms of the GNU General Public License as published by the
 *  Free Software Foundation, either version 2 of the License, or (at your
 *  option) any later version.
 *
 *  This file is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
 * Copyright (c) 2004-2005 Atheros Communications, Inc.
 * Copyright (c) 2006 Devicescape Software, Inc.
 * Copyright (c) 2007 Jiri Slaby <jirislaby@gmail.com>
 * Copyright (c) 2007 Luis R. Rodriguez <mcgrof@winlab.rutgers.edu>
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
 *    redistribution must be conditioned upon including a substantially
 *    similar Disclaimer requirement for further binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGES.
 */

#include "debug.h"
#include "base.h"

static unsigned int ath5k_debug;
module_param_named(debug, ath5k_debug, uint, 0);


#ifdef CONFIG_ATH5K_DEBUG

#include <linux/seq_file.h>
#include "reg.h"

static struct dentry *ath5k_global_debugfs;

static int ath5k_debugfs_open(struct inode *inode, struct file *file)
{
	file->private_data = inode->i_private;
	return 0;
}


/* debugfs: registers */

struct reg {
	char *name;
	int addr;
};

#define REG_STRUCT_INIT(r) { #r, r }

/* just a few random registers, might want to add more */
static struct reg regs[] = {
	REG_STRUCT_INIT(AR5K_CR),
	REG_STRUCT_INIT(AR5K_RXDP),
	REG_STRUCT_INIT(AR5K_CFG),
	REG_STRUCT_INIT(AR5K_IER),
	REG_STRUCT_INIT(AR5K_BCR),
	REG_STRUCT_INIT(AR5K_RTSD0),
	REG_STRUCT_INIT(AR5K_RTSD1),
	REG_STRUCT_INIT(AR5K_TXCFG),
	REG_STRUCT_INIT(AR5K_RXCFG),
	REG_STRUCT_INIT(AR5K_RXJLA),
	REG_STRUCT_INIT(AR5K_MIBC),
	REG_STRUCT_INIT(AR5K_TOPS),
	REG_STRUCT_INIT(AR5K_RXNOFRM),
	REG_STRUCT_INIT(AR5K_TXNOFRM),
	REG_STRUCT_INIT(AR5K_RPGTO),
	REG_STRUCT_INIT(AR5K_RFCNT),
	REG_STRUCT_INIT(AR5K_MISC),
	REG_STRUCT_INIT(AR5K_QCUDCU_CLKGT),
	REG_STRUCT_INIT(AR5K_ISR),
	REG_STRUCT_INIT(AR5K_PISR),
	REG_STRUCT_INIT(AR5K_SISR0),
	REG_STRUCT_INIT(AR5K_SISR1),
	REG_STRUCT_INIT(AR5K_SISR2),
	REG_STRUCT_INIT(AR5K_SISR3),
	REG_STRUCT_INIT(AR5K_SISR4),
	REG_STRUCT_INIT(AR5K_IMR),
	REG_STRUCT_INIT(AR5K_PIMR),
	REG_STRUCT_INIT(AR5K_SIMR0),
	REG_STRUCT_INIT(AR5K_SIMR1),
	REG_STRUCT_INIT(AR5K_SIMR2),
	REG_STRUCT_INIT(AR5K_SIMR3),
	REG_STRUCT_INIT(AR5K_SIMR4),
	REG_STRUCT_INIT(AR5K_DCM_ADDR),
	REG_STRUCT_INIT(AR5K_DCCFG),
	REG_STRUCT_INIT(AR5K_CCFG),
	REG_STRUCT_INIT(AR5K_CPC0),
	REG_STRUCT_INIT(AR5K_CPC1),
	REG_STRUCT_INIT(AR5K_CPC2),
	REG_STRUCT_INIT(AR5K_CPC3),
	REG_STRUCT_INIT(AR5K_CPCORN),
	REG_STRUCT_INIT(AR5K_RESET_CTL),
	REG_STRUCT_INIT(AR5K_SLEEP_CTL),
	REG_STRUCT_INIT(AR5K_INTPEND),
	REG_STRUCT_INIT(AR5K_SFR),
	REG_STRUCT_INIT(AR5K_PCICFG),
	REG_STRUCT_INIT(AR5K_GPIOCR),
	REG_STRUCT_INIT(AR5K_GPIODO),
	REG_STRUCT_INIT(AR5K_SREV),
};

static void *reg_start(struct seq_file *seq, loff_t *pos)
{
	return *pos < ARRAY_SIZE(regs) ? &regs[*pos] : NULL;
}

static void reg_stop(struct seq_file *seq, void *p)
{
	/* nothing to do */
}

static void *reg_next(struct seq_file *seq, void *p, loff_t *pos)
{
	++*pos;
	return *pos < ARRAY_SIZE(regs) ? &regs[*pos] : NULL;
}

static int reg_show(struct seq_file *seq, void *p)
{
	struct ath5k_softc *sc = seq->private;
	struct reg *r = p;
	seq_printf(seq, "%-25s0x%08x\n", r->name,
		ath5k_hw_reg_read(sc->ah, r->addr));
	return 0;
}

static struct seq_operations register_seq_ops = {
	.start = reg_start,
	.next  = reg_next,
	.stop  = reg_stop,
	.show  = reg_show
};

static int open_file_registers(struct inode *inode, struct file *file)
{
	struct seq_file *s;
	int res;
	res = seq_open(file, &register_seq_ops);
	if (res == 0) {
		s = file->private_data;
		s->private = inode->i_private;
	}
	return res;
}

static const struct file_operations fops_registers = {
	.open = open_file_registers,
	.read    = seq_read,
	.llseek  = seq_lseek,
	.release = seq_release,
	.owner = THIS_MODULE,
};


/* debugfs: TSF */

static ssize_t read_file_tsf(struct file *file, char __user *user_buf,
				   size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	char buf[100];
	snprintf(buf, sizeof(buf), "0x%016llx\n", ath5k_hw_get_tsf64(sc->ah));
	return simple_read_from_buffer(user_buf, count, ppos, buf, 19);
}

static ssize_t write_file_tsf(struct file *file,
				 const char __user *userbuf,
				 size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	char buf[20];

	if (copy_from_user(buf, userbuf, min(count, sizeof(buf))))
		return -EFAULT;

	if (strncmp(buf, "reset", 5) == 0) {
		ath5k_hw_reset_tsf(sc->ah);
		printk(KERN_INFO "debugfs reset TSF\n");
	}
	return count;
}

static const struct file_operations fops_tsf = {
	.read = read_file_tsf,
	.write = write_file_tsf,
	.open = ath5k_debugfs_open,
	.owner = THIS_MODULE,
};


/* debugfs: beacons */

static ssize_t read_file_beacon(struct file *file, char __user *user_buf,
				   size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	struct ath5k_hw *ah = sc->ah;
	char buf[500];
	unsigned int len = 0;
	unsigned int v;
	u64 tsf;

	v = ath5k_hw_reg_read(sc->ah, AR5K_BEACON);
	len += snprintf(buf+len, sizeof(buf)-len,
		"%-24s0x%08x\tintval: %d\tTIM: 0x%x\n",
		"AR5K_BEACON", v, v & AR5K_BEACON_PERIOD,
		(v & AR5K_BEACON_TIM) >> AR5K_BEACON_TIM_S);

	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\n",
		"AR5K_LAST_TSTP", ath5k_hw_reg_read(sc->ah, AR5K_LAST_TSTP));

	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\n\n",
		"AR5K_BEACON_CNT", ath5k_hw_reg_read(sc->ah, AR5K_BEACON_CNT));

	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER0);
	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
		"AR5K_TIMER0 (TBTT)", v, v);

	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER1);
	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
		"AR5K_TIMER1 (DMA)", v, v >> 3);

	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER2);
	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
		"AR5K_TIMER2 (SWBA)", v, v >> 3);

	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER3);
	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
		"AR5K_TIMER3 (ATIM)", v, v);

	tsf = ath5k_hw_get_tsf64(sc->ah);
	len += snprintf(buf+len, sizeof(buf)-len,
		"TSF\t\t0x%016llx\tTU: %08x\n", tsf, TSF_TO_TU(tsf));

	return simple_read_from_buffer(user_buf, count, ppos, buf, len);
}

static ssize_t write_file_beacon(struct file *file,
				 const char __user *userbuf,
				 size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	struct ath5k_hw *ah = sc->ah;
	char buf[20];

	if (copy_from_user(buf, userbuf, min(count, sizeof(buf))))
		return -EFAULT;

	if (strncmp(buf, "disable", 7) == 0) {
		AR5K_REG_DISABLE_BITS(ah, AR5K_BEACON, AR5K_BEACON_ENABLE);
		printk(KERN_INFO "debugfs disable beacons\n");
	} else if (strncmp(buf, "enable", 6) == 0) {
		AR5K_REG_ENABLE_BITS(ah, AR5K_BEACON, AR5K_BEACON_ENABLE);
		printk(KERN_INFO "debugfs enable beacons\n");
	}
	return count;
}

static const struct file_operations fops_beacon = {
	.read = read_file_beacon,
	.write = write_file_beacon,
	.open = ath5k_debugfs_open,
	.owner = THIS_MODULE,
};


/* debugfs: reset */

static ssize_t write_file_reset(struct file *file,
				 const char __user *userbuf,
				 size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	tasklet_schedule(&sc->restq);
	return count;
}

static const struct file_operations fops_reset = {
	.write = write_file_reset,
	.open = ath5k_debugfs_open,
	.owner = THIS_MODULE,
};


/* debugfs: debug level */

static struct {
	enum ath5k_debug_level level;
	const char *name;
	const char *desc;
} dbg_info[] = {
	{ ATH5K_DEBUG_RESET,	"reset",	"reset and initialization" },
	{ ATH5K_DEBUG_INTR,	"intr",		"interrupt handling" },
	{ ATH5K_DEBUG_MODE,	"mode",		"mode init/setup" },
	{ ATH5K_DEBUG_XMIT,	"xmit",		"basic xmit operation" },
	{ ATH5K_DEBUG_BEACON,	"beacon",	"beacon handling" },
	{ ATH5K_DEBUG_CALIBRATE, "calib",	"periodic calibration" },
	{ ATH5K_DEBUG_TXPOWER,	"txpower",	"transmit power setting" },
	{ ATH5K_DEBUG_LED,	"led",		"LED mamagement" },
	{ ATH5K_DEBUG_DUMP_RX,	"dumprx",	"print received skb content" },
	{ ATH5K_DEBUG_DUMP_TX,	"dumptx",	"print transmit skb content" },
	{ ATH5K_DEBUG_DUMPBANDS, "dumpbands",	"dump bands" },
	{ ATH5K_DEBUG_TRACE,	"trace",	"trace function calls" },
	{ ATH5K_DEBUG_ANY,	"all",		"show all debug levels" },
};

static ssize_t read_file_debug(struct file *file, char __user *user_buf,
				   size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	char buf[700];
	unsigned int len = 0;
	unsigned int i;

	len += snprintf(buf+len, sizeof(buf)-len,
		"DEBUG LEVEL: 0x%08x\n\n", sc->debug.level);

	for (i = 0; i < ARRAY_SIZE(dbg_info) - 1; i++) {
		len += snprintf(buf+len, sizeof(buf)-len,
			"%10s %c 0x%08x - %s\n", dbg_info[i].name,
			sc->debug.level & dbg_info[i].level ? '+' : ' ',
			dbg_info[i].level, dbg_info[i].desc);
	}
	len += snprintf(buf+len, sizeof(buf)-len,
		"%10s %c 0x%08x - %s\n", dbg_info[i].name,
		sc->debug.level == dbg_info[i].level ? '+' : ' ',
		dbg_info[i].level, dbg_info[i].desc);

	return simple_read_from_buffer(user_buf, count, ppos, buf, len);
}

static ssize_t write_file_debug(struct file *file,
				 const char __user *userbuf,
				 size_t count, loff_t *ppos)
{
	struct ath5k_softc *sc = file->private_data;
	unsigned int i;
	char buf[20];

	if (copy_from_user(buf, userbuf, min(count, sizeof(buf))))
		return -EFAULT;

	for (i = 0; i < ARRAY_SIZE(dbg_info); i++) {
		if (strncmp(buf, dbg_info[i].name,
					strlen(dbg_info[i].name)) == 0) {
			sc->debug.level ^= dbg_info[i].level; /* toggle bit */
			break;
		}
	}
	return count;
}

static const struct file_operations fops_debug = {
	.read = read_file_debug,
	.write = write_file_debug,
	.open = ath5k_debugfs_open,
	.owner = THIS_MODULE,
};


/* init */

void
ath5k_debug_init(void)
{
	ath5k_global_debugfs = debugfs_create_dir("ath5k", NULL);
}

void
ath5k_debug_init_device(struct ath5k_softc *sc)
{
	sc->debug.level = ath5k_debug;

	sc->debug.debugfs_phydir = debugfs_create_dir(wiphy_name(sc->hw->wiphy),
				ath5k_global_debugfs);

	sc->debug.debugfs_debug = debugfs_create_file("debug", 0666,
				sc->debug.debugfs_phydir, sc, &fops_debug);

	sc->debug.debugfs_registers = debugfs_create_file("registers", 0444,
				sc->debug.debugfs_phydir, sc, &fops_registers);

	sc->debug.debugfs_tsf = debugfs_create_file("tsf", 0666,
				sc->debug.debugfs_phydir, sc, &fops_tsf);

	sc->debug.debugfs_beacon = debugfs_create_file("beacon", 0666,
				sc->debug.debugfs_phydir, sc, &fops_beacon);

	sc->debug.debugfs_reset = debugfs_create_file("reset", 0222,
				sc->debug.debugfs_phydir, sc, &fops_reset);
}

void
ath5k_debug_finish(void)
{
	debugfs_remove(ath5k_global_debugfs);
}

void
ath5k_debug_finish_device(struct ath5k_softc *sc)
{
	debugfs_remove(sc->debug.debugfs_debug);
	debugfs_remove(sc->debug.debugfs_registers);
	debugfs_remove(sc->debug.debugfs_tsf);
	debugfs_remove(sc->debug.debugfs_beacon);
	debugfs_remove(sc->debug.debugfs_reset);
	debugfs_remove(sc->debug.debugfs_phydir);
}


/* functions used in other places */

void
ath5k_debug_dump_bands(struct ath5k_softc *sc)
{
	unsigned int b, i;

	if (likely(!(sc->debug.level & ATH5K_DEBUG_DUMPBANDS)))
		return;

	BUG_ON(!sc->sbands);

	for (b = 0; b < IEEE80211_NUM_BANDS; b++) {
		struct ieee80211_supported_band *band = &sc->sbands[b];
		char bname[5];
		switch (band->band) {
		case IEEE80211_BAND_2GHZ:
			strcpy(bname, "2 GHz");
			break;
		case IEEE80211_BAND_5GHZ:
			strcpy(bname, "5 GHz");
			break;
		default:
			printk(KERN_DEBUG "Band not supported: %d\n",
				band->band);
			return;
		}
		printk(KERN_DEBUG "Band %s: channels %d, rates %d\n", bname,
				band->n_channels, band->n_bitrates);
		printk(KERN_DEBUG " channels:\n");
		for (i = 0; i < band->n_channels; i++)
			printk(KERN_DEBUG "  %3d %d %.4x %.4x\n",
					ieee80211_frequency_to_channel(
						band->channels[i].center_freq),
					band->channels[i].center_freq,
					band->channels[i].hw_value,
					band->channels[i].flags);
		printk(KERN_DEBUG " rates:\n");
		for (i = 0; i < band->n_bitrates; i++)
			printk(KERN_DEBUG "  %4d %.4x %.4x %.4x\n",
					band->bitrates[i].bitrate,
					band->bitrates[i].hw_value,
					band->bitrates[i].flags,
					band->bitrates[i].hw_value_short);
	}
}

static inline void
ath5k_debug_printrxbuf(struct ath5k_buf *bf, int done)
{
	struct ath5k_desc *ds = bf->desc;

	printk(KERN_DEBUG "R (%p %llx) %08x %08x %08x %08x %08x %08x %c\n",
		ds, (unsigned long long)bf->daddr,
		ds->ds_link, ds->ds_data, ds->ds_ctl0, ds->ds_ctl1,
		ds->ds_hw[0], ds->ds_hw[1],
		!done ? ' ' : (ds->ds_rxstat.rs_status == 0) ? '*' : '!');
}

void
ath5k_debug_printrxbuffs(struct ath5k_softc *sc, struct ath5k_hw *ah)
{
	struct ath5k_desc *ds;
	struct ath5k_buf *bf;
	int status;

	if (likely(!(sc->debug.level & ATH5K_DEBUG_RESET)))
		return;

	printk(KERN_DEBUG "rx queue %x, link %p\n",
		ath5k_hw_get_rx_buf(ah), sc->rxlink);

	spin_lock_bh(&sc->rxbuflock);
	list_for_each_entry(bf, &sc->rxbuf, list) {
		ds = bf->desc;
		status = ah->ah_proc_rx_desc(ah, ds);
		if (!status)
			ath5k_debug_printrxbuf(bf, status == 0);
	}
	spin_unlock_bh(&sc->rxbuflock);
}

void
ath5k_debug_dump_skb(struct ath5k_softc *sc,
			struct sk_buff *skb, const char *prefix, int tx)
{
	char buf[16];

	if (likely(!((tx && (sc->debug.level & ATH5K_DEBUG_DUMP_TX)) ||
		     (!tx && (sc->debug.level & ATH5K_DEBUG_DUMP_RX)))))
		return;

	snprintf(buf, sizeof(buf), "%s %s", wiphy_name(sc->hw->wiphy), prefix);

	print_hex_dump_bytes(buf, DUMP_PREFIX_NONE, skb->data,
		min(200U, skb->len));

	printk(KERN_DEBUG "\n");
}

void
ath5k_debug_printtxbuf(struct ath5k_softc *sc,
			struct ath5k_buf *bf, int done)
{
	struct ath5k_desc *ds = bf->desc;

	if (likely(!(sc->debug.level & ATH5K_DEBUG_RESET)))
		return;

	printk(KERN_DEBUG "T (%p %llx) %08x %08x %08x %08x %08x %08x %08x "
		"%08x %c\n", ds, (unsigned long long)bf->daddr, ds->ds_link,
		ds->ds_data, ds->ds_ctl0, ds->ds_ctl1,
		ds->ds_hw[0], ds->ds_hw[1], ds->ds_hw[2], ds->ds_hw[3],
		!done ? ' ' : (ds->ds_txstat.ts_status == 0) ? '*' : '!');
}

#endif /* ifdef CONFIG_ATH5K_DEBUG */
Commit	Line	Data
fa1c114f	1	/*
be9b7259	2	* Copyright (c) 2007-2008 Bruno Randolf <bruno@thinktube.com>
fa1c114f JS	3	*
	4	* This file is free software: you may copy, redistribute and/or modify it
	5	* under the terms of the GNU General Public License as published by the
	6	* Free Software Foundation, either version 2 of the License, or (at your
	7	* option) any later version.
	8	*
	9	* This file is distributed in the hope that it will be useful, but
	10	* WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	* General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	*
	17	*
	18	* This file incorporates work covered by the following copyright and
	19	* permission notice:
	20	*
	21	* Copyright (c) 2002-2005 Sam Leffler, Errno Consulting
	22	* Copyright (c) 2004-2005 Atheros Communications, Inc.
	23	* Copyright (c) 2006 Devicescape Software, Inc.
	24	* Copyright (c) 2007 Jiri Slaby <jirislaby@gmail.com>
	25	* Copyright (c) 2007 Luis R. Rodriguez <mcgrof@winlab.rutgers.edu>
	26	*
	27	* All rights reserved.
	28	*
	29	* Redistribution and use in source and binary forms, with or without
	30	* modification, are permitted provided that the following conditions
	31	* are met:
	32	* 1. Redistributions of source code must retain the above copyright
	33	* notice, this list of conditions and the following disclaimer,
	34	* without modification.
	35	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	36	* similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
	37	* redistribution must be conditioned upon including a substantially
	38	* similar Disclaimer requirement for further binary redistribution.
	39	* 3. Neither the names of the above-listed copyright holders nor the names
	40	* of any contributors may be used to endorse or promote products derived
	41	* from this software without specific prior written permission.
	42	*
	43	* Alternatively, this software may be distributed under the terms of the
	44	* GNU General Public License ("GPL") version 2 as published by the Free
	45	* Software Foundation.
	46	*
	47	* NO WARRANTY
	48	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	49	* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	50	* LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
	51	* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
	52	* THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
	53	* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	54	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	55	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
	56	* IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	57	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
	58	* THE POSSIBILITY OF SUCH DAMAGES.
	59	*/
	60
	61	#include "debug.h"
	62	#include "base.h"
	63
	64	static unsigned int ath5k_debug;
	65	module_param_named(debug, ath5k_debug, uint, 0);
	66
67
b446197c	68	#ifdef CONFIG_ATH5K_DEBUG
fa1c114f JS	69
	70	#include <linux/seq_file.h>
	71	#include "reg.h"
	72
	73	static struct dentry *ath5k_global_debugfs;
	74
	75	static int ath5k_debugfs_open(struct inode inode, struct file file)
	76	{
	77	file->private_data = inode->i_private;
	78	return 0;
	79	}
	80
	81
	82	/* debugfs: registers */
	83
	84	struct reg {
	85	char *name;
	86	int addr;
	87	};
	88
	89	#define REG_STRUCT_INIT(r) { #r, r }
	90
	91	/* just a few random registers, might want to add more */
	92	static struct reg regs[] = {
	93	REG_STRUCT_INIT(AR5K_CR),
	94	REG_STRUCT_INIT(AR5K_RXDP),
	95	REG_STRUCT_INIT(AR5K_CFG),
	96	REG_STRUCT_INIT(AR5K_IER),
	97	REG_STRUCT_INIT(AR5K_BCR),
	98	REG_STRUCT_INIT(AR5K_RTSD0),
	99	REG_STRUCT_INIT(AR5K_RTSD1),
	100	REG_STRUCT_INIT(AR5K_TXCFG),
	101	REG_STRUCT_INIT(AR5K_RXCFG),
	102	REG_STRUCT_INIT(AR5K_RXJLA),
	103	REG_STRUCT_INIT(AR5K_MIBC),
	104	REG_STRUCT_INIT(AR5K_TOPS),
	105	REG_STRUCT_INIT(AR5K_RXNOFRM),
	106	REG_STRUCT_INIT(AR5K_TXNOFRM),
	107	REG_STRUCT_INIT(AR5K_RPGTO),
	108	REG_STRUCT_INIT(AR5K_RFCNT),
	109	REG_STRUCT_INIT(AR5K_MISC),
	110	REG_STRUCT_INIT(AR5K_QCUDCU_CLKGT),
	111	REG_STRUCT_INIT(AR5K_ISR),
	112	REG_STRUCT_INIT(AR5K_PISR),
	113	REG_STRUCT_INIT(AR5K_SISR0),
	114	REG_STRUCT_INIT(AR5K_SISR1),
	115	REG_STRUCT_INIT(AR5K_SISR2),
	116	REG_STRUCT_INIT(AR5K_SISR3),
	117	REG_STRUCT_INIT(AR5K_SISR4),
	118	REG_STRUCT_INIT(AR5K_IMR),
	119	REG_STRUCT_INIT(AR5K_PIMR),
	120	REG_STRUCT_INIT(AR5K_SIMR0),
	121	REG_STRUCT_INIT(AR5K_SIMR1),
	122	REG_STRUCT_INIT(AR5K_SIMR2),
	123	REG_STRUCT_INIT(AR5K_SIMR3),
	124	REG_STRUCT_INIT(AR5K_SIMR4),
	125	REG_STRUCT_INIT(AR5K_DCM_ADDR),
	126	REG_STRUCT_INIT(AR5K_DCCFG),
	127	REG_STRUCT_INIT(AR5K_CCFG),
	128	REG_STRUCT_INIT(AR5K_CPC0),
	129	REG_STRUCT_INIT(AR5K_CPC1),
	130	REG_STRUCT_INIT(AR5K_CPC2),
	131	REG_STRUCT_INIT(AR5K_CPC3),
	132	REG_STRUCT_INIT(AR5K_CPCORN),
133	REG_STRUCT_INIT(AR5K_RESET_CTL),
134	REG_STRUCT_INIT(AR5K_SLEEP_CTL),
135	REG_STRUCT_INIT(AR5K_INTPEND),
136	REG_STRUCT_INIT(AR5K_SFR),
137	REG_STRUCT_INIT(AR5K_PCICFG),
138	REG_STRUCT_INIT(AR5K_GPIOCR),
139	REG_STRUCT_INIT(AR5K_GPIODO),
140	REG_STRUCT_INIT(AR5K_SREV),
141	};
142
143	static void reg_start(struct seq_file seq, loff_t *pos)
144	{
145	return pos < ARRAY_SIZE(regs) ? &regs[pos] : NULL;
146	}
147
148	static void reg_stop(struct seq_file seq, void p)
149	{
150	/* nothing to do */
151	}
152
153	static void reg_next(struct seq_file seq, void p, loff_t pos)
154	{
155	++*pos;
156	return pos < ARRAY_SIZE(regs) ? &regs[pos] : NULL;
157	}
158
159	static int reg_show(struct seq_file seq, void p)
160	{
161	struct ath5k_softc *sc = seq->private;
162	struct reg *r = p;
163	seq_printf(seq, "%-25s0x%08x\n", r->name,
164	ath5k_hw_reg_read(sc->ah, r->addr));
165	return 0;
166	}
167
168	static struct seq_operations register_seq_ops = {
169	.start = reg_start,
170	.next = reg_next,
171	.stop = reg_stop,
172	.show = reg_show
173	};
174
175	static int open_file_registers(struct inode inode, struct file file)
176	{
177	struct seq_file *s;
178	int res;
179	res = seq_open(file, &register_seq_ops);
180	if (res == 0) {
181	s = file->private_data;
182	s->private = inode->i_private;
183	}
184	return res;
185	}
186
187	static const struct file_operations fops_registers = {
188	.open = open_file_registers,
189	.read = seq_read,
190	.llseek = seq_lseek,
191	.release = seq_release,
192	.owner = THIS_MODULE,
193	};
194
195
196	/* debugfs: TSF */
197
198	static ssize_t read_file_tsf(struct file file, char __user user_buf,
199	size_t count, loff_t *ppos)
200	{
201	struct ath5k_softc *sc = file->private_data;
202	char buf[100];
be9b7259	203	snprintf(buf, sizeof(buf), "0x%016llx\n", ath5k_hw_get_tsf64(sc->ah));
fa1c114f JS	204	return simple_read_from_buffer(user_buf, count, ppos, buf, 19);
	205	}
	206
	207	static ssize_t write_file_tsf(struct file *file,
	208	const char __user *userbuf,
	209	size_t count, loff_t *ppos)
	210	{
	211	struct ath5k_softc *sc = file->private_data;
be9b7259 BR	212	char buf[20];
	213
	214	if (copy_from_user(buf, userbuf, min(count, sizeof(buf))))
	215	return -EFAULT;
	216
	217	if (strncmp(buf, "reset", 5) == 0) {
fa1c114f JS	218	ath5k_hw_reset_tsf(sc->ah);
	219	printk(KERN_INFO "debugfs reset TSF\n");
	220	}
	221	return count;
	222	}
	223
	224	static const struct file_operations fops_tsf = {
	225	.read = read_file_tsf,
	226	.write = write_file_tsf,
	227	.open = ath5k_debugfs_open,
	228	.owner = THIS_MODULE,
	229	};
	230
	231
	232	/* debugfs: beacons */
	233
	234	static ssize_t read_file_beacon(struct file file, char __user user_buf,
	235	size_t count, loff_t *ppos)
	236	{
	237	struct ath5k_softc *sc = file->private_data;
	238	struct ath5k_hw *ah = sc->ah;
be9b7259 BR	239	char buf[500];
be9b7259 BR	240	unsigned int len = 0;
fa1c114f JS	241	unsigned int v;
	242	u64 tsf;
	243
	244	v = ath5k_hw_reg_read(sc->ah, AR5K_BEACON);
	245	len += snprintf(buf+len, sizeof(buf)-len,
	246	"%-24s0x%08x\tintval: %d\tTIM: 0x%x\n",
	247	"AR5K_BEACON", v, v & AR5K_BEACON_PERIOD,
	248	(v & AR5K_BEACON_TIM) >> AR5K_BEACON_TIM_S);
	249
	250	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\n",
	251	"AR5K_LAST_TSTP", ath5k_hw_reg_read(sc->ah, AR5K_LAST_TSTP));
	252
	253	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\n\n",
	254	"AR5K_BEACON_CNT", ath5k_hw_reg_read(sc->ah, AR5K_BEACON_CNT));
	255
	256	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER0);
	257	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
	258	"AR5K_TIMER0 (TBTT)", v, v);
	259
	260	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER1);
	261	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
	262	"AR5K_TIMER1 (DMA)", v, v >> 3);
	263
	264	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER2);
	265	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
	266	"AR5K_TIMER2 (SWBA)", v, v >> 3);
	267
	268	v = ath5k_hw_reg_read(sc->ah, AR5K_TIMER3);
	269	len += snprintf(buf+len, sizeof(buf)-len, "%-24s0x%08x\tTU: %08x\n",
	270	"AR5K_TIMER3 (ATIM)", v, v);
	271
	272	tsf = ath5k_hw_get_tsf64(sc->ah);
	273	len += snprintf(buf+len, sizeof(buf)-len,
	274	"TSF\t\t0x%016llx\tTU: %08x\n", tsf, TSF_TO_TU(tsf));
	275
	276	return simple_read_from_buffer(user_buf, count, ppos, buf, len);
	277	}
	278
	279	static ssize_t write_file_beacon(struct file *file,
	280	const char __user *userbuf,
	281	size_t count, loff_t *ppos)
	282	{
	283	struct ath5k_softc *sc = file->private_data;
	284	struct ath5k_hw *ah = sc->ah;
be9b7259	285	char buf[20];
fa1c114f	286
be9b7259 BR	287	if (copy_from_user(buf, userbuf, min(count, sizeof(buf))))
	288	return -EFAULT;
	289
	290	if (strncmp(buf, "disable", 7) == 0) {
fa1c114f JS	291	AR5K_REG_DISABLE_BITS(ah, AR5K_BEACON, AR5K_BEACON_ENABLE);
fa1c114f JS	292	printk(KERN_INFO "debugfs disable beacons\n");
be9b7259	293	} else if (strncmp(buf, "enable", 6) == 0) {
fa1c114f JS	294	AR5K_REG_ENABLE_BITS(ah, AR5K_BEACON, AR5K_BEACON_ENABLE);
	295	printk(KERN_INFO "debugfs enable beacons\n");
	296	}
	297	return count;
	298	}
	299
	300	static const struct file_operations fops_beacon = {
	301	.read = read_file_beacon,
	302	.write = write_file_beacon,
	303	.open = ath5k_debugfs_open,
	304	.owner = THIS_MODULE,
	305	};
	306
	307
	308	/* debugfs: reset */
	309
	310	static ssize_t write_file_reset(struct file *file,
	311	const char __user *userbuf,
	312	size_t count, loff_t *ppos)
	313	{
	314	struct ath5k_softc *sc = file->private_data;
	315	tasklet_schedule(&sc->restq);
	316	return count;
	317	}
	318
	319	static const struct file_operations fops_reset = {
	320	.write = write_file_reset,
	321	.open = ath5k_debugfs_open,
	322	.owner = THIS_MODULE,
	323	};
	324
	325
be9b7259 BR	326	/* debugfs: debug level */
	327
	328	static struct {
	329	enum ath5k_debug_level level;
	330	const char *name;
	331	const char *desc;
	332	} dbg_info[] = {
	333	{ ATH5K_DEBUG_RESET, "reset", "reset and initialization" },
	334	{ ATH5K_DEBUG_INTR, "intr", "interrupt handling" },
	335	{ ATH5K_DEBUG_MODE, "mode", "mode init/setup" },
	336	{ ATH5K_DEBUG_XMIT, "xmit", "basic xmit operation" },
	337	{ ATH5K_DEBUG_BEACON, "beacon", "beacon handling" },
	338	{ ATH5K_DEBUG_CALIBRATE, "calib", "periodic calibration" },
	339	{ ATH5K_DEBUG_TXPOWER, "txpower", "transmit power setting" },
	340	{ ATH5K_DEBUG_LED, "led", "LED mamagement" },
	341	{ ATH5K_DEBUG_DUMP_RX, "dumprx", "print received skb content" },
	342	{ ATH5K_DEBUG_DUMP_TX, "dumptx", "print transmit skb content" },
b446197c	343	{ ATH5K_DEBUG_DUMPBANDS, "dumpbands", "dump bands" },
be9b7259 BR	344	{ ATH5K_DEBUG_TRACE, "trace", "trace function calls" },
	345	{ ATH5K_DEBUG_ANY, "all", "show all debug levels" },
	346	};
	347
	348	static ssize_t read_file_debug(struct file file, char __user user_buf,
	349	size_t count, loff_t *ppos)
	350	{
	351	struct ath5k_softc *sc = file->private_data;
	352	char buf[700];
	353	unsigned int len = 0;
	354	unsigned int i;
	355
	356	len += snprintf(buf+len, sizeof(buf)-len,
	357	"DEBUG LEVEL: 0x%08x\n\n", sc->debug.level);
	358
	359	for (i = 0; i < ARRAY_SIZE(dbg_info) - 1; i++) {
	360	len += snprintf(buf+len, sizeof(buf)-len,
	361	"%10s %c 0x%08x - %s\n", dbg_info[i].name,
	362	sc->debug.level & dbg_info[i].level ? '+' : ' ',
	363	dbg_info[i].level, dbg_info[i].desc);
	364	}
	365	len += snprintf(buf+len, sizeof(buf)-len,
	366	"%10s %c 0x%08x - %s\n", dbg_info[i].name,
	367	sc->debug.level == dbg_info[i].level ? '+' : ' ',
	368	dbg_info[i].level, dbg_info[i].desc);
	369
	370	return simple_read_from_buffer(user_buf, count, ppos, buf, len);
	371	}
	372
	373	static ssize_t write_file_debug(struct file *file,
	374	const char __user *userbuf,
	375	size_t count, loff_t *ppos)
	376	{
	377	struct ath5k_softc *sc = file->private_data;
	378	unsigned int i;
	379	char buf[20];
	380
	381	if (copy_from_user(buf, userbuf, min(count, sizeof(buf))))
	382	return -EFAULT;
	383
	384	for (i = 0; i < ARRAY_SIZE(dbg_info); i++) {
	385	if (strncmp(buf, dbg_info[i].name,
	386	strlen(dbg_info[i].name)) == 0) {
	387	sc->debug.level ^= dbg_info[i].level; /* toggle bit */
	388	break;
	389	}
	390	}
	391	return count;
	392	}
	393
	394	static const struct file_operations fops_debug = {
	395	.read = read_file_debug,
	396	.write = write_file_debug,
	397	.open = ath5k_debugfs_open,
	398	.owner = THIS_MODULE,
	399	};
	400
	401
fa1c114f JS	402	/* init */
	403
	404	void
	405	ath5k_debug_init(void)
	406	{
	407	ath5k_global_debugfs = debugfs_create_dir("ath5k", NULL);
	408	}
	409
	410	void
	411	ath5k_debug_init_device(struct ath5k_softc *sc)
	412	{
	413	sc->debug.level = ath5k_debug;
be9b7259	414
fa1c114f	415	sc->debug.debugfs_phydir = debugfs_create_dir(wiphy_name(sc->hw->wiphy),
be9b7259 BR	416	ath5k_global_debugfs);
	417
	418	sc->debug.debugfs_debug = debugfs_create_file("debug", 0666,
	419	sc->debug.debugfs_phydir, sc, &fops_debug);
fa1c114f JS	420
fa1c114f JS	421	sc->debug.debugfs_registers = debugfs_create_file("registers", 0444,
be9b7259	422	sc->debug.debugfs_phydir, sc, &fops_registers);
fa1c114f JS	423
fa1c114f JS	424	sc->debug.debugfs_tsf = debugfs_create_file("tsf", 0666,
be9b7259	425	sc->debug.debugfs_phydir, sc, &fops_tsf);
fa1c114f JS	426
fa1c114f JS	427	sc->debug.debugfs_beacon = debugfs_create_file("beacon", 0666,
be9b7259	428	sc->debug.debugfs_phydir, sc, &fops_beacon);
fa1c114f JS	429
fa1c114f JS	430	sc->debug.debugfs_reset = debugfs_create_file("reset", 0222,
be9b7259	431	sc->debug.debugfs_phydir, sc, &fops_reset);
fa1c114f JS	432	}
	433
	434	void
	435	ath5k_debug_finish(void)
	436	{
	437	debugfs_remove(ath5k_global_debugfs);
	438	}
	439
	440	void
	441	ath5k_debug_finish_device(struct ath5k_softc *sc)
	442	{
	443	debugfs_remove(sc->debug.debugfs_debug);
	444	debugfs_remove(sc->debug.debugfs_registers);
	445	debugfs_remove(sc->debug.debugfs_tsf);
	446	debugfs_remove(sc->debug.debugfs_beacon);
	447	debugfs_remove(sc->debug.debugfs_reset);
	448	debugfs_remove(sc->debug.debugfs_phydir);
	449	}
	450
	451
	452	/* functions used in other places */
	453
	454	void
b446197c	455	ath5k_debug_dump_bands(struct ath5k_softc *sc)
fa1c114f	456	{
b446197c	457	unsigned int b, i;
fa1c114f	458
b446197c	459	if (likely(!(sc->debug.level & ATH5K_DEBUG_DUMPBANDS)))
fa1c114f JS	460	return;
fa1c114f JS	461
b446197c LR	462	BUG_ON(!sc->sbands);
	463
	464	for (b = 0; b < IEEE80211_NUM_BANDS; b++) {
	465	struct ieee80211_supported_band *band = &sc->sbands[b];
	466	char bname[5];
	467	switch (band->band) {
	468	case IEEE80211_BAND_2GHZ:
	469	strcpy(bname, "2 GHz");
	470	break;
	471	case IEEE80211_BAND_5GHZ:
	472	strcpy(bname, "5 GHz");
	473	break;
	474	default:
	475	printk(KERN_DEBUG "Band not supported: %d\n",
	476	band->band);
	477	return;
	478	}
	479	printk(KERN_DEBUG "Band %s: channels %d, rates %d\n", bname,
	480	band->n_channels, band->n_bitrates);
fa1c114f	481	printk(KERN_DEBUG " channels:\n");
b446197c	482	for (i = 0; i < band->n_channels; i++)
fa1c114f	483	printk(KERN_DEBUG " %3d %d %.4x %.4x\n",
b446197c LR	484	ieee80211_frequency_to_channel(
	485	band->channels[i].center_freq),
	486	band->channels[i].center_freq,
	487	band->channels[i].hw_value,
	488	band->channels[i].flags);
fa1c114f	489	printk(KERN_DEBUG " rates:\n");
b446197c	490	for (i = 0; i < band->n_bitrates; i++)
fa1c114f	491	printk(KERN_DEBUG " %4d %.4x %.4x %.4x\n",
b446197c LR	492	band->bitrates[i].bitrate,
	493	band->bitrates[i].hw_value,
	494	band->bitrates[i].flags,
	495	band->bitrates[i].hw_value_short);
fa1c114f JS	496	}
	497	}
	498
	499	static inline void
	500	ath5k_debug_printrxbuf(struct ath5k_buf *bf, int done)
	501	{
	502	struct ath5k_desc *ds = bf->desc;
	503
	504	printk(KERN_DEBUG "R (%p %llx) %08x %08x %08x %08x %08x %08x %c\n",
	505	ds, (unsigned long long)bf->daddr,
	506	ds->ds_link, ds->ds_data, ds->ds_ctl0, ds->ds_ctl1,
	507	ds->ds_hw[0], ds->ds_hw[1],
	508	!done ? ' ' : (ds->ds_rxstat.rs_status == 0) ? '*' : '!');
	509	}
	510
	511	void
	512	ath5k_debug_printrxbuffs(struct ath5k_softc sc, struct ath5k_hw ah)
	513	{
	514	struct ath5k_desc *ds;
	515	struct ath5k_buf *bf;
	516	int status;
	517
be9b7259	518	if (likely(!(sc->debug.level & ATH5K_DEBUG_RESET)))
fa1c114f JS	519	return;
	520
	521	printk(KERN_DEBUG "rx queue %x, link %p\n",
	522	ath5k_hw_get_rx_buf(ah), sc->rxlink);
	523
	524	spin_lock_bh(&sc->rxbuflock);
	525	list_for_each_entry(bf, &sc->rxbuf, list) {
	526	ds = bf->desc;
	527	status = ah->ah_proc_rx_desc(ah, ds);
be9b7259	528	if (!status)
fa1c114f JS	529	ath5k_debug_printrxbuf(bf, status == 0);
	530	}
	531	spin_unlock_bh(&sc->rxbuflock);
	532	}
	533
	534	void
	535	ath5k_debug_dump_skb(struct ath5k_softc *sc,
	536	struct sk_buff skb, const char prefix, int tx)
	537	{
	538	char buf[16];
	539
	540	if (likely(!((tx && (sc->debug.level & ATH5K_DEBUG_DUMP_TX)) \|\|
	541	(!tx && (sc->debug.level & ATH5K_DEBUG_DUMP_RX)))))
	542	return;
	543
	544	snprintf(buf, sizeof(buf), "%s %s", wiphy_name(sc->hw->wiphy), prefix);
	545
	546	print_hex_dump_bytes(buf, DUMP_PREFIX_NONE, skb->data,
	547	min(200U, skb->len));
	548
	549	printk(KERN_DEBUG "\n");
	550	}
	551
	552	void
	553	ath5k_debug_printtxbuf(struct ath5k_softc *sc,
	554	struct ath5k_buf *bf, int done)
	555	{
	556	struct ath5k_desc *ds = bf->desc;
	557
	558	if (likely(!(sc->debug.level & ATH5K_DEBUG_RESET)))
	559	return;
	560
	561	printk(KERN_DEBUG "T (%p %llx) %08x %08x %08x %08x %08x %08x %08x "
	562	"%08x %c\n", ds, (unsigned long long)bf->daddr, ds->ds_link,
	563	ds->ds_data, ds->ds_ctl0, ds->ds_ctl1,
	564	ds->ds_hw[0], ds->ds_hw[1], ds->ds_hw[2], ds->ds_hw[3],
	565	!done ? ' ' : (ds->ds_txstat.ts_status == 0) ? '*' : '!');
	566	}
	567
b446197c	568	#endif /* ifdef CONFIG_ATH5K_DEBUG */