Home | History | Annotate | Line # | Download | only in ieee1394
iec13213.h revision 1.4 
      1 /*	$NetBSD: iec13213.h,v 1.4 2010/03/29 03:05:28 kiyohara Exp $	*/
      2 /*-
      3  * Copyright (c) 2003 Hidetoshi Shimokawa
      4  * Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, 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. All advertising materials mentioning features or use of this software
     16  *    must display the acknowledgement as bellow:
     17  *
     18  *    This product includes software developed by K. Kobayashi and H. Shimokawa
     19  *
     20  * 4. The name of the author may not be used to endorse or promote products
     21  *    derived from this software without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     26  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
     27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     29  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     31  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     33  * POSSIBILITY OF SUCH DAMAGE.
     34  *
     35  * $FreeBSD: /repoman/r/ncvs/src/sys/dev/firewire/iec13213.h,v 1.14 2005/01/06 01:42:41 imp Exp $
     36  *
     37  */
     38 
     39 #ifndef _IEC13213_H_
     40 #define _IEC13213_H_
     41 
     42 #define	STATE_CLEAR	0x0000
     43 #define	STATE_SET	0x0004
     44 #define	NODE_IDS	0x0008
     45 #define	RESET_START	0x000c
     46 #define	SPLIT_TIMEOUT_HI	0x0018
     47 #define	SPLIT_TIMEOUT_LO	0x001c
     48 #define	CYCLE_TIME	0x0200
     49 #define	BUS_TIME	0x0204
     50 #define	BUSY_TIMEOUT	0x0210
     51 #define	PRIORITY_BUDGET 0x0218
     52 #define	BUS_MGR_ID	0x021c
     53 #define	BANDWIDTH_AV	0x0220
     54 #define	CHANNELS_AV_HI	0x0224
     55 #define	CHANNELS_AV_LO	0x0228
     56 #define	IP_CHANNELS	0x0234
     57 
     58 #define	CONF_ROM	0x0400
     59 
     60 #define	TOPO_MAP	0x1000
     61 #define	SPED_MAP	0x2000
     62 
     63 #define CSRTYPE_SHIFT	6
     64 #define CSRTYPE_MASK	(3 << CSRTYPE_SHIFT)
     65 #define CSRTYPE_I	(0 << CSRTYPE_SHIFT) /* Immediate */
     66 #define CSRTYPE_C	(1 << CSRTYPE_SHIFT) /* CSR offset */
     67 #define CSRTYPE_L	(2 << CSRTYPE_SHIFT) /* Leaf */
     68 #define CSRTYPE_D	(3 << CSRTYPE_SHIFT) /* Directory */
     69 
     70 /*
     71  * CSR keys
     72  * 00 - 2F: defined by CSR architecture standards.
     73  * 30 - 37: defined by BUS starndards
     74  * 38 - 3F: defined by Vendor/Specifier
     75  */
     76 #define CSRKEY_MASK	0x3f
     77 #define CSRKEY_DESC	0x01 /* Descriptor */
     78 #define CSRKEY_BDINFO	0x02 /* Bus_Dependent_Info */
     79 #define CSRKEY_VENDOR	0x03 /* Vendor */
     80 #define CSRKEY_HW	0x04 /* Hardware_Version */
     81 #define CSRKEY_MODULE	0x07 /* Module */
     82 #define CSRKEY_NCAP	0x0c /* Node_Capabilities */
     83 #define CSRKEY_EUI64	0x0d /* EUI_64 */
     84 #define CSRKEY_UNIT	0x11 /* Unit */
     85 #define CSRKEY_SPEC	0x12 /* Specifier_ID */
     86 #define CSRKEY_VER	0x13 /* Version */
     87 #define CSRKEY_DINFO	0x14 /* Dependent_Info */
     88 #define CSRKEY_ULOC	0x15 /* Unit_Location */
     89 #define CSRKEY_MODEL	0x17 /* Model */
     90 #define CSRKEY_INST	0x18 /* Instance */
     91 #define CSRKEY_KEYW	0x19 /* Keyword */
     92 #define CSRKEY_FEAT	0x1a /* Feature */
     93 #define CSRKEY_EROM	0x1b /* Extended_ROM */
     94 #define CSRKEY_EKSID	0x1c /* Extended_Key_Specifier_ID */
     95 #define CSRKEY_EKEY	0x1d /* Extended_Key */
     96 #define CSRKEY_EDATA	0x1e /* Extended_Data */
     97 #define CSRKEY_MDESC	0x1f /* Modifiable_Descriptor */
     98 #define CSRKEY_DID	0x20 /* Directory_ID */
     99 #define CSRKEY_REV	0x21 /* Revision */
    100 
    101 #define CSRKEY_FIRM_VER	0x3c /* Firmware version */
    102 #define CSRKEY_UNIT_CH	0x3a /* Unit characteristics */
    103 #define CSRKEY_COM_SPEC	0x38 /* Command set revision */
    104 #define CSRKEY_COM_SET	0x39 /* Command set */
    105 
    106 #define CROM_UDIR	(CSRTYPE_D | CSRKEY_UNIT)  /* 0x81 Unit directory */
    107 #define CROM_TEXTLEAF	(CSRTYPE_L | CSRKEY_DESC)  /* 0x81 Text leaf */
    108 #define CROM_LUN	(CSRTYPE_I | CSRKEY_DINFO) /* 0x14 Logical unit num. */
    109 #define CROM_MGM	(CSRTYPE_C | CSRKEY_DINFO) /* 0x54 Management agent */
    110 
    111 #define CSRVAL_VENDOR_PRIVATE	0xacde48
    112 #define CSRVAL_1394TA	0x00a02d
    113 #define CSRVAL_ANSIT10	0x00609e
    114 #define CSRVAL_IETF	0x00005e
    115 
    116 #define CSR_PROTAVC	0x010001
    117 #define CSR_PROTCAL	0x010002
    118 #define CSR_PROTEHS	0x010004
    119 #define CSR_PROTHAVI	0x010008
    120 #define CSR_PROTCAM104	0x000100
    121 #define CSR_PROTCAM120	0x000101
    122 #define CSR_PROTCAM130	0x000102
    123 #define CSR_PROTDPP	0x0a6be2
    124 #define CSR_PROTIICP	0x4b661f
    125 
    126 #define CSRVAL_T10SBP2	0x010483
    127 #define CSRVAL_SCSI	0x0104d8
    128 
    129 struct csrreg {
    130 #if BYTE_ORDER == BIG_ENDIAN
    131 	uint32_t key:8,
    132 		 val:24;
    133 #else
    134 	uint32_t val:24,
    135 		 key:8;
    136 #endif
    137 };
    138 struct csrhdr {
    139 #if BYTE_ORDER == BIG_ENDIAN
    140 	uint32_t info_len:8,
    141 		 crc_len:8,
    142 		 crc:16;
    143 #else
    144 	uint32_t crc:16,
    145 		 crc_len:8,
    146 		 info_len:8;
    147 #endif
    148 };
    149 struct csrdirectory {
    150 	BIT16x2(crc_len, crc);
    151 	struct csrreg entry[0];
    152 };
    153 struct csrtext {
    154 	BIT16x2(crc_len, crc);
    155 #if BYTE_ORDER == BIG_ENDIAN
    156 	uint32_t spec_type:8,
    157 		 spec_id:24;
    158 #else
    159 	uint32_t spec_id:24,
    160 		 spec_type:8;
    161 #endif
    162 	uint32_t lang_id;
    163 	uint32_t text[0];
    164 };
    165 
    166 struct bus_info {
    167 #define	CSR_BUS_NAME_IEEE1394	0x31333934
    168 	uint32_t bus_name;
    169 #if BYTE_ORDER == BIG_ENDIAN
    170 	uint32_t irmc:1,		/* iso. resource manager capable */
    171 		 cmc:1,			/* cycle master capable */
    172 		 isc:1,			/* iso. operation support */
    173 		 bmc:1,			/* bus manager capable */
    174 		 pmc:1,			/* power manager capable */
    175 		 :3,
    176 		 cyc_clk_acc:8,		/* 0 <= ppm <= 100 */
    177 		 max_rec:4,		/* (2 << max_rec) bytes */
    178 		 :2,
    179 		 max_rom:2,
    180 		 generation:4,
    181 		 :1,
    182 		 link_spd:3;
    183 #else
    184 	uint32_t link_spd:3,
    185 		 :1,
    186 		 generation:4,
    187 		 max_rom:2,
    188 		 :2,
    189 		 max_rec:4,		/* (2 << max_rec) bytes */
    190 		 cyc_clk_acc:8,		/* 0 <= ppm <= 100 */
    191 		 :3,
    192 		 pmc:1,			/* power manager capable */
    193 		 bmc:1,			/* bus manager capable */
    194 		 isc:1,			/* iso. operation support */
    195 		 cmc:1,			/* cycle master capable */
    196 		 irmc:1;		/* iso. resource manager capable */
    197 #endif
    198 	struct fw_eui64 eui64;
    199 };
    200 /* max_rom */
    201 #define MAXROM_4	0
    202 #define MAXROM_64	1
    203 #define MAXROM_1024	2
    204 
    205 #define CROM_MAX_DEPTH	10
    206 struct crom_ptr {
    207 	struct csrdirectory *dir;
    208 	int index;
    209 };
    210 
    211 struct crom_context {
    212 	int depth;
    213 	struct crom_ptr stack[CROM_MAX_DEPTH];
    214 };
    215 
    216 void crom_init_context(struct crom_context *, uint32_t *);
    217 struct csrreg *crom_get(struct crom_context *);
    218 void crom_next(struct crom_context *);
    219 void crom_parse_text(struct crom_context *, char *, int);
    220 uint16_t crom_crc(uint32_t *r, int);
    221 struct csrreg *crom_search_key(struct crom_context *, uint8_t);
    222 int crom_has_specver(uint32_t *, uint32_t, uint32_t);
    223 
    224 #ifndef _KERNEL
    225 const char *crom_desc(struct crom_context *, char *, int);
    226 #endif
    227 
    228 /* For CROM build */
    229 #if defined(_KERNEL) || defined(TEST)
    230 #define CROM_MAX_CHUNK_LEN 20
    231 struct crom_src {
    232 	struct csrhdr hdr;
    233 	struct bus_info businfo;
    234 	STAILQ_HEAD(, crom_chunk) chunk_list;
    235 };
    236 
    237 struct crom_chunk {
    238 	STAILQ_ENTRY(crom_chunk) link;
    239 	struct crom_chunk *ref_chunk;
    240 	int ref_index;
    241 	int offset;
    242 	struct {
    243 		BIT16x2(crc_len, crc);
    244 		uint32_t buf[CROM_MAX_CHUNK_LEN];
    245 	} data;
    246 };
    247 
    248 extern int crom_add_quad(struct crom_chunk *, uint32_t);
    249 extern int crom_add_entry(struct crom_chunk *, int, int);
    250 extern int crom_add_chunk(struct crom_src *src, struct crom_chunk *,
    251 					struct crom_chunk *, int);
    252 extern int crom_add_simple_text(struct crom_src *src, struct crom_chunk *,
    253 					struct crom_chunk *, const char *);
    254 extern int crom_load(struct crom_src *, uint32_t *, int);
    255 #endif
    256 
    257 #endif	/* _IEC13213_H_ */
    258