#undef  BLOCKMOVE
#define Z_WAKE
#undef  Z_EXT_CHARS_IN_BUFFER

/*
 *  linux/drivers/char/cyclades.c
 *
 * This file contains the driver for the Cyclades async multiport
 * serial boards.
 *
 * Initially written by Randolph Bentson <bentson@grieg.seaslug.org>.
 * Modified and maintained by Marcio Saito <marcio@cyclades.com>.
 *
 * Copyright (C) 2007 Jiri Slaby <jirislaby@gmail.com>
 *
 * Much of the design and some of the code came from serial.c
 * which was copyright (C) 1991, 1992  Linus Torvalds.  It was
 * extensively rewritten by Theodore Ts'o, 8/16/92 -- 9/14/92,
 * and then fixed as suggested by Michael K. Johnson 12/12/92.
 * Converted to pci probing and cleaned up by Jiri Slaby.
 *
 * This version supports shared IRQ's (only for PCI boards).
 *
 * Prevent users from opening non-existing Z ports.
 *
 * Revision 2.3.2.8   2000/07/06 18:14:16 ivan
 * Fixed the PCI detection function to work properly on Alpha systems.
 * Implemented support for TIOCSERGETLSR ioctl.
 * Implemented full support for non-standard baud rates.
 *
 * Revision 2.3.2.7   2000/06/01 18:26:34 ivan
 * Request PLX I/O region, although driver doesn't use it, to avoid
 * problems with other drivers accessing it.
 * Removed count for on-board buffer characters in cy_chars_in_buffer
 * (Cyclades-Z only).
 *
 * Revision 2.3.2.6   2000/05/05 13:56:05 ivan
 * Driver now reports physical instead of virtual memory addresses.
 * Masks were added to some Cyclades-Z read accesses.
 * Implemented workaround for PLX9050 bug that would cause a system lockup
 * in certain systems, depending on the MMIO addresses allocated to the
 * board.
 * Changed the Tx interrupt programming in the CD1400 chips to boost up
 * performance (Cyclom-Y only).
 * Code is now compliant with the new module interface (module_[init|exit]).
 * Make use of the PCI helper functions to access PCI resources.
 * Did some code "housekeeping".
 *
 * Revision 2.3.2.5   2000/01/19 14:35:33 ivan
 * Fixed bug in cy_set_termios on CRTSCTS flag turnoff.
 *
 * Revision 2.3.2.4   2000/01/17 09:19:40 ivan
 * Fixed SMP locking in Cyclom-Y interrupt handler.
 *
 * Revision 2.3.2.3   1999/12/28 12:11:39 ivan
 * Added a new cyclades_card field called nports to allow the driver to
 * know the exact number of ports found by the Z firmware after its load;
 * RX buffer contention prevention logic on interrupt op mode revisited
 * (Cyclades-Z only);
 * Revisited printk's for Z debug;
 * Driver now makes sure that the constant SERIAL_XMIT_SIZE is defined;
 *
 * Revision 2.3.2.2   1999/10/01 11:27:43 ivan
 * Fixed bug in cyz_poll that would make all ports but port 0
 * unable to transmit/receive data (Cyclades-Z only);
 * Implemented logic to prevent the RX buffer from being stuck with data
 * due to a driver / firmware race condition in interrupt op mode
 * (Cyclades-Z only);
 * Fixed bug in block_til_ready logic that would lead to a system crash;
 * Revisited cy_close spinlock usage;
 *
 * Revision 2.3.2.1   1999/09/28 11:01:22 ivan
 * Revisited CONFIG_PCI conditional compilation for PCI board support;
 * Implemented TIOCGICOUNT and TIOCMIWAIT ioctl support;
 * _Major_ cleanup on the Cyclades-Z interrupt support code / logic;
 * Removed CTS handling from the driver -- this is now completely handled
 * by the firmware (Cyclades-Z only);
 * Flush RX on-board buffers on a port open (Cyclades-Z only);
 * Fixed handling of ASYNC_SPD_* TTY flags;
 * Module unload now unmaps all memory area allocated by ioremap;
 *
 * Revision 2.3.1.1   1999/07/15 16:45:53 ivan
 * Removed CY_PROC conditional compilation;
 * Implemented SMP-awareness for the driver;
 * Implemented a new ISA IRQ autoprobe that uses the irq_probe_[on|off]
 * functions;
 * The driver now accepts memory addresses (maddr=0xMMMMM) and IRQs
 * (irq=NN) as parameters (only for ISA boards);
 * Fixed bug in set_line_char that would prevent the Cyclades-Z
 * ports from being configured at speeds above 115.2Kbps;
 * Fixed bug in cy_set_termios that would prevent XON/XOFF flow control
 * switching from working properly;
 * The driver now only prints IRQ info for the Cyclades-Z if it's
 * configured to work in interrupt mode;
 *
 * Revision 2.2.2.3   1999/06/28 11:13:29 ivan
 * Added support for interrupt mode operation for the Z cards;
 * Removed the driver inactivity control for the Z;
 * Added a missing MOD_DEC_USE_COUNT in the cy_open function for when
 * the Z firmware is not loaded yet;
 * Replaced the "manual" Z Tx flush buffer by a call to a FW command of
 * same functionality;
 * Implemented workaround for IRQ setting loss on the PCI configuration
 * registers after a PCI bridge EEPROM reload (affects PLX9060 only);
 *
 * Revision 2.2.2.2  1999/05/14 17:18:15 ivan
 * /proc entry location changed to /proc/tty/driver/cyclades;
 * Added support to shared IRQ's (only for PCI boards);
 * Added support for Cobalt Qube2 systems;
 * IRQ [de]allocation scheme revisited;
 * BREAK implementation changed in order to make use of the 'break_ctl'
 * TTY facility;
 * Fixed typo in TTY structure field 'driver_name';
 * Included a PCI bridge reset and EEPROM reload in the board
 * initialization code (for both Y and Z series).
 *
 * Revision 2.2.2.1  1999/04/08 16:17:43 ivan
 * Fixed a bug in cy_wait_until_sent that was preventing the port to be
 * closed properly after a SIGINT;
 * Module usage counter scheme revisited;
 * Added support to the upcoming Y PCI boards (i.e., support to additional
 * PCI Device ID's).
 *
 * Revision 2.2.1.10 1999/01/20 16:14:29 ivan
 * Removed all unnecessary page-alignement operations in ioremap calls
 * (ioremap is currently safe for these operations).
 *
 * Revision 2.2.1.9  1998/12/30 18:18:30 ivan
 * Changed access to PLX PCI bridge registers from I/O to MMIO, in
 * order to make PLX9050-based boards work with certain motherboards.
 *
 * Revision 2.2.1.8  1998/11/13 12:46:20 ivan
 * cy_close function now resets (correctly) the tty->closing flag;
 * JIFFIES_DIFF macro fixed.
 *
 * Revision 2.2.1.7  1998/09/03 12:07:28 ivan
 * Fixed bug in cy_close function, which was not informing HW of
 * which port should have the reception disabled before doing so;
 * fixed Cyclom-8YoP hardware detection bug.
 *
 * Revision 2.2.1.6  1998/08/20 17:15:39 ivan
 * Fixed bug in cy_close function, which causes malfunction
 * of one of the first 4 ports when a higher port is closed
 * (Cyclom-Y only).
 *
 * Revision 2.2.1.5  1998/08/10 18:10:28 ivan
 * Fixed Cyclom-4Yo hardware detection bug.
 *
 * Revision 2.2.1.4  1998/08/04 11:02:50 ivan
 * /proc/cyclades implementation with great collaboration of
 * Marc Lewis <marc@blarg.net>;
 * cyy_interrupt was changed to avoid occurrence of kernel oopses
 * during PPP operation.
 *
 * Revision 2.2.1.3  1998/06/01 12:09:10 ivan
 * General code review in order to comply with 2.1 kernel standards;
 * data loss prevention for slow devices revisited (cy_wait_until_sent
 * was created);
 * removed conditional compilation for new/old PCI structure support
 * (now the driver only supports the new PCI structure).
 *
 * Revision 2.2.1.1  1998/03/19 16:43:12 ivan
 * added conditional compilation for new/old PCI structure support;
 * removed kernel series (2.0.x / 2.1.x) conditional compilation.
 *
 * Revision 2.1.1.3  1998/03/16 18:01:12 ivan
 * cleaned up the data loss fix;
 * fixed XON/XOFF handling once more (Cyclades-Z);
 * general review of the driver routines;
 * introduction of a mechanism to prevent data loss with slow
 * printers, by forcing a delay before closing the port.
 *
 * Revision 2.1.1.2  1998/02/17 16:50:00 ivan
 * fixed detection/handling of new CD1400 in Ye boards;
 * fixed XON/XOFF handling (Cyclades-Z);
 * fixed data loss caused by a premature port close;
 * introduction of a flag that holds the CD1400 version ID per port
 * (used by the CYGETCD1400VER new ioctl).
 *
 * Revision 2.1.1.1  1997/12/03 17:31:19 ivan
 * Code review for the module cleanup routine;
 * fixed RTS and DTR status report for new CD1400's in get_modem_info;
 * includes anonymous changes regarding signal_pending.
 *
 * Revision 2.1  1997/11/01 17:42:41 ivan
 * Changes in the driver to support Alpha systems (except 8Zo V_1);
 * BREAK fix for the Cyclades-Z boards;
 * driver inactivity control by FW implemented;
 * introduction of flag that allows driver to take advantage of
 * a special CD1400 feature related to HW flow control;
 * added support for the CD1400  rev. J (Cyclom-Y boards);
 * introduction of ioctls to:
 *  - control the rtsdtr_inv flag (Cyclom-Y);
 *  - control the rflow flag (Cyclom-Y);
 *  - adjust the polling interval (Cyclades-Z);
 *
 * Revision 1.36.4.33  1997/06/27 19:00:00  ivan
 * Fixes related to kernel version conditional
 * compilation.
 *
 * Revision 1.36.4.32  1997/06/14 19:30:00  ivan
 * Compatibility issues between kernels 2.0.x and
 * 2.1.x (mainly related to clear_bit function).
 *
 * Revision 1.36.4.31  1997/06/03 15:30:00  ivan
 * Changes to define the memory window according to the
 * board type.
 *
 * Revision 1.36.4.30  1997/05/16 15:30:00  daniel
 * Changes to support new cycladesZ boards.
 *
 * Revision 1.36.4.29  1997/05/12 11:30:00  daniel
 * Merge of Bentson's and Daniel's version 1.36.4.28.
 * Corrects bug in cy_detect_pci: check if there are more
 * ports than the number of static structs allocated.
 * Warning message during initialization if this driver is
 * used with the new generation of cycladesZ boards.  Those
 * will be supported only in next release of the driver.
 * Corrects bug in cy_detect_pci and cy_detect_isa that
 * returned wrong number of VALID boards, when a cyclomY
 * was found with no serial modules connected.
 * Changes to use current (2.1.x) kernel subroutine names
 * and created macros for compilation with 2.0.x kernel,
 * instead of the other way around.
 *
 * Revision 1.36.4.28  1997/05/?? ??:00:00  bentson
 * Change queue_task_irq_off to queue_task_irq.
 * The inline function queue_task_irq_off (tqueue.h)
 * was removed from latest releases of 2.1.x kernel.
 * Use of macro __init to mark the initialization
 * routines, so memory can be reused.
 * Also incorporate implementation of critical region
 * in function cleanup_module() created by anonymous
 * linuxer.
 *
 * Revision 1.36.4.28  1997/04/25 16:00:00  daniel
 * Change to support new firmware that solves DCD problem:
 * application could fail to receive SIGHUP signal when DCD
 * varying too fast.
 *
 * Revision 1.36.4.27  1997/03/26 10:30:00  daniel
 * Changed for support linux versions 2.1.X.
 * Backward compatible with linux versions 2.0.X.
 * Corrected illegal use of filler field in
 * CH_CTRL struct.
 * Deleted some debug messages.
 *
 * Revision 1.36.4.26  1997/02/27 12:00:00  daniel
 * Included check for NULL tty pointer in cyz_poll.
 *
 * Revision 1.36.4.25  1997/02/26 16:28:30  bentson
 * Bill Foster at Blarg! Online services noticed that
 * some of the switch elements of -Z modem control
 * lacked a closing "break;"
 *
 * Revision 1.36.4.24  1997/02/24 11:00:00  daniel
 * Changed low water threshold for buffer xmit_buf
 *
 * Revision 1.36.4.23  1996/12/02 21:50:16  bentson
 * Marcio provided fix to modem status fetch for -Z
 *
 * Revision 1.36.4.22  1996/10/28 22:41:17  bentson
 * improve mapping of -Z control page (thanks to Steve
 * Price <stevep@fa.tdktca.com> for help on this)
 *
 * Revision 1.36.4.21  1996/09/10 17:00:10  bentson
 * shift from CPU-bound to memcopy in cyz_polling operation
 *
 * Revision 1.36.4.20  1996/09/09 18:30:32  Bentson
 * Added support to set and report higher speeds.
 *
 * Revision 1.36.4.19c  1996/08/09 10:00:00  Marcio Saito
 * Some fixes in the HW flow control for the BETA release.
 * Don't try to register the IRQ.
 *
 * Revision 1.36.4.19  1996/08/08 16:23:18  Bentson
 * make sure "cyc" appears in all kernel messages; all soft interrupts
 * handled by same routine; recognize out-of-band reception; comment
 * out some diagnostic messages; leave RTS/CTS flow control to hardware;
 * fix race condition in -Z buffer management; only -Y needs to explicitly
 * flush chars; tidy up some startup messages;
 *
 * Revision 1.36.4.18  1996/07/25 18:57:31  bentson
 * shift MOD_INC_USE_COUNT location to match
 * serial.c; purge some diagnostic messages;
 *
 * Revision 1.36.4.17  1996/07/25 18:01:08  bentson
 * enable modem status messages and fetch & process them; note
 * time of last activity type for each port; set_line_char now
 * supports more than line 0 and treats 0 baud correctly;
 * get_modem_info senses rs_status;
 *
 * Revision 1.36.4.16  1996/07/20 08:43:15  bentson
 * barely works--now's time to turn on
 * more features 'til it breaks
 *
 * Revision 1.36.4.15  1996/07/19 22:30:06  bentson
 * check more -Z board status; shorten boot message
 *
 * Revision 1.36.4.14  1996/07/19 22:20:37  bentson
 * fix reference to ch_ctrl in startup; verify return
 * values from cyz_issue_cmd and cyz_update_channel;
 * more stuff to get modem control correct;
 *
 * Revision 1.36.4.13  1996/07/11 19:53:33  bentson
 * more -Z stuff folded in; re-order changes to put -Z stuff
 * after -Y stuff (to make changes clearer)
 *
 * Revision 1.36.4.12  1996/07/11 15:40:55  bentson
 * Add code to poll Cyclades-Z.  Add code to get & set RS-232 control.
 * Add code to send break.  Clear firmware ID word at startup (so
 * that other code won't talk to inactive board).
 *
 * Revision 1.36.4.11  1996/07/09 05:28:29  bentson
 * add code for -Z in set_line_char
 *
 * Revision 1.36.4.10  1996/07/08 19:28:37  bentson
 * fold more -Z stuff (or in some cases, error messages)
 * into driver; add text to "don't know what to do" messages.
 *
 * Revision 1.36.4.9  1996/07/08 18:38:38  bentson
 * moved compile-time flags near top of file; cosmetic changes
 * to narrow text (to allow 2-up printing); changed many declarations
 * to "static" to limit external symbols; shuffled code order to
 * coalesce -Y and -Z specific code, also to put internal functions
 * in order of tty_driver structure; added code to recognize -Z
 * ports (and for moment, do nothing or report error); add cy_startup
 * to parse boot command line for extra base addresses for ISA probes;
 *
 * Revision 1.36.4.8  1996/06/25 17:40:19  bentson
 * reorder some code, fix types of some vars (int vs. long),
 * add cy_setup to support user declared ISA addresses
 *
 * Revision 1.36.4.7  1996/06/21 23:06:18  bentson
 * dump ioctl based firmware load (it's now a user level
 * program); ensure uninitialzed ports cannot be used
 *
 * Revision 1.36.4.6  1996/06/20 23:17:19  bentson
 * rename vars and restructure some code
 *
 * Revision 1.36.4.5  1996/06/14 15:09:44  bentson
 * get right status back after boot load
 *
 * Revision 1.36.4.4  1996/06/13 19:51:44  bentson
 * successfully loads firmware
 *
 * Revision 1.36.4.3  1996/06/13 06:08:33  bentson
 * add more of the code for the boot/load ioctls
 *
 * Revision 1.36.4.2  1996/06/11 21:00:51  bentson
 * start to add Z functionality--starting with ioctl
 * for loading firmware
 *
 * Revision 1.36.4.1  1996/06/10 18:03:02  bentson
 * added code to recognize Z/PCI card at initialization; report
 * presence, but card is not initialized (because firmware needs
 * to be loaded)
 *
 * Revision 1.36.3.8  1996/06/07 16:29:00  bentson
 * starting minor number at zero; added missing verify_area
 * as noted by Heiko Eißfeldt <heiko@colossus.escape.de>
 *
 * Revision 1.36.3.7  1996/04/19 21:06:18  bentson
 * remove unneeded boot message & fix CLOCAL hardware flow
 * control (Miquel van Smoorenburg <miquels@Q.cistron.nl>);
 * remove unused diagnostic statements; minor 0 is first;
 *
 * Revision 1.36.3.6  1996/03/13 13:21:17  marcio
 * The kernel function vremap (available only in later 1.3.xx kernels)
 * allows the access to memory addresses above the RAM. This revision
 * of the driver supports PCI boards below 1Mb (device id 0x100) and
 * above 1Mb (device id 0x101).
 *
 * Revision 1.36.3.5  1996/03/07 15:20:17  bentson
 * Some global changes to interrupt handling spilled into
 * this driver--mostly unused arguments in system function
 * calls.  Also added change by Marcio Saito which should
 * reduce lost interrupts at startup by fast processors.
 *
 * Revision 1.36.3.4  1995/11/13  20:45:10  bentson
 * Changes by Corey Minyard <minyard@wf-rch.cirr.com> distributed
 * in 1.3.41 kernel to remove a possible race condition, extend
 * some error messages, and let the driver run as a loadable module
 * Change by Alan Wendt <alan@ez0.ezlink.com> to remove a
 * possible race condition.
 * Change by Marcio Saito <marcio@cyclades.com> to fix PCI addressing.
 *
 * Revision 1.36.3.3  1995/11/13  19:44:48  bentson
 * Changes by Linus Torvalds in 1.3.33 kernel distribution
 * required due to reordering of driver initialization.
 * Drivers are now initialized *after* memory management.
 *
 * Revision 1.36.3.2  1995/09/08  22:07:14  bentson
 * remove printk from ISR; fix typo
 *
 * Revision 1.36.3.1  1995/09/01  12:00:42  marcio
 * Minor fixes in the PCI board support. PCI function calls in
 * conditional compilation (CONFIG_PCI). Thanks to Jim Duncan
 * <duncan@okay.com>. "bad serial count" message removed.
 *
 * Revision 1.36.3  1995/08/22  09:19:42  marcio
 * Cyclom-Y/PCI support added. Changes in the cy_init routine and
 * board initialization. Changes in the boot messages. The driver
 * supports up to 4 boards and 64 ports by default.
 *
 * Revision 1.36.1.4  1995/03/29  06:14:14  bentson
 * disambiguate between Cyclom-16Y and Cyclom-32Ye;
 *
 * Revision 1.36.1.3  1995/03/23  22:15:35  bentson
 * add missing break in modem control block in ioctl switch statement
 * (discovered by Michael Edward Chastain <mec@jobe.shell.portal.com>);
 *
 * Revision 1.36.1.2  1995/03/22  19:16:22  bentson
 * make sure CTS flow control is set as soon as possible (thanks
 * to note from David Lambert <lambert@chesapeake.rps.slb.com>);
 *
 * Revision 1.36.1.1  1995/03/13  15:44:43  bentson
 * initialize defaults for receive threshold and stale data timeout;
 * cosmetic changes;
 *
 * Revision 1.36  1995/03/10  23:33:53  bentson
 * added support of chips 4-7 in 32 port Cyclom-Ye;
 * fix cy_interrupt pointer dereference problem
 * (Joe Portman <baron@aa.net>);
 * give better error response if open is attempted on non-existent port
 * (Zachariah Vaum <jchryslr@netcom.com>);
 * correct command timeout (Kenneth Lerman <lerman@@seltd.newnet.com>);
 * conditional compilation for -16Y on systems with fast, noisy bus;
 * comment out diagnostic print function;
 * cleaned up table of base addresses;
 * set receiver time-out period register to correct value,
 * set receive threshold to better default values,
 * set chip timer to more accurate 200 Hz ticking,
 * add code to monitor and modify receive parameters
 * (Rik Faith <faith@cs.unc.edu> Nick Simicich
 * <njs@scifi.emi.net>);
 *
 * Revision 1.35  1994/12/16  13:54:18  steffen
 * additional patch by Marcio Saito for board detection
 * Accidently left out in 1.34
 *
 * Revision 1.34  1994/12/10  12:37:12  steffen
 * This is the corrected version as suggested by Marcio Saito
 *
 * Revision 1.33  1994/12/01  22:41:18  bentson
 * add hooks to support more high speeds directly; add tytso
 * patch regarding CLOCAL wakeups
 *
 * Revision 1.32  1994/11/23  19:50:04  bentson
 * allow direct kernel control of higher signalling rates;
 * look for cards at additional locations
 *
 * Revision 1.31  1994/11/16  04:33:28  bentson
 * ANOTHER fix from Corey Minyard, minyard@wf-rch.cirr.com--
 * a problem in chars_in_buffer has been resolved by some
 * small changes;  this should yield smoother output
 *
 * Revision 1.30  1994/11/16  04:28:05  bentson
 * Fix from Corey Minyard, Internet: minyard@metronet.com,
 * UUCP: minyard@wf-rch.cirr.com, WORK: minyardbnr.ca, to
 * cy_hangup that appears to clear up much (all?) of the
 * DTR glitches; also he's added/cleaned-up diagnostic messages
 *
 * Revision 1.29  1994/11/16  04:16:07  bentson
 * add change proposed by Ralph Sims, ralphs@halcyon.com, to
 * operate higher speeds in same way as other serial ports;
 * add more serial ports (for up to two 16-port muxes).
 *
 * Revision 1.28  1994/11/04  00:13:16  root
 * turn off diagnostic messages
 *
 * Revision 1.27  1994/11/03  23:46:37  root
 * bunch of changes to bring driver into greater conformance
 * with the serial.c driver (looking for missed fixes)
 *
 * Revision 1.26  1994/11/03  22:40:36  root
 * automatic interrupt probing fixed.
 *
 * Revision 1.25  1994/11/03  20:17:02  root
 * start to implement auto-irq
 *
 * Revision 1.24  1994/11/03  18:01:55  root
 * still working on modem signals--trying not to drop DTR
 * during the getty/login processes
 *
 * Revision 1.23  1994/11/03  17:51:36  root
 * extend baud rate support; set receive threshold as function
 * of baud rate; fix some problems with RTS/CTS;
 *
 * Revision 1.22  1994/11/02  18:05:35  root
 * changed arguments to udelay to type long to get
 * delays to be of correct duration
 *
 * Revision 1.21  1994/11/02  17:37:30  root
 * employ udelay (after calibrating loops_per_second earlier
 * in init/main.c) instead of using home-grown delay routines
 *
 * Revision 1.20  1994/11/02  03:11:38  root
 * cy_chars_in_buffer forces a return value of 0 to let
 * login work (don't know why it does); some functions
 * that were returning EFAULT, now executes the code;
 * more work on deciding when to disable xmit interrupts;
 *
 * Revision 1.19  1994/11/01  20:10:14  root
 * define routine to start transmission interrupts (by enabling
 * transmit interrupts); directly enable/disable modem interrupts;
 *
 * Revision 1.18  1994/11/01  18:40:45  bentson
 * Don't always enable transmit interrupts in startup; interrupt on
 * TxMpty instead of TxRdy to help characters get out before shutdown;
 * restructure xmit interrupt to check for chars first and quit if
 * none are ready to go; modem status (MXVRx) is upright, _not_ inverted
 * (to my view);
 *
 * Revision 1.17  1994/10/30  04:39:45  bentson
 * rename serial_driver and callout_driver to cy_serial_driver and
 * cy_callout_driver to avoid linkage interference; initialize
 * info->type to PORT_CIRRUS; ruggedize paranoia test; elide ->port
 * from cyclades_port structure; add paranoia check to cy_close;
 *
 * Revision 1.16  1994/10/30  01:14:33  bentson
 * change major numbers; add some _early_ return statements;
 *
 * Revision 1.15  1994/10/29  06:43:15  bentson
 * final tidying up for clean compile;  enable some error reporting
 *
 * Revision 1.14  1994/10/28  20:30:22  Bentson
 * lots of changes to drag the driver towards the new tty_io
 * structures and operation.  not expected to work, but may
 * compile cleanly.
 *
 * Revision 1.13  1994/07/21  23:08:57  Bentson
 * add some diagnostic cruft; support 24 lines (for testing
 * both -8Y and -16Y cards; be more thorough in servicing all
 * chips during interrupt; add "volatile" a few places to
 * circumvent compiler optimizations; fix base & offset
 * computations in block_til_ready (was causing chip 0 to
 * stop operation)
 *
 * Revision 1.12  1994/07/19  16:42:11  Bentson
 * add some hackery for kernel version 1.1.8; expand
 * error messages; refine timing for delay loops and
 * declare loop params volatile
 *
 * Revision 1.11  1994/06/11  21:53:10  bentson
 * get use of save_car right in transmit interrupt service
 *
 * Revision 1.10.1.1  1994/06/11  21:31:18  bentson
 * add some diagnostic printing; try to fix save_car stuff
 *
 * Revision 1.10  1994/06/11  20:36:08  bentson
 * clean up compiler warnings
 *
 * Revision 1.9  1994/06/11  19:42:46  bentson
 * added a bunch of code to support modem signalling
 *
 * Revision 1.8  1994/06/11  17:57:07  bentson
 * recognize break & parity error
 *
 * Revision 1.7  1994/06/05  05:51:34  bentson
 * Reorder baud table to be monotonic; add cli to CP; discard
 * incoming characters and status if the line isn't open; start to
 * fold code into cy_throttle; start to port get_serial_info,
 * set_serial_info, get_modem_info, set_modem_info, and send_break
 * from serial.c; expand cy_ioctl; relocate and expand config_setup;
 * get flow control characters from tty struct; invalidate ports w/o
 * hardware;
 *
 * Revision 1.6  1994/05/31  18:42:21  bentson
 * add a loop-breaker in the interrupt service routine;
 * note when port is initialized so that it can be shut
 * down under the right conditions; receive works without
 * any obvious errors
 *
 * Revision 1.5  1994/05/30  00:55:02  bentson
 * transmit works without obvious errors
 *
 * Revision 1.4  1994/05/27  18:46:27  bentson
 * incorporated more code from lib_y.c; can now print short
 * strings under interrupt control to port zero; seems to
 * select ports/channels/lines correctly
 *
 * Revision 1.3  1994/05/25  22:12:44  bentson
 * shifting from multi-port on a card to proper multiplexor
 * data structures;  added skeletons of most routines
 *
 * Revision 1.2  1994/05/19  13:21:43  bentson
 * start to crib from other sources
 *
 */

