transport

type ActivatePayloadRequest struct {
	PayloadType     types.PayloadType
	PayloadInstance uint8

	EnableEncryption     bool
	EnableAuthentication bool

	EnableTestMode bool

	// [3:2] - Shared Serial Alert Behavior
	//         The following settings are determine what happens to serial alerts
	//         if IPMI over Serial and SOL are sharing the same baseboard serial controller.
	//   - 11b: Reserved
	//   - 10b: Serial/modem alerts succeed while SOL active.
	//   - 01b: Serial/modem alerts deferred while SOL active.
	//   - 00b: Serial/modem alerts fail while SOL active.
	SharedSerialAlertBehavior SharedSerialAlertBehavior

	// [1] - SOL startup handshake
	//  - 0b: BMC asserts CTS and DCD/DSR to baseboard upon activation.
	//  - 1b: CTS and DCD/DSR remain deasserted after activation.
	//        Remote console must send an SOL Payload packet with control field settings to assert CTS and DCD/DSR.
	//        (This enables the remote console to first alter volatile configuration settings before hardware handshake is released).
	SOLStartupHandshake bool
}

type ActivatePayloadResponse struct {
	TestModeEnabled bool

	InboundPayloadSize  uint16
	OutboundPayloadSize uint16

	PayloadUDPPort uint16
	PayloadVLANID  uint16
}

type ChannelSecurityKeysLockStatus uint8

type ChannelSecurityKeysOperation uint8

type DeactivatePayloadRequest struct {
	PayloadType     types.PayloadType
	PayloadInstance uint8
}

type DeactivatePayloadResponse struct {
}

type GetChannelOEMPayloadInfoRequest struct {
	ChannelNumber uint8

	PayloadType types.PayloadType

	// OEM IANA. When Payload Type Number is 02h (OEM Explicit) this field
	// holds the OEM IANA for the OEM payload type to look up information for. Otherwise, this field is set to 00_00_00h.
	OEMIANA      uint32
	OEMPayloadID uint16
}

type GetChannelOEMPayloadInfoResponse struct {
	PayloadType  types.PayloadType
	OEMIANA      uint32
	OEMPayloadID uint16

	MajorVersion uint8
	MinorVersion uint8
}

type GetChannelPayloadSupportRequest struct {
	ChannelNumber uint8
}

type GetChannelPayloadSupportResponse struct {
	// Standard payload types
	PayloadTypeIPMI bool
	PayloadTypeSOL  bool
	PayloadTypeOEM  bool

	// Session setup payload types
	PayloadTypeRmcpOpenSessionRequest  bool
	PayloadTypeRmcpOpenSessionResponse bool
	PayloadTypeRAKPMessage1            bool
	PayloadTypeRAKPMessage2            bool
	PayloadTypeRAKPMessage3            bool
	PayloadTypeRAKPMessage4            bool

	// OEM payload types
	PayloadTypeOEM0 bool
	PayloadTypeOEM1 bool
	PayloadTypeOEM2 bool
	PayloadTypeOEM3 bool
	PayloadTypeOEM4 bool
	PayloadTypeOEM5 bool
	PayloadTypeOEM6 bool
	PayloadTypeOEM7 bool
}

type GetChannelPayloadVersionRequest struct {
	ChannelNumber uint8

	PayloadType types.PayloadType
}

type GetChannelPayloadVersionResponse struct {
	MajorVersion uint8
	MinorVersion uint8
}

type GetIPStatisticsRequest struct {
	ChannelNumber      uint8
	ClearAllStatistics bool
}

type GetIPStatisticsResponse struct {
	IPPacketsReceived           uint16
	IPHeaderErrorsReceived      uint16
	IPAddressErrorsReceived     uint16
	IPPacketsFragmentedReceived uint16
	IPPacketsTransmitted        uint16
	UDPPacketsReceived          uint16
	RMCPPacketsValidReceived    uint16
	UDPProxyPacketsReceived     uint16
	UDPProxyPacketsDropped      uint16
}

type GetLanConfigParamRequest struct {
	ChannelNumber uint8
	ParamSelector types.LanConfigParamSelector
	SetSelector   uint8
	BlockSelector uint8
}

type GetLanConfigParamResponse struct {
	ParamRevision uint8
	ParamData     []byte
}

type GetPayloadActivationStatusRequest struct {
	PayloadType types.PayloadType
}

type GetPayloadActivationStatusResponse struct {

	// [3:0] - Number of instances of given payload type that can be simultaneously activated on BMC. 1-based. 0h = reserved.
	InstanceCapacity uint8

	Instance01Activated bool
	Instance02Activated bool
	Instance03Activated bool
	Instance04Activated bool
	Instance05Activated bool
	Instance06Activated bool
	Instance07Activated bool
	Instance08Activated bool
	Instance09Activated bool
	Instance10Activated bool
	Instance11Activated bool
	Instance12Activated bool
	Instance13Activated bool
	Instance14Activated bool
	Instance15Activated bool
	Instance16Activated bool

	// Store the PayloadType specified in GetPayloadActivationStatusRequest
	PayloadType types.PayloadType
}

type GetPayloadInstanceInfoRequest struct {
	PayloadType     types.PayloadType
	PayloadInstance uint8
}

type GetPayloadInstanceInfoResponse struct {
	SessionID uint32

	// For Payload Type = SOL:
	//  Byte 1: Port Number
	//    A number representing the system serial port that is being redirected.
	//    1-based. 0h = unspecified. Used when more than one port can be redirected on a system.
	PortNumber uint8

	PayloadType types.PayloadType
}

type GetSOLConfigParamRequest struct {
	GetParamRevisionOnly bool
	ChannelNumber        uint8
	ParamSelector        types.SOLConfigParamSelector
	SetSelector          uint8
	BlockSelector        uint8
}

type GetSOLConfigParamResponse struct {
	ParamRevision uint8
	ParamData     []byte
}

type PayloadEncryptionOperation uint8

type SOLActivatingRequest struct {
	SessionState       uint8
	PayloadInstance    uint8
	FormatVersionMajor uint8
	FormatVersionMinor uint8
}

type SOLActivatingResponse struct {
}

type SetChannelSecurityKeysRequest struct {
	ChannelNumber uint8

	Operation ChannelSecurityKeysOperation

	KeyID uint8

	KeyValue []byte
}

type SetChannelSecurityKeysResponse struct {
	LockStatus ChannelSecurityKeysLockStatus
	KeyValue   []byte
}

type SetLanConfigParamRequest struct {
	ChannelNumber uint8
	ParamSelector types.LanConfigParamSelector
	ParamData     []byte
}

type SetLanConfigParamResponse struct {
}

type SetSOLConfigParamRequest struct {
	ChannelNumber uint8
	ParamSelector types.SOLConfigParamSelector
	ParamData     []byte
}

type SetSOLConfigParamResponse struct {
}

type SharedSerialAlertBehavior uint8

type SuspendARPsRequest struct {
	ChannelNumber        uint8
	SuspendARP           bool
	SuspendGratuitousARP bool
}

type SuspendARPsResponse struct {
	IsARPOccurring           bool
	IsGratuitousARPOccurring bool
}

type SuspendResumePayloadEncryptionRequest struct {
	PayloadType     types.PayloadType
	PayloadInstance uint8
	Operation       PayloadEncryptionOperation
}

type SuspendResumePayloadEncryptionResponse struct {
}