BNX2X: fake RCU and socket structs
[akaros.git] / kern / drivers / net / bnx2x / akaros_compat.h
1 /* Copyright (c) 2015 Google Inc.
2  *
3  * Dumping ground for converting between Akaros and other OSs. */
4
5 #ifndef ROS_KERN_AKAROS_COMPAT_H
6 #define ROS_KERN_AKAROS_COMPAT_H
7
8 /* Common headers that most driver files will need */
9
10 #include <assert.h>
11 #include <error.h>
12 #include <ip.h>
13 #include <kmalloc.h>
14 #include <kref.h>
15 #include <pmap.h>
16 #include <slab.h>
17 #include <smp.h>
18 #include <stdio.h>
19 #include <string.h>
20 #include <bitmap.h>
21 #include <mii.h>
22 #include <umem.h>
23 #include <mmio.h>
24 #include <taskqueue.h>
25
26 #define __rcu
27 #define rcu_read_lock()
28 #define rcu_read_unlock()
29 #define rcu_dereference(x) (x)
30 #define rcu_dereference_protected(x, y) (x)
31 #define rcu_assign_pointer(dst, src) (dst) = (src)
32 #define RCU_INIT_POINTER(dst, src) rcu_assign_pointer(dst, src)
33 #define synchronize_rcu()
34
35 #define unlikely(x) (x)
36 #define likely(x) (x)
37 #define UINT_MAX UINT64_MAX
38 #define L1_CACHE_SHIFT (LOG2_UP(ARCH_CL_SIZE))
39
40 /* Wanted to keep the _t variants in the code, in case that's useful in the
41  * future */
42 #define MIN_T(t, a, b) MIN(a, b)
43 #define MAX_T(t, a, b) MAX(a, b)
44 #define CLAMP(val, lo, hi) MIN((typeof(val))MAX(val, lo), hi)
45 #define CLAMP_T(t, val, lo, hi) CLAMP(val, lo, hi)
46
47 /* I'm okay with these versions of the asserts. */
48 #define WARN(args...) warn(args)
49 #define WARN_ONCE(args...) warn_once(args)
50 #define WARN_ON(x) warn_on(x)
51 #define WARN_ON_ONCE(x) warn_on_once(x)
52 #define BUG() panic("BUG")
53 #define BUG_ON(x) assert(x)
54
55 typedef physaddr_t dma_addr_t;
56 typedef int gfp_t;
57
58 /* these dma funcs are empty in linux with !CONFIG_NEED_DMA_MAP_STATE */
59 #define DEFINE_DMA_UNMAP_ADDR(ADDR_NAME)
60 #define DEFINE_DMA_UNMAP_LEN(LEN_NAME)
61 #define dma_unmap_addr(PTR, ADDR_NAME)           (0)
62 #define dma_unmap_addr_set(PTR, ADDR_NAME, VAL)  do { } while (0)
63 #define dma_unmap_len(PTR, LEN_NAME)             (0)
64 #define dma_unmap_len_set(PTR, LEN_NAME, VAL)    do { } while (0)
65 #define DMA_NONE                                0
66 #define DMA_TO_DEVICE                   1
67 #define DMA_FROM_DEVICE                 2
68 #define DMA_BIDIRECTIONAL               3
69
70 static inline void *__dma_alloc_coherent(size_t size, dma_addr_t *dma_handle,
71                                          gfp_t flags)
72 {
73         size_t order = LOG2_UP(nr_pages(size));
74         void *vaddr = get_cont_pages(order, flags);
75         if (!vaddr) {
76                 *dma_handle = 0;
77                 return 0;
78         }
79         *dma_handle = PADDR(vaddr);
80         return vaddr;
81 }
82
83 static inline void *__dma_zalloc_coherent(size_t size, dma_addr_t *dma_handle,
84                                           gfp_t flags)
85 {
86         void *vaddr = __dma_alloc_coherent(size, dma_handle, flags);
87         if (vaddr)
88                 memset(vaddr, 0, size);
89         return vaddr;
90 }
91
92 static inline void __dma_free_coherent(size_t size, void *cpu_addr,
93                                        dma_addr_t dma_handle)
94 {
95         size_t order = LOG2_UP(nr_pages(size));
96         free_cont_pages(cpu_addr, order);
97 }
98
99 static inline dma_addr_t __dma_map_single(void *cpu_addr, size_t size,
100                                           int direction)
101 {
102         return PADDR(cpu_addr);
103 }
104
105 static inline dma_addr_t __dma_map_page(struct page *page,
106                                         unsigned long offset, size_t size,
107                                         int direction)
108 {
109         assert(offset == 0);
110         return page2pa(page);
111 }
112
113 static inline int __dma_mapping_error(dma_addr_t dma_addr)
114 {
115         return (dma_addr == 0);
116 }
117
118 #define dma_unmap_single(...)
119 #define dma_unmap_page(...)
120 #define dma_set_mask_and_coherent(...) (0)
121 #define dma_sync_single_for_cpu(...)
122
123 /* Wrappers to avoid struct device.  Might want that one of these days */
124 #define dma_alloc_coherent(dev, size, dma_handlep, flag)                       \
125         __dma_alloc_coherent(size, dma_handlep, flag)
126
127 #define dma_zalloc_coherent(dev, size, dma_handlep, flag)                      \
128         __dma_zalloc_coherent(size, dma_handlep, flag)
129
130 #define dma_free_coherent(dev, size, dma_handle, flag)                         \
131         __dma_free_coherent(size, dma_handle, flag)
132
133 #define dma_map_single(dev, addr, size, direction)                             \
134         __dma_map_single(addr, size, direction)
135
136 #define dma_map_page(dev, page, offset, size, direction)                       \
137         __dma_map_page(page, offset, size, direction)
138
139 #define dma_mapping_error(dev, handle)                                         \
140         __dma_mapping_error(handle)
141
142
143 typedef int pci_power_t;
144 typedef int pm_message_t;
145
146 #define DEFINE_SEMAPHORE(name)  \
147     struct semaphore name = SEMAPHORE_INITIALIZER_IRQSAVE(name, 1)
148 #define sema_init(sem, val) sem_init_irqsave(sem, val)
149 #define up(sem) sem_up(sem)
150 #define down(sem) sem_down(sem)
151 #define down_trylock(sem) ({!sem_trydown(sem);})
152 /* In lieu of spatching, I wanted to keep the distinction between down and
153  * down_interruptible/down_timeout.  Akaros doesn't have the latter. */
154 #define down_interruptible(sem) ({sem_down(sem); 0;})
155 #define down_timeout(sem, timeout) ({sem_down(sem); 0;})
156
157 /* Linux printk front ends */
158 #ifndef pr_fmt
159 #define pr_fmt(fmt) fmt
160 #endif
161
162 #define KERN_EMERG ""
163 #define KERN_ALERT ""
164 #define KERN_CRIT ""
165 #define KERN_ERR ""
166 #define KERN_WARNING ""
167 #define KERN_NOTICE ""
168 #define KERN_INFO ""
169 #define KERN_CONT ""
170 #define KERN_DEBUG ""
171
172 /*
173  * These can be used to print at the various log levels.
174  * All of these will print unconditionally, although note that pr_debug()
175  * and other debug macros are compiled out unless either DEBUG is defined
176  * or CONFIG_DYNAMIC_DEBUG is set.
177  */
178 #define pr_emerg(fmt, ...) \
179         printk(KERN_EMERG pr_fmt(fmt), ##__VA_ARGS__)
180 #define pr_alert(fmt, ...) \
181         printk(KERN_ALERT pr_fmt(fmt), ##__VA_ARGS__)
182 #define pr_crit(fmt, ...) \
183         printk(KERN_CRIT pr_fmt(fmt), ##__VA_ARGS__)
184 #define pr_err(fmt, ...) \
185         printk(KERN_ERR pr_fmt(fmt), ##__VA_ARGS__)
186 #define pr_warning(fmt, ...) \
187         printk(KERN_WARNING pr_fmt(fmt), ##__VA_ARGS__)
188 #define pr_warn pr_warning
189 #define pr_notice(fmt, ...) \
190         printk(KERN_NOTICE pr_fmt(fmt), ##__VA_ARGS__)
191 #define pr_info(fmt, ...) \
192         printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)
193 #define pr_cont(fmt, ...) \
194         printk(KERN_CONT fmt, ##__VA_ARGS__)
195 #define netdev_printk(lvl, dev, fmt, ...) \
196         printk(fmt, ##__VA_ARGS__)
197 #define netdev_err(dev, fmt, ...) \
198         printk(fmt, ##__VA_ARGS__)
199 #define dev_err(dev, fmt, ...) \
200         printk(fmt, ##__VA_ARGS__)
201 #define dev_info(dev, fmt, ...) \
202         printk(fmt, ##__VA_ARGS__)
203
204
205 #ifdef DEBUG
206
207 #define might_sleep() assert(can_block(&per_cpu_info[core_id()]))
208 #define pr_devel(fmt, ...) \
209         printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
210
211 #else
212
213 #define might_sleep()
214 #define pr_devel(fmt, ...) \
215         printd(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__)
216
217 #endif
218 #define pr_debug pr_devel
219
220
221 enum {
222         NETIF_MSG_DRV           = 0x0001,
223         NETIF_MSG_PROBE         = 0x0002,
224         NETIF_MSG_LINK          = 0x0004,
225         NETIF_MSG_TIMER         = 0x0008,
226         NETIF_MSG_IFDOWN        = 0x0010,
227         NETIF_MSG_IFUP          = 0x0020,
228         NETIF_MSG_RX_ERR        = 0x0040,
229         NETIF_MSG_TX_ERR        = 0x0080,
230         NETIF_MSG_TX_QUEUED     = 0x0100,
231         NETIF_MSG_INTR          = 0x0200,
232         NETIF_MSG_TX_DONE       = 0x0400,
233         NETIF_MSG_RX_STATUS     = 0x0800,
234         NETIF_MSG_PKTDATA       = 0x1000,
235         NETIF_MSG_HW            = 0x2000,
236         NETIF_MSG_WOL           = 0x4000,
237 };
238
239 #define MODULE_AUTHOR(...)
240 #define MODULE_DESCRIPTION(...)
241 #define MODULE_LICENSE(...)
242 #define MODULE_VERSION(...)
243 #define MODULE_FIRMWARE(...)
244 #define module_param(...)
245 #define module_param_named(...)
246 #define MODULE_PARM_DESC(...)
247 #define MODULE_DEVICE_TABLE(...)
248 #define THIS_MODULE ((void*)0)
249 #define EXPORT_SYMBOL(...)
250 #define __init
251 #define __exit
252 #define module_init(...)
253 #define module_exit(...)
254
255 #define is_kdump_kernel() (0)
256
257 /* from Linux's ethtool.h.  We probably won't use any of this code, but at
258  * least we can keep it quiet during porting. */
259 #define SPEED_10        10
260 #define SPEED_100       100
261 #define SPEED_1000      1000
262 #define SPEED_2500      2500
263 #define SPEED_10000     10000
264 #define SPEED_20000     20000
265 #define SPEED_40000     40000
266 #define SPEED_56000     56000
267 #define SPEED_UNKNOWN   -1
268
269 /* Duplex, half or full. */
270 #define DUPLEX_HALF     0x00
271 #define DUPLEX_FULL     0x01
272 #define DUPLEX_UNKNOWN  0xff
273
274 #define SUPPORTED_10baseT_Half      (1 << 0)
275 #define SUPPORTED_10baseT_Full      (1 << 1)
276 #define SUPPORTED_100baseT_Half     (1 << 2)
277 #define SUPPORTED_100baseT_Full     (1 << 3)
278 #define SUPPORTED_1000baseT_Half    (1 << 4)
279 #define SUPPORTED_1000baseT_Full    (1 << 5)
280 #define SUPPORTED_Autoneg       (1 << 6)
281 #define SUPPORTED_TP            (1 << 7)
282 #define SUPPORTED_AUI           (1 << 8)
283 #define SUPPORTED_MII           (1 << 9)
284 #define SUPPORTED_FIBRE         (1 << 10)
285 #define SUPPORTED_BNC           (1 << 11)
286 #define SUPPORTED_10000baseT_Full   (1 << 12)
287 #define SUPPORTED_Pause         (1 << 13)
288 #define SUPPORTED_Asym_Pause        (1 << 14)
289 #define SUPPORTED_2500baseX_Full    (1 << 15)
290 #define SUPPORTED_Backplane     (1 << 16)
291 #define SUPPORTED_1000baseKX_Full   (1 << 17)
292 #define SUPPORTED_10000baseKX4_Full (1 << 18)
293 #define SUPPORTED_10000baseKR_Full  (1 << 19)
294 #define SUPPORTED_10000baseR_FEC    (1 << 20)
295 #define SUPPORTED_20000baseMLD2_Full    (1 << 21)
296 #define SUPPORTED_20000baseKR2_Full (1 << 22)
297 #define SUPPORTED_40000baseKR4_Full (1 << 23)
298 #define SUPPORTED_40000baseCR4_Full (1 << 24)
299 #define SUPPORTED_40000baseSR4_Full (1 << 25)
300 #define SUPPORTED_40000baseLR4_Full (1 << 26)
301 #define SUPPORTED_56000baseKR4_Full (1 << 27)
302 #define SUPPORTED_56000baseCR4_Full (1 << 28)
303 #define SUPPORTED_56000baseSR4_Full (1 << 29)
304 #define SUPPORTED_56000baseLR4_Full (1 << 30)
305
306 #define ADVERTISED_10baseT_Half     (1 << 0)
307 #define ADVERTISED_10baseT_Full     (1 << 1)
308 #define ADVERTISED_100baseT_Half    (1 << 2)
309 #define ADVERTISED_100baseT_Full    (1 << 3)
310 #define ADVERTISED_1000baseT_Half   (1 << 4)
311 #define ADVERTISED_1000baseT_Full   (1 << 5)
312 #define ADVERTISED_Autoneg      (1 << 6)
313 #define ADVERTISED_TP           (1 << 7)
314 #define ADVERTISED_AUI          (1 << 8)
315 #define ADVERTISED_MII          (1 << 9)
316 #define ADVERTISED_FIBRE        (1 << 10)
317 #define ADVERTISED_BNC          (1 << 11)
318 #define ADVERTISED_10000baseT_Full  (1 << 12)
319 #define ADVERTISED_Pause        (1 << 13)
320 #define ADVERTISED_Asym_Pause       (1 << 14)
321 #define ADVERTISED_2500baseX_Full   (1 << 15)
322 #define ADVERTISED_Backplane        (1 << 16)
323 #define ADVERTISED_1000baseKX_Full  (1 << 17)
324 #define ADVERTISED_10000baseKX4_Full    (1 << 18)
325 #define ADVERTISED_10000baseKR_Full (1 << 19)
326 #define ADVERTISED_10000baseR_FEC   (1 << 20)
327 #define ADVERTISED_20000baseMLD2_Full   (1 << 21)
328 #define ADVERTISED_20000baseKR2_Full    (1 << 22)
329 #define ADVERTISED_40000baseKR4_Full    (1 << 23)
330 #define ADVERTISED_40000baseCR4_Full    (1 << 24)
331 #define ADVERTISED_40000baseSR4_Full    (1 << 25)
332 #define ADVERTISED_40000baseLR4_Full    (1 << 26)
333 #define ADVERTISED_56000baseKR4_Full    (1 << 27)
334 #define ADVERTISED_56000baseCR4_Full    (1 << 28)
335 #define ADVERTISED_56000baseSR4_Full    (1 << 29)
336 #define ADVERTISED_56000baseLR4_Full    (1 << 30)
337
338 enum ethtool_test_flags {
339         ETH_TEST_FL_OFFLINE = (1 << 0),
340         ETH_TEST_FL_FAILED  = (1 << 1),
341         ETH_TEST_FL_EXTERNAL_LB = (1 << 2),
342         ETH_TEST_FL_EXTERNAL_LB_DONE    = (1 << 3),
343 };
344
345 enum ethtool_stringset {
346         ETH_SS_TEST     = 0,
347         ETH_SS_STATS,
348         ETH_SS_PRIV_FLAGS,
349         ETH_SS_NTUPLE_FILTERS,
350         ETH_SS_FEATURES,
351         ETH_SS_RSS_HASH_FUNCS,
352 };
353
354 enum {
355         ETH_RSS_HASH_TOP_BIT, /* Configurable RSS hash function - Toeplitz */
356         ETH_RSS_HASH_XOR_BIT, /* Configurable RSS hash function - Xor */
357
358         ETH_RSS_HASH_FUNCS_COUNT
359 };
360
361 #define __ETH_RSS_HASH_BIT(bit) ((uint32_t)1 << (bit))
362 #define __ETH_RSS_HASH(name)    __ETH_RSS_HASH_BIT(ETH_RSS_HASH_##name##_BIT)
363
364 #define ETH_RSS_HASH_TOP    __ETH_RSS_HASH(TOP)
365 #define ETH_RSS_HASH_XOR    __ETH_RSS_HASH(XOR)
366
367 #define ETH_RSS_HASH_UNKNOWN    0
368 #define ETH_RSS_HASH_NO_CHANGE  0
369
370
371 /* EEPROM Standards for plug in modules */
372 #define ETH_MODULE_SFF_8079     0x1
373 #define ETH_MODULE_SFF_8079_LEN     256
374 #define ETH_MODULE_SFF_8472     0x2
375 #define ETH_MODULE_SFF_8472_LEN     512
376 #define ETH_MODULE_SFF_8636     0x3
377 #define ETH_MODULE_SFF_8636_LEN     256
378 #define ETH_MODULE_SFF_8436     0x4
379 #define ETH_MODULE_SFF_8436_LEN     256
380
381 #define ETH_GSTRING_LEN     32
382
383 /* ethernet protocol ids.  the plan 9 equivalent enum only exists in
384  * ethermedium.c. */
385 #define ETH_P_IP    0x0800      /* Internet Protocol packet */
386 #define ETH_P_IPV6  0x86DD      /* IPv6 over bluebook       */
387 #define ETH_P_ARP   0x0806      /* Address Resolution packet    */
388 #define ETH_P_FIP   0x8914      /* FCoE Initialization Protocol */
389 #define ETH_P_8021Q 0x8100          /* 802.1Q VLAN Extended Header  */
390
391 /* Sockaddr structs */
392 struct sockaddr {
393         uint16_t                                sa_family;
394         char                                    sa_data[14];
395 };
396
397 struct in_addr {
398         uint32_t                s_addr;
399 };
400 struct sockaddr_in {
401         uint16_t                                sin_family;
402         uint16_t                                sin_port;
403         struct in_addr                  sin_addr;
404         uint8_t                                 sin_zero[8]; /* padding */
405 };
406
407 struct in6_addr {
408         /* this is actually a weird union in glibc */
409         uint8_t                                 s6_addr[16];
410 };
411
412 struct sockaddr_in6 {
413         uint16_t                                sin6_family;
414         uint16_t                                sin6_port;
415         uint32_t                                sin6_flowinfo;
416         struct in6_addr                 sin6_addr;
417         uint32_t                                sin6_scope_id;
418 };
419
420 /* Common way to go from netdev (ether / netif) to driver-private ctlr */
421 static inline void *netdev_priv(struct ether *dev)
422 {
423         return dev->ctlr;
424 }
425
426 /* u64 on linux, but a u32 on plan 9.  the typedef is probably a good idea */
427 typedef unsigned int netdev_features_t;
428
429 /* Linux has features, hw_features, and a couple others.  Plan 9 just has
430  * features.  This #define should work for merging hw and regular features.  We
431  * spatched away the hw_enc and vlan feats. */
432 #define hw_features feat
433
434 /* Attempted conversions for plan 9 features.  For some things, like rx
435  * checksums, the driver flags the block (e.g. Budpck) to say if a receive
436  * checksum was already done.  There is no flag for saying the device can do
437  * it.  For transmits, the stack needs to know in advance if the device can
438  * handle the checksum or not. */
439 #define NETIF_F_RXHASH                          0
440 #define NETIF_F_RXCSUM                          0
441 #define NETIF_F_LRO                                     NETF_LRO
442 #define NETIF_F_GRO                                     0
443 #define NETIF_F_LOOPBACK                        0
444 #define NETIF_F_TSO                                     NETF_TSO
445 #define NETIF_F_SG                                      NETF_SG
446 #define NETIF_F_IP_CSUM                         (NETF_IPCK | NETF_UDPCK | NETF_TCPCK)
447 #define NETIF_F_IPV6_CSUM                       (NETF_IPCK | NETF_UDPCK | NETF_TCPCK)
448 #define NETIF_F_GSO_GRE                         0
449 #define NETIF_F_GSO_UDP_TUNNEL          0
450 #define NETIF_F_GSO_IPIP                        0
451 #define NETIF_F_GSO_SIT                         0
452 #define NETIF_F_TSO_ECN                         0
453 #define NETIF_F_TSO6                            0
454 #define NETIF_F_HW_VLAN_CTAG_TX         0
455 #define NETIF_F_HIGHDMA                         0
456 #define NETIF_F_HW_VLAN_CTAG_RX         0
457
458 /* Global mutex in linux for "routing netlink".  Not sure if we have an
459  * equivalent or not in Plan 9. */
460 #define rtnl_lock()
461 #define rtnl_unlock()
462 #define ASSERT_RTNL(...)
463
464 #define synchronize_irq(x) warn_once("Asked to sync IRQ %d, unsupported", x)
465 #define HZ 100
466
467 /* Linux has a PCI device id struct.  Drivers make tables of their supported
468  * devices, and this table is handled by higher level systems.  We don't have
469  * those systems, but we probably want the table still for our own parsing. */
470 struct pci_device_id {
471         uint32_t vendor, device;                /* Vendor and device ID or PCI_ANY_ID*/
472         uint32_t subvendor, subdevice;  /* Subsystem ID's or PCI_ANY_ID */
473         uint32_t class, class_mask;             /* (class,subclass,prog-if) triplet */
474         unsigned long driver_data;              /* Data private to the driver */
475 };
476
477 #define PCI_ANY_ID (~0)
478 /* This macro is used in setting device_id entries */
479 #define PCI_VDEVICE(vend, dev) \
480     .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
481     .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
482
483 /* Linux also has its own table of vendor ids.  We have the pci_defs table, but
484  * this is a bootstrap issue. */
485 #define PCI_VENDOR_ID_BROADCOM      0x14e4
486
487 /* I'd like to spatch all of the pci methods, but I don't know how to do the
488  * reads.  Since we're not doing the reads, then no sense doing the writes. */
489 static inline int pci_read_config_byte(struct pci_device *dev, uint32_t off,
490                                        uint8_t *val)
491 {
492         *val = pcidev_read8(dev, off);
493         return 0;
494 }
495                                        
496 static inline int pci_read_config_word(struct pci_device *dev, uint32_t off,
497                                        uint16_t *val)
498 {
499         *val = pcidev_read16(dev, off);
500         return 0;
501 }
502                                        
503 static inline int pci_read_config_dword(struct pci_device *dev, uint32_t off,
504                                         uint32_t *val)
505 {
506         *val = pcidev_read32(dev, off);
507         return 0;
508 }
509                                        
510 static inline int pci_write_config_byte(struct pci_device *dev, uint32_t off,
511                                         uint8_t val)
512 {
513         pcidev_write8(dev, off, val);
514         return 0;
515 }
516
517 static inline int pci_write_config_word(struct pci_device *dev, uint32_t off,
518                                         uint16_t val)
519 {
520         pcidev_write16(dev, off, val);
521         return 0;
522 }
523
524 static inline int pci_write_config_dword(struct pci_device *dev, uint32_t off,
525                                          uint32_t val)
526 {
527         pcidev_write32(dev, off, val);
528         return 0;
529 }
530
531 #endif /* ROS_KERN_AKAROS_COMPAT_H */