PATH ADC Home > Documentation > Hardware > Device Managers and Drivers > PCI Card Services > Designing PCI Cards and Drivers for Power Macintosh Computers

  

---

Figures, Tables, and Listings

Preface About This Book

• Contents of This Book
• PCI Bus Overview
• System Startup by Open Firmware
• Native PowerPC Drivers
• Appendixes
• Supplementary Documents
• Apple Publications
• Other Publications
• Conventions and Abbreviations
• Typographical Conventions
• Notes
• Abbreviations

Part 1 The PCI Bus

Chapter 1 PCI Bus Overview

• Benefits of PCI
• PCI and NuBus
• The Macintosh Implementation of PCI
• Power Macintosh PCI System Architecture
• PCI Bus Characteristics
• PCI Topology
• PCI Host Bridge Operation
• I/O Space
• Configuration Space
• Interrupt Acknowledge Cycles
• Special Cycles
• Maximizing PCI Bus Performance
• PowerPC Processor and PCI Commands
• Bursting from PowerPC to PCI
• Bursting from PCI to PowerPC
• Mac OS & Services That Maximize PCI Throughput
• PCI Transaction Error Responses
• PCI Card Characteristics
• PCI Video and Display Card Characteristics
• Hard Decoding Device Address Space
• Nonvolatile RAM

Chapter 2 Data Formats and Memory Usage

• Address Allocations
• PCI Bus Cycles
• Addressing Modes
• Addressing Mode Conversion
• Addressing Mode Determination
• Frame Buffers
• Pixel Storage
• Frame Buffer Apertures

Part 2 The Open Firmware Process

Chapter 3 Introduction to the NewWorld Architecture

• The Macintosh ROM and The NewWorld Architecture
• Differences Introduced by the NewWorld Architecture
• Boot Devices
• RAM
• Hardware Addresses
• Macintosh Name Registry
• The gestaltMachineType Value
• Interrupt Handling
• ROM-in-RAM
• Runtime Abstraction Services (RTAS)
• NVRAM and PRAM
• USB
• ADB
• Floppy Drives
• Video Drivers
• NewWorld Components
• NewWorld Boot Process
• New Name Registry Functionality
• Modifying Open Firmware Config Variables From the Mac OS
• Communication Between Mac OS and Open Firmware Drivers

Chapter 4 Startup and System Configuration

• Peripheral Devices and Open Firmware
• The Open Firmware Startup Process
• Startup Firmware
• Device Drivers
• PowerPC Addressing and Alignment
• Device Configuration
• Open Firmware FCode Options
• Full Open Firmware Support
• Support for Mac OS and Open Firmware
• Minimum Open Firmware Support
• No Open Firmware Support
• Open Firmware Driver Support
• Startup Sequence
• Initializing the Hardware
• Running Open Firmware
• Starting the Operating System
• Startup Sequence in the NewWorld Architecture
• What Is Different
• Interrupt Handling
• RAM Footprint
• Run-Time Abstraction Services (RTAS)
• NVRAM
• Startup Disk Control Panel
• PCI Bus Configuration
• Configuration Tasks
• Configuration Registers
• Register Actions
• PCI-To-PCI Bridges
• Configuration Header
• Register Settings

Chapter 5 PCI Open Firmware Drivers

• General Requirements
• Driver Interfaces
• Open Firmware Driver Properties
• Open Firmware User Interface
• Invoking the User Interface Via Remote Connection
• Invoking the User Interface On the Current Machine
• User Interface Environment
• Open Firmware Forth Language Symbols
• Defining Forth Words
• Forth Commands (Words)
• Open Firmware User Interface Commands and Examples
• Open Firmware Forth Usage Examples
• Terminal Emulation in Graphics Drivers
• Color Table Initialization
• Display Device Standard Properties
• Display Device Standard Methods
• Sample FCode Drivers

Part 3 Native Device Drivers

Chapter 6 Native Driver Overview

• Macintosh System Evolution
• Terminology
• Concepts
• Separation of Application and Driver Services
• Common Packaging of Loadable Software
• The Name Registry
• Families of Devices
• ROM-Based and Disk-Based Drivers
• Noninterrupt and Interrupt-Level Execution
• Symmetric Multiprocessing
• Generic and Family Drivers
• Driver Descriptions
• Generic Driver Framework
• Device Manager
• Driver Package
• Driver Services Library
• Converting Previous Mac OS Drivers
• Restricted Access to Services
• Error Returns
• Ensuring Future Compatibility
• Copying Data
• Power Management
• Summary
• Use the System Programming Interfaces
• Use the Name Registry

