Programming Interface Information:
This information is NOT intended to be
used as Programming Interfaces of z/VM.

NICBK

Prolog  

Control Block Contents  
   NICBK DSECT

Storage Layout  

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       NICHIPR        1 HiperSockets adapter type
          00000002       NICQDIO        2 QDIO 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
          .... 1...      NICREADY       X'08' LAN READY
          .... .1..      NICROUTR       X'04' NETROUTER is set (USER
                                        DIRECT)
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 -
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 NICDEFIP       Default IP Address (accounting)
0080  128 Address      4 NICROUTP       Pointer to NIDBK(PriRouter)
0084  132 Address      4 NICROUTS       Pointer to NIDBK(SecRouter)
     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.
0088  136 Address      4 NICFPNT        Pointer to Next NICBK
008C  140 Address      4 NICBPNT        Pointer to Prev NICBK
0090  144 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.
0094  148 Address      4 NICSIGA        SIGA Simulation routine
0098  152 Address      4 NICNCABK       Pointer to NCABK
009C  156 Bitstring    4 *              Reserved
     Adapter Counter LKWRD.
     Notes : LKWRDSIZ == 3 doublewords.
00A0  160 Dbl-Word     8 NICCTRLK (3)   Adapter Counter Lockword
     Adapter Counters.
00B8  184 Dbl-Word     8 NICTXBYT       Total Bytes Sent
00C0  192 Dbl-Word     8 NICRXBYT       Total Bytes Received
00C8  200 Signed       4 NICTXPKT       TX Packets extracted
00CC  204 Signed       4 NICTXDSC       TX Packets discarded
00D0  208 Signed       4 NICTXERR       TX Bad Packets discarded
00D4  212 Signed       4 NICRXPKT       RX Packets received
00D8  216 Signed       4 NICRXDSC       RX Packets discarded/overflow
00DC  220 Signed       4 NICRXERR       RX Bad Packets discarded
     End of the NICBK.
00E0  224 Dbl-Word     8 NIC$END (0)    End of the NICBK structure
          000000E0       NICBKLN        *-NICBK Length of NICBK in bytes
          0000001C       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

 

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 |:QDFMT|/////////////|:ADPNL|        NICADPNM-          |
*     +------+-------------+------+---------------------------+
*  68 |          -(064)           |         NICMPCCT          |
*     +---------------------------+---------------------------+
*  70 |         NICMPCHD          |         NICMPCTL          |
*     +-------------+-------------+---------------------------+
*  78 |  NICMAXIQ   |  NICMAXOQ   |         NICDEFIP          |
*     +-------------+-------------+---------------------------+
*  80 |         NICROUTP          |         NICROUTS          |
*     +---------------------------+---------------------------+
*  88 |         NICFPNT           |         NICBPNT           |
*     +---------------------------+---------------------------+
*  90 |         NICLANBK          |         NICSIGA           |
*     +---------------------------+---------------------------+
*  98 |         NICNCABK          |///////////////////////////|
*     +---------------------------+---------------------------+
*  A0 |                                                       |
*     =                       NICCTRLK                        =
*     |                                                       |
*     +-------------------------------------------------------+
*  B8 |                       NICTXBYT                        |
*     +-------------------------------------------------------+
*  C0 |                       NICRXBYT                        |
*     +---------------------------+---------------------------+
*  C8 |         NICTXPKT          |         NICTXDSC          |
*     +---------------------------+---------------------------+
*  D0 |         NICTXERR          |         NICRXPKT          |
*     +---------------------------+---------------------------+
*  D8 |         NICRXDSC          |         NICRXERR          |
*     +---------------------------+---------------------------+
*
*** NICBK - Virtual Network Interface Card block

 

NICBK Cross Reference

Symbol         Dspl Value
-------------- ---- -----
NIC$END        00E0
NICADPNL       0063
NICADPNM       0064
NICADPTK       0063
NICBASE        0010
NICBKLN        00E0 000000E0
NICBKSZ        00E0 0000001C
NICBPNT        008C
NICCFLG        0054
NICCHPID       001F
NICCHPTP       001E
NICCNLAN       0054 20
NICCTRLK       00A0
NICCUMDL       001A
NICCUTYP       0018
NICDEFIP       007C
NICDESC        0000
NICDEVS        0014
NICDLPRG       0054 40
NICDVMDL       001D
NICDVTYP       001B
NICFPNT        0088
NICHIPR        0016 00000001
NICINPRG       0054 80
NICLANBK       0090
NICLAST        0012
NICLKWRD       0038
NICMAC         0028
NICMAXDV       00E0 00000100
NICMAXIP       002E
NICMAXIQ       0078
NICMAXNT       00E0 00000020
NICMAXOQ       007A
NICMFS         0024
NICMPCCT       006C
NICMPCHD       0070
NICMPCTL       0074
NICNCABK       0098
NICNIDHD       0058
NICNIDTL       005C
NICOWNER       0008
NICPVLAN       0054 10
NICQDFMT       0060
NICQDIO        0016 00000002
NICREADY       0054 08
NICRESET       0034
NICRFCTR       0050
NICROUTP       0080
NICROUTR       0054 04
NICROUTS       0084
NICRXBYT       00C0
NICRXDSC       00D8
NICRXERR       00DC
NICRXPKT       00D4
NICSETUP       0030
NICSIGA        0094
NICTXBYT       00B8
NICTXDSC       00CC
NICTXERR       00D0
NICTXPKT       00C8
NICTYPE        0016
NICVDEV        0020

This information is based on z/VM V4R3.0. Last updated on 1 May 2002 at 09:23:41 EDT.
Copyright IBM Corporation, 1990, 2002