Linux-2.6.12-rc2
[linux-2.6.git] / drivers / char / rio / map.h
1 /*
2 ** -----------------------------------------------------------------------------
3 **
4 **  Perle Specialix driver for Linux
5 **  Ported from existing RIO Driver for SCO sources.
6  *
7  *  (C) 1990 - 2000 Specialix International Ltd., Byfleet, Surrey, UK.
8  *
9  *      This program is free software; you can redistribute it and/or modify
10  *      it under the terms of the GNU General Public License as published by
11  *      the Free Software Foundation; either version 2 of the License, or
12  *      (at your option) any later version.
13  *
14  *      This program is distributed in the hope that it will be useful,
15  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *      GNU General Public License for more details.
18  *
19  *      You should have received a copy of the GNU General Public License
20  *      along with this program; if not, write to the Free Software
21  *      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 **
23 **      Module          : map.h
24 **      SID             : 1.2
25 **      Last Modified   : 11/6/98 11:34:11
26 **      Retrieved       : 11/6/98 11:34:21
27 **
28 **  ident @(#)map.h     1.2
29 **
30 ** -----------------------------------------------------------------------------
31 */
32
33 #ifndef __rio_map_h__
34 #define __rio_map_h__
35
36 #ifdef SCCS_LABELS
37 static char *_map_h_sccs_ = "@(#)map.h  1.2";
38 #endif
39
40 /*
41 ** mapping structure passed to and from the config.rio program to
42 ** determine the current topology of the world
43 */
44
45 #define MAX_MAP_ENTRY 17
46 #define TOTAL_MAP_ENTRIES (MAX_MAP_ENTRY*RIO_SLOTS)
47 #define MAX_NAME_LEN 32
48
49 struct Map
50 {
51         uint    HostUniqueNum;          /* Supporting hosts unique number */
52         uint    RtaUniqueNum;           /* Unique number */
53         /*
54         ** The next two IDs must be swapped on big-endian architectures
55         ** when using a v2.04 /etc/rio/config with a v3.00 driver (when
56         ** upgrading for example).
57         */
58         ushort  ID;                     /* ID used in the subnet */
59         ushort  ID2;                    /* ID of 2nd block of 8 for 16 port */
60         ulong   Flags;                  /* Booted, ID Given, Disconnected */
61         ulong   SysPort;                /* First tty mapped to this port */
62         struct Top   Topology[LINKS_PER_UNIT];  /* ID connected to each link */
63         char    Name[MAX_NAME_LEN];        /* Cute name by which RTA is known */
64 };
65
66 /*
67 ** Flag values:
68 */
69 #define RTA_BOOTED              0x00000001
70 #define RTA_NEWBOOT             0x00000010
71 #define MSG_DONE                0x00000020
72 #define RTA_INTERCONNECT        0x00000040
73 #define RTA16_SECOND_SLOT       0x00000080
74 #define BEEN_HERE               0x00000100
75 #define SLOT_TENTATIVE          0x40000000
76 #define SLOT_IN_USE             0x80000000
77
78 /*
79 ** HostUniqueNum is the unique number from the host card that this RTA
80 ** is to be connected to.
81 ** RtaUniqueNum is the unique number of the RTA concerned. It will be ZERO
82 ** if the slot in the table is unused. If it is the same as the HostUniqueNum
83 ** then this slot represents a host card.
84 ** Flags contains current boot/route state info
85 ** SysPort is a value in the range 0-504, being the number of the first tty
86 ** on this RTA. Each RTA supports 8 ports. The SysPort value must be modulo 8.
87 ** SysPort 0-127 correspond to /dev/ttyr001 to /dev/ttyr128, with minor
88 ** numbers 0-127. SysPort 128-255 correspond to /dev/ttyr129 to /dev/ttyr256,
89 ** again with minor numbers 0-127, and so on for SysPorts 256-383 and 384-511
90 ** ID will be in the range 0-16 for a `known' RTA. ID will be 0xFFFF for an
91 ** unused slot/unknown ID etc.
92 ** The Topology array contains the ID of the unit connected to each of the
93 ** four links on this unit. The entry will be 0xFFFF if NOTHING is connected
94 ** to the link, or will be 0xFF00 if an UNKNOWN unit is connected to the link.
95 ** The Name field is a null-terminated string, upto 31 characters, containing
96 ** the 'cute' name that the sysadmin/users know the RTA by. It is permissible
97 ** for this string to contain any character in the range \040 to \176 inclusive.
98 ** In particular, ctrl sequences and DEL (0x7F, \177) are not allowed. The
99 ** special character '%' IS allowable, and needs no special action.
100 **
101 */
102
103 #endif