Preface

The X Server Device Developer's Guide provides detailed information on writing device drivers that run with the OpenWindows^(TM) environment. These device drivers are DDX handlers that interface with the OpenWindows server.

Who Should Use This Book

If you are an Independent Hardware Vendor (IHV) interested in writing device drivers, you should read this book.

Before You Read This Book

This manual assumes that the reader has a programming background and familiarity with, or access to, appropriate documentation for:

• Solaris 2.6
• The X Window System; specifically the X11 sample server and the DDX (Device Dependent X) porting layer.
• C Language
• X, Xlib

How This Book Is Organized

Chapter 1, "DDX Porting Overview," provides an overview of porting features and requirements of the DDX layer.

Chapter 2, "The Loadable DDX Interface," explains how the server interfaces to a loadable DDX handler.

Chapter 3, "Screen Initialization," describes some aspects of Screen initialization common to many devices.

Chapter 4, "Cursors," discusses software and hardware cursor implementations and helps you decide which cursor layer to use for your purposes.

Chapter 5, "Multiple Plane Group Interface," provides an architectural overview and describes the feature of the multiple plane group (MPG) DDX module.

Chapter 6, "Overlay Window Interface," describes the overlay window interface (OVL) for your DDX handler.

Chapter 7, "Window ID Interface," defines the window management interface routines that are part of the MPG package.

Chapter 8, "Colormap Interface," describes all of the routines that are part of the CMAP package. It also provides several examples.

Chapter 9, "Direct Graphics Access Drawable Client Interface," describes the DGA library interface for clients.

Chapter 10, "Direct Graphics Access Drawable DDX Interface," describes the DGA library interface for DDX handlers.

Chapter 11, "Input Devices," explains how to add an extension input device to the server and how to access the extension with MIT's XInput Extension.

Chapter 12, "Direct Pixel Access DDX Interface," describes the direct pixel access (DPA) interface for DDX handlers.

Chapter 13, "Debug Server Modules," provides information about the debug server modules.

Chapter 14, "MIT Shared Memory Extension," explains how to implement the MIT Shared Memory extension.

Appendix A, "The OWconfig File," includes the default OWconfig file and explains its content.

Appendix B, "Packaging and Installation Hints," discusses packaging and installation issues pertaining to loadable modules.

Appendix C, "Virtual User Input Device Interface," explains the mechanism that sets up input devices to generate event codes and what a device driver needs to do in order to conform to the vuid interface.

Appendix D, "Dynamically Loadable Extensions," discusses requirements X extensions must meet to be dynamically loadable by the server.

Related Books

Solaris Release Information

For information on this release, see the following:

• Solaris Reviewer's Guide
• Solaris Driver Developer Kit Introduction
• Solaris Driver Developer Kit Installation Guide
• Solaris Software Developer Kit Installation Guide

OpenWindows Environment Information

To learn how to use the OpenWindows environment, see the following manuals:

• Solaris User's Guide
• Solaris Advanced User's Guide
• Writing Device Drivers

X Window System Information

The following X Window System manuals are available through SunExpress or your local bookstore. Contact your SunSoft representative for information about ordering.

• XView Reference Manual, O'Reilly & Associates
• XView Programming Manual, O'Reilly & Associates
• Xlib Reference Manual, O'Reilly & Associates
• Xlib Programming Manual, O'Reilly & Associates
• X Toolkit Intrinsics Reference Manual, O'Reilly & Associates

• The X Window System, Digital Press
• The X Window System Server, Digital Press

Sample Server Porting Information

The following manuals are available online in the /doc/Server directory of the SUNWxwddk package. The default installation directory of this package is /opt/SUNWddk/xserver. These manuals are recommended if you are new to X11 server development. The associated filename is in parentheses.

• Strategies for Porting the X v11 Sample Server (strat.ms)
• Definition of the Porting Layer for the X v11 Sample Server (ddx.tbl.ms)

Obtaining Sample Server Information

The X11 sample server and documentation are available via the World Wide Web. The URL is http://www.rdg.opengroup.org You can use the File Transfer Protocol (ftp) to download files from this system. If you need help using ftp, refer to the ftp(1) man page. To determine if your system is connected to the World Wide Web, see your system administrator.

What Typographic Changes and Symbols Mean

The following table describes the type changes and symbols used in this book.

Table P-1

Typeface or Symbol	Meaning	Example
AaBbCc123	The names of commands, files, and directories; on-screen computer output	Edit your .login file. Use ls -a to list all files. system% You have mail.
AaBbCc123	What you type, contrasted with on-screen computer output	system%su Password:
AaBbCc123	Command-line placeholder: replace with a real name or value	To delete a file, type rm filename.

Table P-1 (Continued)

Typeface or Symbol	Meaning	Example
AaBbCc123	Book titles, new words or terms, or words to be emphasized	Read Chapter 6 in User's Guide. These are called class options. You must be root to do this.
Code samples are included in boxes and may display the following:
%	UNIX C shell prompt	system%
$	UNIX Bourne and Korn shell prompt	system$
#	Superuser prompt, all shells	system#