drivers/firewire/core.h

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