examples/packet_ordering: enhance getopt_long usage
[dpdk.git] / lib / librte_power / guest_channel.h
index 8ea19b5..43d532a 100644 (file)
@@ -8,7 +8,17 @@
 extern "C" {
 #endif
 
-#include <channel_commands.h>
+/**
+ * Check if any Virtio-Serial VM end-points exist in path.
+ *
+ * @param path
+ *  The path to the serial device on the filesystem
+ *
+ * @return
+ *  - 1 if at least one potential end-point found.
+ *  - 0 if no end-points found.
+ */
+int guest_channel_host_check_exists(const char *path);
 
 /**
  * Connect to the Virtio-Serial VM end-point located in path. It is
@@ -17,6 +27,7 @@ extern "C" {
  *
  * @param path
  *  The path to the serial device on the filesystem
+ *
  * @param lcore_id
  *  lcore_id.
  *
@@ -24,7 +35,7 @@ extern "C" {
  *  - 0 on success.
  *  - Negative on error.
  */
-int guest_channel_host_connect(const char *path, unsigned lcore_id);
+int guest_channel_host_connect(const char *path, unsigned int lcore_id);
 
 /**
  * Disconnect from an already connected Virtio-Serial Endpoint.
@@ -34,7 +45,7 @@ int guest_channel_host_connect(const char *path, unsigned lcore_id);
  *  lcore_id.
  *
  */
-void guest_channel_host_disconnect(unsigned lcore_id);
+void guest_channel_host_disconnect(unsigned int lcore_id);
 
 /**
  * Send a message contained in pkt over the Virtio-Serial to the host endpoint.
@@ -50,13 +61,19 @@ void guest_channel_host_disconnect(unsigned lcore_id);
  *  - Negative on channel not connected.
  *  - errno on write to channel error.
  */
-int guest_channel_send_msg(struct channel_packet *pkt, unsigned lcore_id);
+int guest_channel_send_msg(struct rte_power_channel_packet *pkt,
+               unsigned int lcore_id);
 
 /**
- * Send a message contained in pkt over the Virtio-Serial to the host endpoint.
+ * Read a message contained in pkt over the Virtio-Serial
+ * from the host endpoint.
  *
  * @param pkt
- *  Pointer to a populated struct channel_packet
+ *  Pointer to rte_power_channel_packet or
+ *  rte_power_channel_packet_freq_list struct.
+ *
+ * @param pkt_len
+ *  Size of expected data packet.
  *
  * @param lcore_id
  *  lcore_id.
@@ -65,8 +82,10 @@ int guest_channel_send_msg(struct channel_packet *pkt, unsigned lcore_id);
  *  - 0 on success.
  *  - Negative on error.
  */
-int rte_power_guest_channel_send_msg(struct channel_packet *pkt,
-                       unsigned int lcore_id);
+int power_guest_channel_read_msg(void *pkt,
+               size_t pkt_len,
+               unsigned int lcore_id);
+
 
 #ifdef __cplusplus
 }