kernel/sound/soc/intel/common/sst-ipc.h

   1 /*
   2  * Intel SST generic IPC Support
   3  *
   4  * Copyright (C) 2015, Intel Corporation. All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License version
   8  * 2 as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  */
  16
  17 #ifndef __SST_GENERIC_IPC_H
  18 #define __SST_GENERIC_IPC_H
  19
  20 #include <linux/types.h>
  21 #include <linux/kernel.h>
  22 #include <linux/wait.h>
  23 #include <linux/list.h>
  24 #include <linux/workqueue.h>
  25 #include <linux/sched.h>
  26 #include <linux/kthread.h>
  27
  28 #define IPC_MAX_MAILBOX_BYTES   256
  29
  30 struct ipc_message {
  31         struct list_head list;
  32         u64 header;
  33
  34         /* direction wrt host CPU */
  35         char *tx_data;
  36         size_t tx_size;
  37         char *rx_data;
  38         size_t rx_size;
  39
  40         wait_queue_head_t waitq;
  41         bool pending;
  42         bool complete;
  43         bool wait;
  44         int errno;
  45 };
  46
  47 struct sst_generic_ipc;
  48
  49 struct sst_plat_ipc_ops {
  50         void (*tx_msg)(struct sst_generic_ipc *, struct ipc_message *);
  51         void (*shim_dbg)(struct sst_generic_ipc *, const char *);
  52         void (*tx_data_copy)(struct ipc_message *, char *, size_t);
  53         u64  (*reply_msg_match)(u64 header, u64 *mask);
  54         bool (*is_dsp_busy)(struct sst_dsp *dsp);
  55 };
  56
  57 /* SST generic IPC data */
  58 struct sst_generic_ipc {
  59         struct device *dev;
  60         struct sst_dsp *dsp;
  61
  62         /* IPC messaging */
  63         struct list_head tx_list;
  64         struct list_head rx_list;
  65         struct list_head empty_list;
  66         wait_queue_head_t wait_txq;
  67         struct task_struct *tx_thread;
  68         struct kthread_worker kworker;
  69         struct kthread_work kwork;
  70         bool pending;
  71         struct ipc_message *msg;
  72         int tx_data_max_size;
  73         int rx_data_max_size;
  74
  75         struct sst_plat_ipc_ops ops;
  76 };
  77
  78 int sst_ipc_tx_message_wait(struct sst_generic_ipc *ipc, u64 header,
  79         void *tx_data, size_t tx_bytes, void *rx_data, size_t rx_bytes);
  80
  81 int sst_ipc_tx_message_nowait(struct sst_generic_ipc *ipc, u64 header,
  82         void *tx_data, size_t tx_bytes);
  83
  84 struct ipc_message *sst_ipc_reply_find_msg(struct sst_generic_ipc *ipc,
  85         u64 header);
  86
  87 void sst_ipc_tx_msg_reply_complete(struct sst_generic_ipc *ipc,
  88         struct ipc_message *msg);
  89
  90 void sst_ipc_drop_all(struct sst_generic_ipc *ipc);
  91 int sst_ipc_init(struct sst_generic_ipc *ipc);
  92 void sst_ipc_fini(struct sst_generic_ipc *ipc);
  93
  94 #endif