src/arch/i386/drivers/net/undi.c

   1 /*
   2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License as
   6  * published by the Free Software Foundation; either version 2 of the
   7  * License, or any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 #include <stdint.h>
  20 #include <stdlib.h>
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <gpxe/pci.h>
  24 #include <undi.h>
  25 #include <undirom.h>
  26 #include <undiload.h>
  27 #include <undinet.h>
  28 #include <undipreload.h>
  29
  30 /** @file
  31  *
  32  * UNDI PCI driver
  33  *
  34  */
  35
  36 /**
  37  * Find UNDI ROM for PCI device
  38  *
  39  * @v pci               PCI device
  40  * @ret undirom         UNDI ROM, or NULL
  41  *
  42  * Try to find a driver for this device.  Try an exact match on the
  43  * ROM address first, then fall back to a vendor/device ID match only
  44  */
  45 static struct undi_rom * undipci_find_rom ( struct pci_device *pci ) {
  46         struct undi_rom *undirom;
  47         unsigned long rombase;
  48
  49         rombase = pci_bar_start ( pci, PCI_ROM_ADDRESS );
  50         undirom = undirom_find_pci ( pci->vendor, pci->device, rombase );
  51         if ( ! undirom )
  52                 undirom = undirom_find_pci ( pci->vendor, pci->device, 0 );
  53         return undirom;
  54 }
  55
  56 /**
  57  * Probe PCI device
  58  *
  59  * @v pci               PCI device
  60  * @v id                PCI ID
  61  * @ret rc              Return status code
  62  */
  63 static int undipci_probe ( struct pci_device *pci,
  64                            const struct pci_device_id *id __unused ) {
  65         struct undi_device *undi;
  66         struct undi_rom *undirom;
  67         unsigned int busdevfn = PCI_BUSDEVFN ( pci->bus, pci->devfn );
  68         int rc;
  69
  70         /* Ignore non-network devices */
  71         if ( PCI_BASE_CLASS ( pci->class ) != PCI_BASE_CLASS_NETWORK )
  72                 return -ENOTTY;
  73
  74         /* Allocate UNDI device structure */
  75         undi = zalloc ( sizeof ( *undi ) );
  76         if ( ! undi )
  77                 return -ENOMEM;
  78         pci_set_drvdata ( pci, undi );
  79
  80         /* Find/create our pixie */
  81         if ( preloaded_undi.pci_busdevfn == busdevfn ) {
  82                 /* Claim preloaded UNDI device */
  83                 DBGC ( undi, "UNDI %p using preloaded UNDI device\n", undi );
  84                 memcpy ( undi, &preloaded_undi, sizeof ( *undi ) );
  85                 memset ( &preloaded_undi, 0, sizeof ( preloaded_undi ) );
  86         } else {
  87                 /* Find UNDI ROM for PCI device */
  88                 if ( ! ( undirom = undipci_find_rom ( pci ) ) ) {
  89                         rc = -ENODEV;
  90                         goto err_find_rom;
  91                 }
  92
  93                 /* Call UNDI ROM loader to create pixie */
  94                 if ( ( rc = undi_load_pci ( undi, undirom, busdevfn ) ) != 0 )
  95                         goto err_load_pci;
  96         }
  97
  98         /* Add to device hierarchy */
  99         snprintf ( undi->dev.name, sizeof ( undi->dev.name ),
 100                    "UNDI-%s", pci->dev.name );
 101         memcpy ( &undi->dev.desc, &pci->dev.desc, sizeof ( undi->dev.desc ) );
 102         undi->dev.parent = &pci->dev;
 103         INIT_LIST_HEAD ( &undi->dev.children );
 104         list_add ( &undi->dev.siblings, &pci->dev.children );
 105
 106         /* Create network device */
 107         if ( ( rc = undinet_probe ( undi ) ) != 0 )
 108                 goto err_undinet_probe;
 109
 110         return 0;
 111
 112  err_undinet_probe:
 113         undi_unload ( undi );
 114         list_del ( &undi->dev.siblings );
 115  err_find_rom:
 116  err_load_pci:
 117         free ( undi );
 118         pci_set_drvdata ( pci, NULL );
 119         return rc;
 120 }
 121
 122 /**
 123  * Remove PCI device
 124  *
 125  * @v pci       PCI device
 126  */
 127 static void undipci_remove ( struct pci_device *pci ) {
 128         struct undi_device *undi = pci_get_drvdata ( pci );
 129
 130         undinet_remove ( undi );
 131         undi_unload ( undi );
 132         list_del ( &undi->dev.siblings );
 133         free ( undi );
 134         pci_set_drvdata ( pci, NULL );
 135 }
 136
 137 static struct pci_device_id undipci_nics[] = {
 138 PCI_ROM ( 0xffff, 0xffff, "undipci", "UNDI (PCI)" ),
 139 };
 140
 141 struct pci_driver undipci_driver __pci_driver = {
 142         .ids = undipci_nics,
 143         .id_count = ( sizeof ( undipci_nics ) / sizeof ( undipci_nics[0] ) ),
 144         .probe = undipci_probe,
 145         .remove = undipci_remove,
 146 };