Compaq Tru64 UNIX Manuale utente

Tru64 UNIX

Writing Network Device Drivers

Part Number: AA-RNG2A-TE

December 2000

Product Version: Device Driver Kit Version 2.0

Operating System and Version: Tru64 UNIX Version 5.0A or higher

This manual contains information that systems engineers need to write

network device drivers that operate on any bus.

Compaq Computer Corporation

Houston, Texas

Compaq and the Compaq logo Registered in U.S. Patent and Trademark Office. Tru64 is a trademark of

Compaq Information Technologies Group, L.P. in the United States and other countries.

UNIX and X/Open are trademarks of The Open Group in the United States and other countries. All other

product names mentioned herein may be trademarks of their respective companies.

Confidential computer software. Valid license from Compaq required for possession, use, or copying.

Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software

Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under

vendor’s standard commercial license.

Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information

in this document is provided “as is” without warranty of any kind and is subject to change without

notice. The warranties for Compaq products are set forth in the express limited warranty statements

accompanying such products. Nothing herein should be construed as constituting an additional warranty.

Contents

About This Manual

1 Network Device Driver Environment

1.1 Include Files Section for a Network Driver ....................... 1–3

1.2 Declarations Section for a Network Driver ....................... 1–4

1.2.1 External and Forward Declarations .......................... 1–5

1.2.2 Declaring softc and controller Data Structure Arrays ...... 1–6

1.2.3 Declaring and Initializing the driver Data Structure ...... 1–7

1.2.4 Defining Driver-Specific Macros ............................... 1–7

1.3 Configure Section for a Network Driver ........................... 1–10

1.4 Autoconfiguration Support Section for a Network Driver ...... 1–10

1.5 Initialization Section for a Network Driver ....................... 1–10

1.6 Start Section for a Network Driver ................................ 1–10

1.7 Watchdog Section for a Network Driver ........................... 1–11

1.8 Reset Section for a Network Driver ................................ 1–11

1.9 ioctl Section for a Network Driver .................................. 1–11

1.10 Interrupt Section for a Network Driver ........................... 1–11

1.11 Output Section for a Network Driver .............................. 1–11

2 Defining Device Register Offsets

2.1 Interrupt and Status Register Offset Definitions ................ 2–1

2.2 Command Port Register Offset Definitions ....................... 2–2

2.3 Window 0 Configuration Register Offset Definitions ............ 2–4

2.4 Window 3 Configuration Register Offset Definitions ............ 2–7

2.5 Window 1 Operational Register Offset Definitions .............. 2–9

2.6 Window 4 Diagnostic Register Offset Definitions ................ 2–11

2.7 EEPROM Data Structure Definition .............................. 2–13

3 Defining the softc Data Structure

3.1 Defining Common Information ..................................... 3–2

3.2 Enabling Support for Enhanced Hardware Management ...... 3–4

3.3 Defining Media State Information ................................. 3–4

3.4 Defining the Base Register .......................................... 3–6

3.5 Defining Multicast Table Information ............................. 3–6

Contents iii

3.6 Defining the Interrupt Handler ID ................................. 3–6

3.7 Defining CSR Pointer Information ................................. 3–6

3.8 Defining FIFO Maintenance Information ......................... 3–7

3.9 Defining Bus-Specific Information ................................. 3–7

3.10 Defining the Broadcast Flag ........................................ 3–8

3.11 Defining the Debug Flag ............................................. 3–8

3.12 Defining Interrupt and Timeout Statistics ....................... 3–8

3.13 Defining Autosense Kernel Thread Context Information ...... 3–9

3.14 Defining the Polling Context Flag .................................. 3–9

3.15 Defining a Copy of the w3_eeprom Data Structure .............. 3–10

3.16 Declaring the Simple Lock Data Structure ....................... 3–10

4 Implementing the Configure Section

4.1 Declaring Configure-Related Variables and the

cfg_subsys_attr_t Data Structure .................................. 4–1

4.2 Setting Up the el_configure Routine ............................... 4–3

5 Implementing the Autoconfiguration Support Section (probe)

5.1 Implementing the el_probe Routine ............................... 5–1

5.1.1 Setting Up the el_probe Routine ............................... 5–2

5.1.2 Checking the Maximum Number of Devices That the

Driver Supports .................................................. 5–4

5.1.3 Performing Bus-Specific Tasks ................................. 5–4

5.1.4 Allocating Memory for the softc Data Structure ............ 5–6

5.1.5 Allocating the ether_driver Data Structure .................. 5–7

5.1.6 Initializing the Enhanced Hardware Management Data

Structure .......................................................... 5–8

5.1.7 Computing the CSR Addresses ................................ 5–8

