Rename
[mirror_edk2.git] / MdeModulePkg / Universal / Network / SnpDxe / Get_status.c
1 /** @file
2 Copyright (c) 2004 - 2007, Intel Corporation
3 All rights reserved. This program and the accompanying materials
4 are licensed and made available under the terms and conditions of the BSD License
5 which accompanies this distribution. The full text of the license may be found at
6 http://opensource.org/licenses/bsd-license.php
7
8 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
9 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
10
11 Module name:
12 get_status.c
13
14 Abstract:
15
16 Revision history:
17 2000-Feb-03 M(f)J Genesis.
18
19 **/
20
21 #include "Snp.h"
22
23 STATIC
24 /**
25 this routine calls undi to get the status of the interrupts, get the list of
26 transmit buffers that completed transmitting!
27
28 @param snp pointer to snp driver structure
29 @param InterruptStatusPtr a non null pointer gets the interrupt status
30 @param TransmitBufferListPtrs a non null ointer gets the list of pointers of
31 previously transmitted buffers whose
32 transmission was completed asynchrnously.
33
34
35 **/
36 EFI_STATUS
37 pxe_getstatus (
38 SNP_DRIVER *snp,
39 UINT32 *InterruptStatusPtr,
40 VOID **TransmitBufferListPtr
41 )
42 {
43 PXE_DB_GET_STATUS *db;
44 UINT16 InterruptFlags;
45
46 db = snp->db;
47 snp->cdb.OpCode = PXE_OPCODE_GET_STATUS;
48
49 snp->cdb.OpFlags = 0;
50
51 if (TransmitBufferListPtr != NULL) {
52 snp->cdb.OpFlags |= PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS;
53 }
54
55 if (InterruptStatusPtr != NULL) {
56 snp->cdb.OpFlags |= PXE_OPFLAGS_GET_INTERRUPT_STATUS;
57 }
58
59 snp->cdb.CPBsize = PXE_CPBSIZE_NOT_USED;
60 snp->cdb.CPBaddr = PXE_CPBADDR_NOT_USED;
61
62 //
63 // size DB for return of one buffer
64 //
65 snp->cdb.DBsize = (UINT16) (((UINT16) (sizeof (PXE_DB_GET_STATUS)) - (UINT16) (sizeof db->TxBuffer)) + (UINT16) (sizeof db->TxBuffer[0]));
66
67 snp->cdb.DBaddr = (UINT64)(UINTN) db;
68
69 snp->cdb.StatCode = PXE_STATCODE_INITIALIZE;
70 snp->cdb.StatFlags = PXE_STATFLAGS_INITIALIZE;
71 snp->cdb.IFnum = snp->if_num;
72 snp->cdb.Control = PXE_CONTROL_LAST_CDB_IN_LIST;
73
74 //
75 // Issue UNDI command and check result.
76 //
77 DEBUG ((EFI_D_NET, "\nsnp->undi.get_status() "));
78
79 (*snp->issue_undi32_command) ((UINT64)(UINTN) &snp->cdb);
80
81 if (snp->cdb.StatCode != EFI_SUCCESS) {
82 DEBUG (
83 (EFI_D_NET,
84 "\nsnp->undi.get_status() %xh:%xh\n",
85 snp->cdb.StatFlags,
86 snp->cdb.StatFlags)
87 );
88
89 return EFI_DEVICE_ERROR;
90 }
91 //
92 // report the values back..
93 //
94 if (InterruptStatusPtr != NULL) {
95 InterruptFlags = (UINT16) (snp->cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK);
96
97 *InterruptStatusPtr = 0;
98
99 if (InterruptFlags & PXE_STATFLAGS_GET_STATUS_RECEIVE) {
100 *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT;
101 }
102
103 if (InterruptFlags & PXE_STATFLAGS_GET_STATUS_TRANSMIT) {
104 *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT;
105 }
106
107 if (InterruptFlags & PXE_STATFLAGS_GET_STATUS_COMMAND) {
108 *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT;
109 }
110
111 if (InterruptFlags & PXE_STATFLAGS_GET_STATUS_SOFTWARE) {
112 *InterruptStatusPtr |= EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT;
113 }
114
115 }
116
117 if (TransmitBufferListPtr != NULL) {
118 *TransmitBufferListPtr =
119 (
120 (snp->cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN) ||
121 (snp->cdb.StatFlags & PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY)
122 ) ? 0 : (VOID *) (UINTN) db->TxBuffer[0];
123
124 }
125
126 return EFI_SUCCESS;
127 }
128
129
130 /**
131 This is the SNP interface routine for getting the status
132 This routine basically retrieves snp structure, checks the SNP state and
133 calls the pxe_getstatus routine to actually get the undi status
134
135 @param this context pointer
136 @param InterruptStatusPtr a non null pointer gets the interrupt status
137 @param TransmitBufferListPtrs a non null ointer gets the list of pointers of
138 previously transmitted buffers whose
139 transmission was completed asynchrnously.
140
141
142 **/
143 EFI_STATUS
144 EFIAPI
145 snp_undi32_get_status (
146 IN EFI_SIMPLE_NETWORK_PROTOCOL * this,
147 OUT UINT32 *InterruptStatusPtr OPTIONAL,
148 OUT VOID **TransmitBufferListPtr OPTIONAL
149 )
150 {
151 SNP_DRIVER *snp;
152 EFI_TPL OldTpl;
153 EFI_STATUS Status;
154
155 if (this == NULL) {
156 return EFI_INVALID_PARAMETER;
157 }
158
159 if (InterruptStatusPtr == NULL && TransmitBufferListPtr == NULL) {
160 return EFI_INVALID_PARAMETER;
161 }
162
163 snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (this);
164
165 OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
166
167 if (snp == NULL) {
168 return EFI_DEVICE_ERROR;
169 }
170
171 switch (snp->mode.State) {
172 case EfiSimpleNetworkInitialized:
173 break;
174
175 case EfiSimpleNetworkStopped:
176 Status = EFI_NOT_STARTED;
177 goto ON_EXIT;
178
179 default:
180 Status = EFI_DEVICE_ERROR;
181 goto ON_EXIT;
182 }
183
184 Status = pxe_getstatus (snp, InterruptStatusPtr, TransmitBufferListPtr);
185
186 ON_EXIT:
187 gBS->RestoreTPL (OldTpl);
188
189 return Status;
190 }