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
10 #define NDIS_MINIPORT_DRIVER 1
11 #define NDIS_LEGACY_MINIPORT 1
12 #define NDIS51_MINIPORT 1
17 /* Define NOCARD to test NDIS without a card */
20 /* NE2000 sepcific constants */
21 #define NIC_DATA 0x10 /* Data register */
22 #define NIC_RESET 0x1F /* Reset register */
25 /* Global constants */
27 #define DRIVER_NDIS_MAJOR_VERSION 3
28 #define DRIVER_NDIS_MINOR_VERSION 0
30 #define DRIVER_DEFAULT_IO_BASE_ADDRESS 0x280 /* bochs default */
31 #define DRIVER_DEFAULT_INTERRUPT_NUMBER 9 /* bochs default */
32 #define DRIVER_DEFAULT_INTERRUPT_SHARED FALSE
33 #define DRIVER_DEFAULT_INTERRUPT_MODE NdisInterruptLatched
35 #define DRIVER_MAX_MULTICAST_LIST_SIZE 8
37 #define DRIVER_VENDOR_DESCRIPTION "Novell Eagle 2000 Adapter."
38 #define DRIVER_VENDOR_DRIVER_VERSION 0x0100 /* 1.0 */
40 #define DRIVER_FRAME_SIZE 1514 /* Size of an ethernet frame */
41 #define DRIVER_HEADER_SIZE 14 /* Size of an ethernet header */
42 #define DRIVER_LENGTH_OF_ADDRESS 6 /* Size of an ethernet address */
44 /* Maximum lookahead buffer size */
45 #define DRIVER_MAXIMUM_LOOKAHEAD (252 - DRIVER_HEADER_SIZE)
47 /* Size of a block in a buffer ring */
48 #define DRIVER_BLOCK_SIZE 256
51 /* Default number of transmit buffers */
52 #define DRIVER_DEFAULT_TX_BUFFER_COUNT 12
53 #define BUFFERS_PER_TX_BUF 1
55 /* Interrupt Mask Register value */
56 #define DRIVER_INTERRUPT_MASK IMR_ALLE - IMR_RDCE
58 /* Maximum number of interrupts handled per call to MiniportHandleInterrupt */
59 #define INTERRUPT_LIMIT 10
61 /* Global structures */
63 typedef struct _MINIPORT_RESERVED
66 } MINIPORT_RESERVED
, *PMINIPORT_RESERVED
;
68 #define RESERVED(Packet) ((PMINIPORT_RESERVED)((Packet)->MiniportReserved))
70 typedef UCHAR DRIVER_HARDWARE_ADDRESS
[DRIVER_LENGTH_OF_ADDRESS
];
72 /* Information about an adapter */
73 typedef struct _NIC_ADAPTER
75 /* Entry on global adapter list */
78 NDIS_HANDLE MiniportAdapterHandle
;
79 /* NDIS interrupt object */
80 NDIS_MINIPORT_INTERRUPT Interrupt
;
82 /* I/O base address and interrupt number of adapter */
83 ULONG_PTR IoBaseAddress
;
85 ULONG InterruptVector
;
86 BOOLEAN InterruptShared
;
87 KINTERRUPT_MODE InterruptMode
;
89 /* Mapped address of the I/O base port */
92 /* TRUE if the NIC can transfer in word mode */
95 /* Base address and size of the onboard memory window */
99 /* Station Address PROM (SAPROM) */
102 /* Onboard ethernet address from the manufacturer */
103 DRIVER_HARDWARE_ADDRESS PermanentAddress
;
105 /* Ethernet address currently in use */
106 DRIVER_HARDWARE_ADDRESS StationAddress
;
108 /* Maximum number of multicast addresses this adapter supports */
109 ULONG MaxMulticastListSize
;
111 /* List of multicast addresses in use */
112 DRIVER_HARDWARE_ADDRESS Addresses
[DRIVER_MAX_MULTICAST_LIST_SIZE
];
114 /* Current multicast address mask */
115 UCHAR MulticastAddressMask
[8];
117 /* Masked interrupts (IMR value) */
120 /* Interrupts that have occurred */
121 UCHAR InterruptStatus
;
123 /* Current packet filter */
126 /* Lookahead buffer */
128 UCHAR Lookahead
[DRIVER_MAXIMUM_LOOKAHEAD
+ DRIVER_HEADER_SIZE
];
130 /* Receive buffer ring */
136 /* TRUE if there was a buffer overflow */
137 BOOLEAN BufferOverflow
;
139 /* TRUE if an error occurred during reception of a packet */
140 BOOLEAN ReceiveError
;
142 /* TRUE if an error occurred during transmission of a packet */
143 BOOLEAN TransmitError
;
145 /* TRUE if a transmit interrupt is pending */
146 BOOLEAN TransmitPending
;
148 /* Received packet header */
149 PACKET_HEADER PacketHeader
;
151 /* Offset in onboard RAM of received packet */
154 /* TRUE if receive indications are done and should be completed */
155 BOOLEAN DoneIndicating
;
157 /* Transmit buffers */
158 UINT TXStart
; /* Start block of transmit buffer ring */
159 UINT TXCount
; /* Number of blocks in transmit buffer ring */
160 UINT TXFree
; /* Number of free transmit buffers */
161 UINT TXNext
; /* Next buffer to use */
162 /* Length of packet. 0 means buffer is unused */
163 UINT TXSize
[DRIVER_DEFAULT_TX_BUFFER_COUNT
];
164 INT TXCurrent
; /* Current buffer beeing transmitted. -1 means none */
166 /* Head of transmit queue */
167 PNDIS_PACKET TXQueueHead
;
168 /* Tail of transmit queue */
169 PNDIS_PACKET TXQueueTail
;
172 ULONG FrameAlignmentErrors
;
176 /* Flags used for driver cleanup */
177 BOOLEAN IOPortRangeRegistered
;
178 BOOLEAN InterruptRegistered
;
179 BOOLEAN ShutdownHandlerRegistered
;
180 } NIC_ADAPTER
, *PNIC_ADAPTER
;
182 /* Global driver information */
183 typedef struct _DRIVER_INFORMATION
185 NDIS_HANDLE NdisWrapperHandle
; /* Returned from NdisInitializeWrapper */
186 NDIS_HANDLE NdisMacHandle
; /* Returned from NdisRegisterMac */
187 LIST_ENTRY AdapterListHead
; /* Adapters this driver control */
188 } DRIVER_INFORMATION
, *PDRIVER_INFORMATION
;
192 /* Global variable */
194 extern DRIVER_INFORMATION DriverInfo
;
195 extern NDIS_PHYSICAL_ADDRESS HighestAcceptableMax
;
202 PNIC_ADAPTER Adapter
);
204 NDIS_STATUS
NICInitialize(
205 PNIC_ADAPTER Adapter
);
207 NDIS_STATUS
NICSetup(
208 PNIC_ADAPTER Adapter
);
210 NDIS_STATUS
NICStart(
211 PNIC_ADAPTER Adapter
);
214 PNIC_ADAPTER Adapter
);
216 NDIS_STATUS
NICReset(
217 PNIC_ADAPTER Adapter
);
219 VOID
NICUpdateCounters(
220 PNIC_ADAPTER Adapter
);
222 VOID
NICReadDataAlign(
223 PNIC_ADAPTER Adapter
,
228 VOID
NICWriteDataAlign(
229 PNIC_ADAPTER Adapter
,
235 PNIC_ADAPTER Adapter
,
241 PNIC_ADAPTER Adapter
,
247 PNIC_ADAPTER Adapter
);
249 #endif /* __NE2000_H */