1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright IBM Corp. 2006, 2019
4  * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
5  *	      Martin Schwidefsky <schwidefsky@de.ibm.com>
6  *	      Ralph Wuerthner <rwuerthn@de.ibm.com>
7  *	      Felix Beck <felix.beck@de.ibm.com>
8  *	      Holger Dengler <hd@linux.vnet.ibm.com>
9  *
10  * Adjunct processor bus header file.
11  */
12 
13 #ifndef _AP_BUS_H_
14 #define _AP_BUS_H_
15 
16 #include <linux/device.h>
17 #include <linux/types.h>
18 #include <linux/hashtable.h>
19 #include <asm/isc.h>
20 #include <asm/ap.h>
21 
22 #define AP_DEVICES 256		/* Number of AP devices. */
23 #define AP_DOMAINS 256		/* Number of AP domains. */
24 #define AP_IOCTLS  256		/* Number of ioctls. */
25 #define AP_RESET_TIMEOUT (HZ*0.7)	/* Time in ticks for reset timeouts. */
26 #define AP_CONFIG_TIME 30	/* Time in seconds between AP bus rescans. */
27 #define AP_POLL_TIME 1		/* Time in ticks between receive polls. */
28 #define AP_DEFAULT_MAX_MSG_SIZE (12 * 1024)
29 #define AP_TAPQ_ML_FIELD_CHUNK_SIZE (4096)
30 
31 extern int ap_domain_index;
32 extern atomic_t ap_max_msg_size;
33 
34 extern DECLARE_HASHTABLE(ap_queues, 8);
35 extern spinlock_t ap_queues_lock;
36 
ap_test_bit(unsigned int * ptr,unsigned int nr)37 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
38 {
39 	return (*ptr & (0x80000000u >> nr)) != 0;
40 }
41 
42 #define AP_RESPONSE_NORMAL		0x00
43 #define AP_RESPONSE_Q_NOT_AVAIL		0x01
44 #define AP_RESPONSE_RESET_IN_PROGRESS	0x02
45 #define AP_RESPONSE_DECONFIGURED	0x03
46 #define AP_RESPONSE_CHECKSTOPPED	0x04
47 #define AP_RESPONSE_BUSY		0x05
48 #define AP_RESPONSE_INVALID_ADDRESS	0x06
49 #define AP_RESPONSE_OTHERWISE_CHANGED	0x07
50 #define AP_RESPONSE_INVALID_GISA	0x08
51 #define AP_RESPONSE_Q_FULL		0x10
52 #define AP_RESPONSE_NO_PENDING_REPLY	0x10
53 #define AP_RESPONSE_INDEX_TOO_BIG	0x11
54 #define AP_RESPONSE_NO_FIRST_PART	0x13
55 #define AP_RESPONSE_MESSAGE_TOO_BIG	0x15
56 #define AP_RESPONSE_REQ_FAC_NOT_INST	0x16
57 #define AP_RESPONSE_INVALID_DOMAIN	0x42
58 
59 /*
60  * Known device types
61  */
62 #define AP_DEVICE_TYPE_PCICC	3
63 #define AP_DEVICE_TYPE_PCICA	4
64 #define AP_DEVICE_TYPE_PCIXCC	5
65 #define AP_DEVICE_TYPE_CEX2A	6
66 #define AP_DEVICE_TYPE_CEX2C	7
67 #define AP_DEVICE_TYPE_CEX3A	8
68 #define AP_DEVICE_TYPE_CEX3C	9
69 #define AP_DEVICE_TYPE_CEX4	10
70 #define AP_DEVICE_TYPE_CEX5	11
71 #define AP_DEVICE_TYPE_CEX6	12
72 #define AP_DEVICE_TYPE_CEX7	13
73 #define AP_DEVICE_TYPE_CEX8	14
74 
75 /*
76  * Known function facilities
77  */
78 #define AP_FUNC_MEX4K 1
79 #define AP_FUNC_CRT4K 2
80 #define AP_FUNC_COPRO 3
81 #define AP_FUNC_ACCEL 4
82 #define AP_FUNC_EP11  5
83 #define AP_FUNC_APXA  6
84 
85 /*
86  * AP queue state machine states
87  */
88 enum ap_sm_state {
89 	AP_SM_STATE_RESET_START = 0,
90 	AP_SM_STATE_RESET_WAIT,
91 	AP_SM_STATE_SETIRQ_WAIT,
92 	AP_SM_STATE_IDLE,
93 	AP_SM_STATE_WORKING,
94 	AP_SM_STATE_QUEUE_FULL,
95 	NR_AP_SM_STATES
96 };
97 
98 /*
99  * AP queue state machine events
100  */
101 enum ap_sm_event {
102 	AP_SM_EVENT_POLL,
103 	AP_SM_EVENT_TIMEOUT,
104 	NR_AP_SM_EVENTS
105 };
106 
107 /*
108  * AP queue state wait behaviour
109  */
110 enum ap_sm_wait {
111 	AP_SM_WAIT_AGAIN = 0,	/* retry immediately */
112 	AP_SM_WAIT_TIMEOUT,	/* wait for timeout */
113 	AP_SM_WAIT_INTERRUPT,	/* wait for thin interrupt (if available) */
114 	AP_SM_WAIT_NONE,	/* no wait */
115 	NR_AP_SM_WAIT
116 };
117 
118 /*
119  * AP queue device states
120  */
121 enum ap_dev_state {
122 	AP_DEV_STATE_UNINITIATED = 0,	/* fresh and virgin, not touched */
123 	AP_DEV_STATE_OPERATING,		/* queue dev is working normal */
124 	AP_DEV_STATE_SHUTDOWN,		/* remove/unbind/shutdown in progress */
125 	AP_DEV_STATE_ERROR,		/* device is in error state */
126 	NR_AP_DEV_STATES
127 };
128 
129 struct ap_device;
130 struct ap_message;
131 
132 /*
133  * The ap driver struct includes a flags field which holds some info for
134  * the ap bus about the driver. Currently only one flag is supported and
135  * used: The DEFAULT flag marks an ap driver as a default driver which is
136  * used together with the apmask and aqmask whitelisting of the ap bus.
137  */
138 #define AP_DRIVER_FLAG_DEFAULT 0x0001
139 
140 struct ap_driver {
141 	struct device_driver driver;
142 	struct ap_device_id *ids;
143 	unsigned int flags;
144 
145 	int (*probe)(struct ap_device *);
146 	void (*remove)(struct ap_device *);
147 	int (*in_use)(unsigned long *apm, unsigned long *aqm);
148 	/*
149 	 * Called at the start of the ap bus scan function when
150 	 * the crypto config information (qci) has changed.
151 	 * This callback is not invoked if there is no AP
152 	 * QCI support available.
153 	 */
154 	void (*on_config_changed)(struct ap_config_info *new_config_info,
155 				  struct ap_config_info *old_config_info);
156 	/*
157 	 * Called at the end of the ap bus scan function when
158 	 * the crypto config information (qci) has changed.
159 	 * This callback is not invoked if there is no AP
160 	 * QCI support available.
161 	 */
162 	void (*on_scan_complete)(struct ap_config_info *new_config_info,
163 				 struct ap_config_info *old_config_info);
164 };
165 
166 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
167 
168 int ap_driver_register(struct ap_driver *, struct module *, char *);
169 void ap_driver_unregister(struct ap_driver *);
170 
171 struct ap_device {
172 	struct device device;
173 	int device_type;		/* AP device type. */
174 };
175 
176 #define to_ap_dev(x) container_of((x), struct ap_device, device)
177 
178 struct ap_card {
179 	struct ap_device ap_dev;
180 	int raw_hwtype;			/* AP raw hardware type. */
181 	unsigned int functions;		/* AP device function bitfield. */
182 	int queue_depth;		/* AP queue depth.*/
183 	int id;				/* AP card number. */
184 	unsigned int maxmsgsize;	/* AP msg limit for this card */
185 	bool config;			/* configured state */
186 	bool chkstop;			/* checkstop state */
187 	atomic64_t total_request_count;	/* # requests ever for this AP device.*/
188 };
189 
190 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
191 
192 struct ap_queue {
193 	struct ap_device ap_dev;
194 	struct hlist_node hnode;	/* Node for the ap_queues hashtable */
195 	struct ap_card *card;		/* Ptr to assoc. AP card. */
196 	spinlock_t lock;		/* Per device lock. */
197 	enum ap_dev_state dev_state;	/* queue device state */
198 	bool config;			/* configured state */
199 	bool chkstop;			/* checkstop state */
200 	ap_qid_t qid;			/* AP queue id. */
201 	bool interrupt;			/* indicate if interrupts are enabled */
202 	int queue_count;		/* # messages currently on AP queue. */
203 	int pendingq_count;		/* # requests on pendingq list. */
204 	int requestq_count;		/* # requests on requestq list. */
205 	u64 total_request_count;	/* # requests ever for this AP device.*/
206 	int request_timeout;		/* Request timeout in jiffies. */
207 	struct timer_list timeout;	/* Timer for request timeouts. */
208 	struct list_head pendingq;	/* List of message sent to AP queue. */
209 	struct list_head requestq;	/* List of message yet to be sent. */
210 	struct ap_message *reply;	/* Per device reply message. */
211 	enum ap_sm_state sm_state;	/* ap queue state machine state */
212 	int last_err_rc;		/* last error state response code */
213 };
214 
215 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
216 
217 typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue);
218 
219 /* failure injection cmd struct */
220 struct ap_fi {
221 	union {
222 		u16 cmd;		/* fi flags + action */
223 		struct {
224 			u8 flags;	/* fi flags only */
225 			u8 action;	/* fi action only */
226 		};
227 	};
228 };
229 
230 /* all currently known fi actions */
231 enum ap_fi_actions {
232 	AP_FI_ACTION_CCA_AGENT_FF   = 0x01,
233 	AP_FI_ACTION_CCA_DOM_INVAL  = 0x02,
234 	AP_FI_ACTION_NQAP_QID_INVAL = 0x03,
235 };
236 
237 /* all currently known fi flags */
238 enum ap_fi_flags {
239 	AP_FI_FLAG_NO_RETRY	  = 0x01,
240 	AP_FI_FLAG_TOGGLE_SPECIAL = 0x02,
241 };
242 
243 struct ap_message {
244 	struct list_head list;		/* Request queueing. */
245 	unsigned long long psmid;	/* Message id. */
246 	void *msg;			/* Pointer to message buffer. */
247 	unsigned int len;		/* actual msg len in msg buffer */
248 	unsigned int bufsize;		/* allocated msg buffer size */
249 	u16 flags;			/* Flags, see AP_MSG_FLAG_xxx */
250 	struct ap_fi fi;		/* Failure Injection cmd */
251 	int rc;				/* Return code for this message */
252 	void *private;			/* ap driver private pointer. */
253 	/* receive is called from tasklet context */
254 	void (*receive)(struct ap_queue *, struct ap_message *,
255 			struct ap_message *);
256 };
257 
258 #define AP_MSG_FLAG_SPECIAL  0x0001	/* flag msg as 'special' with NQAP */
259 #define AP_MSG_FLAG_USAGE    0x0002	/* CCA, EP11: usage (no admin) msg */
260 #define AP_MSG_FLAG_ADMIN    0x0004	/* CCA, EP11: admin (=control) msg */
261 
262 /**
263  * ap_init_message() - Initialize ap_message.
264  * Initialize a message before using. Otherwise this might result in
265  * unexpected behaviour.
266  */
ap_init_message(struct ap_message * ap_msg)267 static inline void ap_init_message(struct ap_message *ap_msg)
268 {
269 	memset(ap_msg, 0, sizeof(*ap_msg));
270 }
271 
272 /**
273  * ap_release_message() - Release ap_message.
274  * Releases all memory used internal within the ap_message struct
275  * Currently this is the message and private field.
276  */
ap_release_message(struct ap_message * ap_msg)277 static inline void ap_release_message(struct ap_message *ap_msg)
278 {
279 	kfree_sensitive(ap_msg->msg);
280 	kfree_sensitive(ap_msg->private);
281 }
282 
283 /*
284  * Note: don't use ap_send/ap_recv after using ap_queue_message
285  * for the first time. Otherwise the ap message queue will get
286  * confused.
287  */
288 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
289 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
290 
291 enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event);
292 enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event);
293 
294 int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
295 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
296 void ap_flush_queue(struct ap_queue *aq);
297 
298 void *ap_airq_ptr(void);
299 void ap_wait(enum ap_sm_wait wait);
300 void ap_request_timeout(struct timer_list *t);
301 void ap_bus_force_rescan(void);
302 
303 int ap_test_config_usage_domain(unsigned int domain);
304 int ap_test_config_ctrl_domain(unsigned int domain);
305 
306 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
307 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
308 void ap_queue_prepare_remove(struct ap_queue *aq);
309 void ap_queue_remove(struct ap_queue *aq);
310 void ap_queue_init_state(struct ap_queue *aq);
311 
312 struct ap_card *ap_card_create(int id, int queue_depth, int raw_type,
313 			       int comp_type, unsigned int functions, int ml);
314 
315 #define APMASKSIZE (BITS_TO_LONGS(AP_DEVICES) * sizeof(unsigned long))
316 #define AQMASKSIZE (BITS_TO_LONGS(AP_DOMAINS) * sizeof(unsigned long))
317 
318 struct ap_perms {
319 	unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
320 	unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
321 	unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
322 	unsigned long adm[BITS_TO_LONGS(AP_DOMAINS)];
323 };
324 
325 extern struct ap_perms ap_perms;
326 extern struct mutex ap_perms_mutex;
327 
328 /*
329  * Get ap_queue device for this qid.
330  * Returns ptr to the struct ap_queue device or NULL if there
331  * was no ap_queue device with this qid found. When something is
332  * found, the reference count of the embedded device is increased.
333  * So the caller has to decrease the reference count after use
334  * with a call to put_device(&aq->ap_dev.device).
335  */
336 struct ap_queue *ap_get_qdev(ap_qid_t qid);
337 
338 /*
339  * check APQN for owned/reserved by ap bus and default driver(s).
340  * Checks if this APQN is or will be in use by the ap bus
341  * and the default set of drivers.
342  * If yes, returns 1, if not returns 0. On error a negative
343  * errno value is returned.
344  */
345 int ap_owned_by_def_drv(int card, int queue);
346 
347 /*
348  * check 'matrix' of APQNs for owned/reserved by ap bus and
349  * default driver(s).
350  * Checks if there is at least one APQN in the given 'matrix'
351  * marked as owned/reserved by the ap bus and default driver(s).
352  * If such an APQN is found the return value is 1, otherwise
353  * 0 is returned. On error a negative errno value is returned.
354  * The parameter apm is a bitmask which should be declared
355  * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
356  * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
357  */
358 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
359 				       unsigned long *aqm);
360 
361 /*
362  * ap_parse_mask_str() - helper function to parse a bitmap string
363  * and clear/set the bits in the bitmap accordingly. The string may be
364  * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
365  * overwriting the current content of the bitmap. Or as relative string
366  * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
367  * bits are cleared or set. Distinction is done based on the very
368  * first character which may be '+' or '-' for the relative string
369  * and othewise assume to be an absolute value string. If parsing fails
370  * a negative errno value is returned. All arguments and bitmaps are
371  * big endian order.
372  */
373 int ap_parse_mask_str(const char *str,
374 		      unsigned long *bitmap, int bits,
375 		      struct mutex *lock);
376 
377 /*
378  * Interface to wait for the AP bus to have done one initial ap bus
379  * scan and all detected APQNs have been bound to device drivers.
380  * If these both conditions are not fulfilled, this function blocks
381  * on a condition with wait_for_completion_killable_timeout().
382  * If these both conditions are fulfilled (before the timeout hits)
383  * the return value is 0. If the timeout (in jiffies) hits instead
384  * -ETIME is returned. On failures negative return values are
385  * returned to the caller.
386  */
387 int ap_wait_init_apqn_bindings_complete(unsigned long timeout);
388 
389 void ap_send_config_uevent(struct ap_device *ap_dev, bool cfg);
390 void ap_send_online_uevent(struct ap_device *ap_dev, int online);
391 
392 #endif /* _AP_BUS_H_ */
393