About This Manual

Purpose

This manual is part of a documentation set that describes pSOSystem, the modular, high-performance real-time operating system environment from Integrated Systems.

This manual contains detailed descriptions of all pSOSystem system calls and system services, as well as other important reference material on device drivers, configuration tables, error codes, and memory usage.

The level of information in this manual is different than that provided by either the pSOSystem Getting Started or pSOSystem System Concepts manuals. Together, the three manuals comprise the basic documentation set for the pSOSystem operating system.

Audience

This manual is targeted primarily for embedded application developers who want to implement the pSOSystem environment. Basic familiarity with UNIX terms and concepts is assumed.

Organization

This manual is organized as follows:

Section 1, "System Calls," describes the system calls and C language interface to the pSOS+, pHILE+, pREPC+, pNA+, pRPC+ components.

Section 2, "System Services," describes pSOSystem system services, such as boot ROMs, FTP Client and FTP Server, pSOSystem Loader, NFS Server, pSH command line interface, Telnet Client and Telnet Server, and TFTP Server.

Section 3, "Interfaces and Drivers," describes the pSOSystem Network Interface and Kernel Interface, as well as the interface to SCSI drivers.

Section 4, "Configuration Tables," describes each software component's configuration table, which contains parameters that characterize the hardware and application environment.

Section 5, "Memory Usage," describes formulas used to calculate the amount of RAM required by each pSOSystem software component.

Appendix A, "Error Codes," provides a listing of all error codes returned by pSOSystem system calls.

Appendix B, "Assembly Language Information," gives information that is useful to system programmers who understand MIPS assembly language.

Appendix C, "pHILE+ Volume Verification," describes the system call verify_vol, which verifies a volume control structure.

Related Documentation

When using the pSOSystem operating system you might want to have on hand the other two manuals included in the basic documentation set:

• pSOSystem Getting Started - explains how to create and bring up pSOSystem-based applications. This manual also contains installation instructions and a number of tutorials.
• pSOSystem System Concepts - provides theoretical information about the operation of the pSOSystem operating system.

Based on the options you have purchased, you might also need to reference one or more of the following manuals:

• pROBE+ User's Manual - describes how to use the pROBE+ System Debugger/Analyzer.
• C++ Support Package User's Manual - describes how to implement C++ applications in a pSOSystem environment.
• OpEN User's Manual - describes how to install and use pSOSystem's OPEN (Open Protocol Embedded Networking) product.
• SNMP User's Manual - describes the internal structure and operation of SNMP, Integrated System's Simple Network Management Protocol product. This manual also describes how to install and use the SNMP MIB (Management Information Base) Compiler.
• pSOSim User's Manual - describes how to install and use pSOSim, a UNIX-based pSOS+ kernel simulator.
• SpOTLIGHT Debug Server User's Manual - describes how to use the SpOTLIGHT debugger to debug pSOSystem applications.

Notation Conventions

The following notation conventions are used in this manual:

• Function names (q_receive), filenames (pdefs.h), keywords (int), and operators (!) that must be typed exactly as shown are presented in bold.
• Italics indicate that a user-defined value or name (drive:pathname) can be substituted for the italicized word(s) shown. Italics also indicate emphasis, such as when important terms are introduced.
• Keynames [Enter] are shown within square brackets. Keynames separated by hyphens are typed together. For example, to type [Ctrl-Shift-E], hold down the [Ctrl] and [Shift] keys and type the letter E.
• Code examples are shown in constant width.

Each reference page in this manual adheres to a standard format, as follows:

NAME

provides the name and a brief description of the call or utility.

SYNTAX

provides the C language definition.

DESCRIPTION

provides a description of the call or utility and any associated parameters.

RETURN VALUE

is a value that indicates whether or not the call succeeded. For example, pSOS+ system calls always return a 0 to indicate a successful call, and pREPC+ calls can return either a nonzero value if the test result is true, or 0 if it is false. The Error Codes section lists possible errors returned by each call.

EXAMPLES

provides example(s) containing the call or utility.

ERROR CODES

is a list of possible errors and error codes that the call can generate. For pSOS+ calls, an error code returns as a system call return value. For other components, such as the pREPC+ library and the pNA+ network manager, error codes return by way of errno values. Appendix A contains a complete list of error codes for each software component.

NOTES

provides supplemental information, warnings, and side effects of a call.

MULTIPROCESSOR CONSIDERATIONS

relates only to the pSOS+m kernel, the multiprocessor version of the pSOS+ kernel. This section states whether the system call applies only if used on a local processor node, or if it is callable as a remote system call.

CALLABLE FROM

relates only to the single and multiprocessor kernels. All system services are callable from a task and a device driver procedure. This section indicates whether a system call is also callable from an Interrupt Service Routine (ISR), Kernel Interface (KI), or a callout.

SEE ALSO

lists related service calls or the location of other relevant information.

VOLUME TYPES

names the volume types the service call supports (pHILE+ only).

Copyright © 1996, Integrated Systems, Inc. All rights reserved.