semi合集-English.pdf - 第1529页

SEMI E32-0997 © SEMI 1994 , 1997 24 TRStatus Parameter Detail Parameter RSP/CONF Description Form TRAck M Tells whether the act ivity was successful (=true) or un successful (=false). Bool ean (List of ) Status C Reports…

100%1 / 7923
SEMI E32-0997 © SEMI 1994, 199723
Equipment Initiated Services
Service Name Description Confirmed
TRJobAlert Notification to host that transfer
job is started or complete.
No
TrJobEvent Notification to host that a
transfer-related event has
occurred.
No
4.4.2 Service Detail — The tables below define the
parameters for each service. In some cases, parameters
have additional detail which is defined in a following
section. These parameters are marked with the “*”
character.
The columns labelled REQ/IND and RSP/CONF link
the parameters to the direction of the message. The
message send by the initiator is called the “Request.”
When receiver terms this message the “Indication” or
the request. The receiver may then send a “Response,”
which the original sender terms the “Confirmation.”
The following codes appear in the REQ/IND and
RSP/CONF columns and are used in the definition of
the parameters (e.g., how each parameter is used in
each direction):
“M” — Mandatory Parameter—must be given a
valid value.
“C” — Conditional Parameter—may be defined in
some circumstances and undefined in others.
Whether a value is given may be completely
optional or may depend on the value of other
parameter.
“U” — User Defined Parameter.
“–” — Not Used.
“=“ — (for Response only) Indicates that the value
of this parameter in the response must match that in
the primary (if defined).
The column labelled “Form” is used to indicate the type
of data contained in a parameter. The forms used in this
document are defined below.
Unsigned Integer — May take the value of any non–
negative integer. Messaging protocol may impose a
limit on the range of possible values.
Enumerated — The parameter may take on one of a
limited set of possible values. These values are
generally given logical names but may be represented
by any data type excluding lists and structures.
Boolean — The parameter may take on one of two
possible values, equating to “True” and “False.”
Text — A text string.
Structure — A complex structure which consists of a
collection of values of one of the possible forms. The
breakdown of all “Structure” parameters is provided
within this document.
NOTE 4: To prevent the definition of numberous variables
named “XxxList”, this document adopts the convention of
referring to the list as “(List of) Xxx.” In this case, the
definition of the variable Xxx will be given, not of the list.
The term “list” indicates an ordered collection (or set) of zero
or more items of the same data type. List order is retained
from the message request to the response. For this document,
a list must contain at least one element unless zero elements
are specifically allowed.
TRJobCreate
The host requests that the equipment participate in a material transfer job.
Parameter REQ/IND RSP/CONF Description Form
TRJobName C - Host created identifier of the transfer job. This allows the
host to use a common name for the transfer job on each
participating equipment.
Text
(List of) AtomicSpec M - Specifications for the atomic transfer(s). Structure
TRJobID - M Equipment created ID of the transfer job. Unsigned Integer
(List of)
TRAtomicID
- M The equipment-created identifier of the atomic
transfer(s).* Order matches that given in the (List of)
AtomicSpec in the message req.
Unsigned Integer
TRStatus - M Reports acceptance or rejection of the transfer job. Structure
*All object IDs created by the equipment must be unique within that equipment for that object type. This includes TRJobID and TRAtomicID.
These IDs are used by the host to inquire about those objects.
SEMI E32-0997 © SEMI 1994, 1997 24
TRStatus Parameter Detail
Parameter RSP/CONF Description Form
TRAck M Tells whether the activity was successful (=true) or unsuccessful (=false). Boolean
(List of) Status C Reports any errors found. (May be list of 0.) Structure
Status Parameter Detail
Parameter RSP/CONF Description Form
ErrorCode M Contains the code for the specific error found. Enumerated
ErrorText M Text in support of the error code. Text
AtomicSpec Parameter Detail
Many of these parameters are conditional. The equipment shall decide if it has a sufficient amount of information to
perform each atomic transfer.
Parameter REQ/IND Description Form
TRLink M Used by the transfer partners to assure that their communications
relate to the same atomic transfer. The host is responsible for
assuring uniqueness.
Unsigned integer
TRPort C Material I/O port on the equipment through which the transfer is to
occur. If not specified, the equipment shall select the port.
Unsigned integer
TRObjName C Textual identifier of the object to be transferred. Text
TRObjType* C Identifies the type of transfer object. Not required if only one type is
acceptable.
Enumerated
TRRole M Equipment's role (i.e., Primary or Secondary). Enumerated
TRRecipe C Name of the transfer recipe (if needed). Text
TRPartner M Identifier (Name* attribute of equipment) of the transfer partner. Text
TRPartnerPort C Material I/O port on the equipment's partner to be used for this
atomic transfer.
Unsigned integer
TRDirection M Send or Receive the transfer object? Enumerated
TRType M Is the equipment to be Passive or Active? Enumerated
TRLocation C Identifier of the location on the equipment of the source (or
destination) of the transfer object.
Unsigned integer
TRAutoStart M Should the equipment start the handoff without waiting for the
“StartHandoff” command.
Boolean
TRJobCommand
The host requests a change in an active transfer job. Possible commands include Pause, Resume, Stop, Cancel,
Abort, StartHandoff.
Parameter REQ/IND RSP/CONF Description Form
TRObjID M - Equipment's identifier of the transfer job to which the
command applies.
Unsigned integer
TRCmdName* M - Indicates which command to perform. Text
(List of)
CmdParameter
C - Parameter(s) corresponding to the command type. (May be list
of 0)
Structure
TRStatus - M Describes the acceptance or rejection of the command. Structure
SEMI E32-0997 © SEMI 1994, 199725
CmdParameter Detail
Parameter RSP/CONF Description Form
CmdParmName M The name of the parameter. Text
CmdParmValue M Value of the parameter. Varies per Parameter
TRJobAlert
The equipment indicates the start or completion of a transfer job.
Parameter REQ/IND Description Form
TRJobID M Equipment’s identifier of the transfer job. Unsigned integer
TRJobName M Host created identifier of the transfer job. Text
TRJobMS* M Transfer job milestone. Enumerated
TRStatus M Status of the transfer milestone (i.e., success or failure). Structure
GetAttribute
Information related to a specific object (e.g., transfer job) is requested.
Parameter REQ/IND RSP/CONF Description Form
ObjType* M - Type of object for which attributes are desired. Enumerated
(List of) ObjectID C - Identifier of each object for which attributes are desired. If
omitted (i.e., list of zero elements), it implies a request for all
objects of the specified ObjType.
Varies according
to ObjType.
(List of) AttributeID* M - Identifier of requested attribute. Enumerated
(List of) AttrData - C Attribute data. Returns the requested attribute list for each
specified ObjectID (e.g., grouped per ObjectID). If the object
does not exist, an empty list is returned for that object, if an
attribute does not exist, a null member of the list is returned. If
the ObjType is unknown, a single null list is returned.
Varies per
attribute.
(List of) Status - C Reports any errors found in the GetAttribute request. (May be
list of 0.)
Structure
TRJobEvent
The equipment reports pertinent state changes related to a transfer job.
Parameter REQ/IND Description Form
TREventID* M Identifier of the specific event which occurred. Enumerated
TRJobID M Equipment’s identifier of the job to which the event refers. Unsigned integer
TREventData C Data related to the specific event. May be repeated if multiple data
parameters are reported.
Varies per parameter
reported.