[v5,2/6] power: make channel msg functions public
Checks
Commit Message
From: Bruce Richardson <bruce.richardson@intel.com>
Move the 2 public functions into rte_power_guest_channel.h
Fixes: 210c383e247b ("power: packet format for vm power management")
Fixes: cd0d5547e873 ("power: vm communication channels in guest")
Cc: stable@dpdk.org
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
changes in v3
* Mark both added functions as experimental
changes in v4
* add @internal tag for Doxygen
* add @warning EXPERIMENTAL tag for Doxygen
* improve description of lcore param
changes in v5
* moved version.map additions from patch 3 to patch 2
---
lib/librte_power/guest_channel.h | 40 +----------------
lib/librte_power/rte_power_guest_channel.h | 50 ++++++++++++++++++++++
lib/librte_power/version.map | 4 ++
3 files changed, 55 insertions(+), 39 deletions(-)
@@ -65,21 +65,7 @@ void guest_channel_host_disconnect(unsigned int lcore_id);
*/
int guest_channel_send_msg(struct channel_packet *pkt, unsigned int lcore_id);
-/**
- * Send a message contained in pkt over the Virtio-Serial to the host endpoint.
- *
- * @param pkt
- * Pointer to a populated struct channel_packet
- *
- * @param lcore_id
- * lcore_id.
- *
- * @return
- * - 0 on success.
- * - Negative on error.
- */
-int rte_power_guest_channel_send_msg(struct channel_packet *pkt,
- unsigned int lcore_id);
+
/**
* Read a message contained in pkt over the Virtio-Serial
@@ -103,30 +89,6 @@ int power_guest_channel_read_msg(void *pkt,
size_t pkt_len,
unsigned int lcore_id);
-/**
- * Receive a message contained in pkt over the Virtio-Serial
- * from the host endpoint.
- *
- * @param pkt
- * Pointer to channel_packet or
- * channel_packet_freq_list struct.
- *
- * @param pkt_len
- * Size of expected data packet.
- *
- * @param lcore_id
- * lcore_id.
- *
- * @return
- * - 0 on success.
- * - Negative on error.
- */
-__rte_experimental
-int
-rte_power_guest_channel_receive_msg(void *pkt,
- size_t pkt_len,
- unsigned int lcore_id);
-
#ifdef __cplusplus
}
@@ -116,6 +116,56 @@ struct channel_packet_caps_list {
uint8_t num_vcpu;
};
+/**
+ * @internal
+ *
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Send a message contained in pkt over the Virtio-Serial to the host endpoint.
+ *
+ * @param pkt
+ * Pointer to a populated struct channel_packet.
+ *
+ * @param lcore_id
+ * Use channel specific to this lcore_id.
+ *
+ * @return
+ * - 0 on success.
+ * - Negative on error.
+ */
+__rte_experimental
+int rte_power_guest_channel_send_msg(struct channel_packet *pkt,
+ unsigned int lcore_id);
+
+/**
+ * @internal
+ *
+ * @warning
+ * @b EXPERIMENTAL: this API may change without prior notice.
+ *
+ * Receive a message contained in pkt over the Virtio-Serial
+ * from the host endpoint.
+ *
+ * @param pkt
+ * Pointer to channel_packet or
+ * channel_packet_freq_list struct.
+ *
+ * @param pkt_len
+ * Size of expected data packet.
+ *
+ * @param lcore_id
+ * Use channel specific to this lcore_id.
+ *
+ * @return
+ * - 0 on success.
+ * - Negative on error.
+ */
+__rte_experimental
+int rte_power_guest_channel_receive_msg(void *pkt,
+ size_t pkt_len,
+ unsigned int lcore_id);
+
#ifdef __cplusplus
}
@@ -34,4 +34,8 @@ EXPERIMENTAL {
rte_power_guest_channel_receive_msg;
rte_power_poll_stat_fetch;
rte_power_poll_stat_update;
+
+ # added in 21.02
+ rte_power_guest_channel_receive_msg;
+ rte_power_guest_channel_send_msg;
};