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