1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright IBM Corp. 2006, 2012
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.
13 #define KMSG_COMPONENT "ap"
14 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
16 #include <linux/kernel_stat.h>
17 #include <linux/moduleparam.h>
18 #include <linux/init.h>
19 #include <linux/delay.h>
20 #include <linux/err.h>
21 #include <linux/interrupt.h>
22 #include <linux/workqueue.h>
23 #include <linux/slab.h>
24 #include <linux/notifier.h>
25 #include <linux/kthread.h>
26 #include <linux/mutex.h>
27 #include <linux/suspend.h>
28 #include <asm/reset.h>
30 #include <linux/atomic.h>
32 #include <linux/hrtimer.h>
33 #include <linux/ktime.h>
34 #include <asm/facility.h>
35 #include <linux/crypto.h>
36 #include <linux/mod_devicetable.h>
37 #include <linux/debugfs.h>
44 * Module parameters; note though this file itself isn't modular.
46 int ap_domain_index
= -1; /* Adjunct Processor Domain Index */
47 static DEFINE_SPINLOCK(ap_domain_lock
);
48 module_param_named(domain
, ap_domain_index
, int, S_IRUSR
|S_IRGRP
);
49 MODULE_PARM_DESC(domain
, "domain index for ap devices");
50 EXPORT_SYMBOL(ap_domain_index
);
52 static int ap_thread_flag
= 0;
53 module_param_named(poll_thread
, ap_thread_flag
, int, S_IRUSR
|S_IRGRP
);
54 MODULE_PARM_DESC(poll_thread
, "Turn on/off poll thread, default is 0 (off).");
56 static struct device
*ap_root_device
;
58 DEFINE_SPINLOCK(ap_list_lock
);
59 LIST_HEAD(ap_card_list
);
61 static struct ap_config_info
*ap_configuration
;
62 static bool initialised
;
65 * AP bus related debug feature things.
67 debug_info_t
*ap_dbf_info
;
70 * Workqueue timer for bus rescan.
72 static struct timer_list ap_config_timer
;
73 static int ap_config_time
= AP_CONFIG_TIME
;
74 static void ap_scan_bus(struct work_struct
*);
75 static DECLARE_WORK(ap_scan_work
, ap_scan_bus
);
78 * Tasklet & timer for AP request polling and interrupts
80 static void ap_tasklet_fn(unsigned long);
81 static DECLARE_TASKLET(ap_tasklet
, ap_tasklet_fn
, 0);
82 static DECLARE_WAIT_QUEUE_HEAD(ap_poll_wait
);
83 static struct task_struct
*ap_poll_kthread
= NULL
;
84 static DEFINE_MUTEX(ap_poll_thread_mutex
);
85 static DEFINE_SPINLOCK(ap_poll_timer_lock
);
86 static struct hrtimer ap_poll_timer
;
87 /* In LPAR poll with 4kHz frequency. Poll every 250000 nanoseconds.
88 * If z/VM change to 1500000 nanoseconds to adjust to z/VM polling.*/
89 static unsigned long long poll_timeout
= 250000;
92 static int ap_suspend_flag
;
93 /* Maximum domain id */
94 static int ap_max_domain_id
;
95 /* Flag to check if domain was set through module parameter domain=. This is
96 * important when supsend and resume is done in a z/VM environment where the
97 * domain might change. */
98 static int user_set_domain
= 0;
99 static struct bus_type ap_bus_type
;
101 /* Adapter interrupt definitions */
102 static void ap_interrupt_handler(struct airq_struct
*airq
);
104 static int ap_airq_flag
;
106 static struct airq_struct ap_airq
= {
107 .handler
= ap_interrupt_handler
,
112 * ap_using_interrupts() - Returns non-zero if interrupt support is
115 static inline int ap_using_interrupts(void)
121 * ap_airq_ptr() - Get the address of the adapter interrupt indicator
123 * Returns the address of the local-summary-indicator of the adapter
124 * interrupt handler for AP, or NULL if adapter interrupts are not
127 void *ap_airq_ptr(void)
129 if (ap_using_interrupts())
130 return ap_airq
.lsi_ptr
;
135 * ap_interrupts_available(): Test if AP interrupts are available.
137 * Returns 1 if AP interrupts are available.
139 static int ap_interrupts_available(void)
141 return test_facility(65);
145 * ap_configuration_available(): Test if AP configuration
146 * information is available.
148 * Returns 1 if AP configuration information is available.
150 static int ap_configuration_available(void)
152 return test_facility(12);
156 * ap_apft_available(): Test if AP facilities test (APFT)
157 * facility is available.
159 * Returns 1 if APFT is is available.
161 static int ap_apft_available(void)
163 return test_facility(15);
167 * ap_qact_available(): Test if the PQAP(QACT) subfunction is available.
169 * Returns 1 if the QACT subfunction is available.
171 static inline int ap_qact_available(void)
173 if (ap_configuration
)
174 return ap_configuration
->qact
;
179 * ap_test_queue(): Test adjunct processor queue.
180 * @qid: The AP queue number
181 * @tbit: Test facilities bit
182 * @info: Pointer to queue descriptor
184 * Returns AP queue status structure.
186 struct ap_queue_status
ap_test_queue(ap_qid_t qid
,
191 qid
|= 1UL << 23; /* set T bit*/
192 return ap_tapq(qid
, info
);
194 EXPORT_SYMBOL(ap_test_queue
);
197 * ap_query_configuration(): Fetch cryptographic config info
199 * Returns the ap configuration info fetched via PQAP(QCI).
200 * On success 0 is returned, on failure a negative errno
201 * is returned, e.g. if the PQAP(QCI) instruction is not
202 * available, the return value will be -EOPNOTSUPP.
204 int ap_query_configuration(struct ap_config_info
*info
)
206 if (!ap_configuration_available())
212 EXPORT_SYMBOL(ap_query_configuration
);
215 * ap_init_configuration(): Allocate and query configuration array.
217 static void ap_init_configuration(void)
219 if (!ap_configuration_available())
222 ap_configuration
= kzalloc(sizeof(*ap_configuration
), GFP_KERNEL
);
223 if (!ap_configuration
)
225 if (ap_query_configuration(ap_configuration
) != 0) {
226 kfree(ap_configuration
);
227 ap_configuration
= NULL
;
233 * ap_test_config(): helper function to extract the nrth bit
234 * within the unsigned int array field.
236 static inline int ap_test_config(unsigned int *field
, unsigned int nr
)
238 return ap_test_bit((field
+ (nr
>> 5)), (nr
& 0x1f));
242 * ap_test_config_card_id(): Test, whether an AP card ID is configured.
245 * Returns 0 if the card is not configured
246 * 1 if the card is configured or
247 * if the configuration information is not available
249 static inline int ap_test_config_card_id(unsigned int id
)
251 if (!ap_configuration
) /* QCI not supported */
253 return ap_test_config(ap_configuration
->apm
, id
);
257 * ap_test_config_domain(): Test, whether an AP usage domain is configured.
258 * @domain AP usage domain ID
260 * Returns 0 if the usage domain is not configured
261 * 1 if the usage domain is configured or
262 * if the configuration information is not available
264 static inline int ap_test_config_domain(unsigned int domain
)
266 if (!ap_configuration
) /* QCI not supported */
268 return ap_test_config(ap_configuration
->aqm
, domain
);
272 * ap_query_queue(): Check if an AP queue is available.
273 * @qid: The AP queue number
274 * @queue_depth: Pointer to queue depth value
275 * @device_type: Pointer to device type value
276 * @facilities: Pointer to facility indicator
278 static int ap_query_queue(ap_qid_t qid
, int *queue_depth
, int *device_type
,
279 unsigned int *facilities
)
281 struct ap_queue_status status
;
285 if (!ap_test_config_card_id(AP_QID_CARD(qid
)))
288 status
= ap_test_queue(qid
, ap_apft_available(), &info
);
289 switch (status
.response_code
) {
290 case AP_RESPONSE_NORMAL
:
291 *queue_depth
= (int)(info
& 0xff);
292 *device_type
= (int)((info
>> 24) & 0xff);
293 *facilities
= (unsigned int)(info
>> 32);
294 /* Update maximum domain id */
295 nd
= (info
>> 16) & 0xff;
296 /* if N bit is available, z13 and newer */
297 if ((info
& (1UL << 57)) && nd
> 0)
298 ap_max_domain_id
= nd
;
299 else /* older machine types */
300 ap_max_domain_id
= 15;
301 switch (*device_type
) {
302 /* For CEX2 and CEX3 the available functions
303 * are not refrected by the facilities bits.
304 * Instead it is coded into the type. So here
305 * modify the function bits based on the type.
307 case AP_DEVICE_TYPE_CEX2A
:
308 case AP_DEVICE_TYPE_CEX3A
:
309 *facilities
|= 0x08000000;
311 case AP_DEVICE_TYPE_CEX2C
:
312 case AP_DEVICE_TYPE_CEX3C
:
313 *facilities
|= 0x10000000;
319 case AP_RESPONSE_Q_NOT_AVAIL
:
320 case AP_RESPONSE_DECONFIGURED
:
321 case AP_RESPONSE_CHECKSTOPPED
:
322 case AP_RESPONSE_INVALID_ADDRESS
:
324 case AP_RESPONSE_RESET_IN_PROGRESS
:
325 case AP_RESPONSE_OTHERWISE_CHANGED
:
326 case AP_RESPONSE_BUSY
:
333 void ap_wait(enum ap_wait wait
)
339 case AP_WAIT_INTERRUPT
:
340 if (ap_using_interrupts())
342 if (ap_poll_kthread
) {
343 wake_up(&ap_poll_wait
);
347 case AP_WAIT_TIMEOUT
:
348 spin_lock_bh(&ap_poll_timer_lock
);
349 if (!hrtimer_is_queued(&ap_poll_timer
)) {
350 hr_time
= poll_timeout
;
351 hrtimer_forward_now(&ap_poll_timer
, hr_time
);
352 hrtimer_restart(&ap_poll_timer
);
354 spin_unlock_bh(&ap_poll_timer_lock
);
363 * ap_request_timeout(): Handling of request timeouts
364 * @t: timer making this callback
366 * Handles request timeouts.
368 void ap_request_timeout(struct timer_list
*t
)
370 struct ap_queue
*aq
= from_timer(aq
, t
, timeout
);
374 spin_lock_bh(&aq
->lock
);
375 ap_wait(ap_sm_event(aq
, AP_EVENT_TIMEOUT
));
376 spin_unlock_bh(&aq
->lock
);
380 * ap_poll_timeout(): AP receive polling for finished AP requests.
381 * @unused: Unused pointer.
383 * Schedules the AP tasklet using a high resolution timer.
385 static enum hrtimer_restart
ap_poll_timeout(struct hrtimer
*unused
)
387 if (!ap_suspend_flag
)
388 tasklet_schedule(&ap_tasklet
);
389 return HRTIMER_NORESTART
;
393 * ap_interrupt_handler() - Schedule ap_tasklet on interrupt
394 * @airq: pointer to adapter interrupt descriptor
396 static void ap_interrupt_handler(struct airq_struct
*airq
)
398 inc_irq_stat(IRQIO_APB
);
399 if (!ap_suspend_flag
)
400 tasklet_schedule(&ap_tasklet
);
404 * ap_tasklet_fn(): Tasklet to poll all AP devices.
405 * @dummy: Unused variable
407 * Poll all AP devices on the bus.
409 static void ap_tasklet_fn(unsigned long dummy
)
413 enum ap_wait wait
= AP_WAIT_NONE
;
415 /* Reset the indicator if interrupts are used. Thus new interrupts can
416 * be received. Doing it in the beginning of the tasklet is therefor
417 * important that no requests on any AP get lost.
419 if (ap_using_interrupts())
420 xchg(ap_airq
.lsi_ptr
, 0);
422 spin_lock_bh(&ap_list_lock
);
423 for_each_ap_card(ac
) {
424 for_each_ap_queue(aq
, ac
) {
425 spin_lock_bh(&aq
->lock
);
426 wait
= min(wait
, ap_sm_event_loop(aq
, AP_EVENT_POLL
));
427 spin_unlock_bh(&aq
->lock
);
430 spin_unlock_bh(&ap_list_lock
);
435 static int ap_pending_requests(void)
440 spin_lock_bh(&ap_list_lock
);
441 for_each_ap_card(ac
) {
442 for_each_ap_queue(aq
, ac
) {
443 if (aq
->queue_count
== 0)
445 spin_unlock_bh(&ap_list_lock
);
449 spin_unlock_bh(&ap_list_lock
);
454 * ap_poll_thread(): Thread that polls for finished requests.
455 * @data: Unused pointer
457 * AP bus poll thread. The purpose of this thread is to poll for
458 * finished requests in a loop if there is a "free" cpu - that is
459 * a cpu that doesn't have anything better to do. The polling stops
460 * as soon as there is another task or if all messages have been
463 static int ap_poll_thread(void *data
)
465 DECLARE_WAITQUEUE(wait
, current
);
467 set_user_nice(current
, MAX_NICE
);
469 while (!kthread_should_stop()) {
470 add_wait_queue(&ap_poll_wait
, &wait
);
471 set_current_state(TASK_INTERRUPTIBLE
);
472 if (ap_suspend_flag
|| !ap_pending_requests()) {
476 set_current_state(TASK_RUNNING
);
477 remove_wait_queue(&ap_poll_wait
, &wait
);
478 if (need_resched()) {
489 static int ap_poll_thread_start(void)
493 if (ap_using_interrupts() || ap_poll_kthread
)
495 mutex_lock(&ap_poll_thread_mutex
);
496 ap_poll_kthread
= kthread_run(ap_poll_thread
, NULL
, "appoll");
497 rc
= PTR_RET(ap_poll_kthread
);
499 ap_poll_kthread
= NULL
;
500 mutex_unlock(&ap_poll_thread_mutex
);
504 static void ap_poll_thread_stop(void)
506 if (!ap_poll_kthread
)
508 mutex_lock(&ap_poll_thread_mutex
);
509 kthread_stop(ap_poll_kthread
);
510 ap_poll_kthread
= NULL
;
511 mutex_unlock(&ap_poll_thread_mutex
);
514 #define is_card_dev(x) ((x)->parent == ap_root_device)
515 #define is_queue_dev(x) ((x)->parent != ap_root_device)
519 * @dev: Pointer to device
520 * @drv: Pointer to device_driver
522 * AP bus driver registration/unregistration.
524 static int ap_bus_match(struct device
*dev
, struct device_driver
*drv
)
526 struct ap_driver
*ap_drv
= to_ap_drv(drv
);
527 struct ap_device_id
*id
;
530 * Compare device type of the device with the list of
531 * supported types of the device_driver.
533 for (id
= ap_drv
->ids
; id
->match_flags
; id
++) {
534 if (is_card_dev(dev
) &&
535 id
->match_flags
& AP_DEVICE_ID_MATCH_CARD_TYPE
&&
536 id
->dev_type
== to_ap_dev(dev
)->device_type
)
538 if (is_queue_dev(dev
) &&
539 id
->match_flags
& AP_DEVICE_ID_MATCH_QUEUE_TYPE
&&
540 id
->dev_type
== to_ap_dev(dev
)->device_type
)
547 * ap_uevent(): Uevent function for AP devices.
548 * @dev: Pointer to device
549 * @env: Pointer to kobj_uevent_env
551 * It sets up a single environment variable DEV_TYPE which contains the
552 * hardware device type.
554 static int ap_uevent (struct device
*dev
, struct kobj_uevent_env
*env
)
556 struct ap_device
*ap_dev
= to_ap_dev(dev
);
562 /* Set up DEV_TYPE environment variable. */
563 retval
= add_uevent_var(env
, "DEV_TYPE=%04X", ap_dev
->device_type
);
568 retval
= add_uevent_var(env
, "MODALIAS=ap:t%02X", ap_dev
->device_type
);
573 static int ap_dev_suspend(struct device
*dev
)
575 struct ap_device
*ap_dev
= to_ap_dev(dev
);
577 if (ap_dev
->drv
&& ap_dev
->drv
->suspend
)
578 ap_dev
->drv
->suspend(ap_dev
);
582 static int ap_dev_resume(struct device
*dev
)
584 struct ap_device
*ap_dev
= to_ap_dev(dev
);
586 if (ap_dev
->drv
&& ap_dev
->drv
->resume
)
587 ap_dev
->drv
->resume(ap_dev
);
591 static void ap_bus_suspend(void)
593 AP_DBF(DBF_DEBUG
, "ap_bus_suspend running\n");
597 * Disable scanning for devices, thus we do not want to scan
598 * for them after removing.
600 flush_work(&ap_scan_work
);
601 tasklet_disable(&ap_tasklet
);
604 static int __ap_card_devices_unregister(struct device
*dev
, void *dummy
)
606 if (is_card_dev(dev
))
607 device_unregister(dev
);
611 static int __ap_queue_devices_unregister(struct device
*dev
, void *dummy
)
613 if (is_queue_dev(dev
))
614 device_unregister(dev
);
618 static int __ap_queue_devices_with_id_unregister(struct device
*dev
, void *data
)
620 if (is_queue_dev(dev
) &&
621 AP_QID_CARD(to_ap_queue(dev
)->qid
) == (int)(long) data
)
622 device_unregister(dev
);
626 static void ap_bus_resume(void)
630 AP_DBF(DBF_DEBUG
, "ap_bus_resume running\n");
632 /* remove all queue devices */
633 bus_for_each_dev(&ap_bus_type
, NULL
, NULL
,
634 __ap_queue_devices_unregister
);
635 /* remove all card devices */
636 bus_for_each_dev(&ap_bus_type
, NULL
, NULL
,
637 __ap_card_devices_unregister
);
639 /* Reset thin interrupt setting */
640 if (ap_interrupts_available() && !ap_using_interrupts()) {
641 rc
= register_adapter_interrupt(&ap_airq
);
642 ap_airq_flag
= (rc
== 0);
644 if (!ap_interrupts_available() && ap_using_interrupts()) {
645 unregister_adapter_interrupt(&ap_airq
);
649 if (!user_set_domain
)
650 ap_domain_index
= -1;
651 /* Get things going again */
654 xchg(ap_airq
.lsi_ptr
, 0);
655 tasklet_enable(&ap_tasklet
);
656 queue_work(system_long_wq
, &ap_scan_work
);
659 static int ap_power_event(struct notifier_block
*this, unsigned long event
,
663 case PM_HIBERNATION_PREPARE
:
664 case PM_SUSPEND_PREPARE
:
667 case PM_POST_HIBERNATION
:
668 case PM_POST_SUSPEND
:
676 static struct notifier_block ap_power_notifier
= {
677 .notifier_call
= ap_power_event
,
680 static SIMPLE_DEV_PM_OPS(ap_bus_pm_ops
, ap_dev_suspend
, ap_dev_resume
);
682 static struct bus_type ap_bus_type
= {
684 .match
= &ap_bus_match
,
685 .uevent
= &ap_uevent
,
686 .pm
= &ap_bus_pm_ops
,
689 static int ap_device_probe(struct device
*dev
)
691 struct ap_device
*ap_dev
= to_ap_dev(dev
);
692 struct ap_driver
*ap_drv
= to_ap_drv(dev
->driver
);
695 /* Add queue/card to list of active queues/cards */
696 spin_lock_bh(&ap_list_lock
);
697 if (is_card_dev(dev
))
698 list_add(&to_ap_card(dev
)->list
, &ap_card_list
);
700 list_add(&to_ap_queue(dev
)->list
,
701 &to_ap_queue(dev
)->card
->queues
);
702 spin_unlock_bh(&ap_list_lock
);
704 ap_dev
->drv
= ap_drv
;
705 rc
= ap_drv
->probe
? ap_drv
->probe(ap_dev
) : -ENODEV
;
708 spin_lock_bh(&ap_list_lock
);
709 if (is_card_dev(dev
))
710 list_del_init(&to_ap_card(dev
)->list
);
712 list_del_init(&to_ap_queue(dev
)->list
);
713 spin_unlock_bh(&ap_list_lock
);
720 static int ap_device_remove(struct device
*dev
)
722 struct ap_device
*ap_dev
= to_ap_dev(dev
);
723 struct ap_driver
*ap_drv
= ap_dev
->drv
;
726 ap_drv
->remove(ap_dev
);
728 /* Remove queue/card from list of active queues/cards */
729 spin_lock_bh(&ap_list_lock
);
730 if (is_card_dev(dev
))
731 list_del_init(&to_ap_card(dev
)->list
);
733 list_del_init(&to_ap_queue(dev
)->list
);
734 spin_unlock_bh(&ap_list_lock
);
739 int ap_driver_register(struct ap_driver
*ap_drv
, struct module
*owner
,
742 struct device_driver
*drv
= &ap_drv
->driver
;
747 drv
->bus
= &ap_bus_type
;
748 drv
->probe
= ap_device_probe
;
749 drv
->remove
= ap_device_remove
;
752 return driver_register(drv
);
754 EXPORT_SYMBOL(ap_driver_register
);
756 void ap_driver_unregister(struct ap_driver
*ap_drv
)
758 driver_unregister(&ap_drv
->driver
);
760 EXPORT_SYMBOL(ap_driver_unregister
);
762 void ap_bus_force_rescan(void)
766 /* processing a asynchronous bus rescan */
767 del_timer(&ap_config_timer
);
768 queue_work(system_long_wq
, &ap_scan_work
);
769 flush_work(&ap_scan_work
);
771 EXPORT_SYMBOL(ap_bus_force_rescan
);
776 static ssize_t
ap_domain_show(struct bus_type
*bus
, char *buf
)
778 return snprintf(buf
, PAGE_SIZE
, "%d\n", ap_domain_index
);
781 static ssize_t
ap_domain_store(struct bus_type
*bus
,
782 const char *buf
, size_t count
)
786 if (sscanf(buf
, "%i\n", &domain
) != 1 ||
787 domain
< 0 || domain
> ap_max_domain_id
)
789 spin_lock_bh(&ap_domain_lock
);
790 ap_domain_index
= domain
;
791 spin_unlock_bh(&ap_domain_lock
);
793 AP_DBF(DBF_DEBUG
, "stored new default domain=%d\n", domain
);
798 static BUS_ATTR(ap_domain
, 0644, ap_domain_show
, ap_domain_store
);
800 static ssize_t
ap_control_domain_mask_show(struct bus_type
*bus
, char *buf
)
802 if (!ap_configuration
) /* QCI not supported */
803 return snprintf(buf
, PAGE_SIZE
, "not supported\n");
805 return snprintf(buf
, PAGE_SIZE
,
806 "0x%08x%08x%08x%08x%08x%08x%08x%08x\n",
807 ap_configuration
->adm
[0], ap_configuration
->adm
[1],
808 ap_configuration
->adm
[2], ap_configuration
->adm
[3],
809 ap_configuration
->adm
[4], ap_configuration
->adm
[5],
810 ap_configuration
->adm
[6], ap_configuration
->adm
[7]);
813 static BUS_ATTR(ap_control_domain_mask
, 0444,
814 ap_control_domain_mask_show
, NULL
);
816 static ssize_t
ap_usage_domain_mask_show(struct bus_type
*bus
, char *buf
)
818 if (!ap_configuration
) /* QCI not supported */
819 return snprintf(buf
, PAGE_SIZE
, "not supported\n");
821 return snprintf(buf
, PAGE_SIZE
,
822 "0x%08x%08x%08x%08x%08x%08x%08x%08x\n",
823 ap_configuration
->aqm
[0], ap_configuration
->aqm
[1],
824 ap_configuration
->aqm
[2], ap_configuration
->aqm
[3],
825 ap_configuration
->aqm
[4], ap_configuration
->aqm
[5],
826 ap_configuration
->aqm
[6], ap_configuration
->aqm
[7]);
829 static BUS_ATTR(ap_usage_domain_mask
, 0444,
830 ap_usage_domain_mask_show
, NULL
);
832 static ssize_t
ap_config_time_show(struct bus_type
*bus
, char *buf
)
834 return snprintf(buf
, PAGE_SIZE
, "%d\n", ap_config_time
);
837 static ssize_t
ap_interrupts_show(struct bus_type
*bus
, char *buf
)
839 return snprintf(buf
, PAGE_SIZE
, "%d\n",
840 ap_using_interrupts() ? 1 : 0);
843 static BUS_ATTR(ap_interrupts
, 0444, ap_interrupts_show
, NULL
);
845 static ssize_t
ap_config_time_store(struct bus_type
*bus
,
846 const char *buf
, size_t count
)
850 if (sscanf(buf
, "%d\n", &time
) != 1 || time
< 5 || time
> 120)
852 ap_config_time
= time
;
853 mod_timer(&ap_config_timer
, jiffies
+ ap_config_time
* HZ
);
857 static BUS_ATTR(config_time
, 0644, ap_config_time_show
, ap_config_time_store
);
859 static ssize_t
ap_poll_thread_show(struct bus_type
*bus
, char *buf
)
861 return snprintf(buf
, PAGE_SIZE
, "%d\n", ap_poll_kthread
? 1 : 0);
864 static ssize_t
ap_poll_thread_store(struct bus_type
*bus
,
865 const char *buf
, size_t count
)
869 if (sscanf(buf
, "%d\n", &flag
) != 1)
872 rc
= ap_poll_thread_start();
876 ap_poll_thread_stop();
880 static BUS_ATTR(poll_thread
, 0644, ap_poll_thread_show
, ap_poll_thread_store
);
882 static ssize_t
poll_timeout_show(struct bus_type
*bus
, char *buf
)
884 return snprintf(buf
, PAGE_SIZE
, "%llu\n", poll_timeout
);
887 static ssize_t
poll_timeout_store(struct bus_type
*bus
, const char *buf
,
890 unsigned long long time
;
893 /* 120 seconds = maximum poll interval */
894 if (sscanf(buf
, "%llu\n", &time
) != 1 || time
< 1 ||
895 time
> 120000000000ULL)
898 hr_time
= poll_timeout
;
900 spin_lock_bh(&ap_poll_timer_lock
);
901 hrtimer_cancel(&ap_poll_timer
);
902 hrtimer_set_expires(&ap_poll_timer
, hr_time
);
903 hrtimer_start_expires(&ap_poll_timer
, HRTIMER_MODE_ABS
);
904 spin_unlock_bh(&ap_poll_timer_lock
);
909 static BUS_ATTR(poll_timeout
, 0644, poll_timeout_show
, poll_timeout_store
);
911 static ssize_t
ap_max_domain_id_show(struct bus_type
*bus
, char *buf
)
915 if (ap_configuration
)
916 max_domain_id
= ap_max_domain_id
? : -1;
919 return snprintf(buf
, PAGE_SIZE
, "%d\n", max_domain_id
);
922 static BUS_ATTR(ap_max_domain_id
, 0444, ap_max_domain_id_show
, NULL
);
924 static struct bus_attribute
*const ap_bus_attrs
[] = {
926 &bus_attr_ap_control_domain_mask
,
927 &bus_attr_ap_usage_domain_mask
,
928 &bus_attr_config_time
,
929 &bus_attr_poll_thread
,
930 &bus_attr_ap_interrupts
,
931 &bus_attr_poll_timeout
,
932 &bus_attr_ap_max_domain_id
,
937 * ap_select_domain(): Select an AP domain.
939 * Pick one of the 16 AP domains.
941 static int ap_select_domain(void)
943 int count
, max_count
, best_domain
;
944 struct ap_queue_status status
;
948 * We want to use a single domain. Either the one specified with
949 * the "domain=" parameter or the domain with the maximum number
952 spin_lock_bh(&ap_domain_lock
);
953 if (ap_domain_index
>= 0) {
954 /* Domain has already been selected. */
955 spin_unlock_bh(&ap_domain_lock
);
960 for (i
= 0; i
< AP_DOMAINS
; i
++) {
961 if (!ap_test_config_domain(i
))
964 for (j
= 0; j
< AP_DEVICES
; j
++) {
965 if (!ap_test_config_card_id(j
))
967 status
= ap_test_queue(AP_MKQID(j
, i
),
970 if (status
.response_code
!= AP_RESPONSE_NORMAL
)
974 if (count
> max_count
) {
979 if (best_domain
>= 0){
980 ap_domain_index
= best_domain
;
981 AP_DBF(DBF_DEBUG
, "new ap_domain_index=%d\n", ap_domain_index
);
982 spin_unlock_bh(&ap_domain_lock
);
985 spin_unlock_bh(&ap_domain_lock
);
990 * This function checks the type and returns either 0 for not
991 * supported or the highest compatible type value (which may
992 * include the input type value).
994 static int ap_get_compatible_type(ap_qid_t qid
, int rawtype
, unsigned int func
)
998 /* < CEX2A is not supported */
999 if (rawtype
< AP_DEVICE_TYPE_CEX2A
)
1001 /* up to CEX6 known and fully supported */
1002 if (rawtype
<= AP_DEVICE_TYPE_CEX6
)
1005 * unknown new type > CEX6, check for compatibility
1006 * to the highest known and supported type which is
1007 * currently CEX6 with the help of the QACT function.
1009 if (ap_qact_available()) {
1010 struct ap_queue_status status
;
1011 union ap_qact_ap_info apinfo
= {0};
1013 apinfo
.mode
= (func
>> 26) & 0x07;
1014 apinfo
.cat
= AP_DEVICE_TYPE_CEX6
;
1015 status
= ap_qact(qid
, 0, &apinfo
);
1016 if (status
.response_code
== AP_RESPONSE_NORMAL
1017 && apinfo
.cat
>= AP_DEVICE_TYPE_CEX2A
1018 && apinfo
.cat
<= AP_DEVICE_TYPE_CEX6
)
1019 comp_type
= apinfo
.cat
;
1022 AP_DBF(DBF_WARN
, "queue=%02x.%04x unable to map type %d\n",
1023 AP_QID_CARD(qid
), AP_QID_QUEUE(qid
), rawtype
);
1024 else if (comp_type
!= rawtype
)
1025 AP_DBF(DBF_INFO
, "queue=%02x.%04x map type %d to %d\n",
1026 AP_QID_CARD(qid
), AP_QID_QUEUE(qid
), rawtype
, comp_type
);
1031 * helper function to be used with bus_find_dev
1032 * matches for the card device with the given id
1034 static int __match_card_device_with_id(struct device
*dev
, void *data
)
1036 return is_card_dev(dev
) && to_ap_card(dev
)->id
== (int)(long) data
;
1039 /* helper function to be used with bus_find_dev
1040 * matches for the queue device with a given qid
1042 static int __match_queue_device_with_qid(struct device
*dev
, void *data
)
1044 return is_queue_dev(dev
) && to_ap_queue(dev
)->qid
== (int)(long) data
;
1048 * ap_scan_bus(): Scan the AP bus for new devices
1049 * Runs periodically, workqueue timer (ap_config_time)
1051 static void ap_scan_bus(struct work_struct
*unused
)
1053 struct ap_queue
*aq
;
1057 int comp_type
, depth
= 0, type
= 0;
1058 unsigned int func
= 0;
1059 int rc
, id
, dom
, borked
, domains
, defdomdevs
= 0;
1061 AP_DBF(DBF_DEBUG
, "ap_scan_bus running\n");
1063 ap_query_configuration(ap_configuration
);
1064 if (ap_select_domain() != 0)
1067 for (id
= 0; id
< AP_DEVICES
; id
++) {
1068 /* check if device is registered */
1069 dev
= bus_find_device(&ap_bus_type
, NULL
,
1071 __match_card_device_with_id
);
1072 ac
= dev
? to_ap_card(dev
) : NULL
;
1073 if (!ap_test_config_card_id(id
)) {
1075 /* Card device has been removed from
1076 * configuration, remove the belonging
1079 bus_for_each_dev(&ap_bus_type
, NULL
,
1081 __ap_queue_devices_with_id_unregister
);
1082 /* now remove the card device */
1083 device_unregister(dev
);
1088 /* According to the configuration there should be a card
1089 * device, so check if there is at least one valid queue
1090 * and maybe create queue devices and the card device.
1093 for (dom
= 0; dom
< AP_DOMAINS
; dom
++) {
1094 qid
= AP_MKQID(id
, dom
);
1095 dev
= bus_find_device(&ap_bus_type
, NULL
,
1097 __match_queue_device_with_qid
);
1098 aq
= dev
? to_ap_queue(dev
) : NULL
;
1099 if (!ap_test_config_domain(dom
)) {
1101 /* Queue device exists but has been
1102 * removed from configuration.
1104 device_unregister(dev
);
1109 rc
= ap_query_queue(qid
, &depth
, &type
, &func
);
1111 spin_lock_bh(&aq
->lock
);
1112 if (rc
== -ENODEV
||
1113 /* adapter reconfiguration */
1114 (ac
&& ac
->functions
!= func
))
1115 aq
->state
= AP_STATE_BORKED
;
1116 borked
= aq
->state
== AP_STATE_BORKED
;
1117 spin_unlock_bh(&aq
->lock
);
1118 if (borked
) /* Remove broken device */
1119 device_unregister(dev
);
1123 if (dom
== ap_domain_index
)
1130 /* a new queue device is needed, check out comp type */
1131 comp_type
= ap_get_compatible_type(qid
, type
, func
);
1134 /* maybe a card device needs to be created first */
1136 ac
= ap_card_create(id
, depth
, type
,
1140 ac
->ap_dev
.device
.bus
= &ap_bus_type
;
1141 ac
->ap_dev
.device
.parent
= ap_root_device
;
1142 dev_set_name(&ac
->ap_dev
.device
,
1144 /* Register card with AP bus */
1145 rc
= device_register(&ac
->ap_dev
.device
);
1147 put_device(&ac
->ap_dev
.device
);
1151 /* get it and thus adjust reference counter */
1152 get_device(&ac
->ap_dev
.device
);
1154 /* now create the new queue device */
1155 aq
= ap_queue_create(qid
, comp_type
);
1159 aq
->ap_dev
.device
.bus
= &ap_bus_type
;
1160 aq
->ap_dev
.device
.parent
= &ac
->ap_dev
.device
;
1161 dev_set_name(&aq
->ap_dev
.device
,
1162 "%02x.%04x", id
, dom
);
1163 /* Start with a device reset */
1164 spin_lock_bh(&aq
->lock
);
1165 ap_wait(ap_sm_event(aq
, AP_EVENT_POLL
));
1166 spin_unlock_bh(&aq
->lock
);
1167 /* Register device */
1168 rc
= device_register(&aq
->ap_dev
.device
);
1170 put_device(&aq
->ap_dev
.device
);
1174 if (dom
== ap_domain_index
)
1176 } /* end domain loop */
1178 /* remove card dev if there are no queue devices */
1180 device_unregister(&ac
->ap_dev
.device
);
1181 put_device(&ac
->ap_dev
.device
);
1183 } /* end device loop */
1186 AP_DBF(DBF_INFO
, "no queue device with default domain %d available\n",
1190 mod_timer(&ap_config_timer
, jiffies
+ ap_config_time
* HZ
);
1193 static void ap_config_timeout(struct timer_list
*unused
)
1195 if (ap_suspend_flag
)
1197 queue_work(system_long_wq
, &ap_scan_work
);
1200 static void ap_reset_all(void)
1204 for (i
= 0; i
< AP_DOMAINS
; i
++) {
1205 if (!ap_test_config_domain(i
))
1207 for (j
= 0; j
< AP_DEVICES
; j
++) {
1208 if (!ap_test_config_card_id(j
))
1210 ap_rapq(AP_MKQID(j
, i
));
1215 static struct reset_call ap_reset_call
= {
1219 int __init
ap_debug_init(void)
1221 ap_dbf_info
= debug_register("ap", 1, 1,
1222 DBF_MAX_SPRINTF_ARGS
* sizeof(long));
1223 debug_register_view(ap_dbf_info
, &debug_sprintf_view
);
1224 debug_set_level(ap_dbf_info
, DBF_ERR
);
1229 void ap_debug_exit(void)
1231 debug_unregister(ap_dbf_info
);
1235 * ap_module_init(): The module initialization code.
1237 * Initializes the module.
1239 int __init
ap_module_init(void)
1244 rc
= ap_debug_init();
1248 if (ap_instructions_available() != 0) {
1249 pr_warn("The hardware system does not support AP instructions\n");
1253 /* Get AP configuration data if available */
1254 ap_init_configuration();
1256 if (ap_configuration
)
1258 ap_max_domain_id
? ap_max_domain_id
: AP_DOMAINS
- 1;
1261 if (ap_domain_index
< -1 || ap_domain_index
> max_domain_id
) {
1262 pr_warn("%d is not a valid cryptographic domain\n",
1264 ap_domain_index
= -1;
1266 /* In resume callback we need to know if the user had set the domain.
1267 * If so, we can not just reset it.
1269 if (ap_domain_index
>= 0)
1270 user_set_domain
= 1;
1272 if (ap_interrupts_available()) {
1273 rc
= register_adapter_interrupt(&ap_airq
);
1274 ap_airq_flag
= (rc
== 0);
1277 register_reset_call(&ap_reset_call
);
1279 /* Create /sys/bus/ap. */
1280 rc
= bus_register(&ap_bus_type
);
1283 for (i
= 0; ap_bus_attrs
[i
]; i
++) {
1284 rc
= bus_create_file(&ap_bus_type
, ap_bus_attrs
[i
]);
1289 /* Create /sys/devices/ap. */
1290 ap_root_device
= root_device_register("ap");
1291 rc
= PTR_RET(ap_root_device
);
1295 /* Setup the AP bus rescan timer. */
1296 timer_setup(&ap_config_timer
, ap_config_timeout
, 0);
1299 * Setup the high resultion poll timer.
1300 * If we are running under z/VM adjust polling to z/VM polling rate.
1303 poll_timeout
= 1500000;
1304 spin_lock_init(&ap_poll_timer_lock
);
1305 hrtimer_init(&ap_poll_timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_ABS
);
1306 ap_poll_timer
.function
= ap_poll_timeout
;
1308 /* Start the low priority AP bus poll thread. */
1309 if (ap_thread_flag
) {
1310 rc
= ap_poll_thread_start();
1315 rc
= register_pm_notifier(&ap_power_notifier
);
1319 queue_work(system_long_wq
, &ap_scan_work
);
1325 ap_poll_thread_stop();
1327 hrtimer_cancel(&ap_poll_timer
);
1328 root_device_unregister(ap_root_device
);
1331 bus_remove_file(&ap_bus_type
, ap_bus_attrs
[i
]);
1332 bus_unregister(&ap_bus_type
);
1334 unregister_reset_call(&ap_reset_call
);
1335 if (ap_using_interrupts())
1336 unregister_adapter_interrupt(&ap_airq
);
1337 kfree(ap_configuration
);
1340 device_initcall(ap_module_init
);