4 * Copyright(c) 2017 Cavium, Inc.. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
40 #include <rte_spinlock.h>
41 #include <rte_memory.h>
43 #include "lio_struct.h"
46 #define ROUNDUP4(val) (((val) + 3) & 0xfffffffc)
49 #define LIO_STQUEUE_FIRST_ENTRY(ptr, type, elem) \
50 (type *)((char *)((ptr)->stqh_first) - offsetof(type, elem))
52 #define lio_check_timeout(cur_time, chk_time) ((cur_time) > (chk_time))
55 (size_t)(rte_get_timer_cycles() / rte_get_timer_hz())
57 /** Descriptor format.
58 * The descriptor ring is made of descriptors which have 2 64-bit values:
59 * -# Physical (bus) address of the data buffer.
60 * -# Physical (bus) address of a lio_droq_info structure.
61 * The device DMA's incoming packets and its information at the address
62 * given by these descriptor fields.
64 struct lio_droq_desc {
65 /** The buffer pointer */
68 /** The Info pointer */
72 #define LIO_DROQ_DESC_SIZE (sizeof(struct lio_droq_desc))
74 /** Information about packet DMA'ed by Octeon.
75 * The format of the information available at Info Pointer after Octeon
76 * has posted a packet. Not all descriptors have valid information. Only
77 * the Info field of the first descriptor for a packet has information
80 struct lio_droq_info {
81 /** The Output Receive Header. */
84 /** The Length of the packet. */
88 #define LIO_DROQ_INFO_SIZE (sizeof(struct lio_droq_info))
90 /** Pointer to data buffer.
91 * Driver keeps a pointer to the data buffer that it made available to
92 * the Octeon device. Since the descriptor ring keeps physical (bus)
93 * addresses, this field is required for the driver to keep track of
94 * the virtual address pointers.
96 struct lio_recv_buffer {
97 /** Packet buffer, including meta data. */
100 /** Data in the packet buffer. */
105 #define LIO_DROQ_RECVBUF_SIZE (sizeof(struct lio_recv_buffer))
107 #define LIO_DROQ_SIZE (sizeof(struct lio_droq))
109 #define LIO_IQ_SEND_OK 0
110 #define LIO_IQ_SEND_STOP 1
111 #define LIO_IQ_SEND_FAILED -1
114 #define LIO_REQTYPE_NONE 0
115 #define LIO_REQTYPE_NORESP_NET 1
116 #define LIO_REQTYPE_NORESP_NET_SG 2
117 #define LIO_REQTYPE_SOFT_COMMAND 3
119 struct lio_request_list {
124 /*---------------------- INSTRUCTION FORMAT ----------------------------*/
126 struct lio_instr3_64B {
127 /** Pointer where the input data is available. */
130 /** Instruction Header. */
133 /** Instruction Header. */
136 /** Input Request Header. */
139 /** opcode/subcode specific parameters */
142 /** Return Data Parameters */
145 /** Pointer where the response for a RAW mode packet will be written
152 union lio_instr_64B {
153 struct lio_instr3_64B cmd3;
156 /** The size of each buffer in soft command buffer pool */
157 #define LIO_SOFT_COMMAND_BUFFER_SIZE 1536
159 /** Maximum number of buffers to allocate into soft command buffer pool */
160 #define LIO_MAX_SOFT_COMMAND_BUFFERS 255
162 struct lio_soft_command {
163 /** Soft command buffer info. */
164 struct lio_stailq_node node;
168 /** Command and return status */
169 union lio_instr_64B cmd;
171 #define LIO_COMPLETION_WORD_INIT 0xffffffffffffffffULL
172 uint64_t *status_word;
174 /** Data buffer info */
179 /** Return buffer info */
184 /** Context buffer info */
188 /** Time out and callback */
192 void (*callback)(uint32_t, void *);
194 struct rte_mbuf *mbuf;
197 struct lio_iq_post_status {
223 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
226 uint64_t more : 6; /* How many udd words follow the command */
228 uint64_t reserved : 29;
230 uint64_t param1 : 16;
234 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
238 uint64_t param1 : 16;
240 uint64_t reserved : 29;
250 #define OCTEON_CMD_SIZE (sizeof(union octeon_cmd))
252 /* Instruction Header */
253 struct octeon_instr_ih3 {
254 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
257 uint64_t reserved3 : 1;
259 /** Gather indicator 1=gather*/
262 /** Data length OR no. of entries in gather list */
263 uint64_t dlengsz : 14;
265 /** Front Data size */
269 uint64_t reserved2 : 4;
271 /** PKI port kind - PKIND */
275 uint64_t reserved1 : 32;
277 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
279 uint64_t reserved1 : 32;
281 /** PKI port kind - PKIND */
285 uint64_t reserved2 : 4;
287 /** Front Data size */
290 /** Data length OR no. of entries in gather list */
291 uint64_t dlengsz : 14;
293 /** Gather indicator 1=gather*/
297 uint64_t reserved3 : 1;
302 /* PKI Instruction Header(PKI IH) */
303 struct octeon_instr_pki_ih3 {
304 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
309 /** Raw mode indicator 1 = RAW */
319 uint64_t reserved2 : 1;
331 uint64_t tagtype : 2;
334 uint64_t reserved1 : 2;
342 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
351 uint64_t reserved1 : 2;
354 uint64_t tagtype : 2;
366 uint64_t reserved2 : 1;
374 /** Raw mode indicator 1 = RAW */
382 /** Input Request Header */
383 struct octeon_instr_irh {
384 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
387 uint64_t subcode : 7;
389 uint64_t priority : 3;
390 uint64_t reserved : 5;
391 uint64_t ossp : 32; /* opcode/subcode specific parameters */
392 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
393 uint64_t ossp : 32; /* opcode/subcode specific parameters */
394 uint64_t reserved : 5;
395 uint64_t priority : 3;
397 uint64_t subcode : 7;
403 /* pkiih3 + irh + ossp[0] + ossp[1] + rdp + rptr = 40 bytes */
404 #define OCTEON_SOFT_CMD_RESP_IH3 (40 + 8)
405 /* pki_h3 + irh + ossp[0] + ossp[1] = 32 bytes */
406 #define OCTEON_PCI_CMD_O3 (24 + 8)
408 /** Return Data Parameters */
409 struct octeon_instr_rdp {
410 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
411 uint64_t reserved : 49;
412 uint64_t pcie_port : 3;
414 #elif RTE_BYTE_ORDER == RTE_LITTLE_ENDIAN
416 uint64_t pcie_port : 3;
417 uint64_t reserved : 49;
421 int lio_setup_sc_buffer_pool(struct lio_device *lio_dev);
422 void lio_free_sc_buffer_pool(struct lio_device *lio_dev);
424 struct lio_soft_command *
425 lio_alloc_soft_command(struct lio_device *lio_dev,
426 uint32_t datasize, uint32_t rdatasize,
428 void lio_prepare_soft_command(struct lio_device *lio_dev,
429 struct lio_soft_command *sc,
430 uint8_t opcode, uint8_t subcode,
431 uint32_t irh_ossp, uint64_t ossp0,
433 int lio_send_soft_command(struct lio_device *lio_dev,
434 struct lio_soft_command *sc);
435 void lio_free_soft_command(struct lio_soft_command *sc);
437 /** Maximum ordered requests to process in every invocation of
438 * lio_process_ordered_list(). The function will continue to process requests
439 * as long as it can find one that has finished processing. If it keeps
440 * finding requests that have completed, the function can run for ever. The
441 * value defined here sets an upper limit on the number of requests it can
442 * process before it returns control to the poll thread.
444 #define LIO_MAX_ORD_REQS_TO_PROCESS 4096
446 /** Error codes used in Octeon Host-Core communication.
449 * ----------------------------
451 * ----------------------------
452 * Error codes are 32-bit wide. The upper 16-bits, called Major Error Number,
453 * are reserved to identify the group to which the error code belongs. The
454 * lower 16-bits, called Minor Error Number, carry the actual code.
456 * So error codes are (MAJOR NUMBER << 16)| MINOR_NUMBER.
458 /** Status for a request.
459 * If the request is successfully queued, the driver will return
460 * a LIO_REQUEST_PENDING status. LIO_REQUEST_TIMEOUT is only returned by
461 * the driver if the response for request failed to arrive before a
462 * time-out period or if the request processing * got interrupted due to
463 * a signal respectively.
466 /** A value of 0x00000000 indicates no error i.e. success */
467 LIO_REQUEST_DONE = 0x00000000,
468 /** (Major number: 0x0000; Minor Number: 0x0001) */
469 LIO_REQUEST_PENDING = 0x00000001,
470 LIO_REQUEST_TIMEOUT = 0x00000003,
474 /*------ Error codes used by firmware (bits 15..0 set by firmware */
475 #define LIO_FIRMWARE_MAJOR_ERROR_CODE 0x0001
476 #define LIO_FIRMWARE_STATUS_CODE(status) \
477 ((LIO_FIRMWARE_MAJOR_ERROR_CODE << 16) | (status))
479 /** Initialize the response lists. The number of response lists to create is
481 * @param lio_dev - the lio device structure.
483 void lio_setup_response_list(struct lio_device *lio_dev);
485 /** Check the status of first entry in the ordered list. If the instruction at
486 * that entry finished processing or has timed-out, the entry is cleaned.
487 * @param lio_dev - the lio device structure.
488 * @return 1 if the ordered list is empty, 0 otherwise.
490 int lio_process_ordered_list(struct lio_device *lio_dev);
493 lio_swap_8B_data(uint64_t *data, uint32_t blocks)
496 *data = rte_cpu_to_be_64(*data);
502 static inline uint64_t
503 lio_map_ring(void *buf)
505 phys_addr_t dma_addr;
507 dma_addr = rte_mbuf_data_dma_addr_default(((struct rte_mbuf *)buf));
509 return (uint64_t)dma_addr;
512 static inline uint64_t
513 lio_map_ring_info(struct lio_droq *droq, uint32_t i)
515 phys_addr_t dma_addr;
517 dma_addr = droq->info_list_dma + (i * LIO_DROQ_INFO_SIZE);
519 return (uint64_t)dma_addr;
523 lio_opcode_slow_path(union octeon_rh *rh)
525 uint16_t subcode1, subcode2;
527 subcode1 = LIO_OPCODE_SUBCODE(rh->r.opcode, rh->r.subcode);
528 subcode2 = LIO_OPCODE_SUBCODE(LIO_OPCODE, LIO_OPCODE_NW_DATA);
530 return subcode2 != subcode1;
533 /* Macro to increment index.
534 * Index is incremented by count; if the sum exceeds
535 * max, index is wrapped-around to the start.
537 static inline uint32_t
538 lio_incr_index(uint32_t index, uint32_t count, uint32_t max)
540 if ((index + count) >= max)
541 index = index + count - max;
548 int lio_setup_droq(struct lio_device *lio_dev, int q_no, int num_descs,
549 int desc_size, struct rte_mempool *mpool,
550 unsigned int socket_id);
551 uint16_t lio_dev_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
553 void lio_delete_droq_queue(struct lio_device *lio_dev, int oq_no);
555 int lio_setup_sglists(struct lio_device *lio_dev, int iq_no,
556 int fw_mapped_iq, int num_descs, unsigned int socket_id);
557 int lio_setup_iq(struct lio_device *lio_dev, int q_index,
558 union octeon_txpciq iq_no, uint32_t num_descs, void *app_ctx,
559 unsigned int socket_id);
560 void lio_delete_instruction_queue(struct lio_device *lio_dev, int iq_no);
561 /** Setup instruction queue zero for the device
562 * @param lio_dev which lio device to setup
564 * @return 0 if success. -1 if fails
566 int lio_setup_instr_queue0(struct lio_device *lio_dev);
567 void lio_free_instr_queue0(struct lio_device *lio_dev);
568 #endif /* _LIO_RXTX_H_ */