5.1.8 Setting Bus-Specific Data Structure Members .............. 5–8

5.1.9 Handling First-Time Probe Operations ....................... 5–10

5.1.10 Handling Subsequent Probe Operations ..................... 5–12

5.1.11 Registering the Interrupt Handler ............................ 5–14

5.1.12 Saving the controller and softc Data Structure Pointers .. 5–16

5.1.13 Trying to Allocate Another controller Data Structure ...... 5–16

5.1.14 Registering the shutdown Routine ............................ 5–17

5.2 Implementing the el_shutdown Routine .......................... 5–17

5.3 Implementing the el_autosense_thread Routine ................. 5–17

5.3.1 Setting Up the el_autosense_thread Routine ................ 5–19

5.3.2 Blocking Until Awakened ....................................... 5–19

5.3.3 Testing for the Termination Flag .............................. 5–20

5.3.4 Starting Up Statistics ........................................... 5–20

iv Contents

5.3.5 Entering the Packet Transmit Loop ........................... 5–20

5.3.6 Saving Counters Prior to the Transmit Operation .......... 5–21

5.3.7 Allocating Memory for a Test Packet .......................... 5–21

5.3.8 Using the Default from the ROM .............................. 5–21

5.3.9 Setting the Media in the Hardware ........................... 5–22

5.3.10 Building the Test Packet ........................................ 5–22

5.3.11 Transmitting the Test Packet .................................. 5–22

5.3.12 Setting a Timer for the Current Kernel Thread ............. 5–23

5.3.13 Testing for Loss of Carrier ...................................... 5–23

5.3.14 Determining Whether Packets Were Transmitted

Successfully ....................................................... 5–24

5.3.15 Printing Debug Information .................................... 5–24

5.3.16 Setting Up New Media .......................................... 5–24

5.3.17 Establishing the Media .......................................... 5–25

6 Implementing the Autoconfiguration Support Section (attach)

6.1 Setting Up the el_attach Routine .................................. 6–1

6.2 Initializing the Media Address and Media Header Lengths ... 6–2

6.3 Setting Up the Media ................................................ 6–3

6.4 Initializing Simple Lock Information .............................. 6–5

6.5 Printing a Success Message ......................................... 6–6

6.6 Specifying the Network Driver Interfaces ........................ 6–6

6.7 Setting the Baud Rate ............................................... 6–8

6.8 Attaching to the Packet Filter and the Network Layer ......... 6–8

6.9 Setting Network Attributes and Registering the Adapter ...... 6–9

6.10 Handling the Reinsert Operation .................................. 6–9

6.11 Enabling the Interrupt Handler .................................... 6–10

6.12 Starting the Polling Process ......................................... 6–10

7 Implementing the unattach Routine

7.1 Setting Up the el_unattach Routine ............................... 7–1

7.2 Verifying That the Interface Has Shut Down .................... 7–2

7.3 Obtaining the Simple Lock and Shutting Down the Device .... 7–2

7.4 Disabling the Interrupt Handler ................................... 7–3

7.5 Terminating the Autosense Kernel Thread ....................... 7–3

7.6 Unregistering the PCMCIA Event Callback Routine ........... 7–4

7.7 Stopping the Polling Process ........................................ 7–4

7.8 Unregistering the Shutdown Routine ............................. 7–4

7.9 Terminating the Simple Lock ....................................... 7–4

Contents v

7.10 Unregistering the Card from the Hardware Management

Database ............................................................... 7–5

7.11 Freeing Resources .................................................... 7–5

8 Implementing the Initialization Section

8.1 Implementing the el_init Routine .................................. 8–1

8.1.1 Setting Up the el_init Routine ................................. 8–1

8.1.2 Determining Whether the PCMCIA Card Is Present ....... 8–2

8.1.3 Setting the IPL and Obtaining the Simple Lock ............ 8–2

8.1.4 Calling the el_init_locked Routine ............................ 8–3

8.1.5 Releasing the Simple Lock and Resetting the IPL .......... 8–3

8.1.6 Returning the Status from the el_init_locked Routine ..... 8–3

8.2 Implementing the el_init_locked Routine ......................... 8–3

8.2.1 Resetting the Transmitter and Receiver ...................... 8–4

8.2.2 Clearing Interrupts .............................................. 8–4

8.2.3 Starting the Device .............................................. 8–5

8.2.4 Ensuring That the 10Base2 Transceiver Is Off .............. 8–5

8.2.5 Setting the LAN Media .......................................... 8–6

8.2.6 Setting a LAN Attribute ........................................ 8–7

8.2.7 Selecting Memory Mapping .................................... 8–7

8.2.8 Resetting the Transmitter and Receiver Again .............. 8–7

