blob: 5029b80132aae638b2428d8f0fed2f5e42650926 [file] [log] [blame]
Harald Freudenbergerac2b96f2018-08-17 12:36:01 +02001/* SPDX-License-Identifier: GPL-2.0+ */
Martin Schwidefsky1534c382006-09-20 15:58:25 +02002/*
Harald Freudenbergercf2957f2019-08-16 11:05:58 +02003 * Copyright IBM Corp. 2006, 2019
Martin Schwidefsky1534c382006-09-20 15:58:25 +02004 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
5 * Martin Schwidefsky <schwidefsky@de.ibm.com>
6 * Ralph Wuerthner <rwuerthn@de.ibm.com>
Felix Beckcb17a632008-12-25 13:38:41 +01007 * Felix Beck <felix.beck@de.ibm.com>
Holger Dengler6bed05b2011-07-24 10:48:25 +02008 * Holger Dengler <hd@linux.vnet.ibm.com>
Martin Schwidefsky1534c382006-09-20 15:58:25 +02009 *
10 * Adjunct processor bus header file.
Martin Schwidefsky1534c382006-09-20 15:58:25 +020011 */
12
13#ifndef _AP_BUS_H_
14#define _AP_BUS_H_
15
16#include <linux/device.h>
Martin Schwidefsky1534c382006-09-20 15:58:25 +020017#include <linux/types.h>
Harald Freudenbergerbc4b2952020-05-08 15:51:19 +020018#include <linux/hashtable.h>
Harald Freudenbergerf1b0a4342018-06-12 15:42:36 +020019#include <asm/isc.h>
Tony Krowiake7fc5142016-11-08 07:09:13 +010020#include <asm/ap.h>
Martin Schwidefsky1534c382006-09-20 15:58:25 +020021
Harald Freudenbergeraf4a7222018-04-09 16:18:37 +020022#define AP_DEVICES 256 /* Number of AP devices. */
Ingo Tuchscherer170387a2014-09-08 13:24:13 +020023#define AP_DOMAINS 256 /* Number of AP domains. */
Harald Freudenberger00fab232018-09-17 16:18:41 +020024#define AP_IOCTLS 256 /* Number of ioctls. */
Ingo Tuchscherer91f3e3ea2013-11-20 10:47:13 +010025#define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */
Martin Schwidefsky1534c382006-09-20 15:58:25 +020026#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
29extern int ap_domain_index;
30
Harald Freudenbergerbc4b2952020-05-08 15:51:19 +020031extern DECLARE_HASHTABLE(ap_queues, 8);
32extern spinlock_t ap_queues_lock;
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +020033
Holger Dengler75014552012-08-28 16:41:50 +020034static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
Holger Dengler6bed05b2011-07-24 10:48:25 +020035{
Holger Dengler75014552012-08-28 16:41:50 +020036 return (*ptr & (0x80000000u >> nr)) != 0;
Holger Dengler6bed05b2011-07-24 10:48:25 +020037}
Martin Schwidefsky1534c382006-09-20 15:58:25 +020038
39#define AP_RESPONSE_NORMAL 0x00
40#define AP_RESPONSE_Q_NOT_AVAIL 0x01
41#define AP_RESPONSE_RESET_IN_PROGRESS 0x02
42#define AP_RESPONSE_DECONFIGURED 0x03
43#define AP_RESPONSE_CHECKSTOPPED 0x04
44#define AP_RESPONSE_BUSY 0x05
Felix Beckcb17a632008-12-25 13:38:41 +010045#define AP_RESPONSE_INVALID_ADDRESS 0x06
46#define AP_RESPONSE_OTHERWISE_CHANGED 0x07
Martin Schwidefsky1534c382006-09-20 15:58:25 +020047#define AP_RESPONSE_Q_FULL 0x10
48#define AP_RESPONSE_NO_PENDING_REPLY 0x10
49#define AP_RESPONSE_INDEX_TOO_BIG 0x11
50#define AP_RESPONSE_NO_FIRST_PART 0x13
51#define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
Felix Becka6a5d732009-12-07 12:51:55 +010052#define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
Harald Freudenbergere0332622020-08-04 09:27:47 +020053#define AP_RESPONSE_INVALID_DOMAIN 0x42
Martin Schwidefsky1534c382006-09-20 15:58:25 +020054
Felix Beck1749a812008-04-17 07:46:28 +020055/*
Martin Schwidefsky1534c382006-09-20 15:58:25 +020056 * Known device types
57 */
58#define AP_DEVICE_TYPE_PCICC 3
59#define AP_DEVICE_TYPE_PCICA 4
60#define AP_DEVICE_TYPE_PCIXCC 5
61#define AP_DEVICE_TYPE_CEX2A 6
62#define AP_DEVICE_TYPE_CEX2C 7
Felix Beckffda4f72009-12-07 12:51:56 +010063#define AP_DEVICE_TYPE_CEX3A 8
64#define AP_DEVICE_TYPE_CEX3C 9
Holger Dengler1e2076f2012-08-28 16:48:29 +020065#define AP_DEVICE_TYPE_CEX4 10
Ingo Tuchschererbdea1f1b2015-01-23 14:56:25 +010066#define AP_DEVICE_TYPE_CEX5 11
Harald Freudenbergerb3e86522016-10-12 15:58:14 +020067#define AP_DEVICE_TYPE_CEX6 12
Harald Freudenbergercf2957f2019-08-16 11:05:58 +020068#define AP_DEVICE_TYPE_CEX7 13
Martin Schwidefsky1534c382006-09-20 15:58:25 +020069
Felix Beck1749a812008-04-17 07:46:28 +020070/*
Holger Denglerb26bd942012-08-28 16:43:48 +020071 * Known function facilities
72 */
73#define AP_FUNC_MEX4K 1
74#define AP_FUNC_CRT4K 2
75#define AP_FUNC_COPRO 3
76#define AP_FUNC_ACCEL 4
Ingo Tuchscherer91f3e3ea2013-11-20 10:47:13 +010077#define AP_FUNC_EP11 5
78#define AP_FUNC_APXA 6
Holger Denglerb26bd942012-08-28 16:43:48 +020079
80/*
Ingo Tuchschererc50a1602015-06-17 16:19:15 +020081 * AP interrupt states
82 */
83#define AP_INTR_DISABLED 0 /* AP interrupt disabled */
84#define AP_INTR_ENABLED 1 /* AP interrupt enabled */
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +020085
86/*
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +020087 * AP queue state machine states
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +020088 */
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +020089enum ap_sm_state {
Harald Freudenberger0b641cb2020-07-02 11:22:01 +020090 AP_SM_STATE_RESET_START = 0,
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +020091 AP_SM_STATE_RESET_WAIT,
92 AP_SM_STATE_SETIRQ_WAIT,
93 AP_SM_STATE_IDLE,
94 AP_SM_STATE_WORKING,
95 AP_SM_STATE_QUEUE_FULL,
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +020096 NR_AP_SM_STATES
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +020097};
98
99/*
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200100 * AP queue state machine events
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +0200101 */
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200102enum ap_sm_event {
103 AP_SM_EVENT_POLL,
104 AP_SM_EVENT_TIMEOUT,
105 NR_AP_SM_EVENTS
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +0200106};
107
108/*
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200109 * AP queue state wait behaviour
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +0200110 */
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200111enum ap_sm_wait {
112 AP_SM_WAIT_AGAIN, /* retry immediately */
113 AP_SM_WAIT_TIMEOUT, /* wait for timeout */
114 AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */
115 AP_SM_WAIT_NONE, /* no wait */
116 NR_AP_SM_WAIT
Martin Schwidefsky3f3007a2015-09-14 17:01:23 +0200117};
Ralph Wuerthneraf512ed02007-07-10 11:24:19 +0200118
Harald Freudenberger0b641cb2020-07-02 11:22:01 +0200119/*
120 * AP queue device states
121 */
122enum ap_dev_state {
123 AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */
124 AP_DEV_STATE_OPERATING, /* queue dev is working normal */
125 AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */
126 AP_DEV_STATE_ERROR, /* device is in error state */
127 NR_AP_DEV_STATES
128};
129
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200130struct ap_device;
131struct ap_message;
132
Harald Freudenberger7e0bdbe2018-07-20 08:36:53 +0200133/*
134 * The ap driver struct includes a flags field which holds some info for
135 * the ap bus about the driver. Currently only one flag is supported and
136 * used: The DEFAULT flag marks an ap driver as a default driver which is
137 * used together with the apmask and aqmask whitelisting of the ap bus.
138 */
139#define AP_DRIVER_FLAG_DEFAULT 0x0001
140
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200141struct ap_driver {
142 struct device_driver driver;
143 struct ap_device_id *ids;
Harald Freudenberger7e0bdbe2018-07-20 08:36:53 +0200144 unsigned int flags;
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200145
146 int (*probe)(struct ap_device *);
147 void (*remove)(struct ap_device *);
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200148};
149
150#define to_ap_drv(x) container_of((x), struct ap_driver, driver)
151
152int ap_driver_register(struct ap_driver *, struct module *, char *);
153void ap_driver_unregister(struct ap_driver *);
154
155struct ap_device {
156 struct device device;
157 struct ap_driver *drv; /* Pointer to AP device driver. */
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200158 int device_type; /* AP device type. */
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200159};
160
161#define to_ap_dev(x) container_of((x), struct ap_device, device)
162
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200163struct ap_card {
164 struct ap_device ap_dev;
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200165 void *private; /* ap driver private pointer. */
166 int raw_hwtype; /* AP raw hardware type. */
167 unsigned int functions; /* AP device function bitfield. */
168 int queue_depth; /* AP queue depth.*/
169 int id; /* AP card number. */
Harald Freudenberger4f2fccc2020-07-02 16:57:00 +0200170 bool config; /* configured state */
Harald Freudenbergerfcd98d42019-12-20 16:02:54 +0100171 atomic64_t total_request_count; /* # requests ever for this AP device.*/
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200172};
173
174#define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
175
176struct ap_queue {
177 struct ap_device ap_dev;
Harald Freudenbergerbc4b2952020-05-08 15:51:19 +0200178 struct hlist_node hnode; /* Node for the ap_queues hashtable */
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200179 struct ap_card *card; /* Ptr to assoc. AP card. */
180 spinlock_t lock; /* Per device lock. */
181 void *private; /* ap driver private pointer. */
Harald Freudenberger0b641cb2020-07-02 11:22:01 +0200182 enum ap_dev_state dev_state; /* queue device state */
Harald Freudenberger4f2fccc2020-07-02 16:57:00 +0200183 bool config; /* configured state */
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200184 ap_qid_t qid; /* AP queue id. */
185 int interrupt; /* indicate if interrupts are enabled */
186 int queue_count; /* # messages currently on AP queue. */
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200187 int pendingq_count; /* # requests on pendingq list. */
188 int requestq_count; /* # requests on requestq list. */
Harald Freudenbergerfcd98d42019-12-20 16:02:54 +0100189 u64 total_request_count; /* # requests ever for this AP device.*/
Harald Freudenbergerac2b96f2018-08-17 12:36:01 +0200190 int request_timeout; /* Request timeout in jiffies. */
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200191 struct timer_list timeout; /* Timer for request timeouts. */
192 struct list_head pendingq; /* List of message sent to AP queue. */
193 struct list_head requestq; /* List of message yet to be sent. */
194 struct ap_message *reply; /* Per device reply message. */
Harald Freudenberger0b641cb2020-07-02 11:22:01 +0200195 enum ap_sm_state sm_state; /* ap queue state machine state */
Harald Freudenberger2ea2a602020-07-02 15:56:15 +0200196 int last_err_rc; /* last error state response code */
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200197};
198
199#define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
200
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200201typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue);
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200202
Harald Freudenberger27c4f672020-09-29 16:07:22 +0200203/* failure injection cmd struct */
204struct ap_fi {
205 union {
206 u16 cmd; /* fi flags + action */
207 struct {
208 u8 flags; /* fi flags only */
209 u8 action; /* fi action only */
210 };
211 };
212};
213
214/* all currently known fi actions */
215enum ap_fi_actions {
216 AP_FI_ACTION_CCA_AGENT_FF = 0x01,
217 AP_FI_ACTION_CCA_DOM_INVAL = 0x02,
218 AP_FI_ACTION_NQAP_QID_INVAL = 0x03,
219};
220
221/* all currently known fi flags */
222enum ap_fi_flags {
223 AP_FI_FLAG_NO_RETRY = 0x01,
224 AP_FI_FLAG_TOGGLE_SPECIAL = 0x02,
225};
226
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200227struct ap_message {
228 struct list_head list; /* Request queueing. */
229 unsigned long long psmid; /* Message id. */
Harald Freudenberger74ecbef2020-04-30 12:23:29 +0200230 void *msg; /* Pointer to message buffer. */
231 unsigned int len; /* Message length. */
Harald Freudenberger27c4f672020-09-29 16:07:22 +0200232 u16 flags; /* Flags, see AP_MSG_FLAG_xxx */
233 struct ap_fi fi; /* Failure Injection cmd */
Martin Schwidefskyf58fe332015-09-14 16:59:27 +0200234 int rc; /* Return code for this message */
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200235 void *private; /* ap driver private pointer. */
Holger Dengler54a8f562012-05-16 14:08:22 +0200236 /* receive is called from tasklet context */
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200237 void (*receive)(struct ap_queue *, struct ap_message *,
Holger Dengler54a8f562012-05-16 14:08:22 +0200238 struct ap_message *);
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200239};
240
Harald Freudenberger27c4f672020-09-29 16:07:22 +0200241#define AP_MSG_FLAG_SPECIAL 1 /* flag msg as 'special' with NQAP */
Harald Freudenberger74ecbef2020-04-30 12:23:29 +0200242
Felix Beck468ffdd2009-12-07 12:51:54 +0100243/**
244 * ap_init_message() - Initialize ap_message.
245 * Initialize a message before using. Otherwise this might result in
246 * unexpected behaviour.
247 */
248static inline void ap_init_message(struct ap_message *ap_msg)
249{
Harald Freudenberger89a0c0e2018-05-28 13:00:42 +0200250 memset(ap_msg, 0, sizeof(*ap_msg));
251}
252
253/**
254 * ap_release_message() - Release ap_message.
255 * Releases all memory used internal within the ap_message struct
256 * Currently this is the message and private field.
257 */
258static inline void ap_release_message(struct ap_message *ap_msg)
259{
Waiman Long453431a2020-08-06 23:18:13 -0700260 kfree_sensitive(ap_msg->msg);
261 kfree_sensitive(ap_msg->private);
Felix Beck468ffdd2009-12-07 12:51:54 +0100262}
263
Felix Beck1749a812008-04-17 07:46:28 +0200264/*
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200265 * Note: don't use ap_send/ap_recv after using ap_queue_message
266 * for the first time. Otherwise the ap message queue will get
267 * confused.
268 */
269int ap_send(ap_qid_t, unsigned long long, void *, size_t);
270int ap_recv(ap_qid_t, unsigned long long *, void *, size_t);
271
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200272enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event);
273enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event);
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200274
Harald Freudenberger0b641cb2020-07-02 11:22:01 +0200275int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200276void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
277void ap_flush_queue(struct ap_queue *aq);
278
279void *ap_airq_ptr(void);
Harald Freudenbergerdc4b6de2020-05-26 10:49:33 +0200280void ap_wait(enum ap_sm_wait wait);
Kees Cookcefbeb52017-10-25 03:27:37 -0700281void ap_request_timeout(struct timer_list *t);
Holger Denglerdabecb22012-09-10 21:34:26 +0200282void ap_bus_force_rescan(void);
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200283
Harald Freudenberger7379e652019-05-21 13:50:09 +0200284int ap_test_config_usage_domain(unsigned int domain);
285int ap_test_config_ctrl_domain(unsigned int domain);
286
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200287void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
288struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
Harald Freudenberger01396a32019-02-22 17:24:11 +0100289void ap_queue_prepare_remove(struct ap_queue *aq);
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200290void ap_queue_remove(struct ap_queue *aq);
Harald Freudenberger0c874cd2019-11-22 16:30:06 +0100291void ap_queue_init_state(struct ap_queue *aq);
Ingo Tuchscherere28d2af2016-08-25 11:16:03 +0200292
Harald Freudenberger9a564102017-10-16 12:28:35 +0200293struct ap_card *ap_card_create(int id, int queue_depth, int raw_device_type,
294 int comp_device_type, unsigned int functions);
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200295
Harald Freudenberger00fab232018-09-17 16:18:41 +0200296struct ap_perms {
297 unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
298 unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
299 unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
300};
301extern struct ap_perms ap_perms;
302extern struct mutex ap_perms_mutex;
303
Harald Freudenberger7e0bdbe2018-07-20 08:36:53 +0200304/*
Harald Freudenbergerbc4b2952020-05-08 15:51:19 +0200305 * Get ap_queue device for this qid.
306 * Returns ptr to the struct ap_queue device or NULL if there
307 * was no ap_queue device with this qid found. When something is
308 * found, the reference count of the embedded device is increased.
309 * So the caller has to decrease the reference count after use
310 * with a call to put_device(&aq->ap_dev.device).
311 */
312struct ap_queue *ap_get_qdev(ap_qid_t qid);
313
314/*
Harald Freudenberger7e0bdbe2018-07-20 08:36:53 +0200315 * check APQN for owned/reserved by ap bus and default driver(s).
316 * Checks if this APQN is or will be in use by the ap bus
317 * and the default set of drivers.
318 * If yes, returns 1, if not returns 0. On error a negative
319 * errno value is returned.
320 */
321int ap_owned_by_def_drv(int card, int queue);
322
323/*
324 * check 'matrix' of APQNs for owned/reserved by ap bus and
325 * default driver(s).
326 * Checks if there is at least one APQN in the given 'matrix'
327 * marked as owned/reserved by the ap bus and default driver(s).
328 * If such an APQN is found the return value is 1, otherwise
329 * 0 is returned. On error a negative errno value is returned.
330 * The parameter apm is a bitmask which should be declared
331 * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
332 * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
333 */
334int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
335 unsigned long *aqm);
336
Harald Freudenberger00fab232018-09-17 16:18:41 +0200337/*
338 * ap_parse_mask_str() - helper function to parse a bitmap string
339 * and clear/set the bits in the bitmap accordingly. The string may be
340 * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
341 * overwriting the current content of the bitmap. Or as relative string
342 * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
343 * bits are cleared or set. Distinction is done based on the very
344 * first character which may be '+' or '-' for the relative string
345 * and othewise assume to be an absolute value string. If parsing fails
346 * a negative errno value is returned. All arguments and bitmaps are
347 * big endian order.
348 */
349int ap_parse_mask_str(const char *str,
350 unsigned long *bitmap, int bits,
351 struct mutex *lock);
352
Martin Schwidefsky1534c382006-09-20 15:58:25 +0200353#endif /* _AP_BUS_H_ */