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 fw_memcpy_from_be32(void *_dst, void *_src, size_t size)
  92 {
  93         u32    *dst = _dst;
  94         __be32 *src = _src;
  95         int i;
  96
  97         for (i = 0; i < size / 4; i++)
  98                 dst[i] = be32_to_cpu(src[i]);
  99 }
 100
 101 static inline void fw_memcpy_to_be32(void *_dst, void *_src, size_t size)
 102 {
 103         fw_memcpy_from_be32(_dst, _src, size);
 104 }
 105
 106 struct fw_card;
 107 struct fw_packet;
 108 struct fw_node;
 109 struct fw_request;
 110
 111 struct fw_descriptor {
 112         struct list_head link;
 113         size_t length;
 114         u32 immediate;
 115         u32 key;
 116         const u32 *data;
 117 };
 118
 119 int fw_core_add_descriptor(struct fw_descriptor *desc);
 120 void fw_core_remove_descriptor(struct fw_descriptor *desc);
 121
 122 typedef void (*fw_packet_callback_t)(struct fw_packet *packet,
 123                                      struct fw_card *card, int status);
 124
 125 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode,
 126                                           void *data, size_t length,
 127                                           void *callback_data);
 128
 129 /*
 130  * Important note:  The callback must guarantee that either fw_send_response()
 131  * or kfree() is called on the @request.
 132  */
 133 typedef void (*fw_address_callback_t)(struct fw_card *card,
 134                                       struct fw_request *request,
 135                                       int tcode, int destination, int source,
 136                                       int generation, int speed,
 137                                       unsigned long long offset,
 138                                       void *data, size_t length,
 139                                       void *callback_data);
 140
 141 typedef void (*fw_bus_reset_callback_t)(struct fw_card *handle,
 142                                         int node_id, int generation,
 143                                         u32 *self_ids,
 144                                         int self_id_count,
 145                                         void *callback_data);
 146
 147 struct fw_packet {
 148         int speed;
 149         int generation;
 150         u32 header[4];
 151         size_t header_length;
 152         void *payload;
 153         size_t payload_length;
 154         dma_addr_t payload_bus;
 155         u32 timestamp;
 156
 157         /*
 158          * This callback is called when the packet transmission has
 159          * completed; for successful transmission, the status code is
 160          * the ack received from the destination, otherwise it's a
 161          * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
 162          * The callback can be called from tasklet context and thus
 163          * must never block.
 164          */
 165         fw_packet_callback_t callback;
 166         int ack;
 167         struct list_head link;
 168         void *driver_data;
 169 };
 170
 171 struct fw_transaction {
 172         int node_id; /* The generation is implied; it is always the current. */
 173         int tlabel;
 174         int timestamp;
 175         struct list_head link;
 176
 177         struct fw_packet packet;
 178
 179         /*
 180          * The data passed to the callback is valid only during the
 181          * callback.
 182          */
 183         fw_transaction_callback_t callback;
 184         void *callback_data;
 185 };
 186
 187 static inline struct fw_packet *
 188 fw_packet(struct list_head *l)
 189 {
 190         return list_entry(l, struct fw_packet, link);
 191 }
 192
 193 struct fw_address_handler {
 194         u64 offset;
 195         size_t length;
 196         fw_address_callback_t address_callback;
 197         void *callback_data;
 198         struct list_head link;
 199 };
 200
 201 struct fw_address_region {
 202         u64 start;
 203         u64 end;
 204 };
 205
 206 extern const struct fw_address_region fw_high_memory_region;
 207
 208 int fw_core_add_address_handler(struct fw_address_handler *handler,
 209                                 const struct fw_address_region *region);
 210 void fw_core_remove_address_handler(struct fw_address_handler *handler);
 211 void fw_fill_response(struct fw_packet *response, u32 *request_header,
 212                       int rcode, void *payload, size_t length);
 213 void fw_send_response(struct fw_card *card,
 214                       struct fw_request *request, int rcode);
 215
 216 extern struct bus_type fw_bus_type;
 217
 218 struct fw_card {
 219         const struct fw_card_driver *driver;
 220         struct device *device;
 221         struct kref kref;
 222         struct completion done;
 223
 224         int node_id;
 225         int generation;
 226         int current_tlabel, tlabel_mask;
 227         struct list_head transaction_list;
 228         struct timer_list flush_timer;
 229         unsigned long reset_jiffies;
 230
 231         unsigned long long guid;
 232         unsigned max_receive;
 233         int link_speed;
 234         int config_rom_generation;
 235
 236         spinlock_t lock; /* Take this lock when handling the lists in
 237                           * this struct. */
 238         struct fw_node *local_node;
 239         struct fw_node *root_node;
 240         struct fw_node *irm_node;
 241         u8 color; /* must be u8 to match the definition in struct fw_node */
 242         int gap_count;
 243         bool beta_repeaters_present;
 244
 245         int index;
 246
 247         struct list_head link;
 248
 249         /* Work struct for BM duties. */
 250         struct delayed_work work;
 251         int bm_retries;
 252         int bm_generation;
 253
 254         u32 broadcast_channel;
 255         u32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4];
 256 };
 257
 258 static inline struct fw_card *fw_card_get(struct fw_card *card)
 259 {
 260         kref_get(&card->kref);
 261
 262         return card;
 263 }
 264
 265 void fw_card_release(struct kref *kref);
 266
 267 static inline void fw_card_put(struct fw_card *card)
 268 {
 269         kref_put(&card->kref, fw_card_release);
 270 }
 271
 272 extern void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
 273
 274 /*
 275  * Check whether new_generation is the immediate successor of old_generation.
 276  * Take counter roll-over at 255 (as per to OHCI) into account.
 277  */
 278 static inline bool is_next_generation(int new_generation, int old_generation)
 279 {
 280         return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
 281 }
 282
 283 /*
 284  * The iso packet format allows for an immediate header/payload part
 285  * stored in 'header' immediately after the packet info plus an
 286  * indirect payload part that is pointer to by the 'payload' field.
 287  * Applications can use one or the other or both to implement simple
 288  * low-bandwidth streaming (e.g. audio) or more advanced
 289  * scatter-gather streaming (e.g. assembling video frame automatically).
 290  */
 291
 292 struct fw_iso_packet {
 293         u16 payload_length;     /* Length of indirect payload. */
 294         u32 interrupt : 1;      /* Generate interrupt on this packet */
 295         u32 skip : 1;           /* Set to not send packet at all. */
 296         u32 tag : 2;
 297         u32 sy : 4;
 298         u32 header_length : 8;  /* Length of immediate header. */
 299         u32 header[0];
 300 };
 301
 302 #define FW_ISO_CONTEXT_TRANSMIT 0
 303 #define FW_ISO_CONTEXT_RECEIVE  1
 304
 305 #define FW_ISO_CONTEXT_MATCH_TAG0        1
 306 #define FW_ISO_CONTEXT_MATCH_TAG1        2
 307 #define FW_ISO_CONTEXT_MATCH_TAG2        4
 308 #define FW_ISO_CONTEXT_MATCH_TAG3        8
 309 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS   15
 310
 311 struct fw_iso_context;
 312
 313 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context,
 314                                   u32 cycle, size_t header_length,
 315                                   void *header, void *data);
 316
 317 /*
 318  * An iso buffer is just a set of pages mapped for DMA in the
 319  * specified direction.  Since the pages are to be used for DMA, they
 320  * are not mapped into the kernel virtual address space.  We store the
 321  * DMA address in the page private. The helper function
 322  * fw_iso_buffer_map() will map the pages into a given vma.
 323  */
 324
 325 struct fw_iso_buffer {
 326         enum dma_data_direction direction;
 327         struct page **pages;
 328         int page_count;
 329 };
 330
 331 struct fw_iso_context {
 332         struct fw_card *card;
 333         int type;
 334         int channel;
 335         int speed;
 336         size_t header_size;
 337         fw_iso_callback_t callback;
 338         void *callback_data;
 339 };
 340
 341 int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card,
 342                        int page_count, enum dma_data_direction direction);
 343 int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
 344 void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
 345
 346 struct fw_iso_context *fw_iso_context_create(struct fw_card *card,
 347                 int type, int channel, int speed, size_t header_size,
 348                 fw_iso_callback_t callback, void *callback_data);
 349 int fw_iso_context_queue(struct fw_iso_context *ctx,
 350                          struct fw_iso_packet *packet,
 351                          struct fw_iso_buffer *buffer,
 352                          unsigned long payload);
 353 int fw_iso_context_start(struct fw_iso_context *ctx,
 354                          int cycle, int sync, int tags);
 355 int fw_iso_context_stop(struct fw_iso_context *ctx);
 356 void fw_iso_context_destroy(struct fw_iso_context *ctx);
 357
 358 struct fw_card_driver {
 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 fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
 413
 414 void fw_send_request(struct fw_card *card, struct fw_transaction *t,
 415                 int tcode, int destination_id, int generation, int speed,
 416                 unsigned long long offset, void *data, size_t length,
 417                 fw_transaction_callback_t callback, void *callback_data);
 418 int fw_cancel_transaction(struct fw_card *card,
 419                           struct fw_transaction *transaction);
 420 void fw_flush_transactions(struct fw_card *card);
 421 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id,
 422                        int generation, int speed, unsigned long long offset,
 423                        void *data, size_t length);
 424 void fw_send_phy_config(struct fw_card *card,
 425                         int node_id, int generation, int gap_count);
 426
 427 /*
 428  * Called by the topology code to inform the device code of node
 429  * activity; found, lost, or updated nodes.
 430  */
 431 void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
 432
 433 /* API used by card level drivers */
 434
 435 void fw_card_initialize(struct fw_card *card,
 436                 const struct fw_card_driver *driver, struct device *device);
 437 int fw_card_add(struct fw_card *card,
 438                 u32 max_receive, u32 link_speed, u64 guid);
 439 void fw_core_remove_card(struct fw_card *card);
 440 void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
 441                 int generation, int self_id_count, u32 *self_ids);
 442 void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
 443 void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
 444
 445 #endif /* __fw_transaction_h */