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 <asm/atomic.h> 18 #include <asm/byteorder.h> 19 20 #define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args) 21 #define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args) 22 23 #define CSR_REGISTER_BASE 0xfffff0000000ULL 24 25 /* register offsets are relative to CSR_REGISTER_BASE */ 26 #define CSR_STATE_CLEAR 0x0 27 #define CSR_STATE_SET 0x4 28 #define CSR_NODE_IDS 0x8 29 #define CSR_RESET_START 0xc 30 #define CSR_SPLIT_TIMEOUT_HI 0x18 31 #define CSR_SPLIT_TIMEOUT_LO 0x1c 32 #define CSR_CYCLE_TIME 0x200 33 #define CSR_BUS_TIME 0x204 34 #define CSR_BUSY_TIMEOUT 0x210 35 #define CSR_PRIORITY_BUDGET 0x218 36 #define CSR_BUS_MANAGER_ID 0x21c 37 #define CSR_BANDWIDTH_AVAILABLE 0x220 38 #define CSR_CHANNELS_AVAILABLE 0x224 39 #define CSR_CHANNELS_AVAILABLE_HI 0x224 40 #define CSR_CHANNELS_AVAILABLE_LO 0x228 41 #define CSR_MAINT_UTILITY 0x230 42 #define CSR_BROADCAST_CHANNEL 0x234 43 #define CSR_CONFIG_ROM 0x400 44 #define CSR_CONFIG_ROM_END 0x800 45 #define CSR_FCP_COMMAND 0xB00 46 #define CSR_FCP_RESPONSE 0xD00 47 #define CSR_FCP_END 0xF00 48 #define CSR_TOPOLOGY_MAP 0x1000 49 #define CSR_TOPOLOGY_MAP_END 0x1400 50 #define CSR_SPEED_MAP 0x2000 51 #define CSR_SPEED_MAP_END 0x3000 52 53 #define CSR_OFFSET 0x40 54 #define CSR_LEAF 0x80 55 #define CSR_DIRECTORY 0xc0 56 57 #define CSR_DESCRIPTOR 0x01 58 #define CSR_VENDOR 0x03 59 #define CSR_HARDWARE_VERSION 0x04 60 #define CSR_UNIT 0x11 61 #define CSR_SPECIFIER_ID 0x12 62 #define CSR_VERSION 0x13 63 #define CSR_DEPENDENT_INFO 0x14 64 #define CSR_MODEL 0x17 65 #define CSR_DIRECTORY_ID 0x20 66 67 struct fw_csr_iterator { 68 const u32 *p; 69 const u32 *end; 70 }; 71 72 void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p); 73 int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value); 74 int fw_csr_string(const u32 *directory, int key, char *buf, size_t size); 75 76 extern struct bus_type fw_bus_type; 77 78 struct fw_card_driver; 79 struct fw_node; 80 81 struct fw_card { 82 const struct fw_card_driver *driver; 83 struct device *device; 84 struct kref kref; 85 struct completion done; 86 87 int node_id; 88 int generation; 89 int current_tlabel; 90 u64 tlabel_mask; 91 struct list_head transaction_list; 92 unsigned long reset_jiffies; 93 94 u32 split_timeout_hi; 95 u32 split_timeout_lo; 96 unsigned int split_timeout_cycles; 97 unsigned int split_timeout_jiffies; 98 99 unsigned long long guid; 100 unsigned max_receive; 101 int link_speed; 102 int config_rom_generation; 103 104 spinlock_t lock; /* Take this lock when handling the lists in 105 * this struct. */ 106 struct fw_node *local_node; 107 struct fw_node *root_node; 108 struct fw_node *irm_node; 109 u8 color; /* must be u8 to match the definition in struct fw_node */ 110 int gap_count; 111 bool beta_repeaters_present; 112 113 int index; 114 struct list_head link; 115 116 struct list_head phy_receiver_list; 117 118 struct delayed_work br_work; /* bus reset job */ 119 bool br_short; 120 121 struct delayed_work bm_work; /* bus manager job */ 122 int bm_retries; 123 int bm_generation; 124 __be32 bm_transaction_data[2]; 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 static inline struct fw_device *fw_device_get(struct fw_device *device) 204 { 205 get_device(&device->device); 206 207 return device; 208 } 209 210 static inline void fw_device_put(struct fw_device *device) 211 { 212 put_device(&device->device); 213 } 214 215 int fw_device_enable_phys_dma(struct fw_device *device); 216 217 /* 218 * fw_unit.directory must not be accessed after device_del(&fw_unit.device). 219 */ 220 struct fw_unit { 221 struct device device; 222 const u32 *directory; 223 struct fw_attribute_group attribute_group; 224 }; 225 226 static inline struct fw_unit *fw_unit(struct device *dev) 227 { 228 return container_of(dev, struct fw_unit, device); 229 } 230 231 static inline struct fw_unit *fw_unit_get(struct fw_unit *unit) 232 { 233 get_device(&unit->device); 234 235 return unit; 236 } 237 238 static inline void fw_unit_put(struct fw_unit *unit) 239 { 240 put_device(&unit->device); 241 } 242 243 static inline struct fw_device *fw_parent_device(struct fw_unit *unit) 244 { 245 return fw_device(unit->device.parent); 246 } 247 248 struct ieee1394_device_id; 249 250 struct fw_driver { 251 struct device_driver driver; 252 /* Called when the parent device sits through a bus reset. */ 253 void (*update)(struct fw_unit *unit); 254 const struct ieee1394_device_id *id_table; 255 }; 256 257 struct fw_packet; 258 struct fw_request; 259 260 typedef void (*fw_packet_callback_t)(struct fw_packet *packet, 261 struct fw_card *card, int status); 262 typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode, 263 void *data, size_t length, 264 void *callback_data); 265 /* 266 * Important note: Except for the FCP registers, the callback must guarantee 267 * that either fw_send_response() or kfree() is called on the @request. 268 */ 269 typedef void (*fw_address_callback_t)(struct fw_card *card, 270 struct fw_request *request, 271 int tcode, int destination, int source, 272 int generation, 273 unsigned long long offset, 274 void *data, size_t length, 275 void *callback_data); 276 277 struct fw_packet { 278 int speed; 279 int generation; 280 u32 header[4]; 281 size_t header_length; 282 void *payload; 283 size_t payload_length; 284 dma_addr_t payload_bus; 285 bool payload_mapped; 286 u32 timestamp; 287 288 /* 289 * This callback is called when the packet transmission has completed. 290 * For successful transmission, the status code is the ack received 291 * from the destination. Otherwise it is one of the juju-specific 292 * rcodes: RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK. 293 * The callback can be called from tasklet context and thus 294 * must never block. 295 */ 296 fw_packet_callback_t callback; 297 int ack; 298 struct list_head link; 299 void *driver_data; 300 }; 301 302 struct fw_transaction { 303 int node_id; /* The generation is implied; it is always the current. */ 304 int tlabel; 305 int timestamp; 306 struct list_head link; 307 struct fw_card *card; 308 struct timer_list split_timeout_timer; 309 310 struct fw_packet packet; 311 312 /* 313 * The data passed to the callback is valid only during the 314 * callback. 315 */ 316 fw_transaction_callback_t callback; 317 void *callback_data; 318 }; 319 320 struct fw_address_handler { 321 u64 offset; 322 size_t length; 323 fw_address_callback_t address_callback; 324 void *callback_data; 325 struct list_head link; 326 }; 327 328 struct fw_address_region { 329 u64 start; 330 u64 end; 331 }; 332 333 extern const struct fw_address_region fw_high_memory_region; 334 335 int fw_core_add_address_handler(struct fw_address_handler *handler, 336 const struct fw_address_region *region); 337 void fw_core_remove_address_handler(struct fw_address_handler *handler); 338 void fw_send_response(struct fw_card *card, 339 struct fw_request *request, int rcode); 340 void fw_send_request(struct fw_card *card, struct fw_transaction *t, 341 int tcode, int destination_id, int generation, int speed, 342 unsigned long long offset, void *payload, size_t length, 343 fw_transaction_callback_t callback, void *callback_data); 344 int fw_cancel_transaction(struct fw_card *card, 345 struct fw_transaction *transaction); 346 int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, 347 int generation, int speed, unsigned long long offset, 348 void *payload, size_t length); 349 350 static inline int fw_stream_packet_destination_id(int tag, int channel, int sy) 351 { 352 return tag << 14 | channel << 8 | sy; 353 } 354 355 struct fw_descriptor { 356 struct list_head link; 357 size_t length; 358 u32 immediate; 359 u32 key; 360 const u32 *data; 361 }; 362 363 int fw_core_add_descriptor(struct fw_descriptor *desc); 364 void fw_core_remove_descriptor(struct fw_descriptor *desc); 365 366 /* 367 * The iso packet format allows for an immediate header/payload part 368 * stored in 'header' immediately after the packet info plus an 369 * indirect payload part that is pointer to by the 'payload' field. 370 * Applications can use one or the other or both to implement simple 371 * low-bandwidth streaming (e.g. audio) or more advanced 372 * scatter-gather streaming (e.g. assembling video frame automatically). 373 */ 374 struct fw_iso_packet { 375 u16 payload_length; /* Length of indirect payload */ 376 u32 interrupt:1; /* Generate interrupt on this packet */ 377 u32 skip:1; /* tx: Set to not send packet at all */ 378 /* rx: Sync bit, wait for matching sy */ 379 u32 tag:2; /* tx: Tag in packet header */ 380 u32 sy:4; /* tx: Sy in packet header */ 381 u32 header_length:8; /* Length of immediate header */ 382 u32 header[0]; /* tx: Top of 1394 isoch. data_block */ 383 }; 384 385 #define FW_ISO_CONTEXT_TRANSMIT 0 386 #define FW_ISO_CONTEXT_RECEIVE 1 387 #define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2 388 389 #define FW_ISO_CONTEXT_MATCH_TAG0 1 390 #define FW_ISO_CONTEXT_MATCH_TAG1 2 391 #define FW_ISO_CONTEXT_MATCH_TAG2 4 392 #define FW_ISO_CONTEXT_MATCH_TAG3 8 393 #define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15 394 395 /* 396 * An iso buffer is just a set of pages mapped for DMA in the 397 * specified direction. Since the pages are to be used for DMA, they 398 * are not mapped into the kernel virtual address space. We store the 399 * DMA address in the page private. The helper function 400 * fw_iso_buffer_map() will map the pages into a given vma. 401 */ 402 struct fw_iso_buffer { 403 enum dma_data_direction direction; 404 struct page **pages; 405 int page_count; 406 }; 407 408 int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card, 409 int page_count, enum dma_data_direction direction); 410 void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card); 411 size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed); 412 413 struct fw_iso_context; 414 typedef void (*fw_iso_callback_t)(struct fw_iso_context *context, 415 u32 cycle, size_t header_length, 416 void *header, void *data); 417 typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context, 418 dma_addr_t completed, void *data); 419 struct fw_iso_context { 420 struct fw_card *card; 421 int type; 422 int channel; 423 int speed; 424 size_t header_size; 425 union { 426 fw_iso_callback_t sc; 427 fw_iso_mc_callback_t mc; 428 } callback; 429 void *callback_data; 430 }; 431 432 struct fw_iso_context *fw_iso_context_create(struct fw_card *card, 433 int type, int channel, int speed, size_t header_size, 434 fw_iso_callback_t callback, void *callback_data); 435 int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels); 436 int fw_iso_context_queue(struct fw_iso_context *ctx, 437 struct fw_iso_packet *packet, 438 struct fw_iso_buffer *buffer, 439 unsigned long payload); 440 int fw_iso_context_start(struct fw_iso_context *ctx, 441 int cycle, int sync, int tags); 442 int fw_iso_context_stop(struct fw_iso_context *ctx); 443 void fw_iso_context_destroy(struct fw_iso_context *ctx); 444 445 #endif /* _LINUX_FIREWIRE_H */ 446