1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright 2016-17 IBM Corp.
6 #ifndef _ASM_POWERPC_VAS_H
7 #define _ASM_POWERPC_VAS_H
8 #include <linux/sched/mm.h>
9 #include <linux/mmu_context.h>
10 #include <asm/icswx.h>
11 #include <uapi/asm/vas-api.h>
14 * Min and max FIFO sizes are based on Version 1.05 Section 3.1.4.25
15 * (Local FIFO Size Register) of the VAS workbook.
17 #define VAS_RX_FIFO_SIZE_MIN (1 << 10) /* 1KB */
18 #define VAS_RX_FIFO_SIZE_MAX (8 << 20) /* 8MB */
21 * Threshold Control Mode: Have paste operation fail if the number of
22 * requests in receive FIFO exceeds a threshold.
24 * NOTE: No special error code yet if paste is rejected because of these
25 * limits. So users can't distinguish between this and other errors.
27 #define VAS_THRESH_DISABLED 0
28 #define VAS_THRESH_FIFO_GT_HALF_FULL 1
29 #define VAS_THRESH_FIFO_GT_QTR_FULL 2
30 #define VAS_THRESH_FIFO_GT_EIGHTH_FULL 3
35 #define GET_FIELD(m, v) (((v) & (m)) >> MASK_LSH(m))
36 #define MASK_LSH(m) (__builtin_ffsl(m) - 1)
37 #define SET_FIELD(m, v, val) \
38 (((v) & ~(m)) | ((((typeof(v))(val)) << MASK_LSH(m)) & (m)))
41 * Co-processor Engine type.
46 VAS_COP_TYPE_842_HIPRI,
48 VAS_COP_TYPE_GZIP_HIPRI,
54 * User space VAS windows are opened by tasks and take references
55 * to pid and mm until windows are closed.
56 * Stores pid, mm, and tgid for each window.
58 struct vas_user_win_ref {
59 struct pid *pid; /* PID of owner */
60 struct pid *tgid; /* Thread group ID of owner */
61 struct mm_struct *mm; /* Linux process mm_struct */
65 * Common VAS window struct on PowerNV and PowerVM
69 u32 wcreds_max; /* Window credits */
70 enum vas_cop_type cop;
71 struct vas_user_win_ref task_ref;
73 struct dentry *dbgdir;
77 * User space window operations used for powernv and powerVM
79 struct vas_user_win_ops {
80 struct vas_window * (*open_win)(int vas_id, u64 flags,
82 u64 (*paste_addr)(struct vas_window *);
83 int (*close_win)(struct vas_window *);
86 static inline void put_vas_user_win_ref(struct vas_user_win_ref *ref)
88 /* Drop references to pid, tgid, and mm */
95 static inline void vas_user_win_add_mm_context(struct vas_user_win_ref *ref)
97 mm_context_add_vas_window(ref->mm);
99 * Even a process that has no foreign real address mapping can
100 * use an unpaired COPY instruction (to no real effect). Issue
101 * CP_ABORT to clear any pending COPY and prevent a covert
104 * __switch_to() will issue CP_ABORT on future context switches
105 * if process / thread has any open VAS window (Use
106 * current->mm->context.vas_windows).
108 asm volatile(PPC_CP_ABORT);
112 * Receive window attributes specified by the (in-kernel) owner of window.
114 struct vas_rx_win_attr {
123 bool tx_win_ord_mode;
124 bool rx_win_ord_mode;
142 * Window attributes specified by the in-kernel owner of a send window.
144 struct vas_tx_win_attr {
145 enum vas_cop_type cop;
148 int pidr; /* hardware PID (from SPRN_PID) */
150 int rsvd_txbuf_count;
156 bool rsvd_txbuf_enable;
159 bool tx_win_ord_mode;
160 bool rx_win_ord_mode;
163 #ifdef CONFIG_PPC_POWERNV
165 * Helper to map a chip id to VAS id.
166 * For POWER9, this is a 1:1 mapping. In the future this maybe a 1:N
167 * mapping in which case, we will need to update this helper.
169 * Return the VAS id or -1 if no matching vasid is found.
171 int chip_to_vas_id(int chipid);
174 * Helper to initialize receive window attributes to defaults for an
177 void vas_init_rx_win_attr(struct vas_rx_win_attr *rxattr, enum vas_cop_type cop);
180 * Open a VAS receive window for the instance of VAS identified by @vasid
181 * Use @attr to initialize the attributes of the window.
183 * Return a handle to the window or ERR_PTR() on error.
185 struct vas_window *vas_rx_win_open(int vasid, enum vas_cop_type cop,
186 struct vas_rx_win_attr *attr);
189 * Helper to initialize send window attributes to defaults for an NX window.
191 extern void vas_init_tx_win_attr(struct vas_tx_win_attr *txattr,
192 enum vas_cop_type cop);
195 * Open a VAS send window for the instance of VAS identified by @vasid
196 * and the co-processor type @cop. Use @attr to initialize attributes
199 * Note: The instance of VAS must already have an open receive window for
200 * the coprocessor type @cop.
202 * Return a handle to the send window or ERR_PTR() on error.
204 struct vas_window *vas_tx_win_open(int vasid, enum vas_cop_type cop,
205 struct vas_tx_win_attr *attr);
208 * Close the send or receive window identified by @win. For receive windows
209 * return -EAGAIN if there are active send windows attached to this receive
212 int vas_win_close(struct vas_window *win);
215 * Copy the co-processor request block (CRB) @crb into the local L2 cache.
217 int vas_copy_crb(void *crb, int offset);
220 * Paste a previously copied CRB (see vas_copy_crb()) from the L2 cache to
221 * the hardware address associated with the window @win. @re is expected/
222 * assumed to be true for NX windows.
224 int vas_paste_crb(struct vas_window *win, int offset, bool re);
226 int vas_register_api_powernv(struct module *mod, enum vas_cop_type cop_type,
228 void vas_unregister_api_powernv(void);
231 #ifdef CONFIG_PPC_PSERIES
233 /* VAS Capabilities */
234 #define VAS_GZIP_QOS_FEAT 0x1
235 #define VAS_GZIP_DEF_FEAT 0x2
236 #define VAS_GZIP_QOS_FEAT_BIT PPC_BIT(VAS_GZIP_QOS_FEAT) /* Bit 1 */
237 #define VAS_GZIP_DEF_FEAT_BIT PPC_BIT(VAS_GZIP_DEF_FEAT) /* Bit 2 */
239 /* NX Capabilities */
240 #define VAS_NX_GZIP_FEAT 0x1
241 #define VAS_NX_GZIP_FEAT_BIT PPC_BIT(VAS_NX_GZIP_FEAT) /* Bit 1 */
244 * These structs are used to retrieve overall VAS capabilities that
245 * the hypervisor provides.
247 struct hv_vas_all_caps {
250 } __packed __aligned(0x1000);
252 struct vas_all_caps {
257 int h_query_vas_capabilities(const u64 hcall, u8 query_type, u64 result);
258 int vas_register_api_pseries(struct module *mod,
259 enum vas_cop_type cop_type, const char *name);
260 void vas_unregister_api_pseries(void);
264 * Register / unregister coprocessor type to VAS API which will be exported
265 * to user space. Applications can use this API to open / close window
266 * which can be used to send / receive requests directly to cooprcessor.
268 * Only NX GZIP coprocessor type is supported now, but this API can be
269 * used for others in future.
271 int vas_register_coproc_api(struct module *mod, enum vas_cop_type cop_type,
273 const struct vas_user_win_ops *vops);
274 void vas_unregister_coproc_api(void);
276 int get_vas_user_win_ref(struct vas_user_win_ref *task_ref);
277 void vas_update_csb(struct coprocessor_request_block *crb,
278 struct vas_user_win_ref *task_ref);
279 void vas_dump_crb(struct coprocessor_request_block *crb);
280 #endif /* __ASM_POWERPC_VAS_H */