//
// kern_devinfo.hpp
// Lilu
//
// Copyright © 2018-2020 vit9696. All rights reserved.
//
#ifndef kern_devinfo_h
#define kern_devinfo_h
#include <Headers/kern_config.hpp>
#include <Headers/kern_cpu.hpp>
#include <Headers/kern_iokit.hpp>
#include <Headers/kern_util.hpp>
#include <IOKit/IOService.h>
/**
* Obtain installed devices split into categories.
* Should be used from onPatcherLoad and onwards.
*/
class DeviceInfo {
/**
* Updates reportedLayoutId
*/
void updateLayoutId();
/**
* Updates reportedFramebufferId
*/
void updateFramebufferId();
/**
* Obtains devices from PCI root
*
* @param pciRoot PCI root instance (commonly PCI0@0 device)
*/
void grabDevicesFromPciRoot(IORegistryEntry *pciRoot);
/**
* Await for PCI device publishing in IODeviceTree plane
*
* @param obj wait for (PCI) object publishing
*/
void awaitPublishing(IORegistryEntry *obj);
public:
/**
* Obtains autodetected legacy framebuffer if applicable
*
* @return framebuffer or 0xFFFFFFFF
*/
static uint32_t getLegacyFramebufferId();
/**
* Checks whether the framebuffer has connectors or not.
*
* @return true if the framebuffer has no connectors
*/
static bool isConnectorLessPlatformId(uint32_t id);
/**
* Common external GPU parameter list
*/
struct ExternalVideo {
/**
* Aka GFX0 device
*/
IORegistryEntry *video {nullptr};
/**
* Aka HDAU device
*/
IORegistryEntry *audio {nullptr};
/**
* External GPU vendor
*/
uint32_t vendor {0};
};
/**
* Aka HDEF device
*/
IORegistryEntry *audioBuiltinAnalog {nullptr};
/**
* Aka HDAU device for builtin GPU
*/
IORegistryEntry *audioBuiltinDigital {nullptr};
/**
* Aka IGPU device
*/
IORegistryEntry *videoBuiltin {nullptr};
/**
* Aka IMEI device
*/
IORegistryEntry *managementEngine {nullptr};
/**
* Aka GFX0 devices (kept in sync with audioExternal)
*/
evector<ExternalVideo&> videoExternal;
private:
/**
* This is the default reported layout-id passed to reportedLayoutId.
* The reason for choosing 7 is its presence in 10.14 and the fact
* Apple frameworks still communicate to the files present on disk.
* For information purposes only! Use reportedLayoutId!
*/
static constexpr uint32_t DefaultReportedLayoutId = 7;
/**
* The boot-arg to override the reported layout-id to AppleHDA.
* For user configuration only! Use reportedLayoutId!
*/
static constexpr const char *ReportedLayoutIdArg = "alcapplid";
/**
* The property to override the reported layout-id to AppleHDA.
* For user configuration only! Use reportedLayoutId!
*/
static constexpr const char *ReportedLayoutIdName = "apple-layout-id";
public:
/**
* Layout id to be reported by all audio devices (you must update it yourself).
* This follows the standard convention initially found in AppleALC:
* alcapplid=X boot-arg has highest priority and overrides any other value.
* apple-layout-id HDEF prop has normal priority, you may use it if you need.
* DefaultReportedLayoutId will be used if both of the above are not set.
*/
uint32_t reportedLayoutId {0};
private:
/**
* The boot-arg to override the reported AAPL,ig-platform-id to Intel drivers.
* For user configuration only! Use reportedFramebufferId!
*/
static constexpr const char *ReportedFrameIdArg = "igfxframe";
/**
* The boot-arg to override the reported AAPL,ig-platform-id to Intel drivers.
* Sets VESA framebuffer id (0xFFFFFFFF).
* For user configuration only! Use reportedFramebufferId!
*/
static constexpr const char *ReportedVesaIdArg = "-igfxvesa";
/**
* The boot-arg to force-disable any external GPU if found.
* For user configuration only! Use requestedExternalSwitchOff!
*/
static constexpr const char *RequestedExternalSwitchOffArg {"-wegnoegpu"};
/**
* The boot-arg to force-disable any internal GPU if found.
* For user configuration only! Use requestedInternalSwitchOff!
*/
static constexpr const char *RequestedInternalSwitchOffArg {"-wegnoigpu"};
/**
* The boot-arg to force-disable any internal GPU if external GPU found.
* For user configuration only! Use requestedGpuSwitch!!
*/
static constexpr const char *RequestedGpuSwitchArg {"-wegswitchgpu"};
/**
* The property to set your platform id for Intel drivers (Ivy and newer).
* For user configuration only! Use reportedFramebufferName!
*/
static constexpr const char *ReportedFrameIdName = "AAPL,ig-platform-id";
/**
* The property to set your platform id for Intel drivers (Sandy).
* For user configuration only! Use reportedFramebufferName!
*/
static constexpr const char *ReportedFrameIdLegacyName = "AAPL,snb-platform-id";
/**
* The IGPU property to force-disable any external GPU if found.
* For user configuration only! Use processSwitchOff()!
*/
static constexpr const char *RequestedExternalSwitchOffName {"disable-external-gpu"};
/**
* The IGPU property to force-disable the IGPU if any external GPU is found.
* For user configuration only! Use processSwitchOff()!
*/
static constexpr const char *RequestedGpuSwitchName {"switch-to-external-gpu"};
/**
* The GPU property to force-disable any external or internal GPU.
* For user configuration only! Use processSwitchOff()!
*/
static constexpr const char *RequestedGpuSwitchOffName {"disable-gpu"};
/**
* The GPU property to force-disable any this external GPU with minimum kernel version (inclusive).
* For user configuration only! Use processSwitchOff()!
*/
static constexpr const char *RequestedGpuSwitchOffMinKernelName {"disable-gpu-min"};
/**
* The GPU property to force-disable any this external GPU with maximum kernel version (inclusive).
* For user configuration only! Use processSwitchOff()!
*/
static constexpr const char *RequestedGpuSwitchOffMaxKernelName {"disable-gpu-max"};
/**
* Known platform ids used by Intel GPU kexts
* For user configuration only!
*/
static constexpr uint32_t DefaultAppleSkylakePlatformId {0x19120000};
static constexpr uint32_t DefaultAppleKabyLakePlatformId {0x59160000};
static constexpr uint32_t DefaultAppleCoffeeLakePlatformId {0x3EA50000};
static constexpr uint32_t DefaultAppleCannonLakePlatformId {0x5A520000};
static constexpr uint32_t DefaultAppleIceLakeRealPlatformId {0x8A520000};
static constexpr uint32_t DefaultAppleIceLakeSimulatorPlatformId {0xFF050000};
/**
* Framebuffers without any ports used for hardware acceleration only
* Note 1: Broadwell framebuffers all have connectors added.
* Note 2: Coffee Lake framebuffers without connectors are only present in 10.14.
* Note 3: prerelease Cannon Lake and Ice Lake framebuffers are without connectors.
* For user configuration only!
*/
static constexpr uint32_t ConnectorLessSandyBridgePlatformId1 {0x00030030};
static constexpr uint32_t ConnectorLessSandyBridgePlatformId2 {0x00050000};
static constexpr uint32_t ConnectorLessIvyBridgePlatformId1 {0x01620006};
static constexpr uint32_t ConnectorLessIvyBridgePlatformId2 {0x01620007};
static constexpr uint32_t ConnectorLessHaswellPlatformId1 {0x04120004};
static constexpr uint32_t ConnectorLessHaswellPlatformId2 {0x0412000B};
static constexpr uint32_t ConnectorLessSkylakePlatformId1 {0x19020001};
static constexpr uint32_t ConnectorLessSkylakePlatformId2 {0x19170001};
static constexpr uint32_t ConnectorLessSkylakePlatformId3 {0x19120001};
static constexpr uint32_t ConnectorLessSkylakePlatformId4 {0x19320001};
static constexpr uint32_t ConnectorLessKabyLakePlatformId1 {0x59180002};
static constexpr uint32_t ConnectorLessKabyLakePlatformId2 {0x59120003};
static constexpr uint32_t ConnectorLessCoffeeLakePlatformId1 {0x3E920003};
static constexpr uint32_t ConnectorLessCoffeeLakePlatformId2 {0x3E910003};
static constexpr uint32_t ConnectorLessCoffeeLakePlatformId3 {0x3E980003};
static constexpr uint32_t ConnectorLessCoffeeLakePlatformId4 {0x9BC80003};
static constexpr uint32_t ConnectorLessCoffeeLakePlatformId5 {0x9BC50003};
static constexpr uint32_t ConnectorLessCoffeeLakePlatformId6 {0x9BC40003};
public:
/**
* Vesa framebuffer identifier
*/
static constexpr uint32_t DefaultVesaPlatformId {0xFFFFFFFF};
/**
* Framebuffer id to be reported to IGPU.
* This follows the standard convention initially found in IntelGraphicsFixup:
* igfxframe=X boot-arg has highest priority and overrides any other value.
* -igfxvesa forces 0xFFFFFFFF frame to get into VESA mode.
* Manually specified AAPL,ig-platform-id or AAPL,snb-platform-id go next.
* On Sandy Bridge processors a default AAPL,snb-platform-id will be tried afterwards.
* On Skylake and Kaby Lake processors some default id will be tried afterwards.
*/
uint32_t reportedFramebufferId {0};
/**
* Compatible platform id property name for this IGPU
*/
const char *reportedFramebufferName {nullptr};
/**
* Set to true if the framebuffer has no connectors
*/
bool reportedFramebufferIsConnectorLess {false};
/**
* Known variants of firmware vendors
* Please note, that it may not be possible to always detect the right vendor
*/
enum class FirmwareVendor {
Unknown,
Apple,
VMware,
EDKII,
Parallels,
AMI,
Insyde,
Phoenix,
HP
};
/**
* Firmware vendor manufacturer
*/
FirmwareVendor firmwareVendor {FirmwareVendor::Unknown};
/**
* Requested external GPU switchoff
*/
bool requestedExternalSwitchOff {false};
/**
* Requested internal GPU switchoff
*/
bool requestedInternalSwitchOff {false};
/**
* Requested GPU switch
*/
bool requestedGpuSwitch {false};
/**
* Allocate and initialise cached device list.
*
* @return device list or nullptr
*/
static DeviceInfo *createCached();
/**
* Allocate and initialise the device list.
*
* @return device list or nullptr
*/
EXPORT static DeviceInfo *create();
/**
* Release initialised device list.
*
* @param d device list
*/
EXPORT static void deleter(DeviceInfo *d NONNULL);
/**
* Perform device switch-off as prescribed by the properties injected.
*/
EXPORT void processSwitchOff();
};
/**
* Simple device information available at early stage.
*/
class BaseDeviceInfo {
/**
* Updates firmwareVendor
*/
void updateFirmwareVendor();
/**
* Updates model information
*/
void updateModelInfo();
public:
/**
* Board identifier board-id (VMware has "440BX Desktop Reference Platform", eek)
*/
char boardIdentifier[48] {};
/**
* Model identifier
*/
char modelIdentifier[48] {};
/**
* Computer model type.
*/
int modelType {WIOKit::ComputerModel::ComputerAny};
/**
* Firmware vendor manufacturer
*/
DeviceInfo::FirmwareVendor firmwareVendor {DeviceInfo::FirmwareVendor::Unknown};
/**
* Known variants of bootloader vendors
* Please note, that it may not be possible to always detect the right vendor
*/
enum class BootloaderVendor {
Unknown,
Acidanthera,
Clover
};
/**
* Bootloader vendor
*/
BootloaderVendor bootloaderVendor {BootloaderVendor::Unknown};
/**
* CPU vendor
*/
CPUInfo::CpuVendor cpuVendor {CPUInfo::CpuVendor::Unknown};
/**
* CPU generation
*/
CPUInfo::CpuGeneration cpuGeneration {CPUInfo::CpuGeneration::Unknown};
/**
* CPU family
*/
uint32_t cpuFamily {};
/**
* CPU model
*/
uint32_t cpuModel {};
/**
* CPU stepping
*/
uint32_t cpuStepping {};
/**
* CPU max level
*/
uint32_t cpuMaxLevel {};
/**
* CPU max level (ext)
*/
uint32_t cpuMaxLevelExt {0x80000000};
/**
* AVX 2.0 support
*/
bool cpuHasAvx2 {false};
/**
* Obtain base device info.
*/
EXPORT static const BaseDeviceInfo &get();
/**
* Initialize global base device info.
*/
static void init();
};
#endif /* kern_devinfo_h */