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