xref: /freebsd/sys/dev/mlx5/mlx5_fpga_tools/tools.h (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1 /*-
2  * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
3  *
4  * This software is available to you under a choice of one of two
5  * licenses.  You may choose to be licensed under the terms of the GNU
6  * General Public License (GPL) Version 2, available from the file
7  * COPYING in the main directory of this source tree, or the
8  * OpenIB.org BSD license below:
9  *
10  *     Redistribution and use in source and binary forms, with or
11  *     without modification, are permitted provided that the following
12  *     conditions are met:
13  *
14  *      - Redistributions of source code must retain the above
15  *        copyright notice, this list of conditions and the following
16  *        disclaimer.
17  *
18  *      - Redistributions in binary form must reproduce the above
19  *        copyright notice, this list of conditions and the following
20  *        disclaimer in the documentation and/or other materials
21  *        provided with the distribution.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30  * SOFTWARE.
31  */
32 
33 #ifndef __TOOLS_H__
34 #define __TOOLS_H__
35 
36 #include <sys/lock.h>
37 #include <sys/sx.h>
38 #include <linux/types.h>
39 #include <linux/kobject.h>
40 #include <linux/list.h>
41 #include <dev/mlx5/mlx5_fpga/sdk.h>
42 
43 #define MLX5_FPGA_TOOLS_DRIVER_NAME "mlx5_fpga_tools"
44 
45 struct mlx5_fpga_tools_dev {
46 	/* Core device and connection to FPGA */
47 	struct mlx5_fpga_device *fdev;
48 
49 	/* Serializes memory accesses */
50 	struct sx lock;
51 
52 	/* Char device state */
53 	void *char_device;
54 };
55 
56 int mlx5_fpga_tools_mem_write(struct mlx5_fpga_tools_dev *tdev,
57 			      void *buf, size_t count, u64 address,
58 			      enum mlx5_fpga_access_type access_type);
59 int mlx5_fpga_tools_mem_read(struct mlx5_fpga_tools_dev *tdev, void *buf,
60 			     size_t count, u64 address,
61 			     enum mlx5_fpga_access_type access_type);
62 
63 #endif	/* __TOOLS_H__ */
64