drivers/ieee1394/csr1212.h

   1 /*
   2  * csr1212.h -- IEEE 1212 Control and Status Register support for Linux
   3  *
   4  * Copyright (C) 2003 Francois Retief <fgretief@sun.ac.za>
   5  *                    Steve Kinneberg <kinnebergsteve@acmsystems.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions are met:
   9  *
  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.
  17  *
  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.
  28  */
  29
  30 #ifndef __CSR1212_H__
  31 #define __CSR1212_H__
  32
  33 #include <linux/types.h>
  34 #include <linux/slab.h>
  35
  36 #define CSR1212_MALLOC(size)    kmalloc((size), GFP_KERNEL)
  37 #define CSR1212_FREE(ptr)       kfree(ptr)
  38
  39 #define CSR1212_SUCCESS (0)
  40
  41
  42 /* CSR 1212 key types */
  43 #define CSR1212_KV_TYPE_IMMEDIATE               0
  44 #define CSR1212_KV_TYPE_CSR_OFFSET              1
  45 #define CSR1212_KV_TYPE_LEAF                    2
  46 #define CSR1212_KV_TYPE_DIRECTORY               3
  47
  48
  49 /* CSR 1212 key ids */
  50 #define CSR1212_KV_ID_DESCRIPTOR                0x01
  51 #define CSR1212_KV_ID_BUS_DEPENDENT_INFO        0x02
  52 #define CSR1212_KV_ID_VENDOR                    0x03
  53 #define CSR1212_KV_ID_HARDWARE_VERSION          0x04
  54 #define CSR1212_KV_ID_MODULE                    0x07
  55 #define CSR1212_KV_ID_NODE_CAPABILITIES         0x0C
  56 #define CSR1212_KV_ID_EUI_64                    0x0D
  57 #define CSR1212_KV_ID_UNIT                      0x11
  58 #define CSR1212_KV_ID_SPECIFIER_ID              0x12
  59 #define CSR1212_KV_ID_VERSION                   0x13
  60 #define CSR1212_KV_ID_DEPENDENT_INFO            0x14
  61 #define CSR1212_KV_ID_UNIT_LOCATION             0x15
  62 #define CSR1212_KV_ID_MODEL                     0x17
  63 #define CSR1212_KV_ID_INSTANCE                  0x18
  64 #define CSR1212_KV_ID_KEYWORD                   0x19
  65 #define CSR1212_KV_ID_FEATURE                   0x1A
  66 #define CSR1212_KV_ID_EXTENDED_ROM              0x1B
  67 #define CSR1212_KV_ID_EXTENDED_KEY_SPECIFIER_ID 0x1C
  68 #define CSR1212_KV_ID_EXTENDED_KEY              0x1D
  69 #define CSR1212_KV_ID_EXTENDED_DATA             0x1E
  70 #define CSR1212_KV_ID_MODIFIABLE_DESCRIPTOR     0x1F
  71 #define CSR1212_KV_ID_DIRECTORY_ID              0x20
  72 #define CSR1212_KV_ID_REVISION                  0x21
  73
  74
  75 /* IEEE 1212 Address space map */
  76 #define CSR1212_ALL_SPACE_BASE                  (0x000000000000ULL)
  77 #define CSR1212_ALL_SPACE_SIZE                  (1ULL << 48)
  78 #define CSR1212_ALL_SPACE_END                   (CSR1212_ALL_SPACE_BASE + CSR1212_ALL_SPACE_SIZE)
  79
  80 #define  CSR1212_MEMORY_SPACE_BASE              (0x000000000000ULL)
  81 #define  CSR1212_MEMORY_SPACE_SIZE              ((256ULL * (1ULL << 40)) - (512ULL * (1ULL << 20)))
  82 #define  CSR1212_MEMORY_SPACE_END               (CSR1212_MEMORY_SPACE_BASE + CSR1212_MEMORY_SPACE_SIZE)
  83
  84 #define  CSR1212_PRIVATE_SPACE_BASE             (0xffffe0000000ULL)
  85 #define  CSR1212_PRIVATE_SPACE_SIZE             (256ULL * (1ULL << 20))
  86 #define  CSR1212_PRIVATE_SPACE_END              (CSR1212_PRIVATE_SPACE_BASE + CSR1212_PRIVATE_SPACE_SIZE)
  87
  88 #define  CSR1212_REGISTER_SPACE_BASE            (0xfffff0000000ULL)
  89 #define  CSR1212_REGISTER_SPACE_SIZE            (256ULL * (1ULL << 20))
  90 #define  CSR1212_REGISTER_SPACE_END             (CSR1212_REGISTER_SPACE_BASE + CSR1212_REGISTER_SPACE_SIZE)
  91
  92 #define  CSR1212_CSR_ARCH_REG_SPACE_BASE        (0xfffff0000000ULL)
  93 #define  CSR1212_CSR_ARCH_REG_SPACE_SIZE        (512)
  94 #define  CSR1212_CSR_ARCH_REG_SPACE_END         (CSR1212_CSR_ARCH_REG_SPACE_BASE + CSR1212_CSR_ARCH_REG_SPACE_SIZE)
  95 #define  CSR1212_CSR_ARCH_REG_SPACE_OFFSET      (CSR1212_CSR_ARCH_REG_SPACE_BASE - CSR1212_REGISTER_SPACE_BASE)
  96
  97 #define  CSR1212_CSR_BUS_DEP_REG_SPACE_BASE     (0xfffff0000200ULL)
  98 #define  CSR1212_CSR_BUS_DEP_REG_SPACE_SIZE     (512)
  99 #define  CSR1212_CSR_BUS_DEP_REG_SPACE_END      (CSR1212_CSR_BUS_DEP_REG_SPACE_BASE + CSR1212_CSR_BUS_DEP_REG_SPACE_SIZE)
 100 #define  CSR1212_CSR_BUS_DEP_REG_SPACE_OFFSET   (CSR1212_CSR_BUS_DEP_REG_SPACE_BASE - CSR1212_REGISTER_SPACE_BASE)
 101
 102 #define  CSR1212_CONFIG_ROM_SPACE_BASE          (0xfffff0000400ULL)
 103 #define  CSR1212_CONFIG_ROM_SPACE_SIZE          (1024)
 104 #define  CSR1212_CONFIG_ROM_SPACE_END           (CSR1212_CONFIG_ROM_SPACE_BASE + CSR1212_CONFIG_ROM_SPACE_SIZE)
 105 #define  CSR1212_CONFIG_ROM_SPACE_OFFSET        (CSR1212_CONFIG_ROM_SPACE_BASE - CSR1212_REGISTER_SPACE_BASE)
 106
 107 #define  CSR1212_UNITS_SPACE_BASE               (0xfffff0000800ULL)
 108 #define  CSR1212_UNITS_SPACE_SIZE               ((256ULL * (1ULL << 20)) - 2048)
 109 #define  CSR1212_UNITS_SPACE_END                (CSR1212_UNITS_SPACE_BASE + CSR1212_UNITS_SPACE_SIZE)
 110 #define  CSR1212_UNITS_SPACE_OFFSET             (CSR1212_UNITS_SPACE_BASE - CSR1212_REGISTER_SPACE_BASE)
 111
 112 #define  CSR1212_INVALID_ADDR_SPACE             -1
 113
 114
 115 /* Config ROM image structures */
 116 struct csr1212_bus_info_block_img {
 117         u8 length;
 118         u8 crc_length;
 119         u16 crc;
 120
 121         /* Must be last */
 122         u32 data[0];    /* older gcc can't handle [] which is standard */
 123 };
 124
 125 struct csr1212_leaf {
 126         int len;
 127         u32 *data;
 128 };
 129
 130 struct csr1212_dentry {
 131         struct csr1212_dentry *next, *prev;
 132         struct csr1212_keyval *kv;
 133 };
 134
 135 struct csr1212_directory {
 136         int len;
 137         struct csr1212_dentry *dentries_head, *dentries_tail;
 138 };
 139
 140 struct csr1212_keyval {
 141         struct {
 142                 u8 type;
 143                 u8 id;
 144         } key;
 145         union {
 146                 u32 immediate;
 147                 u32 csr_offset;
 148                 struct csr1212_leaf leaf;
 149                 struct csr1212_directory directory;
 150         } value;
 151         struct csr1212_keyval *associate;
 152         int refcnt;
 153
 154         /* used in generating and/or parsing CSR image */
 155         struct csr1212_keyval *next, *prev;     /* flat list of CSR elements */
 156         u32 offset;     /* position in CSR from 0xffff f000 0000 */
 157         u8 valid;       /* flag indicating keyval has valid data*/
 158 };
 159
 160
 161 struct csr1212_cache_region {
 162         struct csr1212_cache_region *next, *prev;
 163         u32 offset_start;       /* inclusive */
 164         u32 offset_end;         /* exclusive */
 165 };
 166
 167 struct csr1212_csr_rom_cache {
 168         struct csr1212_csr_rom_cache *next, *prev;
 169         struct csr1212_cache_region *filled_head, *filled_tail;
 170         struct csr1212_keyval *layout_head, *layout_tail;
 171         size_t size;
 172         u32 offset;
 173         struct csr1212_keyval *ext_rom;
 174         size_t len;
 175
 176         /* Must be last */
 177         u32 data[0];    /* older gcc can't handle [] which is standard */
 178 };
 179
 180 struct csr1212_csr {
 181         size_t bus_info_len;    /* bus info block length in bytes */
 182         size_t crc_len;         /* crc length in bytes */
 183         u32 *bus_info_data;     /* bus info data incl bus name and EUI */
 184
 185         void *private;          /* private, bus specific data */
 186         struct csr1212_bus_ops *ops;
 187
 188         struct csr1212_keyval *root_kv;
 189
 190         int max_rom;            /* max bytes readable in Config ROM region */
 191
 192         /* Items below used for image parsing and generation */
 193         struct csr1212_csr_rom_cache *cache_head, *cache_tail;
 194 };
 195
 196 struct csr1212_bus_ops {
 197         /* This function is used by csr1212 to read additional information
 198          * from remote nodes when parsing a Config ROM (i.e., read Config ROM
 199          * entries located in the Units Space.  Must return 0 on success
 200          * anything else indicates an error. */
 201         int (*bus_read) (struct csr1212_csr *csr, u64 addr,
 202                          u16 length, void *buffer, void *private);
 203
 204         /* This function is used by csr1212 to allocate a region in units space
 205          * in the event that Config ROM entries don't all fit in the predefined
 206          * 1K region.  The void *private parameter is private member of struct
 207          * csr1212_csr. */
 208         u64 (*allocate_addr_range) (u64 size, u32 alignment, void *private);
 209
 210         /* This function is used by csr1212 to release a region in units space
 211          * that is no longer needed. */
 212         void (*release_addr) (u64 addr, void *private);
 213
 214         /* This function is used by csr1212 to determine the max read request
 215          * supported by a remote node when reading the ConfigROM space.  Must
 216          * return 0, 1, or 2 per IEEE 1212.  */
 217         int (*get_max_rom) (u32 *bus_info, void *private);
 218 };
 219
 220
 221 /* Descriptor Leaf manipulation macros */
 222 #define CSR1212_DESCRIPTOR_LEAF_TYPE_SHIFT 24
 223 #define CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID_MASK 0xffffff
 224 #define CSR1212_DESCRIPTOR_LEAF_OVERHEAD (1 * sizeof(u32))
 225
 226 #define CSR1212_DESCRIPTOR_LEAF_TYPE(kv) \
 227         (be32_to_cpu((kv)->value.leaf.data[0]) >> \
 228          CSR1212_DESCRIPTOR_LEAF_TYPE_SHIFT)
 229 #define CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) \
 230         (be32_to_cpu((kv)->value.leaf.data[0]) & \
 231          CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID_MASK)
 232
 233
 234 /* Text Descriptor Leaf manipulation macros */
 235 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH_SHIFT 28
 236 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH_MASK 0xf /* after shift */
 237 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET_SHIFT 16
 238 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET_MASK 0xfff  /* after shift */
 239 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE_MASK 0xffff
 240 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_OVERHEAD (1 * sizeof(u32))
 241
 242 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) \
 243         (be32_to_cpu((kv)->value.leaf.data[1]) >> \
 244          CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH_SHIFT)
 245 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) \
 246         ((be32_to_cpu((kv)->value.leaf.data[1]) >> \
 247           CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET_SHIFT) & \
 248          CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET_MASK)
 249 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) \
 250         (be32_to_cpu((kv)->value.leaf.data[1]) & \
 251          CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE_MASK)
 252 #define CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(kv) \
 253         (&((kv)->value.leaf.data[2]))
 254
 255
 256 /* The following 2 function are for creating new Configuration ROM trees.  The
 257  * first function is used for both creating local trees and parsing remote
 258  * trees.  The second function adds pertinent information to local Configuration
 259  * ROM trees - namely data for the bus information block. */
 260 extern struct csr1212_csr *csr1212_create_csr(struct csr1212_bus_ops *ops,
 261                                               size_t bus_info_size,
 262                                               void *private);
 263 extern void csr1212_init_local_csr(struct csr1212_csr *csr,
 264                                    const u32 *bus_info_data, int max_rom);
 265
 266
 267 /* Destroy a Configuration ROM tree and release all memory taken by the tree. */
 268 extern void csr1212_destroy_csr(struct csr1212_csr *csr);
 269
 270
 271 /* The following set of functions are fore creating new keyvals for placement in
 272  * a Configuration ROM tree.  Code that creates new keyvals with these functions
 273  * must release those keyvals with csr1212_release_keyval() when they are no
 274  * longer needed. */
 275 extern struct csr1212_keyval *csr1212_new_immediate(u8 key, u32 value);
 276 extern struct csr1212_keyval *csr1212_new_directory(u8 key);
 277 extern struct csr1212_keyval *csr1212_new_string_descriptor_leaf(const char *s);
 278
 279
 280 /* The following function manages association between keyvals.  Typically,
 281  * Descriptor Leaves and Directories will be associated with another keyval and
 282  * it is desirable for the Descriptor keyval to be place immediately after the
 283  * keyval that it is associated with.
 284  * Take care with subsequent ROM modifications:  There is no function to remove
 285  * previously specified associations.
 286  */
 287 extern void csr1212_associate_keyval(struct csr1212_keyval *kv,
 288                                      struct csr1212_keyval *associate);
 289
 290
 291 /* The following functions manage the association of a keyval and directories.
 292  * A keyval may be attached to more than one directory. */
 293 extern int csr1212_attach_keyval_to_directory(struct csr1212_keyval *dir,
 294                                               struct csr1212_keyval *kv);
 295 extern void csr1212_detach_keyval_from_directory(struct csr1212_keyval *dir,
 296                                                  struct csr1212_keyval *kv);
 297
 298
 299 /* Creates a complete Configuration ROM image in the list of caches available
 300  * via csr->cache_head. */
 301 extern int csr1212_generate_csr_image(struct csr1212_csr *csr);
 302
 303
 304 /* This is a convience function for reading a block of data out of one of the
 305  * caches in the csr->cache_head list. */
 306 extern int csr1212_read(struct csr1212_csr *csr, u32 offset, void *buffer,
 307                         u32 len);
 308
 309
 310 /* The following functions are in place for parsing Configuration ROM images.
 311  * csr1212_parse_keyval() is used should there be a need to directly parse a
 312  * Configuration ROM directly. */
 313 extern int csr1212_parse_keyval(struct csr1212_keyval *kv,
 314                                 struct csr1212_csr_rom_cache *cache);
 315 extern int csr1212_parse_csr(struct csr1212_csr *csr);
 316
 317
 318 /* This function allocates a new cache which may be used for either parsing or
 319  * generating sub-sets of Configuration ROM images. */
 320 static inline struct csr1212_csr_rom_cache *
 321 csr1212_rom_cache_malloc(u32 offset, size_t size)
 322 {
 323         struct csr1212_csr_rom_cache *cache;
 324
 325         cache = CSR1212_MALLOC(sizeof(*cache) + size);
 326         if (!cache)
 327                 return NULL;
 328
 329         cache->next = NULL;
 330         cache->prev = NULL;
 331         cache->filled_head = NULL;
 332         cache->filled_tail = NULL;
 333         cache->layout_head = NULL;
 334         cache->layout_tail = NULL;
 335         cache->offset = offset;
 336         cache->size = size;
 337         cache->ext_rom = NULL;
 338
 339         return cache;
 340 }
 341
 342
 343 /* This function ensures that a keyval contains data when referencing a keyval
 344  * created by parsing a Configuration ROM. */
 345 extern struct csr1212_keyval *
 346 csr1212_get_keyval(struct csr1212_csr *csr, struct csr1212_keyval *kv);
 347
 348
 349 /* This function increments the reference count for a keyval should there be a
 350  * need for code to retain a keyval that has been parsed. */
 351 static inline void csr1212_keep_keyval(struct csr1212_keyval *kv)
 352 {
 353         kv->refcnt++;
 354 }
 355
 356
 357 /* This function decrements a keyval's reference count and will destroy the
 358  * keyval when there are no more users of the keyval.  This should be called by
 359  * any code that calls csr1212_keep_keyval() or any of the keyval creation
 360  * routines csr1212_new_*(). */
 361 extern void csr1212_release_keyval(struct csr1212_keyval *kv);
 362
 363
 364 /*
 365  * This macro allows for looping over the keyval entries in a directory and it
 366  * ensures that keyvals from remote ConfigROMs are parsed properly.
 367  *
 368  * struct csr1212_csr *_csr points to the CSR associated with dir.
 369  * struct csr1212_keyval *_kv points to the current keyval (loop index).
 370  * struct csr1212_keyval *_dir points to the directory to be looped.
 371  * struct csr1212_dentry *_pos is used internally for indexing.
 372  *
 373  * kv will be NULL upon exit of the loop.
 374  */
 375 #define csr1212_for_each_dir_entry(_csr, _kv, _dir, _pos)               \
 376         for (csr1212_get_keyval((_csr), (_dir)),                        \
 377              _pos = (_dir)->value.directory.dentries_head,              \
 378              _kv = (_pos) ? csr1212_get_keyval((_csr), _pos->kv) : NULL;\
 379              (_kv) && (_pos);                                           \
 380              (_kv->associate == NULL) ?                                 \
 381                      ((_pos = _pos->next), (_kv = (_pos) ?              \
 382                                 csr1212_get_keyval((_csr), _pos->kv) :  \
 383                                 NULL)) :                                \
 384                      (_kv = csr1212_get_keyval((_csr), _kv->associate)))
 385
 386 #endif /* __CSR1212_H__ */