blob: c98764aeeec6112928fcde7ac0907949aab001ea [file] [log] [blame]
Stefan Richter77c9a5d2009-06-05 16:26:18 +02001#ifndef _FIREWIRE_CORE_H
2#define _FIREWIRE_CORE_H
3
Stefan Richter26b49502012-02-18 22:03:14 +01004#include <linux/compiler.h>
Stefan Richter21076222011-08-27 18:53:03 +02005#include <linux/device.h>
Stefan Richter0b6c4852012-04-09 20:51:18 +02006#include <linux/dma-mapping.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +02007#include <linux/fs.h>
8#include <linux/list.h>
9#include <linux/idr.h>
10#include <linux/mm_types.h>
11#include <linux/rwsem.h>
12#include <linux/slab.h>
13#include <linux/types.h>
14
Arun Sharma600634972011-07-26 16:09:06 -070015#include <linux/atomic.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +020016
17struct device;
18struct fw_card;
19struct fw_device;
20struct fw_iso_buffer;
21struct fw_iso_context;
22struct fw_iso_packet;
23struct fw_node;
24struct fw_packet;
25
26
27/* -card */
28
Stefan Richter26b49502012-02-18 22:03:14 +010029extern __printf(2, 3)
30void fw_err(const struct fw_card *card, const char *fmt, ...);
31extern __printf(2, 3)
32void fw_notice(const struct fw_card *card, const char *fmt, ...);
33
Stefan Richter77c9a5d2009-06-05 16:26:18 +020034/* bitfields within the PHY registers */
35#define PHY_LINK_ACTIVE 0x80
36#define PHY_CONTENDER 0x40
37#define PHY_BUS_RESET 0x40
Clemens Ladisch925e7a62010-04-04 15:19:54 +020038#define PHY_EXTENDED_REGISTERS 0xe0
Stefan Richter77c9a5d2009-06-05 16:26:18 +020039#define PHY_BUS_SHORT_RESET 0x40
Clemens Ladische7014da2010-04-01 16:40:18 +020040#define PHY_INT_STATUS_BITS 0x3c
Clemens Ladisch925e7a62010-04-04 15:19:54 +020041#define PHY_ENABLE_ACCEL 0x02
42#define PHY_ENABLE_MULTI 0x01
43#define PHY_PAGE_SELECT 0xe0
Stefan Richter77c9a5d2009-06-05 16:26:18 +020044
45#define BANDWIDTH_AVAILABLE_INITIAL 4915
46#define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31)
47#define BROADCAST_CHANNEL_VALID (1 << 30)
48
Clemens Ladisch4ffb7a62010-06-10 08:36:37 +020049#define CSR_STATE_BIT_CMSTR (1 << 8)
Clemens Ladisch7e0e314f2010-06-10 08:37:15 +020050#define CSR_STATE_BIT_ABDICATE (1 << 10)
Clemens Ladisch4ffb7a62010-06-10 08:36:37 +020051
Stefan Richter77c9a5d2009-06-05 16:26:18 +020052struct fw_card_driver {
53 /*
54 * Enable the given card with the given initial config rom.
55 * This function is expected to activate the card, and either
56 * enable the PHY or set the link_on bit and initiate a bus
57 * reset.
58 */
Stefan Richter8e859732009-10-08 00:41:59 +020059 int (*enable)(struct fw_card *card,
60 const __be32 *config_rom, size_t length);
Stefan Richter77c9a5d2009-06-05 16:26:18 +020061
Stefan Richter02d37be2010-07-08 16:09:06 +020062 int (*read_phy_reg)(struct fw_card *card, int address);
Stefan Richter77c9a5d2009-06-05 16:26:18 +020063 int (*update_phy_reg)(struct fw_card *card, int address,
64 int clear_bits, int set_bits);
65
66 /*
67 * Update the config rom for an enabled card. This function
68 * should change the config rom that is presented on the bus
Stefan Richter8e859732009-10-08 00:41:59 +020069 * and initiate a bus reset.
Stefan Richter77c9a5d2009-06-05 16:26:18 +020070 */
71 int (*set_config_rom)(struct fw_card *card,
Stefan Richter8e859732009-10-08 00:41:59 +020072 const __be32 *config_rom, size_t length);
Stefan Richter77c9a5d2009-06-05 16:26:18 +020073
74 void (*send_request)(struct fw_card *card, struct fw_packet *packet);
75 void (*send_response)(struct fw_card *card, struct fw_packet *packet);
76 /* Calling cancel is valid once a packet has been submitted. */
77 int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
78
79 /*
80 * Allow the specified node ID to do direct DMA out and in of
81 * host memory. The card will disable this for all node when
82 * a bus reset happens, so driver need to reenable this after
83 * bus reset. Returns 0 on success, -ENODEV if the card
84 * doesn't support this, -ESTALE if the generation doesn't
85 * match.
86 */
87 int (*enable_phys_dma)(struct fw_card *card,
88 int node_id, int generation);
89
Stefan Richter0fcff4e2010-06-12 20:35:52 +020090 u32 (*read_csr)(struct fw_card *card, int csr_offset);
91 void (*write_csr)(struct fw_card *card, int csr_offset, u32 value);
Stefan Richter77c9a5d2009-06-05 16:26:18 +020092
93 struct fw_iso_context *
94 (*allocate_iso_context)(struct fw_card *card,
95 int type, int channel, size_t header_size);
96 void (*free_iso_context)(struct fw_iso_context *ctx);
97
98 int (*start_iso)(struct fw_iso_context *ctx,
99 s32 cycle, u32 sync, u32 tags);
100
Stefan Richter872e3302010-07-29 18:19:22 +0200101 int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels);
102
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200103 int (*queue_iso)(struct fw_iso_context *ctx,
104 struct fw_iso_packet *packet,
105 struct fw_iso_buffer *buffer,
106 unsigned long payload);
107
Clemens Ladisch13882a82011-05-02 09:33:56 +0200108 void (*flush_queue_iso)(struct fw_iso_context *ctx);
109
Clemens Ladischd1bbd202012-03-18 19:06:39 +0100110 int (*flush_iso_completions)(struct fw_iso_context *ctx);
111
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200112 int (*stop_iso)(struct fw_iso_context *ctx);
113};
114
115void fw_card_initialize(struct fw_card *card,
116 const struct fw_card_driver *driver, struct device *device);
117int fw_card_add(struct fw_card *card,
118 u32 max_receive, u32 link_speed, u64 guid);
119void fw_core_remove_card(struct fw_card *card);
Stefan Richtercb7c96d2009-10-08 00:42:53 +0200120int fw_compute_block_crc(__be32 *block);
Stefan Richter02d37be2010-07-08 16:09:06 +0200121void fw_schedule_bus_reset(struct fw_card *card, bool delayed, bool short_reset);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200122void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
123
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200124/* -cdev */
125
126extern const struct file_operations fw_device_ops;
127
128void fw_device_cdev_update(struct fw_device *device);
129void fw_device_cdev_remove(struct fw_device *device);
Stefan Richterbf54e142010-07-16 22:25:51 +0200130void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200131
132
133/* -device */
134
135extern struct rw_semaphore fw_device_rwsem;
136extern struct idr fw_device_idr;
137extern int fw_cdev_major;
138
Stefan Richter21076222011-08-27 18:53:03 +0200139static inline struct fw_device *fw_device_get(struct fw_device *device)
140{
141 get_device(&device->device);
142
143 return device;
144}
145
146static inline void fw_device_put(struct fw_device *device)
147{
148 put_device(&device->device);
149}
150
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200151struct fw_device *fw_device_get_by_devt(dev_t devt);
Stefan Richter099d5412009-06-06 18:37:25 +0200152int fw_device_set_broadcast_channel(struct device *dev, void *gen);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200153void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
154
155
156/* -iso */
157
Stefan Richter0b6c4852012-04-09 20:51:18 +0200158int fw_iso_buffer_alloc(struct fw_iso_buffer *buffer, int page_count);
159int fw_iso_buffer_map_dma(struct fw_iso_buffer *buffer, struct fw_card *card,
160 enum dma_data_direction direction);
161int fw_iso_buffer_map_vma(struct fw_iso_buffer *buffer,
162 struct vm_area_struct *vma);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200163
164
165/* -topology */
166
167enum {
168 FW_NODE_CREATED,
169 FW_NODE_UPDATED,
170 FW_NODE_DESTROYED,
171 FW_NODE_LINK_ON,
172 FW_NODE_LINK_OFF,
173 FW_NODE_INITIATED_RESET,
174};
175
176struct fw_node {
177 u16 node_id;
178 u8 color;
179 u8 port_count;
180 u8 link_on:1;
181 u8 initiated_reset:1;
182 u8 b_path:1;
183 u8 phy_speed:2; /* As in the self ID packet. */
184 u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
185 * local node to this node. */
186 u8 max_depth:4; /* Maximum depth to any leaf node */
187 u8 max_hops:4; /* Max hops in this sub tree */
188 atomic_t ref_count;
189
190 /* For serializing node topology into a list. */
191 struct list_head link;
192
193 /* Upper layer specific data. */
194 void *data;
195
196 struct fw_node *ports[0];
197};
198
199static inline struct fw_node *fw_node_get(struct fw_node *node)
200{
201 atomic_inc(&node->ref_count);
202
203 return node;
204}
205
206static inline void fw_node_put(struct fw_node *node)
207{
208 if (atomic_dec_and_test(&node->ref_count))
209 kfree(node);
210}
211
212void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
Stefan Richterc8a94de2010-06-12 20:34:50 +0200213 int generation, int self_id_count, u32 *self_ids, bool bm_abdicate);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200214void fw_destroy_nodes(struct fw_card *card);
215
216/*
217 * Check whether new_generation is the immediate successor of old_generation.
218 * Take counter roll-over at 255 (as per OHCI) into account.
219 */
220static inline bool is_next_generation(int new_generation, int old_generation)
221{
222 return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
223}
224
225
226/* -transaction */
227
Clemens Ladisch5b06db12010-11-30 08:24:47 +0100228#define TCODE_LINK_INTERNAL 0xe
229
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200230#define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
231#define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
Clemens Ladisch5b06db12010-11-30 08:24:47 +0100232#define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == TCODE_LINK_INTERNAL)
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200233#define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
234#define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
235#define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
236#define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
237
238#define LOCAL_BUS 0xffc0
239
Stefan Richterfcd46b32014-01-18 17:32:20 +0100240/* arbitrarily chosen maximum range for physical DMA: 128 TB */
241#define FW_MAX_PHYSICAL_RANGE (128ULL << 40)
242
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200243void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
244void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
Clemens Ladischa10c0ce72010-05-19 08:28:32 +0200245int fw_get_response_length(struct fw_request *request);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200246void fw_fill_response(struct fw_packet *response, u32 *request_header,
247 int rcode, void *payload, size_t length);
Stefan Richter02d37be2010-07-08 16:09:06 +0200248
249#define FW_PHY_CONFIG_NO_NODE_ID -1
250#define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200251void fw_send_phy_config(struct fw_card *card,
252 int node_id, int generation, int gap_count);
253
Stefan Richtercc550212010-07-18 13:00:50 +0200254static inline bool is_ping_packet(u32 *data)
255{
256 return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1];
257}
258
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200259#endif /* _FIREWIRE_CORE_H */