XOA CLI Documentation Logo

Table of Contents

  • 1. Introduction
  • 2. Understanding XOA CLI
  • 3. Command Reference
    • 3.1. Chassis
    • 3.2. Module
    • 3.3. Port
    • 3.4. Stream
    • 3.5. Transceiver
    • 3.6. Ultra Ethernet (UE)
      • 3.6.1. Control Order Set (CtlOS)
      • 3.6.2. Link Layer Retry (LLR)
      • 3.6.3. Credit-Based Flow Control (CBFC)
        • CBFC Mode
        • CBFC Link Message Configuration
        • CBFC Virtual Channels Configuration
          • P_UE_CBFC_NUMVCS
          • P_UE_CBFC_LINK
            • Description
            • Actions
            • Indices
            • Parameters
            • Example
          • P_UE_CBFC_VC_TYPE
          • P_UE_CBFC_VC
          • P_UE_CBFC_APPLY
          • Manual and Automatic Configuration
          • Staged and Active Configuration Model
          • Staged and Active Configuration Storages
          • Configuration Storage Indexing
          • Configuration Data Model
          • VC Configuration Principles
        • CBFC Error Injection
        • CBFC Statistics
        • Streams-to-CBFC VC Mapping
      • 3.6.4. Link Negotiation
    • 3.7. Layer-1 Event Logging
    • 3.8. Solution Track (ST)
    • 3.9. Legacy
    • 3.10. Special
  • 4. Glossary of Terms
XOA CLI Documentation
  • 3. Command Reference
  • 3.6. Ultra Ethernet (UE)
  • 3.6.3. Credit-Based Flow Control (CBFC)
  • CBFC Virtual Channels Configuration
  • P_UE_CBFC_LINK

P_UE_CBFC_LINK

code: 1039

# set
<module-index>/<port-index> P_UE_CBFC_LINK [<storage_index>] <credit_size> <method> <total_cl> <pkt_ovhd>


# get
<module-index>/<port-index> P_UE_CBFC_LINK [<storage_index>] ?

Description

CBFC link configuration for lossless VCs, including Credit Size, Credit Limit Method, Total Credit Limit, and Packet Overhead.

The configuration is applied to all lossless VCs on the port, and ignored by the best-effort VCs.

Actions

set, get

Indices

  1. storage_index: integer, unsigned 32-bit integer. The index of the configuration data storage to access. See Configuration Storage Indexing for details.

Important

Only storage_index values of 0 and 1 are allowed for the set action. If you try to set with storage_index > 1, you will receive an response with a bad status code.

Parameters

  1. credit_size: integer, unsigned 32-bit integer. Credit Size configuration. Credit Size is the number of bytes represented by each credit.

  • Allowed values: Basic [32, 64, 128, 256, 512, 1024, 2048]. Additional [40, 48, 56, 80, 96, 112, 160, 192, 224, 320, 384, 448, 640, 768, 896, 1280, 1536, and 1792].

  • Default value: 64 bytes.

  1. method: byte, Credit limit method..

  • Allowed values:

    • NONE = 0: (Only used by XM3 to handle unknown scenarios)

    • TOTAL = 1: Total Credit Limit method.

    • PER_VC = 2: Per-VC Credit Limit method.

  • Default value: TOTAL

  1. total_cl: integer, unsigned 32-bit integer. The total credit limit. Must be a positive value.

  • Default value: 2^19-1.

  • Allowed range: 0 to 2^19-1 with granularity of 1.

  • Resolution: 1.

  1. pkt_ovhd: integer, signed 32-bit integer. The number of bytes required on a per-packet basis as overhead in the receiver’s input buffer. The total number of bytes required at the receiver’s buffer for a single packet equals <pkt_ovhd> + (frame size in bytes) rounded up to the credit size. This total size is used to determine the number of credits required to transmit a packet.

  • Default value: 0 bytes.

  • Allowed range: -16 to 12 bytes.

  • Resolution: 1 byte.

Note

Why is <pkt_ovhd> a signed integer?

If a part of each packet is not stored in the receiver’s input buffer, for example, the CRC may be stripped before storing, then <pkt_ovhd> may be a negative value.

Example

# set
input:  0/1 P_UE_CBFC_LINK [0] 256 TOTAL 8192 0
output: <OK>

# get
input:  0/1 P_UE_CBFC_LINK [0] ?
output: 0/1 P_UE_CBFC_LINK [0] 256 TOTAL 8192 0
Previous Next

© Copyright 2026, Teledyne LeCroy.