net/liquidio: add APIs to alloc and send control command
[dpdk.git] / drivers / net / liquidio / lio_rxtx.h
index 9e2d967..95d0007 100644 (file)
 
 #include "lio_struct.h"
 
+#ifndef ROUNDUP4
+#define ROUNDUP4(val) (((val) + 3) & 0xfffffffc)
+#endif
+
 #define LIO_STQUEUE_FIRST_ENTRY(ptr, type, elem)       \
        (type *)((char *)((ptr)->stqh_first) - offsetof(type, elem))
 
 #define lio_uptime             \
        (size_t)(rte_get_timer_cycles() / rte_get_timer_hz())
 
+/** Descriptor format.
+ *  The descriptor ring is made of descriptors which have 2 64-bit values:
+ *  -# Physical (bus) address of the data buffer.
+ *  -# Physical (bus) address of a lio_droq_info structure.
+ *  The device DMA's incoming packets and its information at the address
+ *  given by these descriptor fields.
+ */
+struct lio_droq_desc {
+       /** The buffer pointer */
+       uint64_t buffer_ptr;
+
+       /** The Info pointer */
+       uint64_t info_ptr;
+};
+
+#define LIO_DROQ_DESC_SIZE     (sizeof(struct lio_droq_desc))
+
+/** Information about packet DMA'ed by Octeon.
+ *  The format of the information available at Info Pointer after Octeon
+ *  has posted a packet. Not all descriptors have valid information. Only
+ *  the Info field of the first descriptor for a packet has information
+ *  about the packet.
+ */
+struct lio_droq_info {
+       /** The Output Receive Header. */
+       union octeon_rh rh;
+
+       /** The Length of the packet. */
+       uint64_t length;
+};
+
+#define LIO_DROQ_INFO_SIZE     (sizeof(struct lio_droq_info))
+
+/** Pointer to data buffer.
+ *  Driver keeps a pointer to the data buffer that it made available to
+ *  the Octeon device. Since the descriptor ring keeps physical (bus)
+ *  addresses, this field is required for the driver to keep track of
+ *  the virtual address pointers.
+ */
+struct lio_recv_buffer {
+       /** Packet buffer, including meta data. */
+       void *buffer;
+
+       /** Data in the packet buffer. */
+       uint8_t *data;
+
+};
+
+#define LIO_DROQ_RECVBUF_SIZE  (sizeof(struct lio_recv_buffer))
+
+#define LIO_DROQ_SIZE          (sizeof(struct lio_droq))
+
 #define LIO_IQ_SEND_OK         0
 #define LIO_IQ_SEND_STOP       1
 #define LIO_IQ_SEND_FAILED     -1
