sys/dev/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$*/
  35
  36 #ifndef _FREEBSD_OS_H_
  37 #define _FREEBSD_OS_H_
  38
  39 #include <sys/types.h>
  40 #include <sys/systm.h>
  41 #include <sys/bus.h>
  42 #include <sys/mbuf.h>
  43 #include <sys/malloc.h>
  44 #include <sys/socket.h>
  45
  46 #include <machine/bus.h>
  47 #include <sys/rman.h>
  48 #include <machine/resource.h>
  49
  50 #include <dev/pci/pcivar.h>
  51 #include <dev/pci/pcireg.h>
  52
  53 #define usec_delay(x) DELAY(x)
  54 #define msec_delay(x) DELAY(1000*(x))
  55 /* TODO: Should we be paranoid about delaying in interrupt context? */
  56 #define msec_delay_irq(x) DELAY(1000*(x))
  57
  58 #define MSGOUT(S, A, B)     printf(S "\n", A, B)
  59 #define DEBUGFUNC(F)        DEBUGOUT(F);
  60 #if DBG
  61         #define DEBUGOUT(S)         printf(S "\n")
  62         #define DEBUGOUT1(S,A)      printf(S "\n",A)
  63         #define DEBUGOUT2(S,A,B)    printf(S "\n",A,B)
  64         #define DEBUGOUT3(S,A,B,C)  printf(S "\n",A,B,C)
  65         #define DEBUGOUT7(S,A,B,C,D,E,F,G)  printf(S "\n",A,B,C,D,E,F,G)
  66 #else
  67         #define DEBUGOUT(S)
  68         #define DEBUGOUT1(S,A)
  69         #define DEBUGOUT2(S,A,B)
  70         #define DEBUGOUT3(S,A,B,C)
  71         #define DEBUGOUT7(S,A,B,C,D,E,F,G)
  72 #endif
  73
  74 #define FALSE               0
  75 #define TRUE                1
  76 #define CMD_MEM_WRT_INVALIDATE          0x0010  /* BIT_4 */
  77 #define PCI_COMMAND_REGISTER            PCIR_COMMAND
  78
  79 struct em_osdep
  80 {
  81         bus_space_tag_t    mem_bus_space_tag;
  82         bus_space_handle_t mem_bus_space_handle;
  83         bus_space_tag_t    io_bus_space_tag;
  84         bus_space_handle_t io_bus_space_handle;
  85         struct device     *dev;
  86 };
  87
  88 #define E1000_WRITE_FLUSH(hw) E1000_READ_REG(hw, STATUS)
  89
  90 /* Read from an absolute offset in the adapter's memory space */
  91 #define E1000_READ_OFFSET(hw, offset) \
  92     bus_space_read_4( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
  93                       ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
  94                       offset)
  95
  96 /* Write to an absolute offset in the adapter's memory space */
  97 #define E1000_WRITE_OFFSET(hw, offset, value) \
  98     bus_space_write_4( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
  99                        ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 100                        offset, \
 101                        value)
 102
 103 /* Convert a register name to its offset in the adapter's memory space */
 104 #define E1000_REG_OFFSET(hw, reg) \
 105     ((hw)->mac_type >= em_82543 ? E1000_##reg : E1000_82542_##reg)
 106
 107 #define E1000_READ_REG(hw, reg) \
 108     E1000_READ_OFFSET(hw, E1000_REG_OFFSET(hw, reg))
 109
 110 #define E1000_WRITE_REG(hw, reg, value) \
 111     E1000_WRITE_OFFSET(hw, E1000_REG_OFFSET(hw, reg), value)
 112
 113 #define E1000_READ_REG_ARRAY(hw, reg, index) \
 114     E1000_READ_OFFSET(hw, E1000_REG_OFFSET(hw, reg) + ((index) << 2))
 115
 116 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
 117
 118 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
 119     E1000_WRITE_OFFSET(hw, E1000_REG_OFFSET(hw, reg) + ((index) << 2), value)
 120
 121 #define E1000_WRITE_REG_ARRAY_BYTE(hw, reg, index, value) \
 122     bus_space_write_1( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
 123                        ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 124                        E1000_REG_OFFSET(hw, reg) + (index), \
 125                        value)
 126
 127 #define E1000_WRITE_REG_ARRAY_WORD(hw, reg, index, value) \
 128     bus_space_write_2( ((struct em_osdep *)(hw)->back)->mem_bus_space_tag, \
 129                        ((struct em_osdep *)(hw)->back)->mem_bus_space_handle, \
 130                        E1000_REG_OFFSET(hw, reg) + (index), \
 131                        value)
 132
 133 #define E1000_WRITE_REG_ARRAY_DWORD(hw, reg, index, value) \
 134     E1000_WRITE_OFFSET(hw, E1000_REG_OFFSET(hw, reg) + ((index) << 2), value)
 135
 136 #define em_io_read(hw, port)                                            \
 137     bus_space_read_4(((struct em_osdep *)(hw)->back)->io_bus_space_tag, \
 138         ((struct em_osdep *)(hw)->back)->io_bus_space_handle, (port))
 139
 140 #define em_io_write(hw, port, value)                                     \
 141     bus_space_write_4(((struct em_osdep *)(hw)->back)->io_bus_space_tag, \
 142         ((struct em_osdep *)(hw)->back)->io_bus_space_handle, (port),    \
 143         (value))
 144
 145 #endif  /* _FREEBSD_OS_H_ */
 146