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