/* 
 * MVisor SMBIOS Support
 * Copyright (C) 2021 Terrence <terrence@tenclass.com>
 * Copyright (C) 2009 Hewlett-Packard Development Company, L.P.
 * Authors:
 *  Alex Williamson <alex.williamson@hp.com>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */


#ifndef _MVISOR_DEVICES_SMBIOS_H
#define _MVISOR_DEVICES_SMBIOS_H

#include <cstdint>
#include <string>
#include <map>
#include <vector>

#define SMBIOS_MAX_TYPE 127

/* memory area description, used by type 19 table */
struct smbios_phys_mem_area {
  uint64_t address;
  uint64_t length;
};

/*
 * SMBIOS spec defined tables
 */
typedef enum SmbiosEntryPointType {
  SMBIOS_ENTRY_POINT_21,
  SMBIOS_ENTRY_POINT_30,
} SmbiosEntryPointType;

/* SMBIOS Entry Point
 * There are two types of entry points defined in the SMBIOS specification
 * (see below). BIOS must place the entry point(s) at a 16-byte-aligned
 * address between 0xf0000 and 0xfffff. Note that either entry point type
 * can be used in a 64-bit target system, except that SMBIOS 2.1 entry point
 * only allows the SMBIOS struct table to reside below 4GB address space.
 */

/* SMBIOS 2.1 (32-bit) Entry Point
 *  - introduced since SMBIOS 2.1
 *  - supports structure table below 4GB only
 */
struct smbios_21_entry_point {
  uint8_t anchor_string[4];
  uint8_t checksum;
  uint8_t length;
  uint8_t smbios_major_version;
  uint8_t smbios_minor_version;
  uint16_t max_structure_size;
  uint8_t entry_point_revision;
  uint8_t formatted_area[5];
  uint8_t intermediate_anchor_string[5];
  uint8_t intermediate_checksum;
  uint16_t structure_table_length;
  uint32_t structure_table_address;
  uint16_t number_of_structures;
  uint8_t smbios_bcd_revision;
} __attribute__((packed));

/* SMBIOS 3.0 (64-bit) Entry Point
 *  - introduced since SMBIOS 3.0
 *  - supports structure table at 64-bit address space
 */
struct smbios_30_entry_point {
  uint8_t anchor_string[5];
  uint8_t checksum;
  uint8_t length;
  uint8_t smbios_major_version;
  uint8_t smbios_minor_version;
  uint8_t smbios_doc_rev;
  uint8_t entry_point_revision;
  uint8_t reserved;
  uint32_t structure_table_max_size;
  uint64_t structure_table_address;
} __attribute__((packed));

typedef union {
  struct smbios_21_entry_point ep21;
  struct smbios_30_entry_point ep30;
} __attribute__((packed)) SmbiosEntryPoint;

/* This goes at the beginning of every SMBIOS structure. */
struct smbios_structure_header {
  uint8_t type;
  uint8_t length;
  uint16_t handle;
} __attribute__((packed));

/* SMBIOS type 0 - BIOS Information */
struct smbios_type_0 {
  struct smbios_structure_header header;
  uint8_t vendor_str;
  uint8_t bios_version_str;
  uint16_t bios_starting_address_segment;
  uint8_t bios_release_date_str;
  uint8_t bios_rom_size;
  uint64_t bios_characteristics;
  uint8_t bios_characteristics_extension_bytes[2];
  uint8_t system_bios_major_release;
  uint8_t system_bios_minor_release;
  uint8_t embedded_controller_major_release;
  uint8_t embedded_controller_minor_release;
} __attribute__((packed));

/* UUID encoding. The time_* fields are little-endian, as specified by SMBIOS
 * version 2.6.
 */
struct smbios_uuid {
  uint32_t time_low;
  uint16_t time_mid;
  uint16_t time_hi_and_version;
  uint8_t clock_seq_hi_and_reserved;
  uint8_t clock_seq_low;
  uint8_t node[6];
} __attribute__((packed));

/* SMBIOS type 1 - System Information */
struct smbios_type_1 {
  struct smbios_structure_header header;
  uint8_t manufacturer_str;
  uint8_t product_name_str;
  uint8_t version_str;
  uint8_t serial_number_str;
  struct smbios_uuid uuid;
  uint8_t wake_up_type;
  uint8_t sku_number_str;
  uint8_t family_str;
} __attribute__((packed));

/* SMBIOS type 2 - Base Board */
struct smbios_type_2 {
  struct smbios_structure_header header;
  uint8_t manufacturer_str;
  uint8_t product_str;
  uint8_t version_str;
  uint8_t serial_number_str;
  uint8_t asset_tag_number_str;
  uint8_t feature_flags;
  uint8_t location_str;
  uint16_t chassis_handle;
  uint8_t board_type;
  uint8_t contained_element_count;
  /* contained elements follow */
} __attribute__((packed));

