r/Reference-Documentation/bypass_info_example.c-Source-File

/*
 *
 * Copyright 2023 Napatech A/S. All Rights Reserved.
 *
 * 1. Copying, modification, and distribution of this file, or executable
 * versions of this file, is governed by the terms of the Napatech Software
 * license agreement under which this file was made available. If you do not
 * agree to the terms of the license do not install, copy, access or
 * otherwise use this file.
 *
 * 2. Under the Napatech Software license agreement you are granted a
 * limited, non-exclusive, non-assignable, copyright license to copy, modify
 * and distribute this file in conjunction with Napatech SmartNIC's and
 * similar hardware manufactured or supplied by Napatech A/S.
 *
 * 3. The full Napatech Software license agreement is included in this
 * distribution, please see "NP-0405 Napatech Software license
 * agreement.pdf"
 *
 * 4. Redistributions of source code must retain this copyright notice,
 * list of conditions and the following disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTIES, EXPRESS OR
 * IMPLIED, AND NAPATECH DISCLAIMS ALL IMPLIED WARRANTIES INCLUDING ANY
 * IMPLIED WARRANTY OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, OR OF
 * FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY
 * APPLICABLE LAW, IN NO EVENT SHALL NAPATECH BE LIABLE FOR PERSONAL INJURY,
 * OR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER,
 * INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, CORRUPTION OR
 * LOSS OF DATA, FAILURE TO TRANSMIT OR RECEIVE ANY DATA OR INFORMATION,
 * BUSINESS INTERRUPTION OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES, ARISING
 * OUT OF OR RELATED TO YOUR USE OR INABILITY TO USE NAPATECH SOFTWARE OR
 * SERVICES OR ANY THIRD PARTY SOFTWARE OR APPLICATIONS IN CONJUNCTION WITH
 * THE NAPATECH SOFTWARE OR SERVICES, HOWEVER CAUSED, REGARDLESS OF THE THEORY
 * OF LIABILITY (CONTRACT, TORT OR OTHERWISE) AND EVEN IF NAPATECH HAS BEEN
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW
 * THE EXCLUSION OR LIMITATION OF LIABILITY FOR PERSONAL INJURY, OR OF
 * INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY TO YOU.
 *
 *

 */
/**
 * @example bypass/info/bypass_info_example.c
 * @section bypass_info_example_description Description
 *
 * This source file is an example of how to retrieve bypass port information using the @ref InfoStream
 * "Info stream" interface in NTAPI.
 * *
 * The following NTAPI functions are used:
 * - @ref NT_Init()
 * - @ref NT_InfoOpen()
 * - @ref NT_InfoRead()
 * - @ref NT_InfoClose()
 * - @ref NT_Done()
 * - @ref NT_ExplainError()
 *
 * <hr>
 * @section bypass_info_example_prerequisites Prerequisites
 * A working system is needed with a Napatech accelerator - a Napatech bypass accelerator is preferred.
 *
 * @section bypass_info_example_flow Program flow
 * @{
 * The following is required to perform read operations on
 * the @ref InfoStream "Info stream":
 *
 * - \#include/nt.h - Applications/Tools only need to include @ref
 *   nt.h to obtain prototypes, macros etc. from NTAPI.
 * - @ref NT_Init(@ref NTAPI_VERSION) - Initialize the NTAPI
 *   library. @ref NTAPI_VERSION is a define that describes the version
 *   of the API described in the header files included by @ref
 *   nt.h. NT_Init() will ask the NTAPI library to convert return data
 *   to the @ref NTAPI_VERSION if possible. This will ensure that
 *   applications can run on NTAPI libraries of newer versions.
 *
 * - @ref NT_InfoOpen() - Open an info stream.
 * - @ref NT_InfoRead() - Read info stream.
 * - @ref NT_InfoClose() - Close the stream when terminating.
 * - @ref NT_Done() - Close down the NTAPI library.
 * - @ref NT_ExplainError() - Explain an error code returned by NTAPI functions.
 *
 *<hr>
 * @}
 */

// Include this in order to access the Napatech API
#include <nt.h>

#if defined(__linux__) || defined(__FreeBSD__)
  #include <unistd.h>
#endif

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>


