xref: /freebsd/sys/dev/qat/include/common/qat_freebsd.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1*78ee8d1cSJulian Grajkowski /* SPDX-License-Identifier: BSD-3-Clause */
2*78ee8d1cSJulian Grajkowski /* Copyright(c) 2007-2022 Intel Corporation */
3*78ee8d1cSJulian Grajkowski #ifndef QAT_FREEBSD_H_
4*78ee8d1cSJulian Grajkowski #define QAT_FREEBSD_H_
5*78ee8d1cSJulian Grajkowski 
6*78ee8d1cSJulian Grajkowski #include <sys/param.h>
7*78ee8d1cSJulian Grajkowski #include <sys/module.h>
8*78ee8d1cSJulian Grajkowski #include <sys/bus.h>
9*78ee8d1cSJulian Grajkowski #include <sys/param.h>
10*78ee8d1cSJulian Grajkowski #include <sys/malloc.h>
11*78ee8d1cSJulian Grajkowski #include <sys/firmware.h>
12*78ee8d1cSJulian Grajkowski #include <sys/rman.h>
13*78ee8d1cSJulian Grajkowski #include <sys/types.h>
14*78ee8d1cSJulian Grajkowski #include <sys/ctype.h>
15*78ee8d1cSJulian Grajkowski #include <sys/ioccom.h>
16*78ee8d1cSJulian Grajkowski #include <sys/param.h>
17*78ee8d1cSJulian Grajkowski #include <sys/lock.h>
18*78ee8d1cSJulian Grajkowski #include <linux/device.h>
19*78ee8d1cSJulian Grajkowski #include <linux/dma-mapping.h>
20*78ee8d1cSJulian Grajkowski #include <linux/completion.h>
21*78ee8d1cSJulian Grajkowski #include <linux/list.h>
22*78ee8d1cSJulian Grajkowski #include <machine/bus.h>
23*78ee8d1cSJulian Grajkowski #include <machine/bus_dma.h>
24*78ee8d1cSJulian Grajkowski #include <sys/firmware.h>
25*78ee8d1cSJulian Grajkowski #include <asm/uaccess.h>
26*78ee8d1cSJulian Grajkowski #include <linux/math64.h>
27*78ee8d1cSJulian Grajkowski #include <linux/spinlock.h>
28*78ee8d1cSJulian Grajkowski 
29*78ee8d1cSJulian Grajkowski #define PCI_VENDOR_ID_INTEL 0x8086
30*78ee8d1cSJulian Grajkowski 
31*78ee8d1cSJulian Grajkowski #if !defined(__bool_true_false_are_defined)
32*78ee8d1cSJulian Grajkowski #define __bool_true_false_are_defined 1
33*78ee8d1cSJulian Grajkowski #define false 0
34*78ee8d1cSJulian Grajkowski #define true 1
35*78ee8d1cSJulian Grajkowski #if __STDC_VERSION__ < 199901L && __GNUC__ < 3 && !defined(__INTEL_COMPILER)
36*78ee8d1cSJulian Grajkowski typedef int _Bool;
37*78ee8d1cSJulian Grajkowski #endif
38*78ee8d1cSJulian Grajkowski typedef _Bool bool;
39*78ee8d1cSJulian Grajkowski #endif /* !__bool_true_false_are_defined && !__cplusplus */
40*78ee8d1cSJulian Grajkowski 
41*78ee8d1cSJulian Grajkowski #if __STDC_VERSION__ < 199901L && __GNUC__ < 3 && !defined(__INTEL_COMPILER)
42*78ee8d1cSJulian Grajkowski typedef int _Bool;
43*78ee8d1cSJulian Grajkowski #endif
44*78ee8d1cSJulian Grajkowski 
45*78ee8d1cSJulian Grajkowski #define pause_ms(wmesg, ms) pause_sbt(wmesg, (ms)*SBT_1MS, 0, C_HARDCLOCK)
46*78ee8d1cSJulian Grajkowski 
47*78ee8d1cSJulian Grajkowski /* Function sets the MaxPayload size of a PCI device. */
48*78ee8d1cSJulian Grajkowski int pci_set_max_payload(device_t dev, int payload_size);
49*78ee8d1cSJulian Grajkowski 
50*78ee8d1cSJulian Grajkowski device_t pci_find_pf(device_t vf);
51*78ee8d1cSJulian Grajkowski 
52*78ee8d1cSJulian Grajkowski MALLOC_DECLARE(M_QAT);
53*78ee8d1cSJulian Grajkowski 
54*78ee8d1cSJulian Grajkowski struct msix_entry {
55*78ee8d1cSJulian Grajkowski 	struct resource *irq;
56*78ee8d1cSJulian Grajkowski 	void *cookie;
57*78ee8d1cSJulian Grajkowski };
58*78ee8d1cSJulian Grajkowski 
59*78ee8d1cSJulian Grajkowski struct pci_device_id {
60*78ee8d1cSJulian Grajkowski 	uint16_t vendor;
61*78ee8d1cSJulian Grajkowski 	uint16_t device;
62*78ee8d1cSJulian Grajkowski };
63*78ee8d1cSJulian Grajkowski 
64*78ee8d1cSJulian Grajkowski struct bus_dmamem {
65*78ee8d1cSJulian Grajkowski 	bus_dma_tag_t dma_tag;
66*78ee8d1cSJulian Grajkowski 	bus_dmamap_t dma_map;
67*78ee8d1cSJulian Grajkowski 	void *dma_vaddr;
68*78ee8d1cSJulian Grajkowski 	bus_addr_t dma_baddr;
69*78ee8d1cSJulian Grajkowski };
70*78ee8d1cSJulian Grajkowski 
71*78ee8d1cSJulian Grajkowski /*
72*78ee8d1cSJulian Grajkowski  * Allocate a mapping.	On success, zero is returned and the 'dma_vaddr'
73*78ee8d1cSJulian Grajkowski  * and 'dma_baddr' fields are populated with the virtual and bus addresses,
74*78ee8d1cSJulian Grajkowski  * respectively, of the mapping.
75*78ee8d1cSJulian Grajkowski  */
76*78ee8d1cSJulian Grajkowski int bus_dma_mem_create(struct bus_dmamem *mem,
77*78ee8d1cSJulian Grajkowski 		       bus_dma_tag_t parent,
78*78ee8d1cSJulian Grajkowski 		       bus_size_t alignment,
79*78ee8d1cSJulian Grajkowski 		       bus_addr_t lowaddr,
80*78ee8d1cSJulian Grajkowski 		       bus_size_t len,
81*78ee8d1cSJulian Grajkowski 		       int flags);
82*78ee8d1cSJulian Grajkowski 
83*78ee8d1cSJulian Grajkowski /*
84*78ee8d1cSJulian Grajkowski  * Release a mapping created by bus_dma_mem_create().
85*78ee8d1cSJulian Grajkowski  */
86*78ee8d1cSJulian Grajkowski void bus_dma_mem_free(struct bus_dmamem *mem);
87*78ee8d1cSJulian Grajkowski 
88*78ee8d1cSJulian Grajkowski #define list_for_each_prev_safe(p, n, h)                                       \
89*78ee8d1cSJulian Grajkowski 	for (p = (h)->prev, n = (p)->prev; p != (h); p = n, n = (p)->prev)
90*78ee8d1cSJulian Grajkowski 
91*78ee8d1cSJulian Grajkowski static inline int
compat_strtoul(const char * cp,unsigned int base,unsigned long * res)92*78ee8d1cSJulian Grajkowski compat_strtoul(const char *cp, unsigned int base, unsigned long *res)
93*78ee8d1cSJulian Grajkowski {
94*78ee8d1cSJulian Grajkowski 	char *end;
95*78ee8d1cSJulian Grajkowski 
96*78ee8d1cSJulian Grajkowski 	*res = strtoul(cp, &end, base);
97*78ee8d1cSJulian Grajkowski 
98*78ee8d1cSJulian Grajkowski 	/* skip newline character, if any */
99*78ee8d1cSJulian Grajkowski 	if (*end == '\n')
100*78ee8d1cSJulian Grajkowski 		end++;
101*78ee8d1cSJulian Grajkowski 	if (*cp == 0 || *end != 0)
102*78ee8d1cSJulian Grajkowski 		return (-EINVAL);
103*78ee8d1cSJulian Grajkowski 	return (0);
104*78ee8d1cSJulian Grajkowski }
105*78ee8d1cSJulian Grajkowski 
106*78ee8d1cSJulian Grajkowski static inline int
compat_strtouint(const char * cp,unsigned int base,unsigned int * res)107*78ee8d1cSJulian Grajkowski compat_strtouint(const char *cp, unsigned int base, unsigned int *res)
108*78ee8d1cSJulian Grajkowski {
109*78ee8d1cSJulian Grajkowski 	char *end;
110*78ee8d1cSJulian Grajkowski 	unsigned long temp;
111*78ee8d1cSJulian Grajkowski 
112*78ee8d1cSJulian Grajkowski 	*res = temp = strtoul(cp, &end, base);
113*78ee8d1cSJulian Grajkowski 
114*78ee8d1cSJulian Grajkowski 	/* skip newline character, if any */
115*78ee8d1cSJulian Grajkowski 	if (*end == '\n')
116*78ee8d1cSJulian Grajkowski 		end++;
117*78ee8d1cSJulian Grajkowski 	if (*cp == 0 || *end != 0)
118*78ee8d1cSJulian Grajkowski 		return (-EINVAL);
119*78ee8d1cSJulian Grajkowski 	if (temp != (unsigned int)temp)
120*78ee8d1cSJulian Grajkowski 		return (-ERANGE);
121*78ee8d1cSJulian Grajkowski 	return (0);
122*78ee8d1cSJulian Grajkowski }
123*78ee8d1cSJulian Grajkowski 
124*78ee8d1cSJulian Grajkowski static inline int
compat_strtou8(const char * cp,unsigned int base,unsigned char * res)125*78ee8d1cSJulian Grajkowski compat_strtou8(const char *cp, unsigned int base, unsigned char *res)
126*78ee8d1cSJulian Grajkowski {
127*78ee8d1cSJulian Grajkowski 	char *end;
128*78ee8d1cSJulian Grajkowski 	unsigned long temp;
129*78ee8d1cSJulian Grajkowski 
130*78ee8d1cSJulian Grajkowski 	*res = temp = strtoul(cp, &end, base);
131*78ee8d1cSJulian Grajkowski 
132*78ee8d1cSJulian Grajkowski 	/* skip newline character, if any */
133*78ee8d1cSJulian Grajkowski 	if (*end == '\n')
134*78ee8d1cSJulian Grajkowski 		end++;
135*78ee8d1cSJulian Grajkowski 	if (*cp == 0 || *end != 0)
136*78ee8d1cSJulian Grajkowski 		return -EINVAL;
137*78ee8d1cSJulian Grajkowski 	if (temp != (unsigned char)temp)
138*78ee8d1cSJulian Grajkowski 		return -ERANGE;
139*78ee8d1cSJulian Grajkowski 	return 0;
140*78ee8d1cSJulian Grajkowski }
141*78ee8d1cSJulian Grajkowski 
142*78ee8d1cSJulian Grajkowski #if __FreeBSD_version >= 1300500
143*78ee8d1cSJulian Grajkowski #undef dev_to_node
144*78ee8d1cSJulian Grajkowski static inline int
dev_to_node(device_t dev)145*78ee8d1cSJulian Grajkowski dev_to_node(device_t dev)
146*78ee8d1cSJulian Grajkowski {
147*78ee8d1cSJulian Grajkowski 	int numa_domain;
148*78ee8d1cSJulian Grajkowski 
149*78ee8d1cSJulian Grajkowski 	if (!dev || bus_get_domain(dev, &numa_domain) != 0)
150*78ee8d1cSJulian Grajkowski 		return (-1);
151*78ee8d1cSJulian Grajkowski 	else
152*78ee8d1cSJulian Grajkowski 		return (numa_domain);
153*78ee8d1cSJulian Grajkowski }
154*78ee8d1cSJulian Grajkowski #endif
155*78ee8d1cSJulian Grajkowski #endif
156