Using the HDK documentation set

Using the HDK documentation set

The HDK documentation set is structured to support customers with different levels of driver development experience, with multiple ways of accessing the information that is included.

For a general introduction to device drivers and how to implement them

See ``Device driver overview''.

If you are particularly interested in understanding the UnixWare 7 DDI 8 interface, see the detailed code commentary for a sample DDI 8 driver in ``DDI: 8 sample driver''.

For summary information about a particular feature with cross-references to more detailed information

See HDK Technical Reference. HDK Technical Reference is a set of free-standing articles on various topics of interest to driver developers. The left frame lists the topics alphabetically, while the right frame groups the articals topically. Each article gives summary information about the subject with hotlinks to other places in the documentation set that provides more details.

You can also use the SEARCH button under the right frame to search for information about a specific subject. Note that the SEARCH capability is not supported when viewing the documentation directly from the HDK CD-ROM.

For information about the new driver features for UnixWare 7

See ``New driver features in DDI 8 and UnixWare 7''.

For a checklist of practices that improve driver quality on UnixWare 7 and SCO OpenServer

``Guidelines for all kernel drivers''

For information about porting drivers to UnixWare 7

See ``Porting drivers to DDI 8''.

For information about testing and debugging drivers on UnixWare 7 and SCO OpenServer systems

See ``Driver testing and debugging''

For technical articles about developing drivers on UnixWare 7 and SCO OpenServer systems

See .

For guide information about specific interfaces and device types

Click on the interface link in the left frame of the main UnixWare 7 or SCO OpenServer HDK homepage:

DDI (UnixWare 7 kernel driver interface): Developing DDI kernel drivers
ODDI (SCO OpenServer kernel driver interface): Developing SCO OpenServer kernel drivers
MDI (UnixWare 7 and SCO OpenServer network driver interface): Developing MDI network adapter drivers
SDI (UnixWare 7 mass storage driver interface): Developing SDI storage drivers
OSDI (SCO OpenServer mass storage driver interface): Developing SCO OpenServer SCSI drivers
STREAMS (UnixWare 7 and SCO OpenServer STREAMS interface): Developing STREAMS modules and drivers

For detailed information about entry point routines, kernel functions, and kernel structures

See the appropriate manual pages. ``HDK manual page sections'' provides a full listing of all HDK manual page sections, with a grid that shows the types of information that are available for each interface.

The manual pages for each interface are listed in the right frame when you click on the topic for that interface type. When the HDK documentation is installed on your system, these manual pages can also be accessed with the man command on UnixWare 7 systems or the hdkman command on SCO OpenServer systems.

When you access the manual pages through the graphical browser or lynx, they include hotlinks to related documentation.

The entire UnixWare 7 documentation set, including the Consolidated HDK documentation, is also provided on the HDK CD-ROM as a flat file that can be read directly from the media from any frames-aware graphical browser.

For general information about using the ScoHelp browser, see Using SCOhelp.

For specific information about the HDK packages and known limitations (the information that was traditionally provided in Release Notes), See the /info directories on the HDK media or the Getting Started files that are displayed when you click on the ? icon for the documentation packages on the website.