2 * IBM eServer Hypervisor Virtual Console Server Device Driver
3 * Copyright (C) 2003, 2004 IBM Corp.
4 * Ryan S. Arnold (rsa@us.ibm.com)
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Author(s) : Ryan S. Arnold <rsa@us.ibm.com>
22 * This is the device driver for the IBM Hypervisor Virtual Console Server,
23 * "hvcs". The IBM hvcs provides a tty driver interface to allow Linux
24 * user space applications access to the system consoles of logically
25 * partitioned operating systems, e.g. Linux, running on the same partitioned
26 * Power5 ppc64 system. Physical hardware consoles per partition are not
27 * practical on this hardware so system consoles are accessed by this driver
28 * using inter-partition firmware interfaces to virtual terminal devices.
30 * A vty is known to the HMC as a "virtual serial server adapter". It is a
31 * virtual terminal device that is created by firmware upon partition creation
32 * to act as a partitioned OS's console device.
34 * Firmware dynamically (via hotplug) exposes vty-servers to a running ppc64
35 * Linux system upon their creation by the HMC or their exposure during boot.
36 * The non-user interactive backend of this driver is implemented as a vio
37 * device driver so that it can receive notification of vty-server lifetimes
38 * after it registers with the vio bus to handle vty-server probe and remove
41 * Many vty-servers can be configured to connect to one vty, but a vty can
42 * only be actively connected to by a single vty-server, in any manner, at one
43 * time. If the HMC is currently hosting the console for a target Linux
44 * partition; attempts to open the tty device to the partition's console using
45 * the hvcs on any partition will return -EBUSY with every open attempt until
46 * the HMC frees the connection between its vty-server and the desired
47 * partition's vty device. Conversely, a vty-server may only be connected to
48 * a single vty at one time even though it may have several configured vty
49 * partner possibilities.
51 * Firmware does not provide notification of vty partner changes to this
52 * driver. This means that an HMC Super Admin may add or remove partner vtys
53 * from a vty-server's partner list but the changes will not be signaled to
54 * the vty-server. Firmware only notifies the driver when a vty-server is
55 * added or removed from the system. To compensate for this deficiency, this
56 * driver implements a sysfs update attribute which provides a method for
57 * rescanning partner information upon a user's request.
59 * Each vty-server, prior to being exposed to this driver is reference counted
60 * using the 2.6 Linux kernel kobject construct. This kobject is also used by
61 * the vio bus to provide a vio device sysfs entry that this driver attaches
62 * device specific attributes to, including partner information. The vio bus
63 * framework also provides a sysfs entry for each vio driver. The hvcs driver
64 * provides driver attributes in this entry.
66 * For direction on installation and usage of this driver please reference
67 * Documentation/powerpc/hvcs.txt.
70 #include <linux/device.h>
71 #include <linux/init.h>
72 #include <linux/interrupt.h>
73 #include <linux/kernel.h>
74 #include <linux/kobject.h>
75 #include <linux/kthread.h>
76 #include <linux/list.h>
77 #include <linux/major.h>
78 #include <linux/module.h>
79 #include <linux/moduleparam.h>
80 #include <linux/sched.h>
81 #include <linux/spinlock.h>
82 #include <linux/stat.h>
83 #include <linux/tty.h>
84 #include <linux/tty_flip.h>
85 #include <asm/hvconsole.h>
86 #include <asm/hvcserver.h>
87 #include <asm/uaccess.h>
91 * 1.3.0 -> 1.3.1 In hvcs_open memset(..,0x00,..) instead of memset(..,0x3F,00).
92 * Removed braces around single statements following conditionals. Removed '=
93 * 0' after static int declarations since these default to zero. Removed
94 * list_for_each_safe() and replaced with list_for_each_entry() in
95 * hvcs_get_by_index(). The 'safe' version is un-needed now that the driver is
96 * using spinlocks. Changed spin_lock_irqsave() to spin_lock() when locking
97 * hvcs_structs_lock and hvcs_pi_lock since these are not touched in an int
98 * handler. Initialized hvcs_structs_lock and hvcs_pi_lock to
99 * SPIN_LOCK_UNLOCKED at declaration time rather than in hvcs_module_init().
100 * Added spin_lock around list_del() in destroy_hvcs_struct() to protect the
101 * list traversals from a deletion. Removed '= NULL' from pointer declaration
102 * statements since they are initialized NULL by default. Removed wmb()
103 * instances from hvcs_try_write(). They probably aren't needed with locking in
104 * place. Added check and cleanup for hvcs_pi_buff = kmalloc() in
105 * hvcs_module_init(). Exposed hvcs_struct.index via a sysfs attribute so that
106 * the coupling between /dev/hvcs* and a vty-server can be automatically
107 * determined. Moved kobject_put() in hvcs_open outside of the
108 * spin_unlock_irqrestore().
110 * 1.3.1 -> 1.3.2 Changed method for determining hvcs_struct->index and had it
111 * align with how the tty layer always assigns the lowest index available. This
112 * change resulted in a list of ints that denotes which indexes are available.
113 * Device additions and removals use the new hvcs_get_index() and
114 * hvcs_return_index() helper functions. The list is created with
115 * hvsc_alloc_index_list() and it is destroyed with hvcs_free_index_list().
116 * Without these fixes hotplug vty-server adapter support goes crazy with this
117 * driver if the user removes a vty-server adapter. Moved free_irq() outside of
118 * the hvcs_final_close() function in order to get it out of the spinlock.
119 * Rearranged hvcs_close(). Cleaned up some printks and did some housekeeping
120 * on the changelog. Removed local CLC_LENGTH and used HVCS_CLC_LENGTH from
121 * include/asm-powerpc/hvcserver.h
123 * 1.3.2 -> 1.3.3 Replaced yield() in hvcs_close() with tty_wait_until_sent() to
124 * prevent possible lockup with realtime scheduling as similarily pointed out by
125 * akpm in hvc_console. Changed resulted in the removal of hvcs_final_close()
126 * to reorder cleanup operations and prevent discarding of pending data during
127 * an hvcs_close(). Removed spinlock protection of hvcs_struct data members in
128 * hvcs_write_room() and hvcs_chars_in_buffer() because they aren't needed.
131 #define HVCS_DRIVER_VERSION "1.3.3"
133 MODULE_AUTHOR("Ryan S. Arnold <rsa@us.ibm.com>");
134 MODULE_DESCRIPTION("IBM hvcs (Hypervisor Virtual Console Server) Driver");
135 MODULE_LICENSE("GPL");
136 MODULE_VERSION(HVCS_DRIVER_VERSION);
139 * Wait this long per iteration while trying to push buffered data to the
140 * hypervisor before allowing the tty to complete a close operation.
142 #define HVCS_CLOSE_WAIT (HZ/100) /* 1/10 of a second */
145 * Since the Linux TTY code does not currently (2-04-2004) support dynamic
146 * addition of tty derived devices and we shouldn't allocate thousands of
147 * tty_device pointers when the number of vty-server & vty partner connections
148 * will most often be much lower than this, we'll arbitrarily allocate
149 * HVCS_DEFAULT_SERVER_ADAPTERS tty_structs and cdev's by default when we
150 * register the tty_driver. This can be overridden using an insmod parameter.
152 #define HVCS_DEFAULT_SERVER_ADAPTERS 64
155 * The user can't insmod with more than HVCS_MAX_SERVER_ADAPTERS hvcs device
156 * nodes as a sanity check. Theoretically there can be over 1 Billion
157 * vty-server & vty partner connections.
159 #define HVCS_MAX_SERVER_ADAPTERS 1024
162 * We let Linux assign us a major number and we start the minors at zero. There
163 * is no intuitive mapping between minor number and the target vty-server
164 * adapter except that each new vty-server adapter is always assigned to the
165 * smallest minor number available.
167 #define HVCS_MINOR_START 0
170 * The hcall interface involves putting 8 chars into each of two registers.
171 * We load up those 2 registers (in arch/powerpc/platforms/pseries/hvconsole.c)
172 * by casting char[16] to long[2]. It would work without __ALIGNED__, but a
173 * little (tiny) bit slower because an unaligned load is slower than aligned
176 #define __ALIGNED__ __attribute__((__aligned__(8)))
179 * How much data can firmware send with each hvc_put_chars()? Maybe this
180 * should be moved into an architecture specific area.
182 #define HVCS_BUFF_LEN 16
185 * This is the maximum amount of data we'll let the user send us (hvcs_write) at
186 * once in a chunk as a sanity check.
188 #define HVCS_MAX_FROM_USER 4096
191 * Be careful when adding flags to this line discipline. Don't add anything
192 * that will cause echoing or we'll go into recursive loop echoing chars back
193 * and forth with the console drivers.
195 static struct ktermios hvcs_tty_termios = {
196 .c_iflag = IGNBRK | IGNPAR,
198 .c_cflag = B38400 | CS8 | CREAD | HUPCL,
205 * This value is used to take the place of a command line parameter when the
206 * module is inserted. It starts as -1 and stays as such if the user doesn't
207 * specify a module insmod parameter. If they DO specify one then it is set to
208 * the value of the integer passed in.
210 static int hvcs_parm_num_devs = -1;
211 module_param(hvcs_parm_num_devs, int, 0);
213 char hvcs_driver_name[] = "hvcs";
214 char hvcs_device_node[] = "hvcs";
215 char hvcs_driver_string[]
216 = "IBM hvcs (Hypervisor Virtual Console Server) Driver";
218 /* Status of partner info rescan triggered via sysfs. */
219 static int hvcs_rescan_status;
221 static struct tty_driver *hvcs_tty_driver;
224 * In order to be somewhat sane this driver always associates the hvcs_struct
225 * index element with the numerically equal tty->index. This means that a
226 * hotplugged vty-server adapter will always map to the lowest index valued
227 * device node. If vty-servers were hotplug removed from the system and then
228 * new ones added the new vty-server may have the largest slot number of all
229 * the vty-server adapters in the partition but it may have the lowest dev node
230 * index of all the adapters due to the hole left by the hotplug removed
231 * adapter. There are a set of functions provided to get the lowest index for
232 * a new device as well as return the index to the list. This list is allocated
233 * with a number of elements equal to the number of device nodes requested when
234 * the module was inserted.
236 static int *hvcs_index_list;
239 * How large is the list? This is kept for traversal since the list is
240 * dynamically created.
242 static int hvcs_index_count;
245 * Used by the khvcsd to pick up I/O operations when the kernel_thread is
246 * already awake but potentially shifted to TASK_INTERRUPTIBLE state.
248 static int hvcs_kicked;
251 * Use by the kthread construct for task operations like waking the sleeping
252 * thread and stopping the kthread.
254 static struct task_struct *hvcs_task;
257 * We allocate this for the use of all of the hvcs_structs when they fetch
260 static unsigned long *hvcs_pi_buff;
262 /* Only allow one hvcs_struct to use the hvcs_pi_buff at a time. */
263 static DEFINE_SPINLOCK(hvcs_pi_lock);
265 /* One vty-server per hvcs_struct */
270 * This index identifies this hvcs device as the complement to a
271 * specific tty index.
275 struct tty_struct *tty;
276 unsigned int open_count;
279 * Used to tell the driver kernel_thread what operations need to take
280 * place upon this hvcs_struct instance.
285 * This buffer is required so that when hvcs_write_room() reports that
286 * it can send HVCS_BUFF_LEN characters that it will buffer the full
287 * HVCS_BUFF_LEN characters if need be. This is essential for opost
288 * writes since they do not do high level buffering and expect to be
289 * able to send what the driver commits to sending buffering
290 * [e.g. tab to space conversions in n_tty.c opost()].
292 char buffer[HVCS_BUFF_LEN];
296 * Any variable below the kobject is valid before a tty is connected and
297 * stays valid after the tty is disconnected. These shouldn't be
298 * whacked until the koject refcount reaches zero though some entries
299 * may be changed via sysfs initiatives.
301 struct kobject kobj; /* ref count & hvcs_struct lifetime */
302 int connected; /* is the vty-server currently connected to a vty? */
303 uint32_t p_unit_address; /* partner unit address */
304 uint32_t p_partition_ID; /* partner partition ID */
305 char p_location_code[HVCS_CLC_LENGTH + 1]; /* CLC + Null Term */
306 struct list_head next; /* list management */
307 struct vio_dev *vdev;
310 /* Required to back map a kobject to its containing object */
311 #define from_kobj(kobj) container_of(kobj, struct hvcs_struct, kobj)
313 static struct list_head hvcs_structs = LIST_HEAD_INIT(hvcs_structs);
314 static DEFINE_SPINLOCK(hvcs_structs_lock);
316 static void hvcs_unthrottle(struct tty_struct *tty);
317 static void hvcs_throttle(struct tty_struct *tty);
318 static irqreturn_t hvcs_handle_interrupt(int irq, void *dev_instance);
320 static int hvcs_write(struct tty_struct *tty,
321 const unsigned char *buf, int count);
322 static int hvcs_write_room(struct tty_struct *tty);
323 static int hvcs_chars_in_buffer(struct tty_struct *tty);
325 static int hvcs_has_pi(struct hvcs_struct *hvcsd);
326 static void hvcs_set_pi(struct hvcs_partner_info *pi,
327 struct hvcs_struct *hvcsd);
328 static int hvcs_get_pi(struct hvcs_struct *hvcsd);
329 static int hvcs_rescan_devices_list(void);
331 static int hvcs_partner_connect(struct hvcs_struct *hvcsd);
332 static void hvcs_partner_free(struct hvcs_struct *hvcsd);
334 static int hvcs_enable_device(struct hvcs_struct *hvcsd,
335 uint32_t unit_address, unsigned int irq, struct vio_dev *dev);
337 static void destroy_hvcs_struct(struct kobject *kobj);
338 static int hvcs_open(struct tty_struct *tty, struct file *filp);
339 static void hvcs_close(struct tty_struct *tty, struct file *filp);
340 static void hvcs_hangup(struct tty_struct * tty);
342 static int __devinit hvcs_probe(struct vio_dev *dev,
343 const struct vio_device_id *id);
344 static int __devexit hvcs_remove(struct vio_dev *dev);
345 static int __init hvcs_module_init(void);
346 static void __exit hvcs_module_exit(void);
348 #define HVCS_SCHED_READ 0x00000001
349 #define HVCS_QUICK_READ 0x00000002
350 #define HVCS_TRY_WRITE 0x00000004
351 #define HVCS_READ_MASK (HVCS_SCHED_READ | HVCS_QUICK_READ)
353 static inline struct hvcs_struct *from_vio_dev(struct vio_dev *viod)
355 return viod->dev.driver_data;
357 /* The sysfs interface for the driver and devices */
359 static ssize_t hvcs_partner_vtys_show(struct device *dev, struct device_attribute *attr, char *buf)
361 struct vio_dev *viod = to_vio_dev(dev);
362 struct hvcs_struct *hvcsd = from_vio_dev(viod);
366 spin_lock_irqsave(&hvcsd->lock, flags);
367 retval = sprintf(buf, "%X\n", hvcsd->p_unit_address);
368 spin_unlock_irqrestore(&hvcsd->lock, flags);
371 static DEVICE_ATTR(partner_vtys, S_IRUGO, hvcs_partner_vtys_show, NULL);
373 static ssize_t hvcs_partner_clcs_show(struct device *dev, struct device_attribute *attr, char *buf)
375 struct vio_dev *viod = to_vio_dev(dev);
376 struct hvcs_struct *hvcsd = from_vio_dev(viod);
380 spin_lock_irqsave(&hvcsd->lock, flags);
381 retval = sprintf(buf, "%s\n", &hvcsd->p_location_code[0]);
382 spin_unlock_irqrestore(&hvcsd->lock, flags);
385 static DEVICE_ATTR(partner_clcs, S_IRUGO, hvcs_partner_clcs_show, NULL);
387 static ssize_t hvcs_current_vty_store(struct device *dev, struct device_attribute *attr, const char * buf,
391 * Don't need this feature at the present time because firmware doesn't
392 * yet support multiple partners.
394 printk(KERN_INFO "HVCS: Denied current_vty change: -EPERM.\n");
398 static ssize_t hvcs_current_vty_show(struct device *dev, struct device_attribute *attr, char *buf)
400 struct vio_dev *viod = to_vio_dev(dev);
401 struct hvcs_struct *hvcsd = from_vio_dev(viod);
405 spin_lock_irqsave(&hvcsd->lock, flags);
406 retval = sprintf(buf, "%s\n", &hvcsd->p_location_code[0]);
407 spin_unlock_irqrestore(&hvcsd->lock, flags);
411 static DEVICE_ATTR(current_vty,
412 S_IRUGO | S_IWUSR, hvcs_current_vty_show, hvcs_current_vty_store);
414 static ssize_t hvcs_vterm_state_store(struct device *dev, struct device_attribute *attr, const char *buf,
417 struct vio_dev *viod = to_vio_dev(dev);
418 struct hvcs_struct *hvcsd = from_vio_dev(viod);
421 /* writing a '0' to this sysfs entry will result in the disconnect. */
422 if (simple_strtol(buf, NULL, 0) != 0)
425 spin_lock_irqsave(&hvcsd->lock, flags);
427 if (hvcsd->open_count > 0) {
428 spin_unlock_irqrestore(&hvcsd->lock, flags);
429 printk(KERN_INFO "HVCS: vterm state unchanged. "
430 "The hvcs device node is still in use.\n");
434 if (hvcsd->connected == 0) {
435 spin_unlock_irqrestore(&hvcsd->lock, flags);
436 printk(KERN_INFO "HVCS: vterm state unchanged. The"
437 " vty-server is not connected to a vty.\n");
441 hvcs_partner_free(hvcsd);
442 printk(KERN_INFO "HVCS: Closed vty-server@%X and"
443 " partner vty@%X:%d connection.\n",
444 hvcsd->vdev->unit_address,
445 hvcsd->p_unit_address,
446 (uint32_t)hvcsd->p_partition_ID);
448 spin_unlock_irqrestore(&hvcsd->lock, flags);
452 static ssize_t hvcs_vterm_state_show(struct device *dev, struct device_attribute *attr, char *buf)
454 struct vio_dev *viod = to_vio_dev(dev);
455 struct hvcs_struct *hvcsd = from_vio_dev(viod);
459 spin_lock_irqsave(&hvcsd->lock, flags);
460 retval = sprintf(buf, "%d\n", hvcsd->connected);
461 spin_unlock_irqrestore(&hvcsd->lock, flags);
464 static DEVICE_ATTR(vterm_state, S_IRUGO | S_IWUSR,
465 hvcs_vterm_state_show, hvcs_vterm_state_store);
467 static ssize_t hvcs_index_show(struct device *dev, struct device_attribute *attr, char *buf)
469 struct vio_dev *viod = to_vio_dev(dev);
470 struct hvcs_struct *hvcsd = from_vio_dev(viod);
474 spin_lock_irqsave(&hvcsd->lock, flags);
475 retval = sprintf(buf, "%d\n", hvcsd->index);
476 spin_unlock_irqrestore(&hvcsd->lock, flags);
480 static DEVICE_ATTR(index, S_IRUGO, hvcs_index_show, NULL);
482 static struct attribute *hvcs_attrs[] = {
483 &dev_attr_partner_vtys.attr,
484 &dev_attr_partner_clcs.attr,
485 &dev_attr_current_vty.attr,
486 &dev_attr_vterm_state.attr,
487 &dev_attr_index.attr,
491 static struct attribute_group hvcs_attr_group = {
495 static ssize_t hvcs_rescan_show(struct device_driver *ddp, char *buf)
497 /* A 1 means it is updating, a 0 means it is done updating */
498 return snprintf(buf, PAGE_SIZE, "%d\n", hvcs_rescan_status);
501 static ssize_t hvcs_rescan_store(struct device_driver *ddp, const char * buf,
504 if ((simple_strtol(buf, NULL, 0) != 1)
505 && (hvcs_rescan_status != 0))
508 hvcs_rescan_status = 1;
509 printk(KERN_INFO "HVCS: rescanning partner info for all"
511 hvcs_rescan_devices_list();
512 hvcs_rescan_status = 0;
516 static DRIVER_ATTR(rescan,
517 S_IRUGO | S_IWUSR, hvcs_rescan_show, hvcs_rescan_store);
519 static void hvcs_kick(void)
523 wake_up_process(hvcs_task);
526 static void hvcs_unthrottle(struct tty_struct *tty)
528 struct hvcs_struct *hvcsd = tty->driver_data;
531 spin_lock_irqsave(&hvcsd->lock, flags);
532 hvcsd->todo_mask |= HVCS_SCHED_READ;
533 spin_unlock_irqrestore(&hvcsd->lock, flags);
537 static void hvcs_throttle(struct tty_struct *tty)
539 struct hvcs_struct *hvcsd = tty->driver_data;
542 spin_lock_irqsave(&hvcsd->lock, flags);
543 vio_disable_interrupts(hvcsd->vdev);
544 spin_unlock_irqrestore(&hvcsd->lock, flags);
548 * If the device is being removed we don't have to worry about this interrupt
549 * handler taking any further interrupts because they are disabled which means
550 * the hvcs_struct will always be valid in this handler.
552 static irqreturn_t hvcs_handle_interrupt(int irq, void *dev_instance)
554 struct hvcs_struct *hvcsd = dev_instance;
556 spin_lock(&hvcsd->lock);
557 vio_disable_interrupts(hvcsd->vdev);
558 hvcsd->todo_mask |= HVCS_SCHED_READ;
559 spin_unlock(&hvcsd->lock);
565 /* This function must be called with the hvcsd->lock held */
566 static void hvcs_try_write(struct hvcs_struct *hvcsd)
568 uint32_t unit_address = hvcsd->vdev->unit_address;
569 struct tty_struct *tty = hvcsd->tty;
572 if (hvcsd->todo_mask & HVCS_TRY_WRITE) {
573 /* won't send partial writes */
574 sent = hvc_put_chars(unit_address,
576 hvcsd->chars_in_buffer );
578 hvcsd->chars_in_buffer = 0;
580 hvcsd->todo_mask &= ~(HVCS_TRY_WRITE);
584 * We are still obligated to deliver the data to the
585 * hypervisor even if the tty has been closed because
586 * we commited to delivering it. But don't try to wake
587 * a non-existent tty.
596 static int hvcs_io(struct hvcs_struct *hvcsd)
598 uint32_t unit_address;
599 struct tty_struct *tty;
600 char buf[HVCS_BUFF_LEN] __ALIGNED__;
604 spin_lock_irqsave(&hvcsd->lock, flags);
606 unit_address = hvcsd->vdev->unit_address;
609 hvcs_try_write(hvcsd);
611 if (!tty || test_bit(TTY_THROTTLED, &tty->flags)) {
612 hvcsd->todo_mask &= ~(HVCS_READ_MASK);
614 } else if (!(hvcsd->todo_mask & (HVCS_READ_MASK)))
617 /* remove the read masks */
618 hvcsd->todo_mask &= ~(HVCS_READ_MASK);
620 if (tty_buffer_request_room(tty, HVCS_BUFF_LEN) >= HVCS_BUFF_LEN) {
621 got = hvc_get_chars(unit_address,
624 tty_insert_flip_string(tty, buf, got);
627 /* Give the TTY time to process the data we just sent. */
629 hvcsd->todo_mask |= HVCS_QUICK_READ;
631 spin_unlock_irqrestore(&hvcsd->lock, flags);
632 /* This is synch because tty->low_latency == 1 */
634 tty_flip_buffer_push(tty);
637 /* Do this _after_ the flip_buffer_push */
638 spin_lock_irqsave(&hvcsd->lock, flags);
639 vio_enable_interrupts(hvcsd->vdev);
640 spin_unlock_irqrestore(&hvcsd->lock, flags);
643 return hvcsd->todo_mask;
646 spin_unlock_irqrestore(&hvcsd->lock, flags);
647 return hvcsd->todo_mask;
650 static int khvcsd(void *unused)
652 struct hvcs_struct *hvcsd;
655 __set_current_state(TASK_RUNNING);
662 spin_lock(&hvcs_structs_lock);
663 list_for_each_entry(hvcsd, &hvcs_structs, next) {
664 hvcs_todo_mask |= hvcs_io(hvcsd);
666 spin_unlock(&hvcs_structs_lock);
669 * If any of the hvcs adapters want to try a write or quick read
670 * don't schedule(), yield a smidgen then execute the hvcs_io
671 * thread again for those that want the write.
673 if (hvcs_todo_mask & (HVCS_TRY_WRITE | HVCS_QUICK_READ)) {
678 set_current_state(TASK_INTERRUPTIBLE);
681 __set_current_state(TASK_RUNNING);
682 } while (!kthread_should_stop());
687 static struct vio_device_id hvcs_driver_table[] __devinitdata= {
688 {"serial-server", "hvterm2"},
691 MODULE_DEVICE_TABLE(vio, hvcs_driver_table);
693 static void hvcs_return_index(int index)
696 if (!hvcs_index_list)
698 if (index < 0 || index >= hvcs_index_count)
700 if (hvcs_index_list[index] == -1)
703 hvcs_index_list[index] = -1;
706 /* callback when the kboject ref count reaches zero */
707 static void destroy_hvcs_struct(struct kobject *kobj)
709 struct hvcs_struct *hvcsd = from_kobj(kobj);
710 struct vio_dev *vdev;
713 spin_lock(&hvcs_structs_lock);
714 spin_lock_irqsave(&hvcsd->lock, flags);
716 /* the list_del poisons the pointers */
717 list_del(&(hvcsd->next));
719 if (hvcsd->connected == 1) {
720 hvcs_partner_free(hvcsd);
721 printk(KERN_INFO "HVCS: Closed vty-server@%X and"
722 " partner vty@%X:%d connection.\n",
723 hvcsd->vdev->unit_address,
724 hvcsd->p_unit_address,
725 (uint32_t)hvcsd->p_partition_ID);
727 printk(KERN_INFO "HVCS: Destroyed hvcs_struct for vty-server@%X.\n",
728 hvcsd->vdev->unit_address);
733 hvcsd->p_unit_address = 0;
734 hvcsd->p_partition_ID = 0;
735 hvcs_return_index(hvcsd->index);
736 memset(&hvcsd->p_location_code[0], 0x00, HVCS_CLC_LENGTH + 1);
738 spin_unlock_irqrestore(&hvcsd->lock, flags);
739 spin_unlock(&hvcs_structs_lock);
741 sysfs_remove_group(&vdev->dev.kobj, &hvcs_attr_group);
746 static struct kobj_type hvcs_kobj_type = {
747 .release = destroy_hvcs_struct,
750 static int hvcs_get_index(void)
754 if (!hvcs_index_list) {
755 printk(KERN_ERR "HVCS: hvcs_index_list NOT valid!.\n");
758 /* Find the numerically lowest first free index. */
759 for(i = 0; i < hvcs_index_count; i++) {
760 if (hvcs_index_list[i] == -1) {
761 hvcs_index_list[i] = 0;
768 static int __devinit hvcs_probe(
770 const struct vio_device_id *id)
772 struct hvcs_struct *hvcsd;
777 printk(KERN_ERR "HVCS: probed with invalid parameter.\n");
781 /* early to avoid cleanup on failure */
782 index = hvcs_get_index();
787 hvcsd = kmalloc(sizeof(*hvcsd), GFP_KERNEL);
791 /* hvcsd->tty is zeroed out with the memset */
792 memset(hvcsd, 0x00, sizeof(*hvcsd));
794 spin_lock_init(&hvcsd->lock);
795 /* Automatically incs the refcount the first time */
796 kobject_init(&hvcsd->kobj);
797 /* Set up the callback for terminating the hvcs_struct's life */
798 hvcsd->kobj.ktype = &hvcs_kobj_type;
801 dev->dev.driver_data = hvcsd;
803 hvcsd->index = index;
805 /* hvcsd->index = ++hvcs_struct_count; */
806 hvcsd->chars_in_buffer = 0;
807 hvcsd->todo_mask = 0;
808 hvcsd->connected = 0;
811 * This will populate the hvcs_struct's partner info fields for the
814 if (hvcs_get_pi(hvcsd)) {
815 printk(KERN_ERR "HVCS: Failed to fetch partner"
816 " info for vty-server@%X on device probe.\n",
817 hvcsd->vdev->unit_address);
821 * If a user app opens a tty that corresponds to this vty-server before
822 * the hvcs_struct has been added to the devices list then the user app
825 spin_lock(&hvcs_structs_lock);
826 list_add_tail(&(hvcsd->next), &hvcs_structs);
827 spin_unlock(&hvcs_structs_lock);
829 retval = sysfs_create_group(&dev->dev.kobj, &hvcs_attr_group);
831 printk(KERN_ERR "HVCS: Can't create sysfs attrs for vty-server@%X\n",
832 hvcsd->vdev->unit_address);
836 printk(KERN_INFO "HVCS: vty-server@%X added to the vio bus.\n", dev->unit_address);
839 * DON'T enable interrupts here because there is no user to receive the
845 static int __devexit hvcs_remove(struct vio_dev *dev)
847 struct hvcs_struct *hvcsd = dev->dev.driver_data;
849 struct kobject *kobjp;
850 struct tty_struct *tty;
855 /* By this time the vty-server won't be getting any more interrups */
857 spin_lock_irqsave(&hvcsd->lock, flags);
861 kobjp = &hvcsd->kobj;
863 spin_unlock_irqrestore(&hvcsd->lock, flags);
866 * Let the last holder of this object cause it to be removed, which
867 * would probably be tty_hangup below.
872 * The hangup is a scheduled function which will auto chain call
873 * hvcs_hangup. The tty should always be valid at this time unless a
874 * simultaneous tty close already cleaned up the hvcs_struct.
879 printk(KERN_INFO "HVCS: vty-server@%X removed from the"
880 " vio bus.\n", dev->unit_address);
884 static struct vio_driver hvcs_vio_driver = {
885 .id_table = hvcs_driver_table,
887 .remove = hvcs_remove,
889 .name = hvcs_driver_name,
890 .owner = THIS_MODULE,
894 /* Only called from hvcs_get_pi please */
895 static void hvcs_set_pi(struct hvcs_partner_info *pi, struct hvcs_struct *hvcsd)
899 hvcsd->p_unit_address = pi->unit_address;
900 hvcsd->p_partition_ID = pi->partition_ID;
901 clclength = strlen(&pi->location_code[0]);
902 if (clclength > HVCS_CLC_LENGTH)
903 clclength = HVCS_CLC_LENGTH;
905 /* copy the null-term char too */
906 strncpy(&hvcsd->p_location_code[0],
907 &pi->location_code[0], clclength + 1);
911 * Traverse the list and add the partner info that is found to the hvcs_struct
912 * struct entry. NOTE: At this time I know that partner info will return a
913 * single entry but in the future there may be multiple partner info entries per
914 * vty-server and you'll want to zero out that list and reset it. If for some
915 * reason you have an old version of this driver but there IS more than one
916 * partner info then hvcsd->p_* will hold the last partner info data from the
917 * firmware query. A good way to update this code would be to replace the three
918 * partner info fields in hvcs_struct with a list of hvcs_partner_info
921 * This function must be called with the hvcsd->lock held.
923 static int hvcs_get_pi(struct hvcs_struct *hvcsd)
925 struct hvcs_partner_info *pi;
926 uint32_t unit_address = hvcsd->vdev->unit_address;
927 struct list_head head;
930 spin_lock(&hvcs_pi_lock);
932 spin_unlock(&hvcs_pi_lock);
935 retval = hvcs_get_partner_info(unit_address, &head, hvcs_pi_buff);
936 spin_unlock(&hvcs_pi_lock);
938 printk(KERN_ERR "HVCS: Failed to fetch partner"
939 " info for vty-server@%x.\n", unit_address);
943 /* nixes the values if the partner vty went away */
944 hvcsd->p_unit_address = 0;
945 hvcsd->p_partition_ID = 0;
947 list_for_each_entry(pi, &head, node)
948 hvcs_set_pi(pi, hvcsd);
950 hvcs_free_partner_info(&head);
955 * This function is executed by the driver "rescan" sysfs entry. It shouldn't
956 * be executed elsewhere, in order to prevent deadlock issues.
958 static int hvcs_rescan_devices_list(void)
960 struct hvcs_struct *hvcsd;
963 spin_lock(&hvcs_structs_lock);
965 list_for_each_entry(hvcsd, &hvcs_structs, next) {
966 spin_lock_irqsave(&hvcsd->lock, flags);
968 spin_unlock_irqrestore(&hvcsd->lock, flags);
971 spin_unlock(&hvcs_structs_lock);
977 * Farm this off into its own function because it could be more complex once
978 * multiple partners support is added. This function should be called with
979 * the hvcsd->lock held.
981 static int hvcs_has_pi(struct hvcs_struct *hvcsd)
983 if ((!hvcsd->p_unit_address) || (!hvcsd->p_partition_ID))
989 * NOTE: It is possible that the super admin removed a partner vty and then
990 * added a different vty as the new partner.
992 * This function must be called with the hvcsd->lock held.
994 static int hvcs_partner_connect(struct hvcs_struct *hvcsd)
997 unsigned int unit_address = hvcsd->vdev->unit_address;
1000 * If there wasn't any pi when the device was added it doesn't meant
1001 * there isn't any now. This driver isn't notified when a new partner
1002 * vty is added to a vty-server so we discover changes on our own.
1003 * Please see comments in hvcs_register_connection() for justification
1004 * of this bizarre code.
1006 retval = hvcs_register_connection(unit_address,
1007 hvcsd->p_partition_ID,
1008 hvcsd->p_unit_address);
1010 hvcsd->connected = 1;
1012 } else if (retval != -EINVAL)
1016 * As per the spec re-get the pi and try again if -EINVAL after the
1017 * first connection attempt.
1019 if (hvcs_get_pi(hvcsd))
1022 if (!hvcs_has_pi(hvcsd))
1025 retval = hvcs_register_connection(unit_address,
1026 hvcsd->p_partition_ID,
1027 hvcsd->p_unit_address);
1028 if (retval != -EINVAL) {
1029 hvcsd->connected = 1;
1034 * EBUSY is the most likely scenario though the vty could have been
1035 * removed or there really could be an hcall error due to the parameter
1036 * data but thanks to ambiguous firmware return codes we can't really
1039 printk(KERN_INFO "HVCS: vty-server or partner"
1040 " vty is busy. Try again later.\n");
1044 /* This function must be called with the hvcsd->lock held */
1045 static void hvcs_partner_free(struct hvcs_struct *hvcsd)
1049 retval = hvcs_free_connection(hvcsd->vdev->unit_address);
1050 } while (retval == -EBUSY);
1051 hvcsd->connected = 0;
1054 /* This helper function must be called WITHOUT the hvcsd->lock held */
1055 static int hvcs_enable_device(struct hvcs_struct *hvcsd, uint32_t unit_address,
1056 unsigned int irq, struct vio_dev *vdev)
1058 unsigned long flags;
1062 * It is possible that the vty-server was removed between the time that
1063 * the conn was registered and now.
1065 if (!(rc = request_irq(irq, &hvcs_handle_interrupt,
1066 IRQF_DISABLED, "ibmhvcs", hvcsd))) {
1068 * It is possible the vty-server was removed after the irq was
1069 * requested but before we have time to enable interrupts.
1071 if (vio_enable_interrupts(vdev) == H_SUCCESS)
1074 printk(KERN_ERR "HVCS: int enable failed for"
1075 " vty-server@%X.\n", unit_address);
1076 free_irq(irq, hvcsd);
1079 printk(KERN_ERR "HVCS: irq req failed for"
1080 " vty-server@%X.\n", unit_address);
1082 spin_lock_irqsave(&hvcsd->lock, flags);
1083 hvcs_partner_free(hvcsd);
1084 spin_unlock_irqrestore(&hvcsd->lock, flags);
1091 * This always increments the kobject ref count if the call is successful.
1092 * Please remember to dec when you are done with the instance.
1094 * NOTICE: Do NOT hold either the hvcs_struct.lock or hvcs_structs_lock when
1095 * calling this function or you will get deadlock.
1097 struct hvcs_struct *hvcs_get_by_index(int index)
1099 struct hvcs_struct *hvcsd = NULL;
1100 unsigned long flags;
1102 spin_lock(&hvcs_structs_lock);
1103 /* We can immediately discard OOB requests */
1104 if (index >= 0 && index < HVCS_MAX_SERVER_ADAPTERS) {
1105 list_for_each_entry(hvcsd, &hvcs_structs, next) {
1106 spin_lock_irqsave(&hvcsd->lock, flags);
1107 if (hvcsd->index == index) {
1108 kobject_get(&hvcsd->kobj);
1109 spin_unlock_irqrestore(&hvcsd->lock, flags);
1110 spin_unlock(&hvcs_structs_lock);
1113 spin_unlock_irqrestore(&hvcsd->lock, flags);
1118 spin_unlock(&hvcs_structs_lock);
1123 * This is invoked via the tty_open interface when a user app connects to the
1126 static int hvcs_open(struct tty_struct *tty, struct file *filp)
1128 struct hvcs_struct *hvcsd;
1130 unsigned long flags;
1132 struct vio_dev *vdev;
1133 unsigned long unit_address;
1134 struct kobject *kobjp;
1136 if (tty->driver_data)
1140 * Is there a vty-server that shares the same index?
1141 * This function increments the kobject index.
1143 if (!(hvcsd = hvcs_get_by_index(tty->index))) {
1144 printk(KERN_WARNING "HVCS: open failed, no device associated"
1145 " with tty->index %d.\n", tty->index);
1149 spin_lock_irqsave(&hvcsd->lock, flags);
1151 if (hvcsd->connected == 0)
1152 if ((retval = hvcs_partner_connect(hvcsd)))
1155 hvcsd->open_count = 1;
1157 tty->driver_data = hvcsd;
1160 * Set this driver to low latency so that we actually have a chance at
1161 * catching a throttled TTY after we flip_buffer_push. Otherwise the
1162 * flush_to_async may not execute until after the kernel_thread has
1163 * yielded and resumed the next flip_buffer_push resulting in data
1166 tty->low_latency = 1;
1168 memset(&hvcsd->buffer[0], 0x00, HVCS_BUFF_LEN);
1171 * Save these in the spinlock for the enable operations that need them
1172 * outside of the spinlock.
1174 irq = hvcsd->vdev->irq;
1176 unit_address = hvcsd->vdev->unit_address;
1178 hvcsd->todo_mask |= HVCS_SCHED_READ;
1179 spin_unlock_irqrestore(&hvcsd->lock, flags);
1182 * This must be done outside of the spinlock because it requests irqs
1183 * and will grab the spinlock and free the connection if it fails.
1185 if (((rc = hvcs_enable_device(hvcsd, unit_address, irq, vdev)))) {
1186 kobject_put(&hvcsd->kobj);
1187 printk(KERN_WARNING "HVCS: enable device failed.\n");
1194 hvcsd = tty->driver_data;
1196 spin_lock_irqsave(&hvcsd->lock, flags);
1197 if (!kobject_get(&hvcsd->kobj)) {
1198 spin_unlock_irqrestore(&hvcsd->lock, flags);
1199 printk(KERN_ERR "HVCS: Kobject of open"
1200 " hvcs doesn't exist.\n");
1201 return -EFAULT; /* Is this the right return value? */
1204 hvcsd->open_count++;
1206 hvcsd->todo_mask |= HVCS_SCHED_READ;
1207 spin_unlock_irqrestore(&hvcsd->lock, flags);
1211 printk(KERN_INFO "HVCS: vty-server@%X connection opened.\n",
1212 hvcsd->vdev->unit_address );
1217 kobjp = &hvcsd->kobj;
1218 spin_unlock_irqrestore(&hvcsd->lock, flags);
1219 kobject_put(&hvcsd->kobj);
1221 printk(KERN_WARNING "HVCS: partner connect failed.\n");
1225 static void hvcs_close(struct tty_struct *tty, struct file *filp)
1227 struct hvcs_struct *hvcsd;
1228 unsigned long flags;
1229 struct kobject *kobjp;
1233 * Is someone trying to close the file associated with this device after
1234 * we have hung up? If so tty->driver_data wouldn't be valid.
1236 if (tty_hung_up_p(filp))
1240 * No driver_data means that this close was probably issued after a
1241 * failed hvcs_open by the tty layer's release_dev() api and we can just
1244 if (!tty->driver_data)
1247 hvcsd = tty->driver_data;
1249 spin_lock_irqsave(&hvcsd->lock, flags);
1250 kobjp = &hvcsd->kobj;
1251 if (--hvcsd->open_count == 0) {
1253 vio_disable_interrupts(hvcsd->vdev);
1256 * NULL this early so that the kernel_thread doesn't try to
1257 * execute any operations on the TTY even though it is obligated
1258 * to deliver any pending I/O to the hypervisor.
1262 irq = hvcsd->vdev->irq;
1263 spin_unlock_irqrestore(&hvcsd->lock, flags);
1265 tty_wait_until_sent(tty, HVCS_CLOSE_WAIT);
1268 * This line is important because it tells hvcs_open that this
1269 * device needs to be re-configured the next time hvcs_open is
1272 tty->driver_data = NULL;
1274 free_irq(irq, hvcsd);
1277 } else if (hvcsd->open_count < 0) {
1278 printk(KERN_ERR "HVCS: vty-server@%X open_count: %d"
1279 " is missmanaged.\n",
1280 hvcsd->vdev->unit_address, hvcsd->open_count);
1283 spin_unlock_irqrestore(&hvcsd->lock, flags);
1287 static void hvcs_hangup(struct tty_struct * tty)
1289 struct hvcs_struct *hvcsd = tty->driver_data;
1290 unsigned long flags;
1291 int temp_open_count;
1292 struct kobject *kobjp;
1295 spin_lock_irqsave(&hvcsd->lock, flags);
1296 /* Preserve this so that we know how many kobject refs to put */
1297 temp_open_count = hvcsd->open_count;
1300 * Don't kobject put inside the spinlock because the destruction
1301 * callback may use the spinlock and it may get called before the
1302 * spinlock has been released. Get a pointer to the kobject and
1303 * kobject_put on that after releasing the spinlock.
1305 kobjp = &hvcsd->kobj;
1307 vio_disable_interrupts(hvcsd->vdev);
1309 hvcsd->todo_mask = 0;
1311 /* I don't think the tty needs the hvcs_struct pointer after a hangup */
1312 hvcsd->tty->driver_data = NULL;
1315 hvcsd->open_count = 0;
1317 /* This will drop any buffered data on the floor which is OK in a hangup
1319 memset(&hvcsd->buffer[0], 0x00, HVCS_BUFF_LEN);
1320 hvcsd->chars_in_buffer = 0;
1322 irq = hvcsd->vdev->irq;
1324 spin_unlock_irqrestore(&hvcsd->lock, flags);
1326 free_irq(irq, hvcsd);
1329 * We need to kobject_put() for every open_count we have since the
1330 * tty_hangup() function doesn't invoke a close per open connection on a
1331 * non-console device.
1333 while(temp_open_count) {
1336 * The final put will trigger destruction of the hvcs_struct.
1337 * NOTE: If this hangup was signaled from user space then the
1338 * final put will never happen.
1345 * NOTE: This is almost always from_user since user level apps interact with the
1346 * /dev nodes. I'm trusting that if hvcs_write gets called and interrupted by
1347 * hvcs_remove (which removes the target device and executes tty_hangup()) that
1348 * tty_hangup will allow hvcs_write time to complete execution before it
1349 * terminates our device.
1351 static int hvcs_write(struct tty_struct *tty,
1352 const unsigned char *buf, int count)
1354 struct hvcs_struct *hvcsd = tty->driver_data;
1355 unsigned int unit_address;
1356 const unsigned char *charbuf;
1357 unsigned long flags;
1363 * If they don't check the return code off of their open they may
1364 * attempt this even if there is no connected device.
1369 /* Reasonable size to prevent user level flooding */
1370 if (count > HVCS_MAX_FROM_USER) {
1371 printk(KERN_WARNING "HVCS write: count being truncated to"
1372 " HVCS_MAX_FROM_USER.\n");
1373 count = HVCS_MAX_FROM_USER;
1378 spin_lock_irqsave(&hvcsd->lock, flags);
1381 * Somehow an open succedded but the device was removed or the
1382 * connection terminated between the vty-server and partner vty during
1383 * the middle of a write operation? This is a crummy place to do this
1384 * but we want to keep it all in the spinlock.
1386 if (hvcsd->open_count <= 0) {
1387 spin_unlock_irqrestore(&hvcsd->lock, flags);
1391 unit_address = hvcsd->vdev->unit_address;
1394 tosend = min(count, (HVCS_BUFF_LEN - hvcsd->chars_in_buffer));
1396 * No more space, this probably means that the last call to
1397 * hvcs_write() didn't succeed and the buffer was filled up.
1402 memcpy(&hvcsd->buffer[hvcsd->chars_in_buffer],
1403 &charbuf[total_sent],
1406 hvcsd->chars_in_buffer += tosend;
1411 * If this is true then we don't want to try writing to the
1412 * hypervisor because that is the kernel_threads job now. We'll
1413 * just add to the buffer.
1415 if (!(hvcsd->todo_mask & HVCS_TRY_WRITE))
1416 /* won't send partial writes */
1417 result = hvc_put_chars(unit_address,
1419 hvcsd->chars_in_buffer);
1422 * Since we know we have enough room in hvcsd->buffer for
1423 * tosend we record that it was sent regardless of whether the
1424 * hypervisor actually took it because we have it buffered.
1429 hvcsd->todo_mask |= HVCS_TRY_WRITE;
1434 hvcsd->chars_in_buffer = 0;
1436 * Test after the chars_in_buffer reset otherwise this could
1437 * deadlock our writes if hvc_put_chars fails.
1443 spin_unlock_irqrestore(&hvcsd->lock, flags);
1452 * This is really asking how much can we guarentee that we can send or that we
1453 * absolutely WILL BUFFER if we can't send it. This driver MUST honor the
1454 * return value, hence the reason for hvcs_struct buffering.
1456 static int hvcs_write_room(struct tty_struct *tty)
1458 struct hvcs_struct *hvcsd = tty->driver_data;
1460 if (!hvcsd || hvcsd->open_count <= 0)
1463 return HVCS_BUFF_LEN - hvcsd->chars_in_buffer;
1466 static int hvcs_chars_in_buffer(struct tty_struct *tty)
1468 struct hvcs_struct *hvcsd = tty->driver_data;
1470 return hvcsd->chars_in_buffer;
1473 static const struct tty_operations hvcs_ops = {
1475 .close = hvcs_close,
1476 .hangup = hvcs_hangup,
1477 .write = hvcs_write,
1478 .write_room = hvcs_write_room,
1479 .chars_in_buffer = hvcs_chars_in_buffer,
1480 .unthrottle = hvcs_unthrottle,
1481 .throttle = hvcs_throttle,
1484 static int hvcs_alloc_index_list(int n)
1488 hvcs_index_list = kmalloc(n * sizeof(hvcs_index_count),GFP_KERNEL);
1489 if (!hvcs_index_list)
1491 hvcs_index_count = n;
1492 for (i = 0; i < hvcs_index_count; i++)
1493 hvcs_index_list[i] = -1;
1497 static void hvcs_free_index_list(void)
1499 /* Paranoia check to be thorough. */
1500 kfree(hvcs_index_list);
1501 hvcs_index_list = NULL;
1502 hvcs_index_count = 0;
1505 static int __init hvcs_module_init(void)
1508 int num_ttys_to_alloc;
1510 printk(KERN_INFO "Initializing %s\n", hvcs_driver_string);
1512 /* Has the user specified an overload with an insmod param? */
1513 if (hvcs_parm_num_devs <= 0 ||
1514 (hvcs_parm_num_devs > HVCS_MAX_SERVER_ADAPTERS)) {
1515 num_ttys_to_alloc = HVCS_DEFAULT_SERVER_ADAPTERS;
1517 num_ttys_to_alloc = hvcs_parm_num_devs;
1519 hvcs_tty_driver = alloc_tty_driver(num_ttys_to_alloc);
1520 if (!hvcs_tty_driver)
1523 if (hvcs_alloc_index_list(num_ttys_to_alloc)) {
1528 hvcs_tty_driver->owner = THIS_MODULE;
1530 hvcs_tty_driver->driver_name = hvcs_driver_name;
1531 hvcs_tty_driver->name = hvcs_device_node;
1534 * We'll let the system assign us a major number, indicated by leaving
1538 hvcs_tty_driver->minor_start = HVCS_MINOR_START;
1539 hvcs_tty_driver->type = TTY_DRIVER_TYPE_SYSTEM;
1542 * We role our own so that we DONT ECHO. We can't echo because the
1543 * device we are connecting to already echoes by default and this would
1544 * throw us into a horrible recursive echo-echo-echo loop.
1546 hvcs_tty_driver->init_termios = hvcs_tty_termios;
1547 hvcs_tty_driver->flags = TTY_DRIVER_REAL_RAW;
1549 tty_set_operations(hvcs_tty_driver, &hvcs_ops);
1552 * The following call will result in sysfs entries that denote the
1553 * dynamically assigned major and minor numbers for our devices.
1555 if (tty_register_driver(hvcs_tty_driver)) {
1556 printk(KERN_ERR "HVCS: registration as a tty driver failed.\n");
1561 hvcs_pi_buff = kmalloc(PAGE_SIZE, GFP_KERNEL);
1562 if (!hvcs_pi_buff) {
1564 goto buff_alloc_fail;
1567 hvcs_task = kthread_run(khvcsd, NULL, "khvcsd");
1568 if (IS_ERR(hvcs_task)) {
1569 printk(KERN_ERR "HVCS: khvcsd creation failed. Driver not loaded.\n");
1574 rc = vio_register_driver(&hvcs_vio_driver);
1576 printk(KERN_ERR "HVCS: can't register vio driver\n");
1581 * This needs to be done AFTER the vio_register_driver() call or else
1582 * the kobjects won't be initialized properly.
1584 rc = driver_create_file(&(hvcs_vio_driver.driver), &driver_attr_rescan);
1586 printk(KERN_ERR "HVCS: sysfs attr create failed\n");
1590 printk(KERN_INFO "HVCS: driver module inserted.\n");
1595 vio_unregister_driver(&hvcs_vio_driver);
1597 kthread_stop(hvcs_task);
1599 kfree(hvcs_pi_buff);
1601 tty_unregister_driver(hvcs_tty_driver);
1603 hvcs_free_index_list();
1605 put_tty_driver(hvcs_tty_driver);
1606 hvcs_tty_driver = NULL;
1610 static void __exit hvcs_module_exit(void)
1613 * This driver receives hvcs_remove callbacks for each device upon
1618 * This synchronous operation will wake the khvcsd kthread if it is
1619 * asleep and will return when khvcsd has terminated.
1621 kthread_stop(hvcs_task);
1623 spin_lock(&hvcs_pi_lock);
1624 kfree(hvcs_pi_buff);
1625 hvcs_pi_buff = NULL;
1626 spin_unlock(&hvcs_pi_lock);
1628 driver_remove_file(&hvcs_vio_driver.driver, &driver_attr_rescan);
1630 vio_unregister_driver(&hvcs_vio_driver);
1632 tty_unregister_driver(hvcs_tty_driver);
1634 hvcs_free_index_list();
1636 put_tty_driver(hvcs_tty_driver);
1638 printk(KERN_INFO "HVCS: driver module removed.\n");
1641 module_init(hvcs_module_init);
1642 module_exit(hvcs_module_exit);