ap_bus.h

  1/* SPDX-License-Identifier: GPL-2.0+ */
  2/*
  3 * Copyright IBM Corp. 2006, 2023
  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
 31extern int ap_domain_index;
 32extern atomic_t ap_max_msg_size;
 33
 34extern DECLARE_HASHTABLE(ap_queues, 8);
 35extern spinlock_t ap_queues_lock;
 36
 37static 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_BOUND_TO_ANOTHER	     0x09
 52#define AP_RESPONSE_STATE_CHANGE_IN_PROGRESS 0x0A
 53#define AP_RESPONSE_Q_NOT_BOUND		     0x0B
 54#define AP_RESPONSE_Q_FULL		     0x10
 55#define AP_RESPONSE_NO_PENDING_REPLY	     0x10
 56#define AP_RESPONSE_INDEX_TOO_BIG	     0x11
 57#define AP_RESPONSE_NO_FIRST_PART	     0x13
 58#define AP_RESPONSE_MESSAGE_TOO_BIG	     0x15
 59#define AP_RESPONSE_REQ_FAC_NOT_INST	     0x16
 60#define AP_RESPONSE_Q_BIND_ERROR	     0x30
 61#define AP_RESPONSE_Q_NOT_AVAIL_FOR_ASSOC    0x31
 62#define AP_RESPONSE_Q_NOT_EMPTY		     0x32
 63#define AP_RESPONSE_BIND_LIMIT_EXCEEDED	     0x33
 64#define AP_RESPONSE_INVALID_ASSOC_SECRET     0x34
 65#define AP_RESPONSE_ASSOC_SECRET_NOT_UNIQUE  0x35
 66#define AP_RESPONSE_ASSOC_FAILED	     0x36
 67#define AP_RESPONSE_INVALID_DOMAIN	     0x42
 68
 69/*
 70 * Supported AP device types
 71 */
 72#define AP_DEVICE_TYPE_CEX4	10
 73#define AP_DEVICE_TYPE_CEX5	11
 74#define AP_DEVICE_TYPE_CEX6	12
 75#define AP_DEVICE_TYPE_CEX7	13
 76#define AP_DEVICE_TYPE_CEX8	14
 77
 78/*
 79 * AP queue state machine states
 80 */
 81enum ap_sm_state {
 82	AP_SM_STATE_RESET_START = 0,
 83	AP_SM_STATE_RESET_WAIT,
 84	AP_SM_STATE_SETIRQ_WAIT,
 85	AP_SM_STATE_IDLE,
 86	AP_SM_STATE_WORKING,
 87	AP_SM_STATE_QUEUE_FULL,
 88	AP_SM_STATE_ASSOC_WAIT,
 89	NR_AP_SM_STATES
 90};
 91
 92/*
 93 * AP queue state machine events
 94 */
 95enum ap_sm_event {
 96	AP_SM_EVENT_POLL,
 97	AP_SM_EVENT_TIMEOUT,
 98	NR_AP_SM_EVENTS
 99};
