event/octeontx: add dump function for easier debugging
[dpdk.git] / lib / librte_power / guest_channel.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 #ifndef _GUEST_CHANNEL_H
34 #define _GUEST_CHANNEL_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <channel_commands.h>
41
42 /**
43  * Connect to the Virtio-Serial VM end-point located in path. It is
44  * thread safe for unique lcore_ids. This function must be only called once from
45  * each lcore.
46  *
47  * @param path
48  *  The path to the serial device on the filesystem
49  * @param lcore_id
50  *  lcore_id.
51  *
52  * @return
53  *  - 0 on success.
54  *  - Negative on error.
55  */
56 int guest_channel_host_connect(const char *path, unsigned lcore_id);
57
58 /**
59  * Disconnect from an already connected Virtio-Serial Endpoint.
60  *
61  *
62  * @param lcore_id
63  *  lcore_id.
64  *
65  */
66 void guest_channel_host_disconnect(unsigned lcore_id);
67
68 /**
69  * Send a message contained in pkt over the Virtio-Serial to the host endpoint.
70  *
71  * @param pkt
72  *  Pointer to a populated struct guest_agent_pkt
73  *
74  * @param lcore_id
75  *  lcore_id.
76  *
77  * @return
78  *  - 0 on success.
79  *  - Negative on channel not connected.
80  *  - errno on write to channel error.
81  */
82 int guest_channel_send_msg(struct channel_packet *pkt, unsigned lcore_id);
83
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif