drivers/net/liquidio/lio_rxtx.h

   1 /*
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2017 Cavium, Inc.. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Cavium, Inc. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _LIO_RXTX_H_
  35 #define _LIO_RXTX_H_
  36
  37 #include <stdio.h>
  38 #include <stdint.h>
  39
  40 #include <rte_spinlock.h>
  41 #include <rte_memory.h>
  42
  43 #include "lio_struct.h"
  44
  45 struct lio_request_list {
  46         uint32_t reqtype;
  47         void *buf;
  48 };
  49
  50 /** The size of each buffer in soft command buffer pool */
  51 #define LIO_SOFT_COMMAND_BUFFER_SIZE    1536
  52
  53 /** Maximum number of buffers to allocate into soft command buffer pool */
  54 #define LIO_MAX_SOFT_COMMAND_BUFFERS    255
  55
  56 struct lio_soft_command {
  57         /** Soft command buffer info. */
  58         struct lio_stailq_node node;
  59         uint64_t dma_addr;
  60         uint32_t size;
  61
  62 #define LIO_COMPLETION_WORD_INIT        0xffffffffffffffffULL
  63         uint64_t *status_word;
  64
  65         /** Data buffer info */
  66         void *virtdptr;
  67         uint64_t dmadptr;
  68         uint32_t datasize;
  69
  70         /** Return buffer info */
  71         void *virtrptr;
  72         uint64_t dmarptr;
  73         uint32_t rdatasize;
  74
  75         /** Context buffer info */
  76         void *ctxptr;
  77         uint32_t ctxsize;
  78
  79         /** Time out and callback */
  80         size_t wait_time;
  81         size_t timeout;
  82         uint32_t iq_no;
  83         void (*callback)(uint32_t, void *);
  84         void *callback_arg;
  85         struct rte_mbuf *mbuf;
  86 };
  87
  88 int lio_setup_sc_buffer_pool(struct lio_device *lio_dev);
  89 void lio_free_sc_buffer_pool(struct lio_device *lio_dev);
  90
  91 struct lio_soft_command *
  92 lio_alloc_soft_command(struct lio_device *lio_dev,
  93                        uint32_t datasize, uint32_t rdatasize,
  94                        uint32_t ctxsize);
  95 void lio_free_soft_command(struct lio_soft_command *sc);
  96
  97 /** Setup instruction queue zero for the device
  98  *  @param lio_dev which lio device to setup
  99  *
 100  *  @return 0 if success. -1 if fails
 101  */
 102 int lio_setup_instr_queue0(struct lio_device *lio_dev);
 103 void lio_free_instr_queue0(struct lio_device *lio_dev);
 104 #endif  /* _LIO_RXTX_H_ */