1 #ifndef _FIREWIRE_CORE_H
2 #define _FIREWIRE_CORE_H
5 #include <linux/list.h>
7 #include <linux/mm_types.h>
8 #include <linux/rwsem.h>
9 #include <linux/slab.h>
10 #include <linux/types.h>
12 #include <asm/atomic.h>
18 struct fw_iso_context
;
26 /* bitfields within the PHY registers */
27 #define PHY_LINK_ACTIVE 0x80
28 #define PHY_CONTENDER 0x40
29 #define PHY_BUS_RESET 0x40
30 #define PHY_EXTENDED_REGISTERS 0xe0
31 #define PHY_BUS_SHORT_RESET 0x40
32 #define PHY_INT_STATUS_BITS 0x3c
33 #define PHY_ENABLE_ACCEL 0x02
34 #define PHY_ENABLE_MULTI 0x01
35 #define PHY_PAGE_SELECT 0xe0
37 #define BANDWIDTH_AVAILABLE_INITIAL 4915
38 #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31)
39 #define BROADCAST_CHANNEL_VALID (1 << 30)
41 #define CSR_STATE_BIT_CMSTR (1 << 8)
42 #define CSR_STATE_BIT_ABDICATE (1 << 10)
44 struct fw_card_driver
{
46 * Enable the given card with the given initial config rom.
47 * This function is expected to activate the card, and either
48 * enable the PHY or set the link_on bit and initiate a bus
51 int (*enable
)(struct fw_card
*card
,
52 const __be32
*config_rom
, size_t length
);
54 int (*read_phy_reg
)(struct fw_card
*card
, int address
);
55 int (*update_phy_reg
)(struct fw_card
*card
, int address
,
56 int clear_bits
, int set_bits
);
59 * Update the config rom for an enabled card. This function
60 * should change the config rom that is presented on the bus
61 * and initiate a bus reset.
63 int (*set_config_rom
)(struct fw_card
*card
,
64 const __be32
*config_rom
, size_t length
);
66 void (*send_request
)(struct fw_card
*card
, struct fw_packet
*packet
);
67 void (*send_response
)(struct fw_card
*card
, struct fw_packet
*packet
);
68 /* Calling cancel is valid once a packet has been submitted. */
69 int (*cancel_packet
)(struct fw_card
*card
, struct fw_packet
*packet
);
72 * Allow the specified node ID to do direct DMA out and in of
73 * host memory. The card will disable this for all node when
74 * a bus reset happens, so driver need to reenable this after
75 * bus reset. Returns 0 on success, -ENODEV if the card
76 * doesn't support this, -ESTALE if the generation doesn't
79 int (*enable_phys_dma
)(struct fw_card
*card
,
80 int node_id
, int generation
);
82 u32 (*read_csr
)(struct fw_card
*card
, int csr_offset
);
83 void (*write_csr
)(struct fw_card
*card
, int csr_offset
, u32 value
);
85 struct fw_iso_context
*
86 (*allocate_iso_context
)(struct fw_card
*card
,
87 int type
, int channel
, size_t header_size
);
88 void (*free_iso_context
)(struct fw_iso_context
*ctx
);
90 int (*start_iso
)(struct fw_iso_context
*ctx
,
91 s32 cycle
, u32 sync
, u32 tags
);
93 int (*set_iso_channels
)(struct fw_iso_context
*ctx
, u64
*channels
);
95 int (*queue_iso
)(struct fw_iso_context
*ctx
,
96 struct fw_iso_packet
*packet
,
97 struct fw_iso_buffer
*buffer
,
98 unsigned long payload
);
100 int (*stop_iso
)(struct fw_iso_context
*ctx
);
103 void fw_card_initialize(struct fw_card
*card
,
104 const struct fw_card_driver
*driver
, struct device
*device
);
105 int fw_card_add(struct fw_card
*card
,
106 u32 max_receive
, u32 link_speed
, u64 guid
);
107 void fw_core_remove_card(struct fw_card
*card
);
108 int fw_compute_block_crc(__be32
*block
);
109 void fw_schedule_bus_reset(struct fw_card
*card
, bool delayed
, bool short_reset
);
110 void fw_schedule_bm_work(struct fw_card
*card
, unsigned long delay
);
112 static inline struct fw_card
*fw_card_get(struct fw_card
*card
)
114 kref_get(&card
->kref
);
119 void fw_card_release(struct kref
*kref
);
121 static inline void fw_card_put(struct fw_card
*card
)
123 kref_put(&card
->kref
, fw_card_release
);
129 extern const struct file_operations fw_device_ops
;
131 void fw_device_cdev_update(struct fw_device
*device
);
132 void fw_device_cdev_remove(struct fw_device
*device
);
133 void fw_cdev_handle_phy_packet(struct fw_card
*card
, struct fw_packet
*p
);
138 extern struct rw_semaphore fw_device_rwsem
;
139 extern struct idr fw_device_idr
;
140 extern int fw_cdev_major
;
142 struct fw_device
*fw_device_get_by_devt(dev_t devt
);
143 int fw_device_set_broadcast_channel(struct device
*dev
, void *gen
);
144 void fw_node_event(struct fw_card
*card
, struct fw_node
*node
, int event
);
149 int fw_iso_buffer_map(struct fw_iso_buffer
*buffer
, struct vm_area_struct
*vma
);
160 FW_NODE_INITIATED_RESET
,
168 u8 initiated_reset
:1;
170 u8 phy_speed
:2; /* As in the self ID packet. */
171 u8 max_speed
:2; /* Minimum of all phy-speeds on the path from the
172 * local node to this node. */
173 u8 max_depth
:4; /* Maximum depth to any leaf node */
174 u8 max_hops
:4; /* Max hops in this sub tree */
177 /* For serializing node topology into a list. */
178 struct list_head link
;
180 /* Upper layer specific data. */
183 struct fw_node
*ports
[0];
186 static inline struct fw_node
*fw_node_get(struct fw_node
*node
)
188 atomic_inc(&node
->ref_count
);
193 static inline void fw_node_put(struct fw_node
*node
)
195 if (atomic_dec_and_test(&node
->ref_count
))
199 void fw_core_handle_bus_reset(struct fw_card
*card
, int node_id
,
200 int generation
, int self_id_count
, u32
*self_ids
, bool bm_abdicate
);
201 void fw_destroy_nodes(struct fw_card
*card
);
204 * Check whether new_generation is the immediate successor of old_generation.
205 * Take counter roll-over at 255 (as per OHCI) into account.
207 static inline bool is_next_generation(int new_generation
, int old_generation
)
209 return (new_generation
& 0xff) == ((old_generation
+ 1) & 0xff);
215 #define TCODE_LINK_INTERNAL 0xe
217 #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
218 #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
219 #define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == TCODE_LINK_INTERNAL)
220 #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
221 #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
222 #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
223 #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
225 #define LOCAL_BUS 0xffc0
227 void fw_core_handle_request(struct fw_card
*card
, struct fw_packet
*request
);
228 void fw_core_handle_response(struct fw_card
*card
, struct fw_packet
*packet
);
229 int fw_get_response_length(struct fw_request
*request
);
230 void fw_fill_response(struct fw_packet
*response
, u32
*request_header
,
231 int rcode
, void *payload
, size_t length
);
233 #define FW_PHY_CONFIG_NO_NODE_ID -1
234 #define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1
235 void fw_send_phy_config(struct fw_card
*card
,
236 int node_id
, int generation
, int gap_count
);
238 static inline bool is_ping_packet(u32
*data
)
240 return (data
[0] & 0xc0ffffff) == 0 && ~data
[0] == data
[1];
243 #endif /* _FIREWIRE_CORE_H */