1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * Copyright 2014 Cisco Systems, Inc. All rights reserved.
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * This program is free software; you may redistribute it and/or modify
5*4882a593Smuzhiyun * it under the terms of the GNU General Public License as published by
6*4882a593Smuzhiyun * the Free Software Foundation; version 2 of the License.
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
9*4882a593Smuzhiyun * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
10*4882a593Smuzhiyun * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
11*4882a593Smuzhiyun * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
12*4882a593Smuzhiyun * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
13*4882a593Smuzhiyun * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
14*4882a593Smuzhiyun * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
15*4882a593Smuzhiyun * SOFTWARE.
16*4882a593Smuzhiyun */
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun #ifndef __SNIC_TRC_H
19*4882a593Smuzhiyun #define __SNIC_TRC_H
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #ifdef CONFIG_SCSI_SNIC_DEBUG_FS
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun extern ssize_t simple_read_from_buffer(void __user *to,
24*4882a593Smuzhiyun size_t count,
25*4882a593Smuzhiyun loff_t *ppos,
26*4882a593Smuzhiyun const void *from,
27*4882a593Smuzhiyun size_t available);
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun extern unsigned int snic_trace_max_pages;
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun /* Global Data structure for trace to manage trace functionality */
32*4882a593Smuzhiyun struct snic_trc_data {
33*4882a593Smuzhiyun u64 ts; /* Time Stamp */
34*4882a593Smuzhiyun char *fn; /* Ptr to Function Name */
35*4882a593Smuzhiyun u32 hno; /* SCSI Host ID */
36*4882a593Smuzhiyun u32 tag; /* Command Tag */
37*4882a593Smuzhiyun u64 data[5];
38*4882a593Smuzhiyun } __attribute__((__packed__));
39*4882a593Smuzhiyun
40*4882a593Smuzhiyun #define SNIC_TRC_ENTRY_SZ 64 /* in Bytes */
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun struct snic_trc {
43*4882a593Smuzhiyun spinlock_t lock;
44*4882a593Smuzhiyun struct snic_trc_data *buf; /* Trace Buffer */
45*4882a593Smuzhiyun u32 max_idx; /* Max Index into trace buffer */
46*4882a593Smuzhiyun u32 rd_idx;
47*4882a593Smuzhiyun u32 wr_idx;
48*4882a593Smuzhiyun bool enable; /* Control Variable for Tracing */
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun struct dentry *trc_enable; /* debugfs file object */
51*4882a593Smuzhiyun struct dentry *trc_file;
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun int snic_trc_init(void);
55*4882a593Smuzhiyun void snic_trc_free(void);
56*4882a593Smuzhiyun void snic_trc_debugfs_init(void);
57*4882a593Smuzhiyun void snic_trc_debugfs_term(void);
58*4882a593Smuzhiyun struct snic_trc_data *snic_get_trc_buf(void);
59*4882a593Smuzhiyun int snic_get_trc_data(char *buf, int buf_sz);
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun void snic_debugfs_init(void);
62*4882a593Smuzhiyun void snic_debugfs_term(void);
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun static inline void
snic_trace(char * fn,u16 hno,u32 tag,u64 d1,u64 d2,u64 d3,u64 d4,u64 d5)65*4882a593Smuzhiyun snic_trace(char *fn, u16 hno, u32 tag, u64 d1, u64 d2, u64 d3, u64 d4, u64 d5)
66*4882a593Smuzhiyun {
67*4882a593Smuzhiyun struct snic_trc_data *tr_rec = snic_get_trc_buf();
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun if (!tr_rec)
70*4882a593Smuzhiyun return;
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun tr_rec->fn = (char *)fn;
73*4882a593Smuzhiyun tr_rec->hno = hno;
74*4882a593Smuzhiyun tr_rec->tag = tag;
75*4882a593Smuzhiyun tr_rec->data[0] = d1;
76*4882a593Smuzhiyun tr_rec->data[1] = d2;
77*4882a593Smuzhiyun tr_rec->data[2] = d3;
78*4882a593Smuzhiyun tr_rec->data[3] = d4;
79*4882a593Smuzhiyun tr_rec->data[4] = d5;
80*4882a593Smuzhiyun tr_rec->ts = jiffies; /* Update time stamp at last */
81*4882a593Smuzhiyun }
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun #define SNIC_TRC(_hno, _tag, d1, d2, d3, d4, d5) \
84*4882a593Smuzhiyun do { \
85*4882a593Smuzhiyun if (unlikely(snic_glob->trc.enable)) \
86*4882a593Smuzhiyun snic_trace((char *)__func__, \
87*4882a593Smuzhiyun (u16)(_hno), \
88*4882a593Smuzhiyun (u32)(_tag), \
89*4882a593Smuzhiyun (u64)(d1), \
90*4882a593Smuzhiyun (u64)(d2), \
91*4882a593Smuzhiyun (u64)(d3), \
92*4882a593Smuzhiyun (u64)(d4), \
93*4882a593Smuzhiyun (u64)(d5)); \
94*4882a593Smuzhiyun } while (0)
95*4882a593Smuzhiyun #else
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun #define SNIC_TRC(_hno, _tag, d1, d2, d3, d4, d5) \
98*4882a593Smuzhiyun do { \
99*4882a593Smuzhiyun if (unlikely(snic_log_level & 0x2)) \
100*4882a593Smuzhiyun SNIC_DBG("SnicTrace: %s %2u %2u %llx %llx %llx %llx %llx", \
101*4882a593Smuzhiyun (char *)__func__, \
102*4882a593Smuzhiyun (u16)(_hno), \
103*4882a593Smuzhiyun (u32)(_tag), \
104*4882a593Smuzhiyun (u64)(d1), \
105*4882a593Smuzhiyun (u64)(d2), \
106*4882a593Smuzhiyun (u64)(d3), \
107*4882a593Smuzhiyun (u64)(d4), \
108*4882a593Smuzhiyun (u64)(d5)); \
109*4882a593Smuzhiyun } while (0)
110*4882a593Smuzhiyun #endif /* end of CONFIG_SCSI_SNIC_DEBUG_FS */
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun #define SNIC_TRC_CMD(sc) \
113*4882a593Smuzhiyun ((u64)sc->cmnd[0] << 56 | (u64)sc->cmnd[7] << 40 | \
114*4882a593Smuzhiyun (u64)sc->cmnd[8] << 32 | (u64)sc->cmnd[2] << 24 | \
115*4882a593Smuzhiyun (u64)sc->cmnd[3] << 16 | (u64)sc->cmnd[4] << 8 | \
116*4882a593Smuzhiyun (u64)sc->cmnd[5])
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun #define SNIC_TRC_CMD_STATE_FLAGS(sc) \
119*4882a593Smuzhiyun ((u64) CMD_FLAGS(sc) << 32 | CMD_STATE(sc))
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun #endif /* end of __SNIC_TRC_H */
122