- This is the SNP interface routine for getting the status\r
- This routine basically retrieves snp structure, checks the SNP state and\r
- calls the pxe_getstatus routine to actually get the undi status\r
-\r
- @param this context pointer\r
- @param InterruptStatusPtr a non null pointer gets the interrupt status\r
- @param TransmitBufferListPtrs a non null ointer gets the list of pointers of\r
- previously transmitted buffers whose\r
- transmission was completed asynchrnously.\r
-\r
+ Reads the current interrupt status and recycled transmit buffer status from a\r
+ network interface.\r
+ \r
+ This function gets the current interrupt and recycled transmit buffer status \r
+ from the network interface. The interrupt status is returned as a bit mask in\r
+ InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be\r
+ read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved.\r
+ If a recycled transmit buffer address is returned in TxBuf, then the buffer has\r
+ been successfully transmitted, and the status for that buffer is cleared. If\r
+ the status of the network interface is successfully collected, EFI_SUCCESS \r
+ will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will\r
+ be returned.\r
+\r
+ @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
+ @param InterruptStatus A pointer to the bit mask of the currently active \r
+ interrupts (see "Related Definitions"). If this is NULL,\r
+ the interrupt status will not be read from the device.\r
+ If this is not NULL, the interrupt status will be read\r
+ from the device. When the interrupt status is read, it \r
+ will also be cleared. Clearing the transmit interrupt does \r
+ not empty the recycled transmit buffer array.\r
+ @param TxBuf Recycled transmit buffer address. The network interface\r
+ will not transmit if its internal recycled transmit \r
+ buffer array is full. Reading the transmit buffer does\r
+ not clear the transmit interrupt. If this is NULL, then\r
+ the transmit buffer status will not be read. If there \r
+ are no transmit buffers to recycle and TxBuf is not NULL, \r
+ TxBuf will be set to NULL.\r
+\r
+ @retval EFI_SUCCESS The status of the network interface was retrieved.\r
+ @retval EFI_NOT_STARTED The network interface has not been started.\r
+ @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid \r
+ EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
+ @retval EFI_DEVICE_ERROR The command could not be sent to the network \r
+ interface.\r