SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/firewire.h

   1 #ifndef _LINUX_FIREWIRE_H
   2 #define _LINUX_FIREWIRE_H
   3
   4 #include <linux/completion.h>
   5 #include <linux/device.h>
   6 #include <linux/dma-mapping.h>
   7 #include <linux/kernel.h>
   8 #include <linux/kref.h>
   9 #include <linux/list.h>
  10 #include <linux/mutex.h>
  11 #include <linux/spinlock.h>
  12 #include <linux/sysfs.h>
  13 #include <linux/timer.h>
  14 #include <linux/types.h>
  15 #include <linux/workqueue.h>
  16
  17 #include <asm/atomic.h>
  18 #include <asm/byteorder.h>
  19
  20 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
  21 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
  22
  23 #define CSR_REGISTER_BASE               0xfffff0000000ULL
  24
  25 /* register offsets are relative to CSR_REGISTER_BASE */
  26 #define CSR_STATE_CLEAR                 0x0
  27 #define CSR_STATE_SET                   0x4
  28 #define CSR_NODE_IDS                    0x8
  29 #define CSR_RESET_START                 0xc
  30 #define CSR_SPLIT_TIMEOUT_HI            0x18
  31 #define CSR_SPLIT_TIMEOUT_LO            0x1c
  32 #define CSR_CYCLE_TIME                  0x200
  33 #define CSR_BUS_TIME                    0x204
  34 #define CSR_BUSY_TIMEOUT                0x210
  35 #define CSR_BUS_MANAGER_ID              0x21c
  36 #define CSR_BANDWIDTH_AVAILABLE         0x220
  37 #define CSR_CHANNELS_AVAILABLE          0x224
  38 #define CSR_CHANNELS_AVAILABLE_HI       0x224
  39 #define CSR_CHANNELS_AVAILABLE_LO       0x228
  40 #define CSR_BROADCAST_CHANNEL           0x234
  41 #define CSR_CONFIG_ROM                  0x400
  42 #define CSR_CONFIG_ROM_END              0x800
  43 #define CSR_FCP_COMMAND                 0xB00
  44 #define CSR_FCP_RESPONSE                0xD00
  45 #define CSR_FCP_END                     0xF00
  46 #define CSR_TOPOLOGY_MAP                0x1000
  47 #define CSR_TOPOLOGY_MAP_END            0x1400
  48 #define CSR_SPEED_MAP                   0x2000
  49 #define CSR_SPEED_MAP_END               0x3000
  50
  51 #define CSR_OFFSET              0x40
  52 #define CSR_LEAF                0x80
  53 #define CSR_DIRECTORY           0xc0
  54
  55 #define CSR_DESCRIPTOR          0x01
  56 #define CSR_VENDOR              0x03
  57 #define CSR_HARDWARE_VERSION    0x04
  58 #define CSR_NODE_CAPABILITIES   0x0c
  59 #define CSR_UNIT                0x11
  60 #define CSR_SPECIFIER_ID        0x12
  61 #define CSR_VERSION             0x13
  62 #define CSR_DEPENDENT_INFO      0x14
  63 #define CSR_MODEL               0x17
  64 #define CSR_INSTANCE            0x18
  65 #define CSR_DIRECTORY_ID        0x20
  66
  67 struct fw_csr_iterator {
  68         u32 *p;
  69         u32 *end;
  70 };
  71
  72 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
  73 int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value);
  74
  75 int fw_csr_string(u32 *directory, int key, char *buf, size_t size);
  76
  77 extern struct bus_type fw_bus_type;
  78
  79 struct fw_card_driver;
  80 struct fw_node;
  81
  82 struct fw_card {
  83         const struct fw_card_driver *driver;
  84         struct device *device;
  85         struct kref kref;
  86         struct completion done;
  87
  88         int node_id;
  89         int generation;
  90         int current_tlabel;
  91         u64 tlabel_mask;
  92         struct list_head transaction_list;
  93         struct timer_list flush_timer;
  94         unsigned long reset_jiffies;
  95
  96         unsigned long long guid;
  97         unsigned max_receive;
  98         int link_speed;
  99         int config_rom_generation;
 100
 101         spinlock_t lock; /* Take this lock when handling the lists in
 102                           * this struct. */
 103         struct fw_node *local_node;
 104         struct fw_node *root_node;
 105         struct fw_node *irm_node;
 106         u8 color; /* must be u8 to match the definition in struct fw_node */
 107         int gap_count;
 108         bool beta_repeaters_present;
 109
 110         int index;
 111
 112         struct list_head link;
 113
 114         /* Work struct for BM duties. */
 115         struct delayed_work work;
 116         int bm_retries;
 117         int bm_generation;
 118         __be32 bm_transaction_data[2];
 119
 120         bool broadcast_channel_allocated;
 121         u32 broadcast_channel;
 122         __be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
 123 };
 124
 125 struct fw_attribute_group {
 126         struct attribute_group *groups[2];
 127         struct attribute_group group;
 128         struct attribute *attrs[12];
 129 };
 130
 131 enum fw_device_state {
 132         FW_DEVICE_INITIALIZING,
 133         FW_DEVICE_RUNNING,
 134         FW_DEVICE_GONE,
 135         FW_DEVICE_SHUTDOWN,
 136 };
 137
 138 /*
 139  * Note, fw_device.generation always has to be read before fw_device.node_id.
 140  * Use SMP memory barriers to ensure this.  Otherwise requests will be sent
 141  * to an outdated node_id if the generation was updated in the meantime due
 142  * to a bus reset.
 143  *
 144  * Likewise, fw-core will take care to update .node_id before .generation so
 145  * that whenever fw_device.generation is current WRT the actual bus generation,
 146  * fw_device.node_id is guaranteed to be current too.
 147  *
 148  * The same applies to fw_device.card->node_id vs. fw_device.generation.
 149  *
 150  * fw_device.config_rom and fw_device.config_rom_length may be accessed during
 151  * the lifetime of any fw_unit belonging to the fw_device, before device_del()
 152  * was called on the last fw_unit.  Alternatively, they may be accessed while
 153  * holding fw_device_rwsem.
 154  */
 155 struct fw_device {
 156         atomic_t state;
 157         struct fw_node *node;
 158         int node_id;
 159         int generation;
 160         unsigned max_speed;
 161         struct fw_card *card;
 162         struct device device;
 163
 164         struct mutex client_list_mutex;
 165         struct list_head client_list;
 166
 167         u32 *config_rom;
 168         size_t config_rom_length;
 169         int config_rom_retries;
 170         unsigned is_local:1;
 171         unsigned max_rec:4;
 172         unsigned cmc:1;
 173         unsigned irmc:1;
 174         unsigned bc_implemented:2;
 175
 176         struct delayed_work work;
 177         struct fw_attribute_group attribute_group;
 178 };
 179
 180 static inline struct fw_device *fw_device(struct device *dev)
 181 {
 182         return container_of(dev, struct fw_device, device);
 183 }
 184
 185 static inline int fw_device_is_shutdown(struct fw_device *device)
 186 {
 187         return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
 188 }
 189
 190 static inline struct fw_device *fw_device_get(struct fw_device *device)
 191 {
 192         get_device(&device->device);
 193
 194         return device;
 195 }
 196
 197 static inline void fw_device_put(struct fw_device *device)
 198 {
 199         put_device(&device->device);
 200 }
 201
 202 int fw_device_enable_phys_dma(struct fw_device *device);
 203
 204 /*
 205  * fw_unit.directory must not be accessed after device_del(&fw_unit.device).
 206  */
 207 struct fw_unit {
 208         struct device device;
 209         u32 *directory;
 210         struct fw_attribute_group attribute_group;
 211 };
 212
 213 static inline struct fw_unit *fw_unit(struct device *dev)
 214 {
 215         return container_of(dev, struct fw_unit, device);
 216 }
 217
 218 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit)
 219 {
 220         get_device(&unit->device);
 221
 222         return unit;
 223 }
 224
 225 static inline void fw_unit_put(struct fw_unit *unit)
 226 {
 227         put_device(&unit->device);
 228 }
 229
 230 static inline struct fw_device *fw_parent_device(struct fw_unit *unit)
 231 {
 232         return fw_device(unit->device.parent);
 233 }
 234
 235 struct ieee1394_device_id;
 236
 237 struct fw_driver {
 238         struct device_driver driver;
 239         /* Called when the parent device sits through a bus reset. */
 240         void (*update)(struct fw_unit *unit);
 241         const struct ieee1394_device_id *id_table;
 242 };
 243
 244 struct fw_packet;
 245 struct fw_request;
 246
 247 typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
 248                                      struct fw_card *card, int status);
 249 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
 250                                           void *data, size_t length,
 251                                           void *callback_data);
 252 /*
 253  * Important note:  Except for the FCP registers, the callback must guarantee
 254  * that either fw_send_response() or kfree() is called on the @request.
 255  */
 256 typedef void (*fw_address_callback_t)(struct fw_card *card,
 257                                       struct fw_request *request,
 258                                       int tcode, int destination, int source,
 259                                       int generation, int speed,
 260                                       unsigned long long offset,
 261                                       void *data, size_t length,
 262                                       void *callback_data);
 263
 264 struct fw_packet {
 265         int speed;
 266         int generation;
 267         u32 header[4];
 268         size_t header_length;
 269         void *payload;
 270         size_t payload_length;
 271         dma_addr_t payload_bus;
 272         bool payload_mapped;
 273         u32 timestamp;
 274
 275         /*
 276          * This callback is called when the packet transmission has
 277          * completed; for successful transmission, the status code is
 278          * the ack received from the destination, otherwise it's a
 279          * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
 280          * The callback can be called from tasklet context and thus
 281          * must never block.
 282          */
 283         fw_packet_callback_t callback;
 284         int ack;
 285         struct list_head link;
 286         void *driver_data;
 287 };
 288
 289 struct fw_transaction {
 290         int node_id; /* The generation is implied; it is always the current. */
 291         int tlabel;
 292         int timestamp;
 293         struct list_head link;
 294
 295         struct fw_packet packet;
 296
 297         /*
 298          * The data passed to the callback is valid only during the
 299          * callback.
 300          */
 301         fw_transaction_callback_t callback;
 302         void *callback_data;
 303 };
 304
 305 struct fw_address_handler {
 306         u64 offset;
 307         size_t length;
 308         fw_address_callback_t address_callback;
 309         void *callback_data;
 310         struct list_head link;
 311 };
 312
 313 struct fw_address_region {
 314         u64 start;
 315         u64 end;
 316 };
 317
 318 extern const struct fw_address_region fw_high_memory_region;
 319
 320 int fw_core_add_address_handler(struct fw_address_handler *handler,
 321                                 const struct fw_address_region *region);
 322 void fw_core_remove_address_handler(struct fw_address_handler *handler);
 323 void fw_send_response(struct fw_card *card,
 324                       struct fw_request *request, int rcode);
 325 void fw_send_request(struct fw_card *card, struct fw_transaction *t,
 326                      int tcode, int destination_id, int generation, int speed,
 327                      unsigned long long offset, void *payload, size_t length,
 328                      fw_transaction_callback_t callback, void *callback_data);
 329 int fw_cancel_transaction(struct fw_card *card,
 330                           struct fw_transaction *transaction);
 331 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
 332                        int generation, int speed, unsigned long long offset,
 333                        void *payload, size_t length);
 334
 335 static inline int fw_stream_packet_destination_id(int tag, int channel, int sy)
 336 {
 337         return tag << 14 | channel << 8 | sy;
 338 }
 339
 340 struct fw_descriptor {
 341         struct list_head link;
 342         size_t length;
 343         u32 immediate;
 344         u32 key;
 345         const u32 *data;
 346 };
 347
 348 int fw_core_add_descriptor(struct fw_descriptor *desc);
 349 void fw_core_remove_descriptor(struct fw_descriptor *desc);
 350
 351 /*
 352  * The iso packet format allows for an immediate header/payload part
 353  * stored in 'header' immediately after the packet info plus an
 354  * indirect payload part that is pointer to by the 'payload' field.
 355  * Applications can use one or the other or both to implement simple
 356  * low-bandwidth streaming (e.g. audio) or more advanced
 357  * scatter-gather streaming (e.g. assembling video frame automatically).
 358  */
 359 struct fw_iso_packet {
 360         u16 payload_length;     /* Length of indirect payload. */
 361         u32 interrupt:1;        /* Generate interrupt on this packet */
 362         u32 skip:1;             /* Set to not send packet at all. */
 363         u32 tag:2;
 364         u32 sy:4;
 365         u32 header_length:8;    /* Length of immediate header. */
 366         u32 header[0];
 367 };
 368
 369 #define FW_ISO_CONTEXT_TRANSMIT 0
 370 #define FW_ISO_CONTEXT_RECEIVE  1
 371
 372 #define FW_ISO_CONTEXT_MATCH_TAG0        1
 373 #define FW_ISO_CONTEXT_MATCH_TAG1        2
 374 #define FW_ISO_CONTEXT_MATCH_TAG2        4
 375 #define FW_ISO_CONTEXT_MATCH_TAG3        8
 376 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS   15
 377
 378 /*
 379  * An iso buffer is just a set of pages mapped for DMA in the
 380  * specified direction.  Since the pages are to be used for DMA, they
 381  * are not mapped into the kernel virtual address space.  We store the
 382  * DMA address in the page private. The helper function
 383  * fw_iso_buffer_map() will map the pages into a given vma.
 384  */
 385 struct fw_iso_buffer {
 386         enum dma_data_direction direction;
 387         struct page **pages;
 388         int page_count;
 389 };
 390
 391 int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
 392                        int page_count, enum dma_data_direction direction);
 393 void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
 394
 395 struct fw_iso_context;
 396 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
 397                                   u32 cycle, size_t header_length,
 398                                   void *header, void *data);
 399 struct fw_iso_context {
 400         struct fw_card *card;
 401         int type;
 402         int channel;
 403         int speed;
 404         size_t header_size;
 405         fw_iso_callback_t callback;
 406         void *callback_data;
 407 };
 408
 409 struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
 410                 int type, int channel, int speed, size_t header_size,
 411                 fw_iso_callback_t callback, void *callback_data);
 412 int fw_iso_context_queue(struct fw_iso_context *ctx,
 413                          struct fw_iso_packet *packet,
 414                          struct fw_iso_buffer *buffer,
 415                          unsigned long payload);
 416 int fw_iso_context_start(struct fw_iso_context *ctx,
 417                          int cycle, int sync, int tags);
 418 int fw_iso_context_stop(struct fw_iso_context *ctx);
 419 void fw_iso_context_destroy(struct fw_iso_context *ctx);
 420
 421 #endif /* _LINUX_FIREWIRE_H */