1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2018 Cavium, Inc
7 #include <rte_byteorder.h>
8 #include <rte_common.h>
9 #include <rte_cpuflags.h>
10 #include <rte_malloc.h>
14 static const struct rte_compressdev_capabilities
15 octtx_zip_pmd_capabilities[] = {
16 { .algo = RTE_COMP_ALGO_DEFLATE,
18 .comp_feature_flags = RTE_COMP_FF_HUFFMAN_FIXED |
19 RTE_COMP_FF_HUFFMAN_DYNAMIC,
20 /* Non sharable Priv XFORM and Stateless */
25 /* size supported 2^1 to 2^14 */
28 RTE_COMP_END_OF_CAPABILITIES_LIST()
32 * Reset session to default state for next set of stateless operation
35 reset_stream(struct zip_stream *z_stream)
37 union zip_inst_s *inst = (union zip_inst_s *)(z_stream->inst);
44 zip_process_op(struct rte_comp_op *op,
46 struct zip_stream *zstrm)
48 union zip_inst_s *inst = zstrm->inst;
49 volatile union zip_zres_s *zresult = NULL;
52 if ((op->m_src->nb_segs > 1) || (op->m_dst->nb_segs > 1) ||
53 (op->src.offset > rte_pktmbuf_pkt_len(op->m_src)) ||
54 (op->dst.offset > rte_pktmbuf_pkt_len(op->m_dst))) {
55 op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
56 ZIP_PMD_ERR("Segmented packet is not supported\n");
60 zipvf_prepare_cmd_stateless(op, zstrm);
62 zresult = (union zip_zres_s *)zstrm->bufs[RES_BUF];
63 zresult->s.compcode = 0;
66 zip_dump_instruction(inst);
69 /* Submit zip command */
70 zipvf_push_command(qp, (void *)inst);
72 /* Check and Process results in sync mode */
74 } while (!zresult->s.compcode);
76 if (zresult->s.compcode == ZIP_COMP_E_SUCCESS) {
77 op->status = RTE_COMP_OP_STATUS_SUCCESS;
79 /* FATAL error cannot do anything */
80 ZIP_PMD_ERR("operation failed with error code:%d\n",
82 if (zresult->s.compcode == ZIP_COMP_E_DSTOP)
83 op->status = RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED;
85 op->status = RTE_COMP_OP_STATUS_ERROR;
88 ZIP_PMD_INFO("written %d\n", zresult->s.totalbyteswritten);
92 case RTE_COMP_OP_STATUS_SUCCESS:
93 op->consumed = zresult->s.totalbytesread;
95 case RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED:
96 op->produced = zresult->s.totalbyteswritten;
99 ZIP_PMD_ERR("stats not updated for status:%d\n",
103 /* zstream is reset irrespective of result */
106 zresult->s.compcode = ZIP_COMP_E_NOTDONE;
110 /** Parse xform parameters and setup a stream */
112 zip_set_stream_parameters(struct rte_compressdev *dev,
113 const struct rte_comp_xform *xform,
114 struct zip_stream *z_stream)
117 union zip_inst_s *inst;
118 struct zip_vf *vf = (struct zip_vf *)dev->data->dev_private;
121 /* Allocate resources required by a stream */
122 ret = rte_mempool_get_bulk(vf->zip_mp,
123 z_stream->bufs, MAX_BUFS_PER_STREAM);
127 /* get one command buffer from pool and set up */
128 inst = (union zip_inst_s *)z_stream->bufs[CMD_BUF];
129 res = z_stream->bufs[RES_BUF];
131 memset(inst->u, 0, sizeof(inst->u));
133 /* set bf for only first ops of stream */
136 if (xform->type == RTE_COMP_COMPRESS) {
137 inst->s.op = ZIP_OP_E_COMP;
139 switch (xform->compress.deflate.huffman) {
140 case RTE_COMP_HUFFMAN_DEFAULT:
141 inst->s.cc = ZIP_CC_DEFAULT;
143 case RTE_COMP_HUFFMAN_FIXED:
144 inst->s.cc = ZIP_CC_FIXED_HUFF;
146 case RTE_COMP_HUFFMAN_DYNAMIC:
147 inst->s.cc = ZIP_CC_DYN_HUFF;
154 switch (xform->compress.level) {
155 case RTE_COMP_LEVEL_MIN:
156 inst->s.ss = ZIP_COMP_E_LEVEL_MIN;
158 case RTE_COMP_LEVEL_MAX:
159 inst->s.ss = ZIP_COMP_E_LEVEL_MAX;
161 case RTE_COMP_LEVEL_NONE:
162 ZIP_PMD_ERR("Compression level not supported");
166 /* for any value between min and max , choose
169 inst->s.ss = ZIP_COMP_E_LEVEL_MED; /** PMD default **/
172 } else if (xform->type == RTE_COMP_DECOMPRESS) {
173 inst->s.op = ZIP_OP_E_DECOMP;
175 * For DEFLATE decompression, [CC] must be 0x0.
176 * For decompression, [SS] must be 0x0
179 /* Speed bit should not be set for decompression */
181 /* decompression context is supported only for STATEFUL
182 * operations. Currently we support STATELESS ONLY so
183 * skip setting of ctx pointer
187 ZIP_PMD_ERR("\nxform type not supported");
192 inst->s.res_ptr_addr.s.addr = rte_mempool_virt2iova(res);
193 inst->s.res_ptr_ctl.s.length = 0;
195 z_stream->inst = inst;
196 z_stream->func = zip_process_op;
201 rte_mempool_put_bulk(vf->zip_mp,
202 (void *)&(z_stream->bufs[0]),
203 MAX_BUFS_PER_STREAM);
208 /** Configure device */
210 zip_pmd_config(struct rte_compressdev *dev,
211 struct rte_compressdev_config *config)
214 char res_pool[RTE_MEMZONE_NAMESIZE];
216 struct rte_mempool *zip_buf_mp;
221 vf = (struct zip_vf *)(dev->data->dev_private);
223 /* create pool with maximum numbers of resources
224 * required by streams
227 /* use common pool for non-shareable priv_xform and stream */
228 nb_streams = config->max_nb_priv_xforms + config->max_nb_streams;
230 snprintf(res_pool, RTE_MEMZONE_NAMESIZE, "octtx_zip_res_pool%u",
233 /** TBD Should we use the per core object cache for stream resources */
234 zip_buf_mp = rte_mempool_create(
236 nb_streams * MAX_BUFS_PER_STREAM,
247 if (zip_buf_mp == NULL) {
249 "Failed to create buf mempool octtx_zip_res_pool%u",
254 vf->zip_mp = zip_buf_mp;
261 zip_pmd_start(__rte_unused struct rte_compressdev *dev)
268 zip_pmd_stop(__rte_unused struct rte_compressdev *dev)
275 zip_pmd_close(struct rte_compressdev *dev)
280 struct zip_vf *vf = (struct zip_vf *)dev->data->dev_private;
281 rte_mempool_free(vf->zip_mp);
286 /** Get device statistics */
288 zip_pmd_stats_get(struct rte_compressdev *dev,
289 struct rte_compressdev_stats *stats)
293 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
294 struct zipvf_qp *qp = dev->data->queue_pairs[qp_id];
296 stats->enqueued_count += qp->qp_stats.enqueued_count;
297 stats->dequeued_count += qp->qp_stats.dequeued_count;
299 stats->enqueue_err_count += qp->qp_stats.enqueue_err_count;
300 stats->dequeue_err_count += qp->qp_stats.dequeue_err_count;
304 /** Reset device statistics */
306 zip_pmd_stats_reset(struct rte_compressdev *dev)
310 for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
311 struct zipvf_qp *qp = dev->data->queue_pairs[qp_id];
312 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
316 /** Get device info */
318 zip_pmd_info_get(struct rte_compressdev *dev,
319 struct rte_compressdev_info *dev_info)
321 struct zip_vf *vf = (struct zip_vf *)dev->data->dev_private;
323 if (dev_info != NULL) {
324 dev_info->driver_name = dev->device->driver->name;
325 dev_info->feature_flags = dev->feature_flags;
326 dev_info->capabilities = octtx_zip_pmd_capabilities;
327 dev_info->max_nb_queue_pairs = vf->max_nb_queue_pairs;
331 /** Release queue pair */
333 zip_pmd_qp_release(struct rte_compressdev *dev, uint16_t qp_id)
335 struct zipvf_qp *qp = dev->data->queue_pairs[qp_id];
340 rte_ring_free(qp->processed_pkts);
343 dev->data->queue_pairs[qp_id] = NULL;
348 /** Create a ring to place process packets on */
349 static struct rte_ring *
350 zip_pmd_qp_create_processed_pkts_ring(struct zipvf_qp *qp,
351 unsigned int ring_size, int socket_id)
355 r = rte_ring_lookup(qp->name);
357 if (rte_ring_get_size(r) >= ring_size) {
358 ZIP_PMD_INFO("Reusing existing ring %s for processed"
359 " packets", qp->name);
363 ZIP_PMD_ERR("Unable to reuse existing ring %s for processed"
364 " packets", qp->name);
368 return rte_ring_create(qp->name, ring_size, socket_id,
372 /** Setup a queue pair */
374 zip_pmd_qp_setup(struct rte_compressdev *dev, uint16_t qp_id,
375 uint32_t max_inflight_ops, int socket_id)
377 struct zipvf_qp *qp = NULL;
385 vf = (struct zip_vf *) (dev->data->dev_private);
387 /* Free memory prior to re-allocation if needed. */
388 if (dev->data->queue_pairs[qp_id] != NULL) {
389 ZIP_PMD_INFO("Using existing queue pair %d ", qp_id);
393 name = rte_malloc(NULL, RTE_COMPRESSDEV_NAME_MAX_LEN, 0);
396 snprintf(name, RTE_COMPRESSDEV_NAME_MAX_LEN,
398 dev->data->dev_id, qp_id);
400 /* Allocate the queue pair data structure. */
401 qp = rte_zmalloc_socket(name, sizeof(*qp),
402 RTE_CACHE_LINE_SIZE, socket_id);
410 /* Create completion queue up to max_inflight_ops */
411 qp->processed_pkts = zip_pmd_qp_create_processed_pkts_ring(qp,
412 max_inflight_ops, socket_id);
413 if (qp->processed_pkts == NULL)
414 goto qp_setup_cleanup;
419 ret = zipvf_q_init(qp);
421 goto qp_setup_cleanup;
423 dev->data->queue_pairs[qp_id] = qp;
425 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
429 rte_ring_free(qp->processed_pkts);
435 zip_pmd_stream_create(struct rte_compressdev *dev,
436 const struct rte_comp_xform *xform, void **stream)
439 struct zip_stream *strm = NULL;
441 strm = rte_malloc(NULL,
442 sizeof(struct zip_stream), 0);
447 ret = zip_set_stream_parameters(dev, xform, strm);
449 ZIP_PMD_ERR("failed configure xform parameters");
458 zip_pmd_stream_free(struct rte_compressdev *dev, void *stream)
460 struct zip_vf *vf = (struct zip_vf *) (dev->data->dev_private);
461 struct zip_stream *z_stream;
466 z_stream = (struct zip_stream *)stream;
468 /* Free resources back to pool */
469 rte_mempool_put_bulk(vf->zip_mp,
470 (void *)&(z_stream->bufs[0]),
471 MAX_BUFS_PER_STREAM);
473 /* Zero out the whole structure */
474 memset(stream, 0, sizeof(struct zip_stream));
482 zip_pmd_enqueue_burst_sync(void *queue_pair,
483 struct rte_comp_op **ops, uint16_t nb_ops)
485 struct zipvf_qp *qp = queue_pair;
486 struct rte_comp_op *op;
487 struct zip_stream *zstrm;
491 for (i = 0; i < nb_ops; i++) {
494 if (op->op_type == RTE_COMP_OP_STATEFUL) {
495 op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
497 /* process stateless ops */
498 zstrm = (struct zip_stream *)op->private_xform;
499 if (unlikely(zstrm == NULL))
500 op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
502 ret = zstrm->func(op, qp, zstrm);
505 /* Whatever is out of op, put it into completion queue with
509 ret = rte_ring_enqueue(qp->processed_pkts, (void *)op);
511 if (unlikely(ret < 0)) {
512 /* increment count if failed to enqueue op*/
513 qp->qp_stats.enqueue_err_count++;
515 qp->qp_stats.enqueued_count++;
523 zip_pmd_dequeue_burst_sync(void *queue_pair,
524 struct rte_comp_op **ops, uint16_t nb_ops)
526 struct zipvf_qp *qp = queue_pair;
528 unsigned int nb_dequeued = 0;
530 nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
531 (void **)ops, nb_ops, NULL);
532 qp->qp_stats.dequeued_count += nb_dequeued;
537 static struct rte_compressdev_ops octtx_zip_pmd_ops = {
538 .dev_configure = zip_pmd_config,
539 .dev_start = zip_pmd_start,
540 .dev_stop = zip_pmd_stop,
541 .dev_close = zip_pmd_close,
543 .stats_get = zip_pmd_stats_get,
544 .stats_reset = zip_pmd_stats_reset,
546 .dev_infos_get = zip_pmd_info_get,
548 .queue_pair_setup = zip_pmd_qp_setup,
549 .queue_pair_release = zip_pmd_qp_release,
551 .private_xform_create = zip_pmd_stream_create,
552 .private_xform_free = zip_pmd_stream_free,
553 .stream_create = NULL,
558 zip_pci_probe(struct rte_pci_driver *pci_drv __rte_unused,
559 struct rte_pci_device *pci_dev)
562 char compressdev_name[RTE_COMPRESSDEV_NAME_MAX_LEN];
563 struct rte_compressdev *compressdev;
564 struct rte_compressdev_pmd_init_params init_params = {
569 ZIP_PMD_INFO("vendor_id=0x%x device_id=0x%x",
570 (unsigned int)pci_dev->id.vendor_id,
571 (unsigned int)pci_dev->id.device_id);
573 rte_pci_device_name(&pci_dev->addr, compressdev_name,
574 sizeof(compressdev_name));
576 compressdev = rte_compressdev_pmd_create(compressdev_name,
577 &pci_dev->device, sizeof(struct zip_vf), &init_params);
578 if (compressdev == NULL) {
579 ZIP_PMD_ERR("driver %s: create failed", init_params.name);
584 * create only if proc_type is primary.
586 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
587 /* create vf dev with given pmd dev id */
588 ret = zipvf_create(compressdev);
590 ZIP_PMD_ERR("Device creation failed");
591 rte_compressdev_pmd_destroy(compressdev);
596 compressdev->dev_ops = &octtx_zip_pmd_ops;
597 /* register rx/tx burst functions for data path */
598 compressdev->dequeue_burst = zip_pmd_dequeue_burst_sync;
599 compressdev->enqueue_burst = zip_pmd_enqueue_burst_sync;
600 compressdev->feature_flags = RTE_COMPDEV_FF_HW_ACCELERATED;
605 zip_pci_remove(struct rte_pci_device *pci_dev)
607 struct rte_compressdev *compressdev;
608 char compressdev_name[RTE_COMPRESSDEV_NAME_MAX_LEN];
610 if (pci_dev == NULL) {
611 ZIP_PMD_ERR(" Invalid PCI Device\n");
614 rte_pci_device_name(&pci_dev->addr, compressdev_name,
615 sizeof(compressdev_name));
617 compressdev = rte_compressdev_pmd_get_named_dev(compressdev_name);
618 if (compressdev == NULL)
621 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
622 if (zipvf_destroy(compressdev) < 0)
625 return rte_compressdev_pmd_destroy(compressdev);
628 static struct rte_pci_id pci_id_octtx_zipvf_table[] = {
630 RTE_PCI_DEVICE(PCI_VENDOR_ID_CAVIUM,
631 PCI_DEVICE_ID_OCTEONTX_ZIPVF),
639 * Structure that represents a PCI driver
641 static struct rte_pci_driver octtx_zip_pmd = {
642 .id_table = pci_id_octtx_zipvf_table,
643 .drv_flags = RTE_PCI_DRV_NEED_MAPPING,
644 .probe = zip_pci_probe,
645 .remove = zip_pci_remove,
648 RTE_PMD_REGISTER_PCI(COMPRESSDEV_NAME_ZIP_PMD, octtx_zip_pmd);
649 RTE_PMD_REGISTER_PCI_TABLE(COMPRESSDEV_NAME_ZIP_PMD, pci_id_octtx_zipvf_table);
650 RTE_LOG_REGISTER_DEFAULT(octtx_zip_logtype_driver, INFO);