nubus.h revision 1.13
1 /* $NetBSD: nubus.h,v 1.13 1996/05/05 06:17:05 briggs Exp $ */ 2 3 /* 4 * Copyright (c) 1995 Allen Briggs. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. All advertising materials mentioning features or use of this software 15 * must display the following acknowledgement: 16 * This product includes software developed by Allen Briggs. 17 * 4. The name of the author may not be used to endorse or promote products 18 * derived from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * Nubus cards in Macintoshes are identified by 4 16-bit numbers: 34 * Category: What is the main purpose of this card? 35 * Type: Within this overall category, what kind of card? 36 * DrSW: What software interface does it use? 37 * DrHW: What specific hardware is it? 38 * 39 * For example, the "Toby Frame Buffer" display card is 40 * Category 3 (display) 41 * Type 1 (video) 42 * DrSW 1 (Apple) 43 * and DrHW 1 (TFB). 44 */ 45 46 #include <machine/cpu.h> 47 48 #define NUBUS_CATEGORY_BOARD 0x0001 49 50 #define NUBUS_CATEGORY_DISPLAY 0x0003 51 #define NUBUS_TYPE_VIDEO 0x0001 52 #define NUBUS_TYPE_LCD 0x0002 53 #define NUBUS_DRSW_APPLE 0x0001 54 #define NUBUS_DRHW_TFB 0x0001 55 #define NUBUS_DRHW_M2HRVC 0x0013 56 #define NUBUS_DRHW_MICRON 0x0146 57 58 #define NUBUS_CATEGORY_NETWORK 0x0004 59 #define NUBUS_TYPE_ETHERNET 0x0001 60 #define NUBUS_DRSW_3COM 0x0000 61 #define NUBUS_DRSW_GATOR 0x0103 62 #define NUBUS_DRSW_ASANTE 0x0104 63 #define NUBUS_DRSW_TECHWORKS 0x0109 64 #define NUBUS_DRSW_FARALLON 0x010C 65 #define NUBUS_DRSW_FOCUS 0x011A 66 #define NUBUS_DRHW_INTERLAN 0x0100 67 #define NUBUS_DRHW_KINETICS 0x0106 68 #define NUBUS_DRHW_SONIC 0x0110 69 #define NUBUS_DRHW_CABLETRON 0x0109 70 71 #define NUBUS_CATEGORY_COMMUNICATIONS 0x0006 72 #define NUBUS_TYPE_RS232 0x0002 73 #define NUBUS_DRSW_HDS 0x0102 74 #define NUBUS_DRHW_HDS 0x0102 75 76 #define NUBUS_CATEGORY_FONT 0x0009 /* KanjiTalk Font Card? */ 77 78 #define NUBUS_CATEGORY_CPU 0x000A 79 #define NUBUS_TYPE_68000 0x0002 80 #define NUBUS_TYPE_68020 0x0003 81 #define NUBUS_TYPE_68030 0x0004 82 #define NUBUS_TYPE_68040 0x0005 83 84 /* 85 * This is the same as Apple's Format Block for a card, with the 86 * addition of a pointer to the base of the NuBUS slot. 87 * 88 * This basically describes a nubus card--this structure is held in the last 89 * N bytes of each valid card's declaration ROM. 90 */ 91 typedef struct _nubus_slot { 92 u_long top; 93 u_int8_t slot; 94 u_int8_t bytelanes; 95 u_int8_t step; 96 u_int32_t test_pattern; 97 u_int8_t format; 98 u_int8_t revision_level; 99 u_int32_t crc; 100 u_int32_t length; 101 u_int32_t directory_offset; 102 vm_offset_t virtual_base; 103 } nubus_slot; 104 105 /* 106 * Just a structure to ease comparison of type for drivers, etc. 107 */ 108 typedef struct _nubus_type { 109 u_int16_t category; 110 u_int16_t type; 111 u_int16_t drsw; 112 u_int16_t drhw; 113 } nubus_type; 114 115 /* 116 * nubus_dir is a structure that describes a nubus directory. 117 * The nubus*dir() functions should be used to traverse this. 118 */ 119 typedef struct _nubus_dir { 120 u_int32_t dirbase; 121 u_int32_t curr_ent; 122 } nubus_dir; 123 124 /* 125 * This is the equivalent of an Apple sResource directory entry 126 * with the addition of a pointer to itself (essentially) for easy 127 * calculation of jump to indirect data. 128 */ 129 typedef struct _nubus_dirent { 130 u_int32_t myloc; 131 u_int8_t rsrc_id; 132 u_int32_t offset; 133 } nubus_dirent; 134 135 /* 136 * This is the equivalent of an Apple sResource with the addition of 137 * a pointer back to the sResource directory from whence we came. 138 * 139 * According to the Apple documentation, each sResource is of one of the 140 * following forms: 141 * all: bits 31-24 Identification number 142 * 143 * offset: bits 23-0 Offset to long data, cString, sBlock, etc. 144 * word: bits 23-16 0x00 145 * bits 15-0 word data 146 * byte: bits 23-8 0x0000 147 * bits 7-0 byte data 148 * 149 * The last resource has id = 0xff and data = 0x000000. 150 */ 151 typedef struct _nubus_rsrc { 152 u_int32_t myloc; 153 u_int8_t id; 154 u_int32_t data; 155 } nubus_rsrc; 156 157 /* Resource IDs for NUBUS_CATEGORY_* (All) */ 158 #define NUBUS_RSRC_TYPE 0x01 /* Type (required) */ 159 #define NUBUS_RSRC_NAME 0x02 /* Name (required) */ 160 #define NUBUS_RSRC_ICON 0x03 /* Icon */ 161 #define NUBUS_RSRC_DRVRDIR 0x04 /* Driver directory */ 162 #define NUBUS_RSRC_LOADREC 0x05 /* Load record for resource */ 163 #define NUBUS_RSRC_BOOTREC 0x06 /* Boot record */ 164 #define NUBUS_RSRC_FLAGS 0x07 /* sResource Flags */ 165 #define NUBUS_RSRC_HWDEVID 0x08 /* Hardware device ID */ 166 #define NUBUS_RSRC_MINOR_BASEOS 0x0A /* Offset to hw in std space */ 167 #define NUBUS_RSRC_MINOR_LENGTH 0x0B /* Length of std space */ 168 #define NUBUS_RSRC_MAJOR_BASEOS 0x0C /* Offset to hw in super space */ 169 #define NUBUS_RSRC_MAJOR_LENGTH 0x0D /* Length of super space */ 170 #define NUBUS_RSRC_CICN 0x0F /* Color icon */ 171 #define NUBUS_RSRC_ICL8 0x10 /* 8-bit icon data */ 172 #define NUBUS_RSRC_ICL4 0x11 /* 4-bit icon data */ 173 174 /* Resource IDs for NUBUS_CATEGORY_DISPLAY */ 175 #define NUBUS_RSRC_GAMMADIR 0x40 /* ID for gamma directory */ 176 #define NUBUS_RSRC_VIDNAMES 0x41 /* ID for video name directory */ 177 #define NUBUS_RSRC_FIRSTMODE 0x80 /* ID for first mode (1-bit) */ 178 #define NUBUS_RSRC_SECONDMODE 0x81 /* ID for 2nd mode (2-bit) */ 179 #define NUBUS_RSRC_THIRDMODE 0x82 /* ID for 3rd mode (4-bit) */ 180 #define NUBUS_RSRC_FOURTHMODE 0x83 /* ID for 4th mode (8-bit) */ 181 #define NUBUS_RSRC_FIFTHMODE 0x84 /* ID for 5th mode (16-bit) */ 182 #define NUBUS_RSRC_SIXTHMODE 0x85 /* ID for 6th mode (32-bit) */ 183 184 /* Resource IDs for NUBUS_CATEGORY_BOARD */ 185 #define NUBUS_RSRC_BOARDID 0x20 /* Board ID */ 186 #define NUBUS_RSRC_PRAMINITDATA 0x21 /* Private board data for PRAM */ 187 #define NUBUS_RSRC_PRIMARYINIT 0x22 /* Primary init record */ 188 #define NUBUS_RSRC_TIMEOUTCONST 0x23 /* Timeout constant */ 189 #define NUBUS_RSRC_VENDORINFO 0x24 /* Vendor info list */ 190 #define NUBUS_RSRC_BOARDFLAGS 0x25 /* Board flags */ 191 #define NUBUS_RSRC_SECONDINIT 0x26 /* Secondary init record */ 192 193 #define NUBUS_RSRC_VEND_ID 0x01 /* Card vendor's design ID */ 194 #define NUBUS_RSRC_VEND_SERIAL 0x02 /* Card's serial number */ 195 #define NUBUS_RSRC_VEND_REV 0x03 /* Card design's revision level */ 196 #define NUBUS_RSRC_VEND_PART 0x04 /* Card part number */ 197 #define NUBUS_RSRC_VEND_DATE 0x05 /* Card revision date */ 198 199 typedef struct _NUBUS_DRIVER { 200 u_int8_t drvr_id; 201 u_int32_t offset; 202 } NUBUS_DRIVER; 203 204 typedef struct _NUBUS_BLOCK { 205 u_int32_t size; /* Size of block of data */ 206 caddr_t data; /* Pointer to data */ 207 } NUBUS_BLOCK; 208 209 typedef struct _NUBUS_EXEC_BLOCK { 210 u_int32_t size; /* Size of total block - 4 */ 211 u_int8_t revision; /* Always 0x2 */ 212 u_int8_t cpu; /* Which processor? */ 213 u_int32_t code_offset; /* Offset base to start of code */ 214 caddr_t code; /* pointer to base of code. */ 215 } NUBUS_EXEC_BLOCK; 216 217 #define NUBUS_EXEC_CPU_68000 1 218 #define NUBUS_EXEC_CPU_68020 2 219 #define NUBUS_EXEC_CPU_68030 3 220 #define NUBUS_EXEC_CPU_68040 4 221 222 #define NUBUS_MIN_SLOT 0x9 223 #define NUBUS_MAX_SLOT 0xE 224 #define NUBUS_INT_VIDEO_PSUEDO_SLOT 0xF 225 #define NUBUS_ROM_TEST_PATTERN 0x5A932BC7 226 227 #define NUBUS_SLOT_TO_PADDR(x) ( 0xF9000000 + \ 228 ((((x)-NUBUS_MIN_SLOT) & 0xF) << 24)) 229 #define NUBUS_BASE_TO_SLOT(x) (((((x)-NuBusBase) >> 24) & 0x0F) + \ 230 NUBUS_MIN_SLOT) 231 #define NUBUS_SLOT_TO_BASE(x) (NuBusBase + \ 232 ((((x)-NUBUS_MIN_SLOT) & 0xF) << 24)) 233 #define NUBUS_VIRT_TO_PHYS(x) ((x - NuBusBase) + \ 234 ((0xF0 | NUBUS_MIN_SLOT) << 24)) 235 236 struct nubus_softc { 237 struct device sc_dev; 238 }; 239 240 void nubus_get_main_dir __P((nubus_slot *slot, nubus_dir *dir_return)); 241 int nubus_find_rsrc __P((nubus_slot *slot, nubus_dir *dir, u_int8_t rsrcid, 242 nubus_dirent *dirent_return)); 243 void nubus_get_dir_from_rsrc __P((nubus_slot *slot, nubus_dirent *dirent, 244 nubus_dir *dir_return)); 245 int nubus_get_ind_data __P((nubus_slot *slot, nubus_dirent *dirent, 246 caddr_t data_return, int nbytes)); 247 int nubus_get_c_string __P((nubus_slot *slot, nubus_dirent *dirent, 248 caddr_t data_return, int max_bytes)); 249 char *nubus_get_vendor __P((nubus_slot *slot, int rsrc)); 250 char *nubus_get_card_name __P((nubus_slot *slot)); 251 252
Indexes created Mon Sep 29 21:09:56 GMT 2025