xref: /freebsd/sys/dev/mlx5/mlx5io.h (revision 3b2324c3a800d7599f348c408f01908d0cef05a0)
1 /*-
2  * Copyright (c) 2018, Mellanox Technologies, Ltd.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #ifndef _DEV_MLX5_MLX5IO_H_
29 #define _DEV_MLX5_MLX5IO_H_
30 
31 #include <sys/ioccom.h>
32 
33 struct mlx5_fwdump_reg {
34 	uint32_t addr;
35 	uint32_t val;
36 };
37 
38 struct mlx5_fwdump_addr {
39 	uint32_t domain;
40 	uint8_t bus;
41 	uint8_t slot;
42 	uint8_t func;
43 };
44 
45 struct mlx5_fwdump_get {
46 	struct mlx5_fwdump_addr devaddr;
47 	struct mlx5_fwdump_reg *buf;
48 	size_t reg_cnt;
49 	size_t reg_filled; /* out */
50 };
51 
52 #define	MLX5_FWDUMP_GET		_IOWR('m', 1, struct mlx5_fwdump_get)
53 #define	MLX5_FWDUMP_RESET	_IOW('m', 2, struct mlx5_fwdump_addr)
54 #define	MLX5_FWDUMP_FORCE	_IOW('m', 3, struct mlx5_fwdump_addr)
55 
56 #ifndef _KERNEL
57 #define	MLX5_DEV_PATH	_PATH_DEV"mlx5ctl"
58 #endif
59 
60 enum mlx5_fpga_id {
61 	MLX5_FPGA_NEWTON = 0,
62 	MLX5_FPGA_EDISON = 1,
63 	MLX5_FPGA_MORSE = 2,
64 	MLX5_FPGA_MORSEQ = 3,
65 };
66 
67 enum mlx5_fpga_image {
68 	MLX5_FPGA_IMAGE_USER = 0,
69 	MLX5_FPGA_IMAGE_FACTORY = 1,
70 	MLX5_FPGA_IMAGE_FACTORY_FAILOVER = 2,
71 	MLX5_FPGA_IMAGE_RESET = 17,
72 	MLX5_FPGA_IMAGE_RELOAD = 18,
73 };
74 
75 enum mlx5_fpga_status {
76 	MLX5_FPGA_STATUS_SUCCESS = 0,
77 	MLX5_FPGA_STATUS_FAILURE = 1,
78 	MLX5_FPGA_STATUS_IN_PROGRESS = 2,
79 	MLX5_FPGA_STATUS_DISCONNECTED = 3,
80 };
81 
82 struct mlx5_fpga_query {
83 	enum mlx5_fpga_image admin_image;
84 	enum mlx5_fpga_image oper_image;
85 	enum mlx5_fpga_status image_status;
86 };
87 
88 enum mlx5_fpga_tee {
89 	MLX5_FPGA_TEE_DISABLE = 0,
90 	MLX5_FPGA_TEE_GENERATE_EVENT = 1,
91 	MLX5_FPGA_TEE_GENERATE_SINGLE_EVENT = 2,
92 };
93 
94 enum mlx5_fpga_connect {
95 	MLX5_FPGA_CONNECT_QUERY = 0,
96 	MLX5_FPGA_CONNECT_DISCONNECT = 0x9,
97 	MLX5_FPGA_CONNECT_CONNECT = 0xA,
98 };
99 
100 /**
101  * enum mlx5_fpga_access_type - Enumerated the different methods possible for
102  * accessing the device memory address space
103  */
104 enum mlx5_fpga_access_type {
105 	/** Use the slow CX-FPGA I2C bus*/
106 	MLX5_FPGA_ACCESS_TYPE_I2C = 0x0,
107 	/** Use the fast 'shell QP' */
108 	MLX5_FPGA_ACCESS_TYPE_RDMA,
109 	/** Use the fastest available method */
110 	MLX5_FPGA_ACCESS_TYPE_DONTCARE,
111 	MLX5_FPGA_ACCESS_TYPE_MAX = MLX5_FPGA_ACCESS_TYPE_DONTCARE,
112 };
113 
114 #define MLX5_FPGA_INTERNAL_SENSORS_LOW 63
115 #define MLX5_FPGA_INTERNAL_SENSORS_HIGH 63
116 
117 struct mlx5_fpga_temperature {
118 	uint32_t temperature;
119 	uint32_t index;
120 	uint32_t tee;
121 	uint32_t max_temperature;
122 	uint32_t temperature_threshold_hi;
123 	uint32_t temperature_threshold_lo;
124 	uint32_t mte;
125 	uint32_t mtr;
126 	char sensor_name[16];
127 };
128 
129 #define	MLX5_FPGA_CAP_ARR_SZ 0x40
130 
131 #define	MLX5_FPGA_ACCESS_TYPE	_IOWINT('m', 0x80)
132 #define	MLX5_FPGA_LOAD		_IOWINT('m', 0x81)
133 #define	MLX5_FPGA_RESET		_IO('m', 0x82)
134 #define	MLX5_FPGA_IMAGE_SEL	_IOWINT('m', 0x83)
135 #define	MLX5_FPGA_QUERY		_IOR('m', 0x84, struct mlx5_fpga_query)
136 #define	MLX5_FPGA_CAP		_IOR('m', 0x85, uint32_t[MLX5_FPGA_CAP_ARR_SZ])
137 #define	MLX5_FPGA_TEMPERATURE	_IOWR('m', 0x86, struct mlx5_fpga_temperature)
138 #define	MLX5_FPGA_CONNECT	_IOWR('m', 0x87, enum mlx5_fpga_connect)
139 #define	MLX5_FPGA_RELOAD	_IO('m', 0x88)
140 
141 #define	MLX5_FPGA_TOOLS_NAME_SUFFIX	"_mlx5_fpga_tools"
142 
143 #endif
144