LXR linux/drivers/firewire/core.h

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