interfaces

type BaseSection struct {
	SectionType       types.SectionType `json:"type" offset:"-"`
	SectionOffset     uint64            `json:"offset" offset:"-"`
	SectionSize       uint32            `json:"size" offset:"-"`
	SectionCRCType    types.CRCType     `json:"crc_type" offset:"-"`
	SectionCRC        uint32            `json:"-" offset:"-"` // Internal use only
	EncryptedFlag     bool              `json:"is_encrypted" offset:"-"`
	DeviceDataFlag    bool              `json:"is_device_data" offset:"-"`
	HasRawData        bool              `json:"has_raw_data" offset:"-"` // Set by sections based on parse status
	FromHWPointerFlag bool              `json:"is_from_hw_pointer" offset:"-"`
	// contains filtered or unexported fields
}

type CRCCalculator interface {
	// Calculate calculates CRC for the given data
	Calculate(data []byte) uint32

	// CalculateWithParams calculates CRC with specific parameters
	CalculateWithParams(data []byte, polynomial, initial, xorOut uint32) uint32

	// CalculateImageCRC calculates CRC for firmware image data (handles endianness)
	CalculateImageCRC(data []byte, sizeInDwords int) uint16

	// GetType returns the CRC type
	GetType() types.CRCType
}

type CRCVerifier interface {
	// CalculateSoftwareCRC calculates software CRC16 for data
	CalculateSoftwareCRC(data []byte) uint16

	// CalculateHardwareCRC calculates hardware CRC for data
	CalculateHardwareCRC(data []byte) uint16

	// VerifyCRC verifies CRC for a data buffer
	VerifyCRC(data []byte, expectedCRC uint32, useHardwareCRC bool) error
}

type CompleteSectionInterface interface {
	SectionMetadata
	SectionAttributes
	SectionCRCInfo
	SectionCRCOperations
	SectionData
	SectionExtras
}

type FirmwareInfo struct {
	// Basic information
	Format        string
	FormatVersion int

	// Version information
	FWVersion      string
	FWReleaseDate  string
	MICVersion     string
	ProductVersion string

	// Product information
	PartNumber  string
	Description string
	PSID        string
	OrigPSID    string // Original PSID (shown when different from PSID)
	PRSName     string

	// ROM information
	RomInfo []RomInfo

	// GUID/MAC information
	BaseGUID    uint64
	BaseGUIDNum int
	BaseMAC     uint64
	BaseMACNum  int

	// Additional GUID/MAC for dual format (encrypted firmware)
	BaseGUID2     uint64
	BaseGUID2Num  int
	BaseMAC2      uint64
	BaseMAC2Num   int
	GUIDStep      uint8
	MACStep       uint8
	UseDualFormat bool // Whether to display GUID1/GUID2 format

	// VSD information
	ImageVSD  string
	DeviceVSD string

	// Security information
	SecurityAttrs string
	SecurityVer   int
	IsEncrypted   bool

	// Activation method (device-mode; from MCQI)
	ActivationMethod string

	// Device information
	DeviceID uint16
	VendorID uint16

	// Size information
	ImageSize uint64
	ChunkSize uint64

	// Additional metadata
	Sections []SectionInfo
}

type FirmwareParser interface {
	// Parse reads and parses the firmware from the provided reader
	Parse(reader io.ReaderAt) error

	// Query returns firmware information similar to mstflint query output
	Query() (*FirmwareInfo, error)

	// GetFormat returns the firmware format (FS4 or FS5)
	GetFormat() int

	// GetSections returns all parsed sections
	GetSections() map[uint16]*Section

	// GetSection returns a specific section by type
	GetSection(sectionType uint16) (*Section, error)
}

type RomInfo struct {
	Type    string
	Version string
	CPU     string
}

type Section struct {
	Type            uint16
	Offset          uint64
	Size            uint32
	Data            []byte
	CRCType         types.CRCType
	CRC             uint32
	IsEncrypted     bool
	IsDeviceData    bool
	Entry           *types.ITOCEntry
	IsFromHWPointer bool // True if section was discovered from HW pointer in encrypted firmware
}

type SectionAttributes interface {
	// IsEncrypted returns whether the section is encrypted
	IsEncrypted() bool

	// IsDeviceData returns whether this is device-specific data
	IsDeviceData() bool

	// IsFromHWPointer returns true if this section was referenced from HW pointers
	IsFromHWPointer() bool
}

