1 /**********************************************************************
4 * Contact: support@cavium.com
5 * Please include "LiquidIO" in the subject.
7 * Copyright (c) 2003-2015 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
19 * This file may also be available under a different license from Cavium.
20 * Contact Cavium, Inc. for more information
21 **********************************************************************/
23 /*! \file octeon_network.h
24 * \brief Host NIC Driver: Structure and Macro definitions used by NIC Module.
27 #ifndef __OCTEON_NETWORK_H__
28 #define __OCTEON_NETWORK_H__
29 #include <linux/ptp_clock_kernel.h>
31 #define LIO_MAX_MTU_SIZE (OCTNET_MAX_FRM_SIZE - OCTNET_FRM_HEADER_SIZE)
32 #define LIO_MIN_MTU_SIZE 68
34 struct oct_nic_stats_resp {
36 struct oct_link_stats stats;
40 struct oct_nic_stats_ctrl {
41 struct completion complete;
42 struct net_device *netdev;
45 /** LiquidIO per-interface network private data */
47 /** State of the interface. Rx/Tx happens only in the RUNNING state. */
50 /** Octeon Interface index number. This device will be represented as
51 * oct<ifidx> in the system.
55 /** Octeon Input queue to use to transmit for this network interface. */
58 /** Octeon Output queue from which pkts arrive
59 * for this network interface.
63 /** Guards each glist */
64 spinlock_t *glist_lock;
66 /** Array of gather component linked lists */
67 struct list_head *glist;
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;
131 #define LIO_SIZE (sizeof(struct lio))
132 #define GET_LIO(netdev) ((struct lio *)netdev_priv(netdev))
134 #define CIU3_WDOG(c) (0x1010000020000ULL + (c << 3))
135 #define CIU3_WDOG_MASK 12ULL
136 #define LIO_MONITOR_WDOG_EXPIRE 1
137 #define LIO_MONITOR_CORE_STUCK_MSGD 2
138 #define LIO_MAX_CORES 12
141 * \brief Enable or disable feature
142 * @param netdev pointer to network device
143 * @param cmd Command that just requires acknowledgment
144 * @param param1 Parameter to command
146 int liquidio_set_feature(struct net_device *netdev, int cmd, u16 param1);
149 * \brief Link control command completion callback
150 * @param nctrl_ptr pointer to control packet structure
152 * This routine is called by the callback function when a ctrl pkt sent to
153 * core app completes. The nctrl_ptr contains a copy of the command type
154 * and data sent to the core app. This routine is only called if the ctrl
155 * pkt was sent successfully to the core app.
157 void liquidio_link_ctrl_cmd_completion(void *nctrl_ptr);
160 * \brief Register ethtool operations
161 * @param netdev pointer to network device
163 void liquidio_set_ethtool_ops(struct net_device *netdev);
165 #define SKB_ADJ_MASK 0x3F
166 #define SKB_ADJ (SKB_ADJ_MASK + 1)
168 #define MIN_SKB_SIZE 256 /* 8 bytes and more - 8 bytes for PTP */
169 #define LIO_RXBUFFER_SZ 2048
172 *recv_buffer_alloc(struct octeon_device *oct,
173 struct octeon_skb_page_info *pg_info)
177 struct octeon_skb_page_info *skb_pg_info;
179 page = alloc_page(GFP_ATOMIC | __GFP_COLD);
183 skb = dev_alloc_skb(MIN_SKB_SIZE + SKB_ADJ);
184 if (unlikely(!skb)) {
186 pg_info->page = NULL;
190 if ((unsigned long)skb->data & SKB_ADJ_MASK) {
191 u32 r = SKB_ADJ - ((unsigned long)skb->data & SKB_ADJ_MASK);
196 skb_pg_info = ((struct octeon_skb_page_info *)(skb->cb));
198 pg_info->dma = dma_map_page(&oct->pci_dev->dev, page, 0,
199 PAGE_SIZE, DMA_FROM_DEVICE);
201 /* Mapping failed!! */
202 if (dma_mapping_error(&oct->pci_dev->dev, pg_info->dma)) {
204 dev_kfree_skb_any((struct sk_buff *)skb);
205 pg_info->page = NULL;
209 pg_info->page = page;
210 pg_info->page_offset = 0;
211 skb_pg_info->page = page;
212 skb_pg_info->page_offset = 0;
213 skb_pg_info->dma = pg_info->dma;
219 *recv_buffer_fast_alloc(u32 size)
222 struct octeon_skb_page_info *skb_pg_info;
224 skb = dev_alloc_skb(size + SKB_ADJ);
228 if ((unsigned long)skb->data & SKB_ADJ_MASK) {
229 u32 r = SKB_ADJ - ((unsigned long)skb->data & SKB_ADJ_MASK);
234 skb_pg_info = ((struct octeon_skb_page_info *)(skb->cb));
235 skb_pg_info->page = NULL;
236 skb_pg_info->page_offset = 0;
237 skb_pg_info->dma = 0;
243 recv_buffer_recycle(struct octeon_device *oct, void *buf)
245 struct octeon_skb_page_info *pg_info = buf;
247 if (!pg_info->page) {
248 dev_err(&oct->pci_dev->dev, "%s: pg_info->page NULL\n",
253 if (unlikely(page_count(pg_info->page) != 1) ||
254 unlikely(page_to_nid(pg_info->page) != numa_node_id())) {
255 dma_unmap_page(&oct->pci_dev->dev,
256 pg_info->dma, (PAGE_SIZE << 0),
259 pg_info->page = NULL;
260 pg_info->page_offset = 0;
264 /* Flip to other half of the buffer */
265 if (pg_info->page_offset == 0)
266 pg_info->page_offset = LIO_RXBUFFER_SZ;
268 pg_info->page_offset = 0;
269 page_ref_inc(pg_info->page);
275 *recv_buffer_reuse(struct octeon_device *oct, void *buf)
277 struct octeon_skb_page_info *pg_info = buf, *skb_pg_info;
280 skb = dev_alloc_skb(MIN_SKB_SIZE + SKB_ADJ);
281 if (unlikely(!skb)) {
282 dma_unmap_page(&oct->pci_dev->dev,
283 pg_info->dma, (PAGE_SIZE << 0),
288 if ((unsigned long)skb->data & SKB_ADJ_MASK) {
289 u32 r = SKB_ADJ - ((unsigned long)skb->data & SKB_ADJ_MASK);
294 skb_pg_info = ((struct octeon_skb_page_info *)(skb->cb));
295 skb_pg_info->page = pg_info->page;
296 skb_pg_info->page_offset = pg_info->page_offset;
297 skb_pg_info->dma = pg_info->dma;
303 recv_buffer_destroy(void *buffer, struct octeon_skb_page_info *pg_info)
305 struct sk_buff *skb = (struct sk_buff *)buffer;
307 put_page(pg_info->page);
309 pg_info->page = NULL;
310 pg_info->page_offset = 0;
313 dev_kfree_skb_any(skb);
316 static inline void recv_buffer_free(void *buffer)
318 struct sk_buff *skb = (struct sk_buff *)buffer;
319 struct octeon_skb_page_info *pg_info;
321 pg_info = ((struct octeon_skb_page_info *)(skb->cb));
324 put_page(pg_info->page);
326 pg_info->page = NULL;
327 pg_info->page_offset = 0;
330 dev_kfree_skb_any((struct sk_buff *)buffer);
334 recv_buffer_fast_free(void *buffer)
336 dev_kfree_skb_any((struct sk_buff *)buffer);
339 static inline void tx_buffer_free(void *buffer)
341 dev_kfree_skb_any((struct sk_buff *)buffer);
344 #define lio_dma_alloc(oct, size, dma_addr) \
345 dma_alloc_coherent(&oct->pci_dev->dev, size, dma_addr, GFP_KERNEL)
346 #define lio_dma_free(oct, size, virt_addr, dma_addr) \
347 dma_free_coherent(&oct->pci_dev->dev, size, virt_addr, dma_addr)
350 void *get_rbd(struct sk_buff *skb)
352 struct octeon_skb_page_info *pg_info;
355 pg_info = ((struct octeon_skb_page_info *)(skb->cb));
356 va = page_address(pg_info->page) + pg_info->page_offset;
362 lio_map_ring_info(struct octeon_droq *droq, u32 i)
365 struct octeon_device *oct = droq->oct_dev;
367 dma_addr = dma_map_single(&oct->pci_dev->dev, &droq->info_list[i],
368 OCT_DROQ_INFO_SIZE, DMA_FROM_DEVICE);
370 WARN_ON(dma_mapping_error(&oct->pci_dev->dev, dma_addr));
372 return (u64)dma_addr;
376 lio_unmap_ring_info(struct pci_dev *pci_dev,
377 u64 info_ptr, u32 size)
379 dma_unmap_single(&pci_dev->dev, info_ptr, size, DMA_FROM_DEVICE);
383 lio_map_ring(void *buf)
387 struct sk_buff *skb = (struct sk_buff *)buf;
388 struct octeon_skb_page_info *pg_info;
390 pg_info = ((struct octeon_skb_page_info *)(skb->cb));
391 if (!pg_info->page) {
392 pr_err("%s: pg_info->page NULL\n", __func__);
397 dma_addr = pg_info->dma;
399 pr_err("%s: ERROR it should be already available\n",
403 dma_addr += pg_info->page_offset;
405 return (u64)dma_addr;
409 lio_unmap_ring(struct pci_dev *pci_dev,
413 dma_unmap_page(&pci_dev->dev,
414 buf_ptr, (PAGE_SIZE << 0),
418 static inline void *octeon_fast_packet_alloc(u32 size)
420 return recv_buffer_fast_alloc(size);
423 static inline void octeon_fast_packet_next(struct octeon_droq *droq,
424 struct sk_buff *nicbuf,
428 memcpy(skb_put(nicbuf, copy_len),
429 get_rbd(droq->recv_buf_list[idx].buffer), copy_len);