IEAMETR — Query external time reference status

Description

IEAMETR can be used to query external time reference (ETR) status and connection information for the current MVS image. This information is returned in the output area specified by the OUTAREA keyword.

Environment

The requirements for the caller are:

Environmental factor	Requirement
Minimum authorization:	Any state or key
Dispatchable unit mode:	Task mode
Cross memory mode:	Any PASN, any HASN, any SASN
AMODE:	31-bit
ASC mode:	Primary or access register
Interrupt status:	Enabled for I/O and external interrupts
Locks:	None
Control parameters:	Must be in the primary address space

Programming requirements

None.

Restrictions

None.

Input register information

Before issuing the IEAMETR macro, the caller does not have to place any information into any register unless using it in register notation for a particular parameter, or using it as a base register.

Before issuing the IEAMETR macro, the caller does not have to place any information into any AR unless using it in register notation for a particular parameter, or using it as a base register.

Output register information

When control returns to the caller, the GPRs contain:

Register: Contents
0-1: Used as work registers by the system
2-13: Unchanged
14: Used as a work register by the system
15: Return code

When control returns to the caller, the ARs contain:

Register: Contents
0-1: Used as work registers by the system
2-13: Unchanged
14-15: Used as work registers by the system

Performance implications

None.

Syntax

The IEAMETR macro is written as follows:

Syntax	Description

`xlabel`	`xlabel`: Optional symbol. Begin `xlabel` in column 1. The name must conform to the rules for an ordinary assembler language symbol. DEFAULT: No name.

␢	One or more blanks must precede IEAMETR.

IEAMETR

␢	One or more blanks must follow IEAMETR.

OUTADDR=`xoutaddr`

,MF=S	Default: S
,MF=(L,xmfctrl,xmfattr \| 0D)
,MF=(E,xmfctrl,COMPLETE)

Parameters

The parameters are explained as follows:

OUTADDR=xoutaddr

A required input parameter that contains the address of the 24-byte output area to receive the output. The area is mapped by macro IHAETRI.

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,MF=S | L | E

Optional keyword input that specifies the macro form.

S: Specifies the standard form of the macro. Generates code to put the parameters into an in-line parameter list and invoke the desired service. Full checking for required macro keys is done along with supplying defaults for omitted optional parameters.
DEFAULT: S
L: Specifies the list form of the macro. Defines an area to be used for the parameter list. Any other macro parameters are flagged as errors.
E: Specifies the execute form of the macro. Generates code to put the parameters into the parameter list specified by xmfctrl and provides syntax checking with default setting.

,xmfctrl

Required input. It is the name of a storage for the parameter list.

,xmfattr | 0D

Optional 60 character input string that varies from 1 to 60 characters. It can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list.

DEFAULT: 0D. 0D forces the parameter list to a doubleword boundary.

,xmfctrl

Required input. It is the name (RS-type), or address in register (1)-(12), of a storage area for the parameter list.

,COMPLETE

Optional keyword input that specifies the degree of macro parameter syntax checking.

DEFAULT: COMPLETE. Checking for required macro keys is done, and defaults are supplied for omitted optional parameters.

Return codes

Table 1. Return Codes for the IEAMETR Macro
Hexadecimal Return Code	Meaning and Action
00	Meaning: ETR status and port data was successfully obtained. Action: None.
04	Meaning: ETR status information is available, but port is not. Action: None.
08	Meaning: No status or port data is available. Action: None.
0C	Meaning: The parameter list is not in the user's primary address space. Action: Use a parameter list in the primary address space.