Preface

The ChorusOS 5.0 Board Support Package Developer's Guide contains a description of the hardware abstraction layer of the ChorusOS system and the ChorusOS Device Driver Framework. It describes the source file structure that allows you to port the ChorusOS operating system to a new hardware platform and add support for new devices.

This book is part of the ChorusOS Target Platform Collection.

Who Should Use This Book

The Board Support Package Developer's Guide is intended for users of the ChorusOS operating system who will be involved in one of two target specific tasks: porting the ChorusOS operating system to a new target platform, or developing new device or bus drivers.

Before You Read This Book

This guide relies on the fact that you are familiar with the concepts of device drivers and porting. You should also read the following if you are not familiar with the concepts of building a booting and ChorusOS system image.

• ChorusOS Features and Architecture Overview This book provides a general overview of the architecture of the ChorusOS operating system.

• ChorusOS Installation Guide This book guides you through the initial installation of Sun Embedded Workshop on the host, and describes how to build and boot a standard system image on a target board.

How This Book Is Organized

The ChorusOS Board Support Package Developer's Guide is organized as follows:

Part 1 Overview

• Chapter 1: Overview of ChorusOS Operating System and its Initialization

• Chapter 2 Overview of Porting and Creating new Drivers

Part 2: Porting the ChorusOS Operating System to a New Target Board

• Chapter 3: Writing a New Board Support Package

• Chapter 4: The ChorusOS Boot Program

• Chapter 5: The ChorusOS Reboot Program

• Chapter 6: Porting the Debug Agent and Hot Swap Support

• Chapter 7: Configuring the ChorusOS System Image

Part 3: The ChorusOS Device Driver Framework

• Chapter 8: Introduction to the ChorusOS Driver Framework

• Chapter 9: Driver Kernel Interface Overview

• Chatper 10: Writing a New Device Driver

• Chapter 11: Writing a New Bus Driver

Part 4: Driver Hardening

• Chapter 12: Overview of Driver Hardening

• Chapter 13: Hardened Driver Requirements

• Chapter 14: Testing Hardened Drivers

Related Books

For more information about working with the concepts of configuring and building a ChorusOS system image:

• ChorusOS Source Delivery Guide

• ChorusOS System Administrator's Guide

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.

Typographic Conventions

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	#

Directory Conventions

The following table describes the directory conventions used in this book.

Table P-3 Directory Conventions

Directory	Description
download_dir	Directory containing the ChorusOS 5.0 download files.  Example: /home/user/downloads/ChorusOS_5.0/
extract_dir	Directory containing sufficient space to extract the delivery. This directory can be a local or an NFS mounted disk that has "write" permission.  Example: /home/user/extract/
install_dir	Directory where you install the ChorusOS product.  Example (also default): /opt/SUNWconn/SEW/5.0-processor_family where processor_family is one of the following: UltraSPARC, x86, PowerPC, MPC8xx Note that, during installation, you can choose the installation directory other than /opt/SUNWconn/SEW/. However, the 5.0-processor_family directory containing the ChorusOS directories and files is automatically created in the directory you specify.
build_dir	Directory where you configure and build the system image. This directory can be a local or an NFS mounted disk, but you must have "write" permission.  Example: /home/user/chorusos/build/
root_dir	Directory containing the ChorusOS file system.   Example: /install_dir/chorus-family/os/root
mount_dir	Directory on the host containing a file system you want to mount on a target.  Example: host:/install_dir/chorus-family/os/root
source_dir	Directory containing the source files.  Example: install_dir/chorus-family/src/

---

Note -

family is one of the following:

• usparc for UltraSPARC IIi/III

• x86 for Intel x86/Pentium

• ppc60x for the Motorola PowerPC 60x and 750 processor family and the PowerQUICC II (mpc8260) microcontroller

• mpc860 for the Motorola PowerQUICC I (mpc8xx) microcontroller.

---