Contained Within
Find More Documentation
Featured Support Resources
|  Download this book in PDF
Preface
- This manual, Writing FCode 3.x Programs (802-5379), describes how to write, debug, and test FCode programs for SPARC-based systems and interface card devices. It replaces all previous manuals describing how to write FCode programs. IEEE Standard 1275-1994 is based on the Sun(TM) OpenBoot(TM) 2.x implementation. OpenBoot 3.x from Sun is compliant with IEEE Standard 1275.
- Throughout this book, the reference to FCode PROM might refer to any type of ROM device (ROM, PROM, FlashPROM, etc.).
Who Should Use This Book
- This manual is written for designers of SBus interface cards and other devices that use the FCode programming language. It is written for those designers who have some familiarity with SBus card design requirements and Forth programming. The sample code in this book is not guaranteed to be free of bugs.
- The material in this manual is for developers of FCode applications for SBus peripherals on OpenBoot 3.x. With proper programming precautions, these applications should run on OpenBoot 3.x and earlier versions. By following the IEEE 1275 standard, the same FCode application can also run on non-SPARC systems which are IEEE 1275-compliant. The FCode language is defined by IEEE Standard 1275-1994 Standard for Boot Firmware.
- This manual is written for designers who have read and understood the corresponding SBus specifications and SBus binding to IEEE Standard 1275- 1994 1.2 (or later).
How This Book Is Organized
-
-
Chapter 1, "SBus Cards and FCode", introduces the basic relationships between FCode device drivers and the hardware that they control.
-
Chapter 2, "Elements of FCode Programming", introduces the basic elements of FCode, stack notation, and programming style.
-
Chapter 3, "Testing FCode Programs", describes the process of producing FCode programs, from source files to testing working programs.
-
Chapter 4, "Packages", describes the basic units of FCode program function.
-
Chapter 5, "Properties", describes properties, which define how an FCode device driver program recognizes the hardware that it controls.
-
Chapter 6, "Block and Byte Devices" through Chapter 10, "Serial Devices" describe currently-defined device types, programming requirements, and give examples of device drivers for the various device types.
-
Chapter 11, "FCode Dictionary", describes currently-defined FCode words and their functions and use, with brief programming examples.
-
Appendix A, "FCode Reference", lists all currently-defined FCode words according to functional group, name, and byte value.
-
Appendix B, "FCode Memory Allocation", describes guidelines for memory allocation and de-allocation in FCode.
-
Appendix C, "Coding Style", contains an OpenBoot coding guideline.
Related Books
- This manual does not cover all you need to know in order to write FCode drivers for SBus cards. The following books are also useful.
- For information about SBus and OpenBoot:
-
-
IEEE Standard 1275-1994 Standard for Boot (Initialization Configuration) Firmware, Core Requirements and Practices
-
-
IEEE Standard 1275.1-1994 Standard for Boot (Initialization Configuration) Firmware: Instruction Set Architecture (ISA) Supplement for IEEE 1754
-
IEEE Standard 1275.2-1994 Standard for Boot (Initialization Configuration) Firmware: Bus Supplement for IEEE 1496 (SBus)
-
IEEE 1496-1993 Standard for Chip and Module Interconnect Bus: SBus 1-55937- 353-9
-
OpenBoot 2.x Command Reference (802-3241)
-
OpenBoot 3.x Command Reference (802-3242)
Forth and Forth Programming
- For further information about Forth and Forth programming:
-
-
Mastering Forth, Anita Anderson and Martin Tracy, Brady Communications Co., Inc., 1989
-
ANSI Forth X3J14
-
Forth: A Text and Reference, Mahlon G. Kelly and Nicholas Spies. Prentice-Hall, 1986
-
Starting Forth, Leo Brody. Forth, Inc., second edition, 1987
-
Forth: The New Model, Jack Woehr. M & T Books, 1992
- Forth Interest Group http://forth.org/fig.html
SBus/SCSI Developer's Kit
- The SBus/SCSI developer's Kit, Release III (ISBN 0-13-107202-1) consists of four manuals:
-
-
SunOS 5.3 Writing Device Drivers (ISBN 0-13-107228-5) includes a diskette of sample drivers
-
Writing FCode 2.x Programs (p/n 802-1941)
-
OpenBoot 2.x Command Reference (802-3241)
-
SBus Handbook, Susan A. Mason, Desktop Strategies (ISBN 0-13-107210-2)
- This kit is available at PTR PH Magnet Stores, or directly from Prentice Hall. For single copies, phone 515/284-6751, fax 515/284-2607 or e-mail orders@prenhall.com. For quantity orders of more than 10 books, phone 201/592- 2498, fax 201/592-2249. International customers: Simon & Schuster International, Customer Service, Attention: Joanne Edwing, 200 Old Tappan Road, Old Tappan, NJ 07675, phone 201/767-4990, fax 201/767-5625. The individual manuals are available through local technical bookstores worldwide.
What Typographic Changes Mean
-
| 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 | Variable: 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. |
| [optional] | Optional command-line entry | lpr [-Pprinter] |
| Code samples ar | e included in boxes and may display the following: |
| ok | The OpenBoot Forth Monitor prompt | ok |
| % | UNIX C shell prompt | system% |
| $ | UNIX Bourne and Korn shell prompt | system$ |
| # | Superuser prompt, all shells | system# |
Ordering Sun Documents
- The SunDocs Order Desk is a distribution center for Sun Microsystems technical documentation. You can use major credit cards and company purchase orders. You can order documentation in the following ways:
-
| In the U.S.A. | Outside the U.S.A. |
|
| Call 1-800-247-0250 | Call 1-801-342-3450 |
| Fax 1-801-373-6798 | Fax 1-801-373-6798 |
| World Wide Web: http://www.sun.com/sundocs/catalog.html |
Sun Welcomes Your Comments
- Please use the Reader Comment Card that accompanies this document. We are interested in improving our documentation and welcome your comments and suggestions.
- You can also email or fax your comments to us. Please include the part number of your document in the subject line of your email or fax message.
-
- Email: smcc-docs@sun.com
- Fax: SMCC Document Feedback 1-415-786-6443
|
|
