1 /**********************************************************************
4 * Contact: support@cavium.com
5 * Please include "LiquidIO" in the subject.
7 * Copyright (c) 2003-2016 Cavium, Inc.
9 * This file is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License, Version 2, as
11 * published by the Free Software Foundation.
13 * This file is distributed in the hope that it will be useful, but
14 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty
15 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
16 * NONINFRINGEMENT. See the GNU General Public License for more details.
17 ***********************************************************************/
18 /*! \file octeon_droq.h
19 * \brief Implementation of Octeon Output queues. "Output" is with
20 * respect to the Octeon device on the NIC. From this driver's point of
21 * view they are ingress queues.
24 #ifndef __OCTEON_DROQ_H__
25 #define __OCTEON_DROQ_H__
27 /* Default number of packets that will be processed in one iteration. */
28 #define MAX_PACKET_BUDGET 0xFFFFFFFF
30 /** Octeon descriptor format.
31 * The descriptor ring is made of descriptors which have 2 64-bit values:
32 * -# Physical (bus) address of the data buffer.
33 * -# Physical (bus) address of a octeon_droq_info structure.
34 * The Octeon device DMA's incoming packets and its information at the address
35 * given by these descriptor fields.
37 struct octeon_droq_desc {
38 /** The buffer pointer */
41 /** The Info pointer */
45 #define OCT_DROQ_DESC_SIZE (sizeof(struct octeon_droq_desc))
47 /** Information about packet DMA'ed by Octeon.
48 * The format of the information available at Info Pointer after Octeon
49 * has posted a packet. Not all descriptors have valid information. Only
50 * the Info field of the first descriptor for a packet has information
53 struct octeon_droq_info {
54 /** The Output Receive Header. */
57 /** The Length of the packet. */
61 #define OCT_DROQ_INFO_SIZE (sizeof(struct octeon_droq_info))
63 struct octeon_skb_page_info {
64 /* DMA address for the page */
67 /* Page for the rx dma **/
70 /** which offset into page */
71 unsigned int page_offset;
74 /** Pointer to data buffer.
75 * Driver keeps a pointer to the data buffer that it made available to
76 * the Octeon device. Since the descriptor ring keeps physical (bus)
77 * addresses, this field is required for the driver to keep track of
78 * the virtual address pointers.
80 struct octeon_recv_buffer {
81 /** Packet buffer, including metadata. */
84 /** Data in the packet buffer. */
88 struct octeon_skb_page_info pg_info;
91 #define OCT_DROQ_RECVBUF_SIZE (sizeof(struct octeon_recv_buffer))
93 /** Output Queue statistics. Each output queue has four stats fields. */
94 struct oct_droq_stats {
95 /** Number of packets received in this queue. */
98 /** Bytes received by this queue. */
101 /** Packets dropped due to no dispatch function. */
102 u64 dropped_nodispatch;
104 /** Packets dropped due to no memory available. */
107 /** Packets dropped due to large number of pkts to process. */
110 /** Number of packets sent to stack from this queue. */
111 u64 rx_pkts_received;
113 /** Number of Bytes sent to stack from this queue. */
114 u64 rx_bytes_received;
116 /** Num of Packets dropped due to receive path failures. */
121 /** Num of failures of recv_buffer_alloc() */
122 u64 rx_alloc_failure;
126 #define POLL_EVENT_INTR_ARRIVED 1
127 #define POLL_EVENT_PROCESS_PKTS 2
128 #define POLL_EVENT_PENDING_PKTS 3
129 #define POLL_EVENT_ENABLE_INTR 4
131 /* The maximum number of buffers that can be dispatched from the
132 * output/dma queue. Set to 64 assuming 1K buffers in DROQ and the fact that
133 * max packet size from DROQ is 64K.
135 #define MAX_RECV_BUFS 64
137 /** Receive Packet format used when dispatching output queue packets
138 * with non-raw opcodes.
139 * The received packet will be sent to the upper layers using this
140 * structure which is passed as a parameter to the dispatch function
142 struct octeon_recv_pkt {
143 /** Number of buffers in this received packet */
146 /** Id of the device that is sending the packet up */
149 /** Length of data in the packet buffer */
152 /** The receive header */
155 /** Pointer to the OS-specific packet buffer */
156 void *buffer_ptr[MAX_RECV_BUFS];
158 /** Size of the buffers pointed to by ptr's in buffer_ptr */
159 u32 buffer_size[MAX_RECV_BUFS];
162 #define OCT_RECV_PKT_SIZE (sizeof(struct octeon_recv_pkt))
164 /** The first parameter of a dispatch function.
165 * For a raw mode opcode, the driver dispatches with the device
166 * pointer in this structure.
167 * For non-raw mode opcode, the driver dispatches the recv_pkt
168 * created to contain the buffers with data received from Octeon.
169 * ---------------------
170 * | *recv_pkt ----|---
171 * |-------------------| |
172 * | 0 or more bytes | |
173 * | reserved by driver| |
174 * |-------------------|<-/
175 * | octeon_recv_pkt |
177 * |___________________|
179 struct octeon_recv_info {
181 struct octeon_recv_pkt *recv_pkt;
184 #define OCT_RECV_INFO_SIZE (sizeof(struct octeon_recv_info))
186 /** Allocate a recv_info structure. The recv_pkt pointer in the recv_info
187 * structure is filled in before this call returns.
188 * @param extra_bytes - extra bytes to be allocated at the end of the recv info
190 * @return - pointer to a newly allocated recv_info structure.
192 static inline struct octeon_recv_info *octeon_alloc_recv_info(int extra_bytes)
194 struct octeon_recv_info *recv_info;
197 buf = kmalloc(OCT_RECV_PKT_SIZE + OCT_RECV_INFO_SIZE +
198 extra_bytes, GFP_ATOMIC);
202 recv_info = (struct octeon_recv_info *)buf;
203 recv_info->recv_pkt =
204 (struct octeon_recv_pkt *)(buf + OCT_RECV_INFO_SIZE);
205 recv_info->rsvd = NULL;
207 recv_info->rsvd = buf + OCT_RECV_INFO_SIZE + OCT_RECV_PKT_SIZE;
212 /** Free a recv_info structure.
213 * @param recv_info - Pointer to receive_info to be freed
215 static inline void octeon_free_recv_info(struct octeon_recv_info *recv_info)
220 typedef int (*octeon_dispatch_fn_t)(struct octeon_recv_info *, void *);
222 /** Used by NIC module to register packet handler and to get device
223 * information for each octeon device.
225 struct octeon_droq_ops {
226 /** This registered function will be called by the driver with
227 * the octeon id, pointer to buffer from droq and length of
228 * data in the buffer. The receive header gives the port
229 * number to the caller. Function pointer is set by caller.
231 void (*fptr)(u32, void *, u32, union octeon_rh *, void *, void *);
234 /* This function will be called by the driver for all NAPI related
235 * events. The first param is the octeon id. The second param is the
236 * output queue number. The third is the NAPI event that occurred.
238 void (*napi_fn)(void *);
242 /** Flag indicating if the DROQ handler should drop packets that
243 * it cannot handle in one iteration. Set by caller.
248 /** The Descriptor Ring Output Queue structure.
249 * This structure has all the information required to implement a
253 /** A spinlock to protect access to this ring. */
260 struct octeon_droq_ops ops;
262 struct octeon_device *oct_dev;
264 /** The 8B aligned descriptor ring starts at this address. */
265 struct octeon_droq_desc *desc_ring;
267 /** Index in the ring where the driver should read the next packet */
270 /** Index in the ring where Octeon will write the next packet */
273 /** Index in the ring where the driver will refill the descriptor's
278 /** Packets pending to be processed */
279 atomic_t pkts_pending;
281 /** Number of descriptors in this ring. */
284 /** The number of descriptors pending refill. */
288 u32 refill_threshold;
290 /** The max number of descriptors in DROQ without a buffer.
291 * This field is used to keep track of empty space threshold. If the
292 * refill_count reaches this value, the DROQ cannot accept a max-sized
297 /** The 8B aligned info ptrs begin from this address. */
298 struct octeon_droq_info *info_list;
300 /** The receive buffer list. This list has the virtual addresses of the
303 struct octeon_recv_buffer *recv_buf_list;
305 /** The size of each buffer pointed by the buffer pointer. */
308 /** Pointer to the mapped packet credit register.
309 * Host writes number of info/buffer ptrs available to this register
311 void __iomem *pkts_credit_reg;
313 /** Pointer to the mapped packet sent register.
314 * Octeon writes the number of packets DMA'ed to host memory
317 void __iomem *pkts_sent_reg;
319 struct list_head dispatch_list;
321 /** Statistics for this DROQ. */
322 struct oct_droq_stats stats;
324 /** DMA mapped address of the DROQ descriptor ring. */
325 size_t desc_ring_dma;
327 /** Info ptr list are allocated at this virtual address. */
328 void *info_base_addr;
330 /** DMA mapped address of the info list */
331 dma_addr_t info_list_dma;
333 /** Allocated size of info list. */
336 /** application context */
339 struct napi_struct napi;
343 struct call_single_data csd;
346 #define OCT_DROQ_SIZE (sizeof(struct octeon_droq))
349 * Allocates space for the descriptor ring for the droq and sets the
350 * base addr, num desc etc in Octeon registers.
352 * @param oct_dev - pointer to the octeon device structure
353 * @param q_no - droq no. ranges from 0 - 3.
354 * @param app_ctx - pointer to application context
355 * @return Success: 0 Failure: 1
357 int octeon_init_droq(struct octeon_device *oct_dev,
364 * Frees the space for descriptor ring for the droq.
366 * @param oct_dev - pointer to the octeon device structure
367 * @param q_no - droq no. ranges from 0 - 3.
368 * @return: Success: 0 Failure: 1
370 int octeon_delete_droq(struct octeon_device *oct_dev, u32 q_no);
372 /** Register a change in droq operations. The ops field has a pointer to a
373 * function which will called by the DROQ handler for all packets arriving
374 * on output queues given by q_no irrespective of the type of packet.
375 * The ops field also has a flag which if set tells the DROQ handler to
376 * drop packets if it receives more than what it can process in one
377 * invocation of the handler.
378 * @param oct - octeon device
379 * @param q_no - octeon output queue number (0 <= q_no <= MAX_OCTEON_DROQ-1
380 * @param ops - the droq_ops settings for this queue
381 * @return - 0 on success, -ENODEV or -EINVAL on error.
384 octeon_register_droq_ops(struct octeon_device *oct,
386 struct octeon_droq_ops *ops);
388 /** Resets the function pointer and flag settings made by
389 * octeon_register_droq_ops(). After this routine is called, the DROQ handler
390 * will lookup dispatch function for each arriving packet on the output queue
392 * @param oct - octeon device
393 * @param q_no - octeon output queue number (0 <= q_no <= MAX_OCTEON_DROQ-1
394 * @return - 0 on success, -ENODEV or -EINVAL on error.
396 int octeon_unregister_droq_ops(struct octeon_device *oct, u32 q_no);
398 /** Register a dispatch function for a opcode/subcode. The driver will call
399 * this dispatch function when it receives a packet with the given
400 * opcode/subcode in its output queues along with the user specified
402 * @param oct - the octeon device to register with.
403 * @param opcode - the opcode for which the dispatch will be registered.
404 * @param subcode - the subcode for which the dispatch will be registered
405 * @param fn - the dispatch function.
406 * @param fn_arg - user specified that will be passed along with the
407 * dispatch function by the driver.
408 * @return Success: 0; Failure: 1
410 int octeon_register_dispatch_fn(struct octeon_device *oct,
413 octeon_dispatch_fn_t fn, void *fn_arg);
415 void octeon_droq_print_stats(void);
417 u32 octeon_droq_check_hw_for_pkts(struct octeon_droq *droq);
419 int octeon_create_droq(struct octeon_device *oct, u32 q_no,
420 u32 num_descs, u32 desc_size, void *app_ctx);
422 int octeon_droq_process_packets(struct octeon_device *oct,
423 struct octeon_droq *droq,
426 int octeon_process_droq_poll_cmd(struct octeon_device *oct, u32 q_no,
429 #endif /*__OCTEON_DROQ_H__ */