ChorusOS 4.0 Device Driver Framework Guide

Preface

The ChorusOS 4.0 Device Driver Framework Guide explains the set of tools provided within the ChorusOS operating system to build device and bus drivers, and how to use them. It provides an overview of the device and bus driver architecture within the ChorusOS operating system environment, and explains how the Driver Framework can be used to build highly portable, platform-independent drivers, as well as highly tunable, processor-family specific drivers using the same software paradigm. It also contains a summary of the APIs that make up the Driver Framework, although details of the API calls are discussed in the man pages.

Who Should Use This Guide

This book is designed to be used by developers already familiar with building bus and device drivers. For this reason, there is no general description of the tasks involved in building bus or device drivers. It is recommended that the reader consult books and/or websites dealing specifically with the architecture of the different device, bus, and processor architectures for this kind of information.

Before You Read This Guide

Before starting to build drivers using the ChorusOS operating system, read the ChorusOS 4.0 Introduction. The introduction provides an overview of the features and components of the ChorusOS operating system and explains how to create an application that runs on the ChorusOS operating system.

How This Guide is Organized

This book is organized into the following sections.

Chapter 1, Introduction to the ChorusOS Driver Framework provides an introduction to the toolset, gives an overview of hardware representation in the ChorusOS operating system, and outlines some of the benefits of using the Driver Framework.

Chapter 2, Driver Kernel Interface Overview outlines tasks and services common to device and bus driver production within the Driver Framework Device Kernel Interface API.

Chapter 3, Writing Device Drivers provides a step-by-step overview of writing device drivers in the Driver Framework, using a working driver as an example.

Chapter 4, Writing Bus Drivers provides a step-by-step overview of writing bus drivers in the Driver Framework, using a working driver as an example.

Appendix A, Further Information provides pointers to detailed information.

Ordering Sun Documents

Fatbrain.com, an Internet professional bookstore, stocks select product documentation from Sun Microsystems, Inc.

For a list of documents and how to order them, visit the Sun Documentation Center on Fatbrain.com at http://www1.fatbrain.com/documentation/sun.

Accessing Sun Documentation Online

The docs.sun.com^SM Web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. The URL is http://www.oracle.com/technetwork/indexes/documentation/index.html.

What Typographic Conventions Mean

The following table describes the typographic changes used in this book.

Table P-1 Typographic Conventions


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. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with on-screen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	Command-line placeholder: replace with a real name or value	To delete a file, type `rm` `filename`.
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.

Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.

Table P-2 Shell Prompts


Shell	Prompt
C shell prompt	`machine_name%`
C shell superuser prompt	`machine_name#`
Bourne shell and Korn shell prompt	`$`
Bourne shell and Korn shell superuser prompt	`#`