Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 1 | /* |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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 | |
Stefan Richter | 687198b | 2006-12-28 16:20:00 +0100 | [diff] [blame] | 19 | #ifndef __fw_transaction_h |
| 20 | #define __fw_transaction_h |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 21 | |
Stefan Richter | 459f792 | 2008-05-24 16:50:22 +0200 | [diff] [blame] | 22 | #include <linux/completion.h> |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 23 | #include <linux/device.h> |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 24 | #include <linux/dma-mapping.h> |
Kristian Høgsberg | 4c5a443 | 2007-05-07 20:33:37 -0400 | [diff] [blame] | 25 | #include <linux/firewire-constants.h> |
Stefan Richter | 459f792 | 2008-05-24 16:50:22 +0200 | [diff] [blame] | 26 | #include <linux/kref.h> |
Stefan Richter | 2147ef2 | 2008-05-24 16:48:05 +0200 | [diff] [blame] | 27 | #include <linux/list.h> |
| 28 | #include <linux/spinlock_types.h> |
| 29 | #include <linux/timer.h> |
Stefan Richter | 1d1dc5e | 2008-12-10 00:20:38 +0100 | [diff] [blame] | 30 | #include <linux/types.h> |
Stefan Richter | 2147ef2 | 2008-05-24 16:48:05 +0200 | [diff] [blame] | 31 | #include <linux/workqueue.h> |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 32 | |
Kristian Høgsberg | 93c4cce | 2007-01-26 00:38:26 -0500 | [diff] [blame] | 33 | #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4) |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 40 | #define LOCAL_BUS 0xffc0 |
| 41 | |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 42 | #define SELFID_PORT_CHILD 0x3 |
| 43 | #define SELFID_PORT_PARENT 0x2 |
| 44 | #define SELFID_PORT_NCONN 0x1 |
| 45 | #define SELFID_PORT_NONE 0x0 |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 46 | |
| 47 | #define PHY_PACKET_CONFIG 0x0 |
| 48 | #define PHY_PACKET_LINK_ON 0x1 |
| 49 | #define PHY_PACKET_SELF_ID 0x2 |
| 50 | |
Marc Butler | ecab413 | 2007-03-23 10:24:02 -0600 | [diff] [blame] | 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 | |
Kristian Høgsberg | 93c4cce | 2007-01-26 00:38:26 -0500 | [diff] [blame] | 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 | |
Stefan Richter | e534fe1 | 2008-05-24 16:41:09 +0200 | [diff] [blame] | 85 | #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31) |
| 86 | #define BROADCAST_CHANNEL_VALID (1 << 30) |
| 87 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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) |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 90 | |
| 91 | static inline void |
| 92 | fw_memcpy_from_be32(void *_dst, void *_src, size_t size) |
| 93 | { |
Stefan Richter | efbf390 | 2008-02-23 12:24:57 +0100 | [diff] [blame] | 94 | u32 *dst = _dst; |
| 95 | __be32 *src = _src; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 96 | int i; |
| 97 | |
| 98 | for (i = 0; i < size / 4; i++) |
Stefan Richter | efbf390 | 2008-02-23 12:24:57 +0100 | [diff] [blame] | 99 | dst[i] = be32_to_cpu(src[i]); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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; |
Kristian Høgsberg | 937f687 | 2007-03-07 12:12:36 -0500 | [diff] [blame] | 116 | u32 immediate; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 117 | u32 key; |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 118 | const u32 *data; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 119 | }; |
| 120 | |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 121 | int fw_core_add_descriptor(struct fw_descriptor *desc); |
| 122 | void fw_core_remove_descriptor(struct fw_descriptor *desc); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 123 | |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 124 | typedef void (*fw_packet_callback_t)(struct fw_packet *packet, |
| 125 | struct fw_card *card, int status); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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 | |
Stefan Richter | 9c9bdf4 | 2007-07-17 02:15:36 +0200 | [diff] [blame] | 132 | /* |
| 133 | * Important note: The callback must guarantee that either fw_send_response() |
| 134 | * or kfree() is called on the @request. |
| 135 | */ |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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 { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 151 | int speed; |
| 152 | int generation; |
| 153 | u32 header[4]; |
| 154 | size_t header_length; |
| 155 | void *payload; |
| 156 | size_t payload_length; |
Stefan Richter | 1d1dc5e | 2008-12-10 00:20:38 +0100 | [diff] [blame] | 157 | dma_addr_t payload_bus; |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 158 | u32 timestamp; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 159 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 160 | /* |
| 161 | * This callback is called when the packet transmission has |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 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; |
Kristian Høgsberg | 2639a6f | 2007-01-26 00:37:57 -0500 | [diff] [blame] | 169 | int ack; |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 170 | struct list_head link; |
Kristian Høgsberg | f319b6a | 2007-03-07 12:12:49 -0500 | [diff] [blame] | 171 | void *driver_data; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 172 | }; |
| 173 | |
| 174 | struct fw_transaction { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 175 | int node_id; /* The generation is implied; it is always the current. */ |
| 176 | int tlabel; |
| 177 | int timestamp; |
| 178 | struct list_head link; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 179 | |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 180 | struct fw_packet packet; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 181 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 182 | /* |
| 183 | * The data passed to the callback is valid only during the |
| 184 | * callback. |
| 185 | */ |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 186 | fw_transaction_callback_t callback; |
| 187 | void *callback_data; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 188 | }; |
| 189 | |
Adrian Bunk | 95688e9 | 2007-01-22 19:17:37 +0100 | [diff] [blame] | 190 | static inline struct fw_packet * |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 191 | fw_packet(struct list_head *l) |
| 192 | { |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 193 | return list_entry(l, struct fw_packet, link); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 194 | } |
| 195 | |
| 196 | struct fw_address_handler { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 197 | u64 offset; |
| 198 | size_t length; |
| 199 | fw_address_callback_t address_callback; |
| 200 | void *callback_data; |
| 201 | struct list_head link; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 202 | }; |
| 203 | |
| 204 | |
| 205 | struct fw_address_region { |
| 206 | u64 start; |
| 207 | u64 end; |
| 208 | }; |
| 209 | |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 210 | extern const struct fw_address_region fw_high_memory_region; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 211 | |
| 212 | int fw_core_add_address_handler(struct fw_address_handler *handler, |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 213 | const struct fw_address_region *region); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 214 | void fw_core_remove_address_handler(struct fw_address_handler *handler); |
Kristian Høgsberg | 93c4cce | 2007-01-26 00:38:26 -0500 | [diff] [blame] | 215 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
| 216 | int rcode, void *payload, size_t length); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 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 { |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 223 | const struct fw_card_driver *driver; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 224 | struct device *device; |
Stefan Richter | 459f792 | 2008-05-24 16:50:22 +0200 | [diff] [blame] | 225 | struct kref kref; |
| 226 | struct completion done; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 227 | |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 228 | int node_id; |
| 229 | int generation; |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 230 | int current_tlabel, tlabel_mask; |
| 231 | struct list_head transaction_list; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 232 | struct timer_list flush_timer; |
Kristian Høgsberg | 931c483 | 2007-01-26 00:38:45 -0500 | [diff] [blame] | 233 | unsigned long reset_jiffies; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 234 | |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 235 | unsigned long long guid; |
Stefan Richter | 25659f7 | 2007-07-21 22:43:05 +0200 | [diff] [blame] | 236 | unsigned max_receive; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 237 | int link_speed; |
| 238 | int config_rom_generation; |
| 239 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 240 | /* |
| 241 | * We need to store up to 4 self ID for a maximum of 63 |
| 242 | * devices plus 3 words for the topology map header. |
| 243 | */ |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 244 | int self_id_count; |
Kristian Høgsberg | 473d28c | 2007-03-07 12:12:55 -0500 | [diff] [blame] | 245 | u32 topology_map[252 + 3]; |
Stefan Richter | e534fe1 | 2008-05-24 16:41:09 +0200 | [diff] [blame] | 246 | u32 broadcast_channel; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 247 | |
| 248 | spinlock_t lock; /* Take this lock when handling the lists in |
| 249 | * this struct. */ |
| 250 | struct fw_node *local_node; |
| 251 | struct fw_node *root_node; |
| 252 | struct fw_node *irm_node; |
Jay Fenlason | 4f9740d | 2008-10-16 15:51:59 -0400 | [diff] [blame] | 253 | u8 color; /* must be u8 to match the definition in struct fw_node */ |
Kristian Høgsberg | 83db801 | 2007-01-26 00:37:50 -0500 | [diff] [blame] | 254 | int gap_count; |
Stefan Richter | 24d4012 | 2007-06-18 19:44:12 +0200 | [diff] [blame] | 255 | bool beta_repeaters_present; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 256 | |
| 257 | int index; |
| 258 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 259 | struct list_head link; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 260 | |
Kristian Høgsberg | 931c483 | 2007-01-26 00:38:45 -0500 | [diff] [blame] | 261 | /* Work struct for BM duties. */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 262 | struct delayed_work work; |
Kristian Høgsberg | 931c483 | 2007-01-26 00:38:45 -0500 | [diff] [blame] | 263 | int bm_retries; |
| 264 | int bm_generation; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 265 | }; |
| 266 | |
Stefan Richter | 459f792 | 2008-05-24 16:50:22 +0200 | [diff] [blame] | 267 | static inline struct fw_card *fw_card_get(struct fw_card *card) |
| 268 | { |
| 269 | kref_get(&card->kref); |
| 270 | |
| 271 | return card; |
| 272 | } |
| 273 | |
| 274 | void fw_card_release(struct kref *kref); |
| 275 | |
| 276 | static inline void fw_card_put(struct fw_card *card) |
| 277 | { |
| 278 | kref_put(&card->kref, fw_card_release); |
| 279 | } |
| 280 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 281 | /* |
| 282 | * The iso packet format allows for an immediate header/payload part |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 283 | * stored in 'header' immediately after the packet info plus an |
| 284 | * indirect payload part that is pointer to by the 'payload' field. |
| 285 | * Applications can use one or the other or both to implement simple |
| 286 | * low-bandwidth streaming (e.g. audio) or more advanced |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 287 | * scatter-gather streaming (e.g. assembling video frame automatically). |
| 288 | */ |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 289 | |
| 290 | struct fw_iso_packet { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 291 | u16 payload_length; /* Length of indirect payload. */ |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 292 | u32 interrupt : 1; /* Generate interrupt on this packet */ |
| 293 | u32 skip : 1; /* Set to not send packet at all. */ |
| 294 | u32 tag : 2; |
| 295 | u32 sy : 4; |
| 296 | u32 header_length : 8; /* Length of immediate header. */ |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 297 | u32 header[0]; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 298 | }; |
| 299 | |
| 300 | #define FW_ISO_CONTEXT_TRANSMIT 0 |
| 301 | #define FW_ISO_CONTEXT_RECEIVE 1 |
| 302 | |
Kristian Høgsberg | 98b6cbe | 2007-02-16 17:34:51 -0500 | [diff] [blame] | 303 | #define FW_ISO_CONTEXT_MATCH_TAG0 1 |
| 304 | #define FW_ISO_CONTEXT_MATCH_TAG1 2 |
| 305 | #define FW_ISO_CONTEXT_MATCH_TAG2 4 |
| 306 | #define FW_ISO_CONTEXT_MATCH_TAG3 8 |
| 307 | #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15 |
| 308 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 309 | struct fw_iso_context; |
| 310 | |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 311 | typedef void (*fw_iso_callback_t)(struct fw_iso_context *context, |
| 312 | u32 cycle, |
| 313 | size_t header_length, |
| 314 | void *header, |
| 315 | void *data); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 316 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 317 | /* |
| 318 | * An iso buffer is just a set of pages mapped for DMA in the |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 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 |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 322 | * fw_iso_buffer_map() will map the pages into a given vma. |
| 323 | */ |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 324 | |
| 325 | struct fw_iso_buffer { |
| 326 | enum dma_data_direction direction; |
| 327 | struct page **pages; |
| 328 | int page_count; |
| 329 | }; |
| 330 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 331 | struct fw_iso_context { |
| 332 | struct fw_card *card; |
| 333 | int type; |
| 334 | int channel; |
| 335 | int speed; |
Kristian Høgsberg | 295e3fe | 2007-02-16 17:34:40 -0500 | [diff] [blame] | 336 | size_t header_size; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 337 | fw_iso_callback_t callback; |
| 338 | void *callback_data; |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 339 | }; |
| 340 | |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 341 | int |
| 342 | fw_iso_buffer_init(struct fw_iso_buffer *buffer, |
| 343 | struct fw_card *card, |
| 344 | int page_count, |
| 345 | enum dma_data_direction direction); |
| 346 | int |
| 347 | fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma); |
| 348 | void |
| 349 | fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card); |
| 350 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 351 | struct fw_iso_context * |
Kristian Høgsberg | 21efb3c | 2007-02-16 17:34:50 -0500 | [diff] [blame] | 352 | fw_iso_context_create(struct fw_card *card, int type, |
Kristian Høgsberg | eb0306e | 2007-03-14 17:34:54 -0400 | [diff] [blame] | 353 | int channel, int speed, size_t header_size, |
Kristian Høgsberg | 295e3fe | 2007-02-16 17:34:40 -0500 | [diff] [blame] | 354 | fw_iso_callback_t callback, void *callback_data); |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 355 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 356 | void |
| 357 | fw_iso_context_destroy(struct fw_iso_context *ctx); |
| 358 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 359 | int |
| 360 | fw_iso_context_queue(struct fw_iso_context *ctx, |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 361 | struct fw_iso_packet *packet, |
| 362 | struct fw_iso_buffer *buffer, |
| 363 | unsigned long payload); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 364 | |
| 365 | int |
Kristian Høgsberg | eb0306e | 2007-03-14 17:34:54 -0400 | [diff] [blame] | 366 | fw_iso_context_start(struct fw_iso_context *ctx, |
| 367 | int cycle, int sync, int tags); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 368 | |
Kristian Høgsberg | b829566 | 2007-02-16 17:34:42 -0500 | [diff] [blame] | 369 | int |
| 370 | fw_iso_context_stop(struct fw_iso_context *ctx); |
| 371 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 372 | struct fw_card_driver { |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 373 | /* |
| 374 | * Enable the given card with the given initial config rom. |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 375 | * This function is expected to activate the card, and either |
| 376 | * enable the PHY or set the link_on bit and initiate a bus |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 377 | * reset. |
| 378 | */ |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 379 | int (*enable)(struct fw_card *card, u32 *config_rom, size_t length); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 380 | |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 381 | int (*update_phy_reg)(struct fw_card *card, int address, |
| 382 | int clear_bits, int set_bits); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 383 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 384 | /* |
| 385 | * Update the config rom for an enabled card. This function |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 386 | * should change the config rom that is presented on the bus |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 387 | * an initiate a bus reset. |
| 388 | */ |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 389 | int (*set_config_rom)(struct fw_card *card, |
| 390 | u32 *config_rom, size_t length); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 391 | |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 392 | void (*send_request)(struct fw_card *card, struct fw_packet *packet); |
| 393 | void (*send_response)(struct fw_card *card, struct fw_packet *packet); |
Kristian Høgsberg | 730c32f | 2007-02-06 14:49:32 -0500 | [diff] [blame] | 394 | /* Calling cancel is valid once a packet has been submitted. */ |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 395 | int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 396 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 397 | /* |
| 398 | * Allow the specified node ID to do direct DMA out and in of |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 399 | * host memory. The card will disable this for all node when |
| 400 | * a bus reset happens, so driver need to reenable this after |
| 401 | * bus reset. Returns 0 on success, -ENODEV if the card |
| 402 | * doesn't support this, -ESTALE if the generation doesn't |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 403 | * match. |
| 404 | */ |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 405 | int (*enable_phys_dma)(struct fw_card *card, |
| 406 | int node_id, int generation); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 407 | |
Kristian Høgsberg | a98e271 | 2007-05-07 20:33:34 -0400 | [diff] [blame] | 408 | u64 (*get_bus_time)(struct fw_card *card); |
Kristian Høgsberg | d60d7f1 | 2007-03-07 12:12:56 -0500 | [diff] [blame] | 409 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 410 | struct fw_iso_context * |
Kristian Høgsberg | eb0306e | 2007-03-14 17:34:54 -0400 | [diff] [blame] | 411 | (*allocate_iso_context)(struct fw_card *card, |
Kristian Høgsberg | d2746dc | 2007-02-16 17:34:46 -0500 | [diff] [blame] | 412 | int type, size_t header_size); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 413 | void (*free_iso_context)(struct fw_iso_context *ctx); |
| 414 | |
Kristian Høgsberg | eb0306e | 2007-03-14 17:34:54 -0400 | [diff] [blame] | 415 | int (*start_iso)(struct fw_iso_context *ctx, |
| 416 | s32 cycle, u32 sync, u32 tags); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 417 | |
| 418 | int (*queue_iso)(struct fw_iso_context *ctx, |
Kristian Høgsberg | 9aad812 | 2007-02-16 17:34:38 -0500 | [diff] [blame] | 419 | struct fw_iso_packet *packet, |
| 420 | struct fw_iso_buffer *buffer, |
| 421 | unsigned long payload); |
Kristian Høgsberg | b829566 | 2007-02-16 17:34:42 -0500 | [diff] [blame] | 422 | |
| 423 | int (*stop_iso)(struct fw_iso_context *ctx); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 424 | }; |
| 425 | |
| 426 | int |
| 427 | fw_core_initiate_bus_reset(struct fw_card *card, int short_reset); |
| 428 | |
| 429 | void |
| 430 | fw_send_request(struct fw_card *card, struct fw_transaction *t, |
Jay Fenlason | 1e119fa | 2008-07-20 14:20:53 +0200 | [diff] [blame] | 431 | int tcode, int destination_id, int generation, int speed, |
| 432 | unsigned long long offset, void *data, size_t length, |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 433 | fw_transaction_callback_t callback, void *callback_data); |
| 434 | |
Jay Fenlason | 1e119fa | 2008-07-20 14:20:53 +0200 | [diff] [blame] | 435 | int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, |
| 436 | int generation, int speed, unsigned long long offset, |
| 437 | void *data, size_t length); |
| 438 | |
Kristian Høgsberg | 730c32f | 2007-02-06 14:49:32 -0500 | [diff] [blame] | 439 | int fw_cancel_transaction(struct fw_card *card, |
| 440 | struct fw_transaction *transaction); |
| 441 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 442 | void fw_flush_transactions(struct fw_card *card); |
| 443 | |
Kristian Høgsberg | 83db801 | 2007-01-26 00:37:50 -0500 | [diff] [blame] | 444 | void fw_send_phy_config(struct fw_card *card, |
| 445 | int node_id, int generation, int gap_count); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 446 | |
Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 447 | /* |
| 448 | * Called by the topology code to inform the device code of node |
| 449 | * activity; found, lost, or updated nodes. |
| 450 | */ |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 451 | void |
| 452 | fw_node_event(struct fw_card *card, struct fw_node *node, int event); |
| 453 | |
| 454 | /* API used by card level drivers */ |
| 455 | |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 456 | void |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 457 | fw_card_initialize(struct fw_card *card, const struct fw_card_driver *driver, |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 458 | struct device *device); |
| 459 | int |
| 460 | fw_card_add(struct fw_card *card, |
| 461 | u32 max_receive, u32 link_speed, u64 guid); |
| 462 | |
| 463 | void |
| 464 | fw_core_remove_card(struct fw_card *card); |
| 465 | |
| 466 | void |
| 467 | fw_core_handle_bus_reset(struct fw_card *card, |
| 468 | int node_id, int generation, |
| 469 | int self_id_count, u32 *self_ids); |
| 470 | void |
Kristian Høgsberg | 2639a6f | 2007-01-26 00:37:57 -0500 | [diff] [blame] | 471 | fw_core_handle_request(struct fw_card *card, struct fw_packet *request); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 472 | |
Kristian Høgsberg | 2639a6f | 2007-01-26 00:37:57 -0500 | [diff] [blame] | 473 | void |
| 474 | fw_core_handle_response(struct fw_card *card, struct fw_packet *packet); |
Kristian Høgsberg | 3038e35 | 2006-12-19 19:58:27 -0500 | [diff] [blame] | 475 | |
Stefan Richter | 687198b | 2006-12-28 16:20:00 +0100 | [diff] [blame] | 476 | #endif /* __fw_transaction_h */ |