1/* SPDX-License-Identifier: GPL-2.0 */ 2#ifndef _LINUX_FIREWIRE_H 3#define _LINUX_FIREWIRE_H 4 5#include <linux/completion.h> 6#include <linux/device.h> 7#include <linux/dma-mapping.h> 8#include <linux/kernel.h> 9#include <linux/kref.h> 10#include <linux/list.h> 11#include <linux/mutex.h> 12#include <linux/spinlock.h> 13#include <linux/sysfs.h> 14#include <linux/timer.h> 15#include <linux/types.h> 16#include <linux/workqueue.h> 17 18#include <linux/atomic.h> 19#include <asm/byteorder.h> 20 21#define CSR_REGISTER_BASE 0xfffff0000000ULL 22 23/* register offsets are relative to CSR_REGISTER_BASE */ 24#define CSR_STATE_CLEAR 0x0 25#define CSR_STATE_SET 0x4 26#define CSR_NODE_IDS 0x8 27#define CSR_RESET_START 0xc 28#define CSR_SPLIT_TIMEOUT_HI 0x18 29#define CSR_SPLIT_TIMEOUT_LO 0x1c 30#define CSR_CYCLE_TIME 0x200 31#define CSR_BUS_TIME 0x204 32#define CSR_BUSY_TIMEOUT 0x210 33#define CSR_PRIORITY_BUDGET 0x218 34#define CSR_BUS_MANAGER_ID 0x21c 35#define CSR_BANDWIDTH_AVAILABLE 0x220 36#define CSR_CHANNELS_AVAILABLE 0x224 37#define CSR_CHANNELS_AVAILABLE_HI 0x224 38#define CSR_CHANNELS_AVAILABLE_LO 0x228 39#define CSR_MAINT_UTILITY 0x230 40#define CSR_BROADCAST_CHANNEL 0x234 41#define CSR_CONFIG_ROM 0x400 42#define CSR_CONFIG_ROM_END 0x800 43#define CSR_OMPR 0x900 44#define CSR_OPCR(i) (0x904 + (i) * 4) 45#define CSR_IMPR 0x980 46#define CSR_IPCR(i) (0x984 + (i) * 4) 47#define CSR_FCP_COMMAND 0xB00 48#define CSR_FCP_RESPONSE 0xD00 49#define CSR_FCP_END 0xF00 50#define CSR_TOPOLOGY_MAP 0x1000 51#define CSR_TOPOLOGY_MAP_END 0x1400 52#define CSR_SPEED_MAP 0x2000 53#define CSR_SPEED_MAP_END 0x3000 54 55#define CSR_OFFSET 0x40 56#define CSR_LEAF 0x80 57#define CSR_DIRECTORY 0xc0 58 59#define CSR_DESCRIPTOR 0x01 60#define CSR_VENDOR 0x03 61#define CSR_HARDWARE_VERSION 0x04 62#define CSR_UNIT 0x11 63#define CSR_SPECIFIER_ID 0x12 64#define CSR_VERSION 0x13 65#define CSR_DEPENDENT_INFO 0x14 66#define CSR_MODEL 0x17 67#define CSR_DIRECTORY_ID 0x20 68 69struct fw_csr_iterator { 70 const u32 *p; 71 const u32 *end; 72}; 73 74void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p); 75int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value); 76int fw_csr_string(const u32 *directory, int key, char *buf, size_t size); 77 78extern const struct bus_type fw_bus_type; 79 80struct fw_card_driver; 81struct fw_node; 82 83struct fw_card { 84 const struct fw_card_driver *driver; 85 struct device *device; 86 struct kref kref; 87 struct completion done; 88 89 int node_id; 90 int generation; 91 int current_tlabel; 92 u64 tlabel_mask; 93 struct list_head transaction_list; 94 u64 reset_jiffies; 95 96 u32 split_timeout_hi; 97 u32 split_timeout_lo; 98 unsigned int split_timeout_cycles; 99 unsigned int split_timeout_jiffies; 100 101 unsigned long long guid; 102 unsigned max_receive; 103 int link_speed; 104 int config_rom_generation; 105 106 spinlock_t lock; /* Take this lock when handling the lists in 107 * this struct. */ 108 struct fw_node *local_node; 109 struct fw_node *root_node; 110 struct fw_node *irm_node; 111 u8 color; /* must be u8 to match the definition in struct fw_node */ 112 int gap_count; 113 bool beta_repeaters_present; 114 115 int index; 116 struct list_head link; 117 118 struct list_head phy_receiver_list; 119 120 struct delayed_work br_work; /* bus reset job */ 121 bool br_short; 122 123 struct delayed_work bm_work; /* bus manager job */ 124 int bm_retries; 125 int bm_generation; 126 int bm_node_id; 127 bool bm_abdicate; 128 129 bool priority_budget_implemented; /* controller feature */ 130 bool broadcast_channel_auto_allocated; /* controller feature */ 131 132 bool broadcast_channel_allocated; 133 u32 broadcast_channel; 134 __be32 topology_map[(CSR_TOPOLOGY_MAP_END - CSR_TOPOLOGY_MAP) / 4]; 135 136 __be32 maint_utility_register; 137}; 138 139static inline struct fw_card *fw_card_get(struct fw_card *card) 140{ 141 kref_get(&card->kref); 142 143 return card; 144} 145 146void fw_card_release(struct kref *kref); 147 148static inline void fw_card_put(struct fw_card *card) 149{ 150 kref_put(&card->kref, fw_card_release); 151} 152 153int fw_card_read_cycle_time(struct fw_card *card, u32 *cycle_time); 154 155struct fw_attribute_group { 156 struct attribute_group *groups[2]; 157 struct attribute_group group; 158 struct attribute *attrs[13]; 159}; 160 161enum fw_device_state { 162 FW_DEVICE_INITIALIZING, 163 FW_DEVICE_RUNNING, 164 FW_DEVICE_GONE, 165 FW_DEVICE_SHUTDOWN, 166}; 167 168/* 169 * Note, fw_device.generation always has to be read before fw_device.node_id. 170 * Use SMP memory barriers to ensure this. Otherwise requests will be sent 171 * to an outdated node_id if the generation was updated in the meantime due 172 * to a bus reset. 173 * 174 * Likewise, fw-core will take care to update .node_id before .generation so 175 * that whenever fw_device.generation is current WRT the actual bus generation, 176 * fw_device.node_id is guaranteed to be current too. 177 * 178 * The same applies to fw_device.card->node_id vs. fw_device.generation. 179 * 180 * fw_device.config_rom and fw_device.config_rom_length may be accessed during 181 * the lifetime of any fw_unit belonging to the fw_device, before device_del() 182 * was called on the last fw_unit. Alternatively, they may be accessed while 183 * holding fw_device_rwsem. 184 */ 185struct fw_device { 186 atomic_t state; 187 struct fw_node *node; 188 int node_id; 189 int generation; 190 unsigned max_speed; 191 struct fw_card *card; 192 struct device device; 193 194 struct mutex client_list_mutex; 195 struct list_head client_list; 196 197 const u32 *config_rom; 198 size_t config_rom_length; 199 int config_rom_retries; 200 unsigned is_local:1; 201 unsigned max_rec:4; 202 unsigned cmc:1; 203 unsigned irmc:1; 204 unsigned bc_implemented:2; 205 206 work_func_t workfn; 207 struct delayed_work work; 208 struct fw_attribute_group attribute_group; 209}; 210 211#define fw_device(dev) container_of_const(dev, struct fw_device, device) 212 213static inline int fw_device_is_shutdown(struct fw_device *device) 214{ 215 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN; 216} 217 218int fw_device_enable_phys_dma(struct fw_device *device); 219 220/* 221 * fw_unit.directory must not be accessed after device_del(&fw_unit.device). 222 */ 223struct fw_unit { 224 struct device device; 225 const u32 *directory; 226 struct fw_attribute_group attribute_group; 227}; 228 229#define fw_unit(dev) container_of_const(dev, struct fw_unit, device) 230 231static inline struct fw_unit *fw_unit_get(struct fw_unit *unit) 232{ 233 get_device(&unit->device); 234 235 return unit; 236} 237 238static inline void fw_unit_put(struct fw_unit *unit) 239{ 240 put_device(&unit->device); 241} 242 243#define fw_parent_device(unit) fw_device(unit->device.parent) 244 245struct ieee1394_device_id; 246 247struct fw_driver { 248 struct device_driver driver; 249 int (*probe)(struct fw_unit *unit, const struct ieee1394_device_id *id); 250 /* Called when the parent device sits through a bus reset. */ 251 void (*update)(struct fw_unit *unit); 252 void (*remove)(struct fw_unit *unit); 253 const struct ieee1394_device_id *id_table; 254}; 255 256struct fw_packet; 257struct fw_request; 258 259typedef void (*fw_packet_callback_t)(struct fw_packet *packet, 260 struct fw_card *card, int status); 261typedef void (*fw_transaction_callback_t)(struct fw_card *card, int rcode, 262 void *data, size_t length, 263 void *callback_data); 264typedef void (*fw_transaction_callback_with_tstamp_t)(struct fw_card *card, int rcode, 265 u32 request_tstamp, u32 response_tstamp, void *data, 266 size_t length, void *callback_data); 267 268union fw_transaction_callback { 269 fw_transaction_callback_t without_tstamp; 270 fw_transaction_callback_with_tstamp_t with_tstamp; 271}; 272 273/* 274 * This callback handles an inbound request subaction. It is called in 275 * RCU read-side context, therefore must not sleep. 276 * 277 * The callback should not initiate outbound request subactions directly. 278 * Otherwise there is a danger of recursion of inbound and outbound 279 * transactions from and to the local node. 280 * 281 * The callback is responsible that fw_send_response() is called on the @request, except for FCP 282 * registers for which the core takes care of that. 283 */ 284typedef void (*fw_address_callback_t)(struct fw_card *card, 285 struct fw_request *request, 286 int tcode, int destination, int source, 287 int generation, 288 unsigned long long offset, 289 void *data, size_t length, 290 void *callback_data); 291 292struct fw_packet { 293 int speed; 294 int generation; 295 u32 header[4]; 296 size_t header_length; 297 void *payload; 298 size_t payload_length; 299 dma_addr_t payload_bus; 300 bool payload_mapped; 301 u32 timestamp; 302 303 /* 304 * This callback is called when the packet transmission has completed. 305 * For successful transmission, the status code is the ack received 306 * from the destination. Otherwise it is one of the juju-specific 307 * rcodes: RCODE_SEND_ERROR, _CANCELLED, _BUSY, _GENERATION, _NO_ACK. 308 * The callback can be called from tasklet context and thus 309 * must never block. 310 */ 311 fw_packet_callback_t callback; 312 int ack; 313 struct list_head link; 314 void *driver_data; 315}; 316 317struct fw_transaction { 318 int node_id; /* The generation is implied; it is always the current. */ 319 int tlabel; 320 struct list_head link; 321 struct fw_card *card; 322 bool is_split_transaction; 323 struct timer_list split_timeout_timer; 324 u32 split_timeout_cycle; 325 326 struct fw_packet packet; 327 328 /* 329 * The data passed to the callback is valid only during the 330 * callback. 331 */ 332 union fw_transaction_callback callback; 333 bool with_tstamp; 334 void *callback_data; 335}; 336 337struct fw_address_handler { 338 u64 offset; 339 u64 length; 340 fw_address_callback_t address_callback; 341 void *callback_data; 342 struct list_head link; 343}; 344 345struct fw_address_region { 346 u64 start; 347 u64 end; 348}; 349 350extern const struct fw_address_region fw_high_memory_region; 351 352int fw_core_add_address_handler(struct fw_address_handler *handler, 353 const struct fw_address_region *region); 354void fw_core_remove_address_handler(struct fw_address_handler *handler); 355void fw_send_response(struct fw_card *card, 356 struct fw_request *request, int rcode); 357int fw_get_request_speed(struct fw_request *request); 358u32 fw_request_get_timestamp(const struct fw_request *request); 359 360void __fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode, 361 int destination_id, int generation, int speed, unsigned long long offset, 362 void *payload, size_t length, union fw_transaction_callback callback, 363 bool with_tstamp, void *callback_data); 364 365/** 366 * fw_send_request() - submit a request packet for transmission to generate callback for response 367 * subaction without time stamp. 368 * @card: interface to send the request at 369 * @t: transaction instance to which the request belongs 370 * @tcode: transaction code 371 * @destination_id: destination node ID, consisting of bus_ID and phy_ID 372 * @generation: bus generation in which request and response are valid 373 * @speed: transmission speed 374 * @offset: 48bit wide offset into destination's address space 375 * @payload: data payload for the request subaction 376 * @length: length of the payload, in bytes 377 * @callback: function to be called when the transaction is completed 378 * @callback_data: data to be passed to the transaction completion callback 379 * 380 * A variation of __fw_send_request() to generate callback for response subaction without time 381 * stamp. 382 */ 383static inline void fw_send_request(struct fw_card *card, struct fw_transaction *t, int tcode, 384 int destination_id, int generation, int speed, 385 unsigned long long offset, void *payload, size_t length, 386 fw_transaction_callback_t callback, void *callback_data) 387{ 388 union fw_transaction_callback cb = { 389 .without_tstamp = callback, 390 }; 391 __fw_send_request(card, t, tcode, destination_id, generation, speed, offset, payload, 392 length, cb, false, callback_data); 393} 394 395/** 396 * fw_send_request_with_tstamp() - submit a request packet for transmission to generate callback for 397 * response with time stamp. 398 * @card: interface to send the request at 399 * @t: transaction instance to which the request belongs 400 * @tcode: transaction code 401 * @destination_id: destination node ID, consisting of bus_ID and phy_ID 402 * @generation: bus generation in which request and response are valid 403 * @speed: transmission speed 404 * @offset: 48bit wide offset into destination's address space 405 * @payload: data payload for the request subaction 406 * @length: length of the payload, in bytes 407 * @callback: function to be called when the transaction is completed 408 * @callback_data: data to be passed to the transaction completion callback 409 * 410 * A variation of __fw_send_request() to generate callback for response subaction with time stamp. 411 */ 412static inline void fw_send_request_with_tstamp(struct fw_card *card, struct fw_transaction *t, 413 int tcode, int destination_id, int generation, int speed, unsigned long long offset, 414 void *payload, size_t length, fw_transaction_callback_with_tstamp_t callback, 415 void *callback_data) 416{ 417 union fw_transaction_callback cb = { 418 .with_tstamp = callback, 419 }; 420 __fw_send_request(card, t, tcode, destination_id, generation, speed, offset, payload, 421 length, cb, true, callback_data); 422} 423 424int fw_cancel_transaction(struct fw_card *card, 425 struct fw_transaction *transaction); 426int fw_run_transaction(struct fw_card *card, int tcode, int destination_id, 427 int generation, int speed, unsigned long long offset, 428 void *payload, size_t length); 429const char *fw_rcode_string(int rcode); 430 431static inline int fw_stream_packet_destination_id(int tag, int channel, int sy) 432{ 433 return tag << 14 | channel << 8 | sy; 434} 435 436void fw_schedule_bus_reset(struct fw_card *card, bool delayed, 437 bool short_reset); 438 439struct fw_descriptor { 440 struct list_head link; 441 size_t length; 442 u32 immediate; 443 u32 key; 444 const u32 *data; 445}; 446 447int fw_core_add_descriptor(struct fw_descriptor *desc); 448void fw_core_remove_descriptor(struct fw_descriptor *desc); 449 450/* 451 * The iso packet format allows for an immediate header/payload part 452 * stored in 'header' immediately after the packet info plus an 453 * indirect payload part that is pointer to by the 'payload' field. 454 * Applications can use one or the other or both to implement simple 455 * low-bandwidth streaming (e.g. audio) or more advanced 456 * scatter-gather streaming (e.g. assembling video frame automatically). 457 */ 458struct fw_iso_packet { 459 u16 payload_length; /* Length of indirect payload */ 460 u32 interrupt:1; /* Generate interrupt on this packet */ 461 u32 skip:1; /* tx: Set to not send packet at all */ 462 /* rx: Sync bit, wait for matching sy */ 463 u32 tag:2; /* tx: Tag in packet header */ 464 u32 sy:4; /* tx: Sy in packet header */ 465 u32 header_length:8; /* Length of immediate header */ 466 u32 header[]; /* tx: Top of 1394 isoch. data_block */ 467}; 468 469#define FW_ISO_CONTEXT_TRANSMIT 0 470#define FW_ISO_CONTEXT_RECEIVE 1 471#define FW_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2 472 473#define FW_ISO_CONTEXT_MATCH_TAG0 1 474#define FW_ISO_CONTEXT_MATCH_TAG1 2 475#define FW_ISO_CONTEXT_MATCH_TAG2 4 476#define FW_ISO_CONTEXT_MATCH_TAG3 8 477#define FW_ISO_CONTEXT_MATCH_ALL_TAGS 15 478 479/* 480 * An iso buffer is just a set of pages mapped for DMA in the 481 * specified direction. Since the pages are to be used for DMA, they 482 * are not mapped into the kernel virtual address space. We store the 483 * DMA address in the page private. The helper function 484 * fw_iso_buffer_map() will map the pages into a given vma. 485 */ 486struct fw_iso_buffer { 487 enum dma_data_direction direction; 488 struct page **pages; 489 int page_count; 490 int page_count_mapped; 491}; 492 493int fw_iso_buffer_init(struct fw_iso_buffer *buffer, struct fw_card *card, 494 int page_count, enum dma_data_direction direction); 495void fw_iso_buffer_destroy(struct fw_iso_buffer *buffer, struct fw_card *card); 496size_t fw_iso_buffer_lookup(struct fw_iso_buffer *buffer, dma_addr_t completed); 497 498struct fw_iso_context; 499typedef void (*fw_iso_callback_t)(struct fw_iso_context *context, 500 u32 cycle, size_t header_length, 501 void *header, void *data); 502typedef void (*fw_iso_mc_callback_t)(struct fw_iso_context *context, 503 dma_addr_t completed, void *data); 504 505union fw_iso_callback { 506 fw_iso_callback_t sc; 507 fw_iso_mc_callback_t mc; 508}; 509 510struct fw_iso_context { 511 struct fw_card *card; 512 int type; 513 int channel; 514 int speed; 515 bool drop_overflow_headers; 516 size_t header_size; 517 union fw_iso_callback callback; 518 void *callback_data; 519}; 520 521struct fw_iso_context *fw_iso_context_create(struct fw_card *card, 522 int type, int channel, int speed, size_t header_size, 523 fw_iso_callback_t callback, void *callback_data); 524int fw_iso_context_set_channels(struct fw_iso_context *ctx, u64 *channels); 525int fw_iso_context_queue(struct fw_iso_context *ctx, 526 struct fw_iso_packet *packet, 527 struct fw_iso_buffer *buffer, 528 unsigned long payload); 529void fw_iso_context_queue_flush(struct fw_iso_context *ctx); 530int fw_iso_context_flush_completions(struct fw_iso_context *ctx); 531int fw_iso_context_start(struct fw_iso_context *ctx, 532 int cycle, int sync, int tags); 533int fw_iso_context_stop(struct fw_iso_context *ctx); 534void fw_iso_context_destroy(struct fw_iso_context *ctx); 535void fw_iso_resource_manage(struct fw_card *card, int generation, 536 u64 channels_mask, int *channel, int *bandwidth, 537 bool allocate); 538 539extern struct workqueue_struct *fw_workqueue; 540 541#endif /* _LINUX_FIREWIRE_H */ 542