numam-dpdk/lib/power/rte_power_guest_channel.h
Bruce Richardson 99a2dd955f lib: remove librte_ prefix from directory names
There is no reason for the DPDK libraries to all have 'librte_' prefix on
the directory names. This prefix makes the directory names longer and also
makes it awkward to add features referring to individual libraries in the
build - should the lib names be specified with or without the prefix.
Therefore, we can just remove the library prefix and use the library's
unique name as the directory name, i.e. 'eal' rather than 'librte_eal'

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2021-04-21 14:04:09 +02:00

169 lines
4.1 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2010-2021 Intel Corporation
*/
#ifndef RTE_POWER_GUEST_CHANNEL_H
#define RTE_POWER_GUEST_CHANNEL_H
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include <rte_compat.h>
#ifdef __cplusplus
extern "C" {
#endif
#define RTE_POWER_MAX_VFS 10
#define RTE_POWER_VM_MAX_NAME_SZ 32
#define RTE_POWER_MAX_VCPU_PER_VM 8
#define RTE_POWER_HOURS_PER_DAY 24
/* Valid Commands */
#define RTE_POWER_CPU_POWER 1
#define RTE_POWER_CPU_POWER_CONNECT 2
#define RTE_POWER_PKT_POLICY 3
#define RTE_POWER_PKT_POLICY_REMOVE 4
#define RTE_POWER_CORE_TYPE_VIRTUAL 0
#define RTE_POWER_CORE_TYPE_PHYSICAL 1
/* CPU Power Command Scaling */
#define RTE_POWER_SCALE_UP 1
#define RTE_POWER_SCALE_DOWN 2
#define RTE_POWER_SCALE_MAX 3
#define RTE_POWER_SCALE_MIN 4
#define RTE_POWER_ENABLE_TURBO 5
#define RTE_POWER_DISABLE_TURBO 6
/* CPU Power Queries */
#define RTE_POWER_QUERY_FREQ_LIST 7
#define RTE_POWER_QUERY_FREQ 8
#define RTE_POWER_QUERY_CAPS_LIST 9
#define RTE_POWER_QUERY_CAPS 10
/* Generic Power Command Response */
#define RTE_POWER_CMD_ACK 1
#define RTE_POWER_CMD_NACK 2
/* CPU Power Query Responses */
#define RTE_POWER_FREQ_LIST 3
#define RTE_POWER_CAPS_LIST 4
struct rte_power_traffic_policy {
uint32_t min_packet_thresh;
uint32_t avg_max_packet_thresh;
uint32_t max_max_packet_thresh;
};
struct rte_power_timer_profile {
int busy_hours[RTE_POWER_HOURS_PER_DAY];
int quiet_hours[RTE_POWER_HOURS_PER_DAY];
int hours_to_use_traffic_profile[RTE_POWER_HOURS_PER_DAY];
};
enum rte_power_workload_level {
RTE_POWER_WL_HIGH,
RTE_POWER_WL_MEDIUM,
RTE_POWER_WL_LOW
};
enum rte_power_policy {
RTE_POWER_POLICY_TRAFFIC,
RTE_POWER_POLICY_TIME,
RTE_POWER_POLICY_WORKLOAD,
RTE_POWER_POLICY_BRANCH_RATIO
};
struct rte_power_turbo_status {
bool tbEnabled;
};
struct rte_power_channel_packet {
uint64_t resource_id; /**< core_num, device */
uint32_t unit; /**< scale down/up/min/max */
uint32_t command; /**< Power, IO, etc */
char vm_name[RTE_POWER_VM_MAX_NAME_SZ];
uint64_t vfid[RTE_POWER_MAX_VFS];
int nb_mac_to_monitor;
struct rte_power_traffic_policy traffic_policy;
uint8_t vcpu_to_control[RTE_POWER_MAX_VCPU_PER_VM];
uint8_t num_vcpu;
struct rte_power_timer_profile timer_policy;
bool core_type;
enum rte_power_workload_level workload;
enum rte_power_policy policy_to_use;
struct rte_power_turbo_status t_boost_status;
};
struct rte_power_channel_packet_freq_list {
uint64_t resource_id; /**< core_num, device */
uint32_t unit; /**< scale down/up/min/max */
uint32_t command; /**< Power, IO, etc */
char vm_name[RTE_POWER_VM_MAX_NAME_SZ];
uint32_t freq_list[RTE_POWER_MAX_VCPU_PER_VM];
uint8_t num_vcpu;
};
struct rte_power_channel_packet_caps_list {
uint64_t resource_id; /**< core_num, device */
uint32_t unit; /**< scale down/up/min/max */
uint32_t command; /**< Power, IO, etc */
char vm_name[RTE_POWER_VM_MAX_NAME_SZ];
uint64_t turbo[RTE_POWER_MAX_VCPU_PER_VM];
uint64_t priority[RTE_POWER_MAX_VCPU_PER_VM];
uint8_t num_vcpu;
};
/**
* 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.
*/
int rte_power_guest_channel_send_msg(struct rte_power_channel_packet *pkt,
unsigned int lcore_id);
/**
* @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
}
#endif
#endif /* RTE_POWER_GUEST_CHANNEL_H_ */