//
// main()
//
int main(void)
{
  NtError_t status;
  char errBuf[NT_ERRBUF_SIZE];
  //
  NtInfoStream_t hInfo;
  //
  NtInfo_t infoSystem;
  NtInfo_t infoAdapter;
  NtInfo_t infoPort;
  //
  unsigned int adapter;
  unsigned int port;
  //
  const char* aBpWdt[]   = {"Inactive", "Active"};
  const char* aBpFlags[] = {"Off", "On"};
  const char* aBpState[] = {"Unknown", "Normal", "Bypass"};
  //
  //
  //

  // Initialize NTAPI library
  if ((status = NT_Init(NTAPI_VERSION)) != NT_SUCCESS) {
    NT_ExplainError(status, errBuf, sizeof(errBuf));
    fprintf(stderr, "ERROR: NT_Init failed. Code 0x%x = %s\n", status, errBuf);
    return status;
  }

  // Open the information stream
  if ((status = NT_InfoOpen(&hInfo, "bypass_info_example")) != NT_SUCCESS) {
    NT_ExplainError(status, errBuf, sizeof(errBuf));
    fprintf(stderr, ">>> Error: NT_InfoOpen failed. Code 0x%x = %s\n", status, errBuf);
    return status;
  }

  // Read system information
  infoSystem.cmd = NT_INFO_CMD_READ_SYSTEM;
  if ((status = NT_InfoRead(hInfo, &infoSystem)) != NT_SUCCESS) {
    NT_ExplainError(status, errBuf, sizeof(errBuf));
    fprintf(stderr, "ERROR: NT_InfoRead failed. Code 0x%x = %s\n", status, errBuf);
    return status;
  }

  printf("System: %d.%d.%d.%d\n\n", infoSystem.u.system.data.version.major,
                                  infoSystem.u.system.data.version.minor,
                                  infoSystem.u.system.data.version.patch,
                                  infoSystem.u.system.data.version.tag);
  printf("Adapters: %u\n", infoSystem.u.system.data.numAdapters);
  printf("Ports: %u\n", infoSystem.u.system.data.numPorts);
  printf("\n");

  for (adapter = 0; adapter < infoSystem.u.system.data.numAdapters; adapter++) {
    infoAdapter.cmd = NT_INFO_CMD_READ_ADAPTER_V6;
    infoAdapter.u.adapter_v6.adapterNo = (uint8_t)adapter;
    if ((status = NT_InfoRead(hInfo, &infoAdapter)) != 0) {
      NT_ExplainError(status, errBuf, sizeof(errBuf));
      fprintf(stderr, "ERROR: NT_InfoRead failed. Code 0x%x = %s\n", status, errBuf);
      return status;
    }
    printf("Adapter %u (%u ports):\n", infoAdapter.u.adapter_v6.adapterNo, infoAdapter.u.adapter_v6.data.numPorts);

    for (port = 0; port < infoAdapter.u.adapter_v6.data.numPorts; port++) {
      infoPort.cmd = NT_INFO_CMD_READ_PORT_V9;
      infoPort.u.port_v9.portNo = (uint8_t)(infoAdapter.u.adapter_v6.data.portOffset + port);
      if ((status = NT_InfoRead(hInfo, &infoPort)) != 0) {
        NT_ExplainError(status, errBuf, sizeof(errBuf));
        fprintf(stderr, "ERROR: NT_InfoRead failed. Code 0x%x = %s\n", status, errBuf);
        return status;
      }

      printf("Port %u (adapter #%u port #%u):\n", infoPort.u.port_v9.portNo, infoPort.u.port_v9.data.adapterNo, port);

      if ( infoPort.u.port_v9.data.capabilities.featureMask & NT_PORT_FEATURE_BYPASS) {
        printf("  Bypass port feature is present\n");
        if ((status = NT_InfoRead(hInfo, &infoPort)) != 0) {
          NT_ExplainError(status, errBuf, sizeof(errBuf));
          fprintf(stderr, ">>> Error: NT_InfoRead failed. Code 0x%x = %s\n", status, errBuf);
          return status;
        }

        printf("  Bypass port belongs to adapter #%u portset #%u\n", infoPort.u.port_v9.data.adapterNo, infoPort.u.port_v9.data.bypass.bypassPortsetNo);
        printf("  Bypass port is currently in %s state\n", aBpState[infoPort.u.port_v9.data.bypass.currentBypassPortState]);
        printf("  Bypass port watchdog is %s\n", aBpWdt[(infoPort.u.port_v9.data.bypass.bypassPortWatchdogTimeout==0?0:1)]);
        printf("  Bypass port onPowerFail detect trigger is %s\n", aBpFlags[((infoPort.u.port_v9.data.bypass.bypassTriggerModes & NT_BYPASS_TRIGGER_PWRFAIL)==0?0:1)]);
      }
      printf("\n");
    }
    printf("\n");
  }

  printf("\n");

  // Close down the NTAPI library
  NT_Done();

  return 0;
}

//
// EOF
//