#define CY_VERSION      "2.5"

/* If you need to install more boards than NR_CARDS, change the constant
   in the definition below. No other change is necessary to support up to
   eight boards. Beyond that you'll have to extend cy_isa_addresses. */

#define NR_CARDS        4

/*
   If the total number of ports is larger than NR_PORTS, change this
   constant in the definition below. No other change is necessary to
   support more boards/ports. */

#define NR_PORTS        256

#define ZE_V1_NPORTS    64
#define ZO_V1   0
#define ZO_V2   1
#define ZE_V1   2

#define SERIAL_PARANOIA_CHECK
#undef  CY_DEBUG_OPEN
#undef  CY_DEBUG_THROTTLE
#undef  CY_DEBUG_OTHER
#undef  CY_DEBUG_IO
#undef  CY_DEBUG_COUNT
#undef  CY_DEBUG_DTR
#undef  CY_DEBUG_WAIT_UNTIL_SENT
#undef  CY_DEBUG_INTERRUPTS
#undef  CY_16Y_HACK
#undef  CY_ENABLE_MONITORING
#undef  CY_PCI_DEBUG

/*
 * Include section
 */
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/signal.h>
#include <linux/sched.h>
#include <linux/timer.h>
#include <linux/interrupt.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
#include <linux/serial.h>
#include <linux/major.h>
#include <linux/string.h>
#include <linux/fcntl.h>
#include <linux/ptrace.h>
#include <linux/cyclades.h>
#include <linux/mm.h>
#include <linux/ioport.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/spinlock.h>
#include <linux/bitops.h>
#include <linux/firmware.h>

