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