8.2.9 Setting the LAN Address ....................................... 8–8

8.2.10 Processing Special Flags ........................................ 8–8

8.2.11 Setting the Debug Flag .......................................... 8–9

8.2.12 Enabling TX and RX ............................................. 8–9

8.2.13 Enabling Interrupts ............................................. 8–10

8.2.14 Setting the Operational Window .............................. 8–10

8.2.15 Marking the Device as Running ............................... 8–10

8.2.16 Starting the Autosense Kernel Thread ....................... 8–11

8.2.17 Starting the Transmit of Pending Packets ................... 8–11

9 Implementing the Start Section

9.1 Implementing the el_start Routine ................................ 9–1

9.1.1 Setting the IPL and Obtaining the Simple Lock ............ 9–1

9.1.2 Calling the el_start_locked Routine ........................... 9–2

9.1.3 Releasing the Simple Lock and Resetting the IPL .......... 9–2

9.2 Implementing the el_start_locked Routine ....................... 9–3

9.2.1 Discarding All Transmits After the User Removes the

PCMCIA Card .................................................... 9–3

9.2.2 Removing Packets from the Pending Queue and Preparing

the Transmit Buffer .............................................. 9–4

vi Contents

9.2.3 Transmitting the Buffer ......................................... 9–6

9.2.4 Accounting for Outgoing Bytes ................................. 9–7

9.2.5 Updating Counters, Freeing the Transmit Buffer, and

Marking the Output Process as Active ....................... 9–7

9.2.6 Indicating When to Start the Watchdog Routine ............ 9–8

10 Implementing a Watchdog Section

10.1 Setting the IPL and Obtaining the Simple Lock ................. 10–1

10.2 Incrementing the Transmit Timeout Counter and Resetting

the Unit ................................................................ 10–2

10.3 Releasing the Simple Lock and Resetting the IPL ............... 10–2

11 Implementing the Reset Section

11.1 Implementing the el_reset Routine ................................ 11–1

11.2 Implementing the el_reset_locked Routine ....................... 11–2

12 Implementing the ioctl Section

12.1 Setting Up the el_ioctl Routine ..................................... 12–2

12.2 Determining Whether the User Has Removed the PCMCIA

Card from the Slot .................................................... 12–3

12.3 Setting the IPL and Obtaining the Simple Lock ................. 12–3

12.4 Enabling Loopback Mode (SIOCENABLBACK ioctl

Command) ............................................................. 12–4

12.5 Disabling Loopback Mode (SIOCDISABLBACK ioctl

Command) ............................................................. 12–4

12.6 Reading Current and Default MAC Addresses

(SIOCRPHYSADDR ioctl Command) .............................. 12–5

12.7 Setting the Local MAC Address (SIOCSPHYSADDR ioctl

Command) ............................................................. 12–5

12.8 Adding the Device to a Multicast Group (SIOCADDMULTI

ioctl Command) ....................................................... 12–6

12.9 Deleting the Device from a Multicast Group (SIOCDELMULTI

ioctl Command) ....................................................... 12–7

12.10 Accessing Network Counters (SIOCRDCTRS and

SIOCRDZCTRS ioctl Commands) .................................. 12–8

12.11 Bringing Up the Device (SIOCSIFADDR ioctl Command) ..... 12–9

12.12 Using Currently Set Flags (SIOCSIFFLAGS ioctl Command) 12–10

12.13 Setting the IP MTU (SIOCSIPMTU ioctl Command) ........... 12–10

12.14 Setting the Media Speed (SIOCSMACSPEED ioctl

Command) ............................................................. 12–10

Contents vii

12.15 Resetting the Device (SIOCIFRESET ioctl Command) ......... 12–11

12.16 Setting Device Characteristics (SIOCIFSETCHAR ioctl

Command) ............................................................. 12–11

12.17 Releasing the Simple Lock and Resetting the IPL ............... 12–13

13 Implementing the Interrupt Section

13.1 Implementing the el_intr Routine .................................. 13–1

13.1.1 Setting the IPL and Obtaining the Simple Lock ............ 13–2

13.1.2 Rearming the Next Timeout .................................... 13–2

13.1.3 Reading the Interrupt Status .................................. 13–3

13.1.4 Processing Completed Receive and Transmit Operations . 13–3

13.1.5 Acknowledging the Interrupt .................................. 13–4

13.1.6 Transmitting Pending Frames ................................. 13–4

13.1.7 Releasing the Simple Lock and Resetting the IPL .......... 13–4

13.1.8 Indicating That the Interrupt Was Serviced ................. 13–5

13.2 Implementing the el_rint Routine .................................. 13–5

13.2.1 Counting the Receive Interrupt and Reading the Receive

