fwcrom.c revision 1.13
1 /* $NetBSD: fwcrom.c,v 1.13 2010/08/26 07:36:53 cegger Exp $ */ 2 /*- 3 * Copyright (c) 2002-2003 4 * Hidetoshi Shimokawa. 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 * 17 * This product includes software developed by Hidetoshi Shimokawa. 18 * 19 * 4. Neither the name of the author nor the names of its contributors 20 * may be used to endorse or promote products derived from this software 21 * without specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 */ 35 36 #include <sys/cdefs.h> 37 __KERNEL_RCSID(0, "$NetBSD: fwcrom.c,v 1.13 2010/08/26 07:36:53 cegger Exp $"); 38 39 #include <sys/param.h> 40 #ifdef _KERNEL 41 #include <sys/device.h> 42 #include <sys/errno.h> 43 #include <sys/systm.h> 44 #else 45 #include <stdio.h> 46 #include <string.h> 47 #endif 48 #include <dev/ieee1394/firewire.h> 49 #include <dev/ieee1394/iec13213.h> 50 51 #define MAX_ROM (1024 - sizeof(uint32_t) * 5) 52 #define CROM_END(cc) ((char *)(cc)->stack[0].dir + MAX_ROM - 1) 53 54 void 55 crom_init_context(struct crom_context *cc, uint32_t *p) 56 { 57 struct csrhdr *hdr; 58 59 hdr = (struct csrhdr *)p; 60 if (hdr->info_len <= 1) { 61 /* minimum or invalid ROM */ 62 cc->depth = -1; 63 return; 64 } 65 p += 1 + hdr->info_len; 66 67 /* check size of root directory */ 68 if (((struct csrdirectory *)p)->crc_len == 0) { 69 cc->depth = -1; 70 return; 71 } 72 cc->depth = 0; 73 cc->stack[0].dir = (struct csrdirectory *)p; 74 cc->stack[0].index = 0; 75 } 76 77 struct csrreg * 78 crom_get(struct crom_context *cc) 79 { 80 struct crom_ptr *ptr; 81 82 ptr = &cc->stack[cc->depth]; 83 return &ptr->dir->entry[ptr->index]; 84 } 85 86 void 87 crom_next(struct crom_context *cc) 88 { 89 struct crom_ptr *ptr; 90 struct csrreg *reg; 91 92 if (cc->depth < 0) 93 return; 94 reg = crom_get(cc); 95 if ((reg->key & CSRTYPE_MASK) == CSRTYPE_D) { 96 if (cc->depth >= CROM_MAX_DEPTH) { 97 printf("crom_next: too deep\n"); 98 goto again; 99 } 100 cc->depth++; 101 102 ptr = &cc->stack[cc->depth]; 103 ptr->dir = (struct csrdirectory *)(reg + reg->val); 104 ptr->index = 0; 105 goto check; 106 } 107 again: 108 ptr = &cc->stack[cc->depth]; 109 ptr->index++; 110 check: 111 if (ptr->index < ptr->dir->crc_len && 112 (char *)crom_get(cc) <= CROM_END(cc)) 113 return; 114 115 if (ptr->index < ptr->dir->crc_len) 116 printf("crom_next: bound check failed\n"); 117 118 if (cc->depth > 0) { 119 cc->depth--; 120 goto again; 121 } 122 /* no more data */ 123 cc->depth = -1; 124 } 125 126 127 struct csrreg * 128 crom_search_key(struct crom_context *cc, uint8_t key) 129 { 130 struct csrreg *reg; 131 132 while (cc->depth >= 0) { 133 reg = crom_get(cc); 134 if (reg->key == key) 135 return reg; 136 crom_next(cc); 137 } 138 return NULL; 139 } 140 141 int 142 crom_has_specver(uint32_t *p, uint32_t spec, uint32_t ver) 143 { 144 struct csrreg *reg; 145 struct crom_context c, *cc; 146 int state = 0; 147 148 cc = &c; 149 crom_init_context(cc, p); 150 while (cc->depth >= 0) { 151 reg = crom_get(cc); 152 if (state == 0) { 153 if (reg->key == CSRKEY_SPEC && reg->val == spec) 154 state = 1; 155 else 156 state = 0; 157 } else { 158 if (reg->key == CSRKEY_VER && reg->val == ver) 159 return 1; 160 else 161 state = 0; 162 } 163 crom_next(cc); 164 } 165 return 0; 166 } 167 168 void 169 crom_parse_text(struct crom_context *cc, char *buf, int len) 170 { 171 struct csrreg *reg; 172 struct csrtext *textleaf; 173 uint32_t *bp; 174 int i, qlen; 175 static char *nullstr = (char *)&"(null)"; 176 177 if (cc->depth < 0) 178 return; 179 180 reg = crom_get(cc); 181 switch (reg->key) { 182 case CROM_TEXTLEAF: 183 case CROM_TEXTLEAF2: 184 break; 185 default: 186 if ((char *)(reg + reg->val) > CROM_END(cc)) { 187 strncpy(buf, nullstr, len); 188 return; 189 } 190 break; 191 } 192 textleaf = (struct csrtext *)(reg + reg->val); 193 194 if ((char *)textleaf + textleaf->crc_len > CROM_END(cc)) { 195 strncpy(buf, nullstr, len); 196 return; 197 } 198 199 /* XXX should check spec and type */ 200 201 bp = (uint32_t *)buf; 202 qlen = textleaf->crc_len - 2; 203 if (len < qlen * 4) 204 qlen = len/4; 205 for (i = 0; i < qlen; i++) 206 *bp++ = ntohl(textleaf->text[i]); 207 /* make sure to terminate the string */ 208 if (len <= qlen * 4) 209 buf[len - 1] = 0; 210 else 211 buf[qlen * 4] = 0; 212 } 213 214 uint16_t 215 crom_crc(uint32_t *ptr, int len) 216 { 217 int i, shift; 218 uint32_t data, sum, crc = 0; 219 220 for (i = 0; i < len; i++) { 221 data = ptr[i]; 222 for (shift = 28; shift >= 0; shift -= 4) { 223 sum = ((crc >> 12) ^ (data >> shift)) & 0xf; 224 crc = (crc << 4) ^ (sum << 12) ^ (sum << 5) ^ sum; 225 } 226 crc &= 0xffff; 227 } 228 return (uint16_t)crc; 229 } 230 231 #if !defined(_KERNEL) && !defined(_BOOT) 232 static void 233 crom_desc_specver(uint32_t spec, uint32_t ver, char *buf, int len) 234 { 235 const char *s = NULL; 236 237 if (spec == CSRVAL_ANSIT10 || spec == 0) { 238 switch (ver) { 239 case CSRVAL_T10SBP2: 240 s = "SBP-2"; 241 break; 242 default: 243 if (spec != 0) 244 s = "unknown ANSIT10"; 245 } 246 } 247 if (spec == CSRVAL_1394TA || spec == 0) { 248 switch (ver) { 249 case CSR_PROTAVC: 250 s = "AV/C"; 251 break; 252 case CSR_PROTCAL: 253 s = "CAL"; 254 break; 255 case CSR_PROTEHS: 256 s = "EHS"; 257 break; 258 case CSR_PROTHAVI: 259 s = "HAVi"; 260 break; 261 case CSR_PROTCAM104: 262 s = "1394 Cam 1.04"; 263 break; 264 case CSR_PROTCAM120: 265 s = "1394 Cam 1.20"; 266 break; 267 case CSR_PROTCAM130: 268 s = "1394 Cam 1.30"; 269 break; 270 case CSR_PROTDPP: 271 s = "1394 Direct print"; 272 break; 273 case CSR_PROTIICP: 274 s = "Industrial & Instrument"; 275 break; 276 default: 277 if (spec != 0) 278 s = "unknown 1394TA"; 279 } 280 } 281 if (s != NULL) 282 snprintf(buf, len, "%s", s); 283 } 284 285 const char * 286 crom_desc(struct crom_context *cc, char *buf, int len) 287 { 288 struct csrreg *reg; 289 struct csrdirectory *dir; 290 const char *desc; 291 uint16_t crc; 292 293 reg = crom_get(cc); 294 switch (reg->key & CSRTYPE_MASK) { 295 case CSRTYPE_I: 296 #if 0 297 len -= snprintf(buf, len, "0x%x", reg->val); 298 buf += strlen(buf); 299 #else 300 *buf = '\0'; 301 #endif 302 break; 303 case CSRTYPE_C: 304 len -= 305 snprintf(buf, len, "offset=0x%04x(%d)", reg->val, reg->val); 306 buf += strlen(buf); 307 break; 308 case CSRTYPE_L: 309 /* XXX fall through */ 310 case CSRTYPE_D: 311 dir = (struct csrdirectory *) (reg + reg->val); 312 crc = crom_crc((uint32_t *)dir->entry, dir->crc_len); 313 len -= snprintf(buf, len, "len=%d crc=0x%04x ", 314 dir->crc_len, crc); 315 buf += strlen(buf); 316 317 if (crc == dir->crc) 318 len -= snprintf(buf, len, "(OK) "); 319 else 320 len -= snprintf(buf, len, "(NG, 0x%x) ", 321 dir->crc); 322 buf += strlen(buf); 323 } 324 switch (reg->key) { 325 case CSRKEY_VENDOR: /* 0x03 */ 326 desc = "module_vendor_ID"; 327 break; 328 case CSRKEY_HW: /* 0x04 */ 329 desc = "hardware_version"; 330 break; 331 case CSRKEY_NCAP: /* 0x0c */ 332 desc = "node_capabilities"; 333 break; 334 case CSRKEY_SPEC: /* 0x12 */ 335 desc = "unit_spec_ID"; 336 break; 337 case CSRKEY_VER: /* 0x13 */ 338 desc = "unit_sw_version"; 339 crom_desc_specver(0, reg->val, buf, len); 340 break; 341 case CSRKEY_DINFO: /* 0x14 */ 342 desc = "logical_unit_number"; 343 break; 344 case CSRKEY_MODEL: /* 0x17 */ 345 desc = "model_ID"; 346 break; 347 case CSRKEY_REV: /* 0x21 */ 348 desc = "revision_ID"; 349 break; 350 case 0x38: 351 desc = "command_set_spec_ID"; 352 break; 353 case 0x39: 354 desc = "command_set"; 355 break; 356 case 0x3a: 357 desc = "unit_characteristics"; 358 break; 359 case 0x3b: 360 desc = "command_set_revision"; 361 break; 362 case 0x3c: 363 desc = "firmware_revision"; 364 break; 365 case 0x3d: 366 desc = "reconnect_timeout"; 367 break; 368 case 0x40: 369 desc = "command_regs_base"; 370 break; 371 case 0x54: 372 desc = "management_agent"; 373 break; 374 case CROM_TEXTLEAF: /* 0x81 */ 375 case CROM_TEXTLEAF2: /* 0x82 */ 376 desc = "text_leaf"; 377 crom_parse_text(cc, buf + strlen(buf), len); 378 break; 379 case CROM_NODEID: /* 0x8d */ 380 desc = "node_unique_ID"; 381 break; 382 case 0xd1: 383 desc = "unit_directory"; 384 break; 385 case 0xd4: 386 desc = "logical_unit_directory"; 387 break; 388 default: 389 desc = "unknown"; 390 } 391 return desc; 392 } 393 #endif 394 395 #if defined(_KERNEL) || defined(_BOOT) || defined(TEST) 396 397 int 398 crom_add_quad(struct crom_chunk *chunk, uint32_t entry) 399 { 400 int index; 401 402 index = chunk->data.crc_len; 403 if (index >= CROM_MAX_CHUNK_LEN - 1) { 404 printf("too large chunk %d\n", index); 405 return -1; 406 } 407 chunk->data.buf[index] = entry; 408 chunk->data.crc_len++; 409 return index; 410 } 411 412 int 413 crom_add_entry(struct crom_chunk *chunk, int key, int val) 414 { 415 union { 416 struct csrreg reg; 417 uint32_t i; 418 } foo; 419 420 foo.reg.key = key; 421 foo.reg.val = val; 422 423 return crom_add_quad(chunk, foo.i); 424 } 425 426 int 427 crom_add_chunk(struct crom_src *src, struct crom_chunk *parent, 428 struct crom_chunk *child, int key) 429 { 430 int index; 431 432 if (parent == NULL) { 433 STAILQ_INSERT_TAIL(&src->chunk_list, child, link); 434 return 0; 435 } 436 437 index = crom_add_entry(parent, key, 0); 438 if (index < 0) 439 return -1; 440 child->ref_chunk = parent; 441 child->ref_index = index; 442 STAILQ_INSERT_TAIL(&src->chunk_list, child, link); 443 return index; 444 } 445 446 #define MAX_TEXT (int)((CROM_MAX_CHUNK_LEN + 1) * 4 - sizeof(struct csrtext)) 447 int 448 crom_add_simple_text(struct crom_src *src, struct crom_chunk *parent, 449 struct crom_chunk *chunk, const char *buf) 450 { 451 struct csrtext *tl; 452 uint32_t *p; 453 int len, i; 454 char t[MAX_TEXT]; 455 456 len = strlen(buf); 457 if (len > MAX_TEXT) { 458 printf("text(%d) trancated to %d.\n", len, MAX_TEXT); 459 len = MAX_TEXT; 460 } 461 462 tl = (struct csrtext *) &chunk->data; 463 tl->crc_len = howmany(sizeof(struct csrtext) + len, sizeof(uint32_t)); 464 tl->spec_id = 0; 465 tl->spec_type = 0; 466 tl->lang_id = 0; 467 memset(t, 0, roundup2(len, sizeof(uint32_t))); 468 memcpy(t, buf, len); 469 p = (uint32_t *)t; 470 for (i = 0; i < howmany(len, sizeof(uint32_t)); i++) 471 tl->text[i] = ntohl(*p++); 472 return crom_add_chunk(src, parent, chunk, CROM_TEXTLEAF); 473 } 474 475 static int 476 crom_copy(uint32_t *src, uint32_t *dst, int *offset, int len, int maxlen) 477 { 478 479 if (*offset + len > maxlen) { 480 printf("Config. ROM is too large for the buffer\n"); 481 return -1; 482 } 483 memcpy((char *)(dst + *offset), src, len * sizeof(uint32_t)); 484 *offset += len; 485 return 0; 486 } 487 488 int 489 crom_load(struct crom_src *src, uint32_t *buf, int maxlen) 490 { 491 struct crom_chunk *chunk, *parent; 492 struct csrhdr *hdr; 493 #if defined(_KERNEL) || defined(_BOOT) 494 uint32_t *ptr; 495 int i; 496 #endif 497 int count, offset; 498 int len; 499 500 offset = 0; 501 /* Determine offset */ 502 STAILQ_FOREACH(chunk, &src->chunk_list, link) { 503 chunk->offset = offset; 504 /* Assume the offset of the parent is already known */ 505 parent = chunk->ref_chunk; 506 if (parent != NULL) { 507 struct csrreg *reg; 508 const int ref_index = chunk->ref_index; 509 510 reg = (struct csrreg *)&parent->data.buf[ref_index]; 511 reg->val = 512 offset - (parent->offset + 1 + chunk->ref_index); 513 } 514 offset += (1 + chunk->data.crc_len); 515 } 516 517 /* Calculate CRC and dump to the buffer */ 518 len = 1 + src->hdr.info_len; 519 count = 0; 520 if (crom_copy((uint32_t *)&src->hdr, buf, &count, len, maxlen) < 0) 521 return -1; 522 STAILQ_FOREACH(chunk, &src->chunk_list, link) { 523 chunk->data.crc = 524 crom_crc(chunk->data.buf, chunk->data.crc_len); 525 526 len = 1 + chunk->data.crc_len; 527 if (crom_copy((uint32_t *)&chunk->data, buf, &count, len, 528 maxlen) < 0) 529 return -1; 530 } 531 hdr = (struct csrhdr *)buf; 532 hdr->crc_len = count - 1; 533 hdr->crc = crom_crc(&buf[1], hdr->crc_len); 534 535 #if defined(_KERNEL) || defined(_BOOT) 536 /* byte swap */ 537 ptr = buf; 538 for (i = 0; i < count; i++) { 539 *ptr = htonl(*ptr); 540 ptr++; 541 } 542 #endif 543 544 return count; 545 } 546 #endif 547 548 #ifdef TEST 549 int 550 main(void) 551 { 552 struct crom_src src; 553 struct crom_chunk root, unit1, unit2, unit3; 554 struct crom_chunk text1, text2, text3, text4, text5, text6, text7; 555 uint32_t buf[256], *p; 556 int i; 557 extern const char ostype[]; 558 559 memset(&src, 0, sizeof(src)); 560 memset(&root, 0, sizeof(root)); 561 memset(&unit1, 0, sizeof(unit1)); 562 memset(&unit2, 0, sizeof(unit2)); 563 memset(&unit3, 0, sizeof(unit3)); 564 memset(&text1, 0, sizeof(text1)); 565 memset(&text2, 0, sizeof(text2)); 566 memset(&text3, 0, sizeof(text3)); 567 memset(&text3, 0, sizeof(text4)); 568 memset(&text3, 0, sizeof(text5)); 569 memset(&text3, 0, sizeof(text6)); 570 memset(&text3, 0, sizeof(text7)); 571 memset(buf, 0, sizeof(buf)); 572 573 /* BUS info sample */ 574 src.hdr.info_len = 4; 575 src.businfo.bus_name = CSR_BUS_NAME_IEEE1394; 576 src.businfo.eui64.hi = 0x11223344; 577 src.businfo.eui64.lo = 0x55667788; 578 src.businfo.link_spd = FWSPD_S400; 579 src.businfo.generation = 0; 580 src.businfo.max_rom = MAXROM_4; 581 src.businfo.max_rec = 10; 582 src.businfo.cyc_clk_acc = 100; 583 src.businfo.pmc = 0; 584 src.businfo.bmc = 1; 585 src.businfo.isc = 1; 586 src.businfo.cmc = 1; 587 src.businfo.irmc = 1; 588 STAILQ_INIT(&src.chunk_list); 589 590 /* Root directory */ 591 crom_add_chunk(&src, NULL, &root, 0); 592 crom_add_entry(&root, CSRKEY_NCAP, 0x123456); 593 /* private company_id */ 594 crom_add_entry(&root, CSRKEY_VENDOR, 0xacde48); 595 596 crom_add_simple_text(&src, &root, &text1, ostype); 597 crom_add_entry(&root, CSRKEY_HW, __NetBSD_Version__); 598 crom_add_simple_text(&src, &root, &text2, OS_VER_STR); 599 600 /* SBP unit directory */ 601 crom_add_chunk(&src, &root, &unit1, CROM_UDIR); 602 crom_add_entry(&unit1, CSRKEY_SPEC, CSRVAL_ANSIT10); 603 crom_add_entry(&unit1, CSRKEY_VER, CSRVAL_T10SBP2); 604 crom_add_entry(&unit1, CSRKEY_COM_SPEC, CSRVAL_ANSIT10); 605 crom_add_entry(&unit1, CSRKEY_COM_SET, CSRVAL_SCSI); 606 /* management_agent */ 607 crom_add_entry(&unit1, CROM_MGM, 0x1000); 608 crom_add_entry(&unit1, CSRKEY_UNIT_CH, (10<<8) | 8); 609 /* Device type and LUN */ 610 crom_add_entry(&unit1, CROM_LUN, 0); 611 crom_add_entry(&unit1, CSRKEY_MODEL, 1); 612 crom_add_simple_text(&src, &unit1, &text3, "scsi_target"); 613 614 /* RFC2734 IPv4 over IEEE1394 */ 615 crom_add_chunk(&src, &root, &unit2, CROM_UDIR); 616 crom_add_entry(&unit2, CSRKEY_SPEC, CSRVAL_IETF); 617 crom_add_simple_text(&src, &unit2, &text4, "IANA"); 618 crom_add_entry(&unit2, CSRKEY_VER, 1); 619 crom_add_simple_text(&src, &unit2, &text5, "IPv4"); 620 621 /* RFC3146 IPv6 over IEEE1394 */ 622 crom_add_chunk(&src, &root, &unit3, CROM_UDIR); 623 crom_add_entry(&unit3, CSRKEY_SPEC, CSRVAL_IETF); 624 crom_add_simple_text(&src, &unit3, &text6, "IANA"); 625 crom_add_entry(&unit3, CSRKEY_VER, 2); 626 crom_add_simple_text(&src, &unit3, &text7, "IPv6"); 627 628 crom_load(&src, buf, 256); 629 p = buf; 630 #define DUMP_FORMAT "%08x %08x %08x %08x %08x %08x %08x %08x\n" 631 for (i = 0; i < 256 / 8; i++) { 632 printf(DUMP_FORMAT, 633 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]); 634 p += 8; 635 } 636 return 0; 637 } 638 #endif 639
Indexes created Wed Sep 24 05:09:52 GMT 2025