1 /*
2  * This file is part of the Chelsio T4 Ethernet driver for Linux.
3  *
4  * Copyright (c) 2003-2014 Chelsio Communications, Inc. All rights reserved.
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenIB.org BSD license below:
11  *
12  *     Redistribution and use in source and binary forms, with or
13  *     without modification, are permitted provided that the following
14  *     conditions are met:
15  *
16  *      - Redistributions of source code must retain the above
17  *        copyright notice, this list of conditions and the following
18  *        disclaimer.
19  *
20  *      - Redistributions in binary form must reproduce the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer in the documentation and/or other materials
23  *        provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  */
34 
35 #ifndef __CXGB4_DEBUGFS_H
36 #define __CXGB4_DEBUGFS_H
37 
38 #include <linux/export.h>
39 
40 #define DEFINE_SIMPLE_DEBUGFS_FILE(name) \
41 static int name##_open(struct inode *inode, struct file *file) \
42 { \
43 	return single_open(file, name##_show, inode->i_private); \
44 } \
45 static const struct file_operations name##_debugfs_fops = { \
46 	.owner   = THIS_MODULE, \
47 	.open    = name##_open, \
48 	.read    = seq_read, \
49 	.llseek  = seq_lseek, \
50 	.release = single_release \
51 }
52 
53 struct t4_debugfs_entry {
54 	const char *name;
55 	const struct file_operations *ops;
56 	umode_t mode;
57 	unsigned char data;
58 };
59 
60 struct seq_tab {
61 	int (*show)(struct seq_file *seq, void *v, int idx);
62 	unsigned int rows;        /* # of entries */
63 	unsigned char width;      /* size in bytes of each entry */
64 	unsigned char skip_first; /* whether the first line is a header */
65 	char data[0];             /* the table data */
66 };
67 
68 static inline unsigned int hex2val(char c)
69 {
70 	return isdigit(c) ? c - '0' : tolower(c) - 'a' + 10;
71 }
72 
73 struct seq_tab *seq_open_tab(struct file *f, unsigned int rows,
74 			     unsigned int width, unsigned int have_header,
75 			     int (*show)(struct seq_file *seq, void *v, int i));
76 
77 int t4_setup_debugfs(struct adapter *adap);
78 void add_debugfs_files(struct adapter *adap,
79 		       struct t4_debugfs_entry *files,
80 		       unsigned int nfiles);
81 int mem_open(struct inode *inode, struct file *file);
82 
83 #endif
84