1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2020 Mellanox Technologies, Ltd
5 #ifndef RTE_PMD_MLX5_COMMON_OS_H_
6 #define RTE_PMD_MLX5_COMMON_OS_H_
10 #include "mlx5_autoconf.h"
11 #include "mlx5_glue.h"
12 #include "mlx5_malloc.h"
15 * This API allocates aligned or non-aligned memory. The free can be on either
16 * aligned or nonaligned memory. To be protected - even though there may be no
17 * alignment - in Windows this API will unconditioanlly call _aligned_malloc()
18 * with at least a minimal alignment size.
21 * The alignment value, which must be an integer power of 2 (or 0 for
24 * Size in bytes to allocate
27 * Valid pointer to allocated memory, NULL in case of failure
30 mlx5_os_malloc(size_t align, size_t size)
32 if (align < MLX5_MALLOC_ALIGNMENT)
33 align = MLX5_MALLOC_ALIGNMENT;
34 return _aligned_malloc(size, align);
38 * This API de-allocates a memory that originally could have been allocated
39 * aligned or non-aligned. In Windows since the allocation was with
40 * _aligned_malloc() - it is safe to always call _aligned_free().
43 * Pointer to address to free
47 mlx5_os_free(void *addr)
53 * Get fd. Given a pointer to DevX channel object of type
54 * 'struct mlx5dv_devx_event_channel*' - return its fd.
55 * Under Windows it is a stub.
58 * Pointer to channel object.
64 mlx5_os_get_devx_channel_fd(void *channel)
72 * Get device name. Given a device pointer - return a
73 * pointer to the corresponding device name.
79 * Pointer to device name if dev is valid, NULL otherwise.
81 static inline const char *
82 mlx5_os_get_dev_device_name(void *dev)
86 return ((struct devx_device *)dev)->name;
90 * Get device name. Given a context pointer - return a
91 * pointer to the corresponding device name.
97 * Pointer to device name if ctx is valid, NULL otherwise.
99 static inline const char *
100 mlx5_os_get_ctx_device_name(void *ctx)
104 return ((mlx5_context_st *)ctx)->mlx5_dev.name;
108 * Get a device path name. Given acontext pointer - return a
109 * pointer to the corresponding device path name.
112 * Pointer to context.
115 * Pointer to device path name if ctx is valid, NULL otherwise.
118 static inline const char *
119 mlx5_os_get_ctx_device_path(void *ctx)
123 return ((mlx5_context_st *)ctx)->mlx5_dev.dev_pnp_id;
127 * Get umem id. Given a pointer to umem object of type return its id.
130 * Pointer to umem object.
133 * The umem id if umem is valid, 0 otherwise.
135 static inline uint32_t
136 mlx5_os_get_umem_id(void *umem)
140 return ((struct mlx5_devx_umem *)umem)->umem_id;
143 void *mlx5_os_alloc_pd(void *ctx);
144 int mlx5_os_dealloc_pd(void *pd);
145 void *mlx5_os_umem_reg(void *ctx, void *addr, size_t size, uint32_t access);
146 int mlx5_os_umem_dereg(void *pumem);
147 #endif /* RTE_PMD_MLX5_COMMON_OS_H_ */