drivers/net/atlx/atlx.c

   1 /* atlx.c -- common functions for Attansic network drivers
   2  *
   3  * Copyright(c) 2005 - 2006 Attansic Corporation. All rights reserved.
   4  * Copyright(c) 2006 - 2007 Chris Snook <csnook@redhat.com>
   5  * Copyright(c) 2006 Jay Cliburn <jcliburn@gmail.com>
   6  * Copyright(c) 2007 Atheros Corporation. All rights reserved.
   7  *
   8  * Derived from Intel e1000 driver
   9  * Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the Free
  13  * Software Foundation; either version 2 of the License, or (at your option)
  14  * any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  19  * more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along with
  22  * this program; if not, write to the Free Software Foundation, Inc., 59
  23  * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 /* Including this file like a header is a temporary hack, I promise. -- CHS */
  27 #ifndef ATLX_C
  28 #define ATLX_C
  29
  30 #include <linux/device.h>
  31 #include <linux/errno.h>
  32 #include <linux/etherdevice.h>
  33 #include <linux/if.h>
  34 #include <linux/netdevice.h>
  35 #include <linux/socket.h>
  36 #include <linux/sockios.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/string.h>
  39 #include <linux/types.h>
  40 #include <linux/workqueue.h>
  41
  42 #include "atlx.h"
  43
  44 static struct atlx_spi_flash_dev flash_table[] = {
  45 /*      MFR_NAME  WRSR  READ  PRGM  WREN  WRDI  RDSR  RDID  SEC_ERS CHIP_ERS */
  46         {"Atmel", 0x00, 0x03, 0x02, 0x06, 0x04, 0x05, 0x15, 0x52,   0x62},
  47         {"SST",   0x01, 0x03, 0x02, 0x06, 0x04, 0x05, 0x90, 0x20,   0x60},
  48         {"ST",    0x01, 0x03, 0x02, 0x06, 0x04, 0x05, 0xAB, 0xD8,   0xC7},
  49 };
  50
  51 static int atlx_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd)
  52 {
  53         switch (cmd) {
  54         case SIOCGMIIPHY:
  55         case SIOCGMIIREG:
  56         case SIOCSMIIREG:
  57                 return atlx_mii_ioctl(netdev, ifr, cmd);
  58         default:
  59                 return -EOPNOTSUPP;
  60         }
  61 }
  62
  63 /*
  64  * atlx_set_mac - Change the Ethernet Address of the NIC
  65  * @netdev: network interface device structure
  66  * @p: pointer to an address structure
  67  *
  68  * Returns 0 on success, negative on failure
  69  */
  70 static int atlx_set_mac(struct net_device *netdev, void *p)
  71 {
  72         struct atlx_adapter *adapter = netdev_priv(netdev);
  73         struct sockaddr *addr = p;
  74
  75         if (netif_running(netdev))
  76                 return -EBUSY;
  77
  78         if (!is_valid_ether_addr(addr->sa_data))
  79                 return -EADDRNOTAVAIL;
  80
  81         memcpy(netdev->dev_addr, addr->sa_data, netdev->addr_len);
  82         memcpy(adapter->hw.mac_addr, addr->sa_data, netdev->addr_len);
  83
  84         atlx_set_mac_addr(&adapter->hw);
  85         return 0;
  86 }
  87
  88 static void atlx_check_for_link(struct atlx_adapter *adapter)
  89 {
  90         struct net_device *netdev = adapter->netdev;
  91         u16 phy_data = 0;
  92
  93         spin_lock(&adapter->lock);
  94         adapter->phy_timer_pending = false;
  95         atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
  96         atlx_read_phy_reg(&adapter->hw, MII_BMSR, &phy_data);
  97         spin_unlock(&adapter->lock);
  98
  99         /* notify upper layer link down ASAP */
 100         if (!(phy_data & BMSR_LSTATUS)) {
 101                 /* Link Down */
 102                 if (netif_carrier_ok(netdev)) {
 103                         /* old link state: Up */
 104                         dev_info(&adapter->pdev->dev, "%s link is down\n",
 105                                 netdev->name);
 106                         adapter->link_speed = SPEED_0;
 107                         netif_carrier_off(netdev);
 108                         netif_stop_queue(netdev);
 109                 }
 110         }
 111         schedule_work(&adapter->link_chg_task);
 112 }
 113
 114 /*
 115  * atlx_set_multi - Multicast and Promiscuous mode set
 116  * @netdev: network interface device structure
 117  *
 118  * The set_multi entry point is called whenever the multicast address
 119  * list or the network interface flags are updated.  This routine is
 120  * responsible for configuring the hardware for proper multicast,
 121  * promiscuous mode, and all-multi behavior.
 122  */
 123 static void atlx_set_multi(struct net_device *netdev)
 124 {
 125         struct atlx_adapter *adapter = netdev_priv(netdev);
 126         struct atlx_hw *hw = &adapter->hw;
 127         struct dev_mc_list *mc_ptr;
 128         u32 rctl;
 129         u32 hash_value;
 130
 131         /* Check for Promiscuous and All Multicast modes */
 132         rctl = ioread32(hw->hw_addr + REG_MAC_CTRL);
 133         if (netdev->flags & IFF_PROMISC)
 134                 rctl |= MAC_CTRL_PROMIS_EN;
 135         else if (netdev->flags & IFF_ALLMULTI) {
 136                 rctl |= MAC_CTRL_MC_ALL_EN;
 137                 rctl &= ~MAC_CTRL_PROMIS_EN;
 138         } else
 139                 rctl &= ~(MAC_CTRL_PROMIS_EN | MAC_CTRL_MC_ALL_EN);
 140
 141         iowrite32(rctl, hw->hw_addr + REG_MAC_CTRL);
 142
 143         /* clear the old settings from the multicast hash table */
 144         iowrite32(0, hw->hw_addr + REG_RX_HASH_TABLE);
 145         iowrite32(0, (hw->hw_addr + REG_RX_HASH_TABLE) + (1 << 2));
 146
 147         /* compute mc addresses' hash value ,and put it into hash table */
 148         for (mc_ptr = netdev->mc_list; mc_ptr; mc_ptr = mc_ptr->next) {
 149                 hash_value = atlx_hash_mc_addr(hw, mc_ptr->dmi_addr);
 150                 atlx_hash_set(hw, hash_value);
 151         }
 152 }
 153
 154 /*
 155  * atlx_irq_enable - Enable default interrupt generation settings
 156  * @adapter: board private structure
 157  */
 158 static void atlx_irq_enable(struct atlx_adapter *adapter)
 159 {
 160         iowrite32(IMR_NORMAL_MASK, adapter->hw.hw_addr + REG_IMR);
 161         ioread32(adapter->hw.hw_addr + REG_IMR);
 162 }
 163
 164 /*
 165  * atlx_irq_disable - Mask off interrupt generation on the NIC
 166  * @adapter: board private structure
 167  */
 168 static void atlx_irq_disable(struct atlx_adapter *adapter)
 169 {
 170         iowrite32(0, adapter->hw.hw_addr + REG_IMR);
 171         ioread32(adapter->hw.hw_addr + REG_IMR);
 172         synchronize_irq(adapter->pdev->irq);
 173 }
 174
 175 static void atlx_clear_phy_int(struct atlx_adapter *adapter)
 176 {
 177         u16 phy_data;
 178         unsigned long flags;
 179
 180         spin_lock_irqsave(&adapter->lock, flags);
 181         atlx_read_phy_reg(&adapter->hw, 19, &phy_data);
 182         spin_unlock_irqrestore(&adapter->lock, flags);
 183 }
 184
 185 /*
 186  * atlx_get_stats - Get System Network Statistics
 187  * @netdev: network interface device structure
 188  *
 189  * Returns the address of the device statistics structure.
 190  * The statistics are actually updated from the timer callback.
 191  */
 192 static struct net_device_stats *atlx_get_stats(struct net_device *netdev)
 193 {
 194         struct atlx_adapter *adapter = netdev_priv(netdev);
 195         return &adapter->net_stats;
 196 }
 197
 198 /*
 199  * atlx_tx_timeout - Respond to a Tx Hang
 200  * @netdev: network interface device structure
 201  */
 202 static void atlx_tx_timeout(struct net_device *netdev)
 203 {
 204         struct atlx_adapter *adapter = netdev_priv(netdev);
 205         /* Do the reset outside of interrupt context */
 206         schedule_work(&adapter->tx_timeout_task);
 207 }
 208
 209 /*
 210  * atlx_link_chg_task - deal with link change event Out of interrupt context
 211  */
 212 static void atlx_link_chg_task(struct work_struct *work)
 213 {
 214         struct atlx_adapter *adapter;
 215         unsigned long flags;
 216
 217         adapter = container_of(work, struct atlx_adapter, link_chg_task);
 218
 219         spin_lock_irqsave(&adapter->lock, flags);
 220         atlx_check_link(adapter);
 221         spin_unlock_irqrestore(&adapter->lock, flags);
 222 }
 223
 224 static void atlx_vlan_rx_register(struct net_device *netdev,
 225         struct vlan_group *grp)
 226 {
 227         struct atlx_adapter *adapter = netdev_priv(netdev);
 228         unsigned long flags;
 229         u32 ctrl;
 230
 231         spin_lock_irqsave(&adapter->lock, flags);
 232         /* atlx_irq_disable(adapter); FIXME: confirm/remove */
 233         adapter->vlgrp = grp;
 234
 235         if (grp) {
 236                 /* enable VLAN tag insert/strip */
 237                 ctrl = ioread32(adapter->hw.hw_addr + REG_MAC_CTRL);
 238                 ctrl |= MAC_CTRL_RMV_VLAN;
 239                 iowrite32(ctrl, adapter->hw.hw_addr + REG_MAC_CTRL);
 240         } else {
 241                 /* disable VLAN tag insert/strip */
 242                 ctrl = ioread32(adapter->hw.hw_addr + REG_MAC_CTRL);
 243                 ctrl &= ~MAC_CTRL_RMV_VLAN;
 244                 iowrite32(ctrl, adapter->hw.hw_addr + REG_MAC_CTRL);
 245         }
 246
 247         /* atlx_irq_enable(adapter); FIXME */
 248         spin_unlock_irqrestore(&adapter->lock, flags);
 249 }
 250
 251 static void atlx_restore_vlan(struct atlx_adapter *adapter)
 252 {
 253         atlx_vlan_rx_register(adapter->netdev, adapter->vlgrp);
 254 }
 255
 256 /*
 257  * This is the only thing that needs to be changed to adjust the
 258  * maximum number of ports that the driver can manage.
 259  */
 260 #define ATL1_MAX_NIC 4
 261
 262 #define OPTION_UNSET    -1
 263 #define OPTION_DISABLED 0
 264 #define OPTION_ENABLED  1
 265
 266 #define ATL1_PARAM_INIT { [0 ... ATL1_MAX_NIC] = OPTION_UNSET }
 267
 268 /*
 269  * Interrupt Moderate Timer in units of 2 us
 270  *
 271  * Valid Range: 10-65535
 272  *
 273  * Default Value: 100 (200us)
 274  */
 275 static int __devinitdata int_mod_timer[ATL1_MAX_NIC+1] = ATL1_PARAM_INIT;
 276 static int num_int_mod_timer;
 277 module_param_array_named(int_mod_timer, int_mod_timer, int,
 278         &num_int_mod_timer, 0);
 279 MODULE_PARM_DESC(int_mod_timer, "Interrupt moderator timer");
 280
 281 /*
 282  * flash_vendor
 283  *
 284  * Valid Range: 0-2
 285  *
 286  * 0 - Atmel
 287  * 1 - SST
 288  * 2 - ST
 289  *
 290  * Default Value: 0
 291  */
 292 static int __devinitdata flash_vendor[ATL1_MAX_NIC+1] = ATL1_PARAM_INIT;
 293 static int num_flash_vendor;
 294 module_param_array_named(flash_vendor, flash_vendor, int, &num_flash_vendor, 0);
 295 MODULE_PARM_DESC(flash_vendor, "SPI flash vendor");
 296
 297 #define DEFAULT_INT_MOD_CNT     100     /* 200us */
 298 #define MAX_INT_MOD_CNT         65000
 299 #define MIN_INT_MOD_CNT         50
 300
 301 #define FLASH_VENDOR_DEFAULT    0
 302 #define FLASH_VENDOR_MIN        0
 303 #define FLASH_VENDOR_MAX        2
 304
 305 struct atl1_option {
 306         enum { enable_option, range_option, list_option } type;
 307         char *name;
 308         char *err;
 309         int def;
 310         union {
 311                 struct {        /* range_option info */
 312                         int min;
 313                         int max;
 314                 } r;
 315                 struct {        /* list_option info */
 316                         int nr;
 317                         struct atl1_opt_list {
 318                                 int i;
 319                                 char *str;
 320                         } *p;
 321                 } l;
 322         } arg;
 323 };
 324
 325 static int __devinit atl1_validate_option(int *value, struct atl1_option *opt,
 326         struct pci_dev *pdev)
 327 {
 328         if (*value == OPTION_UNSET) {
 329                 *value = opt->def;
 330                 return 0;
 331         }
 332
 333         switch (opt->type) {
 334         case enable_option:
 335                 switch (*value) {
 336                 case OPTION_ENABLED:
 337                         dev_info(&pdev->dev, "%s enabled\n", opt->name);
 338                         return 0;
 339                 case OPTION_DISABLED:
 340                         dev_info(&pdev->dev, "%s disabled\n", opt->name);
 341                         return 0;
 342                 }
 343                 break;
 344         case range_option:
 345                 if (*value >= opt->arg.r.min && *value <= opt->arg.r.max) {
 346                         dev_info(&pdev->dev, "%s set to %i\n", opt->name,
 347                                 *value);
 348                         return 0;
 349                 }
 350                 break;
 351         case list_option:{
 352                         int i;
 353                         struct atl1_opt_list *ent;
 354
 355                         for (i = 0; i < opt->arg.l.nr; i++) {
 356                                 ent = &opt->arg.l.p[i];
 357                                 if (*value == ent->i) {
 358                                         if (ent->str[0] != '\0')
 359                                                 dev_info(&pdev->dev, "%s\n",
 360                                                         ent->str);
 361                                         return 0;
 362                                 }
 363                         }
 364                 }
 365                 break;
 366
 367         default:
 368                 break;
 369         }
 370
 371         dev_info(&pdev->dev, "invalid %s specified (%i) %s\n",
 372                 opt->name, *value, opt->err);
 373         *value = opt->def;
 374         return -1;
 375 }
 376
 377 /*
 378  * atl1_check_options - Range Checking for Command Line Parameters
 379  * @adapter: board private structure
 380  *
 381  * This routine checks all command line parameters for valid user
 382  * input.  If an invalid value is given, or if no user specified
 383  * value exists, a default value is used.  The final value is stored
 384  * in a variable in the adapter structure.
 385  */
 386 void __devinit atl1_check_options(struct atl1_adapter *adapter)
 387 {
 388         struct pci_dev *pdev = adapter->pdev;
 389         int bd = adapter->bd_number;
 390         if (bd >= ATL1_MAX_NIC) {
 391                 dev_notice(&pdev->dev, "no configuration for board#%i\n", bd);
 392                 dev_notice(&pdev->dev, "using defaults for all values\n");
 393         }
 394         {                       /* Interrupt Moderate Timer */
 395                 struct atl1_option opt = {
 396                         .type = range_option,
 397                         .name = "Interrupt Moderator Timer",
 398                         .err = "using default of "
 399                                 __MODULE_STRING(DEFAULT_INT_MOD_CNT),
 400                         .def = DEFAULT_INT_MOD_CNT,
 401                         .arg = {.r = {.min = MIN_INT_MOD_CNT,
 402                                         .max = MAX_INT_MOD_CNT} }
 403                 };
 404                 int val;
 405                 if (num_int_mod_timer > bd) {
 406                         val = int_mod_timer[bd];
 407                         atl1_validate_option(&val, &opt, pdev);
 408                         adapter->imt = (u16) val;
 409                 } else
 410                         adapter->imt = (u16) (opt.def);
 411         }
 412
 413         {                       /* Flash Vendor */
 414                 struct atl1_option opt = {
 415                         .type = range_option,
 416                         .name = "SPI Flash Vendor",
 417                         .err = "using default of "
 418                                 __MODULE_STRING(FLASH_VENDOR_DEFAULT),
 419                         .def = DEFAULT_INT_MOD_CNT,
 420                         .arg = {.r = {.min = FLASH_VENDOR_MIN,
 421                                         .max = FLASH_VENDOR_MAX} }
 422                 };
 423                 int val;
 424                 if (num_flash_vendor > bd) {
 425                         val = flash_vendor[bd];
 426                         atl1_validate_option(&val, &opt, pdev);
 427                         adapter->hw.flash_vendor = (u8) val;
 428                 } else
 429                         adapter->hw.flash_vendor = (u8) (opt.def);
 430         }
 431 }
 432
 433 #endif /* ATLX_C */