Remove the unit included in the softc, it is not used beside the call to
[dragonfly.git] / sys / dev / netif / nv / if_nv.c
1 /*
2  * Copyright (c) 2003 by Quinton Dolan <q@onthenet.com.au>. 
3  * All rights reserved.
4  * 
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions 
7  * are met: 
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer. 
10  * 2. Redistributions in binary form must reproduce the above copyright 
11  *    notice, this list of conditions and the following disclaimer in the 
12  *    documentation and/or other materials provided with the distribution.
13  * 
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
18  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  * 
26  * $Id: if_nv.c,v 1.9 2003/12/13 15:27:40 q Exp $
27  * $DragonFly: src/sys/dev/netif/nv/Attic/if_nv.c,v 1.2 2004/09/05 12:36:16 joerg Exp $
28  */
29
30 /*
31  * NVIDIA nForce MCP Networking Adapter driver
32  * 
33  * This is a port of the NVIDIA MCP Linux ethernet driver distributed by NVIDIA
34  * through their web site.
35  * 
36  * All mainstream nForce and nForce2 motherboards are supported. This module
37  * is as stable, sometimes more stable, than the linux version. (This seems to 
38  * be related to some issues with newer distributions using GCC 3.2, however 
39  * this don't appear to effect FreeBSD 5.x).
40  * 
41  * In accordance with the NVIDIA distribution license it is necessary to link
42  * this module against the nvlibnet.o binary object included in the Linux
43  * driver source distribution. The binary component is not modified in any
44  * way and is simply linked against a FreeBSD equivalent of the nvnet.c linux
45  * kernel module "wrapper".
46  * 
47  * The Linux driver uses a common code API that is shared between Win32 and
48  * Linux. This abstracts the low level driver functions and uses callbacks
49  * and hooks to access the underlying hardware device. By using this same API
50  * in a FreeBSD kernel module it is possible to support the hardware without
51  * breaching the Linux source distributions licensing requirements, or
52  * obtaining the hardware programming specifications.
53  * 
54  * Although not conventional, it works, and given the relatively small amount of
55  * hardware centric code, it's hopefully no more buggy than its linux
56  * counterpart.
57  *
58  * Written by Quinton Dolan <q@onthenet.com.au> 
59  * Portions based on existing FreeBSD network drivers. 
60  * NVIDIA API usage derived from distributed NVIDIA NVNET driver source files.
61  * 
62  * $Id: if_nv.c,v 1.9 2003/12/13 15:27:40 q Exp $
63  */
64
65 #include <sys/param.h>
66 #include <sys/systm.h>
67 #include <sys/sockio.h>
68 #include <sys/mbuf.h>
69 #include <sys/malloc.h>
70 #include <sys/kernel.h>
71 #include <sys/socket.h>
72 #include <sys/sysctl.h>
73 #include <sys/queue.h>
74 #include <sys/module.h>
75
76 #include <net/if.h>
77 #include <net/if_arp.h>
78 #include <net/ethernet.h>
79 #include <net/if_dl.h>
80 #include <net/if_media.h>
81
82 #include <net/bpf.h>
83
84 #include <net/vlan/if_vlan_var.h>
85
86 #include <machine/bus_memio.h>
87 #include <machine/bus.h>
88 #include <machine/resource.h>
89
90 #include <vm/vm.h>              /* for vtophys */
91 #include <vm/pmap.h>            /* for vtophys */
92 #include <machine/clock.h>      /* for DELAY */
93 #include <sys/bus.h>
94 #include <sys/rman.h>
95
96 #include <bus/pci/pcireg.h>
97 #include <bus/pci/pcivar.h>
98
99 #include <dev/netif/mii_layer/mii.h>
100 #include <dev/netif/mii_layer/miivar.h>
101
102 MODULE_DEPEND(nv, pci, 1, 1, 1);
103 MODULE_DEPEND(nv, ether, 1, 1, 1);
104 MODULE_DEPEND(nv, miibus, 1, 1, 1);
105
106 #include "if_nvreg.h"
107 #include "miibus_if.h"
108
109 static int      nv_probe(device_t);
110 static int      nv_attach(device_t);
111 static int      nv_detach(device_t);
112 static void     nv_init(void *);
113 static void     nv_stop(struct nv_softc *);
114 static void     nv_shutdown(device_t);
115 static int      nv_init_rings(struct nv_softc *);
116 static void     nv_free_rings(struct nv_softc *);
117
118 static void     nv_ifstart(struct ifnet *);
119 static int      nv_ioctl(struct ifnet *, u_long, caddr_t, struct ucred *);
120 static void     nv_intr(void *);
121 static void     nv_tick(void *);
122 static void     nv_setmulti(struct nv_softc *);
123 static void     nv_watchdog(struct ifnet *);
124 static void     nv_update_stats(struct nv_softc *);
125
126 static int      nv_ifmedia_upd(struct ifnet *);
127 static void     nv_ifmedia_sts(struct ifnet *, struct ifmediareq *);
128 static int      nv_miibus_readreg(device_t, int, int);
129 static void     nv_miibus_writereg(device_t, int, int, int);
130
131 static void     nv_dmamap_cb(void *, bus_dma_segment_t *, int, int);
132 static void     nv_dmamap_tx_cb(void *, bus_dma_segment_t *, int, bus_size_t, int);
133
134 static int      nv_osalloc(void *, MEMORY_BLOCK *);
135 static int      nv_osfree(void *, MEMORY_BLOCK *);
136 static int      nv_osallocex(void *, MEMORY_BLOCKEX *);
137 static int      nv_osfreeex(void *, MEMORY_BLOCKEX *);
138 static int      nv_osclear(void *, void *, int);
139 static int      nv_osdelay(void *, unsigned long);
140 static int      nv_osallocrxbuf(void *, MEMORY_BLOCK *, void **);
141 static int      nv_osfreerxbuf(void *, MEMORY_BLOCK *, void *);
142 static int      nv_ospackettx(void *, void *, unsigned long);
143 static int      nv_ospacketrx(void *, void *, unsigned long, unsigned char *, unsigned char);
144 static int      nv_oslinkchg(void *, int);
145 static int      nv_osalloctimer(void *, void **);
146 static int      nv_osfreetimer(void *, void *);
147 static int      nv_osinittimer(void *, void *, PTIMER_FUNC, void *);
148 static int      nv_ossettimer(void *, void *, unsigned long);
149 static int      nv_oscanceltimer(void *, void *);
150 static int      nv_ospreprocpkt(void *, void *, void **, unsigned char *, unsigned char);
151 static void    *nv_ospreprocpktnopq(void *, void *);
152 static int      nv_osindicatepkt(void *, void **, unsigned long);
153 static int      nv_oslockalloc(void *, int, void **);
154 static int      nv_oslockacquire(void *, int, void *);
155 static int      nv_oslockrelease(void *, int, void *);
156 static void    *nv_osreturnbufvirt(void *, void *);
157
158 static device_method_t nv_methods[] = {
159         /* Device interface */
160         DEVMETHOD(device_probe, nv_probe),
161         DEVMETHOD(device_attach, nv_attach),
162         DEVMETHOD(device_detach, nv_detach),
163         DEVMETHOD(device_shutdown, nv_shutdown),
164
165         /* Bus interface */
166         DEVMETHOD(bus_print_child, bus_generic_print_child),
167         DEVMETHOD(bus_driver_added, bus_generic_driver_added),
168
169         /* MII interface */
170         DEVMETHOD(miibus_readreg, nv_miibus_readreg),
171         DEVMETHOD(miibus_writereg, nv_miibus_writereg),
172
173         {0, 0}
174 };
175
176 static driver_t nv_driver = {
177         "nv",
178         nv_methods,
179         sizeof(struct nv_softc)
180 };
181
182 static devclass_t nv_devclass;
183
184 static int      nv_pollinterval = 0;
185 SYSCTL_INT(_hw, OID_AUTO, nv_pollinterval, CTLFLAG_RW,
186            &nv_pollinterval, 0, "delay between interface polls");
187
188 DRIVER_MODULE(nv, pci, nv_driver, nv_devclass, 0, 0);
189 DRIVER_MODULE(miibus, nv, miibus_driver, miibus_devclass, 0, 0);
190
191 static struct nv_type nv_devs[] = {
192         {NVIDIA_VENDORID, NFORCE_MCPNET1_DEVICEID,
193         "NVIDIA nForce MCP Networking Adapter"},
194         {NVIDIA_VENDORID, NFORCE_MCPNET2_DEVICEID,
195         "NVIDIA nForce MCP2 Networking Adapter"},
196         {NVIDIA_VENDORID, NFORCE_MCPNET3_DEVICEID,
197         "NVIDIA nForce MCP3 Networking Adapter"},
198         {0, 0, NULL}
199 };
200
201 /* DMA MEM map callback function to get data segment physical address */
202 static void
203 nv_dmamap_cb(void *arg, bus_dma_segment_t * segs, int nsegs, int error)
204 {
205         if (error)
206                 return;
207
208         KASSERT(nsegs == 1,
209                 ("Too many DMA segments returned when mapping DMA memory"));
210         *(bus_addr_t *)arg = segs->ds_addr;
211 }
212
213 /* DMA RX map callback function to get data segment physical address */
214 static void
215 nv_dmamap_rx_cb(void *arg, bus_dma_segment_t * segs, int nsegs, bus_size_t mapsize, int error)
216 {
217         if (error)
218                 return;
219         *(bus_addr_t *)arg = segs->ds_addr;
220 }
221
222 /*
223  * DMA TX buffer callback function to allocate fragment data segment
224  * addresses
225  */
226 static void
227 nv_dmamap_tx_cb(void *arg, bus_dma_segment_t * segs, int nsegs, bus_size_t mapsize, int error)
228 {
229         struct nv_tx_desc *info = arg;
230
231         if (error)
232                 return;
233         KASSERT(nsegs < NV_MAX_FRAGS,
234                 ("Too many DMA segments returned when mapping mbuf"));
235         info->numfrags = nsegs;
236         bcopy(segs, info->frags, nsegs * sizeof(bus_dma_segment_t));
237 }
238
239 /* Probe for supported hardware ID's */
240 static int
241 nv_probe(device_t dev)
242 {
243         struct nv_type *t = nv_devs;
244
245         /* Check for matching PCI DEVICE ID's */
246         while (t->name != NULL) {
247                 if ((pci_get_vendor(dev) == t->vid_id) &&
248                     (pci_get_device(dev) == t->dev_id)) {
249                         device_set_desc(dev, t->name);
250                         return (0);
251                 }
252                 t++;
253         }
254
255         return (ENXIO);
256 }
257
258 /* Attach driver and initialise hardware for use */
259 static int
260 nv_attach(device_t dev)
261 {
262         u_char          eaddr[ETHER_ADDR_LEN];
263         struct nv_softc *sc;
264         struct ifnet   *ifp;
265         OS_API         *osapi;
266         ADAPTER_OPEN_PARAMS OpenParams;
267         int             error = 0, i, rid;
268
269         DEBUGOUT(NV_DEBUG_INIT, "nv: nv_attach - entry\n");
270
271         sc = device_get_softc(dev);
272
273         sc->dev = dev;
274
275         /* Preinitialize data structures */
276         bzero(&OpenParams, sizeof(ADAPTER_OPEN_PARAMS));
277
278         /* Enable bus mastering */
279         pci_enable_busmaster(dev);
280
281         /* Allocate memory mapped address space */
282         rid = NV_RID;
283         sc->res = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid,
284                                      0, ~0, 1, RF_ACTIVE);
285
286         if (sc->res == NULL) {
287                 device_printf(dev, "couldn't map memory\n");
288                 error = ENXIO;
289                 goto fail;
290         }
291         sc->sc_st = rman_get_bustag(sc->res);
292         sc->sc_sh = rman_get_bushandle(sc->res);
293
294         /* Allocate interrupt */
295         rid = 0;
296         sc->irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
297                                      RF_SHAREABLE | RF_ACTIVE);
298
299         if (sc->irq == NULL) {
300                 device_printf(dev, "couldn't map interrupt\n");
301                 error = ENXIO;
302                 goto fail;
303         }
304         /* Allocate DMA tags */
305         error = bus_dma_tag_create(NULL, 4, 0, BUS_SPACE_MAXADDR_32BIT,
306                      BUS_SPACE_MAXADDR, NULL, NULL, MCLBYTES * NV_MAX_FRAGS,
307                                    NV_MAX_FRAGS, MCLBYTES, 0,
308                                    &sc->mtag);
309         if (error) {
310                 device_printf(dev, "couldn't allocate dma tag\n");
311                 goto fail;
312         }
313         error = bus_dma_tag_create(NULL, 4, 0, BUS_SPACE_MAXADDR_32BIT,
314                                    BUS_SPACE_MAXADDR, NULL, NULL,
315                                 sizeof(struct nv_rx_desc) * RX_RING_SIZE, 1,
316                                 sizeof(struct nv_rx_desc) * RX_RING_SIZE, 0,
317                                    &sc->rtag);
318         if (error) {
319                 device_printf(dev, "couldn't allocate dma tag\n");
320                 goto fail;
321         }
322         error = bus_dma_tag_create(NULL, 4, 0, BUS_SPACE_MAXADDR_32BIT,
323                                    BUS_SPACE_MAXADDR, NULL, NULL,
324                                 sizeof(struct nv_tx_desc) * TX_RING_SIZE, 1,
325                                 sizeof(struct nv_tx_desc) * TX_RING_SIZE, 0,
326                                    &sc->ttag);
327         if (error) {
328                 device_printf(dev, "couldn't allocate dma tag\n");
329                 goto fail;
330         }
331         /* Allocate DMA safe memory and get the DMA addresses. */
332         error = bus_dmamem_alloc(sc->ttag, (void **)&sc->tx_desc,
333                                  BUS_DMA_NOWAIT, &sc->tmap);
334         if (error) {
335                 device_printf(dev, "couldn't allocate dma memory\n");
336                 goto fail;
337         }
338         bzero(sc->tx_desc, sizeof(struct nv_tx_desc) * TX_RING_SIZE);
339         error = bus_dmamap_load(sc->ttag, sc->tmap, sc->tx_desc,
340                      sizeof(struct nv_tx_desc) * TX_RING_SIZE, nv_dmamap_cb,
341                                 &sc->tx_addr, 0);
342         if (error) {
343                 device_printf(dev, "couldn't map dma memory\n");
344                 goto fail;
345         }
346         error = bus_dmamem_alloc(sc->rtag, (void **)&sc->rx_desc,
347                                  BUS_DMA_NOWAIT, &sc->rmap);
348         if (error) {
349                 device_printf(dev, "couldn't allocate dma memory\n");
350                 goto fail;
351         }
352         bzero(sc->rx_desc, sizeof(struct nv_rx_desc) * RX_RING_SIZE);
353         error = bus_dmamap_load(sc->rtag, sc->rmap, sc->rx_desc,
354                      sizeof(struct nv_rx_desc) * RX_RING_SIZE, nv_dmamap_cb,
355                                 &sc->rx_addr, 0);
356         if (error) {
357                 device_printf(dev, "couldn't map dma memory\n");
358                 goto fail;
359         }
360         /* Initialize rings. */
361         if (nv_init_rings(sc)) {
362                 device_printf(dev, "failed to init rings\n");
363                 error = ENXIO;
364                 goto fail;
365         }
366         /* Setup NVIDIA API callback routines */
367         osapi = &sc->osapi;
368         osapi->pOSCX = sc;
369         osapi->pfnAllocMemory = nv_osalloc;
370         osapi->pfnFreeMemory = nv_osfree;
371         osapi->pfnAllocMemoryEx = nv_osallocex;
372         osapi->pfnFreeMemoryEx = nv_osfreeex;
373         osapi->pfnClearMemory = nv_osclear;
374         osapi->pfnStallExecution = nv_osdelay;
375         osapi->pfnAllocReceiveBuffer = nv_osallocrxbuf;
376         osapi->pfnFreeReceiveBuffer = nv_osfreerxbuf;
377         osapi->pfnPacketWasSent = nv_ospackettx;
378         osapi->pfnPacketWasReceived = nv_ospacketrx;
379         osapi->pfnLinkStateHasChanged = nv_oslinkchg;
380         osapi->pfnAllocTimer = nv_osalloctimer;
381         osapi->pfnFreeTimer = nv_osfreetimer;
382         osapi->pfnInitializeTimer = nv_osinittimer;
383         osapi->pfnSetTimer = nv_ossettimer;
384         osapi->pfnCancelTimer = nv_oscanceltimer;
385         osapi->pfnPreprocessPacket = nv_ospreprocpkt;
386         osapi->pfnPreprocessPacketNopq = nv_ospreprocpktnopq;
387         osapi->pfnIndicatePackets = nv_osindicatepkt;
388         osapi->pfnLockAlloc = nv_oslockalloc;
389         osapi->pfnLockAcquire = nv_oslockacquire;
390         osapi->pfnLockRelease = nv_oslockrelease;
391         osapi->pfnReturnBufferVirtual = nv_osreturnbufvirt;
392
393         /* Set NVIDIA API startup parameters */
394         OpenParams.MaxDpcLoop = 2;
395         OpenParams.MaxRxPkt = RX_RING_SIZE;
396         OpenParams.MaxTxPkt = TX_RING_SIZE;
397         OpenParams.SentPacketStatusSuccess = 1;
398         OpenParams.SentPacketStatusFailure = 0;
399         OpenParams.MaxRxPktToAccumulate = 6;
400         OpenParams.ulPollInterval = nv_pollinterval;
401         OpenParams.SetForcedModeEveryNthRxPacket = 0;
402         OpenParams.SetForcedModeEveryNthTxPacket = 0;
403         OpenParams.RxForcedInterrupt = 0;
404         OpenParams.TxForcedInterrupt = 0;
405         OpenParams.pOSApi = osapi;
406         OpenParams.pvHardwareBaseAddress = rman_get_virtual(sc->res);
407         sc->linkup = 0;
408
409         /* Open NVIDIA Hardware API */
410         error = ADAPTER_Open(&OpenParams, (void **)&(sc->hwapi), &sc->phyaddr);
411         if (error) {
412                 device_printf(dev, "failed to open NVIDIA Hardware API: 0x%x\n", error);
413                 goto fail;
414         }
415         /* MAC is loaded backwards into h/w reg */
416         sc->hwapi->pfnGetNodeAddress(sc->hwapi->pADCX, sc->original_mac_addr);
417         for (i = 0; i < 6; i++) {
418                 eaddr[i] = sc->original_mac_addr[5 - i];
419         }
420         sc->hwapi->pfnSetNodeAddress(sc->hwapi->pADCX, eaddr);
421         bcopy(eaddr, (char *)&sc->sc_macaddr, ETHER_ADDR_LEN);
422
423         /* Display ethernet address ,... */
424         device_printf(dev, "Ethernet address %6D\n", sc->sc_macaddr, ":");
425
426         DEBUGOUT(NV_DEBUG_INIT, "nv: do mii_phy_probe\n");
427
428         /* Probe device for MII interface to PHY */
429         if (mii_phy_probe(dev, &sc->miibus,
430                           nv_ifmedia_upd, nv_ifmedia_sts)) {
431                 device_printf(dev, "MII without any phy!\n");
432                 error = ENXIO;
433                 goto fail;
434         }
435         /* Setup interface parameters */
436         ifp = &sc->sc_if;
437         ifp->if_softc = sc;
438         if_initname(ifp, device_get_name(dev), device_get_unit(dev));
439         ifp->if_flags = IFF_BROADCAST | IFF_SIMPLEX | IFF_MULTICAST;
440         ifp->if_ioctl = nv_ioctl;
441         ifp->if_start = nv_ifstart;
442         ifp->if_watchdog = nv_watchdog;
443         ifp->if_timer = 0;
444         ifp->if_init = nv_init;
445         ifp->if_mtu = ETHERMTU;
446         ifp->if_baudrate = IF_Mbps(100);
447         ifp->if_snd.ifq_maxlen = IFQ_MAXLEN;
448
449         /* Attach to OS's managers. */
450         ether_ifattach(ifp, sc->sc_macaddr);
451         callout_handle_init(&sc->stat_ch);
452
453         /* Activate our interrupt handler. - attach last to avoid lock */
454         error = bus_setup_intr(sc->dev, sc->irq, INTR_TYPE_NET,
455                                nv_intr, sc, &sc->sc_ih);
456         if (error) {
457                 device_printf(sc->dev, "couldn't set up interrupt handler\n");
458                 goto fail;
459         }
460         DEBUGOUT(NV_DEBUG_INIT, "nv: nv_attach - exit\n");
461
462 fail:
463         if (error)
464                 nv_detach(dev);
465
466         return (error);
467 }
468
469 /* Detach interface for module unload */
470 static int
471 nv_detach(device_t dev)
472 {
473         struct nv_softc *sc = device_get_softc(dev);
474         struct ifnet   *ifp;
475
476         NV_LOCK(sc);
477
478         DEBUGOUT(NV_DEBUG_DEINIT, "nv: nv_detach - entry\n");
479
480         ifp = &sc->arpcom.ac_if;
481
482         if (device_is_attached(dev)) {
483                 nv_stop(sc);
484                 ether_ifdetach(ifp);
485         }
486
487         if (sc->miibus)
488                 device_delete_child(dev, sc->miibus);
489         bus_generic_detach(dev);
490
491         /* Reload unreversed address back into MAC in original state */
492         if (sc->original_mac_addr)
493                 sc->hwapi->pfnSetNodeAddress(sc->hwapi->pADCX, sc->original_mac_addr);
494
495         DEBUGOUT(NV_DEBUG_DEINIT, "nv: do pfnClose\n");
496         /* Detach from NVIDIA hardware API */
497         if (sc->hwapi->pfnClose)
498                 sc->hwapi->pfnClose(sc->hwapi->pADCX);
499         /* Release resources */
500         if (sc->sc_ih)
501                 bus_teardown_intr(sc->dev, sc->irq, sc->sc_ih);
502         if (sc->irq)
503                 bus_release_resource(sc->dev, SYS_RES_IRQ, 0, sc->irq);
504         if (sc->res)
505                 bus_release_resource(sc->dev, SYS_RES_MEMORY, NV_RID, sc->res);
506
507         nv_free_rings(sc);
508
509         if (sc->tx_desc) {
510                 bus_dmamap_unload(sc->rtag, sc->rmap);
511                 bus_dmamem_free(sc->rtag, sc->rx_desc, sc->rmap);
512                 bus_dmamap_destroy(sc->rtag, sc->rmap);
513         }
514         if (sc->mtag)
515                 bus_dma_tag_destroy(sc->mtag);
516         if (sc->ttag)
517                 bus_dma_tag_destroy(sc->ttag);
518         if (sc->rtag)
519                 bus_dma_tag_destroy(sc->rtag);
520
521         NV_UNLOCK(sc);
522
523         DEBUGOUT(NV_DEBUG_DEINIT, "nv: nv_detach - exit\n");
524
525         return (0);
526 }
527
528 /* Initialise interface and start it "RUNNING" */
529 static void
530 nv_init(void *xsc)
531 {
532         struct nv_softc *sc = xsc;
533         struct ifnet   *ifp;
534         int             error;
535
536         NV_LOCK(sc);
537
538         DEBUGOUT(NV_DEBUG_INIT, "nv: nv_init - entry (%d)\n", sc->linkup);
539
540         ifp = &sc->sc_if;
541
542         /* Do nothing if already running */
543         if (ifp->if_flags & IFF_RUNNING)
544                 goto fail;
545
546         nv_stop(sc);
547
548         DEBUGOUT(NV_DEBUG_INIT, "nv: do pfnInit\n");
549         /* Setup Hardware interface and allocate memory structures */
550         error = sc->hwapi->pfnInit(sc->hwapi->pADCX, 0, 0, 0, &sc->linkup);
551         if (error) {
552                 device_printf(sc->dev, "failed to start NVIDIA Hardware interface\n");
553                 goto fail;
554         }
555         /* Set the MAC address */
556         sc->hwapi->pfnSetNodeAddress(sc->hwapi->pADCX, sc->sc_macaddr);
557         sc->hwapi->pfnEnableInterrupts(sc->hwapi->pADCX);
558         sc->hwapi->pfnStart(sc->hwapi->pADCX);
559
560         /* Setup multicast filter */
561         nv_setmulti(sc);
562         nv_ifmedia_upd(ifp);
563
564         /* Update interface parameters */
565         ifp->if_flags |= IFF_RUNNING;
566         ifp->if_flags &= ~IFF_OACTIVE;
567
568         sc->stat_ch = timeout(nv_tick, sc, hz);
569
570         DEBUGOUT(NV_DEBUG_INIT, "nv: nv_init - exit\n");
571
572 fail:
573         NV_UNLOCK(sc);
574
575         return;
576 }
577
578 /* Stop interface activity ie. not "RUNNING" */
579 static void
580 nv_stop(struct nv_softc *sc)
581 {
582         struct ifnet   *ifp;
583
584         NV_LOCK(sc);
585
586         DEBUGOUT(NV_DEBUG_RUNNING, "nv: nv_stop - entry\n");
587
588         ifp = &sc->sc_if;
589         ifp->if_timer = 0;
590
591         /* Cancel tick timer */
592         untimeout(nv_tick, sc, sc->stat_ch);
593
594         /* Stop hardware activity */
595         sc->hwapi->pfnDisableInterrupts(sc->hwapi->pADCX);
596         sc->hwapi->pfnStop(sc->hwapi->pADCX, 0);
597
598         DEBUGOUT(NV_DEBUG_DEINIT, "nv: do pfnDeinit\n");
599         /* Shutdown interface and deallocate memory buffers */
600         if (sc->hwapi->pfnDeinit)
601                 sc->hwapi->pfnDeinit(sc->hwapi->pADCX, 0);
602
603         sc->linkup = 0;
604         sc->cur_rx = 0;
605
606         ifp->if_flags &= ~(IFF_RUNNING | IFF_OACTIVE);
607
608         DEBUGOUT(NV_DEBUG_RUNNING, "nv: nv_stop - exit\n");
609
610         NV_UNLOCK(sc);
611
612         return;
613 }
614
615 /* Shutdown interface for unload/reboot */
616 static void
617 nv_shutdown(device_t dev)
618 {
619         struct nv_softc *sc;
620
621         DEBUGOUT(NV_DEBUG_DEINIT, "nv: nv_shutdown\n");
622
623         sc = device_get_softc(dev);
624
625         /* Stop hardware activity */
626         nv_stop(sc);
627 }
628
629 /* Allocate TX ring buffers */
630 static int
631 nv_init_rings(struct nv_softc *sc)
632 {
633         int             error, i;
634
635         NV_LOCK(sc);
636
637         DEBUGOUT(NV_DEBUG_INIT, "nv: nv_init_rings - entry\n");
638
639         sc->cur_rx = sc->cur_tx = sc->pending_rxs = sc->pending_txs = 0;
640         /* Initialise RX ring */
641         for (i = 0; i < RX_RING_SIZE; i++) {
642                 struct nv_rx_desc *desc = sc->rx_desc + i;
643                 struct nv_map_buffer *buf = &desc->buf;
644
645                 buf->mbuf = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
646                 if (buf->mbuf == NULL) {
647                         device_printf(sc->dev, "couldn't allocate mbuf\n");
648                         nv_free_rings(sc);
649                         error = ENOBUFS;
650                         goto fail;
651                 }
652                 buf->mbuf->m_len = buf->mbuf->m_pkthdr.len = MCLBYTES;
653                 m_adj(buf->mbuf, ETHER_ALIGN);
654
655                 error = bus_dmamap_create(sc->mtag, 0, &buf->map);
656                 if (error) {
657                         device_printf(sc->dev, "couldn't create dma map\n");
658                         nv_free_rings(sc);
659                         goto fail;
660                 }
661                 error = bus_dmamap_load_mbuf(sc->mtag, buf->map, buf->mbuf,
662                                           nv_dmamap_rx_cb, &desc->paddr, 0);
663                 if (error) {
664                         device_printf(sc->dev, "couldn't dma map mbuf\n");
665                         nv_free_rings(sc);
666                         goto fail;
667                 }
668                 bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_PREREAD);
669
670                 desc->buflength = buf->mbuf->m_len;
671                 desc->vaddr = mtod(buf->mbuf, PVOID);
672         }
673         bus_dmamap_sync(sc->rtag, sc->rmap,
674                         BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);
675
676         /* Initialize TX ring */
677         for (i = 0; i < TX_RING_SIZE; i++) {
678                 struct nv_tx_desc *desc = sc->tx_desc + i;
679                 struct nv_map_buffer *buf = &desc->buf;
680
681                 buf->mbuf = NULL;
682
683                 error = bus_dmamap_create(sc->mtag, 0, &buf->map);
684                 if (error) {
685                         device_printf(sc->dev, "couldn't create dma map\n");
686                         nv_free_rings(sc);
687                         goto fail;
688                 }
689         }
690         bus_dmamap_sync(sc->ttag, sc->tmap,
691                         BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);
692
693         DEBUGOUT(NV_DEBUG_INIT, "nv: nv_init_rings - exit\n");
694
695 fail:
696         NV_UNLOCK(sc);
697
698         return (error);
699 }
700
701 /* Free the TX ring buffers */
702 static void
703 nv_free_rings(struct nv_softc *sc)
704 {
705         int             i;
706
707         NV_LOCK(sc);
708
709         DEBUGOUT(NV_DEBUG_DEINIT, "nv: nv_free_rings - entry\n");
710
711         for (i = 0; i < RX_RING_SIZE; i++) {
712                 struct nv_rx_desc *desc = sc->rx_desc + i;
713                 struct nv_map_buffer *buf = &desc->buf;
714
715                 if (buf->mbuf) {
716                         bus_dmamap_unload(sc->mtag, buf->map);
717                         bus_dmamap_destroy(sc->mtag, buf->map);
718                         m_freem(buf->mbuf);
719                 }
720                 buf->mbuf = NULL;
721         }
722
723         for (i = 0; i < TX_RING_SIZE; i++) {
724                 struct nv_tx_desc *desc = sc->tx_desc + i;
725                 struct nv_map_buffer *buf = &desc->buf;
726
727                 if (buf->mbuf) {
728                         bus_dmamap_unload(sc->mtag, buf->map);
729                         bus_dmamap_destroy(sc->mtag, buf->map);
730                         m_freem(buf->mbuf);
731                 }
732                 buf->mbuf = NULL;
733         }
734
735         DEBUGOUT(NV_DEBUG_DEINIT, "nv: nv_free_rings - exit\n");
736
737         NV_UNLOCK(sc);
738 }
739
740 /* Main loop for sending packets from OS to interface */
741 static void
742 nv_ifstart(struct ifnet *ifp)
743 {
744         struct nv_softc *sc = ifp->if_softc;
745         struct nv_map_buffer *buf;
746         struct mbuf    *m0, *m;
747         struct nv_tx_desc *desc;
748         ADAPTER_WRITE_DATA txdata;
749         int             error, i;
750
751         DEBUGOUT(NV_DEBUG_RUNNING, "nv: nv_ifstart - entry\n");
752
753         /* If link is down/busy or queue is empty do nothing */
754         if (ifp->if_flags & IFF_OACTIVE || ifp->if_snd.ifq_head == NULL)
755                 return;
756
757         /* Transmit queued packets until sent or TX ring is full */
758         while (sc->pending_txs < TX_RING_SIZE) {
759                 desc = sc->tx_desc + sc->cur_tx;
760                 buf = &desc->buf;
761
762                 /* Get next packet to send. */
763                 IF_DEQUEUE(&ifp->if_snd, m0);
764
765                 /* If nothing to send, return. */
766                 if (m0 == NULL)
767                         return;
768
769                 /* Map MBUF for DMA access */
770                 error = bus_dmamap_load_mbuf(sc->mtag, buf->map, m0,
771                                      nv_dmamap_tx_cb, desc, BUS_DMA_NOWAIT);
772
773                 if (error && error != EFBIG) {
774                         m_freem(m0);
775                         sc->tx_errors++;
776                         continue;
777                 }
778                 /*
779                  * Packet has too many fragments - defrag into new mbuf
780                  * cluster
781                  */
782                 if (error) {
783                         m = m_defrag(m0, MB_DONTWAIT);
784                         if (m == NULL) {
785                                 m_freem(m0);
786                                 sc->tx_errors++;
787                                 continue;
788                         }
789                         m_freem(m0);
790                         m0 = m;
791
792                         error = bus_dmamap_load_mbuf(sc->mtag, buf->map, m,
793                                      nv_dmamap_tx_cb, desc, BUS_DMA_NOWAIT);
794                         if (error) {
795                                 m_freem(m);
796                                 sc->tx_errors++;
797                                 continue;
798                         }
799                 }
800                 /* Do sync on DMA bounce buffer */
801                 bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_PREWRITE);
802
803                 buf->mbuf = m0;
804                 txdata.ulNumberOfElements = desc->numfrags;
805                 txdata.pvID = (PVOID)desc;
806
807                 /* Put fragments into API element list */
808                 txdata.ulTotalLength = buf->mbuf->m_len;
809                 for (i = 0; i < desc->numfrags; i++) {
810                         txdata.sElement[i].ulLength = (ulong)desc->frags[i].ds_len;
811                         txdata.sElement[i].pPhysical = (PVOID)desc->frags[i].ds_addr;
812                 }
813
814                 /* Send packet to Nvidia API for transmission */
815                 error = sc->hwapi->pfnWrite(sc->hwapi->pADCX, &txdata);
816
817                 switch (error) {
818                 case ADAPTERERR_NONE:
819                         /* Packet was queued in API TX queue successfully */
820                         sc->pending_txs++;
821                         sc->cur_tx = (sc->cur_tx + 1) % TX_RING_SIZE;
822                         break;
823
824                 case ADAPTERERR_TRANSMIT_QUEUE_FULL:
825                         /* The API TX queue is full - requeue the packet */
826                         device_printf(sc->dev, "nv_ifstart: transmit queue is full\n");
827                         ifp->if_flags |= IFF_OACTIVE;
828                         bus_dmamap_unload(sc->mtag, buf->map);
829                         IF_PREPEND(&ifp->if_snd, buf->mbuf);
830                         buf->mbuf = NULL;
831                         return;
832
833                 default:
834                         /* The API failed to queue/send the packet so dump it */
835                         device_printf(sc->dev, "nv_ifstart: transmit error\n");
836                         bus_dmamap_unload(sc->mtag, buf->map);
837                         m_freem(buf->mbuf);
838                         buf->mbuf = NULL;
839                         sc->tx_errors++;
840                         return;
841                 }
842                 /* Set watchdog timer. */
843                 ifp->if_timer = 8;
844
845                 /* Copy packet to BPF tap */
846                 BPF_MTAP(ifp, m0);
847         }
848         ifp->if_flags |= IFF_OACTIVE;
849
850         DEBUGOUT(NV_DEBUG_RUNNING, "nv: nv_ifstart - exit\n");
851 }
852
853 /* Handle IOCTL events */
854 static int
855 nv_ioctl(struct ifnet *ifp, u_long command, caddr_t data, struct ucred *cr)
856 {
857         struct nv_softc *sc = ifp->if_softc;
858         struct ifreq   *ifr = (struct ifreq *) data;
859         struct mii_data *mii;
860         int             error = 0;
861
862         NV_LOCK(sc);
863
864         DEBUGOUT(NV_DEBUG_IOCTL, "nv: nv_ioctl - entry\n");
865
866         switch (command) {
867         case SIOCSIFMTU:
868                 /* Set MTU size */
869                 if (ifp->if_mtu == ifr->ifr_mtu)
870                         break;
871                 if (ifr->ifr_mtu + ifp->if_hdrlen <= MAX_PACKET_SIZE) {
872                         ifp->if_mtu = ifr->ifr_mtu;
873                         nv_stop(sc);
874                         nv_init(sc);
875                 } else
876                         error = EINVAL;
877                 break;
878
879         case SIOCSIFFLAGS:
880                 /* Setup interface flags */
881                 if (ifp->if_flags & IFF_UP) {
882                         if ((ifp->if_flags & IFF_RUNNING) == 0) {
883                                 nv_init(sc);
884                                 break;
885                         }
886                 } else {
887                         if (ifp->if_flags & IFF_RUNNING) {
888                                 nv_stop(sc);
889                                 break;
890                         }
891                 }
892
893                 /* Handle IFF_PROMISC and IFF_ALLMULTI flags. */
894                 nv_setmulti(sc);
895                 break;
896
897         case SIOCADDMULTI:
898         case SIOCDELMULTI:
899                 /* Setup multicast filter */
900                 if (ifp->if_flags & IFF_RUNNING) {
901                         nv_setmulti(sc);
902                 }
903                 break;
904         case SIOCGIFMEDIA:
905         case SIOCSIFMEDIA:
906                 /* Get/Set interface media parameters */
907                 mii = device_get_softc(sc->miibus);
908                 error = ifmedia_ioctl(ifp, ifr, &mii->mii_media, command);
909                 break;
910
911         default:
912                 /* Everything else we forward to generic ether ioctl */
913                 error = ether_ioctl(ifp, (int)command, data);
914                 break;
915         }
916
917         DEBUGOUT(NV_DEBUG_IOCTL, "nv: nv_ioctl - exit\n");
918
919         NV_UNLOCK(sc);
920
921         return (error);
922 }
923
924 /* Interrupt service routine */
925 static void
926 nv_intr(void *arg)
927 {
928         struct nv_softc *sc = arg;
929         struct ifnet   *ifp = &sc->sc_if;
930
931         DEBUGOUT(NV_DEBUG_INTERRUPT, "nv: nv_intr - entry\n");
932
933         if (!ifp->if_flags & IFF_UP) {
934                 nv_stop(sc);
935                 return;
936         }
937         /* Handle interrupt event */
938         if (sc->hwapi->pfnQueryInterrupt(sc->hwapi->pADCX)) {
939                 sc->hwapi->pfnHandleInterrupt(sc->hwapi->pADCX);
940                 sc->hwapi->pfnEnableInterrupts(sc->hwapi->pADCX);
941         }
942         if (ifp->if_snd.ifq_head != NULL)
943                 nv_ifstart(ifp);
944
945         /* If no pending packets we don't need a timeout */
946         if (sc->pending_txs == 0)
947                 sc->sc_if.if_timer = 0;
948
949         DEBUGOUT(NV_DEBUG_INTERRUPT, "nv: nv_intr - exit\n");
950
951         return;
952 }
953
954 /* Setup multicast filters */
955 static void
956 nv_setmulti(struct nv_softc *sc)
957 {
958         struct ifnet   *ifp;
959         struct ifmultiaddr *ifma;
960         PACKET_FILTER   hwfilter;
961         int             i;
962         u_int8_t        oraddr[6];
963         u_int8_t        andaddr[6];
964
965         NV_LOCK(sc);
966
967         DEBUGOUT(NV_DEBUG_RUNNING, "nv: nv_setmulti - entry\n");
968
969         ifp = &sc->sc_if;
970
971         /* Initialize filter */
972         hwfilter.ulFilterFlags = 0;
973         for (i = 0; i < 6; i++) {
974                 hwfilter.acMulticastAddress[i] = 0;
975                 hwfilter.acMulticastMask[i] = 0;
976         }
977
978         if (ifp->if_flags & (IFF_PROMISC | IFF_ALLMULTI)) {
979                 /* Accept all packets */
980                 hwfilter.ulFilterFlags |= ACCEPT_ALL_PACKETS;
981                 sc->hwapi->pfnSetPacketFilter(sc->hwapi->pADCX, &hwfilter);
982                 NV_UNLOCK(sc);
983                 return;
984         }
985         /* Setup multicast filter */
986         LIST_FOREACH(ifma, &ifp->if_multiaddrs, ifma_link) {
987                 u_char         *addrp;
988
989                 if (ifma->ifma_addr->sa_family != AF_LINK)
990                         continue;
991
992                 addrp = LLADDR((struct sockaddr_dl *) ifma->ifma_addr);
993                 for (i = 0; i < 6; i++) {
994                         u_int8_t        mcaddr = addrp[i];
995                         andaddr[i] &= mcaddr;
996                         oraddr[i] |= mcaddr;
997                 }
998         }
999         for (i = 0; i < 6; i++) {
1000                 hwfilter.acMulticastAddress[i] = andaddr[i] & oraddr[i];
1001                 hwfilter.acMulticastMask[i] = andaddr[i] | (~oraddr[i]);
1002         }
1003
1004         /* Send filter to NVIDIA API */
1005         sc->hwapi->pfnSetPacketFilter(sc->hwapi->pADCX, &hwfilter);
1006
1007         NV_UNLOCK(sc);
1008
1009         DEBUGOUT(NV_DEBUG_RUNNING, "nv: nv_setmulti - exit\n");
1010
1011         return;
1012 }
1013
1014 /* Change the current media/mediaopts */
1015 static int
1016 nv_ifmedia_upd(struct ifnet *ifp)
1017 {
1018         struct nv_softc *sc = ifp->if_softc;
1019         struct mii_data *mii;
1020
1021         DEBUGOUT(NV_DEBUG_MII, "nv: nv_ifmedia_upd\n");
1022
1023         mii = device_get_softc(sc->miibus);
1024
1025         if (mii->mii_instance) {
1026                 struct mii_softc *miisc;
1027                 for (miisc = LIST_FIRST(&mii->mii_phys); miisc != NULL;
1028                      miisc = LIST_NEXT(miisc, mii_list)) {
1029                         mii_phy_reset(miisc);
1030                 }
1031         }
1032         mii_mediachg(mii);
1033
1034         return (0);
1035 }
1036
1037 /* Update current miibus PHY status of media */
1038 static void
1039 nv_ifmedia_sts(struct ifnet *ifp, struct ifmediareq *ifmr)
1040 {
1041         struct nv_softc *sc;
1042         struct mii_data *mii;
1043
1044         DEBUGOUT(NV_DEBUG_MII, "nv: nv_ifmedia_sts\n");
1045
1046         sc = ifp->if_softc;
1047         mii = device_get_softc(sc->miibus);
1048         mii_pollstat(mii);
1049
1050         ifmr->ifm_active = mii->mii_media_active;
1051         ifmr->ifm_status = mii->mii_media_status;
1052
1053         return;
1054 }
1055
1056 /* miibus tick timer - maintain link status */
1057 static void
1058 nv_tick(void *xsc)
1059 {
1060         struct nv_softc *sc = xsc;
1061         struct mii_data *mii;
1062         struct ifnet   *ifp;
1063
1064         NV_LOCK(sc);
1065
1066         ifp = &sc->sc_if;
1067         nv_update_stats(sc);
1068
1069         mii = device_get_softc(sc->miibus);
1070         mii_tick(mii);
1071
1072         if (mii->mii_media_status & IFM_ACTIVE &&
1073             IFM_SUBTYPE(mii->mii_media_active) != IFM_NONE) {
1074                 if (ifp->if_snd.ifq_head != NULL)
1075                         nv_ifstart(ifp);
1076         }
1077         sc->stat_ch = timeout(nv_tick, sc, hz);
1078
1079         NV_UNLOCK(sc);
1080
1081         return;
1082 }
1083
1084 /* Update ifnet data structure with collected interface stats from API */
1085 static void
1086 nv_update_stats(struct nv_softc *sc)
1087 {
1088         struct ifnet   *ifp = &sc->sc_if;
1089         ADAPTER_STATS   stats;
1090
1091         NV_LOCK(sc);
1092
1093         if (sc->hwapi) {
1094                 sc->hwapi->pfnGetStatistics(sc->hwapi->pADCX, &stats);
1095
1096                 ifp->if_ipackets = stats.ulSuccessfulReceptions;
1097                 ifp->if_ierrors = stats.ulMissedFrames +
1098                         stats.ulFailedReceptions +
1099                         stats.ulCRCErrors +
1100                         stats.ulFramingErrors +
1101                         stats.ulOverFlowErrors;
1102
1103                 ifp->if_opackets = stats.ulSuccessfulTransmissions;
1104                 ifp->if_oerrors = sc->tx_errors +
1105                         stats.ulFailedTransmissions +
1106                         stats.ulRetryErrors +
1107                         stats.ulUnderflowErrors +
1108                         stats.ulLossOfCarrierErrors +
1109                         stats.ulLateCollisionErrors;
1110
1111                 ifp->if_collisions = stats.ulLateCollisionErrors;
1112         }
1113         NV_UNLOCK(sc);
1114
1115         return;
1116 }
1117
1118 /* miibus Read PHY register wrapper - calls Nvidia API entry point */
1119 static int
1120 nv_miibus_readreg(device_t dev, int phy, int reg)
1121 {
1122         struct nv_softc *sc = device_get_softc(dev);
1123         ulong           data;
1124
1125         DEBUGOUT(NV_DEBUG_MII, "nv: nv_miibus_readreg - entry\n");
1126
1127         ADAPTER_ReadPhy(sc->hwapi->pADCX, phy, reg, &data);
1128
1129         DEBUGOUT(NV_DEBUG_MII, "nv: nv_miibus_readreg - exit\n");
1130
1131         return (data);
1132 }
1133
1134 /* miibus Write PHY register wrapper - calls Nvidia API entry point */
1135 static void
1136 nv_miibus_writereg(device_t dev, int phy, int reg, int data)
1137 {
1138         struct nv_softc *sc = device_get_softc(dev);
1139
1140         DEBUGOUT(NV_DEBUG_MII, "nv: nv_miibus_writereg - entry\n");
1141
1142         ADAPTER_WritePhy(sc->hwapi->pADCX, phy, reg, (ulong)data);
1143
1144         DEBUGOUT(NV_DEBUG_MII, "nv: nv_miibus_writereg - exit\n");
1145
1146         return;
1147 }
1148
1149 /* Watchdog timer to prevent PHY lockups */
1150 static void
1151 nv_watchdog(struct ifnet *ifp)
1152 {
1153         struct nv_softc *sc = ifp->if_softc;
1154
1155         device_printf(sc->dev, "device timeout\n");
1156
1157         sc->tx_errors++;
1158
1159         nv_stop(sc);
1160         ifp->if_flags &= ~IFF_RUNNING;
1161         nv_init(sc);
1162
1163         if (ifp->if_snd.ifq_head != NULL)
1164                 nv_ifstart(ifp);
1165
1166         return;
1167 }
1168
1169 /* --- Start of NVOSAPI interface --- */
1170
1171 /* Allocate DMA enabled general use memory for API */
1172 static int
1173 nv_osalloc(void *ctx, MEMORY_BLOCK *mem)
1174 {
1175         struct nv_softc *sc;
1176         bus_addr_t      mem_physical;
1177
1178         DEBUGOUT(NV_DEBUG_API, "nv: nv_osalloc - %d\n", mem->uiLength);
1179
1180         sc = (struct nv_softc *)ctx;
1181
1182         mem->pLogical = (PVOID)contigmalloc(mem->uiLength, M_DEVBUF,
1183                                     M_NOWAIT | M_ZERO, 0, ~0, PAGE_SIZE, 0);
1184
1185         if (!mem->pLogical) {
1186                 device_printf(sc->dev, "memory allocation failed\n");
1187                 return (0);
1188         }
1189         memset(mem->pLogical, 0, (ulong)mem->uiLength);
1190         mem_physical = vtophys(mem->pLogical);
1191         mem->pPhysical = (PVOID)mem_physical;
1192
1193         DEBUGOUT(NV_DEBUG_API, "nv: nv_osalloc 0x%x/0x%x - %d\n",
1194                  (u_int32_t) mem->pLogical,
1195                  (u_int32_t) mem->pPhysical, mem->uiLength);
1196
1197         return (1);
1198 }
1199
1200 /* Free allocated memory */
1201 static int
1202 nv_osfree(void *ctx, MEMORY_BLOCK *mem)
1203 {
1204         DEBUGOUT(NV_DEBUG_API, "nv: nv_osfree - 0x%x - %d\n",
1205                  (u_int32_t) mem->pLogical, mem->uiLength);
1206
1207         contigfree(mem->pLogical, PAGE_SIZE, M_DEVBUF);
1208         return (1);
1209 }
1210
1211 /* Copied directly from nvnet.c */
1212 static int
1213 nv_osallocex(void *ctx, MEMORY_BLOCKEX *mem_block_ex)
1214 {
1215         MEMORY_BLOCK    mem_block;
1216
1217         DEBUGOUT(NV_DEBUG_API, "nv: nv_osallocex\n");
1218
1219         mem_block_ex->pLogical = NULL;
1220         mem_block_ex->uiLengthOrig = mem_block_ex->uiLength;
1221
1222         if ((mem_block_ex->AllocFlags & ALLOC_MEMORY_ALIGNED) &&
1223             (mem_block_ex->AlignmentSize > 1)) {
1224                 DEBUGOUT(NV_DEBUG_API, "     aligning on %d\n",
1225                          mem_block_ex->AlignmentSize);
1226                 mem_block_ex->uiLengthOrig += mem_block_ex->AlignmentSize;
1227         }
1228         mem_block.uiLength = mem_block_ex->uiLengthOrig;
1229
1230         if (nv_osalloc(ctx, &mem_block) == 0) {
1231                 return (0);
1232         }
1233         mem_block_ex->pLogicalOrig = mem_block.pLogical;
1234         mem_block_ex->pPhysicalOrigLow = (ULONG)mem_block.pPhysical;
1235         mem_block_ex->pPhysicalOrigHigh = 0;
1236
1237         mem_block_ex->pPhysical = mem_block.pPhysical;
1238         mem_block_ex->pLogical = mem_block.pLogical;
1239
1240         if (mem_block_ex->uiLength != mem_block_ex->uiLengthOrig) {
1241                 unsigned int    offset;
1242                 offset = mem_block_ex->pPhysicalOrigLow & (mem_block_ex->AlignmentSize - 1);
1243
1244                 if (offset) {
1245                         mem_block_ex->pPhysical = (PVOID)((ULONG)mem_block_ex->pPhysical +
1246                                       mem_block_ex->AlignmentSize - offset);
1247                         mem_block_ex->pLogical = (PVOID)((ULONG)mem_block_ex->pLogical +
1248                                       mem_block_ex->AlignmentSize - offset);
1249                 }               /* if (offset) */
1250         }                       /* if (mem_block_ex->uiLength !=
1251                                  * mem_block_ex->uiLengthOrig) */
1252         return (1);
1253 }
1254
1255 /* Copied directly from nvnet.c */
1256 static int
1257 nv_osfreeex(void *ctx, MEMORY_BLOCKEX *mem_block_ex)
1258 {
1259         MEMORY_BLOCK    mem_block;
1260
1261         DEBUGOUT(NV_DEBUG_API, "nv: nv_osfreeex\n");
1262
1263         mem_block.pLogical = mem_block_ex->pLogicalOrig;
1264         mem_block.pPhysical = (PVOID)mem_block_ex->pPhysicalOrigLow;
1265         mem_block.uiLength = mem_block_ex->uiLengthOrig;
1266
1267         return (nv_osfree(ctx, &mem_block));
1268 }
1269
1270 /* Clear memory region */
1271 static int
1272 nv_osclear(void *ctx, void *mem, int length)
1273 {
1274         DEBUGOUT(NV_DEBUG_API, "nv: nv_osclear\n");
1275         memset(mem, 0, length);
1276         return (1);
1277 }
1278
1279 /* Sleep for a tick */
1280 static int
1281 nv_osdelay(void *ctx, unsigned long usec)
1282 {
1283         DELAY(usec);
1284         return (1);
1285 }
1286
1287 /* Allocate memory for rx buffer */
1288 static int
1289 nv_osallocrxbuf(void *ctx, MEMORY_BLOCK *mem, void **id)
1290 {
1291         struct nv_softc *sc = ctx;
1292         struct nv_rx_desc *desc;
1293         struct nv_map_buffer *buf;
1294         int             error;
1295
1296         NV_LOCK(sc);
1297
1298         DEBUGOUT(NV_DEBUG_API, "nv: nv_osallocrxbuf\n");
1299
1300         if (sc->pending_rxs == RX_RING_SIZE) {
1301                 device_printf(sc->dev, "rx ring buffer is full\n");
1302                 goto fail;
1303         }
1304         desc = sc->rx_desc + sc->cur_rx;
1305         buf = &desc->buf;
1306
1307         if (buf->mbuf == NULL) {
1308                 buf->mbuf = m_getcl(MB_DONTWAIT, MT_DATA, M_PKTHDR);
1309                 if (buf->mbuf == NULL) {
1310                         device_printf(sc->dev, "failed to allocate memory\n");
1311                         goto fail;
1312                 }
1313                 buf->mbuf->m_len = buf->mbuf->m_pkthdr.len = MCLBYTES;
1314                 m_adj(buf->mbuf, ETHER_ALIGN);
1315
1316                 error = bus_dmamap_load_mbuf(sc->mtag, buf->map, buf->mbuf,
1317                                           nv_dmamap_rx_cb, &desc->paddr, 0);
1318                 if (error) {
1319                         device_printf(sc->dev, "failed to dmamap mbuf\n");
1320                         m_freem(buf->mbuf);
1321                         buf->mbuf = NULL;
1322                         goto fail;
1323                 }
1324                 bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_PREREAD);
1325                 desc->buflength = buf->mbuf->m_len;
1326                 desc->vaddr = mtod(buf->mbuf, PVOID);
1327         }
1328         sc->pending_rxs++;
1329         sc->cur_rx = (sc->cur_rx + 1) % RX_RING_SIZE;
1330
1331         mem->pLogical = (void *)desc->vaddr;
1332         mem->pPhysical = (void *)desc->paddr;
1333         mem->uiLength = desc->buflength;
1334         *id = (void *)desc;
1335
1336 fail:
1337         NV_UNLOCK(sc);
1338
1339         return (1);
1340 }
1341
1342
1343 /* Free the rx buffer */
1344 static int
1345 nv_osfreerxbuf(void *ctx, MEMORY_BLOCK *mem, void *id)
1346 {
1347         struct nv_softc *sc = ctx;
1348         struct nv_rx_desc *desc;
1349         struct nv_map_buffer *buf;
1350
1351         NV_LOCK(sc);
1352
1353         DEBUGOUT(NV_DEBUG_API, "nv: nv_osfreerxbuf\n");
1354
1355         desc = (struct nv_rx_desc *) id;
1356         buf = &desc->buf;
1357
1358         if (buf->mbuf) {
1359                 bus_dmamap_unload(sc->mtag, buf->map);
1360                 bus_dmamap_destroy(sc->mtag, buf->map);
1361                 m_freem(buf->mbuf);
1362         }
1363         sc->pending_rxs--;
1364         buf->mbuf = NULL;
1365
1366         NV_UNLOCK(sc);
1367
1368         return (1);
1369 }
1370
1371 /* This gets called by the Nvidia API after our TX packet has been sent */
1372 static int
1373 nv_ospackettx(void *ctx, void *id, unsigned long success)
1374 {
1375         struct nv_softc *sc = ctx;
1376         struct nv_map_buffer *buf;
1377         struct nv_tx_desc *desc = (struct nv_tx_desc *) id;
1378         struct ifnet   *ifp;
1379
1380         NV_LOCK(sc);
1381
1382         DEBUGOUT(NV_DEBUG_API, "nv: nv_ospackettx\n");
1383
1384         ifp = &sc->sc_if;
1385
1386         buf = &desc->buf;
1387
1388         if (buf->mbuf == NULL)
1389                 goto fail;
1390
1391         bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_POSTWRITE);
1392         bus_dmamap_unload(sc->mtag, buf->map);
1393         m_freem(buf->mbuf);
1394         buf->mbuf = NULL;
1395
1396         sc->pending_txs--;
1397
1398         if (ifp->if_snd.ifq_head != NULL && sc->pending_txs < TX_RING_SIZE)
1399                 nv_ifstart(ifp);
1400
1401 fail:
1402         NV_UNLOCK(sc);
1403
1404         return (1);
1405 }
1406
1407 /* This gets called by the Nvidia API when a new packet has been received */
1408 /* XXX What is newbuf used for? XXX */
1409 static int
1410 nv_ospacketrx(void *ctx, void *data, unsigned long success,
1411               unsigned char *newbuf, unsigned char priority)
1412 {
1413         struct nv_softc *sc = ctx;
1414         struct ifnet   *ifp;
1415         struct nv_rx_desc *desc;
1416         struct nv_map_buffer *buf;
1417         ADAPTER_READ_DATA *readdata;
1418         NV_LOCK(sc);
1419
1420         DEBUGOUT(NV_DEBUG_API, "nv: nv_ospacketrx\n");
1421
1422         ifp = &sc->sc_if;
1423
1424         readdata = (ADAPTER_READ_DATA *) data;
1425         desc = readdata->pvID;
1426         buf = &desc->buf;
1427         bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_POSTREAD);
1428
1429         if (success) {
1430                 /* Sync DMA bounce buffer. */
1431                 bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_POSTREAD);
1432
1433                 /* First mbuf in packet holds the ethernet and packet headers */
1434                 buf->mbuf->m_pkthdr.rcvif = ifp;
1435                 buf->mbuf->m_pkthdr.len = buf->mbuf->m_len = readdata->ulTotalLength;
1436
1437                 bus_dmamap_unload(sc->mtag, buf->map);
1438
1439                 /* Give mbuf to OS. */
1440                 (*ifp->if_input) (ifp, buf->mbuf);
1441                 if (readdata->ulFilterMatch & ADREADFL_MULTICAST_MATCH)
1442                         ifp->if_imcasts++;
1443
1444                 /* Blat the mbuf pointer, kernel will free the mbuf cluster */
1445                 buf->mbuf = NULL;
1446         } else {
1447                 bus_dmamap_sync(sc->mtag, buf->map, BUS_DMASYNC_POSTREAD);
1448                 bus_dmamap_unload(sc->mtag, buf->map);
1449                 m_freem(buf->mbuf);
1450                 buf->mbuf = NULL;
1451         }
1452
1453         sc->cur_rx = desc - sc->rx_desc;
1454         sc->pending_rxs--;
1455
1456         NV_UNLOCK(sc);
1457
1458         return (1);
1459 }
1460
1461 /* This gets called by NVIDIA API when the PHY link state changes */
1462 static int
1463 nv_oslinkchg(void *ctx, int enabled)
1464 {
1465         struct nv_softc *sc = (struct nv_softc *)ctx;
1466         struct ifnet   *ifp;
1467
1468         DEBUGOUT(NV_DEBUG_API, "nv: nv_oslinkchg\n");
1469
1470         ifp = &sc->sc_if;
1471
1472         if (enabled)
1473                 ifp->if_flags |= IFF_UP;
1474         else
1475                 ifp->if_flags &= ~IFF_UP;
1476
1477
1478         return (1);
1479 }
1480
1481
1482 /* Setup a watchdog timer */
1483 static int
1484 nv_osalloctimer(void *ctx, void **timer)
1485 {
1486         struct nv_softc *sc = (struct nv_softc *)ctx;
1487
1488         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_osalloctimer\n");
1489
1490         callout_handle_init(&sc->ostimer);
1491         *timer = &sc->ostimer;
1492
1493         return (1);
1494 }
1495
1496 /* Free the timer */
1497 static int
1498 nv_osfreetimer(void *ctx, void *timer)
1499 {
1500         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_osfreetimer\n");
1501
1502         return (1);
1503 }
1504
1505 /* Setup timer parameters */
1506 static int
1507 nv_osinittimer(void *ctx, void *timer, PTIMER_FUNC func, void *parameters)
1508 {
1509         struct nv_softc *sc = (struct nv_softc *)ctx;
1510
1511         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_osinittimer\n");
1512
1513         sc->ostimer_func = func;
1514         sc->ostimer_params = parameters;
1515
1516         return (1);
1517 }
1518
1519 /* Set the timer to go off */
1520 static int
1521 nv_ossettimer(void *ctx, void *timer, unsigned long delay)
1522 {
1523         struct nv_softc *sc = ctx;
1524
1525         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_ossettimer\n");
1526
1527         *(struct callout_handle *) timer = timeout(sc->ostimer_func, sc->ostimer_params, delay);
1528
1529         return (1);
1530 }
1531
1532 /* Cancel the timer */
1533 static int
1534 nv_oscanceltimer(void *ctx, void *timer)
1535 {
1536         struct nv_softc *sc = ctx;
1537
1538         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_oscanceltimer\n");
1539
1540         untimeout(sc->ostimer_func, sc->ostimer_params, *(struct callout_handle *) timer);
1541
1542         return (1);
1543 }
1544
1545 static int
1546 nv_ospreprocpkt(void *ctx, void *readdata, void **id, unsigned char *newbuffer,
1547                 unsigned char priority)
1548 {
1549         /* Not implemented */
1550         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_ospreprocpkt\n");
1551
1552         return (1);
1553 }
1554
1555 static void
1556                *
1557 nv_ospreprocpktnopq(void *ctx, void *readdata)
1558 {
1559         /* Not implemented */
1560         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_ospreprocpkt\n");
1561
1562         return (NULL);
1563 }
1564
1565 static int
1566 nv_osindicatepkt(void *ctx, void **id, unsigned long pktno)
1567 {
1568         /* Not implemented */
1569         DEBUGOUT(NV_DEBUG_BROKEN, "nv: nv_osindicatepkt\n");
1570
1571         return (1);
1572 }
1573
1574 /* Allocate mutex context (already done in nv_attach) */
1575 static int
1576 nv_oslockalloc(void *ctx, int type, void **pLock)
1577 {
1578         struct nv_softc *sc = (struct nv_softc *)ctx;
1579
1580         DEBUGOUT(NV_DEBUG_LOCK, "nv: nv_oslockalloc\n");
1581
1582         *pLock = (void **)sc;
1583
1584         return (1);
1585 }
1586
1587 /* Obtain a spin lock */
1588 static int
1589 nv_oslockacquire(void *ctx, int type, void *lock)
1590 {
1591         DEBUGOUT(NV_DEBUG_LOCK, "nv: nv_oslockacquire\n");
1592
1593         NV_OSLOCK((struct nv_softc *)lock);
1594
1595         return (1);
1596 }
1597
1598 /* Release lock */
1599 static int
1600 nv_oslockrelease(void *ctx, int type, void *lock)
1601 {
1602         DEBUGOUT(NV_DEBUG_LOCK, "nv: nv_oslockrelease\n");
1603
1604         NV_OSUNLOCK((struct nv_softc *)lock);
1605
1606         return (1);
1607 }
1608
1609 /* I have no idea what this is for */
1610 static void    *
1611 nv_osreturnbufvirt(void *ctx, void *readdata)
1612 {
1613         /* Not implemented */
1614         DEBUGOUT(NV_DEBUG_LOCK, "nv: nv_osreturnbufvirt\n");
1615         panic("nv: nv_osreturnbufvirtual not implemented\n");
1616
1617         return (NULL);
1618 }
1619
1620
1621 /* --- End on NVOSAPI interface --- */