#include <asm/system.h>
#include <linux/io.h>
#include <asm/irq.h>
#include <linux/uaccess.h>

#include <linux/kernel.h>
#include <linux/pci.h>

#include <linux/stat.h>
#include <linux/proc_fs.h>

static void cy_throttle(struct tty_struct *tty);
static void cy_send_xchar(struct tty_struct *tty, char ch);

#define IS_CYC_Z(card) ((card).num_chips == (unsigned int)-1)

#define Z_FPGA_CHECK(card) \
        ((readl(&((struct RUNTIME_9060 __iomem *) \
                ((card).ctl_addr))->init_ctrl) & (1<<17)) != 0)

#define ISZLOADED(card) (((ZO_V1 == readl(&((struct RUNTIME_9060 __iomem *) \
                        ((card).ctl_addr))->mail_box_0)) || \
                        Z_FPGA_CHECK(card)) && \
                        (ZFIRM_ID == readl(&((struct FIRM_ID __iomem *) \
                        ((card).base_addr+ID_ADDRESS))->signature)))

#ifndef SERIAL_XMIT_SIZE
#define SERIAL_XMIT_SIZE        (min(PAGE_SIZE, 4096))
#endif
#define WAKEUP_CHARS            256

#define STD_COM_FLAGS (0)

/* firmware stuff */
#define ZL_MAX_BLOCKS   16
#define DRIVER_VERSION  0x02010203
#define RAM_SIZE 0x80000

#define Z_FPGA_LOADED(X)        ((readl(&(X)->init_ctrl) & (1<<17)) != 0)

enum zblock_type {
        ZBLOCK_PRG = 0,
        ZBLOCK_FPGA = 1
};

struct zfile_header {
        char name[64];
        char date[32];
        char aux[32];
        u32 n_config;
        u32 config_offset;
        u32 n_blocks;
        u32 block_offset;
        u32 reserved[9];
} __attribute__ ((packed));

struct zfile_config {
        char name[64];
        u32 mailbox;
        u32 function;
        u32 n_blocks;
        u32 block_list[ZL_MAX_BLOCKS];
} __attribute__ ((packed));

struct zfile_block {
        u32 type;
        u32 file_offset;
        u32 ram_offset;
        u32 size;
} __attribute__ ((packed));

static struct tty_driver *cy_serial_driver;

#ifdef CONFIG_ISA
/* This is the address lookup table. The driver will probe for
   Cyclom-Y/ISA boards at all addresses in here. If you want the
   driver to probe addresses at a different address, add it to
   this table.  If the driver is probing some other board and
   causing problems, remove the offending address from this table.
*/

static unsigned int cy_isa_addresses[] = {
        0xD0000,
        0xD2000,
        0xD4000,
        0xD6000,
        0xD8000,
        0xDA000,
        0xDC000,
        0xDE000,
        0, 0, 0, 0, 0, 0, 0, 0
};

#define NR_ISA_ADDRS ARRAY_SIZE(cy_isa_addresses)

#ifdef MODULE
static long maddr[NR_CARDS];
static int irq[NR_CARDS];

module_param_array(maddr, long, NULL, 0);
module_param_array(irq, int, NULL, 0);
#endif

#endif                          /* CONFIG_ISA */

/* This is the per-card data structure containing address, irq, number of
   channels, etc. This driver supports a maximum of NR_CARDS cards.
*/
static struct cyclades_card cy_card[NR_CARDS];

static int cy_next_channel;     /* next minor available */

/*
 * This is used to look up the divisor speeds and the timeouts
 * We're normally limited to 15 distinct baud rates.  The extra
 * are accessed via settings in info->port.flags.
 *      0,     1,     2,     3,     4,     5,     6,     7,     8,     9,
 *     10,    11,    12,    13,    14,    15,    16,    17,    18,    19,
 *                                               HI            VHI
 *     20
 */
static int baud_table[] = {
        0, 50, 75, 110, 134, 150, 200, 300, 600, 1200,
        1800, 2400, 4800, 9600, 19200, 38400, 57600, 76800, 115200, 150000,
        230400, 0
};

static char baud_co_25[] = {    /* 25 MHz clock option table */
        /* value =>    00    01   02    03    04 */
        /* divide by    8    32   128   512  2048 */
        0x00, 0x04, 0x04, 0x04, 0x04, 0x04, 0x03, 0x03, 0x03, 0x02,
        0x02, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
};

static char baud_bpr_25[] = {   /* 25 MHz baud rate period table */
        0x00, 0xf5, 0xa3, 0x6f, 0x5c, 0x51, 0xf5, 0xa3, 0x51, 0xa3,
        0x6d, 0x51, 0xa3, 0x51, 0xa3, 0x51, 0x36, 0x29, 0x1b, 0x15
};

static char baud_co_60[] = {    /* 60 MHz clock option table (CD1400 J) */
        /* value =>    00    01   02    03    04 */
        /* divide by    8    32   128   512  2048 */
        0x00, 0x00, 0x00, 0x04, 0x04, 0x04, 0x04, 0x04, 0x03, 0x03,
        0x03, 0x02, 0x02, 0x01, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00
};

static char baud_bpr_60[] = {   /* 60 MHz baud rate period table (CD1400 J) */
        0x00, 0x82, 0x21, 0xff, 0xdb, 0xc3, 0x92, 0x62, 0xc3, 0x62,
        0x41, 0xc3, 0x62, 0xc3, 0x62, 0xc3, 0x82, 0x62, 0x41, 0x32,
        0x21
};

static char baud_cor3[] = {     /* receive threshold */
        0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a,
        0x0a, 0x0a, 0x0a, 0x09, 0x09, 0x08, 0x08, 0x08, 0x08, 0x07,
        0x07
};

/*
 * The Cyclades driver implements HW flow control as any serial driver.
 * The cyclades_port structure member rflow and the vector rflow_thr
 * allows us to take advantage of a special feature in the CD1400 to avoid
 * data loss even when the system interrupt latency is too high. These flags
 * are to be used only with very special applications. Setting these flags
 * requires the use of a special cable (DTR and RTS reversed). In the new
 * CD1400-based boards (rev. 6.00 or later), there is no need for special
 * cables.
 */

static char rflow_thr[] = {     /* rflow threshold */
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a, 0x0a,
        0x0a
};

/*  The Cyclom-Ye has placed the sequential chips in non-sequential
 *  address order.  This look-up table overcomes that problem.
 */
static int cy_chip_offset[] = { 0x0000,
        0x0400,
        0x0800,
        0x0C00,
        0x0200,
        0x0600,
        0x0A00,
        0x0E00
};

/* PCI related definitions */

#ifdef CONFIG_PCI
static struct pci_device_id cy_pci_dev_id[] __devinitdata = {
        /* PCI < 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_Y_Lo) },
        /* PCI > 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_Y_Hi) },
        /* 4Y PCI < 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_4Y_Lo) },
        /* 4Y PCI > 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_4Y_Hi) },
        /* 8Y PCI < 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_8Y_Lo) },
        /* 8Y PCI > 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_8Y_Hi) },
        /* Z PCI < 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_Z_Lo) },
        /* Z PCI > 1Mb */
        { PCI_DEVICE(PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_CYCLOM_Z_Hi) },
        { }                     /* end of table */
};
MODULE_DEVICE_TABLE(pci, cy_pci_dev_id);
#endif

static void cy_start(struct tty_struct *);
static void set_line_char(struct cyclades_port *);
static int cyz_issue_cmd(struct cyclades_card *, __u32, __u8, __u32);
#ifdef CONFIG_ISA
static unsigned detect_isa_irq(void __iomem *);
#endif                          /* CONFIG_ISA */

static int cyclades_get_proc_info(char *, char **, off_t, int, int *, void *);

#ifndef CONFIG_CYZ_INTR
static void cyz_poll(unsigned long);

/* The Cyclades-Z polling cycle is defined by this variable */
static long cyz_polling_cycle = CZ_DEF_POLL;

static DEFINE_TIMER(cyz_timerlist, cyz_poll, 0, 0);

#else                           /* CONFIG_CYZ_INTR */
static void cyz_rx_restart(unsigned long);
static struct timer_list cyz_rx_full_timer[NR_PORTS];
#endif                          /* CONFIG_CYZ_INTR */

static inline int serial_paranoia_check(struct cyclades_port *info,
                char *name, const char *routine)
{
#ifdef SERIAL_PARANOIA_CHECK
        if (!info) {
                printk(KERN_WARNING "cyc Warning: null cyclades_port for (%s) "
                                "in %s\n", name, routine);
                return 1;
        }

        if (info->magic != CYCLADES_MAGIC) {
                printk(KERN_WARNING "cyc Warning: bad magic number for serial "
                                "struct (%s) in %s\n", name, routine);
                return 1;
        }
#endif
        return 0;
}                               /* serial_paranoia_check */

/***********************************************************/
/********* Start of block of Cyclom-Y specific code ********/

/* This routine waits up to 1000 micro-seconds for the previous
   command to the Cirrus chip to complete and then issues the
   new command.  An error is returned if the previous command
   didn't finish within the time limit.

   This function is only called from inside spinlock-protected code.
 */
static int cyy_issue_cmd(void __iomem *base_addr, u_char cmd, int index)
{
        unsigned int i;

        /* Check to see that the previous command has completed */
        for (i = 0; i < 100; i++) {
                if (readb(base_addr + (CyCCR << index)) == 0)
                        break;
                udelay(10L);
        }
        /* if the CCR never cleared, the previous command
           didn't finish within the "reasonable time" */
        if (i == 100)
                return -1;

        /* Issue the new command */
        cy_writeb(base_addr + (CyCCR << index), cmd);

        return 0;
}                               /* cyy_issue_cmd */

#ifdef CONFIG_ISA
/* ISA interrupt detection code */
static unsigned detect_isa_irq(void __iomem *address)
{
        int irq;
        unsigned long irqs, flags;
        int save_xir, save_car;
        int index = 0;          /* IRQ probing is only for ISA */

        /* forget possible initially masked and pending IRQ */
        irq = probe_irq_off(probe_irq_on());

        /* Clear interrupts on the board first */
        cy_writeb(address + (Cy_ClrIntr << index), 0);
        /* Cy_ClrIntr is 0x1800 */

        irqs = probe_irq_on();
        /* Wait ... */
        udelay(5000L);

        /* Enable the Tx interrupts on the CD1400 */
        local_irq_save(flags);
        cy_writeb(address + (CyCAR << index), 0);
        cyy_issue_cmd(address, CyCHAN_CTL | CyENB_XMTR, index);

        cy_writeb(address + (CyCAR << index), 0);
        cy_writeb(address + (CySRER << index),
                  readb(address + (CySRER << index)) | CyTxRdy);
        local_irq_restore(flags);

        /* Wait ... */
        udelay(5000L);

        /* Check which interrupt is in use */
        irq = probe_irq_off(irqs);

        /* Clean up */
        save_xir = (u_char) readb(address + (CyTIR << index));
        save_car = readb(address + (CyCAR << index));
        cy_writeb(address + (CyCAR << index), (save_xir & 0x3));
        cy_writeb(address + (CySRER << index),
                  readb(address + (CySRER << index)) & ~CyTxRdy);
        cy_writeb(address + (CyTIR << index), (save_xir & 0x3f));
        cy_writeb(address + (CyCAR << index), (save_car));
        cy_writeb(address + (Cy_ClrIntr << index), 0);
        /* Cy_ClrIntr is 0x1800 */

        return (irq > 0) ? irq : 0;
}
#endif                          /* CONFIG_ISA */

