1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) 2015-2018 Atomic Rules LLC 3 */ 4 5 #include <unistd.h> 6 7 #include "ark_ethdev_rx.h" 8 #include "ark_global.h" 9 #include "ark_logs.h" 10 #include "ark_mpu.h" 11 #include "ark_udm.h" 12 13 #define ARK_RX_META_SIZE 32 14 #define ARK_RX_META_OFFSET (RTE_PKTMBUF_HEADROOM - ARK_RX_META_SIZE) 15 #define ARK_RX_MAX_NOCHAIN (RTE_MBUF_DEFAULT_DATAROOM) 16 17 /* Forward declarations */ 18 struct ark_rx_queue; 19 struct ark_rx_meta; 20 21 static void dump_mbuf_data(struct rte_mbuf *mbuf, uint16_t lo, uint16_t hi); 22 static void ark_ethdev_rx_dump(const char *name, struct ark_rx_queue *queue); 23 static uint32_t eth_ark_rx_jumbo(struct ark_rx_queue *queue, 24 struct ark_rx_meta *meta, 25 struct rte_mbuf *mbuf0, 26 uint32_t cons_index); 27 static inline int eth_ark_rx_seed_mbufs(struct ark_rx_queue *queue); 28 29 /* ************************************************************************* */ 30 struct ark_rx_queue { 31 /* array of mbufs to populate */ 32 struct rte_mbuf **reserve_q; 33 /* array of physical addresses of the mbuf data pointer */ 34 /* This point is a virtual address */ 35 rte_iova_t *paddress_q; 36 struct rte_mempool *mb_pool; 37 38 struct ark_udm_t *udm; 39 struct ark_mpu_t *mpu; 40 41 rx_user_meta_hook_fn rx_user_meta_hook; 42 void *ext_user_data; 43 44 uint32_t queue_size; 45 uint32_t queue_mask; 46 47 uint32_t seed_index; /* step 1 set with empty mbuf */ 48 uint32_t cons_index; /* step 3 consumed by driver */ 49 50 /* The queue Id is used to identify the HW Q */ 51 uint16_t phys_qid; 52 53 /* The queue Index is used within the dpdk device structures */ 54 uint16_t queue_index; 55 56 uint32_t unused; 57 58 /* next cache line - fields written by device */ 59 RTE_MARKER cacheline1 __rte_cache_min_aligned; 60 61 volatile uint32_t prod_index; /* step 2 filled by FPGA */ 62 } __rte_cache_aligned; 63 64 /* ************************************************************************* */ 65 static int 66 eth_ark_rx_hw_setup(struct rte_eth_dev *dev, 67 struct ark_rx_queue *queue, 68 uint16_t rx_queue_id __rte_unused, uint16_t rx_queue_idx) 69 { 70 rte_iova_t queue_base; 71 rte_iova_t phys_addr_q_base; 72 rte_iova_t phys_addr_prod_index; 73 74 queue_base = rte_malloc_virt2iova(queue); 75 phys_addr_prod_index = queue_base + 76 offsetof(struct ark_rx_queue, prod_index); 77 78 phys_addr_q_base = rte_malloc_virt2iova(queue->paddress_q); 79 80 /* Verify HW */ 81 if (ark_mpu_verify(queue->mpu, sizeof(rte_iova_t))) { 82 ARK_PMD_LOG(ERR, "Illegal configuration rx queue\n"); 83 return -1; 84 } 85 86 /* Stop and Reset and configure MPU */ 87 ark_mpu_configure(queue->mpu, phys_addr_q_base, queue->queue_size, 0); 88 89 ark_udm_write_addr(queue->udm, phys_addr_prod_index); 90 91 /* advance the valid pointer, but don't start until the queue starts */ 92 ark_mpu_reset_stats(queue->mpu); 93 94 /* The seed is the producer index for the HW */ 95 ark_mpu_set_producer(queue->mpu, queue->seed_index); 96 dev->data->rx_queue_state[rx_queue_idx] = RTE_ETH_QUEUE_STATE_STOPPED; 97 98 return 0; 99 } 100 101 static inline void 102 eth_ark_rx_update_cons_index(struct ark_rx_queue *queue, uint32_t cons_index) 103 { 104 queue->cons_index = cons_index; 105 if ((cons_index + queue->queue_size - queue->seed_index) >= 64U) { 106 eth_ark_rx_seed_mbufs(queue); 107 ark_mpu_set_producer(queue->mpu, queue->seed_index); 108 } 109 } 110 111 /* ************************************************************************* */ 112 int 113 eth_ark_dev_rx_queue_setup(struct rte_eth_dev *dev, 114 uint16_t queue_idx, 115 uint16_t nb_desc, 116 unsigned int socket_id, 117 const struct rte_eth_rxconf *rx_conf, 118 struct rte_mempool *mb_pool) 119 { 120 static int warning1; /* = 0 */ 121 struct ark_adapter *ark = dev->data->dev_private; 122 123 struct ark_rx_queue *queue; 124 uint32_t i; 125 int status; 126 127 int qidx = queue_idx; 128 129 /* We may already be setup, free memory prior to re-allocation */ 130 if (dev->data->rx_queues[queue_idx] != NULL) { 131 eth_ark_dev_rx_queue_release(dev->data->rx_queues[queue_idx]); 132 dev->data->rx_queues[queue_idx] = NULL; 133 } 134 135 if (rx_conf != NULL && warning1 == 0) { 136 warning1 = 1; 137 ARK_PMD_LOG(NOTICE, 138 "Arkville ignores rte_eth_rxconf argument.\n"); 139 } 140 141 if (RTE_PKTMBUF_HEADROOM < ARK_RX_META_SIZE) { 142 ARK_PMD_LOG(ERR, 143 "Error: DPDK Arkville requires head room > %d bytes (%s)\n", 144 ARK_RX_META_SIZE, __func__); 145 return -1; /* ERROR CODE */ 146 } 147 148 if (!rte_is_power_of_2(nb_desc)) { 149 ARK_PMD_LOG(ERR, 150 "DPDK Arkville configuration queue size must be power of two %u (%s)\n", 151 nb_desc, __func__); 152 return -1; /* ERROR CODE */ 153 } 154 155 /* Allocate queue struct */ 156 queue = rte_zmalloc_socket("Ark_rxqueue", 157 sizeof(struct ark_rx_queue), 158 64, 159 socket_id); 160 if (queue == 0) { 161 ARK_PMD_LOG(ERR, "Failed to allocate memory in %s\n", __func__); 162 return -ENOMEM; 163 } 164 165 /* NOTE zmalloc is used, no need to 0 indexes, etc. */ 166 queue->mb_pool = mb_pool; 167 queue->phys_qid = qidx; 168 queue->queue_index = queue_idx; 169 queue->queue_size = nb_desc; 170 queue->queue_mask = nb_desc - 1; 171 queue->rx_user_meta_hook = ark->user_ext.rx_user_meta_hook; 172 queue->ext_user_data = ark->user_data[dev->data->port_id]; 173 174 queue->reserve_q = 175 rte_zmalloc_socket("Ark_rx_queue mbuf", 176 nb_desc * sizeof(struct rte_mbuf *), 177 64, 178 socket_id); 179 queue->paddress_q = 180 rte_zmalloc_socket("Ark_rx_queue paddr", 181 nb_desc * sizeof(rte_iova_t), 182 64, 183 socket_id); 184 185 if (queue->reserve_q == 0 || queue->paddress_q == 0) { 186 ARK_PMD_LOG(ERR, 187 "Failed to allocate queue memory in %s\n", 188 __func__); 189 rte_free(queue->reserve_q); 190 rte_free(queue->paddress_q); 191 rte_free(queue); 192 return -ENOMEM; 193 } 194 195 dev->data->rx_queues[queue_idx] = queue; 196 queue->udm = RTE_PTR_ADD(ark->udm.v, qidx * ARK_UDM_QOFFSET); 197 queue->mpu = RTE_PTR_ADD(ark->mpurx.v, qidx * ARK_MPU_QOFFSET); 198 199 /* populate mbuf reserve */ 200 status = eth_ark_rx_seed_mbufs(queue); 201 202 if (queue->seed_index != nb_desc) { 203 ARK_PMD_LOG(ERR, "Failed to allocate %u mbufs for RX queue %d\n", 204 nb_desc, qidx); 205 status = -1; 206 } 207 /* MPU Setup */ 208 if (status == 0) 209 status = eth_ark_rx_hw_setup(dev, queue, qidx, queue_idx); 210 211 if (unlikely(status != 0)) { 212 struct rte_mbuf **mbuf; 213 214 ARK_PMD_LOG(ERR, "Failed to initialize RX queue %d %s\n", 215 qidx, 216 __func__); 217 /* Free the mbufs allocated */ 218 for (i = 0, mbuf = queue->reserve_q; 219 i < queue->seed_index; ++i, mbuf++) { 220 rte_pktmbuf_free(*mbuf); 221 } 222 rte_free(queue->reserve_q); 223 rte_free(queue->paddress_q); 224 rte_free(queue); 225 return -1; /* ERROR CODE */ 226 } 227 228 return 0; 229 } 230 231 /* ************************************************************************* */ 232 uint16_t 233 eth_ark_recv_pkts(void *rx_queue, 234 struct rte_mbuf **rx_pkts, 235 uint16_t nb_pkts) 236 { 237 struct ark_rx_queue *queue; 238 register uint32_t cons_index, prod_index; 239 uint16_t nb; 240 uint16_t i; 241 struct rte_mbuf *mbuf; 242 struct rte_mbuf **pmbuf; 243 struct ark_rx_meta *meta; 244 rx_user_meta_hook_fn rx_user_meta_hook; 245 246 queue = (struct ark_rx_queue *)rx_queue; 247 if (unlikely(queue == 0)) 248 return 0; 249 if (unlikely(nb_pkts == 0)) 250 return 0; 251 prod_index = queue->prod_index; 252 cons_index = queue->cons_index; 253 if (prod_index == cons_index) 254 return 0; 255 nb = 0; 256 257 while (prod_index != cons_index) { 258 mbuf = queue->reserve_q[cons_index & queue->queue_mask]; 259 /* prefetch mbuf */ 260 rte_mbuf_prefetch_part1(mbuf); 261 rte_mbuf_prefetch_part2(mbuf); 262 263 /* META DATA embedded in headroom */ 264 meta = RTE_PTR_ADD(mbuf->buf_addr, ARK_RX_META_OFFSET); 265 266 mbuf->pkt_len = meta->pkt_len; 267 mbuf->data_len = meta->pkt_len; 268 269 if (ARK_DEBUG_CORE) { /* debug sanity checks */ 270 if ((meta->pkt_len > (1024 * 16)) || 271 (meta->pkt_len == 0)) { 272 ARK_PMD_LOG(DEBUG, "RX: Bad Meta Q: %u" 273 " cons: %" PRIU32 274 " prod: %" PRIU32 275 " seed_index %" PRIU32 276 "\n", 277 queue->phys_qid, 278 cons_index, 279 queue->prod_index, 280 queue->seed_index); 281 282 283 ARK_PMD_LOG(DEBUG, " : UDM" 284 " prod: %" PRIU32 285 " len: %u\n", 286 queue->udm->rt_cfg.prod_idx, 287 meta->pkt_len); 288 ark_mpu_dump(queue->mpu, 289 " ", 290 queue->phys_qid); 291 dump_mbuf_data(mbuf, 0, 256); 292 /* its FUBAR so fix it */ 293 mbuf->pkt_len = 63; 294 meta->pkt_len = 63; 295 } 296 } 297 298 if (unlikely(meta->pkt_len > ARK_RX_MAX_NOCHAIN)) 299 cons_index = eth_ark_rx_jumbo 300 (queue, meta, mbuf, cons_index + 1); 301 else 302 cons_index += 1; 303 304 rx_pkts[nb] = mbuf; 305 nb++; 306 if (nb >= nb_pkts) 307 break; 308 } 309 310 rx_user_meta_hook = queue->rx_user_meta_hook; 311 for (pmbuf = rx_pkts, i = 0; rx_user_meta_hook && i < nb; i++) { 312 mbuf = *pmbuf++; 313 meta = RTE_PTR_ADD(mbuf->buf_addr, ARK_RX_META_OFFSET); 314 rx_user_meta_hook(mbuf, meta->user_meta, queue->ext_user_data); 315 } 316 317 eth_ark_rx_update_cons_index(queue, cons_index); 318 319 return nb; 320 } 321 322 /* ************************************************************************* */ 323 static uint32_t 324 eth_ark_rx_jumbo(struct ark_rx_queue *queue, 325 struct ark_rx_meta *meta, 326 struct rte_mbuf *mbuf0, 327 uint32_t cons_index) 328 { 329 struct rte_mbuf *mbuf_prev; 330 struct rte_mbuf *mbuf; 331 332 uint16_t remaining; 333 uint16_t data_len; 334 uint16_t segments; 335 336 /* first buf populated by called */ 337 mbuf_prev = mbuf0; 338 segments = 1; 339 data_len = RTE_MIN(meta->pkt_len, RTE_MBUF_DEFAULT_DATAROOM); 340 remaining = meta->pkt_len - data_len; 341 mbuf0->data_len = data_len; 342 343 /* HW guarantees that the data does not exceed prod_index! */ 344 while (remaining != 0) { 345 data_len = RTE_MIN(remaining, 346 RTE_MBUF_DEFAULT_DATAROOM); 347 348 remaining -= data_len; 349 segments += 1; 350 351 mbuf = queue->reserve_q[cons_index & queue->queue_mask]; 352 mbuf_prev->next = mbuf; 353 mbuf_prev = mbuf; 354 mbuf->data_len = data_len; 355 356 cons_index += 1; 357 } 358 359 mbuf0->nb_segs = segments; 360 return cons_index; 361 } 362 363 /* Drain the internal queue allowing hw to clear out. */ 364 static void 365 eth_ark_rx_queue_drain(struct ark_rx_queue *queue) 366 { 367 register uint32_t cons_index; 368 struct rte_mbuf *mbuf; 369 370 cons_index = queue->cons_index; 371 372 /* NOT performance optimized, since this is a one-shot call */ 373 while ((cons_index ^ queue->prod_index) & queue->queue_mask) { 374 mbuf = queue->reserve_q[cons_index & queue->queue_mask]; 375 rte_pktmbuf_free(mbuf); 376 cons_index++; 377 eth_ark_rx_update_cons_index(queue, cons_index); 378 } 379 } 380 381 uint32_t 382 eth_ark_dev_rx_queue_count(void *rx_queue) 383 { 384 struct ark_rx_queue *queue; 385 386 queue = rx_queue; 387 return (queue->prod_index - queue->cons_index); /* mod arith */ 388 } 389 390 /* ************************************************************************* */ 391 int 392 eth_ark_rx_start_queue(struct rte_eth_dev *dev, uint16_t queue_id) 393 { 394 struct ark_rx_queue *queue; 395 396 queue = dev->data->rx_queues[queue_id]; 397 if (queue == 0) 398 return -1; 399 400 dev->data->rx_queue_state[queue_id] = RTE_ETH_QUEUE_STATE_STARTED; 401 402 ark_mpu_set_producer(queue->mpu, queue->seed_index); 403 ark_mpu_start(queue->mpu); 404 405 ark_udm_queue_enable(queue->udm, 1); 406 407 return 0; 408 } 409 410 /* ************************************************************************* */ 411 412 /* Queue can be restarted. data remains 413 */ 414 int 415 eth_ark_rx_stop_queue(struct rte_eth_dev *dev, uint16_t queue_id) 416 { 417 struct ark_rx_queue *queue; 418 419 queue = dev->data->rx_queues[queue_id]; 420 if (queue == 0) 421 return -1; 422 423 ark_udm_queue_enable(queue->udm, 0); 424 425 dev->data->rx_queue_state[queue_id] = RTE_ETH_QUEUE_STATE_STOPPED; 426 427 return 0; 428 } 429 430 /* ************************************************************************* */ 431 static inline int 432 eth_ark_rx_seed_mbufs(struct ark_rx_queue *queue) 433 { 434 uint32_t limit = queue->cons_index + queue->queue_size; 435 uint32_t seed_index = queue->seed_index; 436 437 uint32_t count = 0; 438 uint32_t seed_m = queue->seed_index & queue->queue_mask; 439 440 uint32_t nb = limit - seed_index; 441 442 /* Handle wrap around -- remainder is filled on the next call */ 443 if (unlikely(seed_m + nb > queue->queue_size)) 444 nb = queue->queue_size - seed_m; 445 446 struct rte_mbuf **mbufs = &queue->reserve_q[seed_m]; 447 int status = rte_pktmbuf_alloc_bulk(queue->mb_pool, mbufs, nb); 448 449 if (unlikely(status != 0)) { 450 ARK_PMD_LOG(NOTICE, 451 "Could not allocate %u mbufs from pool" 452 " for RX queue %u;" 453 " %u free buffers remaining in queue\n", 454 nb, queue->queue_index, 455 queue->seed_index - queue->cons_index); 456 return -1; 457 } 458 459 if (ARK_DEBUG_CORE) { /* DEBUG */ 460 while (count != nb) { 461 struct rte_mbuf *mbuf_init = 462 queue->reserve_q[seed_m + count]; 463 464 memset(mbuf_init->buf_addr, -1, 512); 465 *((uint32_t *)mbuf_init->buf_addr) = 466 seed_index + count; 467 *(uint16_t *)RTE_PTR_ADD(mbuf_init->buf_addr, 4) = 468 queue->phys_qid; 469 count++; 470 } 471 count = 0; 472 } /* DEBUG */ 473 queue->seed_index += nb; 474 475 /* Duff's device https://en.wikipedia.org/wiki/Duff's_device */ 476 switch (nb % 4) { 477 case 0: 478 while (count != nb) { 479 queue->paddress_q[seed_m++] = 480 (*mbufs++)->buf_iova; 481 count++; 482 /* FALLTHROUGH */ 483 case 3: 484 queue->paddress_q[seed_m++] = 485 (*mbufs++)->buf_iova; 486 count++; 487 /* FALLTHROUGH */ 488 case 2: 489 queue->paddress_q[seed_m++] = 490 (*mbufs++)->buf_iova; 491 count++; 492 /* FALLTHROUGH */ 493 case 1: 494 queue->paddress_q[seed_m++] = 495 (*mbufs++)->buf_iova; 496 count++; 497 /* FALLTHROUGH */ 498 499 } /* while (count != nb) */ 500 } /* switch */ 501 502 return 0; 503 } 504 505 void 506 eth_ark_rx_dump_queue(struct rte_eth_dev *dev, uint16_t queue_id, 507 const char *msg) 508 { 509 struct ark_rx_queue *queue; 510 511 queue = dev->data->rx_queues[queue_id]; 512 513 ark_ethdev_rx_dump(msg, queue); 514 } 515 516 /* ************************************************************************* */ 517 /* Call on device closed no user API, queue is stopped */ 518 void 519 eth_ark_dev_rx_queue_release(void *vqueue) 520 { 521 struct ark_rx_queue *queue; 522 uint32_t i; 523 524 queue = (struct ark_rx_queue *)vqueue; 525 if (queue == 0) 526 return; 527 528 ark_udm_queue_enable(queue->udm, 0); 529 /* Stop the MPU since pointer are going away */ 530 ark_mpu_stop(queue->mpu); 531 532 /* Need to clear out mbufs here, dropping packets along the way */ 533 eth_ark_rx_queue_drain(queue); 534 535 for (i = 0; i < queue->queue_size; ++i) 536 rte_pktmbuf_free(queue->reserve_q[i]); 537 538 rte_free(queue->reserve_q); 539 rte_free(queue->paddress_q); 540 rte_free(queue); 541 } 542 543 void 544 eth_rx_queue_stats_get(void *vqueue, struct rte_eth_stats *stats) 545 { 546 struct ark_rx_queue *queue; 547 struct ark_udm_t *udm; 548 549 queue = vqueue; 550 if (queue == 0) 551 return; 552 udm = queue->udm; 553 554 uint64_t ibytes = ark_udm_bytes(udm); 555 uint64_t ipackets = ark_udm_packets(udm); 556 uint64_t idropped = ark_udm_dropped(queue->udm); 557 558 stats->q_ipackets[queue->queue_index] = ipackets; 559 stats->q_ibytes[queue->queue_index] = ibytes; 560 stats->q_errors[queue->queue_index] = idropped; 561 stats->ipackets += ipackets; 562 stats->ibytes += ibytes; 563 stats->imissed += idropped; 564 } 565 566 void 567 eth_rx_queue_stats_reset(void *vqueue) 568 { 569 struct ark_rx_queue *queue; 570 571 queue = vqueue; 572 if (queue == 0) 573 return; 574 575 ark_mpu_reset_stats(queue->mpu); 576 ark_udm_queue_stats_reset(queue->udm); 577 } 578 579 void 580 eth_ark_udm_force_close(struct rte_eth_dev *dev) 581 { 582 struct ark_adapter *ark = dev->data->dev_private; 583 struct ark_rx_queue *queue; 584 uint32_t index; 585 uint16_t i; 586 587 if (!ark_udm_is_flushed(ark->udm.v)) { 588 /* restart the MPUs */ 589 ARK_PMD_LOG(NOTICE, "UDM not flushed -- forcing flush\n"); 590 for (i = 0; i < dev->data->nb_rx_queues; i++) { 591 queue = (struct ark_rx_queue *)dev->data->rx_queues[i]; 592 if (queue == 0) 593 continue; 594 595 ark_mpu_start(queue->mpu); 596 /* Add some buffers */ 597 index = 100000 + queue->seed_index; 598 ark_mpu_set_producer(queue->mpu, index); 599 } 600 /* Wait to allow data to pass */ 601 usleep(100); 602 603 ARK_PMD_LOG(DEBUG, "UDM forced flush attempt, stopped = %d\n", 604 ark_udm_is_flushed(ark->udm.v)); 605 } 606 ark_udm_reset(ark->udm.v); 607 } 608 609 static void 610 ark_ethdev_rx_dump(const char *name, struct ark_rx_queue *queue) 611 { 612 if (queue == NULL) 613 return; 614 ARK_PMD_LOG(DEBUG, "RX QUEUE %d -- %s", queue->phys_qid, name); 615 ARK_PMD_LOG(DEBUG, ARK_SU32 ARK_SU32 ARK_SU32 ARK_SU32 "\n", 616 "queue_size", queue->queue_size, 617 "seed_index", queue->seed_index, 618 "prod_index", queue->prod_index, 619 "cons_index", queue->cons_index); 620 621 ark_mpu_dump(queue->mpu, name, queue->phys_qid); 622 ark_mpu_dump_setup(queue->mpu, queue->phys_qid); 623 ark_udm_dump(queue->udm, name); 624 ark_udm_dump_setup(queue->udm, queue->phys_qid); 625 } 626 627 /* Only used in debug. 628 * This function is a raw memory dump of a portion of an mbuf's memory 629 * region. The usual function, rte_pktmbuf_dump() only shows data 630 * with respect to the data_off field. This function show data 631 * anywhere in the mbuf's buffer. This is useful for examining 632 * data in the headroom or tailroom portion of an mbuf. 633 */ 634 static void 635 dump_mbuf_data(struct rte_mbuf *mbuf, uint16_t lo, uint16_t hi) 636 { 637 uint16_t i, j; 638 639 ARK_PMD_LOG(DEBUG, " MBUF: %p len %d, off: %d\n", 640 mbuf, mbuf->pkt_len, mbuf->data_off); 641 for (i = lo; i < hi; i += 16) { 642 uint8_t *dp = RTE_PTR_ADD(mbuf->buf_addr, i); 643 644 ARK_PMD_LOG(DEBUG, " %6d: ", i); 645 for (j = 0; j < 16; j++) 646 ARK_PMD_LOG(DEBUG, " %02x", dp[j]); 647 648 ARK_PMD_LOG(DEBUG, "\n"); 649 } 650 } 651