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

1 INTRODUCTION 9

1.1 Purpose 9

1.2 Scope 9

1.3 Reference Documents 10

1.4 Abbreviations And Acronyms 10

1.5 Stylistic Conventions 11

1.6 Naming Conventions 11

1.7 Problem Reporting/Change Request 11

PART I ·  DRIVER ARCHITECTURE

2 GENERAL DRIVER ARCHITECTURE 13

2.1 The Device Layer 14

2.2 The Command Layer 14

2.3 The User Interface Layer 14

2.4 Interrupt Handlers 15

2.5 Channel Handling 15

2.6 Multi Device Handling 16

2.7 Multi Task Handling 16

2.8 Command Handling 17

3 DRIVER FILES AND DIRECTORIES 19

3.1 Driver Directory Structure 19

3.2 Driver Header Files 20

3.2.1 Guidelines for xxx.h 20

3.2.2 Guidelines for xxxCommands.h 20

3.2.3 Guidelines for xxxErrors.h 21

3.2.4 Guidelines for xxxDevice.h 21

3.2.5 Guidelines for xxxPrivate.h 21

3.3 Driver Source Files 22

3.3.1 Guidelines for xxxDrv.c 22

3.3.2 Guidelines for xxxDevCreate.c 24

3.3.3 Guidelines for xxxOpen.c 27

3.3.4 Guidelines for xxxClose.c 28

3.3.5 Guidelines for xxxIoctl.c 29

3.4 Makefiles 30

3.5 Sample Installation Scripts 30

3.6 Module Boot Scripts for Use with lcuboot 30

3.7 Device Documentation Man-Page 31

PART II ·  USER MANUAL

4 THE LCU DRIVER COMMON MODULES - lcudrv and lculog 33

4.1 lcudrv - Driver Common Functions 33

4.2 The Device Descriptor Table 35

4.3 The Command Descriptor Table 36

4.4 lculog - Driver Common Logging Functions 37

4.5 Errors Reference 38

4.6 Functions Reference 38

5 A GRAPHICAL COMMAND INTERFACE TO DRIVERS - lcudrvTk 39

5.1 Overview 39

5.2 Starting from the Command Line 39

5.3 The Configuration File for lcudrvTk 39

5.4 The Control Panel 40

5.4.1 Buttons and Entries 40

5.4.2 The Menu Bar 41

5.5 Recording and Executing Macros 42

5.6 Where lcudrvTk gets the Menu Information from 43

5.7 Guidelines and Restrictions for Driver Header Files 43

5.7.1 lcudrvTk `s Rules for xxx.h 43

5.7.2 lcudrvTk `s Rules for xxxCommands.h 44

5.7.3 lcudrvTk `s Rules for xxxErrors.h 45

5.8 lcudrvTkUtil - The LCU Server Module for lcudrvTk 45

5.9 Known Problems 45

6 MISCELLEANOUS 47

6.1 Integration of Drivers into LCC 47

PART III ·  REFERENCE

7 REFERENCE lcudrv/lculog 51

7.1 lcudrv Errors Reference 51

7.2 Functions Reference 52

7.2.1 lcudrvCheckAccess(3) 53

7.2.2 lcudrvCheckChannel(3) 54

7.2.3 lcudrvCheckDev(3) 55

7.2.4 lcudrvClose(3) 57

7.2.5 lcudrvDevice(3) 58

7.2.6 lcudrvErrorGet(1) 59

7.2.7 lcudrvInitDCT(3) 60

7.2.8 lcudrvInitDevice(3) 61

7.2.9 lcudrvOpen(3) 62

7.2.10 lcudrvProbeAddress(1) 63

7.2.11 lcudrvTk(1) 64

7.2.12 lcudrvTkUtil(3) 67

7.2.13 lculog(3) 68

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