static void cyy_chip_rx(struct cyclades_card *cinfo, int chip,
                void __iomem *base_addr)
{
        struct cyclades_port *info;
        struct tty_struct *tty;
        int len, index = cinfo->bus_index;
        u8 save_xir, channel, save_car, data, char_count;

#ifdef CY_DEBUG_INTERRUPTS
        printk(KERN_DEBUG "cyy_interrupt: rcvd intr, chip %d\n", chip);
#endif
        /* determine the channel & change to that context */
        save_xir = readb(base_addr + (CyRIR << index));
        channel = save_xir & CyIRChannel;

        info = &cinfo->ports[channel + chip * 4];
        save_car = readb(base_addr + (CyCAR << index));
        cy_writeb(base_addr + (CyCAR << index), save_xir);

        /* if there is nowhere to put the data, discard it */
        if (info->port.tty == NULL) {
                if ((readb(base_addr + (CyRIVR << index)) & CyIVRMask) ==
                                CyIVRRxEx) {    /* exception */
                        data = readb(base_addr + (CyRDSR << index));
                } else {        /* normal character reception */
                        char_count = readb(base_addr + (CyRDCR << index));
                        while (char_count--)
                                data = readb(base_addr + (CyRDSR << index));
                }
                goto end;
        }
        /* there is an open port for this data */
        tty = info->port.tty;
        if ((readb(base_addr + (CyRIVR << index)) & CyIVRMask) ==
                        CyIVRRxEx) {    /* exception */
                data = readb(base_addr + (CyRDSR << index));

                /* For statistics only */
                if (data & CyBREAK)
                        info->icount.brk++;
                else if (data & CyFRAME)
                        info->icount.frame++;
                else if (data & CyPARITY)
                        info->icount.parity++;
                else if (data & CyOVERRUN)
                        info->icount.overrun++;

                if (data & info->ignore_status_mask) {
                        info->icount.rx++;
                        return;
                }
                if (tty_buffer_request_room(tty, 1)) {
                        if (data & info->read_status_mask) {
                                if (data & CyBREAK) {
                                        tty_insert_flip_char(tty,
                                                readb(base_addr + (CyRDSR <<
                                                        index)), TTY_BREAK);
                                        info->icount.rx++;
                                        if (info->port.flags & ASYNC_SAK)
                                                do_SAK(tty);
                                } else if (data & CyFRAME) {
                                        tty_insert_flip_char(tty,
                                                readb(base_addr + (CyRDSR <<
                                                        index)), TTY_FRAME);
                                        info->icount.rx++;
                                        info->idle_stats.frame_errs++;
                                } else if (data & CyPARITY) {
                                        /* Pieces of seven... */
                                        tty_insert_flip_char(tty,
                                                readb(base_addr + (CyRDSR <<
                                                        index)), TTY_PARITY);
                                        info->icount.rx++;
                                        info->idle_stats.parity_errs++;
                                } else if (data & CyOVERRUN) {
                                        tty_insert_flip_char(tty, 0,
                                                        TTY_OVERRUN);
                                        info->icount.rx++;
                                        /* If the flip buffer itself is
                                           overflowing, we still lose
                                           the next incoming character.
                                         */
                                        tty_insert_flip_char(tty,
                                                readb(base_addr + (CyRDSR <<
                                                        index)), TTY_FRAME);
                                        info->icount.rx++;
                                        info->idle_stats.overruns++;
                                /* These two conditions may imply */
                                /* a normal read should be done. */
                                /* } else if(data & CyTIMEOUT) { */
                                /* } else if(data & CySPECHAR) { */
                                } else {
                                        tty_insert_flip_char(tty, 0,
                                                        TTY_NORMAL);
                                        info->icount.rx++;
                                }
                        } else {
                                tty_insert_flip_char(tty, 0, TTY_NORMAL);
                                info->icount.rx++;
                        }
                } else {
                        /* there was a software buffer overrun and nothing
                         * could be done about it!!! */
                        info->icount.buf_overrun++;
                        info->idle_stats.overruns++;
                }
        } else {        /* normal character reception */
                /* load # chars available from the chip */
                char_count = readb(base_addr + (CyRDCR << index));

#ifdef CY_ENABLE_MONITORING
                ++info->mon.int_count;
                info->mon.char_count += char_count;
                if (char_count > info->mon.char_max)
                        info->mon.char_max = char_count;
                info->mon.char_last = char_count;
#endif
                len = tty_buffer_request_room(tty, char_count);
                while (len--) {
                        data = readb(base_addr + (CyRDSR << index));
                        tty_insert_flip_char(tty, data, TTY_NORMAL);
                        info->idle_stats.recv_bytes++;
                        info->icount.rx++;
#ifdef CY_16Y_HACK
                        udelay(10L);
#endif
                }
                info->idle_stats.recv_idle = jiffies;
        }
        tty_schedule_flip(tty);
end:
        /* end of service */
        cy_writeb(base_addr + (CyRIR << index), save_xir & 0x3f);
        cy_writeb(base_addr + (CyCAR << index), save_car);
}

static void cyy_chip_tx(struct cyclades_card *cinfo, unsigned int chip,
                void __iomem *base_addr)
{
        struct cyclades_port *info;
        int char_count, index = cinfo->bus_index;
        u8 save_xir, channel, save_car, outch;

        /* Since we only get here when the transmit buffer
           is empty, we know we can always stuff a dozen
           characters. */
#ifdef CY_DEBUG_INTERRUPTS
        printk(KERN_DEBUG "cyy_interrupt: xmit intr, chip %d\n", chip);
#endif

        /* determine the channel & change to that context */
        save_xir = readb(base_addr + (CyTIR << index));
        channel = save_xir & CyIRChannel;
        save_car = readb(base_addr + (CyCAR << index));
        cy_writeb(base_addr + (CyCAR << index), save_xir);

        /* validate the port# (as configured and open) */
        if (channel + chip * 4 >= cinfo->nports) {
                cy_writeb(base_addr + (CySRER << index),
                          readb(base_addr + (CySRER << index)) & ~CyTxRdy);
                goto end;
        }
        info = &cinfo->ports[channel + chip * 4];
        if (info->port.tty == NULL) {
                cy_writeb(base_addr + (CySRER << index),
                          readb(base_addr + (CySRER << index)) & ~CyTxRdy);
                goto end;
        }

        /* load the on-chip space for outbound data */
        char_count = info->xmit_fifo_size;

        if (info->x_char) {     /* send special char */
                outch = info->x_char;
                cy_writeb(base_addr + (CyTDR << index), outch);
                char_count--;
                info->icount.tx++;
                info->x_char = 0;
        }

        if (info->breakon || info->breakoff) {
                if (info->breakon) {
                        cy_writeb(base_addr + (CyTDR << index), 0);
                        cy_writeb(base_addr + (CyTDR << index), 0x81);
                        info->breakon = 0;
                        char_count -= 2;
                }
                if (info->breakoff) {
                        cy_writeb(base_addr + (CyTDR << index), 0);
                        cy_writeb(base_addr + (CyTDR << index), 0x83);
                        info->breakoff = 0;
                        char_count -= 2;
                }
        }

        while (char_count-- > 0) {
                if (!info->xmit_cnt) {
                        if (readb(base_addr + (CySRER << index)) & CyTxMpty) {
                                cy_writeb(base_addr + (CySRER << index),
                                        readb(base_addr + (CySRER << index)) &
                                                ~CyTxMpty);
                        } else {
                                cy_writeb(base_addr + (CySRER << index),
                                        (readb(base_addr + (CySRER << index)) &
                                                ~CyTxRdy) | CyTxMpty);
                        }
                        goto done;
                }
                if (info->port.xmit_buf == NULL) {
                        cy_writeb(base_addr + (CySRER << index),
                                readb(base_addr + (CySRER << index)) &
                                        ~CyTxRdy);
                        goto done;
                }
                if (info->port.tty->stopped || info->port.tty->hw_stopped) {
                        cy_writeb(base_addr + (CySRER << index),
                                readb(base_addr + (CySRER << index)) &
                                        ~CyTxRdy);
                        goto done;
                }
                /* Because the Embedded Transmit Commands have been enabled,
                 * we must check to see if the escape character, NULL, is being
                 * sent. If it is, we must ensure that there is room for it to
                 * be doubled in the output stream.  Therefore we no longer
                 * advance the pointer when the character is fetched, but
                 * rather wait until after the check for a NULL output
                 * character. This is necessary because there may not be room
                 * for the two chars needed to send a NULL.)
                 */
                outch = info->port.xmit_buf[info->xmit_tail];
                if (outch) {
                        info->xmit_cnt--;
                        info->xmit_tail = (info->xmit_tail + 1) &
                                        (SERIAL_XMIT_SIZE - 1);
                        cy_writeb(base_addr + (CyTDR << index), outch);
                        info->icount.tx++;
                } else {
                        if (char_count > 1) {
                                info->xmit_cnt--;
                                info->xmit_tail = (info->xmit_tail + 1) &
                                        (SERIAL_XMIT_SIZE - 1);
                                cy_writeb(base_addr + (CyTDR << index), outch);
                                cy_writeb(base_addr + (CyTDR << index), 0);
                                info->icount.tx++;
                                char_count--;
                        }
                }
        }

done:
        tty_wakeup(info->port.tty);
end:
        /* end of service */
        cy_writeb(base_addr + (CyTIR << index), save_xir & 0x3f);
        cy_writeb(base_addr + (CyCAR << index), save_car);
}

static void cyy_chip_modem(struct cyclades_card *cinfo, int chip,
                void __iomem *base_addr)
{
        struct cyclades_port *info;
        int index = cinfo->bus_index;
        u8 save_xir, channel, save_car, mdm_change, mdm_status;

        /* determine the channel & change to that context */
        save_xir = readb(base_addr + (CyMIR << index));
        channel = save_xir & CyIRChannel;
        info = &cinfo->ports[channel + chip * 4];
        save_car = readb(base_addr + (CyCAR << index));
        cy_writeb(base_addr + (CyCAR << index), save_xir);

        mdm_change = readb(base_addr + (CyMISR << index));
        mdm_status = readb(base_addr + (CyMSVR1 << index));

        if (!info->port.tty)
                goto end;

        if (mdm_change & CyANY_DELTA) {
                /* For statistics only */
                if (mdm_change & CyDCD)
                        info->icount.dcd++;
                if (mdm_change & CyCTS)
                        info->icount.cts++;
                if (mdm_change & CyDSR)
                        info->icount.dsr++;
                if (mdm_change & CyRI)
                        info->icount.rng++;

                wake_up_interruptible(&info->delta_msr_wait);
        }

        if ((mdm_change & CyDCD) && (info->port.flags & ASYNC_CHECK_CD)) {
                if (!(mdm_status & CyDCD)) {
                        tty_hangup(info->port.tty);
                        info->port.flags &= ~ASYNC_NORMAL_ACTIVE;
                }
                wake_up_interruptible(&info->port.open_wait);
        }
        if ((mdm_change & CyCTS) && (info->port.flags & ASYNC_CTS_FLOW)) {
                if (info->port.tty->hw_stopped) {
                        if (mdm_status & CyCTS) {
                                /* cy_start isn't used
                                   because... !!! */
                                info->port.tty->hw_stopped = 0;
                                cy_writeb(base_addr + (CySRER << index),
                                        readb(base_addr + (CySRER << index)) |
                                                CyTxRdy);
                                tty_wakeup(info->port.tty);
                        }
                } else {
                        if (!(mdm_status & CyCTS)) {
                                /* cy_stop isn't used
                                   because ... !!! */
                                info->port.tty->hw_stopped = 1;
                                cy_writeb(base_addr + (CySRER << index),
                                        readb(base_addr + (CySRER << index)) &
                                                ~CyTxRdy);
                        }
                }
        }
/*      if (mdm_change & CyDSR) {
        }
        if (mdm_change & CyRI) {
        }*/
end:
        /* end of service */
        cy_writeb(base_addr + (CyMIR << index), save_xir & 0x3f);
        cy_writeb(base_addr + (CyCAR << index), save_car);
}

/* The real interrupt service routine is called
   whenever the card wants its hand held--chars
   received, out buffer empty, modem change, etc.
 */
static irqreturn_t cyy_interrupt(int irq, void *dev_id)
{
        int status;
        struct cyclades_card *cinfo = dev_id;
        void __iomem *base_addr, *card_base_addr;
        unsigned int chip, too_many, had_work;
        int index;

        if (unlikely(cinfo == NULL)) {
#ifdef CY_DEBUG_INTERRUPTS
                printk(KERN_DEBUG "cyy_interrupt: spurious interrupt %d\n",
                                irq);
#endif
                return IRQ_NONE;        /* spurious interrupt */
        }

        card_base_addr = cinfo->base_addr;
        index = cinfo->bus_index;

        /* card was not initialized yet (e.g. DEBUG_SHIRQ) */
        if (unlikely(card_base_addr == NULL))
                return IRQ_HANDLED;

        /* This loop checks all chips in the card.  Make a note whenever
           _any_ chip had some work to do, as this is considered an
           indication that there will be more to do.  Only when no chip
           has any work does this outermost loop exit.
         */
        do {
                had_work = 0;
                for (chip = 0; chip < cinfo->num_chips; chip++) {
                        base_addr = cinfo->base_addr +
                                        (cy_chip_offset[chip] << index);
                        too_many = 0;
                        while ((status = readb(base_addr +
                                                (CySVRR << index))) != 0x00) {
                                had_work++;
                        /* The purpose of the following test is to ensure that
                           no chip can monopolize the driver.  This forces the
                           chips to be checked in a round-robin fashion (after
                           draining each of a bunch (1000) of characters).
                         */
                                if (1000 < too_many++)
                                        break;
                                spin_lock(&cinfo->card_lock);
                                if (status & CySRReceive) /* rx intr */
                                        cyy_chip_rx(cinfo, chip, base_addr);
                                if (status & CySRTransmit) /* tx intr */
                                        cyy_chip_tx(cinfo, chip, base_addr);
                                if (status & CySRModem) /* modem intr */
                                        cyy_chip_modem(cinfo, chip, base_addr);
                                spin_unlock(&cinfo->card_lock);
                        }
                }
        } while (had_work);

        /* clear interrupts */
        spin_lock(&cinfo->card_lock);
        cy_writeb(card_base_addr + (Cy_ClrIntr << index), 0);
        /* Cy_ClrIntr is 0x1800 */
        spin_unlock(&cinfo->card_lock);
        return IRQ_HANDLED;
}                               /* cyy_interrupt */

/***********************************************************/
/********* End of block of Cyclom-Y specific code **********/
/******** Start of block of Cyclades-Z specific code *******/
/***********************************************************/

static int
cyz_fetch_msg(struct cyclades_card *cinfo,
                __u32 *channel, __u8 *cmd, __u32 *param)
{
        struct FIRM_ID __iomem *firm_id;
        struct ZFW_CTRL __iomem *zfw_ctrl;
        struct BOARD_CTRL __iomem *board_ctrl;
        unsigned long loc_doorbell;

        firm_id = cinfo->base_addr + ID_ADDRESS;
        if (!ISZLOADED(*cinfo))
                return -1;
        zfw_ctrl = cinfo->base_addr + (readl(&firm_id->zfwctrl_addr) & 0xfffff);
        board_ctrl = &zfw_ctrl->board_ctrl;

        loc_doorbell = readl(&((struct RUNTIME_9060 __iomem *)
                                  (cinfo->ctl_addr))->loc_doorbell);
        if (loc_doorbell) {
                *cmd = (char)(0xff & loc_doorbell);
                *channel = readl(&board_ctrl->fwcmd_channel);
                *param = (__u32) readl(&board_ctrl->fwcmd_param);
                cy_writel(&((struct RUNTIME_9060 __iomem *)(cinfo->ctl_addr))->
                          loc_doorbell, 0xffffffff);
                return 1;
        }
        return 0;
}                               /* cyz_fetch_msg */

