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[NR_CPUS];
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[NR_CPUS];
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 = iucv_param[cpu];
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 = iucv_param[cpu];
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 interrupt 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 = iucv_param[cpu];
405 memset(parm, 0, sizeof(union iucv_param));
406 parm->db.ipbfadr1 = virt_to_phys(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 = 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_single(cpu, iucv_allow_cpu,
490 * Allow iucv interrupts on a single cpu.
492 static void iucv_setmask_up(void)
497 /* Disable all cpu but the first in cpu_irq_cpumask. */
498 cpumask = iucv_irq_cpumask;
499 cpu_clear(first_cpu(iucv_irq_cpumask), cpumask);
500 for_each_cpu_mask(cpu, cpumask)
501 smp_call_function_single(cpu, iucv_block_cpu, NULL, 0, 1);
507 * This function makes iucv ready for use. It allocates the pathid
508 * table, declares an iucv interrupt buffer and enables the iucv
509 * interrupts. Called when the first user has registered an iucv
512 static int iucv_enable(void)
518 alloc_size = iucv_max_pathid * sizeof(struct iucv_path);
519 iucv_path_table = kzalloc(alloc_size, GFP_KERNEL);
520 if (!iucv_path_table)
522 /* Declare per cpu buffers. */
525 for_each_online_cpu(cpu)
526 smp_call_function_single(cpu, iucv_declare_cpu, NULL, 0, 1);
527 if (cpus_empty(iucv_buffer_cpumask))
528 /* No cpu could declare an iucv buffer. */
535 kfree(iucv_path_table);
543 * This function shuts down iucv. It disables iucv interrupts, retrieves
544 * the iucv interrupt buffer and frees the pathid table. Called after the
545 * last user unregister its iucv handler.
547 static void iucv_disable(void)
550 on_each_cpu(iucv_retrieve_cpu, NULL, 0, 1);
552 kfree(iucv_path_table);
555 static int __cpuinit iucv_cpu_notify(struct notifier_block *self,
556 unsigned long action, void *hcpu)
559 long cpu = (long) hcpu;
563 case CPU_UP_PREPARE_FROZEN:
564 iucv_irq_data[cpu] = kmalloc_node(sizeof(struct iucv_irq_data),
565 GFP_KERNEL|GFP_DMA, cpu_to_node(cpu));
566 if (!iucv_irq_data[cpu])
568 iucv_param[cpu] = kmalloc_node(sizeof(union iucv_param),
569 GFP_KERNEL|GFP_DMA, cpu_to_node(cpu));
570 if (!iucv_param[cpu]) {
571 kfree(iucv_irq_data[cpu]);
572 iucv_irq_data[cpu] = NULL;
576 case CPU_UP_CANCELED:
577 case CPU_UP_CANCELED_FROZEN:
579 case CPU_DEAD_FROZEN:
580 kfree(iucv_param[cpu]);
581 iucv_param[cpu] = NULL;
582 kfree(iucv_irq_data[cpu]);
583 iucv_irq_data[cpu] = NULL;
586 case CPU_ONLINE_FROZEN:
587 case CPU_DOWN_FAILED:
588 case CPU_DOWN_FAILED_FROZEN:
589 smp_call_function_single(cpu, iucv_declare_cpu, NULL, 0, 1);
591 case CPU_DOWN_PREPARE:
592 case CPU_DOWN_PREPARE_FROZEN:
593 cpumask = iucv_buffer_cpumask;
594 cpu_clear(cpu, cpumask);
595 if (cpus_empty(cpumask))
596 /* Can't offline last IUCV enabled cpu. */
598 smp_call_function_single(cpu, iucv_retrieve_cpu, NULL, 0, 1);
599 if (cpus_empty(iucv_irq_cpumask))
600 smp_call_function_single(first_cpu(iucv_buffer_cpumask),
601 iucv_allow_cpu, NULL, 0, 1);
607 static struct notifier_block __refdata iucv_cpu_notifier = {
608 .notifier_call = iucv_cpu_notify,
613 * @pathid: path identification number.
614 * @userdata: 16-bytes of user data.
616 * Sever an iucv path to free up the pathid. Used internally.
618 static int iucv_sever_pathid(u16 pathid, u8 userdata[16])
620 union iucv_param *parm;
622 parm = iucv_param[smp_processor_id()];
623 memset(parm, 0, sizeof(union iucv_param));
625 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
626 parm->ctrl.ippathid = pathid;
627 return iucv_call_b2f0(IUCV_SEVER, parm);
631 * __iucv_cleanup_queue
632 * @dummy: unused dummy argument
634 * Nop function called via smp_call_function to force work items from
635 * pending external iucv interrupts to the work queue.
637 static void __iucv_cleanup_queue(void *dummy)
644 * Function called after a path has been severed to find all remaining
645 * work items for the now stale pathid. The caller needs to hold the
648 static void iucv_cleanup_queue(void)
650 struct iucv_irq_list *p, *n;
653 * When a path is severed, the pathid can be reused immediatly
654 * on a iucv connect or a connection pending interrupt. Remove
655 * all entries from the task queue that refer to a stale pathid
656 * (iucv_path_table[ix] == NULL). Only then do the iucv connect
657 * or deliver the connection pending interrupt. To get all the
658 * pending interrupts force them to the work queue by calling
659 * an empty function on all cpus.
661 smp_call_function(__iucv_cleanup_queue, NULL, 0, 1);
662 spin_lock_irq(&iucv_queue_lock);
663 list_for_each_entry_safe(p, n, &iucv_task_queue, list) {
664 /* Remove stale work items from the task queue. */
665 if (iucv_path_table[p->data.ippathid] == NULL) {
670 spin_unlock_irq(&iucv_queue_lock);
675 * @handler: address of iucv handler structure
676 * @smp: != 0 indicates that the handler can deal with out of order messages
678 * Registers a driver with IUCV.
680 * Returns 0 on success, -ENOMEM if the memory allocation for the pathid
681 * table failed, or -EIO if IUCV_DECLARE_BUFFER failed on all cpus.
683 int iucv_register(struct iucv_handler *handler, int smp)
689 mutex_lock(&iucv_register_mutex);
691 iucv_nonsmp_handler++;
692 if (list_empty(&iucv_handler_list)) {
696 } else if (!smp && iucv_nonsmp_handler == 1)
698 INIT_LIST_HEAD(&handler->paths);
700 spin_lock_bh(&iucv_table_lock);
701 list_add_tail(&handler->list, &iucv_handler_list);
702 spin_unlock_bh(&iucv_table_lock);
705 mutex_unlock(&iucv_register_mutex);
708 EXPORT_SYMBOL(iucv_register);
712 * @handler: address of iucv handler structure
713 * @smp: != 0 indicates that the handler can deal with out of order messages
715 * Unregister driver from IUCV.
717 void iucv_unregister(struct iucv_handler *handler, int smp)
719 struct iucv_path *p, *n;
721 mutex_lock(&iucv_register_mutex);
722 spin_lock_bh(&iucv_table_lock);
723 /* Remove handler from the iucv_handler_list. */
724 list_del_init(&handler->list);
725 /* Sever all pathids still refering to the handler. */
726 list_for_each_entry_safe(p, n, &handler->paths, list) {
727 iucv_sever_pathid(p->pathid, NULL);
728 iucv_path_table[p->pathid] = NULL;
732 spin_unlock_bh(&iucv_table_lock);
734 iucv_nonsmp_handler--;
735 if (list_empty(&iucv_handler_list))
737 else if (!smp && iucv_nonsmp_handler == 0)
739 mutex_unlock(&iucv_register_mutex);
741 EXPORT_SYMBOL(iucv_unregister);
745 * @path: address of iucv path structure
746 * @handler: address of iucv handler structure
747 * @userdata: 16 bytes of data reflected to the communication partner
748 * @private: private data passed to interrupt handlers for this path
750 * This function is issued after the user received a connection pending
751 * external interrupt and now wishes to complete the IUCV communication path.
753 * Returns the result of the CP IUCV call.
755 int iucv_path_accept(struct iucv_path *path, struct iucv_handler *handler,
756 u8 userdata[16], void *private)
758 union iucv_param *parm;
762 /* Prepare parameter block. */
763 parm = iucv_param[smp_processor_id()];
764 memset(parm, 0, sizeof(union iucv_param));
765 parm->ctrl.ippathid = path->pathid;
766 parm->ctrl.ipmsglim = path->msglim;
768 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
769 parm->ctrl.ipflags1 = path->flags;
771 rc = iucv_call_b2f0(IUCV_ACCEPT, parm);
773 path->private = private;
774 path->msglim = parm->ctrl.ipmsglim;
775 path->flags = parm->ctrl.ipflags1;
780 EXPORT_SYMBOL(iucv_path_accept);
784 * @path: address of iucv path structure
785 * @handler: address of iucv handler structure
786 * @userid: 8-byte user identification
787 * @system: 8-byte target system identification
788 * @userdata: 16 bytes of data reflected to the communication partner
789 * @private: private data passed to interrupt handlers for this path
791 * This function establishes an IUCV path. Although the connect may complete
792 * successfully, you are not able to use the path until you receive an IUCV
793 * Connection Complete external interrupt.
795 * Returns the result of the CP IUCV call.
797 int iucv_path_connect(struct iucv_path *path, struct iucv_handler *handler,
798 u8 userid[8], u8 system[8], u8 userdata[16],
801 union iucv_param *parm;
804 spin_lock_bh(&iucv_table_lock);
805 iucv_cleanup_queue();
806 parm = iucv_param[smp_processor_id()];
807 memset(parm, 0, sizeof(union iucv_param));
808 parm->ctrl.ipmsglim = path->msglim;
809 parm->ctrl.ipflags1 = path->flags;
811 memcpy(parm->ctrl.ipvmid, userid, sizeof(parm->ctrl.ipvmid));
812 ASCEBC(parm->ctrl.ipvmid, sizeof(parm->ctrl.ipvmid));
813 EBC_TOUPPER(parm->ctrl.ipvmid, sizeof(parm->ctrl.ipvmid));
816 memcpy(parm->ctrl.iptarget, system,
817 sizeof(parm->ctrl.iptarget));
818 ASCEBC(parm->ctrl.iptarget, sizeof(parm->ctrl.iptarget));
819 EBC_TOUPPER(parm->ctrl.iptarget, sizeof(parm->ctrl.iptarget));
822 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
824 rc = iucv_call_b2f0(IUCV_CONNECT, parm);
826 if (parm->ctrl.ippathid < iucv_max_pathid) {
827 path->pathid = parm->ctrl.ippathid;
828 path->msglim = parm->ctrl.ipmsglim;
829 path->flags = parm->ctrl.ipflags1;
830 path->handler = handler;
831 path->private = private;
832 list_add_tail(&path->list, &handler->paths);
833 iucv_path_table[path->pathid] = path;
835 iucv_sever_pathid(parm->ctrl.ippathid,
840 spin_unlock_bh(&iucv_table_lock);
843 EXPORT_SYMBOL(iucv_path_connect);
847 * @path: address of iucv path structure
848 * @userdata: 16 bytes of data reflected to the communication partner
850 * This function temporarily suspends incoming messages on an IUCV path.
851 * You can later reactivate the path by invoking the iucv_resume function.
853 * Returns the result from the CP IUCV call.
855 int iucv_path_quiesce(struct iucv_path *path, u8 userdata[16])
857 union iucv_param *parm;
861 parm = iucv_param[smp_processor_id()];
862 memset(parm, 0, sizeof(union iucv_param));
864 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
865 parm->ctrl.ippathid = path->pathid;
866 rc = iucv_call_b2f0(IUCV_QUIESCE, parm);
870 EXPORT_SYMBOL(iucv_path_quiesce);
874 * @path: address of iucv path structure
875 * @userdata: 16 bytes of data reflected to the communication partner
877 * This function resumes incoming messages on an IUCV path that has
878 * been stopped with iucv_path_quiesce.
880 * Returns the result from the CP IUCV call.
882 int iucv_path_resume(struct iucv_path *path, u8 userdata[16])
884 union iucv_param *parm;
888 parm = iucv_param[smp_processor_id()];
889 memset(parm, 0, sizeof(union iucv_param));
891 memcpy(parm->ctrl.ipuser, userdata, sizeof(parm->ctrl.ipuser));
892 parm->ctrl.ippathid = path->pathid;
893 rc = iucv_call_b2f0(IUCV_RESUME, parm);
900 * @path: address of iucv path structure
901 * @userdata: 16 bytes of data reflected to the communication partner
903 * This function terminates an IUCV path.
905 * Returns the result from the CP IUCV call.
907 int iucv_path_sever(struct iucv_path *path, u8 userdata[16])
912 if (iucv_active_cpu != smp_processor_id())
913 spin_lock_bh(&iucv_table_lock);
914 rc = iucv_sever_pathid(path->pathid, userdata);
916 iucv_path_table[path->pathid] = NULL;
917 list_del_init(&path->list);
919 if (iucv_active_cpu != smp_processor_id())
920 spin_unlock_bh(&iucv_table_lock);
924 EXPORT_SYMBOL(iucv_path_sever);
928 * @path: address of iucv path structure
929 * @msg: address of iucv msg structure
930 * @srccls: source class of message
932 * Cancels a message you have sent.
934 * Returns the result from the CP IUCV call.
936 int iucv_message_purge(struct iucv_path *path, struct iucv_message *msg,
939 union iucv_param *parm;
943 parm = iucv_param[smp_processor_id()];
944 memset(parm, 0, sizeof(union iucv_param));
945 parm->purge.ippathid = path->pathid;
946 parm->purge.ipmsgid = msg->id;
947 parm->purge.ipsrccls = srccls;
948 parm->purge.ipflags1 = IUCV_IPSRCCLS | IUCV_IPFGMID | IUCV_IPFGPID;
949 rc = iucv_call_b2f0(IUCV_PURGE, parm);
951 msg->audit = (*(u32 *) &parm->purge.ipaudit) >> 8;
952 msg->tag = parm->purge.ipmsgtag;
957 EXPORT_SYMBOL(iucv_message_purge);
960 * iucv_message_receive
961 * @path: address of iucv path structure
962 * @msg: address of iucv msg structure
963 * @flags: how the message is received (IUCV_IPBUFLST)
964 * @buffer: address of data buffer or address of struct iucv_array
965 * @size: length of data buffer
968 * This function receives messages that are being sent to you over
969 * established paths. This function will deal with RMDATA messages
970 * embedded in struct iucv_message as well.
972 * Returns the result from the CP IUCV call.
974 int iucv_message_receive(struct iucv_path *path, struct iucv_message *msg,
975 u8 flags, void *buffer, size_t size, size_t *residual)
977 union iucv_param *parm;
978 struct iucv_array *array;
983 if (msg->flags & IUCV_IPRMDATA) {
985 * Message is 8 bytes long and has been stored to the
986 * message descriptor itself.
988 rc = (size < 8) ? 5 : 0;
990 *residual = abs(size - 8);
992 if (flags & IUCV_IPBUFLST) {
993 /* Copy to struct iucv_array. */
994 size = (size < 8) ? size : 8;
995 for (array = buffer; size > 0; array++) {
996 copy = min_t(size_t, size, array->length);
997 memcpy((u8 *)(addr_t) array->address,
1003 /* Copy to direct buffer. */
1004 memcpy(buffer, rmmsg, min_t(size_t, size, 8));
1010 parm = iucv_param[smp_processor_id()];
1011 memset(parm, 0, sizeof(union iucv_param));
1012 parm->db.ipbfadr1 = (u32)(addr_t) buffer;
1013 parm->db.ipbfln1f = (u32) size;
1014 parm->db.ipmsgid = msg->id;
1015 parm->db.ippathid = path->pathid;
1016 parm->db.iptrgcls = msg->class;
1017 parm->db.ipflags1 = (flags | IUCV_IPFGPID |
1018 IUCV_IPFGMID | IUCV_IPTRGCLS);
1019 rc = iucv_call_b2f0(IUCV_RECEIVE, parm);
1020 if (!rc || rc == 5) {
1021 msg->flags = parm->db.ipflags1;
1023 *residual = parm->db.ipbfln1f;
1028 EXPORT_SYMBOL(iucv_message_receive);
1031 * iucv_message_reject
1032 * @path: address of iucv path structure
1033 * @msg: address of iucv msg structure
1035 * The reject function refuses a specified message. Between the time you
1036 * are notified of a message and the time that you complete the message,
1037 * the message may be rejected.
1039 * Returns the result from the CP IUCV call.
1041 int iucv_message_reject(struct iucv_path *path, struct iucv_message *msg)
1043 union iucv_param *parm;
1047 parm = iucv_param[smp_processor_id()];
1048 memset(parm, 0, sizeof(union iucv_param));
1049 parm->db.ippathid = path->pathid;
1050 parm->db.ipmsgid = msg->id;
1051 parm->db.iptrgcls = msg->class;
1052 parm->db.ipflags1 = (IUCV_IPTRGCLS | IUCV_IPFGMID | IUCV_IPFGPID);
1053 rc = iucv_call_b2f0(IUCV_REJECT, parm);
1057 EXPORT_SYMBOL(iucv_message_reject);
1060 * iucv_message_reply
1061 * @path: address of iucv path structure
1062 * @msg: address of iucv msg structure
1063 * @flags: how the reply is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST)
1064 * @reply: address of reply data buffer or address of struct iucv_array
1065 * @size: length of reply data buffer
1067 * This function responds to the two-way messages that you receive. You
1068 * must identify completely the message to which you wish to reply. ie,
1069 * pathid, msgid, and trgcls. Prmmsg signifies the data is moved into
1070 * the parameter list.
1072 * Returns the result from the CP IUCV call.
1074 int iucv_message_reply(struct iucv_path *path, struct iucv_message *msg,
1075 u8 flags, void *reply, size_t size)
1077 union iucv_param *parm;
1081 parm = iucv_param[smp_processor_id()];
1082 memset(parm, 0, sizeof(union iucv_param));
1083 if (flags & IUCV_IPRMDATA) {
1084 parm->dpl.ippathid = path->pathid;
1085 parm->dpl.ipflags1 = flags;
1086 parm->dpl.ipmsgid = msg->id;
1087 parm->dpl.iptrgcls = msg->class;
1088 memcpy(parm->dpl.iprmmsg, reply, min_t(size_t, size, 8));
1090 parm->db.ipbfadr1 = (u32)(addr_t) reply;
1091 parm->db.ipbfln1f = (u32) size;
1092 parm->db.ippathid = path->pathid;
1093 parm->db.ipflags1 = flags;
1094 parm->db.ipmsgid = msg->id;
1095 parm->db.iptrgcls = msg->class;
1097 rc = iucv_call_b2f0(IUCV_REPLY, parm);
1101 EXPORT_SYMBOL(iucv_message_reply);
1105 * @path: address of iucv path structure
1106 * @msg: address of iucv msg structure
1107 * @flags: how the message is sent (IUCV_IPRMDATA, IUCV_IPPRTY, IUCV_IPBUFLST)
1108 * @srccls: source class of message
1109 * @buffer: address of send buffer or address of struct iucv_array
1110 * @size: length of send buffer
1112 * This function transmits data to another application. Data to be
1113 * transmitted is in a buffer and this is a one-way message and the
1114 * receiver will not reply to the message.
1116 * Returns the result from the CP IUCV call.
1118 int iucv_message_send(struct iucv_path *path, struct iucv_message *msg,
1119 u8 flags, u32 srccls, void *buffer, size_t size)
1121 union iucv_param *parm;
1125 parm = iucv_param[smp_processor_id()];
1126 memset(parm, 0, sizeof(union iucv_param));
1127 if (flags & IUCV_IPRMDATA) {
1128 /* Message of 8 bytes can be placed into the parameter list. */
1129 parm->dpl.ippathid = path->pathid;
1130 parm->dpl.ipflags1 = flags | IUCV_IPNORPY;
1131 parm->dpl.iptrgcls = msg->class;
1132 parm->dpl.ipsrccls = srccls;
1133 parm->dpl.ipmsgtag = msg->tag;
1134 memcpy(parm->dpl.iprmmsg, buffer, 8);
1136 parm->db.ipbfadr1 = (u32)(addr_t) buffer;
1137 parm->db.ipbfln1f = (u32) size;
1138 parm->db.ippathid = path->pathid;
1139 parm->db.ipflags1 = flags | IUCV_IPNORPY;
1140 parm->db.iptrgcls = msg->class;
1141 parm->db.ipsrccls = srccls;
1142 parm->db.ipmsgtag = msg->tag;
1144 rc = iucv_call_b2f0(IUCV_SEND, parm);
1146 msg->id = parm->db.ipmsgid;
1150 EXPORT_SYMBOL(iucv_message_send);
1153 * iucv_message_send2way
1154 * @path: address of iucv path structure
1155 * @msg: address of iucv msg structure
1156 * @flags: how the message is sent and the reply is received
1157 * (IUCV_IPRMDATA, IUCV_IPBUFLST, IUCV_IPPRTY, IUCV_ANSLST)
1158 * @srccls: source class of message
1159 * @buffer: address of send buffer or address of struct iucv_array
1160 * @size: length of send buffer
1161 * @ansbuf: address of answer buffer or address of struct iucv_array
1162 * @asize: size of reply buffer
1164 * This function transmits data to another application. Data to be
1165 * transmitted is in a buffer. The receiver of the send is expected to
1166 * reply to the message and a buffer is provided into which IUCV moves
1167 * the reply to this message.
1169 * Returns the result from the CP IUCV call.
1171 int iucv_message_send2way(struct iucv_path *path, struct iucv_message *msg,
1172 u8 flags, u32 srccls, void *buffer, size_t size,
1173 void *answer, size_t asize, size_t *residual)
1175 union iucv_param *parm;
1179 parm = iucv_param[smp_processor_id()];
1180 memset(parm, 0, sizeof(union iucv_param));
1181 if (flags & IUCV_IPRMDATA) {
1182 parm->dpl.ippathid = path->pathid;
1183 parm->dpl.ipflags1 = path->flags; /* priority message */
1184 parm->dpl.iptrgcls = msg->class;
1185 parm->dpl.ipsrccls = srccls;
1186 parm->dpl.ipmsgtag = msg->tag;
1187 parm->dpl.ipbfadr2 = (u32)(addr_t) answer;
1188 parm->dpl.ipbfln2f = (u32) asize;
1189 memcpy(parm->dpl.iprmmsg, buffer, 8);
1191 parm->db.ippathid = path->pathid;
1192 parm->db.ipflags1 = path->flags; /* priority message */
1193 parm->db.iptrgcls = msg->class;
1194 parm->db.ipsrccls = srccls;
1195 parm->db.ipmsgtag = msg->tag;
1196 parm->db.ipbfadr1 = (u32)(addr_t) buffer;
1197 parm->db.ipbfln1f = (u32) size;
1198 parm->db.ipbfadr2 = (u32)(addr_t) answer;
1199 parm->db.ipbfln2f = (u32) asize;
1201 rc = iucv_call_b2f0(IUCV_SEND, parm);
1203 msg->id = parm->db.ipmsgid;
1207 EXPORT_SYMBOL(iucv_message_send2way);
1211 * @data: Pointer to external interrupt buffer
1213 * Process connection pending work item. Called from tasklet while holding
1216 struct iucv_path_pending {
1227 } __attribute__ ((packed));
1229 static void iucv_path_pending(struct iucv_irq_data *data)
1231 struct iucv_path_pending *ipp = (void *) data;
1232 struct iucv_handler *handler;
1233 struct iucv_path *path;
1236 BUG_ON(iucv_path_table[ipp->ippathid]);
1237 /* New pathid, handler found. Create a new path struct. */
1238 error = iucv_error_no_memory;
1239 path = iucv_path_alloc(ipp->ipmsglim, ipp->ipflags1, GFP_ATOMIC);
1242 path->pathid = ipp->ippathid;
1243 iucv_path_table[path->pathid] = path;
1244 EBCASC(ipp->ipvmid, 8);
1246 /* Call registered handler until one is found that wants the path. */
1247 list_for_each_entry(handler, &iucv_handler_list, list) {
1248 if (!handler->path_pending)
1251 * Add path to handler to allow a call to iucv_path_sever
1252 * inside the path_pending function. If the handler returns
1253 * an error remove the path from the handler again.
1255 list_add(&path->list, &handler->paths);
1256 path->handler = handler;
1257 if (!handler->path_pending(path, ipp->ipvmid, ipp->ipuser))
1259 list_del(&path->list);
1260 path->handler = NULL;
1262 /* No handler wanted the path. */
1263 iucv_path_table[path->pathid] = NULL;
1264 iucv_path_free(path);
1265 error = iucv_error_no_listener;
1267 iucv_sever_pathid(ipp->ippathid, error);
1271 * iucv_path_complete
1272 * @data: Pointer to external interrupt buffer
1274 * Process connection complete work item. Called from tasklet while holding
1277 struct iucv_path_complete {
1288 } __attribute__ ((packed));
1290 static void iucv_path_complete(struct iucv_irq_data *data)
1292 struct iucv_path_complete *ipc = (void *) data;
1293 struct iucv_path *path = iucv_path_table[ipc->ippathid];
1295 if (path && path->handler && path->handler->path_complete)
1296 path->handler->path_complete(path, ipc->ipuser);
1301 * @data: Pointer to external interrupt buffer
1303 * Process connection severed work item. Called from tasklet while holding
1306 struct iucv_path_severed {
1316 } __attribute__ ((packed));
1318 static void iucv_path_severed(struct iucv_irq_data *data)
1320 struct iucv_path_severed *ips = (void *) data;
1321 struct iucv_path *path = iucv_path_table[ips->ippathid];
1323 if (!path || !path->handler) /* Already severed */
1325 if (path->handler->path_severed)
1326 path->handler->path_severed(path, ips->ipuser);
1328 iucv_sever_pathid(path->pathid, NULL);
1329 iucv_path_table[path->pathid] = NULL;
1330 list_del_init(&path->list);
1331 iucv_path_free(path);
1336 * iucv_path_quiesced
1337 * @data: Pointer to external interrupt buffer
1339 * Process connection quiesced work item. Called from tasklet while holding
1342 struct iucv_path_quiesced {
1352 } __attribute__ ((packed));
1354 static void iucv_path_quiesced(struct iucv_irq_data *data)
1356 struct iucv_path_quiesced *ipq = (void *) data;
1357 struct iucv_path *path = iucv_path_table[ipq->ippathid];
1359 if (path && path->handler && path->handler->path_quiesced)
1360 path->handler->path_quiesced(path, ipq->ipuser);
1365 * @data: Pointer to external interrupt buffer
1367 * Process connection resumed work item. Called from tasklet while holding
1370 struct iucv_path_resumed {
1380 } __attribute__ ((packed));
1382 static void iucv_path_resumed(struct iucv_irq_data *data)
1384 struct iucv_path_resumed *ipr = (void *) data;
1385 struct iucv_path *path = iucv_path_table[ipr->ippathid];
1387 if (path && path->handler && path->handler->path_resumed)
1388 path->handler->path_resumed(path, ipr->ipuser);
1392 * iucv_message_complete
1393 * @data: Pointer to external interrupt buffer
1395 * Process message complete work item. Called from tasklet while holding
1398 struct iucv_message_complete {
1411 } __attribute__ ((packed));
1413 static void iucv_message_complete(struct iucv_irq_data *data)
1415 struct iucv_message_complete *imc = (void *) data;
1416 struct iucv_path *path = iucv_path_table[imc->ippathid];
1417 struct iucv_message msg;
1419 if (path && path->handler && path->handler->message_complete) {
1420 msg.flags = imc->ipflags1;
1421 msg.id = imc->ipmsgid;
1422 msg.audit = imc->ipaudit;
1423 memcpy(msg.rmmsg, imc->iprmmsg, 8);
1424 msg.class = imc->ipsrccls;
1425 msg.tag = imc->ipmsgtag;
1426 msg.length = imc->ipbfln2f;
1427 path->handler->message_complete(path, &msg);
1432 * iucv_message_pending
1433 * @data: Pointer to external interrupt buffer
1435 * Process message pending work item. Called from tasklet while holding
1438 struct iucv_message_pending {
1456 } __attribute__ ((packed));
1458 static void iucv_message_pending(struct iucv_irq_data *data)
1460 struct iucv_message_pending *imp = (void *) data;
1461 struct iucv_path *path = iucv_path_table[imp->ippathid];
1462 struct iucv_message msg;
1464 if (path && path->handler && path->handler->message_pending) {
1465 msg.flags = imp->ipflags1;
1466 msg.id = imp->ipmsgid;
1467 msg.class = imp->iptrgcls;
1468 if (imp->ipflags1 & IUCV_IPRMDATA) {
1469 memcpy(msg.rmmsg, imp->ln1msg1.iprmmsg1, 8);
1472 msg.length = imp->ln1msg2.ipbfln1f;
1473 msg.reply_size = imp->ipbfln2f;
1474 path->handler->message_pending(path, &msg);
1481 * This tasklet loops over the queue of irq buffers created by
1482 * iucv_external_interrupt, calls the appropriate action handler
1483 * and then frees the buffer.
1485 static void iucv_tasklet_fn(unsigned long ignored)
1487 typedef void iucv_irq_fn(struct iucv_irq_data *);
1488 static iucv_irq_fn *irq_fn[] = {
1489 [0x02] = iucv_path_complete,
1490 [0x03] = iucv_path_severed,
1491 [0x04] = iucv_path_quiesced,
1492 [0x05] = iucv_path_resumed,
1493 [0x06] = iucv_message_complete,
1494 [0x07] = iucv_message_complete,
1495 [0x08] = iucv_message_pending,
1496 [0x09] = iucv_message_pending,
1498 LIST_HEAD(task_queue);
1499 struct iucv_irq_list *p, *n;
1501 /* Serialize tasklet, iucv_path_sever and iucv_path_connect. */
1502 if (!spin_trylock(&iucv_table_lock)) {
1503 tasklet_schedule(&iucv_tasklet);
1506 iucv_active_cpu = smp_processor_id();
1508 spin_lock_irq(&iucv_queue_lock);
1509 list_splice_init(&iucv_task_queue, &task_queue);
1510 spin_unlock_irq(&iucv_queue_lock);
1512 list_for_each_entry_safe(p, n, &task_queue, list) {
1513 list_del_init(&p->list);
1514 irq_fn[p->data.iptype](&p->data);
1518 iucv_active_cpu = -1;
1519 spin_unlock(&iucv_table_lock);
1525 * This work function loops over the queue of path pending irq blocks
1526 * created by iucv_external_interrupt, calls the appropriate action
1527 * handler and then frees the buffer.
1529 static void iucv_work_fn(struct work_struct *work)
1531 typedef void iucv_irq_fn(struct iucv_irq_data *);
1532 LIST_HEAD(work_queue);
1533 struct iucv_irq_list *p, *n;
1535 /* Serialize tasklet, iucv_path_sever and iucv_path_connect. */
1536 spin_lock_bh(&iucv_table_lock);
1537 iucv_active_cpu = smp_processor_id();
1539 spin_lock_irq(&iucv_queue_lock);
1540 list_splice_init(&iucv_work_queue, &work_queue);
1541 spin_unlock_irq(&iucv_queue_lock);
1543 iucv_cleanup_queue();
1544 list_for_each_entry_safe(p, n, &work_queue, list) {
1545 list_del_init(&p->list);
1546 iucv_path_pending(&p->data);
1550 iucv_active_cpu = -1;
1551 spin_unlock_bh(&iucv_table_lock);
1555 * iucv_external_interrupt
1558 * Handles external interrupts coming in from CP.
1559 * Places the interrupt buffer on a queue and schedules iucv_tasklet_fn().
1561 static void iucv_external_interrupt(u16 code)
1563 struct iucv_irq_data *p;
1564 struct iucv_irq_list *work;
1566 p = iucv_irq_data[smp_processor_id()];
1567 if (p->ippathid >= iucv_max_pathid) {
1568 printk(KERN_WARNING "iucv_do_int: Got interrupt with "
1569 "pathid %d > max_connections (%ld)\n",
1570 p->ippathid, iucv_max_pathid - 1);
1571 iucv_sever_pathid(p->ippathid, iucv_error_no_listener);
1574 if (p->iptype < 0x01 || p->iptype > 0x09) {
1575 printk(KERN_ERR "iucv_do_int: unknown iucv interrupt\n");
1578 work = kmalloc(sizeof(struct iucv_irq_list), GFP_ATOMIC);
1580 printk(KERN_WARNING "iucv_external_interrupt: out of memory\n");
1583 memcpy(&work->data, p, sizeof(work->data));
1584 spin_lock(&iucv_queue_lock);
1585 if (p->iptype == 0x01) {
1586 /* Path pending interrupt. */
1587 list_add_tail(&work->list, &iucv_work_queue);
1588 schedule_work(&iucv_work);
1590 /* The other interrupts. */
1591 list_add_tail(&work->list, &iucv_task_queue);
1592 tasklet_schedule(&iucv_tasklet);
1594 spin_unlock(&iucv_queue_lock);
1600 * Allocates and initializes various data structures.
1602 static int __init iucv_init(void)
1607 if (!MACHINE_IS_VM) {
1608 rc = -EPROTONOSUPPORT;
1611 rc = iucv_query_maxconn();
1614 rc = register_external_interrupt(0x4000, iucv_external_interrupt);
1617 iucv_root = s390_root_dev_register("iucv");
1618 if (IS_ERR(iucv_root)) {
1619 rc = PTR_ERR(iucv_root);
1623 for_each_online_cpu(cpu) {
1624 /* Note: GFP_DMA used to get memory below 2G */
1625 iucv_irq_data[cpu] = kmalloc_node(sizeof(struct iucv_irq_data),
1626 GFP_KERNEL|GFP_DMA, cpu_to_node(cpu));
1627 if (!iucv_irq_data[cpu]) {
1632 /* Allocate parameter blocks. */
1633 iucv_param[cpu] = kmalloc_node(sizeof(union iucv_param),
1634 GFP_KERNEL|GFP_DMA, cpu_to_node(cpu));
1635 if (!iucv_param[cpu]) {
1640 rc = register_hotcpu_notifier(&iucv_cpu_notifier);
1643 ASCEBC(iucv_error_no_listener, 16);
1644 ASCEBC(iucv_error_no_memory, 16);
1645 ASCEBC(iucv_error_pathid, 16);
1647 rc = bus_register(&iucv_bus);
1653 unregister_hotcpu_notifier(&iucv_cpu_notifier);
1655 for_each_possible_cpu(cpu) {
1656 kfree(iucv_param[cpu]);
1657 iucv_param[cpu] = NULL;
1658 kfree(iucv_irq_data[cpu]);
1659 iucv_irq_data[cpu] = NULL;
1661 s390_root_dev_unregister(iucv_root);
1663 unregister_external_interrupt(0x4000, iucv_external_interrupt);
1671 * Frees everything allocated from iucv_init.
1673 static void __exit iucv_exit(void)
1675 struct iucv_irq_list *p, *n;
1678 spin_lock_irq(&iucv_queue_lock);
1679 list_for_each_entry_safe(p, n, &iucv_task_queue, list)
1681 list_for_each_entry_safe(p, n, &iucv_work_queue, list)
1683 spin_unlock_irq(&iucv_queue_lock);
1684 unregister_hotcpu_notifier(&iucv_cpu_notifier);
1685 for_each_possible_cpu(cpu) {
1686 kfree(iucv_param[cpu]);
1687 iucv_param[cpu] = NULL;
1688 kfree(iucv_irq_data[cpu]);
1689 iucv_irq_data[cpu] = NULL;
1691 s390_root_dev_unregister(iucv_root);
1692 bus_unregister(&iucv_bus);
1693 unregister_external_interrupt(0x4000, iucv_external_interrupt);
1696 subsys_initcall(iucv_init);
1697 module_exit(iucv_exit);
1699 MODULE_AUTHOR("(C) 2001 IBM Corp. by Fritz Elfert (felfert@millenux.com)");
1700 MODULE_DESCRIPTION("Linux for S/390 IUCV lowlevel driver");
1701 MODULE_LICENSE("GPL");