hw/acpi/hmat.c

   1 /*
   2  * HMAT ACPI Implementation
   3  *
   4  * Copyright(C) 2019 Intel Corporation.
   5  *
   6  * Author:
   7  *  Liu jingqi <jingqi.liu@linux.intel.com>
   8  *  Tao Xu <tao3.xu@intel.com>
   9  *
  10  * HMAT is defined in ACPI 6.3: 5.2.27 Heterogeneous Memory Attribute Table
  11  * (HMAT)
  12  *
  13  * This library is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU Lesser General Public
  15  * License as published by the Free Software Foundation; either
  16  * version 2.1 of the License, or (at your option) any later version.
  17  *
  18  * This library is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * Lesser General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public
  24  * License along with this library; if not, see <http://www.gnu.org/licenses/>
  25  */
  26
  27 #include "qemu/osdep.h"
  28 #include "qemu/units.h"
  29 #include "sysemu/numa.h"
  30 #include "hw/acpi/aml-build.h"
  31 #include "hw/acpi/hmat.h"
  32
  33 /*
  34  * ACPI 6.3:
  35  * 5.2.27.3 Memory Proximity Domain Attributes Structure: Table 5-145
  36  */
  37 static void build_hmat_mpda(GArray *table_data, uint16_t flags,
  38                             uint32_t initiator, uint32_t mem_node)
  39 {
  40
  41     /* Memory Proximity Domain Attributes Structure */
  42     /* Type */
  43     build_append_int_noprefix(table_data, 0, 2);
  44     /* Reserved */
  45     build_append_int_noprefix(table_data, 0, 2);
  46     /* Length */
  47     build_append_int_noprefix(table_data, 40, 4);
  48     /* Flags */
  49     build_append_int_noprefix(table_data, flags, 2);
  50     /* Reserved */
  51     build_append_int_noprefix(table_data, 0, 2);
  52     /* Proximity Domain for the Attached Initiator */
  53     build_append_int_noprefix(table_data, initiator, 4);
  54     /* Proximity Domain for the Memory */
  55     build_append_int_noprefix(table_data, mem_node, 4);
  56     /* Reserved */
  57     build_append_int_noprefix(table_data, 0, 4);
  58     /*
  59      * Reserved:
  60      * Previously defined as the Start Address of the System Physical
  61      * Address Range. Deprecated since ACPI Spec 6.3.
  62      */
  63     build_append_int_noprefix(table_data, 0, 8);
  64     /*
  65      * Reserved:
  66      * Previously defined as the Range Length of the region in bytes.
  67      * Deprecated since ACPI Spec 6.3.
  68      */
  69     build_append_int_noprefix(table_data, 0, 8);
  70 }
  71
  72 /*
  73  * ACPI 6.3: 5.2.27.4 System Locality Latency and Bandwidth Information
  74  * Structure: Table 5-146
  75  */
  76 static void build_hmat_lb(GArray *table_data, HMAT_LB_Info *hmat_lb,
  77                           uint32_t num_initiator, uint32_t num_target,
  78                           uint32_t *initiator_list)
  79 {
  80     int i, index;
  81     HMAT_LB_Data *lb_data;
  82     uint16_t *entry_list;
  83     uint32_t base;
  84     /* Length in bytes for entire structure */
  85     uint32_t lb_length
  86         = 32 /* Table length up to and including Entry Base Unit */
  87         + 4 * num_initiator /* Initiator Proximity Domain List */
  88         + 4 * num_target /* Target Proximity Domain List */
  89         + 2 * num_initiator * num_target; /* Latency or Bandwidth Entries */
  90
  91     /* Type */
  92     build_append_int_noprefix(table_data, 1, 2);
  93     /* Reserved */
  94     build_append_int_noprefix(table_data, 0, 2);
  95     /* Length */
  96     build_append_int_noprefix(table_data, lb_length, 4);
  97     /* Flags: Bits [3:0] Memory Hierarchy, Bits[7:4] Reserved */
  98     assert(!(hmat_lb->hierarchy >> 4));
  99     build_append_int_noprefix(table_data, hmat_lb->hierarchy, 1);
 100     /* Data Type */
 101     build_append_int_noprefix(table_data, hmat_lb->data_type, 1);
 102     /* Reserved */
 103     build_append_int_noprefix(table_data, 0, 2);
 104     /* Number of Initiator Proximity Domains (s) */
 105     build_append_int_noprefix(table_data, num_initiator, 4);
 106     /* Number of Target Proximity Domains (t) */
 107     build_append_int_noprefix(table_data, num_target, 4);
 108     /* Reserved */
 109     build_append_int_noprefix(table_data, 0, 4);
 110
 111     /* Entry Base Unit */
 112     if (hmat_lb->data_type <= HMAT_LB_DATA_WRITE_LATENCY) {
 113         /* Convert latency base from nanoseconds to picosecond */
 114         base = hmat_lb->base * 1000;
 115     } else {
 116         /* Convert bandwidth base from Byte to Megabyte */
 117         base = hmat_lb->base / MiB;
 118     }
 119     build_append_int_noprefix(table_data, base, 8);
 120
 121     /* Initiator Proximity Domain List */
 122     for (i = 0; i < num_initiator; i++) {
 123         build_append_int_noprefix(table_data, initiator_list[i], 4);
 124     }
 125
 126     /* Target Proximity Domain List */
 127     for (i = 0; i < num_target; i++) {
 128         build_append_int_noprefix(table_data, i, 4);
 129     }
 130
 131     /* Latency or Bandwidth Entries */
 132     entry_list = g_new0(uint16_t, num_initiator * num_target);
 133     for (i = 0; i < hmat_lb->list->len; i++) {
 134         lb_data = &g_array_index(hmat_lb->list, HMAT_LB_Data, i);
 135         index = lb_data->initiator * num_target + lb_data->target;
 136
 137         entry_list[index] = (uint16_t)(lb_data->data / hmat_lb->base);
 138     }
 139
 140     for (i = 0; i < num_initiator * num_target; i++) {
 141         build_append_int_noprefix(table_data, entry_list[i], 2);
 142     }
 143
 144     g_free(entry_list);
 145 }
 146
 147 /* ACPI 6.3: 5.2.27.5 Memory Side Cache Information Structure: Table 5-147 */
 148 static void build_hmat_cache(GArray *table_data, uint8_t total_levels,
 149                              NumaHmatCacheOptions *hmat_cache)
 150 {
 151     /*
 152      * Cache Attributes: Bits [3:0] – Total Cache Levels
 153      * for this Memory Proximity Domain
 154      */
 155     uint32_t cache_attr = total_levels;
 156
 157     /* Bits [7:4] : Cache Level described in this structure */
 158     cache_attr |= (uint32_t) hmat_cache->level << 4;
 159
 160     /* Bits [11:8] - Cache Associativity */
 161     cache_attr |= (uint32_t) hmat_cache->associativity << 8;
 162
 163     /* Bits [15:12] - Write Policy */
 164     cache_attr |= (uint32_t) hmat_cache->policy << 12;
 165
 166     /* Bits [31:16] - Cache Line size in bytes */
 167     cache_attr |= (uint32_t) hmat_cache->line << 16;
 168
 169     /* Type */
 170     build_append_int_noprefix(table_data, 2, 2);
 171     /* Reserved */
 172     build_append_int_noprefix(table_data, 0, 2);
 173     /* Length */
 174     build_append_int_noprefix(table_data, 32, 4);
 175     /* Proximity Domain for the Memory */
 176     build_append_int_noprefix(table_data, hmat_cache->node_id, 4);
 177     /* Reserved */
 178     build_append_int_noprefix(table_data, 0, 4);
 179     /* Memory Side Cache Size */
 180     build_append_int_noprefix(table_data, hmat_cache->size, 8);
 181     /* Cache Attributes */
 182     build_append_int_noprefix(table_data, cache_attr, 4);
 183     /* Reserved */
 184     build_append_int_noprefix(table_data, 0, 2);
 185     /*
 186      * Number of SMBIOS handles (n)
 187      * Linux kernel uses Memory Side Cache Information Structure
 188      * without SMBIOS entries for now, so set Number of SMBIOS handles
 189      * as 0.
 190      */
 191     build_append_int_noprefix(table_data, 0, 2);
 192 }
 193
 194 /* Build HMAT sub table structures */
 195 static void hmat_build_table_structs(GArray *table_data, NumaState *numa_state)
 196 {
 197     uint16_t flags;
 198     uint32_t num_initiator = 0;
 199     uint32_t initiator_list[MAX_NODES];
 200     int i, hierarchy, type, cache_level, total_levels;
 201     HMAT_LB_Info *hmat_lb;
 202     NumaHmatCacheOptions *hmat_cache;
 203
 204     build_append_int_noprefix(table_data, 0, 4); /* Reserved */
 205
 206     for (i = 0; i < numa_state->num_nodes; i++) {
 207         flags = 0;
 208
 209         if (numa_state->nodes[i].initiator < MAX_NODES) {
 210             flags |= HMAT_PROXIMITY_INITIATOR_VALID;
 211         }
 212
 213         build_hmat_mpda(table_data, flags, numa_state->nodes[i].initiator, i);
 214     }
 215
 216     for (i = 0; i < numa_state->num_nodes; i++) {
 217         if (numa_state->nodes[i].has_cpu) {
 218             initiator_list[num_initiator++] = i;
 219         }
 220     }
 221
 222     /*
 223      * ACPI 6.3: 5.2.27.4 System Locality Latency and Bandwidth Information
 224      * Structure: Table 5-146
 225      */
 226     for (hierarchy = HMAT_LB_MEM_MEMORY;
 227          hierarchy <= HMAT_LB_MEM_CACHE_3RD_LEVEL; hierarchy++) {
 228         for (type = HMAT_LB_DATA_ACCESS_LATENCY;
 229              type <= HMAT_LB_DATA_WRITE_BANDWIDTH; type++) {
 230             hmat_lb = numa_state->hmat_lb[hierarchy][type];
 231
 232             if (hmat_lb && hmat_lb->list->len) {
 233                 build_hmat_lb(table_data, hmat_lb, num_initiator,
 234                               numa_state->num_nodes, initiator_list);
 235             }
 236         }
 237     }
 238
 239     /*
 240      * ACPI 6.3: 5.2.27.5 Memory Side Cache Information Structure:
 241      * Table 5-147
 242      */
 243     for (i = 0; i < numa_state->num_nodes; i++) {
 244         total_levels = 0;
 245         for (cache_level = 1; cache_level < HMAT_LB_LEVELS; cache_level++) {
 246             if (numa_state->hmat_cache[i][cache_level]) {
 247                 total_levels++;
 248             }
 249         }
 250         for (cache_level = 0; cache_level <= total_levels; cache_level++) {
 251             hmat_cache = numa_state->hmat_cache[i][cache_level];
 252             if (hmat_cache) {
 253                 build_hmat_cache(table_data, total_levels, hmat_cache);
 254             }
 255         }
 256     }
 257 }
 258
 259 void build_hmat(GArray *table_data, BIOSLinker *linker, NumaState *numa_state,
 260                 const char *oem_id, const char *oem_table_id)
 261 {
 262     AcpiTable table = { .sig = "HMAT", .rev = 2,
 263                         .oem_id = oem_id, .oem_table_id = oem_table_id };
 264
 265     acpi_table_begin(&table, table_data);
 266     hmat_build_table_structs(table_data, numa_state);
 267     acpi_table_end(linker, &table);
 268 }