1 // SPDX-License-Identifier: GPL-2.0
3 * Driver for s390 chsc subchannels
5 * Copyright IBM Corp. 2008, 2011
7 * Author(s): Cornelia Huck <cornelia.huck@de.ibm.com>
11 #include <linux/slab.h>
12 #include <linux/compat.h>
13 #include <linux/device.h>
14 #include <linux/module.h>
15 #include <linux/uaccess.h>
16 #include <linux/miscdevice.h>
17 #include <linux/kernel_stat.h>
24 #include "cio_debug.h"
29 static debug_info_t *chsc_debug_msg_id;
30 static debug_info_t *chsc_debug_log_id;
32 static struct chsc_request *on_close_request;
33 static struct chsc_async_area *on_close_chsc_area;
34 static DEFINE_MUTEX(on_close_mutex);
36 #define CHSC_MSG(imp, args...) do { \
37 debug_sprintf_event(chsc_debug_msg_id, imp , ##args); \
40 #define CHSC_LOG(imp, txt) do { \
41 debug_text_event(chsc_debug_log_id, imp , txt); \
44 static void CHSC_LOG_HEX(int level, void *data, int length)
46 debug_event(chsc_debug_log_id, level, data, length);
49 MODULE_AUTHOR("IBM Corporation");
50 MODULE_DESCRIPTION("driver for s390 chsc subchannels");
51 MODULE_LICENSE("GPL");
53 static void chsc_subchannel_irq(struct subchannel *sch)
55 struct chsc_private *private = dev_get_drvdata(&sch->dev);
56 struct chsc_request *request = private->request;
57 struct irb *irb = this_cpu_ptr(&cio_irb);
60 CHSC_LOG_HEX(4, irb, sizeof(*irb));
61 inc_irq_stat(IRQIO_CSC);
63 /* Copy irb to provided request and set done. */
65 CHSC_MSG(0, "Interrupt on sch 0.%x.%04x with no request\n",
66 sch->schid.ssid, sch->schid.sch_no);
69 private->request = NULL;
70 memcpy(&request->irb, irb, sizeof(*irb));
71 cio_update_schib(sch);
72 complete(&request->completion);
73 put_device(&sch->dev);
76 static int chsc_subchannel_probe(struct subchannel *sch)
78 struct chsc_private *private;
81 CHSC_MSG(6, "Detected chsc subchannel 0.%x.%04x\n",
82 sch->schid.ssid, sch->schid.sch_no);
83 sch->isc = CHSC_SCH_ISC;
84 private = kzalloc(sizeof(*private), GFP_KERNEL);
87 dev_set_drvdata(&sch->dev, private);
88 ret = cio_enable_subchannel(sch, (u32)(unsigned long)sch);
90 CHSC_MSG(0, "Failed to enable 0.%x.%04x: %d\n",
91 sch->schid.ssid, sch->schid.sch_no, ret);
92 dev_set_drvdata(&sch->dev, NULL);
95 if (dev_get_uevent_suppress(&sch->dev)) {
96 dev_set_uevent_suppress(&sch->dev, 0);
97 kobject_uevent(&sch->dev.kobj, KOBJ_ADD);
103 static void chsc_subchannel_remove(struct subchannel *sch)
105 struct chsc_private *private;
107 cio_disable_subchannel(sch);
108 private = dev_get_drvdata(&sch->dev);
109 dev_set_drvdata(&sch->dev, NULL);
110 if (private->request) {
111 complete(&private->request->completion);
112 put_device(&sch->dev);
117 static void chsc_subchannel_shutdown(struct subchannel *sch)
119 cio_disable_subchannel(sch);
122 static struct css_device_id chsc_subchannel_ids[] = {
123 { .match_flags = 0x1, .type =SUBCHANNEL_TYPE_CHSC, },
124 { /* end of list */ },
126 MODULE_DEVICE_TABLE(css, chsc_subchannel_ids);
128 static struct css_driver chsc_subchannel_driver = {
130 .owner = THIS_MODULE,
131 .name = "chsc_subchannel",
133 .subchannel_type = chsc_subchannel_ids,
134 .irq = chsc_subchannel_irq,
135 .probe = chsc_subchannel_probe,
136 .remove = chsc_subchannel_remove,
137 .shutdown = chsc_subchannel_shutdown,
140 static int __init chsc_init_dbfs(void)
142 chsc_debug_msg_id = debug_register("chsc_msg", 8, 1, 4 * sizeof(long));
143 if (!chsc_debug_msg_id)
145 debug_register_view(chsc_debug_msg_id, &debug_sprintf_view);
146 debug_set_level(chsc_debug_msg_id, 2);
147 chsc_debug_log_id = debug_register("chsc_log", 16, 1, 16);
148 if (!chsc_debug_log_id)
150 debug_register_view(chsc_debug_log_id, &debug_hex_ascii_view);
151 debug_set_level(chsc_debug_log_id, 2);
154 debug_unregister(chsc_debug_msg_id);
158 static void chsc_remove_dbfs(void)
160 debug_unregister(chsc_debug_log_id);
161 debug_unregister(chsc_debug_msg_id);
164 static int __init chsc_init_sch_driver(void)
166 return css_driver_register(&chsc_subchannel_driver);
169 static void chsc_cleanup_sch_driver(void)
171 css_driver_unregister(&chsc_subchannel_driver);
174 static DEFINE_SPINLOCK(chsc_lock);
176 static int chsc_subchannel_match_next_free(struct device *dev, const void *data)
178 struct subchannel *sch = to_subchannel(dev);
180 return sch->schib.pmcw.ena && !scsw_fctl(&sch->schib.scsw);
183 static struct subchannel *chsc_get_next_subchannel(struct subchannel *sch)
187 dev = driver_find_device(&chsc_subchannel_driver.drv,
188 sch ? &sch->dev : NULL, NULL,
189 chsc_subchannel_match_next_free);
190 return dev ? to_subchannel(dev) : NULL;
194 * chsc_async() - try to start a chsc request asynchronously
195 * @chsc_area: request to be started
196 * @request: request structure to associate
198 * Tries to start a chsc request on one of the existing chsc subchannels.
200 * %0 if the request was performed synchronously
201 * %-EINPROGRESS if the request was successfully started
202 * %-EBUSY if all chsc subchannels are busy
203 * %-ENODEV if no chsc subchannels are available
205 * interrupts disabled, chsc_lock held
207 static int chsc_async(struct chsc_async_area *chsc_area,
208 struct chsc_request *request)
211 struct chsc_private *private;
212 struct subchannel *sch = NULL;
216 chsc_area->header.key = PAGE_DEFAULT_KEY >> 4;
217 while ((sch = chsc_get_next_subchannel(sch))) {
218 spin_lock(sch->lock);
219 private = dev_get_drvdata(&sch->dev);
220 if (private->request) {
221 spin_unlock(sch->lock);
225 chsc_area->header.sid = sch->schid;
226 CHSC_LOG(2, "schid");
227 CHSC_LOG_HEX(2, &sch->schid, sizeof(sch->schid));
228 cc = chsc(chsc_area);
229 snprintf(dbf, sizeof(dbf), "cc:%d", cc);
236 sch->schib.scsw.cmd.fctl |= SCSW_FCTL_START_FUNC;
238 private->request = request;
246 spin_unlock(sch->lock);
247 CHSC_MSG(2, "chsc on 0.%x.%04x returned cc=%d\n",
248 sch->schid.ssid, sch->schid.sch_no, cc);
249 if (ret == -EINPROGRESS)
251 put_device(&sch->dev);
258 static void chsc_log_command(void *chsc_area)
262 snprintf(dbf, sizeof(dbf), "CHSC:%x", ((uint16_t *)chsc_area)[1]);
264 CHSC_LOG_HEX(0, chsc_area, 32);
267 static int chsc_examine_irb(struct chsc_request *request)
271 if (!(scsw_stctl(&request->irb.scsw) & SCSW_STCTL_STATUS_PEND))
273 backed_up = scsw_cstat(&request->irb.scsw) & SCHN_STAT_CHAIN_CHECK;
274 request->irb.scsw.cmd.cstat &= ~SCHN_STAT_CHAIN_CHECK;
275 if (scsw_cstat(&request->irb.scsw) == 0)
279 if (scsw_cstat(&request->irb.scsw) & SCHN_STAT_PROG_CHECK)
281 if (scsw_cstat(&request->irb.scsw) & SCHN_STAT_PROT_CHECK)
283 if (scsw_cstat(&request->irb.scsw) & SCHN_STAT_CHN_DATA_CHK)
285 if (scsw_cstat(&request->irb.scsw) & SCHN_STAT_CHN_CTRL_CHK)
290 static int chsc_ioctl_start(void __user *user_area)
292 struct chsc_request *request;
293 struct chsc_async_area *chsc_area;
297 if (!css_general_characteristics.dynio)
298 /* It makes no sense to try. */
300 chsc_area = (void *)get_zeroed_page(GFP_DMA | GFP_KERNEL);
303 request = kzalloc(sizeof(*request), GFP_KERNEL);
308 init_completion(&request->completion);
309 if (copy_from_user(chsc_area, user_area, PAGE_SIZE)) {
313 chsc_log_command(chsc_area);
314 spin_lock_irq(&chsc_lock);
315 ret = chsc_async(chsc_area, request);
316 spin_unlock_irq(&chsc_lock);
317 if (ret == -EINPROGRESS) {
318 wait_for_completion(&request->completion);
319 ret = chsc_examine_irb(request);
321 /* copy area back to user */
323 if (copy_to_user(user_area, chsc_area, PAGE_SIZE))
326 snprintf(dbf, sizeof(dbf), "ret:%d", ret);
329 free_page((unsigned long)chsc_area);
333 static int chsc_ioctl_on_close_set(void __user *user_area)
338 mutex_lock(&on_close_mutex);
339 if (on_close_chsc_area) {
343 on_close_request = kzalloc(sizeof(*on_close_request), GFP_KERNEL);
344 if (!on_close_request) {
348 on_close_chsc_area = (void *)get_zeroed_page(GFP_DMA | GFP_KERNEL);
349 if (!on_close_chsc_area) {
351 goto out_free_request;
353 if (copy_from_user(on_close_chsc_area, user_area, PAGE_SIZE)) {
361 free_page((unsigned long)on_close_chsc_area);
362 on_close_chsc_area = NULL;
364 kfree(on_close_request);
365 on_close_request = NULL;
367 mutex_unlock(&on_close_mutex);
368 snprintf(dbf, sizeof(dbf), "ocsret:%d", ret);
373 static int chsc_ioctl_on_close_remove(void)
378 mutex_lock(&on_close_mutex);
379 if (!on_close_chsc_area) {
383 free_page((unsigned long)on_close_chsc_area);
384 on_close_chsc_area = NULL;
385 kfree(on_close_request);
386 on_close_request = NULL;
389 mutex_unlock(&on_close_mutex);
390 snprintf(dbf, sizeof(dbf), "ocrret:%d", ret);
395 static int chsc_ioctl_start_sync(void __user *user_area)
397 struct chsc_sync_area *chsc_area;
400 chsc_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
403 if (copy_from_user(chsc_area, user_area, PAGE_SIZE)) {
407 if (chsc_area->header.code & 0x4000) {
411 chsc_log_command(chsc_area);
412 ccode = chsc(chsc_area);
417 if (copy_to_user(user_area, chsc_area, PAGE_SIZE))
422 free_page((unsigned long)chsc_area);
426 static int chsc_ioctl_info_channel_path(void __user *user_cd)
428 struct chsc_chp_cd *cd;
431 struct chsc_header request;
442 struct chsc_header response;
443 u8 data[PAGE_SIZE - 20];
444 } __attribute__ ((packed)) *scpcd_area;
446 scpcd_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
449 cd = kzalloc(sizeof(*cd), GFP_KERNEL);
454 if (copy_from_user(cd, user_cd, sizeof(*cd))) {
458 scpcd_area->request.length = 0x0010;
459 scpcd_area->request.code = 0x0028;
460 scpcd_area->m = cd->m;
461 scpcd_area->fmt1 = cd->fmt;
462 scpcd_area->cssid = cd->chpid.cssid;
463 scpcd_area->first_chpid = cd->chpid.id;
464 scpcd_area->last_chpid = cd->chpid.id;
466 ccode = chsc(scpcd_area);
471 if (scpcd_area->response.code != 0x0001) {
473 CHSC_MSG(0, "scpcd: response code=%x\n",
474 scpcd_area->response.code);
477 memcpy(&cd->cpcb, &scpcd_area->response, scpcd_area->response.length);
478 if (copy_to_user(user_cd, cd, sizeof(*cd)))
484 free_page((unsigned long)scpcd_area);
488 static int chsc_ioctl_info_cu(void __user *user_cd)
490 struct chsc_cu_cd *cd;
493 struct chsc_header request;
504 struct chsc_header response;
505 u8 data[PAGE_SIZE - 20];
506 } __attribute__ ((packed)) *scucd_area;
508 scucd_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
511 cd = kzalloc(sizeof(*cd), GFP_KERNEL);
516 if (copy_from_user(cd, user_cd, sizeof(*cd))) {
520 scucd_area->request.length = 0x0010;
521 scucd_area->request.code = 0x0026;
522 scucd_area->m = cd->m;
523 scucd_area->fmt1 = cd->fmt;
524 scucd_area->cssid = cd->cssid;
525 scucd_area->first_cun = cd->cun;
526 scucd_area->last_cun = cd->cun;
528 ccode = chsc(scucd_area);
533 if (scucd_area->response.code != 0x0001) {
535 CHSC_MSG(0, "scucd: response code=%x\n",
536 scucd_area->response.code);
539 memcpy(&cd->cucb, &scucd_area->response, scucd_area->response.length);
540 if (copy_to_user(user_cd, cd, sizeof(*cd)))
546 free_page((unsigned long)scucd_area);
550 static int chsc_ioctl_info_sch_cu(void __user *user_cud)
552 struct chsc_sch_cud *cud;
555 struct chsc_header request;
567 struct chsc_header response;
568 u8 data[PAGE_SIZE - 20];
569 } __attribute__ ((packed)) *sscud_area;
571 sscud_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
574 cud = kzalloc(sizeof(*cud), GFP_KERNEL);
579 if (copy_from_user(cud, user_cud, sizeof(*cud))) {
583 sscud_area->request.length = 0x0010;
584 sscud_area->request.code = 0x0006;
585 sscud_area->m = cud->schid.m;
586 sscud_area->fmt1 = cud->fmt;
587 sscud_area->ssid = cud->schid.ssid;
588 sscud_area->first_sch = cud->schid.sch_no;
589 sscud_area->cssid = cud->schid.cssid;
590 sscud_area->last_sch = cud->schid.sch_no;
592 ccode = chsc(sscud_area);
597 if (sscud_area->response.code != 0x0001) {
599 CHSC_MSG(0, "sscud: response code=%x\n",
600 sscud_area->response.code);
603 memcpy(&cud->scub, &sscud_area->response, sscud_area->response.length);
604 if (copy_to_user(user_cud, cud, sizeof(*cud)))
610 free_page((unsigned long)sscud_area);
614 static int chsc_ioctl_conf_info(void __user *user_ci)
616 struct chsc_conf_info *ci;
619 struct chsc_header request;
629 struct chsc_header response;
630 u8 data[PAGE_SIZE - 20];
631 } __attribute__ ((packed)) *sci_area;
633 sci_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
636 ci = kzalloc(sizeof(*ci), GFP_KERNEL);
641 if (copy_from_user(ci, user_ci, sizeof(*ci))) {
645 sci_area->request.length = 0x0010;
646 sci_area->request.code = 0x0012;
647 sci_area->m = ci->id.m;
648 sci_area->fmt1 = ci->fmt;
649 sci_area->cssid = ci->id.cssid;
650 sci_area->ssid = ci->id.ssid;
652 ccode = chsc(sci_area);
657 if (sci_area->response.code != 0x0001) {
659 CHSC_MSG(0, "sci: response code=%x\n",
660 sci_area->response.code);
663 memcpy(&ci->scid, &sci_area->response, sci_area->response.length);
664 if (copy_to_user(user_ci, ci, sizeof(*ci)))
670 free_page((unsigned long)sci_area);
674 static int chsc_ioctl_conf_comp_list(void __user *user_ccl)
676 struct chsc_comp_list *ccl;
679 struct chsc_header request;
687 struct chsc_header response;
688 u8 data[PAGE_SIZE - 36];
689 } __attribute__ ((packed)) *sccl_area;
696 } __attribute__ ((packed)) *chpid_parm;
702 } __attribute__ ((packed)) *cssids_parm;
704 sccl_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
707 ccl = kzalloc(sizeof(*ccl), GFP_KERNEL);
712 if (copy_from_user(ccl, user_ccl, sizeof(*ccl))) {
716 sccl_area->request.length = 0x0020;
717 sccl_area->request.code = 0x0030;
718 sccl_area->fmt = ccl->req.fmt;
719 sccl_area->ctype = ccl->req.ctype;
720 switch (sccl_area->ctype) {
723 chpid_parm = (void *)&sccl_area->list_parm;
724 chpid_parm->m = ccl->req.chpid.m;
725 chpid_parm->cssid = ccl->req.chpid.chp.cssid;
726 chpid_parm->chpid = ccl->req.chpid.chp.id;
729 case CCL_CSS_IMG_CONF_CHAR:
730 cssids_parm = (void *)&sccl_area->list_parm;
731 cssids_parm->f_cssid = ccl->req.cssids.f_cssid;
732 cssids_parm->l_cssid = ccl->req.cssids.l_cssid;
735 ccode = chsc(sccl_area);
740 if (sccl_area->response.code != 0x0001) {
742 CHSC_MSG(0, "sccl: response code=%x\n",
743 sccl_area->response.code);
746 memcpy(&ccl->sccl, &sccl_area->response, sccl_area->response.length);
747 if (copy_to_user(user_ccl, ccl, sizeof(*ccl)))
753 free_page((unsigned long)sccl_area);
757 static int chsc_ioctl_chpd(void __user *user_chpd)
759 struct chsc_scpd *scpd_area;
760 struct chsc_cpd_info *chpd;
763 chpd = kzalloc(sizeof(*chpd), GFP_KERNEL);
764 scpd_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
765 if (!scpd_area || !chpd) {
769 if (copy_from_user(chpd, user_chpd, sizeof(*chpd))) {
773 ret = chsc_determine_channel_path_desc(chpd->chpid, chpd->fmt,
774 chpd->rfmt, chpd->c, chpd->m,
778 memcpy(&chpd->chpdb, &scpd_area->response, scpd_area->response.length);
779 if (copy_to_user(user_chpd, chpd, sizeof(*chpd)))
783 free_page((unsigned long)scpd_area);
787 static int chsc_ioctl_dcal(void __user *user_dcal)
789 struct chsc_dcal *dcal;
792 struct chsc_header request;
800 struct chsc_header response;
801 u8 data[PAGE_SIZE - 36];
802 } __attribute__ ((packed)) *sdcal_area;
804 sdcal_area = (void *)get_zeroed_page(GFP_KERNEL | GFP_DMA);
807 dcal = kzalloc(sizeof(*dcal), GFP_KERNEL);
812 if (copy_from_user(dcal, user_dcal, sizeof(*dcal))) {
816 sdcal_area->request.length = 0x0020;
817 sdcal_area->request.code = 0x0034;
818 sdcal_area->atype = dcal->req.atype;
819 sdcal_area->fmt = dcal->req.fmt;
820 memcpy(&sdcal_area->list_parm, &dcal->req.list_parm,
821 sizeof(sdcal_area->list_parm));
823 ccode = chsc(sdcal_area);
828 if (sdcal_area->response.code != 0x0001) {
830 CHSC_MSG(0, "sdcal: response code=%x\n",
831 sdcal_area->response.code);
834 memcpy(&dcal->sdcal, &sdcal_area->response,
835 sdcal_area->response.length);
836 if (copy_to_user(user_dcal, dcal, sizeof(*dcal)))
842 free_page((unsigned long)sdcal_area);
846 static long chsc_ioctl(struct file *filp, unsigned int cmd,
851 CHSC_MSG(2, "chsc_ioctl called, cmd=%x\n", cmd);
852 if (is_compat_task())
853 argp = compat_ptr(arg);
855 argp = (void __user *)arg;
858 return chsc_ioctl_start(argp);
859 case CHSC_START_SYNC:
860 return chsc_ioctl_start_sync(argp);
861 case CHSC_INFO_CHANNEL_PATH:
862 return chsc_ioctl_info_channel_path(argp);
864 return chsc_ioctl_info_cu(argp);
865 case CHSC_INFO_SCH_CU:
866 return chsc_ioctl_info_sch_cu(argp);
868 return chsc_ioctl_conf_info(argp);
870 return chsc_ioctl_conf_comp_list(argp);
872 return chsc_ioctl_chpd(argp);
874 return chsc_ioctl_dcal(argp);
875 case CHSC_ON_CLOSE_SET:
876 return chsc_ioctl_on_close_set(argp);
877 case CHSC_ON_CLOSE_REMOVE:
878 return chsc_ioctl_on_close_remove();
879 default: /* unknown ioctl number */
884 static atomic_t chsc_ready_for_use = ATOMIC_INIT(1);
886 static int chsc_open(struct inode *inode, struct file *file)
888 if (!atomic_dec_and_test(&chsc_ready_for_use)) {
889 atomic_inc(&chsc_ready_for_use);
892 return nonseekable_open(inode, file);
895 static int chsc_release(struct inode *inode, struct file *filp)
900 mutex_lock(&on_close_mutex);
901 if (!on_close_chsc_area)
903 init_completion(&on_close_request->completion);
904 CHSC_LOG(0, "on_close");
905 chsc_log_command(on_close_chsc_area);
906 spin_lock_irq(&chsc_lock);
907 ret = chsc_async(on_close_chsc_area, on_close_request);
908 spin_unlock_irq(&chsc_lock);
909 if (ret == -EINPROGRESS) {
910 wait_for_completion(&on_close_request->completion);
911 ret = chsc_examine_irb(on_close_request);
913 snprintf(dbf, sizeof(dbf), "relret:%d", ret);
915 free_page((unsigned long)on_close_chsc_area);
916 on_close_chsc_area = NULL;
917 kfree(on_close_request);
918 on_close_request = NULL;
920 mutex_unlock(&on_close_mutex);
921 atomic_inc(&chsc_ready_for_use);
925 static const struct file_operations chsc_fops = {
926 .owner = THIS_MODULE,
928 .release = chsc_release,
929 .unlocked_ioctl = chsc_ioctl,
930 .compat_ioctl = chsc_ioctl,
934 static struct miscdevice chsc_misc_device = {
935 .minor = MISC_DYNAMIC_MINOR,
940 static int __init chsc_misc_init(void)
942 return misc_register(&chsc_misc_device);
945 static void chsc_misc_cleanup(void)
947 misc_deregister(&chsc_misc_device);
950 static int __init chsc_sch_init(void)
954 ret = chsc_init_dbfs();
957 isc_register(CHSC_SCH_ISC);
958 ret = chsc_init_sch_driver();
961 ret = chsc_misc_init();
966 chsc_cleanup_sch_driver();
968 isc_unregister(CHSC_SCH_ISC);
973 static void __exit chsc_sch_exit(void)
976 chsc_cleanup_sch_driver();
977 isc_unregister(CHSC_SCH_ISC);
981 module_init(chsc_sch_init);
982 module_exit(chsc_sch_exit);