first public release
[dpdk.git] / lib / librte_pmd_igb / igb / 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
46 #include "../e1000_logs.h"
47
48 /* Remove some compiler warnings for the files in this dir */
49 #ifdef __INTEL_COMPILER
50 #pragma warning(disable:2259) /* conversion may lose significant bits */
51 #pragma warning(disable:869)  /* Parameter was never referenced */
52 #pragma warning(disable:181)  /* Arg incompatible with format string */
53 #else
54 #pragma GCC diagnostic ignored "-Wunused-parameter"
55 #pragma GCC diagnostic ignored "-Wformat"
56 #pragma GCC diagnostic ignored "-Wuninitialized"
57 #if (((__GNUC__) >= 4) && ((__GNUC_MINOR__) >= 7))
58 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
59 #endif
60 #endif
61
62 #define DELAY(x) rte_delay_us(x)
63 #define usec_delay(x) DELAY(x)
64 #define msec_delay(x) DELAY(1000*(x))
65 #define msec_delay_irq(x) DELAY(1000*(x))
66
67 #define DEBUGFUNC(F)            DEBUGOUT(F);
68 #define DEBUGOUT(S, args...)    PMD_DRV_LOG(DEBUG, S, ##args)
69 #define DEBUGOUT1(S, args...)   DEBUGOUT(S, ##args)
70 #define DEBUGOUT2(S, args...)   DEBUGOUT(S, ##args)
71 #define DEBUGOUT3(S, args...)   DEBUGOUT(S, ##args)
72 #define DEBUGOUT6(S, args...)   DEBUGOUT(S, ##args)
73 #define DEBUGOUT7(S, args...)   DEBUGOUT(S, ##args)
74
75 #define FALSE                   0
76 #define TRUE                    1
77
78 typedef uint64_t        u64;
79 typedef uint32_t        u32;
80 typedef uint16_t        u16;
81 typedef uint8_t         u8;
82 typedef int64_t         s64;
83 typedef int32_t         s32;
84 typedef int16_t         s16;
85 typedef int8_t          s8;
86 typedef int             bool;
87
88 #define __le16          u16
89 #define __le32          u32
90 #define __le64          u64
91
92 #define E1000_WRITE_FLUSH(a) E1000_READ_REG(a, E1000_STATUS)
93
94 #define E1000_PCI_REG(reg) (*((volatile uint32_t *)(reg)))
95
96 #define E1000_PCI_REG_WRITE(reg, value) do { \
97         E1000_PCI_REG((reg)) = (value); \
98 } while (0)
99
100 #define E1000_PCI_REG_ADDR(hw, reg) \
101         ((volatile uint32_t *)((char *)(hw)->hw_addr + (reg)))
102
103 #define E1000_PCI_REG_ARRAY_ADDR(hw, reg, index) \
104         E1000_PCI_REG_ADDR((hw), (reg) + ((index) << 2))
105
106 static inline uint32_t e1000_read_addr(volatile void* addr)
107 {
108         return E1000_PCI_REG(addr);
109 }
110
111 /* Register READ/WRITE macros */
112
113 #define E1000_READ_REG(hw, reg) \
114         e1000_read_addr(E1000_PCI_REG_ADDR((hw), (reg)))
115
116 #define E1000_WRITE_REG(hw, reg, value) \
117         E1000_PCI_REG_WRITE(E1000_PCI_REG_ADDR((hw), (reg)), (value))
118
119 #define E1000_READ_REG_ARRAY(hw, reg, index) \
120         E1000_PCI_REG(E1000_PCI_REG_ARRAY_ADDR((hw), (reg), (index)))
121
122 #define E1000_WRITE_REG_ARRAY(hw, reg, index, value) \
123         E1000_PCI_REG_WRITE(E1000_PCI_REG_ARRAY_ADDR((hw), (reg), (index)), (value))
124
125 #define E1000_READ_REG_ARRAY_DWORD E1000_READ_REG_ARRAY
126 #define E1000_WRITE_REG_ARRAY_DWORD E1000_WRITE_REG_ARRAY
127
128 #endif /* _E1000_OSDEP_H_ */