d4ca97546e7b970cb911b89a2dcfddc046836824
[akaros.git] / kern / include / linux_compat.h
1 /* Copyright (c) 2015 Google Inc.
2  * Copyright (C) 1991-2017, the Linux Kernel authors
3  *
4  * Dumping ground for converting between Akaros and Linux. */
5
6 #pragma once
7
8 #define ROS_KERN_LINUX_COMPAT_H
9
10 /* Common headers that most driver files will need */
11
12 #include <ros/common.h>
13 #include <assert.h>
14 #include <error.h>
15 #include <net/ip.h>
16 #include <kmalloc.h>
17 #include <kref.h>
18 #include <pmap.h>
19 #include <slab.h>
20 #include <smp.h>
21 #include <stdio.h>
22 #include <string.h>
23 #include <bitmap.h>
24 #include <umem.h>
25 #include <mmio.h>
26 #include <taskqueue.h>
27 #include <zlib.h>
28 #include <list.h>
29 #include <refd_pages.h>
30 #include <linux/errno.h>
31 /* temporary dumping ground */
32 #include "compat_todo.h"
33
34 //#define CONFIG_DCB
35 //#define CONFIG_NET_RX_BUSY_POLL 1
36 //#define CONFIG_NET_POLL_CONTROLLER 1
37 //#define CONFIG_INET 1         // will deal with this manually
38 #define CONFIG_PCI_MSI 1
39
40 static inline void synchronize_sched(void)
41 {
42         synchronize_rcu();
43 }
44
45 #define atomic_cmpxchg(_addr, _old, _new)                                      \
46 ({                                                                             \
47         typeof(_old) _ret;                                                         \
48         if (atomic_cas((_addr), (_old), (_new)))                                   \
49                 _ret = _old;                                                           \
50         else                                                                       \
51                 _ret = atomic_read(_addr);                                             \
52         _ret;                                                                      \
53 })
54
55 #define UINT_MAX UINT64_MAX
56 #define L1_CACHE_SHIFT (LOG2_UP(ARCH_CL_SIZE))
57 #define __stringify(x...) STRINGIFY(x)
58
59 /* Wanted to keep the _t variants in the code, in case that's useful in the
60  * future */
61 #define MIN_T(t, a, b) MIN(a, b)
62 #define MAX_T(t, a, b) MAX(a, b)
63 #define CLAMP(val, lo, hi) MIN((typeof(val))MAX(val, lo), hi)
64 #define CLAMP_T(t, val, lo, hi) CLAMP(val, lo, hi)
65
66 typedef physaddr_t dma_addr_t;
67 typedef int gfp_t;
68
69 /* these dma funcs are empty in linux with !CONFIG_NEED_DMA_MAP_STATE */
70 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
71 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
72 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
73 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
74 #define dma_unmap_len(PTR, LEN_NAME)             (0)
75 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
76 #define DMA_BIT_MASK(n) (((n) == 64) ? ~0ULL : ((1ULL << (n)) - 1))
77 #define DMA_MASK_NONE 0x0ULL
78
79 enum dma_data_direction {
80         DMA_BIDIRECTIONAL = 0,
81         DMA_TO_DEVICE = 1,
82         DMA_FROM_DEVICE = 2,
83         DMA_NONE = 3,
84 };
85
86 static inline void *__dma_alloc_coherent(size_t size, dma_addr_t *dma_handle,
87                                          gfp_t flags)
88 {
89         void *vaddr = get_cont_pages(LOG2_UP(nr_pages(size)), flags);
90
91         if (!vaddr) {
92                 *dma_handle = 0;
93                 return 0;
94         }
95         *dma_handle = PADDR(vaddr);
96         return vaddr;
97 }
98
99 static inline void *__dma_zalloc_coherent(size_t size, dma_addr_t *dma_handle,
100                                           gfp_t flags)
101 {
102         void *vaddr = __dma_alloc_coherent(size, dma_handle, flags);
103         if (vaddr)
104                 memset(vaddr, 0, size);
105         return vaddr;
106 }
107
108 static inline void __dma_free_coherent(size_t size, void *cpu_addr,
109                                        dma_addr_t dma_handle)
110 {
111         free_cont_pages(cpu_addr, LOG2_UP(nr_pages(size)));
112 }
113
114 static inline dma_addr_t __dma_map_single(void *cpu_addr, size_t size,
115                                           int direction)
116 {
117         return PADDR(cpu_addr);
118 }
119
120 static inline dma_addr_t __dma_map_page(struct page *page,
121                                         unsigned long offset, size_t size,
122                                         int direction)
123 {
124         assert(offset == 0);
125         return page2pa(page);
126 }
127
128 static inline int __dma_mapping_error(dma_addr_t dma_addr)
129 {
130         return (dma_addr == 0);
131 }
132
133 #define dma_unmap_single(...)
134 #define dma_unmap_page(...)
135 #define dma_set_mask_and_coherent(...) (0)
136 #define dma_sync_single_for_cpu(...)
137 #define dma_sync_single_for_device(...)
138
139 /* Wrappers to avoid struct device.  Might want that one of these days.
140  *
141  * Note dma_alloc_coherent() does a zalloc.  Some Linux drivers (r8169)
142  * accidentally assume the memory is zeroed, which may be what Linux allocators
143  * often do. */
144 #define dma_alloc_coherent(dev, size, dma_handlep, flag)                       \
145         __dma_zalloc_coherent(size, dma_handlep, flag)
146
147 #define dma_zalloc_coherent(dev, size, dma_handlep, flag)                      \
148         __dma_zalloc_coherent(size, dma_handlep, flag)
149
150 #define dma_free_coherent(dev, size, dma_handle, flag)                         \
151         __dma_free_coherent(size, dma_handle, flag)
152
153 #define dma_map_single(dev, addr, size, direction)                             \
154         __dma_map_single(addr, size, direction)
155
156 #define dma_map_page(dev, page, offset, size, direction)                       \
157         __dma_map_page(page, offset, size, direction)
158
159 #define dma_mapping_error(dev, handle)                                         \
160         __dma_mapping_error(handle)
161
162 static void *vmalloc(size_t size)
163 {
164         void *vaddr = get_cont_pages(LOG2_UP(nr_pages(size)), MEM_WAIT);
165         /* zalloc, to be safe */
166         if (vaddr)
167                 memset(vaddr, 0, size);
168         return vaddr;
169 }
170
171 /* Akaros needs to know the size, for now.  So it's not quite compatible */
172 static void vfree(void *vaddr, size_t size)
173 {
174         free_cont_pages(vaddr, LOG2_UP(nr_pages(size)));
175 }
176
177 typedef int pci_power_t;
178 typedef int pm_message_t;
179
180 #define DEFINE_SEMAPHORE(name)  \
181     struct semaphore name = SEMAPHORE_INITIALIZER_IRQSAVE(name, 1)
182 #define sema_init(sem, val) sem_init_irqsave(sem, val)
183 #define up(sem) sem_up(sem)
184 #define down(sem) sem_down(sem)
185 #define down_trylock(sem) ({!sem_trydown(sem);})
186 /* In lieu of spatching, I wanted to keep the distinction between down and
187  * down_interruptible/down_timeout.  Akaros doesn't have the latter. */
188 #define down_interruptible(sem) ({sem_down(sem); 0;})
189 #define down_timeout(sem, timeout) ({sem_down(sem); 0;})
190
191 static void msleep(unsigned int msecs)
192 {
193         kthread_usleep(msecs * 1000);
194 }
195
196 #define mdelay(x) udelay((x) * 1000)
197
198 #define local_bh_disable() cmb()
199 #define local_bh_enable() cmb()
200
201 /* Linux printk front ends */
202 #ifndef pr_fmt
203 #define pr_fmt(fmt) fmt
204 #endif
205
206 #define KERN_EMERG ""
207 #define KERN_ALERT ""
208 #define KERN_CRIT ""
209 #define KERN_ERR ""
210 #define KERN_WARNING ""
211 #define KERN_NOTICE ""
212 #define KERN_INFO ""
213 #define KERN_CONT ""
214 #define KERN_DEBUG ""
215
216 /*
217  * These can be used to print at the various log levels.
218  * All of these will print unconditionally, although note that pr_debug()
219  * and other debug macros are compiled out unless either DEBUG is defined
220  * or CONFIG_DYNAMIC_DEBUG is set.
221  */
222 #define pr_emerg(fmt, ...) \
223         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
224 #define pr_alert(fmt, ...) \
225         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
226 #define pr_crit(fmt, ...) \
227         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
228 #define pr_err(fmt, ...) \
229         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
230 #define pr_warning(fmt, ...) \
231         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
232 #define pr_warn pr_warning
233 #define pr_notice(fmt, ...) \
234         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
235 #define pr_info(fmt, ...) \
236         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
237 #define pr_cont(fmt, ...) \
238         printk(KERN_CONT pr_fmt(fmt), ##__VA_ARGS__)
239
240 #define __print_netif_name(dev) (dev)->drv_name[0] ? (dev)->drv_name : "netdev"
241
242 #define netdev_printk(lvl, dev, fmt, ...) \
243         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
244 #define netdev_err(dev, fmt, ...) \
245         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
246 #define netdev_info(dev, fmt, ...) \
247         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
248 #define netdev_dbg(dev, fmt, ...) \
249         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
250 #define netif_err(priv, type, dev, fmt, ...) \
251         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
252 #define netif_warn(priv, type, dev, fmt, ...) \
253         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
254 #define netif_notice(priv, type, dev, fmt, ...) \
255         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
256 #define netif_info(priv, type, dev, fmt, ...) \
257         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
258 #define netif_dbg(priv, type, dev, fmt, ...) \
259         printk("[%s]: " fmt, __print_netif_name(dev), ##__VA_ARGS__)
260
261 #define dev_err(dev, fmt, ...) \
262         printk("[dev]: " fmt, ##__VA_ARGS__)
263 #define dev_info(dev, fmt, ...) \
264         printk("[dev]: " fmt, ##__VA_ARGS__)
265 #define dev_alert(dev, fmt, ...) \
266         printk("[dev]: " fmt, ##__VA_ARGS__)
267
268 #ifdef DEBUG
269
270 #define might_sleep() assert(can_block(&per_cpu_info[core_id()]))
271 #define pr_devel(fmt, ...) \
272         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
273
274 #else
275
276 #define might_sleep()
277 #define pr_devel(fmt, ...) \
278         printd(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
279
280 #endif
281 #define pr_debug pr_devel
282
283
284 enum {
285         NETIF_MSG_DRV           = 0x0001,
286         NETIF_MSG_PROBE         = 0x0002,
287         NETIF_MSG_LINK          = 0x0004,
288         NETIF_MSG_TIMER         = 0x0008,
289         NETIF_MSG_IFDOWN        = 0x0010,
290         NETIF_MSG_IFUP          = 0x0020,
291         NETIF_MSG_RX_ERR        = 0x0040,
292         NETIF_MSG_TX_ERR        = 0x0080,
293         NETIF_MSG_TX_QUEUED     = 0x0100,
294         NETIF_MSG_INTR          = 0x0200,
295         NETIF_MSG_TX_DONE       = 0x0400,
296         NETIF_MSG_RX_STATUS     = 0x0800,
297         NETIF_MSG_PKTDATA       = 0x1000,
298         NETIF_MSG_HW            = 0x2000,
299         NETIF_MSG_WOL           = 0x4000,
300 };
301
302 #define MODULE_AUTHOR(...)
303 #define MODULE_DESCRIPTION(...)
304 #define MODULE_LICENSE(...)
305 #define MODULE_VERSION(...)
306 #define MODULE_FIRMWARE(...)
307 #define module_param(...)
308 #define module_param_named(...)
309 #define MODULE_PARM_DESC(...)
310 #define MODULE_DEVICE_TABLE(...)
311 #define THIS_MODULE ((void*)0)
312 #define EXPORT_SYMBOL(...)
313 #define __init
314 #define __exit
315 #define module_init(...)
316 #define module_exit(...)
317
318 #define is_kdump_kernel() (0)
319
320 /* from Linux's ethtool.h.  We probably won't use any of this code, but at
321  * least we can keep it quiet during porting. */
322 #define SPEED_10        10
323 #define SPEED_100       100
324 #define SPEED_1000      1000
325 #define SPEED_2500      2500
326 #define SPEED_10000     10000
327 #define SPEED_20000     20000
328 #define SPEED_40000     40000
329 #define SPEED_56000     56000
330 #define SPEED_UNKNOWN   -1
331
332 /* Duplex, half or full. */
333 #define DUPLEX_HALF     0x00
334 #define DUPLEX_FULL     0x01
335 #define DUPLEX_UNKNOWN  0xff
336
337 #define SUPPORTED_10baseT_Half      (1 << 0)
338 #define SUPPORTED_10baseT_Full      (1 << 1)
339 #define SUPPORTED_100baseT_Half     (1 << 2)
340 #define SUPPORTED_100baseT_Full     (1 << 3)
341 #define SUPPORTED_1000baseT_Half    (1 << 4)
342 #define SUPPORTED_1000baseT_Full    (1 << 5)
343 #define SUPPORTED_Autoneg       (1 << 6)
344 #define SUPPORTED_TP            (1 << 7)
345 #define SUPPORTED_AUI           (1 << 8)
346 #define SUPPORTED_MII           (1 << 9)
347 #define SUPPORTED_FIBRE         (1 << 10)
348 #define SUPPORTED_BNC           (1 << 11)
349 #define SUPPORTED_10000baseT_Full   (1 << 12)
350 #define SUPPORTED_Pause         (1 << 13)
351 #define SUPPORTED_Asym_Pause        (1 << 14)
352 #define SUPPORTED_2500baseX_Full    (1 << 15)
353 #define SUPPORTED_Backplane     (1 << 16)
354 #define SUPPORTED_1000baseKX_Full   (1 << 17)
355 #define SUPPORTED_10000baseKX4_Full (1 << 18)
356 #define SUPPORTED_10000baseKR_Full  (1 << 19)
357 #define SUPPORTED_10000baseR_FEC    (1 << 20)
358 #define SUPPORTED_20000baseMLD2_Full    (1 << 21)
359 #define SUPPORTED_20000baseKR2_Full (1 << 22)
360 #define SUPPORTED_40000baseKR4_Full (1 << 23)
361 #define SUPPORTED_40000baseCR4_Full (1 << 24)
362 #define SUPPORTED_40000baseSR4_Full (1 << 25)
363 #define SUPPORTED_40000baseLR4_Full (1 << 26)
364 #define SUPPORTED_56000baseKR4_Full (1 << 27)
365 #define SUPPORTED_56000baseCR4_Full (1 << 28)
366 #define SUPPORTED_56000baseSR4_Full (1 << 29)
367 #define SUPPORTED_56000baseLR4_Full (1 << 30)
368
369 #define ADVERTISED_10baseT_Half     (1 << 0)
370 #define ADVERTISED_10baseT_Full     (1 << 1)
371 #define ADVERTISED_100baseT_Half    (1 << 2)
372 #define ADVERTISED_100baseT_Full    (1 << 3)
373 #define ADVERTISED_1000baseT_Half   (1 << 4)
374 #define ADVERTISED_1000baseT_Full   (1 << 5)
375 #define ADVERTISED_Autoneg      (1 << 6)
376 #define ADVERTISED_TP           (1 << 7)
377 #define ADVERTISED_AUI          (1 << 8)
378 #define ADVERTISED_MII          (1 << 9)
379 #define ADVERTISED_FIBRE        (1 << 10)
380 #define ADVERTISED_BNC          (1 << 11)
381 #define ADVERTISED_10000baseT_Full  (1 << 12)
382 #define ADVERTISED_Pause        (1 << 13)
383 #define ADVERTISED_Asym_Pause       (1 << 14)
384 #define ADVERTISED_2500baseX_Full   (1 << 15)
385 #define ADVERTISED_Backplane        (1 << 16)
386 #define ADVERTISED_1000baseKX_Full  (1 << 17)
387 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
388 #define ADVERTISED_10000baseKR_Full (1 << 19)
389 #define ADVERTISED_10000baseR_FEC   (1 << 20)
390 #define ADVERTISED_20000baseMLD2_Full   (1 << 21)
391 #define ADVERTISED_20000baseKR2_Full    (1 << 22)
392 #define ADVERTISED_40000baseKR4_Full    (1 << 23)
393 #define ADVERTISED_40000baseCR4_Full    (1 << 24)
394 #define ADVERTISED_40000baseSR4_Full    (1 << 25)
395 #define ADVERTISED_40000baseLR4_Full    (1 << 26)
396 #define ADVERTISED_56000baseKR4_Full    (1 << 27)
397 #define ADVERTISED_56000baseCR4_Full    (1 << 28)
398 #define ADVERTISED_56000baseSR4_Full    (1 << 29)
399 #define ADVERTISED_56000baseLR4_Full    (1 << 30)
400
401 /* Wake-On-Lan options. */
402 #define WAKE_PHY        (1 << 0)
403 #define WAKE_UCAST      (1 << 1)
404 #define WAKE_MCAST      (1 << 2)
405 #define WAKE_BCAST      (1 << 3)
406 #define WAKE_ARP        (1 << 4)
407 #define WAKE_MAGIC      (1 << 5)
408 #define WAKE_MAGICSECURE    (1 << 6) /* only meaningful if WAKE_MAGIC */
409
410 /* Enable or disable autonegotiation. */
411 #define AUTONEG_DISABLE     0x00
412 #define AUTONEG_ENABLE      0x01
413
414 enum ethtool_test_flags {
415         ETH_TEST_FL_OFFLINE = (1 << 0),
416         ETH_TEST_FL_FAILED  = (1 << 1),
417         ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
418         ETH_TEST_FL_EXTERNAL_LB_DONE    = (1 << 3),
419 };
420
421 enum ethtool_stringset {
422         ETH_SS_TEST     = 0,
423         ETH_SS_STATS,
424         ETH_SS_PRIV_FLAGS,
425         ETH_SS_NTUPLE_FILTERS,
426         ETH_SS_FEATURES,
427         ETH_SS_RSS_HASH_FUNCS,
428 };
429
430 enum {
431         ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
432         ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
433
434         ETH_RSS_HASH_FUNCS_COUNT
435 };
436
437 #define __ETH_RSS_HASH_BIT(bit) ((uint32_t)1 << (bit))
438 #define __ETH_RSS_HASH(name)    __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
439
440 #define ETH_RSS_HASH_TOP    __ETH_RSS_HASH(TOP)
441 #define ETH_RSS_HASH_XOR    __ETH_RSS_HASH(XOR)
442
443 #define ETH_RSS_HASH_UNKNOWN    0
444 #define ETH_RSS_HASH_NO_CHANGE  0
445
446
447 /* EEPROM Standards for plug in modules */
448 #define ETH_MODULE_SFF_8079     0x1
449 #define ETH_MODULE_SFF_8079_LEN     256
450 #define ETH_MODULE_SFF_8472     0x2
451 #define ETH_MODULE_SFF_8472_LEN     512
452 #define ETH_MODULE_SFF_8636     0x3
453 #define ETH_MODULE_SFF_8636_LEN     256
454 #define ETH_MODULE_SFF_8436     0x4
455 #define ETH_MODULE_SFF_8436_LEN     256
456
457 #define ETH_GSTRING_LEN     32
458
459 /* ethernet protocol ids.  the plan 9 equivalent enum only exists in
460  * ethermedium.c. */
461 #define ETH_P_IP    0x0800      /* Internet Protocol packet */
462 #define ETH_P_IPV6  0x86DD      /* IPv6 over bluebook       */
463 #define ETH_P_ARP   0x0806      /* Address Resolution packet    */
464 #define ETH_P_FIP   0x8914      /* FCoE Initialization Protocol */
465 #define ETH_P_8021Q 0x8100          /* 802.1Q VLAN Extended Header  */
466
467 /* Sockaddr structs */
468 struct sockaddr {
469         uint16_t                                sa_family;
470         char                                    sa_data[14];
471 };
472
473 struct in_addr {
474         uint32_t                s_addr;
475 };
476 struct sockaddr_in {
477         uint16_t                                sin_family;
478         uint16_t                                sin_port;
479         struct in_addr                  sin_addr;
480         uint8_t                                 sin_zero[8]; /* padding */
481 };
482
483 struct in6_addr {
484         /* this is actually a weird union in glibc */
485         uint8_t                                 s6_addr[16];
486 };
487
488 struct sockaddr_in6 {
489         uint16_t                                sin6_family;
490         uint16_t                                sin6_port;
491         uint32_t                                sin6_flowinfo;
492         struct in6_addr                 sin6_addr;
493         uint32_t                                sin6_scope_id;
494 };
495
496 /* Common way to go from netdev (ether / netif) to driver-private ctlr */
497 static inline void *netdev_priv(struct ether *dev)
498 {
499         return dev->ctlr;
500 }
501
502 /* We do our linker table magic and other nonsense.  Keeping these around to
503  * show the code's intent. */
504 static int register_netdev(struct ether *dev)
505 {
506         return 0;
507 }
508
509 static void unregister_netdev(struct ether *dev)
510 {
511 }
512
513 static void free_netdev(struct ether *dev)
514 {
515 }
516
517 /* u64 on linux, but a u32 on plan 9.  the typedef is probably a good idea */
518 typedef unsigned int netdev_features_t;
519
520 /* Attempted conversions for plan 9 features.  For some things, like rx
521  * checksums, the driver flags the block (e.g. Budpck) to say if a receive
522  * checksum was already done.  There is no flag for saying the device can do
523  * it.  For transmits, the stack needs to know in advance if the device can
524  * handle the checksum or not. */
525 #define NETIF_F_RXHASH                          0
526 #define NETIF_F_RXCSUM                          NETF_RXCSUM
527 #define NETIF_F_LRO                                     NETF_LRO
528 #define NETIF_F_GRO                                     0
529 #define NETIF_F_LOOPBACK                        0
530 #define NETIF_F_TSO                                     NETF_TSO
531 #define NETIF_F_SG                                      NETF_SG
532 #define NETIF_F_IP_CSUM                         (NETF_IPCK | NETF_UDPCK | NETF_TCPCK)
533 #define NETIF_F_IPV6_CSUM                       (NETF_IPCK | NETF_UDPCK | NETF_TCPCK)
534 #define NETIF_F_GSO_GRE                         0
535 #define NETIF_F_GSO_UDP_TUNNEL          0
536 #define NETIF_F_GSO_IPIP                        0
537 #define NETIF_F_GSO_SIT                         0
538 #define NETIF_F_TSO_ECN                         0
539 #define NETIF_F_TSO6                            0
540 #define NETIF_F_HW_VLAN_CTAG_TX         0
541 #define NETIF_F_HIGHDMA                         0
542 #define NETIF_F_HW_VLAN_CTAG_RX         0
543 #define NETIF_F_TSO_MANGLEID            0
544 #define NETIF_F_ALL_TSO (NETIF_F_TSO | NETIF_F_TSO6 | NETIF_F_TSO_ECN | NETIF_F_TSO_MANGLEID)
545
546 #define netif_msg_drv(p)                ((p)->msg_enable & NETIF_MSG_DRV)
547 #define netif_msg_probe(p)              ((p)->msg_enable & NETIF_MSG_PROBE)
548 #define netif_msg_link(p)               ((p)->msg_enable & NETIF_MSG_LINK)
549 #define netif_msg_timer(p)              ((p)->msg_enable & NETIF_MSG_TIMER)
550 #define netif_msg_ifdown(p)             ((p)->msg_enable & NETIF_MSG_IFDOWN)
551 #define netif_msg_ifup(p)               ((p)->msg_enable & NETIF_MSG_IFUP)
552 #define netif_msg_rx_err(p)             ((p)->msg_enable & NETIF_MSG_RX_ERR)
553 #define netif_msg_tx_err(p)             ((p)->msg_enable & NETIF_MSG_TX_ERR)
554 #define netif_msg_tx_queued(p)  ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
555 #define netif_msg_intr(p)               ((p)->msg_enable & NETIF_MSG_INTR)
556 #define netif_msg_tx_done(p)    ((p)->msg_enable & NETIF_MSG_TX_DONE)
557 #define netif_msg_rx_status(p)  ((p)->msg_enable & NETIF_MSG_RX_STATUS)
558 #define netif_msg_pktdata(p)    ((p)->msg_enable & NETIF_MSG_PKTDATA)
559 #define netif_msg_hw(p)                 ((p)->msg_enable & NETIF_MSG_HW)
560 #define netif_msg_wol(p)                ((p)->msg_enable & NETIF_MSG_WOL)
561
562 static inline uint32_t netif_msg_init(int debug_value,
563                                       int default_msg_enable_bits)
564 {
565         /* use default */
566         if (debug_value < 0 || debug_value >= (sizeof(uint32_t) * 8))
567                 return default_msg_enable_bits;
568         if (debug_value == 0)   /* no output */
569                 return 0;
570         /* set low N bits */
571         return (1 << debug_value) - 1;
572 }
573
574 enum netdev_state_t {
575         __LINK_STATE_START,
576         __LINK_STATE_PRESENT,
577         __LINK_STATE_NOCARRIER,
578         __LINK_STATE_LINKWATCH_PENDING,
579         __LINK_STATE_DORMANT,
580 };
581
582 enum netdev_tx {
583         __NETDEV_TX_MIN  = INT32_MIN,   /* make sure enum is signed */
584         NETDEV_TX_OK     = 0x00,                /* driver took care of packet */
585         NETDEV_TX_BUSY   = 0x10,                /* driver tx path was busy*/
586         NETDEV_TX_LOCKED = 0x20,                /* driver tx lock was already taken */
587 };
588 typedef enum netdev_tx netdev_tx_t;
589
590 /* Global mutex in linux for "routing netlink".  Not sure if we have an
591  * equivalent or not in Plan 9. */
592 #define rtnl_lock()
593 #define rtnl_unlock()
594 #define ASSERT_RTNL(...)
595
596 #define synchronize_irq(x) warn_once("Asked to sync IRQ %d, unsupported", x)
597 #define HZ 1000
598
599 /* Linux has a PCI device id struct.  Drivers make tables of their supported
600  * devices, and this table is handled by higher level systems.  We don't have
601  * those systems, but we probably want the table still for our own parsing. */
602 struct pci_device_id {
603         uint32_t vendor, device;                /* Vendor and device ID or PCI_ANY_ID*/
604         uint32_t subvendor, subdevice;  /* Subsystem ID's or PCI_ANY_ID */
605         uint32_t class, class_mask;             /* (class,subclass,prog-if) triplet */
606         unsigned long driver_data;              /* Data private to the driver */
607 };
608
609 static const struct pci_device_id *
610 srch_linux_pci_tbl(const struct pci_device_id *tbl, struct pci_device *needle)
611 {
612         const struct pci_device_id *i;
613
614         for (i = tbl; i->vendor; i++) {
615                 if ((needle->ven_id == i->vendor) && (needle->dev_id == i->device))
616                         break;
617         }
618         if (i->vendor)
619                 return i;
620         return 0;
621 }
622
623 #define PCI_ANY_ID (~0)
624 /* This macro is used in setting device_id entries */
625 #define PCI_VDEVICE(vend, dev) \
626     .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
627     .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
628
629 #define PCI_DEVICE(vend, dev) \
630     .vendor = (vend), .device = (dev), \
631     .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
632
633 /* Linux also has its own table of vendor ids.  We have the pci_defs table, but
634  * this is a bootstrap issue. */
635 #define PCI_VENDOR_ID_BROADCOM      0x14e4
636 #define PCI_VENDOR_ID_REALTEK       0x10ec
637 #define PCI_VENDOR_ID_DLINK         0x1186
638 #define PCI_VENDOR_ID_AT            0x1259
639 #define PCI_VENDOR_ID_LINKSYS       0x1737
640 #define PCI_VENDOR_ID_GIGABYTE      0x1458
641
642 /* I'd like to spatch all of the pci methods, but I don't know how to do the
643  * reads.  Since we're not doing the reads, then no sense doing the writes. */
644 static inline int pci_read_config_byte(struct pci_device *dev, uint32_t off,
645                                        uint8_t *val)
646 {
647         *val = pcidev_read8(dev, off);
648         return 0;
649 }
650
651 static inline int pci_read_config_word(struct pci_device *dev, uint32_t off,
652                                        uint16_t *val)
653 {
654         *val = pcidev_read16(dev, off);
655         return 0;
656 }
657
658 static inline int pci_read_config_dword(struct pci_device *dev, uint32_t off,
659                                         uint32_t *val)
660 {
661         *val = pcidev_read32(dev, off);
662         return 0;
663 }
664
665 static inline int pci_write_config_byte(struct pci_device *dev, uint32_t off,
666                                         uint8_t val)
667 {
668         pcidev_write8(dev, off, val);
669         return 0;
670 }
671
672 static inline int pci_write_config_word(struct pci_device *dev, uint32_t off,
673                                         uint16_t val)
674 {
675         pcidev_write16(dev, off, val);
676         return 0;
677 }
678
679 static inline int pci_write_config_dword(struct pci_device *dev, uint32_t off,
680                                          uint32_t val)
681 {
682         pcidev_write32(dev, off, val);
683         return 0;
684 }
685
686 static inline void pci_disable_device(struct pci_device *dev)
687 {
688         pci_clr_bus_master(dev);
689 }
690
691 static inline int pci_enable_device(struct pci_device *dev)
692 {
693         pci_set_bus_master(dev);
694         return 0;
695 }
696
697 static inline uint32_t pci_resource_len(struct pci_device *dev, int bir)
698 {
699         return pci_get_membar_sz(dev, bir);
700 }
701
702 static inline void *pci_resource_start(struct pci_device *dev, int bir)
703 {
704         return (void*)pci_get_membar(dev, bir);
705 }
706
707 static inline void *pci_resource_end(struct pci_device *dev, int bir)
708 {
709         return (void*)(pci_get_membar(dev, bir) + pci_resource_len(dev, bir));
710 }
711
712 #define IORESOURCE_TYPE_BITS    0x00001f00  /* Resource type */
713 #define IORESOURCE_IO       0x00000100  /* PCI/ISA I/O ports */
714 #define IORESOURCE_MEM      0x00000200
715
716 static inline int pci_resource_flags(struct pci_device *pdev, int bir)
717 {
718         return pci_get_membar(pdev, bir) ? IORESOURCE_MEM : IORESOURCE_IO;
719 }
720
721 /* Linux stores this in the device to avoid lookups, which we can consider. */
722 static bool pci_is_pcie(struct pci_device *dev)
723 {
724         return pci_find_cap(dev, PCI_CAP_ID_EXP, NULL) == 0 ? TRUE : FALSE;
725 }
726
727 /* Hacked up version of Linux's.  Assuming reg's are implemented and
728  * read_config never fails. */
729 static int pcie_capability_read_word(struct pci_device *dev, int pos,
730                                      uint16_t *val)
731 {
732         uint32_t pcie_cap;
733
734         *val = 0;
735         if (pos & 1)
736                 return -EINVAL;
737         if (pci_find_cap(dev, PCI_CAP_ID_EXP, &pcie_cap))
738                 return -EINVAL;
739         pci_read_config_word(dev, pcie_cap + pos, val);
740         return 0;
741 }
742
743 static int pcie_capability_write_word(struct pci_device *dev, int pos,
744                                       uint16_t val)
745 {
746         uint32_t pcie_cap;
747
748         if (pos & 3)
749                 return -EINVAL;
750         if (pci_find_cap(dev, PCI_CAP_ID_EXP, &pcie_cap))
751                 return -EINVAL;
752         pci_write_config_word(dev, pcie_cap + pos, val);
753         return 0;
754 }
755
756 static int pcie_capability_clear_and_set_word(struct pci_device *dev, int pos,
757                                               uint16_t clear, uint16_t set)
758 {
759         int ret;
760         uint16_t val;
761
762         ret = pcie_capability_read_word(dev, pos, &val);
763         if (ret)
764                 return ret;
765         val &= ~clear;
766         val |= set;
767         return pcie_capability_write_word(dev, pos, val);
768 }
769
770 static int pcie_capability_clear_word(struct pci_device *dev, int pos,
771                                       uint16_t clear)
772 {
773         return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
774 }
775
776 static int pcie_capability_set_word(struct pci_device *dev, int pos,
777                                     uint16_t set)
778 {
779         return pcie_capability_clear_and_set_word(dev, pos, 0, set);
780 }
781
782 /* Faking it */
783 static int pci_request_regions(struct pci_device *pdev, const char *res_name)
784 {
785         return 0;
786 }
787
788 static void pci_release_regions(struct pci_device *pdev)
789 {
790 }
791
792 static bool pci_dev_run_wake(struct pci_device *dev)
793 {
794         return FALSE;
795 }
796
797 #define ioremap_nocache(paddr, sz) \
798         (void*)vmap_pmem_nocache((uintptr_t)paddr, sz)
799 #define ioremap(paddr, sz) (void*)vmap_pmem((uintptr_t)paddr, sz)
800 #define pci_ioremap_bar(dev, bir) (void*)pci_map_membar(dev, bir)
801 #define pci_disable_link_state(...)
802
803 #define dev_addr_add(dev, addr, type) ({memcpy((dev)->ea, addr, Eaddrlen); 0;})
804 #define dev_addr_del(...)
805
806 /* Some of these might be important.  Mostly we need to rewrite whatever is
807  * using them, but we can leave the functions around to remind us what the code
808  * is supposed to do, especially for things we don't support yet. */
809 #define SET_NETDEV_DEV(...)
810 /* May need to do something with edev's queues or flags. */
811 #define netif_tx_wake_all_queues(...)
812 #define netif_tx_wake_queue(...)
813 #define netif_tx_start_all_queues(...)
814 #define netif_tx_start_queue(...)
815 #define netif_tx_stop_queue(...)
816 #define netif_start_queue(...)
817 #define netif_stop_queue(...)
818 #define netif_wake_queue(...)
819 #define netif_device_detach(...)
820 #define netif_queue_stopped(...) (FALSE)
821 #define netif_napi_add(...)
822 #define netif_napi_del(...)
823 #define napi_hash_add(...)
824 #define napi_enable(...)
825 #define napi_disable(...)
826 #define napi_schedule(...)
827 #define napi_schedule_irqoff(...)
828 #define napi_complete(...)
829 #define free_irq(...)   /* We don't free yet! */
830 /* picks a random, valid mac addr for dev */
831 #define eth_hw_addr_random(...)
832 /* checks if the MAC is not 0 and not multicast (all 1s) */
833 #define is_valid_ether_addr(...) (TRUE)
834 /* The flag this checks is set on before open.  Turned off on failure, etc. */
835 #define netif_running(dev) (TRUE)
836 #define netdev_tx_sent_queue(...)
837 #define netdev_update_features(...)
838 #define skb_tx_timestamp(...)
839 #define net_ratelimit() (TRUE)
840
841 #define NET_SKB_PAD 0           /* padding for SKBs.  Ignoring it for now */
842 #define MAX_SKB_FRAGS 16        /* we'll probably delete code using this */
843 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
844
845 /* Could spatch this:
846         if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
847         to:
848         if (!pci_get_membar(pdev, 0)) {
849
850         eth_zero_addr(bp->dev->ea);
851         to:
852         memset(bp->dev->ea, 0, Eaddrlen);
853 */
854
855 struct firmware {
856         const uint8_t *data;
857         size_t size;
858 };
859
860 static inline int request_firmware(const struct firmware **fwp,
861                                    const char *file_name,
862                                                                    struct device *ignored)
863 {
864         struct firmware *ret_fw;
865         struct file_or_chan *fw_file;
866         void *fw_data;
867         char dirname[] = "/lib/firmware/";
868         /* could dynamically allocate the min of this and some MAX */
869         char fullpath[sizeof(dirname) + strlen(file_name) + 1];
870
871         snprintf(fullpath, sizeof(fullpath), "%s%s", dirname, file_name);
872         fw_file = foc_open(fullpath, O_READ, 0);
873         if (!fw_file) {
874                 printk("Unable to find firmware file %s!\n", fullpath);
875                 return -1;
876         }
877         fw_data = kread_whole_file(fw_file);
878         if (!fw_data) {
879                 printk("Unable to load firmware file %s!\n", fullpath);
880                 foc_decref(fw_file);
881                 return -1;
882         }
883         ret_fw = kmalloc(sizeof(struct firmware), MEM_WAIT);
884         ret_fw->data = fw_data;
885         ret_fw->size = foc_get_len(fw_file);
886         *fwp = ret_fw;
887         foc_decref(fw_file);
888         return 0;
889 }
890
891 static inline void release_firmware(const struct firmware *fw)
892 {
893         if (fw) {
894                 kfree((void*)fw->data);
895                 kfree((void*)fw);
896         }
897 }
898
899 static inline uint32_t ethtool_rxfh_indir_default(uint32_t index,
900                                                   uint32_t n_rx_rings)
901 {
902         return index % n_rx_rings;
903 }
904
905 /* Plan 9 does a memcmp for this.  We should probably have a helper, like for
906  * IP addrs. */
907 static inline bool ether_addr_equal(const uint8_t *addr1, const uint8_t *addr2)
908 {
909 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
910         uint32_t fold = ((*(const uint32_t *)addr1) ^ (*(const uint32_t *)addr2)) |
911         ((*(const uint16_t *)(addr1 + 4)) ^ (*(const uint16_t *)(addr2 + 4)));
912
913         return fold == 0;
914 #else
915         const uint16_t *a = (const uint16_t *)addr1;
916         const uint16_t *b = (const uint16_t *)addr2;
917
918         return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) == 0;
919 #endif
920 }
921
922 /* Linux uses this interface for 64 bit stats on 32 bit machines.  We're 64 bit
923  * only, so we can ignore the 32 bit versions. */
924 struct u64_stats_sync {
925 };
926
927 static inline void u64_stats_init(struct u64_stats_sync *syncp)
928 {
929 }
930
931 static inline void u64_stats_update_begin(struct u64_stats_sync *syncp)
932 {
933 }
934
935 static inline void u64_stats_update_end(struct u64_stats_sync *syncp)
936 {
937 }
938
939 static inline void u64_stats_update_begin_raw(struct u64_stats_sync *syncp)
940 {
941 }
942
943 static inline void u64_stats_update_end_raw(struct u64_stats_sync *syncp)
944 {
945 }
946
947 static inline unsigned int
948 __u64_stats_fetch_begin(const struct u64_stats_sync *syncp)
949 {
950         return 0;
951 }
952
953 static inline unsigned int
954 u64_stats_fetch_begin(const struct u64_stats_sync *syncp)
955 {
956         return __u64_stats_fetch_begin(syncp);
957 }
958
959 static inline bool __u64_stats_fetch_retry(const struct u64_stats_sync *syncp,
960                                            unsigned int start)
961 {
962         return false;
963 }
964
965 static inline bool u64_stats_fetch_retry(const struct u64_stats_sync *syncp,
966                                          unsigned int start)
967 {
968         return __u64_stats_fetch_retry(syncp, start);
969 }
970
971 static inline unsigned int
972 u64_stats_fetch_begin_irq(const struct u64_stats_sync *syncp)
973 {
974         return __u64_stats_fetch_begin(syncp);
975 }
976
977 static inline bool u64_stats_fetch_retry_irq(const struct u64_stats_sync *syncp,
978                                              unsigned int start)
979 {
980         return __u64_stats_fetch_retry(syncp, start);
981 }
982
983 #define pm_request_resume(...) (1)
984 #define pm_schedule_suspend(...) (-ENOSYS)
985 #define pm_runtime_get_noresume(...)
986 #define pm_runtime_active(...) (true)
987 #define pm_runtime_put_noidle(...)
988 #define pm_runtime_get_sync(...) (1)
989 #define pm_runtime_put_sync(...) (-ENOSYS)
990 #define device_set_wakeup_enable(...) (-EINVAL)
991
992 #include <linux/compat_todo.h>