IRB structure (1394.h)
Drivers use this structure to pass most requests to IEEE 1394 bus driver.
Syntax
typedef struct _IRB {
ULONG FunctionNumber;
ULONG Flags;
ULONG_PTR BusReserved[IRB_BUS_RESERVED_SZ];
ULONG_PTR PortReserved[IRB_PORT_RESERVED_SZ];
union {
IRB_REQ_ASYNC_READ AsyncRead;
IRB_REQ_ASYNC_WRITE AsyncWrite;
IRB_REQ_ASYNC_LOCK AsyncLock;
IRB_REQ_ISOCH_ALLOCATE_BANDWIDTH IsochAllocateBandwidth;
IRB_REQ_ISOCH_ALLOCATE_CHANNEL IsochAllocateChannel;
IRB_REQ_ISOCH_ALLOCATE_RESOURCES IsochAllocateResources;
IRB_REQ_ISOCH_ATTACH_BUFFERS IsochAttachBuffers;
IRB_REQ_ISOCH_DETACH_BUFFERS IsochDetachBuffers;
IRB_REQ_ISOCH_FREE_BANDWIDTH IsochFreeBandwidth;
IRB_REQ_ISOCH_FREE_CHANNEL IsochFreeChannel;
IRB_REQ_ISOCH_FREE_RESOURCES IsochFreeResources;
IRB_REQ_ISOCH_LISTEN IsochListen;
IRB_REQ_ISOCH_QUERY_CURRENT_CYCLE_TIME IsochQueryCurrentCycleTime;
IRB_REQ_ISOCH_QUERY_RESOURCES IsochQueryResources;
IRB_REQ_ISOCH_SET_CHANNEL_BANDWIDTH IsochSetChannelBandwidth;
IRB_REQ_ISOCH_STOP IsochStop;
IRB_REQ_ISOCH_TALK IsochTalk;
IRB_REQ_ISOCH_MODIFY_STREAM_PROPERTIES IsochModifyStreamProperties;
IRB_REQ_ALLOCATE_ADDRESS_RANGE AllocateAddressRange;
IRB_REQ_FREE_ADDRESS_RANGE FreeAddressRange;
IRB_REQ_GET_LOCAL_HOST_INFORMATION GetLocalHostInformation;
IRB_REQ_GET_1394_ADDRESS_FROM_DEVICE_OBJECT Get1394AddressFromDeviceObject;
IRB_REQ_CONTROL Control;
IRB_REQ_GET_MAX_SPEED_BETWEEN_DEVICES GetMaxSpeedBetweenDevices;
IRB_REQ_SET_DEVICE_XMIT_PROPERTIES SetDeviceXmitProperties;
IRB_REQ_SET_LOCAL_HOST_PROPERTIES SetLocalHostProperties;
IRB_REQ_GET_CONFIGURATION_INFORMATION GetConfigurationInformation;
IRB_REQ_GET_CONFIG_ROM GetConfigRom;
IRB_REQ_BUS_RESET BusReset;
IRB_REQ_GET_GENERATION_COUNT GetGenerationCount;
IRB_REQ_SEND_PHY_CONFIGURATION_PACKET SendPhyConfigurationPacket;
IRB_REQ_SEND_PHY_PACKET SendPhyPacket;
IRB_REQ_RECEIVE_PHY_PACKETS ReceivePhyPackets;
IRB_REQ_GET_SPEED_TOPOLOGY_MAPS GetSpeedTopologyMaps;
IRB_REQ_BUS_RESET_NOTIFICATION BusResetNotification;
IRB_REQ_ASYNC_STREAM AsyncStream;
} u;
} IRB, *PIRB;
Members
FunctionNumber
Determines the type of request. Each request type is documented under the value of FunctionNumber in IEEE 1394 Bus I/O Requests.
Flags
Reserved. Drivers must set this member to zero with one exception. When making a REQUEST_ISOCH_ALLOCATE_BANDWIDTH request, the caller can set the IRB_FLAG_ALLOW_REMOTE_FREE flag in Flags to indicate that the system should free the bandwidth handle memory pointed to be IsochAllocateBandwidth.hBandwidth. If caller does not set this flag, then caller will have to free the bandwidth handle.
BusReserved[IRB_BUS_RESERVED_SZ]
Reserved.
PortReserved[IRB_PORT_RESERVED_SZ]
Reserved.
u
Specifies a union of structures, one for each value of FunctionNumber. The applicable submembers of u for each request are described with each request type in IEEE 1394 Bus I/O Requests.
u.AsyncRead
u.AsyncWrite
u.AsyncLock
u.IsochAllocateBandwidth
u.IsochAllocateChannel
u.IsochAllocateResources
u.IsochAttachBuffers
u.IsochDetachBuffers
u.IsochFreeBandwidth
u.IsochFreeChannel
u.IsochFreeResources
u.IsochListen
u.IsochQueryCurrentCycleTime
u.IsochQueryResources
u.IsochSetChannelBandwidth
u.IsochStop
u.IsochTalk
u.IsochModifyStreamProperties
u.AllocateAddressRange
u.FreeAddressRange
u.GetLocalHostInformation
u.Get1394AddressFromDeviceObject
u.Control
u.GetMaxSpeedBetweenDevices
u.SetDeviceXmitProperties
u.SetLocalHostProperties
u.GetConfigurationInformation
u.GetConfigRom
u.BusReset
u.GetGenerationCount
u.SendPhyConfigurationPacket
u.SendPhyPacket
u.ReceivePhyPackets
u.GetSpeedTopologyMaps
u.BusResetNotification
u.AsyncStream
Remarks
The Parameters->Others.Arguments1 member of an IOCTL_1394_CLASS IRP points to an IRB structure. The bus driver uses the IRB to determine the type of request made by the device driver, and also to return the results of the operation. See IEEE 1394 Bus I/O Requests for a description of the behavior of each request.
Requirements
| Requirement | Value |
|---|---|
| Header | 1394.h (include 1394.h) |