1 /* $NetBSD: fwcrom.c,v 1.12 2010/04/24 21:34:29 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.12 2010/04/24 21:34:29 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 if (reg->key != CROM_TEXTLEAF || 182 (char *)(reg + reg->val) > CROM_END(cc)) { 183 strncpy(buf, nullstr, len); 184 return; 185 } 186 textleaf = (struct csrtext *)(reg + reg->val); 187 188 if ((char *)textleaf + textleaf->crc_len > CROM_END(cc)) { 189 strncpy(buf, nullstr, len); 190 return; 191 } 192 193 /* XXX should check spec and type */ 194 195 bp = (uint32_t *)buf; 196 qlen = textleaf->crc_len - 2; 197 if (len < qlen * 4) 198 qlen = len/4; 199 for (i = 0; i < qlen; i++) 200 *bp++ = ntohl(textleaf->text[i]); 201 /* make sure to terminate the string */ 202 if (len <= qlen * 4) 203 buf[len - 1] = 0; 204 else 205 buf[qlen * 4] = 0; 206 } 207 208 uint16_t 209 crom_crc(uint32_t *ptr, int len) 210 { 211 int i, shift; 212 uint32_t data, sum, crc = 0; 213 214 for (i = 0; i < len; i++) { 215 data = ptr[i]; 216 for (shift = 28; shift >= 0; shift -= 4) { 217 sum = ((crc >> 12) ^ (data >> shift)) & 0xf; 218 crc = (crc << 4) ^ (sum << 12) ^ (sum << 5) ^ sum; 219 } 220 crc &= 0xffff; 221 } 222 return (uint16_t)crc; 223 } 224 225 #if !defined(_KERNEL) && !defined(_BOOT) 226 static void 227 crom_desc_specver(uint32_t spec, uint32_t ver, char *buf, int len) 228 { 229 const char *s = NULL; 230 231 if (spec == CSRVAL_ANSIT10 || spec == 0) { 232 switch (ver) { 233 case CSRVAL_T10SBP2: 234 s = "SBP-2"; 235 break; 236 default: 237 if (spec != 0) 238 s = "unknown ANSIT10"; 239 } 240 } 241 if (spec == CSRVAL_1394TA || spec == 0) { 242 switch (ver) { 243 case CSR_PROTAVC: 244 s = "AV/C"; 245 break; 246 case CSR_PROTCAL: 247 s = "CAL"; 248 break; 249 case CSR_PROTEHS: 250 s = "EHS"; 251 break; 252 case CSR_PROTHAVI: 253 s = "HAVi"; 254 break; 255 case CSR_PROTCAM104: 256 s = "1394 Cam 1.04"; 257 break; 258 case CSR_PROTCAM120: 259 s = "1394 Cam 1.20"; 260 break; 261 case CSR_PROTCAM130: 262 s = "1394 Cam 1.30"; 263 break; 264 case CSR_PROTDPP: 265 s = "1394 Direct print"; 266 break; 267 case CSR_PROTIICP: 268 s = "Industrial & Instrument"; 269 break; 270 default: 271 if (spec != 0) 272 s = "unknown 1394TA"; 273 } 274 } 275 if (s != NULL) 276 snprintf(buf, len, "%s", s); 277 } 278 279 const char * 280 crom_desc(struct crom_context *cc, char *buf, int len) 281 { 282 struct csrreg *reg; 283 struct csrdirectory *dir; 284 const char *desc; 285 uint16_t crc; 286 287 reg = crom_get(cc); 288 switch (reg->key & CSRTYPE_MASK) { 289 case CSRTYPE_I: 290 #if 0 291 len -= snprintf(buf, len, "%d", reg->val); 292 buf += strlen(buf); 293 #else 294 *buf = '\0'; 295 #endif 296 break; 297 case CSRTYPE_C: 298 len -= 299 snprintf(buf, len, "offset=0x%04x(%d)", reg->val, reg->val); 300 buf += strlen(buf); 301 break; 302 case CSRTYPE_L: 303 /* XXX fall through */ 304 case CSRTYPE_D: 305 dir = (struct csrdirectory *) (reg + reg->val); 306 crc = crom_crc((uint32_t *)dir->entry, dir->crc_len); 307 len -= snprintf(buf, len, "len=%d crc=0x%04x(%s) ", 308 dir->crc_len, dir->crc, (crc == dir->crc) ? "OK" : "NG"); 309 buf += strlen(buf); 310 } 311 switch (reg->key) { 312 case 0x03: 313 desc = "module_vendor_ID"; 314 break; 315 case 0x04: 316 desc = "hardware_version"; 317 break; 318 case 0x0c: 319 desc = "node_capabilities"; 320 break; 321 case 0x12: 322 desc = "unit_spec_ID"; 323 break; 324 case 0x13: 325 desc = "unit_sw_version"; 326 crom_desc_specver(0, reg->val, buf, len); 327 break; 328 case 0x14: 329 desc = "logical_unit_number"; 330 break; 331 case 0x17: 332 desc = "model_ID"; 333 break; 334 case 0x38: 335 desc = "command_set_spec_ID"; 336 break; 337 case 0x39: 338 desc = "command_set"; 339 break; 340 case 0x3a: 341 desc = "unit_characteristics"; 342 break; 343 case 0x3b: 344 desc = "command_set_revision"; 345 break; 346 case 0x3c: 347 desc = "firmware_revision"; 348 break; 349 case 0x3d: 350 desc = "reconnect_timeout"; 351 break; 352 case 0x54: 353 desc = "management_agent"; 354 break; 355 case 0x81: 356 desc = "text_leaf"; 357 crom_parse_text(cc, buf + strlen(buf), len); 358 break; 359 case 0xd1: 360 desc = "unit_directory"; 361 break; 362 case 0xd4: 363 desc = "logical_unit_directory"; 364 break; 365 default: 366 desc = "unknown"; 367 } 368 return desc; 369 } 370 #endif 371 372 #if defined(_KERNEL) || defined(_BOOT) || defined(TEST) 373 374 int 375 crom_add_quad(struct crom_chunk *chunk, uint32_t entry) 376 { 377 int index; 378 379 index = chunk->data.crc_len; 380 if (index >= CROM_MAX_CHUNK_LEN - 1) { 381 printf("too large chunk %d\n", index); 382 return -1; 383 } 384 chunk->data.buf[index] = entry; 385 chunk->data.crc_len++; 386 return index; 387 } 388 389 int 390 crom_add_entry(struct crom_chunk *chunk, int key, int val) 391 { 392 union { 393 struct csrreg reg; 394 uint32_t i; 395 } foo; 396 397 foo.reg.key = key; 398 foo.reg.val = val; 399 400 return crom_add_quad(chunk, foo.i); 401 } 402 403 int 404 crom_add_chunk(struct crom_src *src, struct crom_chunk *parent, 405 struct crom_chunk *child, int key) 406 { 407 int index; 408 409 if (parent == NULL) { 410 STAILQ_INSERT_TAIL(&src->chunk_list, child, link); 411 return 0; 412 } 413 414 index = crom_add_entry(parent, key, 0); 415 if (index < 0) 416 return -1; 417 child->ref_chunk = parent; 418 child->ref_index = index; 419 STAILQ_INSERT_TAIL(&src->chunk_list, child, link); 420 return index; 421 } 422 423 #define MAX_TEXT (int)((CROM_MAX_CHUNK_LEN + 1) * 4 - sizeof(struct csrtext)) 424 int 425 crom_add_simple_text(struct crom_src *src, struct crom_chunk *parent, 426 struct crom_chunk *chunk, const char *buf) 427 { 428 struct csrtext *tl; 429 uint32_t *p; 430 int len, i; 431 char t[MAX_TEXT]; 432 433 len = strlen(buf); 434 if (len > MAX_TEXT) { 435 printf("text(%d) trancated to %d.\n", len, MAX_TEXT); 436 len = MAX_TEXT; 437 } 438 439 tl = (struct csrtext *) &chunk->data; 440 tl->crc_len = howmany(sizeof(struct csrtext) + len, sizeof(uint32_t)); 441 tl->spec_id = 0; 442 tl->spec_type = 0; 443 tl->lang_id = 0; 444 memset(t, 0, roundup2(len, sizeof(uint32_t))); 445 memcpy(t, buf, len); 446 p = (uint32_t *)t; 447 for (i = 0; i < howmany(len, sizeof(uint32_t)); i++) 448 tl->text[i] = ntohl(*p++); 449 return crom_add_chunk(src, parent, chunk, CROM_TEXTLEAF); 450 } 451 452 static int 453 crom_copy(uint32_t *src, uint32_t *dst, int *offset, int len, int maxlen) 454 { 455 456 if (*offset + len > maxlen) { 457 printf("Config. ROM is too large for the buffer\n"); 458 return -1; 459 } 460 memcpy((char *)(dst + *offset), src, len * sizeof(uint32_t)); 461 *offset += len; 462 return 0; 463 } 464 465 int 466 crom_load(struct crom_src *src, uint32_t *buf, int maxlen) 467 { 468 struct crom_chunk *chunk, *parent; 469 struct csrhdr *hdr; 470 #if defined(_KERNEL) || defined(_BOOT) 471 uint32_t *ptr; 472 int i; 473 #endif 474 int count, offset; 475 int len; 476 477 offset = 0; 478 /* Determine offset */ 479 STAILQ_FOREACH(chunk, &src->chunk_list, link) { 480 chunk->offset = offset; 481 /* Assume the offset of the parent is already known */ 482 parent = chunk->ref_chunk; 483 if (parent != NULL) { 484 struct csrreg *reg; 485 const int ref_index = chunk->ref_index; 486 487 reg = (struct csrreg *)&parent->data.buf[ref_index]; 488 reg->val = 489 offset - (parent->offset + 1 + chunk->ref_index); 490 } 491 offset += (1 + chunk->data.crc_len); 492 } 493 494 /* Calculate CRC and dump to the buffer */ 495 len = 1 + src->hdr.info_len; 496 count = 0; 497 if (crom_copy((uint32_t *)&src->hdr, buf, &count, len, maxlen) < 0) 498 return -1; 499 STAILQ_FOREACH(chunk, &src->chunk_list, link) { 500 chunk->data.crc = 501 crom_crc(chunk->data.buf, chunk->data.crc_len); 502 503 len = 1 + chunk->data.crc_len; 504 if (crom_copy((uint32_t *)&chunk->data, buf, &count, len, 505 maxlen) < 0) 506 return -1; 507 } 508 hdr = (struct csrhdr *)buf; 509 hdr->crc_len = count - 1; 510 hdr->crc = crom_crc(&buf[1], hdr->crc_len); 511 512 #if defined(_KERNEL) || defined(_BOOT) 513 /* byte swap */ 514 ptr = buf; 515 for (i = 0; i < count; i++) { 516 *ptr = htonl(*ptr); 517 ptr++; 518 } 519 #endif 520 521 return count; 522 } 523 #endif 524 525 #ifdef TEST 526 int 527 main(void) 528 { 529 struct crom_src src; 530 struct crom_chunk root, unit1, unit2, unit3; 531 struct crom_chunk text1, text2, text3, text4, text5, text6, text7; 532 uint32_t buf[256], *p; 533 int i; 534 extern const char ostype[]; 535 536 memset(&src, 0, sizeof(src)); 537 memset(&root, 0, sizeof(root)); 538 memset(&unit1, 0, sizeof(unit1)); 539 memset(&unit2, 0, sizeof(unit2)); 540 memset(&unit3, 0, sizeof(unit3)); 541 memset(&text1, 0, sizeof(text1)); 542 memset(&text2, 0, sizeof(text2)); 543 memset(&text3, 0, sizeof(text3)); 544 memset(&text3, 0, sizeof(text4)); 545 memset(&text3, 0, sizeof(text5)); 546 memset(&text3, 0, sizeof(text6)); 547 memset(&text3, 0, sizeof(text7)); 548 memset(buf, 0, sizeof(buf)); 549 550 /* BUS info sample */ 551 src.hdr.info_len = 4; 552 src.businfo.bus_name = CSR_BUS_NAME_IEEE1394; 553 src.businfo.eui64.hi = 0x11223344; 554 src.businfo.eui64.lo = 0x55667788; 555 src.businfo.link_spd = FWSPD_S400; 556 src.businfo.generation = 0; 557 src.businfo.max_rom = MAXROM_4; 558 src.businfo.max_rec = 10; 559 src.businfo.cyc_clk_acc = 100; 560 src.businfo.pmc = 0; 561 src.businfo.bmc = 1; 562 src.businfo.isc = 1; 563 src.businfo.cmc = 1; 564 src.businfo.irmc = 1; 565 STAILQ_INIT(&src.chunk_list); 566 567 /* Root directory */ 568 crom_add_chunk(&src, NULL, &root, 0); 569 crom_add_entry(&root, CSRKEY_NCAP, 0x123456); 570 /* private company_id */ 571 crom_add_entry(&root, CSRKEY_VENDOR, 0xacde48); 572 573 crom_add_simple_text(&src, &root, &text1, ostype); 574 crom_add_entry(&root, CSRKEY_HW, __NetBSD_Version__); 575 crom_add_simple_text(&src, &root, &text2, OS_VER_STR); 576 577 /* SBP unit directory */ 578 crom_add_chunk(&src, &root, &unit1, CROM_UDIR); 579 crom_add_entry(&unit1, CSRKEY_SPEC, CSRVAL_ANSIT10); 580 crom_add_entry(&unit1, CSRKEY_VER, CSRVAL_T10SBP2); 581 crom_add_entry(&unit1, CSRKEY_COM_SPEC, CSRVAL_ANSIT10); 582 crom_add_entry(&unit1, CSRKEY_COM_SET, CSRVAL_SCSI); 583 /* management_agent */ 584 crom_add_entry(&unit1, CROM_MGM, 0x1000); 585 crom_add_entry(&unit1, CSRKEY_UNIT_CH, (10<<8) | 8); 586 /* Device type and LUN */ 587 crom_add_entry(&unit1, CROM_LUN, 0); 588 crom_add_entry(&unit1, CSRKEY_MODEL, 1); 589 crom_add_simple_text(&src, &unit1, &text3, "scsi_target"); 590 591 /* RFC2734 IPv4 over IEEE1394 */ 592 crom_add_chunk(&src, &root, &unit2, CROM_UDIR); 593 crom_add_entry(&unit2, CSRKEY_SPEC, CSRVAL_IETF); 594 crom_add_simple_text(&src, &unit2, &text4, "IANA"); 595 crom_add_entry(&unit2, CSRKEY_VER, 1); 596 crom_add_simple_text(&src, &unit2, &text5, "IPv4"); 597 598 /* RFC3146 IPv6 over IEEE1394 */ 599 crom_add_chunk(&src, &root, &unit3, CROM_UDIR); 600 crom_add_entry(&unit3, CSRKEY_SPEC, CSRVAL_IETF); 601 crom_add_simple_text(&src, &unit3, &text6, "IANA"); 602 crom_add_entry(&unit3, CSRKEY_VER, 2); 603 crom_add_simple_text(&src, &unit3, &text7, "IPv6"); 604 605 crom_load(&src, buf, 256); 606 p = buf; 607 #define DUMP_FORMAT "%08x %08x %08x %08x %08x %08x %08x %08x\n" 608 for (i = 0; i < 256 / 8; i++) { 609 printf(DUMP_FORMAT, 610 p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]); 611 p += 8; 612 } 613 return 0; 614 } 615 #endif 616