]> err.no Git - linux-2.6/blobdiff - drivers/firewire/fw-transaction.h
firewire: Rename 'send_iso' to 'start_iso'.
[linux-2.6] / drivers / firewire / fw-transaction.h
index 292add509102334233c29cca96274ad125933200..9ccbed80cebb0c448ca4693fa530d22cd7daa028 100644 (file)
@@ -27,6 +27,7 @@
 #include <linux/interrupt.h>
 #include <linux/list.h>
 #include <linux/fs.h>
+#include <linux/dma-mapping.h>
 
 #define TCODE_WRITE_QUADLET_REQUEST    0
 #define TCODE_WRITE_BLOCK_REQUEST      1
 #define TCODE_READ_QUADLET_RESPONSE    6
 #define TCODE_READ_BLOCK_RESPONSE      7
 #define TCODE_CYCLE_START              8
-#define TCODE_LOCK_REQUEST             9
-#define TCODE_STREAM_DATA              10
-#define TCODE_LOCK_RESPONSE            11
+#define TCODE_LOCK_REQUEST             9
+#define TCODE_STREAM_DATA              10
+#define TCODE_LOCK_RESPONSE            11
 
+#define TCODE_IS_READ_REQUEST(tcode)   (((tcode) & ~1) == 4)
 #define TCODE_IS_BLOCK_PACKET(tcode)   (((tcode) &  1) != 0)
 #define TCODE_IS_REQUEST(tcode)                (((tcode) &  2) == 0)
 #define TCODE_IS_RESPONSE(tcode)       (((tcode) &  2) != 0)
 #define SCODE_400                      0x2
 #define SCODE_BETA                     0x3
 
-#define EXTCODE_MASK_SWAP        0x1
-#define EXTCODE_COMPARE_SWAP     0x2
-#define EXTCODE_FETCH_ADD        0x3
-#define EXTCODE_LITTLE_ADD       0x4
-#define EXTCODE_BOUNDED_ADD      0x5
-#define EXTCODE_WRAP_ADD         0x6
-
-#define ACK_COMPLETE             0x1
-#define ACK_PENDING              0x2
-#define ACK_BUSY_X               0x4
-#define ACK_BUSY_A               0x5
-#define ACK_BUSY_B               0x6
-#define ACK_DATA_ERROR           0xd
-#define ACK_TYPE_ERROR           0xe
-
-#define RCODE_COMPLETE           0x0
-#define RCODE_CONFLICT_ERROR     0x4
-#define RCODE_DATA_ERROR         0x5
-#define RCODE_TYPE_ERROR         0x6
-#define RCODE_ADDRESS_ERROR      0x7
+#define EXTCODE_MASK_SWAP      0x1
+#define EXTCODE_COMPARE_SWAP   0x2
+#define EXTCODE_FETCH_ADD      0x3
+#define EXTCODE_LITTLE_ADD     0x4
+#define EXTCODE_BOUNDED_ADD    0x5
+#define EXTCODE_WRAP_ADD       0x6
+
+#define ACK_COMPLETE           0x1
+#define ACK_PENDING            0x2
+#define ACK_BUSY_X             0x4
+#define ACK_BUSY_A             0x5
+#define ACK_BUSY_B             0x6
+#define ACK_DATA_ERROR         0xd
+#define ACK_TYPE_ERROR         0xe
+
+#define RCODE_COMPLETE         0x0
+#define RCODE_CONFLICT_ERROR   0x4
+#define RCODE_DATA_ERROR       0x5
+#define RCODE_TYPE_ERROR       0x6
+#define RCODE_ADDRESS_ERROR    0x7
 
 /* Juju specific rcodes */
 #define RCODE_SEND_ERROR       0x10
 #define RCODE_CANCELLED                0x11
 #define RCODE_BUSY             0x12
+#define RCODE_GENERATION       0x13
+#define RCODE_NO_ACK           0x14
 
 #define RETRY_1        0x00
 #define RETRY_X        0x01
 
 #define LOCAL_BUS 0xffc0
 
-#define SELFID_PORT_CHILD        0x3
-#define SELFID_PORT_PARENT       0x2
-#define SELFID_PORT_NCONN        0x1
-#define SELFID_PORT_NONE         0x0
+#define SELFID_PORT_CHILD      0x3
+#define SELFID_PORT_PARENT     0x2
+#define SELFID_PORT_NCONN      0x1
+#define SELFID_PORT_NONE       0x0
 
 #define PHY_PACKET_CONFIG      0x0
 #define PHY_PACKET_LINK_ON     0x1
 #define PHY_PACKET_SELF_ID     0x2
 
