1 /* SPDX-License-Identifier: GPL-2.0-only */ <<
2 /* 1 /*
3 * Copyright (C) 2013-2014 Linaro Ltd. 2 * Copyright (C) 2013-2014 Linaro Ltd.
4 * Author: Jassi Brar <jassisinghbrar@gmail.co 3 * Author: Jassi Brar <jassisinghbrar@gmail.com>
>> 4 *
>> 5 * This program is free software; you can redistribute it and/or modify
>> 6 * it under the terms of the GNU General Public License version 2 as
>> 7 * published by the Free Software Foundation.
5 */ 8 */
6 9
7 #ifndef __MAILBOX_CLIENT_H 10 #ifndef __MAILBOX_CLIENT_H
8 #define __MAILBOX_CLIENT_H 11 #define __MAILBOX_CLIENT_H
9 12
10 #include <linux/of.h> 13 #include <linux/of.h>
11 #include <linux/device.h> 14 #include <linux/device.h>
12 15
13 struct mbox_chan; 16 struct mbox_chan;
14 17
15 /** 18 /**
16 * struct mbox_client - User of a mailbox 19 * struct mbox_client - User of a mailbox
17 * @dev: The client device 20 * @dev: The client device
18 * @tx_block: If the mbox_send_messa 21 * @tx_block: If the mbox_send_message should block until data is
19 * transmitted. 22 * transmitted.
20 * @tx_tout: Max block period in ms 23 * @tx_tout: Max block period in ms before TX is assumed failure
21 * @knows_txdone: If the client could ru 24 * @knows_txdone: If the client could run the TX state machine. Usually
22 * if the client receives 25 * if the client receives some ACK packet for transmission.
23 * Unused if the controll 26 * Unused if the controller already has TX_Done/RTR IRQ.
24 * @rx_callback: Atomic callback to pro 27 * @rx_callback: Atomic callback to provide client the data received
25 * @tx_prepare: Atomic callback to ask 28 * @tx_prepare: Atomic callback to ask client to prepare the payload
26 * before initiating the 29 * before initiating the transmission if required.
27 * @tx_done: Atomic callback to tel 30 * @tx_done: Atomic callback to tell client of data transmission
28 */ 31 */
29 struct mbox_client { 32 struct mbox_client {
30 struct device *dev; 33 struct device *dev;
31 bool tx_block; 34 bool tx_block;
32 unsigned long tx_tout; 35 unsigned long tx_tout;
33 bool knows_txdone; 36 bool knows_txdone;
34 37
35 void (*rx_callback)(struct mbox_client 38 void (*rx_callback)(struct mbox_client *cl, void *mssg);
36 void (*tx_prepare)(struct mbox_client 39 void (*tx_prepare)(struct mbox_client *cl, void *mssg);
37 void (*tx_done)(struct mbox_client *cl 40 void (*tx_done)(struct mbox_client *cl, void *mssg, int r);
38 }; 41 };
39 42
40 int mbox_bind_client(struct mbox_chan *chan, s <<
41 struct mbox_chan *mbox_request_channel_byname( 43 struct mbox_chan *mbox_request_channel_byname(struct mbox_client *cl,
42 44 const char *name);
43 struct mbox_chan *mbox_request_channel(struct 45 struct mbox_chan *mbox_request_channel(struct mbox_client *cl, int index);
44 int mbox_send_message(struct mbox_chan *chan, 46 int mbox_send_message(struct mbox_chan *chan, void *mssg);
45 int mbox_flush(struct mbox_chan *chan, unsigne 47 int mbox_flush(struct mbox_chan *chan, unsigned long timeout);
46 void mbox_client_txdone(struct mbox_chan *chan 48 void mbox_client_txdone(struct mbox_chan *chan, int r); /* atomic */
47 bool mbox_client_peek_data(struct mbox_chan *c 49 bool mbox_client_peek_data(struct mbox_chan *chan); /* atomic */
48 void mbox_free_channel(struct mbox_chan *chan) 50 void mbox_free_channel(struct mbox_chan *chan); /* may sleep */
49 51
50 #endif /* __MAILBOX_CLIENT_H */ 52 #endif /* __MAILBOX_CLIENT_H */
51 53
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.