net: Use NULL to signal lack of promisc/multicast
[akaros.git] / kern / drivers / net / bnx2x / bnx2x_dev.c
1 /* This file is part of the UCB release of Plan 9. It is subject to the license
2  * terms in the LICENSE file found in the top-level directory of this
3  * distribution and at http://akaros.cs.berkeley.edu/files/Plan9License. No
4  * part of the UCB release of Plan 9, including this file, may be copied,
5  * modified, propagated, or distributed except according to the terms contained
6  * in the LICENSE file. */
7
8 /* Network driver stub for bnx2x_ */
9
10 #include <vfs.h>
11 #include <kfs.h>
12 #include <slab.h>
13 #include <kmalloc.h>
14 #include <kref.h>
15 #include <string.h>
16 #include <stdio.h>
17 #include <assert.h>
18 #include <error.h>
19 #include <cpio.h>
20 #include <pmap.h>
21 #include <smp.h>
22 #include <arch/pci.h>
23 #include <ip.h>
24 #include <ns.h>
25 #include "bnx2x.h"
26
27 /* TODO: Cheap externs */
28 extern int __init bnx2x_init(void);
29 extern bool is_bnx2x_dev(struct pci_device *dev);
30 extern const struct pci_device_id *
31                     srch_bnx2x_pci_tbl(struct pci_device *needle);
32 extern int bnx2x_init_one(struct ether *dev, struct bnx2x *bp,
33                           struct pci_device *pdev,
34                           const struct pci_device_id *ent);
35 extern int bnx2x_open(struct ether *dev);
36 extern void bnx2x_set_rx_mode(struct ether *dev);
37 extern netdev_tx_t bnx2x_start_xmit(struct block *block,
38                                     struct bnx2x_fp_txdata *txdata);
39
40 spinlock_t bnx2x_tq_lock = SPINLOCK_INITIALIZER;
41 TAILQ_HEAD(bnx2x_tq, bnx2x);
42 struct bnx2x_tq bnx2x_tq = TAILQ_HEAD_INITIALIZER(bnx2x_tq);
43
44 /* We're required to print out stats at some point.  Here are a couple from
45  * igbe, as an example. */
46 static char *statistics[Nstatistics] = {
47         "CRC Error",
48         "Alignment Error",
49 };
50
51 static long bnx2x_ifstat(struct ether *edev, void *a, long n, uint32_t offset)
52 {
53         struct bnx2x *ctlr;
54         char *p, *s;
55         int i, l, r;
56         uint64_t tuvl, ruvl;
57
58         ctlr = edev->ctlr;
59         qlock(&ctlr->slock);
60         p = kzmalloc(READSTR, 0);
61         if (p == NULL) {
62                 qunlock(&ctlr->slock);
63                 error(ENOMEM, ERROR_FIXME);
64         }
65         l = 0;
66         for (i = 0; i < Nstatistics; i++) {
67                 /* somehow read the device's HW stats */
68                 //r = csr32r(ctlr, Statistics + i * 4);
69                 r = 3;  /* TODO: this is the value for the statistic */
70                 if ((s = statistics[i]) == NULL)
71                         continue;
72                 /* based on the stat, spit out a string */
73                 switch (i) {
74                         default:
75                                 ctlr->statistics[i] += r;
76                                 if (ctlr->statistics[i] == 0)
77                                         continue;
78                                 l += snprintf(p + l, READSTR - l, "%s: %ud %ud\n",
79                                                           s, ctlr->statistics[i], r);
80                                 break;
81                 }
82         }
83
84         /* TODO: then print out the software-only (ctlr) stats */
85 //      l += snprintf(p + l, READSTR - l, "lintr: %ud %ud\n",
86 //                                ctlr->lintr, ctlr->lsleep);
87         n = readstr(offset, a, n, p);
88         kfree(p);
89         qunlock(&ctlr->slock);
90
91         return n;
92 }
93
94 static long bnx2x_ctl(struct ether *edev, void *buf, long n)
95 {
96         ERRSTACK(1);
97         int v;
98         char *p;
99         struct bnx2x *ctlr;
100         struct cmdbuf *cb;
101         struct cmdtab *ct;
102
103         if ((ctlr = edev->ctlr) == NULL)
104                 error(ENODEV, ERROR_FIXME);
105         cb = parsecmd(buf, n);
106         if (waserror()) {
107                 kfree(cb);
108                 nexterror();
109         }
110         if (cb->nf < 1)
111                 error(EFAIL, "short control request");
112
113         /* TODO: handle ctl command somehow.  igbe did the following: */
114         //ct = lookupcmd(cb, igbectlmsg, ARRAY_SIZE(igbectlmsg));
115
116         kfree(cb);
117         poperror();
118         return n;
119 }
120
121 /* The poke function: we are guaranteed that only one copy of this func runs
122  * per poke tracker (per queue).  Both transmit and tx_int will poke, and after
123  * any pokes, the func will run at least once.
124  *
125  * Some notes for optimizing and synchronization:
126  *
127  * If we want a flag or something to keep us from checking the oq and attempting
128  * the xmit, all that will do is speed up xmit when the tx rings are full.
129  * You'd need to be careful.  The post/poke makes sure that this'll run after
130  * work was posted, but if this function sets an abort flag and later checks it,
131  * you need to check tx_avail *after* setting the flag (check, signal, check
132  * again).  Consider this:
133  *
134  * this func:
135  *              calls start_xmit, fails with BUSY.  wants to set ABORT flag
136  *
137  *      PAUSE - meanwhile:
138  *
139  * tx_int clears the ABORT flag, then pokes:
140  *              drain so there is room;
141  *              clear flag (combo of these is "post work");
142  *              poke;.  guaranteed that poke will happen after we cleared flag.
143  *                      but it is concurrent with this function
144  *
145  *              RESUME this func:
146  *
147  *              sets ABORT flag
148  *              returns.
149  *              tx_int's poke ensures we run again
150  *              we run again and see ABORT, then return
151  *              never try again til the next tx_int, if ever
152  *
153  * Instead, in this func, we must set ABORT flag, then check tx_avail.  Or
154  * have two flags, one set by us, another set by tx_int, where this func only
155  * clears the tx_int flag when it will attempt a start_xmit.
156  *
157  * It's probably easier to just check tx_avail before entering the while loop,
158  * if you're really concerned.  If you want to do the flag thing, probably use
159  * two flags (atomically), and be careful. */
160 void __bnx2x_tx_queue(void *txdata_arg)
161 {
162         struct bnx2x_fp_txdata *txdata = txdata_arg;
163         struct block *block;
164         struct queue *oq = txdata->oq;
165
166         /* TODO: avoid bugs til multi-queue is working */
167         assert(oq);
168         assert(txdata->txq_index == 0);
169
170         while ((block = qget(oq))) {
171                 if ((bnx2x_start_xmit(block, txdata) != NETDEV_TX_OK)) {
172                         /* all queue readers are sync'd by the poke, so we can putback
173                          * without fear of going out of order. */
174
175                         /* TODO: q code has methods that should be called with the spinlock
176                          * held, but no methods to do the locking... */
177                         //spin_unlock_irqsave(&oq->lock);
178                         qputback(oq, block);
179                         //spin_lock_irqsave(&oq->lock);
180
181                         /* device can't handle any more, we're done for now.  tx_int will
182                          * poke when space frees up.  it may be poking concurrently, and in
183                          * which case, we'll run again immediately. */
184                         break;
185                 }
186         }
187 }
188
189 static void bnx2x_transmit(struct ether *edev)
190 {
191         struct bnx2x *ctlr = edev->ctlr;
192         struct bnx2x_fp_txdata *txdata;
193         /* TODO: determine the tx queue we're supposed to work on */
194         int txq_index = 0;
195
196         txdata = &ctlr->bnx2x_txq[txq_index];
197         poke(&txdata->poker, txdata);
198 }
199
200 /* Not mandatory.  Called to make sure there are free blocks available for
201  * incoming packets */
202 static void bnx2x_replenish(struct bnx2x *ctlr)
203 {
204         struct block *bp;
205
206         while (1) {
207         //while (NEXT_RING(rdt, ctlr->nrd) != ctlr->rdh) {
208                 //if we want a new block
209                 {
210                         // TODO: use your block size, e.g. Rbsz
211                         bp = block_alloc(64, MEM_ATOMIC);
212                         if (bp == NULL) {
213                                 /* needs to be a safe print for interrupt level */
214                                 printk("#l%d bnx2x_replenish: no available buffers\n",
215                                            ctlr->edev->ctlrno);
216                                 break;
217                         }
218                         //ctlr->rb[rdt] = bp;
219                         //rd->addr[0] = paddr_low32(bp->rp);
220                         //rd->addr[1] = paddr_high32(bp->rp);
221                 }
222                 wmb();  /* ensure prev rd writes come before status = 0. */
223                 //rd->status = 0;
224         }
225 }
226
227 /* Not mandatory.  Device init. */
228 static void bnx2x_rxinit(struct bnx2x *ctlr)
229 {
230         bnx2x_replenish(ctlr);
231 }
232
233 static int bnx2x_rim(void* ctlr)
234 {
235         //return ((struct bnx2x*)ctlr)->rim != 0;
236         return 1;
237 }
238
239 /* Do we want a receive proc?  It is similar to softirq.  Or we can do the work
240  * in hard IRQ ctx. */
241 static void bnx2x_rproc(void *arg)
242 {
243         struct block *bp;
244         struct bnx2x *ctlr;
245         struct ether *edev;
246
247         edev = arg;
248         ctlr = edev->ctlr;
249
250         bnx2x_rxinit(ctlr);
251         /* TODO: one time RX init */
252
253
254         for (;;) {
255                 /* TODO: set up, once per sleep.  make sure we'll wake up */
256                 rendez_sleep(&ctlr->rrendez, bnx2x_rim, ctlr);
257
258                 for (;;) {
259                         /* if we can get a block, here's how to ram it up the stack */
260
261                         if (1) {
262                                 bp = (void*)0xdeadbeef;
263                                 //bp = ctlr->rb[rdh];
264                                 //bp->wp += rd->length;
265                                 //bp->next = NULL;
266                                 /* conditionally, set block flags */
267                                         //bp->flag |= Bipck; /* IP checksum done in HW */
268                                         //bp->flag |= Btcpck | Budpck;
269                                         //bp->checksum = rd->checksum;
270                                         //bp->flag |= Bpktck;   /* Packet checksum? */
271                                 etheriq(edev, bp, 1);
272                         } else {
273                                 //freeb(ctlr->rb[rdh]);
274                         }
275
276                 }
277                 // optionally
278                         bnx2x_replenish(ctlr);
279         }
280 }
281
282 static void bnx2x_attach(struct ether *edev)
283 {
284         ERRSTACK(1);
285         struct block *bp;
286         struct bnx2x *ctlr;
287         char *name;
288
289         ctlr = edev->ctlr;
290         ctlr->edev = edev;      /* point back to Ether* */
291
292         qlock(&ctlr->alock);
293         if (ctlr->attached) {
294                 qunlock(&ctlr->alock);
295                 return;
296         }
297
298         bnx2x_open(ctlr->edev);
299         bnx2x_set_rx_mode(edev);
300
301         ctlr->attached = TRUE;
302         qunlock(&ctlr->alock);
303         /* not sure if we'll need/want any of the other 9ns stuff */
304         return;
305
306         /* Alloc all your ctrl crap. */
307
308         /* the ktasks should free these names, if they ever exit */
309         name = kmalloc(KNAMELEN, MEM_WAIT);
310         snprintf(name, KNAMELEN, "#l%d-bnx2x_rproc", edev->ctlrno);
311         ktask(name, bnx2x_rproc, edev);
312
313         qunlock(&ctlr->alock);
314 }
315
316 /* Hard IRQ */
317 static void bnx2x_interrupt(struct hw_trapframe *hw_tf, void *arg)
318 {
319         struct bnx2x *ctlr;
320         struct ether *edev;
321         int icr, im, txdw;
322
323         edev = arg;
324         ctlr = edev->ctlr;
325
326                         /* At some point, wake up the rproc */
327                         rendez_wakeup(&ctlr->rrendez);
328
329         /* optionally, might need to transmit (not sure if this is a good idea in
330          * hard irq or not) */
331         bnx2x_transmit(edev);
332 }
333
334 static void bnx2x_shutdown(struct ether *ether)
335 {
336         /*
337          * Perform a device reset to get the chip back to the
338          * power-on state, followed by an EEPROM reset to read
339          * the defaults for some internal registers.
340          */
341         /* igbe did: */
342         //igbedetach(ether->ctlr);
343 }
344
345 /* "reset", getting it back to the basic power-on state.  9ns drivers call this
346  * during the initial setup (from the PCI func) */
347 static int bnx2x_reset(struct bnx2x *ctlr)
348 {
349         int ctrl, i, pause, r, swdpio, txcw;
350
351         bnx2x_init_one(ctlr->edev, ctlr, ctlr->pcidev, ctlr->pci_id);
352         return 0;
353 }
354
355 static void bnx2x_pci(void)
356 {
357         int cls, id;
358         struct pci_device *pcidev;
359         struct bnx2x *ctlr;
360         const struct pci_device_id *pci_id;
361
362         STAILQ_FOREACH(pcidev, &pci_devices, all_dev) {
363                 /* This checks that pcidev is a Network Controller for Ethernet */
364                 if (pcidev->class != 0x02 || pcidev->subclass != 0x00)
365                         continue;
366                 id = pcidev->dev_id << 16 | pcidev->ven_id;
367
368                 pci_id = srch_bnx2x_pci_tbl(pcidev);
369                 if (!pci_id)
370                         continue;
371
372                 /* only run bnx2x's __init method once we know we have one */
373                 run_once(bnx2x_init());
374
375                 printk("bnx2x driver found 0x%04x:%04x at %02x:%02x.%x\n",
376                            pcidev->ven_id, pcidev->dev_id,
377                            pcidev->bus, pcidev->dev, pcidev->func);
378
379                 /* MMIO, pci_bus_master, etc, are all done in bnx2x_attach */
380
381                 cls = pcidev_read8(pcidev, PCI_CLSZ_REG);
382                 switch (cls) {
383                         default:
384                                 printd("bnx2x: unexpected CLS - %d\n", cls * 4);
385                                 break;
386                         case 0x00:
387                         case 0xFF:
388                                 /* bogus value; use a sane default.  cls is set in DWORD (u32)
389                                  * units. */
390                                 cls = ARCH_CL_SIZE / sizeof(long);
391                                 pcidev_write8(pcidev, PCI_CLSZ_REG, cls);
392                                 break;
393                         case 0x08:
394                         case 0x10:
395                                 break;
396                 }
397
398                 ctlr = kzmalloc(sizeof(struct bnx2x), 0);
399                 if (ctlr == NULL)
400                         error(ENOMEM, ERROR_FIXME);
401
402                 spinlock_init_irqsave(&ctlr->imlock);
403                 spinlock_init_irqsave(&ctlr->tlock);
404                 qlock_init(&ctlr->alock);
405                 qlock_init(&ctlr->slock);
406                 rendez_init(&ctlr->rrendez);
407
408                 ctlr->pcidev = pcidev;
409                 ctlr->pci_id = pci_id;
410
411                 spin_lock(&bnx2x_tq_lock);
412                 TAILQ_INSERT_TAIL(&bnx2x_tq, ctlr, link9ns);
413                 spin_unlock(&bnx2x_tq_lock);
414         }
415 }
416
417 /* Called by devether's probe routines.  Return -1 if the edev does not match
418  * any of your ctlrs. */
419 static int bnx2x_pnp(struct ether *edev)
420 {
421         struct bnx2x *ctlr;
422
423         /* Allocs ctlrs for all PCI devices matching our IDs, does various PCI and
424          * MMIO/port setup */
425         run_once(bnx2x_pci());
426
427         spin_lock(&bnx2x_tq_lock);
428         TAILQ_FOREACH(ctlr, &bnx2x_tq, link9ns) {
429                 /* just take the first inactive ctlr on the list */
430                 if (ctlr->active)
431                         continue;
432                 ctlr->active = 1;
433                 break;
434         }
435         spin_unlock(&bnx2x_tq_lock);
436         if (ctlr == NULL)
437                 return -1;
438
439         edev->ctlr = ctlr;
440         ctlr->edev = edev;
441
442         //edev->port = ctlr->port;      /* might just remove this from devether */
443         edev->irq = ctlr->pcidev->irqline;
444         edev->tbdf = MKBUS(BusPCI, ctlr->pcidev->bus, ctlr->pcidev->dev,
445                            ctlr->pcidev->func);
446         edev->mbps = 1000;
447         memmove(edev->ea, ctlr->link_params.mac_addr, Eaddrlen);
448
449         /*
450          * Linkage to the generic ethernet driver.
451          */
452         edev->attach = bnx2x_attach;
453         edev->transmit = bnx2x_transmit;
454         edev->ifstat = bnx2x_ifstat;
455         edev->ctl = bnx2x_ctl;
456         edev->shutdown = bnx2x_shutdown;
457
458         edev->arg = edev;
459         edev->promiscuous = NULL;
460         edev->multicast = NULL;
461
462         bnx2x_reset(ctlr);
463
464         return 0;
465 }
466
467 linker_func_3(etherbnx2x_link)
468 {
469         addethercard("bnx2x", bnx2x_pnp);
470 }