+#define CSR_REGISTER_BASE              0xfffff0000000ULL
+
+/* register offsets relative to CSR_REGISTER_BASE */
+#define CSR_STATE_CLEAR                        0x0
+#define CSR_STATE_SET                  0x4
+#define CSR_NODE_IDS                   0x8
+#define CSR_RESET_START                        0xc
+#define CSR_SPLIT_TIMEOUT_HI           0x18
+#define CSR_SPLIT_TIMEOUT_LO           0x1c
+#define CSR_CYCLE_TIME                 0x200
+#define CSR_BUS_TIME                   0x204
+#define CSR_BUSY_TIMEOUT               0x210
+#define CSR_BUS_MANAGER_ID             0x21c
+#define CSR_BANDWIDTH_AVAILABLE                0x220
+#define CSR_CHANNELS_AVAILABLE         0x224
+#define CSR_CHANNELS_AVAILABLE_HI      0x224
+#define CSR_CHANNELS_AVAILABLE_LO      0x228
+#define CSR_BROADCAST_CHANNEL          0x234
+#define CSR_CONFIG_ROM                 0x400
+#define CSR_CONFIG_ROM_END             0x800
+#define CSR_FCP_COMMAND                        0xB00
+#define CSR_FCP_RESPONSE               0xD00
+#define CSR_FCP_END                    0xF00
+#define CSR_TOPOLOGY_MAP               0x1000
+#define CSR_TOPOLOGY_MAP_END           0x1400
+#define CSR_SPEED_MAP                  0x2000
+#define CSR_SPEED_MAP_END              0x3000
+
 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args)
 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args)
 #define fw_debug(s, args...) printk(KERN_DEBUG KBUILD_MODNAME ": " s, ## args)
@@ -133,7 +165,7 @@ struct fw_descriptor {
        struct list_head link;
        size_t length;
        u32 key;
-       u32 *data;
+       const u32 *data;
 };
 
 int fw_core_add_descriptor (struct fw_descriptor *desc);
@@ -162,54 +194,54 @@ typedef void (*fw_bus_reset_callback_t)(struct fw_card *handle,
                                        void *callback_data);
 
 struct fw_packet {
-        int speed;
-        int generation;
-        u32 header[4];
-        size_t header_length;
-        void *payload;
-        size_t payload_length;
-        u32 timestamp;
-
-        dma_addr_t payload_bus;
-
-        /* This callback is called when the packet transmission has
-         * completed; for successful transmission, the status code is
-         * the ack received from the destination, otherwise it's a
-         * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
-         * The callback can be called from tasklet context and thus
-         * must never block.
-         */
-        fw_packet_callback_t callback;
-       int status;
-        struct list_head link;
+       int speed;
+       int generation;
+       u32 header[4];
+       size_t header_length;
+       void *payload;
+       size_t payload_length;
+       u32 timestamp;
+
+       dma_addr_t payload_bus;
+
+       /* This callback is called when the packet transmission has
+        * completed; for successful transmission, the status code is
+        * the ack received from the destination, otherwise it's a
+        * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO.
+        * The callback can be called from tasklet context and thus
+        * must never block.
+        */
+       fw_packet_callback_t callback;
+       int ack;
+       struct list_head link;
 };
 
 struct fw_transaction {
-        int node_id; /* The generation is implied; it is always the current. */
-        int tlabel;
-        int timestamp;
-        struct list_head link;
+       int node_id; /* The generation is implied; it is always the current. */
+       int tlabel;
+       int timestamp;
+       struct list_head link;
 
-        struct fw_packet packet;
+       struct fw_packet packet;
 
        /* The data passed to the callback is valid only during the
         * callback.  */
-        fw_transaction_callback_t callback;
-        void *callback_data;
+       fw_transaction_callback_t callback;
+       void *callback_data;
 };
 
-extern inline struct fw_packet *
+static inline struct fw_packet *
 fw_packet(struct list_head *l)
 {
-        return list_entry (l, struct fw_packet, link);
+       return list_entry (l, struct fw_packet, link);
 }
 
 struct fw_address_handler {
-        u64 offset;
-        size_t length;
-        fw_address_callback_t address_callback;
-        void *callback_data;
-        struct list_head link;
+       u64 offset;
+       size_t length;
+       fw_address_callback_t address_callback;
+       void *callback_data;
+       struct list_head link;
 };
 
 
@@ -218,40 +250,43 @@ struct fw_address_region {
        u64 end;
 };
 