@@ -193,6 +249,84 @@ union octeon_cmd {
 
 #define OCTEON_CMD_SIZE (sizeof(union octeon_cmd))
 
+/* Maximum number of 8-byte words can be
+ * sent in a NIC control message.
+ */
+#define LIO_MAX_NCTRL_UDD      32
+
+/* Structure of control information passed by driver to the BASE
+ * layer when sending control commands to Octeon device software.
+ */
+struct lio_ctrl_pkt {
+       /** Command to be passed to the Octeon device software. */
+       union octeon_cmd ncmd;
+
+       /** Send buffer */
+       void *data;
+       uint64_t dmadata;
+
+       /** Response buffer */
+       void *rdata;
+       uint64_t dmardata;
+
+       /** Additional data that may be needed by some commands. */
+       uint64_t udd[LIO_MAX_NCTRL_UDD];
+
+       /** Input queue to use to send this command. */
+       uint64_t iq_no;
+
+       /** Time to wait for Octeon software to respond to this control command.
+        *  If wait_time is 0, BASE assumes no response is expected.
+        */
+       size_t wait_time;
+
+       struct lio_dev_ctrl_cmd *ctrl_cmd;
+};
+
+/** Structure of data information passed by driver to the BASE
+ *  layer when forwarding data to Octeon device software.
+ */
+struct lio_data_pkt {
+       /** Pointer to information maintained by NIC module for this packet. The
+        *  BASE layer passes this as-is to the driver.
+        */
+       void *buf;
+
+       /** Type of buffer passed in "buf" above. */
+       uint32_t reqtype;
+
+       /** Total data bytes to be transferred in this command. */
+       uint32_t datasize;
+
+       /** Command to be passed to the Octeon device software. */
+       union lio_instr_64B cmd;
+
+       /** Input queue to use to send this command. */
+       uint32_t q_no;
+};
+
+/** Structure passed by driver to BASE layer to prepare a command to send
+ *  network data to Octeon.
+ */
+union lio_cmd_setup {
+       struct {
+               uint32_t iq_no : 8;
+               uint32_t gather : 1;
+               uint32_t timestamp : 1;
+               uint32_t ip_csum : 1;
+               uint32_t transport_csum : 1;
+               uint32_t tnl_csum : 1;
+               uint32_t rsvd : 19;
+
+               union {
+                       uint32_t datasize;
+                       uint32_t gatherptrs;
+               } u;
+       } s;
+
+       uint64_t cmd_setup64;
+};
+
 /* Instruction Header */
 struct octeon_instr_ih3 {
 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
@@ -362,6 +496,98 @@ struct octeon_instr_rdp {
 #endif
 };
 
+union octeon_packet_params {
+       uint32_t pkt_params32;
+       struct {
+#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+               uint32_t reserved : 24;
+               uint32_t ip_csum : 1; /* Perform IP header checksum(s) */
+               /* Perform Outer transport header checksum */
+               uint32_t transport_csum : 1;
+               /* Find tunnel, and perform transport csum. */
+               uint32_t tnl_csum : 1;
+               uint32_t tsflag : 1;   /* Timestamp this packet */
+               uint32_t ipsec_ops : 4; /* IPsec operation */
+#else
+               uint32_t ipsec_ops : 4;
+               uint32_t tsflag : 1;
+               uint32_t tnl_csum : 1;
+               uint32_t transport_csum : 1;
+               uint32_t ip_csum : 1;
+               uint32_t reserved : 7;
+#endif
+       } s;
+};
+
+/** Utility function to prepare a 64B NIC instruction based on a setup command
+ * @param cmd - pointer to instruction to be filled in.
+ * @param setup - pointer to the setup structure
+ * @param q_no - which queue for back pressure
+ *
+ * Assumes the cmd instruction is pre-allocated, but no fields are filled in.
+ */
+static inline void
+lio_prepare_pci_cmd(struct lio_device *lio_dev,
+                   union lio_instr_64B *cmd,
+                   union lio_cmd_setup *setup,
+                   uint32_t tag)
+{
+       union octeon_packet_params packet_params;
+       struct octeon_instr_pki_ih3 *pki_ih3;
+       struct octeon_instr_irh *irh;
+       struct octeon_instr_ih3 *ih3;
+       int port;
+
+       memset(cmd, 0, sizeof(union lio_instr_64B));
+
+       ih3 = (struct octeon_instr_ih3 *)&cmd->cmd3.ih3;
+       pki_ih3 = (struct octeon_instr_pki_ih3 *)&cmd->cmd3.pki_ih3;
+
+       /* assume that rflag is cleared so therefore front data will only have
+        * irh and ossp[1] and ossp[2] for a total of 24 bytes
+        */
+       ih3->pkind = lio_dev->instr_queue[setup->s.iq_no]->txpciq.s.pkind;
+       /* PKI IH */
+       ih3->fsz = OCTEON_PCI_CMD_O3;
+
+       if (!setup->s.gather) {
+               ih3->dlengsz = setup->s.u.datasize;
+       } else {
+               ih3->gather = 1;
+               ih3->dlengsz = setup->s.u.gatherptrs;
+       }
+
+       pki_ih3->w = 1;
+       pki_ih3->raw = 0;
+       pki_ih3->utag = 0;
+       pki_ih3->utt = 1;
+       pki_ih3->uqpg = lio_dev->instr_queue[setup->s.iq_no]->txpciq.s.use_qpg;
+
+       port = (int)lio_dev->instr_queue[setup->s.iq_no]->txpciq.s.port;
+
+       if (tag)
+               pki_ih3->tag = tag;
+       else
+               pki_ih3->tag = LIO_DATA(port);
+
+       pki_ih3->tagtype = OCTEON_ORDERED_TAG;
+       pki_ih3->qpg = lio_dev->instr_queue[setup->s.iq_no]->txpciq.s.qpg;
+       pki_ih3->pm = 0x0; /* parse from L2 */
+       pki_ih3->sl = 32;  /* sl will be sizeof(pki_ih3) + irh + ossp0 + ossp1*/
+
+       irh = (struct octeon_instr_irh *)&cmd->cmd3.irh;
+
+       irh->opcode = LIO_OPCODE;
+       irh->subcode = LIO_OPCODE_NW_DATA;
+
+       packet_params.pkt_params32 = 0;
+       packet_params.s.ip_csum = setup->s.ip_csum;
+       packet_params.s.transport_csum = setup->s.transport_csum;
+       packet_params.s.tsflag = setup->s.timestamp;
+
+       irh->ossp = packet_params.pkt_params32;
+}
+
 int lio_setup_sc_buffer_pool(struct lio_device *lio_dev);
 void lio_free_sc_buffer_pool(struct lio_device *lio_dev);
 
@@ -378,6 +604,16 @@ int lio_send_soft_command(struct lio_device *lio_dev,
                          struct lio_soft_command *sc);
 void lio_free_soft_command(struct lio_soft_command *sc);
 
+/** Send control packet to the device
+ *  @param lio_dev - lio device pointer
+ *  @param nctrl   - control structure with command, timeout, and callback info
+ *
+ *  @returns IQ_FAILED if it failed to add to the input queue. IQ_STOP if it the
+ *  queue should be stopped, and LIO_IQ_SEND_OK if it sent okay.
+ */
+int lio_send_ctrl_pkt(struct lio_device *lio_dev,
+                     struct lio_ctrl_pkt *ctrl_pkt);
+
 /** Maximum ordered requests to process in every invocation of
  *  lio_process_ordered_list(). The function will continue to process requests
  *  as long as it can find one that has finished processing. If it keeps
@@ -443,6 +679,48 @@ lio_swap_8B_data(uint64_t *data, uint32_t blocks)
        }
 }
 
+static inline uint64_t
+lio_map_ring(void *buf)
+{
+       phys_addr_t dma_addr;
+
+       dma_addr = rte_mbuf_data_dma_addr_default(((struct rte_mbuf *)buf));
+
+       return (uint64_t)dma_addr;
+}
+
+static inline uint64_t
+lio_map_ring_info(struct lio_droq *droq, uint32_t i)
+{
+       phys_addr_t dma_addr;
+
+       dma_addr = droq->info_list_dma + (i * LIO_DROQ_INFO_SIZE);
+
+       return (uint64_t)dma_addr;
+}
+
+static inline int
+lio_opcode_slow_path(union octeon_rh *rh)
+{
+       uint16_t subcode1, subcode2;
+
+       subcode1 = LIO_OPCODE_SUBCODE(rh->r.opcode, rh->r.subcode);
+       subcode2 = LIO_OPCODE_SUBCODE(LIO_OPCODE, LIO_OPCODE_NW_DATA);
+
+       return subcode2 != subcode1;
+}
+
+static inline void
+lio_add_sg_size(struct lio_sg_entry *sg_entry,
+               uint16_t size, uint32_t pos)
+{
+#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
+       sg_entry->u.size[pos] = size;
+#elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
+       sg_entry->u.size[3 - pos] = size;
+#endif
+}
+
 /* Macro to increment index.
  * Index is incremented by count; if the sum exceeds
  * max, index is wrapped-around to the start.
@@ -458,6 +736,23 @@ lio_incr_index(uint32_t index, uint32_t count, uint32_t max)
        return index;
 }
 
+int lio_setup_droq(struct lio_device *lio_dev, int q_no, int num_descs,
+                  int desc_size, struct rte_mempool *mpool,
+                  unsigned int socket_id);
+uint16_t lio_dev_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
+                          uint16_t budget);
+void lio_delete_droq_queue(struct lio_device *lio_dev, int oq_no);
+
+void lio_delete_sglist(struct lio_instr_queue *txq);
+int lio_setup_sglists(struct lio_device *lio_dev, int iq_no,
+                     int fw_mapped_iq, int num_descs, unsigned int socket_id);
+uint16_t lio_dev_xmit_pkts(void *tx_queue, struct rte_mbuf **pkts,
+                          uint16_t nb_pkts);
+int lio_setup_iq(struct lio_device *lio_dev, int q_index,
+                union octeon_txpciq iq_no, uint32_t num_descs, void *app_ctx,
+                unsigned int socket_id);
+int lio_flush_iq(struct lio_device *lio_dev, struct lio_instr_queue *iq);
+void lio_delete_instruction_queue(struct lio_device *lio_dev, int iq_no);
 /** Setup instruction queue zero for the device
  *  @param lio_dev which lio device to setup
  *