xref: /freebsd/sys/dev/qlxgb/qla_os.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2011-2013 Qlogic Corporation
5  * All rights reserved.
6  *
7  *  Redistribution and use in source and binary forms, with or without
8  *  modification, are permitted provided that the following conditions
9  *  are met:
10  *
11  *  1. Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer.
13  *  2. Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution.
16  *
17  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  *  POSSIBILITY OF SUCH DAMAGE.
28  */
29 /*
30  * File: qla_os.h
31  * Author : David C Somayajulu, Qlogic Corporation, Aliso Viejo, CA 92656.
32  */
33 
34 #ifndef _QLA_OS_H_
35 #define _QLA_OS_H_
36 
37 #include "opt_inet.h"
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/mbuf.h>
42 #include <sys/protosw.h>
43 #include <sys/socket.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/kernel.h>
47 #include <sys/sockio.h>
48 #include <sys/types.h>
49 #include <machine/atomic.h>
50 #include <sys/conf.h>
51 
52 #include <net/if.h>
53 #include <net/if_var.h>
54 #include <net/if_arp.h>
55 #include <net/ethernet.h>
56 #include <net/if_dl.h>
57 #include <net/if_media.h>
58 #include <net/bpf.h>
59 #include <net/if_types.h>
60 #include <net/if_vlan_var.h>
61 
62 #include <netinet/in_systm.h>
63 #include <netinet/in.h>
64 #include <netinet/if_ether.h>
65 #include <netinet/ip.h>
66 #include <netinet/ip6.h>
67 #include <netinet/tcp.h>
68 #include <netinet/udp.h>
69 #include <netinet/in_var.h>
70 #include <netinet/tcp_lro.h>
71 
72 #include <sys/bus.h>
73 #include <machine/bus.h>
74 #include <sys/rman.h>
75 #include <machine/resource.h>
76 #include <dev/pci/pcireg.h>
77 #include <dev/pci/pcivar.h>
78 #include <sys/mutex.h>
79 #include <sys/condvar.h>
80 #include <sys/proc.h>
81 #include <sys/sysctl.h>
82 #include <sys/endian.h>
83 #include <sys/taskqueue.h>
84 #include <sys/pcpu.h>
85 
86 #include <sys/unistd.h>
87 #include <sys/kthread.h>
88 
89 #define QLA_USEC_DELAY(usec)	DELAY(usec)
90 
91 static __inline int qla_ms_to_hz(int ms)
92 {
93 	int qla_hz;
94 
95 	struct timeval t;
96 
97 	t.tv_sec = ms / 1000;
98 	t.tv_usec = (ms % 1000) * 1000;
99 
100 	qla_hz = tvtohz(&t);
101 
102 	if (qla_hz < 0)
103 		qla_hz = 0x7fffffff;
104 	if (!qla_hz)
105 		qla_hz = 1;
106 
107 	return (qla_hz);
108 }
109 
110 static __inline int qla_sec_to_hz(int sec)
111 {
112 	struct timeval t;
113 
114 	t.tv_sec = sec;
115 	t.tv_usec = 0;
116 
117 	return (tvtohz(&t));
118 }
119 
120 #define qla_host_to_le16(x)	htole16(x)
121 #define qla_host_to_le32(x)	htole32(x)
122 #define qla_host_to_le64(x)	htole64(x)
123 #define qla_host_to_be16(x)	htobe16(x)
124 #define qla_host_to_be32(x)	htobe32(x)
125 #define qla_host_to_be64(x)	htobe64(x)
126 
127 #define qla_le16_to_host(x)	le16toh(x)
128 #define qla_le32_to_host(x)	le32toh(x)
129 #define qla_le64_to_host(x)	le64toh(x)
130 #define qla_be16_to_host(x)	be16toh(x)
131 #define qla_be32_to_host(x)	be32toh(x)
132 #define qla_be64_to_host(x)	be64toh(x)
133 
134 MALLOC_DECLARE(M_QLA8XXXBUF);
135 
136 #define qla_mdelay(fn, msecs)	\
137 	{\
138 		if (cold) \
139 			DELAY((msecs * 1000)); \
140 		else  \
141 			pause(fn, qla_ms_to_hz(msecs)); \
142 	}
143 
144 /*
145  * Locks
146  */
147 #define QLA_LOCK(ha, str) qla_lock(ha, str);
148 #define QLA_UNLOCK(ha, str) qla_unlock(ha, str)
149 
150 #define QLA_TX_LOCK(ha)		mtx_lock(&ha->tx_lock);
151 #define QLA_TX_UNLOCK(ha)	mtx_unlock(&ha->tx_lock);
152 
153 #define QLA_RX_LOCK(ha)		mtx_lock(&ha->rx_lock);
154 #define QLA_RX_UNLOCK(ha)	mtx_unlock(&ha->rx_lock);
155 
156 #define QLA_RXJ_LOCK(ha)	mtx_lock(&ha->rxj_lock);
157 #define QLA_RXJ_UNLOCK(ha)	mtx_unlock(&ha->rxj_lock);
158 
159 /*
160  * structure encapsulating a DMA buffer
161  */
162 struct qla_dma {
163         bus_size_t              alignment;
164         uint32_t                size;
165         void                    *dma_b;
166         bus_addr_t              dma_addr;
167         bus_dmamap_t            dma_map;
168         bus_dma_tag_t           dma_tag;
169 };
170 typedef struct qla_dma qla_dma_t;
171 
172 #define QL_ASSERT(x, y) if (!x) panic y
173 
174 #endif /* #ifndef _QLA_OS_H_ */
175