xref: /netbsd-src/sys/arch/sgimips/gio/gioreg.h (revision 8b5466f0875059a1d1d91df3d63b175fbdc0a759)
1 /*	$NetBSD: gioreg.h,v 1.4 2006/08/31 00:01:10 rumble Exp $	*/
2 
3 /*
4  * Copyright (c) 2003 Ilpo Ruotsalainen
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * <<Id: LICENSE_GC,v 1.1 2001/10/01 23:24:05 cgd Exp>>
30  */
31 
32 #ifndef _ARCH_SGIMIPS_GIO_GIOREG_H_
33 #define _ARCH_SGIMIPS_GIO_GIOREG_H_
34 
35 /*
36  * The GIO Product Identification Word is the first word (1 or 4 bytes)
37  * in each GIO device's address space. It is the same format for GIO32,
38  * GIO32-bis, and GIO64 devices. The macros below extract the following
39  * fields:
40  *
41  * Bits:
42  *    0-6 Product ID Code
43  *	7 Product Identification Word size (0: 8 bits, 1: 32 bits)
44  *   8-15 Product Revision
45  *     16 GIO Interface Size (0: 32, 1: 64; NB: GIO64 devices may be 32)
46  *     17 Rom Present (1: present)
47  *  18-31 Manufacturer-specific Code
48  *
49  * The upper three bytes containing the Product Revision, GIO Interface
50  * Size, Rom Presence indicator, and Manufacturer-specific Code are only
51  * valid if bit 7 is set in the Product ID Word. If it is not set, all
52  * values default to 0.
53  *
54  * If the Rom Present bit is set, the three words after the Product ID are
55  * reserved for three ROM registers:
56  *	Board Serial Number Register	(base_address + 0x4)
57  *	ROM Index Register		(base_address + 0x8)
58  *	ROM Read Register		(base_address + 0xc)
59  *
60  * The ROM Index Register is initialised by the CPU to 0 and incremented by
61  * 4 on each read from the ROM Read Register. The Board Serial Number
62  * Register contains a manufacturer-specific serial number.
63  */
64 
65 #define GIO_PRODUCT_32BIT_ID(x)		((x) & 0x80)
66 #define GIO_PRODUCT_PRODUCTID(x)	((x) & 0x7f)
67 #define GIO_PRODUCT_REVISION(x)		(((x) >> 8) & 0xff)
68 #define GIO_PRODUCT_IS_64BIT(x)		(!!((x) & 0x8000))
69 #define GIO_PRODUCT_HAS_ROM(x)		(!!((x) & 0x10000))
70 #define GIO_PRODUCT_MANUCODE(x)		((x) >> 18)
71 
72 #endif
73