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