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