1 /******************************************************************************
2  *
3  * This file is provided under a dual BSD/GPLv2 license.  When using or
4  * redistributing this file, you may do so under either license.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of version 2 of the GNU General Public License as
14  * published by the Free Software Foundation.
15  *
16  * This program is distributed in the hope that it will be useful, but
17  * WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.
23  *
24  * The full GNU General Public License is included in this distribution
25  * in the file called COPYING.
26  *
27  * Contact Information:
28  *  Intel Linux Wireless <linuxwifi@intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
34  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
35  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
36  * All rights reserved.
37  *
38  * Redistribution and use in source and binary forms, with or without
39  * modification, are permitted provided that the following conditions
40  * are met:
41  *
42  *  * Redistributions of source code must retain the above copyright
43  *    notice, this list of conditions and the following disclaimer.
44  *  * Redistributions in binary form must reproduce the above copyright
45  *    notice, this list of conditions and the following disclaimer in
46  *    the documentation and/or other materials provided with the
47  *    distribution.
48  *  * Neither the name Intel Corporation nor the names of its
49  *    contributors may be used to endorse or promote products derived
50  *    from this software without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63  *
64  *****************************************************************************/
65 #include "api/commands.h"
66 #include "debugfs.h"
67 
68 #define FWRT_DEBUGFS_READ_FILE_OPS(name)				\
69 static ssize_t iwl_dbgfs_##name##_read(struct iwl_fw_runtime *fwrt,	\
70 				       char *buf, size_t count,		\
71 				       loff_t *ppos);			\
72 static const struct file_operations iwl_dbgfs_##name##_ops = {		\
73 	.read = iwl_dbgfs_##name##_read,				\
74 	.open = simple_open,						\
75 	.llseek = generic_file_llseek,					\
76 }
77 
78 #define FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen)			\
79 static ssize_t iwl_dbgfs_##name##_write(struct iwl_fw_runtime *fwrt,	\
80 					char *buf, size_t count,	\
81 					loff_t *ppos);			\
82 static ssize_t _iwl_dbgfs_##name##_write(struct file *file,		\
83 					 const char __user *user_buf,	\
84 					 size_t count, loff_t *ppos)	\
85 {									\
86 	struct iwl_fw_runtime *fwrt = file->private_data;		\
87 	char buf[buflen] = {};						\
88 	size_t buf_size = min(count, sizeof(buf) -  1);			\
89 									\
90 	if (copy_from_user(buf, user_buf, buf_size))			\
91 		return -EFAULT;						\
92 									\
93 	return iwl_dbgfs_##name##_write(fwrt, buf, buf_size, ppos);	\
94 }
95 
96 #define FWRT_DEBUGFS_READ_WRITE_FILE_OPS(name, buflen)			\
97 FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen)				\
98 static const struct file_operations iwl_dbgfs_##name##_ops = {		\
99 	.write = _iwl_dbgfs_##name##_write,				\
100 	.read = iwl_dbgfs_##name##_read,				\
101 	.open = simple_open,						\
102 	.llseek = generic_file_llseek,					\
103 }
104 
105 #define FWRT_DEBUGFS_WRITE_FILE_OPS(name, buflen)			\
106 FWRT_DEBUGFS_WRITE_WRAPPER(name, buflen)				\
107 static const struct file_operations iwl_dbgfs_##name##_ops = {		\
108 	.write = _iwl_dbgfs_##name##_write,				\
109 	.open = simple_open,						\
110 	.llseek = generic_file_llseek,					\
111 }
112 
113 #define FWRT_DEBUGFS_ADD_FILE_ALIAS(alias, name, parent, mode) do {	\
114 		if (!debugfs_create_file(alias, mode, parent, fwrt,	\
115 					 &iwl_dbgfs_##name##_ops))	\
116 			goto err;					\
117 	} while (0)
118 #define FWRT_DEBUGFS_ADD_FILE(name, parent, mode) \
119 	FWRT_DEBUGFS_ADD_FILE_ALIAS(#name, name, parent, mode)
120 
121 static int iwl_fw_send_timestamp_marker_cmd(struct iwl_fw_runtime *fwrt)
122 {
123 	struct iwl_mvm_marker marker = {
124 		.dw_len = sizeof(struct iwl_mvm_marker) / 4,
125 		.marker_id = MARKER_ID_SYNC_CLOCK,
126 
127 		/* the real timestamp is taken from the ftrace clock
128 		 * this is for finding the match between fw and kernel logs
129 		 */
130 		.timestamp = cpu_to_le64(fwrt->timestamp.seq++),
131 	};
132 
133 	struct iwl_host_cmd hcmd = {
134 		.id = MARKER_CMD,
135 		.flags = CMD_ASYNC,
136 		.data[0] = &marker,
137 		.len[0] = sizeof(marker),
138 	};
139 
140 	return iwl_trans_send_cmd(fwrt->trans, &hcmd);
141 }
142 
143 static void iwl_fw_timestamp_marker_wk(struct work_struct *work)
144 {
145 	int ret;
146 	struct iwl_fw_runtime *fwrt =
147 		container_of(work, struct iwl_fw_runtime, timestamp.wk.work);
148 	unsigned long delay = fwrt->timestamp.delay;
149 
150 	ret = iwl_fw_send_timestamp_marker_cmd(fwrt);
151 	if (!ret && delay)
152 		schedule_delayed_work(&fwrt->timestamp.wk,
153 				      round_jiffies_relative(delay));
154 	else
155 		IWL_INFO(fwrt,
156 			 "stopping timestamp_marker, ret: %d, delay: %u\n",
157 			 ret, jiffies_to_msecs(delay) / 1000);
158 }
159 
160 static ssize_t iwl_dbgfs_timestamp_marker_write(struct iwl_fw_runtime *fwrt,
161 						char *buf, size_t count,
162 						loff_t *ppos)
163 {
164 	int ret;
165 	u32 delay;
166 
167 	ret = kstrtou32(buf, 10, &delay);
168 	if (ret < 0)
169 		return ret;
170 
171 	IWL_INFO(fwrt,
172 		 "starting timestamp_marker trigger with delay: %us\n",
173 		 delay);
174 
175 	iwl_fw_cancel_timestamp(fwrt);
176 
177 	fwrt->timestamp.delay = msecs_to_jiffies(delay * 1000);
178 
179 	schedule_delayed_work(&fwrt->timestamp.wk,
180 			      round_jiffies_relative(fwrt->timestamp.delay));
181 	return count;
182 }
183 
184 FWRT_DEBUGFS_WRITE_FILE_OPS(timestamp_marker, 10);
185 
186 int iwl_fwrt_dbgfs_register(struct iwl_fw_runtime *fwrt,
187 			    struct dentry *dbgfs_dir)
188 {
189 	INIT_DELAYED_WORK(&fwrt->timestamp.wk, iwl_fw_timestamp_marker_wk);
190 	FWRT_DEBUGFS_ADD_FILE(timestamp_marker, dbgfs_dir, S_IWUSR);
191 	return 0;
192 err:
193 	IWL_ERR(fwrt, "Can't create the fwrt debugfs directory\n");
194 	return -ENOMEM;
195 }
196