static int
cyz_issue_cmd(struct cyclades_card *cinfo,
                __u32 channel, __u8 cmd, __u32 param)
{
        struct FIRM_ID __iomem *firm_id;
        struct ZFW_CTRL __iomem *zfw_ctrl;
        struct BOARD_CTRL __iomem *board_ctrl;
        __u32 __iomem *pci_doorbell;
        unsigned int index;

        firm_id = cinfo->base_addr + ID_ADDRESS;
        if (!ISZLOADED(*cinfo))
                return -1;

        zfw_ctrl = cinfo->base_addr + (readl(&firm_id->zfwctrl_addr) & 0xfffff);
        board_ctrl = &zfw_ctrl->board_ctrl;

        index = 0;
        pci_doorbell =
            &((struct RUNTIME_9060 __iomem *)(cinfo->ctl_addr))->pci_doorbell;
        while ((readl(pci_doorbell) & 0xff) != 0) {
                if (index++ == 1000)
                        return (int)(readl(pci_doorbell) & 0xff);
                udelay(50L);
        }
        cy_writel(&board_ctrl->hcmd_channel, channel);
        cy_writel(&board_ctrl->hcmd_param, param);
        cy_writel(pci_doorbell, (long)cmd);

        return 0;
}                               /* cyz_issue_cmd */

static void cyz_handle_rx(struct cyclades_port *info,
                struct BUF_CTRL __iomem *buf_ctrl)
{
        struct cyclades_card *cinfo = info->card;
        struct tty_struct *tty = info->port.tty;
        unsigned int char_count;
        int len;
#ifdef BLOCKMOVE
        unsigned char *buf;
#else
        char data;
#endif
        __u32 rx_put, rx_get, new_rx_get, rx_bufsize, rx_bufaddr;

        rx_get = new_rx_get = readl(&buf_ctrl->rx_get);
        rx_put = readl(&buf_ctrl->rx_put);
        rx_bufsize = readl(&buf_ctrl->rx_bufsize);
        rx_bufaddr = readl(&buf_ctrl->rx_bufaddr);
        if (rx_put >= rx_get)
                char_count = rx_put - rx_get;
        else
                char_count = rx_put - rx_get + rx_bufsize;

        if (char_count) {
#ifdef CY_ENABLE_MONITORING
                info->mon.int_count++;
                info->mon.char_count += char_count;
                if (char_count > info->mon.char_max)
                        info->mon.char_max = char_count;
                info->mon.char_last = char_count;
#endif
                if (tty == NULL) {
                        /* flush received characters */
                        new_rx_get = (new_rx_get + char_count) &
                                        (rx_bufsize - 1);
                        info->rflush_count++;
                } else {
#ifdef BLOCKMOVE
                /* we'd like to use memcpy(t, f, n) and memset(s, c, count)
                   for performance, but because of buffer boundaries, there
                   may be several steps to the operation */
                        while (1) {
                                len = tty_prepare_flip_string(tty, &buf,
                                                char_count);
                                if (!len)
                                        break;

                                len = min_t(unsigned int, min(len, char_count),
                                                rx_bufsize - new_rx_get);

                                memcpy_fromio(buf, cinfo->base_addr +
                                                rx_bufaddr + new_rx_get, len);

                                new_rx_get = (new_rx_get + len) &
                                                (rx_bufsize - 1);
                                char_count -= len;
                                info->icount.rx += len;
                                info->idle_stats.recv_bytes += len;
                        }
#else
                        len = tty_buffer_request_room(tty, char_count);
                        while (len--) {
                                data = readb(cinfo->base_addr + rx_bufaddr +
                                                new_rx_get);
                                new_rx_get = (new_rx_get + 1) &
                                                        (rx_bufsize - 1);
                                tty_insert_flip_char(tty, data, TTY_NORMAL);
                                info->idle_stats.recv_bytes++;
                                info->icount.rx++;
                        }
#endif
#ifdef CONFIG_CYZ_INTR
                /* Recalculate the number of chars in the RX buffer and issue
                   a cmd in case it's higher than the RX high water mark */
                        rx_put = readl(&buf_ctrl->rx_put);
                        if (rx_put >= rx_get)
                                char_count = rx_put - rx_get;
                        else
                                char_count = rx_put - rx_get + rx_bufsize;
                        if (char_count >= readl(&buf_ctrl->rx_threshold) &&
                                        !timer_pending(&cyz_rx_full_timer[
                                                        info->line]))
                                mod_timer(&cyz_rx_full_timer[info->line],
                                                jiffies + 1);
#endif
                        info->idle_stats.recv_idle = jiffies;
                        tty_schedule_flip(tty);
                }
                /* Update rx_get */
                cy_writel(&buf_ctrl->rx_get, new_rx_get);
        }
}

static void cyz_handle_tx(struct cyclades_port *info,
                struct BUF_CTRL __iomem *buf_ctrl)
{
        struct cyclades_card *cinfo = info->card;
        struct tty_struct *tty = info->port.tty;
        u8 data;
        unsigned int char_count;
#ifdef BLOCKMOVE
        int small_count;
#endif
        __u32 tx_put, tx_get, tx_bufsize, tx_bufaddr;

        if (info->xmit_cnt <= 0)        /* Nothing to transmit */
                return;

        tx_get = readl(&buf_ctrl->tx_get);
        tx_put = readl(&buf_ctrl->tx_put);
        tx_bufsize = readl(&buf_ctrl->tx_bufsize);
        tx_bufaddr = readl(&buf_ctrl->tx_bufaddr);
        if (tx_put >= tx_get)
                char_count = tx_get - tx_put - 1 + tx_bufsize;
        else
                char_count = tx_get - tx_put - 1;

        if (char_count) {

                if (tty == NULL)
                        goto ztxdone;

                if (info->x_char) {     /* send special char */
                        data = info->x_char;

                        cy_writeb(cinfo->base_addr + tx_bufaddr + tx_put, data);
                        tx_put = (tx_put + 1) & (tx_bufsize - 1);
                        info->x_char = 0;
                        char_count--;
                        info->icount.tx++;
                }
#ifdef BLOCKMOVE
                while (0 < (small_count = min_t(unsigned int,
                                tx_bufsize - tx_put, min_t(unsigned int,
                                        (SERIAL_XMIT_SIZE - info->xmit_tail),
                                        min_t(unsigned int, info->xmit_cnt,
                                                char_count))))) {

                        memcpy_toio((char *)(cinfo->base_addr + tx_bufaddr +
                                        tx_put),
                                        &info->port.xmit_buf[info->xmit_tail],
                                        small_count);

                        tx_put = (tx_put + small_count) & (tx_bufsize - 1);
                        char_count -= small_count;
                        info->icount.tx += small_count;
                        info->xmit_cnt -= small_count;
                        info->xmit_tail = (info->xmit_tail + small_count) &
                                        (SERIAL_XMIT_SIZE - 1);
                }
#else
                while (info->xmit_cnt && char_count) {
                        data = info->port.xmit_buf[info->xmit_tail];
                        info->xmit_cnt--;
                        info->xmit_tail = (info->xmit_tail + 1) &
                                        (SERIAL_XMIT_SIZE - 1);

                        cy_writeb(cinfo->base_addr + tx_bufaddr + tx_put, data);
                        tx_put = (tx_put + 1) & (tx_bufsize - 1);
                        char_count--;
                        info->icount.tx++;
                }
#endif
                tty_wakeup(tty);
ztxdone:
                /* Update tx_put */
                cy_writel(&buf_ctrl->tx_put, tx_put);
        }
}

static void cyz_handle_cmd(struct cyclades_card *cinfo)
{
        struct tty_struct *tty;
        struct cyclades_port *info;
        static struct FIRM_ID __iomem *firm_id;
        static struct ZFW_CTRL __iomem *zfw_ctrl;
        static struct BOARD_CTRL __iomem *board_ctrl;
        static struct CH_CTRL __iomem *ch_ctrl;
        static struct BUF_CTRL __iomem *buf_ctrl;
        __u32 channel;
        __u8 cmd;
        __u32 param;
        __u32 hw_ver, fw_ver;
        int special_count;
        int delta_count;

        firm_id = cinfo->base_addr + ID_ADDRESS;
        zfw_ctrl = cinfo->base_addr + (readl(&firm_id->zfwctrl_addr) & 0xfffff);
        board_ctrl = &zfw_ctrl->board_ctrl;
        fw_ver = readl(&board_ctrl->fw_version);
        hw_ver = readl(&((struct RUNTIME_9060 __iomem *)(cinfo->ctl_addr))->
                        mail_box_0);

        while (cyz_fetch_msg(cinfo, &channel, &cmd, &param) == 1) {
                special_count = 0;
                delta_count = 0;
                info = &cinfo->ports[channel];
                tty = info->port.tty;
                if (tty == NULL)
                        continue;

                ch_ctrl = &(zfw_ctrl->ch_ctrl[channel]);
                buf_ctrl = &(zfw_ctrl->buf_ctrl[channel]);

                switch (cmd) {
                case C_CM_PR_ERROR:
                        tty_insert_flip_char(tty, 0, TTY_PARITY);
                        info->icount.rx++;
                        special_count++;
                        break;
                case C_CM_FR_ERROR:
                        tty_insert_flip_char(tty, 0, TTY_FRAME);
                        info->icount.rx++;
                        special_count++;
                        break;
                case C_CM_RXBRK:
                        tty_insert_flip_char(tty, 0, TTY_BREAK);
                        info->icount.rx++;
                        special_count++;
                        break;
                case C_CM_MDCD:
                        info->icount.dcd++;
                        delta_count++;
                        if (info->port.flags & ASYNC_CHECK_CD) {
                                if ((fw_ver > 241 ? ((u_long) param) :
                                                readl(&ch_ctrl->rs_status)) &
                                                C_RS_DCD) {
                                        wake_up_interruptible(&info->port.open_wait);
                                } else {
                                        tty_hangup(info->port.tty);
                                        wake_up_interruptible(&info->port.open_wait);
                                        info->port.flags &= ~ASYNC_NORMAL_ACTIVE;
                                }
                        }
                        break;
                case C_CM_MCTS:
                        info->icount.cts++;
                        delta_count++;
                        break;
                case C_CM_MRI:
                        info->icount.rng++;
                        delta_count++;
                        break;
                case C_CM_MDSR:
                        info->icount.dsr++;
                        delta_count++;
                        break;
#ifdef Z_WAKE
                case C_CM_IOCTLW:
                        complete(&info->shutdown_wait);
                        break;
#endif
#ifdef CONFIG_CYZ_INTR
                case C_CM_RXHIWM:
                case C_CM_RXNNDT:
                case C_CM_INTBACK2:
                        /* Reception Interrupt */
#ifdef CY_DEBUG_INTERRUPTS
                        printk(KERN_DEBUG "cyz_interrupt: rcvd intr, card %d, "
                                        "port %ld\n", info->card, channel);
#endif
                        cyz_handle_rx(info, buf_ctrl);
                        break;
                case C_CM_TXBEMPTY:
                case C_CM_TXLOWWM:
                case C_CM_INTBACK:
                        /* Transmission Interrupt */
#ifdef CY_DEBUG_INTERRUPTS
                        printk(KERN_DEBUG "cyz_interrupt: xmit intr, card %d, "
                                        "port %ld\n", info->card, channel);
#endif
                        cyz_handle_tx(info, buf_ctrl);
                        break;
#endif                          /* CONFIG_CYZ_INTR */
                case C_CM_FATAL:
                        /* should do something with this !!! */
                        break;
                default:
                        break;
                }
                if (delta_count)
                        wake_up_interruptible(&info->delta_msr_wait);
                if (special_count)
                        tty_schedule_flip(tty);
        }
}

#ifdef CONFIG_CYZ_INTR
static irqreturn_t cyz_interrupt(int irq, void *dev_id)
{
        struct cyclades_card *cinfo = dev_id;

        if (unlikely(cinfo == NULL)) {
#ifdef CY_DEBUG_INTERRUPTS
                printk(KERN_DEBUG "cyz_interrupt: spurious interrupt %d\n",
                                                                        irq);
#endif
                return IRQ_NONE;        /* spurious interrupt */
        }

        if (unlikely(!ISZLOADED(*cinfo))) {
#ifdef CY_DEBUG_INTERRUPTS
                printk(KERN_DEBUG "cyz_interrupt: board not yet loaded "
                                "(IRQ%d).\n", irq);
#endif
                return IRQ_NONE;
        }

        /* Handle the interrupts */
        cyz_handle_cmd(cinfo);

        return IRQ_HANDLED;
}                               /* cyz_interrupt */

static void cyz_rx_restart(unsigned long arg)
{
        struct cyclades_port *info = (struct cyclades_port *)arg;
        struct cyclades_card *card = info->card;
        int retval;
        __u32 channel = info->line - card->first_line;
        unsigned long flags;

        spin_lock_irqsave(&card->card_lock, flags);
        retval = cyz_issue_cmd(card, channel, C_CM_INTBACK2, 0L);
        if (retval != 0) {
                printk(KERN_ERR "cyc:cyz_rx_restart retval on ttyC%d was %x\n",
                        info->line, retval);
        }
        spin_unlock_irqrestore(&card->card_lock, flags);
}

#else                           /* CONFIG_CYZ_INTR */

static void cyz_poll(unsigned long arg)
{
        struct cyclades_card *cinfo;
        struct cyclades_port *info;
        struct tty_struct *tty;
        struct FIRM_ID __iomem *firm_id;
        struct ZFW_CTRL __iomem *zfw_ctrl;
        struct BOARD_CTRL __iomem *board_ctrl;
        struct BUF_CTRL __iomem *buf_ctrl;
        unsigned long expires = jiffies + HZ;
        unsigned int port, card;

        for (card = 0; card < NR_CARDS; card++) {
                cinfo = &cy_card[card];

                if (!IS_CYC_Z(*cinfo))
                        continue;
                if (!ISZLOADED(*cinfo))
                        continue;

                firm_id = cinfo->base_addr + ID_ADDRESS;
                zfw_ctrl = cinfo->base_addr +
                                (readl(&firm_id->zfwctrl_addr) & 0xfffff);
                board_ctrl = &(zfw_ctrl->board_ctrl);

        /* Skip first polling cycle to avoid racing conditions with the FW */
                if (!cinfo->intr_enabled) {
                        cinfo->nports = (int)readl(&board_ctrl->n_channel);
                        cinfo->intr_enabled = 1;
                        continue;
                }

                cyz_handle_cmd(cinfo);

                for (port = 0; port < cinfo->nports; port++) {
                        info = &cinfo->ports[port];
                        tty = info->port.tty;
                        buf_ctrl = &(zfw_ctrl->buf_ctrl[port]);

                        if (!info->throttle)
                                cyz_handle_rx(info, buf_ctrl);
                        cyz_handle_tx(info, buf_ctrl);
                }
                /* poll every 'cyz_polling_cycle' period */
                expires = jiffies + cyz_polling_cycle;
        }
        mod_timer(&cyz_timerlist, expires);
}                               /* cyz_poll */

