1 /* $NetBSD: cardbus_exrom.c,v 1.6 2001/11/13 12:51:12 lukem Exp $ */ 2 3 /* 4 * Copyright (c) 1999 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to 8 * The NetBSD Foundation by Johan Danielsson. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * 3. Neither the name of The NetBSD Foundation nor the names of its 22 * contributors may be used to endorse or promote products derived 23 * from this software without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35 * POSSIBILITY OF SUCH DAMAGE. 36 */ 37 38 #include <sys/cdefs.h> 39 __KERNEL_RCSID(0, "$NetBSD: cardbus_exrom.c,v 1.6 2001/11/13 12:51:12 lukem Exp $"); 40 41 #include <sys/param.h> 42 #include <sys/systm.h> 43 #include <sys/queue.h> 44 #include <sys/malloc.h> 45 46 #include <machine/bus.h> 47 48 #include <dev/cardbus/cardbus_exrom.h> 49 50 #define READ_INT16(T, H, O) \ 51 (bus_space_read_1((T), (H), (O)) | (bus_space_read_1((T), (H), (O) + 1) << 8)) 52 53 /* A PCI ROM is divided into a number of images. Each image has two 54 * data structures, a header located at the start of the image, and a 55 * `data structure' at some offset into it. 56 * 57 * The header is a 26 byte structure: 58 * 59 * Offset Length Description 60 * 0x00 1 signature byte 1 (0x55) 61 * 0x01 1 signature byte 2 (0xAA) 62 * 0x02 22 processor architecture data 63 * 0x18 2 pointer to the data structure 64 * 65 * The data structure is a 24 byte structure: 66 * 67 * Offset Length Description 68 * 0x00 4 signature (PCIR) 69 * 0x04 2 vendor id 70 * 0x06 2 device id 71 * 0x08 2 reserved 72 * 0x0A 2 data structure length 73 * 0x0C 1 data structure revision (0) 74 * 0x0D 3 class code 75 * 0x10 2 image length (in 512 byte blocks) 76 * 0x12 2 code revision level 77 * 0x14 1 code type 78 * 0x15 1 indicator (bit 7 indicates final image) 79 * 0x16 2 reserved 80 * 81 */ 82 83 /* 84 * Scan through a PCI expansion ROM, and create subregions for each 85 * ROM image. This function assumes that the ROM is mapped at 86 * (tag,handle), and that the expansion ROM address decoder is 87 * enabled. The PCI specification requires that no other BAR should 88 * be accessed while the ROM is enabled, so interrupts should be 89 * disabled. 90 */ 91 92 int 93 cardbus_read_exrom(romt, romh, head) 94 bus_space_tag_t romt; 95 bus_space_handle_t romh; 96 struct cardbus_rom_image_head *head; 97 { 98 static const char thisfunc[] = "cardbus_read_exrom"; 99 100 size_t addr = 0; /* offset of current rom image */ 101 size_t dataptr; 102 unsigned int rom_image = 0; 103 104 SIMPLEQ_INIT(head); 105 do { 106 size_t image_size; 107 struct cardbus_rom_image *image; 108 u_int16_t val; 109 110 val = READ_INT16(romt, romh, addr + CARDBUS_EXROM_SIGNATURE); 111 if(val != 0xaa55) { 112 printf("%s: bad header signature in ROM image %u: 0x%04x\n", 113 thisfunc, rom_image, val); 114 return 1; 115 } 116 dataptr = addr + READ_INT16(romt, romh, addr + CARDBUS_EXROM_DATA_PTR); 117 /* get the ROM image size, in blocks */ 118 image_size = READ_INT16(romt, romh, 119 dataptr + CARDBUS_EXROM_DATA_IMAGE_LENGTH); 120 if(image_size == 0) 121 /* XXX some ROMs seem to have this as zero, can we assume 122 this means 1 block? */ 123 image_size = 1; 124 image_size <<= 9; 125 image = malloc(sizeof(*image), M_DEVBUF, M_NOWAIT); 126 if(image == NULL) { 127 printf("%s: out of memory\n", thisfunc); 128 return 1; 129 } 130 image->rom_image = rom_image; 131 image->image_size = image_size; 132 image->romt = romt; 133 if(bus_space_subregion(romt, romh, addr, 134 image_size, &image->romh)) { 135 printf("%s: bus_space_subregion failed", thisfunc); 136 free(image, M_DEVBUF); 137 return 1; 138 } 139 SIMPLEQ_INSERT_TAIL(head, image, next); 140 addr += image_size; 141 rom_image++; 142 } while ((bus_space_read_1(romt, romh, 143 dataptr + CARDBUS_EXROM_DATA_INDICATOR) & 0x80) == 0); 144 return 0; 145 } 146 147 148 #if 0 149 struct cardbus_exrom_data_structure { 150 char signature[4]; 151 cardbusreg_t id; /* vendor & device id */ 152 u_int16_t structure_length; 153 u_int8_t structure_revision; 154 cardbusreg_t class; /* class code in upper 24 bits */ 155 u_int16_t image_length; 156 u_int16_t data_revision; 157 u_int8_t code_type; 158 u_int8_t indicator; 159 }; 160 161 pci_exrom_parse_data_structure(bus_space_tag_t tag, 162 bus_space_handle_t handle, 163 struct pci_exrom_data_structure *ds) 164 { 165 unsigned char hdr[16]; 166 bus_space_read_region_1(tag, handle, dataptr, hdr, sizeof(hdr)); 167 memcpy(header->signature, hdr + PCI_EXROM_DATA_SIGNATURE, 4); 168 #define LEINT16(B, O) ((B)[(O)] | ((B)[(O) + 1] << 8)) 169 header->id = LEINT16(hdr, PCI_EXROM_DATA_VENDOR_ID) | 170 (LEINT16(hdr, PCI_EXROM_DATA_DEVICE_ID) << 16); 171 header->structure_length = LEINT16(hdr, PCI_EXROM_DATA_LENGTH); 172 header->structure_rev = hdr[PCI_EXROM_DATA_REV]; 173 header->class = (hdr[PCI_EXROM_DATA_CLASS_CODE] << 8) | 174 (hdr[PCI_EXROM_DATA_CLASS_CODE + 1] << 16) | 175 (hdr[PCI_EXROM_DATA_CLASS_CODE + 2] << 24); 176 header->image_length = LEINT16(hdr, PCI_EXROM_DATA_IMAGE_LENGTH) << 16; 177 header->data_revision = LEINT16(hdr, PCI_EXROM_DATA_DATA_REV); 178 header->code_type = hdr[PCI_EXROM_DATA_CODE_TYPE]; 179 header->indicator = hdr[PCI_EXROM_DATA_INDICATOR]; 180 length = min(length, header->image_length - 0x18 - offset); 181 bus_space_read_region_1(tag, handle, dataptr + 0x18 + offset, 182 buf, length); 183 ret = length; 184 } 185 #endif 186