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 7

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 9

1.9 Problem Reporting/Change Request 9

2 OVERVIEW 11

2.1 The Hardware 11

2.2 The Driver 11

2.3 The Devices 11

2.4 Device Access 11

2.5 Interrupts 12

2.6 Special Features 12

2.7 Include files 13

3 DRIVER FUNCTIONS 14

3.1 Introduction 14

3.2 Driver and Device Installation Functions 14

3.3 Tool Functions 15

3.4 Support Functions 16

3.5 Device Access Functions 17

3.5.1 open 18

3.5.2 close 20

3.5.3 ioctl 21

4 DRIVER IOCTL COMMANDS 23

4.1 Access to DPRAM Data Area 23

4.2 Access to DPRAM Parameter Area 23

4.3 Position Commands 26

4.3.1 Command Arguments 26

4.3.2 Command Options 26

4.3.3 Position Reading 27

4.4 Initialization Commands 29

4.5 Correction Value Commands 29

4.6 Auxiliary Ioctl Commands 31

4.7 Driver-Related Ioctl Commands 31

4.8 Special Considerations for Correction Value Recording 32

5 ERROR MESSAGES AND RECOVERY 34

6 CODE EXAMPLES 36

6.1 Programmatic Parameter Loading 36

6.2 Move to Reference Point 36

6.3 Record Correction Values 37

7 DIAGNOSTICS 38

7.1 ikonDevShow 38

7.2 ikonPosShow 39

7.3 ikonParamShow 40

7.4 ikonDataShow 41

7.5 Trouble Shooting 42

8 INSTALLATION 43

8.1 Installation Prerequisites 43

8.1.1 Hardware Requirements 43

8.1.2 Software Requirements 43

8.2 Building the Software 43

8.3 Installation Procedure 43

8.4 Installation Verification 44

8.5 Sample Core File 44

9 REFERENCE 47

9.1 Functions 47

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