2 * IUCV base infrastructure.
4 * Copyright 2001, 2006 IBM Deutschland Entwicklung GmbH, IBM Corporation
7 * Alan Altmark (Alan_Altmark@us.ibm.com) Sept. 2000
8 * Xenia Tkatschow (xenia@us.ibm.com)
9 * 2Gb awareness and general cleanup:
10 * Fritz Elfert (elfert@de.ibm.com, felfert@millenux.com)
11 * Rewritten for af_iucv:
12 * Martin Schwidefsky <schwidefsky@de.ibm.com>
16 * CP Programming Service, IBM document # SC24-5760
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2, or (at your option)
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
33 #include <linux/module.h>
34 #include <linux/moduleparam.h>
35 #include <linux/spinlock.h>
36 #include <linux/kernel.h>
37 #include <linux/slab.h>
38 #include <linux/init.h>
39 #include <linux/interrupt.h>
40 #include <linux/list.h>
41 #include <linux/errno.h>
42 #include <linux/err.h>
43 #include <linux/device.h>
44 #include <linux/cpu.h>
45 #include <net/iucv/iucv.h>
46 #include <asm/atomic.h>
47 #include <asm/ebcdic.h>
49 #include <asm/s390_ext.h>
50 #include <asm/s390_rdev.h>
55 * All flags are defined in the field IPFLAGS1 of each function
56 * and can be found in CP Programming Services.
57 * IPSRCCLS - Indicates you have specified a source class.
58 * IPTRGCLS - Indicates you have specified a target class.
59 * IPFGPID - Indicates you have specified a pathid.
60 * IPFGMID - Indicates you have specified a message ID.
61 * IPNORPY - Indicates a one-way message. No reply expected.
62 * IPALL - Indicates that all paths are affected.
64 #define IUCV_IPSRCCLS 0x01
65 #define IUCV_IPTRGCLS 0x01
66 #define IUCV_IPFGPID 0x02
67 #define IUCV_IPFGMID 0x04
68 #define IUCV_IPNORPY 0x10
69 #define IUCV_IPALL 0x80
71 static int iucv_bus_match(struct device *dev, struct device_driver *drv)
76 struct bus_type iucv_bus = {
78 .match = iucv_bus_match,
80 EXPORT_SYMBOL(iucv_bus);
82 struct device *iucv_root;
83 EXPORT_SYMBOL(iucv_root);
85 static int iucv_available;
87 /* General IUCV interrupt structure */
88 struct iucv_irq_data {
95 struct iucv_irq_list {
96 struct list_head list;
97 struct iucv_irq_data data;
100 static struct iucv_irq_data *iucv_irq_data;
101 static cpumask_t iucv_buffer_cpumask = CPU_MASK_NONE;
102 static cpumask_t iucv_irq_cpumask = CPU_MASK_NONE;
105 * Queue of interrupt buffers lock for delivery via the tasklet
106 * (fast but can't call smp_call_function).
108 static LIST_HEAD(iucv_task_queue);
111 * The tasklet for fast delivery of iucv interrupts.
113 static void iucv_tasklet_fn(unsigned long);
114 static DECLARE_TASKLET(iucv_tasklet, iucv_tasklet_fn,0);
117 * Queue of interrupt buffers for delivery via a work queue
118 * (slower but can call smp_call_function).
120 static LIST_HEAD(iucv_work_queue);
123 * The work element to deliver path pending interrupts.
125 static void iucv_work_fn(struct work_struct *work);
126 static DECLARE_WORK(iucv_work, iucv_work_fn);
129 * Spinlock protecting task and work queue.
131 static DEFINE_SPINLOCK(iucv_queue_lock);
133 enum iucv_command_codes {
135 IUCV_RETRIEVE_BUFFER = 2,
143 IUCV_DECLARE_BUFFER = 12,
151 * Error messages that are used with the iucv_sever function. They get
152 * converted to EBCDIC.
154 static char iucv_error_no_listener[16] = "NO LISTENER";
155 static char iucv_error_no_memory[16] = "NO MEMORY";
156 static char iucv_error_pathid[16] = "INVALID PATHID";
159 * iucv_handler_list: List of registered handlers.
161 static LIST_HEAD(iucv_handler_list);
164 * iucv_path_table: an array of iucv_path structures.
166 static struct iucv_path **iucv_path_table;
167 static unsigned long iucv_max_pathid;
170 * iucv_lock: spinlock protecting iucv_handler_list and iucv_pathid_table
172 static DEFINE_SPINLOCK(iucv_table_lock);
175 * iucv_active_cpu: contains the number of the cpu executing the tasklet
176 * or the work handler. Needed for iucv_path_sever called from tasklet.
178 static int iucv_active_cpu = -1;
181 * Mutex and wait queue for iucv_register/iucv_unregister.
183 static DEFINE_MUTEX(iucv_register_mutex);
186 * Counter for number of non-smp capable handlers.
188 static int iucv_nonsmp_handler;
191 * IUCV control data structure. Used by iucv_path_accept, iucv_path_connect,
192 * iucv_path_quiesce and iucv_path_sever.
194 struct iucv_cmd_control {
203 } __attribute__ ((packed,aligned(8)));
206 * Data in parameter list iucv structure. Used by iucv_message_send,
207 * iucv_message_send2way and iucv_message_reply.
209 struct iucv_cmd_dpl {
221 } __attribute__ ((packed,aligned(8)));
224 * Data in buffer iucv structure. Used by iucv_message_receive,
225 * iucv_message_reject, iucv_message_send, iucv_message_send2way
226 * and iucv_declare_cpu.
241 } __attribute__ ((packed,aligned(8)));
244 * Purge message iucv structure. Used by iucv_message_purge.
246 struct iucv_cmd_purge {
257 } __attribute__ ((packed,aligned(8)));
260 * Set mask iucv structure. Used by iucv_enable_cpu.
262 struct iucv_cmd_set_mask {
267 } __attribute__ ((packed,aligned(8)));
270 struct iucv_cmd_control ctrl;
271 struct iucv_cmd_dpl dpl;
272 struct iucv_cmd_db db;
273 struct iucv_cmd_purge purge;
274 struct iucv_cmd_set_mask set_mask;
278 * Anchor for per-cpu IUCV command parameter block.
280 static union iucv_param *iucv_param;
284 * @code: identifier of IUCV call to CP.
285 * @parm: pointer to a struct iucv_parm block
287 * Calls CP to execute IUCV commands.
289 * Returns the result of the CP IUCV call.
291 static inline int iucv_call_b2f0(int command, union iucv_param *parm)
293 register unsigned long reg0 asm ("0");
294 register unsigned long reg1 asm ("1");
298 reg1 = virt_to_phys(parm);
300 " .long 0xb2f01000\n"
303 : "=d" (ccode), "=m" (*parm), "+d" (reg0), "+a" (reg1)
304 : "m" (*parm) : "cc");
305 return (ccode == 1) ? parm->ctrl.iprcode : ccode;
311 * Determines the maximum number of connections that may be established.
313 * Returns the maximum number of connections or -EPERM is IUCV is not
316 static int iucv_query_maxconn(void)
318 register unsigned long reg0 asm ("0");
319 register unsigned long reg1 asm ("1");
323 param = kzalloc(sizeof(union iucv_param), GFP_KERNEL|GFP_DMA);
327 reg1 = (unsigned long) param;
329 " .long 0xb2f01000\n"
332 : "=d" (ccode), "+d" (reg0), "+d" (reg1) : : "cc");
334 iucv_max_pathid = reg0;
336 return ccode ? -EPERM : 0;
343 * Allow iucv interrupts on this cpu.
345 static void iucv_allow_cpu(void *data)
347 int cpu = smp_processor_id();
348 union iucv_param *parm;
351 * Enable all iucv interrupts.
352 * ipmask contains bits for the different interrupts
353 * 0x80 - Flag to allow nonpriority message pending interrupts
354 * 0x40 - Flag to allow priority message pending interrupts
355 * 0x20 - Flag to allow nonpriority message completion interrupts
356 * 0x10 - Flag to allow priority message completion interrupts
357 * 0x08 - Flag to allow IUCV control interrupts
359 parm = percpu_ptr(iucv_param, smp_processor_id());
360 memset(parm, 0, sizeof(union iucv_param));
361 parm->set_mask.ipmask = 0xf8;
362 iucv_call_b2f0(IUCV_SETMASK, parm);
364 /* Set indication that iucv interrupts are allowed for this cpu. */
365 cpu_set(cpu, iucv_irq_cpumask);
372 * Block iucv interrupts on this cpu.
374 static void iucv_block_cpu(void *data)
376 int cpu = smp_processor_id();
377 union iucv_param *parm;
379 /* Disable all iucv interrupts. */
380 parm = percpu_ptr(iucv_param, smp_processor_id());
381 memset(parm, 0, sizeof(union iucv_param));
382 iucv_call_b2f0(IUCV_SETMASK, parm);
384 /* Clear indication that iucv interrupts are allowed for this cpu. */
385 cpu_clear(cpu, iucv_irq_cpumask);
392 * Declare a interupt buffer on this cpu.
394 static void iucv_declare_cpu(void *data)
396 int cpu = smp_processor_id();
397 union iucv_param *parm;
400 if (cpu_isset(cpu, iucv_buffer_cpumask))
403 /* Declare interrupt buffer. */
404 parm = percpu_ptr(iucv_param, cpu);
405 memset(parm, 0, sizeof(union iucv_param));
406 parm->db.ipbfadr1 = virt_to_phys(percpu_ptr(iucv_irq_data, cpu));
407 rc = iucv_call_b2f0(IUCV_DECLARE_BUFFER, parm);
409 char *err = "Unknown";
412 err = "Directory error";
415 err = "Invalid length";
418 err = "Buffer already exists";
421 err = "Buffer overlap";
424 err = "Paging or storage error";
427 printk(KERN_WARNING "iucv_register: iucv_declare_buffer "
428 "on cpu %i returned error 0x%02x (%s)\n", cpu, rc, err);
432 /* Set indication that an iucv buffer exists for this cpu. */
433 cpu_set(cpu, iucv_buffer_cpumask);
435 if (iucv_nonsmp_handler == 0 || cpus_empty(iucv_irq_cpumask))
436 /* Enable iucv interrupts on this cpu. */
437 iucv_allow_cpu(NULL);
439 /* Disable iucv interrupts on this cpu. */
440 iucv_block_cpu(NULL);
447 * Retrieve interrupt buffer on this cpu.
449 static void iucv_retrieve_cpu(void *data)
451 int cpu = smp_processor_id();
452 union iucv_param *parm;
454 if (!cpu_isset(cpu, iucv_buffer_cpumask))
457 /* Block iucv interrupts. */
458 iucv_block_cpu(NULL);
460 /* Retrieve interrupt buffer. */
461 parm = percpu_ptr(iucv_param, cpu);
462 iucv_call_b2f0(IUCV_RETRIEVE_BUFFER, parm);
464 /* Clear indication that an iucv buffer exists for this cpu. */
465 cpu_clear(cpu, iucv_buffer_cpumask);
471 * Allow iucv interrupts on all cpus.
473 static void iucv_setmask_mp(void)
478 for_each_online_cpu(cpu)
479 /* Enable all cpus with a declared buffer. */
480 if (cpu_isset(cpu, iucv_buffer_cpumask) &&
481 !cpu_isset(cpu, iucv_irq_cpumask))
482 smp_call_function_on(iucv_allow_cpu, NULL, 0, 1, cpu);
489 * Allow iucv interrupts on a single cpu.
491 static void iucv_setmask_up(void)
496 /* Disable all cpu but the first in cpu_irq_cpumask. */
497 cpumask = iucv_irq_cpumask;
498 cpu_clear(first_cpu(iucv_irq_cpumask), cpumask);
499 for_each_cpu_mask(cpu, cpumask)
500 smp_call_function_on(iucv_block_cpu, NULL, 0, 1, cpu);
506 * This function makes iucv ready for use. It allocates the pathid
507 * table, declares an iucv interrupt buffer and enables the iucv
508 * interrupts. Called when the first user has registered an iucv
511 static int iucv_enable(void)
517 alloc_size = iucv_max_pathid * sizeof(struct iucv_path);
518 iucv_path_table = kzalloc(alloc_size, GFP_KERNEL);
519 if (!iucv_path_table)
521 /* Declare per cpu buffers. */
524 for_each_online_cpu(cpu)
525 smp_call_function_on(iucv_declare_cpu, NULL, 0, 1, cpu);
527 if (cpus_empty(iucv_buffer_cpumask))
528 /* No cpu could declare an iucv buffer. */
533 kfree(iucv_path_table);
541 * This function shuts down iucv. It disables iucv interrupts, retrieves
542 * the iucv interrupt buffer and frees the pathid table. Called after the
543 * last user unregister its iucv handler.
545 static void iucv_disable(void)
547 on_each_cpu(iucv_retrieve_cpu, NULL, 0, 1);
548 kfree(iucv_path_table);
551 static int __cpuinit iucv_cpu_notify(struct notifier_block *self,
552 unsigned long action, void *hcpu)
555 long cpu = (long) hcpu;
559 case CPU_UP_PREPARE_FROZEN:
560 if (!percpu_populate(iucv_irq_data,
561 sizeof(struct iucv_irq_data),
562 GFP_KERNEL|GFP_DMA, cpu))
564 if (!percpu_populate(iucv_param, sizeof(union iucv_param),
565 GFP_KERNEL|GFP_DMA, cpu)) {
566 percpu_depopulate(iucv_irq_data, cpu);
570 case CPU_UP_CANCELED:
571 case CPU_UP_CANCELED_FROZEN:
573 case CPU_DEAD_FROZEN:
574 percpu_depopulate(iucv_param, cpu);
575 percpu_depopulate(iucv_irq_data, cpu);
578 case CPU_ONLINE_FROZEN:
579 case CPU_DOWN_FAILED:
580 case CPU_DOWN_FAILED_FROZEN:
581 smp_call_function_on(iucv_declare_cpu, NULL, 0, 1, cpu);
583 case CPU_DOWN_PREPARE:
584 case CPU_DOWN_PREPARE_FROZEN:
585 cpumask = iucv_buffer_cpumask;
586 cpu_clear(cpu, cpumask);
587 if (cpus_empty(cpumask))
588 /* Can't offline last IUCV enabled cpu. */
590 smp_call_function_on(iucv_retrieve_cpu, NULL, 0, 1, cpu);
591 if (cpus_empty(iucv_irq_cpumask))
592 smp_call_function_on(iucv_allow_cpu, NULL, 0, 1,
593 first_cpu(iucv_buffer_cpumask));
599 static struct notifier_block __cpuinitdata iucv_cpu_notifier = {
600 .notifier_call = iucv_cpu_notify,
605 * @pathid: path identification number.
606 * @userdata: 16-bytes of user data.
608 * Sever an iucv path to free up the pathid. Used internally.
610 static int iucv_sever_pathid(u16 pathid, u8 userdata[16])
612 union iucv_param *parm;
614 parm = percpu_ptr(iucv_param, smp_processor_id());
615 memset(parm, 0, sizeof(union iucv_param));
617 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
618 parm->ctrl.ippathid = pathid;
619 return iucv_call_b2f0(IUCV_SEVER, parm);
624 * __iucv_cleanup_queue
625 * @dummy: unused dummy argument
627 * Nop function called via smp_call_function to force work items from
628 * pending external iucv interrupts to the work queue.
630 static void __iucv_cleanup_queue(void *dummy)
638 * Function called after a path has been severed to find all remaining
639 * work items for the now stale pathid. The caller needs to hold the
642 static void iucv_cleanup_queue(void)
644 struct iucv_irq_list *p, *n;
647 * When a path is severed, the pathid can be reused immediatly
648 * on a iucv connect or a connection pending interrupt. Remove
649 * all entries from the task queue that refer to a stale pathid
650 * (iucv_path_table[ix] == NULL). Only then do the iucv connect
651 * or deliver the connection pending interrupt. To get all the
652 * pending interrupts force them to the work queue by calling
653 * an empty function on all cpus.
655 smp_call_function(__iucv_cleanup_queue, NULL, 0, 1);
656 spin_lock_irq(&iucv_queue_lock);
657 list_for_each_entry_safe(p, n, &iucv_task_queue, list) {
658 /* Remove stale work items from the task queue. */
659 if (iucv_path_table[p->data.ippathid] == NULL) {
664 spin_unlock_irq(&iucv_queue_lock);
669 * @handler: address of iucv handler structure
670 * @smp: != 0 indicates that the handler can deal with out of order messages
672 * Registers a driver with IUCV.
674 * Returns 0 on success, -ENOMEM if the memory allocation for the pathid
675 * table failed, or -EIO if IUCV_DECLARE_BUFFER failed on all cpus.
677 int iucv_register(struct iucv_handler *handler, int smp)
683 mutex_lock(&iucv_register_mutex);
685 iucv_nonsmp_handler++;
686 if (list_empty(&iucv_handler_list)) {
690 } else if (!smp && iucv_nonsmp_handler == 1)
692 INIT_LIST_HEAD(&handler->paths);
694 spin_lock_irq(&iucv_table_lock);
695 list_add_tail(&handler->list, &iucv_handler_list);
696 spin_unlock_irq(&iucv_table_lock);
699 mutex_unlock(&iucv_register_mutex);
702 EXPORT_SYMBOL(iucv_register);
706 * @handler: address of iucv handler structure
707 * @smp: != 0 indicates that the handler can deal with out of order messages
709 * Unregister driver from IUCV.
711 void iucv_unregister(struct iucv_handler *handler, int smp)
713 struct iucv_path *p, *n;
715 mutex_lock(&iucv_register_mutex);
716 spin_lock_bh(&iucv_table_lock);
717 /* Remove handler from the iucv_handler_list. */
718 list_del_init(&handler->list);
719 /* Sever all pathids still refering to the handler. */
720 list_for_each_entry_safe(p, n, &handler->paths, list) {
721 iucv_sever_pathid(p->pathid, NULL);
722 iucv_path_table[p->pathid] = NULL;
726 spin_unlock_bh(&iucv_table_lock);
728 iucv_nonsmp_handler--;
729 if (list_empty(&iucv_handler_list))
731 else if (!smp && iucv_nonsmp_handler == 0)
733 mutex_unlock(&iucv_register_mutex);
735 EXPORT_SYMBOL(iucv_unregister);
739 * @path: address of iucv path structure
740 * @handler: address of iucv handler structure
741 * @userdata: 16 bytes of data reflected to the communication partner
742 * @private: private data passed to interrupt handlers for this path
744 * This function is issued after the user received a connection pending
745 * external interrupt and now wishes to complete the IUCV communication path.
747 * Returns the result of the CP IUCV call.
749 int iucv_path_accept(struct iucv_path *path, struct iucv_handler *handler,
750 u8 userdata[16], void *private)
752 union iucv_param *parm;
756 /* Prepare parameter block. */
757 parm = percpu_ptr(iucv_param, smp_processor_id());
758 memset(parm, 0, sizeof(union iucv_param));
759 parm->ctrl.ippathid = path->pathid;
760 parm->ctrl.ipmsglim = path->msglim;
762 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
763 parm->ctrl.ipflags1 = path->flags;
765 rc = iucv_call_b2f0(IUCV_ACCEPT, parm);
767 path->private = private;
768 path->msglim = parm->ctrl.ipmsglim;
769 path->flags = parm->ctrl.ipflags1;
774 EXPORT_SYMBOL(iucv_path_accept);
778 * @path: address of iucv path structure
779 * @handler: address of iucv handler structure
780 * @userid: 8-byte user identification
781 * @system: 8-byte target system identification
782 * @userdata: 16 bytes of data reflected to the communication partner
783 * @private: private data passed to interrupt handlers for this path
785 * This function establishes an IUCV path. Although the connect may complete
786 * successfully, you are not able to use the path until you receive an IUCV
787 * Connection Complete external interrupt.
789 * Returns the result of the CP IUCV call.
791 int iucv_path_connect(struct iucv_path *path, struct iucv_handler *handler,
792 u8 userid[8], u8 system[8], u8 userdata[16],
795 union iucv_param *parm;
799 spin_lock_bh(&iucv_table_lock);
800 iucv_cleanup_queue();
801 parm = percpu_ptr(iucv_param, smp_processor_id());
802 memset(parm, 0, sizeof(union iucv_param));
803 parm->ctrl.ipmsglim = path->msglim;
804 parm->ctrl.ipflags1 = path->flags;
806 memcpy(parm->ctrl.ipvmid, userid, sizeof(parm->ctrl.ipvmid));
807 ASCEBC(parm->ctrl.ipvmid, sizeof(parm->ctrl.ipvmid));
808 EBC_TOUPPER(parm->ctrl.ipvmid, sizeof(parm->ctrl.ipvmid));
811 memcpy(parm->ctrl.iptarget, system,
812 sizeof(parm->ctrl.iptarget));
813 ASCEBC(parm->ctrl.iptarget, sizeof(parm->ctrl.iptarget));
814 EBC_TOUPPER(parm->ctrl.iptarget, sizeof(parm->ctrl.iptarget));
817 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
819 rc = iucv_call_b2f0(IUCV_CONNECT, parm);
821 if (parm->ctrl.ippathid < iucv_max_pathid) {
822 path->pathid = parm->ctrl.ippathid;
823 path->msglim = parm->ctrl.ipmsglim;
824 path->flags = parm->ctrl.ipflags1;
825 path->handler = handler;
826 path->private = private;
827 list_add_tail(&path->list, &handler->paths);
828 iucv_path_table[path->pathid] = path;
830 iucv_sever_pathid(parm->ctrl.ippathid,
835 spin_unlock_bh(&iucv_table_lock);
838 EXPORT_SYMBOL(iucv_path_connect);
842 * @path: address of iucv path structure
843 * @userdata: 16 bytes of data reflected to the communication partner
845 * This function temporarily suspends incoming messages on an IUCV path.
846 * You can later reactivate the path by invoking the iucv_resume function.
848 * Returns the result from the CP IUCV call.
850 int iucv_path_quiesce(struct iucv_path *path, u8 userdata[16])
852 union iucv_param *parm;
856 parm = percpu_ptr(iucv_param, smp_processor_id());
857 memset(parm, 0, sizeof(union iucv_param));
859 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
860 parm->ctrl.ippathid = path->pathid;
861 rc = iucv_call_b2f0(IUCV_QUIESCE, parm);
865 EXPORT_SYMBOL(iucv_path_quiesce);
869 * @path: address of iucv path structure
870 * @userdata: 16 bytes of data reflected to the communication partner
872 * This function resumes incoming messages on an IUCV path that has
873 * been stopped with iucv_path_quiesce.
875 * Returns the result from the CP IUCV call.
877 int iucv_path_resume(struct iucv_path *path, u8 userdata[16])
879 union iucv_param *parm;
883 parm = percpu_ptr(iucv_param, smp_processor_id());
884 memset(parm, 0, sizeof(union iucv_param));
886 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
887 parm->ctrl.ippathid = path->pathid;
888 rc = iucv_call_b2f0(IUCV_RESUME, parm);
895 * @path: address of iucv path structure
896 * @userdata: 16 bytes of data reflected to the communication partner
898 * This function terminates an IUCV path.
900 * Returns the result from the CP IUCV call.
902 int iucv_path_sever(struct iucv_path *path, u8 userdata[16])
907 if (iucv_active_cpu != smp_processor_id())
908 spin_lock_bh(&iucv_table_lock);
909 rc = iucv_sever_pathid(path->pathid, userdata);
911 iucv_path_table[path->pathid] = NULL;
912 list_del_init(&path->list);
914 if (iucv_active_cpu != smp_processor_id())
915 spin_unlock_bh(&iucv_table_lock);
919 EXPORT_SYMBOL(iucv_path_sever);
923 * @path: address of iucv path structure
924 * @msg: address of iucv msg structure
925 * @srccls: source class of message
927 * Cancels a message you have sent.
929 * Returns the result from the CP IUCV call.
931 int iucv_message_purge(struct iucv_path *path, struct iucv_message *msg,
934 union iucv_param *parm;
938 parm = percpu_ptr(iucv_param, smp_processor_id());
939 memset(parm, 0, sizeof(union iucv_param));
940 parm->purge.ippathid = path->pathid;
941 parm->purge.ipmsgid = msg->id;
942 parm->purge.ipsrccls = srccls;
943 parm->purge.ipflags1 = IUCV_IPSRCCLS | IUCV_IPFGMID | IUCV_IPFGPID;
944 rc = iucv_call_b2f0(IUCV_PURGE, parm);
946 msg->audit = (*(u32 *) &parm->purge.ipaudit) >> 8;
947 msg->tag = parm->purge.ipmsgtag;
952 EXPORT_SYMBOL(iucv_message_purge);
955 * iucv_message_receive
956 * @path: address of iucv path structure
957 * @msg: address of iucv msg structure
958 * @flags: how the message is received (IUCV_IPBUFLST)
959 * @buffer: address of data buffer or address of struct iucv_array
960 * @size: length of data buffer
963 * This function receives messages that are being sent to you over
964 * established paths. This function will deal with RMDATA messages
965 * embedded in struct iucv_message as well.
967 * Returns the result from the CP IUCV call.
969 int iucv_message_receive(struct iucv_path *path, struct iucv_message *msg,
970 u8 flags, void *buffer, size_t size, size_t *residual)
972 union iucv_param *parm;
973 struct iucv_array *array;
978 if (msg->flags & IUCV_IPRMDATA) {
980 * Message is 8 bytes long and has been stored to the
981 * message descriptor itself.
983 rc = (size < 8) ? 5 : 0;
985 *residual = abs(size - 8);
987 if (flags & IUCV_IPBUFLST) {
988 /* Copy to struct iucv_array. */
989 size = (size < 8) ? size : 8;
990 for (array = buffer; size > 0; array++) {
991 copy = min_t(size_t, size, array->length);
992 memcpy((u8 *)(addr_t) array->address,
998 /* Copy to direct buffer. */
999 memcpy(buffer, rmmsg, min_t(size_t, size, 8));
1005 parm = percpu_ptr(iucv_param, smp_processor_id());
1006 memset(parm, 0, sizeof(union iucv_param));
1007 parm->db.ipbfadr1 = (u32)(addr_t) buffer;
1008 parm->db.ipbfln1f = (u32) size;
1009 parm->db.ipmsgid = msg->id;
1010 parm->db.ippathid = path->pathid;
1011 parm->db.iptrgcls = msg->class;
1012 parm->db.ipflags1 = (flags | IUCV_IPFGPID |
1013 IUCV_IPFGMID | IUCV_IPTRGCLS);
1014 rc = iucv_call_b2f0(IUCV_RECEIVE, parm);
1015 if (!rc || rc == 5) {
1016 msg->flags = parm->db.ipflags1;
1018 *residual = parm->db.ipbfln1f;
1023 EXPORT_SYMBOL(iucv_message_receive);
1026 * iucv_message_reject
1027 * @path: address of iucv path structure
1028 * @msg: address of iucv msg structure
1030 * The reject function refuses a specified message. Between the time you
1031 * are notified of a message and the time that you complete the message,
1032 * the message may be rejected.
1034 * Returns the result from the CP IUCV call.
1036 int iucv_message_reject(struct iucv_path *path, struct iucv_message *msg)
1038 union iucv_param *parm;
1042 parm = percpu_ptr(iucv_param, smp_processor_id());
1043 memset(parm, 0, sizeof(union iucv_param));
1044 parm->db.ippathid = path->pathid;
1045 parm->db.ipmsgid = msg->id;
1046 parm->db.iptrgcls = msg->class;
1047 parm->db.ipflags1 = (IUCV_IPTRGCLS | IUCV_IPFGMID | IUCV_IPFGPID);
1048 rc = iucv_call_b2f0(IUCV_REJECT, parm);
1052 EXPORT_SYMBOL(iucv_message_reject);
1055 * iucv_message_reply
1056 * @path: address of iucv path structure
1057 * @msg: address of iucv msg structure
1058 * @flags: how the reply is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST)
1059 * @reply: address of reply data buffer or address of struct iucv_array
1060 * @size: length of reply data buffer
1062 * This function responds to the two-way messages that you receive. You
1063 * must identify completely the message to which you wish to reply. ie,
1064 * pathid, msgid, and trgcls. Prmmsg signifies the data is moved into
1065 * the parameter list.
1067 * Returns the result from the CP IUCV call.
1069 int iucv_message_reply(struct iucv_path *path, struct iucv_message *msg,
1070 u8 flags, void *reply, size_t size)
1072 union iucv_param *parm;
1076 parm = percpu_ptr(iucv_param, smp_processor_id());
1077 memset(parm, 0, sizeof(union iucv_param));
1078 if (flags & IUCV_IPRMDATA) {
1079 parm->dpl.ippathid = path->pathid;
1080 parm->dpl.ipflags1 = flags;
1081 parm->dpl.ipmsgid = msg->id;
1082 parm->dpl.iptrgcls = msg->class;
1083 memcpy(parm->dpl.iprmmsg, reply, min_t(size_t, size, 8));
1085 parm->db.ipbfadr1 = (u32)(addr_t) reply;
1086 parm->db.ipbfln1f = (u32) size;
1087 parm->db.ippathid = path->pathid;
1088 parm->db.ipflags1 = flags;
1089 parm->db.ipmsgid = msg->id;
1090 parm->db.iptrgcls = msg->class;
1092 rc = iucv_call_b2f0(IUCV_REPLY, parm);
1096 EXPORT_SYMBOL(iucv_message_reply);
1100 * @path: address of iucv path structure
1101 * @msg: address of iucv msg structure
1102 * @flags: how the message is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST)
1103 * @srccls: source class of message
1104 * @buffer: address of send buffer or address of struct iucv_array
1105 * @size: length of send buffer
1107 * This function transmits data to another application. Data to be
1108 * transmitted is in a buffer and this is a one-way message and the
1109 * receiver will not reply to the message.
1111 * Returns the result from the CP IUCV call.
1113 int iucv_message_send(struct iucv_path *path, struct iucv_message *msg,
1114 u8 flags, u32 srccls, void *buffer, size_t size)
1116 union iucv_param *parm;
1120 parm = percpu_ptr(iucv_param, smp_processor_id());
1121 memset(parm, 0, sizeof(union iucv_param));
1122 if (flags & IUCV_IPRMDATA) {
1123 /* Message of 8 bytes can be placed into the parameter list. */
1124 parm->dpl.ippathid = path->pathid;
1125 parm->dpl.ipflags1 = flags | IUCV_IPNORPY;
1126 parm->dpl.iptrgcls = msg->class;
1127 parm->dpl.ipsrccls = srccls;
1128 parm->dpl.ipmsgtag = msg->tag;
1129 memcpy(parm->dpl.iprmmsg, buffer, 8);
1131 parm->db.ipbfadr1 = (u32)(addr_t) buffer;
1132 parm->db.ipbfln1f = (u32) size;
1133 parm->db.ippathid = path->pathid;
1134 parm->db.ipflags1 = flags | IUCV_IPNORPY;
1135 parm->db.iptrgcls = msg->class;
1136 parm->db.ipsrccls = srccls;
1137 parm->db.ipmsgtag = msg->tag;
1139 rc = iucv_call_b2f0(IUCV_SEND, parm);
1141 msg->id = parm->db.ipmsgid;
1145 EXPORT_SYMBOL(iucv_message_send);
1148 * iucv_message_send2way
1149 * @path: address of iucv path structure
1150 * @msg: address of iucv msg structure
1151 * @flags: how the message is sent and the reply is received
1152 * (IUCV_IPRMDATA, IUCV_IPBUFLST, IUCV_IPPRTY, IUCV_ANSLST)
1153 * @srccls: source class of message
1154 * @buffer: address of send buffer or address of struct iucv_array
1155 * @size: length of send buffer
1156 * @ansbuf: address of answer buffer or address of struct iucv_array
1157 * @asize: size of reply buffer
1159 * This function transmits data to another application. Data to be
1160 * transmitted is in a buffer. The receiver of the send is expected to
1161 * reply to the message and a buffer is provided into which IUCV moves
1162 * the reply to this message.
1164 * Returns the result from the CP IUCV call.
1166 int iucv_message_send2way(struct iucv_path *path, struct iucv_message *msg,
1167 u8 flags, u32 srccls, void *buffer, size_t size,
1168 void *answer, size_t asize, size_t *residual)
1170 union iucv_param *parm;
1174 parm = percpu_ptr(iucv_param, smp_processor_id());
1175 memset(parm, 0, sizeof(union iucv_param));
1176 if (flags & IUCV_IPRMDATA) {
1177 parm->dpl.ippathid = path->pathid;
1178 parm->dpl.ipflags1 = path->flags; /* priority message */
1179 parm->dpl.iptrgcls = msg->class;
1180 parm->dpl.ipsrccls = srccls;
1181 parm->dpl.ipmsgtag = msg->tag;
1182 parm->dpl.ipbfadr2 = (u32)(addr_t) answer;
1183 parm->dpl.ipbfln2f = (u32) asize;
1184 memcpy(parm->dpl.iprmmsg, buffer, 8);
1186 parm->db.ippathid = path->pathid;
1187 parm->db.ipflags1 = path->flags; /* priority message */
1188 parm->db.iptrgcls = msg->class;
1189 parm->db.ipsrccls = srccls;
1190 parm->db.ipmsgtag = msg->tag;
1191 parm->db.ipbfadr1 = (u32)(addr_t) buffer;
1192 parm->db.ipbfln1f = (u32) size;
1193 parm->db.ipbfadr2 = (u32)(addr_t) answer;
1194 parm->db.ipbfln2f = (u32) asize;
1196 rc = iucv_call_b2f0(IUCV_SEND, parm);
1198 msg->id = parm->db.ipmsgid;
1202 EXPORT_SYMBOL(iucv_message_send2way);
1206 * @data: Pointer to external interrupt buffer
1208 * Process connection pending work item. Called from tasklet while holding
1211 struct iucv_path_pending {
1222 } __attribute__ ((packed));
1224 static void iucv_path_pending(struct iucv_irq_data *data)
1226 struct iucv_path_pending *ipp = (void *) data;
1227 struct iucv_handler *handler;
1228 struct iucv_path *path;
1231 BUG_ON(iucv_path_table[ipp->ippathid]);
1232 /* New pathid, handler found. Create a new path struct. */
1233 error = iucv_error_no_memory;
1234 path = iucv_path_alloc(ipp->ipmsglim, ipp->ipflags1, GFP_ATOMIC);
1237 path->pathid = ipp->ippathid;
1238 iucv_path_table[path->pathid] = path;
1239 EBCASC(ipp->ipvmid, 8);
1241 /* Call registered handler until one is found that wants the path. */
1242 list_for_each_entry(handler, &iucv_handler_list, list) {
1243 if (!handler->path_pending)
1246 * Add path to handler to allow a call to iucv_path_sever
1247 * inside the path_pending function. If the handler returns
1248 * an error remove the path from the handler again.
1250 list_add(&path->list, &handler->paths);
1251 path->handler = handler;
1252 if (!handler->path_pending(path, ipp->ipvmid, ipp->ipuser))
1254 list_del(&path->list);
1255 path->handler = NULL;
1257 /* No handler wanted the path. */
1258 iucv_path_table[path->pathid] = NULL;
1259 iucv_path_free(path);
1260 error = iucv_error_no_listener;
1262 iucv_sever_pathid(ipp->ippathid, error);
1266 * iucv_path_complete
1267 * @data: Pointer to external interrupt buffer
1269 * Process connection complete work item. Called from tasklet while holding
1272 struct iucv_path_complete {
1283 } __attribute__ ((packed));
1285 static void iucv_path_complete(struct iucv_irq_data *data)
1287 struct iucv_path_complete *ipc = (void *) data;
1288 struct iucv_path *path = iucv_path_table[ipc->ippathid];
1290 if (path && path->handler && path->handler->path_complete)
1291 path->handler->path_complete(path, ipc->ipuser);
1296 * @data: Pointer to external interrupt buffer
1298 * Process connection severed work item. Called from tasklet while holding
1301 struct iucv_path_severed {
1311 } __attribute__ ((packed));
1313 static void iucv_path_severed(struct iucv_irq_data *data)
1315 struct iucv_path_severed *ips = (void *) data;
1316 struct iucv_path *path = iucv_path_table[ips->ippathid];
1318 if (!path || !path->handler) /* Already severed */
1320 if (path->handler->path_severed)
1321 path->handler->path_severed(path, ips->ipuser);
1323 iucv_sever_pathid(path->pathid, NULL);
1324 iucv_path_table[path->pathid] = NULL;
1325 list_del_init(&path->list);
1326 iucv_path_free(path);
1331 * iucv_path_quiesced
1332 * @data: Pointer to external interrupt buffer
1334 * Process connection quiesced work item. Called from tasklet while holding
1337 struct iucv_path_quiesced {
1347 } __attribute__ ((packed));
1349 static void iucv_path_quiesced(struct iucv_irq_data *data)
1351 struct iucv_path_quiesced *ipq = (void *) data;
1352 struct iucv_path *path = iucv_path_table[ipq->ippathid];
1354 if (path && path->handler && path->handler->path_quiesced)
1355 path->handler->path_quiesced(path, ipq->ipuser);
1360 * @data: Pointer to external interrupt buffer
1362 * Process connection resumed work item. Called from tasklet while holding
1365 struct iucv_path_resumed {
1375 } __attribute__ ((packed));
1377 static void iucv_path_resumed(struct iucv_irq_data *data)
1379 struct iucv_path_resumed *ipr = (void *) data;
1380 struct iucv_path *path = iucv_path_table[ipr->ippathid];
1382 if (path && path->handler && path->handler->path_resumed)
1383 path->handler->path_resumed(path, ipr->ipuser);
1387 * iucv_message_complete
1388 * @data: Pointer to external interrupt buffer
1390 * Process message complete work item. Called from tasklet while holding
1393 struct iucv_message_complete {
1406 } __attribute__ ((packed));
1408 static void iucv_message_complete(struct iucv_irq_data *data)
1410 struct iucv_message_complete *imc = (void *) data;
1411 struct iucv_path *path = iucv_path_table[imc->ippathid];
1412 struct iucv_message msg;
1414 if (path && path->handler && path->handler->message_complete) {
1415 msg.flags = imc->ipflags1;
1416 msg.id = imc->ipmsgid;
1417 msg.audit = imc->ipaudit;
1418 memcpy(msg.rmmsg, imc->iprmmsg, 8);
1419 msg.class = imc->ipsrccls;
1420 msg.tag = imc->ipmsgtag;
1421 msg.length = imc->ipbfln2f;
1422 path->handler->message_complete(path, &msg);
1427 * iucv_message_pending
1428 * @data: Pointer to external interrupt buffer
1430 * Process message pending work item. Called from tasklet while holding
1433 struct iucv_message_pending {
1451 } __attribute__ ((packed));
1453 static void iucv_message_pending(struct iucv_irq_data *data)
1455 struct iucv_message_pending *imp = (void *) data;
1456 struct iucv_path *path = iucv_path_table[imp->ippathid];
1457 struct iucv_message msg;
1459 if (path && path->handler && path->handler->message_pending) {
1460 msg.flags = imp->ipflags1;
1461 msg.id = imp->ipmsgid;
1462 msg.class = imp->iptrgcls;
1463 if (imp->ipflags1 & IUCV_IPRMDATA) {
1464 memcpy(msg.rmmsg, imp->ln1msg1.iprmmsg1, 8);
1467 msg.length = imp->ln1msg2.ipbfln1f;
1468 msg.reply_size = imp->ipbfln2f;
1469 path->handler->message_pending(path, &msg);
1476 * This tasklet loops over the queue of irq buffers created by
1477 * iucv_external_interrupt, calls the appropriate action handler
1478 * and then frees the buffer.
1480 static void iucv_tasklet_fn(unsigned long ignored)
1482 typedef void iucv_irq_fn(struct iucv_irq_data *);
1483 static iucv_irq_fn *irq_fn[] = {
1484 [0x02] = iucv_path_complete,
1485 [0x03] = iucv_path_severed,
1486 [0x04] = iucv_path_quiesced,
1487 [0x05] = iucv_path_resumed,
1488 [0x06] = iucv_message_complete,
1489 [0x07] = iucv_message_complete,
1490 [0x08] = iucv_message_pending,
1491 [0x09] = iucv_message_pending,
1493 struct list_head task_queue = LIST_HEAD_INIT(task_queue);
1494 struct iucv_irq_list *p, *n;
1496 /* Serialize tasklet, iucv_path_sever and iucv_path_connect. */
1497 if (!spin_trylock(&iucv_table_lock)) {
1498 tasklet_schedule(&iucv_tasklet);
1501 iucv_active_cpu = smp_processor_id();
1503 spin_lock_irq(&iucv_queue_lock);
1504 list_splice_init(&iucv_task_queue, &task_queue);
1505 spin_unlock_irq(&iucv_queue_lock);
1507 list_for_each_entry_safe(p, n, &task_queue, list) {
1508 list_del_init(&p->list);
1509 irq_fn[p->data.iptype](&p->data);
1513 iucv_active_cpu = -1;
1514 spin_unlock(&iucv_table_lock);
1520 * This work function loops over the queue of path pending irq blocks
1521 * created by iucv_external_interrupt, calls the appropriate action
1522 * handler and then frees the buffer.
1524 static void iucv_work_fn(struct work_struct *work)
1526 typedef void iucv_irq_fn(struct iucv_irq_data *);
1527 struct list_head work_queue = LIST_HEAD_INIT(work_queue);
1528 struct iucv_irq_list *p, *n;
1530 /* Serialize tasklet, iucv_path_sever and iucv_path_connect. */
1531 spin_lock_bh(&iucv_table_lock);
1532 iucv_active_cpu = smp_processor_id();
1534 spin_lock_irq(&iucv_queue_lock);
1535 list_splice_init(&iucv_work_queue, &work_queue);
1536 spin_unlock_irq(&iucv_queue_lock);
1538 iucv_cleanup_queue();
1539 list_for_each_entry_safe(p, n, &work_queue, list) {
1540 list_del_init(&p->list);
1541 iucv_path_pending(&p->data);
1545 iucv_active_cpu = -1;
1546 spin_unlock_bh(&iucv_table_lock);
1550 * iucv_external_interrupt
1553 * Handles external interrupts coming in from CP.
1554 * Places the interrupt buffer on a queue and schedules iucv_tasklet_fn().
1556 static void iucv_external_interrupt(u16 code)
1558 struct iucv_irq_data *p;
1559 struct iucv_irq_list *work;
1561 p = percpu_ptr(iucv_irq_data, smp_processor_id());
1562 if (p->ippathid >= iucv_max_pathid) {
1563 printk(KERN_WARNING "iucv_do_int: Got interrupt with "
1564 "pathid %d > max_connections (%ld)\n",
1565 p->ippathid, iucv_max_pathid - 1);
1566 iucv_sever_pathid(p->ippathid, iucv_error_no_listener);
1569 if (p->iptype < 0x01 || p->iptype > 0x09) {
1570 printk(KERN_ERR "iucv_do_int: unknown iucv interrupt\n");
1573 work = kmalloc(sizeof(struct iucv_irq_list), GFP_ATOMIC);
1575 printk(KERN_WARNING "iucv_external_interrupt: out of memory\n");
1578 memcpy(&work->data, p, sizeof(work->data));
1579 spin_lock(&iucv_queue_lock);
1580 if (p->iptype == 0x01) {
1581 /* Path pending interrupt. */
1582 list_add_tail(&work->list, &iucv_work_queue);
1583 schedule_work(&iucv_work);
1585 /* The other interrupts. */
1586 list_add_tail(&work->list, &iucv_task_queue);
1587 tasklet_schedule(&iucv_tasklet);
1589 spin_unlock(&iucv_queue_lock);
1595 * Allocates and initializes various data structures.
1597 static int __init iucv_init(void)
1601 if (!MACHINE_IS_VM) {
1602 rc = -EPROTONOSUPPORT;
1605 rc = iucv_query_maxconn();
1608 rc = register_external_interrupt(0x4000, iucv_external_interrupt);
1611 rc = bus_register(&iucv_bus);
1614 iucv_root = s390_root_dev_register("iucv");
1615 if (IS_ERR(iucv_root)) {
1616 rc = PTR_ERR(iucv_root);
1619 /* Note: GFP_DMA used to get memory below 2G */
1620 iucv_irq_data = percpu_alloc(sizeof(struct iucv_irq_data),
1621 GFP_KERNEL|GFP_DMA);
1622 if (!iucv_irq_data) {
1626 /* Allocate parameter blocks. */
1627 iucv_param = percpu_alloc(sizeof(union iucv_param),
1628 GFP_KERNEL|GFP_DMA);
1633 register_hotcpu_notifier(&iucv_cpu_notifier);
1634 ASCEBC(iucv_error_no_listener, 16);
1635 ASCEBC(iucv_error_no_memory, 16);
1636 ASCEBC(iucv_error_pathid, 16);
1641 percpu_free(iucv_irq_data);
1643 s390_root_dev_unregister(iucv_root);
1645 bus_unregister(&iucv_bus);
1647 unregister_external_interrupt(0x4000, iucv_external_interrupt);
1655 * Frees everything allocated from iucv_init.
1657 static void __exit iucv_exit(void)
1659 struct iucv_irq_list *p, *n;
1661 spin_lock_irq(&iucv_queue_lock);
1662 list_for_each_entry_safe(p, n, &iucv_task_queue, list)
1664 list_for_each_entry_safe(p, n, &iucv_work_queue, list)
1666 spin_unlock_irq(&iucv_queue_lock);
1667 unregister_hotcpu_notifier(&iucv_cpu_notifier);
1668 percpu_free(iucv_param);
1669 percpu_free(iucv_irq_data);
1670 s390_root_dev_unregister(iucv_root);
1671 bus_unregister(&iucv_bus);
1672 unregister_external_interrupt(0x4000, iucv_external_interrupt);
1675 subsys_initcall(iucv_init);
1676 module_exit(iucv_exit);
1678 MODULE_AUTHOR("(C) 2001 IBM Corp. by Fritz Elfert (felfert@millenux.com)");
1679 MODULE_DESCRIPTION("Linux for S/390 IUCV lowlevel driver");
1680 MODULE_LICENSE("GPL");