| blob | 2ba24a26beb029f865459a46262619dca5e58fc4 |
1 /*
4 Copyright (C) 1996 Digi International.
6 For technical support please email digiLinux@dgii.com or
7 call Digi tech support at (612) 912-3456
9 Much of this design and code came from epca.c which was
10 copyright (C) 1994, 1995 Troy De Jongh, and subsquently
11 modified by David Nugent, Christoph Lameter, Mike McLagan.
13 This program is free software; you can redistribute it and/or modify
14 it under the terms of the GNU General Public License as published by
15 the Free Software Foundation; either version 2 of the License, or
16 (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 GNU General Public License for more details.
23 You should have received a copy of the GNU General Public License
24 along with this program; if not, write to the Free Software
25 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 --------------------------------------------------------------------------- */
28 /* See README.epca for change history --DAT*/
31 #include <linux/config.h>
32 #include <linux/module.h>
33 #include <linux/kernel.h>
34 #include <linux/types.h>
35 #include <linux/init.h>
36 #include <linux/serial.h>
37 #include <linux/delay.h>
38 #include <linux/ctype.h>
39 #include <linux/tty.h>
40 #include <linux/tty_flip.h>
41 #include <linux/slab.h>
42 #include <linux/ioport.h>
43 #include <asm/uaccess.h>
44 #include <asm/io.h>
46 #ifdef CONFIG_PCI
47 #define ENABLE_PCI
50 #define putUser(arg1, arg2) put_user(arg1, (unsigned long *)arg2)
51 #define getUser(arg1, arg2) get_user(arg1, (unsigned int *)arg2)
53 #ifdef ENABLE_PCI
54 #include <linux/pci.h>
63 /* ---------------------- Begin defines ------------------------ */
67 /* This major needs to be submitted to Linux to join the majors list */
72 #define MIN(a,b) ((a) < (b) ? (a) : (b))
73 #define MAXCARDS 7
74 #define epcaassert(x, msg) if (!(x)) epca_error(__LINE__, msg)
78 /* ----------------- Begin global definitions ------------------- */
87 /* -----------------------------------------------------------------------
88 MAXBOARDS is typically 12, but ISA and EISA cards are restricted to
89 7 below.
90 --------------------------------------------------------------------------*/
94 /* ------------- Begin structures used for driver registeration ---------- */
100 /* The below structures are used to initialize the tty_driver structures. */
102 /* -------------------------------------------------------------------------
103 Note : MAX_ALLOC is currently limited to 0x100. This restriction is
104 placed on us by Linux not Digi.
105 ----------------------------------------------------------------------------*/
111 /* ------------------ Begin Digi specific structures -------------------- */
113 /* ------------------------------------------------------------------------
114 digi_channels represents an array of structures that keep track of
115 each channel of the Digi product. Information such as transmit and
116 receive pointers, termio data, and signal definitions (DTR, CTS, etc ...)
117 are stored here. This structure is NOT used to overlay the cards
118 physical channel structure.
119 -------------------------------------------------------------------------- */
123 /* ------------------------------------------------------------------------
124 card_ptr is an array used to hold the address of the
125 first channel structure of each card. This array will hold
126 the addresses of various channels located in digi_channels.
127 -------------------------------------------------------------------------- */
132 /* ---------------------- Begin function prototypes --------------------- */
134 /* ----------------------------------------------------------------------
135 Begin generic memory functions. These functions will be alias
136 (point at) more specific functions dependent on the board being
137 configured.
138 ----------------------------------------------------------------------- */
141 #ifdef MODULE
155 /* ---- Begin more 'specific' memory functions for cx_like products --- */
164 /* ------ Begin more 'specific' memory functions for the pcxe ------- */
173 /* ---- Begin more 'specific' memory functions for the pc64xe and pcxi ---- */
174 /* Note : pc64xe and pcxi share the same windowing routines */
183 /* - Begin 'specific' do nothing memory functions needed for some cards - */
194 /* ------------------- Begin declare functions ----------------------- */
236 #ifdef ENABLE_PCI
241 /* ------------------------------------------------------------------
242 Table of functions for each board to handle memory. Mantaining
243 parallelism is a *very* good idea here. The idea is for the
244 runtime code to blindly call these functions, not knowing/caring
245 about the underlying hardware. This stuff should contain no
246 conditionals; if more functionality is needed a different entry
247 should be established. These calls are the interface calls and
248 are the only functions that should be accessed. Anyone caught
249 making direct calls deserves what they get.
250 -------------------------------------------------------------------- */
253 {
255 }
258 {
260 }
263 {
265 }
268 {
270 }
273 {
275 }
278 {
280 }
282 {
284 }
287 {
289 }
291 /* ---------------------------------------------------------
292 PCXEM windowing is the same as that used in the PCXR
293 and CX series cards.
294 ------------------------------------------------------------ */
297 {
299 }
302 {
304 }
307 {
309 }
312 {
314 }
317 {
319 }
322 {
324 }
326 /* ----------------- Begin pcxe memory window stuff ------------------ */
329 {
331 }
334 {
338 }
341 {
343 }
346 {
348 }
351 {
353 }
356 {
359 }
361 /* ------------- Begin pc64xe and pcxi memory window stuff -------------- */
364 {
366 }
369 {
371 }
374 {
376 }
379 {
381 }
384 {
386 }
389 {
391 }
394 {
396 }
399 {
401 }
404 /* ----------------------------------------------------------------------
405 Not all of the cards need specific memory windowing routines. Some
406 cards (Such as PCI) needs no windowing routines at all. We provide
407 these do nothing routines so that the same code base can be used.
408 The driver will ALWAYS call a windowing routine if it thinks it needs
409 to; regardless of the card. However, dependent on the card the routine
410 may or may not do anything.
411 ---------------------------------------------------------------------------*/
414 {
415 }
418 {
419 }
422 {
423 }
426 {
427 }
430 {
431 }
434 {
435 }
438 {
439 }
442 {
443 }
445 /* ----------------- Begin verifyChannel function ----------------------- */
449 /* --------------------------------------------------------------------
450 This routine basically provides a sanity check. It insures that
451 the channel returned is within the proper range of addresses as
452 well as properly initialized. If some bogus info gets passed in
453 through tty->driver_data this should catch it.
454 --------------------------------------------------------------------- */
462 {
465 }
469 /* Else return a NULL for invalid */
474 /* ------------------ Begin pc_sched_event ------------------------- */
480 /* ----------------------------------------------------------------------
481 We call this to schedule interrupt processing on some event. The
482 kernel sees our request and calls the related routine in OUR driver.
483 -------------------------------------------------------------------------*/
491 /* ------------------ Begin epca_error ------------------------- */
501 /* ------------------ Begin pc_close ------------------------- */
509 {
511 }
514 /* ---------------------------------------------------------
515 verifyChannel returns the channel from the tty struct
516 if it is valid. This serves as a sanity check.
517 ------------------------------------------------------------- */
526 {
529 }
531 /* Check to see if the channel is open more than once */
535 /* -------------------------------------------------------------
536 Return without doing anything. Someone might still be using
537 the channel.
538 ---------------------------------------------------------------- */
544 /* Port open only once go ahead with shutdown & reset */
547 {
549 }
551 /* ---------------------------------------------------------------
552 Let the rest of the driver know the channel is being closed.
553 This becomes important if an open is attempted before close
554 is finished.
555 ------------------------------------------------------------------ */
559 /* -------------------------------------------------------------
560 Save the termios structure, since this port may have
561 separate termios for callout and dialin.
562 --------------------------------------------------------------- */
573 {
574 /* Setup an event to indicate when the transmit buffer empties */
577 }
594 {
597 }
607 #ifdef MODULE
608 MOD_DEC_USE_COUNT;
609 #endif
617 /* ------------------ Begin shutdown ------------------------- */
635 /* ------------------------------------------------------------------
636 In order for an event to be generated on the receipt of data the
637 idata flag must be set. Since we are shutting down, this is not
638 necessary clear this flag.
639 --------------------------------------------------------------------- */
646 /* ----------------------------------------------------------------
647 If we're a modem control device and HUPCL is on, drop RTS & DTR.
648 ------------------------------------------------------------------ */
651 {
654 }
658 /* ------------------------------------------------------------------
659 The channel has officialy been closed. The next time it is opened
660 it will have to reinitialized. Set a flag to indicate this.
661 ---------------------------------------------------------------------- */
663 /* Prevent future Digi programmed interrupts from coming active */
670 /* ------------------ Begin pc_hangup ------------------------- */
677 /* ---------------------------------------------------------
678 verifyChannel returns the channel from the tty struct
679 if it is valid. This serves as a sanity check.
680 ------------------------------------------------------------- */
697 #ifdef MODULE
699 MOD_DEC_USE_COUNT;
714 /* ------------------ Begin pc_write ------------------------- */
732 /* ----------------------------------------------------------------
733 pc_write is primarily called directly by the kernel routine
734 tty_write (Though it can also be called by put_char) found in
735 tty_io.c. pc_write is passed a line discipline buffer where
736 the data to be written out is stored. The line discipline
737 implementation itself is done at the kernel level and is not
738 brought into the driver.
739 ------------------------------------------------------------------- */
741 /* Stop users from hurting themselves on control minor */
744 {
746 }
748 /* ---------------------------------------------------------
749 verifyChannel returns the channel from the tty struct
750 if it is valid. This serves as a sanity check.
751 ------------------------------------------------------------- */
756 /* Make a pointer to the channel data structure found on the board. */
769 /* -----------------------------------------------------------------
770 Anding against size will wrap the pointer back to its begining
771 position if it is necessary. This will only work if size is
772 a power of 2 which should always be the case. Size is determined
773 by the cards on board FEP/OS.
774 -------------------------------------------------------------------- */
776 /* head refers to the next empty location in which data may be stored */
780 /* tail refers to the next data byte to be transmitted */
784 /* Consider changing this to a do statement to make sure */
789 /* ------------------------------------------------------------------
790 Anding against size will wrap the pointer back to its begining
791 position if it is necessary. This will only work if size is
792 a power of 2 which should always be the case. Size is determined
793 by the cards on board FEP/OS.
794 --------------------------------------------------------------------- */
798 /* -----------------------------------------------------------------
799 Two situations can affect how space in the transmit buffer
800 is calculated. You can have a situation where the transmit
801 in pointer (tin) head has wrapped around and actually has a
802 lower address than the transmit out pointer (tout) tail; or
803 the transmit in pointer (tin) head will not be wrapped around
804 yet, and have a higher address than the transmit out pointer
805 (tout) tail. Obviously space available in the transmit buffer
806 is calculated differently for each case.
808 Example 1:
810 Consider a 10 byte buffer where head is a pointer to the next
811 empty location in the buffer and tail is a pointer to the next
812 byte to transmit. In this example head will not have wrapped
813 around and therefore head > tail.
815 0 1 2 3 4 5 6 7 8 9
816 tail head
818 The above diagram shows that buffer locations 2,3,4,5 and 6 have
819 data to be transmited, while head points at the next empty
820 location. To calculate how much space is available first we have
821 to determine if the head pointer (tin) has wrapped. To do this
822 compare the head pointer to the tail pointer, If head is equal
823 or greater than tail; then it has not wrapped; and the space may
824 be calculated by subtracting tail from head and then subtracting
825 that value from the buffers size. A one is subtracted from the
826 new value to indicate how much space is available between the
827 head pointer and end of buffer; as well as the space between the
828 begining of the buffer and the tail. If the head is not greater
829 or equal to the tail this indicates that the head has wrapped
830 around to the begining of the buffer. To calculate the space
831 available in this case simply subtract head from tail. This new
832 value minus one represents the space available betwwen the head
833 and tail pointers. In this example head (7) is greater than tail (2)
834 and therefore has not wrapped around. We find the space by first
835 subtracting tail from head (7-2=5). We then subtract this value
836 from the buffer size of ten and subtract one (10-5-1=4). The space
837 remaining is 4 bytes.
839 Example 2:
841 Consider a 10 byte buffer where head is a pointer to the next
842 empty location in the buffer and tail is a pointer to the next
843 byte to transmit. In this example head will wrapped around and
844 therefore head < tail.
846 0 1 2 3 4 5 6 7 8 9
847 head tail
849 The above diagram shows that buffer locations 7,8,9,0 and 1 have
850 data to be transmited, while head points at the next empty
851 location. To find the space available we compare head to tail. If
852 head is not equal to, or greater than tail this indicates that head
853 has wrapped around. In this case head (2) is not equal to, or
854 greater than tail (7) and therefore has already wrapped around. To
855 calculate the available space between the two pointers we subtract
856 head from tail (7-2=5). We then subtract one from this new value
857 (5-1=4). We have 5 bytes empty remaining in the buffer. Unlike the
858 previous example these five bytes are located between the head and
859 tail pointers.
861 ----------------------------------------------------------------------- */
865 /* ----------------------------------------------------------------------
866 In this case bytesAvailable has been passed into pc_write and
867 represents the amount of data that needs to be written. dataLen
868 represents the amount of space available on the card. Whichever
869 value is smaller will be the amount actually written.
870 bytesAvailable will then take on this newly calculated value.
871 ---------------------------------------------------------------------- */
875 /* First we read the data in from the file system into a temp buffer */
880 /* Can the user buffer be accessed at the moment ? */
885 /* ---------------------------------------------------------------
886 The below function reads data from user memory. This routine
887 can not be used in an interrupt routine. (Because it may
888 generate a page fault) It can only be called while we can the
889 user context is accessible.
891 The prototype is :
892 inline void copy_from_user(void * to, const void * from,
893 unsigned long count);
895 You must include <asm/segment.h>
896 I also think (Check hackers guide) that optimization must
897 be turned ON. (Which sounds strange to me...)
899 Remember copy_from_user WILL generate a page fault if the
900 user memory being accessed has been swapped out. This can
901 cause this routine to temporarily sleep while this page
902 fault is occuring.
904 ----------------------------------------------------------------- */
912 /* ------------------------------------------------------------------
913 Set buf to this address for the moment. tmp_buf was allocated in
914 post_fep_init.
915 --------------------------------------------------------------------- */
922 /* All data is now local */
937 /* If head >= tail, head has not wrapped around. */
941 /* ---------------------------------------------------------------
942 remain (much like dataLen above) represents the total amount of
943 space available on the card for data. Here dataLen represents
944 the space existing between the head pointer and the end of
945 buffer. This is important because a memcpy cannot be told to
946 automatically wrap around when it hits the buffer end.
947 ------------------------------------------------------------------ */
953 else
961 /* -------------------------------------------------------------------
962 Check the space on the card. If we have more data than
963 space; reduce the amount of data to fit the space.
964 ---------------------------------------------------------------------- */
972 /* -----------------------------------------------------------------
973 If head is not wrapped, the below will make sure the first
974 data copy fills to the end of card buffer.
975 ------------------------------------------------------------------- */
985 {
988 }
997 {
1000 }
1008 /* ------------------ Begin pc_put_char ------------------------- */
1019 /* ------------------ Begin pc_write_room ------------------------- */
1032 /* ---------------------------------------------------------
1033 verifyChannel returns the channel from the tty struct
1034 if it is valid. This serves as a sanity check.
1035 ------------------------------------------------------------- */
1038 {
1049 /* Wrap tail if necessary */
1056 {
1059 }
1062 }
1064 /* Return how much room is left on card */
1069 /* ------------------ Begin pc_chars_in_buffer ---------------------- */
1082 /* ---------------------------------------------------------
1083 verifyChannel returns the channel from the tty struct
1084 if it is valid. This serves as a sanity check.
1085 ------------------------------------------------------------- */
1101 else
1107 /* --------------------------------------------------------------
1108 The logic here is basically opposite of the above pc_write_room
1109 here we are finding the amount of bytes in the buffer filled.
1110 Not the amount of bytes empty.
1111 ------------------------------------------------------------------- */
1118 /* -------------------------------------------------------------
1119 Make it possible to wakeup anything waiting for output
1120 in tty_ioctl.c, etc.
1122 If not already set. Setup an event to indicate when the
1123 transmit buffer empties
1124 ----------------------------------------------------------------- */
1134 /* Return number of characters residing on card. */
1139 /* ------------------ Begin pc_flush_buffer ---------------------- */
1150 /* ---------------------------------------------------------
1151 verifyChannel returns the channel from the tty struct
1152 if it is valid. This serves as a sanity check.
1153 ------------------------------------------------------------- */
1166 /* Have FEP move tout pointer; effectively flushing transmit buffer */
1179 /* ------------------ Begin pc_flush_chars ---------------------- */
1186 /* ---------------------------------------------------------
1187 verifyChannel returns the channel from the tty struct
1188 if it is valid. This serves as a sanity check.
1189 ------------------------------------------------------------- */
1192 {
1198 /* ----------------------------------------------------------------
1199 If not already set and the transmitter is busy setup an event
1200 to indicate when the transmit empties.
1201 ------------------------------------------------------------------- */
1207 }
1211 /* ------------------ Begin block_til_ready ---------------------- */
1223 {
1226 else
1229 }
1231 /* -----------------------------------------------------------------
1232 If the device is in the middle of being closed, then block
1233 until it's done, and then try again.
1234 -------------------------------------------------------------------- */
1236 {
1241 else
1243 }
1245 /* -----------------------------------------------------------------
1246 If this is a callout device, then just make sure the normal
1247 device isn't being used.
1248 -------------------------------------------------------------------- */
1271 {
1272 /* -----------------------------------------------------------------
1273 If non-blocking mode is set, then make the check up front
1274 and then exit.
1275 -------------------------------------------------------------------- */
1283 }
1287 {
1290 }
1291 else
1292 {
1295 }
1297 /* Block waiting for the carrier detect and the line to become free */
1305 /* We dec count so that pc_close will know when to free things */
1320 {
1323 else
1326 }
1334 {
1337 }
1339 /* ---------------------------------------------------------------
1340 Allow someone else to be scheduled. We will occasionaly go
1341 through this loop until one of the above conditions change.
1342 The below schedule call will allow other processes to enter and
1343 prevent this loop from hogging the cpu.
1344 ------------------------------------------------------------------ */
1367 /* ------------------ Begin pc_open ---------------------- */
1378 /* Nothing "real" happens in open of control device */
1381 {
1383 }
1387 {
1391 }
1393 #ifdef MODULE
1395 MOD_INC_USE_COUNT;
1397 #endif
1402 /* Check status of board configured in system. */
1404 /* -----------------------------------------------------------------
1405 I check to see if the epca_setup routine detected an user error.
1406 It might be better to put this in pc_init, but for the moment it
1407 goes here.
1408 ---------------------------------------------------------------------- */
1411 {
1419 printk(KERN_ERR "<Error> - pc_open: Invalid board memory address specified in LILO command\n");
1432 }
1435 {
1438 }
1441 {
1444 }
1446 /* ------------------------------------------------------------------
1447 Every time a channel is opened, increment a counter. This is
1448 necessary because we do not wish to flush and shutdown the channel
1449 until the last app holding the channel open, closes it.
1450 --------------------------------------------------------------------- */
1454 /* ----------------------------------------------------------------
1455 Set a kernel structures pointer to our local channel
1456 structure. This way we can get to it when passed only
1457 a tty struct.
1458 ------------------------------------------------------------------ */
1462 /* ----------------------------------------------------------------
1463 If this is the first time the channel has been opened, initialize
1464 the tty->termios struct otherwise let pc_close handle it.
1465 -------------------------------------------------------------------- */
1467 /* Should this be here except for SPLIT termios ? */
1469 {
1472 else
1474 }
1485 /* Save boards current modem status */
1488 /* ----------------------------------------------------------------
1489 Set receive head and tail ptrs to each other. This indicates
1490 no data available to read.
1491 ----------------------------------------------------------------- */
1495 /* Set the channels associated tty structure */
1498 /* -----------------------------------------------------------------
1499 The below routine generally sets up parity, baud, flow control
1500 issues, etc.... It effect both control flags and input flags.
1501 -------------------------------------------------------------------- */
1511 {
1513 }
1515 /* -------------------------------------------------------------
1516 Set this again in case a hangup set it to zero while this
1517 open() was waiting for the line...
1518 --------------------------------------------------------------- */
1525 /* Enable Digi Data events */
1535 #ifdef MODULE
1536 /* -------------------- Begin init_module ---------------------- */
1552 #endif
1554 #ifdef ENABLE_PCI
1556 #endif
1558 #ifdef MODULE
1559 /* -------------------- Begin cleanup_module ---------------------- */
1576 {
1580 }
1599 {
1603 }
1608 #ifdef ENABLE_PCI
1610 #endif
1617 /* ------------------ Begin pc_init ---------------------- */
1622 /* ----------------------------------------------------------------
1623 pc_init is called by the operating system during boot up prior to
1624 any open calls being made. In the older versions of Linux (Prior
1625 to 2.0.0) an entry is made into tty_io.c. A pointer to the last
1626 memory location (from kernel space) used (kmem_start) is passed
1627 to pc_init. It is pc_inits responsibility to modify this value
1628 for any memory that the Digi driver might need and then return
1629 this value to the operating system. For example if the driver
1630 wishes to allocate 1K of kernel memory, pc_init would return
1631 (kmem_start + 1024). This memory (Between kmem_start and kmem_start
1632 + 1024) would then be available for use exclusively by the driver.
1633 In this case our driver does not allocate any of this kernel
1634 memory.
1635 ------------------------------------------------------------------*/
1643 #ifdef ENABLE_PCI
1649 /* -----------------------------------------------------------------------
1650 If epca_setup has not been ran by LILO set num_cards to defaults; copy
1651 board structure defined by digiConfig into drivers board structure.
1652 Note : If LILO has ran epca_setup then epca_setup will handle defining
1653 num_cards as well as copying the data into the board structure.
1654 -------------------------------------------------------------------------- */
1664 /* -----------------------------------------------------------------
1665 Note : If lilo was used to configure the driver and the
1666 ignore epcaconfig option was choosen (digiepca=2) then
1667 nbdevs and num_cards will equal 0 at this point. This is
1668 okay; PCI cards will still be picked up if detected.
1669 --------------------------------------------------------------------- */
1671 /* -----------------------------------------------------------
1672 Set up interrupt, we will worry about memory allocation in
1673 post_fep_init.
1674 --------------------------------------------------------------- */
1679 #ifdef ENABLE_PCI
1681 /* ------------------------------------------------------------------
1682 NOTE : This code assumes that the number of ports found in
1683 the boards array is correct. This could be wrong if
1684 the card in question is PCI (And therefore has no ports
1685 entry in the boards structure.) The rest of the
1686 information will be valid for PCI because the begining
1687 of pc_init scans for PCI and determines i/o and base
1688 memory addresses. I am not sure if it is possible to
1689 read the number of ports supported by the card prior to
1690 it being booted (Since that is the state it is in when
1691 pc_init is run). Because it is not possible to query the
1692 number of supported ports until after the card has booted;
1693 we are required to calculate the card_ptrs as the card is
1694 is initialized (Inside post_fep_init). The negative thing
1695 about this approach is that digiDload's call to GET_INFO
1696 will have a bad port value. (Since this is called prior
1697 to post_fep_init.)
1699 --------------------------------------------------------------------- */
1703 {
1707 }
1708 else
1709 {
1711 }
1736 /* pc_termios is an array of pointers pointing at termios structs */
1737 /* The below should get the first pointer */
1741 /* ------------------------------------------------------------------
1742 Setup entry points for the driver. These are primarily called by
1743 the kernel in tty_io.c and n_tty.c
1744 --------------------------------------------------------------------- */
1778 /* ---------------------------------------------------------------------
1779 loops_per_sec hasn't been set at this point :-(, so fake it out...
1780 I set it, so that I can use the __delay() function.
1781 ------------------------------------------------------------------------ */
1791 /* ------------------------------------------------------------------
1792 This is where the appropriate memory handlers for the hardware is
1793 set. Everything at runtime blindly jumps through these vectors.
1794 ---------------------------------------------------------------------- */
1796 /* defined in epcaconfig.h */
1857 /* ---------------------------------------------------------------
1858 Some cards need a memory segment to be defined for use in
1859 transmit and receive windowing operations. These boards
1860 are listed in the below switch. In the case of the XI the
1861 amount of memory on the board is variable so the memory_seg
1862 is also variable. This code determines what they segment
1863 should be.
1864 ----------------------------------------------------------------- */
1880 /* Is it a 64K board */
1884 /* Is it a 128K board */
1888 /* Is is a 256K board */
1892 /* Is it a 512K board */
1897 else
1898 {
1900 }
1918 /* -------------------------------------------------------------------
1919 Start up the poller to check for events on all enabled boards
1920 ---------------------------------------------------------------------- */
1932 /* ------------------ Begin post_fep_init ---------------------- */
1945 /* -------------------------------------------------------------
1946 This call is made by the user via. the ioctl call DIGI_INIT.
1947 It is resposible for setting up all the card specific stuff.
1948 ---------------------------------------------------------------- */
1951 /* -----------------------------------------------------------------
1952 If this is a PCI board, get the port info. Remember PCI cards
1953 do not have entries into the epcaconfig.h file, so we can't get
1954 the number of ports from it. Unfortunetly, this means that anyone
1955 doing a DIGI_GETINFO before the board has booted will get an invalid
1956 number of ports returned (It should return 0). Calls to DIGI_GETINFO
1957 after DIGI_INIT has been called will return the proper values.
1958 ------------------------------------------------------------------- */
1963 /* --------------------------------------------------------------------
1964 Below we use XEMPORTS as a memory offset regardless of which PCI
1965 card it is. This is because all of the supported PCI cards have
1966 the same memory offset for the channel data. This will have to be
1967 changed if we ever develop a PCI/XE card. NOTE : The FEP manual
1968 states that the port offset is 0xC22 as opposed to 0xC02. This is
1969 only true for PC/XE, and PC/XI cards; not for the XEM, or CX series.
1970 On the PCI cards the number of ports is determined by reading a
1971 ID PROM located in the box attached to the card. The card can then
1972 determine the index the id to determine the number of ports available.
1973 (FYI - The id should be located at 0x1ac (And may use up to 4 bytes
1974 if the box in question is a XEM or CX)).
1975 ------------------------------------------------------------------------ */
1988 else
1998 /*
1999 The below command is necessary because newer kernels (2.1.x and
2000 up) do not have a 1:1 virtual to physical mapping. The below
2001 call adjust for that.
2002 */
2006 /* -----------------------------------------------------------------
2007 The below assignment will set bc to point at the BEGINING of
2008 the cards channel structures. For 1 card there will be between
2009 8 and 64 of these structures.
2010 -------------------------------------------------------------------- */
2014 /* -------------------------------------------------------------------
2015 The below assignment will set gd to point at the BEGINING of
2016 global memory address 0xc00. The first data in that global
2017 memory actually starts at address 0xc1a. The command in
2018 pointer begins at 0xd10.
2019 ---------------------------------------------------------------------- */
2023 /* --------------------------------------------------------------------
2024 XEPORTS (address 0xc22) points at the number of channels the
2025 card supports. (For 64XE, XI, XEM, and XR use 0xc02)
2026 ----------------------------------------------------------------------- */
2036 /* --------------------------------------------------------------------
2037 Remember ch is the main drivers channels structure, while bc is
2038 the cards channel structure.
2039 ------------------------------------------------------------------------ */
2041 /* For every port on the card do ..... */
2055 /* ----------------------------------------------------------------
2056 Since some of the boards use different bitmaps for their
2057 control signals we cannot hard code these values and retain
2058 portability. We virtualize this data here.
2059 ------------------------------------------------------------------- */
2088 {
2092 }
2093 else
2094 {
2097 }
2105 {
2108 }
2116 /* Cover all the 2MEG cards */
2125 /* Cover all the 32K windowed cards */
2126 /* Mask equal to window size - 1 */
2158 /* Set transmitter low water mark */
2161 /* Set receiver low water mark */
2165 /* Set receiver high water mark */
2194 {
2197 }
2213 /* --------------------- Begin epcapoll ------------------------ */
2224 /* -------------------------------------------------------------------
2225 This routine is called upon every timer interrupt. Even though
2226 the Digi series cards are capable of generating interupts this
2227 method of non-looping polling is more efficient. This routine
2228 checks for card generated events (Such as receive data, are transmit
2229 buffer empty) and acts on those events.
2230 ----------------------------------------------------------------------- */
2244 /* -----------------------------------------------------------
2245 assertmemoff is not needed here; indeed it is an empty subroutine.
2246 It is being kept because future boards may need this as well as
2247 some legacy boards.
2248 ---------------------------------------------------------------- */
2254 /* ---------------------------------------------------------------
2255 In this case head and tail actually refer to the event queue not
2256 the transmit or receive queue.
2257 ------------------------------------------------------------------- */
2262 /* If head isn't equal to tail we have an event */
2276 /* --------------------- Begin doevent ------------------------ */
2290 /* -------------------------------------------------------------------
2291 This subroutine is called by epcapoll when an event is detected
2292 in the event queue. This routine responds to those events.
2293 --------------------------------------------------------------------- */
2309 /* Get the channel the event occurred on */
2312 /* Get the actual event code that occurred */
2315 /* ----------------------------------------------------------------
2316 The two assignments below get the current modem status (mstat)
2317 and the previous modem status (lstat). These are useful becuase
2318 an event could signal a change in modem signals itself.
2319 ------------------------------------------------------------------- */
2327 {
2332 }
2348 /* A modem signal change has been indicated */
2353 {
2356 else
2358 }
2369 /* A break has been indicated */
2379 else
2395 else
2399 /* This event is generated by setup_empty_event */
2419 next:
2424 else
2434 /* --------------------- Begin fepcmd ------------------------ */
2445 /* This is the routine in which commands may be passed to the card. */
2448 {
2450 }
2454 /* Remember head (As well as max) is just an offset not a base addr */
2457 /* cmdStart is a base address */
2460 /* ------------------------------------------------------------------
2461 We do the addition below because we do not want a max pointer
2462 relative to cmdStart. We want a max pointer that points at the
2463 physical end of the command queue.
2464 -------------------------------------------------------------------- */
2470 /*
2471 The below command is necessary because newer kernels (2.1.x and
2472 up) do not have a 1:1 virtual to physical mapping. The below
2473 call adjust for that.
2474 */
2479 {
2485 }
2488 {
2492 /* Below word_or_byte is bits to set */
2494 /* Below byte2 is bits to reset */
2497 }
2498 else
2499 {
2503 }
2513 count--;
2515 {
2518 }
2525 /* ----------------------------------------------------------
2526 Basically this will break when the FEP acknowledges the
2527 command by incrementing cmdTail (Making it equal to head).
2528 ------------------------------------------------------------- */
2537 /* ---------------------------------------------------------------------
2538 Digi products use fields in their channels structures that are very
2539 similar to the c_cflag and c_iflag fields typically found in UNIX
2540 termios structures. The below three routines allow mappings
2541 between these hardware "flags" and their respective Linux flags.
2542 ------------------------------------------------------------------------- */
2544 /* --------------------- Begin termios2digi_h -------------------- */
2552 {
2555 }
2582 /* --------------------- Begin termios2digi_i -------------------- */
2595 /* --------------------- Begin termios2digi_c -------------------- */
2602 #ifdef SPEED_HACK
2603 /* CL: HACK to force 115200 at 38400 and 57600 at 19200 Baud */
2613 /* -------------------------------------------------------------
2614 HUPCL bit is used by FEP to indicate fast baud
2615 table is to be used.
2616 ----------------------------------------------------------------- */
2623 /* -------------------------------------------------------------------
2624 CBAUD has bit position 0x1000 set these days to indicate Linux
2625 baud rate remap. Digi hardware can't handle the bit assignment.
2626 (We use a different bit assignment for high speed.). Clear this
2627 bit out.
2628 ---------------------------------------------------------------------- */
2631 /* -------------------------------------------------------------
2632 This gets a little confusing. The Digi cards have their own
2633 representation of c_cflags controling baud rate. For the most
2634 part this is identical to the Linux implementation. However;
2635 Digi supports one rate (76800) that Linux doesn't. This means
2636 that the c_cflag entry that would normally mean 76800 for Digi
2637 actually means 115200 under Linux. Without the below mapping,
2638 a stty 115200 would only drive the board at 76800. Since
2639 the rate 230400 is also found after 76800, the same problem afflicts
2640 us when we choose a rate of 230400. Without the below modificiation
2641 stty 230400 would actually give us 115200.
2643 There are two additional differences. The Linux value for CLOCAL
2644 (0x800; 0004000) has no meaning to the Digi hardware. Also in
2645 later releases of Linux; the CBAUD define has CBAUDEX (0x1000;
2646 0010000) ored into it (CBAUD = 0x100f as opposed to 0xf). CBAUDEX
2647 should be checked for a screened out prior to termios2digi_c
2648 returning. Since CLOCAL isn't used by the board this can be
2649 ignored as long as the returned value is used only by Digi hardware.
2650 ----------------------------------------------------------------- */
2653 {
2654 /* -------------------------------------------------------------
2655 The below code is trying to guarantee that only baud rates
2656 115200 and 230400 are remapped. We use exclusive or because
2657 the various baud rates share common bit positions and therefore
2658 can't be tested for easily.
2659 ----------------------------------------------------------------- */
2664 {
2666 }
2667 }
2673 /* --------------------- Begin epcaparam ----------------------- */
2697 /* Changing baud in mid-stream transmission can be wonderful */
2698 /* ---------------------------------------------------------------
2699 Flush current transmit buffer by setting cmdTail pointer (tout)
2700 to cmdHead pointer (tin). Hopefully the transmit buffer is empty.
2701 ----------------------------------------------------------------- */
2707 else
2710 /* -------------------------------------------------------------------
2711 c_cflags have changed but that change had nothing to do with BAUD.
2712 Propagate the change to the card.
2713 ---------------------------------------------------------------------- */
2718 {
2720 /* Set baud rate, char size, stop bits, parity */
2722 }
2725 /* ----------------------------------------------------------------
2726 If the user has not forced CLOCAL and if the device is not a
2727 CALLOUT device (Which is always CLOCAL) we set flags such that
2728 the driver will wait on carrier detect.
2729 ------------------------------------------------------------------- */
2735 else
2746 /* Check input mode flags */
2749 {
2752 /* ---------------------------------------------------------------
2753 Command sets channels iflag structure on the board. Such things
2754 as input soft flow control, handeling of parity errors, and
2755 break handeling are all set here.
2756 ------------------------------------------------------------------- */
2758 /* break handeling, parity handeling, input stripping, flow control chars */
2760 }
2762 /* ---------------------------------------------------------------
2763 Set the board mint value for this channel. This will cause hardware
2764 events to be generated each time the DCD signal (Described in mint)
2765 changes.
2766 ------------------------------------------------------------------- */
2778 {
2781 /* --------------------------------------------------------------
2782 Hard flow control has been selected but the board is not
2783 using it. Activate hard flow control now.
2784 ----------------------------------------------------------------- */
2787 }
2793 {
2796 /* --------------------------------------------------------------
2797 The below command sets the DTR and RTS mstat structure. If
2798 hard flow control is NOT active these changes will drive the
2799 output of the actual DTR and RTS lines. If hard flow control
2800 is active, the changes will be saved in the mstat structure and
2801 only asserted when hard flow control is turned off.
2802 ----------------------------------------------------------------- */
2804 /* First reset DTR & RTS; then set them */
2808 }
2811 {
2815 /* ------------------------------------------------------------
2816 The XON / XOFF characters have changed; propogate these
2817 changes to the card.
2818 --------------------------------------------------------------- */
2821 }
2824 {
2828 /* ---------------------------------------------------------------
2829 Similar to the above, this time the auxilarly XON / XOFF
2830 characters have changed; propogate these changes to the card.
2831 ------------------------------------------------------------------ */
2834 }
2838 /* --------------------- Begin receive_data ----------------------- */
2853 /* ---------------------------------------------------------------
2854 This routine is called by doint when a receive data event
2855 has taken place.
2856 ------------------------------------------------------------------- */
2870 {
2873 }
2877 /* ---------------------------------------------------------------------
2878 Get the head and tail pointers to the receiver queue. Wrap the
2879 head pointer if it has reached the end of the buffer.
2880 ------------------------------------------------------------------------ */
2891 /* ------------------------------------------------------------------
2892 If CREAD bit is off or device not open, set TX tail to head
2893 --------------------------------------------------------------------- */
2896 {
2899 }
2905 {
2908 }
2919 /* ---------------------------------------------------------------
2920 Even if head has wrapped around only report the amount of
2921 data to be equal to the size - tail. Remember memcpy can't
2922 automaticly wrap around the receive buffer.
2923 ----------------------------------------------------------------- */
2927 /* --------------------------------------------------------------
2928 Make sure we don't overflow the buffer
2929 ----------------------------------------------------------------- */
2937 /* ---------------------------------------------------------------
2938 Move data read from our card into the line disciplines buffer
2939 for translation if necessary.
2940 ------------------------------------------------------------------ */
2958 /* Must be called with global data */
2964 /* --------------------- Begin pc_ioctl ----------------------- */
2970 digiflow_t dflow;
2978 /* The control device has it's own set of commands */
2994 {
2997 }
3023 {
3026 }
3036 /* ------------------------------------------------------------
3037 This call is made by the apps to complete the initilization
3038 of the board(s). This routine is responsible for setting
3039 the card to its initial state and setting the drivers control
3040 fields to the sutianle settings for the card in question.
3041 ---------------------------------------------------------------- */
3062 else
3063 {
3066 }
3070 /* -------------------------------------------------------------------
3071 For POSIX compliance we need to add more ioctls. See tty_ioctl.c
3072 in /usr/src/linux/drivers/char for a good example. In particular
3073 think about adding TCSETAF, TCSETAW, TCSETA, TCSETSF, TCSETSW, TCSETS.
3074 ---------------------------------------------------------------------- */
3099 /* Setup an event to indicate when the transmit buffer empties */
3113 /* Setup an event to indicate when the transmit buffer empties */
3131 /*RONNIE PUT VERIFY_READ (See above) check here */
3132 {
3140 }
3218 /* --------------------------------------------------------------
3219 The below routine generally sets up parity, baud, flow control
3220 issues, etc.... It effect both control flags and input flags.
3221 ------------------------------------------------------------------ */
3249 {
3252 }
3260 {
3261 /* Setup an event to indicate when the transmit buffer empties */
3265 }
3266 else
3267 {
3270 }
3272 /* Fall Thru */
3282 {
3285 }
3286 else
3287 {
3290 }
3295 /* -----------------------------------------------------------------
3296 The below routine generally sets up parity, baud, flow control
3297 issues, etc.... It effect both control flags and input flags.
3298 ------------------------------------------------------------------- */
3310 {
3313 }
3314 else
3315 {
3318 }
3331 {
3334 }
3335 else
3336 {
3339 }
3352 {
3356 }
3357 else
3358 {
3362 }
3382 /* --------------------- Begin pc_set_termios ----------------------- */
3390 /* ---------------------------------------------------------
3391 verifyChannel returns the channel from the tty struct
3392 if it is valid. This serves as a sanity check.
3393 ------------------------------------------------------------- */
3418 /* --------------------- Begin do_softint ----------------------- */
3426 /* Called in response to a modem change event */
3434 {
3443 }
3449 /* ------------------------------------------------------------
3450 pc_stop and pc_start provide software flow control to the
3451 routine and the pc_ioctl routine.
3452 ---------------------------------------------------------------- */
3454 /* --------------------- Begin pc_stop ----------------------- */
3462 /* ---------------------------------------------------------
3463 verifyChannel returns the channel from the tty struct
3464 if it is valid. This serves as a sanity check.
3465 ------------------------------------------------------------- */
3478 /* STOP transmitting now !! */
3493 /* --------------------- Begin pc_start ----------------------- */
3500 /* ---------------------------------------------------------
3501 verifyChannel returns the channel from the tty struct
3502 if it is valid. This serves as a sanity check.
3503 ------------------------------------------------------------- */
3513 /* Just in case output was resumed because of a change in Digi-flow */
3524 /* Okay, you can start transmitting again... */
3539 /* ------------------------------------------------------------------
3540 The below routines pc_throttle and pc_unthrottle are used
3541 to slow (And resume) the receipt of data into the kernels
3542 receive buffers. The exact occurence of this depends on the
3543 size of the kernels receive buffer and what the 'watermarks'
3544 are set to for that buffer. See the n_ttys.c file for more
3545 details.
3546 ______________________________________________________________________ */
3547 /* --------------------- Begin throttle ----------------------- */
3555 /* ---------------------------------------------------------
3556 verifyChannel returns the channel from the tty struct
3557 if it is valid. This serves as a sanity check.
3558 ------------------------------------------------------------- */
3568 {
3574 }
3581 /* --------------------- Begin unthrottle ----------------------- */
3591 /* ---------------------------------------------------------
3592 verifyChannel returns the channel from the tty struct
3593 if it is valid. This serves as a sanity check.
3594 ------------------------------------------------------------- */
3600 /* Just in case output was resumed because of a change in Digi-flow */
3605 {
3613 }
3620 /* --------------------- Begin digi_send_break ----------------------- */
3631 /* --------------------------------------------------------------------
3632 Maybe I should send an infinite break here, schedule() for
3633 msec amount of time, and then stop the break. This way,
3634 the user can't screw up the FEP by causing digi_send_break()
3635 to be called (i.e. via an ioctl()) more than once in msec amount
3636 of time. Try this for now...
3637 ------------------------------------------------------------------------ */
3646 /* --------------------- Begin setup_empty_event ----------------------- */
3659 /* ------------------------------------------------------------------
3660 When set the iempty flag request a event to be generated when the
3661 transmit buffer is empty (If there is no BREAK in progress).
3662 --------------------------------------------------------------------- */
3670 /* --------------------- Begin get_termio ----------------------- */
3684 /* ---------------------- Begin epca_setup -------------------------- */
3693 /* ----------------------------------------------------------------------
3694 If this routine looks a little strange it is because it is only called
3695 if a LILO append command is given to boot the kernel with parameters.
3696 In this way, we can provide the user a method of changing his board
3697 configuration without rebuilding the kernel.
3698 ----------------------------------------------------------------------- */
3704 /* Assume the data is int first, later we can change it */
3705 /* I think that array position 0 of ints holds the number of args */
3713 /* ---------------------------------------------------------
3714 We check for 2 (As opposed to 1; because 2 is a flag
3715 instructing the driver to ignore epcaconfig.) For this
3716 reason we check for 2.
3717 ------------------------------------------------------------ */
3726 {
3731 }
3738 {
3743 }
3750 {
3755 }
3762 {
3767 }
3775 {
3780 }
3787 {
3788 printk(KERN_ERR "<Error> - epca_setup: Invalid memory base 0x%x\n",(unsigned int)board.membase);
3792 }
3805 /* find the next comma or terminator */
3808 /* While string is not null, and a comma hasn't been found */
3810 temp++;
3814 else
3817 /* Set index to the number of args + 1 */
3821 {
3826 else
3829 else
3830 {
3835 }
3846 /* ---------------------------------------------------------------
3847 If the index incremented above refers to a legitamate board
3848 type set it here.
3849 ------------------------------------------------------------------*/
3853 else
3854 {
3859 }
3867 else
3870 else
3871 {
3876 }
3883 t2++;
3886 {
3891 }
3893 /* ------------------------------------------------------------
3894 There is not a man page for simple_strtoul but the code can be
3895 found in vsprintf.c. The first argument is the string to
3896 translate (To an unsigned long obviously), the second argument
3897 can be the address of any character variable or a NULL. If a
3898 variable is given, the end pointer of the string will be stored
3899 in that variable; if a NULL is given the end pointer will
3900 not be returned. The last argument is the base to use. If
3901 a 0 is indicated, the routine will attempt to determine the
3902 proper base by looking at the values prefix (A '0' for octal,
3903 a 'x' for hex, etc ... If a value is given it will use that
3904 value as the base.
3905 ---------------------------------------------------------------- */
3914 t2++;
3917 {
3922 }
3931 t2++;
3934 {
3939 }
3948 }
3955 {
3958 }
3960 /* I should REALLY validate the stuff here */
3962 /* Copies our local copy of board into boards */
3966 /* Does this get called once per lilo arg are what ? */
3972 num_cards++;
3978 #ifdef ENABLE_PCI
3979 /* ------------------------ Begin init_PCI --------------------------- */
3983 brd_xem,
3984 brd_cx,
3985 brd_xrj,
3986 };
3989 /* indexed directly by epic_board_types enum */
3998 };
4003 {
4011 board_num++;
4021 }
4035 }
4042 }
4048 }
4055 }
4057 /* --------------------------------------------------------------
4058 I don't know what the below does, but the hardware guys say
4059 its required on everything except PLX (In this case XRJ).
4060 ---------------------------------------------------------------- */
4064 }
4068 err_out_free_memregion:
4070 err_out_free_iounmap:
4072 err_out_free_pciio:
4074 err_out:
4076 }
4085 };
4104 }