nubus.h revision 1.29
1 /* $NetBSD: nubus.h,v 1.29 1997/08/14 06:16:49 scottr 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 /* Apple Toby Frame Buffer */ 55 #define NUBUS_DRHW_WVC 0x0006 /* Apple Workstation Video Card */ 56 #define NUBUS_DRHW_COLORMAX 0x0007 /* Sigma Designs ColorMax */ 57 #define NUBUS_DRHW_SE30 0x0009 /* Apple SE/30 pseudo-slot video */ 58 #define NUBUS_DRHW_M2HRVC 0x0013 /* Apple Mac II High-Res Video Card */ 59 #define NUBUS_DRHW_PVC 0x0017 /* Apple Mac II Portrait Video Card */ 60 #define NUBUS_DRHW_MDC 0x0019 /* Apple Macintosh Display Card */ 61 #define NUBUS_DRHW_CB264 0x013B /* RasterOps ColorBoard 264 */ 62 #define NUBUS_DRHW_MICRON 0x0146 63 #define NUBUS_DRHW_CB364 0x026F /* RasterOps ColorBoard 364 */ 64 #define NUBUS_DRHW_THUNDER24 0x02CB /* SuperMac Thunder/24 */ 65 #define NUBUS_DRHW_RPC8XJ 0x040B /* Radius PrecisionColor 8xj */ 66 #define NUBUS_DRHW_FIILX 0x0417 /* Futura II LX */ 67 #define NUBUS_DRHW_FIISXDSP 0x042F /* Futura II SX/DSP */ 68 69 /* False DrHW values for video cards masquerading as other cards */ 70 #define NUBUS_DRHW_SAM768 0x10000 /* Cornerstone/Samsung 768x1006 */ 71 72 #define NUBUS_CATEGORY_NETWORK 0x0004 73 #define NUBUS_TYPE_ETHERNET 0x0001 74 #define NUBUS_DRSW_3COM 0x0000 75 #define NUBUS_DRSW_GATOR 0x0103 76 #define NUBUS_DRSW_ASANTE 0x0104 77 #define NUBUS_DRSW_TECHWORKS 0x0109 78 #define NUBUS_DRSW_DAYNA 0x010B 79 #define NUBUS_DRSW_FARALLON 0x010C 80 #define NUBUS_DRSW_FOCUS 0x011A 81 #define NUBUS_DRHW_INTERLAN 0x0100 82 #define NUBUS_DRHW_KINETICS 0x0106 83 #define NUBUS_DRHW_CABLETRON 0x0109 84 #define NUBUS_DRHW_SONIC 0x0110 85 #define NUBUS_DRHW_APPLE_SNT 0x0118 86 #define NUBUS_DRHW_APPLE_SN 0x0119 87 88 #define NUBUS_CATEGORY_COMMUNICATIONS 0x0006 89 #define NUBUS_TYPE_RS232 0x0002 90 #define NUBUS_DRSW_HDS 0x0102 91 #define NUBUS_DRHW_HDS 0x0102 92 93 #define NUBUS_CATEGORY_FONT 0x0009 /* KanjiTalk Font Card? */ 94 95 #define NUBUS_CATEGORY_CPU 0x000A 96 #define NUBUS_TYPE_68000 0x0002 97 #define NUBUS_TYPE_68020 0x0003 98 #define NUBUS_TYPE_68030 0x0004 99 #define NUBUS_TYPE_68040 0x0005 100 101 /* 102 * This is the same as Apple's Format Block for a card, with the 103 * addition of a pointer to the base of the NuBUS slot. 104 * 105 * This basically describes a nubus card--this structure is held in the last 106 * N bytes of each valid card's declaration ROM. 107 */ 108 typedef struct _nubus_slot { 109 u_long top; 110 u_int8_t slot; 111 u_int8_t bytelanes; 112 u_int8_t step; 113 u_int32_t test_pattern; 114 u_int8_t format; 115 u_int8_t revision_level; 116 u_int32_t crc; 117 u_int32_t length; 118 u_int32_t directory_offset; 119 } nubus_slot; 120 121 /* 122 * Just a structure to ease comparison of type for drivers, etc. 123 */ 124 typedef struct _nubus_type { 125 u_int16_t category; 126 u_int16_t type; 127 u_int16_t drsw; 128 u_int16_t drhw; 129 } nubus_type; 130 131 /* 132 * nubus_dir is a structure that describes a nubus directory. 133 * The nubus*dir() functions should be used to traverse this. 134 */ 135 typedef struct _nubus_dir { 136 u_int32_t dirbase; 137 u_int32_t curr_ent; 138 } nubus_dir; 139 140 /* 141 * This is the equivalent of an Apple sResource directory entry 142 * with the addition of a pointer to itself (essentially) for easy 143 * calculation of jump to indirect data. 144 */ 145 typedef struct _nubus_dirent { 146 u_int32_t myloc; 147 u_int8_t rsrc_id; 148 u_int32_t offset; 149 } nubus_dirent; 150 151 /* 152 * This is the equivalent of an Apple sResource with the addition of 153 * a pointer back to the sResource directory from whence we came. 154 * 155 * According to the Apple documentation, each sResource is of one of the 156 * following forms: 157 * all: bits 31-24 Identification number 158 * 159 * offset: bits 23-0 Offset to long data, cString, sBlock, etc. 160 * word: bits 23-16 0x00 161 * bits 15-0 word data 162 * byte: bits 23-8 0x0000 163 * bits 7-0 byte data 164 * 165 * The last resource has id = 0xff and data = 0x000000. 166 */ 167 typedef struct _nubus_rsrc { 168 u_int32_t myloc; 169 u_int8_t id; 170 u_int32_t data; 171 } nubus_rsrc; 172 173 /* Resource IDs for NUBUS_CATEGORY_* (All) */ 174 #define NUBUS_RSRC_TYPE 0x01 /* Type (required) */ 175 #define NUBUS_RSRC_NAME 0x02 /* Name (required) */ 176 #define NUBUS_RSRC_ICON 0x03 /* Icon */ 177 #define NUBUS_RSRC_DRVRDIR 0x04 /* Driver directory */ 178 #define NUBUS_RSRC_LOADREC 0x05 /* Load record for resource */ 179 #define NUBUS_RSRC_BOOTREC 0x06 /* Boot record */ 180 #define NUBUS_RSRC_FLAGS 0x07 /* sResource Flags */ 181 #define NUBUS_RSRC_HWDEVID 0x08 /* Hardware device ID */ 182 #define NUBUS_RSRC_MINOR_BASEOS 0x0A /* Offset to hw in std space */ 183 #define NUBUS_RSRC_MINOR_LENGTH 0x0B /* Length of std space */ 184 #define NUBUS_RSRC_MAJOR_BASEOS 0x0C /* Offset to hw in super space */ 185 #define NUBUS_RSRC_MAJOR_LENGTH 0x0D /* Length of super space */ 186 #define NUBUS_RSRC_CICN 0x0F /* Color icon */ 187 #define NUBUS_RSRC_ICL8 0x10 /* 8-bit icon data */ 188 #define NUBUS_RSRC_ICL4 0x11 /* 4-bit icon data */ 189 190 /* Resource IDs for NUBUS_CATEGORY_DISPLAY */ 191 #define NUBUS_RSRC_GAMMADIR 0x40 /* ID for gamma directory */ 192 #define NUBUS_RSRC_VIDNAMES 0x41 /* ID for video name directory */ 193 #define NUBUS_RSRC_FIRSTMODE 0x80 /* ID for first mode (1-bit) */ 194 #define NUBUS_RSRC_SECONDMODE 0x81 /* ID for 2nd mode (2-bit) */ 195 #define NUBUS_RSRC_THIRDMODE 0x82 /* ID for 3rd mode (4-bit) */ 196 #define NUBUS_RSRC_FOURTHMODE 0x83 /* ID for 4th mode (8-bit) */ 197 #define NUBUS_RSRC_FIFTHMODE 0x84 /* ID for 5th mode (16-bit) */ 198 #define NUBUS_RSRC_SIXTHMODE 0x85 /* ID for 6th mode (32-bit) */ 199 200 /* Resource IDs for NUBUS_CATEGORY_BOARD */ 201 #define NUBUS_RSRC_BOARDID 0x20 /* Board ID */ 202 #define NUBUS_RSRC_PRAMINITDATA 0x21 /* Private board data for PRAM */ 203 #define NUBUS_RSRC_PRIMARYINIT 0x22 /* Primary init record */ 204 #define NUBUS_RSRC_TIMEOUTCONST 0x23 /* Timeout constant */ 205 #define NUBUS_RSRC_VENDORINFO 0x24 /* Vendor info list */ 206 #define NUBUS_RSRC_BOARDFLAGS 0x25 /* Board flags */ 207 #define NUBUS_RSRC_SECONDINIT 0x26 /* Secondary init record */ 208 209 #define NUBUS_RSRC_VEND_ID 0x01 /* Card vendor's design ID */ 210 #define NUBUS_RSRC_VEND_SERIAL 0x02 /* Card's serial number */ 211 #define NUBUS_RSRC_VEND_REV 0x03 /* Card design's revision level */ 212 #define NUBUS_RSRC_VEND_PART 0x04 /* Card part number */ 213 #define NUBUS_RSRC_VEND_DATE 0x05 /* Card revision date */ 214 215 typedef struct _NUBUS_DRIVER { 216 u_int8_t drvr_id; 217 u_int32_t offset; 218 } NUBUS_DRIVER; 219 220 typedef struct _NUBUS_BLOCK { 221 u_int32_t size; /* Size of block of data */ 222 caddr_t data; /* Pointer to data */ 223 } NUBUS_BLOCK; 224 225 typedef struct _NUBUS_EXEC_BLOCK { 226 u_int32_t size; /* Size of total block - 4 */ 227 u_int8_t revision; /* Always 0x2 */ 228 u_int8_t cpu; /* Which processor? */ 229 u_int32_t code_offset; /* Offset base to start of code */ 230 caddr_t code; /* pointer to base of code. */ 231 } NUBUS_EXEC_BLOCK; 232 233 #define NUBUS_EXEC_CPU_68000 1 234 #define NUBUS_EXEC_CPU_68020 2 235 #define NUBUS_EXEC_CPU_68030 3 236 #define NUBUS_EXEC_CPU_68040 4 237 238 #define NUBUS_MIN_SLOT 0x9 239 #define NUBUS_MAX_SLOT 0xE 240 #define NUBUS_ROM_TEST_PATTERN 0x5A932BC7 241 242 #define NUBUS_SLOT2PA(x) (0xf9000000 + \ 243 ((((x) - NUBUS_MIN_SLOT) & 0xf) << 24)) 244 245 struct nubus_attach_args { 246 bus_space_tag_t na_tag; 247 int slot; 248 int rsrcid; 249 u_int16_t category; 250 u_int16_t type; 251 u_int16_t drsw; 252 u_int16_t drhw; 253 nubus_slot *fmt; 254 }; 255 256 struct nubus_softc { 257 struct device sc_dev; 258 }; 259 260 void nubus_get_main_dir __P((nubus_slot *slot, nubus_dir *dir_return)); 261 void nubus_get_dir_from_rsrc __P((nubus_slot *slot, nubus_dirent *dirent, 262 nubus_dir *dir_return)); 263 264 int nubus_find_rsrc __P((bus_space_tag_t, bus_space_handle_t, 265 nubus_slot *slot, nubus_dir *dir, u_int8_t rsrcid, 266 nubus_dirent *dirent_return)); 267 int nubus_get_ind_data __P((bus_space_tag_t, bus_space_handle_t, 268 nubus_slot *slot, nubus_dirent *dirent, 269 caddr_t data_return, int nbytes)); 270 int nubus_get_c_string __P((bus_space_tag_t, bus_space_handle_t, 271 nubus_slot *slot, nubus_dirent *dirent, 272 caddr_t data_return, int max_bytes)); 273 274 char *nubus_get_vendor __P((bus_space_tag_t, bus_space_handle_t, 275 nubus_slot *slot, int rsrc)); 276 char *nubus_get_card_name __P((bus_space_tag_t, bus_space_handle_t, 277 nubus_slot *slot)); 278
Indexes created Tue Sep 30 20:09:53 GMT 2025