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