sys/dev/netif/em/if_em_osdep.h

   1 /**************************************************************************
   2
   3 Copyright (c) 2001-2005, Intel Corporation
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in the
  14     documentation and/or other materials provided with the distribution.
  15
  16  3. Neither the name of the Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived from
  18     this software without specific prior written permission.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 POSSIBILITY OF SUCH DAMAGE.
  31
  32 ***************************************************************************/
  33
  34 /*$FreeBSD: src/sys/dev/em/if_em_osdep.h,v 1.1.2.11 2003/06/09 21:43:41 pdeuskar Exp $*/
  35 /*$DragonFly: src/sys/dev/netif/em/if_em_osdep.h,v 1.5 2005/11/08 12:48:18 sephe Exp $*/
  36
  37 #ifndef _FREEBSD_OS_H_
  38 #define _FREEBSD_OS_H_
  39
  40 #include <sys/types.h>
  41 #include <sys/param.h>
  42 #include <sys/systm.h>
  43 #include <sys/mbuf.h>
  44 #include <sys/protosw.h>
  45 #include <sys/socket.h>
  46 #include <sys/malloc.h>
  47 #include <sys/kernel.h>
  48 #include <sys/bus.h>
  49 #include <machine/bus.h>
  50 #include <sys/rman.h>
  51 #include <machine/resource.h>
  52 #include <vm/vm.h>
  53 #include <vm/pmap.h>
  54 #include <machine/clock.h>
  55 #include <bus/pci/pcivar.h>
  56 #include <bus/pci/pcireg.h>
  57
  58
  59 #define ASSERT(x) if(!(x)) panic("EM: x")
  60
  61 /* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */
  62 #define usec_delay(x) DELAY(x)
  63 #define msec_delay(x) DELAY(1000*(x))
  64 /* TODO: Should we be paranoid about delaying in interrupt context? */
  65 #define msec_delay_irq(x) DELAY(1000*(x))
  66
  67 #define MSGOUT(S, A, B)     printf(S "\n", A, B)
  68 #define DEBUGFUNC(F)        DEBUGOUT(F);
  69 #if DBG
  70         #define DEBUGOUT(S)         printf(S "\n")
  71         #define DEBUGOUT1(S,A)      printf(S "\n",A)
  72         #define DEBUGOUT2(S,A,B)    printf(S "\n",A,B)
  73         #define DEBUGOUT3(S,A,B,C)  printf(S "\n",A,B,C)
  74         #define DEBUGOUT7(S,A,B,C,D,E,F,G)  printf(S "\n",A,B,C,D,E,F,G)
  75 #else
  76         #define DEBUGOUT(S)
  77         #define DEBUGOUT1(S,A)
  78         #define DEBUGOUT2(S,A,B)
  79         #define DEBUGOUT3(S,A,B,C)
  80         #define DEBUGOUT7(S,A,B,C,D,E,F,G)
  81 #endif
  82
  83 #define FALSE               0
  84 #define TRUE                1
  85 #define CMD_MEM_WRT_INVALIDATE          0x0010  /* BIT_4 */
  86 #define PCI_COMMAND_REGISTER            PCIR_COMMAND
  87
  88 struct em_osdep
  89 {
  90         bus_space_tag_t    mem_bus_space_tag;
  91         bus_space_handle_t mem_bus_space_handle;
  92         struct device     *dev;
  93 };
  94
  95 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, STATUS)
  96
  97 /* Read from an absolute offset in the adapter's memory space */
  98 #define E1000_READ_OFFSET(hw, offset) \
  99     bus_space_read_4( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
 100                       ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 101                       offset)
 102
 103 /* Write to an absolute offset in the adapter's memory space */
 104 #define E1000_WRITE_OFFSET(hw, offset, value) \
 105     bus_space_write_4( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
 106                        ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 107                        offset, \
 108                        value)
 109
 110 /* Convert a register name to its offset in the adapter's memory space */
 111 #define E1000_REG_OFFSET(hw, reg) \
 112     ((hw)->mac_type >= em_82543 ? E1000_##reg : E1000_82542_##reg)
 113
 114 #define E1000_READ_REG(hw, reg) \
 115     E1000_READ_OFFSET(hw, E1000_REG_OFFSET(hw, reg))
 116
 117 #define E1000_WRITE_REG(hw, reg, value) \
 118     E1000_WRITE_OFFSET(hw, E1000_REG_OFFSET(hw, reg), value)
 119
 120 #define E1000_READ_REG_ARRAY(hw, reg, index) \
 121     E1000_READ_OFFSET(hw, E1000_REG_OFFSET(hw, reg) + ((index) << 2))
 122
 123 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
 124
 125 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
 126     E1000_WRITE_OFFSET(hw, E1000_REG_OFFSET(hw, reg) + ((index) << 2), value)
 127
 128 #define E1000_WRITE_REG_ARRAY_BYTE(hw, reg, index, value) \
 129     bus_space_write_1( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
 130                        ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 131                        E1000_REG_OFFSET(hw, reg) + (index), \
 132                        value)
 133
 134 #define E1000_WRITE_REG_ARRAY_WORD(hw, reg, index, value) \
 135     bus_space_write_2( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
 136                        ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 137                        E1000_REG_OFFSET(hw, reg) + (index), \
 138                        value)
 139
 140 #define E1000_WRITE_REG_ARRAY_DWORD(hw, reg, index, value) \
 141     E1000_WRITE_OFFSET(hw, E1000_REG_OFFSET(hw, reg) + ((index) << 2), value)
 142
 143 #endif  /* _FREEBSD_OS_H_ */
 144