/* SMBIOS type 3 - System Enclosure (v2.7) */
struct smbios_type_3 {
  struct smbios_structure_header header;
  uint8_t manufacturer_str;
  uint8_t type;
  uint8_t version_str;
  uint8_t serial_number_str;
  uint8_t asset_tag_number_str;
  uint8_t boot_up_state;
  uint8_t power_supply_state;
  uint8_t thermal_state;
  uint8_t security_status;
  uint32_t oem_defined;
  uint8_t height;
  uint8_t number_of_power_cords;
  uint8_t contained_element_count;
  uint8_t contained_element_record_length;
  uint8_t sku_number_str;
  /* contained elements follow */
} __attribute__((packed));

/* SMBIOS type 4 - Processor Information (v2.6) */
struct smbios_type_4 {
  struct smbios_structure_header header;
  uint8_t socket_designation_str;
  uint8_t processor_type;
  uint8_t processor_family;
  uint8_t processor_manufacturer_str;
  uint32_t processor_id[2];
  uint8_t processor_version_str;
  uint8_t voltage;
  uint16_t external_clock;
  uint16_t max_speed;
  uint16_t current_speed;
  uint8_t status;
  uint8_t processor_upgrade;
  uint16_t l1_cache_handle;
  uint16_t l2_cache_handle;
  uint16_t l3_cache_handle;
  uint8_t serial_number_str;
  uint8_t asset_tag_number_str;
  uint8_t part_number_str;
  uint8_t core_count;
  uint8_t core_enabled;
  uint8_t thread_count;
  uint16_t processor_characteristics;
  uint16_t processor_family2;
} __attribute__((packed));

/* SMBIOS type 11 - OEM strings */
struct smbios_type_11 {
  struct smbios_structure_header header;
  uint8_t count;
} __attribute__((packed));

/* SMBIOS type 16 - Physical Memory Array (v2.7) */
struct smbios_type_16 {
  struct smbios_structure_header header;
  uint8_t location;
  uint8_t use;
  uint8_t error_correction;
  uint32_t maximum_capacity;
  uint16_t memory_error_information_handle;
  uint16_t number_of_memory_devices;
  uint64_t extended_maximum_capacity;
} __attribute__((packed));

/* SMBIOS type 17 - Memory Device (v2.8) */
struct smbios_type_17 {
  struct smbios_structure_header header;
  uint16_t physical_memory_array_handle;
  uint16_t memory_error_information_handle;
  uint16_t total_width;
  uint16_t data_width;
  uint16_t size;
  uint8_t form_factor;
  uint8_t device_set;
  uint8_t device_locator_str;
  uint8_t bank_locator_str;
  uint8_t memory_type;
  uint16_t type_detail;
  uint16_t speed;
  uint8_t manufacturer_str;
  uint8_t serial_number_str;
  uint8_t asset_tag_number_str;
  uint8_t part_number_str;
  uint8_t attributes;
  uint32_t extended_size;
  uint16_t configured_clock_speed;
  uint16_t minimum_voltage;
  uint16_t maximum_voltage;
  uint16_t configured_voltage;
} __attribute__((packed));

/* SMBIOS type 19 - Memory Array Mapped Address (v2.7) */
struct smbios_type_19 {
  struct smbios_structure_header header;
  uint32_t starting_address;
  uint32_t ending_address;
  uint16_t memory_array_handle;
  uint8_t partition_width;
  uint64_t extended_starting_address;
  uint64_t extended_ending_address;
} __attribute__((packed));

/* SMBIOS type 32 - System Boot Information */
struct smbios_type_32 {
  struct smbios_structure_header header;
  uint8_t reserved[6];
  uint8_t boot_status;
} __attribute__((packed));

/* SMBIOS type 127 -- End-of-table */
struct smbios_type_127 {
  struct smbios_structure_header header;
} __attribute__((packed));


class Machine;
class Smbios {
 public:
  Smbios(Machine* machine);
  void GetTables(std::string& anchor, std::string& table);

 private:
  void BuildStructure(uint8_t type, void* data, size_t size, std::vector<std::string>& texts, uint16_t handle=0);
  void BuildType1();
  void BuildType2();
  void BuildType3();
  void BuildType4();
  void BuildType16();
  void BuildType17();
  void BuildType19();
  void BuildType32();
  void SetupEntryPoint();
  Machine* machine_;

  smbios_21_entry_point entry_point_;
  std::vector<std::string> table_entries_;

  std::string default_manufacturer_;
  std::string default_product_name_;
  std::string default_version_;
  std::string default_serial_number_;
};

#endif // _MVISOR_DEVICES_SMBIOS_H
