DPDK  18.11.11
rte_rawdev_pmd.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2017 NXP
3  */
4 
5 #ifndef _RTE_RAWDEV_PMD_H_
6 #define _RTE_RAWDEV_PMD_H_
7 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <string.h>
21 
22 #include <rte_dev.h>
23 #include <rte_malloc.h>
24 #include <rte_log.h>
25 #include <rte_common.h>
26 
27 #include "rte_rawdev.h"
28 
29 extern int librawdev_logtype;
30 
31 /* Logging Macros */
32 #define RTE_RDEV_LOG(level, fmt, args...) \
33  rte_log(RTE_LOG_ ## level, librawdev_logtype, "%s(): " fmt "\n", \
34  __func__, ##args)
35 
36 #define RTE_RDEV_ERR(fmt, args...) \
37  RTE_RDEV_LOG(ERR, fmt, ## args)
38 #define RTE_RDEV_DEBUG(fmt, args...) \
39  RTE_RDEV_LOG(DEBUG, fmt, ## args)
40 #define RTE_RDEV_INFO(fmt, args...) \
41  RTE_RDEV_LOG(INFO, fmt, ## args)
42 
43 
44 /* Macros to check for valid device */
45 #define RTE_RAWDEV_VALID_DEVID_OR_ERR_RET(dev_id, retval) do { \
46  if (!rte_rawdev_pmd_is_valid_dev((dev_id))) { \
47  RTE_RDEV_ERR("Invalid dev_id=%d", dev_id); \
48  return retval; \
49  } \
50 } while (0)
51 
52 #define RTE_RAWDEV_VALID_DEVID_OR_RET(dev_id) do { \
53  if (!rte_rawdev_pmd_is_valid_dev((dev_id))) { \
54  RTE_RDEV_ERR("Invalid dev_id=%d", dev_id); \
55  return; \
56  } \
57 } while (0)
58 
59 #define RTE_RAWDEV_DETACHED (0)
60 #define RTE_RAWDEV_ATTACHED (1)
61 
62 /* Global structure used for maintaining state of allocated raw devices.
63  *
64  * TODO: Can be expanded to <type of raw device>:<count> in future.
65  * Applications should be able to select from a number of type of raw
66  * devices which were detected or attached to this DPDK instance.
67  */
68 struct rte_rawdev_global {
70  uint16_t nb_devs;
71 };
72 
73 extern struct rte_rawdev *rte_rawdevs;
85 static inline struct rte_rawdev *
87 {
88  struct rte_rawdev *dev;
89  unsigned int i;
90 
91  if (name == NULL)
92  return NULL;
93 
94  for (i = 0; i < RTE_RAWDEV_MAX_DEVS; i++) {
95  dev = &rte_rawdevs[i];
96  if ((dev->attached == RTE_RAWDEV_ATTACHED) &&
97  (strcmp(dev->name, name) == 0))
98  return dev;
99  }
100 
101  return NULL;
102 }
103 
113 static inline unsigned
115 {
116  struct rte_rawdev *dev;
117 
118  if (dev_id >= RTE_RAWDEV_MAX_DEVS)
119  return 0;
120 
121  dev = &rte_rawdevs[dev_id];
122  if (dev->attached != RTE_RAWDEV_ATTACHED)
123  return 0;
124  else
125  return 1;
126 }
127 
145 typedef void (*rawdev_info_get_t)(struct rte_rawdev *dev,
146  rte_rawdev_obj_t dev_info);
147 
159 typedef int (*rawdev_configure_t)(const struct rte_rawdev *dev,
160  rte_rawdev_obj_t config);
161 
171 typedef int (*rawdev_start_t)(struct rte_rawdev *dev);
172 
179 typedef void (*rawdev_stop_t)(struct rte_rawdev *dev);
180 
191 typedef int (*rawdev_close_t)(struct rte_rawdev *dev);
192 
202 typedef int (*rawdev_reset_t)(struct rte_rawdev *dev);
203 
215 typedef void (*rawdev_queue_conf_get_t)(struct rte_rawdev *dev,
216  uint16_t queue_id,
217  rte_rawdev_obj_t queue_conf);
218 
232 typedef int (*rawdev_queue_setup_t)(struct rte_rawdev *dev,
233  uint16_t queue_id,
234  rte_rawdev_obj_t queue_conf);
235 
245 typedef int (*rawdev_queue_release_t)(struct rte_rawdev *dev,
246  uint16_t queue_id);
247 
264 typedef uint16_t (*rawdev_queue_count_t)(struct rte_rawdev *dev);
265 
288 typedef int (*rawdev_enqueue_bufs_t)(struct rte_rawdev *dev,
289  struct rte_rawdev_buf **buffers,
290  unsigned int count,
291  rte_rawdev_obj_t context);
292 
313 typedef int (*rawdev_dequeue_bufs_t)(struct rte_rawdev *dev,
314  struct rte_rawdev_buf **buffers,
315  unsigned int count,
316  rte_rawdev_obj_t context);
317 
330 typedef int (*rawdev_dump_t)(struct rte_rawdev *dev, FILE *f);
331 
347 typedef int (*rawdev_get_attr_t)(struct rte_rawdev *dev,
348  const char *attr_name,
349  uint64_t *attr_value);
350 
365 typedef int (*rawdev_set_attr_t)(struct rte_rawdev *dev,
366  const char *attr_name,
367  const uint64_t attr_value);
368 
385 typedef int (*rawdev_xstats_get_t)(const struct rte_rawdev *dev,
386  const unsigned int ids[], uint64_t values[], unsigned int n);
387 
391 typedef int (*rawdev_xstats_reset_t)(struct rte_rawdev *dev,
392  const uint32_t ids[],
393  uint32_t nb_ids);
394 
410 typedef int (*rawdev_xstats_get_names_t)(const struct rte_rawdev *dev,
411  struct rte_rawdev_xstats_name *xstats_names,
412  unsigned int size);
413 
429 typedef uint64_t (*rawdev_xstats_get_by_name_t)(const struct rte_rawdev *dev,
430  const char *name,
431  unsigned int *id);
432 
445 typedef int (*rawdev_firmware_status_get_t)(struct rte_rawdev *dev,
446  rte_rawdev_obj_t status_info);
447 
459 typedef int (*rawdev_firmware_version_get_t)(struct rte_rawdev *dev,
460  rte_rawdev_obj_t version_info);
461 
476 typedef int (*rawdev_firmware_load_t)(struct rte_rawdev *dev,
477  rte_rawdev_obj_t firmware_buf);
478 
491 typedef int (*rawdev_firmware_unload_t)(struct rte_rawdev *dev);
492 
499 typedef int (*rawdev_selftest_t)(void);
500 
515 
524 
530 
531  /* Dump internal information */
533 
538 
547 
556 
558  rawdev_selftest_t dev_selftest;
559 };
560 
574 struct rte_rawdev *
575 rte_rawdev_pmd_allocate(const char *name, size_t dev_private_size,
576  int socket_id);
577 
586 int
587 rte_rawdev_pmd_release(struct rte_rawdev *rawdev);
588 
603 struct rte_rawdev *
604 rte_rawdev_pmd_init(const char *name, size_t dev_private_size,
605  int socket_id);
606 
615 int
616 rte_rawdev_pmd_uninit(const char *name);
617 
618 #ifdef __cplusplus
619 }
620 #endif
621 
622 #endif /* _RTE_RAWDEV_PMD_H_ */
int(* rawdev_xstats_get_t)(const struct rte_rawdev *dev, const unsigned int ids[], uint64_t values[], unsigned int n)
rawdev_reset_t dev_reset
int(* rawdev_set_attr_t)(struct rte_rawdev *dev, const char *attr_name, const uint64_t attr_value)
rawdev_dequeue_bufs_t dequeue_bufs
rawdev_xstats_get_t xstats_get
int(* rawdev_get_attr_t)(struct rte_rawdev *dev, const char *attr_name, uint64_t *attr_value)
int(* rawdev_start_t)(struct rte_rawdev *dev)
int(* rawdev_configure_t)(const struct rte_rawdev *dev, rte_rawdev_obj_t config)
rawdev_info_get_t dev_info_get
static unsigned rte_rawdev_pmd_is_valid_dev(uint8_t dev_id)
void(* rawdev_info_get_t)(struct rte_rawdev *dev, rte_rawdev_obj_t dev_info)
int rte_rawdev_pmd_uninit(const char *name)
int(* rawdev_xstats_reset_t)(struct rte_rawdev *dev, const uint32_t ids[], uint32_t nb_ids)
int rte_rawdev_pmd_release(struct rte_rawdev *rawdev)
int(* rawdev_firmware_version_get_t)(struct rte_rawdev *dev, rte_rawdev_obj_t version_info)
struct rte_rawdev * rte_rawdev_pmd_allocate(const char *name, size_t dev_private_size, int socket_id)
rawdev_firmware_version_get_t firmware_version_get
int(* rawdev_selftest_t)(void)
rawdev_xstats_reset_t xstats_reset
int(* rawdev_queue_release_t)(struct rte_rawdev *dev, uint16_t queue_id)
rawdev_queue_conf_get_t queue_def_conf
int(* rawdev_firmware_load_t)(struct rte_rawdev *dev, rte_rawdev_obj_t firmware_buf)
rawdev_configure_t dev_configure
int(* rawdev_dequeue_bufs_t)(struct rte_rawdev *dev, struct rte_rawdev_buf **buffers, unsigned int count, rte_rawdev_obj_t context)
rawdev_start_t dev_start
rawdev_queue_count_t queue_count
int(* rawdev_firmware_unload_t)(struct rte_rawdev *dev)
int(* rawdev_queue_setup_t)(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf)
uint16_t(* rawdev_queue_count_t)(struct rte_rawdev *dev)
struct rte_rawdev * rte_rawdev_pmd_init(const char *name, size_t dev_private_size, int socket_id)
int(* rawdev_close_t)(struct rte_rawdev *dev)
rawdev_xstats_get_by_name_t xstats_get_by_name
rawdev_firmware_load_t firmware_load
int(* rawdev_xstats_get_names_t)(const struct rte_rawdev *dev, struct rte_rawdev_xstats_name *xstats_names, unsigned int size)
uint64_t(* rawdev_xstats_get_by_name_t)(const struct rte_rawdev *dev, const char *name, unsigned int *id)
rawdev_set_attr_t attr_set
rawdev_queue_release_t queue_release
void(* rawdev_stop_t)(struct rte_rawdev *dev)
rawdev_queue_setup_t queue_setup
rawdev_xstats_get_names_t xstats_get_names
rawdev_get_attr_t attr_get
int(* rawdev_reset_t)(struct rte_rawdev *dev)
rawdev_firmware_status_get_t firmware_status_get
rawdev_enqueue_bufs_t enqueue_bufs
int(* rawdev_firmware_status_get_t)(struct rte_rawdev *dev, rte_rawdev_obj_t status_info)
static struct rte_rawdev * rte_rawdev_pmd_get_named_dev(const char *name)
rawdev_close_t dev_close
void(* rawdev_queue_conf_get_t)(struct rte_rawdev *dev, uint16_t queue_id, rte_rawdev_obj_t queue_conf)
rawdev_stop_t dev_stop
int(* rawdev_enqueue_bufs_t)(struct rte_rawdev *dev, struct rte_rawdev_buf **buffers, unsigned int count, rte_rawdev_obj_t context)
int(* rawdev_dump_t)(struct rte_rawdev *dev, FILE *f)
rawdev_dump_t dump
rawdev_firmware_unload_t firmware_unload