lib/librte_power/channel_commands.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
  34 #ifndef CHANNEL_COMMANDS_H_
  35 #define CHANNEL_COMMANDS_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #include <stdint.h>
  42 #include <stdbool.h>
  43
  44 /* Maximum number of channels per VM */
  45 #define CHANNEL_CMDS_MAX_VM_CHANNELS 64
  46
  47 /* Valid Commands */
  48 #define CPU_POWER               1
  49 #define CPU_POWER_CONNECT       2
  50 #define PKT_POLICY              3
  51
  52 /* CPU Power Command Scaling */
  53 #define CPU_POWER_SCALE_UP      1
  54 #define CPU_POWER_SCALE_DOWN    2
  55 #define CPU_POWER_SCALE_MAX     3
  56 #define CPU_POWER_SCALE_MIN     4
  57 #define CPU_POWER_ENABLE_TURBO  5
  58 #define CPU_POWER_DISABLE_TURBO 6
  59 #define HOURS 24
  60
  61 #define MAX_VFS 10
  62 #define VM_MAX_NAME_SZ 32
  63
  64 #define MAX_VCPU_PER_VM         8
  65
  66 struct t_boost_status {
  67         bool tbEnabled;
  68 };
  69
  70 struct timer_profile {
  71         int busy_hours[HOURS];
  72         int quiet_hours[HOURS];
  73         int hours_to_use_traffic_profile[HOURS];
  74 };
  75
  76 enum workload {HIGH, MEDIUM, LOW};
  77 enum policy_to_use {
  78         TRAFFIC,
  79         TIME,
  80         WORKLOAD
  81 };
  82
  83 struct traffic {
  84         uint32_t min_packet_thresh;
  85         uint32_t avg_max_packet_thresh;
  86         uint32_t max_max_packet_thresh;
  87 };
  88
  89 struct channel_packet {
  90         uint64_t resource_id; /**< core_num, device */
  91         uint32_t unit;        /**< scale down/up/min/max */
  92         uint32_t command;     /**< Power, IO, etc */
  93         char vm_name[VM_MAX_NAME_SZ];
  94
  95         uint64_t vfid[MAX_VFS];
  96         int nb_mac_to_monitor;
  97         struct traffic traffic_policy;
  98         uint8_t vcpu_to_control[MAX_VCPU_PER_VM];
  99         uint8_t num_vcpu;
 100         struct timer_profile timer_policy;
 101         enum workload workload;
 102         enum policy_to_use policy_to_use;
 103         struct t_boost_status t_boost_status;
 104 };
 105
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif /* CHANNEL_COMMANDS_H_ */