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
18 **********************************************************************/
20 /*! \file octeon_network.h
21 * \brief Host NIC Driver: Structure and Macro definitions used by NIC Module.
24 #ifndef __OCTEON_NETWORK_H__
25 #define __OCTEON_NETWORK_H__
26 #include <linux/ptp_clock_kernel.h>
28 #define LIO_MAX_MTU_SIZE (OCTNET_MAX_FRM_SIZE - OCTNET_FRM_HEADER_SIZE)
29 #define LIO_MIN_MTU_SIZE ETH_MIN_MTU
31 struct oct_nic_stats_resp {
33 struct oct_link_stats stats;
37 struct oct_nic_stats_ctrl {
38 struct completion complete;
39 struct net_device *netdev;
42 /** LiquidIO per-interface network private data */
44 /** State of the interface. Rx/Tx happens only in the RUNNING state. */
47 /** Octeon Interface index number. This device will be represented as
48 * oct<ifidx> in the system.
52 /** Octeon Input queue to use to transmit for this network interface. */
55 /** Octeon Output queue from which pkts arrive
56 * for this network interface.
60 /** Guards each glist */
61 spinlock_t *glist_lock;
63 /** Array of gather component linked lists */
64 struct list_head *glist;
65 void **glists_virt_base;
66 dma_addr_t *glists_dma_base;
69 /** Pointer to the NIC properties for the Octeon device this network
70 * interface is associated with.
72 struct octdev_props *octprops;
74 /** Pointer to the octeon device structure. */
75 struct octeon_device *oct_dev;
77 struct net_device *netdev;
79 /** Link information sent by the core application for this interface. */
80 struct oct_link_info linfo;
82 /** counter of link changes */
85 /** Size of Tx queue for this octeon device. */
88 /** Size of Rx queue for this octeon device. */
91 /** Size of MTU this octeon device. */
94 /** msg level flag per interface. */
97 /** Copy of Interface capabilities: TSO, TSO6, LRO, Chescksums . */
100 /* Copy of transmit encapsulation capabilities:
101 * TSO, TSO6, Checksums for this device for Kernel
104 u64 enc_dev_capability;
106 /** Copy of beacaon reg in phy */
109 /** Copy of ctrl reg in phy */
112 /* PTP clock information */
113 struct ptp_clock_info ptp_info;
114 struct ptp_clock *ptp_clock;
117 /* for atomic access to Octeon PTP reg and data struct */
123 /* work queue for txq status */
124 struct cavium_wq txq_status_wq;
126 /* work queue for link status */
127 struct cavium_wq link_status_wq;
132 #define LIO_SIZE (sizeof(struct lio))
133 #define GET_LIO(netdev) ((struct lio *)netdev_priv(netdev))
135 #define CIU3_WDOG(c) (0x1010000020000ULL + ((c) << 3))
136 #define CIU3_WDOG_MASK 12ULL
137 #define LIO_MONITOR_WDOG_EXPIRE 1
138 #define LIO_MONITOR_CORE_STUCK_MSGD 2
139 #define LIO_MAX_CORES 12
142 * \brief Enable or disable feature
143 * @param netdev pointer to network device
144 * @param cmd Command that just requires acknowledgment
145 * @param param1 Parameter to command
147 int liquidio_set_feature(struct net_device *netdev, int cmd, u16 param1);
150 * \brief Link control command completion callback
151 * @param nctrl_ptr pointer to control packet structure
153 * This routine is called by the callback function when a ctrl pkt sent to
154 * core app completes. The nctrl_ptr contains a copy of the command type
155 * and data sent to the core app. This routine is only called if the ctrl
156 * pkt was sent successfully to the core app.
158 void liquidio_link_ctrl_cmd_completion(void *nctrl_ptr);
161 * \brief Register ethtool operations
162 * @param netdev pointer to network device
164 void liquidio_set_ethtool_ops(struct net_device *netdev);
166 #define SKB_ADJ_MASK 0x3F
167 #define SKB_ADJ (SKB_ADJ_MASK + 1)
169 #define MIN_SKB_SIZE 256 /* 8 bytes and more - 8 bytes for PTP */
170 #define LIO_RXBUFFER_SZ 2048
173 *recv_buffer_alloc(struct octeon_device *oct,
174 struct octeon_skb_page_info *pg_info)
178 struct octeon_skb_page_info *skb_pg_info;
180 page = alloc_page(GFP_ATOMIC | __GFP_COLD);
184 skb = dev_alloc_skb(MIN_SKB_SIZE + SKB_ADJ);
185 if (unlikely(!skb)) {
187 pg_info->page = NULL;
191 if ((unsigned long)skb->data & SKB_ADJ_MASK) {
192 u32 r = SKB_ADJ - ((unsigned long)skb->data & SKB_ADJ_MASK);
197 skb_pg_info = ((struct octeon_skb_page_info *)(skb->cb));
199 pg_info->dma = dma_map_page(&oct->pci_dev->dev, page, 0,
200 PAGE_SIZE, DMA_FROM_DEVICE);
202 /* Mapping failed!! */
203 if (dma_mapping_error(&oct->pci_dev->dev, pg_info->dma)) {
205 dev_kfree_skb_any((struct sk_buff *)skb);
206 pg_info->page = NULL;
210 pg_info->page = page;
211 pg_info->page_offset = 0;
212 skb_pg_info->page = page;
213 skb_pg_info->page_offset = 0;
214 skb_pg_info->dma = pg_info->dma;
220 *recv_buffer_fast_alloc(u32 size)
223 struct octeon_skb_page_info *skb_pg_info;
225 skb = dev_alloc_skb(size + SKB_ADJ);
229 if ((unsigned long)skb->data & SKB_ADJ_MASK) {
230 u32 r = SKB_ADJ - ((unsigned long)skb->data & SKB_ADJ_MASK);
235 skb_pg_info = ((struct octeon_skb_page_info *)(skb->cb));
236 skb_pg_info->page = NULL;
237 skb_pg_info->page_offset = 0;
238 skb_pg_info->dma = 0;
244 recv_buffer_recycle(struct octeon_device *oct, void *buf)
246 struct octeon_skb_page_info *pg_info = buf;
248 if (!pg_info->page) {
249 dev_err(&oct->pci_dev->dev, "%s: pg_info->page NULL\n",
254 if (unlikely(page_count(pg_info->page) != 1) ||
255 unlikely(page_to_nid(pg_info->page) != numa_node_id())) {
256 dma_unmap_page(&oct->pci_dev->dev,
257 pg_info->dma, (PAGE_SIZE << 0),
260 pg_info->page = NULL;
261 pg_info->page_offset = 0;
265 /* Flip to other half of the buffer */
266 if (pg_info->page_offset == 0)
267 pg_info->page_offset = LIO_RXBUFFER_SZ;
269 pg_info->page_offset = 0;
270 page_ref_inc(pg_info->page);
276 *recv_buffer_reuse(struct octeon_device *oct, void *buf)
278 struct octeon_skb_page_info *pg_info = buf, *skb_pg_info;
281 skb = dev_alloc_skb(MIN_SKB_SIZE + SKB_ADJ);
282 if (unlikely(!skb)) {
283 dma_unmap_page(&oct->pci_dev->dev,
284 pg_info->dma, (PAGE_SIZE << 0),
289 if ((unsigned long)skb->data & SKB_ADJ_MASK) {
290 u32 r = SKB_ADJ - ((unsigned long)skb->data & SKB_ADJ_MASK);
295 skb_pg_info = ((struct octeon_skb_page_info *)(skb->cb));
296 skb_pg_info->page = pg_info->page;
297 skb_pg_info->page_offset = pg_info->page_offset;
298 skb_pg_info->dma = pg_info->dma;
304 recv_buffer_destroy(void *buffer, struct octeon_skb_page_info *pg_info)
306 struct sk_buff *skb = (struct sk_buff *)buffer;
308 put_page(pg_info->page);
310 pg_info->page = NULL;
311 pg_info->page_offset = 0;
314 dev_kfree_skb_any(skb);
317 static inline void recv_buffer_free(void *buffer)
319 struct sk_buff *skb = (struct sk_buff *)buffer;
320 struct octeon_skb_page_info *pg_info;
322 pg_info = ((struct octeon_skb_page_info *)(skb->cb));
325 put_page(pg_info->page);
327 pg_info->page = NULL;
328 pg_info->page_offset = 0;
331 dev_kfree_skb_any((struct sk_buff *)buffer);
335 recv_buffer_fast_free(void *buffer)
337 dev_kfree_skb_any((struct sk_buff *)buffer);
340 static inline void tx_buffer_free(void *buffer)
342 dev_kfree_skb_any((struct sk_buff *)buffer);
345 #define lio_dma_alloc(oct, size, dma_addr) \
346 dma_alloc_coherent(&(oct)->pci_dev->dev, size, dma_addr, GFP_KERNEL)
347 #define lio_dma_free(oct, size, virt_addr, dma_addr) \
348 dma_free_coherent(&(oct)->pci_dev->dev, size, virt_addr, dma_addr)
351 lio_alloc_info_buffer(struct octeon_device *oct,
352 struct octeon_droq *droq)
356 virt_ptr = lio_dma_alloc(oct, (droq->max_count * OCT_DROQ_INFO_SIZE),
357 &droq->info_list_dma);
359 droq->info_alloc_size = droq->max_count * OCT_DROQ_INFO_SIZE;
360 droq->info_base_addr = virt_ptr;
366 static inline void lio_free_info_buffer(struct octeon_device *oct,
367 struct octeon_droq *droq)
369 lio_dma_free(oct, droq->info_alloc_size, droq->info_base_addr,
370 droq->info_list_dma);
374 void *get_rbd(struct sk_buff *skb)
376 struct octeon_skb_page_info *pg_info;
379 pg_info = ((struct octeon_skb_page_info *)(skb->cb));
380 va = page_address(pg_info->page) + pg_info->page_offset;
386 lio_map_ring_info(struct octeon_droq *droq, u32 i)
388 return droq->info_list_dma + (i * sizeof(struct octeon_droq_info));
392 lio_map_ring(void *buf)
396 struct sk_buff *skb = (struct sk_buff *)buf;
397 struct octeon_skb_page_info *pg_info;
399 pg_info = ((struct octeon_skb_page_info *)(skb->cb));
400 if (!pg_info->page) {
401 pr_err("%s: pg_info->page NULL\n", __func__);
406 dma_addr = pg_info->dma;
408 pr_err("%s: ERROR it should be already available\n",
412 dma_addr += pg_info->page_offset;
414 return (u64)dma_addr;
418 lio_unmap_ring(struct pci_dev *pci_dev,
422 dma_unmap_page(&pci_dev->dev,
423 buf_ptr, (PAGE_SIZE << 0),
427 static inline void *octeon_fast_packet_alloc(u32 size)
429 return recv_buffer_fast_alloc(size);
432 static inline void octeon_fast_packet_next(struct octeon_droq *droq,
433 struct sk_buff *nicbuf,
437 memcpy(skb_put(nicbuf, copy_len),
438 get_rbd(droq->recv_buf_list[idx].buffer), copy_len);