lib/librte_pmd_e1000/e1000/e1000_osdep.h

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