Parameters

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the IWM4MGDD macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

,DESCRIPTIONS=descriptions

A required input parameter,

For REQTYPE=DEFINE, the address specifies the input area to the request that contains descriptions for generic delay states to be defined for a particular subsystem.
The layout of the data area must adhere to the mapping defined by macro IWMWGDD.

Note: With one DEFINE request, a subsystem defines a set of descriptions for the generic delay states it uses. A subsequent DEFINE request will override the currently existing definitions.
If IWMWGNUM is set to 0, then the currently existing definitions are deleted.

Following fields in the data area must be set correctly. For their meaning refer to the header of macro IWMWGDD directly.

• IWMWGEYE
• IWMWGVER
• IWMWGTYP
• IWMWGNUM
• IWMWGTNUM

Following field in the data area must not be set, i.e. it must have a value of zero. .br;For its meaning refer to the header of macro IWMWGDD directly.

• IWMWGNXT

If any of these fields is not set correctly, the request is terminated with return code IwmRetCodeInvocError and reason code IwmRsnCodeBadRequestList. The field in error is identified by setting IWMWGRC appropriately, refer to macro IWMWGDD for the possible values in IWMWGRC.

For REQTYPE=RETRIEVE, the address specifies the input/output area to the request.
As input to the request the area contains the type of the subsystem for which the descriptions are to be retrieved.
After execution of the request the area contains the descriptions for generic delay states as they are currently defined for the input subsystem.
The layout of the data area must adhere to the mapping defined by macro IWMWGDD.

Following fields in the data area must be set correctly. For their meaning refer to the header of macro IWMWGDD directly.

• IWMWGEYE
• IWMWGVER
• IWMWGTYP
• IWMWGNUM

Following field in the data area must not be set

• IWMWGNXT

If any of these fields is not set correctly, the request is terminated with return code IwmRetCodeInvocError and reason code IwmRsnCodeBadRequestList. The field in error is identified by setting IWMWGRC appropriately, refer to macro IWMWGDD for the possible values in IWMWGRC.

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

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter may be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,list addr

The name of a storage area to contain the parameters. For MF=S and MF=E, this can be an RS-type address or an address in register (1)-(12).

,attr

An optional 1- to 60-character input string that you use to force boundary alignment of the parameter list. Use a value of 0F to force the parameter list to a word boundary, or 0D to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value of 0D.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form, when both are assembled with the same level of the system. In this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 0, if you use the currently available parameters.

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0

REQTYPE=DEFINE

REQTYPE=RETRIEVE

A required parameter that indicates whether the request is to define or to retrieve generic delay state descriptions.

REQTYPE=DEFINE

The request is to define the generic delay state descriptions for a particular subsystem.

REQTYPE=RETRIEVE

The request is to retrieve the generic delay state descriptions of a particular subsystem.

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15. If you specify 15, GPR15, REG15, or R15 (within or without parentheses), the value will be left in GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or (R15).

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0. If you specify 0, 00, GPR0, GPR00, REG0, REG00, or R0 (within or without parentheses), the value will be left in GPR 0.

To code: Specify the RS-type address of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00), REG0), (REG00), or (R0).