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