IPC: Extend VirtQueue slave API
[gstreamer-omap:sysbios-rpmsg.git] / src / ti / ipc / rpmsg / VirtQueue.h
1 /*
2  * Copyright (c) 2011, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /** ============================================================================
33  *  @file       VirtQueue.h
34  *
35  *  @brief      Virtio Queue interface for BIOS
36  *
37  *  Differences between BIOS version and Linux kernel (include/linux/virtio.h):
38  *  - Renamed module from virtio.h to VirtQueue.h to match the API prefixes;
39  *  - BIOS (XDC) types and CamelCasing used;
40  *  - virtio_device concept removed (i.e, assumes no containing device);
41  *  - removed scatterlist;
42  *  - VirtQueues are created statically here, so just added a VirtQueue_init()
43  *    fxn to take the place of the Virtio vring_new_virtqueue() API;
44  *  - The notify function is implicit in the implementation, and not provided
45  *    by the client, as it is in Linux virtio.
46  *  - Broke into APIs to add/get used and avail buffers, as the API is
47  *    assymmetric.
48  *
49  *  Usage:
50  *     This IPC only works between one processor designated as the Host (Linux)
51  *     and one or more Slave processors (BIOS).
52  *
53  *     For any Host/Slave pair, there are 2 VirtQueues (aka Vrings);
54  *     Only the Host adds new buffers to the avail list of a vring;
55  *     Available buffers can be empty or full, depending on direction;
56  *     Used buffer means "processed" (emptied or filled);
57  *
58  *  Host:
59  *    - To send buffer to the slave processor:
60  *          add_avail_buf(slave_virtqueue);
61  *          kick(slave_virtqueue);
62  *          get_used_buf(slave_virtqueue);
63  *    - To receive buffer from slave processor:
64  *          add_avail_buf(host_virtqueue);
65  *          kick(host_virtqueue);
66  *          get_used_buf(host_virtqueue);
67  *
68  *  Slave:
69  *    - To send buffer to the host:
70  *          get_avail_buf(host_virtqueue);
71  *          add_used_buf(host_virtqueue);
72  *          kick(host_virtqueue);
73  *    - To receive buffer from the host:
74  *          get_avail_buf(slave_virtqueue);
75  *          add_used_buf(slave_virtqueue);
76  *          kick(slave_virtqueue);
77  *
78  *  All VirtQueue operations can be called in any context.
79  *
80  *  The virtio header should be included in an application as follows:
81  *  @code
82  *  #include <ti/ipc/rpmsg/VirtQueue.h>
83  *  @endcode
84  *
85  *  ============================================================================
86  */
87
88 #ifndef ti_ipc_VirtQueue__include
89 #define ti_ipc_VirtQueue__include
90
91 #if defined (__cplusplus)
92 extern "C" {
93 #endif
94
95 /*!
96  *  @brief  VirtQueue Ids for the basic IPC transport rings.
97  */
98 #define ID_SELF_TO_A9      0
99 #define ID_A9_TO_SELF      1
100
101 /*!
102  *  @brief  Size of buffer being exchanged in the VirtQueue rings.
103  */
104 #define RP_MSG_BUF_SIZE     (512)
105
106
107 /*!
108  *  @brief  a queue to register buffers for sending or receiving.
109  */
110 typedef struct VirtQueue_Object *VirtQueue_Handle;
111
112 /*!
113  *  @var     VirtQueue_callback
114  *  @brief   Signature of any callback function that can be registered with the
115  *           VirtQueue
116  *
117  *  @param[in]  VirtQueue     Pointer to the VirtQueue which was signalled.
118  */
119 typedef Void (*VirtQueue_callback)(VirtQueue_Handle);
120
121 /*!
122  *  @brief      Initialize at runtime the VirtQueue
123  *
124  *  @param[in]  callback  the clients callback function.
125  *  @param[in]  procId    Processor ID associated with this VirtQueue.
126  *  @param[in]  vqId      VirtQueue ID for this VirtQueue.
127  *
128  *  @Returns    Returns a handle to a new initialized VirtQueue.
129  */
130 VirtQueue_Handle VirtQueue_create(VirtQueue_callback callback, UInt16 procId,
131                                   Int vqId);
132
133 /*!
134  *  @brief      Notify other processor of new buffers in the queue.
135  *
136  *  After one or more add_buf calls, invoke this to kick the other side.
137  *
138  *  @param[in]  vq        the VirtQueue.
139  *
140  *  @sa         VirtQueue_addBuf
141  */
142 Void VirtQueue_kick(VirtQueue_Handle vq);
143
144 /*!
145  *  @brief       Used at startup-time for initialization
146  *
147  *  Should be called before any other VirtQueue APIs
148  */
149 Void VirtQueue_startup();
150
151
152 /*
153  *  ============================================================================
154  *  Host Only Functions:
155  *  ============================================================================
156  */
157
158 /*!
159  *  @brief      Add available buffer to virtqueue's available buffer list.
160  *              Only used by Host.
161  *
162  *  @param[in]  vq        the VirtQueue.
163  *  @param[in]  buf      the buffer to be processed by the slave.
164  *
165  *  @return     Remaining capacity of queue or a negative error.
166  *
167  *  @sa         VirtQueue_getUsedBuf
168  */
169 Int VirtQueue_addAvailBuf(VirtQueue_Handle vq, Void *buf);
170
171 /*!
172  *  @brief      Get the next used buffer.
173  *              Only used by Host.
174  *
175  *  @param[in]  vq        the VirtQueue.
176  *
177  *  @return     Returns NULL or the processed buffer.
178  *
179  *  @sa         VirtQueue_addAvailBuf
180  */
181 Void *VirtQueue_getUsedBuf(VirtQueue_Handle vq);
182
183 /*
184  *  ============================================================================
185  *  Slave Only Functions:
186  *  ============================================================================
187  */
188
189 /*!
190  *  @brief      Get the next available buffer.
191  *              Only used by Slave.
192  *
193  *  @param[in]  vq        the VirtQueue.
194  *  @param[out] buf       Pointer to location of available buffer;
195  *  @param[out] len       Length of the available buffer message.
196  *
197  *  @return     Returns a token used to identify the available buffer, to be
198  *              passed back into VirtQueue_addUsedBuf();
199  *              token is negative if failure to find an available buffer.
200  *
201  *  @sa         VirtQueue_addUsedBuf
202  */
203 Int16 VirtQueue_getAvailBuf(VirtQueue_Handle vq, Void **buf, Int *len);
204
205 /*!
206  *  @brief      Add used buffer to virtqueue's used buffer list.
207  *              Only used by Slave.
208  *
209  *  @param[in]  vq        the VirtQueue.
210  *  @param[in]  token     token of the buffer to be added to vring used list.
211  *  @param[in]  len       length of the message being added.
212  *
213  *  @return     Remaining capacity of queue or a negative error.
214  *
215  *  @sa         VirtQueue_getAvailBuf
216  */
217 Int VirtQueue_addUsedBuf(VirtQueue_Handle vq, Int16 token, Int len);
218
219 /*!
220  *  @brief      Post crash message to host mailbox
221  */
222 Void VirtQueue_postCrashToMailbox(Void);
223
224 /*!
225  *  @brief      Post a init done message to host
226  */
227 Void VirtQueue_postInitDone(Void);
228
229
230 #if defined (__cplusplus)
231 }
232 #endif /* defined (__cplusplus) */
233
234 #endif /* ti_ipc_VirtQueue__include */