1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Copyright 2020-21 IBM Corp.
4 */
5
6#ifndef _VAS_H
7#define _VAS_H
8#include <asm/vas.h>
9#include <linux/mutex.h>
10#include <linux/stringify.h>
11
12/*
13 * VAS window modify flags
14 */
15#define VAS_MOD_WIN_CLOSE	PPC_BIT(0)
16#define VAS_MOD_WIN_JOBS_KILL	PPC_BIT(1)
17#define VAS_MOD_WIN_DR		PPC_BIT(3)
18#define VAS_MOD_WIN_PR		PPC_BIT(4)
19#define VAS_MOD_WIN_SF		PPC_BIT(5)
20#define VAS_MOD_WIN_TA		PPC_BIT(6)
21#define VAS_MOD_WIN_FLAGS	(VAS_MOD_WIN_JOBS_KILL | VAS_MOD_WIN_DR | \
22				VAS_MOD_WIN_PR | VAS_MOD_WIN_SF)
23
24#define VAS_WIN_ACTIVE		0x0
25#define VAS_WIN_CLOSED		0x1
26#define VAS_WIN_INACTIVE	0x2	/* Inactive due to HW failure */
27/* Process of being modified, deallocated, or quiesced */
28#define VAS_WIN_MOD_IN_PROCESS	0x3
29
30#define VAS_COPY_PASTE_USER_MODE	0x00000001
31#define VAS_COP_OP_USER_MODE		0x00000010
32
33#define VAS_GZIP_QOS_CAPABILITIES	0x56516F73477A6970
34#define VAS_GZIP_DEFAULT_CAPABILITIES	0x56446566477A6970
35
36enum vas_migrate_action {
37	VAS_SUSPEND,
38	VAS_RESUME,
39};
40
41/*
42 * Co-processor feature - GZIP QoS windows or GZIP default windows
43 */
44enum vas_cop_feat_type {
45	VAS_GZIP_QOS_FEAT_TYPE,
46	VAS_GZIP_DEF_FEAT_TYPE,
47	VAS_MAX_FEAT_TYPE,
48};
49
50/*
51 * Use to get feature specific capabilities from the
52 * hypervisor.
53 */
54struct hv_vas_cop_feat_caps {
55	__be64	descriptor;
56	u8	win_type;		/* Default or QoS type */
57	u8	user_mode;
58	__be16	max_lpar_creds;
59	__be16	max_win_creds;
60	union {
61		__be16	reserved;
62		__be16	def_lpar_creds; /* Used for default capabilities */
63	};
64	__be16	target_lpar_creds;
65} __packed __aligned(0x1000);
66
67/*
68 * Feature specific (QoS or default) capabilities.
69 */
70struct vas_cop_feat_caps {
71	u64		descriptor;
72	u8		win_type;	/* Default or QoS type */
73	u8		user_mode;	/* User mode copy/paste or COP HCALL */
74	u16		max_lpar_creds;	/* Max credits available in LPAR */
75	/* Max credits can be assigned per window */
76	u16		max_win_creds;
77	union {
78		u16	reserved;	/* Used for QoS credit type */
79		u16	def_lpar_creds; /* Used for default credit type */
80	};
81	/* Total LPAR available credits. Can be different from max LPAR */
82	/* credits due to DLPAR operation */
83	atomic_t	nr_total_credits;	/* Total credits assigned to LPAR */
84	atomic_t	nr_used_credits;	/* Used credits so far */
85};
86
87/*
88 * Feature (QoS or Default) specific to store capabilities and
89 * the list of open windows.
90 */
91struct vas_caps {
92	struct vas_cop_feat_caps caps;
93	struct list_head list;	/* List of open windows */
94	int nr_open_wins_progress;	/* Number of open windows in */
95					/* progress. Used in migration */
96	int nr_close_wins;	/* closed windows in the hypervisor for DLPAR */
97	int nr_open_windows;	/* Number of successful open windows */
98	u8 feat;		/* Feature type */
99};
100
101/*
102 * To get window information from the hypervisor.
103 */
104struct hv_vas_win_lpar {
105	__be16	version;
106	u8	win_type;
107	u8	status;
108	__be16	credits;	/* No of credits assigned to this window */
109	__be16	reserved;
110	__be32	pid;		/* LPAR Process ID */
111	__be32	tid;		/* LPAR Thread ID */
112	__be64	win_addr;	/* Paste address */
113	__be32	interrupt;	/* Interrupt when NX request completes */
114	__be32	fault;		/* Interrupt when NX sees fault */
115	/* Associativity Domain Identifiers as returned in */
116	/* H_HOME_NODE_ASSOCIATIVITY */
117	__be64	domain[6];
118	__be64	win_util;	/* Number of bytes processed */
119} __packed __aligned(0x1000);
120
121struct pseries_vas_window {
122	struct vas_window vas_win;
123	u64 win_addr;		/* Physical paste address */
124	u8 win_type;		/* QoS or Default window */
125	u32 complete_irq;	/* Completion interrupt */
126	u32 fault_irq;		/* Fault interrupt */
127	u64 domain[6];		/* Associativity domain Ids */
128				/* this window is allocated */
129	u64 util;
130	u32 pid;		/* PID associated with this window */
131
132	/* List of windows opened which is used for LPM */
133	struct list_head win_list;
134	u64 flags;
135	char *name;
136	int fault_virq;
137	atomic_t pending_faults; /* Number of pending faults */
138};
139
140int sysfs_add_vas_caps(struct vas_cop_feat_caps *caps);
141int vas_reconfig_capabilties(u8 type, int new_nr_creds);
142int __init sysfs_pseries_vas_init(struct vas_all_caps *vas_caps);
143
144#ifdef CONFIG_PPC_VAS
145int vas_migration_handler(int action);
146int pseries_vas_dlpar_cpu(void);
147#else
148static inline int vas_migration_handler(int action)
149{
150	return 0;
151}
152static inline int pseries_vas_dlpar_cpu(void)
153{
154	return 0;
155}
156#endif
157#endif /* _VAS_H */
158