-extern struct fw_address_region fw_low_memory_region;
-extern struct fw_address_region fw_high_memory_region;
-extern struct fw_address_region fw_private_region;
-extern struct fw_address_region fw_csr_region;
-extern struct fw_address_region fw_unit_space_region;
+extern const struct fw_address_region fw_low_memory_region;
+extern const struct fw_address_region fw_high_memory_region;
+extern const struct fw_address_region fw_private_region;
+extern const struct fw_address_region fw_csr_region;
+extern const struct fw_address_region fw_unit_space_region;
 
 int fw_core_add_address_handler(struct fw_address_handler *handler,
-                               struct fw_address_region *region);
+                               const struct fw_address_region *region);
 void fw_core_remove_address_handler(struct fw_address_handler *handler);
+void fw_fill_response(struct fw_packet *response, u32 *request_header,
+                     int rcode, void *payload, size_t length);
 void fw_send_response(struct fw_card *card,
                      struct fw_request *request, int rcode);
 
 extern struct bus_type fw_bus_type;
 
 struct fw_card {
-        struct fw_card_driver *driver;
+       const struct fw_card_driver *driver;
        struct device *device;
 
-        int node_id;
-        int generation;
-        /* This is the generation used for timestamping incoming requests. */
-        int request_generation;
-        int current_tlabel, tlabel_mask;
-        struct list_head transaction_list;
+       int node_id;
+       int generation;
+       /* This is the generation used for timestamping incoming requests. */
+       int request_generation;
+       int current_tlabel, tlabel_mask;
+       struct list_head transaction_list;
        struct timer_list flush_timer;
+       unsigned long reset_jiffies;
 
-        unsigned long long guid;
+       unsigned long long guid;
        int max_receive;
        int link_speed;
        int config_rom_generation;
 
-        /* We need to store up to 4 self ID for a maximum of 63 devices. */
-        int self_id_count;
-        u32 self_ids[252];
+       /* We need to store up to 4 self ID for a maximum of 63 devices. */
+       int self_id_count;
+       u32 self_ids[252];
 
        spinlock_t lock; /* Take this lock when handling the lists in
                          * this struct. */
@@ -259,6 +294,8 @@ struct fw_card {
        struct fw_node *root_node;
        struct fw_node *irm_node;
        int color;
+       int gap_count;
+       int topology_type;
 
        int index;
 
@@ -266,9 +303,10 @@ struct fw_card {
 
        struct list_head link;
 
-       /* Work struct for IRM duties. */
+       /* Work struct for BM duties. */
        struct delayed_work work;
-       int irm_retries;
+       int bm_retries;
+       int bm_generation;
 };
 
 struct fw_card *fw_card_get(struct fw_card *card);
@@ -282,13 +320,13 @@ void fw_card_put(struct fw_card *card);
  * scatter-gather streaming (e.g. assembling video frame automatically). */
 
 struct fw_iso_packet {
-        u16 payload_length;    /* Length of indirect payload. */
+       u16 payload_length;     /* Length of indirect payload. */
        u32 interrupt : 1;      /* Generate interrupt on this packet */
        u32 skip : 1;           /* Set to not send packet at all. */
        u32 tag : 2;
        u32 sy : 4;
        u32 header_length : 8;  /* Length of immediate header. */
-        u32 header[0];
+       u32 header[0];
 };
 
 #define FW_ISO_CONTEXT_TRANSMIT        0
@@ -299,61 +337,77 @@ struct fw_iso_context;
 typedef void (*fw_iso_callback_t) (struct fw_iso_context *context,
                                   int status, u32 cycle, void *data);
 
+/* An iso buffer is just a set of pages mapped for DMA in the
+ * specified direction.  Since the pages are to be used for DMA, they
+ * are not mapped into the kernel virtual address space.  We store the
+ * DMA address in the page private. The helper function
+ * fw_iso_buffer_map() will map the pages into a given vma. */
+
+struct fw_iso_buffer {
+       enum dma_data_direction direction;
+       struct page **pages;
+       int page_count;
+};
+
 struct fw_iso_context {
        struct fw_card *card;
        int type;
        int channel;
        int speed;
+       size_t header_size;
        fw_iso_callback_t callback;
        void *callback_data;
-
-       void *buffer;
-       size_t buffer_size;
-       dma_addr_t *pages;
-       int page_count;
 };
 
+int
+fw_iso_buffer_init(struct fw_iso_buffer *buffer,
+                  struct fw_card *card,
+                  int page_count,
+                  enum dma_data_direction direction);
+int
+fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
+void
+fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card);
+
 struct fw_iso_context *
-fw_iso_context_create(struct fw_card *card, int type,
-                     size_t buffer_size,
-                     fw_iso_callback_t callback,
-                     void *callback_data);
+fw_iso_context_create(struct fw_card *card, int type, size_t header_size,
+                     fw_iso_callback_t callback, void *callback_data);
 
 void
 fw_iso_context_destroy(struct fw_iso_context *ctx);
 
-void
-fw_iso_context_start(struct fw_iso_context *ctx,
-                    int channel, int speed, int cycle);
-
 int
 fw_iso_context_queue(struct fw_iso_context *ctx,
-                    struct fw_iso_packet *packet, void *payload);
+                    struct fw_iso_packet *packet,
+                    struct fw_iso_buffer *buffer,
+                    unsigned long payload);
 
 int
