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