C    Summary Tables

This appendix presents tables that summarize:

• Header files

• Kernel interfaces

• ioctl commands

• Global variables

• Data structures

• Device driver interfaces

• Bus configuration interfaces

C.1    List of Header Files

Table C-1 lists the header files related to device drivers, along with short descriptions of their contents. For convenience, the header files are listed in alphabetical order. Note that device drivers should include header files that use the relative pathname instead of the explicit pathname. For example, although buf.h resides in /usr/sys/include/sys/buf.h, device drivers should include it as:

<sys/buf.h>

Not all of the header files reside in <sys>. The following include files reside in other directories:

<kern/lock.h>
<machine/cpu.h>
<io/common/devdriver.h>

Chapter 1 of Writing Device Drivers: Reference provides reference page descriptions of the header files listed in Table C-1.

Table C-1: Summary Descriptions of Header Files

C.2    List of Kernel Support Interfaces

Chapter 2 of Writing Device Drivers: Reference provides reference page descriptions of the kernel interfaces listed in Table C-2.

Note

Device drivers use the following header files most frequently:

#include <sys/types.h>
#include <sys/errno.h>
#include <io/common/devdriver.h>
#include <sys/uio.h>
#include <machine/cpu.h>
#include <sys/conf.h>
#include <sys/sysconfig.h>

Table C-2: Summary Descriptions of Kernel Support Interfaces

C.3    ioctl Commands

When defining ioctl commands that your driver supports, use a set of macros defined in /usr/sys/include/sys/ioctl.h to construct these definitions. These macros instruct the kernel on how much data, if any, is transferred between the application program making the ioctl system call and the device driver. Table C-3 describes the macros defined in /usr/sys/include/sys/ioctl.h as well as some ioctl commands defined in /usr/sys/include/sys/ioctl_compat.h. Chapter 2 of Writing Device Drivers: Reference provides reference (man) page descriptions of the ioctls listed in the table.

Table C-3: Summary Descriptions of ioctl Commands

C.4    List of Global Variables

Table C-4 summarizes the global variables that device drivers use. Chapter 2 of Writing Device Drivers: Reference provides reference page descriptions of the global variables listed in Table C-4.

Table C-4: Summary Descriptions of Global Variables

C.5    List of Data Structures

Table C-5 summarizes the structures that device drivers use. Chapter 3 of Writing Device Drivers: Reference provides reference page descriptions of the structures listed in Table C-5.

Table C-5: Summary Descriptions of Data Structures

C.6    List of Device Driver Interfaces

Table C-6 summarizes the interfaces that device drivers use. Chapter 4 of Writing Device Drivers: Reference provides reference page descriptions of the driver interfaces listed in Table C-6. The table has the following columns:

• Interface

  This column lists the driver interface name.

• Entry point

  This column lists the structure (or file) where the driver writer defines the entry point for the device driver interface.

• Character

  A Yes appears in this column if the interface is applicable to a character device. Otherwise, N/A (not applicable) appears.

• Block

  A Yes appears in this column if the interface is applicable to a block device. Otherwise, N/A (not applicable) appears.

Table C-6: Summary of Block and Character Device Driver Interfaces

C.7    List of Bus Configuration Interfaces

Table C-7 summarizes the bus configuration interfaces related to device drivers. Chapter 4 of Writing Device Drivers: Reference provides reference page descriptions of the bus configuration interfaces listed in Table C-7.

Table C-7: Summary Descriptions of Bus Configuration Interfaces