100
101/*
102 * AP queue state wait behaviour
103 */
104enum ap_sm_wait {
105	AP_SM_WAIT_AGAIN = 0,	 /* retry immediately */
106	AP_SM_WAIT_HIGH_TIMEOUT, /* poll high freq, wait for timeout */
107	AP_SM_WAIT_LOW_TIMEOUT,	 /* poll low freq, wait for timeout */
108	AP_SM_WAIT_INTERRUPT,	 /* wait for thin interrupt (if available) */
109	AP_SM_WAIT_NONE,	 /* no wait */
110	NR_AP_SM_WAIT
111};
112
113/*
114 * AP queue device states
115 */
116enum ap_dev_state {
117	AP_DEV_STATE_UNINITIATED = 0,	/* fresh and virgin, not touched */
118	AP_DEV_STATE_OPERATING,		/* queue dev is working normal */
119	AP_DEV_STATE_SHUTDOWN,		/* remove/unbind/shutdown in progress */
120	AP_DEV_STATE_ERROR,		/* device is in error state */
121	NR_AP_DEV_STATES
122};
123
124struct ap_device;
125struct ap_message;
126
127/*
128 * The ap driver struct includes a flags field which holds some info for
129 * the ap bus about the driver. Currently only one flag is supported and
130 * used: The DEFAULT flag marks an ap driver as a default driver which is
131 * used together with the apmask and aqmask whitelisting of the ap bus.
132 */
133#define AP_DRIVER_FLAG_DEFAULT 0x0001
134
135struct ap_driver {
136	struct device_driver driver;
137	struct ap_device_id *ids;
138	unsigned int flags;
139
140	int (*probe)(struct ap_device *);
141	void (*remove)(struct ap_device *);
142	int (*in_use)(unsigned long *apm, unsigned long *aqm);
143	/*
144	 * Called at the start of the ap bus scan function when
145	 * the crypto config information (qci) has changed.
146	 * This callback is not invoked if there is no AP
147	 * QCI support available.
148	 */
149	void (*on_config_changed)(struct ap_config_info *new_config_info,
150				  struct ap_config_info *old_config_info);
151	/*
152	 * Called at the end of the ap bus scan function when
153	 * the crypto config information (qci) has changed.
154	 * This callback is not invoked if there is no AP
155	 * QCI support available.
156	 */
157	void (*on_scan_complete)(struct ap_config_info *new_config_info,
158				 struct ap_config_info *old_config_info);
159};
160
161#define to_ap_drv(x) container_of_const((x), struct ap_driver, driver)
162
163int ap_driver_register(struct ap_driver *, struct module *, char *);
164void ap_driver_unregister(struct ap_driver *);
165
166struct ap_device {
167	struct device device;
168	int device_type;		/* AP device type. */
169	const char *driver_override;
170};
171
172#define to_ap_dev(x) container_of((x), struct ap_device, device)
173
174struct ap_card {
175	struct ap_device ap_dev;
176	struct ap_tapq_hwinfo hwinfo;	/* TAPQ GR2 content */
177	int id;				/* AP card number. */
178	unsigned int maxmsgsize;	/* AP msg limit for this card */
179	bool config;			/* configured state */
180	bool chkstop;			/* checkstop state */
181	atomic64_t total_request_count;	/* # requests ever for this AP device.*/
182};
183
184#define TAPQ_CARD_HWINFO_MASK 0xFFFF0000FFFF0F0FUL
185#define ASSOC_IDX_INVALID 0x10000
186
187#define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
188
189struct ap_queue {
190	struct ap_device ap_dev;
191	struct hlist_node hnode;	/* Node for the ap_queues hashtable */
192	struct ap_card *card;		/* Ptr to assoc. AP card. */
193	spinlock_t lock;		/* Per device lock. */
194	enum ap_dev_state dev_state;	/* queue device state */
195	bool config;			/* configured state */
196	bool chkstop;			/* checkstop state */
197	ap_qid_t qid;			/* AP queue id. */
198	unsigned int se_bstate;		/* SE bind state (BS) */
199	unsigned int assoc_idx;		/* SE association index */
200	int queue_count;		/* # messages currently on AP queue. */
201	int pendingq_count;		/* # requests on pendingq list. */
202	int requestq_count;		/* # requests on requestq list. */
203	u64 total_request_count;	/* # requests ever for this AP device.*/
204	int request_timeout;		/* Request timeout in jiffies. */
205	struct timer_list timeout;	/* Timer for request timeouts. */
206	struct list_head pendingq;	/* List of message sent to AP queue. */
207	struct list_head requestq;	/* List of message yet to be sent. */
208	struct ap_message *reply;	/* Per device reply message. */
209	enum ap_sm_state sm_state;	/* ap queue state machine state */
210	int rapq_fbit;			/* fbit arg for next rapq invocation */
211	int last_err_rc;		/* last error state response code */
212};
213
214#define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
215
216typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue);
217
218struct ap_response_type {
219	struct completion work;
220	int type;
221};
222
223struct ap_message {
224	struct list_head list;		/* Request queueing. */
225	unsigned long psmid;		/* Message id. */
226	void *msg;			/* Pointer to message buffer. */
227	size_t len;			/* actual msg len in msg buffer */
228	size_t bufsize;			/* allocated msg buffer size */
229	u16 flags;			/* Flags, see AP_MSG_FLAG_xxx */
230	int rc;				/* Return code for this message */
231	struct ap_response_type response;
232	/* receive is called from tasklet context */
233	void (*receive)(struct ap_queue *, struct ap_message *,
234			struct ap_message *);
235};
236
237#define AP_MSG_FLAG_SPECIAL  0x0001	/* flag msg as 'special' with NQAP */
238#define AP_MSG_FLAG_USAGE    0x0002	/* CCA, EP11: usage (no admin) msg */
239#define AP_MSG_FLAG_ADMIN    0x0004	/* CCA, EP11: admin (=control) msg */
240#define AP_MSG_FLAG_MEMPOOL  0x0008 /* ap msg buffer allocated via mempool */
241
242int ap_init_apmsg(struct ap_message *ap_msg, u32 flags);
243void ap_release_apmsg(struct ap_message *ap_msg);
244
245enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event);
246enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event);
247
248int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
249void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
250void ap_flush_queue(struct ap_queue *aq);
251bool ap_queue_usable(struct ap_queue *aq);
252
253void *ap_airq_ptr(void);
254int ap_sb_available(void);
255bool ap_is_se_guest(void);
256void ap_wait(enum ap_sm_wait wait);
257void ap_request_timeout(struct timer_list *t);
258bool ap_bus_force_rescan(void);
259
260int ap_test_config_usage_domain(unsigned int domain);
261int ap_test_config_ctrl_domain(unsigned int domain);
262
263void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
264struct ap_queue *ap_queue_create(ap_qid_t qid, struct ap_card *ac);
265void ap_queue_prepare_remove(struct ap_queue *aq);
266void ap_queue_remove(struct ap_queue *aq);
267void ap_queue_init_state(struct ap_queue *aq);
268void _ap_queue_init_state(struct ap_queue *aq);
269
270struct ap_card *ap_card_create(int id, struct ap_tapq_hwinfo info,
271			       int comp_type);
272
273#define APMASKSIZE (BITS_TO_LONGS(AP_DEVICES) * sizeof(unsigned long))
274#define AQMASKSIZE (BITS_TO_LONGS(AP_DOMAINS) * sizeof(unsigned long))
275
276struct ap_perms {
277	unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
278	unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
279	unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
280	unsigned long adm[BITS_TO_LONGS(AP_DOMAINS)];
281};
282
283extern struct ap_perms ap_perms;
284extern bool ap_apmask_aqmask_in_use;
285extern int ap_driver_override_ctr;
286extern struct mutex ap_attr_mutex;
287
288/*
289 * Get ap_queue device for this qid.
290 * Returns ptr to the struct ap_queue device or NULL if there
291 * was no ap_queue device with this qid found. When something is
292 * found, the reference count of the embedded device is increased.
293 * So the caller has to decrease the reference count after use
294 * with a call to put_device(&aq->ap_dev.device).
295 */
296struct ap_queue *ap_get_qdev(ap_qid_t qid);
297
298/*
299 * check APQN for owned/reserved by ap bus and default driver(s).
300 * Checks if this APQN is or will be in use by the ap bus
301 * and the default set of drivers.
302 * If yes, returns 1, if not returns 0. On error a negative
303 * errno value is returned.
304 */
305int ap_owned_by_def_drv(int card, int queue);
306
307/*
308 * check 'matrix' of APQNs for owned/reserved by ap bus and
309 * default driver(s).
310 * Checks if there is at least one APQN in the given 'matrix'
311 * marked as owned/reserved by the ap bus and default driver(s).
312 * If such an APQN is found the return value is 1, otherwise
313 * 0 is returned. On error a negative errno value is returned.
314 * The parameter apm is a bitmask which should be declared
315 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
316 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
317 */
318int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
319				       unsigned long *aqm);
320
321/*
322 * ap_parse_mask_str() - helper function to parse a bitmap string
323 * and clear/set the bits in the bitmap accordingly. The string may be
324 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
325 * overwriting the current content of the bitmap. Or as relative string
326 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
327 * bits are cleared or set. Distinction is done based on the very
328 * first character which may be '+' or '-' for the relative string
329 * and otherwise assume to be an absolute value string. If parsing fails
330 * a negative errno value is returned. All arguments and bitmaps are
331 * big endian order.
332 */
333int ap_parse_mask_str(const char *str,
334		      unsigned long *bitmap, int bits,
335		      struct mutex *lock);
336
337/*
338 * ap_hex2bitmap() - Convert a string containing a hexadecimal number (str)
339 * into a bitmap (bitmap) with bits set that correspond to the bits represented
340 * by the hex string. Input and output data is in big endian order.
341 *
342 * str - Input hex string of format "0x1234abcd". The leading "0x" is optional.
343 * At least one digit is required. Must be large enough to hold the number of
344 * bits represented by the bits parameter.
345 *
346 * bitmap - Pointer to a bitmap. Upon successful completion of this function,
347 * this bitmap will have bits set to match the value of str. If bitmap is longer
348 * than str, then the rightmost bits of bitmap are padded with zeros. Must be
349 * large enough to hold the number of bits represented by the bits parameter.
350 *
351 * bits - Length, in bits, of the bitmap represented by str. Must be a multiple
352 * of 8.
353 *
354 * Returns: 0		On success
355 *	    -EINVAL	If str format is invalid or bits is not a multiple of 8.
356 */
357int ap_hex2bitmap(const char *str, unsigned long *bitmap, int bits);
358
359/*
360 * Interface to wait for the AP bus to have done one initial ap bus
361 * scan and all detected APQNs have been bound to device drivers.
362 * If these both conditions are not fulfilled, this function blocks
363 * on a condition with wait_for_completion_killable_timeout().
364 * If these both conditions are fulfilled (before the timeout hits)
365 * the return value is 0. If the timeout (in jiffies) hits instead
366 * -ETIME is returned. On failures negative return values are
367 * returned to the caller.
368 * It may be that the AP bus scan finds new devices. Then the
369 * condition that all APQNs are bound to their device drivers
370 * is reset to false and this call again blocks until either all
371 * APQNs are bound to a device driver or the timeout hits again.
372 */
373int ap_wait_apqn_bindings_complete(unsigned long timeout);
374
375void ap_send_config_uevent(struct ap_device *ap_dev, bool cfg);
376void ap_send_online_uevent(struct ap_device *ap_dev, int online);
377
378#endif /* _AP_BUS_H_ */