firewire.h revision 837ec787d85fda8d73193a399ebcea0288e4765b
177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#ifndef _LINUX_FIREWIRE_H 277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define _LINUX_FIREWIRE_H 377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/completion.h> 577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/device.h> 677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/kernel.h> 777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/kref.h> 877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/list.h> 977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/mutex.h> 1077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/spinlock.h> 1177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/sysfs.h> 1277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/timer.h> 1377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/types.h> 1477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <linux/workqueue.h> 1577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 1677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <asm/atomic.h> 1777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#include <asm/byteorder.h> 1877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 1977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define fw_notify(s, args...) printk(KERN_NOTICE KBUILD_MODNAME ": " s, ## args) 2077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define fw_error(s, args...) printk(KERN_ERR KBUILD_MODNAME ": " s, ## args) 2177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 2277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline void fw_memcpy_from_be32(void *_dst, void *_src, size_t size) 2377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 2477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 *dst = _dst; 2577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter __be32 *src = _src; 2677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int i; 2777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 2877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter for (i = 0; i < size / 4; i++) 2977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter dst[i] = be32_to_cpu(src[i]); 3077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 3177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 3277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline void fw_memcpy_to_be32(void *_dst, void *_src, size_t size) 3377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 3477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter fw_memcpy_from_be32(_dst, _src, size); 3577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 3677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_REGISTER_BASE 0xfffff0000000ULL 3777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 3877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter/* register offsets are relative to CSR_REGISTER_BASE */ 3977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_STATE_CLEAR 0x0 4077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_STATE_SET 0x4 4177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_NODE_IDS 0x8 4277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_RESET_START 0xc 4377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_SPLIT_TIMEOUT_HI 0x18 4477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_SPLIT_TIMEOUT_LO 0x1c 4577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_CYCLE_TIME 0x200 4677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_BUS_TIME 0x204 4777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_BUSY_TIMEOUT 0x210 4877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_BUS_MANAGER_ID 0x21c 4977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_BANDWIDTH_AVAILABLE 0x220 5077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_CHANNELS_AVAILABLE 0x224 5177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_CHANNELS_AVAILABLE_HI 0x224 5277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_CHANNELS_AVAILABLE_LO 0x228 5377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_BROADCAST_CHANNEL 0x234 5477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_CONFIG_ROM 0x400 5577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_CONFIG_ROM_END 0x800 5677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_FCP_COMMAND 0xB00 5777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_FCP_RESPONSE 0xD00 5877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_FCP_END 0xF00 5977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_TOPOLOGY_MAP 0x1000 6077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_TOPOLOGY_MAP_END 0x1400 6177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_SPEED_MAP 0x2000 6277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_SPEED_MAP_END 0x3000 6377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 6477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_OFFSET 0x40 6577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_LEAF 0x80 6677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_DIRECTORY 0xc0 6777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 6877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_DESCRIPTOR 0x01 6977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_VENDOR 0x03 7077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_HARDWARE_VERSION 0x04 7177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_NODE_CAPABILITIES 0x0c 7277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_UNIT 0x11 7377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_SPECIFIER_ID 0x12 7477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_VERSION 0x13 7577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_DEPENDENT_INFO 0x14 7677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_MODEL 0x17 7777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_INSTANCE 0x18 7877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#define CSR_DIRECTORY_ID 0x20 7977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 8077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_csr_iterator { 8177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 *p; 8277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 *end; 8377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 8477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 8577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtervoid fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p); 8677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterint fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value); 8777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 8877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterextern struct bus_type fw_bus_type; 8977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 9077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_card_driver; 9177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_node; 9277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 9377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_card { 9477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter const struct fw_card_driver *driver; 9577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct device *device; 9677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct kref kref; 9777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct completion done; 9877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 9977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int node_id; 10077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int generation; 10177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int current_tlabel, tlabel_mask; 10277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct list_head transaction_list; 10377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct timer_list flush_timer; 10477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned long reset_jiffies; 10577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 10677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned long long guid; 10777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned max_receive; 10877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int link_speed; 10977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int config_rom_generation; 11077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 11177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter spinlock_t lock; /* Take this lock when handling the lists in 11277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * this struct. */ 11377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_node *local_node; 11477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_node *root_node; 11577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_node *irm_node; 11677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u8 color; /* must be u8 to match the definition in struct fw_node */ 11777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int gap_count; 11877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter bool beta_repeaters_present; 11977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 12077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int index; 12177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 12277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct list_head link; 12377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 12477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter /* Work struct for BM duties. */ 12577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct delayed_work work; 12677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int bm_retries; 12777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int bm_generation; 12877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 12977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter bool broadcast_channel_allocated; 13077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 broadcast_channel; 13177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4]; 13277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 13377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 13477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline struct fw_card *fw_card_get(struct fw_card *card) 13577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 13677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter kref_get(&card->kref); 13777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 13877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter return card; 13977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 14077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 14177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtervoid fw_card_release(struct kref *kref); 14277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 14377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline void fw_card_put(struct fw_card *card) 14477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 14577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter kref_put(&card->kref, fw_card_release); 14677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 14777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 14877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_attribute_group { 14977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct attribute_group *groups[2]; 15077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct attribute_group group; 15177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct attribute *attrs[12]; 15277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 15377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 15477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterenum fw_device_state { 15577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter FW_DEVICE_INITIALIZING, 15677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter FW_DEVICE_RUNNING, 15777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter FW_DEVICE_GONE, 15877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter FW_DEVICE_SHUTDOWN, 15977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 16077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 16177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter/* 16277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * Note, fw_device.generation always has to be read before fw_device.node_id. 16377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * Use SMP memory barriers to ensure this. Otherwise requests will be sent 16477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * to an outdated node_id if the generation was updated in the meantime due 16577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * to a bus reset. 16677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * 16777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * Likewise, fw-core will take care to update .node_id before .generation so 16877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * that whenever fw_device.generation is current WRT the actual bus generation, 16977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * fw_device.node_id is guaranteed to be current too. 17077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * 17177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * The same applies to fw_device.card->node_id vs. fw_device.generation. 17277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * 17377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * fw_device.config_rom and fw_device.config_rom_length may be accessed during 17477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * the lifetime of any fw_unit belonging to the fw_device, before device_del() 17577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * was called on the last fw_unit. Alternatively, they may be accessed while 17677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * holding fw_device_rwsem. 17777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter */ 17877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_device { 17977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter atomic_t state; 18077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_node *node; 18177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int node_id; 18277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int generation; 18377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned max_speed; 18477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_card *card; 18577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct device device; 18677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 18777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct mutex client_list_mutex; 18877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct list_head client_list; 18977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 19077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 *config_rom; 19177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter size_t config_rom_length; 19277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int config_rom_retries; 19377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned is_local:1; 194837ec787d85fda8d73193a399ebcea0288e4765bStefan Richter unsigned max_rec:4; 19577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned cmc:1; 196837ec787d85fda8d73193a399ebcea0288e4765bStefan Richter unsigned irmc:1; 19777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned bc_implemented:2; 19877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 19977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct delayed_work work; 20077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_attribute_group attribute_group; 20177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 20277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 20377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline struct fw_device *fw_device(struct device *dev) 20477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 20577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter return container_of(dev, struct fw_device, device); 20677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 20777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 20877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline int fw_device_is_shutdown(struct fw_device *device) 20977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 21077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN; 21177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 21277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 21377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline struct fw_device *fw_device_get(struct fw_device *device) 21477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 21577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter get_device(&device->device); 21677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 21777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter return device; 21877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 21977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 22077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline void fw_device_put(struct fw_device *device) 22177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 22277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter put_device(&device->device); 22377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 22477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 22577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterint fw_device_enable_phys_dma(struct fw_device *device); 22677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 22777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter/* 22877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * fw_unit.directory must not be accessed after device_del(&fw_unit.device). 22977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter */ 23077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_unit { 23177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct device device; 23277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 *directory; 23377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_attribute_group attribute_group; 23477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 23577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 23677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline struct fw_unit *fw_unit(struct device *dev) 23777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 23877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter return container_of(dev, struct fw_unit, device); 23977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 24077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 24177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline struct fw_unit *fw_unit_get(struct fw_unit *unit) 24277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 24377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter get_device(&unit->device); 24477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 24577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter return unit; 24677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 24777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 24877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstatic inline void fw_unit_put(struct fw_unit *unit) 24977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter{ 25077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter put_device(&unit->device); 25177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter} 25277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 253e5110d011e03030926872457f05e49e3d5031737Stefan Richterstatic inline struct fw_device *fw_parent_device(struct fw_unit *unit) 254e5110d011e03030926872457f05e49e3d5031737Stefan Richter{ 255e5110d011e03030926872457f05e49e3d5031737Stefan Richter return fw_device(unit->device.parent); 256e5110d011e03030926872457f05e49e3d5031737Stefan Richter} 257e5110d011e03030926872457f05e49e3d5031737Stefan Richter 25877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct ieee1394_device_id; 25977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 26077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_driver { 26177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct device_driver driver; 26277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter /* Called when the parent device sits through a bus reset. */ 26377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void (*update)(struct fw_unit *unit); 26477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter const struct ieee1394_device_id *id_table; 26577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 26677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 26777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_packet; 26877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_request; 26977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 27077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtertypedef void (*fw_packet_callback_t)(struct fw_packet *packet, 27177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_card *card, int status); 27277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtertypedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode, 27377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *data, size_t length, 27477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *callback_data); 27577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter/* 27677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * Important note: The callback must guarantee that either fw_send_response() 27777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * or kfree() is called on the @request. 27877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter */ 27977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtertypedef void (*fw_address_callback_t)(struct fw_card *card, 28077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_request *request, 28177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int tcode, int destination, int source, 28277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int generation, int speed, 28377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned long long offset, 28477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *data, size_t length, 28577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *callback_data); 28677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 28777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_packet { 28877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int speed; 28977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int generation; 29077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 header[4]; 29177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter size_t header_length; 29277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *payload; 29377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter size_t payload_length; 29477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter dma_addr_t payload_bus; 29577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u32 timestamp; 29677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 29777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter /* 29877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * This callback is called when the packet transmission has 29977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * completed; for successful transmission, the status code is 30077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * the ack received from the destination, otherwise it's a 30177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * negative errno: ENOMEM, ESTALE, ETIMEDOUT, ENODEV, EIO. 30277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * The callback can be called from tasklet context and thus 30377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * must never block. 30477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter */ 30577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter fw_packet_callback_t callback; 30677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int ack; 30777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct list_head link; 30877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *driver_data; 30977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 31077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 31177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_transaction { 31277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int node_id; /* The generation is implied; it is always the current. */ 31377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int tlabel; 31477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int timestamp; 31577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct list_head link; 31677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 31777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_packet packet; 31877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 31977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter /* 32077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * The data passed to the callback is valid only during the 32177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter * callback. 32277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter */ 32377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter fw_transaction_callback_t callback; 32477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *callback_data; 32577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 32677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 32777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_address_handler { 32877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u64 offset; 32977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter size_t length; 33077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter fw_address_callback_t address_callback; 33177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *callback_data; 33277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct list_head link; 33377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 33477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 33577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterstruct fw_address_region { 33677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u64 start; 33777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter u64 end; 33877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter}; 33977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 34077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterextern const struct fw_address_region fw_high_memory_region; 34177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 34277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterint fw_core_add_address_handler(struct fw_address_handler *handler, 34377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter const struct fw_address_region *region); 34477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtervoid fw_core_remove_address_handler(struct fw_address_handler *handler); 34577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtervoid fw_send_response(struct fw_card *card, 34677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_request *request, int rcode); 34777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richtervoid fw_send_request(struct fw_card *card, struct fw_transaction *t, 34877c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int tcode, int destination_id, int generation, int speed, 34977c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter unsigned long long offset, void *payload, size_t length, 35077c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter fw_transaction_callback_t callback, void *callback_data); 35177c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterint fw_cancel_transaction(struct fw_card *card, 35277c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter struct fw_transaction *transaction); 35377c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richterint fw_run_transaction(struct fw_card *card, int tcode, int destination_id, 35477c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter int generation, int speed, unsigned long long offset, 35577c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter void *payload, size_t length); 35677c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter 35777c9a5daa9c4d9b37812c9c69c7bcbb3f9399c3cStefan Richter#endif /* _LINUX_FIREWIRE_H */ 358