api/spec/dma_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2021-2023 Nokia
 */
 
#ifndef ODP_API_SPEC_DMA_TYPES_H_
#define ODP_API_SPEC_DMA_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/event_types.h>
#include <odp/api/packet_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct odp_dma_pool_capability_t {
    uint32_t max_pools;
 
    uint32_t max_num;
 
    uint32_t max_uarea_size;
 
    odp_bool_t uarea_persistence;
 
    uint32_t min_cache_size;
 
    uint32_t max_cache_size;
 
} odp_dma_pool_capability_t;
 
typedef struct odp_dma_pool_param_t {
    uint32_t num;
 
    uint32_t uarea_size;
 
    struct {
        void (*init_fn)(void *uarea, uint32_t size, void *args, uint32_t index);
 
        void *args;
 
    } uarea_init;
 
    uint32_t cache_size;
 
} odp_dma_pool_param_t;
 
#ifdef __cplusplus
}
#endif
 
/* Includes pool_types.h, which depends on odp_dma_pool_param_t. */
#include <odp/api/pool_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uint32_t odp_dma_direction_t;
 
#define ODP_DMA_MAIN_TO_MAIN 0x1u
 
typedef uint32_t odp_dma_transfer_type_t;
 
#define ODP_DMA_TYPE_COPY 0x1u
 
typedef uint32_t odp_dma_compl_mode_t;
 
#define ODP_DMA_COMPL_NONE  0x1u
 
#define ODP_DMA_COMPL_SYNC  0x2u
 
#define ODP_DMA_COMPL_EVENT 0x4u
 
#define ODP_DMA_COMPL_POLL  0x8u
 
typedef enum {
    ODP_DMA_FORMAT_ADDR = 0,
 
    ODP_DMA_FORMAT_PACKET
 
} odp_dma_data_format_t;
 
typedef enum {
    ODP_DMA_ORDER_NONE = 0,
 
    ODP_DMA_ORDER_COMPL,
 
    ODP_DMA_ORDER_ALL
 
} odp_dma_transfer_order_t;
 
typedef enum {
    ODP_DMA_MT_SAFE = 0,
 
    ODP_DMA_MT_SERIAL
 
} odp_dma_mt_mode_t;
 
typedef struct odp_dma_capability_t {
    uint32_t max_sessions;
 
    uint32_t max_transfers;
 
    uint32_t max_src_segs;
 
    uint32_t max_dst_segs;
 
    uint32_t max_segs;
 
    uint32_t max_seg_len;
 
    odp_dma_compl_mode_t compl_mode_mask;
 
    odp_bool_t queue_type_sched;
 
    odp_bool_t queue_type_plain;
 
    odp_bool_t src_seg_free;
 
    odp_bool_t dst_seg_alloc;
 
    odp_dma_pool_capability_t pool;
 
} odp_dma_capability_t;
 
typedef struct odp_dma_param_t {
    odp_dma_direction_t direction;
 
    odp_dma_transfer_type_t type;
 
    odp_dma_compl_mode_t compl_mode_mask;
 
    odp_dma_mt_mode_t mt_mode;
 
    odp_dma_transfer_order_t order;
 
} odp_dma_param_t;
 
typedef struct odp_dma_seg_t {
    union {
        void *addr;
 
        odp_packet_t packet;
 
        struct {
            uint32_t pkt_index;
 
            uint32_t pkt_len;
        };
    };
 
    uint32_t len;
 
    uint32_t offset;
 
    struct {
        union {
            struct {
                uint16_t full_lines : 1;
 
                uint16_t cache_stash_l3 : 1;
            } bit;
 
            uint16_t all_bits;
        };
 
        struct {
            struct {
                uint32_t offset;
 
                uint32_t len;
            } l3;
        } cache_stash;
    } hints;
 
} odp_dma_seg_t;
 
typedef struct odp_dma_transfer_param_t {
    odp_dma_data_format_t src_format;
 
    odp_dma_data_format_t dst_format;
 
    uint32_t num_src;
 
    uint32_t num_dst;
 
    odp_dma_seg_t *src_seg;
 
    odp_dma_seg_t *dst_seg;
 
    odp_pool_t dst_seg_pool;
 
    union {
        struct {
            uint16_t seg_free : 1;
 
            uint16_t unique_src_segs : 1;
 
            uint16_t single_pool : 1;
 
            uint16_t seg_alloc : 1;
 
            uint16_t unique_dst_segs : 1;
        } opts;
 
        uint16_t all_opts;
    };
 
} odp_dma_transfer_param_t;
 
typedef struct odp_dma_compl_param_t {
    odp_dma_compl_mode_t compl_mode;
 
    odp_dma_transfer_id_t transfer_id;
 
    odp_event_t event;
 
    odp_queue_t queue;
 
    void *user_ptr;
 
} odp_dma_compl_param_t;
 
typedef struct odp_dma_result_t {
    odp_bool_t success;
 
    void *user_ptr;
 
    uint32_t num_dst;
 
    odp_packet_t *dst_pkt;
 
} odp_dma_result_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif