Fixes unchecked results from parsecmd
[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);
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(Enonexist);
105         cb = parsecmd(buf, n);
106         if (waserror()) {
107                 kfree(cb);
108                 nexterror();
109         }
110         if (cb->nf < 1)
111                 error("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 static void bnx2x_promiscuous(void *arg, int on)
122 {
123         int rctl;
124         struct bnx2x *ctlr;
125         struct ether *edev;
126
127         edev = arg;
128         ctlr = edev->ctlr;
129         /* TODO: set promisc on/off */
130 }
131
132 static void bnx2x_multicast(void *arg, uint8_t * addr, int add)
133 {
134         int bit, x;
135         struct bnx2x *ctlr;
136         struct ether *edev;
137
138         edev = arg;
139         ctlr = edev->ctlr;
140         /* TODO: add or remove a multicast addr */
141 }
142
143 /* The poke function: we are guaranteed that only one copy of this func runs
144  * per poke tracker (per queue).  Both transmit and tx_int will poke, and after
145  * any pokes, the func will run at least once.
146  *
147  * Some notes for optimizing and synchronization:
148  *
149  * If we want a flag or something to keep us from checking the oq and attempting
150  * the xmit, all that will do is speed up xmit when the tx rings are full.
151  * You'd need to be careful.  The post/poke makes sure that this'll run after
152  * work was posted, but if this function sets an abort flag and later checks it,
153  * you need to check tx_avail *after* setting the flag (check, signal, check
154  * again).  Consider this:
155  *
156  * this func:
157  *              calls start_xmit, fails with BUSY.  wants to set ABORT flag
158  *
159  *      PAUSE - meanwhile:
160  *
161  * tx_int clears the ABORT flag, then pokes:
162  *              drain so there is room;
163  *              clear flag (combo of these is "post work");
164  *              poke;.  guaranteed that poke will happen after we cleared flag.
165  *                      but it is concurrent with this function
166  *
167  *              RESUME this func:
168  *
169  *              sets ABORT flag
170  *              returns.
171  *              tx_int's poke ensures we run again
172  *              we run again and see ABORT, then return
173  *              never try again til the next tx_int, if ever
174  *
175  * Instead, in this func, we must set ABORT flag, then check tx_avail.  Or
176  * have two flags, one set by us, another set by tx_int, where this func only
177  * clears the tx_int flag when it will attempt a start_xmit.
178  *
179  * It's probably easier to just check tx_avail before entering the while loop,
180  * if you're really concerned.  If you want to do the flag thing, probably use
181  * two flags (atomically), and be careful. */
182 void __bnx2x_tx_queue(void *txdata_arg)
183 {
184         struct bnx2x_fp_txdata *txdata = txdata_arg;
185         struct block *block;
186         struct queue *oq = txdata->oq;
187
188         /* TODO: avoid bugs til multi-queue is working */
189         assert(oq);
190         assert(txdata->txq_index == 0);
191
192         while ((block = qget(oq))) {
193                 if ((bnx2x_start_xmit(block, txdata) != NETDEV_TX_OK)) {
194                         /* all queue readers are sync'd by the poke, so we can putback
195                          * without fear of going out of order. */
196
197                         /* TODO: q code has methods that should be called with the spinlock
198                          * held, but no methods to do the locking... */
199                         //spin_unlock_irqsave(&oq->lock);
200                         qputback(oq, block);
201                         //spin_lock_irqsave(&oq->lock);
202
203                         /* device can't handle any more, we're done for now.  tx_int will
204                          * poke when space frees up.  it may be poking concurrently, and in
205                          * which case, we'll run again immediately. */
206                         break;
207                 }
208         }
209 }
210
211 static void bnx2x_transmit(struct ether *edev)
212 {
213         struct bnx2x *ctlr = edev->ctlr;
214         struct bnx2x_fp_txdata *txdata;
215         /* TODO: determine the tx queue we're supposed to work on */
216         int txq_index = 0;
217
218         txdata = &ctlr->bnx2x_txq[txq_index];
219         poke(&txdata->poker, txdata);
220 }
221
222 /* Not mandatory.  Called to make sure there are free blocks available for
223  * incoming packets */
224 static void bnx2x_replenish(struct bnx2x *ctlr)
225 {
226         struct block *bp;
227
228         while (1) {
229         //while (NEXT_RING(rdt, ctlr->nrd) != ctlr->rdh) {
230                 //if we want a new block
231                 {
232                         bp = iallocb(64); // TODO: use your block size, e.g. Rbsz
233                         if (bp == NULL) {
234                                 /* needs to be a safe print for interrupt level */
235                                 printk("#l%d bnx2x_replenish: no available buffers\n",
236                                            ctlr->edev->ctlrno);
237                                 break;
238                         }
239                         //ctlr->rb[rdt] = bp;
240                         //rd->addr[0] = paddr_low32(bp->rp);
241                         //rd->addr[1] = paddr_high32(bp->rp);
242                 }
243                 wmb();  /* ensure prev rd writes come before status = 0. */
244                 //rd->status = 0;
245         }
246 }
247
248 /* Not mandatory.  Device init. */
249 static void bnx2x_rxinit(struct bnx2x *ctlr)
250 {
251         bnx2x_replenish(ctlr);
252 }
253
254 static int bnx2x_rim(void* ctlr)
255 {
256         //return ((struct bnx2x*)ctlr)->rim != 0;
257         return 1;
258 }
259
260 /* Do we want a receive proc?  It is similar to softirq.  Or we can do the work
261  * in hard IRQ ctx. */
262 static void bnx2x_rproc(void *arg)
263 {
264         struct block *bp;
265         struct bnx2x *ctlr;
266         struct ether *edev;
267
268         edev = arg;
269         ctlr = edev->ctlr;
270
271         bnx2x_rxinit(ctlr);
272         /* TODO: one time RX init */
273
274
275         for (;;) {
276                 /* TODO: set up, once per sleep.  make sure we'll wake up */
277                 rendez_sleep(&ctlr->rrendez, bnx2x_rim, ctlr);
278
279                 for (;;) {
280                         /* if we can get a block, here's how to ram it up the stack */
281
282                         if (1) {
283                                 bp = (void*)0xdeadbeef;
284                                 //bp = ctlr->rb[rdh];
285                                 //bp->wp += rd->length;
286                                 //bp->next = NULL;
287                                 /* conditionally, set block flags */
288                                         //bp->flag |= Bipck; /* IP checksum done in HW */
289                                         //bp->flag |= Btcpck | Budpck;
290                                         //bp->checksum = rd->checksum;
291                                         //bp->flag |= Bpktck;   /* Packet checksum? */
292                                 etheriq(edev, bp, 1);
293                         } else {
294                                 //freeb(ctlr->rb[rdh]);
295                         }
296
297                 }
298                 // optionally
299                         bnx2x_replenish(ctlr);
300         }
301 }
302
303 static void bnx2x_attach(struct ether *edev)
304 {
305         ERRSTACK(1);
306         struct block *bp;
307         struct bnx2x *ctlr;
308         char *name;
309
310         ctlr = edev->ctlr;
311         ctlr->edev = edev;      /* point back to Ether* */
312
313         qlock(&ctlr->alock);
314         if (ctlr->attached) {
315                 qunlock(&ctlr->alock);
316                 return;
317         }
318
319         bnx2x_open(ctlr->edev);
320         bnx2x_set_rx_mode(edev);
321
322         ctlr->attached = TRUE;
323         qunlock(&ctlr->alock);
324         /* not sure if we'll need/want any of the other 9ns stuff */
325         return;
326
327         /* Alloc all your ctrl crap. */
328
329         /* the ktasks should free these names, if they ever exit */
330         name = kmalloc(KNAMELEN, KMALLOC_WAIT);
331         snprintf(name, KNAMELEN, "#l%d-bnx2x_rproc", edev->ctlrno);
332         ktask(name, bnx2x_rproc, edev);
333
334         qunlock(&ctlr->alock);
335 }
336
337 /* Hard IRQ */
338 static void bnx2x_interrupt(struct hw_trapframe *hw_tf, void *arg)
339 {
340         struct bnx2x *ctlr;
341         struct ether *edev;
342         int icr, im, txdw;
343
344         edev = arg;
345         ctlr = edev->ctlr;
346
347                         /* At some point, wake up the rproc */
348                         rendez_wakeup(&ctlr->rrendez);
349
350         /* optionally, might need to transmit (not sure if this is a good idea in
351          * hard irq or not) */
352         bnx2x_transmit(edev);
353 }
354
355 static void bnx2x_shutdown(struct ether *ether)
356 {
357         /*
358          * Perform a device reset to get the chip back to the
359          * power-on state, followed by an EEPROM reset to read
360          * the defaults for some internal registers.
361          */
362         /* igbe did: */
363         //igbedetach(ether->ctlr);
364 }
365
366 /* "reset", getting it back to the basic power-on state.  9ns drivers call this
367  * during the initial setup (from the PCI func) */
368 static int bnx2x_reset(struct bnx2x *ctlr)
369 {
370         int ctrl, i, pause, r, swdpio, txcw;
371
372         bnx2x_init_one(ctlr->edev, ctlr, ctlr->pcidev, ctlr->pci_id);
373         return 0;
374 }
375
376 static void bnx2x_pci(void)
377 {
378         int cls, id;
379         struct pci_device *pcidev;
380         struct bnx2x *ctlr;
381         const struct pci_device_id *pci_id;
382
383         STAILQ_FOREACH(pcidev, &pci_devices, all_dev) {
384                 /* This checks that pcidev is a Network Controller for Ethernet */
385                 if (pcidev->class != 0x02 || pcidev->subclass != 0x00)
386                         continue;
387                 id = pcidev->dev_id << 16 | pcidev->ven_id;
388
389                 pci_id = srch_bnx2x_pci_tbl(pcidev);
390                 if (!pci_id)
391                         continue;
392
393                 /* only run bnx2x's __init method once we know we have one */
394                 run_once(bnx2x_init());
395
396                 printk("bnx2x driver found 0x%04x:%04x at %02x:%02x.%x\n",
397                            pcidev->ven_id, pcidev->dev_id,
398                            pcidev->bus, pcidev->dev, pcidev->func);
399
400                 /* MMIO, pci_bus_master, etc, are all done in bnx2x_attach */
401
402                 cls = pcidev_read8(pcidev, PCI_CLSZ_REG);
403                 switch (cls) {
404                         default:
405                                 printd("bnx2x: unexpected CLS - %d\n", cls * 4);
406                                 break;
407                         case 0x00:
408                         case 0xFF:
409                                 /* bogus value; use a sane default.  cls is set in DWORD (u32)
410                                  * units. */
411                                 cls = ARCH_CL_SIZE / sizeof(long);
412                                 pcidev_write8(pcidev, PCI_CLSZ_REG, cls);
413                                 break;
414                         case 0x08:
415                         case 0x10:
416                                 break;
417                 }
418
419                 ctlr = kzmalloc(sizeof(struct bnx2x), 0);
420                 if (ctlr == NULL)
421                         error(Enomem);
422
423                 spinlock_init_irqsave(&ctlr->imlock);
424                 spinlock_init_irqsave(&ctlr->tlock);
425                 qlock_init(&ctlr->alock);
426                 qlock_init(&ctlr->slock);
427                 rendez_init(&ctlr->rrendez);
428
429                 ctlr->pcidev = pcidev;
430                 ctlr->pci_id = pci_id;
431                 
432                 spin_lock(&bnx2x_tq_lock);
433                 TAILQ_INSERT_TAIL(&bnx2x_tq, ctlr, link9ns);
434                 spin_unlock(&bnx2x_tq_lock);
435         }
436 }
437
438 /* Called by devether's probe routines.  Return -1 if the edev does not match
439  * any of your ctlrs. */
440 static int bnx2x_pnp(struct ether *edev)
441 {
442         struct bnx2x *ctlr;
443
444         /* Allocs ctlrs for all PCI devices matching our IDs, does various PCI and
445          * MMIO/port setup */
446         run_once(bnx2x_pci());
447
448         spin_lock(&bnx2x_tq_lock);
449         TAILQ_FOREACH(ctlr, &bnx2x_tq, link9ns) {
450                 /* just take the first inactive ctlr on the list */
451                 if (ctlr->active)
452                         continue;
453                 ctlr->active = 1;
454                 break;
455         }
456         spin_unlock(&bnx2x_tq_lock);
457         if (ctlr == NULL)
458                 return -1;
459
460         edev->ctlr = ctlr;
461         ctlr->edev = edev;
462
463         //edev->port = ctlr->port;      /* might just remove this from devether */
464         edev->irq = ctlr->pcidev->irqline;
465         edev->tbdf = MKBUS(BusPCI, ctlr->pcidev->bus, ctlr->pcidev->dev,
466                            ctlr->pcidev->func);
467         edev->mbps = 1000;
468         memmove(edev->ea, ctlr->link_params.mac_addr, Eaddrlen);
469         
470         /*
471          * Linkage to the generic ethernet driver.
472          */
473         edev->attach = bnx2x_attach;
474         edev->transmit = bnx2x_transmit;
475         edev->ifstat = bnx2x_ifstat;
476         edev->ctl = bnx2x_ctl;
477         edev->shutdown = bnx2x_shutdown;
478
479         edev->arg = edev;
480         edev->promiscuous = bnx2x_promiscuous;
481         edev->multicast = bnx2x_multicast;
482
483         bnx2x_reset(ctlr);
484
485         return 0;
486 }
487
488 linker_func_3(etherbnx2x_link)
489 {
490         addethercard("bnx2x", bnx2x_pnp);
491 }