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 FEATURE_PRIORITY_BUDGET 0x01
43 struct fw_card_driver {
45 * Enable the given card with the given initial config rom.
46 * This function is expected to activate the card, and either
47 * enable the PHY or set the link_on bit and initiate a bus
50 int (*enable)(struct fw_card *card,
51 const __be32 *config_rom, size_t length);
53 int (*update_phy_reg)(struct fw_card *card, int address,
54 int clear_bits, int set_bits);
57 * Update the config rom for an enabled card. This function
58 * should change the config rom that is presented on the bus
59 * and initiate a bus reset.
61 int (*set_config_rom)(struct fw_card *card,
62 const __be32 *config_rom, size_t length);
64 void (*send_request)(struct fw_card *card, struct fw_packet *packet);
65 void (*send_response)(struct fw_card *card, struct fw_packet *packet);
66 /* Calling cancel is valid once a packet has been submitted. */
67 int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
70 * Allow the specified node ID to do direct DMA out and in of
71 * host memory. The card will disable this for all node when
72 * a bus reset happens, so driver need to reenable this after
73 * bus reset. Returns 0 on success, -ENODEV if the card
74 * doesn't support this, -ESTALE if the generation doesn't
77 int (*enable_phys_dma)(struct fw_card *card,
78 int node_id, int generation);
80 u32 (*read_csr_reg)(struct fw_card *card, int csr_offset);
81 void (*write_csr_reg)(struct fw_card *card, int csr_offset, u32 value);
83 unsigned int (*get_features)(struct fw_card *card);
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 (*queue_iso)(struct fw_iso_context *ctx,
94 struct fw_iso_packet *packet,
95 struct fw_iso_buffer *buffer,
96 unsigned long payload);
98 int (*stop_iso)(struct fw_iso_context *ctx);
101 void fw_card_initialize(struct fw_card *card,
102 const struct fw_card_driver *driver, struct device *device);
103 int fw_card_add(struct fw_card *card,
104 u32 max_receive, u32 link_speed, u64 guid);
105 void fw_core_remove_card(struct fw_card *card);
106 int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
107 int fw_compute_block_crc(__be32 *block);
108 void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
110 static inline struct fw_card *fw_card_get(struct fw_card *card)
112 kref_get(&card->kref);
117 void fw_card_release(struct kref *kref);
119 static inline void fw_card_put(struct fw_card *card)
121 kref_put(&card->kref, fw_card_release);
127 extern const struct file_operations fw_device_ops;
129 void fw_device_cdev_update(struct fw_device *device);
130 void fw_device_cdev_remove(struct fw_device *device);
135 extern struct rw_semaphore fw_device_rwsem;
136 extern struct idr fw_device_idr;
137 extern int fw_cdev_major;
139 struct fw_device *fw_device_get_by_devt(dev_t devt);
140 int fw_device_set_broadcast_channel(struct device *dev, void *gen);
141 void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
146 int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
147 void fw_iso_resource_manage(struct fw_card *card, int generation,
148 u64 channels_mask, int *channel, int *bandwidth,
149 bool allocate, __be32 buffer[2]);
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);
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_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
216 #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
217 #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
218 #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
219 #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
220 #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
222 #define LOCAL_BUS 0xffc0
224 void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
225 void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
226 int fw_get_response_length(struct fw_request *request);
227 void fw_fill_response(struct fw_packet *response, u32 *request_header,
228 int rcode, void *payload, size_t length);
229 void fw_send_phy_config(struct fw_card *card,
230 int node_id, int generation, int gap_count);
232 #endif /* _FIREWIRE_CORE_H */