type SectionCRCHandler interface {
	// CalculateCRC calculates the CRC for the section data
	CalculateCRC(data []byte, crcType types.CRCType) (uint32, error)

	// VerifyCRC verifies the CRC for the section
	VerifyCRC(data []byte, expectedCRC uint32, crcType types.CRCType) error

	// GetCRCOffset returns the offset of CRC within the section data (if CRC is embedded)
	GetCRCOffset() int

	// HasEmbeddedCRC returns true if CRC is stored within the section data
	HasEmbeddedCRC() bool
}

type SectionCRCInfo interface {
	// CRCType returns the CRC type for this section
	CRCType() types.CRCType

	// HasCRC returns whether this section has CRC verification enabled
	HasCRC() bool

	// GetCRC returns the expected CRC value for this section
	GetCRC() uint32
}

type SectionCRCOperations interface {
	// CalculateCRC calculates the CRC for this section
	CalculateCRC() (uint32, error)

	// VerifyCRC verifies the section's CRC
	VerifyCRC() error
}

type SectionData interface {
	// Parse parses the raw data into section-specific structures
	Parse(data []byte) error

	// GetRawData returns the raw section data
	GetRawData() []byte

	// Write writes the section data to the writer
	Write(w io.Writer) error
}

type SectionExtras interface {
	// GetITOCEntry returns the ITOC entry for this section (may be nil)
	GetITOCEntry() *types.ITOCEntry
}

type SectionFactory interface {
	// CreateSection creates a new section instance for the given type
	CreateSection(sectionType uint16, offset uint64, size uint32, crcType types.CRCType,
		crc uint32, isEncrypted, isDeviceData bool, entry *types.ITOCEntry, isFromHWPointer bool) (CompleteSectionInterface, error)

	// CreateSectionFromData creates a section and parses its data
	CreateSectionFromData(sectionType uint16, offset uint64, size uint32, crcType types.CRCType,
		crc uint32, isEncrypted, isDeviceData bool, entry *types.ITOCEntry, isFromHWPointer bool, data []byte) (CompleteSectionInterface, error)
}

type SectionInfo struct {
	Type         uint16
	TypeName     string
	Offset       uint64
	Size         uint32
	CRCType      types.CRCType
	IsEncrypted  bool
	IsDeviceData bool
}

type SectionInterface interface {
	// Type returns the section type
	Type() uint16

	// TypeName returns the human-readable name for this section type
	TypeName() string

	// Offset returns the section offset in the firmware
	Offset() uint64

	// Size returns the section size
	Size() uint32

	// CRCType returns the CRC type for this section
	CRCType() types.CRCType

	// HasCRC returns whether this section has CRC verification enabled
	HasCRC() bool

	// GetCRC returns the expected CRC value for this section
	GetCRC() uint32

	// CalculateCRC calculates the CRC for this section
	CalculateCRC() (uint32, error)

	// VerifyCRC verifies the section's CRC
	VerifyCRC() error

	// IsEncrypted returns whether the section is encrypted
	IsEncrypted() bool

	// IsDeviceData returns whether this is device-specific data
	IsDeviceData() bool

	// Parse parses the raw data into section-specific structures
	Parse(data []byte) error

	// GetRawData returns the raw section data
	GetRawData() []byte

	// Write writes the section data to the writer
	Write(w io.Writer) error

	// GetITOCEntry returns the ITOC entry for this section (may be nil)
	GetITOCEntry() *types.ITOCEntry

	// IsFromHWPointer returns true if this section was referenced from HW pointers
	IsFromHWPointer() bool
}

type SectionMetadata interface {
	// Type returns the section type
	Type() uint16

	// TypeName returns the human-readable name for this section type
	TypeName() string

	// Offset returns the section offset in the firmware
	Offset() uint64

	// Size returns the section size
	Size() uint32
}

type SectionOption func(*BaseSection)

type SectionParser interface {
	SectionReader
	SectionData
}

type SectionReader interface {
	SectionMetadata
	SectionAttributes
	SectionCRCInfo
	SectionExtras
}

type SectionVerifier interface {
	SectionReader
	SectionCRCOperations
	SectionData
}