jchv
commented
7 years ago I've made a quick demonstration. It may not be 100% accurate, sorry if I messed anything up, I've only verified that it reads the header correctly.
package main
import (
"encoding/binary"
"flag"
"fmt"
"io/ioutil"
"log"
restruct "gopkg.in/restruct.v1"
)
const (
AtomROMChecksumOffset = 0x21
AtomROMHeaderPtr = 0x48
)
type AtomCommonTableHeader struct {
StructureSize int16
TableFormatRevision byte
TableContentRevision byte
}
type AtomRomHeader struct {
Header AtomCommonTableHeader
FirmWareSignature uint32
BiosRuntimeSegmentAddress uint16
ProtectedModeInfoOffset uint16
ConfigFilenameOffset uint16
CRCBlockOffset uint16
BIOSBootupMessageOffset uint16
Int10Offset uint16
PciBusDevInitCode uint16
IoBaseAddress uint16
SubsystemVendorID uint16
SubsystemID uint16
PCIInfoOffset uint16
MasterCommandTableOffset uint16
MasterDataTableOffset uint16
ExtendedFunctionCode byte
_ byte
PSPDirTableOffset uint32
VendorID uint16
DeviceID uint16
}
type AtomDataTables struct {
Header AtomCommonTableHeader
UtilityPipeLine uint16
MultimediaCapabilityInfo uint16
MultimediaConfigInfo uint16
StandardVESATiming uint16
FirmwareInfo uint16
PaletteData uint16
LCDInfo uint16
DIGTransmitterInfo uint16
SMUInfo uint16
SupportedDevicesInfo uint16
GPIOI2CInfo uint16
VRAMUsageByFirmware uint16
GPIOPinLUT uint16
VESAToInternalModeLUT uint16
GFXInfo uint16
PowerPlayInfo uint16
GPUVirtualizationInfo uint16
SaveRestoreInfo uint16
PPLLSSInfo uint16
OemInfo uint16
XTMDSInfo uint16
MclkSSInfo uint16
ObjectHeader uint16
IndirectIOAccess uint16
MCInitParameter uint16
ASICVDDCInfo uint16
ASICInternalSSInfo uint16
TVVideoMode uint16
VRAMInfo uint16
MemoryTrainingInfo uint16
IntegratedSystemInfo uint16
ASICProfilingInfo uint16
VoltageObjectInfo uint16
PowerSourceInfo uint16
ServiceInfo uint16
}
type AtomPowerplayTable struct {
Header AtomCommonTableHeader
TableRevision byte
TableSize uint16
GoldenPPID uint32
GoldenRevision uint32
FormatID uint16
VoltageTime uint16
PlatformCaps uint32
MaxODEngineClock uint32
MaxODMemoryClock uint32
PowerControlLimit uint16
UlvVoltageOffset uint16
StateArrayOffset uint16
FanTableOffset uint16
ThermalControllerOffset uint16
_ uint16
MclkDependencyTableOffset uint16
SclkDependencyTableOffset uint16
VddcLookupTableOffset uint16
VddgfxLookupTableOffset uint16
MMDependencyTableOffset uint16
VCEStateTableOffset uint16
PPMTableOffset uint16
PowerTuneTableOffset uint16
HardLimitTableOffset uint16
PCIETableOffset uint16
GPIOTableOffset uint16
_ [6]uint16
}
type AtomMClkEntry struct {
VddcInd byte
Vddci uint16
VddgfxOffset uint16
Mvdd uint16
Mclk uint32
_ uint16
}
type AtomMClkTable struct {
RevID byte
NumEntries byte
Entries []AtomMClkEntry ``
}
type AtomSClkEntry struct {
VddInd byte
VddcOffset uint16
Sclk uint32
EdcCurrent uint16
ReliabilityTemperature byte
CKSVOffsetandDisable byte
SclkOffset uint32
// Polaris Only, remove for compatibility with Fiji
}
type AtomSClkTable struct {
RevID byte
NumEntries byte `struct:"sizeof=Entries"`
Entries []AtomSClkEntry
}
type AtomVoltageEntry struct {
Vdd uint16
CACLow uint16
CACMid uint16
CACHigh uint16
}
type AtomVoltageTable struct {
RevID byte
NumEntries byte `struct:"sizeof=Entries"`
Entries []AtomVoltageEntry
}
type AtomFanTable struct {
RevID byte
THyst byte
TMin uint16
TMed uint16
THigh uint16
PWMMin uint16
PWMMed uint16
PWMHigh uint16
TMax uint16
FanControlMode byte
FanPWMMax uint16
FanOutputSensitivity uint16
FanRPMMax uint16
MinFanSCLKAcousticLimit uint32
TargetTemperature byte
MinimumPWMLimit byte
FanGainEdge uint16
FanGainHotspot uint16
FanGainLiquid uint16
FanGainVrVddc uint16
FanGainVrMvdd uint16
FanGainPlx uint16
FanGainHbm uint16
_ uint16
}
type AtomPowertuneTable struct {
RevID byte
TDP uint16
ConfigurableTDP uint16
TDC uint16
BatteryPowerLimit uint16
SmallPowerLimit uint16
LowCACLeakage uint16
HighCACLeakage uint16
MaximumPowerDeliveryLimit uint16
TjMax uint16
PowerTuneDataSetID uint16
EDCLimit uint16
SoftwareShutdownTemp uint16
ClockStretchAmount uint16
TemperatureLimitHotspot uint16
TemperatureLimitLiquid1 uint16
TemperatureLimitLiquid2 uint16
TemperatureLimitVrVddc uint16
TemperatureLimitVrMvdd uint16
TemperatureLimitPlx uint16
Liquid1I2CAddress byte
Liquid2I2CAddress byte
LiquidI2CLine byte
VrI2CAddress byte
VrI2CLine byte
PlxI2CAddress byte
PlxI2CLine byte
_ uint16
}
type AtomVRAMTimingEntry struct {
ClkRange uint32
Latency [0x30]byte
}
type AtomVRAMEntry struct {
ChannelMapCfg uint32
ModuleSize uint16
McRAMCfg uint16
EnableChannels uint16
ExtMemoryID byte
MemoryType byte
ChannelNum byte
ChannelWidth byte
Density byte
BankCol byte
Misc byte
VREFI byte
_ uint16
MemorySize uint16
McTunningSetID byte
RowNum byte
EMRS2Value uint16
EMRS3Value uint16
MemoryVenderID byte
RefreshRateFactor byte
FIFODepth byte
CDRBandwidth byte
ChannelMapCfg1 uint32
BankMapCfg uint32
_ uint32
MemPNString [20]byte
}
type AtomVRAMInfo struct {
Header AtomCommonTableHeader
MemAdjustTblOffset uint16
MemClkPatchTblOffset uint16
McAdjustPerTileTblOffset uint16
McPhyInitTableOffset uint16
DramDataRemapTblOffset uint16
_ uint16
NumOfVRAMModule byte `struct:"sizeof=VramInfo"`
MemoryClkPatchTblVer byte
VramModuleVer byte
McPhyTileNum byte
VramInfo []AtomVRAMEntry
}
func main() {
flag.Parse()
if flag.NArg() != 1 {
log.Println("Usage: <ROM file>")
return
}
fn := flag.Arg(0)
data, err := ioutil.ReadFile(fn)
if err != nil {
log.Fatalln("Error reading ROM file:", err)
}
// Get offset to header
headerOffset := binary.LittleEndian.Uint16(data[AtomROMHeaderPtr : AtomROMHeaderPtr+2])
// Unpack header
header := AtomRomHeader{}
err = restruct.Unpack(data[headerOffset:], binary.LittleEndian, &header)
if err != nil {
log.Fatalln("Error unpacking ROM header:", err)
}
fmt.Printf("HEADER: %#v\n", header)
}Some useful notes:
- The struct fields must be capitalized so that they can be accessed via reflection. In Go, whether or not a field is private is solely determined by capitalization. This also means we can remove all of the
publickeywords. - Go will emit warnings if you use underscores in names or all caps in names, so I decided to make the names as idiomatic as possible.
- Your text was missing
ATOM_COMMON_TABLE_HEADER, so I pulled it off of Google. - The original code has some commented out lines like:
// public ATOM_VRAM_ENTRY aVramInfo[ucNumOfVRAMModule];This is because C#'s binary marshaling is not powerful enough to represent dynamic arrays with size prefixes. Restruct (and the Go library restruct was inspired by,
struc) supports these, so we can actually do this without having to loop over the array separately to read each entry. This is done by putting asizeofstruct tag above it that references it:NumOfVRAMModule byte `struct:"sizeof=VramInfo"` - C#
fixedhas no meaning in Golang. Go does have a concept ofunsafebut it is used for memory unsafe operations and not for fixing things in place, which is not necessary because Go does not reorder memory. So we can remove entirelyunsafeandfixed. [StructLayout (LayoutKind.Sequential, Pack = 1)]specifies tight struct packing, i.e. no added padding between elements. Restruct already assumes this, so it's actually necessary to manually emulate this padding if it happens to be present. In this case, we can just put everything as it is and it should work.- Fields with the name
Reservedwere renamed to_. This means there is no way to access them directly and the data will be cleared if you try to repack the struct. Therefore, if you are modding your BIOS with this code, PLEASE change all fields named_to something like,Reserved1,Reserved2, etc.
I hope this will help you get started. I tested it with the RX480 BIOS and was able to get what looked like the header structure. Try it using the demo code above (throw the example into a file in an empty folder, go build, and pass it the filename via command line.)
Also, if you are doing so, please be careful when modding your BIOS :) Obviously, I can't provide any warranty as to the correct operation of Restruct, but I wish you the best of luck in your endeavors.
kellabyte
I have these structs from C# that I want to port to Go. How would I handle these custom annotations with restruct?