#endif                          /* CONFIG_CYZ_INTR */

/********** End of block of Cyclades-Z specific code *********/
/***********************************************************/

/* This is called whenever a port becomes active;
   interrupts are enabled and DTR & RTS are turned on.
 */
static int startup(struct cyclades_port *info)
{
        struct cyclades_card *card;
        unsigned long flags;
        int retval = 0;
        void __iomem *base_addr;
        int chip, channel, index;
        unsigned long page;

        card = info->card;
        channel = info->line - card->first_line;

        page = get_zeroed_page(GFP_KERNEL);
        if (!page)
                return -ENOMEM;

        spin_lock_irqsave(&card->card_lock, flags);

        if (info->port.flags & ASYNC_INITIALIZED) {
                free_page(page);
                goto errout;
        }

        if (!info->type) {
                if (info->port.tty)
                        set_bit(TTY_IO_ERROR, &info->port.tty->flags);
                free_page(page);
                goto errout;
        }

        if (info->port.xmit_buf)
                free_page(page);
        else
                info->port.xmit_buf = (unsigned char *)page;

        spin_unlock_irqrestore(&card->card_lock, flags);

        set_line_char(info);

        if (!IS_CYC_Z(*card)) {
                chip = channel >> 2;
                channel &= 0x03;
                index = card->bus_index;
                base_addr = card->base_addr + (cy_chip_offset[chip] << index);

#ifdef CY_DEBUG_OPEN
                printk(KERN_DEBUG "cyc startup card %d, chip %d, channel %d, "
                                "base_addr %p\n",
                                card, chip, channel, base_addr);
#endif
                spin_lock_irqsave(&card->card_lock, flags);

                cy_writeb(base_addr + (CyCAR << index), (u_char) channel);

                cy_writeb(base_addr + (CyRTPR << index),
                        (info->default_timeout ? info->default_timeout : 0x02));
                /* 10ms rx timeout */

                cyy_issue_cmd(base_addr, CyCHAN_CTL | CyENB_RCVR | CyENB_XMTR,
                                index);

                cy_writeb(base_addr + (CyCAR << index), (u_char) channel);
                cy_writeb(base_addr + (CyMSVR1 << index), CyRTS);
                cy_writeb(base_addr + (CyMSVR2 << index), CyDTR);

#ifdef CY_DEBUG_DTR
                printk(KERN_DEBUG "cyc:startup raising DTR\n");
                printk(KERN_DEBUG "     status: 0x%x, 0x%x\n",
                        readb(base_addr + (CyMSVR1 << index)),
                        readb(base_addr + (CyMSVR2 << index)));
#endif

                cy_writeb(base_addr + (CySRER << index),
                        readb(base_addr + (CySRER << index)) | CyRxData);
                info->port.flags |= ASYNC_INITIALIZED;

                if (info->port.tty)
                        clear_bit(TTY_IO_ERROR, &info->port.tty->flags);
                info->xmit_cnt = info->xmit_head = info->xmit_tail = 0;
                info->breakon = info->breakoff = 0;
                memset((char *)&info->idle_stats, 0, sizeof(info->idle_stats));
                info->idle_stats.in_use =
                info->idle_stats.recv_idle =
                info->idle_stats.xmit_idle = jiffies;

                spin_unlock_irqrestore(&card->card_lock, flags);

        } else {
                struct FIRM_ID __iomem *firm_id;
                struct ZFW_CTRL __iomem *zfw_ctrl;
                struct BOARD_CTRL __iomem *board_ctrl;
                struct CH_CTRL __iomem *ch_ctrl;

                base_addr = card->base_addr;

                firm_id = base_addr + ID_ADDRESS;
                if (!ISZLOADED(*card))
                        return -ENODEV;

                zfw_ctrl = card->base_addr +
                                (readl(&firm_id->zfwctrl_addr) & 0xfffff);
                board_ctrl = &zfw_ctrl->board_ctrl;
                ch_ctrl = zfw_ctrl->ch_ctrl;

#ifdef CY_DEBUG_OPEN
                printk(KERN_DEBUG "cyc startup Z card %d, channel %d, "
                        "base_addr %p\n", card, channel, base_addr);
#endif
                spin_lock_irqsave(&card->card_lock, flags);

                cy_writel(&ch_ctrl[channel].op_mode, C_CH_ENABLE);
#ifdef Z_WAKE
#ifdef CONFIG_CYZ_INTR
                cy_writel(&ch_ctrl[channel].intr_enable,
                          C_IN_TXBEMPTY | C_IN_TXLOWWM | C_IN_RXHIWM |
                          C_IN_RXNNDT | C_IN_IOCTLW | C_IN_MDCD);
#else
                cy_writel(&ch_ctrl[channel].intr_enable,
                          C_IN_IOCTLW | C_IN_MDCD);
#endif                          /* CONFIG_CYZ_INTR */
#else
#ifdef CONFIG_CYZ_INTR
                cy_writel(&ch_ctrl[channel].intr_enable,
                          C_IN_TXBEMPTY | C_IN_TXLOWWM | C_IN_RXHIWM |
                          C_IN_RXNNDT | C_IN_MDCD);
#else
                cy_writel(&ch_ctrl[channel].intr_enable, C_IN_MDCD);
#endif                          /* CONFIG_CYZ_INTR */
#endif                          /* Z_WAKE */

                retval = cyz_issue_cmd(card, channel, C_CM_IOCTL, 0L);
                if (retval != 0) {
                        printk(KERN_ERR "cyc:startup(1) retval on ttyC%d was "
                                "%x\n", info->line, retval);
                }

                /* Flush RX buffers before raising DTR and RTS */
                retval = cyz_issue_cmd(card, channel, C_CM_FLUSH_RX, 0L);
                if (retval != 0) {
                        printk(KERN_ERR "cyc:startup(2) retval on ttyC%d was "
                                "%x\n", info->line, retval);
                }

                /* set timeout !!! */
                /* set RTS and DTR !!! */
                cy_writel(&ch_ctrl[channel].rs_control,
                        readl(&ch_ctrl[channel].rs_control) | C_RS_RTS |
                        C_RS_DTR);
                retval = cyz_issue_cmd(card, channel, C_CM_IOCTLM, 0L);
                if (retval != 0) {
                        printk(KERN_ERR "cyc:startup(3) retval on ttyC%d was "
                                "%x\n", info->line, retval);
                }
#ifdef CY_DEBUG_DTR
                printk(KERN_DEBUG "cyc:startup raising Z DTR\n");
#endif

                /* enable send, recv, modem !!! */

                info->port.flags |= ASYNC_INITIALIZED;
                if (info->port.tty)
                        clear_bit(TTY_IO_ERROR, &info->port.tty->flags);
                info->xmit_cnt = info->xmit_head = info->xmit_tail = 0;

                info->breakon = info->breakoff = 0;
                memset((char *)&info->idle_stats, 0, sizeof(info->idle_stats));
                info->idle_stats.in_use =
                info->idle_stats.recv_idle =
                info->idle_stats.xmit_idle = jiffies;

                spin_unlock_irqrestore(&card->card_lock, flags);
        }

#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc startup done\n");
#endif
        return 0;

errout:
        spin_unlock_irqrestore(&card->card_lock, flags);
        return retval;
}                               /* startup */

static void start_xmit(struct cyclades_port *info)
{
        struct cyclades_card *card;
        unsigned long flags;
        void __iomem *base_addr;
        int chip, channel, index;

        card = info->card;
        channel = info->line - card->first_line;
        if (!IS_CYC_Z(*card)) {
                chip = channel >> 2;
                channel &= 0x03;
                index = card->bus_index;
                base_addr = card->base_addr + (cy_chip_offset[chip] << index);

                spin_lock_irqsave(&card->card_lock, flags);
                cy_writeb(base_addr + (CyCAR << index), channel);
                cy_writeb(base_addr + (CySRER << index),
                        readb(base_addr + (CySRER << index)) | CyTxRdy);
                spin_unlock_irqrestore(&card->card_lock, flags);
        } else {
#ifdef CONFIG_CYZ_INTR
                int retval;

                spin_lock_irqsave(&card->card_lock, flags);
                retval = cyz_issue_cmd(card, channel, C_CM_INTBACK, 0L);
                if (retval != 0) {
                        printk(KERN_ERR "cyc:start_xmit retval on ttyC%d was "
                                "%x\n", info->line, retval);
                }
                spin_unlock_irqrestore(&card->card_lock, flags);
#else                           /* CONFIG_CYZ_INTR */
                /* Don't have to do anything at this time */
#endif                          /* CONFIG_CYZ_INTR */
        }
}                               /* start_xmit */

/*
 * This routine shuts down a serial port; interrupts are disabled,
 * and DTR is dropped if the hangup on close termio flag is on.
 */
static void shutdown(struct cyclades_port *info)
{
        struct cyclades_card *card;
        unsigned long flags;
        void __iomem *base_addr;
        int chip, channel, index;

        if (!(info->port.flags & ASYNC_INITIALIZED))
                return;

        card = info->card;
        channel = info->line - card->first_line;
        if (!IS_CYC_Z(*card)) {
                chip = channel >> 2;
                channel &= 0x03;
                index = card->bus_index;
                base_addr = card->base_addr + (cy_chip_offset[chip] << index);

#ifdef CY_DEBUG_OPEN
                printk(KERN_DEBUG "cyc shutdown Y card %d, chip %d, "
                                "channel %d, base_addr %p\n",
                                card, chip, channel, base_addr);
#endif

                spin_lock_irqsave(&card->card_lock, flags);

                /* Clear delta_msr_wait queue to avoid mem leaks. */
                wake_up_interruptible(&info->delta_msr_wait);

                if (info->port.xmit_buf) {
                        unsigned char *temp;
                        temp = info->port.xmit_buf;
                        info->port.xmit_buf = NULL;
                        free_page((unsigned long)temp);
                }
                cy_writeb(base_addr + (CyCAR << index), (u_char) channel);
                if (!info->port.tty || (info->port.tty->termios->c_cflag & HUPCL)) {
                        cy_writeb(base_addr + (CyMSVR1 << index), ~CyRTS);
                        cy_writeb(base_addr + (CyMSVR2 << index), ~CyDTR);
#ifdef CY_DEBUG_DTR
                        printk(KERN_DEBUG "cyc shutdown dropping DTR\n");
                        printk(KERN_DEBUG "     status: 0x%x, 0x%x\n",
                                readb(base_addr + (CyMSVR1 << index)),
                                readb(base_addr + (CyMSVR2 << index)));
#endif
                }
                cyy_issue_cmd(base_addr, CyCHAN_CTL | CyDIS_RCVR, index);
                /* it may be appropriate to clear _XMIT at
                   some later date (after testing)!!! */

                if (info->port.tty)
                        set_bit(TTY_IO_ERROR, &info->port.tty->flags);
                info->port.flags &= ~ASYNC_INITIALIZED;
                spin_unlock_irqrestore(&card->card_lock, flags);
        } else {
                struct FIRM_ID __iomem *firm_id;
                struct ZFW_CTRL __iomem *zfw_ctrl;
                struct BOARD_CTRL __iomem *board_ctrl;
                struct CH_CTRL __iomem *ch_ctrl;
                int retval;

                base_addr = card->base_addr;
#ifdef CY_DEBUG_OPEN
                printk(KERN_DEBUG "cyc shutdown Z card %d, channel %d, "
                        "base_addr %p\n", card, channel, base_addr);
#endif

                firm_id = base_addr + ID_ADDRESS;
                if (!ISZLOADED(*card))
                        return;

                zfw_ctrl = card->base_addr +
                                (readl(&firm_id->zfwctrl_addr) & 0xfffff);
                board_ctrl = &zfw_ctrl->board_ctrl;
                ch_ctrl = zfw_ctrl->ch_ctrl;

                spin_lock_irqsave(&card->card_lock, flags);

                if (info->port.xmit_buf) {
                        unsigned char *temp;
                        temp = info->port.xmit_buf;
                        info->port.xmit_buf = NULL;
                        free_page((unsigned long)temp);
                }

                if (!info->port.tty || (info->port.tty->termios->c_cflag & HUPCL)) {
                        cy_writel(&ch_ctrl[channel].rs_control,
                                (__u32)(readl(&ch_ctrl[channel].rs_control) &
                                        ~(C_RS_RTS | C_RS_DTR)));
                        retval = cyz_issue_cmd(info->card, channel,
                                        C_CM_IOCTLM, 0L);
                        if (retval != 0) {
                                printk(KERN_ERR"cyc:shutdown retval on ttyC%d "
                                        "was %x\n", info->line, retval);
                        }
#ifdef CY_DEBUG_DTR
                        printk(KERN_DEBUG "cyc:shutdown dropping Z DTR\n");
#endif
                }

                if (info->port.tty)
                        set_bit(TTY_IO_ERROR, &info->port.tty->flags);
                info->port.flags &= ~ASYNC_INITIALIZED;

                spin_unlock_irqrestore(&card->card_lock, flags);
        }

#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc shutdown done\n");
#endif
}                               /* shutdown */

/*
 * ------------------------------------------------------------
 * cy_open() and friends
 * ------------------------------------------------------------
 */

static int
block_til_ready(struct tty_struct *tty, struct file *filp,
                struct cyclades_port *info)
{
        DECLARE_WAITQUEUE(wait, current);
        struct cyclades_card *cinfo;
        unsigned long flags;
        int chip, channel, index;
        int retval;
        void __iomem *base_addr;

        cinfo = info->card;
        channel = info->line - cinfo->first_line;

        /*
         * If the device is in the middle of being closed, then block
         * until it's done, and then try again.
         */
        if (tty_hung_up_p(filp) || (info->port.flags & ASYNC_CLOSING)) {
                wait_event_interruptible(info->port.close_wait,
                                !(info->port.flags & ASYNC_CLOSING));
                return (info->port.flags & ASYNC_HUP_NOTIFY) ? -EAGAIN: -ERESTARTSYS;
        }

