2 * This file is subject to the terms and conditions of the GNU General Public
3 * License. See the file "COPYING" in the main directory of this archive
6 * Derived from IRIX <sys/SN/klconfig.h>.
8 * Copyright (C) 1992 - 1997, 1999, 2000 Silicon Graphics, Inc.
9 * Copyright (C) 1999, 2000 by Ralf Baechle
11 #ifndef _ASM_SN_KLCONFIG_H
12 #define _ASM_SN_KLCONFIG_H
15 * The KLCONFIG structures store info about the various BOARDs found
16 * during Hardware Discovery. In addition, it stores info about the
17 * components found on the BOARDs.
22 * Certain assembly language routines (notably xxxxx.s) in the IP27PROM
23 * will depend on the format of the data structures in this file. In
24 * most cases, rearranging the fields can seriously break things.
25 * Adding fields in the beginning or middle can also break things.
26 * Add fields if necessary, to the end of a struct in such a way
27 * that offsets of existing fields do not change.
30 #include <linux/config.h>
31 #include <linux/types.h>
32 #include <asm/sn/types.h>
33 #if defined(CONFIG_SGI_IP27)
34 #include <asm/sn/sn0/addrs.h>
35 //#include <sys/SN/router.h>
36 // XXX Stolen from <sys/SN/router.h>:
37 #define MAX_ROUTER_PORTS (6) /* Max. number of ports on a router */
38 #include <asm/sn/sn0/sn0_fru.h>
39 //#include <sys/graph.h>
40 //#include <sys/xtalk/xbow.h>
41 #elif defined(CONFIG_SGI_IP35)
42 #include <asm/sn/sn1/addrs.h>
43 #include <sys/sn/router.h>
44 #include <sys/graph.h>
45 #include <asm/xtalk/xbow.h>
46 #endif /* !CONFIG_SGI_IP27 && !CONFIG_SGI_IP35 */
47 #if defined(CONFIG_SGI_IP27) || defined(CONFIG_SGI_IP35)
48 #include <asm/sn/agent.h>
49 #include <asm/arc/types.h>
50 #include <asm/arc/hinv.h>
51 #if defined(CONFIG_SGI_IO) || defined(CONFIG_SGI_IP35)
52 // The hack file has to be before vector and after sn0_fru....
54 #include <asm/sn/vector.h>
55 #include <asm/xtalk/xtalk.h>
56 #endif /* CONFIG_SGI_IO || CONFIG_SGI_IP35 */
57 #endif /* CONFIG_SGI_IP27 || CONFIG_SGI_IP35 */
59 #define KLCFGINFO_MAGIC 0xbeedbabe
62 typedef u64 klconf_off_t;
64 typedef s32 klconf_off_t;
68 * Some IMPORTANT OFFSETS. These are the offsets on all NODES.
72 #define ARCSSPB_OFF 0x1000 /* shift it to sys/arcs/spb.h */
77 #define MAX_MODULE_ID 255
78 #define SIZE_PAD 4096 /* 4k padding for structures */
80 * 1 NODE brd, 2 Router brd (1 8p, 1 meta), 6 Widgets,
81 * 2 Midplanes assuming no pci card cages
83 #define MAX_SLOTS_PER_NODE (1 + 2 + 6 + 2)
85 /* XXX if each node is guranteed to have some memory */
87 #define MAX_PCI_DEVS 8
89 /* lboard_t->brd_flags fields */
90 /* All bits in this field are currently used. Try the pad fields if
91 you need more flag bits */
93 #define ENABLE_BOARD 0x01
94 #define FAILED_BOARD 0x02
95 #define DUPLICATE_BOARD 0x04 /* Boards like midplanes/routers which
96 are discovered twice. Use one of them */
97 #define VISITED_BOARD 0x08 /* Used for compact hub numbering. */
98 #define LOCAL_MASTER_IO6 0x10 /* master io6 for that node */
99 #define GLOBAL_MASTER_IO6 0x20
100 #define THIRD_NIC_PRESENT 0x40 /* for future use */
101 #define SECOND_NIC_PRESENT 0x80 /* addons like MIO are present */
103 /* klinfo->flags fields */
105 #define KLINFO_ENABLE 0x01 /* This component is enabled */
106 #define KLINFO_FAILED 0x02 /* This component failed */
107 #define KLINFO_DEVICE 0x04 /* This component is a device */
108 #define KLINFO_VISITED 0x08 /* This component has been visited */
109 #define KLINFO_CONTROLLER 0x10 /* This component is a device controller */
110 #define KLINFO_INSTALL 0x20 /* Install a driver */
111 #define KLINFO_HEADLESS 0x40 /* Headless (or hubless) component */
112 #define IS_CONSOLE_IOC3(i) ((((klinfo_t *)i)->flags) & KLINFO_INSTALL)
114 #define GB2 0x80000000
116 #define MAX_RSV_PTRS 32
118 /* Structures to manage various data storage areas */
119 /* The numbers must be contiguous since the array index i
120 is used in the code to allocate various areas.
123 #define BOARD_STRUCT 0
124 #define COMPONENT_STRUCT 1
125 #define ERRINFO_STRUCT 2
126 #define KLMALLOC_TYPE_MAX (ERRINFO_STRUCT + 1)
127 #define DEVICE_STRUCT 3
130 typedef struct console_s {
131 #if defined(CONFIG_SGI_IO) /* FIXME */
132 __psunsigned_t uart_base;
133 __psunsigned_t config_base;
134 __psunsigned_t memory_base;
136 unsigned long uart_base;
137 unsigned long config_base;
138 unsigned long memory_base;
149 typedef struct klc_malloc_hdr {
150 klconf_off_t km_base;
151 klconf_off_t km_limit;
152 klconf_off_t km_current;
155 /* Functions/macros needed to use this structure */
157 typedef struct kl_config_hdr {
158 u64 ch_magic; /* set this to KLCFGINFO_MAGIC */
159 u32 ch_version; /* structure version number */
160 klconf_off_t ch_malloc_hdr_off; /* offset of ch_malloc_hdr */
161 klconf_off_t ch_cons_off; /* offset of ch_cons */
162 klconf_off_t ch_board_info; /* the link list of boards */
163 console_t ch_cons_info; /* address info of the console */
164 klc_malloc_hdr_t ch_malloc_hdr[KLMALLOC_TYPE_MAX];
165 confidence_t ch_sw_belief; /* confidence that software is bad*/
166 confidence_t ch_sn0net_belief; /* confidence that sn0net is bad */
170 #define KL_CONFIG_HDR(_nasid) ((kl_config_hdr_t *)(KLCONFIG_ADDR(_nasid)))
172 #define KL_CONFIG_MALLOC_HDR(_nasid) \
173 (KL_CONFIG_HDR(_nasid)->ch_malloc_hdr)
175 #define KL_CONFIG_INFO_OFFSET(_nasid) \
176 (KL_CONFIG_HDR(_nasid)->ch_board_info)
177 #define KL_CONFIG_INFO_SET_OFFSET(_nasid, _off) \
178 (KL_CONFIG_HDR(_nasid)->ch_board_info = (_off))
180 #define KL_CONFIG_INFO(_nasid) \
181 (lboard_t *)((KL_CONFIG_HDR(_nasid)->ch_board_info) ? \
182 NODE_OFFSET_TO_K1((_nasid), KL_CONFIG_HDR(_nasid)->ch_board_info) : \
184 #define KL_CONFIG_MAGIC(_nasid) (KL_CONFIG_HDR(_nasid)->ch_magic)
186 #define KL_CONFIG_CHECK_MAGIC(_nasid) \
187 (KL_CONFIG_HDR(_nasid)->ch_magic == KLCFGINFO_MAGIC)
189 #define KL_CONFIG_HDR_INIT_MAGIC(_nasid) \
190 (KL_CONFIG_HDR(_nasid)->ch_magic = KLCFGINFO_MAGIC)
192 /* --- New Macros for the changed kl_config_hdr_t structure --- */
194 #if defined(CONFIG_SGI_IO)
195 #define PTR_CH_MALLOC_HDR(_k) ((klc_malloc_hdr_t *)\
196 ((__psunsigned_t)_k + (_k->ch_malloc_hdr_off)))
198 #define PTR_CH_MALLOC_HDR(_k) ((klc_malloc_hdr_t *)\
199 (unsigned long)_k + (_k->ch_malloc_hdr_off)))
202 #define KL_CONFIG_CH_MALLOC_HDR(_n) PTR_CH_MALLOC_HDR(KL_CONFIG_HDR(_n))
204 #if defined(CONFIG_SGI_IO)
205 #define PTR_CH_CONS_INFO(_k) ((console_t *)\
206 ((__psunsigned_t)_k + (_k->ch_cons_off)))
208 #define PTR_CH_CONS_INFO(_k) ((console_t *)\
209 ((unsigned long)_k + (_k->ch_cons_off)))
212 #define KL_CONFIG_CH_CONS_INFO(_n) PTR_CH_CONS_INFO(KL_CONFIG_HDR(_n))
214 /* ------------------------------------------------------------- */
216 #define KL_CONFIG_INFO_START(_nasid) \
217 (klconf_off_t)(KLCONFIG_OFFSET(_nasid) + sizeof(kl_config_hdr_t))
219 #define KL_CONFIG_BOARD_NASID(_brd) ((_brd)->brd_nasid)
220 #define KL_CONFIG_BOARD_SET_NEXT(_brd, _off) ((_brd)->brd_next = (_off))
222 #define KL_CONFIG_DUPLICATE_BOARD(_brd) ((_brd)->brd_flags & DUPLICATE_BOARD)
224 #define XBOW_PORT_TYPE_HUB(_xbowp, _link) \
225 ((_xbowp)->xbow_port_info[(_link) - BASE_XBOW_PORT].port_flag & XBOW_PORT_HUB)
226 #define XBOW_PORT_TYPE_IO(_xbowp, _link) \
227 ((_xbowp)->xbow_port_info[(_link) - BASE_XBOW_PORT].port_flag & XBOW_PORT_IO)
229 #define XBOW_PORT_IS_ENABLED(_xbowp, _link) \
230 ((_xbowp)->xbow_port_info[(_link) - BASE_XBOW_PORT].port_flag & XBOW_PORT_ENABLE)
231 #define XBOW_PORT_NASID(_xbowp, _link) \
232 ((_xbowp)->xbow_port_info[(_link) - BASE_XBOW_PORT].port_nasid)
234 #define XBOW_PORT_IO 0x1
235 #define XBOW_PORT_HUB 0x2
236 #define XBOW_PORT_ENABLE 0x4
238 #define SN0_PORT_FENCE_SHFT 0
239 #define SN0_PORT_FENCE_MASK (1 << SN0_PORT_FENCE_SHFT)
242 * The KLCONFIG area is organized as a LINKED LIST of BOARDs. A BOARD
243 * can be either 'LOCAL' or 'REMOTE'. LOCAL means it is attached to
244 * the LOCAL/current NODE. REMOTE means it is attached to a different
245 * node.(TBD - Need a way to treat ROUTER boards.)
247 * There are 2 different structures to represent these boards -
248 * lboard - Local board, rboard - remote board. These 2 structures
249 * can be arbitrarily mixed in the LINKED LIST of BOARDs. (Refer
250 * Figure below). The first byte of the rboard or lboard structure
251 * is used to find out its type - no unions are used.
252 * If it is a lboard, then the config info of this board will be found
253 * on the local node. (LOCAL NODE BASE + offset value gives pointer to
255 * If it is a rboard, the local structure contains the node number
256 * and the offset of the beginning of the LINKED LIST on the remote node.
257 * The details of the hardware on a remote node can be built locally,
258 * if required, by reading the LINKED LIST on the remote node and
259 * ignoring all the rboards on that node.
261 * The local node uses the REMOTE NODE NUMBER + OFFSET to point to the
262 * First board info on the remote node. The remote node list is
263 * traversed as the local list, using the REMOTE BASE ADDRESS and not
264 * the local base address and ignoring all rboard values.
269 +------------+ +------------+ +------------+ +------------+
270 | lboard | +-->| lboard | +-->| rboard | +-->| lboard |
271 +------------+ | +------------+ | +------------+ | +------------+
272 | board info | | | board info | | |errinfo,bptr| | | board info |
273 +------------+ | +------------+ | +------------+ | +------------+
274 | offset |--+ | offset |--+ | offset |--+ |offset=NULL |
275 +------------+ +------------+ +------------+ +------------+
280 +------------+ +--------------------------------+
281 | compt 1 |------>| type, rev, diaginfo, size ... | (CPU)
282 +------------+ +--------------------------------+
284 +------------+ | +--------------------------------+
285 | ... | +--->| type, rev, diaginfo, size ... | (MEM_BANK)
286 +------------+ +--------------------------------+
288 +------------+ | +--------------------------------+
289 +--->|r/l brd errinfo,compt err flags |
290 +--------------------------------+
293 * Each BOARD consists of COMPONENTs and the BOARD structure has
294 * pointers (offsets) to its COMPONENT structure.
295 * The COMPONENT structure has version info, size and speed info, revision,
296 * error info and the NIC info. This structure can accommodate any
297 * BOARD with arbitrary COMPONENT composition.
299 * The ERRORINFO part of each BOARD has error information
300 * that describes errors about the BOARD itself. It also has flags to
301 * indicate the COMPONENT(s) on the board that have errors. The error
302 * information specific to the COMPONENT is present in the respective
303 * COMPONENT structure.
305 * The ERRORINFO structure is also treated like a COMPONENT, ie. the
306 * BOARD has pointers(offset) to the ERRORINFO structure. The rboard
307 * structure also has a pointer to the ERRORINFO structure. This is
308 * the place to store ERRORINFO about a REMOTE NODE, if the HUB on
309 * that NODE is not working or if the REMOTE MEMORY is BAD. In cases where
310 * only the CPU of the REMOTE NODE is disabled, the ERRORINFO pointer can
311 * be a NODE NUMBER, REMOTE OFFSET combination, pointing to error info
312 * which is present on the REMOTE NODE.(TBD)
313 * REMOTE ERRINFO can be stored on any of the nearest nodes
314 * or on all the nearest nodes.(TBD)
315 * Like BOARD structures, REMOTE ERRINFO structures can be built locally
316 * using the rboard errinfo pointer.
318 * In order to get useful information from this Data organization, a set of
319 * interface routines are provided (TBD). The important thing to remember while
320 * manipulating the structures, is that, the NODE number information should
321 * be used. If the NODE is non-zero (remote) then each offset should
322 * be added to the REMOTE BASE ADDR else it should be added to the LOCAL BASE ADDR.
323 * This includes offsets for BOARDS, COMPONENTS and ERRORINFO.
325 * Note that these structures do not provide much info about connectivity.
326 * That info will be part of HWGRAPH, which is an extension of the cfg_t
327 * data structure. (ref IP27prom/cfg.h) It has to be extended to include
328 * the IO part of the Network(TBD).
330 * The data structures below define the above concepts.
334 * Values for CPU types
336 #define KL_CPU_R4000 0x1 /* Standard R4000 */
337 #define KL_CPU_TFP 0x2 /* TFP processor */
338 #define KL_CPU_R10000 0x3 /* R10000 (T5) */
339 #define KL_CPU_NONE (-1) /* no cpu present in slot */
345 #define KLCLASS_MASK 0xf0
346 #define KLCLASS_NONE 0x00
347 #define KLCLASS_NODE 0x10 /* CPU, Memory and HUB board */
348 #define KLCLASS_CPU KLCLASS_NODE
349 #define KLCLASS_IO 0x20 /* BaseIO, 4 ch SCSI, ethernet, FDDI
350 and the non-graphics widget boards */
351 #define KLCLASS_ROUTER 0x30 /* Router board */
352 #define KLCLASS_MIDPLANE 0x40 /* We need to treat this as a board
353 so that we can record error info */
354 #define KLCLASS_GFX 0x50 /* graphics boards */
356 #define KLCLASS_PSEUDO_GFX 0x60 /* HDTV type cards that use a gfx
357 * hw ifc to xtalk and are not gfx
358 * class for sw purposes */
360 #define KLCLASS_MAX 7 /* Bump this if a new CLASS is added */
361 #define KLTYPE_MAX 10 /* Bump this if a new CLASS is added */
363 #define KLCLASS_UNKNOWN 0xf0
365 #define KLCLASS(_x) ((_x) & KLCLASS_MASK)
371 #define KLTYPE_MASK 0x0f
372 #define KLTYPE_NONE 0x00
373 #define KLTYPE_EMPTY 0x00
375 #define KLTYPE_WEIRDCPU (KLCLASS_CPU | 0x0)
376 #define KLTYPE_IP27 (KLCLASS_CPU | 0x1) /* 2 CPUs(R10K) per board */
378 #define KLTYPE_WEIRDIO (KLCLASS_IO | 0x0)
379 #define KLTYPE_BASEIO (KLCLASS_IO | 0x1) /* IOC3, SuperIO, Bridge, SCSI */
380 #define KLTYPE_IO6 KLTYPE_BASEIO /* Additional name */
381 #define KLTYPE_4CHSCSI (KLCLASS_IO | 0x2)
382 #define KLTYPE_MSCSI KLTYPE_4CHSCSI /* Additional name */
383 #define KLTYPE_ETHERNET (KLCLASS_IO | 0x3)
384 #define KLTYPE_MENET KLTYPE_ETHERNET /* Additional name */
385 #define KLTYPE_FDDI (KLCLASS_IO | 0x4)
386 #define KLTYPE_UNUSED (KLCLASS_IO | 0x5) /* XXX UNUSED */
387 #define KLTYPE_HAROLD (KLCLASS_IO | 0x6) /* PCI SHOE BOX */
388 #define KLTYPE_PCI KLTYPE_HAROLD
389 #define KLTYPE_VME (KLCLASS_IO | 0x7) /* Any 3rd party VME card */
390 #define KLTYPE_MIO (KLCLASS_IO | 0x8)
391 #define KLTYPE_FC (KLCLASS_IO | 0x9)
392 #define KLTYPE_LINC (KLCLASS_IO | 0xA)
393 #define KLTYPE_TPU (KLCLASS_IO | 0xB) /* Tensor Processing Unit */
394 #define KLTYPE_GSN_A (KLCLASS_IO | 0xC) /* Main GSN board */
395 #define KLTYPE_GSN_B (KLCLASS_IO | 0xD) /* Auxiliary GSN board */
397 #define KLTYPE_GFX (KLCLASS_GFX | 0x0) /* unknown graphics type */
398 #define KLTYPE_GFX_KONA (KLCLASS_GFX | 0x1) /* KONA graphics on IP27 */
399 #define KLTYPE_GFX_MGRA (KLCLASS_GFX | 0x3) /* MGRAS graphics on IP27 */
401 #define KLTYPE_WEIRDROUTER (KLCLASS_ROUTER | 0x0)
402 #define KLTYPE_ROUTER (KLCLASS_ROUTER | 0x1)
403 #define KLTYPE_ROUTER2 KLTYPE_ROUTER /* Obsolete! */
404 #define KLTYPE_NULL_ROUTER (KLCLASS_ROUTER | 0x2)
405 #define KLTYPE_META_ROUTER (KLCLASS_ROUTER | 0x3)
407 #define KLTYPE_WEIRDMIDPLANE (KLCLASS_MIDPLANE | 0x0)
408 #define KLTYPE_MIDPLANE8 (KLCLASS_MIDPLANE | 0x1) /* 8 slot backplane */
409 #define KLTYPE_MIDPLANE KLTYPE_MIDPLANE8
410 #define KLTYPE_PBRICK_XBOW (KLCLASS_MIDPLANE | 0x2)
412 #define KLTYPE_IOBRICK (KLCLASS_IOBRICK | 0x0)
413 #define KLTYPE_IBRICK (KLCLASS_IOBRICK | 0x1)
414 #define KLTYPE_PBRICK (KLCLASS_IOBRICK | 0x2)
415 #define KLTYPE_XBRICK (KLCLASS_IOBRICK | 0x3)
417 #define KLTYPE_PBRICK_BRIDGE KLTYPE_PBRICK
419 /* The value of type should be more than 8 so that hinv prints
420 * out the board name from the NIC string. For values less than
421 * 8 the name of the board needs to be hard coded in a few places.
422 * When bringup started nic names had not standardized and so we
423 * had to hard code. (For people interested in history.)
425 #define KLTYPE_XTHD (KLCLASS_PSEUDO_GFX | 0x9)
427 #define KLTYPE_UNKNOWN (KLCLASS_UNKNOWN | 0xf)
429 #define KLTYPE(_x) ((_x) & KLTYPE_MASK)
430 #define IS_MIO_PRESENT(l) ((l->brd_type == KLTYPE_BASEIO) && \
431 (l->brd_flags & SECOND_NIC_PRESENT))
432 #define IS_MIO_IOC3(l,n) (IS_MIO_PRESENT(l) && (n > 2))
438 #define MAX_COMPTS_PER_BRD 24
440 #define LOCAL_BOARD 1
441 #define REMOTE_BOARD 2
443 #define LBOARD_STRUCT_VERSION 2
445 typedef struct lboard_s {
446 klconf_off_t brd_next; /* Next BOARD */
447 unsigned char struct_type; /* type of structure, local or remote */
448 unsigned char brd_type; /* type+class */
449 unsigned char brd_sversion; /* version of this structure */
450 unsigned char brd_brevision; /* board revision */
451 unsigned char brd_promver; /* board prom version, if any */
452 unsigned char brd_flags; /* Enabled, Disabled etc */
453 unsigned char brd_slot; /* slot number */
454 unsigned short brd_debugsw; /* Debug switches */
455 moduleid_t brd_module; /* module to which it belongs */
456 partid_t brd_partition; /* Partition number */
457 unsigned short brd_diagval; /* diagnostic value */
458 unsigned short brd_diagparm; /* diagnostic parameter */
459 unsigned char brd_inventory; /* inventory history */
460 unsigned char brd_numcompts; /* Number of components */
461 nic_t brd_nic; /* Number in CAN */
462 nasid_t brd_nasid; /* passed parameter */
463 klconf_off_t brd_compts[MAX_COMPTS_PER_BRD]; /* pointers to COMPONENTS */
464 klconf_off_t brd_errinfo; /* Board's error information */
465 struct lboard_s *brd_parent; /* Logical parent for this brd */
466 vertex_hdl_t brd_graph_link; /* vertex hdl to connect extern compts */
467 confidence_t brd_confidence; /* confidence that the board is bad */
468 nasid_t brd_owner; /* who owns this board */
469 unsigned char brd_nic_flags; /* To handle 8 more NICs */
475 * Make sure we pass back the calias space address for local boards.
476 * klconfig board traversal and error structure extraction defines.
479 #define BOARD_SLOT(_brd) ((_brd)->brd_slot)
481 #define KLCF_CLASS(_brd) KLCLASS((_brd)->brd_type)
482 #define KLCF_TYPE(_brd) KLTYPE((_brd)->brd_type)
483 #define KLCF_REMOTE(_brd) (((_brd)->struct_type & LOCAL_BOARD) ? 0 : 1)
484 #define KLCF_NUM_COMPS(_brd) ((_brd)->brd_numcompts)
485 #define KLCF_MODULE_ID(_brd) ((_brd)->brd_module)
489 #define KLCF_NEXT(_brd) ((_brd)->brd_next ? (lboard_t *)((_brd)->brd_next): NULL)
490 #define KLCF_COMP(_brd, _ndx) (klinfo_t *)((_brd)->brd_compts[(_ndx)])
491 #define KLCF_COMP_ERROR(_brd, _comp) (_brd = _brd , (_comp)->errinfo)
495 #define KLCF_NEXT(_brd) \
496 ((_brd)->brd_next ? \
497 (lboard_t *)(NODE_OFFSET_TO_K1(NASID_GET(_brd), (_brd)->brd_next)):\
499 #define KLCF_COMP(_brd, _ndx) \
500 (klinfo_t *)(NODE_OFFSET_TO_K1(NASID_GET(_brd), \
501 (_brd)->brd_compts[(_ndx)]))
503 #define KLCF_COMP_ERROR(_brd, _comp) \
504 (NODE_OFFSET_TO_K1(NASID_GET(_brd), (_comp)->errinfo))
508 #define KLCF_COMP_TYPE(_comp) ((_comp)->struct_type)
509 #define KLCF_BRIDGE_W_ID(_comp) ((_comp)->physid) /* Widget ID */
514 * Generic info structure. This stores common info about a
518 typedef struct klinfo_s { /* Generic info */
519 unsigned char struct_type; /* type of this structure */
520 unsigned char struct_version; /* version of this structure */
521 unsigned char flags; /* Enabled, disabled etc */
522 unsigned char revision; /* component revision */
523 unsigned short diagval; /* result of diagnostics */
524 unsigned short diagparm; /* diagnostic parameter */
525 unsigned char inventory; /* previous inventory status */
526 nic_t nic; /* MUst be aligned properly */
527 unsigned char physid; /* physical id of component */
528 unsigned int virtid; /* virtual id as seen by system */
529 unsigned char widid; /* Widget id - if applicable */
530 nasid_t nasid; /* node number - from parent */
531 char pad1; /* pad out structure. */
532 char pad2; /* pad out structure. */
533 COMPONENT *arcs_compt; /* ptr to the arcs struct for ease*/
534 klconf_off_t errinfo; /* component specific errors */
535 unsigned short pad3; /* pci fields have moved over to */
536 unsigned short pad4; /* klbri_t */
539 #define KLCONFIG_INFO_ENABLED(_i) ((_i)->flags & KLINFO_ENABLE)
541 * Component structures.
542 * Following are the currently identified components:
543 * CPU, HUB, MEM_BANK,
544 * XBOW(consists of 16 WIDGETs, each of which can be HUB or GRAPHICS or BRIDGE)
545 * BRIDGE, IOC3, SuperIO, SCSI, FDDI
549 #define KLSTRUCT_UNKNOWN 0
550 #define KLSTRUCT_CPU 1
551 #define KLSTRUCT_HUB 2
552 #define KLSTRUCT_MEMBNK 3
553 #define KLSTRUCT_XBOW 4
554 #define KLSTRUCT_BRI 5
555 #define KLSTRUCT_IOC3 6
556 #define KLSTRUCT_PCI 7
557 #define KLSTRUCT_VME 8
558 #define KLSTRUCT_ROU 9
559 #define KLSTRUCT_GFX 10
560 #define KLSTRUCT_SCSI 11
561 #define KLSTRUCT_FDDI 12
562 #define KLSTRUCT_MIO 13
563 #define KLSTRUCT_DISK 14
564 #define KLSTRUCT_TAPE 15
565 #define KLSTRUCT_CDROM 16
566 #define KLSTRUCT_HUB_UART 17
567 #define KLSTRUCT_IOC3ENET 18
568 #define KLSTRUCT_IOC3UART 19
569 #define KLSTRUCT_UNUSED 20 /* XXX UNUSED */
570 #define KLSTRUCT_IOC3PCKM 21
571 #define KLSTRUCT_RAD 22
572 #define KLSTRUCT_HUB_TTY 23
573 #define KLSTRUCT_IOC3_TTY 24
575 /* Early Access IO proms are compatible
576 only with KLSTRUCT values upto 24. */
578 #define KLSTRUCT_FIBERCHANNEL 25
579 #define KLSTRUCT_MOD_SERIAL_NUM 26
580 #define KLSTRUCT_IOC3MS 27
581 #define KLSTRUCT_TPU 28
582 #define KLSTRUCT_GSN_A 29
583 #define KLSTRUCT_GSN_B 30
584 #define KLSTRUCT_XTHD 31
587 * These are the indices of various components within a lboard structure.
590 #define IP27_CPU0_INDEX 0
591 #define IP27_CPU1_INDEX 1
592 #define IP27_HUB_INDEX 2
593 #define IP27_MEM_INDEX 3
595 #define BASEIO_BRIDGE_INDEX 0
596 #define BASEIO_IOC3_INDEX 1
597 #define BASEIO_SCSI1_INDEX 2
598 #define BASEIO_SCSI2_INDEX 3
600 #define MIDPLANE_XBOW_INDEX 0
601 #define ROUTER_COMPONENT_INDEX 0
603 #define CH4SCSI_BRIDGE_INDEX 0
605 /* Info holders for various hardware components */
613 typedef u64 *graphics_t;
614 typedef u64 *router_t;
617 * The port info in ip27_cfg area translates to a lboart_t in the
618 * KLCONFIG area. But since KLCONFIG does not use pointers, lboart_t
619 * is stored in terms of a nasid and a offset from start of KLCONFIG
620 * area on that nasid.
622 typedef struct klport_s {
624 unsigned char port_flag;
625 klconf_off_t port_offset;
630 * This is very similar to the klport_s but instead of having a componant
631 * offset it has a board offset.
633 typedef struct klxbow_port_s {
635 unsigned char port_flag;
636 klconf_off_t board_offset;
640 typedef struct klcpu_s { /* CPU */
642 unsigned short cpu_prid; /* Processor PRID value */
643 unsigned short cpu_fpirr; /* FPU IRR value */
644 unsigned short cpu_speed; /* Speed in MHZ */
645 unsigned short cpu_scachesz; /* secondary cache size in MB */
646 unsigned short cpu_scachespeed;/* secondary cache speed in MHz */
649 #define CPU_STRUCT_VERSION 2
651 typedef struct klhub_s { /* HUB */
653 uint hub_flags; /* PCFG_HUB_xxx flags */
654 klport_t hub_port; /* hub is connected to this */
655 nic_t hub_box_nic; /* nic of containing box */
656 klconf_off_t hub_mfg_nic; /* MFG NIC string */
657 u64 hub_speed; /* Speed of hub in HZ */
660 typedef struct klhub_uart_s { /* HUB */
661 klinfo_t hubuart_info;
662 uint hubuart_flags; /* PCFG_HUB_xxx flags */
663 nic_t hubuart_box_nic; /* nic of containing box */
666 #define MEMORY_STRUCT_VERSION 2
668 typedef struct klmembnk_s { /* MEMORY BANK */
669 klinfo_t membnk_info;
670 short membnk_memsz; /* Total memory in megabytes */
671 short membnk_dimm_select; /* bank to physical addr mapping*/
672 short membnk_bnksz[MD_MEM_BANKS]; /* Memory bank sizes */
676 #define KLCONFIG_MEMBNK_SIZE(_info, _bank) \
677 ((_info)->membnk_bnksz[(_bank)])
680 #define MEMBNK_PREMIUM 1
681 #define KLCONFIG_MEMBNK_PREMIUM(_info, _bank) \
682 ((_info)->membnk_attr & (MEMBNK_PREMIUM << (_bank)))
684 #define MAX_SERIAL_NUM_SIZE 10
686 typedef struct klmod_serial_num_s {
689 char snum_str[MAX_SERIAL_NUM_SIZE];
690 unsigned long long snum_int;
692 } klmod_serial_num_t;
694 /* Macros needed to access serial number structure in lboard_t.
695 Hard coded values are necessary since we cannot treat
696 serial number struct as a component without losing compatibility
697 between prom versions. */
699 #define GET_SNUM_COMP(_l) ((klmod_serial_num_t *)\
700 KLCF_COMP(_l, _l->brd_numcompts))
702 #define MAX_XBOW_LINKS 16
704 typedef struct klxbow_s { /* XBOW */
706 klport_t xbow_port_info[MAX_XBOW_LINKS] ; /* Module number */
707 int xbow_master_hub_link;
708 /* type of brd connected+component struct ptr+flags */
711 #define MAX_PCI_SLOTS 8
713 typedef struct klpci_device_s {
714 s32 pci_device_id; /* 32 bits of vendor/device ID. */
715 s32 pci_device_pad; /* 32 bits of padding. */
718 #define BRIDGE_STRUCT_VERSION 2
720 typedef struct klbri_s { /* BRIDGE */
722 unsigned char bri_eprominfo ; /* IO6prom connected to bridge */
723 unsigned char bri_bustype ; /* PCI/VME BUS bridge/GIO */
724 pci_t pci_specific ; /* PCI Board config info */
725 klpci_device_t bri_devices[MAX_PCI_DEVS] ; /* PCI IDs */
726 klconf_off_t bri_mfg_nic ;
729 #define MAX_IOC3_TTY 2
731 typedef struct klioc3_s { /* IOC3 */
733 unsigned char ioc3_ssram ; /* Info about ssram */
734 unsigned char ioc3_nvram ; /* Info about nvram */
735 klinfo_t ioc3_superio ; /* Info about superio */
736 klconf_off_t ioc3_tty_off ;
738 klconf_off_t ioc3_enet_off ;
739 klconf_off_t ioc3_kbd_off ;
742 #define MAX_VME_SLOTS 8
744 typedef struct klvmeb_s { /* VME BRIDGE - PCI CTLR */
746 vmeb_t vmeb_specific ;
747 klconf_off_t vmeb_brdinfo[MAX_VME_SLOTS] ; /* VME Board config info */
750 typedef struct klvmed_s { /* VME DEVICE - VME BOARD */
752 vmed_t vmed_specific ;
753 klconf_off_t vmed_brdinfo[MAX_VME_SLOTS] ; /* VME Board config info */
756 #define ROUTER_VECTOR_VERS 2
758 /* XXX - Don't we need the number of ports here?!? */
759 typedef struct klrou_s { /* ROUTER */
761 uint rou_flags ; /* PCFG_ROUTER_xxx flags */
762 nic_t rou_box_nic ; /* nic of the containing module */
763 klport_t rou_port[MAX_ROUTER_PORTS + 1] ; /* array index 1 to 6 */
764 klconf_off_t rou_mfg_nic ; /* MFG NIC string */
765 u64 rou_vector; /* vector from master node */
769 * Graphics Controller/Device
771 * (IP27/IO6) Prom versions 6.13 (and 6.5.1 kernels) and earlier
772 * used a couple different structures to store graphics information.
773 * For compatibility reasons, the newer data structure preserves some
774 * of the layout so that fields that are used in the old versions remain
775 * in the same place (with the same info). Determination of what version
776 * of this structure we have is done by checking the cookie field.
778 #define KLGFX_COOKIE 0x0c0de000
780 typedef struct klgfx_s { /* GRAPHICS Device */
782 klconf_off_t old_gndevs; /* for compatibility with older proms */
783 klconf_off_t old_gdoff0; /* for compatibility with older proms */
784 uint cookie; /* for compatibility with older proms */
786 struct klgfx_s *gfx_next_pipe;
787 graphics_t gfx_specific;
788 klconf_off_t pad0; /* for compatibility with older proms */
789 klconf_off_t gfx_mfg_nic;
792 typedef struct klxthd_s {
794 klconf_off_t xthd_mfg_nic ; /* MFG NIC string */
797 typedef struct kltpu_s { /* TPU board */
799 klconf_off_t tpu_mfg_nic ; /* MFG NIC string */
802 typedef struct klgsn_s { /* GSN board */
804 klconf_off_t gsn_mfg_nic ; /* MFG NIC string */
807 #define MAX_SCSI_DEVS 16
810 * NOTE: THis is the max sized kl* structure and is used in klmalloc.c
811 * to allocate space of type COMPONENT. Make sure that if the size of
812 * any other component struct becomes more than this, then redefine
813 * that as the size to be klmalloced.
816 typedef struct klscsi_s { /* SCSI Controller */
818 scsi_t scsi_specific ;
819 unsigned char scsi_numdevs ;
820 klconf_off_t scsi_devinfo[MAX_SCSI_DEVS] ;
823 typedef struct klscdev_s { /* SCSI device */
824 klinfo_t scdev_info ;
825 struct scsidisk_data *scdev_cfg ; /* driver fills up this */
828 typedef struct klttydev_s { /* TTY device */
829 klinfo_t ttydev_info ;
830 struct terminal_data *ttydev_cfg ; /* driver fills up this */
833 typedef struct klenetdev_s { /* ENET device */
834 klinfo_t enetdev_info ;
835 struct net_data *enetdev_cfg ; /* driver fills up this */
838 typedef struct klkbddev_s { /* KBD device */
839 klinfo_t kbddev_info ;
840 struct keyboard_data *kbddev_cfg ; /* driver fills up this */
843 typedef struct klmsdev_s { /* mouse device */
844 klinfo_t msdev_info ;
848 #define MAX_FDDI_DEVS 10 /* XXX Is this true */
850 typedef struct klfddi_s { /* FDDI */
852 fddi_t fddi_specific ;
853 klconf_off_t fddi_devinfo[MAX_FDDI_DEVS] ;
856 typedef struct klmio_s { /* MIO */
862 typedef union klcomp_s {
874 klscdev_t kc_scsi_dev;
877 klmod_serial_num_t kc_snum ;
880 typedef union kldev_s { /* for device structure allocation */
881 klscdev_t kc_scsi_dev ;
882 klttydev_t kc_tty_dev ;
883 klenetdev_t kc_enet_dev ;
884 klkbddev_t kc_kbd_dev ;
887 /* Data structure interface routines. TBD */
889 /* Include launch info in this file itself? TBD */
892 * TBD - Can the ARCS and device driver related info also be included in the
893 * KLCONFIG area. On the IO4PROM, prom device driver info is part of cfgnode_t
894 * structure, viz private to the IO4prom.
898 * TBD - Allocation issues.
900 * Do we need to Mark off sepatate heaps for lboard_t, rboard_t, component,
901 * errinfo and allocate from them, or have a single heap and allocate all
902 * structures from it. Debug is easier in the former method since we can
903 * dump all similar structs in one command, but there will be lots of holes,
904 * in memory and max limits are needed for number of structures.
905 * Another way to make it organized, is to have a union of all components
906 * and allocate a aligned chunk of memory greater than the biggest
915 #define BRI_PER_XBOW 6
916 #define PCI_PER_BRI 8
917 #define DEV_PER_PCI 16
920 /* Virtual dipswitch values (starting from switch "7"): */
922 #define VDS_NOGFX 0x8000 /* Don't enable gfx and autoboot */
923 #define VDS_NOMP 0x100 /* Don't start slave processors */
924 #define VDS_MANUMODE 0x80 /* Manufacturing mode */
925 #define VDS_NOARB 0x40 /* No bootmaster arbitration */
926 #define VDS_PODMODE 0x20 /* Go straight to POD mode */
927 #define VDS_NO_DIAGS 0x10 /* Don't run any diags after BM arb */
928 #define VDS_DEFAULTS 0x08 /* Use default environment values */
929 #define VDS_NOMEMCLEAR 0x04 /* Don't run mem cfg code */
930 #define VDS_2ND_IO4 0x02 /* Boot from the second IO4 */
931 #define VDS_DEBUG_PROM 0x01 /* Print PROM debugging messages */
933 /* external declarations of Linux kernel functions. */
935 extern lboard_t *find_lboard(lboard_t *start, unsigned char type);
936 extern klinfo_t *find_component(lboard_t *brd, klinfo_t *kli, unsigned char type);
937 extern klinfo_t *find_first_component(lboard_t *brd, unsigned char type);
938 extern klcpu_t *nasid_slice_to_cpuinfo(nasid_t, int);
939 extern lboard_t *find_lboard_class(lboard_t *start, unsigned char brd_class);
942 #if defined(CONFIG_SGI_IO)
943 extern xwidgetnum_t nodevertex_widgetnum_get(vertex_hdl_t node_vtx);
944 extern vertex_hdl_t nodevertex_xbow_peer_get(vertex_hdl_t node_vtx);
945 extern lboard_t *find_gfxpipe(int pipenum);
946 extern void setup_gfxpipe_link(vertex_hdl_t vhdl,int pipenum);
947 extern lboard_t *find_lboard_module_class(lboard_t *start, moduleid_t mod,
948 unsigned char brd_class);
949 extern lboard_t *find_nic_lboard(lboard_t *, nic_t);
950 extern lboard_t *find_nic_type_lboard(nasid_t, unsigned char, nic_t);
951 extern lboard_t *find_lboard_modslot(lboard_t *start, moduleid_t mod, slotid_t slot);
952 extern lboard_t *find_lboard_module(lboard_t *start, moduleid_t mod);
953 extern lboard_t *get_board_name(nasid_t nasid, moduleid_t mod, slotid_t slot, char *name);
954 extern int config_find_nic_router(nasid_t, nic_t, lboard_t **, klrou_t**);
955 extern int config_find_nic_hub(nasid_t, nic_t, lboard_t **, klhub_t**);
956 extern int config_find_xbow(nasid_t, lboard_t **, klxbow_t**);
957 extern klcpu_t *get_cpuinfo(cpuid_t cpu);
958 extern int update_klcfg_cpuinfo(nasid_t, int);
959 extern void board_to_path(lboard_t *brd, char *path);
960 extern moduleid_t get_module_id(nasid_t nasid);
961 extern void nic_name_convert(char *old_name, char *new_name);
962 extern int module_brds(nasid_t nasid, lboard_t **module_brds, int n);
963 extern lboard_t *brd_from_key(ulong_t key);
964 extern void device_component_canonical_name_get(lboard_t *,klinfo_t *,
966 extern int board_serial_number_get(lboard_t *,char *);
967 extern int is_master_baseio(nasid_t,moduleid_t,slotid_t);
968 extern nasid_t get_actual_nasid(lboard_t *brd) ;
969 extern net_vec_t klcfg_discover_route(lboard_t *, lboard_t *, int);
970 #else /* CONFIG_SGI_IO */
971 extern klcpu_t *sn_get_cpuinfo(cpuid_t cpu);
972 #endif /* CONFIG_SGI_IO */
974 #endif /* _ASM_SN_KLCONFIG_H */