ixv_osdep.h revision 315333 
1/******************************************************************************
2
3  Copyright (c) 2001-2017, 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: stable/10/sys/dev/ixgbe/ixv_osdep.h 315333 2017-03-15 21:20:17Z erj $*/
34
35
36#ifndef _IXGBEVF_OSDEP_H_
37#define _IXGBEVF_OSDEP_H_
38
39#include <sys/types.h>
40#include <sys/param.h>
41#include <sys/endian.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 <dev/pci/pcivar.h>
56#include <dev/pci/pcireg.h>
57
58#define ASSERT(x) if(!(x)) panic("IXGBE: x")
59
60/* The happy-fun DELAY macro is defined in /usr/src/sys/i386/include/clock.h */
61#define usec_delay(x) DELAY(x)
62#define msec_delay(x) DELAY(1000*(x))
63
64#define DBG 0
65#define DEBUGFUNC(F)        DEBUGOUT(F);
66#if DBG
67	#define DEBUGOUT(S)         printf(S "\n")
68	#define DEBUGOUT1(S,A)      printf(S "\n",A)
69	#define DEBUGOUT2(S,A,B)    printf(S "\n",A,B)
70	#define DEBUGOUT3(S,A,B,C)  printf(S "\n",A,B,C)
71	#define DEBUGOUT4(S,A,B,C,D)  printf(S "\n",A,B,C,D)
72	#define DEBUGOUT5(S,A,B,C,D,E)  printf(S "\n",A,B,C,D,E)
73	#define DEBUGOUT6(S,A,B,C,D,E,F)  printf(S "\n",A,B,C,D,E,F)
74	#define DEBUGOUT7(S,A,B,C,D,E,F,G)  printf(S "\n",A,B,C,D,E,F,G)
75	#define ERROR_REPORT1(S,A)      printf(S "\n",A)
76	#define ERROR_REPORT2(S,A,B)    printf(S "\n",A,B)
77	#define ERROR_REPORT3(S,A,B,C)  printf(S "\n",A,B,C)
78#else
79	#define DEBUGOUT(S)
80	#define DEBUGOUT1(S,A)
81	#define DEBUGOUT2(S,A,B)
82	#define DEBUGOUT3(S,A,B,C)
83	#define DEBUGOUT4(S,A,B,C,D)
84	#define DEBUGOUT5(S,A,B,C,D,E)
85	#define DEBUGOUT6(S,A,B,C,D,E,F)
86	#define DEBUGOUT7(S,A,B,C,D,E,F,G)
87
88	#define ERROR_REPORT1(S,A)
89	#define ERROR_REPORT2(S,A,B)
90	#define ERROR_REPORT3(S,A,B,C)
91#endif
92
93#define FALSE               0
94#define false               0 /* shared code requires this */
95#define TRUE                1
96#define true                1
97
98/* Shared code dropped this define.. */
99#define IXGBE_INTEL_VENDOR_ID		0x8086
100
101/* Bunch of defines for shared code bogosity */
102#define UNREFERENCED_PARAMETER(_p)
103#define UNREFERENCED_1PARAMETER(_p)
104#define UNREFERENCED_2PARAMETER(_p, _q)
105#define UNREFERENCED_3PARAMETER(_p, _q, _r)
106
107typedef uint8_t		u8;
108typedef int8_t		s8;
109typedef uint16_t	u16;
110typedef int16_t		s16;
111typedef uint32_t	u32;
112typedef int32_t		s32;
113typedef uint64_t	u64;
114#ifndef __bool_true_false_are_defined
115typedef boolean_t	bool;
116#endif
117
118/* shared code requires this */
119#define __le16  u16
120#define __le32  u32
121#define __le64  u64
122#define __be16  u16
123#define __be32  u32
124#define __be64  u64
125
126#if defined(__i386__) || defined(__amd64__)
127static __inline
128void prefetch(void *x)
129{
130	__asm volatile("prefetcht0 %0" :: "m" (*(unsigned long *)x));
131}
132#else
133#define prefetch(x)
134#endif
135
136/*
137 * Optimized bcopy thanks to Luigi Rizzo's investigative work.  Assumes
138 * non-overlapping regions and 32-byte padding on both src and dst.
139 */
140static __inline int
141ixv_bcopy(void *restrict _src, void *restrict _dst, int l)
142{
143	uint64_t *src = _src;
144	uint64_t *dst = _dst;
145
146	for (; l > 0; l -= 32) {
147		*dst++ = *src++;
148		*dst++ = *src++;
149		*dst++ = *src++;
150		*dst++ = *src++;
151	}
152	return (0);
153}
154
155struct ixgbe_osdep
156{
157	bus_space_tag_t    mem_bus_space_tag;
158	bus_space_handle_t mem_bus_space_handle;
159};
160
161/* These routines need struct ixgbe_hw declared */
162struct ixgbe_hw;
163
164/* These routines are needed by the shared code */
165#define IXGBE_WRITE_FLUSH(a) IXGBE_READ_REG(a, IXGBE_STATUS)
166
167extern u32 ixv_read_reg(struct ixgbe_hw *, u32);
168#define IXGBE_READ_REG(a, reg) ixv_read_reg(a, reg)
169
170extern void ixv_write_reg(struct ixgbe_hw *, u32, u32);
171#define IXGBE_WRITE_REG(a, reg, val) ixv_write_reg(a, reg, val)
172
173extern u32 ixv_read_reg_array(struct ixgbe_hw *, u32, u32);
174#define IXGBE_READ_REG_ARRAY(a, reg, offset) \
175    ixv_read_reg_array(a, reg, offset)
176
177extern void ixv_write_reg_array(struct ixgbe_hw *, u32, u32, u32);
178#define IXGBE_WRITE_REG_ARRAY(a, reg, offset, val) \
179    ixv_write_reg_array(a, reg, offset, val)
180
181#endif /* _IXGBEVF_OSDEP_H_ */
182