1 /* SPDX-License-Identifier: GPL-2.0+ */
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>
10 * Adjunct processor bus header file.
16 #include <linux/device.h>
17 #include <linux/types.h>
18 #include <linux/hashtable.h>
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)
31 extern int ap_domain_index;
32 extern atomic_t ap_max_msg_size;
34 extern DECLARE_HASHTABLE(ap_queues, 8);
35 extern spinlock_t ap_queues_lock;
37 static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
39 return (*ptr & (0x80000000u >> nr)) != 0;
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
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
75 * Known function facilities
77 #define AP_FUNC_MEX4K 1
78 #define AP_FUNC_CRT4K 2
79 #define AP_FUNC_COPRO 3
80 #define AP_FUNC_ACCEL 4
81 #define AP_FUNC_EP11 5
82 #define AP_FUNC_APXA 6
85 * AP queue state machine states
88 AP_SM_STATE_RESET_START = 0,
89 AP_SM_STATE_RESET_WAIT,
90 AP_SM_STATE_SETIRQ_WAIT,
93 AP_SM_STATE_QUEUE_FULL,
98 * AP queue state machine events
107 * AP queue state wait behaviour
110 AP_SM_WAIT_AGAIN = 0, /* retry immediately */
111 AP_SM_WAIT_TIMEOUT, /* wait for timeout */
112 AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */
113 AP_SM_WAIT_NONE, /* no wait */
118 * AP queue device states
121 AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */
122 AP_DEV_STATE_OPERATING, /* queue dev is working normal */
123 AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */
124 AP_DEV_STATE_ERROR, /* device is in error state */
132 * The ap driver struct includes a flags field which holds some info for
133 * the ap bus about the driver. Currently only one flag is supported and
134 * used: The DEFAULT flag marks an ap driver as a default driver which is
135 * used together with the apmask and aqmask whitelisting of the ap bus.
137 #define AP_DRIVER_FLAG_DEFAULT 0x0001
140 struct device_driver driver;
141 struct ap_device_id *ids;
144 int (*probe)(struct ap_device *);
145 void (*remove)(struct ap_device *);
146 int (*in_use)(unsigned long *apm, unsigned long *aqm);
148 * Called at the start of the ap bus scan function when
149 * the crypto config information (qci) has changed.
151 void (*on_config_changed)(struct ap_config_info *new_config_info,
152 struct ap_config_info *old_config_info);
154 * Called at the end of the ap bus scan function when
155 * the crypto config information (qci) has changed.
157 void (*on_scan_complete)(struct ap_config_info *new_config_info,
158 struct ap_config_info *old_config_info);
161 #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
163 int ap_driver_register(struct ap_driver *, struct module *, char *);
164 void ap_driver_unregister(struct ap_driver *);
167 struct device device;
168 int device_type; /* AP device type. */
171 #define to_ap_dev(x) container_of((x), struct ap_device, device)
174 struct ap_device ap_dev;
175 int raw_hwtype; /* AP raw hardware type. */
176 unsigned int functions; /* AP device function bitfield. */
177 int queue_depth; /* AP queue depth.*/
178 int id; /* AP card number. */
179 unsigned int maxmsgsize; /* AP msg limit for this card */
180 bool config; /* configured state */
181 atomic64_t total_request_count; /* # requests ever for this AP device.*/
184 #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
187 struct ap_device ap_dev;
188 struct hlist_node hnode; /* Node for the ap_queues hashtable */
189 struct ap_card *card; /* Ptr to assoc. AP card. */
190 spinlock_t lock; /* Per device lock. */
191 enum ap_dev_state dev_state; /* queue device state */
192 bool config; /* configured state */
193 ap_qid_t qid; /* AP queue id. */
194 bool interrupt; /* indicate if interrupts are enabled */
195 int queue_count; /* # messages currently on AP queue. */
196 int pendingq_count; /* # requests on pendingq list. */
197 int requestq_count; /* # requests on requestq list. */
198 u64 total_request_count; /* # requests ever for this AP device.*/
199 int request_timeout; /* Request timeout in jiffies. */
200 struct timer_list timeout; /* Timer for request timeouts. */
201 struct list_head pendingq; /* List of message sent to AP queue. */
202 struct list_head requestq; /* List of message yet to be sent. */
203 struct ap_message *reply; /* Per device reply message. */
204 enum ap_sm_state sm_state; /* ap queue state machine state */
205 int last_err_rc; /* last error state response code */
208 #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
210 typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue);
212 /* failure injection cmd struct */
215 u16 cmd; /* fi flags + action */
217 u8 flags; /* fi flags only */
218 u8 action; /* fi action only */
223 /* all currently known fi actions */
225 AP_FI_ACTION_CCA_AGENT_FF = 0x01,
226 AP_FI_ACTION_CCA_DOM_INVAL = 0x02,
227 AP_FI_ACTION_NQAP_QID_INVAL = 0x03,
230 /* all currently known fi flags */
232 AP_FI_FLAG_NO_RETRY = 0x01,
233 AP_FI_FLAG_TOGGLE_SPECIAL = 0x02,
237 struct list_head list; /* Request queueing. */
238 unsigned long long psmid; /* Message id. */
239 void *msg; /* Pointer to message buffer. */
240 unsigned int len; /* actual msg len in msg buffer */
241 unsigned int bufsize; /* allocated msg buffer size */
242 u16 flags; /* Flags, see AP_MSG_FLAG_xxx */
243 struct ap_fi fi; /* Failure Injection cmd */
244 int rc; /* Return code for this message */
245 void *private; /* ap driver private pointer. */
246 /* receive is called from tasklet context */
247 void (*receive)(struct ap_queue *, struct ap_message *,
248 struct ap_message *);
251 #define AP_MSG_FLAG_SPECIAL 1 /* flag msg as 'special' with NQAP */
254 * ap_init_message() - Initialize ap_message.
255 * Initialize a message before using. Otherwise this might result in
256 * unexpected behaviour.
258 static inline void ap_init_message(struct ap_message *ap_msg)
260 memset(ap_msg, 0, sizeof(*ap_msg));
264 * ap_release_message() - Release ap_message.
265 * Releases all memory used internal within the ap_message struct
266 * Currently this is the message and private field.
268 static inline void ap_release_message(struct ap_message *ap_msg)
270 kfree_sensitive(ap_msg->msg);
271 kfree_sensitive(ap_msg->private);
275 * Note: don't use ap_send/ap_recv after using ap_queue_message
276 * for the first time. Otherwise the ap message queue will get
279 int ap_send(ap_qid_t, unsigned long long, void *, size_t);
280 int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
282 enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event);
283 enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event);
285 int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
286 void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
287 void ap_flush_queue(struct ap_queue *aq);
289 void *ap_airq_ptr(void);
290 void ap_wait(enum ap_sm_wait wait);
291 void ap_request_timeout(struct timer_list *t);
292 void ap_bus_force_rescan(void);
294 int ap_test_config_usage_domain(unsigned int domain);
295 int ap_test_config_ctrl_domain(unsigned int domain);
297 void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
298 struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
299 void ap_queue_prepare_remove(struct ap_queue *aq);
300 void ap_queue_remove(struct ap_queue *aq);
301 void ap_queue_init_state(struct ap_queue *aq);
303 struct ap_card *ap_card_create(int id, int queue_depth, int raw_type,
304 int comp_type, unsigned int functions, int ml);
306 #define APMASKSIZE (BITS_TO_LONGS(AP_DEVICES) * sizeof(unsigned long))
307 #define AQMASKSIZE (BITS_TO_LONGS(AP_DOMAINS) * sizeof(unsigned long))
310 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
311 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
312 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
314 extern struct ap_perms ap_perms;
315 extern struct mutex ap_perms_mutex;
318 * Get ap_queue device for this qid.
319 * Returns ptr to the struct ap_queue device or NULL if there
320 * was no ap_queue device with this qid found. When something is
321 * found, the reference count of the embedded device is increased.
322 * So the caller has to decrease the reference count after use
323 * with a call to put_device(&aq->ap_dev.device).
325 struct ap_queue *ap_get_qdev(ap_qid_t qid);
328 * check APQN for owned/reserved by ap bus and default driver(s).
329 * Checks if this APQN is or will be in use by the ap bus
330 * and the default set of drivers.
331 * If yes, returns 1, if not returns 0. On error a negative
332 * errno value is returned.
334 int ap_owned_by_def_drv(int card, int queue);
337 * check 'matrix' of APQNs for owned/reserved by ap bus and
339 * Checks if there is at least one APQN in the given 'matrix'
340 * marked as owned/reserved by the ap bus and default driver(s).
341 * If such an APQN is found the return value is 1, otherwise
342 * 0 is returned. On error a negative errno value is returned.
343 * The parameter apm is a bitmask which should be declared
344 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
345 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
347 int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
351 * ap_parse_mask_str() - helper function to parse a bitmap string
352 * and clear/set the bits in the bitmap accordingly. The string may be
353 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
354 * overwriting the current content of the bitmap. Or as relative string
355 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
356 * bits are cleared or set. Distinction is done based on the very
357 * first character which may be '+' or '-' for the relative string
358 * and othewise assume to be an absolute value string. If parsing fails
359 * a negative errno value is returned. All arguments and bitmaps are
362 int ap_parse_mask_str(const char *str,
363 unsigned long *bitmap, int bits,
367 * Interface to wait for the AP bus to have done one initial ap bus
368 * scan and all detected APQNs have been bound to device drivers.
369 * If these both conditions are not fulfilled, this function blocks
370 * on a condition with wait_for_completion_killable_timeout().
371 * If these both conditions are fulfilled (before the timeout hits)
372 * the return value is 0. If the timeout (in jiffies) hits instead
373 * -ETIME is returned. On failures negative return values are
374 * returned to the caller.
376 int ap_wait_init_apqn_bindings_complete(unsigned long timeout);
378 void ap_send_config_uevent(struct ap_device *ap_dev, bool cfg);
379 void ap_send_online_uevent(struct ap_device *ap_dev, int online);
381 #endif /* _AP_BUS_H_ */