Status .............................................................. 13–5

13.2.2 Pulling the Packets from the FIFO Buffer ................... 13–6

13.2.3 Examining the First Part of the Packet ...................... 13–7

13.2.4 Copying the Received Packet into the mbuf ................. 13–8

13.2.5 Discarding a Packet ............................................. 13–9

13.3 Implementing the el_tint Routine .................................. 13–10

13.3.1 Counting the Transmit Interrupt .............................. 13–10

13.3.2 Reading the Transmit Status and Counting All Significant

Events .............................................................. 13–10

13.3.3 Managing Excessive Data Collisions .......................... 13–11

13.3.4 Writing to the Status Register to Obtain the Next Value .. 13–11

13.3.5 Queuing Other Transmits ...................................... 13–12

13.4 Implementing the el_error Routine ................................ 13–12

14 Network Device Driver Configuration

Index

Figures

1–1Sections of a Network Device Driver ............................... 1–2

2–1Window 0 Configuration Registers ................................. 2–5

2–2Window 3 Configuration Registers ................................. 2–8

2–3Window 1 Operational Registers ................................... 2–9

viii Contents

2–4Window 4 Diagnostic Registers ..................................... 2–11

3–1Typical softc Data Structure ........................................ 3–2

3–2Mapping Alternate Names .......................................... 3–4

Tables

1–1Driver-Specific Macros ............................................... 1–9

12–1Network ioctl Commands ............................................ 12–1

12–2Network Interface Counter Types .................................. 12–9

Contents ix

Indice

Altri manuali Compaq Software

Compaq

Compaq Proliant 800 Manuale utente

Compaq

Compaq dc7800 - Convertible Minitower PC Manuale utente

Compaq

Compaq Aero 8000 Manuale

Compaq

Compaq TP Desktop Connector AA-PVNFG-TE Manuale utente

Compaq

Compaq AAR-88LB-TE Manuale utente

Compaq

Compaq 230039-001 - StorageWorks NAS Executor E7000 Model 904... Supplemento

Compaq

Compaq BL10e - HP ProLiant - 512 MB RAM Manuale tecnico

Compaq

Compaq 234664-002 - ProLiant - ML330T02 Manuale utente

Compaq

Compaq 166207-B21 - Smart Array 5302/32 RAID... Manuale utente

Compaq

Compaq dc5800 - Microtower PC Manuale utente

Compaq

Compaq 239158-999 - Mini Tower - Power Supply 250... Manuale di istruzioni

Compaq

Compaq Aero 8000 Manuale

Compaq

Compaq COBOL AAQ2G1FTK Manuale utente

Compaq

Compaq BL10e - HP ProLiant - 512 MB RAM Manuale tecnico

Compaq

Compaq BL10e - HP ProLiant - 512 MB RAM Manuale tecnico

Compaq

Compaq Compaq TCP/IP Services for OpenVMS Manuale del proprietario

Compaq

Compaq dc5750 - Microtower PC Manuale utente

Compaq

Compaq BL10e - HP ProLiant - 512 MB RAM Manuale tecnico

Compaq

Compaq BL10e - HP ProLiant - 512 MB RAM Manuale tecnico

Compaq

Compaq t5300 - Thin Client Manuale di servizio

Compaq

Compaq SANworksNetwork Manuale utente

Compaq

Compaq Presario SR1400 - Desktop PC Manuale utente

Compaq

Compaq dc7700 - Convertible Minitower PC Manuale per l'uso e la cura

Compaq

Compaq DEC Text Processing Utility (DECTPU) Guide Manuale utente

Manuali Software popolari di altre marche

COMPRO

COMPRO COMPROFM Manuale utente

Muratec

Muratec OFFICEBRIDGE ONLINE Manuale utente

Oracle

Oracle Contact Center Anywhere 8.1 Manuale utente

Adobe

Adobe 65007312 - Photoshop Lightroom Manuale

Avaya

Avaya NULL One-X for RIM Blackberry Manuale utente

HP ProLiant BL420c Manuale utente

PS Audio

PS Audio PowerPlay Manuale del proprietario

Brady

Brady LOCKOUT PRO 3.0 Manuale di servizio

Avaya

Avaya Interaction Center Manuale utente

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Manuale

Novell

Novell GROUPWISE 8 - INTERNET AGENT Manuale utente

Oracle

Oracle Application 9i Manuale utente

Acer

Acer RDM Manuale utente

Canon

Canon Vixia HF21 Manuale utente

Canon

Canon ZR950 Manuale utente

Samsung

Samsung Auto Backup Manuale utente

Polycom

Polycom Vortex EF2201 Istruzioni per l'installazione e il funzionamento

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Manuale utente