drivers/firewire/fw-transaction.h

   1 /*
   2  * Copyright (C) 2003-2006 Kristian Hoegsberg <krh@bitplanet.net>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 #ifndef __fw_transaction_h
  20 #define __fw_transaction_h
  21
  22 #include <linux/completion.h>
  23 #include <linux/device.h>
  24 #include <linux/dma-mapping.h>
  25 #include <linux/firewire-constants.h>
  26 #include <linux/kref.h>
  27 #include <linux/list.h>
  28 #include <linux/spinlock_types.h>
  29 #include <linux/timer.h>
  30 #include <linux/types.h>
  31 #include <linux/workqueue.h>
  32
  33 #define TCODE_IS_READ_REQUEST(tcode)    (((tcode) & ~1) == 4)
  34 #define TCODE_IS_BLOCK_PACKET(tcode)    (((tcode) &  1) != 0)
  35 #define TCODE_IS_REQUEST(tcode)         (((tcode) &  2) == 0)
  36 #define TCODE_IS_RESPONSE(tcode)        (((tcode) &  2) != 0)
  37 #define TCODE_HAS_REQUEST_DATA(tcode)   (((tcode) & 12) != 4)
  38 #define TCODE_HAS_RESPONSE_DATA(tcode)  (((tcode) & 12) != 0)
  39
  40 #define LOCAL_BUS 0xffc0
  41
  42 #define SELFID_PORT_CHILD       0x3
  43 #define SELFID_PORT_PARENT      0x2
  44 #define SELFID_PORT_NCONN       0x1
  45 #define SELFID_PORT_NONE        0x0
  46
  47 #define PHY_PACKET_CONFIG       0x0
  48 #define PHY_PACKET_LINK_ON      0x1
  49 #define PHY_PACKET_SELF_ID      0x2
  50
  51 /* Bit fields _within_ the PHY registers. */
  52 #define PHY_LINK_ACTIVE         0x80
  53 #define PHY_CONTENDER           0x40
  54 #define PHY_BUS_RESET           0x40
  55 #define PHY_BUS_SHORT_RESET     0x40
  56
  57 #define CSR_REGISTER_BASE               0xfffff0000000ULL
  58
  59 /* register offsets relative to CSR_REGISTER_BASE */
  60 #define CSR_STATE_CLEAR                 0x0
  61 #define CSR_STATE_SET                   0x4
  62 #define CSR_NODE_IDS                    0x8
  63 #define CSR_RESET_START                 0xc
  64 #define CSR_SPLIT_TIMEOUT_HI            0x18
  65 #define CSR_SPLIT_TIMEOUT_LO            0x1c
  66 #define CSR_CYCLE_TIME                  0x200
  67 #define CSR_BUS_TIME                    0x204
  68 #define CSR_BUSY_TIMEOUT                0x210
  69 #define CSR_BUS_MANAGER_ID              0x21c
  70 #define CSR_BANDWIDTH_AVAILABLE         0x220
  71 #define CSR_CHANNELS_AVAILABLE          0x224
  72 #define CSR_CHANNELS_AVAILABLE_HI       0x224
  73 #define CSR_CHANNELS_AVAILABLE_LO       0x228
  74 #define CSR_BROADCAST_CHANNEL           0x234
  75 #define CSR_CONFIG_ROM                  0x400
  76 #define CSR_CONFIG_ROM_END              0x800
  77 #define CSR_FCP_COMMAND                 0xB00
  78 #define CSR_FCP_RESPONSE                0xD00
  79 #define CSR_FCP_END                     0xF00
  80 #define CSR_TOPOLOGY_MAP                0x1000
  81 #define CSR_TOPOLOGY_MAP_END            0x1400
  82 #define CSR_SPEED_MAP                   0x2000
  83 #define CSR_SPEED_MAP_END               0x3000
  84
  85 #define BROADCAST_CHANNEL_INITIAL       (1 << 31 | 31)
  86 #define BROADCAST_CHANNEL_VALID         (1 << 30)
  87
  88 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
  89 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
  90
  91 static inline void
  92 fw_memcpy_from_be32(void *_dst, void *_src, size_t size)
  93 {
  94         u32    *dst = _dst;
  95         __be32 *src = _src;
  96         int i;
  97
  98         for (i = 0; i < size / 4; i++)
  99                 dst[i] = be32_to_cpu(src[i]);
 100 }
 101
 102 static inline void
 103 fw_memcpy_to_be32(void *_dst, void *_src, size_t size)
 104 {
 105         fw_memcpy_from_be32(_dst, _src, size);
 106 }
 107
 108 struct fw_card;
 109 struct fw_packet;
 110 struct fw_node;
 111 struct fw_request;
 112
 113 struct fw_descriptor {
 114         struct list_head link;
 115         size_t length;
 116         u32 immediate;
 117         u32 key;
 118         const u32 *data;
 119 };
 120
 121 int fw_core_add_descriptor(struct fw_descriptor *desc);
 122 void fw_core_remove_descriptor(struct fw_descriptor *desc);
 123
 124 typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
 125                                      struct fw_card *card, int status);
 126
 127 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
 128                                           void *data,
 129                                           size_t length,
 130                                           void *callback_data);
 131
 132 /*
 133  * Important note:  The callback must guarantee that either fw_send_response()
 134  * or kfree() is called on the @request.
 135  */
 136 typedef void (*fw_address_callback_t)(struct fw_card *card,
 137                                       struct fw_request *request,
 138                                       int tcode, int destination, int source,
 139                                       int generation, int speed,
 140                                       unsigned long long offset,
 141                                       void *data, size_t length,
 142                                       void *callback_data);
 143
 144 typedef void (*fw_bus_reset_callback_t)(struct fw_card *handle,
 145                                         int node_id, int generation,
 146                                         u32 *self_ids,
 147                                         int self_id_count,
 148                                         void *callback_data);
 149
 150 struct fw_packet {
 151         int speed;
 152         int generation;
 153         u32 header[4];
 154         size_t header_length;
 155         void *payload;
 156         size_t payload_length;
 157         dma_addr_t payload_bus;
 158         u32 timestamp;
 159
 160         /*
 161          * This callback is called when the packet transmission has
 162          * completed; for successful transmission, the status code is
 163          * the ack received from the destination, otherwise it's a
 164          * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
 165          * The callback can be called from tasklet context and thus
 166          * must never block.
 167          */
 168         fw_packet_callback_t callback;
 169         int ack;
 170         struct list_head link;
 171         void *driver_data;
 172 };
 173
 174 struct fw_transaction {
 175         int node_id; /* The generation is implied; it is always the current. */
 176         int tlabel;
 177         int timestamp;
 178         struct list_head link;
 179
 180         struct fw_packet packet;
 181
 182         /*
 183          * The data passed to the callback is valid only during the
 184          * callback.
 185          */
 186         fw_transaction_callback_t callback;
 187         void *callback_data;
 188 };
 189
 190 static inline struct fw_packet *
 191 fw_packet(struct list_head *l)
 192 {
 193         return list_entry(l, struct fw_packet, link);
 194 }
 195
 196 struct fw_address_handler {
 197         u64 offset;
 198         size_t length;
 199         fw_address_callback_t address_callback;
 200         void *callback_data;
 201         struct list_head link;
 202 };
 203
 204
 205 struct fw_address_region {
 206         u64 start;
 207         u64 end;
 208 };
 209
 210 extern const struct fw_address_region fw_high_memory_region;
 211
 212 int fw_core_add_address_handler(struct fw_address_handler *handler,
 213                                 const struct fw_address_region *region);
 214 void fw_core_remove_address_handler(struct fw_address_handler *handler);
 215 void fw_fill_response(struct fw_packet *response, u32 *request_header,
 216                       int rcode, void *payload, size_t length);
 217 void fw_send_response(struct fw_card *card,
 218                       struct fw_request *request, int rcode);
 219
 220 extern struct bus_type fw_bus_type;
 221
 222 struct fw_card {
 223         const struct fw_card_driver *driver;
 224         struct device *device;
 225         struct kref kref;
 226         struct completion done;
 227
 228         int node_id;
 229         int generation;
 230         int current_tlabel, tlabel_mask;
 231         struct list_head transaction_list;
 232         struct timer_list flush_timer;
 233         unsigned long reset_jiffies;
 234
 235         unsigned long long guid;
 236         unsigned max_receive;
 237         int link_speed;
 238         int config_rom_generation;
 239
 240         spinlock_t lock; /* Take this lock when handling the lists in
 241                           * this struct. */
 242         struct fw_node *local_node;
 243         struct fw_node *root_node;
 244         struct fw_node *irm_node;
 245         u8 color; /* must be u8 to match the definition in struct fw_node */
 246         int gap_count;
 247         bool beta_repeaters_present;
 248
 249         int index;
 250
 251         struct list_head link;
 252
 253         /* Work struct for BM duties. */
 254         struct delayed_work work;
 255         int bm_retries;
 256         int bm_generation;
 257
 258         u32 broadcast_channel;
 259         u32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
 260 };
 261
 262 static inline struct fw_card *fw_card_get(struct fw_card *card)
 263 {
 264         kref_get(&card->kref);
 265
 266         return card;
 267 }
 268
 269 void fw_card_release(struct kref *kref);
 270
 271 static inline void fw_card_put(struct fw_card *card)
 272 {
 273         kref_put(&card->kref, fw_card_release);
 274 }
 275
 276 extern void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
 277
 278 /*
 279  * Check whether new_generation is the immediate successor of old_generation.
 280  * Take counter roll-over at 255 (as per to OHCI) into account.
 281  */
 282 static inline bool is_next_generation(int new_generation, int old_generation)
 283 {
 284         return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
 285 }
 286
 287 /*
 288  * The iso packet format allows for an immediate header/payload part
 289  * stored in 'header' immediately after the packet info plus an
 290  * indirect payload part that is pointer to by the 'payload' field.
 291  * Applications can use one or the other or both to implement simple
 292  * low-bandwidth streaming (e.g. audio) or more advanced
 293  * scatter-gather streaming (e.g. assembling video frame automatically).
 294  */
 295
 296 struct fw_iso_packet {
 297         u16 payload_length;     /* Length of indirect payload. */
 298         u32 interrupt : 1;      /* Generate interrupt on this packet */
 299         u32 skip : 1;           /* Set to not send packet at all. */
 300         u32 tag : 2;
 301         u32 sy : 4;
 302         u32 header_length : 8;  /* Length of immediate header. */
 303         u32 header[0];
 304 };
 305
 306 #define FW_ISO_CONTEXT_TRANSMIT 0
 307 #define FW_ISO_CONTEXT_RECEIVE  1
 308
 309 #define FW_ISO_CONTEXT_MATCH_TAG0        1
 310 #define FW_ISO_CONTEXT_MATCH_TAG1        2
 311 #define FW_ISO_CONTEXT_MATCH_TAG2        4
 312 #define FW_ISO_CONTEXT_MATCH_TAG3        8
 313 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS   15
 314
 315 struct fw_iso_context;
 316
 317 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
 318                                   u32 cycle,
 319                                   size_t header_length,
 320                                   void *header,
 321                                   void *data);
 322
 323 /*
 324  * An iso buffer is just a set of pages mapped for DMA in the
 325  * specified direction.  Since the pages are to be used for DMA, they
 326  * are not mapped into the kernel virtual address space.  We store the
 327  * DMA address in the page private. The helper function
 328  * fw_iso_buffer_map() will map the pages into a given vma.
 329  */
 330
 331 struct fw_iso_buffer {
 332         enum dma_data_direction direction;
 333         struct page **pages;
 334         int page_count;
 335 };
 336
 337 struct fw_iso_context {
 338         struct fw_card *card;
 339         int type;
 340         int channel;
 341         int speed;
 342         size_t header_size;
 343         fw_iso_callback_t callback;
 344         void *callback_data;
 345 };
 346
 347 int
 348 fw_iso_buffer_init(struct fw_iso_buffer *buffer,
 349                    struct fw_card *card,
 350                    int page_count,
 351                    enum dma_data_direction direction);
 352 int
 353 fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
 354 void
 355 fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
 356
 357 struct fw_iso_context *
 358 fw_iso_context_create(struct fw_card *card, int type,
 359                       int channel, int speed, size_t header_size,
 360                       fw_iso_callback_t callback, void *callback_data);
 361
 362 void
 363 fw_iso_context_destroy(struct fw_iso_context *ctx);
 364
 365 int
 366 fw_iso_context_queue(struct fw_iso_context *ctx,
 367                      struct fw_iso_packet *packet,
 368                      struct fw_iso_buffer *buffer,
 369                      unsigned long payload);
 370
 371 int
 372 fw_iso_context_start(struct fw_iso_context *ctx,
 373                      int cycle, int sync, int tags);
 374
 375 int
 376 fw_iso_context_stop(struct fw_iso_context *ctx);
 377
 378 struct fw_card_driver {
 379         /*
 380          * Enable the given card with the given initial config rom.
 381          * This function is expected to activate the card, and either
 382          * enable the PHY or set the link_on bit and initiate a bus
 383          * reset.
 384          */
 385         int (*enable)(struct fw_card *card, u32 *config_rom, size_t length);
 386
 387         int (*update_phy_reg)(struct fw_card *card, int address,
 388                               int clear_bits, int set_bits);
 389
 390         /*
 391          * Update the config rom for an enabled card.  This function
 392          * should change the config rom that is presented on the bus
 393          * an initiate a bus reset.
 394          */
 395         int (*set_config_rom)(struct fw_card *card,
 396                               u32 *config_rom, size_t length);
 397
 398         void (*send_request)(struct fw_card *card, struct fw_packet *packet);
 399         void (*send_response)(struct fw_card *card, struct fw_packet *packet);
 400         /* Calling cancel is valid once a packet has been submitted. */
 401         int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
 402
 403         /*
 404          * Allow the specified node ID to do direct DMA out and in of
 405          * host memory.  The card will disable this for all node when
 406          * a bus reset happens, so driver need to reenable this after
 407          * bus reset.  Returns 0 on success, -ENODEV if the card
 408          * doesn't support this, -ESTALE if the generation doesn't
 409          * match.
 410          */
 411         int (*enable_phys_dma)(struct fw_card *card,
 412                                int node_id, int generation);
 413
 414         u64 (*get_bus_time)(struct fw_card *card);
 415
 416         struct fw_iso_context *
 417         (*allocate_iso_context)(struct fw_card *card,
 418                                 int type, size_t header_size);
 419         void (*free_iso_context)(struct fw_iso_context *ctx);
 420
 421         int (*start_iso)(struct fw_iso_context *ctx,
 422                          s32 cycle, u32 sync, u32 tags);
 423
 424         int (*queue_iso)(struct fw_iso_context *ctx,
 425                          struct fw_iso_packet *packet,
 426                          struct fw_iso_buffer *buffer,
 427                          unsigned long payload);
 428
 429         int (*stop_iso)(struct fw_iso_context *ctx);
 430 };
 431
 432 int
 433 fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
 434
 435 void
 436 fw_send_request(struct fw_card *card, struct fw_transaction *t,
 437                 int tcode, int destination_id, int generation, int speed,
 438                 unsigned long long offset, void *data, size_t length,
 439                 fw_transaction_callback_t callback, void *callback_data);
 440
 441 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
 442                        int generation, int speed, unsigned long long offset,
 443                        void *data, size_t length);
 444
 445 int fw_cancel_transaction(struct fw_card *card,
 446                           struct fw_transaction *transaction);
 447
 448 void fw_flush_transactions(struct fw_card *card);
 449
 450 void fw_send_phy_config(struct fw_card *card,
 451                         int node_id, int generation, int gap_count);
 452
 453 /*
 454  * Called by the topology code to inform the device code of node
 455  * activity; found, lost, or updated nodes.
 456  */
 457 void
 458 fw_node_event(struct fw_card *card, struct fw_node *node, int event);
 459
 460 /* API used by card level drivers */
 461
 462 void
 463 fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
 464                    struct device *device);
 465 int
 466 fw_card_add(struct fw_card *card,
 467             u32 max_receive, u32 link_speed, u64 guid);
 468
 469 void
 470 fw_core_remove_card(struct fw_card *card);
 471
 472 void
 473 fw_core_handle_bus_reset(struct fw_card *card,
 474                          int node_id, int generation,
 475                          int self_id_count, u32 *self_ids);
 476 void
 477 fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
 478
 479 void
 480 fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
 481
 482 #endif /* __fw_transaction_h */