lib/librte_pmd_e1000/e1000/e1000_osdep.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2001-2014, 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 /*$FreeBSD$*/
  34
  35 #ifndef _E1000_OSDEP_H_
  36 #define _E1000_OSDEP_H_
  37
  38 #include <stdint.h>
  39 #include <stdio.h>
  40 #include <stdarg.h>
  41 #include <string.h>
  42 #include <rte_common.h>
  43 #include <rte_cycles.h>
  44 #include <rte_log.h>
  45 #include <rte_debug.h>
  46 #include <rte_byteorder.h>
  47
  48 #include "../e1000_logs.h"
  49
  50 #define DELAY(x) rte_delay_us(x)
  51 #define usec_delay(x) DELAY(x)
  52 #define usec_delay_irq(x) DELAY(x)
  53 #define msec_delay(x) DELAY(1000*(x))
  54 #define msec_delay_irq(x) DELAY(1000*(x))
  55
  56 #define DEBUGFUNC(F)            DEBUGOUT(F "\n");
  57 #define DEBUGOUT(S, args...)    PMD_DRV_LOG_RAW(DEBUG, S, ##args)
  58 #define DEBUGOUT1(S, args...)   DEBUGOUT(S, ##args)
  59 #define DEBUGOUT2(S, args...)   DEBUGOUT(S, ##args)
  60 #define DEBUGOUT3(S, args...)   DEBUGOUT(S, ##args)
  61 #define DEBUGOUT6(S, args...)   DEBUGOUT(S, ##args)
  62 #define DEBUGOUT7(S, args...)   DEBUGOUT(S, ##args)
  63
  64 #define UNREFERENCED_PARAMETER(_p)
  65 #define UNREFERENCED_1PARAMETER(_p)
  66 #define UNREFERENCED_2PARAMETER(_p, _q)
  67 #define UNREFERENCED_3PARAMETER(_p, _q, _r)
  68 #define UNREFERENCED_4PARAMETER(_p, _q, _r, _s)
  69
  70 #define FALSE                   0
  71 #define TRUE                    1
  72
  73 #define CMD_MEM_WRT_INVALIDATE  0x0010  /* BIT_4 */
  74
  75 /* Mutex used in the shared code */
  76 #define E1000_MUTEX                     uintptr_t
  77 #define E1000_MUTEX_INIT(mutex)         (*(mutex) = 0)
  78 #define E1000_MUTEX_LOCK(mutex)         (*(mutex) = 1)
  79 #define E1000_MUTEX_UNLOCK(mutex)       (*(mutex) = 0)
  80
  81 typedef uint64_t        u64;
  82 typedef uint32_t        u32;
  83 typedef uint16_t        u16;
  84 typedef uint8_t         u8;
  85 typedef int64_t         s64;
  86 typedef int32_t         s32;
  87 typedef int16_t         s16;
  88 typedef int8_t          s8;
  89 typedef int             bool;
  90
  91 #define __le16          u16
  92 #define __le32          u32
  93 #define __le64          u64
  94
  95 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
  96
  97 #define E1000_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
  98
  99 #define E1000_PCI_REG_WRITE(reg, value) do { \
 100         E1000_PCI_REG((reg)) = (rte_cpu_to_le_32(value)); \
 101 } while (0)
 102
 103 #define E1000_PCI_REG_ADDR(hw, reg) \
 104         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
 105
 106 #define E1000_PCI_REG_ARRAY_ADDR(hw, reg, index) \
 107         E1000_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
 108
 109 static inline uint32_t e1000_read_addr(volatile void* addr)
 110 {
 111         return rte_le_to_cpu_32(E1000_PCI_REG(addr));
 112 }
 113
 114 /* Necessary defines */
 115 #define E1000_MRQC_ENABLE_MASK                  0x00000007
 116 #define E1000_MRQC_RSS_FIELD_IPV6_EX            0x00080000
 117 #define E1000_ALL_FULL_DUPLEX   ( \
 118         ADVERTISE_10_FULL | ADVERTISE_100_FULL | ADVERTISE_1000_FULL)
 119
 120 #define M88E1543_E_PHY_ID    0x01410EA0
 121 #define NAHUM6LP_HW
 122 #define ULP_SUPPORT
 123
 124 #define E1000_RCTL_DTYP_MASK    0x00000C00 /* Descriptor type mask */
 125 #define E1000_MRQC_RSS_FIELD_IPV6_EX            0x00080000
 126
 127 /* Register READ/WRITE macros */
 128
 129 #define E1000_READ_REG(hw, reg) \
 130         e1000_read_addr(E1000_PCI_REG_ADDR((hw), (reg)))
 131
 132 #define E1000_WRITE_REG(hw, reg, value) \
 133         E1000_PCI_REG_WRITE(E1000_PCI_REG_ADDR((hw), (reg)), (value))
 134
 135 #define E1000_READ_REG_ARRAY(hw, reg, index) \
 136         E1000_PCI_REG(E1000_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
 137
 138 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
 139         E1000_PCI_REG_WRITE(E1000_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
 140
 141 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
 142 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
 143
 144 #define E1000_ACCESS_PANIC(x, hw, reg, value) \
 145         rte_panic("%s:%u\t" RTE_STR(x) "(%p, 0x%x, 0x%x)", \
 146                 __FILE__, __LINE__, (hw), (reg), (unsigned int)(value))
 147
 148 /*
 149  * To be able to do IO write, we need to map IO BAR
 150  * (bar 2/4 depending on device).
 151  * Right now mapping multiple BARs is not supported by DPDK.
 152  * Fortunatelly we need it only for legacy hw support.
 153  */
 154
 155 #define E1000_WRITE_REG_IO(hw, reg, value) \
 156         E1000_WRITE_REG(hw, reg, value)
 157
 158 /*
 159  * Not implemented.
 160  */
 161
 162 #define E1000_READ_FLASH_REG(hw, reg) \
 163         (E1000_ACCESS_PANIC(E1000_READ_FLASH_REG, hw, reg, 0), 0)
 164
 165 #define E1000_READ_FLASH_REG16(hw, reg)  \
 166         (E1000_ACCESS_PANIC(E1000_READ_FLASH_REG16, hw, reg, 0), 0)
 167
 168 #define E1000_WRITE_FLASH_REG(hw, reg, value)  \
 169         E1000_ACCESS_PANIC(E1000_WRITE_FLASH_REG, hw, reg, value)
 170
 171 #define E1000_WRITE_FLASH_REG16(hw, reg, value) \
 172         E1000_ACCESS_PANIC(E1000_WRITE_FLASH_REG16, hw, reg, value)
 173
 174 #define STATIC static
 175
 176 #ifndef ETH_ADDR_LEN
 177 #define ETH_ADDR_LEN                  6
 178 #endif
 179
 180 #define false                         FALSE
 181 #define true                          TRUE
 182
 183 #endif /* _E1000_OSDEP_H_ */