mailbox_client.h 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * Copyright (C) 2013-2014 Linaro Ltd.
  4. * Author: Jassi Brar <jassisinghbrar@gmail.com>
  5. */
  6. #ifndef __MAILBOX_CLIENT_H
  7. #define __MAILBOX_CLIENT_H
  8. #include <linux/of.h>
  9. #include <linux/device.h>
  10. struct mbox_chan;
  11. /**
  12. * struct mbox_client - User of a mailbox
  13. * @dev: The client device
  14. * @tx_block: If the mbox_send_message should block until data is
  15. * transmitted.
  16. * @tx_tout: Max block period in ms before TX is assumed failure
  17. * @knows_txdone: If the client could run the TX state machine. Usually
  18. * if the client receives some ACK packet for transmission.
  19. * Unused if the controller already has TX_Done/RTR IRQ.
  20. * @rx_callback: Atomic callback to provide client the data received
  21. * @tx_prepare: Atomic callback to ask client to prepare the payload
  22. * before initiating the transmission if required.
  23. * @tx_done: Atomic callback to tell client of data transmission
  24. */
  25. struct mbox_client {
  26. struct device *dev;
  27. bool tx_block;
  28. unsigned long tx_tout;
  29. bool knows_txdone;
  30. void (*rx_callback)(struct mbox_client *cl, void *mssg);
  31. void (*tx_prepare)(struct mbox_client *cl, void *mssg);
  32. void (*tx_done)(struct mbox_client *cl, void *mssg, int r);
  33. };
  34. struct mbox_chan *mbox_request_channel_byname(struct mbox_client *cl,
  35. const char *name);
  36. struct mbox_chan *mbox_request_channel(struct mbox_client *cl, int index);
  37. int mbox_send_message(struct mbox_chan *chan, void *mssg);
  38. int mbox_flush(struct mbox_chan *chan, unsigned long timeout);
  39. void mbox_client_txdone(struct mbox_chan *chan, int r); /* atomic */
  40. bool mbox_client_peek_data(struct mbox_chan *chan); /* atomic */
  41. void mbox_free_channel(struct mbox_chan *chan); /* may sleep */
  42. #endif /* __MAILBOX_CLIENT_H */