u-boot/include/mailbox.h

10  * A mailbox is a hardware mechanism for transferring small fixed-size messages
14  * Data transfer is optional; a mailbox may consist solely of a notification
16  * FIFOs, rather than via RAM-based buffers. The mailbox API generally
20  * A mailbox channel is a bi-directional mechanism that can send a message or
23  * messages is defined by the mailbox implementation, or the remote entity with
26  * A driver that implements UCLASS_MAILBOX is a mailbox provider. A provider
27  * will often implement multiple separate mailbox channels, since the hardware
28  * it manages often has this capability. mailbox-uclass.h describes the
29  * interface which mailbox providers must implement.
31  * Mailbox consumers/clients generate and send, or receive and process,
38  * struct mbox_chan - A handle to a single mailbox channel.
41  * is managed solely by the mailbox API and mailbox drivers. A mailbox channel
42  * is initialized by "get"ing the mailbox. The channel struct is passed to all
43  * other mailbox APIs to identify which mailbox to operate upon.
45  * @dev: The device which implements the mailbox.
46  * @id: The mailbox channel ID within the provider.
49  * Currently, the mailbox API assumes that a single integer ID is enough to
50  * identify and configure any mailbox channel for any mailbox provider. If this
52  * either (a) add more fields to allow mailbox providers to store additional
66  * mbox_get_by_index - Get/request a mailbox by integer index
68  * This looks up and requests a mailbox channel. The index is relative to the
69  * client device; each device is assumed to have n mailbox channels associated
76  * @index:	The index of the mailbox channel to request, within the
84  * mbox_get_by_name - Get/request a mailbox by name
86  * This looks up and requests a mailbox channel. The name is relative to the
87  * client device; each device is assumed to have n mailbox channels associated
94  * @name:	The name of the mailbox channel to request, within the client's
103  * mbox_free - Free a previously requested mailbox channel.
112  * mbox_send - Send a message over a mailbox channel
121  *		mailbox provider. Providers that solely transfer notifications
128  * mbox_recv - Receive any available message from a mailbox channel
138  *		the mailbox provider. Providers that solely transfer