[PATCH] prism54: fix potential race in reset scheduling
[linux-2.6] / drivers / char / hvcs.c
1 /*
2  * IBM eServer Hypervisor Virtual Console Server Device Driver
3  * Copyright (C) 2003, 2004 IBM Corp.
4  *  Ryan S. Arnold (rsa@us.ibm.com)
5  *
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.
10  *
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.
15  *
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
19  *
20  * Author(s) :  Ryan S. Arnold <rsa@us.ibm.com>
21  *
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.
29  *
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.
33  *
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
39  * callbacks.
40  *
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.
50  *
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.
58  *
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.
65  *
66  * For direction on installation and usage of this driver please reference
67  * Documentation/powerpc/hvcs.txt.
68  */
69
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>
88 #include <asm/vio.h>
89
90 /*
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().
109  *
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 
122  *
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.
129  */
130
131 #define HVCS_DRIVER_VERSION "1.3.3"
132
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);
137
138 /*
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.
141  */
142 #define HVCS_CLOSE_WAIT (HZ/100) /* 1/10 of a second */
143
144 /*
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.
151  */
152 #define HVCS_DEFAULT_SERVER_ADAPTERS    64
153
154 /*
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.
158  */
159 #define HVCS_MAX_SERVER_ADAPTERS        1024
160
161 /*
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.
166  */
167 #define HVCS_MINOR_START        0
168
169 /*
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 
174  * load.
175  */
176 #define __ALIGNED__     __attribute__((__aligned__(8)))
177
178 /*
179  * How much data can firmware send with each hvc_put_chars()?  Maybe this
180  * should be moved into an architecture specific area.
181  */
182 #define HVCS_BUFF_LEN   16
183
184 /*
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.
187  */
188 #define HVCS_MAX_FROM_USER      4096
189
190 /*
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.
194  */
195 static struct termios hvcs_tty_termios = {
196         .c_iflag = IGNBRK | IGNPAR,
197         .c_oflag = OPOST,
198         .c_cflag = B38400 | CS8 | CREAD | HUPCL,
199         .c_cc = INIT_C_CC
200 };
201
202 /*
203  * This value is used to take the place of a command line parameter when the
204  * module is inserted.  It starts as -1 and stays as such if the user doesn't
205  * specify a module insmod parameter.  If they DO specify one then it is set to
206  * the value of the integer passed in.
207  */
208 static int hvcs_parm_num_devs = -1;
209 module_param(hvcs_parm_num_devs, int, 0);
210
211 char hvcs_driver_name[] = "hvcs";
212 char hvcs_device_node[] = "hvcs";
213 char hvcs_driver_string[]
214         = "IBM hvcs (Hypervisor Virtual Console Server) Driver";
215
216 /* Status of partner info rescan triggered via sysfs. */
217 static int hvcs_rescan_status;
218
219 static struct tty_driver *hvcs_tty_driver;
220
221 /*
222  * In order to be somewhat sane this driver always associates the hvcs_struct
223  * index element with the numerically equal tty->index.  This means that a
224  * hotplugged vty-server adapter will always map to the lowest index valued
225  * device node.  If vty-servers were hotplug removed from the system and then
226  * new ones added the new vty-server may have the largest slot number of all
227  * the vty-server adapters in the partition but it may have the lowest dev node
228  * index of all the adapters due to the hole left by the hotplug removed
229  * adapter.  There are a set of functions provided to get the lowest index for
230  * a new device as well as return the index to the list.  This list is allocated
231  * with a number of elements equal to the number of device nodes requested when
232  * the module was inserted.
233  */
234 static int *hvcs_index_list;
235
236 /*
237  * How large is the list?  This is kept for traversal since the list is
238  * dynamically created.
239  */
240 static int hvcs_index_count;
241
242 /*
243  * Used by the khvcsd to pick up I/O operations when the kernel_thread is
244  * already awake but potentially shifted to TASK_INTERRUPTIBLE state.
245  */
246 static int hvcs_kicked;
247
248 /*
249  * Use by the kthread construct for task operations like waking the sleeping
250  * thread and stopping the kthread.
251  */
252 static struct task_struct *hvcs_task;
253
254 /*
255  * We allocate this for the use of all of the hvcs_structs when they fetch
256  * partner info.
257  */
258 static unsigned long *hvcs_pi_buff;
259
260 /* Only allow one hvcs_struct to use the hvcs_pi_buff at a time. */
261 static DEFINE_SPINLOCK(hvcs_pi_lock);
262
263 /* One vty-server per hvcs_struct */
264 struct hvcs_struct {
265         spinlock_t lock;
266
267         /*
268          * This index identifies this hvcs device as the complement to a
269          * specific tty index.
270          */
271         unsigned int index;
272
273         struct tty_struct *tty;
274         unsigned int open_count;
275
276         /*
277          * Used to tell the driver kernel_thread what operations need to take
278          * place upon this hvcs_struct instance.
279          */
280         int todo_mask;
281
282         /*
283          * This buffer is required so that when hvcs_write_room() reports that
284          * it can send HVCS_BUFF_LEN characters that it will buffer the full
285          * HVCS_BUFF_LEN characters if need be.  This is essential for opost
286          * writes since they do not do high level buffering and expect to be
287          * able to send what the driver commits to sending buffering
288          * [e.g. tab to space conversions in n_tty.c opost()].
289          */
290         char buffer[HVCS_BUFF_LEN];
291         int chars_in_buffer;
292
293         /*
294          * Any variable below the kobject is valid before a tty is connected and
295          * stays valid after the tty is disconnected.  These shouldn't be
296          * whacked until the koject refcount reaches zero though some entries
297          * may be changed via sysfs initiatives.
298          */
299         struct kobject kobj; /* ref count & hvcs_struct lifetime */
300         int connected; /* is the vty-server currently connected to a vty? */
301         uint32_t p_unit_address; /* partner unit address */
302         uint32_t p_partition_ID; /* partner partition ID */
303         char p_location_code[HVCS_CLC_LENGTH + 1]; /* CLC + Null Term */
304         struct list_head next; /* list management */
305         struct vio_dev *vdev;
306 };
307
308 /* Required to back map a kobject to its containing object */
309 #define from_kobj(kobj) container_of(kobj, struct hvcs_struct, kobj)
310
311 static struct list_head hvcs_structs = LIST_HEAD_INIT(hvcs_structs);
312 static DEFINE_SPINLOCK(hvcs_structs_lock);
313
314 static void hvcs_unthrottle(struct tty_struct *tty);
315 static void hvcs_throttle(struct tty_struct *tty);
316 static irqreturn_t hvcs_handle_interrupt(int irq, void *dev_instance);
317
318 static int hvcs_write(struct tty_struct *tty,
319                 const unsigned char *buf, int count);
320 static int hvcs_write_room(struct tty_struct *tty);
321 static int hvcs_chars_in_buffer(struct tty_struct *tty);
322
323 static int hvcs_has_pi(struct hvcs_struct *hvcsd);
324 static void hvcs_set_pi(struct hvcs_partner_info *pi,
325                 struct hvcs_struct *hvcsd);
326 static int hvcs_get_pi(struct hvcs_struct *hvcsd);
327 static int hvcs_rescan_devices_list(void);
328
329 static int hvcs_partner_connect(struct hvcs_struct *hvcsd);
330 static void hvcs_partner_free(struct hvcs_struct *hvcsd);
331
332 static int hvcs_enable_device(struct hvcs_struct *hvcsd,
333                 uint32_t unit_address, unsigned int irq, struct vio_dev *dev);
334
335 static void destroy_hvcs_struct(struct kobject *kobj);
336 static int hvcs_open(struct tty_struct *tty, struct file *filp);
337 static void hvcs_close(struct tty_struct *tty, struct file *filp);
338 static void hvcs_hangup(struct tty_struct * tty);
339
340 static void hvcs_create_device_attrs(struct hvcs_struct *hvcsd);
341 static void hvcs_remove_device_attrs(struct vio_dev *vdev);
342 static void hvcs_create_driver_attrs(void);
343 static void hvcs_remove_driver_attrs(void);
344
345 static int __devinit hvcs_probe(struct vio_dev *dev,
346                 const struct vio_device_id *id);
347 static int __devexit hvcs_remove(struct vio_dev *dev);
348 static int __init hvcs_module_init(void);
349 static void __exit hvcs_module_exit(void);
350
351 #define HVCS_SCHED_READ 0x00000001
352 #define HVCS_QUICK_READ 0x00000002
353 #define HVCS_TRY_WRITE  0x00000004
354 #define HVCS_READ_MASK  (HVCS_SCHED_READ | HVCS_QUICK_READ)
355
356 static void hvcs_kick(void)
357 {
358         hvcs_kicked = 1;
359         wmb();
360         wake_up_process(hvcs_task);
361 }
362
363 static void hvcs_unthrottle(struct tty_struct *tty)
364 {
365         struct hvcs_struct *hvcsd = tty->driver_data;
366         unsigned long flags;
367
368         spin_lock_irqsave(&hvcsd->lock, flags);
369         hvcsd->todo_mask |= HVCS_SCHED_READ;
370         spin_unlock_irqrestore(&hvcsd->lock, flags);
371         hvcs_kick();
372 }
373
374 static void hvcs_throttle(struct tty_struct *tty)
375 {
376         struct hvcs_struct *hvcsd = tty->driver_data;
377         unsigned long flags;
378
379         spin_lock_irqsave(&hvcsd->lock, flags);
380         vio_disable_interrupts(hvcsd->vdev);
381         spin_unlock_irqrestore(&hvcsd->lock, flags);
382 }
383
384 /*
385  * If the device is being removed we don't have to worry about this interrupt
386  * handler taking any further interrupts because they are disabled which means
387  * the hvcs_struct will always be valid in this handler.
388  */
389 static irqreturn_t hvcs_handle_interrupt(int irq, void *dev_instance)
390 {
391         struct hvcs_struct *hvcsd = dev_instance;
392
393         spin_lock(&hvcsd->lock);
394         vio_disable_interrupts(hvcsd->vdev);
395         hvcsd->todo_mask |= HVCS_SCHED_READ;
396         spin_unlock(&hvcsd->lock);
397         hvcs_kick();
398
399         return IRQ_HANDLED;
400 }
401
402 /* This function must be called with the hvcsd->lock held */
403 static void hvcs_try_write(struct hvcs_struct *hvcsd)
404 {
405         uint32_t unit_address = hvcsd->vdev->unit_address;
406         struct tty_struct *tty = hvcsd->tty;
407         int sent;
408
409         if (hvcsd->todo_mask & HVCS_TRY_WRITE) {
410                 /* won't send partial writes */
411                 sent = hvc_put_chars(unit_address,
412                                 &hvcsd->buffer[0],
413                                 hvcsd->chars_in_buffer );
414                 if (sent > 0) {
415                         hvcsd->chars_in_buffer = 0;
416                         /* wmb(); */
417                         hvcsd->todo_mask &= ~(HVCS_TRY_WRITE);
418                         /* wmb(); */
419
420                         /*
421                          * We are still obligated to deliver the data to the
422                          * hypervisor even if the tty has been closed because
423                          * we commited to delivering it.  But don't try to wake
424                          * a non-existent tty.
425                          */
426                         if (tty) {
427                                 tty_wakeup(tty);
428                         }
429                 }
430         }
431 }
432
433 static int hvcs_io(struct hvcs_struct *hvcsd)
434 {
435         uint32_t unit_address;
436         struct tty_struct *tty;
437         char buf[HVCS_BUFF_LEN] __ALIGNED__;
438         unsigned long flags;
439         int got = 0;
440
441         spin_lock_irqsave(&hvcsd->lock, flags);
442
443         unit_address = hvcsd->vdev->unit_address;
444         tty = hvcsd->tty;
445
446         hvcs_try_write(hvcsd);
447
448         if (!tty || test_bit(TTY_THROTTLED, &tty->flags)) {
449                 hvcsd->todo_mask &= ~(HVCS_READ_MASK);
450                 goto bail;
451         } else if (!(hvcsd->todo_mask & (HVCS_READ_MASK)))
452                 goto bail;
453
454         /* remove the read masks */
455         hvcsd->todo_mask &= ~(HVCS_READ_MASK);
456
457         if (tty_buffer_request_room(tty, HVCS_BUFF_LEN) >= HVCS_BUFF_LEN) {
458                 got = hvc_get_chars(unit_address,
459                                 &buf[0],
460                                 HVCS_BUFF_LEN);
461                 tty_insert_flip_string(tty, buf, got);
462         }
463
464         /* Give the TTY time to process the data we just sent. */
465         if (got)
466                 hvcsd->todo_mask |= HVCS_QUICK_READ;
467
468         spin_unlock_irqrestore(&hvcsd->lock, flags);
469         /* This is synch because tty->low_latency == 1 */
470         if(got)
471                 tty_flip_buffer_push(tty);
472
473         if (!got) {
474                 /* Do this _after_ the flip_buffer_push */
475                 spin_lock_irqsave(&hvcsd->lock, flags);
476                 vio_enable_interrupts(hvcsd->vdev);
477                 spin_unlock_irqrestore(&hvcsd->lock, flags);
478         }
479
480         return hvcsd->todo_mask;
481
482  bail:
483         spin_unlock_irqrestore(&hvcsd->lock, flags);
484         return hvcsd->todo_mask;
485 }
486
487 static int khvcsd(void *unused)
488 {
489         struct hvcs_struct *hvcsd;
490         int hvcs_todo_mask;
491
492         __set_current_state(TASK_RUNNING);
493
494         do {
495                 hvcs_todo_mask = 0;
496                 hvcs_kicked = 0;
497                 wmb();
498
499                 spin_lock(&hvcs_structs_lock);
500                 list_for_each_entry(hvcsd, &hvcs_structs, next) {
501                         hvcs_todo_mask |= hvcs_io(hvcsd);
502                 }
503                 spin_unlock(&hvcs_structs_lock);
504
505                 /*
506                  * If any of the hvcs adapters want to try a write or quick read
507                  * don't schedule(), yield a smidgen then execute the hvcs_io
508                  * thread again for those that want the write.
509                  */
510                  if (hvcs_todo_mask & (HVCS_TRY_WRITE | HVCS_QUICK_READ)) {
511                         yield();
512                         continue;
513                 }
514
515                 set_current_state(TASK_INTERRUPTIBLE);
516                 if (!hvcs_kicked)
517                         schedule();
518                 __set_current_state(TASK_RUNNING);
519         } while (!kthread_should_stop());
520
521         return 0;
522 }
523
524 static struct vio_device_id hvcs_driver_table[] __devinitdata= {
525         {"serial-server", "hvterm2"},
526         { "", "" }
527 };
528 MODULE_DEVICE_TABLE(vio, hvcs_driver_table);
529
530 static void hvcs_return_index(int index)
531 {
532         /* Paranoia check */
533         if (!hvcs_index_list)
534                 return;
535         if (index < 0 || index >= hvcs_index_count)
536                 return;
537         if (hvcs_index_list[index] == -1)
538                 return;
539         else
540                 hvcs_index_list[index] = -1;
541 }
542
543 /* callback when the kboject ref count reaches zero */
544 static void destroy_hvcs_struct(struct kobject *kobj)
545 {
546         struct hvcs_struct *hvcsd = from_kobj(kobj);
547         struct vio_dev *vdev;
548         unsigned long flags;
549
550         spin_lock(&hvcs_structs_lock);
551         spin_lock_irqsave(&hvcsd->lock, flags);
552
553         /* the list_del poisons the pointers */
554         list_del(&(hvcsd->next));
555
556         if (hvcsd->connected == 1) {
557                 hvcs_partner_free(hvcsd);
558                 printk(KERN_INFO "HVCS: Closed vty-server@%X and"
559                                 " partner vty@%X:%d connection.\n",
560                                 hvcsd->vdev->unit_address,
561                                 hvcsd->p_unit_address,
562                                 (uint32_t)hvcsd->p_partition_ID);
563         }
564         printk(KERN_INFO "HVCS: Destroyed hvcs_struct for vty-server@%X.\n",
565                         hvcsd->vdev->unit_address);
566
567         vdev = hvcsd->vdev;
568         hvcsd->vdev = NULL;
569
570         hvcsd->p_unit_address = 0;
571         hvcsd->p_partition_ID = 0;
572         hvcs_return_index(hvcsd->index);
573         memset(&hvcsd->p_location_code[0], 0x00, HVCS_CLC_LENGTH + 1);
574
575         spin_unlock_irqrestore(&hvcsd->lock, flags);
576         spin_unlock(&hvcs_structs_lock);
577
578         hvcs_remove_device_attrs(vdev);
579
580         kfree(hvcsd);
581 }
582
583 static struct kobj_type hvcs_kobj_type = {
584         .release = destroy_hvcs_struct,
585 };
586
587 static int hvcs_get_index(void)
588 {
589         int i;
590         /* Paranoia check */
591         if (!hvcs_index_list) {
592                 printk(KERN_ERR "HVCS: hvcs_index_list NOT valid!.\n");
593                 return -EFAULT;
594         }
595         /* Find the numerically lowest first free index. */
596         for(i = 0; i < hvcs_index_count; i++) {
597                 if (hvcs_index_list[i] == -1) {
598                         hvcs_index_list[i] = 0;
599                         return i;
600                 }
601         }
602         return -1;
603 }
604
605 static int __devinit hvcs_probe(
606         struct vio_dev *dev,
607         const struct vio_device_id *id)
608 {
609         struct hvcs_struct *hvcsd;
610         int index;
611
612         if (!dev || !id) {
613                 printk(KERN_ERR "HVCS: probed with invalid parameter.\n");
614                 return -EPERM;
615         }
616
617         /* early to avoid cleanup on failure */
618         index = hvcs_get_index();
619         if (index < 0) {
620                 return -EFAULT;
621         }
622
623         hvcsd = kmalloc(sizeof(*hvcsd), GFP_KERNEL);
624         if (!hvcsd)
625                 return -ENODEV;
626
627         /* hvcsd->tty is zeroed out with the memset */
628         memset(hvcsd, 0x00, sizeof(*hvcsd));
629
630         spin_lock_init(&hvcsd->lock);
631         /* Automatically incs the refcount the first time */
632         kobject_init(&hvcsd->kobj);
633         /* Set up the callback for terminating the hvcs_struct's life */
634         hvcsd->kobj.ktype = &hvcs_kobj_type;
635
636         hvcsd->vdev = dev;
637         dev->dev.driver_data = hvcsd;
638
639         hvcsd->index = index;
640
641         /* hvcsd->index = ++hvcs_struct_count; */
642         hvcsd->chars_in_buffer = 0;
643         hvcsd->todo_mask = 0;
644         hvcsd->connected = 0;
645
646         /*
647          * This will populate the hvcs_struct's partner info fields for the
648          * first time.
649          */
650         if (hvcs_get_pi(hvcsd)) {
651                 printk(KERN_ERR "HVCS: Failed to fetch partner"
652                         " info for vty-server@%X on device probe.\n",
653                         hvcsd->vdev->unit_address);
654         }
655
656         /*
657          * If a user app opens a tty that corresponds to this vty-server before
658          * the hvcs_struct has been added to the devices list then the user app
659          * will get -ENODEV.
660          */
661
662         spin_lock(&hvcs_structs_lock);
663
664         list_add_tail(&(hvcsd->next), &hvcs_structs);
665
666         spin_unlock(&hvcs_structs_lock);
667
668         hvcs_create_device_attrs(hvcsd);
669
670         printk(KERN_INFO "HVCS: vty-server@%X added to the vio bus.\n", dev->unit_address);
671
672         /*
673          * DON'T enable interrupts here because there is no user to receive the
674          * data.
675          */
676         return 0;
677 }
678
679 static int __devexit hvcs_remove(struct vio_dev *dev)
680 {
681         struct hvcs_struct *hvcsd = dev->dev.driver_data;
682         unsigned long flags;
683         struct kobject *kobjp;
684         struct tty_struct *tty;
685
686         if (!hvcsd)
687                 return -ENODEV;
688
689         /* By this time the vty-server won't be getting any more interrups */
690
691         spin_lock_irqsave(&hvcsd->lock, flags);
692
693         tty = hvcsd->tty;
694
695         kobjp = &hvcsd->kobj;
696
697         spin_unlock_irqrestore(&hvcsd->lock, flags);
698
699         /*
700          * Let the last holder of this object cause it to be removed, which
701          * would probably be tty_hangup below.
702          */
703         kobject_put (kobjp);
704
705         /*
706          * The hangup is a scheduled function which will auto chain call
707          * hvcs_hangup.  The tty should always be valid at this time unless a
708          * simultaneous tty close already cleaned up the hvcs_struct.
709          */
710         if (tty)
711                 tty_hangup(tty);
712
713         printk(KERN_INFO "HVCS: vty-server@%X removed from the"
714                         " vio bus.\n", dev->unit_address);
715         return 0;
716 };
717
718 static struct vio_driver hvcs_vio_driver = {
719         .id_table       = hvcs_driver_table,
720         .probe          = hvcs_probe,
721         .remove         = hvcs_remove,
722         .driver         = {
723                 .name   = hvcs_driver_name,
724                 .owner  = THIS_MODULE,
725         }
726 };
727
728 /* Only called from hvcs_get_pi please */
729 static void hvcs_set_pi(struct hvcs_partner_info *pi, struct hvcs_struct *hvcsd)
730 {
731         int clclength;
732
733         hvcsd->p_unit_address = pi->unit_address;
734         hvcsd->p_partition_ID  = pi->partition_ID;
735         clclength = strlen(&pi->location_code[0]);
736         if (clclength > HVCS_CLC_LENGTH)
737                 clclength = HVCS_CLC_LENGTH;
738
739         /* copy the null-term char too */
740         strncpy(&hvcsd->p_location_code[0],
741                         &pi->location_code[0], clclength + 1);
742 }
743
744 /*
745  * Traverse the list and add the partner info that is found to the hvcs_struct
746  * struct entry. NOTE: At this time I know that partner info will return a
747  * single entry but in the future there may be multiple partner info entries per
748  * vty-server and you'll want to zero out that list and reset it.  If for some
749  * reason you have an old version of this driver but there IS more than one
750  * partner info then hvcsd->p_* will hold the last partner info data from the
751  * firmware query.  A good way to update this code would be to replace the three
752  * partner info fields in hvcs_struct with a list of hvcs_partner_info
753  * instances.
754  *
755  * This function must be called with the hvcsd->lock held.
756  */
757 static int hvcs_get_pi(struct hvcs_struct *hvcsd)
758 {
759         struct hvcs_partner_info *pi;
760         uint32_t unit_address = hvcsd->vdev->unit_address;
761         struct list_head head;
762         int retval;
763
764         spin_lock(&hvcs_pi_lock);
765         if (!hvcs_pi_buff) {
766                 spin_unlock(&hvcs_pi_lock);
767                 return -EFAULT;
768         }
769         retval = hvcs_get_partner_info(unit_address, &head, hvcs_pi_buff);
770         spin_unlock(&hvcs_pi_lock);
771         if (retval) {
772                 printk(KERN_ERR "HVCS: Failed to fetch partner"
773                         " info for vty-server@%x.\n", unit_address);
774                 return retval;
775         }
776
777         /* nixes the values if the partner vty went away */
778         hvcsd->p_unit_address = 0;
779         hvcsd->p_partition_ID = 0;
780
781         list_for_each_entry(pi, &head, node)
782                 hvcs_set_pi(pi, hvcsd);
783
784         hvcs_free_partner_info(&head);
785         return 0;
786 }
787
788 /*
789  * This function is executed by the driver "rescan" sysfs entry.  It shouldn't
790  * be executed elsewhere, in order to prevent deadlock issues.
791  */
792 static int hvcs_rescan_devices_list(void)
793 {
794         struct hvcs_struct *hvcsd;
795         unsigned long flags;
796
797         spin_lock(&hvcs_structs_lock);
798
799         list_for_each_entry(hvcsd, &hvcs_structs, next) {
800                 spin_lock_irqsave(&hvcsd->lock, flags);
801                 hvcs_get_pi(hvcsd);
802                 spin_unlock_irqrestore(&hvcsd->lock, flags);
803         }
804
805         spin_unlock(&hvcs_structs_lock);
806
807         return 0;
808 }
809
810 /*
811  * Farm this off into its own function because it could be more complex once
812  * multiple partners support is added. This function should be called with
813  * the hvcsd->lock held.
814  */
815 static int hvcs_has_pi(struct hvcs_struct *hvcsd)
816 {
817         if ((!hvcsd->p_unit_address) || (!hvcsd->p_partition_ID))
818                 return 0;
819         return 1;
820 }
821
822 /*
823  * NOTE: It is possible that the super admin removed a partner vty and then
824  * added a different vty as the new partner.
825  *
826  * This function must be called with the hvcsd->lock held.
827  */
828 static int hvcs_partner_connect(struct hvcs_struct *hvcsd)
829 {
830         int retval;
831         unsigned int unit_address = hvcsd->vdev->unit_address;
832
833         /*
834          * If there wasn't any pi when the device was added it doesn't meant
835          * there isn't any now.  This driver isn't notified when a new partner
836          * vty is added to a vty-server so we discover changes on our own.
837          * Please see comments in hvcs_register_connection() for justification
838          * of this bizarre code.
839          */
840         retval = hvcs_register_connection(unit_address,
841                         hvcsd->p_partition_ID,
842                         hvcsd->p_unit_address);
843         if (!retval) {
844                 hvcsd->connected = 1;
845                 return 0;
846         } else if (retval != -EINVAL)
847                 return retval;
848
849         /*
850          * As per the spec re-get the pi and try again if -EINVAL after the
851          * first connection attempt.
852          */
853         if (hvcs_get_pi(hvcsd))
854                 return -ENOMEM;
855
856         if (!hvcs_has_pi(hvcsd))
857                 return -ENODEV;
858
859         retval = hvcs_register_connection(unit_address,
860                         hvcsd->p_partition_ID,
861                         hvcsd->p_unit_address);
862         if (retval != -EINVAL) {
863                 hvcsd->connected = 1;
864                 return retval;
865         }
866
867         /*
868          * EBUSY is the most likely scenario though the vty could have been
869          * removed or there really could be an hcall error due to the parameter
870          * data but thanks to ambiguous firmware return codes we can't really
871          * tell.
872          */
873         printk(KERN_INFO "HVCS: vty-server or partner"
874                         " vty is busy.  Try again later.\n");
875         return -EBUSY;
876 }
877
878 /* This function must be called with the hvcsd->lock held */
879 static void hvcs_partner_free(struct hvcs_struct *hvcsd)
880 {
881         int retval;
882         do {
883                 retval = hvcs_free_connection(hvcsd->vdev->unit_address);
884         } while (retval == -EBUSY);
885         hvcsd->connected = 0;
886 }
887
888 /* This helper function must be called WITHOUT the hvcsd->lock held */
889 static int hvcs_enable_device(struct hvcs_struct *hvcsd, uint32_t unit_address,
890                 unsigned int irq, struct vio_dev *vdev)
891 {
892         unsigned long flags;
893         int rc;
894
895         /*
896          * It is possible that the vty-server was removed between the time that
897          * the conn was registered and now.
898          */
899         if (!(rc = request_irq(irq, &hvcs_handle_interrupt,
900                                 IRQF_DISABLED, "ibmhvcs", hvcsd))) {
901                 /*
902                  * It is possible the vty-server was removed after the irq was
903                  * requested but before we have time to enable interrupts.
904                  */
905                 if (vio_enable_interrupts(vdev) == H_SUCCESS)
906                         return 0;
907                 else {
908                         printk(KERN_ERR "HVCS: int enable failed for"
909                                         " vty-server@%X.\n", unit_address);
910                         free_irq(irq, hvcsd);
911                 }
912         } else
913                 printk(KERN_ERR "HVCS: irq req failed for"
914                                 " vty-server@%X.\n", unit_address);
915
916         spin_lock_irqsave(&hvcsd->lock, flags);
917         hvcs_partner_free(hvcsd);
918         spin_unlock_irqrestore(&hvcsd->lock, flags);
919
920         return rc;
921
922 }
923
924 /*
925  * This always increments the kobject ref count if the call is successful.
926  * Please remember to dec when you are done with the instance.
927  *
928  * NOTICE: Do NOT hold either the hvcs_struct.lock or hvcs_structs_lock when
929  * calling this function or you will get deadlock.
930  */
931 struct hvcs_struct *hvcs_get_by_index(int index)
932 {
933         struct hvcs_struct *hvcsd = NULL;
934         unsigned long flags;
935
936         spin_lock(&hvcs_structs_lock);
937         /* We can immediately discard OOB requests */
938         if (index >= 0 && index < HVCS_MAX_SERVER_ADAPTERS) {
939                 list_for_each_entry(hvcsd, &hvcs_structs, next) {
940                         spin_lock_irqsave(&hvcsd->lock, flags);
941                         if (hvcsd->index == index) {
942                                 kobject_get(&hvcsd->kobj);
943                                 spin_unlock_irqrestore(&hvcsd->lock, flags);
944                                 spin_unlock(&hvcs_structs_lock);
945                                 return hvcsd;
946                         }
947                         spin_unlock_irqrestore(&hvcsd->lock, flags);
948                 }
949                 hvcsd = NULL;
950         }
951
952         spin_unlock(&hvcs_structs_lock);
953         return hvcsd;
954 }
955
956 /*
957  * This is invoked via the tty_open interface when a user app connects to the
958  * /dev node.
959  */
960 static int hvcs_open(struct tty_struct *tty, struct file *filp)
961 {
962         struct hvcs_struct *hvcsd;
963         int rc, retval = 0;
964         unsigned long flags;
965         unsigned int irq;
966         struct vio_dev *vdev;
967         unsigned long unit_address;
968         struct kobject *kobjp;
969
970         if (tty->driver_data)
971                 goto fast_open;
972
973         /*
974          * Is there a vty-server that shares the same index?
975          * This function increments the kobject index.
976          */
977         if (!(hvcsd = hvcs_get_by_index(tty->index))) {
978                 printk(KERN_WARNING "HVCS: open failed, no device associated"
979                                 " with tty->index %d.\n", tty->index);
980                 return -ENODEV;
981         }
982
983         spin_lock_irqsave(&hvcsd->lock, flags);
984
985         if (hvcsd->connected == 0)
986                 if ((retval = hvcs_partner_connect(hvcsd)))
987                         goto error_release;
988
989         hvcsd->open_count = 1;
990         hvcsd->tty = tty;
991         tty->driver_data = hvcsd;
992
993         /*
994          * Set this driver to low latency so that we actually have a chance at
995          * catching a throttled TTY after we flip_buffer_push.  Otherwise the
996          * flush_to_async may not execute until after the kernel_thread has
997          * yielded and resumed the next flip_buffer_push resulting in data
998          * loss.
999          */
1000         tty->low_latency = 1;
1001
1002         memset(&hvcsd->buffer[0], 0x00, HVCS_BUFF_LEN);
1003
1004         /*
1005          * Save these in the spinlock for the enable operations that need them
1006          * outside of the spinlock.
1007          */
1008         irq = hvcsd->vdev->irq;
1009         vdev = hvcsd->vdev;
1010         unit_address = hvcsd->vdev->unit_address;
1011
1012         hvcsd->todo_mask |= HVCS_SCHED_READ;
1013         spin_unlock_irqrestore(&hvcsd->lock, flags);
1014
1015         /*
1016          * This must be done outside of the spinlock because it requests irqs
1017          * and will grab the spinlock and free the connection if it fails.
1018          */
1019         if (((rc = hvcs_enable_device(hvcsd, unit_address, irq, vdev)))) {
1020                 kobject_put(&hvcsd->kobj);
1021                 printk(KERN_WARNING "HVCS: enable device failed.\n");
1022                 return rc;
1023         }
1024
1025         goto open_success;
1026
1027 fast_open:
1028         hvcsd = tty->driver_data;
1029
1030         spin_lock_irqsave(&hvcsd->lock, flags);
1031         if (!kobject_get(&hvcsd->kobj)) {
1032                 spin_unlock_irqrestore(&hvcsd->lock, flags);
1033                 printk(KERN_ERR "HVCS: Kobject of open"
1034                         " hvcs doesn't exist.\n");
1035                 return -EFAULT; /* Is this the right return value? */
1036         }
1037
1038         hvcsd->open_count++;
1039
1040         hvcsd->todo_mask |= HVCS_SCHED_READ;
1041         spin_unlock_irqrestore(&hvcsd->lock, flags);
1042 open_success:
1043         hvcs_kick();
1044
1045         printk(KERN_INFO "HVCS: vty-server@%X connection opened.\n",
1046                 hvcsd->vdev->unit_address );
1047
1048         return 0;
1049
1050 error_release:
1051         kobjp = &hvcsd->kobj;
1052         spin_unlock_irqrestore(&hvcsd->lock, flags);
1053         kobject_put(&hvcsd->kobj);
1054
1055         printk(KERN_WARNING "HVCS: partner connect failed.\n");
1056         return retval;
1057 }
1058
1059 static void hvcs_close(struct tty_struct *tty, struct file *filp)
1060 {
1061         struct hvcs_struct *hvcsd;
1062         unsigned long flags;
1063         struct kobject *kobjp;
1064         int irq = NO_IRQ;
1065
1066         /*
1067          * Is someone trying to close the file associated with this device after
1068          * we have hung up?  If so tty->driver_data wouldn't be valid.
1069          */
1070         if (tty_hung_up_p(filp))
1071                 return;
1072
1073         /*
1074          * No driver_data means that this close was probably issued after a
1075          * failed hvcs_open by the tty layer's release_dev() api and we can just
1076          * exit cleanly.
1077          */
1078         if (!tty->driver_data)
1079                 return;
1080
1081         hvcsd = tty->driver_data;
1082
1083         spin_lock_irqsave(&hvcsd->lock, flags);
1084         kobjp = &hvcsd->kobj;
1085         if (--hvcsd->open_count == 0) {
1086
1087                 vio_disable_interrupts(hvcsd->vdev);
1088
1089                 /*
1090                  * NULL this early so that the kernel_thread doesn't try to
1091                  * execute any operations on the TTY even though it is obligated
1092                  * to deliver any pending I/O to the hypervisor.
1093                  */
1094                 hvcsd->tty = NULL;
1095
1096                 irq = hvcsd->vdev->irq;
1097                 spin_unlock_irqrestore(&hvcsd->lock, flags);
1098
1099                 tty_wait_until_sent(tty, HVCS_CLOSE_WAIT);
1100
1101                 /*
1102                  * This line is important because it tells hvcs_open that this
1103                  * device needs to be re-configured the next time hvcs_open is
1104                  * called.
1105                  */
1106                 tty->driver_data = NULL;
1107
1108                 free_irq(irq, hvcsd);
1109                 kobject_put(kobjp);
1110                 return;
1111         } else if (hvcsd->open_count < 0) {
1112                 printk(KERN_ERR "HVCS: vty-server@%X open_count: %d"
1113                                 " is missmanaged.\n",
1114                 hvcsd->vdev->unit_address, hvcsd->open_count);
1115         }
1116
1117         spin_unlock_irqrestore(&hvcsd->lock, flags);
1118         kobject_put(kobjp);
1119 }
1120
1121 static void hvcs_hangup(struct tty_struct * tty)
1122 {
1123         struct hvcs_struct *hvcsd = tty->driver_data;
1124         unsigned long flags;
1125         int temp_open_count;
1126         struct kobject *kobjp;
1127         int irq = NO_IRQ;
1128
1129         spin_lock_irqsave(&hvcsd->lock, flags);
1130         /* Preserve this so that we know how many kobject refs to put */
1131         temp_open_count = hvcsd->open_count;
1132
1133         /*
1134          * Don't kobject put inside the spinlock because the destruction
1135          * callback may use the spinlock and it may get called before the
1136          * spinlock has been released.  Get a pointer to the kobject and
1137          * kobject_put on that after releasing the spinlock.
1138          */
1139         kobjp = &hvcsd->kobj;
1140
1141         vio_disable_interrupts(hvcsd->vdev);
1142
1143         hvcsd->todo_mask = 0;
1144
1145         /* I don't think the tty needs the hvcs_struct pointer after a hangup */
1146         hvcsd->tty->driver_data = NULL;
1147         hvcsd->tty = NULL;
1148
1149         hvcsd->open_count = 0;
1150
1151         /* This will drop any buffered data on the floor which is OK in a hangup
1152          * scenario. */
1153         memset(&hvcsd->buffer[0], 0x00, HVCS_BUFF_LEN);
1154         hvcsd->chars_in_buffer = 0;
1155
1156         irq = hvcsd->vdev->irq;
1157
1158         spin_unlock_irqrestore(&hvcsd->lock, flags);
1159
1160         free_irq(irq, hvcsd);
1161
1162         /*
1163          * We need to kobject_put() for every open_count we have since the
1164          * tty_hangup() function doesn't invoke a close per open connection on a
1165          * non-console device.
1166          */
1167         while(temp_open_count) {
1168                 --temp_open_count;
1169                 /*
1170                  * The final put will trigger destruction of the hvcs_struct.
1171                  * NOTE:  If this hangup was signaled from user space then the
1172                  * final put will never happen.
1173                  */
1174                 kobject_put(kobjp);
1175         }
1176 }
1177
1178 /*
1179  * NOTE: This is almost always from_user since user level apps interact with the
1180  * /dev nodes. I'm trusting that if hvcs_write gets called and interrupted by
1181  * hvcs_remove (which removes the target device and executes tty_hangup()) that
1182  * tty_hangup will allow hvcs_write time to complete execution before it
1183  * terminates our device.
1184  */
1185 static int hvcs_write(struct tty_struct *tty,
1186                 const unsigned char *buf, int count)
1187 {
1188         struct hvcs_struct *hvcsd = tty->driver_data;
1189         unsigned int unit_address;
1190         const unsigned char *charbuf;
1191         unsigned long flags;
1192         int total_sent = 0;
1193         int tosend = 0;
1194         int result = 0;
1195
1196         /*
1197          * If they don't check the return code off of their open they may
1198          * attempt this even if there is no connected device.
1199          */
1200         if (!hvcsd)
1201                 return -ENODEV;
1202
1203         /* Reasonable size to prevent user level flooding */
1204         if (count > HVCS_MAX_FROM_USER) {
1205                 printk(KERN_WARNING "HVCS write: count being truncated to"
1206                                 " HVCS_MAX_FROM_USER.\n");
1207                 count = HVCS_MAX_FROM_USER;
1208         }
1209
1210         charbuf = buf;
1211
1212         spin_lock_irqsave(&hvcsd->lock, flags);
1213
1214         /*
1215          * Somehow an open succedded but the device was removed or the
1216          * connection terminated between the vty-server and partner vty during
1217          * the middle of a write operation?  This is a crummy place to do this
1218          * but we want to keep it all in the spinlock.
1219          */
1220         if (hvcsd->open_count <= 0) {
1221                 spin_unlock_irqrestore(&hvcsd->lock, flags);
1222                 return -ENODEV;
1223         }
1224
1225         unit_address = hvcsd->vdev->unit_address;
1226
1227         while (count > 0) {
1228                 tosend = min(count, (HVCS_BUFF_LEN - hvcsd->chars_in_buffer));
1229                 /*
1230                  * No more space, this probably means that the last call to
1231                  * hvcs_write() didn't succeed and the buffer was filled up.
1232                  */
1233                 if (!tosend)
1234                         break;
1235
1236                 memcpy(&hvcsd->buffer[hvcsd->chars_in_buffer],
1237                                 &charbuf[total_sent],
1238                                 tosend);
1239
1240                 hvcsd->chars_in_buffer += tosend;
1241
1242                 result = 0;
1243
1244                 /*
1245                  * If this is true then we don't want to try writing to the
1246                  * hypervisor because that is the kernel_threads job now.  We'll
1247                  * just add to the buffer.
1248                  */
1249                 if (!(hvcsd->todo_mask & HVCS_TRY_WRITE))
1250                         /* won't send partial writes */
1251                         result = hvc_put_chars(unit_address,
1252                                         &hvcsd->buffer[0],
1253                                         hvcsd->chars_in_buffer);
1254
1255                 /*
1256                  * Since we know we have enough room in hvcsd->buffer for
1257                  * tosend we record that it was sent regardless of whether the
1258                  * hypervisor actually took it because we have it buffered.
1259                  */
1260                 total_sent+=tosend;
1261                 count-=tosend;
1262                 if (result == 0) {
1263                         hvcsd->todo_mask |= HVCS_TRY_WRITE;
1264                         hvcs_kick();
1265                         break;
1266                 }
1267
1268                 hvcsd->chars_in_buffer = 0;
1269                 /*
1270                  * Test after the chars_in_buffer reset otherwise this could
1271                  * deadlock our writes if hvc_put_chars fails.
1272                  */
1273                 if (result < 0)
1274                         break;
1275         }
1276
1277         spin_unlock_irqrestore(&hvcsd->lock, flags);
1278
1279         if (result == -1)
1280                 return -EIO;
1281         else
1282                 return total_sent;
1283 }
1284
1285 /*
1286  * This is really asking how much can we guarentee that we can send or that we
1287  * absolutely WILL BUFFER if we can't send it.  This driver MUST honor the
1288  * return value, hence the reason for hvcs_struct buffering.
1289  */
1290 static int hvcs_write_room(struct tty_struct *tty)
1291 {
1292         struct hvcs_struct *hvcsd = tty->driver_data;
1293
1294         if (!hvcsd || hvcsd->open_count <= 0)
1295                 return 0;
1296
1297         return HVCS_BUFF_LEN - hvcsd->chars_in_buffer;
1298 }
1299
1300 static int hvcs_chars_in_buffer(struct tty_struct *tty)
1301 {
1302         struct hvcs_struct *hvcsd = tty->driver_data;
1303
1304         return hvcsd->chars_in_buffer;
1305 }
1306
1307 static const struct tty_operations hvcs_ops = {
1308         .open = hvcs_open,
1309         .close = hvcs_close,
1310         .hangup = hvcs_hangup,
1311         .write = hvcs_write,
1312         .write_room = hvcs_write_room,
1313         .chars_in_buffer = hvcs_chars_in_buffer,
1314         .unthrottle = hvcs_unthrottle,
1315         .throttle = hvcs_throttle,
1316 };
1317
1318 static int hvcs_alloc_index_list(int n)
1319 {
1320         int i;
1321
1322         hvcs_index_list = kmalloc(n * sizeof(hvcs_index_count),GFP_KERNEL);
1323         if (!hvcs_index_list)
1324                 return -ENOMEM;
1325         hvcs_index_count = n;
1326         for (i = 0; i < hvcs_index_count; i++)
1327                 hvcs_index_list[i] = -1;
1328         return 0;
1329 }
1330
1331 static void hvcs_free_index_list(void)
1332 {
1333         /* Paranoia check to be thorough. */
1334         kfree(hvcs_index_list);
1335         hvcs_index_list = NULL;
1336         hvcs_index_count = 0;
1337 }
1338
1339 static int __init hvcs_module_init(void)
1340 {
1341         int rc;
1342         int num_ttys_to_alloc;
1343
1344         printk(KERN_INFO "Initializing %s\n", hvcs_driver_string);
1345
1346         /* Has the user specified an overload with an insmod param? */
1347         if (hvcs_parm_num_devs <= 0 ||
1348                 (hvcs_parm_num_devs > HVCS_MAX_SERVER_ADAPTERS)) {
1349                 num_ttys_to_alloc = HVCS_DEFAULT_SERVER_ADAPTERS;
1350         } else
1351                 num_ttys_to_alloc = hvcs_parm_num_devs;
1352
1353         hvcs_tty_driver = alloc_tty_driver(num_ttys_to_alloc);
1354         if (!hvcs_tty_driver)
1355                 return -ENOMEM;
1356
1357         if (hvcs_alloc_index_list(num_ttys_to_alloc))
1358                 return -ENOMEM;
1359
1360         hvcs_tty_driver->owner = THIS_MODULE;
1361
1362         hvcs_tty_driver->driver_name = hvcs_driver_name;
1363         hvcs_tty_driver->name = hvcs_device_node;
1364
1365         /*
1366          * We'll let the system assign us a major number, indicated by leaving
1367          * it blank.
1368          */
1369
1370         hvcs_tty_driver->minor_start = HVCS_MINOR_START;
1371         hvcs_tty_driver->type = TTY_DRIVER_TYPE_SYSTEM;
1372
1373         /*
1374          * We role our own so that we DONT ECHO.  We can't echo because the
1375          * device we are connecting to already echoes by default and this would
1376          * throw us into a horrible recursive echo-echo-echo loop.
1377          */
1378         hvcs_tty_driver->init_termios = hvcs_tty_termios;
1379         hvcs_tty_driver->flags = TTY_DRIVER_REAL_RAW;
1380
1381         tty_set_operations(hvcs_tty_driver, &hvcs_ops);
1382
1383         /*
1384          * The following call will result in sysfs entries that denote the
1385          * dynamically assigned major and minor numbers for our devices.
1386          */
1387         if (tty_register_driver(hvcs_tty_driver)) {
1388                 printk(KERN_ERR "HVCS: registration "
1389                         " as a tty driver failed.\n");
1390                 hvcs_free_index_list();
1391                 put_tty_driver(hvcs_tty_driver);
1392                 return -EIO;
1393         }
1394
1395         hvcs_pi_buff = kmalloc(PAGE_SIZE, GFP_KERNEL);
1396         if (!hvcs_pi_buff) {
1397                 tty_unregister_driver(hvcs_tty_driver);
1398                 hvcs_free_index_list();
1399                 put_tty_driver(hvcs_tty_driver);
1400                 return -ENOMEM;
1401         }
1402
1403         hvcs_task = kthread_run(khvcsd, NULL, "khvcsd");
1404         if (IS_ERR(hvcs_task)) {
1405                 printk(KERN_ERR "HVCS: khvcsd creation failed.  Driver not loaded.\n");
1406                 kfree(hvcs_pi_buff);
1407                 tty_unregister_driver(hvcs_tty_driver);
1408                 hvcs_free_index_list();
1409                 put_tty_driver(hvcs_tty_driver);
1410                 return -EIO;
1411         }
1412
1413         rc = vio_register_driver(&hvcs_vio_driver);
1414
1415         /*
1416          * This needs to be done AFTER the vio_register_driver() call or else
1417          * the kobjects won't be initialized properly.
1418          */
1419         hvcs_create_driver_attrs();
1420
1421         printk(KERN_INFO "HVCS: driver module inserted.\n");
1422
1423         return rc;
1424 }
1425
1426 static void __exit hvcs_module_exit(void)
1427 {
1428         /*
1429          * This driver receives hvcs_remove callbacks for each device upon
1430          * module removal.
1431          */
1432
1433         /*
1434          * This synchronous operation  will wake the khvcsd kthread if it is
1435          * asleep and will return when khvcsd has terminated.
1436          */
1437         kthread_stop(hvcs_task);
1438
1439         spin_lock(&hvcs_pi_lock);
1440         kfree(hvcs_pi_buff);
1441         hvcs_pi_buff = NULL;
1442         spin_unlock(&hvcs_pi_lock);
1443
1444         hvcs_remove_driver_attrs();
1445
1446         vio_unregister_driver(&hvcs_vio_driver);
1447
1448         tty_unregister_driver(hvcs_tty_driver);
1449
1450         hvcs_free_index_list();
1451
1452         put_tty_driver(hvcs_tty_driver);
1453
1454         printk(KERN_INFO "HVCS: driver module removed.\n");
1455 }
1456
1457 module_init(hvcs_module_init);
1458 module_exit(hvcs_module_exit);
1459
1460 static inline struct hvcs_struct *from_vio_dev(struct vio_dev *viod)
1461 {
1462         return viod->dev.driver_data;
1463 }
1464 /* The sysfs interface for the driver and devices */
1465
1466 static ssize_t hvcs_partner_vtys_show(struct device *dev, struct device_attribute *attr, char *buf)
1467 {
1468         struct vio_dev *viod = to_vio_dev(dev);
1469         struct hvcs_struct *hvcsd = from_vio_dev(viod);
1470         unsigned long flags;
1471         int retval;
1472
1473         spin_lock_irqsave(&hvcsd->lock, flags);
1474         retval = sprintf(buf, "%X\n", hvcsd->p_unit_address);
1475         spin_unlock_irqrestore(&hvcsd->lock, flags);
1476         return retval;
1477 }
1478 static DEVICE_ATTR(partner_vtys, S_IRUGO, hvcs_partner_vtys_show, NULL);
1479
1480 static ssize_t hvcs_partner_clcs_show(struct device *dev, struct device_attribute *attr, char *buf)
1481 {
1482         struct vio_dev *viod = to_vio_dev(dev);
1483         struct hvcs_struct *hvcsd = from_vio_dev(viod);
1484         unsigned long flags;
1485         int retval;
1486
1487         spin_lock_irqsave(&hvcsd->lock, flags);
1488         retval = sprintf(buf, "%s\n", &hvcsd->p_location_code[0]);
1489         spin_unlock_irqrestore(&hvcsd->lock, flags);
1490         return retval;
1491 }
1492 static DEVICE_ATTR(partner_clcs, S_IRUGO, hvcs_partner_clcs_show, NULL);
1493
1494 static ssize_t hvcs_current_vty_store(struct device *dev, struct device_attribute *attr, const char * buf,
1495                 size_t count)
1496 {
1497         /*
1498          * Don't need this feature at the present time because firmware doesn't
1499          * yet support multiple partners.
1500          */
1501         printk(KERN_INFO "HVCS: Denied current_vty change: -EPERM.\n");
1502         return -EPERM;
1503 }
1504
1505 static ssize_t hvcs_current_vty_show(struct device *dev, struct device_attribute *attr, char *buf)
1506 {
1507         struct vio_dev *viod = to_vio_dev(dev);
1508         struct hvcs_struct *hvcsd = from_vio_dev(viod);
1509         unsigned long flags;
1510         int retval;
1511
1512         spin_lock_irqsave(&hvcsd->lock, flags);
1513         retval = sprintf(buf, "%s\n", &hvcsd->p_location_code[0]);
1514         spin_unlock_irqrestore(&hvcsd->lock, flags);
1515         return retval;
1516 }
1517
1518 static DEVICE_ATTR(current_vty,
1519         S_IRUGO | S_IWUSR, hvcs_current_vty_show, hvcs_current_vty_store);
1520
1521 static ssize_t hvcs_vterm_state_store(struct device *dev, struct device_attribute *attr, const char *buf,
1522                 size_t count)
1523 {
1524         struct vio_dev *viod = to_vio_dev(dev);
1525         struct hvcs_struct *hvcsd = from_vio_dev(viod);
1526         unsigned long flags;
1527
1528         /* writing a '0' to this sysfs entry will result in the disconnect. */
1529         if (simple_strtol(buf, NULL, 0) != 0)
1530                 return -EINVAL;
1531
1532         spin_lock_irqsave(&hvcsd->lock, flags);
1533
1534         if (hvcsd->open_count > 0) {
1535                 spin_unlock_irqrestore(&hvcsd->lock, flags);
1536                 printk(KERN_INFO "HVCS: vterm state unchanged.  "
1537                                 "The hvcs device node is still in use.\n");
1538                 return -EPERM;
1539         }
1540
1541         if (hvcsd->connected == 0) {
1542                 spin_unlock_irqrestore(&hvcsd->lock, flags);
1543                 printk(KERN_INFO "HVCS: vterm state unchanged. The"
1544                                 " vty-server is not connected to a vty.\n");
1545                 return -EPERM;
1546         }
1547
1548         hvcs_partner_free(hvcsd);
1549         printk(KERN_INFO "HVCS: Closed vty-server@%X and"
1550                         " partner vty@%X:%d connection.\n",
1551                         hvcsd->vdev->unit_address,
1552                         hvcsd->p_unit_address,
1553                         (uint32_t)hvcsd->p_partition_ID);
1554
1555         spin_unlock_irqrestore(&hvcsd->lock, flags);
1556         return count;
1557 }
1558
1559 static ssize_t hvcs_vterm_state_show(struct device *dev, struct device_attribute *attr, char *buf)
1560 {
1561         struct vio_dev *viod = to_vio_dev(dev);
1562         struct hvcs_struct *hvcsd = from_vio_dev(viod);
1563         unsigned long flags;
1564         int retval;
1565
1566         spin_lock_irqsave(&hvcsd->lock, flags);
1567         retval = sprintf(buf, "%d\n", hvcsd->connected);
1568         spin_unlock_irqrestore(&hvcsd->lock, flags);
1569         return retval;
1570 }
1571 static DEVICE_ATTR(vterm_state, S_IRUGO | S_IWUSR,
1572                 hvcs_vterm_state_show, hvcs_vterm_state_store);
1573
1574 static ssize_t hvcs_index_show(struct device *dev, struct device_attribute *attr, char *buf)
1575 {
1576         struct vio_dev *viod = to_vio_dev(dev);
1577         struct hvcs_struct *hvcsd = from_vio_dev(viod);
1578         unsigned long flags;
1579         int retval;
1580
1581         spin_lock_irqsave(&hvcsd->lock, flags);
1582         retval = sprintf(buf, "%d\n", hvcsd->index);
1583         spin_unlock_irqrestore(&hvcsd->lock, flags);
1584         return retval;
1585 }
1586
1587 static DEVICE_ATTR(index, S_IRUGO, hvcs_index_show, NULL);
1588
1589 static struct attribute *hvcs_attrs[] = {
1590         &dev_attr_partner_vtys.attr,
1591         &dev_attr_partner_clcs.attr,
1592         &dev_attr_current_vty.attr,
1593         &dev_attr_vterm_state.attr,
1594         &dev_attr_index.attr,
1595         NULL,
1596 };
1597
1598 static struct attribute_group hvcs_attr_group = {
1599         .attrs = hvcs_attrs,
1600 };
1601
1602 static void hvcs_create_device_attrs(struct hvcs_struct *hvcsd)
1603 {
1604         struct vio_dev *vdev = hvcsd->vdev;
1605         sysfs_create_group(&vdev->dev.kobj, &hvcs_attr_group);
1606 }
1607
1608 static void hvcs_remove_device_attrs(struct vio_dev *vdev)
1609 {
1610         sysfs_remove_group(&vdev->dev.kobj, &hvcs_attr_group);
1611 }
1612
1613 static ssize_t hvcs_rescan_show(struct device_driver *ddp, char *buf)
1614 {
1615         /* A 1 means it is updating, a 0 means it is done updating */
1616         return snprintf(buf, PAGE_SIZE, "%d\n", hvcs_rescan_status);
1617 }
1618
1619 static ssize_t hvcs_rescan_store(struct device_driver *ddp, const char * buf,
1620                 size_t count)
1621 {
1622         if ((simple_strtol(buf, NULL, 0) != 1)
1623                 && (hvcs_rescan_status != 0))
1624                 return -EINVAL;
1625
1626         hvcs_rescan_status = 1;
1627         printk(KERN_INFO "HVCS: rescanning partner info for all"
1628                 " vty-servers.\n");
1629         hvcs_rescan_devices_list();
1630         hvcs_rescan_status = 0;
1631         return count;
1632 }
1633 static DRIVER_ATTR(rescan,
1634         S_IRUGO | S_IWUSR, hvcs_rescan_show, hvcs_rescan_store);
1635
1636 static void hvcs_create_driver_attrs(void)
1637 {
1638         struct device_driver *driverfs = &(hvcs_vio_driver.driver);
1639         driver_create_file(driverfs, &driver_attr_rescan);
1640 }
1641
1642 static void hvcs_remove_driver_attrs(void)
1643 {
1644         struct device_driver *driverfs = &(hvcs_vio_driver.driver);
1645         driver_remove_file(driverfs, &driver_attr_rescan);
1646 }