doca_types.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_TYPES_H_
#define DOCA_TYPES_H_
 
#include <stdint.h>
 
#ifdef __linux__
#include <linux/types.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef __linux__
typedef int doca_event_handle_t;
#define doca_event_invalid_handle -1               
#else                              /* Windows*/
typedef void *doca_event_handle_t; 
#define doca_event_invalid_handle INVALID_HANDLE_VALUE 
#endif
 
#define DOCA_GID_BYTE_LENGTH 16
 
typedef doca_event_handle_t doca_notification_handle_t; 
union doca_data {
    void *ptr;    
    uint64_t u64; 
};
 
struct doca_gather_list {
    void *addr;            
    uint64_t len;              
    struct doca_gather_list *next; 
};
 
enum doca_access_flag {
    DOCA_ACCESS_FLAG_LOCAL_READ_ONLY = 0,         /* Allows reading buffer by a local device but no write */
    DOCA_ACCESS_FLAG_LOCAL_READ_WRITE = (1 << 0),     /* Allows reading and writing to buffer by a local device */
    DOCA_ACCESS_FLAG_RDMA_READ = (1 << 1),        /* Allows reading buffer by a remote device using RDMA */
    DOCA_ACCESS_FLAG_RDMA_WRITE = (1 << 2),       /* Allows writing to buffer by a remote device using RDMA */
    DOCA_ACCESS_FLAG_RDMA_ATOMIC = (1 << 3),      /* Allows atomic operations by remote device using RDMA */
    DOCA_ACCESS_FLAG_PCI_READ_ONLY = (1 << 4),    
    DOCA_ACCESS_FLAG_PCI_READ_WRITE = (1 << 5),   
    DOCA_ACCESS_FLAG_PCI_RELAXED_ORDERING = (1 << 6), 
};
 
enum doca_pci_func_type {
    DOCA_PCI_FUNC_TYPE_PF = 0, /* physical function */
    DOCA_PCI_FUNC_TYPE_VF,     /* virtual function */
    DOCA_PCI_FUNC_TYPE_SF,     /* sub function */
};
 
#ifdef __linux__
typedef __be16 doca_be16_t; 
typedef __be32 doca_be32_t; 
typedef __be64 doca_be64_t; 
#else               /* Windows */
typedef uint16_t doca_be16_t;      
typedef uint32_t doca_be32_t;      
typedef uint64_t doca_be64_t;      
#endif
 
enum doca_gpu_mem_type {
    /* GPU memory not accessible from CPU. */
    DOCA_GPU_MEM_TYPE_GPU = 0,
    /* GPU memory with direct access from CPU. */
    DOCA_GPU_MEM_TYPE_GPU_CPU = 1,
    /* CPU memory with direct access from GPU. */
    DOCA_GPU_MEM_TYPE_CPU_GPU = 2,
};
 
enum doca_eth_wait_on_time_type {
    /* Wait on time not supported. */
    DOCA_ETH_WAIT_ON_TIME_TYPE_NONE = 0,
    /* Wait on time supported by HW. */
    DOCA_ETH_WAIT_ON_TIME_TYPE_NATIVE = 1,
    /* Wait on time supported by SW. */
    DOCA_ETH_WAIT_ON_TIME_TYPE_DPDK = 2,
};
 
enum doca_mtu_size {
    DOCA_MTU_SIZE_256_BYTES = 0x0,
    DOCA_MTU_SIZE_512_BYTES = 0x1,
    DOCA_MTU_SIZE_1K_BYTES = 0x2,
    DOCA_MTU_SIZE_2K_BYTES = 0x3,
    DOCA_MTU_SIZE_4K_BYTES = 0x4,
    DOCA_MTU_SIZE_RAW_ETHERNET = 0x5, /* Reserved */
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_TYPES_H_ */