Chapter 7 Finding, Initializing, and Replacing Drivers

• Device Properties
• PCI Boot Sequence
• Matching Drivers With Devices
• Driver Initialization and Resource Verification
• Opening Devices
• Driver Replacement
• Driver Migration
• Driver Services That Have No Replacement
• Device Manager
• Exception Manager
• Gestalt Manager
• Mixed Mode Manager
• Notification Manager
• Power Manager
• Resource Manager
• Segment Loader
• Shutdown Manager
• Slot Manager
• Vertical Retrace Manager
• Native Driver Services
• Registry Services
• Operating-System Services
• Timing Services
• Memory Management Services
• Hardware Interrupt Mechanisms
• Secondary Interrupt Services
• Device Configuration

Chapter 8 Writing Native Drivers

• Native Driver Framework
• Native Driver CFM Container Format
• Native Driver Data Exports
• Generic Native Driver Code Exports
• Native Driver Imports
• Drivers for Multiple Cards
• The Device Manager and Generic Drivers
• Native Driver Differences
• Native Driver Limitations
• Concurrent Generic Drivers
• Completing an I/O Request
• Concurrent I/O Request Flow
• Driver Execution Contexts
• Code Execution in General
• Driver Execution
• Writing a Generic Device Driver
• Native Driver Package
• Driver Description Structure
• Driver Type Structure
• Driver Run-Time Structure
• Driver Services Structure
• Driver Services Information Structure
• DoDriverIO Entry Point
• DoDriverIO Parameter Data Structures
• Sample Handler Framework
• Getting Command Information
• Responding to Device Manager Requests
• Initialization and Finalization Routines
• Open and Close Routines
• Read and Write Routines
• Control and Status Routines
• KillIO Routine
• Replace and Superseded Routines
• Handling Asynchronous I/O
• Installing a Device Driver
• Driver Gestalt
• Supporting and Testing Driver Gestalt
• Implementing Driver Gestalt
• DCE Flags
• Using DriverGestalt and DriverConfigure
• DriverGestalt Selectors
• Using the 'boot' Selector
• Other Control and Status Requests
• Startup Drive Control Request
• Disk Partition Control and Status Requests and File Exchange
• Low Power Mode Support Calls
• Device-Specific Status Calls
• Implementing Private Control and Status Calls
• Private csCode Selection
• Synchronous Does Not Equal System Task Time
• Private Calls and Virtual Memory

Chapter 9 Driver Loader Library

• Loading and Unloading
• Installation
• Load and Install Option
• Match, Load, and Install
• Driver Removal
• Getting Driver Information
• Searching for Drivers

Chapter 10 Name Registry

• Concepts
• The Name Tree
• Name Properties
• How the Registry Is Built
• Name Registry Overview
• Scope
• Limitations
• Terminology
• Registry Topology
• The Device Tree
• Real and Virtual Devices
• Using the Name Registry
• Determining If the Name Registry Exists
• PCI Bus Identification
• Name Entry Management
• Name Entry Identifiers
• Pathnames
• Finding Name Registry Components
• Using Iterate Routines
• Using Search Routines
• Data Structures and Constants
• ID Management
• Name Creation and Deletion
• Name Iteration and Searching
• Name Lookup
• Pathname Parsing
• Property Management
• Creation and Deletion
• Property Iteration
• Property Retrieval and Assignment
• Standard Properties
• Modifier Management
• Data Structures and Constants
• Modifier-Based Searching
• Name Modifier Retrieval and Assignment
• Property Modifier Retrieval and Assignment
• Macintosh System Gestalt
• Code Samples
• Adding a Device Entry
• Finding a Device Entry
• Removing a Device Entry
• Listing Devices

Chapter 11 Driver Services Library

