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