        /*
         * If non-blocking mode is set, then make the check up front
         * and then exit.
         */
        if ((filp->f_flags & O_NONBLOCK) ||
                                        (tty->flags & (1 << TTY_IO_ERROR))) {
                info->port.flags |= ASYNC_NORMAL_ACTIVE;
                return 0;
        }

        /*
         * Block waiting for the carrier detect and the line to become
         * free (i.e., not in use by the callout).  While we are in
         * this loop, info->port.count is dropped by one, so that
         * cy_close() knows when to free things.  We restore it upon
         * exit, either normal or abnormal.
         */
        retval = 0;
        add_wait_queue(&info->port.open_wait, &wait);
#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc block_til_ready before block: ttyC%d, "
                "count = %d\n", info->line, info->port.count);
#endif
        spin_lock_irqsave(&cinfo->card_lock, flags);
        if (!tty_hung_up_p(filp))
                info->port.count--;
        spin_unlock_irqrestore(&cinfo->card_lock, flags);
#ifdef CY_DEBUG_COUNT
        printk(KERN_DEBUG "cyc block_til_ready: (%d): decrementing count to "
                "%d\n", current->pid, info->port.count);
#endif
        info->port.blocked_open++;

        if (!IS_CYC_Z(*cinfo)) {
                chip = channel >> 2;
                channel &= 0x03;
                index = cinfo->bus_index;
                base_addr = cinfo->base_addr + (cy_chip_offset[chip] << index);

                while (1) {
                        spin_lock_irqsave(&cinfo->card_lock, flags);
                        if ((tty->termios->c_cflag & CBAUD)) {
                                cy_writeb(base_addr + (CyCAR << index),
                                          (u_char) channel);
                                cy_writeb(base_addr + (CyMSVR1 << index),
                                          CyRTS);
                                cy_writeb(base_addr + (CyMSVR2 << index),
                                          CyDTR);
#ifdef CY_DEBUG_DTR
                                printk(KERN_DEBUG "cyc:block_til_ready raising "
                                        "DTR\n");
                                printk(KERN_DEBUG "     status: 0x%x, 0x%x\n",
                                        readb(base_addr + (CyMSVR1 << index)),
                                        readb(base_addr + (CyMSVR2 << index)));
#endif
                        }
                        spin_unlock_irqrestore(&cinfo->card_lock, flags);

                        set_current_state(TASK_INTERRUPTIBLE);
                        if (tty_hung_up_p(filp) ||
                                        !(info->port.flags & ASYNC_INITIALIZED)) {
                                retval = ((info->port.flags & ASYNC_HUP_NOTIFY) ?
                                          -EAGAIN : -ERESTARTSYS);
                                break;
                        }

                        spin_lock_irqsave(&cinfo->card_lock, flags);
                        cy_writeb(base_addr + (CyCAR << index),
                                  (u_char) channel);
                        if (!(info->port.flags & ASYNC_CLOSING) && (C_CLOCAL(tty) ||
                                        (readb(base_addr +
                                                (CyMSVR1 << index)) & CyDCD))) {
                                spin_unlock_irqrestore(&cinfo->card_lock, flags);
                                break;
                        }
                        spin_unlock_irqrestore(&cinfo->card_lock, flags);

                        if (signal_pending(current)) {
                                retval = -ERESTARTSYS;
                                break;
                        }
#ifdef CY_DEBUG_OPEN
                        printk(KERN_DEBUG "cyc block_til_ready blocking: "
                                "ttyC%d, count = %d\n",
                                info->line, info->port.count);
#endif
                        schedule();
                }
        } else {
                struct FIRM_ID __iomem *firm_id;
                struct ZFW_CTRL __iomem *zfw_ctrl;
                struct BOARD_CTRL __iomem *board_ctrl;
                struct CH_CTRL __iomem *ch_ctrl;

                base_addr = cinfo->base_addr;
                firm_id = base_addr + ID_ADDRESS;
                if (!ISZLOADED(*cinfo)) {
                        __set_current_state(TASK_RUNNING);
                        remove_wait_queue(&info->port.open_wait, &wait);
                        return -EINVAL;
                }

                zfw_ctrl = base_addr + (readl(&firm_id->zfwctrl_addr)
                                                                & 0xfffff);
                board_ctrl = &zfw_ctrl->board_ctrl;
                ch_ctrl = zfw_ctrl->ch_ctrl;

                while (1) {
                        if ((tty->termios->c_cflag & CBAUD)) {
                                cy_writel(&ch_ctrl[channel].rs_control,
                                        readl(&ch_ctrl[channel].rs_control) |
                                        C_RS_RTS | C_RS_DTR);
                                retval = cyz_issue_cmd(cinfo,
                                        channel, C_CM_IOCTLM, 0L);
                                if (retval != 0) {
                                        printk(KERN_ERR "cyc:block_til_ready "
                                                "retval on ttyC%d was %x\n",
                                                info->line, retval);
                                }
#ifdef CY_DEBUG_DTR
                                printk(KERN_DEBUG "cyc:block_til_ready raising "
                                        "Z DTR\n");
#endif
                        }

                        set_current_state(TASK_INTERRUPTIBLE);
                        if (tty_hung_up_p(filp) ||
                                        !(info->port.flags & ASYNC_INITIALIZED)) {
                                retval = ((info->port.flags & ASYNC_HUP_NOTIFY) ?
                                          -EAGAIN : -ERESTARTSYS);
                                break;
                        }
                        if (!(info->port.flags & ASYNC_CLOSING) && (C_CLOCAL(tty) ||
                                        (readl(&ch_ctrl[channel].rs_status) &
                                                C_RS_DCD))) {
                                break;
                        }
                        if (signal_pending(current)) {
                                retval = -ERESTARTSYS;
                                break;
                        }
#ifdef CY_DEBUG_OPEN
                        printk(KERN_DEBUG "cyc block_til_ready blocking: "
                                "ttyC%d, count = %d\n",
                                info->line, info->port.count);
#endif
                        schedule();
                }
        }
        __set_current_state(TASK_RUNNING);
        remove_wait_queue(&info->port.open_wait, &wait);
        if (!tty_hung_up_p(filp)) {
                info->port.count++;
#ifdef CY_DEBUG_COUNT
                printk(KERN_DEBUG "cyc:block_til_ready (%d): incrementing "
                        "count to %d\n", current->pid, info->port.count);
#endif
        }
        info->port.blocked_open--;
#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc:block_til_ready after blocking: ttyC%d, "
                "count = %d\n", info->line, info->port.count);
#endif
        if (retval)
                return retval;
        info->port.flags |= ASYNC_NORMAL_ACTIVE;
        return 0;
}                               /* block_til_ready */

/*
 * This routine is called whenever a serial port is opened.  It
 * performs the serial-specific initialization for the tty structure.
 */
static int cy_open(struct tty_struct *tty, struct file *filp)
{
        struct cyclades_port *info;
        unsigned int i, line;
        int retval;

        line = tty->index;
        if (tty->index < 0 || NR_PORTS <= line)
                return -ENODEV;

        for (i = 0; i < NR_CARDS; i++)
                if (line < cy_card[i].first_line + cy_card[i].nports &&
                                line >= cy_card[i].first_line)
                        break;
        if (i >= NR_CARDS)
                return -ENODEV;
        info = &cy_card[i].ports[line - cy_card[i].first_line];
        if (info->line < 0)
                return -ENODEV;

        /* If the card's firmware hasn't been loaded,
           treat it as absent from the system.  This
           will make the user pay attention.
         */
        if (IS_CYC_Z(*info->card)) {
                struct cyclades_card *cinfo = info->card;
                struct FIRM_ID __iomem *firm_id = cinfo->base_addr + ID_ADDRESS;

                if (!ISZLOADED(*cinfo)) {
                        if (((ZE_V1 == readl(&((struct RUNTIME_9060 __iomem *)
                                         (cinfo->ctl_addr))->mail_box_0)) &&
                                        Z_FPGA_CHECK(*cinfo)) &&
                                        (ZFIRM_HLT == readl(
                                                &firm_id->signature))) {
                                printk(KERN_ERR "cyc:Cyclades-Z Error: you "
                                        "need an external power supply for "
                                        "this number of ports.\nFirmware "
                                        "halted.\n");
                        } else {
                                printk(KERN_ERR "cyc:Cyclades-Z firmware not "
                                        "yet loaded\n");
                        }
                        return -ENODEV;
                }
#ifdef CONFIG_CYZ_INTR
                else {
                /* In case this Z board is operating in interrupt mode, its
                   interrupts should be enabled as soon as the first open
                   happens to one of its ports. */
                        if (!cinfo->intr_enabled) {
                                struct ZFW_CTRL __iomem *zfw_ctrl;
                                struct BOARD_CTRL __iomem *board_ctrl;

                                zfw_ctrl = cinfo->base_addr +
                                        (readl(&firm_id->zfwctrl_addr) &
                                         0xfffff);

                                board_ctrl = &zfw_ctrl->board_ctrl;

                                /* Enable interrupts on the PLX chip */
                                cy_writew(cinfo->ctl_addr + 0x68,
                                        readw(cinfo->ctl_addr + 0x68) | 0x0900);
                                /* Enable interrupts on the FW */
                                retval = cyz_issue_cmd(cinfo, 0,
                                                C_CM_IRQ_ENBL, 0L);
                                if (retval != 0) {
                                        printk(KERN_ERR "cyc:IRQ enable retval "
                                                "was %x\n", retval);
                                }
                                cinfo->nports =
                                        (int)readl(&board_ctrl->n_channel);
                                cinfo->intr_enabled = 1;
                        }
                }
#endif                          /* CONFIG_CYZ_INTR */
                /* Make sure this Z port really exists in hardware */
                if (info->line > (cinfo->first_line + cinfo->nports - 1))
                        return -ENODEV;
        }
#ifdef CY_DEBUG_OTHER
        printk(KERN_DEBUG "cyc:cy_open ttyC%d\n", info->line);
#endif
        tty->driver_data = info;
        info->port.tty = tty;
        if (serial_paranoia_check(info, tty->name, "cy_open"))
                return -ENODEV;

#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc:cy_open ttyC%d, count = %d\n", info->line,
                        info->port.count);
#endif
        info->port.count++;
#ifdef CY_DEBUG_COUNT
        printk(KERN_DEBUG "cyc:cy_open (%d): incrementing count to %d\n",
                current->pid, info->port.count);
#endif

        /*
         * If the port is the middle of closing, bail out now
         */
        if (tty_hung_up_p(filp) || (info->port.flags & ASYNC_CLOSING)) {
                wait_event_interruptible(info->port.close_wait,
                                !(info->port.flags & ASYNC_CLOSING));
                return (info->port.flags & ASYNC_HUP_NOTIFY) ? -EAGAIN: -ERESTARTSYS;
        }

        /*
         * Start up serial port
         */
        retval = startup(info);
        if (retval)
                return retval;

        retval = block_til_ready(tty, filp, info);
        if (retval) {
#ifdef CY_DEBUG_OPEN
                printk(KERN_DEBUG "cyc:cy_open returning after block_til_ready "
                        "with %d\n", retval);
#endif
                return retval;
        }

        info->throttle = 0;

#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc:cy_open done\n");
#endif
        return 0;
}                               /* cy_open */

/*
 * cy_wait_until_sent() --- wait until the transmitter is empty
 */
static void cy_wait_until_sent(struct tty_struct *tty, int timeout)
{
        struct cyclades_card *card;
        struct cyclades_port *info = tty->driver_data;
        void __iomem *base_addr;
        int chip, channel, index;
        unsigned long orig_jiffies;
        int char_time;

        if (serial_paranoia_check(info, tty->name, "cy_wait_until_sent"))
                return;

        if (info->xmit_fifo_size == 0)
                return;         /* Just in case.... */

        orig_jiffies = jiffies;
        lock_kernel();
        /*
         * Set the check interval to be 1/5 of the estimated time to
         * send a single character, and make it at least 1.  The check
         * interval should also be less than the timeout.
         *
         * Note: we have to use pretty tight timings here to satisfy
         * the NIST-PCTS.
         */
        char_time = (info->timeout - HZ / 50) / info->xmit_fifo_size;
        char_time = char_time / 5;
        if (char_time <= 0)
                char_time = 1;
        if (timeout < 0)
                timeout = 0;
        if (timeout)
                char_time = min(char_time, timeout);
        /*
         * If the transmitter hasn't cleared in twice the approximate
         * amount of time to send the entire FIFO, it probably won't
         * ever clear.  This assumes the UART isn't doing flow
         * control, which is currently the case.  Hence, if it ever
         * takes longer than info->timeout, this is probably due to a
         * UART bug of some kind.  So, we clamp the timeout parameter at
         * 2*info->timeout.
         */
        if (!timeout || timeout > 2 * info->timeout)
                timeout = 2 * info->timeout;
#ifdef CY_DEBUG_WAIT_UNTIL_SENT
        printk(KERN_DEBUG "In cy_wait_until_sent(%d) check=%d, jiff=%lu...",
                timeout, char_time, jiffies);
#endif
        card = info->card;
        channel = (info->line) - (card->first_line);
        if (!IS_CYC_Z(*card)) {
                chip = channel >> 2;
                channel &= 0x03;
                index = card->bus_index;
                base_addr = card->base_addr + (cy_chip_offset[chip] << index);
                while (readb(base_addr + (CySRER << index)) & CyTxRdy) {
#ifdef CY_DEBUG_WAIT_UNTIL_SENT
                        printk(KERN_DEBUG "Not clean (jiff=%lu)...", jiffies);
#endif
                        if (msleep_interruptible(jiffies_to_msecs(char_time)))
                                break;
                        if (timeout && time_after(jiffies, orig_jiffies +
                                        timeout))
                                break;
                }
        }
        /* Run one more char cycle */
        msleep_interruptible(jiffies_to_msecs(char_time * 5));
        unlock_kernel();
#ifdef CY_DEBUG_WAIT_UNTIL_SENT
        printk(KERN_DEBUG "Clean (jiff=%lu)...done\n", jiffies);
#endif
}

