The FreeWPC Manual

Introduction
1 Overview
2 Installation
- 2.1 Binary Packages
- 2.2 Source Code Packages
- 2.3 Directory Layout
3 Compiling
- 3.1 Configuration
- 3.2 Building
- 3.3 Build Results
4 Software Environment
- 4.1 Multitasking
  - 4.1.1 Periodic Functions
  - 4.1.2 Task APIs
- 4.2 Real-Time Processing
- 4.3 Memory Allocation
- 4.4 Bit Variables
- 4.5 Event Handling
- 4.6 Template Drivers
  - 4.6.1 Template Syntax
  - 4.6.2 Template Usage
- 4.7 Fault Detection
- 4.8 Timers
- 4.9 Bank Switching
5 Core APIs
- 5.1 Switches
- 5.2 Lamps
- 5.3 Solenoids
- 5.4 Dot-Matrix Display (DMD)
- 5.5 Sound Board
- 5.6 General Illumination
- 5.7 Real-Time Clock
6 Effects
- 6.1 Basic Effect Principles
- 6.2 Background Effects
- 6.3 Display Effects
- 6.4 Lamp Effects
- 6.5 Sound and Music Effects
- 6.6 Lamplists
- 6.7 DMD Transitions
- 6.8 Background Refresh
7 Ball Tracking
- 7.1 Device Status
- 7.2 Global Status
- 7.3 Events
- 7.4 The Trough Device
- 7.5 Virtual Balls
8 Test Mode
- 8.1 Adjustments
- 8.2 Audits
- 8.3 Tests
9 Common Pinball Library
- 9.1 Coins and Pricing
- 9.2 Extra Balls
- 9.3 Tournament Mode
- 9.4 Ball Search
- 9.5 Knocker Driver
- 9.6 Adjustments
- 9.7 Audits
- 9.8 Scoring
- 9.9 Lamp Timers
- 9.10 Diagnostics
- 9.11 Score Rank
- 9.12 Timed Modes
- 9.13 Ball Savers
- 9.14 Ball Serve
- 9.15 Multiball Modes
- 9.16 Mute and Pause Mode
- 9.17 Status Report
10 Fonts and Graphics
- 10.1 Compression
- 10.2 Using TrueType Fonts
- 10.3 Printing Text
- 10.4 Formatting Text
- 10.5 Frame List
11 System Initialization
12 Platform APIs
13 Native Mode
- 13.1 Thread Model
- 13.2 Persistent Memory
- 13.3 Input and Output
- 13.4 GDB Debugging
- 13.5 Interrupt Tracing
- 13.6 Platform Emulation
- 13.7 Timing
- 13.8 Command Language
- 13.9 Variables
- 13.10 User Interface
- 13.11 Hardware Emulation
- 13.12 Signal Tracking
14 Debugging
- 14.1 dbprintf
- 14.2 gdb
- 14.3 exec09
- 14.4 Breakpoints
- 14.5 Switch Stress Test
Appendix A The WPC Hardware
- A.1 Overview
- A.2 CPU Board
- A.3 Power Driver Board
- A.4 Sound Board
- A.5 Fliptronic Board
- A.6 Auxiliary Driver Board
- A.7 Dot Matrix Controller Board
- A.8 Memory Map
Appendix B The Machine Definition
- B.1 Syntax
- B.2 Fixed Objects
- B.3 Variable Objects
- B.4 Directives
  - B.4.1 include
  - B.4.2 define
- B.5 Global Configuration
- B.6 Section Summary
- B.7 How genmachine works
Appendix C System Events
Appendix D Build Tools
- D.1 csum : ROM Checksum Tool
- D.2 srec2bin : S-Record Converter
- D.3 sched : Static Scheduler
- D.4 fontgen2 : TrueType Font Generator
Appendix E Dot-Matrix Performance
- E.1 Frame Rate
- E.2 Simulating Color
- E.3 6809 Instruction Set
- E.4 The Fastest Copy in Town
- E.5 Bit Alignment
- E.6 Compression Techniques
Appendix F Historical Notes
Appendix G Design Principles
- G.1 Overview
- G.2 Classes of Modules
- G.3 Device Drivers
- G.4 Shot Detection
- G.5 Game Rules
- G.6 Other Modules
Concept Index

Introduction

This is the manual for FreeWPC, a free platform for developing replacement game ROMs for Bally/Williams pinball machines based on the WPC (Williams Pinball Controller) chip. FreeWPC provides the foundation for building new ROMs with custom game rules. This document describes version 1.10-dev of the software.

FreeWPC is developed by Brian Dominy (brian@oddchange.com) and is licensed under the GNU General Public License version 2 or later. The latest version of the software can be obtained at http://www.oddchange.com/freewpc. Developers should be familiar with basic embedded systems programming concepts and the C programming language. Familiarity with 6809 assembler is recommended but not necessary. Also, knowledge of WPC pinball machines is very helpful.

The FreeWPC Manual

Table of Contents

Introduction