1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2017 Intel Corporation 3 */ 4 5 #include <stdlib.h> 6 #include <string.h> 7 8 #include <rte_common.h> 9 #include <rte_bus_vdev.h> 10 #include <rte_malloc.h> 11 #include <rte_ring.h> 12 #include <rte_kvargs.h> 13 14 #include <rte_bbdev.h> 15 #include <rte_bbdev_pmd.h> 16 17 #define DRIVER_NAME baseband_null 18 19 RTE_LOG_REGISTER_DEFAULT(bbdev_null_logtype, NOTICE); 20 21 /* Helper macro for logging */ 22 #define rte_bbdev_log(level, fmt, ...) \ 23 rte_log(RTE_LOG_ ## level, bbdev_null_logtype, fmt "\n", ##__VA_ARGS__) 24 25 #define rte_bbdev_log_debug(fmt, ...) \ 26 rte_bbdev_log(DEBUG, RTE_STR(__LINE__) ":%s() " fmt, __func__, \ 27 ##__VA_ARGS__) 28 29 /* Initialisation params structure that can be used by null BBDEV driver */ 30 struct bbdev_null_params { 31 int socket_id; /*< Null BBDEV socket */ 32 uint16_t queues_num; /*< Null BBDEV queues number */ 33 }; 34 35 /* Acceptable params for null BBDEV devices */ 36 #define BBDEV_NULL_MAX_NB_QUEUES_ARG "max_nb_queues" 37 #define BBDEV_NULL_SOCKET_ID_ARG "socket_id" 38 39 static const char * const bbdev_null_valid_params[] = { 40 BBDEV_NULL_MAX_NB_QUEUES_ARG, 41 BBDEV_NULL_SOCKET_ID_ARG 42 }; 43 44 /* private data structure */ 45 struct bbdev_private { 46 unsigned int max_nb_queues; /**< Max number of queues */ 47 }; 48 49 /* queue */ 50 struct bbdev_queue { 51 struct rte_ring *processed_pkts; /* Ring for processed packets */ 52 } __rte_cache_aligned; 53 54 /* Get device info */ 55 static void 56 info_get(struct rte_bbdev *dev, struct rte_bbdev_driver_info *dev_info) 57 { 58 struct bbdev_private *internals = dev->data->dev_private; 59 60 static const struct rte_bbdev_op_cap bbdev_capabilities[] = { 61 RTE_BBDEV_END_OF_CAPABILITIES_LIST(), 62 }; 63 64 static struct rte_bbdev_queue_conf default_queue_conf = { 65 .queue_size = RTE_BBDEV_QUEUE_SIZE_LIMIT, 66 }; 67 68 default_queue_conf.socket = dev->data->socket_id; 69 70 dev_info->driver_name = RTE_STR(DRIVER_NAME); 71 dev_info->max_num_queues = internals->max_nb_queues; 72 dev_info->queue_size_lim = RTE_BBDEV_QUEUE_SIZE_LIMIT; 73 dev_info->hardware_accelerated = false; 74 dev_info->max_dl_queue_priority = 0; 75 dev_info->max_ul_queue_priority = 0; 76 dev_info->default_queue_conf = default_queue_conf; 77 dev_info->capabilities = bbdev_capabilities; 78 dev_info->cpu_flag_reqs = NULL; 79 dev_info->min_alignment = 0; 80 81 /* BBDEV null device does not process the data, so 82 * endianness setting is not relevant, but setting it 83 * here for code completeness. 84 */ 85 dev_info->data_endianness = RTE_LITTLE_ENDIAN; 86 87 rte_bbdev_log_debug("got device info from %u", dev->data->dev_id); 88 } 89 90 /* Release queue */ 91 static int 92 q_release(struct rte_bbdev *dev, uint16_t q_id) 93 { 94 struct bbdev_queue *q = dev->data->queues[q_id].queue_private; 95 96 if (q != NULL) { 97 rte_ring_free(q->processed_pkts); 98 rte_free(q); 99 dev->data->queues[q_id].queue_private = NULL; 100 } 101 102 rte_bbdev_log_debug("released device queue %u:%u", 103 dev->data->dev_id, q_id); 104 return 0; 105 } 106 107 /* Setup a queue */ 108 static int 109 q_setup(struct rte_bbdev *dev, uint16_t q_id, 110 const struct rte_bbdev_queue_conf *queue_conf) 111 { 112 struct bbdev_queue *q; 113 char ring_name[RTE_RING_NAMESIZE]; 114 snprintf(ring_name, RTE_RING_NAMESIZE, RTE_STR(DRIVER_NAME) "%u:%u", 115 dev->data->dev_id, q_id); 116 117 /* Allocate the queue data structure. */ 118 q = rte_zmalloc_socket(RTE_STR(DRIVER_NAME), sizeof(*q), 119 RTE_CACHE_LINE_SIZE, queue_conf->socket); 120 if (q == NULL) { 121 rte_bbdev_log(ERR, "Failed to allocate queue memory"); 122 return -ENOMEM; 123 } 124 125 q->processed_pkts = rte_ring_create(ring_name, queue_conf->queue_size, 126 queue_conf->socket, RING_F_SP_ENQ | RING_F_SC_DEQ); 127 if (q->processed_pkts == NULL) { 128 rte_bbdev_log(ERR, "Failed to create ring"); 129 goto free_q; 130 } 131 132 dev->data->queues[q_id].queue_private = q; 133 rte_bbdev_log_debug("setup device queue %s", ring_name); 134 return 0; 135 136 free_q: 137 rte_free(q); 138 return -EFAULT; 139 } 140 141 static const struct rte_bbdev_ops pmd_ops = { 142 .info_get = info_get, 143 .queue_setup = q_setup, 144 .queue_release = q_release 145 }; 146 147 /* Enqueue decode burst */ 148 static uint16_t 149 enqueue_dec_ops(struct rte_bbdev_queue_data *q_data, 150 struct rte_bbdev_dec_op **ops, uint16_t nb_ops) 151 { 152 struct bbdev_queue *q = q_data->queue_private; 153 uint16_t nb_enqueued = rte_ring_enqueue_burst(q->processed_pkts, 154 (void **)ops, nb_ops, NULL); 155 156 q_data->queue_stats.enqueue_err_count += nb_ops - nb_enqueued; 157 q_data->queue_stats.enqueued_count += nb_enqueued; 158 159 return nb_enqueued; 160 } 161 162 /* Enqueue encode burst */ 163 static uint16_t 164 enqueue_enc_ops(struct rte_bbdev_queue_data *q_data, 165 struct rte_bbdev_enc_op **ops, uint16_t nb_ops) 166 { 167 struct bbdev_queue *q = q_data->queue_private; 168 uint16_t nb_enqueued = rte_ring_enqueue_burst(q->processed_pkts, 169 (void **)ops, nb_ops, NULL); 170 171 q_data->queue_stats.enqueue_err_count += nb_ops - nb_enqueued; 172 q_data->queue_stats.enqueued_count += nb_enqueued; 173 174 return nb_enqueued; 175 } 176 177 /* Dequeue decode burst */ 178 static uint16_t 179 dequeue_dec_ops(struct rte_bbdev_queue_data *q_data, 180 struct rte_bbdev_dec_op **ops, uint16_t nb_ops) 181 { 182 struct bbdev_queue *q = q_data->queue_private; 183 uint16_t nb_dequeued = rte_ring_dequeue_burst(q->processed_pkts, 184 (void **)ops, nb_ops, NULL); 185 q_data->queue_stats.dequeued_count += nb_dequeued; 186 187 return nb_dequeued; 188 } 189 190 /* Dequeue encode burst */ 191 static uint16_t 192 dequeue_enc_ops(struct rte_bbdev_queue_data *q_data, 193 struct rte_bbdev_enc_op **ops, uint16_t nb_ops) 194 { 195 struct bbdev_queue *q = q_data->queue_private; 196 uint16_t nb_dequeued = rte_ring_dequeue_burst(q->processed_pkts, 197 (void **)ops, nb_ops, NULL); 198 q_data->queue_stats.dequeued_count += nb_dequeued; 199 200 return nb_dequeued; 201 } 202 203 /* Parse 16bit integer from string argument */ 204 static inline int 205 parse_u16_arg(const char *key, const char *value, void *extra_args) 206 { 207 uint16_t *u16 = extra_args; 208 unsigned int long result; 209 210 if ((value == NULL) || (extra_args == NULL)) 211 return -EINVAL; 212 errno = 0; 213 result = strtoul(value, NULL, 0); 214 if ((result >= (1 << 16)) || (errno != 0)) { 215 rte_bbdev_log(ERR, "Invalid value %lu for %s", result, key); 216 return -ERANGE; 217 } 218 *u16 = (uint16_t)result; 219 return 0; 220 } 221 222 /* Parse parameters used to create device */ 223 static int 224 parse_bbdev_null_params(struct bbdev_null_params *params, 225 const char *input_args) 226 { 227 struct rte_kvargs *kvlist = NULL; 228 int ret = 0; 229 230 if (params == NULL) 231 return -EINVAL; 232 if (input_args) { 233 kvlist = rte_kvargs_parse(input_args, bbdev_null_valid_params); 234 if (kvlist == NULL) 235 return -EFAULT; 236 237 ret = rte_kvargs_process(kvlist, bbdev_null_valid_params[0], 238 &parse_u16_arg, ¶ms->queues_num); 239 if (ret < 0) 240 goto exit; 241 242 ret = rte_kvargs_process(kvlist, bbdev_null_valid_params[1], 243 &parse_u16_arg, ¶ms->socket_id); 244 if (ret < 0) 245 goto exit; 246 247 if (params->socket_id >= RTE_MAX_NUMA_NODES) { 248 rte_bbdev_log(ERR, "Invalid socket, must be < %u", 249 RTE_MAX_NUMA_NODES); 250 goto exit; 251 } 252 } 253 254 exit: 255 rte_kvargs_free(kvlist); 256 return ret; 257 } 258 259 /* Create device */ 260 static int 261 null_bbdev_create(struct rte_vdev_device *vdev, 262 struct bbdev_null_params *init_params) 263 { 264 struct rte_bbdev *bbdev; 265 const char *name = rte_vdev_device_name(vdev); 266 267 bbdev = rte_bbdev_allocate(name); 268 if (bbdev == NULL) 269 return -ENODEV; 270 271 bbdev->data->dev_private = rte_zmalloc_socket(name, 272 sizeof(struct bbdev_private), RTE_CACHE_LINE_SIZE, 273 init_params->socket_id); 274 if (bbdev->data->dev_private == NULL) { 275 rte_bbdev_release(bbdev); 276 return -ENOMEM; 277 } 278 279 bbdev->dev_ops = &pmd_ops; 280 bbdev->device = &vdev->device; 281 bbdev->data->socket_id = init_params->socket_id; 282 bbdev->intr_handle = NULL; 283 284 /* register rx/tx burst functions for data path */ 285 bbdev->dequeue_enc_ops = dequeue_enc_ops; 286 bbdev->dequeue_dec_ops = dequeue_dec_ops; 287 bbdev->enqueue_enc_ops = enqueue_enc_ops; 288 bbdev->enqueue_dec_ops = enqueue_dec_ops; 289 ((struct bbdev_private *) bbdev->data->dev_private)->max_nb_queues = 290 init_params->queues_num; 291 292 return 0; 293 } 294 295 /* Initialise device */ 296 static int 297 null_bbdev_probe(struct rte_vdev_device *vdev) 298 { 299 struct bbdev_null_params init_params = { 300 rte_socket_id(), 301 RTE_BBDEV_DEFAULT_MAX_NB_QUEUES 302 }; 303 const char *name; 304 const char *input_args; 305 306 if (vdev == NULL) 307 return -EINVAL; 308 309 name = rte_vdev_device_name(vdev); 310 if (name == NULL) 311 return -EINVAL; 312 313 input_args = rte_vdev_device_args(vdev); 314 parse_bbdev_null_params(&init_params, input_args); 315 316 rte_bbdev_log_debug("Init %s on NUMA node %d with max queues: %d", 317 name, init_params.socket_id, init_params.queues_num); 318 319 return null_bbdev_create(vdev, &init_params); 320 } 321 322 /* Uninitialise device */ 323 static int 324 null_bbdev_remove(struct rte_vdev_device *vdev) 325 { 326 struct rte_bbdev *bbdev; 327 const char *name; 328 329 if (vdev == NULL) 330 return -EINVAL; 331 332 name = rte_vdev_device_name(vdev); 333 if (name == NULL) 334 return -EINVAL; 335 336 bbdev = rte_bbdev_get_named_dev(name); 337 if (bbdev == NULL) 338 return -EINVAL; 339 340 rte_free(bbdev->data->dev_private); 341 342 return rte_bbdev_release(bbdev); 343 } 344 345 static struct rte_vdev_driver bbdev_null_pmd_drv = { 346 .probe = null_bbdev_probe, 347 .remove = null_bbdev_remove 348 }; 349 350 RTE_PMD_REGISTER_VDEV(DRIVER_NAME, bbdev_null_pmd_drv); 351 RTE_PMD_REGISTER_PARAM_STRING(DRIVER_NAME, 352 BBDEV_NULL_MAX_NB_QUEUES_ARG"=<int> " 353 BBDEV_NULL_SOCKET_ID_ARG"=<int>"); 354 RTE_PMD_REGISTER_ALIAS(DRIVER_NAME, bbdev_null); 355