user/vmm: print RIP and hexdump of RIP[0:16] on failed vmexit handling.
[akaros.git] / kern / include / linux_compat.h
1 /* Copyright (c) 2015 Google Inc.
2  *
3  * Dumping ground for converting between Akaros and Linux. */
4
5 #pragma once
6
7 #define ROS_KERN_LINUX_COMPAT_H
8
9 /* Common headers that most driver files will need */
10
11 #include <ros/common.h>
12 #include <assert.h>
13 #include <error.h>
14 #include <ip.h>
15 #include <kmalloc.h>
16 #include <kref.h>
17 #include <pmap.h>
18 #include <slab.h>
19 #include <smp.h>
20 #include <stdio.h>
21 #include <string.h>
22 #include <bitmap.h>
23 #include <umem.h>
24 #include <mmio.h>
25 #include <taskqueue.h>
26 #include <zlib.h>
27 #include <list.h>
28 #include <linux/errno.h>
29 /* temporary dumping ground */
30 #include "compat_todo.h"
31
32 //#define CONFIG_DCB
33 //#define CONFIG_NET_RX_BUSY_POLL 1
34 //#define CONFIG_NET_POLL_CONTROLLER 1
35 //#define CONFIG_INET 1         // will deal with this manually
36 #define CONFIG_PCI_MSI 1
37
38 #define __rcu
39 #define rcu_read_lock()
40 #define rcu_read_unlock()
41 #define rcu_dereference(x) (x)
42 #define rcu_dereference_protected(x, y) (x)
43 #define rcu_assign_pointer(dst, src) (dst) = (src)
44 #define RCU_INIT_POINTER(dst, src) rcu_assign_pointer(dst, src)
45 #define synchronize_rcu()
46
47 #define atomic_cmpxchg(_addr, _old, _new)                                      \
48 ({                                                                             \
49         typeof(_old) _ret;                                                         \
50         if (atomic_cas((_addr), (_old), (_new)))                                   \
51                 _ret = _old;                                                           \
52         else                                                                       \
53                 _ret = atomic_read(_addr);                                             \
54         _ret;                                                                      \
55 })
56
57 #define UINT_MAX UINT64_MAX
58 #define L1_CACHE_SHIFT (LOG2_UP(ARCH_CL_SIZE))
59 #define __stringify(x...) STRINGIFY(x)
60
61 /* Wanted to keep the _t variants in the code, in case that's useful in the
62  * future */
63 #define MIN_T(t, a, b) MIN(a, b)
64 #define MAX_T(t, a, b) MAX(a, b)
65 #define CLAMP(val, lo, hi) MIN((typeof(val))MAX(val, lo), hi)
66 #define CLAMP_T(t, val, lo, hi) CLAMP(val, lo, hi)
67
68 typedef physaddr_t dma_addr_t;
69 typedef int gfp_t;
70
71 /* these dma funcs are empty in linux with !CONFIG_NEED_DMA_MAP_STATE */
72 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
73 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
74 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
75 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
76 #define dma_unmap_len(PTR, LEN_NAME)             (0)
77 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
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         size_t order = LOG2_UP(nr_pages(size));
90         /* our shitty allocator doesn't align the higher order allocations, so we
91          * go 2x, and align manually.  we don't save the original pointer, so we
92          * can't free them later. */
93         void *vaddr = get_cont_pages(order > 0 ?  order + 1 : order,
94                                      flags);
95         if (!vaddr) {
96                 *dma_handle = 0;
97                 return 0;
98         }
99         /* manual alignment.  order 0 allocs are already page aligned */
100         vaddr = ALIGN(vaddr, PGSIZE << order);
101         *dma_handle = PADDR(vaddr);
102         return vaddr;
103 }
104
105 static inline void *__dma_zalloc_coherent(size_t size, dma_addr_t *dma_handle,
106                                           gfp_t flags)
107 {
108         void *vaddr = __dma_alloc_coherent(size, dma_handle, flags);
109         if (vaddr)
110                 memset(vaddr, 0, size);
111         return vaddr;
112 }
113
114 static inline void __dma_free_coherent(size_t size, void *cpu_addr,
115                                        dma_addr_t dma_handle)
116 {
117         size_t order = LOG2_UP(nr_pages(size));
118         if (order > 0) {
119                 warn("Not freeing high order alloc!  Fix the allocator!");
120                 return;
121         }
122         free_cont_pages(cpu_addr, order);
123 }
124
125 static inline dma_addr_t __dma_map_single(void *cpu_addr, size_t size,
126                                           int direction)
127 {
128         return PADDR(cpu_addr);
129 }
130
131 static inline dma_addr_t __dma_map_page(struct page *page,
132                                         unsigned long offset, size_t size,
133                                         int direction)
134 {
135         assert(offset == 0);
136         return page2pa(page);
137 }
138
139 static inline int __dma_mapping_error(dma_addr_t dma_addr)
140 {
141         return (dma_addr == 0);
142 }
143
144 #define dma_unmap_single(...)
145 #define dma_unmap_page(...)
146 #define dma_set_mask_and_coherent(...) (0)
147 #define dma_sync_single_for_cpu(...)
148 #define dma_sync_single_for_device(...)
149
150 /* Wrappers to avoid struct device.  Might want that one of these days */
151 #define dma_alloc_coherent(dev, size, dma_handlep, flag)                       \
152         __dma_alloc_coherent(size, dma_handlep, flag)
153
154 #define dma_zalloc_coherent(dev, size, dma_handlep, flag)                      \
155         __dma_zalloc_coherent(size, dma_handlep, flag)
156
157 #define dma_free_coherent(dev, size, dma_handle, flag)                         \
158         __dma_free_coherent(size, dma_handle, flag)
159
160 #define dma_map_single(dev, addr, size, direction)                             \
161         __dma_map_single(addr, size, direction)
162
163 #define dma_map_page(dev, page, offset, size, direction)                       \
164         __dma_map_page(page, offset, size, direction)
165
166 #define dma_mapping_error(dev, handle)                                         \
167         __dma_mapping_error(handle)
168
169 static void *vmalloc(size_t size)
170 {
171         void *vaddr = get_cont_pages(LOG2_UP(nr_pages(size)), MEM_WAIT);
172         /* zalloc, to be safe */
173         if (vaddr)
174                 memset(vaddr, 0, size);
175         return vaddr;
176 }
177
178 /* Akaros needs to know the size, for now.  So it's not quite compatible */
179 static void vfree(void *vaddr, size_t size)
180 {
181         free_cont_pages(vaddr, LOG2_UP(nr_pages(size)));
182 }
183
184 typedef int pci_power_t;
185 typedef int pm_message_t;
186
187 #define DEFINE_SEMAPHORE(name)  \
188     struct semaphore name = SEMAPHORE_INITIALIZER_IRQSAVE(name, 1)
189 #define sema_init(sem, val) sem_init_irqsave(sem, val)
190 #define up(sem) sem_up(sem)
191 #define down(sem) sem_down(sem)
192 #define down_trylock(sem) ({!sem_trydown(sem);})
193 /* In lieu of spatching, I wanted to keep the distinction between down and
194  * down_interruptible/down_timeout.  Akaros doesn't have the latter. */
195 #define down_interruptible(sem) ({sem_down(sem); 0;})
196 #define down_timeout(sem, timeout) ({sem_down(sem); 0;})
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) "bnx2x:" 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 #define netdev_printk(lvl, dev, fmt, ...) \
240         printk("[netdev]: " fmt, ##__VA_ARGS__)
241 #define netdev_err(dev, fmt, ...) \
242         printk("[netdev]: " fmt, ##__VA_ARGS__)
243 #define netdev_info(dev, fmt, ...) \
244         printk("[netdev]: " fmt, ##__VA_ARGS__)
245 #define netdev_dbg(dev, fmt, ...) \
246         printk("[netdev]: " fmt, ##__VA_ARGS__)
247 #define dev_err(dev, fmt, ...) \
248         printk("[dev]: " fmt, ##__VA_ARGS__)
249 #define dev_info(dev, fmt, ...) \
250         printk("[dev]: " fmt, ##__VA_ARGS__)
251 #define dev_alert(dev, fmt, ...) \
252         printk("[dev]: " fmt, ##__VA_ARGS__)
253
254 #ifdef DEBUG
255
256 #define might_sleep() assert(can_block(&per_cpu_info[core_id()]))
257 #define pr_devel(fmt, ...) \
258         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
259
260 #else
261
262 #define might_sleep()
263 #define pr_devel(fmt, ...) \
264         printd(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
265
266 #endif
267 #define pr_debug pr_devel
268
269
270 enum {
271         NETIF_MSG_DRV           = 0x0001,
272         NETIF_MSG_PROBE         = 0x0002,
273         NETIF_MSG_LINK          = 0x0004,
274         NETIF_MSG_TIMER         = 0x0008,
275         NETIF_MSG_IFDOWN        = 0x0010,
276         NETIF_MSG_IFUP          = 0x0020,
277         NETIF_MSG_RX_ERR        = 0x0040,
278         NETIF_MSG_TX_ERR        = 0x0080,
279         NETIF_MSG_TX_QUEUED     = 0x0100,
280         NETIF_MSG_INTR          = 0x0200,
281         NETIF_MSG_TX_DONE       = 0x0400,
282         NETIF_MSG_RX_STATUS     = 0x0800,
283         NETIF_MSG_PKTDATA       = 0x1000,
284         NETIF_MSG_HW            = 0x2000,
285         NETIF_MSG_WOL           = 0x4000,
286 };
287
288 #define MODULE_AUTHOR(...)
289 #define MODULE_DESCRIPTION(...)
290 #define MODULE_LICENSE(...)
291 #define MODULE_VERSION(...)
292 #define MODULE_FIRMWARE(...)
293 #define module_param(...)
294 #define module_param_named(...)
295 #define MODULE_PARM_DESC(...)
296 #define MODULE_DEVICE_TABLE(...)
297 #define THIS_MODULE ((void*)0)
298 #define EXPORT_SYMBOL(...)
299 #define __init
300 #define __exit
301 #define module_init(...)
302 #define module_exit(...)
303
304 #define is_kdump_kernel() (0)
305
306 /* from Linux's ethtool.h.  We probably won't use any of this code, but at
307  * least we can keep it quiet during porting. */
308 #define SPEED_10        10
309 #define SPEED_100       100
310 #define SPEED_1000      1000
311 #define SPEED_2500      2500
312 #define SPEED_10000     10000
313 #define SPEED_20000     20000
314 #define SPEED_40000     40000
315 #define SPEED_56000     56000
316 #define SPEED_UNKNOWN   -1
317
318 /* Duplex, half or full. */
319 #define DUPLEX_HALF     0x00
320 #define DUPLEX_FULL     0x01
321 #define DUPLEX_UNKNOWN  0xff
322
323 #define SUPPORTED_10baseT_Half      (1 << 0)
324 #define SUPPORTED_10baseT_Full      (1 << 1)
325 #define SUPPORTED_100baseT_Half     (1 << 2)
326 #define SUPPORTED_100baseT_Full     (1 << 3)
327 #define SUPPORTED_1000baseT_Half    (1 << 4)
328 #define SUPPORTED_1000baseT_Full    (1 << 5)
329 #define SUPPORTED_Autoneg       (1 << 6)
330 #define SUPPORTED_TP            (1 << 7)
331 #define SUPPORTED_AUI           (1 << 8)
332 #define SUPPORTED_MII           (1 << 9)
333 #define SUPPORTED_FIBRE         (1 << 10)
334 #define SUPPORTED_BNC           (1 << 11)
335 #define SUPPORTED_10000baseT_Full   (1 << 12)
336 #define SUPPORTED_Pause         (1 << 13)
337 #define SUPPORTED_Asym_Pause        (1 << 14)
338 #define SUPPORTED_2500baseX_Full    (1 << 15)
339 #define SUPPORTED_Backplane     (1 << 16)
340 #define SUPPORTED_1000baseKX_Full   (1 << 17)
341 #define SUPPORTED_10000baseKX4_Full (1 << 18)
342 #define SUPPORTED_10000baseKR_Full  (1 << 19)
343 #define SUPPORTED_10000baseR_FEC    (1 << 20)
344 #define SUPPORTED_20000baseMLD2_Full    (1 << 21)
345 #define SUPPORTED_20000baseKR2_Full (1 << 22)
346 #define SUPPORTED_40000baseKR4_Full (1 << 23)
347 #define SUPPORTED_40000baseCR4_Full (1 << 24)
348 #define SUPPORTED_40000baseSR4_Full (1 << 25)
349 #define SUPPORTED_40000baseLR4_Full (1 << 26)
350 #define SUPPORTED_56000baseKR4_Full (1 << 27)
351 #define SUPPORTED_56000baseCR4_Full (1 << 28)
352 #define SUPPORTED_56000baseSR4_Full (1 << 29)
353 #define SUPPORTED_56000baseLR4_Full (1 << 30)
354
355 #define ADVERTISED_10baseT_Half     (1 << 0)
356 #define ADVERTISED_10baseT_Full     (1 << 1)
357 #define ADVERTISED_100baseT_Half    (1 << 2)
358 #define ADVERTISED_100baseT_Full    (1 << 3)
359 #define ADVERTISED_1000baseT_Half   (1 << 4)
360 #define ADVERTISED_1000baseT_Full   (1 << 5)
361 #define ADVERTISED_Autoneg      (1 << 6)
362 #define ADVERTISED_TP           (1 << 7)
363 #define ADVERTISED_AUI          (1 << 8)
364 #define ADVERTISED_MII          (1 << 9)
365 #define ADVERTISED_FIBRE        (1 << 10)
366 #define ADVERTISED_BNC          (1 << 11)
367 #define ADVERTISED_10000baseT_Full  (1 << 12)
368 #define ADVERTISED_Pause        (1 << 13)
369 #define ADVERTISED_Asym_Pause       (1 << 14)
370 #define ADVERTISED_2500baseX_Full   (1 << 15)
371 #define ADVERTISED_Backplane        (1 << 16)
372 #define ADVERTISED_1000baseKX_Full  (1 << 17)
373 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
374 #define ADVERTISED_10000baseKR_Full (1 << 19)
375 #define ADVERTISED_10000baseR_FEC   (1 << 20)
376 #define ADVERTISED_20000baseMLD2_Full   (1 << 21)
377 #define ADVERTISED_20000baseKR2_Full    (1 << 22)
378 #define ADVERTISED_40000baseKR4_Full    (1 << 23)
379 #define ADVERTISED_40000baseCR4_Full    (1 << 24)
380 #define ADVERTISED_40000baseSR4_Full    (1 << 25)
381 #define ADVERTISED_40000baseLR4_Full    (1 << 26)
382 #define ADVERTISED_56000baseKR4_Full    (1 << 27)
383 #define ADVERTISED_56000baseCR4_Full    (1 << 28)
384 #define ADVERTISED_56000baseSR4_Full    (1 << 29)
385 #define ADVERTISED_56000baseLR4_Full    (1 << 30)
386
387 enum ethtool_test_flags {
388         ETH_TEST_FL_OFFLINE = (1 << 0),
389         ETH_TEST_FL_FAILED  = (1 << 1),
390         ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
391         ETH_TEST_FL_EXTERNAL_LB_DONE    = (1 << 3),
392 };
393
394 enum ethtool_stringset {
395         ETH_SS_TEST     = 0,
396         ETH_SS_STATS,
397         ETH_SS_PRIV_FLAGS,
398         ETH_SS_NTUPLE_FILTERS,
399         ETH_SS_FEATURES,
400         ETH_SS_RSS_HASH_FUNCS,
401 };
402
403 enum {
404         ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
405         ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
406
407         ETH_RSS_HASH_FUNCS_COUNT
408 };
409
410 #define __ETH_RSS_HASH_BIT(bit) ((uint32_t)1 << (bit))
411 #define __ETH_RSS_HASH(name)    __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
412
413 #define ETH_RSS_HASH_TOP    __ETH_RSS_HASH(TOP)
414 #define ETH_RSS_HASH_XOR    __ETH_RSS_HASH(XOR)
415
416 #define ETH_RSS_HASH_UNKNOWN    0
417 #define ETH_RSS_HASH_NO_CHANGE  0
418
419
420 /* EEPROM Standards for plug in modules */
421 #define ETH_MODULE_SFF_8079     0x1
422 #define ETH_MODULE_SFF_8079_LEN     256
423 #define ETH_MODULE_SFF_8472     0x2
424 #define ETH_MODULE_SFF_8472_LEN     512
425 #define ETH_MODULE_SFF_8636     0x3
426 #define ETH_MODULE_SFF_8636_LEN     256
427 #define ETH_MODULE_SFF_8436     0x4
428 #define ETH_MODULE_SFF_8436_LEN     256
429
430 #define ETH_GSTRING_LEN     32
431
432 /* ethernet protocol ids.  the plan 9 equivalent enum only exists in
433  * ethermedium.c. */
434 #define ETH_P_IP    0x0800      /* Internet Protocol packet */
435 #define ETH_P_IPV6  0x86DD      /* IPv6 over bluebook       */
436 #define ETH_P_ARP   0x0806      /* Address Resolution packet    */
437 #define ETH_P_FIP   0x8914      /* FCoE Initialization Protocol */
438 #define ETH_P_8021Q 0x8100          /* 802.1Q VLAN Extended Header  */
439
440 /* Sockaddr structs */
441 struct sockaddr {
442         uint16_t                                sa_family;
443         char                                    sa_data[14];
444 };
445
446 struct in_addr {
447         uint32_t                s_addr;
448 };
449 struct sockaddr_in {
450         uint16_t                                sin_family;
451         uint16_t                                sin_port;
452         struct in_addr                  sin_addr;
453         uint8_t                                 sin_zero[8]; /* padding */
454 };
455
456 struct in6_addr {
457         /* this is actually a weird union in glibc */
458         uint8_t                                 s6_addr[16];
459 };
460
461 struct sockaddr_in6 {
462         uint16_t                                sin6_family;
463         uint16_t                                sin6_port;
464         uint32_t                                sin6_flowinfo;
465         struct in6_addr                 sin6_addr;
466         uint32_t                                sin6_scope_id;
467 };
468
469 /* Common way to go from netdev (ether / netif) to driver-private ctlr */
470 static inline void *netdev_priv(struct ether *dev)
471 {
472         return dev->ctlr;
473 }
474
475 /* u64 on linux, but a u32 on plan 9.  the typedef is probably a good idea */
476 typedef unsigned int netdev_features_t;
477
478 /* Linux has features, hw_features, and a couple others.  Plan 9 just has
479  * features.  This #define should work for merging hw and regular features.  We
480  * spatched away the hw_enc and vlan feats. */
481 #define hw_features feat
482
483 /* Attempted conversions for plan 9 features.  For some things, like rx
484  * checksums, the driver flags the block (e.g. Budpck) to say if a receive
485  * checksum was already done.  There is no flag for saying the device can do
486  * it.  For transmits, the stack needs to know in advance if the device can
487  * handle the checksum or not. */
488 #define NETIF_F_RXHASH                          0
489 #define NETIF_F_RXCSUM                          0
490 #define NETIF_F_LRO                                     NETF_LRO
491 #define NETIF_F_GRO                                     0
492 #define NETIF_F_LOOPBACK                        0
493 #define NETIF_F_TSO                                     NETF_TSO
494 #define NETIF_F_SG                                      NETF_SG
495 #define NETIF_F_IP_CSUM                         (NETF_IPCK | NETF_UDPCK | NETF_TCPCK)
496 #define NETIF_F_IPV6_CSUM                       (NETF_IPCK | NETF_UDPCK | NETF_TCPCK)
497 #define NETIF_F_GSO_GRE                         0
498 #define NETIF_F_GSO_UDP_TUNNEL          0
499 #define NETIF_F_GSO_IPIP                        0
500 #define NETIF_F_GSO_SIT                         0
501 #define NETIF_F_TSO_ECN                         0
502 #define NETIF_F_TSO6                            0
503 #define NETIF_F_HW_VLAN_CTAG_TX         0
504 #define NETIF_F_HIGHDMA                         0
505 #define NETIF_F_HW_VLAN_CTAG_RX         0
506
507 #define netif_msg_drv(p)                ((p)->msg_enable & NETIF_MSG_DRV)
508 #define netif_msg_probe(p)              ((p)->msg_enable & NETIF_MSG_PROBE)
509 #define netif_msg_link(p)               ((p)->msg_enable & NETIF_MSG_LINK)
510 #define netif_msg_timer(p)              ((p)->msg_enable & NETIF_MSG_TIMER)
511 #define netif_msg_ifdown(p)             ((p)->msg_enable & NETIF_MSG_IFDOWN)
512 #define netif_msg_ifup(p)               ((p)->msg_enable & NETIF_MSG_IFUP)
513 #define netif_msg_rx_err(p)             ((p)->msg_enable & NETIF_MSG_RX_ERR)
514 #define netif_msg_tx_err(p)             ((p)->msg_enable & NETIF_MSG_TX_ERR)
515 #define netif_msg_tx_queued(p)  ((p)->msg_enable & NETIF_MSG_TX_QUEUED)
516 #define netif_msg_intr(p)               ((p)->msg_enable & NETIF_MSG_INTR)
517 #define netif_msg_tx_done(p)    ((p)->msg_enable & NETIF_MSG_TX_DONE)
518 #define netif_msg_rx_status(p)  ((p)->msg_enable & NETIF_MSG_RX_STATUS)
519 #define netif_msg_pktdata(p)    ((p)->msg_enable & NETIF_MSG_PKTDATA)
520 #define netif_msg_hw(p)                 ((p)->msg_enable & NETIF_MSG_HW)
521 #define netif_msg_wol(p)                ((p)->msg_enable & NETIF_MSG_WOL)
522
523 enum netdev_state_t {
524         __LINK_STATE_START,
525         __LINK_STATE_PRESENT,
526         __LINK_STATE_NOCARRIER,
527         __LINK_STATE_LINKWATCH_PENDING,
528         __LINK_STATE_DORMANT,
529 };
530
531 enum netdev_tx {
532         __NETDEV_TX_MIN  = INT32_MIN,   /* make sure enum is signed */
533         NETDEV_TX_OK     = 0x00,                /* driver took care of packet */
534         NETDEV_TX_BUSY   = 0x10,                /* driver tx path was busy*/
535         NETDEV_TX_LOCKED = 0x20,                /* driver tx lock was already taken */
536 };
537 typedef enum netdev_tx netdev_tx_t;
538
539 /* Global mutex in linux for "routing netlink".  Not sure if we have an
540  * equivalent or not in Plan 9. */
541 #define rtnl_lock()
542 #define rtnl_unlock()
543 #define ASSERT_RTNL(...)
544
545 #define synchronize_irq(x) warn_once("Asked to sync IRQ %d, unsupported", x)
546 #define HZ 100
547
548 /* Linux has a PCI device id struct.  Drivers make tables of their supported
549  * devices, and this table is handled by higher level systems.  We don't have
550  * those systems, but we probably want the table still for our own parsing. */
551 struct pci_device_id {
552         uint32_t vendor, device;                /* Vendor and device ID or PCI_ANY_ID*/
553         uint32_t subvendor, subdevice;  /* Subsystem ID's or PCI_ANY_ID */
554         uint32_t class, class_mask;             /* (class,subclass,prog-if) triplet */
555         unsigned long driver_data;              /* Data private to the driver */
556 };
557
558 #define PCI_ANY_ID (~0)
559 /* This macro is used in setting device_id entries */
560 #define PCI_VDEVICE(vend, dev) \
561     .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
562     .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
563
564 /* Linux also has its own table of vendor ids.  We have the pci_defs table, but
565  * this is a bootstrap issue. */
566 #define PCI_VENDOR_ID_BROADCOM      0x14e4
567
568 /* I'd like to spatch all of the pci methods, but I don't know how to do the
569  * reads.  Since we're not doing the reads, then no sense doing the writes. */
570 static inline int pci_read_config_byte(struct pci_device *dev, uint32_t off,
571                                        uint8_t *val)
572 {
573         *val = pcidev_read8(dev, off);
574         return 0;
575 }
576
577 static inline int pci_read_config_word(struct pci_device *dev, uint32_t off,
578                                        uint16_t *val)
579 {
580         *val = pcidev_read16(dev, off);
581         return 0;
582 }
583
584 static inline int pci_read_config_dword(struct pci_device *dev, uint32_t off,
585                                         uint32_t *val)
586 {
587         *val = pcidev_read32(dev, off);
588         return 0;
589 }
590
591 static inline int pci_write_config_byte(struct pci_device *dev, uint32_t off,
592                                         uint8_t val)
593 {
594         pcidev_write8(dev, off, val);
595         return 0;
596 }
597
598 static inline int pci_write_config_word(struct pci_device *dev, uint32_t off,
599                                         uint16_t val)
600 {
601         pcidev_write16(dev, off, val);
602         return 0;
603 }
604
605 static inline int pci_write_config_dword(struct pci_device *dev, uint32_t off,
606                                          uint32_t val)
607 {
608         pcidev_write32(dev, off, val);
609         return 0;
610 }
611
612 static inline void pci_disable_device(struct pci_device *dev)
613 {
614         pci_clr_bus_master(dev);
615 }
616
617 static inline int pci_enable_device(struct pci_device *dev)
618 {
619         pci_set_bus_master(dev);
620         return 0;
621 }
622
623 static inline uint32_t pci_resource_len(struct pci_device *dev, int bir)
624 {
625         return pci_get_membar_sz(dev, bir);
626 }
627
628 static inline void *pci_resource_start(struct pci_device *dev, int bir)
629 {
630         return (void*)pci_get_membar(dev, bir);
631 }
632
633 static inline void *pci_resource_end(struct pci_device *dev, int bir)
634 {
635         return (void*)(pci_get_membar(dev, bir) + pci_resource_len(dev, bir));
636 }
637
638 /* Hacked up version of Linux's.  Assuming reg's are implemented and
639  * read_config never fails. */
640 static int pcie_capability_read_word(struct pci_device *dev, int pos,
641                                      uint16_t *val)
642 {
643         uint32_t pcie_cap;
644         *val = 0;
645         if (pos & 1)
646                 return -EINVAL;
647         if (pci_find_cap(dev, PCI_CAP_ID_EXP, &pcie_cap))
648                 return -EINVAL;
649         pci_read_config_word(dev, pcie_cap + pos, val);
650         return 0;
651 }
652
653 #define ioremap_nocache(paddr, sz) \
654         (void*)vmap_pmem_nocache((uintptr_t)paddr, sz)
655 #define ioremap(paddr, sz) (void*)vmap_pmem((uintptr_t)paddr, sz)
656 #define pci_ioremap_bar(dev, bir) (void*)pci_map_membar(dev, bir)
657 #define pci_set_master(x) pci_set_bus_master(x)
658
659 #define dev_addr_add(dev, addr, type) ({memcpy((dev)->ea, addr, Eaddrlen); 0;})
660 #define dev_addr_del(...)
661
662 #define SET_NETDEV_DEV(...)
663 #define netif_carrier_off(...)
664 #define netif_carrier_on(...)
665 /* May need to do something with edev's queues or flags. */
666 #define netif_tx_wake_all_queues(...)
667 #define netif_tx_wake_queue(...)
668 #define netif_tx_start_all_queues(...)
669 #define netif_tx_start_queue(...)
670 #define netif_tx_stop_queue(...)
671 #define netif_napi_add(...)
672 #define napi_hash_add(...)
673 #define napi_enable(...)
674 #define napi_disable(...)
675 #define napi_schedule(...)
676 #define napi_schedule_irqoff(...)
677 #define napi_complete(...)
678 /* picks a random, valid mac addr for dev */
679 #define eth_hw_addr_random(...)
680 /* checks if the MAC is not 0 and not multicast (all 1s) */
681 #define is_valid_ether_addr(...) (TRUE)
682 /* The flag this checks is set on before open.  Turned off on failure, etc. */
683 #define netif_running(dev) (TRUE)
684 #define netdev_tx_sent_queue(...)
685 #define skb_tx_timestamp(...)
686
687 #define NET_SKB_PAD 0           /* padding for SKBs.  Ignoring it for now */
688 #define MAX_SKB_FRAGS 16        /* we'll probably delete code using this */
689 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
690
691 /* Could spatch this:
692         if (!(pci_resource_flags(pdev, 0) & IORESOURCE_MEM)) {
693         to:
694         if (!pci_get_membar(pdev, 0)) {
695
696         eth_zero_addr(bp->dev->ea);
697         to:
698         memset(bp->dev->ea, 0, Eaddrlen);
699 */
700
701 struct firmware {
702         const uint8_t *data;
703         size_t size;
704 };
705
706 /* the ignored param is a &pcidev->dev in linux, which is a struct dev.  our
707  * pcidev->dev is the "slot" */
708 static inline int request_firmware(const struct firmware **fwp,
709                                    const char *file_name, uint8_t *ignored)
710 {
711         struct firmware *ret_fw;
712         struct file *fw_file;
713         void *fw_data;
714         char dirname[] = "/lib/firmware/";
715         /* could dynamically allocate the min of this and some MAX */
716         char fullpath[sizeof(dirname) + strlen(file_name) + 1];
717
718         snprintf(fullpath, sizeof(fullpath), "%s%s", dirname, file_name);
719         fw_file = do_file_open(fullpath, O_READ, 0);
720         if (!fw_file) {
721                 printk("Unable to find firmware file %s!\n", fullpath);
722                 return -1;
723         }
724         fw_data = kread_whole_file(fw_file);
725         if (!fw_data) {
726                 printk("Unable to load firmware file %s!\n", fullpath);
727                 kref_put(&fw_file->f_kref);
728                 return -1;
729         }
730         ret_fw = kmalloc(sizeof(struct firmware), MEM_WAIT);
731         ret_fw->data = fw_data;
732         ret_fw->size = fw_file->f_dentry->d_inode->i_size;
733         *fwp = ret_fw;
734         kref_put(&fw_file->f_kref);
735         return 0;
736 }
737
738 static inline void release_firmware(const struct firmware *fw)
739 {
740         if (fw) {
741                 kfree((void*)fw->data);
742                 kfree((void*)fw);
743         }
744 }
745
746 static inline uint32_t ethtool_rxfh_indir_default(uint32_t index,
747                                                   uint32_t n_rx_rings)
748 {
749         return index % n_rx_rings;
750 }
751
752 /* Plan 9 does a memcmp for this.  We should probably have a helper, like for
753  * IP addrs. */
754 static inline bool ether_addr_equal(const uint8_t *addr1, const uint8_t *addr2)
755 {
756 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
757         uint32_t fold = ((*(const uint32_t *)addr1) ^ (*(const uint32_t *)addr2)) |
758         ((*(const uint16_t *)(addr1 + 4)) ^ (*(const uint16_t *)(addr2 + 4)));
759
760         return fold == 0;
761 #else
762         const uint16_t *a = (const uint16_t *)addr1;
763         const uint16_t *b = (const uint16_t *)addr2;
764
765         return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) == 0;
766 #endif
767 }
768
769 #include <linux/compat_todo.h>