xref: /OK3568_Linux_fs/kernel/drivers/misc/genwqe/genwqe_driver.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun #ifndef __GENWQE_DRIVER_H__
3*4882a593Smuzhiyun #define __GENWQE_DRIVER_H__
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun /**
6*4882a593Smuzhiyun  * IBM Accelerator Family 'GenWQE'
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  * (C) Copyright IBM Corp. 2013
9*4882a593Smuzhiyun  *
10*4882a593Smuzhiyun  * Author: Frank Haverkamp <haver@linux.vnet.ibm.com>
11*4882a593Smuzhiyun  * Author: Joerg-Stephan Vogt <jsvogt@de.ibm.com>
12*4882a593Smuzhiyun  * Author: Michael Jung <mijung@gmx.net>
13*4882a593Smuzhiyun  * Author: Michael Ruettger <michael@ibmra.de>
14*4882a593Smuzhiyun  */
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #include <linux/types.h>
17*4882a593Smuzhiyun #include <linux/stddef.h>
18*4882a593Smuzhiyun #include <linux/cdev.h>
19*4882a593Smuzhiyun #include <linux/list.h>
20*4882a593Smuzhiyun #include <linux/kthread.h>
21*4882a593Smuzhiyun #include <linux/scatterlist.h>
22*4882a593Smuzhiyun #include <linux/iommu.h>
23*4882a593Smuzhiyun #include <linux/spinlock.h>
24*4882a593Smuzhiyun #include <linux/mutex.h>
25*4882a593Smuzhiyun #include <linux/platform_device.h>
26*4882a593Smuzhiyun #include <linux/printk.h>
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #include <asm/byteorder.h>
29*4882a593Smuzhiyun #include <linux/genwqe/genwqe_card.h>
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun #define DRV_VERSION		"2.0.25"
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun /*
34*4882a593Smuzhiyun  * Static minor number assignement, until we decide/implement
35*4882a593Smuzhiyun  * something dynamic.
36*4882a593Smuzhiyun  */
37*4882a593Smuzhiyun #define GENWQE_MAX_MINOR	128 /* up to 128 possible genwqe devices */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun /**
40*4882a593Smuzhiyun  * genwqe_requ_alloc() - Allocate a new DDCB execution request
41*4882a593Smuzhiyun  *
42*4882a593Smuzhiyun  * This data structure contains the user visiable fields of the DDCB
43*4882a593Smuzhiyun  * to be executed.
44*4882a593Smuzhiyun  *
45*4882a593Smuzhiyun  * Return: ptr to genwqe_ddcb_cmd data structure
46*4882a593Smuzhiyun  */
47*4882a593Smuzhiyun struct genwqe_ddcb_cmd *ddcb_requ_alloc(void);
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun /**
50*4882a593Smuzhiyun  * ddcb_requ_free() - Free DDCB execution request.
51*4882a593Smuzhiyun  * @req:       ptr to genwqe_ddcb_cmd data structure.
52*4882a593Smuzhiyun  */
53*4882a593Smuzhiyun void ddcb_requ_free(struct genwqe_ddcb_cmd *req);
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun u32  genwqe_crc32(u8 *buff, size_t len, u32 init);
56*4882a593Smuzhiyun 
genwqe_hexdump(struct pci_dev * pci_dev,const void * buff,unsigned int size)57*4882a593Smuzhiyun static inline void genwqe_hexdump(struct pci_dev *pci_dev,
58*4882a593Smuzhiyun 				  const void *buff, unsigned int size)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	char prefix[32];
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	scnprintf(prefix, sizeof(prefix), "%s %s: ",
63*4882a593Smuzhiyun 		  GENWQE_DEVNAME, pci_name(pci_dev));
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	print_hex_dump_debug(prefix, DUMP_PREFIX_OFFSET, 16, 1, buff,
66*4882a593Smuzhiyun 			     size, true);
67*4882a593Smuzhiyun }
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun #endif	/* __GENWQE_DRIVER_H__ */
70