b24413180f560 (Greg Kroah-Hartman 2017-11-01 15:07:57 +0100 1) /* SPDX-License-Identifier: GPL-2.0 */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 2) #ifndef _FIREWIRE_CORE_H
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 3) #define _FIREWIRE_CORE_H
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 4)
26b4950de174b (Stefan Richter 2012-02-18 22:03:14 +0100 5) #include <linux/compiler.h>
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 6) #include <linux/device.h>
0b6c4857f7684 (Stefan Richter 2012-04-09 20:51:18 +0200 7) #include <linux/dma-mapping.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 8) #include <linux/fs.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 9) #include <linux/list.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 10) #include <linux/idr.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 11) #include <linux/mm_types.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 12) #include <linux/rwsem.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 13) #include <linux/slab.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 14) #include <linux/types.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 15)
392910cf3f8a0 (Elena Reshetova 2017-03-06 16:20:49 +0200 16) #include <linux/refcount.h>
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 17)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 18) struct device;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 19) struct fw_card;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 20) struct fw_device;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 21) struct fw_iso_buffer;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 22) struct fw_iso_context;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 23) struct fw_iso_packet;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 24) struct fw_node;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 25) struct fw_packet;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 26)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 27)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 28) /* -card */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 29)
26b4950de174b (Stefan Richter 2012-02-18 22:03:14 +0100 30) extern __printf(2, 3)
26b4950de174b (Stefan Richter 2012-02-18 22:03:14 +0100 31) void fw_err(const struct fw_card *card, const char *fmt, ...);
26b4950de174b (Stefan Richter 2012-02-18 22:03:14 +0100 32) extern __printf(2, 3)
26b4950de174b (Stefan Richter 2012-02-18 22:03:14 +0100 33) void fw_notice(const struct fw_card *card, const char *fmt, ...);
26b4950de174b (Stefan Richter 2012-02-18 22:03:14 +0100 34)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 35) /* bitfields within the PHY registers */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 36) #define PHY_LINK_ACTIVE 0x80
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 37) #define PHY_CONTENDER 0x40
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 38) #define PHY_BUS_RESET 0x40
925e7a6504966 (Clemens Ladisch 2010-04-04 15:19:54 +0200 39) #define PHY_EXTENDED_REGISTERS 0xe0
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 40) #define PHY_BUS_SHORT_RESET 0x40
e7014dada0419 (Clemens Ladisch 2010-04-01 16:40:18 +0200 41) #define PHY_INT_STATUS_BITS 0x3c
925e7a6504966 (Clemens Ladisch 2010-04-04 15:19:54 +0200 42) #define PHY_ENABLE_ACCEL 0x02
925e7a6504966 (Clemens Ladisch 2010-04-04 15:19:54 +0200 43) #define PHY_ENABLE_MULTI 0x01
925e7a6504966 (Clemens Ladisch 2010-04-04 15:19:54 +0200 44) #define PHY_PAGE_SELECT 0xe0
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 45)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 46) #define BANDWIDTH_AVAILABLE_INITIAL 4915
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 47) #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 48) #define BROADCAST_CHANNEL_VALID (1 << 30)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 49)
4ffb7a6a066e4 (Clemens Ladisch 2010-06-10 08:36:37 +0200 50) #define CSR_STATE_BIT_CMSTR (1 << 8)
7e0e314f198d5 (Clemens Ladisch 2010-06-10 08:37:15 +0200 51) #define CSR_STATE_BIT_ABDICATE (1 << 10)
4ffb7a6a066e4 (Clemens Ladisch 2010-06-10 08:36:37 +0200 52)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 53) struct fw_card_driver {
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 54) /*
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 55) * Enable the given card with the given initial config rom.
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 56) * This function is expected to activate the card, and either
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 57) * enable the PHY or set the link_on bit and initiate a bus
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 58) * reset.
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 59) */
8e85973efc87d (Stefan Richter 2009-10-08 00:41:59 +0200 60) int (*enable)(struct fw_card *card,
8e85973efc87d (Stefan Richter 2009-10-08 00:41:59 +0200 61) const __be32 *config_rom, size_t length);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 62)
02d37bed188c5 (Stefan Richter 2010-07-08 16:09:06 +0200 63) int (*read_phy_reg)(struct fw_card *card, int address);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 64) int (*update_phy_reg)(struct fw_card *card, int address,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 65) int clear_bits, int set_bits);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 66)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 67) /*
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 68) * Update the config rom for an enabled card. This function
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 69) * should change the config rom that is presented on the bus
8e85973efc87d (Stefan Richter 2009-10-08 00:41:59 +0200 70) * and initiate a bus reset.
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 71) */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 72) int (*set_config_rom)(struct fw_card *card,
8e85973efc87d (Stefan Richter 2009-10-08 00:41:59 +0200 73) const __be32 *config_rom, size_t length);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 74)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 75) void (*send_request)(struct fw_card *card, struct fw_packet *packet);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 76) void (*send_response)(struct fw_card *card, struct fw_packet *packet);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 77) /* Calling cancel is valid once a packet has been submitted. */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 78) int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 79)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 80) /*
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 81) * Allow the specified node ID to do direct DMA out and in of
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 82) * host memory. The card will disable this for all node when
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 83) * a bus reset happens, so driver need to reenable this after
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 84) * bus reset. Returns 0 on success, -ENODEV if the card
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 85) * doesn't support this, -ESTALE if the generation doesn't
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 86) * match.
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 87) */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 88) int (*enable_phys_dma)(struct fw_card *card,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 89) int node_id, int generation);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 90)
0fcff4e39323f (Stefan Richter 2010-06-12 20:35:52 +0200 91) u32 (*read_csr)(struct fw_card *card, int csr_offset);
0fcff4e39323f (Stefan Richter 2010-06-12 20:35:52 +0200 92) void (*write_csr)(struct fw_card *card, int csr_offset, u32 value);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 93)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 94) struct fw_iso_context *
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 95) (*allocate_iso_context)(struct fw_card *card,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 96) int type, int channel, size_t header_size);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 97) void (*free_iso_context)(struct fw_iso_context *ctx);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 98)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 99) int (*start_iso)(struct fw_iso_context *ctx,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 100) s32 cycle, u32 sync, u32 tags);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 101)
872e330e38806 (Stefan Richter 2010-07-29 18:19:22 +0200 102) int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels);
872e330e38806 (Stefan Richter 2010-07-29 18:19:22 +0200 103)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 104) int (*queue_iso)(struct fw_iso_context *ctx,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 105) struct fw_iso_packet *packet,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 106) struct fw_iso_buffer *buffer,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 107) unsigned long payload);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 108)
13882a82ee164 (Clemens Ladisch 2011-05-02 09:33:56 +0200 109) void (*flush_queue_iso)(struct fw_iso_context *ctx);
13882a82ee164 (Clemens Ladisch 2011-05-02 09:33:56 +0200 110)
d1bbd20972936 (Clemens Ladisch 2012-03-18 19:06:39 +0100 111) int (*flush_iso_completions)(struct fw_iso_context *ctx);
d1bbd20972936 (Clemens Ladisch 2012-03-18 19:06:39 +0100 112)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 113) int (*stop_iso)(struct fw_iso_context *ctx);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 114) };
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 115)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 116) void fw_card_initialize(struct fw_card *card,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 117) const struct fw_card_driver *driver, struct device *device);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 118) int fw_card_add(struct fw_card *card,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 119) u32 max_receive, u32 link_speed, u64 guid);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 120) void fw_core_remove_card(struct fw_card *card);
cb7c96da36511 (Stefan Richter 2009-10-08 00:42:53 +0200 121) int fw_compute_block_crc(__be32 *block);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 122) void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 123)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 124) /* -cdev */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 125)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 126) extern const struct file_operations fw_device_ops;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 127)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 128) void fw_device_cdev_update(struct fw_device *device);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 129) void fw_device_cdev_remove(struct fw_device *device);
bf54e1462b919 (Stefan Richter 2010-07-16 22:25:51 +0200 130) void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 131)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 132)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 133) /* -device */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 134)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 135) extern struct rw_semaphore fw_device_rwsem;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 136) extern struct idr fw_device_idr;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 137) extern int fw_cdev_major;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 138)
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 139) static inline struct fw_device *fw_device_get(struct fw_device *device)
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 140) {
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 141) get_device(&device->device);
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 142)
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 143) return device;
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 144) }
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 145)
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 146) static inline void fw_device_put(struct fw_device *device)
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 147) {
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 148) put_device(&device->device);
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 149) }
2107622684666 (Stefan Richter 2011-08-27 18:53:03 +0200 150)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 151) struct fw_device *fw_device_get_by_devt(dev_t devt);
099d54143e49d (Stefan Richter 2009-06-06 18:37:25 +0200 152) int fw_device_set_broadcast_channel(struct device *dev, void *gen);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 153) void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 154)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 155)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 156) /* -iso */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 157)
0b6c4857f7684 (Stefan Richter 2012-04-09 20:51:18 +0200 158) int fw_iso_buffer_alloc(struct fw_iso_buffer *buffer, int page_count);
0b6c4857f7684 (Stefan Richter 2012-04-09 20:51:18 +0200 159) int fw_iso_buffer_map_dma(struct fw_iso_buffer *buffer, struct fw_card *card,
0b6c4857f7684 (Stefan Richter 2012-04-09 20:51:18 +0200 160) enum dma_data_direction direction);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 161)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 162)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 163) /* -topology */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 164)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 165) enum {
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 166) FW_NODE_CREATED,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 167) FW_NODE_UPDATED,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 168) FW_NODE_DESTROYED,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 169) FW_NODE_LINK_ON,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 170) FW_NODE_LINK_OFF,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 171) FW_NODE_INITIATED_RESET,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 172) };
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 173)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 174) struct fw_node {
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 175) u16 node_id;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 176) u8 color;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 177) u8 port_count;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 178) u8 link_on:1;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 179) u8 initiated_reset:1;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 180) u8 b_path:1;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 181) u8 phy_speed:2; /* As in the self ID packet. */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 182) u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 183) * local node to this node. */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 184) u8 max_depth:4; /* Maximum depth to any leaf node */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 185) u8 max_hops:4; /* Max hops in this sub tree */
392910cf3f8a0 (Elena Reshetova 2017-03-06 16:20:49 +0200 186) refcount_t ref_count;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 187)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 188) /* For serializing node topology into a list. */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 189) struct list_head link;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 190)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 191) /* Upper layer specific data. */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 192) void *data;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 193)
c38e7e212acdb (Gustavo A. R. Silva 2020-05-28 09:35:11 -0500 194) struct fw_node *ports[];
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 195) };
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 196)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 197) static inline struct fw_node *fw_node_get(struct fw_node *node)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 198) {
392910cf3f8a0 (Elena Reshetova 2017-03-06 16:20:49 +0200 199) refcount_inc(&node->ref_count);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 200)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 201) return node;
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 202) }
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 203)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 204) static inline void fw_node_put(struct fw_node *node)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 205) {
392910cf3f8a0 (Elena Reshetova 2017-03-06 16:20:49 +0200 206) if (refcount_dec_and_test(&node->ref_count))
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 207) kfree(node);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 208) }
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 209)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 210) void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
c8a94ded57e9c (Stefan Richter 2010-06-12 20:34:50 +0200 211) int generation, int self_id_count, u32 *self_ids, bool bm_abdicate);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 212) void fw_destroy_nodes(struct fw_card *card);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 213)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 214) /*
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 215) * Check whether new_generation is the immediate successor of old_generation.
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 216) * Take counter roll-over at 255 (as per OHCI) into account.
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 217) */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 218) static inline bool is_next_generation(int new_generation, int old_generation)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 219) {
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 220) return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 221) }
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 222)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 223)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 224) /* -transaction */
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 225)
5b06db166c4d3 (Clemens Ladisch 2010-11-30 08:24:47 +0100 226) #define TCODE_LINK_INTERNAL 0xe
5b06db166c4d3 (Clemens Ladisch 2010-11-30 08:24:47 +0100 227)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 228) #define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 229) #define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
5b06db166c4d3 (Clemens Ladisch 2010-11-30 08:24:47 +0100 230) #define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == TCODE_LINK_INTERNAL)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 231) #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 232) #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 233) #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 234) #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 235)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 236) #define LOCAL_BUS 0xffc0
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 237)
2fe2023adf695 (Stefan Richter 2014-05-29 15:23:26 +0200 238) /* OHCI-1394's default upper bound for physical DMA: 4 GB */
2fe2023adf695 (Stefan Richter 2014-05-29 15:23:26 +0200 239) #define FW_MAX_PHYSICAL_RANGE (1ULL << 32)
fcd46b34425da (Stefan Richter 2014-01-18 17:32:20 +0100 240)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 241) void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 242) void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
a10c0ce760988 (Clemens Ladisch 2010-05-19 08:28:32 +0200 243) int fw_get_response_length(struct fw_request *request);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 244) void fw_fill_response(struct fw_packet *response, u32 *request_header,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 245) int rcode, void *payload, size_t length);
02d37bed188c5 (Stefan Richter 2010-07-08 16:09:06 +0200 246)
02d37bed188c5 (Stefan Richter 2010-07-08 16:09:06 +0200 247) #define FW_PHY_CONFIG_NO_NODE_ID -1
02d37bed188c5 (Stefan Richter 2010-07-08 16:09:06 +0200 248) #define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 249) void fw_send_phy_config(struct fw_card *card,
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 250) int node_id, int generation, int gap_count);
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 251)
cc550216ae9a2 (Stefan Richter 2010-07-18 13:00:50 +0200 252) static inline bool is_ping_packet(u32 *data)
cc550216ae9a2 (Stefan Richter 2010-07-18 13:00:50 +0200 253) {
cc550216ae9a2 (Stefan Richter 2010-07-18 13:00:50 +0200 254) return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1];
cc550216ae9a2 (Stefan Richter 2010-07-18 13:00:50 +0200 255) }
cc550216ae9a2 (Stefan Richter 2010-07-18 13:00:50 +0200 256)
77c9a5daa9c4d (Stefan Richter 2009-06-05 16:26:18 +0200 257) #endif /* _FIREWIRE_CORE_H */