2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS Novell Eagle 2000 driver
4 * FILE: include/ne2000.h
5 * PURPOSE: NE2000 driver definitions
13 #define ULONG ULONG_PTR
23 /* Define NOCARD to test NDIS without a card */
26 /* NE2000 sepcific constants */
27 #define NIC_DATA 0x10 /* Data register */
28 #define NIC_RESET 0x1F /* Reset register */
31 /* Global constants */
33 #define DRIVER_NDIS_MAJOR_VERSION 3
34 #define DRIVER_NDIS_MINOR_VERSION 0
36 #define DRIVER_DEFAULT_IO_BASE_ADDRESS 0x300
37 #define DRIVER_DEFAULT_INTERRUPT_NUMBER 10
39 #define DRIVER_MAX_MULTICAST_LIST_SIZE 8
41 #define DRIVER_VENDOR_DESCRIPTION "Novell Eagle 2000 Adapter."
42 #define DRIVER_VENDOR_DRIVER_VERSION 0x0100 /* 1.0 */
44 #define DRIVER_FRAME_SIZE 1514 /* Size of an ethernet frame */
45 #define DRIVER_HEADER_SIZE 14 /* Size of an ethernet header */
46 #define DRIVER_LENGTH_OF_ADDRESS 6 /* Size of an ethernet address */
48 /* Maximum lookahead buffer size */
49 #define DRIVER_MAXIMUM_LOOKAHEAD (252 - DRIVER_HEADER_SIZE)
51 /* Size of a block in a buffer ring */
52 #define DRIVER_BLOCK_SIZE 256
55 /* Default number of transmit buffers */
56 #define DRIVER_DEFAULT_TX_BUFFER_COUNT 12
58 /* Interrupt Mask Register value */
59 #define DRIVER_INTERRUPT_MASK IMR_ALLE - IMR_RDCE
63 /* Global structures */
65 typedef struct _MINIPORT_RESERVED
68 } MINIPORT_RESERVED
, *PMINIPORT_RESERVED
;
70 #define RESERVED(Packet) ((PMINIPORT_RESERVED)((Packet)->u.s1.MiniportReserved))
72 typedef UCHAR DRIVER_HARDWARE_ADDRESS
[DRIVER_LENGTH_OF_ADDRESS
];
74 /* Information about an adapter */
75 typedef struct _NIC_ADAPTER
77 /* Entry on global adapter list */
80 NDIS_HANDLE MiniportAdapterHandle
;
81 /* NDIS interrupt object */
82 NDIS_MINIPORT_INTERRUPT Interrupt
;
84 /* I/O base address and interrupt number of adapter */
86 ULONG InterruptNumber
;
88 /* Mapped address of the I/O base port */
91 /* TRUE if the NIC can transfer in word mode */
94 /* Base address and size of the onboard memory window */
98 /* Station Address PROM (SAPROM) */
101 /* Onboard ethernet address from the manufacturer */
102 DRIVER_HARDWARE_ADDRESS PermanentAddress
;
104 /* Ethernet address currently in use */
105 DRIVER_HARDWARE_ADDRESS StationAddress
;
107 /* Maximum number of multicast addresses this adapter supports */
108 ULONG MaxMulticastListSize
;
110 /* List of multicast addresses in use */
111 DRIVER_HARDWARE_ADDRESS Addresses
[DRIVER_MAX_MULTICAST_LIST_SIZE
];
113 /* Current multicast address mask */
114 UCHAR MulticastAddressMask
[8];
116 /* Masked interrupts (IMR value) */
119 /* Interrupts that have occurred */
120 UCHAR InterruptStatus
;
122 /* Current packet filter */
125 /* Lookahead buffer */
127 UCHAR Lookahead
[DRIVER_MAXIMUM_LOOKAHEAD
+ DRIVER_HEADER_SIZE
];
129 /* Receive buffer ring */
135 /* TRUE if there was a buffer overflow */
136 BOOLEAN BufferOverflow
;
138 /* TRUE if an error occurred during reception of a packet */
139 BOOLEAN ReceiveError
;
141 /* TRUE if an error occurred during transmission of a packet */
142 BOOLEAN TransmitError
;
144 /* TRUE if a transmit interrupt is pending */
145 BOOLEAN TransmitPending
;
147 /* Received packet header */
148 PACKET_HEADER PacketHeader
;
150 /* Offset in onboard RAM of received packet */
153 /* TRUE if receive indications are done and should be completed */
154 BOOLEAN DoneIndicating
;
156 /* Transmit buffers */
157 UINT TXStart
; /* Start block of transmit buffer ring */
158 UINT TXCount
; /* Number of blocks in transmit buffer ring */
159 UINT TXFree
; /* Number of free transmit buffers */
160 UINT TXNext
; /* Next buffer to use */
161 /* Length of packet. 0 means buffer is unused */
162 INT TXSize
[DRIVER_DEFAULT_TX_BUFFER_COUNT
];
163 INT TXCurrent
; /* Current buffer beeing transmitted. -1 means none */
165 /* Head of transmit queue */
166 PNDIS_PACKET TXQueueHead
;
167 /* Tail of transmit queue */
168 PNDIS_PACKET TXQueueTail
;
171 ULONG FrameAlignmentErrors
;
175 /* Flags used for driver cleanup */
176 BOOLEAN IOPortRangeRegistered
;
177 BOOLEAN InterruptRegistered
;
178 } NIC_ADAPTER
, *PNIC_ADAPTER
;
180 /* Global driver information */
181 typedef struct _DRIVER_INFORMATION
183 NDIS_HANDLE NdisWrapperHandle
; /* Returned from NdisInitializeWrapper */
184 NDIS_HANDLE NdisMacHandle
; /* Returned from NdisRegisterMac */
185 LIST_ENTRY AdapterListHead
; /* Adapters this driver control */
186 } DRIVER_INFORMATION
, *PDRIVER_INFORMATION
;
190 /* Global variable */
192 extern DRIVER_INFORMATION DriverInfo
;
193 extern NDIS_PHYSICAL_ADDRESS HighestAcceptableMax
;
200 PNIC_ADAPTER Adapter
);
202 NDIS_STATUS
NICInitialize(
203 PNIC_ADAPTER Adapter
);
205 NDIS_STATUS
NICSetup(
206 PNIC_ADAPTER Adapter
);
208 NDIS_STATUS
NICStart(
209 PNIC_ADAPTER Adapter
);
212 PNIC_ADAPTER Adapter
);
214 NDIS_STATUS
NICReset(
215 PNIC_ADAPTER Adapter
);
217 VOID
NICUpdateCounters(
218 PNIC_ADAPTER Adapter
);
220 VOID
NICReadDataAlign(
221 PNIC_ADAPTER Adapter
,
226 VOID
NICWriteDataAlign(
227 PNIC_ADAPTER Adapter
,
233 PNIC_ADAPTER Adapter
,
239 PNIC_ADAPTER Adapter
,
245 PNIC_ADAPTER Adapter
);
247 #endif /* __NE2000_H */