xref: /linux/include/uapi/misc/cxl.h (revision 4b132aacb0768ac1e652cf517097ea6f237214b9)
1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /*
3  * Copyright 2014 IBM Corp.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version
8  * 2 of the License, or (at your option) any later version.
9  */
10 
11 #ifndef _UAPI_MISC_CXL_H
12 #define _UAPI_MISC_CXL_H
13 
14 #include <linux/types.h>
15 #include <linux/ioctl.h>
16 
17 
18 struct cxl_ioctl_start_work {
19 	__u64 flags;
20 	__u64 work_element_descriptor;
21 	__u64 amr;
22 	__s16 num_interrupts;
23 	__u16 tid;
24 	__s32 reserved1;
25 	__u64 reserved2;
26 	__u64 reserved3;
27 	__u64 reserved4;
28 	__u64 reserved5;
29 };
30 
31 #define CXL_START_WORK_AMR		0x0000000000000001ULL
32 #define CXL_START_WORK_NUM_IRQS		0x0000000000000002ULL
33 #define CXL_START_WORK_ERR_FF		0x0000000000000004ULL
34 #define CXL_START_WORK_TID		0x0000000000000008ULL
35 #define CXL_START_WORK_ALL		(CXL_START_WORK_AMR |\
36 					 CXL_START_WORK_NUM_IRQS |\
37 					 CXL_START_WORK_ERR_FF |\
38 					 CXL_START_WORK_TID)
39 
40 
41 /* Possible modes that an afu can be in */
42 #define CXL_MODE_DEDICATED   0x1
43 #define CXL_MODE_DIRECTED    0x2
44 
45 /* possible flags for the cxl_afu_id flags field */
46 #define CXL_AFUID_FLAG_SLAVE    0x1  /* In directed-mode afu is in slave mode */
47 
48 struct cxl_afu_id {
49 	__u64 flags;     /* One of CXL_AFUID_FLAG_X */
50 	__u32 card_id;
51 	__u32 afu_offset;
52 	__u32 afu_mode;  /* one of the CXL_MODE_X */
53 	__u32 reserved1;
54 	__u64 reserved2;
55 	__u64 reserved3;
56 	__u64 reserved4;
57 	__u64 reserved5;
58 	__u64 reserved6;
59 };
60 
61 /* base adapter image header is included in the image */
62 #define CXL_AI_NEED_HEADER	0x0000000000000001ULL
63 #define CXL_AI_ALL		CXL_AI_NEED_HEADER
64 
65 #define CXL_AI_HEADER_SIZE 128
66 #define CXL_AI_BUFFER_SIZE 4096
67 #define CXL_AI_MAX_ENTRIES 256
68 #define CXL_AI_MAX_CHUNK_SIZE (CXL_AI_BUFFER_SIZE * CXL_AI_MAX_ENTRIES)
69 
70 struct cxl_adapter_image {
71 	__u64 flags;
72 	__u64 data;
73 	__u64 len_data;
74 	__u64 len_image;
75 	__u64 reserved1;
76 	__u64 reserved2;
77 	__u64 reserved3;
78 	__u64 reserved4;
79 };
80 
81 /* ioctl numbers */
82 #define CXL_MAGIC 0xCA
83 /* AFU devices */
84 #define CXL_IOCTL_START_WORK		_IOW(CXL_MAGIC, 0x00, struct cxl_ioctl_start_work)
85 #define CXL_IOCTL_GET_PROCESS_ELEMENT	_IOR(CXL_MAGIC, 0x01, __u32)
86 #define CXL_IOCTL_GET_AFU_ID            _IOR(CXL_MAGIC, 0x02, struct cxl_afu_id)
87 /* adapter devices */
88 #define CXL_IOCTL_DOWNLOAD_IMAGE        _IOW(CXL_MAGIC, 0x0A, struct cxl_adapter_image)
89 #define CXL_IOCTL_VALIDATE_IMAGE        _IOW(CXL_MAGIC, 0x0B, struct cxl_adapter_image)
90 
91 #define CXL_READ_MIN_SIZE 0x1000 /* 4K */
92 
93 /* Events from read() */
94 enum cxl_event_type {
95 	CXL_EVENT_RESERVED      = 0,
96 	CXL_EVENT_AFU_INTERRUPT = 1,
97 	CXL_EVENT_DATA_STORAGE  = 2,
98 	CXL_EVENT_AFU_ERROR     = 3,
99 	CXL_EVENT_AFU_DRIVER    = 4,
100 };
101 
102 struct cxl_event_header {
103 	__u16 type;
104 	__u16 size;
105 	__u16 process_element;
106 	__u16 reserved1;
107 };
108 
109 struct cxl_event_afu_interrupt {
110 	__u16 flags;
111 	__u16 irq; /* Raised AFU interrupt number */
112 	__u32 reserved1;
113 };
114 
115 struct cxl_event_data_storage {
116 	__u16 flags;
117 	__u16 reserved1;
118 	__u32 reserved2;
119 	__u64 addr;
120 	__u64 dsisr;
121 	__u64 reserved3;
122 };
123 
124 struct cxl_event_afu_error {
125 	__u16 flags;
126 	__u16 reserved1;
127 	__u32 reserved2;
128 	__u64 error;
129 };
130 
131 struct cxl_event_afu_driver_reserved {
132 	/*
133 	 * Defines the buffer passed to the cxl driver by the AFU driver.
134 	 *
135 	 * This is not ABI since the event header.size passed to the user for
136 	 * existing events is set in the read call to sizeof(cxl_event_header)
137 	 * + sizeof(whatever event is being dispatched) and the user is already
138 	 * required to use a 4K buffer on the read call.
139 	 *
140 	 * Of course the contents will be ABI, but that's up the AFU driver.
141 	 */
142 	__u32 data_size;
143 	__u8 data[];
144 };
145 
146 struct cxl_event {
147 	struct cxl_event_header header;
148 	union {
149 		struct cxl_event_afu_interrupt irq;
150 		struct cxl_event_data_storage fault;
151 		struct cxl_event_afu_error afu_error;
152 		struct cxl_event_afu_driver_reserved afu_driver_event;
153 	};
154 };
155 
156 #endif /* _UAPI_MISC_CXL_H */
157