2 * csr1212.c -- IEEE 1212 Control and Status Register support for Linux
4 * Copyright (C) 2003 Francois Retief <fgretief@sun.ac.za>
5 * Steve Kinneberg <kinnebergsteve@acmsystems.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * - Verify interface consistency: i.e., public functions that take a size
33 * parameter expect size to be in bytes.
36 #include <linux/errno.h>
37 #include <linux/kernel.h>
38 #include <linux/string.h>
40 #include <asm/byteorder.h>
45 /* Permitted key type for each key id */
46 #define __I (1 << CSR1212_KV_TYPE_IMMEDIATE)
47 #define __C (1 << CSR1212_KV_TYPE_CSR_OFFSET)
48 #define __D (1 << CSR1212_KV_TYPE_DIRECTORY)
49 #define __L (1 << CSR1212_KV_TYPE_LEAF)
50 static const u8 csr1212_key_id_type_map
[0x30] = {
51 __C
, /* used by Apple iSight */
52 __D
| __L
, /* Descriptor */
53 __I
| __D
| __L
, /* Bus_Dependent_Info */
54 __I
| __D
| __L
, /* Vendor */
55 __I
, /* Hardware_Version */
57 __D
| __L
| __I
, /* Module */
58 __I
, 0, 0, 0, /* used by Apple iSight, Reserved */
59 __I
, /* Node_Capabilities */
61 0, 0, 0, /* Reserved */
63 __I
, /* Specifier_ID */
65 __I
| __C
| __D
| __L
, /* Dependent_Info */
66 __L
, /* Unit_Location */
72 __L
, /* Extended_ROM */
73 __I
, /* Extended_Key_Specifier_ID */
74 __I
, /* Extended_Key */
75 __I
| __C
| __D
| __L
, /* Extended_Data */
76 __L
, /* Modifiable_Descriptor */
77 __I
, /* Directory_ID */
86 #define quads_to_bytes(_q) ((_q) * sizeof(u32))
87 #define bytes_to_quads(_b) DIV_ROUND_UP(_b, sizeof(u32))
89 static void free_keyval(struct csr1212_keyval
*kv
)
91 if ((kv
->key
.type
== CSR1212_KV_TYPE_LEAF
) &&
92 (kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_ROM
))
93 CSR1212_FREE(kv
->value
.leaf
.data
);
98 static u16
csr1212_crc16(const u32
*buffer
, size_t length
)
104 for (; length
; length
--) {
105 data
= be32_to_cpu(*buffer
);
107 for (shift
= 28; shift
>= 0; shift
-= 4 ) {
108 sum
= ((crc
>> 12) ^ (data
>> shift
)) & 0xf;
109 crc
= (crc
<< 4) ^ (sum
<< 12) ^ (sum
<< 5) ^ (sum
);
114 return cpu_to_be16(crc
);
117 /* Microsoft computes the CRC with the bytes in reverse order. */
118 static u16
csr1212_msft_crc16(const u32
*buffer
, size_t length
)
124 for (; length
; length
--) {
125 data
= le32_to_cpu(*buffer
);
127 for (shift
= 28; shift
>= 0; shift
-= 4 ) {
128 sum
= ((crc
>> 12) ^ (data
>> shift
)) & 0xf;
129 crc
= (crc
<< 4) ^ (sum
<< 12) ^ (sum
<< 5) ^ (sum
);
134 return cpu_to_be16(crc
);
137 static struct csr1212_dentry
*
138 csr1212_find_keyval(struct csr1212_keyval
*dir
, struct csr1212_keyval
*kv
)
140 struct csr1212_dentry
*pos
;
142 for (pos
= dir
->value
.directory
.dentries_head
;
143 pos
!= NULL
; pos
= pos
->next
)
149 static struct csr1212_keyval
*
150 csr1212_find_keyval_offset(struct csr1212_keyval
*kv_list
, u32 offset
)
152 struct csr1212_keyval
*kv
;
154 for (kv
= kv_list
->next
; kv
&& (kv
!= kv_list
); kv
= kv
->next
)
155 if (kv
->offset
== offset
)
161 /* Creation Routines */
163 struct csr1212_csr
*csr1212_create_csr(struct csr1212_bus_ops
*ops
,
164 size_t bus_info_size
, void *private)
166 struct csr1212_csr
*csr
;
168 csr
= CSR1212_MALLOC(sizeof(*csr
));
173 csr1212_rom_cache_malloc(CSR1212_CONFIG_ROM_SPACE_OFFSET
,
174 CSR1212_CONFIG_ROM_SPACE_SIZE
);
175 if (!csr
->cache_head
) {
180 /* The keyval key id is not used for the root node, but a valid key id
181 * that can be used for a directory needs to be passed to
182 * csr1212_new_directory(). */
183 csr
->root_kv
= csr1212_new_directory(CSR1212_KV_ID_VENDOR
);
185 CSR1212_FREE(csr
->cache_head
);
190 csr
->bus_info_data
= csr
->cache_head
->data
;
191 csr
->bus_info_len
= bus_info_size
;
192 csr
->crc_len
= bus_info_size
;
194 csr
->private = private;
195 csr
->cache_tail
= csr
->cache_head
;
200 void csr1212_init_local_csr(struct csr1212_csr
*csr
,
201 const u32
*bus_info_data
, int max_rom
)
203 static const int mr_map
[] = { 4, 64, 1024, 0 };
205 BUG_ON(max_rom
& ~0x3);
206 csr
->max_rom
= mr_map
[max_rom
];
207 memcpy(csr
->bus_info_data
, bus_info_data
, csr
->bus_info_len
);
210 static struct csr1212_keyval
*csr1212_new_keyval(u8 type
, u8 key
)
212 struct csr1212_keyval
*kv
;
214 if (key
< 0x30 && ((csr1212_key_id_type_map
[key
] & (1 << type
)) == 0))
217 kv
= CSR1212_MALLOC(sizeof(*kv
));
221 atomic_set(&kv
->refcnt
, 1);
224 kv
->associate
= NULL
;
232 struct csr1212_keyval
*csr1212_new_immediate(u8 key
, u32 value
)
234 struct csr1212_keyval
*kv
;
236 kv
= csr1212_new_keyval(CSR1212_KV_TYPE_IMMEDIATE
, key
);
240 kv
->value
.immediate
= value
;
245 static struct csr1212_keyval
*
246 csr1212_new_leaf(u8 key
, const void *data
, size_t data_len
)
248 struct csr1212_keyval
*kv
;
250 kv
= csr1212_new_keyval(CSR1212_KV_TYPE_LEAF
, key
);
255 kv
->value
.leaf
.data
= CSR1212_MALLOC(data_len
);
256 if (!kv
->value
.leaf
.data
) {
262 memcpy(kv
->value
.leaf
.data
, data
, data_len
);
264 kv
->value
.leaf
.data
= NULL
;
267 kv
->value
.leaf
.len
= bytes_to_quads(data_len
);
274 static struct csr1212_keyval
*
275 csr1212_new_csr_offset(u8 key
, u32 csr_offset
)
277 struct csr1212_keyval
*kv
;
279 kv
= csr1212_new_keyval(CSR1212_KV_TYPE_CSR_OFFSET
, key
);
283 kv
->value
.csr_offset
= csr_offset
;
290 struct csr1212_keyval
*csr1212_new_directory(u8 key
)
292 struct csr1212_keyval
*kv
;
294 kv
= csr1212_new_keyval(CSR1212_KV_TYPE_DIRECTORY
, key
);
298 kv
->value
.directory
.len
= 0;
300 kv
->value
.directory
.dentries_head
= NULL
;
301 kv
->value
.directory
.dentries_tail
= NULL
;
306 void csr1212_associate_keyval(struct csr1212_keyval
*kv
,
307 struct csr1212_keyval
*associate
)
309 BUG_ON(!kv
|| !associate
|| kv
->key
.id
== CSR1212_KV_ID_DESCRIPTOR
||
310 (associate
->key
.id
!= CSR1212_KV_ID_DESCRIPTOR
&&
311 associate
->key
.id
!= CSR1212_KV_ID_DEPENDENT_INFO
&&
312 associate
->key
.id
!= CSR1212_KV_ID_EXTENDED_KEY
&&
313 associate
->key
.id
!= CSR1212_KV_ID_EXTENDED_DATA
&&
314 associate
->key
.id
< 0x30) ||
315 (kv
->key
.id
== CSR1212_KV_ID_EXTENDED_KEY_SPECIFIER_ID
&&
316 associate
->key
.id
!= CSR1212_KV_ID_EXTENDED_KEY
) ||
317 (kv
->key
.id
== CSR1212_KV_ID_EXTENDED_KEY
&&
318 associate
->key
.id
!= CSR1212_KV_ID_EXTENDED_DATA
) ||
319 (associate
->key
.id
== CSR1212_KV_ID_EXTENDED_KEY
&&
320 kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_KEY_SPECIFIER_ID
) ||
321 (associate
->key
.id
== CSR1212_KV_ID_EXTENDED_DATA
&&
322 kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_KEY
));
325 csr1212_release_keyval(kv
->associate
);
327 csr1212_keep_keyval(associate
);
328 kv
->associate
= associate
;
331 static int __csr1212_attach_keyval_to_directory(struct csr1212_keyval
*dir
,
332 struct csr1212_keyval
*kv
,
335 struct csr1212_dentry
*dentry
;
337 BUG_ON(!kv
|| !dir
|| dir
->key
.type
!= CSR1212_KV_TYPE_DIRECTORY
);
339 dentry
= CSR1212_MALLOC(sizeof(*dentry
));
344 csr1212_keep_keyval(kv
);
348 dentry
->prev
= dir
->value
.directory
.dentries_tail
;
350 if (!dir
->value
.directory
.dentries_head
)
351 dir
->value
.directory
.dentries_head
= dentry
;
353 if (dir
->value
.directory
.dentries_tail
)
354 dir
->value
.directory
.dentries_tail
->next
= dentry
;
355 dir
->value
.directory
.dentries_tail
= dentry
;
357 return CSR1212_SUCCESS
;
360 int csr1212_attach_keyval_to_directory(struct csr1212_keyval
*dir
,
361 struct csr1212_keyval
*kv
)
363 return __csr1212_attach_keyval_to_directory(dir
, kv
, true);
366 #define CSR1212_DESCRIPTOR_LEAF_DATA(kv) \
367 (&((kv)->value.leaf.data[1]))
369 #define CSR1212_DESCRIPTOR_LEAF_SET_TYPE(kv, type) \
370 ((kv)->value.leaf.data[0] = \
371 cpu_to_be32(CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) | \
372 ((type) << CSR1212_DESCRIPTOR_LEAF_TYPE_SHIFT)))
373 #define CSR1212_DESCRIPTOR_LEAF_SET_SPECIFIER_ID(kv, spec_id) \
374 ((kv)->value.leaf.data[0] = \
375 cpu_to_be32((CSR1212_DESCRIPTOR_LEAF_TYPE(kv) << \
376 CSR1212_DESCRIPTOR_LEAF_TYPE_SHIFT) | \
377 ((spec_id) & CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID_MASK)))
379 static struct csr1212_keyval
*
380 csr1212_new_descriptor_leaf(u8 dtype
, u32 specifier_id
,
381 const void *data
, size_t data_len
)
383 struct csr1212_keyval
*kv
;
385 kv
= csr1212_new_leaf(CSR1212_KV_ID_DESCRIPTOR
, NULL
,
386 data_len
+ CSR1212_DESCRIPTOR_LEAF_OVERHEAD
);
390 CSR1212_DESCRIPTOR_LEAF_SET_TYPE(kv
, dtype
);
391 CSR1212_DESCRIPTOR_LEAF_SET_SPECIFIER_ID(kv
, specifier_id
);
394 memcpy(CSR1212_DESCRIPTOR_LEAF_DATA(kv
), data
, data_len
);
399 /* Check if string conforms to minimal ASCII as per IEEE 1212 clause 7.4 */
400 static int csr1212_check_minimal_ascii(const char *s
)
402 static const char minimal_ascii_table
[] = {
403 /* 1 2 4 8 16 32 64 128 */
404 128, /* --, --, --, --, --, --, --, 07, */
405 4 + 16 + 32, /* --, --, 0a, --, 0C, 0D, --, --, */
406 0, /* --, --, --, --, --, --, --, --, */
407 0, /* --, --, --, --, --, --, --, --, */
408 255 - 8 - 16, /* 20, 21, 22, --, --, 25, 26, 27, */
409 255, /* 28, 29, 2a, 2b, 2c, 2d, 2e, 2f, */
410 255, /* 30, 31, 32, 33, 34, 35, 36, 37, */
411 255, /* 38, 39, 3a, 3b, 3c, 3d, 3e, 3f, */
412 255, /* 40, 41, 42, 43, 44, 45, 46, 47, */
413 255, /* 48, 49, 4a, 4b, 4c, 4d, 4e, 4f, */
414 255, /* 50, 51, 52, 53, 54, 55, 56, 57, */
415 1 + 2 + 4 + 128, /* 58, 59, 5a, --, --, --, --, 5f, */
416 255 - 1, /* --, 61, 62, 63, 64, 65, 66, 67, */
417 255, /* 68, 69, 6a, 6b, 6c, 6d, 6e, 6f, */
418 255, /* 70, 71, 72, 73, 74, 75, 76, 77, */
419 1 + 2 + 4, /* 78, 79, 7a, --, --, --, --, --, */
424 i
= *s
>> 3; /* i = *s / 8; */
425 j
= 1 << (*s
& 3); /* j = 1 << (*s % 8); */
427 if (i
>= ARRAY_SIZE(minimal_ascii_table
) ||
428 !(minimal_ascii_table
[i
] & j
))
434 /* IEEE 1212 clause 7.5.4.1 textual descriptors (English, minimal ASCII) */
435 struct csr1212_keyval
*csr1212_new_string_descriptor_leaf(const char *s
)
437 struct csr1212_keyval
*kv
;
439 size_t str_len
, quads
;
441 if (!s
|| !*s
|| csr1212_check_minimal_ascii(s
))
445 quads
= bytes_to_quads(str_len
);
446 kv
= csr1212_new_descriptor_leaf(0, 0, NULL
, quads_to_bytes(quads
) +
447 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_OVERHEAD
);
451 kv
->value
.leaf
.data
[1] = 0; /* width, character_set, language */
452 text
= CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(kv
);
453 text
[quads
- 1] = 0; /* padding */
454 memcpy(text
, s
, str_len
);
460 /* Destruction Routines */
462 void csr1212_detach_keyval_from_directory(struct csr1212_keyval
*dir
,
463 struct csr1212_keyval
*kv
)
465 struct csr1212_dentry
*dentry
;
467 if (!kv
|| !dir
|| dir
->key
.type
!= CSR1212_KV_TYPE_DIRECTORY
)
470 dentry
= csr1212_find_keyval(dir
, kv
);
476 dentry
->prev
->next
= dentry
->next
;
478 dentry
->next
->prev
= dentry
->prev
;
479 if (dir
->value
.directory
.dentries_head
== dentry
)
480 dir
->value
.directory
.dentries_head
= dentry
->next
;
481 if (dir
->value
.directory
.dentries_tail
== dentry
)
482 dir
->value
.directory
.dentries_tail
= dentry
->prev
;
484 CSR1212_FREE(dentry
);
486 csr1212_release_keyval(kv
);
489 /* This function is used to free the memory taken by a keyval. If the given
490 * keyval is a directory type, then any keyvals contained in that directory
491 * will be destroyed as well if noone holds a reference on them. By means of
492 * list manipulation, this routine will descend a directory structure in a
493 * non-recursive manner. */
494 void csr1212_release_keyval(struct csr1212_keyval
*kv
)
496 struct csr1212_keyval
*k
, *a
;
497 struct csr1212_dentry dentry
;
498 struct csr1212_dentry
*head
, *tail
;
500 if (!atomic_dec_and_test(&kv
->refcnt
))
514 /* must not dec_and_test kv->refcnt again */
515 if (k
!= kv
&& !atomic_dec_and_test(&k
->refcnt
))
520 if (k
->key
.type
== CSR1212_KV_TYPE_DIRECTORY
) {
521 /* If the current entry is a directory, move all
522 * the entries to the destruction list. */
523 if (k
->value
.directory
.dentries_head
) {
525 k
->value
.directory
.dentries_head
;
526 k
->value
.directory
.dentries_head
->prev
=
528 tail
= k
->value
.directory
.dentries_tail
;
537 if (head
->prev
&& head
->prev
!= &dentry
)
538 CSR1212_FREE(head
->prev
);
540 } else if (tail
!= &dentry
) {
546 void csr1212_destroy_csr(struct csr1212_csr
*csr
)
548 struct csr1212_csr_rom_cache
*c
, *oc
;
549 struct csr1212_cache_region
*cr
, *ocr
;
551 csr1212_release_keyval(csr
->root_kv
);
570 /* CSR Image Creation */
572 static int csr1212_append_new_cache(struct csr1212_csr
*csr
, size_t romsize
)
574 struct csr1212_csr_rom_cache
*cache
;
577 BUG_ON(!csr
|| !csr
->ops
|| !csr
->ops
->allocate_addr_range
||
578 !csr
->ops
->release_addr
|| csr
->max_rom
< 1);
580 /* ROM size must be a multiple of csr->max_rom */
581 romsize
= (romsize
+ (csr
->max_rom
- 1)) & ~(csr
->max_rom
- 1);
583 csr_addr
= csr
->ops
->allocate_addr_range(romsize
, csr
->max_rom
,
585 if (csr_addr
== CSR1212_INVALID_ADDR_SPACE
)
588 if (csr_addr
< CSR1212_REGISTER_SPACE_BASE
) {
589 /* Invalid address returned from allocate_addr_range(). */
590 csr
->ops
->release_addr(csr_addr
, csr
->private);
594 cache
= csr1212_rom_cache_malloc(csr_addr
- CSR1212_REGISTER_SPACE_BASE
,
597 csr
->ops
->release_addr(csr_addr
, csr
->private);
601 cache
->ext_rom
= csr1212_new_keyval(CSR1212_KV_TYPE_LEAF
,
602 CSR1212_KV_ID_EXTENDED_ROM
);
603 if (!cache
->ext_rom
) {
604 csr
->ops
->release_addr(csr_addr
, csr
->private);
609 if (csr1212_attach_keyval_to_directory(csr
->root_kv
, cache
->ext_rom
) !=
611 csr1212_release_keyval(cache
->ext_rom
);
612 csr
->ops
->release_addr(csr_addr
, csr
->private);
616 cache
->ext_rom
->offset
= csr_addr
- CSR1212_REGISTER_SPACE_BASE
;
617 cache
->ext_rom
->value
.leaf
.len
= -1;
618 cache
->ext_rom
->value
.leaf
.data
= cache
->data
;
620 /* Add cache to tail of cache list */
621 cache
->prev
= csr
->cache_tail
;
622 csr
->cache_tail
->next
= cache
;
623 csr
->cache_tail
= cache
;
624 return CSR1212_SUCCESS
;
627 static void csr1212_remove_cache(struct csr1212_csr
*csr
,
628 struct csr1212_csr_rom_cache
*cache
)
630 if (csr
->cache_head
== cache
)
631 csr
->cache_head
= cache
->next
;
632 if (csr
->cache_tail
== cache
)
633 csr
->cache_tail
= cache
->prev
;
636 cache
->prev
->next
= cache
->next
;
638 cache
->next
->prev
= cache
->prev
;
640 if (cache
->ext_rom
) {
641 csr1212_detach_keyval_from_directory(csr
->root_kv
,
643 csr1212_release_keyval(cache
->ext_rom
);
649 static int csr1212_generate_layout_subdir(struct csr1212_keyval
*dir
,
650 struct csr1212_keyval
**layout_tail
)
652 struct csr1212_dentry
*dentry
;
653 struct csr1212_keyval
*dkv
;
654 struct csr1212_keyval
*last_extkey_spec
= NULL
;
655 struct csr1212_keyval
*last_extkey
= NULL
;
658 for (dentry
= dir
->value
.directory
.dentries_head
; dentry
;
659 dentry
= dentry
->next
) {
660 for (dkv
= dentry
->kv
; dkv
; dkv
= dkv
->associate
) {
661 /* Special Case: Extended Key Specifier_ID */
663 CSR1212_KV_ID_EXTENDED_KEY_SPECIFIER_ID
) {
664 if (last_extkey_spec
== NULL
)
665 last_extkey_spec
= dkv
;
666 else if (dkv
->value
.immediate
!=
667 last_extkey_spec
->value
.immediate
)
668 last_extkey_spec
= dkv
;
671 /* Special Case: Extended Key */
672 } else if (dkv
->key
.id
== CSR1212_KV_ID_EXTENDED_KEY
) {
673 if (last_extkey
== NULL
)
675 else if (dkv
->value
.immediate
!=
676 last_extkey
->value
.immediate
)
684 switch (dkv
->key
.type
) {
686 case CSR1212_KV_TYPE_IMMEDIATE
:
687 case CSR1212_KV_TYPE_CSR_OFFSET
:
689 case CSR1212_KV_TYPE_LEAF
:
690 case CSR1212_KV_TYPE_DIRECTORY
:
691 /* Remove from list */
692 if (dkv
->prev
&& (dkv
->prev
->next
== dkv
))
693 dkv
->prev
->next
= dkv
->next
;
694 if (dkv
->next
&& (dkv
->next
->prev
== dkv
))
695 dkv
->next
->prev
= dkv
->prev
;
696 //if (dkv == *layout_tail)
697 // *layout_tail = dkv->prev;
699 /* Special case: Extended ROM leafs */
700 if (dkv
->key
.id
== CSR1212_KV_ID_EXTENDED_ROM
) {
701 dkv
->value
.leaf
.len
= -1;
702 /* Don't add Extended ROM leafs in the
703 * layout list, they are handled
708 /* Add to tail of list */
710 dkv
->prev
= *layout_tail
;
711 (*layout_tail
)->next
= dkv
;
720 static size_t csr1212_generate_layout_order(struct csr1212_keyval
*kv
)
722 struct csr1212_keyval
*ltail
= kv
;
726 switch (kv
->key
.type
) {
727 case CSR1212_KV_TYPE_LEAF
:
728 /* Add 1 quadlet for crc/len field */
729 agg_size
+= kv
->value
.leaf
.len
+ 1;
732 case CSR1212_KV_TYPE_DIRECTORY
:
733 kv
->value
.directory
.len
=
734 csr1212_generate_layout_subdir(kv
, <ail
);
735 /* Add 1 quadlet for crc/len field */
736 agg_size
+= kv
->value
.directory
.len
+ 1;
741 return quads_to_bytes(agg_size
);
744 static struct csr1212_keyval
*
745 csr1212_generate_positions(struct csr1212_csr_rom_cache
*cache
,
746 struct csr1212_keyval
*start_kv
, int start_pos
)
748 struct csr1212_keyval
*kv
= start_kv
;
749 struct csr1212_keyval
*okv
= start_kv
;
751 int kv_len
= 0, okv_len
= 0;
753 cache
->layout_head
= kv
;
755 while (kv
&& pos
< cache
->size
) {
756 /* Special case: Extended ROM leafs */
757 if (kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_ROM
)
758 kv
->offset
= cache
->offset
+ pos
;
760 switch (kv
->key
.type
) {
761 case CSR1212_KV_TYPE_LEAF
:
762 kv_len
= kv
->value
.leaf
.len
;
765 case CSR1212_KV_TYPE_DIRECTORY
:
766 kv_len
= kv
->value
.directory
.len
;
770 /* Should never get here */
775 pos
+= quads_to_bytes(kv_len
+ 1);
777 if (pos
<= cache
->size
) {
784 cache
->layout_tail
= okv
;
785 cache
->len
= okv
->offset
- cache
->offset
+ quads_to_bytes(okv_len
+ 1);
790 #define CSR1212_KV_KEY_SHIFT 24
791 #define CSR1212_KV_KEY_TYPE_SHIFT 6
792 #define CSR1212_KV_KEY_ID_MASK 0x3f
793 #define CSR1212_KV_KEY_TYPE_MASK 0x3 /* after shift */
796 csr1212_generate_tree_subdir(struct csr1212_keyval
*dir
, u32
*data_buffer
)
798 struct csr1212_dentry
*dentry
;
799 struct csr1212_keyval
*last_extkey_spec
= NULL
;
800 struct csr1212_keyval
*last_extkey
= NULL
;
803 for (dentry
= dir
->value
.directory
.dentries_head
;
805 dentry
= dentry
->next
) {
806 struct csr1212_keyval
*a
;
808 for (a
= dentry
->kv
; a
; a
= a
->associate
) {
811 /* Special Case: Extended Key Specifier_ID */
813 CSR1212_KV_ID_EXTENDED_KEY_SPECIFIER_ID
) {
814 if (last_extkey_spec
== NULL
)
815 last_extkey_spec
= a
;
816 else if (a
->value
.immediate
!=
817 last_extkey_spec
->value
.immediate
)
818 last_extkey_spec
= a
;
822 /* Special Case: Extended Key */
823 } else if (a
->key
.id
== CSR1212_KV_ID_EXTENDED_KEY
) {
824 if (last_extkey
== NULL
)
826 else if (a
->value
.immediate
!=
827 last_extkey
->value
.immediate
)
833 switch (a
->key
.type
) {
834 case CSR1212_KV_TYPE_IMMEDIATE
:
835 value
= a
->value
.immediate
;
837 case CSR1212_KV_TYPE_CSR_OFFSET
:
838 value
= a
->value
.csr_offset
;
840 case CSR1212_KV_TYPE_LEAF
:
842 value
-= dir
->offset
+ quads_to_bytes(1+index
);
843 value
= bytes_to_quads(value
);
845 case CSR1212_KV_TYPE_DIRECTORY
:
847 value
-= dir
->offset
+ quads_to_bytes(1+index
);
848 value
= bytes_to_quads(value
);
851 /* Should never get here */
856 value
|= (a
->key
.id
& CSR1212_KV_KEY_ID_MASK
) <<
857 CSR1212_KV_KEY_SHIFT
;
858 value
|= (a
->key
.type
& CSR1212_KV_KEY_TYPE_MASK
) <<
859 (CSR1212_KV_KEY_SHIFT
+
860 CSR1212_KV_KEY_TYPE_SHIFT
);
861 data_buffer
[index
] = cpu_to_be32(value
);
867 struct csr1212_keyval_img
{
872 u32 data
[0]; /* older gcc can't handle [] which is standard */
875 static void csr1212_fill_cache(struct csr1212_csr_rom_cache
*cache
)
877 struct csr1212_keyval
*kv
, *nkv
;
878 struct csr1212_keyval_img
*kvi
;
880 for (kv
= cache
->layout_head
;
881 kv
!= cache
->layout_tail
->next
;
883 kvi
= (struct csr1212_keyval_img
*)(cache
->data
+
884 bytes_to_quads(kv
->offset
- cache
->offset
));
885 switch (kv
->key
.type
) {
887 case CSR1212_KV_TYPE_IMMEDIATE
:
888 case CSR1212_KV_TYPE_CSR_OFFSET
:
889 /* Should never get here */
893 case CSR1212_KV_TYPE_LEAF
:
894 /* Don't copy over Extended ROM areas, they are
895 * already filled out! */
896 if (kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_ROM
)
897 memcpy(kvi
->data
, kv
->value
.leaf
.data
,
898 quads_to_bytes(kv
->value
.leaf
.len
));
900 kvi
->length
= cpu_to_be16(kv
->value
.leaf
.len
);
901 kvi
->crc
= csr1212_crc16(kvi
->data
, kv
->value
.leaf
.len
);
904 case CSR1212_KV_TYPE_DIRECTORY
:
905 csr1212_generate_tree_subdir(kv
, kvi
->data
);
907 kvi
->length
= cpu_to_be16(kv
->value
.directory
.len
);
908 kvi
->crc
= csr1212_crc16(kvi
->data
,
909 kv
->value
.directory
.len
);
915 kv
->prev
->next
= NULL
;
917 kv
->next
->prev
= NULL
;
923 /* This size is arbitrarily chosen.
924 * The struct overhead is subtracted for more economic allocations. */
925 #define CSR1212_EXTENDED_ROM_SIZE (2048 - sizeof(struct csr1212_csr_rom_cache))
927 int csr1212_generate_csr_image(struct csr1212_csr
*csr
)
929 struct csr1212_bus_info_block_img
*bi
;
930 struct csr1212_csr_rom_cache
*cache
;
931 struct csr1212_keyval
*kv
;
938 cache
= csr
->cache_head
;
940 bi
= (struct csr1212_bus_info_block_img
*)cache
->data
;
942 bi
->length
= bytes_to_quads(csr
->bus_info_len
) - 1;
943 bi
->crc_length
= bi
->length
;
944 bi
->crc
= csr1212_crc16(bi
->data
, bi
->crc_length
);
946 csr
->root_kv
->next
= NULL
;
947 csr
->root_kv
->prev
= NULL
;
949 agg_size
= csr1212_generate_layout_order(csr
->root_kv
);
951 init_offset
= csr
->bus_info_len
;
953 for (kv
= csr
->root_kv
, cache
= csr
->cache_head
;
955 cache
= cache
->next
) {
957 /* Estimate approximate number of additional cache
958 * regions needed (it assumes that the cache holding
959 * the first 1K Config ROM space always exists). */
960 int est_c
= agg_size
/ (CSR1212_EXTENDED_ROM_SIZE
-
961 (2 * sizeof(u32
))) + 1;
963 /* Add additional cache regions, extras will be
965 for (; est_c
; est_c
--) {
966 ret
= csr1212_append_new_cache(csr
,
967 CSR1212_EXTENDED_ROM_SIZE
);
968 if (ret
!= CSR1212_SUCCESS
)
971 /* Need to re-layout for additional cache regions */
972 agg_size
= csr1212_generate_layout_order(csr
->root_kv
);
974 cache
= csr
->cache_head
;
975 init_offset
= csr
->bus_info_len
;
977 kv
= csr1212_generate_positions(cache
, kv
, init_offset
);
978 agg_size
-= cache
->len
;
979 init_offset
= sizeof(u32
);
982 /* Remove unused, excess cache regions */
984 struct csr1212_csr_rom_cache
*oc
= cache
;
987 csr1212_remove_cache(csr
, oc
);
990 /* Go through the list backward so that when done, the correct CRC
991 * will be calculated for the Extended ROM areas. */
992 for (cache
= csr
->cache_tail
; cache
; cache
= cache
->prev
) {
993 /* Only Extended ROM caches should have this set. */
994 if (cache
->ext_rom
) {
997 /* Make sure the Extended ROM leaf is a multiple of
998 * max_rom in size. */
999 BUG_ON(csr
->max_rom
< 1);
1000 leaf_size
= (cache
->len
+ (csr
->max_rom
- 1)) &
1001 ~(csr
->max_rom
- 1);
1003 /* Zero out the unused ROM region */
1004 memset(cache
->data
+ bytes_to_quads(cache
->len
), 0x00,
1005 leaf_size
- cache
->len
);
1007 /* Subtract leaf header */
1008 leaf_size
-= sizeof(u32
);
1010 /* Update the Extended ROM leaf length */
1011 cache
->ext_rom
->value
.leaf
.len
=
1012 bytes_to_quads(leaf_size
);
1014 /* Zero out the unused ROM region */
1015 memset(cache
->data
+ bytes_to_quads(cache
->len
), 0x00,
1016 cache
->size
- cache
->len
);
1019 /* Copy the data into the cache buffer */
1020 csr1212_fill_cache(cache
);
1022 if (cache
!= csr
->cache_head
) {
1023 /* Set the length and CRC of the extended ROM. */
1024 struct csr1212_keyval_img
*kvi
=
1025 (struct csr1212_keyval_img
*)cache
->data
;
1026 u16 len
= bytes_to_quads(cache
->len
) - 1;
1028 kvi
->length
= cpu_to_be16(len
);
1029 kvi
->crc
= csr1212_crc16(kvi
->data
, len
);
1033 return CSR1212_SUCCESS
;
1036 int csr1212_read(struct csr1212_csr
*csr
, u32 offset
, void *buffer
, u32 len
)
1038 struct csr1212_csr_rom_cache
*cache
;
1040 for (cache
= csr
->cache_head
; cache
; cache
= cache
->next
)
1041 if (offset
>= cache
->offset
&&
1042 (offset
+ len
) <= (cache
->offset
+ cache
->size
)) {
1043 memcpy(buffer
, &cache
->data
[
1044 bytes_to_quads(offset
- cache
->offset
)],
1046 return CSR1212_SUCCESS
;
1053 * Apparently there are many different wrong implementations of the CRC
1054 * algorithm. We don't fail, we just warn... approximately once per GUID.
1057 csr1212_check_crc(const u32
*buffer
, size_t length
, u16 crc
, __be32
*guid
)
1059 static u64 last_bad_eui64
;
1060 u64 eui64
= ((u64
)be32_to_cpu(guid
[0]) << 32) | be32_to_cpu(guid
[1]);
1062 if (csr1212_crc16(buffer
, length
) == crc
||
1063 csr1212_msft_crc16(buffer
, length
) == crc
||
1064 eui64
== last_bad_eui64
)
1067 printk(KERN_DEBUG
"ieee1394: config ROM CRC error\n");
1068 last_bad_eui64
= eui64
;
1071 /* Parse a chunk of data as a Config ROM */
1073 static int csr1212_parse_bus_info_block(struct csr1212_csr
*csr
)
1075 struct csr1212_bus_info_block_img
*bi
;
1076 struct csr1212_cache_region
*cr
;
1080 for (i
= 0; i
< csr
->bus_info_len
; i
+= sizeof(u32
)) {
1081 ret
= csr
->ops
->bus_read(csr
, CSR1212_CONFIG_ROM_SPACE_BASE
+ i
,
1082 &csr
->cache_head
->data
[bytes_to_quads(i
)],
1084 if (ret
!= CSR1212_SUCCESS
)
1087 /* check ROM header's info_length */
1089 be32_to_cpu(csr
->cache_head
->data
[0]) >> 24 !=
1090 bytes_to_quads(csr
->bus_info_len
) - 1)
1094 bi
= (struct csr1212_bus_info_block_img
*)csr
->cache_head
->data
;
1095 csr
->crc_len
= quads_to_bytes(bi
->crc_length
);
1097 /* IEEE 1212 recommends that crc_len be equal to bus_info_len, but that
1098 * is not always the case, so read the rest of the crc area 1 quadlet at
1100 for (i
= csr
->bus_info_len
; i
<= csr
->crc_len
; i
+= sizeof(u32
)) {
1101 ret
= csr
->ops
->bus_read(csr
, CSR1212_CONFIG_ROM_SPACE_BASE
+ i
,
1102 &csr
->cache_head
->data
[bytes_to_quads(i
)],
1104 if (ret
!= CSR1212_SUCCESS
)
1108 csr1212_check_crc(bi
->data
, bi
->crc_length
, bi
->crc
,
1109 &csr
->bus_info_data
[3]);
1111 cr
= CSR1212_MALLOC(sizeof(*cr
));
1117 cr
->offset_start
= 0;
1118 cr
->offset_end
= csr
->crc_len
+ 4;
1120 csr
->cache_head
->filled_head
= cr
;
1121 csr
->cache_head
->filled_tail
= cr
;
1123 return CSR1212_SUCCESS
;
1126 #define CSR1212_KV_KEY(q) (be32_to_cpu(q) >> CSR1212_KV_KEY_SHIFT)
1127 #define CSR1212_KV_KEY_TYPE(q) (CSR1212_KV_KEY(q) >> CSR1212_KV_KEY_TYPE_SHIFT)
1128 #define CSR1212_KV_KEY_ID(q) (CSR1212_KV_KEY(q) & CSR1212_KV_KEY_ID_MASK)
1129 #define CSR1212_KV_VAL_MASK 0xffffff
1130 #define CSR1212_KV_VAL(q) (be32_to_cpu(q) & CSR1212_KV_VAL_MASK)
1133 csr1212_parse_dir_entry(struct csr1212_keyval
*dir
, u32 ki
, u32 kv_pos
)
1135 int ret
= CSR1212_SUCCESS
;
1136 struct csr1212_keyval
*k
= NULL
;
1138 bool keep_keyval
= true;
1140 switch (CSR1212_KV_KEY_TYPE(ki
)) {
1141 case CSR1212_KV_TYPE_IMMEDIATE
:
1142 k
= csr1212_new_immediate(CSR1212_KV_KEY_ID(ki
),
1143 CSR1212_KV_VAL(ki
));
1148 /* Don't keep local reference when parsing. */
1149 keep_keyval
= false;
1152 case CSR1212_KV_TYPE_CSR_OFFSET
:
1153 k
= csr1212_new_csr_offset(CSR1212_KV_KEY_ID(ki
),
1154 CSR1212_KV_VAL(ki
));
1159 /* Don't keep local reference when parsing. */
1160 keep_keyval
= false;
1164 /* Compute the offset from 0xffff f000 0000. */
1165 offset
= quads_to_bytes(CSR1212_KV_VAL(ki
)) + kv_pos
;
1166 if (offset
== kv_pos
) {
1167 /* Uh-oh. Can't have a relative offset of 0 for Leaves
1168 * or Directories. The Config ROM image is most likely
1169 * messed up, so we'll just abort here. */
1174 k
= csr1212_find_keyval_offset(dir
, offset
);
1177 break; /* Found it. */
1179 if (CSR1212_KV_KEY_TYPE(ki
) == CSR1212_KV_TYPE_DIRECTORY
)
1180 k
= csr1212_new_directory(CSR1212_KV_KEY_ID(ki
));
1182 k
= csr1212_new_leaf(CSR1212_KV_KEY_ID(ki
), NULL
, 0);
1188 /* Don't keep local reference when parsing. */
1189 keep_keyval
= false;
1190 /* Contents not read yet so it's not valid. */
1195 k
->next
= dir
->next
;
1196 dir
->next
->prev
= k
;
1199 ret
= __csr1212_attach_keyval_to_directory(dir
, k
, keep_keyval
);
1201 if (ret
!= CSR1212_SUCCESS
&& k
!= NULL
)
1206 int csr1212_parse_keyval(struct csr1212_keyval
*kv
,
1207 struct csr1212_csr_rom_cache
*cache
)
1209 struct csr1212_keyval_img
*kvi
;
1211 int ret
= CSR1212_SUCCESS
;
1214 kvi
= (struct csr1212_keyval_img
*)
1215 &cache
->data
[bytes_to_quads(kv
->offset
- cache
->offset
)];
1216 kvi_len
= be16_to_cpu(kvi
->length
);
1218 /* GUID is wrong in here in case of extended ROM. We don't care. */
1219 csr1212_check_crc(kvi
->data
, kvi_len
, kvi
->crc
, &cache
->data
[3]);
1221 switch (kv
->key
.type
) {
1222 case CSR1212_KV_TYPE_DIRECTORY
:
1223 for (i
= 0; i
< kvi_len
; i
++) {
1224 u32 ki
= kvi
->data
[i
];
1226 /* Some devices put null entries in their unit
1227 * directories. If we come across such an entry,
1231 ret
= csr1212_parse_dir_entry(kv
, ki
,
1232 kv
->offset
+ quads_to_bytes(i
+ 1));
1234 kv
->value
.directory
.len
= kvi_len
;
1237 case CSR1212_KV_TYPE_LEAF
:
1238 if (kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_ROM
) {
1239 size_t size
= quads_to_bytes(kvi_len
);
1241 kv
->value
.leaf
.data
= CSR1212_MALLOC(size
);
1242 if (!kv
->value
.leaf
.data
) {
1247 kv
->value
.leaf
.len
= kvi_len
;
1248 memcpy(kv
->value
.leaf
.data
, kvi
->data
, size
);
1259 csr1212_read_keyval(struct csr1212_csr
*csr
, struct csr1212_keyval
*kv
)
1261 struct csr1212_cache_region
*cr
, *ncr
, *newcr
= NULL
;
1262 struct csr1212_keyval_img
*kvi
= NULL
;
1263 struct csr1212_csr_rom_cache
*cache
;
1269 BUG_ON(!csr
|| !kv
|| csr
->max_rom
< 1);
1271 /* First find which cache the data should be in (or go in if not read
1273 for (cache
= csr
->cache_head
; cache
; cache
= cache
->next
)
1274 if (kv
->offset
>= cache
->offset
&&
1275 kv
->offset
< (cache
->offset
+ cache
->size
))
1281 /* Only create a new cache for Extended ROM leaves. */
1282 if (kv
->key
.id
!= CSR1212_KV_ID_EXTENDED_ROM
)
1285 if (csr
->ops
->bus_read(csr
,
1286 CSR1212_REGISTER_SPACE_BASE
+ kv
->offset
,
1290 kv
->value
.leaf
.len
= be32_to_cpu(q
) >> 16;
1292 cache_size
= (quads_to_bytes(kv
->value
.leaf
.len
+ 1) +
1293 (csr
->max_rom
- 1)) & ~(csr
->max_rom
- 1);
1295 cache
= csr1212_rom_cache_malloc(kv
->offset
, cache_size
);
1299 kv
->value
.leaf
.data
= &cache
->data
[1];
1300 csr
->cache_tail
->next
= cache
;
1301 cache
->prev
= csr
->cache_tail
;
1303 csr
->cache_tail
= cache
;
1304 cache
->filled_head
=
1305 CSR1212_MALLOC(sizeof(*cache
->filled_head
));
1306 if (!cache
->filled_head
)
1309 cache
->filled_head
->offset_start
= 0;
1310 cache
->filled_head
->offset_end
= sizeof(u32
);
1311 cache
->filled_tail
= cache
->filled_head
;
1312 cache
->filled_head
->next
= NULL
;
1313 cache
->filled_head
->prev
= NULL
;
1316 /* Don't read the entire extended ROM now. Pieces of it will
1317 * be read when entries inside it are read. */
1318 return csr1212_parse_keyval(kv
, cache
);
1321 cache_index
= kv
->offset
- cache
->offset
;
1323 /* Now seach read portions of the cache to see if it is there. */
1324 for (cr
= cache
->filled_head
; cr
; cr
= cr
->next
) {
1325 if (cache_index
< cr
->offset_start
) {
1326 newcr
= CSR1212_MALLOC(sizeof(*newcr
));
1330 newcr
->offset_start
= cache_index
& ~(csr
->max_rom
- 1);
1331 newcr
->offset_end
= newcr
->offset_start
;
1333 newcr
->prev
= cr
->prev
;
1337 } else if ((cache_index
>= cr
->offset_start
) &&
1338 (cache_index
< cr
->offset_end
)) {
1339 kvi
= (struct csr1212_keyval_img
*)
1340 (&cache
->data
[bytes_to_quads(cache_index
)]);
1341 kv_len
= quads_to_bytes(be16_to_cpu(kvi
->length
) + 1);
1343 } else if (cache_index
== cr
->offset_end
) {
1349 cr
= cache
->filled_tail
;
1350 newcr
= CSR1212_MALLOC(sizeof(*newcr
));
1354 newcr
->offset_start
= cache_index
& ~(csr
->max_rom
- 1);
1355 newcr
->offset_end
= newcr
->offset_start
;
1357 newcr
->next
= cr
->next
;
1360 cache
->filled_tail
= newcr
;
1363 while(!kvi
|| cr
->offset_end
< cache_index
+ kv_len
) {
1364 cache_ptr
= &cache
->data
[bytes_to_quads(cr
->offset_end
&
1365 ~(csr
->max_rom
- 1))];
1367 addr
= (CSR1212_CSR_ARCH_REG_SPACE_BASE
+ cache
->offset
+
1368 cr
->offset_end
) & ~(csr
->max_rom
- 1);
1370 if (csr
->ops
->bus_read(csr
, addr
, cache_ptr
, csr
->private))
1373 cr
->offset_end
+= csr
->max_rom
- (cr
->offset_end
&
1374 (csr
->max_rom
- 1));
1376 if (!kvi
&& (cr
->offset_end
> cache_index
)) {
1377 kvi
= (struct csr1212_keyval_img
*)
1378 (&cache
->data
[bytes_to_quads(cache_index
)]);
1379 kv_len
= quads_to_bytes(be16_to_cpu(kvi
->length
) + 1);
1382 if ((kv_len
+ (kv
->offset
- cache
->offset
)) > cache
->size
) {
1383 /* The Leaf or Directory claims its length extends
1384 * beyond the ConfigROM image region and thus beyond the
1385 * end of our cache region. Therefore, we abort now
1386 * rather than seg faulting later. */
1392 if (ncr
&& (cr
->offset_end
>= ncr
->offset_start
)) {
1393 /* consolidate region entries */
1394 ncr
->offset_start
= cr
->offset_start
;
1397 cr
->prev
->next
= cr
->next
;
1398 ncr
->prev
= cr
->prev
;
1399 if (cache
->filled_head
== cr
)
1400 cache
->filled_head
= ncr
;
1406 return csr1212_parse_keyval(kv
, cache
);
1409 struct csr1212_keyval
*
1410 csr1212_get_keyval(struct csr1212_csr
*csr
, struct csr1212_keyval
*kv
)
1415 if (csr1212_read_keyval(csr
, kv
) != CSR1212_SUCCESS
)
1420 int csr1212_parse_csr(struct csr1212_csr
*csr
)
1422 struct csr1212_dentry
*dentry
;
1425 BUG_ON(!csr
|| !csr
->ops
|| !csr
->ops
->bus_read
);
1427 ret
= csr1212_parse_bus_info_block(csr
);
1428 if (ret
!= CSR1212_SUCCESS
)
1432 * There has been a buggy firmware with bus_info_block.max_rom > 0
1433 * spotted which actually only supported quadlet read requests to the
1434 * config ROM. Therefore read everything quadlet by quadlet regardless
1435 * of what the bus info block says.
1439 csr
->cache_head
->layout_head
= csr
->root_kv
;
1440 csr
->cache_head
->layout_tail
= csr
->root_kv
;
1442 csr
->root_kv
->offset
= (CSR1212_CONFIG_ROM_SPACE_BASE
& 0xffff) +
1445 csr
->root_kv
->valid
= 0;
1446 csr
->root_kv
->next
= csr
->root_kv
;
1447 csr
->root_kv
->prev
= csr
->root_kv
;
1448 ret
= csr1212_read_keyval(csr
, csr
->root_kv
);
1449 if (ret
!= CSR1212_SUCCESS
)
1452 /* Scan through the Root directory finding all extended ROM regions
1453 * and make cache regions for them */
1454 for (dentry
= csr
->root_kv
->value
.directory
.dentries_head
;
1455 dentry
; dentry
= dentry
->next
) {
1456 if (dentry
->kv
->key
.id
== CSR1212_KV_ID_EXTENDED_ROM
&&
1457 !dentry
->kv
->valid
) {
1458 ret
= csr1212_read_keyval(csr
, dentry
->kv
);
1459 if (ret
!= CSR1212_SUCCESS
)
1464 return CSR1212_SUCCESS
;