|
Programming Interface Information:
This information is NOT intended to be used as Programming Interfaces of z/VM. |
NICBK
Control Block Contents
NICBK DSECT
Cross Reference (Contains links to field and bit definitions)
NICBK Prolog
NAME : HCPNICBK
DESCRIPTION: Virtual Network Interface Card block
DSECT : NICBK
FUNCTION :
Define a structure to represent a Network Interface
Card. One NICBK exists for each Virtual Adapter.
Each NICBK is associated with a set of Virtual
Network Interface Devices (VDEV/NIDBK).
LOCATED BY -
VDEVNIC = Pointer to owning adapter NICBK
NIDNICBK = Pointer to owning adapter NICBK
LNKNICHD = Pointer to chain of coupled adapter NICBK
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
NICBK Control Block Content
NICBK DSECT
Hex Dec Type/Val Lng Label (dup) Comments
---- ---- --------- ---- -------------- --------
0000 0 Structure NICBK Virtual Network Interface Card
block
Static Area -
The fields in this area are relatively constant. They are initialized
when the adapter (NIC) is created, and may be referenced with minimal
serialization (just enough to be sure your pointer to the NICBK is
valid).
0000 0 Character 8 NICDESC NIC Description (e.g. HIPER)
0008 8 Character 8 NICOWNER NIC Owner VM Userid
0010 16 Signed 2 NICBASE NIC Base Virtual Device Address
0012 18 Signed 2 NICLAST NIC Last Virtual Device Address
0014 20 Signed 2 NICDEVS NIC Device Count
0016 22 Bitstring 1 NICTYPE Network Device Type
00000001 NICIQDC 1 IQDC Device
00000001 NICHIPR 1 HIPERSOCKET adapter type
00000002 NICQDIO 2 QDIO adapter type
00000003 NICLCS 3 LCS adapter type
0017 23 Bitstring 1 * Reserved
0018 24 Bitstring 2 NICCUTYP Simulated Control Unit Type
001A 26 Bitstring 1 NICCUMDL Simulated Control Unit Model
001B 27 Bitstring 2 NICDVTYP Simulated Device Type
001D 29 Bitstring 1 NICDVMDL Simulated Device Model
001E 30 Bitstring 1 NICCHPTP CHPID type for this adapter
001F 31 Bitstring 1 NICCHPID CHPID for this adapter
0020 32 Address 4 NICVDEV Pointer to Base VDEV
0024 36 Signed 4 NICMFS MFS (bytes) for current LAN
0028 40 Bitstring 6 NICMAC MAC Address for this adapter
002E 46 Bitstring 2 NICMAXIP Maximum IP Addresses per device
0030 48 Address 4 NICSETUP Driver Setup routine
0034 52 Address 4 NICRESET Driver Reset routine
NIC Adapter Lock -
Notes : LKWRDSIZ == 3 doublewords.
0038 56 Dbl-Word 8 NICLKWRD (3) Adapter Lockword
Adapter Management Area -
The fields in this area are used in the normal operation of the adapter
(NIC). In general, these fields are serialized by the NIC Adapter Lock:
- Hold NICLKWRD EXCLUSIVE to update - Hold NICLKWRD SHARED to reference
0050 80 Signed 4 NICRFCTR Outstanding Reference count
0054 84 Bitstring 1 NICCFLG Adapter Configuration flags
1... .... NICINPRG X'80' Initialization in Progress
.1.. .... NICDLPRG X'40' Delete in Progress
..1. .... NICCNLAN X'20' Connected to a SYSTEM LAN
...1 .... NICPVLAN X'10' Connected to a PRIVATE LAN
0055 85 Bitstring 3 * Reserved
0058 88 Address 4 NICNIDHD Pointer to First NIDBK
005C 92 Address 4 NICNIDTL Pointer to Last NIDBK
Device Specific Area -
This area is reserved for use by device-specific routines.
0060 96 Bitstring 32 NICSPEC NICBK Device-dependent extension
LAN Management Area -
The fields in this area are used to connect the adapter (NIC) to a
Virtual LAN.
To connect or disconnect this adapter (NIC) to/from a Virtual LAN, the
following locks must be obtained (in this sequence):
- The LAN Lock (LANLKWRD) EXCLUSIVE - The NIC Adapter Lock (NICLKWRD)
EXCLUSIVE
To reference these fields (e.g. while following the chain) you only
need to hold LANLKWRD SHARED.
0080 128 Address 4 NICFPNT Pointer to Next NICBK
0084 132 Address 4 NICBPNT Pointer to Prev NICBK
0088 136 Address 4 NICLANBK Pointer to associated LANBK. If
NICCNLAN=1 this is a System LAN.
Otherwise this is the PRIVATE LAN
that represents a disconnected
adapter.
008C 140 Bitstring 4 * Reserved
End of the NICBK.
0090 144 Dbl-Word 8 NIC$END (0) End of the NICBK structure
00000090 NICBKLN *-NICBK Length of NICBK in bytes
00000012 NICBKSZ (*-NICBK+7)/8 Size of NICBK in
doublewords
Related constants.
00000100 NICMAXDV 256 Max Network Devices per NIC
00000020 NICMAXNT 32 Max Network Ports per NIC
NICSPEC Overlay for HIPERSOCKET -
0060 96 Bitstring 1 NICQDFMT QDIO Queue Format
0061 97 Bitstring 2 * Reserved
0063 99 Bitstring 9 NICADPTK (0) Adapter Name : Length||Token
0063 99 Bitstring 1 NICADPNL Length of NICADPNM Token
0064 100 Character 8 NICADPNM Adapter Name Token
006C 108 Signed 4 NICMPCCT Count of established MPC groups
0070 112 Address 4 NICMPCHD Pointer to First MPCBK
0074 116 Address 4 NICMPCTL Pointer to Last MPCBK
0078 120 Signed 2 NICMAXIQ Maximum INPUT Queues per MPC
007A 122 Signed 2 NICMAXOQ Maximum OUTPUT Queues per MPC
007C 124 Bitstring 4 * Reserved
NICBK Storage Layout
*** NICBK - Virtual Network Interface Card block
*
* +-------------------------------------------------------+
* 0 | NICDESC |
* +-------------------------------------------------------+
* 8 | NICOWNER |
* +-------------+-------------+-------------+------+------+
* 10 | NICBASE | NICLAST | NICDEVS |:TYPE |//////|
* +-------------+------+------+------+------+------+------+
* 18 | NICCUTYP |:CUMDL| NICDVTYP |:DVMDL|:CHPTP|:CHPID|
* +-------------+------+------+------+------+------+------+
* 20 | NICVDEV | NICMFS |
* +---------------------------+-------------+-------------+
* 28 | NICMAC | NICMAXIP |
* +---------------------------+-------------+-------------+
* 30 | NICSETUP | NICRESET |
* +---------------------------+---------------------------+
* 38 | |
* = NICLKWRD =
* | |
* +---------------------------+------+--------------------+
* 50 | NICRFCTR |:CFLG |////////////////////|
* +---------------------------+------+--------------------+
* 58 | NICNIDHD | NICNIDTL |
* +---------------------------+---------------------------+
* 60 | |
* = NICSPEC =
* | |
* +---------------------------+---------------------------+
* 80 | NICFPNT | NICBPNT |
* +---------------------------+---------------------------+
* 88 | NICLANBK |///////////////////////////|
* +---------------------------+---------------------------+
*
*** NICBK - Virtual Network Interface Card block
*** Overlay for NICSPEC in NICBK
*
* +------+-------------+------+---------------------------+
* 60 |:QDFMT|/////////////|:ADPNL| NICADPNM- |
* +------+-------------+------+---------------------------+
* 68 | -(064) | NICMPCCT |
* +---------------------------+---------------------------+
* 70 | NICMPCHD | NICMPCTL |
* +-------------+-------------+---------------------------+
* 78 | NICMAXIQ | NICMAXOQ |///////////////////////////|
* +-------------+-------------+---------------------------+
* 80
*
*** Overlay for NICSPEC in NICBK
NICBK Cross Reference
Symbol Dspl Value -------------- ---- ----- NIC$END 0090 NICADPNL 0063 NICADPNM 0064 NICADPTK 0063 NICBASE 0010 NICBKLN 0090 00000090 NICBKSZ 0090 00000012 NICBPNT 0084 NICCFLG 0054 NICCHPID 001F NICCHPTP 001E NICCNLAN 0054 20 NICCUMDL 001A NICCUTYP 0018 NICDESC 0000 NICDEVS 0014 NICDLPRG 0054 40 NICDVMDL 001D NICDVTYP 001B NICFPNT 0080 NICHIPR 0016 00000001 NICINPRG 0054 80 NICIQDC 0016 00000001 NICLANBK 0088 NICLAST 0012 NICLCS 0016 00000003 NICLKWRD 0038 NICMAC 0028 NICMAXDV 0090 00000100 NICMAXIP 002E NICMAXIQ 0078 NICMAXNT 0090 00000020 NICMAXOQ 007A NICMFS 0024 NICMPCCT 006C NICMPCHD 0070 NICMPCTL 0074 NICNIDHD 0058 NICNIDTL 005C NICOWNER 0008 NICPVLAN 0054 10 NICQDFMT 0060 NICQDIO 0016 00000002 NICRESET 0034 NICRFCTR 0050 NICSETUP 0030 NICSPEC 0060 NICTYPE 0016 NICVDEV 0020
Copyright IBM Corporation, 1990, 2001