LSZCRYPT(8)

NAME
lszcrypt - display zcrypt device and configuration information

SYNOPSIS

lszcrypt
    [ -V ] [ <device-id> [...]]

lszcrypt
    -c <card-id>

lszcrypt -b

lszcrypt -d

lszcrypt -h

lszcrypt -v

DESCRIPTION
The lszcrypt command is used to display information about cryptographic devices managed by zcrypt and the AP bus attributes of zcrypt. Displayed information depends on the kernel version. lszcrypt requires that sysfs is mounted.

The following information can be displayed for each cryptographic device: card ID, domain ID, card type (symbolic), mode, online status, hardware card type (numeric), installed function facilities, card capability, hardware queue depth, request count, number of requests in hardware queue, and the number of outstanding requests. The following AP bus attributes can be displayed: AP domain, Max AP domain, configuration timer, poll thread status, poll timeout, and AP interrupt status.

OPTIONS

-V, --verbose
    The verbose level for cryptographic device information. With this verbose level additional information like hardware card type, hardware queue depth, pending requests count, installed function facilities and driver binding is displayed.

<device-id>
    Specifies a cryptographic device to display. A cryptographic device can be either a card device or a queue device. If no devices are specified information about all available devices is displayed. Please note that the card device representation and the queue device are both in hexadecimal notation.

-b, --bus
    Displays the AP bus attributes and exits.

-c, --capability <card-id>
    Shows the capabilities of a cryptographic card device of hardware type 6 or higher. The card device id value may be given as decimal or hex value (with a leading 0x). The capabilities of a cryptographic card device depend on the card type and the installed function facilities. A cryptographic card device can provide one or more of the following capabilities:

    o   RSA 2K Clear Key

    o   RSA 4K Clear Key

    o   CCA Secure Key

    o   EP11 Secure Key

    o   Long RNG
    The CCA Secure Key capability may be limited by a hypervisor layer. The remarks 'full function set' or 'restricted function set' may reflect this. For details about these limitations please check the hypervisor documentation.

-d, --domains
    Shows the usage and control domains of the cryptographic devices. The displayed domains of the cryptographic device depends on the initial cryptographic configuration.

    o   C - indicate a control domain

    o   U - indicate a usage domain

    o   B - indicate both (control and usage domain)

-h, --help
    Displays help text and exits.

-v, --version
    Displays version information and exits.

LISTING DETAILS
Here is an explanation of the columns displayed. Please note that some of the columns show up in verbose mode only.

CARD.DOM
    The crypto card number in hexadecimal for a crypto card line or the crypto card number and the domain id both in hex separated by a single dot for a queue line.

TYPE and HWTYPE
    The HWTYPE is a numeric value showing which type of hardware the zcrypt device driver presumes that this crypto card is. The currently known values are 7=CEX3C, 8=CEX3A, 10=CEX4, 11=CEX5, 12=CEX6 and 13=CEX7.
    The TYPE is a human readable value showing the hardware type and the basic function type (A=Accelerator, C=CCA Coprocessor, P=EP11 Coprocessor). So for example CEX6P means a CEX6 card in EP11 Coprocessor mode.

MODE
    A crypto card can be configured to run into one of 3 modes:
    Accelerator - Acceleration of clear key RSA (CRT and ME) cryptographic operations.
    CCA Coprocessor - Support CCA secure key cryptographic operations.
    EP11 Coprocessor - Support EP11 secure key cryptographic operations.

STATUS
    A crypto card and/or a crypto queue may be switched offline to prohibit it's use. There are two levels of offline state. A software online/offline state is kept by the zcrypt device driver and can be switched on or off with the help of the chzcrypt application.
    A crypto card can also be 'configured' or 'deconfigured'. This state may be adjusted on the HMC or SE. The chzcrypt application can also trigger this state with the --config-on and --config-off options.
    lszcrypt shows 'online' when a card or queue is available for cryptographic operations. 'offline' is displayed when a card or queue is switched to (software) offline. If a card is 'deconfigured' via HMC, SE or chzcrypt the field shows 'deconfig'.
    If a queue is not bound to a device driver there is no detailed information available and thus the status shows only '-'.
    If a queue is bound to the vfio-ap device driver it is up to this driver to give some status information and what exactly this means. So lszcrypt shows the text retrieved from the underlying sysfs attribute here.

REQUESTS
    This is the counter value of successful processed requests on card or queue level. Successful here means the request was processed without any failure in the whole processing chain.

PENDING
    The underlying firmware and hardware layer usually provide some queuing space for requests. When this queue is already filled up, the zcrypt device driver maintains a software queue of pending requests. The sum of these both values is displayed here and shows the amount of requests waiting for processing on card or queue level.

FUNCTIONS
    This column shows firmware and hardware function details:
    S - APSC available: card/queue can handle requests with the special bit enabled.
    M - Accelerator card/queue with support for RSA ME with up to 4k key size. C - Accelerator card/queue with support for RSA CRT with up to 4k key size.
    D - Card/queue is providing CCA functions (this is the CCA Coprocessor mode).
    A - Card/queue is providing Accelerator functions (this is the Accelerator mode).
    X - Card/queue is providing EP11 functions (this is the EP11 Coprocessor mode).
    N - APXA available (ability to address more than 16 crypto cards and domains).
    F - Full function support (opposed to restricted function support, see below).
    R - Restricted function support. The F and R flag both reflect if a hypervisor is somehow restricting this crypto resource in a virtual environment. Dependent on the hypervisor configuration the crypto requests may be filtered by the hypervisor to allow only a subset of functions within the virtual runtime environment. For example a shared CCA Coprocessor may be restricted by the hypervisor to allow only clear key operations within the guests.

DRIVER
    Shows which card or queue device driver currently handles this crypto resource. Currently known drivers are cex4card/cex4queue (CEX4-CEX7 hardware), cex2card/cex2cqueue (CEX2C and CEX3C hardware), cex2acard/cex2aqueue (CEX2A and CEX3A hardware) and vfio_ap (queue reserved for use by kvm hypervisor for kvm guests and not accessible to host applications). It is also valid to have no driver handling a queue which is shown as a -no-driver- entry.

EXAMPLES

lszcrypt
    Displays the card/domain ID, card type (short name), mode (long name), online status and request count of all available cryptographic devices.

lszcrypt 1 3 5
    Displays the card/domain ID, card type, mode, online status and request count for cryptographic devices 1, 3, and 5.

lszcrypt -V 3 7 11
    Displays the card/domain ID, card type, mode, online status, request count, number of requests in the hardware queue, number of outstanding requests and installed function facilities for cryptographic devices 3, 7 and 17 (0x11).

lszcrypt 10.0038
    Displays information of the cryptographic device '10.0038' respectively card id 16 (0x10) with domain 56 (0x38).

lszcrypt .0038
    Displays information of all available queue devices (potentially multiple adapters) with domain 56 (0x38).

lszcrypt -b
    Displays AP bus information.

lszcrypt -c 7
    Coprocessor card07 provides capability for:
    CCA Secure Key
    RSA 4K Clear Key
    Long RNG

SEE ALSO
chzcrypt(8)