include/linux/firewire.h

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