T A B L E O F C O N T E N T S

1 INTRODUCTION 7

1.1 Purpose 7

1.2 Scope 7

1.3 Applicable Documents 8

1.4 Reference Documents 8

1.5 Abbreviations and Acronyms 8

1.6 Usage of Terms 9

1.7 Stylistic Conventions 9

1.8 Naming Conventions 10

1.9 Problem Reporting/Change Request 10

2 OVERVIEW 13

2.1 The Hardware 13

2.2 The Driver 13

2.3 The Devices 13

2.4 Device Access 13

2.5 Interrupts 14

2.6 Special Features 15

2.7 Include files 15

3 DRIVER FUNCTIONS 17

3.1 Introduction 17

3.2 Driver and Device Installation Functions 17

3.3 Tool Functions 18

3.4 Device Access Functions 18

3.4.1 open 20

3.4.2 close 22

3.4.3 ioctl 23

4 DRIVER IOCTL COMMANDS 25

4.1 Access to the User Memory 25

4.2 Access to the Register Memory 26

4.2.1 Board Control and Status 26

4.2.2 Node Identification 27

4.2.3 Interrupt Commands 27

4.3 Test Command 29

4.4 Reset Command 30

4.5 Driver-Related Commands 30

4.6 Simulation Mode 31

5 ERROR MESSAGES AND RECOVERY 33

6 CODE EXAMPLES 35

6.1 Reflective Memory Access 35

6.2 Sending and Receiving Interrupts 35

7 DIAGNOSTICS 39

7.1 rmnVersion 39

7.2 rmnDevShow 39

7.3 rmnDevDump 39

7.4 rmnMemDump 40

7.5 rmnDevDescrDump 40

7.6 rmnTestBoard 42

7.7 rmnPrintError 42

7.8 rmnPrintCommand 42

7.9 Troubleshooting 42

8 INSTALLATION 45

8.1 Installation Prerequisites 45

8.1.1 Hardware Requirements 45

8.1.2 Software Requirements 45

8.2 Building the Software 45

8.3 Installation Procedure 45

8.4 Installation Verification 46

9 REFERENCE 47

9.1 rmnClose(3) 48

9.2 rmnDevCreate(3) 49

9.3 rmnDrv(3) 51

9.4 rmnIoctl(3) 52

9.5 rmnOpen(3) 53

9.6 rmnTools(1) 54

Quadralay Corporation http://www.webworks.com Voice: (512) 719-3399 Fax: (512) 719-3606 sales@webworks.com