sof-client-ipc-msg-injector.c

  1// SPDX-License-Identifier: GPL-2.0-only
  2//
  3// Copyright(c) 2022 Intel Corporation
  4//
  5// Author: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
  6//
  7
  8#include <linux/auxiliary_bus.h>
  9#include <linux/completion.h>
 10#include <linux/debugfs.h>
 11#include <linux/ktime.h>
 12#include <linux/mod_devicetable.h>
 13#include <linux/module.h>
 14#include <linux/pm_runtime.h>
 15#include <linux/slab.h>
 16#include <linux/uaccess.h>
 17#include <sound/sof/header.h>
 18#include <sound/sof/ipc4/header.h>
 19
 20#include "sof-client.h"
 21
 22#define SOF_IPC_CLIENT_SUSPEND_DELAY_MS	3000
 23
 24struct sof_msg_inject_priv {
 25	struct dentry *dfs_file;
 26	size_t max_msg_size;
 27	enum sof_ipc_type ipc_type;
 28
 29	void *tx_buffer;
 30	void *rx_buffer;
 31};
 32
 33static int sof_msg_inject_dfs_open(struct inode *inode, struct file *file)
 34{
 35	struct sof_client_dev *cdev = inode->i_private;
 36	int ret;
 37
 38	if (sof_client_get_fw_state(cdev) == SOF_FW_CRASHED)
 39		return -ENODEV;
 40
 41	ret = debugfs_file_get(file->f_path.dentry);
 42	if (unlikely(ret))
 43		return ret;
 44
 45	ret = simple_open(inode, file);
 46	if (ret)
 47		debugfs_file_put(file->f_path.dentry);
 48
 49	return ret;
 50}
 51
 52static ssize_t sof_msg_inject_dfs_read(struct file *file, char __user *buffer,
 53				       size_t count, loff_t *ppos)
 54{
 55	struct sof_client_dev *cdev = file->private_data;
 56	struct sof_msg_inject_priv *priv = cdev->data;
 57	struct sof_ipc_reply *rhdr = priv->rx_buffer;
 58
 59	if (!rhdr->hdr.size || !count || *ppos)
 60		return 0;
 61
 62	if (count > rhdr->hdr.size)
 63		count = rhdr->hdr.size;
 64
 65	if (copy_to_user(buffer, priv->rx_buffer, count))
 66		return -EFAULT;
 67
 68	*ppos += count;
 69	return count;
 70}
 71
 72static ssize_t sof_msg_inject_ipc4_dfs_read(struct file *file,
 73					    char __user *buffer,
 74					    size_t count, loff_t *ppos)
 75{
 76	struct sof_client_dev *cdev = file->private_data;
 77	struct sof_msg_inject_priv *priv = cdev->data;
 78	struct sof_ipc4_msg *ipc4_msg = priv->rx_buffer;
 79	size_t header_size = sizeof(ipc4_msg->header_u64);
 80	size_t remaining;
 81
 82	if (!ipc4_msg->header_u64 || !count || *ppos)
 83		return 0;
 84
 85	/* we need space for the header at minimum (u64) */
 86	if (count < header_size)
 87		return -ENOSPC;
 88
 89	remaining = header_size;
 90
 91	/* Only get large config have payload */
 92	if (SOF_IPC4_MSG_IS_MODULE_MSG(ipc4_msg->primary) &&
 93	    (SOF_IPC4_MSG_TYPE_GET(ipc4_msg->primary) == SOF_IPC4_MOD_LARGE_CONFIG_GET))
 94		remaining += ipc4_msg->data_size;
 95
 96	if (count > remaining)
 97		count = remaining;
 98	else if (count < remaining)
 99		remaining = count;
100
101	/* copy the header first */
102	if (copy_to_user(buffer, &ipc4_msg->header_u64, header_size))
103		return -EFAULT;
104
105	*ppos += header_size;
106	remaining -= header_size;
107
108	if (!remaining)
109		return count;
110
111	if (remaining > ipc4_msg->data_size)
112		remaining = ipc4_msg->data_size;
113
114	/* Copy the payload */
115	if (copy_to_user(buffer + *ppos, ipc4_msg->data_ptr, remaining))
116		return -EFAULT;
117
118	*ppos += remaining;
119	return count;
120}
121
122static int sof_msg_inject_send_message(struct sof_client_dev *cdev)
123{
124	struct sof_msg_inject_priv *priv = cdev->data;
125	struct device *dev = &cdev->auxdev.dev;
126	int ret, err;
127
128	ret = pm_runtime_resume_and_get(dev);
129	if (ret < 0 && ret != -EACCES) {
130		dev_err_ratelimited(dev, "debugfs write failed to resume %d\n", ret);
131		return ret;
132	}
133
134	/* send the message */
135	ret = sof_client_ipc_tx_message(cdev, priv->tx_buffer, priv->rx_buffer,
136					priv->max_msg_size);
137	if (ret)
138		dev_err(dev, "IPC message send failed: %d\n", ret);
139
140	err = pm_runtime_put_autosuspend(dev);
141	if (err < 0)
142		dev_err_ratelimited(dev, "debugfs write failed to idle %d\n", err);
143
144	return ret;
145}
146
147static ssize_t sof_msg_inject_dfs_write(struct file *file, const char __user *buffer,
148					size_t count, loff_t *ppos)
149{
150	struct sof_client_dev *cdev = file->private_data;
151	struct sof_msg_inject_priv *priv = cdev->data;
152	ssize_t size;
153	int ret;
154
155	if (*ppos)
156		return 0;
157
158	size = simple_write_to_buffer(priv->tx_buffer, priv->max_msg_size,
159				      ppos, buffer, count);
160	if (size < 0)
161		return size;
162	if (size != count)
163		return -EFAULT;
164
165	memset(priv->rx_buffer, 0, priv->max_msg_size);
166
167	ret = sof_msg_inject_send_message(cdev);
168
169	/* return the error code if test failed */
170	if (ret < 0)
171		size = ret;
172
173	return size;
174};
175
176static ssize_t sof_msg_inject_ipc4_dfs_write(struct file *file,
177					     const char __user *buffer,
178					     size_t count, loff_t *ppos)
179{
180	struct sof_client_dev *cdev = file->private_data;
181	struct sof_msg_inject_priv *priv = cdev->data;
182	struct sof_ipc4_msg *ipc4_msg = priv->tx_buffer;
183	size_t data_size;
184	int ret;
185
186	if (*ppos)
187		return 0;
188
189	if (count < sizeof(ipc4_msg->header_u64))
190		return -EINVAL;
191
192	/* copy the header first */
193	if (copy_from_user(&ipc4_msg->header_u64, buffer,
194			   sizeof(ipc4_msg->header_u64)))
195		return -EFAULT;
196
197	data_size = count - sizeof(ipc4_msg->header_u64);
198	if (data_size > priv->max_msg_size)
199		return -EINVAL;
200
201	/* Copy the payload */
202	if (copy_from_user(ipc4_msg->data_ptr,
203			   buffer + sizeof(ipc4_msg->header_u64), data_size))
204		return -EFAULT;
205
206	ipc4_msg->data_size = data_size;
207
208	/* Initialize the reply storage */
209	ipc4_msg = priv->rx_buffer;
210	ipc4_msg->header_u64 = 0;
211	ipc4_msg->data_size = priv->max_msg_size;
212	memset(ipc4_msg->data_ptr, 0, priv->max_msg_size);
213
214	ret = sof_msg_inject_send_message(cdev);
215
216	/* return the error code if test failed */
217	if (ret < 0)
218		return ret;
219
220	return count;
221};
222
223static int sof_msg_inject_dfs_release(struct inode *inode, struct file *file)
224{
225	debugfs_file_put(file->f_path.dentry);
226
227	return 0;
228}
229
230static const struct file_operations sof_msg_inject_fops = {
231	.open = sof_msg_inject_dfs_open,
232	.read = sof_msg_inject_dfs_read,
233	.write = sof_msg_inject_dfs_write,
234	.llseek = default_llseek,
235	.release = sof_msg_inject_dfs_release,
236
237	.owner = THIS_MODULE,
238};
239
240static const struct file_operations sof_msg_inject_ipc4_fops = {
241	.open = sof_msg_inject_dfs_open,
242	.read = sof_msg_inject_ipc4_dfs_read,
243	.write = sof_msg_inject_ipc4_dfs_write,
244	.llseek = default_llseek,
245	.release = sof_msg_inject_dfs_release,
246
247	.owner = THIS_MODULE,
248};
249
250static int sof_msg_inject_probe(struct auxiliary_device *auxdev,
251				const struct auxiliary_device_id *id)
252{
253	struct sof_client_dev *cdev = auxiliary_dev_to_sof_client_dev(auxdev);
254	struct dentry *debugfs_root = sof_client_get_debugfs_root(cdev);
255	static const struct file_operations *fops;
256	struct device *dev = &auxdev->dev;
257	struct sof_msg_inject_priv *priv;
258	size_t alloc_size;
259
260	/* allocate memory for client data */
261	priv = devm_kzalloc(&auxdev->dev, sizeof(*priv), GFP_KERNEL);
262	if (!priv)
263		return -ENOMEM;
264
265	priv->ipc_type = sof_client_get_ipc_type(cdev);
266	priv->max_msg_size = sof_client_get_ipc_max_payload_size(cdev);
267	alloc_size = priv->max_msg_size;
268
269	if (priv->ipc_type == SOF_IPC_TYPE_4)
270		alloc_size += sizeof(struct sof_ipc4_msg);
271
272	priv->tx_buffer = devm_kmalloc(dev, alloc_size, GFP_KERNEL);
273	priv->rx_buffer = devm_kzalloc(dev, alloc_size, GFP_KERNEL);
274	if (!priv->tx_buffer || !priv->rx_buffer)
275		return -ENOMEM;
276
277	if (priv->ipc_type == SOF_IPC_TYPE_4) {
278		struct sof_ipc4_msg *ipc4_msg;
279
280		ipc4_msg = priv->tx_buffer;
281		ipc4_msg->data_ptr = priv->tx_buffer + sizeof(struct sof_ipc4_msg);
282
283		ipc4_msg = priv->rx_buffer;
284		ipc4_msg->data_ptr = priv->rx_buffer + sizeof(struct sof_ipc4_msg);
285
286		fops = &sof_msg_inject_ipc4_fops;
287	} else {
288		fops = &sof_msg_inject_fops;
289	}
290
291	cdev->data = priv;
292
293	priv->dfs_file = debugfs_create_file("ipc_msg_inject", 0644, debugfs_root,
294					     cdev, fops);
295
296	/* enable runtime PM */
297	pm_runtime_set_autosuspend_delay(dev, SOF_IPC_CLIENT_SUSPEND_DELAY_MS);
298	pm_runtime_use_autosuspend(dev);
299	pm_runtime_enable(dev);
300	pm_runtime_mark_last_busy(dev);
301	pm_runtime_idle(dev);
302
303	return 0;
304}
305
306static void sof_msg_inject_remove(struct auxiliary_device *auxdev)
307{
308	struct sof_client_dev *cdev = auxiliary_dev_to_sof_client_dev(auxdev);
309	struct sof_msg_inject_priv *priv = cdev->data;
310
311	pm_runtime_disable(&auxdev->dev);
312
313	debugfs_remove(priv->dfs_file);
314}
315
316static const struct auxiliary_device_id sof_msg_inject_client_id_table[] = {
317	{ .name = "snd_sof.msg_injector" },
318	{},
319};
320MODULE_DEVICE_TABLE(auxiliary, sof_msg_inject_client_id_table);
321
322/*
323 * No need for driver pm_ops as the generic pm callbacks in the auxiliary bus
324 * type are enough to ensure that the parent SOF device resumes to bring the DSP
325 * back to D0.
326 * Driver name will be set based on KBUILD_MODNAME.
327 */
328static struct auxiliary_driver sof_msg_inject_client_drv = {
329	.probe = sof_msg_inject_probe,
330	.remove = sof_msg_inject_remove,
331
332	.id_table = sof_msg_inject_client_id_table,
333};
334
335module_auxiliary_driver(sof_msg_inject_client_drv);
336
337MODULE_LICENSE("GPL");
338MODULE_DESCRIPTION("SOF IPC Message Injector Client Driver");
339MODULE_IMPORT_NS("SND_SOC_SOF_CLIENT");