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