packages/devs/eth/arm/grg/i82559/v2_0/include/grg_i82559.inl

   1 //==========================================================================
   2 //
   3 //      grg_i82559.inl
   4 //
   5 //      GRG ethernet I/O definitions.
   6 //
   7 //==========================================================================
   8 //####ECOSGPLCOPYRIGHTBEGIN####
   9 // -------------------------------------------
  10 // This file is part of eCos, the Embedded Configurable Operating System.
  11 // Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003 Red Hat, Inc.
  12 //
  13 // eCos is free software; you can redistribute it and/or modify it under
  14 // the terms of the GNU General Public License as published by the Free
  15 // Software Foundation; either version 2 or (at your option) any later version.
  16 //
  17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 // for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License along
  23 // with eCos; if not, write to the Free Software Foundation, Inc.,
  24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 //
  26 // As a special exception, if other files instantiate templates or use macros
  27 // or inline functions from this file, or you compile this file and link it
  28 // with other works to produce a work based on this file, this file does not
  29 // by itself cause the resulting work to be covered by the GNU General Public
  30 // License. However the source code for this file must still be made available
  31 // in accordance with section (3) of the GNU General Public License.
  32 //
  33 // This exception does not invalidate any other reasons why a work based on
  34 // this file might be covered by the GNU General Public License.
  35 //
  36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 // at http://sources.redhat.com/ecos/ecos-license/
  38 // -------------------------------------------
  39 //####ECOSGPLCOPYRIGHTEND####
  40 //==========================================================================
  41 //#####DESCRIPTIONBEGIN####
  42 //
  43 // Author(s):
  44 // Contributors:msalter
  45 // Date:        2003-02-05
  46 // Purpose:     grg ethernet definitions
  47 //####DESCRIPTIONEND####
  48 //==========================================================================
  49
  50 #include <cyg/hal/hal_intr.h>           // CYGNUM_HAL_INTERRUPT_ETHERNET
  51 #include <cyg/hal/hal_cache.h>          // HAL_DCACHE_LINE_SIZE
  52 #include <cyg/hal/plf_io.h>             // CYGARC_UNCACHED_ADDRESS
  53
  54 // Bus hardware takes care of IO endianess issues.
  55 #define CYGHWR_DEVS_ETH_INTEL_I82559_ENDIAN_NEUTRAL_IO 1
  56
  57 // NB: Bus masters can only get to first 64MB SDRAM
  58 #define CYGHWR_INTEL_I82559_PCI_VIRT_TO_BUS( _x_ ) \
  59                  ((cyg_uint32)CYGARC_VIRT_TO_BUS(_x_))
  60
  61 #define MAX_PACKET_SIZE   1536
  62 #define SIZEOF_DESCRIPTOR 16
  63 #define MISC_MEM          1128     // selftest, ioctl and statistics
  64
  65 #define CYGHWR_INTEL_I82559_PCI_MEM_MAP_SIZE \
  66   (((MAX_PACKET_SIZE + SIZEOF_DESCRIPTOR) * \
  67      (CYGNUM_DEVS_ETH_INTEL_I82559_MAX_TX_DESCRIPTORS + \
  68       CYGNUM_DEVS_ETH_INTEL_I82559_MAX_RX_DESCRIPTORS)) + \
  69    MISC_MEM)*CYGNUM_DEVS_ETH_INTEL_I82559_DEV_COUNT
  70
  71 // The PCI Window is 64MB starting at 0x00000000, so as long as the bss
  72 // section is within addresses 0x00000000-0x04000000, pci_mem_buffer[] will be
  73 // in the true PCI Window.  Because pci_mem_buffer[] is in the bss section,
  74 // wanted its size to be only as large as required so as to not waste memory.
  75 // Therefore, had to compute it's size in this file and not in the memory
  76 // layout files.  So no __pci_window label was ever defined, therefore,
  77 // CYGMEM_SECTION_pci_window does not exist.  Define CYGMEM_SECTION_pci_window
  78 // here in order to satisfy the ASSERT within if_i82559.c.
  79 static char pci_mem_buffer[CYGHWR_INTEL_I82559_PCI_MEM_MAP_SIZE
  80                            + HAL_DCACHE_LINE_SIZE];
  81
  82 #define CYGMEM_SECTION_pci_window (((unsigned)pci_mem_buffer         \
  83                                        + HAL_DCACHE_LINE_SIZE - 1)   \
  84                                    & ~(HAL_DCACHE_LINE_SIZE - 1))
  85
  86 #define CYGHWR_INTEL_I82559_PCI_MEM_MAP_BASE \
  87   (CYGARC_UNCACHED_ADDRESS(CYGMEM_SECTION_pci_window))
  88
  89
  90 #ifdef CYGPKG_DEVS_ETH_ARM_GRG_I82559_ETH0
  91
  92 static I82559 i82559_eth0_priv_data = {
  93     hardwired_esa: 0,
  94 #if defined(CYGPKG_REDBOOT) && defined(CYGVAR_DEVS_ETH_I82559_ETH_REDBOOT_HOLDS_ESA_ETH0)
  95     mac_address: CYGDAT_DEVS_ETH_ARM_GRG_ETH0_DEFAULT_ESA
  96 #endif
  97 };
  98
  99 ETH_DRV_SC(i82559_sc0,
 100            &i82559_eth0_priv_data,      // Driver specific data
 101            CYGDAT_DEVS_ETH_ARM_GRG_I82559_ETH0_NAME, // Name for device
 102            i82559_start,
 103            i82559_stop,
 104            i82559_ioctl,
 105            i82559_can_send,
 106            i82559_send,
 107            i82559_recv,
 108            i82559_deliver,
 109            i82559_poll,
 110            i82559_int_vector
 111     );
 112
 113 NETDEVTAB_ENTRY(i82559_netdev0,
 114                 "i82559_" CYGDAT_DEVS_ETH_ARM_GRG_I82559_ETH0_NAME,
 115                 i82559_init,
 116                 &i82559_sc0);
 117 #endif // CYGPKG_DEVS_ETH_ARM_IXP425_I82559_ETH0
 118
 119
 120 // These arrays are used for sanity checking of pointers
 121 I82559 *
 122 i82559_priv_array[CYGNUM_DEVS_ETH_INTEL_I82559_DEV_COUNT] = {
 123 #ifdef CYGPKG_DEVS_ETH_ARM_GRG_I82559_ETH0
 124     &i82559_eth0_priv_data,
 125 #endif
 126 };
 127
 128 #ifdef CYGDBG_USE_ASSERTS
 129 // These are only used when assertions are enabled
 130 cyg_netdevtab_entry_t *
 131 i82559_netdev_array[CYGNUM_DEVS_ETH_INTEL_I82559_DEV_COUNT] = {
 132 #ifdef CYGPKG_DEVS_ETH_ARM_GRG_I82559_ETH0
 133     &i82559_netdev0,
 134 #endif
 135 };
 136
 137 struct eth_drv_sc *
 138 i82559_sc_array[CYGNUM_DEVS_ETH_INTEL_I82559_DEV_COUNT] = {
 139 #ifdef CYGPKG_DEVS_ETH_ARM_GRG_I82559_ETH0
 140     &i82559_sc0,
 141 #endif
 142 };
 143 #endif // CYGDBG_USE_ASSERTS
 144
 145 // --------------------------------------------------------------
 146 // RedBoot configuration options for managing ESAs for us
 147
 148 // Decide whether to have redboot config vars for it...
 149 #ifdef CYGPKG_REDBOOT
 150 #include <pkgconf/redboot.h>
 151 #ifdef CYGSEM_REDBOOT_FLASH_CONFIG
 152 #ifdef CYGPKG_REDBOOT_NETWORKING
 153 #include <redboot.h>
 154 #include <flash_config.h>
 155
 156 #ifdef CYGVAR_DEVS_ETH_I82559_ETH_REDBOOT_HOLDS_ESA_ETH0
 157 RedBoot_config_option("Network hardware address [MAC] for eth0",
 158                       eth0_esa,
 159                       ALWAYS_ENABLED, true,
 160                       CONFIG_ESA, i82559_eth0_priv_data.mac_address
 161     );
 162 #endif
 163
 164 #endif  // CYGPKG_REDBOOT_NETWORKING
 165 #endif  // CYGSEM_REDBOOT_FLASH_CONFIG
 166 #endif  // CYGPKG_REDBOOT
 167
 168 // and initialization code to read them
 169 // - independent of whether we are building RedBoot right now:
 170 #ifdef CYGPKG_DEVS_ETH_I82559_ETH_REDBOOT_HOLDS_ESA
 171
 172 #include <cyg/hal/hal_if.h>
 173
 174 #ifndef CONFIG_ESA
 175 #define CONFIG_ESA (6)
 176 #endif
 177
 178 #define CYGHWR_DEVS_ETH_INTEL_I82559_GET_ESA( p_i82559, mac_address, ok )       \
 179 CYG_MACRO_START                                                                 \
 180     ok = false;                                                                 \
 181     if ( 0 == p_i82559->index )                                                 \
 182         ok = CYGACC_CALL_IF_FLASH_CFG_OP( CYGNUM_CALL_IF_FLASH_CFG_GET,         \
 183                                           "eth0_esa", mac_address, CONFIG_ESA); \
 184     else if ( 1 == p_i82559->index )                                            \
 185         ok = CYGACC_CALL_IF_FLASH_CFG_OP( CYGNUM_CALL_IF_FLASH_CFG_GET,         \
 186                                           "eth1_esa", mac_address, CONFIG_ESA); \
 187 CYG_MACRO_END
 188
 189 #endif // CYGPKG_DEVS_ETH_I82559_ETH_REDBOOT_HOLDS_ESA