HPlogo Asynchronous Serial Communications Programmer's Reference Manual: HP 3000 MPE/iX Computer Systems > Chapter 8 Intrinsics Reference

Intrinsic Descriptions

» 

Technical documentation

Complete book in PDF
» Feedback

 » Table of Contents

 » Glossary

 » Index

The descriptions that follow are specific to the use of intrinsics for programmatic control of asynchronous devices. Because of this, the explanations in this manual may vary from the more general explanations provided by the MPE/iX Intrinsics Reference Manual. In all cases, however, the intrinsics are described according to the conventions that are explained here.

Intrinsic Name

Intrinsic Name A brief summary of the purpose of the intrinsic is listed next to the intrinsic name at the top of the first page of explanation for each intrinsic.

Syntax

The syntax statement contains the complete intrinsic call description. The intrinsic call descriptions are in the format shown below:

           16V       I16V    *
FFILEINFO(filenum [,itemnum,item
                  [,itemnum,item
                  [,itemnum,item
                  [,itemnum,item
                  [,itemnum,item]]]]]);

Required parameters, such as filenum, are shown in boldface. Optional parameters, such as itemnum and item, are shown in italics. The mnemonics that appear over the parameters indicate their type and whether they are passed by reference (the default) or by value. The mnemonics applicable to the intrinsics described in this manual are listed below, along with their meanings:

MNEMONIC

MEANING

I16

16-bit signed integer

I32

32-bit signed integer

U16

16-bit signed integer

C

character

A

array

UDS

user-defined structure

@32

32-bit address

*

type varies

NOTE: A parameter passed by value is indicated by appending V to the mnemonic. Pass by reference is considered to be the default and, consequently, is not marked. All arrays are assumed to be passed by reference.

In the FFILEINFO intrinsic shown previously, there is one required parameter (filenum), and a pair of optional parameters that can be repeated up to five times (itemnum and item). The * over the item parameter indicates that the type of the parameter will change according to an associated factor (in this case, the value associated with itemnum determines what the item parameter will contain and therefore its type).

Use

This paragraph describes how to use the intrinsic. It provides a more complete description than the brief summary given under the intrinsic name.

Functional Return

If applicable to the intrinsic being described, the functional return value will be explained here. If the intrinsic does not have a functional return, this paragraph of the intrinsic description is omitted.

Parameters

All parameters are described, including their data type, whether they are passed by reference or by value, and whether they are required or optional. Any default values for optional parameters are noted here. The description also includes whether the parameter is used to pass information from the program, return information to the program, or both.

For some parameters certain bit settings have particular meanings; when significant, these bit settings and their meanings are described. Bit groups are denoted using the standard notation (starting bit number:length). Thus bit (15:1) indicates bit 15; bits (0:3) indicates bits 0, 1 and 2.

In some cases bits within a word are described as being reserved for MPE/iX. You should always set these bits to zero to be sure your program will remain compatible with future MPE/iX releases.

Notes

A special notes section is included in the explanation of the individual FCONTROL functions, and provides additional information regarding their use.

Condition Codes

Where applicable, condition codes are included in the intrinsic descriptions.

Special Considerations

The special considerations portion of the description is omitted unless the intrinsic requires some special circumstances for proper execution, such as Privileged Mode (PM) capability.

Additional Discussion

This paragraph refers to parts of this or other Hewlett-Packard manuals where you can find additional information on the use of the intrinsic.

Feedback to webmaster