sound/soc/sof/sof-client-ipc-msg-injector.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 //
   3 // Copyright(c) 2022 Intel Corporation. All rights reserved.
   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
  24 struct 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
  33 static 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
  52 static 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
  72 static 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
 122 static 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         pm_runtime_mark_last_busy(dev);
 141         err = pm_runtime_put_autosuspend(dev);
 142         if (err < 0)
 143                 dev_err_ratelimited(dev, "debugfs write failed to idle %d\n", err);
 144
 145         return ret;
 146 }
 147
 148 static ssize_t sof_msg_inject_dfs_write(struct file *file, const char __user *buffer,
 149                                         size_t count, loff_t *ppos)
 150 {
 151         struct sof_client_dev *cdev = file->private_data;
 152         struct sof_msg_inject_priv *priv = cdev->data;
 153         ssize_t size;
 154         int ret;
 155
 156         if (*ppos)
 157                 return 0;
 158
 159         size = simple_write_to_buffer(priv->tx_buffer, priv->max_msg_size,
 160                                       ppos, buffer, count);
 161         if (size < 0)
 162                 return size;
 163         if (size != count)
 164                 return -EFAULT;
 165
 166         memset(priv->rx_buffer, 0, priv->max_msg_size);
 167
 168         ret = sof_msg_inject_send_message(cdev);
 169
 170         /* return the error code if test failed */
 171         if (ret < 0)
 172                 size = ret;
 173
 174         return size;
 175 };
 176
 177 static ssize_t sof_msg_inject_ipc4_dfs_write(struct file *file,
 178                                              const char __user *buffer,
 179                                              size_t count, loff_t *ppos)
 180 {
 181         struct sof_client_dev *cdev = file->private_data;
 182         struct sof_msg_inject_priv *priv = cdev->data;
 183         struct sof_ipc4_msg *ipc4_msg = priv->tx_buffer;
 184         ssize_t size;
 185         int ret;
 186
 187         if (*ppos)
 188                 return 0;
 189
 190         if (count < sizeof(ipc4_msg->header_u64))
 191                 return -EINVAL;
 192
 193         /* copy the header first */
 194         size = simple_write_to_buffer(&ipc4_msg->header_u64,
 195                                       sizeof(ipc4_msg->header_u64),
 196                                       ppos, buffer, count);
 197         if (size < 0)
 198                 return size;
 199         if (size != sizeof(ipc4_msg->header_u64))
 200                 return -EFAULT;
 201
 202         count -= size;
 203         /* Copy the payload */
 204         size = simple_write_to_buffer(ipc4_msg->data_ptr,
 205                                       priv->max_msg_size, ppos, buffer,
 206                                       count);
 207         if (size < 0)
 208                 return size;
 209         if (size != count)
 210                 return -EFAULT;
 211
 212         ipc4_msg->data_size = count;
 213
 214         /* Initialize the reply storage */
 215         ipc4_msg = priv->rx_buffer;
 216         ipc4_msg->header_u64 = 0;
 217         ipc4_msg->data_size = priv->max_msg_size;
 218         memset(ipc4_msg->data_ptr, 0, priv->max_msg_size);
 219
 220         ret = sof_msg_inject_send_message(cdev);
 221
 222         /* return the error code if test failed */
 223         if (ret < 0)
 224                 size = ret;
 225
 226         return size;
 227 };
 228
 229 static int sof_msg_inject_dfs_release(struct inode *inode, struct file *file)
 230 {
 231         debugfs_file_put(file->f_path.dentry);
 232
 233         return 0;
 234 }
 235
 236 static const struct file_operations sof_msg_inject_fops = {
 237         .open = sof_msg_inject_dfs_open,
 238         .read = sof_msg_inject_dfs_read,
 239         .write = sof_msg_inject_dfs_write,
 240         .llseek = default_llseek,
 241         .release = sof_msg_inject_dfs_release,
 242
 243         .owner = THIS_MODULE,
 244 };
 245
 246 static const struct file_operations sof_msg_inject_ipc4_fops = {
 247         .open = sof_msg_inject_dfs_open,
 248         .read = sof_msg_inject_ipc4_dfs_read,
 249         .write = sof_msg_inject_ipc4_dfs_write,
 250         .llseek = default_llseek,
 251         .release = sof_msg_inject_dfs_release,
 252
 253         .owner = THIS_MODULE,
 254 };
 255
 256 static int sof_msg_inject_probe(struct auxiliary_device *auxdev,
 257                                 const struct auxiliary_device_id *id)
 258 {
 259         struct sof_client_dev *cdev = auxiliary_dev_to_sof_client_dev(auxdev);
 260         struct dentry *debugfs_root = sof_client_get_debugfs_root(cdev);
 261         static const struct file_operations *fops;
 262         struct device *dev = &auxdev->dev;
 263         struct sof_msg_inject_priv *priv;
 264         size_t alloc_size;
 265
 266         /* allocate memory for client data */
 267         priv = devm_kzalloc(&auxdev->dev, sizeof(*priv), GFP_KERNEL);
 268         if (!priv)
 269                 return -ENOMEM;
 270
 271         priv->ipc_type = sof_client_get_ipc_type(cdev);
 272         priv->max_msg_size = sof_client_get_ipc_max_payload_size(cdev);
 273         alloc_size = priv->max_msg_size;
 274
 275         if (priv->ipc_type == SOF_INTEL_IPC4)
 276                 alloc_size += sizeof(struct sof_ipc4_msg);
 277
 278         priv->tx_buffer = devm_kmalloc(dev, alloc_size, GFP_KERNEL);
 279         priv->rx_buffer = devm_kzalloc(dev, alloc_size, GFP_KERNEL);
 280         if (!priv->tx_buffer || !priv->rx_buffer)
 281                 return -ENOMEM;
 282
 283         if (priv->ipc_type == SOF_INTEL_IPC4) {
 284                 struct sof_ipc4_msg *ipc4_msg;
 285
 286                 ipc4_msg = priv->tx_buffer;
 287                 ipc4_msg->data_ptr = priv->tx_buffer + sizeof(struct sof_ipc4_msg);
 288
 289                 ipc4_msg = priv->rx_buffer;
 290                 ipc4_msg->data_ptr = priv->rx_buffer + sizeof(struct sof_ipc4_msg);
 291
 292                 fops = &sof_msg_inject_ipc4_fops;
 293         } else {
 294                 fops = &sof_msg_inject_fops;
 295         }
 296
 297         cdev->data = priv;
 298
 299         priv->dfs_file = debugfs_create_file("ipc_msg_inject", 0644, debugfs_root,
 300                                              cdev, fops);
 301
 302         /* enable runtime PM */
 303         pm_runtime_set_autosuspend_delay(dev, SOF_IPC_CLIENT_SUSPEND_DELAY_MS);
 304         pm_runtime_use_autosuspend(dev);
 305         pm_runtime_enable(dev);
 306         pm_runtime_mark_last_busy(dev);
 307         pm_runtime_idle(dev);
 308
 309         return 0;
 310 }
 311
 312 static void sof_msg_inject_remove(struct auxiliary_device *auxdev)
 313 {
 314         struct sof_client_dev *cdev = auxiliary_dev_to_sof_client_dev(auxdev);
 315         struct sof_msg_inject_priv *priv = cdev->data;
 316
 317         pm_runtime_disable(&auxdev->dev);
 318
 319         debugfs_remove(priv->dfs_file);
 320 }
 321
 322 static const struct auxiliary_device_id sof_msg_inject_client_id_table[] = {
 323         { .name = "snd_sof.msg_injector" },
 324         {},
 325 };
 326 MODULE_DEVICE_TABLE(auxiliary, sof_msg_inject_client_id_table);
 327
 328 /*
 329  * No need for driver pm_ops as the generic pm callbacks in the auxiliary bus
 330  * type are enough to ensure that the parent SOF device resumes to bring the DSP
 331  * back to D0.
 332  * Driver name will be set based on KBUILD_MODNAME.
 333  */
 334 static struct auxiliary_driver sof_msg_inject_client_drv = {
 335         .probe = sof_msg_inject_probe,
 336         .remove = sof_msg_inject_remove,
 337
 338         .id_table = sof_msg_inject_client_id_table,
 339 };
 340
 341 module_auxiliary_driver(sof_msg_inject_client_drv);
 342
 343 MODULE_DESCRIPTION("SOF IPC Message Injector Client Driver");
 344 MODULE_LICENSE("GPL");
 345 MODULE_IMPORT_NS(SND_SOC_SOF_CLIENT);