Undi32.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439
  1. /** @file
  2. EFI internal structures for the EFI UNDI driver.
  3. Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef _UNDI_32_H_
  7. #define _UNDI_32_H_
  8. #include <Uefi.h>
  9. #include <Guid/EventGroup.h>
  10. #include <Protocol/PciIo.h>
  11. #include <Protocol/NetworkInterfaceIdentifier.h>
  12. #include <Protocol/DevicePath.h>
  13. #include <Protocol/AdapterInformation.h>
  14. #include <Library/UefiDriverEntryPoint.h>
  15. #include <Library/UefiRuntimeLib.h>
  16. #include <Library/DebugLib.h>
  17. #include <Library/BaseMemoryLib.h>
  18. #include <Library/UefiBootServicesTableLib.h>
  19. #include <Library/UefiLib.h>
  20. #include <Library/BaseLib.h>
  21. #include <Library/DevicePathLib.h>
  22. #include <Library/MemoryAllocationLib.h>
  23. #include <IndustryStandard/Pci.h>
  24. #include "E100b.h"
  25. extern EFI_DRIVER_BINDING_PROTOCOL gUndiDriverBinding;
  26. extern EFI_COMPONENT_NAME_PROTOCOL gUndiComponentName;
  27. extern EFI_COMPONENT_NAME2_PROTOCOL gUndiComponentName2;
  28. #define MAX_NIC_INTERFACES 16
  29. #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION_31 0x00010001
  30. #define PXE_ROMID_MINORVER_31 0x10
  31. #define PXE_STATFLAGS_DB_WRITE_TRUNCATED 0x2000
  32. //
  33. // UNDI_CALL_TABLE.state can have the following values
  34. //
  35. #define DONT_CHECK -1
  36. #define ANY_STATE -1
  37. #define MUST_BE_STARTED 1
  38. #define MUST_BE_INITIALIZED 2
  39. #define UNDI_DEV_SIGNATURE SIGNATURE_32('u','n','d','i')
  40. #define UNDI_DEV_FROM_THIS(a) CR(a, UNDI32_DEV, NIIProtocol_31, UNDI_DEV_SIGNATURE)
  41. #define UNDI_DEV_FROM_NIC(a) CR(a, UNDI32_DEV, NicInfo, UNDI_DEV_SIGNATURE)
  42. #define UNDI_DEV_FROM_AIP(a) CR(a, UNDI32_DEV, Aip, UNDI_DEV_SIGNATURE)
  43. typedef struct {
  44. UINTN Signature;
  45. EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol_31;
  46. EFI_ADAPTER_INFORMATION_PROTOCOL Aip;
  47. EFI_HANDLE DeviceHandle;
  48. EFI_DEVICE_PATH_PROTOCOL *Undi32BaseDevPath;
  49. EFI_DEVICE_PATH_PROTOCOL *Undi32DevPath;
  50. NIC_DATA_INSTANCE NicInfo;
  51. } UNDI32_DEV;
  52. typedef struct {
  53. UINT16 cpbsize;
  54. UINT16 dbsize;
  55. UINT16 opflags;
  56. UINT16 state;
  57. VOID (*api_ptr)();
  58. } UNDI_CALL_TABLE;
  59. typedef VOID (*ptr)(VOID);
  60. typedef VOID (*bsptr_30)(UINTN);
  61. typedef VOID (*virtphys_30)(UINT64, UINT64);
  62. typedef VOID (*block_30)(UINT32);
  63. typedef VOID (*mem_io_30)(UINT8, UINT8, UINT64, UINT64);
  64. typedef VOID (*bsptr)(UINT64, UINTN);
  65. typedef VOID (*virtphys)(UINT64, UINT64, UINT64);
  66. typedef VOID (*block)(UINT64, UINT32);
  67. typedef VOID (*mem_io)(UINT64, UINT8, UINT8, UINT64, UINT64);
  68. typedef VOID (*map_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);
  69. typedef VOID (*unmap_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);
  70. typedef VOID (*sync_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);
  71. extern UNDI_CALL_TABLE api_table[];
  72. extern PXE_SW_UNDI *pxe_31; // !pxe structure for 3.1 drivers
  73. extern UNDI32_DEV *UNDI32DeviceList[MAX_NIC_INTERFACES];
  74. //
  75. // functions defined in e100b.c
  76. //
  77. UINT8 InByte (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);
  78. UINT16 InWord (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);
  79. UINT32 InLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);
  80. VOID OutByte (NIC_DATA_INSTANCE *AdapterInfo, UINT8 Data, UINT32 Port);
  81. VOID OutWord (NIC_DATA_INSTANCE *AdapterInfo, UINT16 Data, UINT32 Port);
  82. VOID OutLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Data, UINT32 Port);
  83. UINTN E100bInit (NIC_DATA_INSTANCE *AdapterInfo);
  84. UINTN E100bReset (NIC_DATA_INSTANCE *AdapterInfo, INT32 OpFlags);
  85. UINTN E100bShutdown (NIC_DATA_INSTANCE *AdapterInfo);
  86. UINTN E100bTransmit (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT16 opflags);
  87. UINTN E100bReceive (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT64 db);
  88. UINTN E100bSetfilter (NIC_DATA_INSTANCE *AdapterInfo, UINT16 New_filter,
  89. UINT64 cpb, UINT32 cpbsize);
  90. UINTN E100bStatistics(NIC_DATA_INSTANCE *AdapterInfo, UINT64 db, UINT16 dbsize);
  91. UINT8 E100bSetupIAAddr (NIC_DATA_INSTANCE *AdapterInfo);
  92. UINT8 E100bSetInterruptState (NIC_DATA_INSTANCE *AdapterInfo);
  93. UINT8 E100bGetEepromAddrLen (NIC_DATA_INSTANCE *AdapterInfo);
  94. UINT16 E100bReadEeprom (NIC_DATA_INSTANCE *AdapterInfo, INT32 Location, UINT8 address_len);
  95. INT16 E100bReadEepromAndStationAddress (NIC_DATA_INSTANCE *AdapterInfo);
  96. UINT16 next(UINT16);
  97. UINT8 SetupCBlink (NIC_DATA_INSTANCE *AdapterInfo);
  98. VOID SetFreeCB (NIC_DATA_INSTANCE *AdapterInfo,TxCB *);
  99. TxCB *GetFreeCB (NIC_DATA_INSTANCE *AdapterInfo);
  100. UINT16 CheckCBList (NIC_DATA_INSTANCE *AdapterInfo);
  101. UINT8 SelectiveReset (NIC_DATA_INSTANCE *AdapterInfo);
  102. UINT16 InitializeChip (NIC_DATA_INSTANCE *AdapterInfo);
  103. UINT8 SetupReceiveQueues (NIC_DATA_INSTANCE *AdapterInfo);
  104. VOID Recycle_RFD (NIC_DATA_INSTANCE *AdapterInfo, UINT16);
  105. VOID XmitWaitForCompletion (NIC_DATA_INSTANCE *AdapterInfo);
  106. INT8 CommandWaitForCompletion (TxCB *cmd_ptr, NIC_DATA_INSTANCE *AdapterInfo);
  107. BOOLEAN PhyDetect (NIC_DATA_INSTANCE *AdapterInfo);
  108. VOID PhyReset (NIC_DATA_INSTANCE *AdapterInfo);
  109. VOID
  110. MdiWrite (
  111. IN NIC_DATA_INSTANCE *AdapterInfo,
  112. IN UINT8 RegAddress,
  113. IN UINT8 PhyAddress,
  114. IN UINT16 DataValue
  115. );
  116. VOID
  117. MdiRead(
  118. IN NIC_DATA_INSTANCE *AdapterInfo,
  119. IN UINT8 RegAddress,
  120. IN UINT8 PhyAddress,
  121. IN OUT UINT16 *DataValue
  122. );
  123. BOOLEAN SetupPhy (NIC_DATA_INSTANCE *AdapterInfo);
  124. VOID FindPhySpeedAndDpx (NIC_DATA_INSTANCE *AdapterInfo, UINT32 PhyId);
  125. //
  126. // functions defined in init.c
  127. //
  128. EFI_STATUS
  129. InstallConfigTable (
  130. IN VOID
  131. );
  132. EFI_STATUS
  133. EFIAPI
  134. InitializeUNDIDriver (
  135. IN EFI_HANDLE ImageHandle,
  136. IN EFI_SYSTEM_TABLE *SystemTable
  137. );
  138. VOID
  139. UNDI_notify_virtual (
  140. EFI_EVENT event,
  141. VOID *context
  142. );
  143. EFI_STATUS
  144. EFIAPI
  145. UndiDriverSupported (
  146. IN EFI_DRIVER_BINDING_PROTOCOL *This,
  147. IN EFI_HANDLE Controller,
  148. IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
  149. );
  150. EFI_STATUS
  151. EFIAPI
  152. UndiDriverStart (
  153. IN EFI_DRIVER_BINDING_PROTOCOL *This,
  154. IN EFI_HANDLE Controller,
  155. IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
  156. );
  157. EFI_STATUS
  158. EFIAPI
  159. UndiDriverStop (
  160. IN EFI_DRIVER_BINDING_PROTOCOL *This,
  161. IN EFI_HANDLE Controller,
  162. IN UINTN NumberOfChildren,
  163. IN EFI_HANDLE *ChildHandleBuffer
  164. );
  165. EFI_STATUS
  166. AppendMac2DevPath (
  167. IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPtr,
  168. IN EFI_DEVICE_PATH_PROTOCOL *BaseDevPtr,
  169. IN NIC_DATA_INSTANCE *AdapterInfo
  170. );
  171. VOID
  172. TmpDelay (
  173. IN UINT64 UnqId,
  174. IN UINTN MicroSeconds
  175. );
  176. VOID
  177. TmpMemIo (
  178. IN UINT64 UnqId,
  179. IN UINT8 ReadWrite,
  180. IN UINT8 Len,
  181. IN UINT64 Port,
  182. IN UINT64 BufAddr
  183. );
  184. //
  185. // functions defined in decode.c
  186. //
  187. VOID
  188. UNDI_GetState (
  189. IN PXE_CDB *CdbPtr,
  190. IN NIC_DATA_INSTANCE *AdapterInfo
  191. );
  192. VOID
  193. UNDI_Start (
  194. IN PXE_CDB *CdbPtr,
  195. IN NIC_DATA_INSTANCE *AdapterInfo
  196. );
  197. VOID
  198. UNDI_Stop (
  199. IN PXE_CDB *CdbPtr,
  200. IN NIC_DATA_INSTANCE *AdapterInfo
  201. );
  202. VOID
  203. UNDI_GetInitInfo (
  204. IN PXE_CDB *CdbPtr,
  205. IN NIC_DATA_INSTANCE *AdapterInfo
  206. );
  207. VOID
  208. UNDI_GetConfigInfo (
  209. IN PXE_CDB *CdbPtr,
  210. IN NIC_DATA_INSTANCE *AdapterInfo
  211. );
  212. VOID
  213. UNDI_Initialize (
  214. IN PXE_CDB *CdbPtr,
  215. NIC_DATA_INSTANCE *AdapterInfo
  216. );
  217. VOID
  218. UNDI_Reset (
  219. IN PXE_CDB *CdbPtr,
  220. IN NIC_DATA_INSTANCE *AdapterInfo
  221. );
  222. VOID
  223. UNDI_Shutdown (
  224. IN PXE_CDB *CdbPtr,
  225. IN NIC_DATA_INSTANCE *AdapterInfo
  226. );
  227. VOID
  228. UNDI_Interrupt (
  229. IN PXE_CDB *CdbPtr,
  230. IN NIC_DATA_INSTANCE *AdapterInfo
  231. );
  232. VOID
  233. UNDI_RecFilter (
  234. IN PXE_CDB *CdbPtr,
  235. IN NIC_DATA_INSTANCE *AdapterInfo
  236. );
  237. VOID
  238. UNDI_StnAddr (
  239. IN PXE_CDB *CdbPtr,
  240. IN NIC_DATA_INSTANCE *AdapterInfo
  241. );
  242. VOID
  243. UNDI_Statistics (
  244. IN PXE_CDB *CdbPtr,
  245. IN NIC_DATA_INSTANCE *AdapterInfo
  246. );
  247. VOID
  248. UNDI_ip2mac (
  249. IN PXE_CDB *CdbPtr,
  250. IN NIC_DATA_INSTANCE *AdapterInfo
  251. );
  252. VOID
  253. UNDI_NVData (
  254. IN PXE_CDB *CdbPtr,
  255. IN NIC_DATA_INSTANCE *AdapterInfo
  256. );
  257. VOID
  258. UNDI_Status (
  259. IN PXE_CDB *CdbPtr,
  260. IN NIC_DATA_INSTANCE *AdapterInfo
  261. );
  262. VOID
  263. UNDI_FillHeader (
  264. IN PXE_CDB *CdbPtr,
  265. IN NIC_DATA_INSTANCE *AdapterInfo
  266. );
  267. VOID
  268. UNDI_Transmit (
  269. IN PXE_CDB *CdbPtr,
  270. IN NIC_DATA_INSTANCE *AdapterInfo
  271. );
  272. VOID
  273. UNDI_Receive (
  274. IN PXE_CDB *CdbPtr,
  275. IN NIC_DATA_INSTANCE *AdapterInfo
  276. );
  277. VOID EFIAPI UNDI_APIEntry_new(UINT64);
  278. VOID UNDI_APIEntry_Common(UINT64);
  279. PXE_IPV4 convert_mcip(PXE_MAC_ADDR *);
  280. INT32 validate_mcip (PXE_MAC_ADDR *MCastAddr);
  281. VOID PxeStructInit (PXE_SW_UNDI *PxePtr);
  282. VOID PxeUpdate (NIC_DATA_INSTANCE *NicPtr, PXE_SW_UNDI *PxePtr);
  283. //
  284. // functions defined in UndiAipImpl.c
  285. //
  286. /**
  287. Returns the current state information for the adapter.
  288. This function returns information of type InformationType from the adapter.
  289. If an adapter does not support the requested informational type, then
  290. EFI_UNSUPPORTED is returned.
  291. @param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
  292. @param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock.
  293. @param[out] InforamtionBlock The service returns a pointer to the buffer with the InformationBlock
  294. structure which contains details about the data specific to InformationType.
  295. @param[out] InforamtionBlockSize The driver returns the size of the InformationBlock in bytes.
  296. @retval EFI_SUCCESS The InformationType information was retrieved.
  297. @retval EFI_UNSUPPORTED The InformationType is not known.
  298. @retval EFI_DEVICE_ERROR The device reported an error.
  299. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
  300. @retval EFI_INVALID_PARAMETER This is NULL.
  301. @retval EFI_INVALID_PARAMETER InformationBlock is NULL.
  302. @retval EFI_INVALID_PARAMETER InformationBlockSize is NULL.
  303. **/
  304. EFI_STATUS
  305. EFIAPI
  306. UndiAipGetInfo (
  307. IN EFI_ADAPTER_INFORMATION_PROTOCOL *This,
  308. IN EFI_GUID *InformationType,
  309. OUT VOID **InformationBlock,
  310. OUT UINTN *InformationBlockSize
  311. );
  312. /**
  313. Sets state information for an adapter.
  314. This function sends information of type InformationType for an adapter.
  315. If an adapter does not support the requested information type, then EFI_UNSUPPORTED
  316. is returned.
  317. @param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
  318. @param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock.
  319. @param[in] InforamtionBlock A pointer to the InformationBlock structure which contains details
  320. about the data specific to InformationType.
  321. @param[in] InforamtionBlockSize The size of the InformationBlock in bytes.
  322. @retval EFI_SUCCESS The information was received and interpreted successfully.
  323. @retval EFI_UNSUPPORTED The InformationType is not known.
  324. @retval EFI_DEVICE_ERROR The device reported an error.
  325. @retval EFI_INVALID_PARAMETER This is NULL.
  326. @retval EFI_INVALID_PARAMETER InformationBlock is NULL.
  327. @retval EFI_WRITE_PROTECTED The InformationType cannot be modified using EFI_ADAPTER_INFO_SET_INFO().
  328. **/
  329. EFI_STATUS
  330. EFIAPI
  331. UndiAipSetInfo (
  332. IN EFI_ADAPTER_INFORMATION_PROTOCOL *This,
  333. IN EFI_GUID *InformationType,
  334. IN VOID *InformationBlock,
  335. IN UINTN InformationBlockSize
  336. );
  337. /**
  338. Get a list of supported information types for this instance of the protocol.
  339. This function returns a list of InformationType GUIDs that are supported on an
  340. adapter with this instance of EFI_ADAPTER_INFORMATION_PROTOCOL. The list is returned
  341. in InfoTypesBuffer, and the number of GUID pointers in InfoTypesBuffer is returned in
  342. InfoTypesBufferCount.
  343. @param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
  344. @param[out] InfoTypesBuffer A pointer to the list of InformationType GUID pointers that are supported
  345. by This.
  346. @param[out] InfoTypesBufferCount A pointer to the number of GUID pointers present in InfoTypesBuffer.
  347. @retval EFI_SUCCESS The list of information type GUIDs that are supported on this adapter was
  348. returned in InfoTypesBuffer. The number of information type GUIDs was
  349. returned in InfoTypesBufferCount.
  350. @retval EFI_INVALID_PARAMETER This is NULL.
  351. @retval EFI_INVALID_PARAMETER InfoTypesBuffer is NULL.
  352. @retval EFI_INVALID_PARAMETER InfoTypesBufferCount is NULL.
  353. @retval EFI_OUT_OF_RESOURCES There is not enough pool memory to store the results.
  354. **/
  355. EFI_STATUS
  356. EFIAPI
  357. UndiAipGetSupportedTypes (
  358. IN EFI_ADAPTER_INFORMATION_PROTOCOL *This,
  359. OUT EFI_GUID **InfoTypesBuffer,
  360. OUT UINTN *InfoTypesBufferCount
  361. );
  362. #endif