1 #ifndef _LINUX_FIREWIRE_H 2 #define _LINUX_FIREWIRE_H 3 4 #include <linux/completion.h> 5 #include <linux/device.h> 6 #include <linux/dma-mapping.h> 7 #include <linux/kernel.h> 8 #include <linux/kref.h> 9 #include <linux/list.h> 10 #include <linux/mutex.h> 11 #include <linux/spinlock.h> 12 #include <linux/sysfs.h> 13 #include <linux/timer.h> 14 #include <linux/types.h> 15 #include <linux/workqueue.h> 16 17 #include <linux/atomic.h> 18 #include <asm/byteorder.h> 19 20 #define CSR_REGISTER_BASE 0xfffff0000000ULL 21 22 /* register offsets are relative to CSR_REGISTER_BASE */ 23 #define CSR_STATE_CLEAR 0x0 24 #define CSR_STATE_SET 0x4 25 #define CSR_NODE_IDS 0x8 26 #define CSR_RESET_START 0xc 27 #define CSR_SPLIT_TIMEOUT_HI 0x18 28 #define CSR_SPLIT_TIMEOUT_LO 0x1c 29 #define CSR_CYCLE_TIME 0x200 30 #define CSR_BUS_TIME 0x204 31 #define CSR_BUSY_TIMEOUT 0x210 32 #define CSR_PRIORITY_BUDGET 0x218 33 #define CSR_BUS_MANAGER_ID 0x21c 34 #define CSR_BANDWIDTH_AVAILABLE 0x220 35 #define CSR_CHANNELS_AVAILABLE 0x224 36 #define CSR_CHANNELS_AVAILABLE_HI 0x224 37 #define CSR_CHANNELS_AVAILABLE_LO 0x228 38 #define CSR_MAINT_UTILITY 0x230 39 #define CSR_BROADCAST_CHANNEL 0x234 40 #define CSR_CONFIG_ROM 0x400 41 #define CSR_CONFIG_ROM_END 0x800 42 #define CSR_OMPR 0x900 43 #define CSR_OPCR(i) (0x904 + (i) * 4) 44 #define CSR_IMPR 0x980 45 #define CSR_IPCR(i) (0x984 + (i) * 4) 46 #define CSR_FCP_COMMAND 0xB00 47 #define CSR_FCP_RESPONSE 0xD00 48 #define CSR_FCP_END 0xF00 49 #define CSR_TOPOLOGY_MAP 0x1000 50 #define CSR_TOPOLOGY_MAP_END 0x1400 51 #define CSR_SPEED_MAP 0x2000 52 #define CSR_SPEED_MAP_END 0x3000 53 54 #define CSR_OFFSET 0x40 55 #define CSR_LEAF 0x80 56 #define CSR_DIRECTORY 0xc0 57 58 #define CSR_DESCRIPTOR 0x01 59 #define CSR_VENDOR 0x03 60 #define CSR_HARDWARE_VERSION 0x04 61 #define CSR_UNIT 0x11 62 #define CSR_SPECIFIER_ID 0x12 63 #define CSR_VERSION 0x13 64 #define CSR_DEPENDENT_INFO 0x14 65 #define CSR_MODEL 0x17 66 #define CSR_DIRECTORY_ID 0x20 67 68 struct fw_csr_iterator { 69 const u32 *p; 70 const u32 *end; 71 }; 72 73 void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p); 74 int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value); 75 int fw_csr_string(const u32 *directory, int key, char *buf, size_t size); 76 77 extern struct bus_type fw_bus_type; 78 79 struct fw_card_driver; 80 struct fw_node; 81 82 struct fw_card { 83 const struct fw_card_driver *driver; 84 struct device *device; 85 struct kref kref; 86 struct completion done; 87 88 int node_id; 89 int generation; 90 int current_tlabel; 91 u64 tlabel_mask; 92 struct list_head transaction_list; 93 u64 reset_jiffies; 94 95 u32 split_timeout_hi; 96 u32 split_timeout_lo; 97 unsigned int split_timeout_cycles; 98 unsigned int split_timeout_jiffies; 99 100 unsigned long long guid; 101 unsigned max_receive; 102 int link_speed; 103 int config_rom_generation; 104 105 spinlock_t lock; /* Take this lock when handling the lists in 106 * this struct. */ 107 struct fw_node *local_node; 108 struct fw_node *root_node; 109 struct fw_node *irm_node; 110 u8 color; /* must be u8 to match the definition in struct fw_node */ 111 int gap_count; 112 bool beta_repeaters_present; 113 114 int index; 115 struct list_head link; 116 117 struct list_head phy_receiver_list; 118 119 struct delayed_work br_work; /* bus reset job */ 120 bool br_short; 121 122 struct delayed_work bm_work; /* bus manager job */ 123 int bm_retries; 124 int bm_generation; 125 int bm_node_id; 126 bool bm_abdicate; 127 128 bool priority_budget_implemented; /* controller feature */ 129 bool broadcast_channel_auto_allocated; /* controller feature */ 130 131 bool broadcast_channel_allocated; 132 u32 broadcast_channel; 133 __be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4]; 134 135 __be32 maint_utility_register; 136 }; 137 138 struct fw_attribute_group { 139 struct attribute_group *groups[2]; 140 struct attribute_group group; 141 struct attribute *attrs[12]; 142 }; 143 144 enum fw_device_state { 145 FW_DEVICE_INITIALIZING, 146 FW_DEVICE_RUNNING, 147 FW_DEVICE_GONE, 148 FW_DEVICE_SHUTDOWN, 149 }; 150 151 /* 152 * Note, fw_device.generation always has to be read before fw_device.node_id. 153 * Use SMP memory barriers to ensure this. Otherwise requests will be sent 154 * to an outdated node_id if the generation was updated in the meantime due 155 * to a bus reset. 156 * 157 * Likewise, fw-core will take care to update .node_id before .generation so 158 * that whenever fw_device.generation is current WRT the actual bus generation, 159 * fw_device.node_id is guaranteed to be current too. 160 * 161 * The same applies to fw_device.card->node_id vs. fw_device.generation. 162 * 163 * fw_device.config_rom and fw_device.config_rom_length may be accessed during 164 * the lifetime of any fw_unit belonging to the fw_device, before device_del() 165 * was called on the last fw_unit. Alternatively, they may be accessed while 166 * holding fw_device_rwsem. 167 */ 168 struct fw_device { 169 atomic_t state; 170 struct fw_node *node; 171 int node_id; 172 int generation; 173 unsigned max_speed; 174 struct fw_card *card; 175 struct device device; 176 177 struct mutex client_list_mutex; 178 struct list_head client_list; 179 180 const u32 *config_rom; 181 size_t config_rom_length; 182 int config_rom_retries; 183 unsigned is_local:1; 184 unsigned max_rec:4; 185 unsigned cmc:1; 186 unsigned irmc:1; 187 unsigned bc_implemented:2; 188 189 struct delayed_work work; 190 struct fw_attribute_group attribute_group; 191 }; 192 193 static inline struct fw_device *fw_device(struct device *dev) 194 { 195 return container_of(dev, struct fw_device, device); 196 } 197 198 static inline int fw_device_is_shutdown(struct fw_device *device) 199 { 200 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN; 201 } 202 203 int fw_device_enable_phys_dma(struct fw_device *device); 204 205 /* 206 * fw_unit.directory must not be accessed after device_del(&fw_unit.device). 207 */ 208 struct fw_unit { 209 struct device device; 210 const u32 *directory; 211 struct fw_attribute_group attribute_group; 212 }; 213 214 static inline struct fw_unit *fw_unit(struct device *dev) 215 { 216 return container_of(dev, struct fw_unit, device); 217 } 218 219 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit) 220 { 221 get_device(&unit->device); 222 223 return unit; 224 } 225 226 static inline void fw_unit_put(struct fw_unit *unit) 227 { 228 put_device(&unit->device); 229 } 230 231 static inline struct fw_device *fw_parent_device(struct fw_unit *unit) 232 { 233 return fw_device(unit->device.parent); 234 } 235 236 struct ieee1394_device_id; 237 238 struct fw_driver { 239 struct device_driver driver; 240 /* Called when the parent device sits through a bus reset. */ 241 void (*update)(struct fw_unit *unit); 242 const struct ieee1394_device_id *id_table; 243 }; 244 245 struct fw_packet; 246 struct fw_request; 247 248 typedef void (*fw_packet_callback_t)(struct fw_packet *packet, 249 struct fw_card *card, int status); 250 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode, 251 void *data, size_t length, 252 void *callback_data); 253 /* 254 * Important note: Except for the FCP registers, the callback must guarantee 255 * that either fw_send_response() or kfree() is called on the @request. 256 */ 257 typedef void (*fw_address_callback_t)(struct fw_card *card, 258 struct fw_request *request, 259 int tcode, int destination, int source, 260 int generation, 261 unsigned long long offset, 262 void *data, size_t length, 263 void *callback_data); 264 265 struct fw_packet { 266 int speed; 267 int generation; 268 u32 header[4]; 269 size_t header_length; 270 void *payload; 271 size_t payload_length; 272 dma_addr_t payload_bus; 273 bool payload_mapped; 274 u32 timestamp; 275 276 /* 277 * This callback is called when the packet transmission has completed. 278 * For successful transmission, the status code is the ack received 279 * from the destination. Otherwise it is one of the juju-specific 280 * rcodes: RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK. 281 * The callback can be called from tasklet context and thus 282 * must never block. 283 */ 284 fw_packet_callback_t callback; 285 int ack; 286 struct list_head link; 287 void *driver_data; 288 }; 289 290 struct fw_transaction { 291 int node_id; /* The generation is implied; it is always the current. */ 292 int tlabel; 293 struct list_head link; 294 struct fw_card *card; 295 bool is_split_transaction; 296 struct timer_list split_timeout_timer; 297 298 struct fw_packet packet; 299 300 /* 301 * The data passed to the callback is valid only during the 302 * callback. 303 */ 304 fw_transaction_callback_t callback; 305 void *callback_data; 306 }; 307 308 struct fw_address_handler { 309 u64 offset; 310 size_t length; 311 fw_address_callback_t address_callback; 312 void *callback_data; 313 struct list_head link; 314 }; 315 316 struct fw_address_region { 317 u64 start; 318 u64 end; 319 }; 320 321 extern const struct fw_address_region fw_high_memory_region; 322 323 int fw_core_add_address_handler(struct fw_address_handler *handler, 324 const struct fw_address_region *region); 325 void fw_core_remove_address_handler(struct fw_address_handler *handler); 326 void fw_send_response(struct fw_card *card, 327 struct fw_request *request, int rcode); 328 void fw_send_request(struct fw_card *card, struct fw_transaction *t, 329 int tcode, int destination_id, int generation, int speed, 330 unsigned long long offset, void *payload, size_t length, 331 fw_transaction_callback_t callback, void *callback_data); 332 int fw_cancel_transaction(struct fw_card *card, 333 struct fw_transaction *transaction); 334 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, 335 int generation, int speed, unsigned long long offset, 336 void *payload, size_t length); 337 338 static inline int fw_stream_packet_destination_id(int tag, int channel, int sy) 339 { 340 return tag << 14 | channel << 8 | sy; 341 } 342 343 struct fw_descriptor { 344 struct list_head link; 345 size_t length; 346 u32 immediate; 347 u32 key; 348 const u32 *data; 349 }; 350 351 int fw_core_add_descriptor(struct fw_descriptor *desc); 352 void fw_core_remove_descriptor(struct fw_descriptor *desc); 353 354 /* 355 * The iso packet format allows for an immediate header/payload part 356 * stored in 'header' immediately after the packet info plus an 357 * indirect payload part that is pointer to by the 'payload' field. 358 * Applications can use one or the other or both to implement simple 359 * low-bandwidth streaming (e.g. audio) or more advanced 360 * scatter-gather streaming (e.g. assembling video frame automatically). 361 */ 362 struct fw_iso_packet { 363 u16 payload_length; /* Length of indirect payload */ 364 u32 interrupt:1; /* Generate interrupt on this packet */ 365 u32 skip:1; /* tx: Set to not send packet at all */ 366 /* rx: Sync bit, wait for matching sy */ 367 u32 tag:2; /* tx: Tag in packet header */ 368 u32 sy:4; /* tx: Sy in packet header */ 369 u32 header_length:8; /* Length of immediate header */ 370 u32 header[0]; /* tx: Top of 1394 isoch. data_block */ 371 }; 372 373 #define FW_ISO_CONTEXT_TRANSMIT 0 374 #define FW_ISO_CONTEXT_RECEIVE 1 375 #define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2 376 377 #define FW_ISO_CONTEXT_MATCH_TAG0 1 378 #define FW_ISO_CONTEXT_MATCH_TAG1 2 379 #define FW_ISO_CONTEXT_MATCH_TAG2 4 380 #define FW_ISO_CONTEXT_MATCH_TAG3 8 381 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15 382 383 /* 384 * An iso buffer is just a set of pages mapped for DMA in the 385 * specified direction. Since the pages are to be used for DMA, they 386 * are not mapped into the kernel virtual address space. We store the 387 * DMA address in the page private. The helper function 388 * fw_iso_buffer_map() will map the pages into a given vma. 389 */ 390 struct fw_iso_buffer { 391 enum dma_data_direction direction; 392 struct page **pages; 393 int page_count; 394 }; 395 396 int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card, 397 int page_count, enum dma_data_direction direction); 398 void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card); 399 size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed); 400 401 struct fw_iso_context; 402 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context, 403 u32 cycle, size_t header_length, 404 void *header, void *data); 405 typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context, 406 dma_addr_t completed, void *data); 407 struct fw_iso_context { 408 struct fw_card *card; 409 int type; 410 int channel; 411 int speed; 412 size_t header_size; 413 union { 414 fw_iso_callback_t sc; 415 fw_iso_mc_callback_t mc; 416 } callback; 417 void *callback_data; 418 }; 419 420 struct fw_iso_context *fw_iso_context_create(struct fw_card *card, 421 int type, int channel, int speed, size_t header_size, 422 fw_iso_callback_t callback, void *callback_data); 423 int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels); 424 int fw_iso_context_queue(struct fw_iso_context *ctx, 425 struct fw_iso_packet *packet, 426 struct fw_iso_buffer *buffer, 427 unsigned long payload); 428 void fw_iso_context_queue_flush(struct fw_iso_context *ctx); 429 int fw_iso_context_flush_completions(struct fw_iso_context *ctx); 430 int fw_iso_context_start(struct fw_iso_context *ctx, 431 int cycle, int sync, int tags); 432 int fw_iso_context_stop(struct fw_iso_context *ctx); 433 void fw_iso_context_destroy(struct fw_iso_context *ctx); 434 void fw_iso_resource_manage(struct fw_card *card, int generation, 435 u64 channels_mask, int *channel, int *bandwidth, 436 bool allocate); 437 438 extern struct workqueue_struct *fw_workqueue; 439 440 #endif /* _LINUX_FIREWIRE_H */ 441