|
Programming Interface Information:
This information is NOT intended to be used as Programming Interfaces of z/VM. |
NIDBK
Control Block Contents
NIDBK DSECT
Cross Reference (Contains links to field and bit definitions)
NIDBK Prolog
NAME : HCPNIDBK
DESCRIPTION: Virtual Network Interface Device block
DSECT : NIDBK
FUNCTION :
Define a structure to represent a Network Interface
Device. One NIDBK exists for each Virtual OSA device
(VDEVCLAS=CLASSPEC and VDEVTYPE=TYPOSA) that is NOT
dedicated (that is, VDEVRDEV does NOT point to an RDEV).
LOCATED BY -
VDEVNID = Pointer to the NIDBK for this device
NICBK = The NICBK contains pointers to each
associated NIDBK, and a pointer to
the CTL-READ NIDBK for delivery of
messages to the virtual machine.
CREATED BY :
CP DEFINE command processing (module HCPVDB)
DELETED BY :
CP DETACH command processing (module HCPVDB)
REFERENCES :
HCPDVTYP COPY - Specific device types
HCPEQUAT COPY - General CP equates
NIDBK Control Block Content
NIDBK DSECT
Hex Dec Type/Val Lng Label (dup) Comments
---- ---- --------- ---- -------------- --------
0000 0 Structure NIDBK Virtual Network Interface Device
block
0000 0 Character 8 NIDDESC NID Description (e.g. IQDC)
0008 8 Address 4 NIDVDEV Pointer to VDEV
000C 12 Address 4 NIDNICBK Pointer to NICBK
0010 16 Address 4 NIDFPNT Pointer to NEXT NIDBK
0014 20 Address 4 NIDBPNT Pointer to PREV NIDBK
0018 24 Bitstring 1 NIDTYPE Network Device Type
0019 25 Bitstring 1 NIDGWFCN NIC device function
00000000 NIDNOFCN 0 Unassigned
00000001 NIDCTLRD 1 CTL-0 / CTL-READ
00000002 NIDCTLWR 2 CTL-1 / CTL-WRITE
00000003 NIDDATA 3 DATA device
001A 26 Signed 2 NIDGWDEV (0) NIC device index (0-xxxx)
001A 26 Bitstring 1 NIDUA0 Unit Address (byte 0)
001B 27 Bitstring 1 NIDUA Unit Address
001C 28 Bitstring 4 NIDSTSWD (0) Status Word (summary for trace)
001C 28 Bitstring 1 NIDLATCH Device Latches
1... .... NIDBUSY X'80' - Busy with a CCW
.1.. .... NIDNTRDY X'40' - Device is NOTREADY
..1. .... NIDCCW1 X'20' - This is First/Only CCW
...1 .... NIDCCFLG X'10' - Command Chaining in
effect
.... 1... NIDNEWUC X'08' - Last CCW caused UC
.... .1.. NIDRSEVT X'04' - Resetting-Event Latch
Notes : NIDGWSTS is serialized by
NIDSPNLK.
001D 29 Bitstring 1 NIDGWSTS Gateway Status
1... .... NIDMSPND X'80' - Message pending from GW
.1.. .... NIDRDPND X'40' - Read pending from VM
..1. .... NIDRDACT X'20' - Read active from VM
...1 .... NIDWRACT X'10' - Write active from VM
.... 1... NIDXDACT X'08' - QDIO exchange is active
Notes : NIDCNTRL is serialized by
NIDSPNLK.
001E 30 Bitstring 1 NIDCNTRL Control options
1... .... NIDSUSPD X'80' - Device is SUSPENDED
.1.. .... NIDSCHED X'40' - RESUME is Scheduled
..1. .... NIDUIPND X'20' - Unsolicited Int Pending
...1 .... NIDRESET X'10' - Reset in Progress
.... 1... NIDDET X'08' - DETACH in Progress
001F 31 Bitstring 1 NIDUISTS Pending Unsolicited Status
0020 32 Bitstring 1 NIDCMD Current CCW opcode
0021 33 Bitstring 1 NIDDVPST Posted Unit Status
0022 34 Bitstring 1 NIDDVSTS Latest Unit Status
0023 35 Bitstring 1 NIDTRFLG Extended Trace Flags
1... .... NIDTRCCW X'80' - Trace CCW Data Buffer
0024 36 Bitstring 2 NIDSNS (0) Sense Data registers
0024 36 Bitstring 1 NIDSNS0 Sense Byte 0 latches
1... .... NIDCMREJ X'80' - Command Reject
.1.. .... NIDINTRQ X'40' - Intervention Reqd
..1. .... NIDBUSCK X'20' - Bus-Out Check
...1 .... NIDEQCHK X'10' - Equipment Check
.... 1... NIDCDC X'08' - Channel Data Check
.... .1.. NIDCCC X'04' - Channel Control Check
.... ..1. NIDIFCC X'02' - Interface Control Check
.... ...1 NIDCANCL X'01' - Cancel Function
0025 37 Bitstring 1 NIDSNS1 Sense Byte 1 latches
1... .... NIDRJRES X'80' - Rejected by
Resetting-Event
0026 38 Bitstring 1 NIDPVCMD Previous CCW opcode
0027 39 Bitstring 1 NIDPVSTS Previous CCW status
0028 40 Signed 4 NIDRFCTR Outstanding Reference Counter
002C 44 Bitstring 2 * Reserved
002E 46 Signed 2 NIDIPCTR Count of IP Addresses installed
0030 48 Address 4 NIDXFRPT Pointer to current buffer
0034 52 Signed 4 NIDXFRLN Bytes to/from VM buffer
0038 56 Address 4 NIDIPNHD Pointer to first IPNBK
003C 60 Address 4 NIDIPNTL Pointer to last IPNBK
The NID Spin Lock (NIDSPNLK) serializes the following fields:
NIDGWSTS - Gateway status flag NIDCNTRL - Device control flag NIDCPEBK
- Pointer to the SUSPEND CPEBK NIDPNDFN - Function being suspended (see
NIDGWFCN) NIDNDMHD - Pointer to the first message (NDMBK) NIDNDMTL -
Pointer to the last message (NDMBK)
0040 64 Signed 4 NIDSPNLK NID Spin Lock
0044 68 Address 4 NIDCPEBK Pointer to SUSPEND CPEBK
0048 72 Bitstring 6 * reserved
004E 78 Signed 2 NIDNDMCT Count of pending messages
0050 80 Address 4 NIDNDMHD Pointer to first NDMBK
0054 84 Address 4 NIDNDMTL Pointer to last NDMBK
NIDSPEC is reserved for device-specific use.
0058 88 Bitstring 16 NIDSPEC Device-Specific area
NIDWORK is reserved as a trace work area.
0068 104 Bitstring 72 NIDWORK Work area for extended trace
End of NIDBK structure.
00B0 176 Bitstring 1 NID$END (0) End of NIDBK
000000B0 NIDBKLN *-NIDBK Length of NICBK in bytes
00000016 NIDBKSZ (*-NIDBK+7)/8 Size of NICBK in
doublewords
Redefine NIDSPEC for NIDTYPE=NICIQDC -
0058 88 Address 4 NIDMPCBK Pointer to assigned MPC block
005C 92 Bitstring 12 * Reserved
Redefine NIDSPEC for NIDTYPE=NICLCS -
0058 88 Address 4 NIDLCABK Pointer to LCABK for this Port
005C 92 Bitstring 1 NIDPORT Binary Adapter Port Number
005D 93 Bitstring 11 * Reserved
NIDBK Storage Layout
*** NIDBK - Virtual Network Interface Device block
*
* +-------------------------------------------------------+
* 0 | NIDDESC |
* +---------------------------+---------------------------+
* 8 | NIDVDEV | NIDNICBK |
* +---------------------------+---------------------------+
* 10 | NIDFPNT | NIDBPNT |
* +------+------+------+------+------+------+------+------+
* 18 |:TYPE |:GWFCN|NIDUA0|NIDUA |:LATCH|:GWSTS|:CNTRL|:UISTS|
* +------+------+------+------+------+------+------+------+
* 20 |NIDCMD|:DVPST|:DVSTS|:TRFLG|:SNS0 |:SNS1 |:PVCMD|:PVSTS|
* +------+------+------+------+------+------+------+------+
* 28 | NIDRFCTR |/////////////| NIDIPCTR |
* +---------------------------+-------------+-------------+
* 30 | NIDXFRPT | NIDXFRLN |
* +---------------------------+---------------------------+
* 38 | NIDIPNHD | NIDIPNTL |
* +---------------------------+---------------------------+
* 40 | NIDSPNLK | NIDCPEBK |
* +---------------------------+-------------+-------------+
* 48 |/////////////////////////////////////////| NIDNDMCT |
* +---------------------------+-------------+-------------+
* 50 | NIDNDMHD | NIDNDMTL |
* +---------------------------+---------------------------+
* 58 | NIDSPEC |
* | |
* +-------------------------------------------------------+
* 68 | |
* = NIDWORK =
* | |
* +-------------------------------------------------------+
*
*** NIDBK - Virtual Network Interface Device block
*** Overlay for NIDSPEC in NIDBK
*
* +---------------------------+---------------------------+
* 58 | NIDMPCBK |///////////////////////////|
* +---------------------------+///////////////////////////|
* |///////////////////////////////////////////////////////|
* +-------------------------------------------------------+
* 68
*
*** Overlay for NIDSPEC in NIDBK
*** Overlay for NIDSPEC in NIDBK
*
* +---------------------------+------+--------------------+
* 58 | NIDLCABK |:PORT |////////////////////|
* +---------------------------+------+////////////////////|
* |///////////////////////////////////////////////////////|
* +-------------------------------------------------------+
* 68
*
*** Overlay for NIDSPEC in NIDBK
NIDBK Cross Reference
Symbol Dspl Value -------------- ---- ----- NID$END 00B0 NIDBKLN 00B0 000000B0 NIDBKSZ 00B0 00000016 NIDBPNT 0014 NIDBUSCK 0024 20 NIDBUSY 001C 80 NIDCANCL 0024 01 NIDCCC 0024 04 NIDCCFLG 001C 10 NIDCCW1 001C 20 NIDCDC 0024 08 NIDCMD 0020 NIDCMREJ 0024 80 NIDCNTRL 001E NIDCPEBK 0044 NIDCTLRD 0019 00000001 NIDCTLWR 0019 00000002 NIDDATA 0019 00000003 NIDDESC 0000 NIDDET 001E 08 NIDDVPST 0021 NIDDVSTS 0022 NIDEQCHK 0024 10 NIDFPNT 0010 NIDGWDEV 001A NIDGWFCN 0019 NIDGWSTS 001D NIDIFCC 0024 02 NIDINTRQ 0024 40 NIDIPCTR 002E NIDIPNHD 0038 NIDIPNTL 003C NIDLATCH 001C NIDLCABK 0058 NIDMPCBK 0058 NIDMSPND 001D 80 NIDNDMCT 004E NIDNDMHD 0050 NIDNDMTL 0054 NIDNEWUC 001C 08 NIDNICBK 000C NIDNOFCN 0019 00000000 NIDNTRDY 001C 40 NIDPORT 005C NIDPVCMD 0026 NIDPVSTS 0027 NIDRDACT 001D 20 NIDRDPND 001D 40 NIDRESET 001E 10 NIDRFCTR 0028 NIDRJRES 0025 80 NIDRSEVT 001C 04 NIDSCHED 001E 40 NIDSNS 0024 NIDSNS0 0024 NIDSNS1 0025 NIDSPEC 0058 NIDSPNLK 0040 NIDSTSWD 001C NIDSUSPD 001E 80 NIDTRCCW 0023 80 NIDTRFLG 0023 NIDTYPE 0018 NIDUA 001B NIDUA0 001A NIDUIPND 001E 20 NIDUISTS 001F NIDVDEV 0008 NIDWORK 0068 NIDWRACT 001D 10 NIDXDACT 001D 08 NIDXFRLN 0034 NIDXFRPT 0030
Copyright IBM Corporation, 1990, 2001