• Device Driver Execution Contexts
• Miscellaneous Types
• Memory Management Services
• Addressing
• I/O Operations and Memory
• Memory Management Types
• Memory Services Used During I/O Operations
• Preparing Memory for I/O
• PrepareMemoryForIO Data Structures
• IOPreparationTable Options
• Using PrepareMemoryForIO
• Logical and Physical Memory Preparation
• Mapping Tables
• Scatter-Gather Client Buffers
• Multiple Transfers
• Reducing Memory Usage
• Reducing Execution Overhead
• DMA Alignment Requirements
• Partial Preparation
• Finishing I/O Transactions
• Cache Operations
• Getting Cache Information
• Setting Cache Modes
• Synchronizing I/O
• Flushing the Processor Cache
• Memory Allocation and Deallocation
• Memory Copying Routines
• Interrupt Management
• Definitions
• Interrupt Model
• Hardware and Secondary Interrupt Level
• Interrupt Source Tree Composition
• Interrupt Registration
• Interrupt Dispatching
• Using kIsrIsComplete
• Using kIsrIsNotComplete
• Interrupt Priority
• Interrupt Source Tree Construction
• Interrupts and the Name Registry
• Extending the Interrupt Source Tree
• Automatic IST Extension
• Automatic IST Extension Operation
• Explicit IST Extension
• Basic Data Types
• Control Routines
• Control Routine Installation and Examination
• Interrupt Set Creation and Options
• Software Interrupts
• Secondary Interrupt Handlers
• Queuing Secondary Interrupt Handlers
• Calling Secondary Interrupt Handlers
• Interrupt Code Example
• Timing Services
• Time Base
• Measuring Elapsed Time
• Basic Time Types
• Obtaining the Time
• Time Conversion Routines
• Interrupt Timers
• Setting Interrupt Timers
• Canceling Interrupt Timers
• Atomic Memory Operations
• Byte Operations
• Bit Operations
• Queue Operations
• String Operations
• Debugging Support
• Service Limitations

Chapter 12 Expansion Bus Manager

• Expansion ROM Contents
• Nonvolatile RAM
• Typical NVRAM Structure
• Operating-System Partition
• Apple-Reserved Partitions
• Open Firmware Partition
• Using NVRAM to Store Name Registry Properties
• PCI Nonmemory Space Cycle Generation
• Fast I/O Space Cycle Generation
• Slow I/O Space Cycle Generation
• Configuration Space Cycle Generation
• Interrupt Acknowledge Cycle Generation
• Special Cycle Generation
• Byte Swapping Routines
• Card Power Controls
• Guidelines
• Sample Code

Chapter 13 Graphics Drivers

• Graphics Driver Description
• Graphics Driver Routines
• Control Calls
• Gamma Table Implementation
• Correction Data
• Gamma Table Errors
• Status Calls
• Reporting the Frame Buffer Controller's Capabilities
• Reporting the Current Sync Status
• Display Timing Modes
• Display Manager Requirements
• Responding to GetConnectionInfo
• New Field and Bit Definitions
• Reporting csConnectTaggedType and csConnectTaggedData
• Connection Information Flags
• Timing Information
• Reporting Display Resolution Values
• Implementing the GetNextResolution Call
• Implementing the GetModeConnection Call
• Implementing the GetModeTiming Call
• Programming the Hardware
• Supporting the Hardware Cursor
• Video Services Library
• Interrupt Services
• Hardware Cursor Utility
• Data Structures
• Replacing Graphics Drivers

Chapter 14 Network Drivers

• Dynamic Loading
• Finding the Driver
• Native Port Drivers
• Installing the Driver
• Driver Initialization
• Driver Loading
• Driver Operation
• Interrupt-Safe Functions
• Secondary Interrupt Services
• Timer Services
• Atomic Services
• Power Services
• CSMA/CD Driver
• Supported DLPI Primitives
• Extensions to the DLPI
• Packet Formats
• Ethernet Packets
• 802.2 Packets
• IPX Packets
• Address Formats
• Ethernet
• 802.2
• IPX
• Binding
• Ethernet
• 802.2
• IPX
• Multicasts
• Sending Packets
• Receiving Packets
• Raw Packets
• Test and XID Packets
• Fast Path Mode
• Framing and DL_INFO_REQ
• TokenRing and FDDI Drivers

Chapter 15 SCSI Drivers

• The SCSI Expert
• SIMs for Current Versions of Mac OS
• Future Compatibility
• SCSI Device Power Management

Appendixes

Appendix A Big-Endian and Little-Endian Addressing

• Endian Theory
• Big-Endian Addressing
• Little-Endian Addressing
• Scalar Accesses
• Address Invariance and Byte Swapping
• Mixed-Endian Systems
• Transmitting Addresses
• Byte-Swapping Issues
• Byte Swapping and Frame Buffers
• Address Swizzling
• PowerPC Little-Endian Support
• Byte-Reversed Load and Store Instructions
• Little-Endian Processing Mode

Appendix B Graphic Memory Formats

• RGB Pixel Formats
• 1, 2, 4, and 8 Bits Per Pixel
• 16 Bits Per Pixel
• 24 and 32 Bits Per Pixel
• YUV Pixel Formats
• Definitions of Pixel Formats in C

Appendix C PCI Header Files

Appendix D Abbreviations

Glossary