-fw_iso_context_send(struct fw_iso_context *ctx,
+fw_iso_context_start(struct fw_iso_context *ctx,
                    int channel, int speed, int cycle);
 
 struct fw_card_driver {
-        const char *name;
+       const char *name;
 
-        /* Enable the given card with the given initial config rom.
-         * This function is expected to activate the card, and either
-         * enable the PHY or set the link_on bit and initiate a bus
-         * reset. */
-        int (*enable) (struct fw_card *card, u32 *config_rom, size_t length);
+       /* Enable the given card with the given initial config rom.
+        * This function is expected to activate the card, and either
+        * enable the PHY or set the link_on bit and initiate a bus
+        * reset. */
+       int (*enable) (struct fw_card *card, u32 *config_rom, size_t length);
 
-        int (*update_phy_reg) (struct fw_card *card, int address,
-                               int clear_bits, int set_bits);
+       int (*update_phy_reg) (struct fw_card *card, int address,
+                              int clear_bits, int set_bits);
 
-        /* Update the config rom for an enabled card.  This function
-         * should change the config rom that is presented on the bus
-         * an initiate a bus reset. */
-        int (*set_config_rom) (struct fw_card *card,
+       /* Update the config rom for an enabled card.  This function
+        * should change the config rom that is presented on the bus
+        * an initiate a bus reset. */
+       int (*set_config_rom) (struct fw_card *card,
                               u32 *config_rom, size_t length);
 
-        void (*send_request) (struct fw_card *card, struct fw_packet *packet);
-        void (*send_response) (struct fw_card *card, struct fw_packet *packet);
+       void (*send_request) (struct fw_card *card, struct fw_packet *packet);
+       void (*send_response) (struct fw_card *card, struct fw_packet *packet);
+       /* Calling cancel is valid once a packet has been submitted. */
+       int (*cancel_packet) (struct fw_card *card, struct fw_packet *packet);
 
        /* Allow the specified node ID to do direct DMA out and in of
         * host memory.  The card will disable this for all node when
@@ -368,10 +422,12 @@ struct fw_card_driver {
        (*allocate_iso_context)(struct fw_card *card, int type);
        void (*free_iso_context)(struct fw_iso_context *ctx);
 
-       int (*send_iso)(struct fw_iso_context *ctx, s32 cycle);
+       int (*start_iso)(struct fw_iso_context *ctx, s32 cycle);
 
        int (*queue_iso)(struct fw_iso_context *ctx,
-                        struct fw_iso_packet *packet, void *payload);
+                        struct fw_iso_packet *packet,
+                        struct fw_iso_buffer *buffer,
+                        unsigned long payload);
 };
 
 int
@@ -384,10 +440,13 @@ fw_send_request(struct fw_card *card, struct fw_transaction *t,
                void *data, size_t length,
                fw_transaction_callback_t callback, void *callback_data);
 
+int fw_cancel_transaction(struct fw_card *card,
+                         struct fw_transaction *transaction);
+
 void fw_flush_transactions(struct fw_card *card);
 
-void
-fw_send_force_root(struct fw_card *card, int node_id, int generation);
+void fw_send_phy_config(struct fw_card *card,
+                       int node_id, int generation, int gap_count);
 
 /* Called by the topology code to inform the device code of node
  * activity; found, lost, or updated nodes */
@@ -399,7 +458,7 @@ fw_node_event(struct fw_card *card, struct fw_node *node, int event);
 /* Do we need phy speed here also?  If we add more args, maybe we
    should go back to struct fw_card_info. */
 void
-fw_card_initialize(struct fw_card *card, struct fw_card_driver *driver,
+fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver,
                   struct device *device);
 int
 fw_card_add(struct fw_card *card,
@@ -413,14 +472,9 @@ fw_core_handle_bus_reset(struct fw_card *card,
                         int node_id, int generation,
                         int self_id_count, u32 *self_ids);
 void
-fw_core_handle_request(struct fw_card *card,
-                      int speed, int ack, int timestamp,
-                      int generation,
-                      u32 length, u32 *payload);
-void
-fw_core_handle_response(struct fw_card *card,
-                        int speed, int ack, int timestamp,
-                        u32 length, u32 *payload);
+fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
 
+void
+fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
 
 #endif /* __fw_transaction_h */