static void cy_flush_buffer(struct tty_struct *tty)
{
        struct cyclades_port *info = tty->driver_data;
        struct cyclades_card *card;
        int channel, retval;
        unsigned long flags;

#ifdef CY_DEBUG_IO
        printk(KERN_DEBUG "cyc:cy_flush_buffer ttyC%d\n", info->line);
#endif

        if (serial_paranoia_check(info, tty->name, "cy_flush_buffer"))
                return;

        card = info->card;
        channel = info->line - card->first_line;

        spin_lock_irqsave(&card->card_lock, flags);
        info->xmit_cnt = info->xmit_head = info->xmit_tail = 0;
        spin_unlock_irqrestore(&card->card_lock, flags);

        if (IS_CYC_Z(*card)) {  /* If it is a Z card, flush the on-board
                                           buffers as well */
                spin_lock_irqsave(&card->card_lock, flags);
                retval = cyz_issue_cmd(card, channel, C_CM_FLUSH_TX, 0L);
                if (retval != 0) {
                        printk(KERN_ERR "cyc: flush_buffer retval on ttyC%d "
                                "was %x\n", info->line, retval);
                }
                spin_unlock_irqrestore(&card->card_lock, flags);
        }
        tty_wakeup(tty);
}                               /* cy_flush_buffer */


/*
 * This routine is called when a particular tty device is closed.
 */
static void cy_close(struct tty_struct *tty, struct file *filp)
{
        struct cyclades_port *info = tty->driver_data;
        struct cyclades_card *card;
        unsigned long flags;

#ifdef CY_DEBUG_OTHER
        printk(KERN_DEBUG "cyc:cy_close ttyC%d\n", info->line);
#endif

        if (!info || serial_paranoia_check(info, tty->name, "cy_close"))
                return;

        card = info->card;

        spin_lock_irqsave(&card->card_lock, flags);
        /* If the TTY is being hung up, nothing to do */
        if (tty_hung_up_p(filp)) {
                spin_unlock_irqrestore(&card->card_lock, flags);
                return;
        }
#ifdef CY_DEBUG_OPEN
        printk(KERN_DEBUG "cyc:cy_close ttyC%d, count = %d\n", info->line,
                info->port.count);
#endif
        if ((tty->count == 1) && (info->port.count != 1)) {
                /*
                 * Uh, oh.  tty->count is 1, which means that the tty
                 * structure will be freed.  Info->count should always
                 * be one in these conditions.  If it's greater than
                 * one, we've got real problems, since it means the
                 * serial port won't be shutdown.
                 */
                printk(KERN_ERR "cyc:cy_close: bad serial port count; "
                        "tty->count is 1, info->port.count is %d\n", info->port.count);
                info->port.count = 1;
        }
#ifdef CY_DEBUG_COUNT
        printk(KERN_DEBUG  "cyc:cy_close at (%d): decrementing count to %d\n",
                current->pid, info->port.count - 1);
#endif
        if (--info->port.count < 0) {
#ifdef CY_DEBUG_COUNT
                printk(KERN_DEBUG "cyc:cyc_close setting count to 0\n");
#endif
                info->port.count = 0;
        }
        if (info->port.count) {
                spin_unlock_irqrestore(&card->card_lock, flags);
                return;
        }
        info->port.flags |= ASYNC_CLOSING;

        /*
         * Now we wait for the transmit buffer to clear; and we notify
         * the line discipline to only process XON/XOFF characters.
         */
        tty->closing = 1;
        spin_unlock_irqrestore(&card->card_lock, flags);
        if (info->port.closing_wait != CY_CLOSING_WAIT_NONE)
                tty_wait_until_sent(tty, info->port.closing_wait);

        spin_lock_irqsave(&card->card_lock, flags);

        if (!IS_CYC_Z(*card)) {
                int channel = info->line - card->first_line;
                int index = card->bus_index;
                void __iomem *base_addr = card->base_addr +
                        (cy_chip_offset[channel >> 2] << index);
                /* Stop accepting input */
                channel &= 0x03;
                cy_writeb(base_addr + (CyCAR << index), (u_char) channel);
                cy_writeb(base_addr + (CySRER << index),
                          readb(base_addr + (CySRER << index)) & ~CyRxData);
                if (info->port.flags & ASYNC_INITIALIZED) {
                        /* Waiting for on-board buffers to be empty before
                           closing the port */
                        spin_unlock_irqrestore(&card->card_lock, flags);
                        cy_wait_until_sent(tty, info->timeout);
                        spin_lock_irqsave(&card->card_lock, flags);
                }
        } else {
#ifdef Z_WAKE
                /* Waiting for on-board buffers to be empty before closing
                   the port */
                void __iomem *base_addr = card->base_addr;
                struct FIRM_ID __iomem *firm_id = base_addr + ID_ADDRESS;
                struct ZFW_CTRL __iomem *zfw_ctrl =
                    base_addr + (readl(&firm_id->zfwctrl_addr) & 0xfffff);
                struct CH_CTRL __iomem *ch_ctrl = zfw_ctrl->ch_ctrl;
                int channel = info->line - card->first_line;
                int retval;

                if (readl(&ch_ctrl[channel].flow_status) != C_FS_TXIDLE) {
                        retval = cyz_issue_cmd(card, channel, C_CM_IOCTLW, 0L);
                        if (retval != 0) {
                                printk(KERN_DEBUG "cyc:cy_close retval on "
                                        "ttyC%d was %x\n", info->line, retval);
                        }
                        spin_unlock_irqrestore(&card->card_lock, flags);
                        wait_for_completion_interruptible(&info->shutdown_wait);
                        spin_lock_irqsave(&card->card_lock, flags);
                }
#endif
        }

        spin_unlock_irqrestore(&card->card_lock, flags);
        shutdown(info);
        cy_flush_buffer(tty);
        tty_ldisc_flush(tty);
        spin_lock_irqsave(&card->card_lock, flags);

        tty->closing = 0;
        info->port.tty = NULL;
        if (info->port.blocked_open) {
                spin_unlock_irqrestore(&card->card_lock, flags);
                if (info->port.close_delay) {
                        msleep_interruptible(jiffies_to_msecs
                                                (info->port.close_delay));
                }
                wake_up_interruptible(&info->port.open_wait);
                spin_lock_irqsave(&card->card_lock, flags);
        }
        info->port.flags &= ~(ASYNC_NORMAL_ACTIVE | ASYNC_CLOSING);
        wake_up_interruptible(&info->port.close_wait);

#ifdef CY_DEBUG_OTHER
        printk(KERN_DEBUG "cyc:cy_close done\n");
#endif

        spin_unlock_irqrestore(&card->card_lock, flags);
}                               /* cy_close */

/* This routine gets called when tty_write has put something into
 * the write_queue.  The characters may come from user space or
 * kernel space.
 *
 * This routine will return the number of characters actually
 * accepted for writing.
 *
 * If the port is not already transmitting stuff, start it off by
 * enabling interrupts.  The interrupt service routine will then
 * ensure that the characters are sent.
 * If the port is already active, there is no need to kick it.
 *
 */
static int cy_write(struct tty_struct *tty, const unsigned char *buf, int count)
{
        struct cyclades_port *info = tty->driver_data;
        unsigned long flags;
        int c, ret = 0;

#ifdef CY_DEBUG_IO
        printk(KERN_DEBUG "cyc:cy_write ttyC%d\n", info->line);
#endif

        if (serial_paranoia_check(info, tty->name, "cy_write"))
                return 0;

        if (!info->port.xmit_buf)
                return 0;

        spin_lock_irqsave(&info->card->card_lock, flags);
        while (1) {
                c = min(count, (int)(SERIAL_XMIT_SIZE - info->xmit_cnt - 1));
                c = min(c, (int)(SERIAL_XMIT_SIZE - info->xmit_head));

                if (c <= 0)
                        break;

                memcpy(info->port.xmit_buf + info->xmit_head, buf, c);
                info->xmit_head = (info->xmit_head + c) &
                        (SERIAL_XMIT_SIZE - 1);
                info->xmit_cnt += c;
                buf += c;
                count -= c;
                ret += c;
        }
        spin_unlock_irqrestore(&info->card->card_lock, flags);

        info->idle_stats.xmit_bytes += ret;
        info->idle_stats.xmit_idle = jiffies;

        if (info->xmit_cnt && !tty->stopped && !tty->hw_stopped)
                start_xmit(info);

        return ret;
}                               /* cy_write */

/*
 * This routine is called by the kernel to write a single
 * character to the tty device.  If the kernel uses this routine,
 * it must call the flush_chars() routine (if defined) when it is
 * done stuffing characters into the driver.  If there is no room
 * in the queue, the character is ignored.
 */
static int cy_put_char(struct tty_struct *tty, unsigned char ch)
{
        struct cyclades_port *info = tty->driver_data;
        unsigned long flags;

#ifdef CY_DEBUG_IO
        printk(KERN_DEBUG "cyc:cy_put_char ttyC%d\n", info->line);
#endif

        if (serial_paranoia_check(info, tty->name, "cy_put_char"))
                return 0;

        if (!info->port.xmit_buf)
                return 0;

        spin_lock_irqsave(&info->card->card_lock, flags);
        if (info->xmit_cnt >= (int)(SERIAL_XMIT_SIZE - 1)) {
                spin_unlock_irqrestore(&info->card->card_lock, flags);
                return 0;
        }

        info->port.xmit_buf[info->xmit_head++] = ch;
        info->xmit_head &= SERIAL_XMIT_SIZE - 1;
        info->xmit_cnt++;
        info->idle_stats.xmit_bytes++;
        info->idle_stats.xmit_idle = jiffies;
        spin_unlock_irqrestore(&info->card->card_lock, flags);
        return 1;
}                               /* cy_put_char */

/*
 * This routine is called by the kernel after it has written a
 * series of characters to the tty device using put_char().
 */
static void cy_flush_chars(struct tty_struct *tty)
{
        struct cyclades_port *info = tty->driver_data;

#ifdef CY_DEBUG_IO
        printk(KERN_DEBUG "cyc:cy_flush_chars ttyC%d\n", info->line);
#endif

        if (serial_paranoia_check(info, tty->name, "cy_flush_chars"))
                return;

        if (info->xmit_cnt <= 0 || tty->stopped || tty->hw_stopped ||
                        !info->port.xmit_buf)
                return;

        start_xmit(info);
}                               /* cy_flush_chars */

/*
 * This routine returns the numbers of characters the tty driver
 * will accept for queuing to be written.  This number is subject
 * to change as output buffers get emptied, or if the output flow
 * control is activated.
 */
static int cy_write_room(struct tty_struct *tty)
{
        struct cyclades_port *info = tty->driver_data;
        int ret;

#ifdef CY_DEBUG_IO
        printk(KERN_DEBUG "cyc:cy_write_room ttyC%d\n", info->line);
#endif

        if (serial_paranoia_check(info, tty->name, "cy_write_room"))
                return 0;
        ret = SERIAL_XMIT_SIZE - info->xmit_cnt - 1;
        if (ret < 0)
                ret = 0;
        return ret;
}                               /* cy_write_room */

static int cy_chars_in_buffer(struct tty_struct *tty)
{
        struct cyclades_card *card;
        struct cyclades_port *info = tty->driver_data;
        int channel;

        if (serial_paranoia_check(info, tty->name, "cy_chars_in_buffer"))
                return 0;

        card = info->card;
        channel = (info->line) - (card->first_line);

#ifdef Z_EXT_CHARS_IN_BUFFER
        if (!IS_CYC_Z(cy_card[card])) {
#endif                          /* Z_EXT_CHARS_IN_BUFFER */
#ifdef CY_DEBUG_IO
                printk(KERN_DEBUG "cyc:cy_chars_in_buffer ttyC%d %d\n",
                        info->line, info->xmit_cnt);
#endif
                return info->xmit_cnt;
#ifdef Z_EXT_CHARS_IN_BUFFER
        } else {
                static struct FIRM_ID *firm_id;
                static struct ZFW_CTRL *zfw_ctrl;
                static struct CH_CTRL *ch_ctrl;
                static struct BUF_CTRL *buf_ctrl;
                int char_count;
                __u32 tx_put, tx_get, tx_bufsize;

                lock_kernel();
                firm_id = card->base_addr + ID_ADDRESS;
                zfw_ctrl = card->base_addr +
                        (readl(&firm_id->zfwctrl_addr) & 0xfffff);
                ch_ctrl = &(zfw_ctrl->ch_ctrl[channel]);
                buf_ctrl = &(zfw_ctrl->buf_ctrl[channel]);

                tx_get = readl(&buf_ctrl->tx_get);
                tx_put = readl(&buf_ctrl->tx_put);
                tx_bufsize = readl(&buf_ctrl->tx_bufsize);
                if (tx_put >= tx_get)
                        char_count = tx_put - tx_get;
                else
                        char_count = tx_put - tx_get + tx_bufsize;
#ifdef CY_DEBUG_IO
                printk(KERN_DEBUG "cyc:cy_chars_in_buffer ttyC%d %d\n",
                        info->line, info->xmit_cnt + char_count);
#endif
                unlock_kernel();
                return info->xmit_cnt + char_count;
        }
#endif                          /* Z_EXT_CHARS_IN_BUFFER */
}                               /* cy_chars_in_buffer */

/*
 * ------------------------------------------------------------
 * cy_ioctl() and friends
 * ------------------------------------------------------------
 */

static void cyy_baud_calc(struct cyclades_port *info, __u32 baud)
{
        int co, co_val, bpr;
        __u32 cy_clock = ((info->chip_rev >= CD1400_REV_J) ? 60000000 :
                        25000000);

        if (baud == 0) {
                info->tbpr = info->tco = info->rbpr = info->rco = 0;
                return;
        }

        /* determine which prescaler to use */
        for (co = 4, co_val = 2048; co; co--, co_val >>= 2) {
                if (cy_clock / co_val / baud > 63)
                        break;
        }

        bpr = (cy_clock / co_val * 2 / baud + 1) / 2;
        if (bpr > 255)
                bpr = 255;

        info->tbpr = info->rbpr = bpr;
        info->tco = info->rco = co;
}

/*
 * This routine finds or computes the various line characteristics.
 * It used to be called config_setup
 */
static void set_line_char(struct cyclades_port *info)
{
        struct cyclades_card *card;
        unsigned long flags;
        void __iomem *base_addr;
        int chip, channel, index;
        unsigned cflag, iflag;
        unsigned short chip_number;
        int baud, baud_rate = 0;
        int i;

        if (!info->port.tty || !info->port.tty->termios)
                return;

        if (info->line == -1)
                return;

        cflag = info->port.tty->termios->c_cflag;
        iflag = info->port.tty->termios->c_iflag;

        /*