1ac2b96f3SHarald Freudenberger /* SPDX-License-Identifier: GPL-2.0+ */
21534c382SMartin Schwidefsky /*
35ac8c724SHarald Freudenberger * Copyright IBM Corp. 2006, 2023
41534c382SMartin Schwidefsky * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
51534c382SMartin Schwidefsky * Martin Schwidefsky <schwidefsky@de.ibm.com>
61534c382SMartin Schwidefsky * Ralph Wuerthner <rwuerthn@de.ibm.com>
7cb17a636SFelix Beck * Felix Beck <felix.beck@de.ibm.com>
86bed05bcSHolger Dengler * Holger Dengler <hd@linux.vnet.ibm.com>
91534c382SMartin Schwidefsky *
101534c382SMartin Schwidefsky * Adjunct processor bus header file.
111534c382SMartin Schwidefsky */
121534c382SMartin Schwidefsky
131534c382SMartin Schwidefsky #ifndef _AP_BUS_H_
141534c382SMartin Schwidefsky #define _AP_BUS_H_
151534c382SMartin Schwidefsky
161534c382SMartin Schwidefsky #include <linux/device.h>
171534c382SMartin Schwidefsky #include <linux/types.h>
18bc4b295eSHarald Freudenberger #include <linux/hashtable.h>
19f1b0a434SHarald Freudenberger #include <asm/isc.h>
20e7fc5146STony Krowiak #include <asm/ap.h>
211534c382SMartin Schwidefsky
22af4a7227SHarald Freudenberger #define AP_DEVICES 256 /* Number of AP devices. */
23170387a8SIngo Tuchscherer #define AP_DOMAINS 256 /* Number of AP domains. */
2400fab235SHarald Freudenberger #define AP_IOCTLS 256 /* Number of ioctls. */
2591f3e3eaSIngo Tuchscherer #define AP_RESET_TIMEOUT (HZ*0.7) /* Time in ticks for reset timeouts. */
261534c382SMartin Schwidefsky #define AP_CONFIG_TIME 30 /* Time in seconds between AP bus rescans. */
271534c382SMartin Schwidefsky #define AP_POLL_TIME 1 /* Time in ticks between receive polls. */
28bd39654aSHarald Freudenberger #define AP_DEFAULT_MAX_MSG_SIZE (12 * 1024)
29bd39654aSHarald Freudenberger #define AP_TAPQ_ML_FIELD_CHUNK_SIZE (4096)
301534c382SMartin Schwidefsky
311534c382SMartin Schwidefsky extern int ap_domain_index;
32bd39654aSHarald Freudenberger extern atomic_t ap_max_msg_size;
331534c382SMartin Schwidefsky
34bc4b295eSHarald Freudenberger extern DECLARE_HASHTABLE(ap_queues, 8);
35bc4b295eSHarald Freudenberger extern spinlock_t ap_queues_lock;
36e28d2af4SIngo Tuchscherer
ap_test_bit(unsigned int * ptr,unsigned int nr)3775014550SHolger Dengler static inline int ap_test_bit(unsigned int *ptr, unsigned int nr)
386bed05bcSHolger Dengler {
3975014550SHolger Dengler return (*ptr & (0x80000000u >> nr)) != 0;
406bed05bcSHolger Dengler }
411534c382SMartin Schwidefsky
421534c382SMartin Schwidefsky #define AP_RESPONSE_NORMAL 0x00
431534c382SMartin Schwidefsky #define AP_RESPONSE_Q_NOT_AVAIL 0x01
441534c382SMartin Schwidefsky #define AP_RESPONSE_RESET_IN_PROGRESS 0x02
451534c382SMartin Schwidefsky #define AP_RESPONSE_DECONFIGURED 0x03
461534c382SMartin Schwidefsky #define AP_RESPONSE_CHECKSTOPPED 0x04
471534c382SMartin Schwidefsky #define AP_RESPONSE_BUSY 0x05
48cb17a636SFelix Beck #define AP_RESPONSE_INVALID_ADDRESS 0x06
49cb17a636SFelix Beck #define AP_RESPONSE_OTHERWISE_CHANGED 0x07
50783f0a3cSTony Krowiak #define AP_RESPONSE_INVALID_GISA 0x08
512d72eaf0SHarald Freudenberger #define AP_RESPONSE_Q_BOUND_TO_ANOTHER 0x09
522d72eaf0SHarald Freudenberger #define AP_RESPONSE_STATE_CHANGE_IN_PROGRESS 0x0A
532d72eaf0SHarald Freudenberger #define AP_RESPONSE_Q_NOT_BOUND 0x0B
541534c382SMartin Schwidefsky #define AP_RESPONSE_Q_FULL 0x10
551534c382SMartin Schwidefsky #define AP_RESPONSE_NO_PENDING_REPLY 0x10
561534c382SMartin Schwidefsky #define AP_RESPONSE_INDEX_TOO_BIG 0x11
571534c382SMartin Schwidefsky #define AP_RESPONSE_NO_FIRST_PART 0x13
581534c382SMartin Schwidefsky #define AP_RESPONSE_MESSAGE_TOO_BIG 0x15
59a6a5d73aSFelix Beck #define AP_RESPONSE_REQ_FAC_NOT_INST 0x16
602d72eaf0SHarald Freudenberger #define AP_RESPONSE_Q_BIND_ERROR 0x30
612d72eaf0SHarald Freudenberger #define AP_RESPONSE_Q_NOT_AVAIL_FOR_ASSOC 0x31
622d72eaf0SHarald Freudenberger #define AP_RESPONSE_Q_NOT_EMPTY 0x32
632d72eaf0SHarald Freudenberger #define AP_RESPONSE_BIND_LIMIT_EXCEEDED 0x33
642d72eaf0SHarald Freudenberger #define AP_RESPONSE_INVALID_ASSOC_SECRET 0x34
652d72eaf0SHarald Freudenberger #define AP_RESPONSE_ASSOC_SECRET_NOT_UNIQUE 0x35
662d72eaf0SHarald Freudenberger #define AP_RESPONSE_ASSOC_FAILED 0x36
67e0332629SHarald Freudenberger #define AP_RESPONSE_INVALID_DOMAIN 0x42
681534c382SMartin Schwidefsky
691749a81dSFelix Beck /*
705ac8c724SHarald Freudenberger * Supported AP device types
711534c382SMartin Schwidefsky */
721e2076f4SHolger Dengler #define AP_DEVICE_TYPE_CEX4 10
73bdea1f1bSIngo Tuchscherer #define AP_DEVICE_TYPE_CEX5 11
74b3e8652bSHarald Freudenberger #define AP_DEVICE_TYPE_CEX6 12
75cf2957f3SHarald Freudenberger #define AP_DEVICE_TYPE_CEX7 13
76985214afSHarald Freudenberger #define AP_DEVICE_TYPE_CEX8 14
771534c382SMartin Schwidefsky
781749a81dSFelix Beck /*
79b26bd941SHolger Dengler * Known function facilities
80b26bd941SHolger Dengler */
81b26bd941SHolger Dengler #define AP_FUNC_MEX4K 1
82b26bd941SHolger Dengler #define AP_FUNC_CRT4K 2
83b26bd941SHolger Dengler #define AP_FUNC_COPRO 3
84b26bd941SHolger Dengler #define AP_FUNC_ACCEL 4
8591f3e3eaSIngo Tuchscherer #define AP_FUNC_EP11 5
8691f3e3eaSIngo Tuchscherer #define AP_FUNC_APXA 6
87b26bd941SHolger Dengler
88b26bd941SHolger Dengler /*
89dc4b6dedSHarald Freudenberger * AP queue state machine states
903f3007afSMartin Schwidefsky */
91dc4b6dedSHarald Freudenberger enum ap_sm_state {
920b641cbdSHarald Freudenberger AP_SM_STATE_RESET_START = 0,
93dc4b6dedSHarald Freudenberger AP_SM_STATE_RESET_WAIT,
94dc4b6dedSHarald Freudenberger AP_SM_STATE_SETIRQ_WAIT,
95dc4b6dedSHarald Freudenberger AP_SM_STATE_IDLE,
96dc4b6dedSHarald Freudenberger AP_SM_STATE_WORKING,
97dc4b6dedSHarald Freudenberger AP_SM_STATE_QUEUE_FULL,
982d72eaf0SHarald Freudenberger AP_SM_STATE_ASSOC_WAIT,
99dc4b6dedSHarald Freudenberger NR_AP_SM_STATES
1003f3007afSMartin Schwidefsky };
1013f3007afSMartin Schwidefsky
1023f3007afSMartin Schwidefsky /*
103dc4b6dedSHarald Freudenberger * AP queue state machine events
1043f3007afSMartin Schwidefsky */
105dc4b6dedSHarald Freudenberger enum ap_sm_event {
106dc4b6dedSHarald Freudenberger AP_SM_EVENT_POLL,
107dc4b6dedSHarald Freudenberger AP_SM_EVENT_TIMEOUT,
108dc4b6dedSHarald Freudenberger NR_AP_SM_EVENTS
1093f3007afSMartin Schwidefsky };
1103f3007afSMartin Schwidefsky
1113f3007afSMartin Schwidefsky /*
112dc4b6dedSHarald Freudenberger * AP queue state wait behaviour
1133f3007afSMartin Schwidefsky */
114dc4b6dedSHarald Freudenberger enum ap_sm_wait {
115cabebb69SHarald Freudenberger AP_SM_WAIT_AGAIN = 0, /* retry immediately */
116263c8454SHarald Freudenberger AP_SM_WAIT_HIGH_TIMEOUT, /* poll high freq, wait for timeout */
117263c8454SHarald Freudenberger AP_SM_WAIT_LOW_TIMEOUT, /* poll low freq, wait for timeout */
118dc4b6dedSHarald Freudenberger AP_SM_WAIT_INTERRUPT, /* wait for thin interrupt (if available) */
119dc4b6dedSHarald Freudenberger AP_SM_WAIT_NONE, /* no wait */
120dc4b6dedSHarald Freudenberger NR_AP_SM_WAIT
1213f3007afSMartin Schwidefsky };
122af512ed0SRalph Wuerthner
1230b641cbdSHarald Freudenberger /*
1240b641cbdSHarald Freudenberger * AP queue device states
1250b641cbdSHarald Freudenberger */
1260b641cbdSHarald Freudenberger enum ap_dev_state {
1270b641cbdSHarald Freudenberger AP_DEV_STATE_UNINITIATED = 0, /* fresh and virgin, not touched */
1280b641cbdSHarald Freudenberger AP_DEV_STATE_OPERATING, /* queue dev is working normal */
1290b641cbdSHarald Freudenberger AP_DEV_STATE_SHUTDOWN, /* remove/unbind/shutdown in progress */
1300b641cbdSHarald Freudenberger AP_DEV_STATE_ERROR, /* device is in error state */
1310b641cbdSHarald Freudenberger NR_AP_DEV_STATES
1320b641cbdSHarald Freudenberger };
1330b641cbdSHarald Freudenberger
1341534c382SMartin Schwidefsky struct ap_device;
1351534c382SMartin Schwidefsky struct ap_message;
1361534c382SMartin Schwidefsky
1377e0bdbe5SHarald Freudenberger /*
1387e0bdbe5SHarald Freudenberger * The ap driver struct includes a flags field which holds some info for
1397e0bdbe5SHarald Freudenberger * the ap bus about the driver. Currently only one flag is supported and
1407e0bdbe5SHarald Freudenberger * used: The DEFAULT flag marks an ap driver as a default driver which is
1417e0bdbe5SHarald Freudenberger * used together with the apmask and aqmask whitelisting of the ap bus.
1427e0bdbe5SHarald Freudenberger */
1437e0bdbe5SHarald Freudenberger #define AP_DRIVER_FLAG_DEFAULT 0x0001
1447e0bdbe5SHarald Freudenberger
1451534c382SMartin Schwidefsky struct ap_driver {
1461534c382SMartin Schwidefsky struct device_driver driver;
1471534c382SMartin Schwidefsky struct ap_device_id *ids;
1487e0bdbe5SHarald Freudenberger unsigned int flags;
1491534c382SMartin Schwidefsky
1501534c382SMartin Schwidefsky int (*probe)(struct ap_device *);
1511534c382SMartin Schwidefsky void (*remove)(struct ap_device *);
1524f8206b8STony Krowiak int (*in_use)(unsigned long *apm, unsigned long *aqm);
15328391585STony Krowiak /*
15428391585STony Krowiak * Called at the start of the ap bus scan function when
15528391585STony Krowiak * the crypto config information (qci) has changed.
1560fef40beSHarald Freudenberger * This callback is not invoked if there is no AP
1570fef40beSHarald Freudenberger * QCI support available.
15828391585STony Krowiak */
15928391585STony Krowiak void (*on_config_changed)(struct ap_config_info *new_config_info,
16028391585STony Krowiak struct ap_config_info *old_config_info);
16128391585STony Krowiak /*
16228391585STony Krowiak * Called at the end of the ap bus scan function when
16328391585STony Krowiak * the crypto config information (qci) has changed.
1640fef40beSHarald Freudenberger * This callback is not invoked if there is no AP
1650fef40beSHarald Freudenberger * QCI support available.
16628391585STony Krowiak */
16728391585STony Krowiak void (*on_scan_complete)(struct ap_config_info *new_config_info,
16828391585STony Krowiak struct ap_config_info *old_config_info);
1691534c382SMartin Schwidefsky };
1701534c382SMartin Schwidefsky
1711534c382SMartin Schwidefsky #define to_ap_drv(x) container_of((x), struct ap_driver, driver)
1721534c382SMartin Schwidefsky
1731534c382SMartin Schwidefsky int ap_driver_register(struct ap_driver *, struct module *, char *);
1741534c382SMartin Schwidefsky void ap_driver_unregister(struct ap_driver *);
1751534c382SMartin Schwidefsky
1761534c382SMartin Schwidefsky struct ap_device {
1771534c382SMartin Schwidefsky struct device device;
1781534c382SMartin Schwidefsky int device_type; /* AP device type. */
1791534c382SMartin Schwidefsky };
1801534c382SMartin Schwidefsky
1811534c382SMartin Schwidefsky #define to_ap_dev(x) container_of((x), struct ap_device, device)
1821534c382SMartin Schwidefsky
183e28d2af4SIngo Tuchscherer struct ap_card {
184e28d2af4SIngo Tuchscherer struct ap_device ap_dev;
185e28d2af4SIngo Tuchscherer int raw_hwtype; /* AP raw hardware type. */
18608817496SHarald Freudenberger unsigned int functions; /* TAPQ GR2 upper 32 facility bits */
187e28d2af4SIngo Tuchscherer int queue_depth; /* AP queue depth.*/
188e28d2af4SIngo Tuchscherer int id; /* AP card number. */
189bd39654aSHarald Freudenberger unsigned int maxmsgsize; /* AP msg limit for this card */
1904f2fcccdSHarald Freudenberger bool config; /* configured state */
191a7e701dbSHarald Freudenberger bool chkstop; /* checkstop state */
192fcd98d40SHarald Freudenberger atomic64_t total_request_count; /* # requests ever for this AP device.*/
193e28d2af4SIngo Tuchscherer };
194e28d2af4SIngo Tuchscherer
19508817496SHarald Freudenberger #define TAPQ_CARD_FUNC_CMP_MASK 0xFFFF0000
1962d72eaf0SHarald Freudenberger #define ASSOC_IDX_INVALID 0x10000
19708817496SHarald Freudenberger
198e28d2af4SIngo Tuchscherer #define to_ap_card(x) container_of((x), struct ap_card, ap_dev.device)
199e28d2af4SIngo Tuchscherer
200e28d2af4SIngo Tuchscherer struct ap_queue {
201e28d2af4SIngo Tuchscherer struct ap_device ap_dev;
202bc4b295eSHarald Freudenberger struct hlist_node hnode; /* Node for the ap_queues hashtable */
203e28d2af4SIngo Tuchscherer struct ap_card *card; /* Ptr to assoc. AP card. */
204e28d2af4SIngo Tuchscherer spinlock_t lock; /* Per device lock. */
2050b641cbdSHarald Freudenberger enum ap_dev_state dev_state; /* queue device state */
2064f2fcccdSHarald Freudenberger bool config; /* configured state */
207a7e701dbSHarald Freudenberger bool chkstop; /* checkstop state */
208e28d2af4SIngo Tuchscherer ap_qid_t qid; /* AP queue id. */
209cabebb69SHarald Freudenberger bool interrupt; /* indicate if interrupts are enabled */
2102d72eaf0SHarald Freudenberger unsigned int assoc_idx; /* SE association index */
211e28d2af4SIngo Tuchscherer int queue_count; /* # messages currently on AP queue. */
212e28d2af4SIngo Tuchscherer int pendingq_count; /* # requests on pendingq list. */
213e28d2af4SIngo Tuchscherer int requestq_count; /* # requests on requestq list. */
214fcd98d40SHarald Freudenberger u64 total_request_count; /* # requests ever for this AP device.*/
215ac2b96f3SHarald Freudenberger int request_timeout; /* Request timeout in jiffies. */
216e28d2af4SIngo Tuchscherer struct timer_list timeout; /* Timer for request timeouts. */
217e28d2af4SIngo Tuchscherer struct list_head pendingq; /* List of message sent to AP queue. */
218e28d2af4SIngo Tuchscherer struct list_head requestq; /* List of message yet to be sent. */
219e28d2af4SIngo Tuchscherer struct ap_message *reply; /* Per device reply message. */
2200b641cbdSHarald Freudenberger enum ap_sm_state sm_state; /* ap queue state machine state */
2212d72eaf0SHarald Freudenberger int rapq_fbit; /* fbit arg for next rapq invocation */
2222ea2a609SHarald Freudenberger int last_err_rc; /* last error state response code */
223e28d2af4SIngo Tuchscherer };
224e28d2af4SIngo Tuchscherer
225e28d2af4SIngo Tuchscherer #define to_ap_queue(x) container_of((x), struct ap_queue, ap_dev.device)
226e28d2af4SIngo Tuchscherer
227dc4b6dedSHarald Freudenberger typedef enum ap_sm_wait (ap_func_t)(struct ap_queue *queue);
228e28d2af4SIngo Tuchscherer
2291534c382SMartin Schwidefsky struct ap_message {
2301534c382SMartin Schwidefsky struct list_head list; /* Request queueing. */
231003d248fSHarald Freudenberger unsigned long psmid; /* Message id. */
23274ecbef7SHarald Freudenberger void *msg; /* Pointer to message buffer. */
2338794c596SHarald Freudenberger size_t len; /* actual msg len in msg buffer */
2348794c596SHarald Freudenberger size_t bufsize; /* allocated msg buffer size */
23527c4f673SHarald Freudenberger u16 flags; /* Flags, see AP_MSG_FLAG_xxx */
236f58fe336SMartin Schwidefsky int rc; /* Return code for this message */
2371534c382SMartin Schwidefsky void *private; /* ap driver private pointer. */
23854a8f561SHolger Dengler /* receive is called from tasklet context */
239e28d2af4SIngo Tuchscherer void (*receive)(struct ap_queue *, struct ap_message *,
24054a8f561SHolger Dengler struct ap_message *);
2411534c382SMartin Schwidefsky };
2421534c382SMartin Schwidefsky
243383366b5SHarald Freudenberger #define AP_MSG_FLAG_SPECIAL 0x0001 /* flag msg as 'special' with NQAP */
244383366b5SHarald Freudenberger #define AP_MSG_FLAG_USAGE 0x0002 /* CCA, EP11: usage (no admin) msg */
245383366b5SHarald Freudenberger #define AP_MSG_FLAG_ADMIN 0x0004 /* CCA, EP11: admin (=control) msg */
24674ecbef7SHarald Freudenberger
247468ffddfSFelix Beck /**
248468ffddfSFelix Beck * ap_init_message() - Initialize ap_message.
249468ffddfSFelix Beck * Initialize a message before using. Otherwise this might result in
250468ffddfSFelix Beck * unexpected behaviour.
251468ffddfSFelix Beck */
ap_init_message(struct ap_message * ap_msg)252468ffddfSFelix Beck static inline void ap_init_message(struct ap_message *ap_msg)
253468ffddfSFelix Beck {
25489a0c0ecSHarald Freudenberger memset(ap_msg, 0, sizeof(*ap_msg));
25589a0c0ecSHarald Freudenberger }
25689a0c0ecSHarald Freudenberger
25789a0c0ecSHarald Freudenberger /**
25889a0c0ecSHarald Freudenberger * ap_release_message() - Release ap_message.
25989a0c0ecSHarald Freudenberger * Releases all memory used internal within the ap_message struct
26089a0c0ecSHarald Freudenberger * Currently this is the message and private field.
26189a0c0ecSHarald Freudenberger */
ap_release_message(struct ap_message * ap_msg)26289a0c0ecSHarald Freudenberger static inline void ap_release_message(struct ap_message *ap_msg)
26389a0c0ecSHarald Freudenberger {
264453431a5SWaiman Long kfree_sensitive(ap_msg->msg);
265453431a5SWaiman Long kfree_sensitive(ap_msg->private);
266468ffddfSFelix Beck }
267468ffddfSFelix Beck
268dc4b6dedSHarald Freudenberger enum ap_sm_wait ap_sm_event(struct ap_queue *aq, enum ap_sm_event event);
269dc4b6dedSHarald Freudenberger enum ap_sm_wait ap_sm_event_loop(struct ap_queue *aq, enum ap_sm_event event);
270e28d2af4SIngo Tuchscherer
2710b641cbdSHarald Freudenberger int ap_queue_message(struct ap_queue *aq, struct ap_message *ap_msg);
272e28d2af4SIngo Tuchscherer void ap_cancel_message(struct ap_queue *aq, struct ap_message *ap_msg);
273e28d2af4SIngo Tuchscherer void ap_flush_queue(struct ap_queue *aq);
274e28d2af4SIngo Tuchscherer
275e28d2af4SIngo Tuchscherer void *ap_airq_ptr(void);
276f6047040SHarald Freudenberger int ap_sb_available(void);
277386cb81eSHolger Dengler bool ap_is_se_guest(void);
278dc4b6dedSHarald Freudenberger void ap_wait(enum ap_sm_wait wait);
279cefbeb5dSKees Cook void ap_request_timeout(struct timer_list *t);
280dabecb29SHolger Dengler void ap_bus_force_rescan(void);
281e28d2af4SIngo Tuchscherer
2827379e652SHarald Freudenberger int ap_test_config_usage_domain(unsigned int domain);
2837379e652SHarald Freudenberger int ap_test_config_ctrl_domain(unsigned int domain);
2847379e652SHarald Freudenberger
285e28d2af4SIngo Tuchscherer void ap_queue_init_reply(struct ap_queue *aq, struct ap_message *ap_msg);
286e28d2af4SIngo Tuchscherer struct ap_queue *ap_queue_create(ap_qid_t qid, int device_type);
28701396a37SHarald Freudenberger void ap_queue_prepare_remove(struct ap_queue *aq);
288e28d2af4SIngo Tuchscherer void ap_queue_remove(struct ap_queue *aq);
2890c874cd0SHarald Freudenberger void ap_queue_init_state(struct ap_queue *aq);
290*a03b8ab0SHarald Freudenberger void _ap_queue_init_state(struct ap_queue *aq);
291e28d2af4SIngo Tuchscherer
292bd39654aSHarald Freudenberger struct ap_card *ap_card_create(int id, int queue_depth, int raw_type,
293bd39654aSHarald Freudenberger int comp_type, unsigned int functions, int ml);
2941534c382SMartin Schwidefsky
2954f8206b8STony Krowiak #define APMASKSIZE (BITS_TO_LONGS(AP_DEVICES) * sizeof(unsigned long))
2964f8206b8STony Krowiak #define AQMASKSIZE (BITS_TO_LONGS(AP_DOMAINS) * sizeof(unsigned long))
2974f8206b8STony Krowiak
29800fab235SHarald Freudenberger struct ap_perms {
29900fab235SHarald Freudenberger unsigned long ioctlm[BITS_TO_LONGS(AP_IOCTLS)];
30000fab235SHarald Freudenberger unsigned long apm[BITS_TO_LONGS(AP_DEVICES)];
30100fab235SHarald Freudenberger unsigned long aqm[BITS_TO_LONGS(AP_DOMAINS)];
302895ae58dSJuergen Christ unsigned long adm[BITS_TO_LONGS(AP_DOMAINS)];
30300fab235SHarald Freudenberger };
3042004b57cSHarald Freudenberger
30500fab235SHarald Freudenberger extern struct ap_perms ap_perms;
30600fab235SHarald Freudenberger extern struct mutex ap_perms_mutex;
30700fab235SHarald Freudenberger
3087e0bdbe5SHarald Freudenberger /*
309bc4b295eSHarald Freudenberger * Get ap_queue device for this qid.
310bc4b295eSHarald Freudenberger * Returns ptr to the struct ap_queue device or NULL if there
311bc4b295eSHarald Freudenberger * was no ap_queue device with this qid found. When something is
312bc4b295eSHarald Freudenberger * found, the reference count of the embedded device is increased.
313bc4b295eSHarald Freudenberger * So the caller has to decrease the reference count after use
314bc4b295eSHarald Freudenberger * with a call to put_device(&aq->ap_dev.device).
315bc4b295eSHarald Freudenberger */
316bc4b295eSHarald Freudenberger struct ap_queue *ap_get_qdev(ap_qid_t qid);
317bc4b295eSHarald Freudenberger
318bc4b295eSHarald Freudenberger /*
3197e0bdbe5SHarald Freudenberger * check APQN for owned/reserved by ap bus and default driver(s).
3207e0bdbe5SHarald Freudenberger * Checks if this APQN is or will be in use by the ap bus
3217e0bdbe5SHarald Freudenberger * and the default set of drivers.
3227e0bdbe5SHarald Freudenberger * If yes, returns 1, if not returns 0. On error a negative
3237e0bdbe5SHarald Freudenberger * errno value is returned.
3247e0bdbe5SHarald Freudenberger */
3257e0bdbe5SHarald Freudenberger int ap_owned_by_def_drv(int card, int queue);
3267e0bdbe5SHarald Freudenberger
3277e0bdbe5SHarald Freudenberger /*
3287e0bdbe5SHarald Freudenberger * check 'matrix' of APQNs for owned/reserved by ap bus and
3297e0bdbe5SHarald Freudenberger * default driver(s).
3307e0bdbe5SHarald Freudenberger * Checks if there is at least one APQN in the given 'matrix'
3317e0bdbe5SHarald Freudenberger * marked as owned/reserved by the ap bus and default driver(s).
3327e0bdbe5SHarald Freudenberger * If such an APQN is found the return value is 1, otherwise
3337e0bdbe5SHarald Freudenberger * 0 is returned. On error a negative errno value is returned.
3347e0bdbe5SHarald Freudenberger * The parameter apm is a bitmask which should be declared
3357e0bdbe5SHarald Freudenberger * as DECLARE_BITMAP(apm, AP_DEVICES), the aqm parameter is
3367e0bdbe5SHarald Freudenberger * similar, should be declared as DECLARE_BITMAP(aqm, AP_DOMAINS).
3377e0bdbe5SHarald Freudenberger */
3387e0bdbe5SHarald Freudenberger int ap_apqn_in_matrix_owned_by_def_drv(unsigned long *apm,
3397e0bdbe5SHarald Freudenberger unsigned long *aqm);
3407e0bdbe5SHarald Freudenberger
34100fab235SHarald Freudenberger /*
34200fab235SHarald Freudenberger * ap_parse_mask_str() - helper function to parse a bitmap string
34300fab235SHarald Freudenberger * and clear/set the bits in the bitmap accordingly. The string may be
34400fab235SHarald Freudenberger * given as absolute value, a hex string like 0x1F2E3D4C5B6A" simple
34500fab235SHarald Freudenberger * overwriting the current content of the bitmap. Or as relative string
34600fab235SHarald Freudenberger * like "+1-16,-32,-0x40,+128" where only single bits or ranges of
34700fab235SHarald Freudenberger * bits are cleared or set. Distinction is done based on the very
34800fab235SHarald Freudenberger * first character which may be '+' or '-' for the relative string
349cada938aSHeiko Carstens * and otherwise assume to be an absolute value string. If parsing fails
35000fab235SHarald Freudenberger * a negative errno value is returned. All arguments and bitmaps are
35100fab235SHarald Freudenberger * big endian order.
35200fab235SHarald Freudenberger */
35300fab235SHarald Freudenberger int ap_parse_mask_str(const char *str,
35400fab235SHarald Freudenberger unsigned long *bitmap, int bits,
35500fab235SHarald Freudenberger struct mutex *lock);
35600fab235SHarald Freudenberger
357837cd105SHarald Freudenberger /*
358837cd105SHarald Freudenberger * Interface to wait for the AP bus to have done one initial ap bus
359837cd105SHarald Freudenberger * scan and all detected APQNs have been bound to device drivers.
360837cd105SHarald Freudenberger * If these both conditions are not fulfilled, this function blocks
361837cd105SHarald Freudenberger * on a condition with wait_for_completion_killable_timeout().
362837cd105SHarald Freudenberger * If these both conditions are fulfilled (before the timeout hits)
363837cd105SHarald Freudenberger * the return value is 0. If the timeout (in jiffies) hits instead
364837cd105SHarald Freudenberger * -ETIME is returned. On failures negative return values are
365837cd105SHarald Freudenberger * returned to the caller.
366837cd105SHarald Freudenberger */
367837cd105SHarald Freudenberger int ap_wait_init_apqn_bindings_complete(unsigned long timeout);
368837cd105SHarald Freudenberger
369df6f508cSHarald Freudenberger void ap_send_config_uevent(struct ap_device *ap_dev, bool cfg);
370df6f508cSHarald Freudenberger void ap_send_online_uevent(struct ap_device *ap_dev, int online);
371df6f508cSHarald Freudenberger
3721534c382SMartin Schwidefsky #endif /* _AP_BUS_H_ */
373