common.h File Reference

#include <stdbool.h>
#include <doca_buf.h>
#include <doca_buf_inventory.h>
#include <doca_dev.h>
#include <doca_error.h>
#include <doca_mmap.h>

Include dependency graph for common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	program_core_objects

Typedefs
typedef doca_error_t(*	tasks_check) (struct doca_devinfo *)

Functions
doca_error_t	open_doca_device_with_pci (const char *pci_addr, tasks_check func, struct doca_dev **retval)
doca_error_t	open_doca_device_with_ibdev_name (const uint8_t *value, size_t val_size, tasks_check func, struct doca_dev **retval)
doca_error_t	open_doca_device_with_iface_name (const uint8_t *value, size_t val_size, tasks_check func, struct doca_dev **retval)
doca_error_t	open_doca_device_with_capabilities (tasks_check func, struct doca_dev **retval)
doca_error_t	open_doca_device_rep_with_vuid (struct doca_dev *local, enum doca_devinfo_rep_filter filter, const uint8_t *value, size_t val_size, struct doca_dev_rep **retval)
doca_error_t	open_doca_device_rep_with_pci (struct doca_dev *local, enum doca_devinfo_rep_filter filter, const char *pci_addr, struct doca_dev_rep **retval)
doca_error_t	create_core_objects (struct program_core_objects *state, uint32_t max_bufs)
doca_error_t	request_stop_ctx (struct doca_pe *pe, struct doca_ctx *ctx)
doca_error_t	destroy_core_objects (struct program_core_objects *state)
char *	hex_dump (const void *data, size_t size)
uint64_t	align_up_uint64 (uint64_t value, uint64_t alignment)
uint64_t	align_down_uint64 (uint64_t value, uint64_t alignment)
doca_error_t	allocat_doca_buf_list (struct doca_buf_inventory *buf_inv, struct doca_mmap *mmap, void *buf_addr, size_t buf_len, int num_buf, bool set_data_pos, struct doca_buf **dbuf)

Typedef Documentation

tasks_check

typedef doca_error_t(* tasks_check) (struct doca_devinfo *)

Definition at line 42 of file common.h.

Function Documentation

align_down_uint64()

uint64_t align_down_uint64	(	uint64_t	value,
		uint64_t	alignment
	)

This method aligns a uint64 value down

@value [in]: value to align down @alignment [in]: alignment value

Returns

: aligned value

Definition at line 522 of file common.c.

align_up_uint64()

uint64_t align_up_uint64	(	uint64_t	value,
		uint64_t	alignment
	)

This method aligns a uint64 value up

@value [in]: value to align up @alignment [in]: alignment value

Returns

: aligned value

Definition at line 512 of file common.c.

allocat_doca_buf_list()

doca_error_t allocat_doca_buf_list	(	struct doca_buf_inventory *	buf_inv,
		struct doca_mmap *	mmap,
		void *	buf_addr,
		size_t	buf_len,
		int	num_buf,
		bool	set_data_pos,
		struct doca_buf **	dbuf
	)

Definition at line 527 of file common.c.

create_core_objects()

doca_error_t create_core_objects	(	struct program_core_objects *	state,
		uint32_t	max_bufs
	)

Definition at line 302 of file common.c.

destroy_core_objects()

doca_error_t destroy_core_objects

(

struct program_core_objects *

state

)

Definition at line 392 of file common.c.

hex_dump()

char* hex_dump	(	const void *	data,
		size_t	size
	)

Definition at line 356 of file nvme_pci_common.c.

open_doca_device_rep_with_pci()

doca_error_t open_doca_device_rep_with_pci	(	struct doca_dev *	local,
		enum doca_devinfo_rep_filter	filter,
		const char *	pci_addr,
		struct doca_dev_rep **	retval
	)

Definition at line 267 of file common.c.

open_doca_device_rep_with_vuid()

doca_error_t open_doca_device_rep_with_vuid	(	struct doca_dev *	local,
		enum doca_devinfo_rep_filter	filter,
		const uint8_t *	value,
		size_t	val_size,
		struct doca_dev_rep **	retval
	)

Definition at line 222 of file common.c.

open_doca_device_with_capabilities()

doca_error_t open_doca_device_with_capabilities	(	tasks_check	func,
		struct doca_dev **	retval
	)

Definition at line 188 of file common.c.

open_doca_device_with_ibdev_name()

doca_error_t open_doca_device_with_ibdev_name	(	const uint8_t *	value,
		size_t	val_size,
		tasks_check	func,
		struct doca_dev **	retval
	)

Definition at line 84 of file common.c.

open_doca_device_with_iface_name()

doca_error_t open_doca_device_with_iface_name	(	const uint8_t *	value,
		size_t	val_size,
		tasks_check	func,
		struct doca_dev **	retval
	)

Definition at line 136 of file common.c.

open_doca_device_with_pci()

doca_error_t open_doca_device_with_pci	(	const char *	pci_addr,
		tasks_check	func,
		struct doca_dev **	retval
	)

Definition at line 43 of file common.c.

request_stop_ctx()

doca_error_t request_stop_ctx	(	struct doca_pe *	pe,
		struct doca_ctx *	ctx
	)

Definition at line 367 of file common.c.