aboutsummaryrefslogtreecommitdiff
path: root/include/linux/mailbox_client.h
diff options
context:
space:
mode:
authorJassi Brar <jaswinder.singh@linaro.org>2014-06-12 22:31:19 +0530
committerShow Liu <show.liu@linaro.org>2014-06-18 12:05:34 +0800
commit58940f09032fdf5b546bb88f20bf32336a5630e5 (patch)
treeae694c8151a1625b423da12d6f1649bafa8e4e94 /include/linux/mailbox_client.h
parentd06dd64b0c4b748cdd37061d6b7a9e5ff1c9a366 (diff)
downloadlinaro-lsk-58940f09032fdf5b546bb88f20bf32336a5630e5.tar.gz
mailbox: Introduce framework for mailbox
Introduce common framework for client/protocol drivers and controller drivers of Inter-Processor-Communication (IPC). Client driver developers should have a look at include/linux/mailbox_client.h to understand the part of the API exposed to client drivers. Similarly controller driver developers should have a look at include/linux/mailbox_controller.h Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org> Signed-off-by: Mark Brown <broonie@linaro.org>
Diffstat (limited to 'include/linux/mailbox_client.h')
-rw-r--r--include/linux/mailbox_client.h45
1 files changed, 45 insertions, 0 deletions
diff --git a/include/linux/mailbox_client.h b/include/linux/mailbox_client.h
new file mode 100644
index 00000000000..53eb0784261
--- /dev/null
+++ b/include/linux/mailbox_client.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2014 Linaro Ltd.
+ * Author: Jassi Brar <jassisinghbrar@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#ifndef __MAILBOX_CLIENT_H
+#define __MAILBOX_CLIENT_H
+
+#include <linux/of.h>
+
+struct mbox_chan;
+
+/**
+ * struct mbox_client - User of a mailbox
+ * @dev: The client device
+ * @chan_name: The "controller:channel" this client wants
+ * @rx_callback: Atomic callback to provide client the data received
+ * @tx_done: Atomic callback to tell client of data transmission
+ * @tx_block: If the mbox_send_message should block until data is
+ * transmitted.
+ * @tx_tout: Max block period in ms before TX is assumed failure
+ * @knows_txdone: if the client could run the TX state machine. Usually
+ * if the client receives some ACK packet for transmission.
+ * Unused if the controller already has TX_Done/RTR IRQ.
+ */
+struct mbox_client {
+ struct device *dev;
+ const char *chan_name;
+ void (*rx_callback)(struct mbox_client *cl, void *mssg);
+ void (*tx_done)(struct mbox_client *cl, void *mssg, int r);
+ bool tx_block;
+ unsigned long tx_tout;
+ bool knows_txdone;
+};
+
+struct mbox_chan *mbox_request_channel(const struct mbox_client *cl);
+int mbox_send_message(struct mbox_chan *chan, void *mssg);
+void mbox_client_txdone(struct mbox_chan *chan, int r);
+void mbox_free_channel(struct mbox_chan *chan);
+
+#endif /* __MAILBOX_CLIENT_H */