drivers/firewire/core.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 #ifndef _FIREWIRE_CORE_H
0003 #define _FIREWIRE_CORE_H
0004
0005 #include <linux/compiler.h>
0006 #include <linux/device.h>
0007 #include <linux/dma-mapping.h>
0008 #include <linux/fs.h>
0009 #include <linux/list.h>
0010 #include <linux/idr.h>
0011 #include <linux/mm_types.h>
0012 #include <linux/rwsem.h>
0013 #include <linux/slab.h>
0014 #include <linux/types.h>
0015
0016 #include <linux/refcount.h>
0017
0018 struct device;
0019 struct fw_card;
0020 struct fw_device;
0021 struct fw_iso_buffer;
0022 struct fw_iso_context;
0023 struct fw_iso_packet;
0024 struct fw_node;
0025 struct fw_packet;
0026
0027
0028 /* -card */
0029
0030 extern __printf(2, 3)
0031 void fw_err(const struct fw_card *card, const char *fmt, ...);
0032 extern __printf(2, 3)
0033 void fw_notice(const struct fw_card *card, const char *fmt, ...);
0034
0035 /* bitfields within the PHY registers */
0036 #define PHY_LINK_ACTIVE     0x80
0037 #define PHY_CONTENDER       0x40
0038 #define PHY_BUS_RESET       0x40
0039 #define PHY_EXTENDED_REGISTERS  0xe0
0040 #define PHY_BUS_SHORT_RESET 0x40
0041 #define PHY_INT_STATUS_BITS 0x3c
0042 #define PHY_ENABLE_ACCEL    0x02
0043 #define PHY_ENABLE_MULTI    0x01
0044 #define PHY_PAGE_SELECT     0xe0
0045
0046 #define BANDWIDTH_AVAILABLE_INITIAL 4915
0047 #define BROADCAST_CHANNEL_INITIAL   (1 << 31 | 31)
0048 #define BROADCAST_CHANNEL_VALID     (1 << 30)
0049
0050 #define CSR_STATE_BIT_CMSTR (1 << 8)
0051 #define CSR_STATE_BIT_ABDICATE  (1 << 10)
0052
0053 struct fw_card_driver {
0054     /*
0055      * Enable the given card with the given initial config rom.
0056      * This function is expected to activate the card, and either
0057      * enable the PHY or set the link_on bit and initiate a bus
0058      * reset.
0059      */
0060     int (*enable)(struct fw_card *card,
0061               const __be32 *config_rom, size_t length);
0062
0063     int (*read_phy_reg)(struct fw_card *card, int address);
0064     int (*update_phy_reg)(struct fw_card *card, int address,
0065                   int clear_bits, int set_bits);
0066
0067     /*
0068      * Update the config rom for an enabled card.  This function
0069      * should change the config rom that is presented on the bus
0070      * and initiate a bus reset.
0071      */
0072     int (*set_config_rom)(struct fw_card *card,
0073                   const __be32 *config_rom, size_t length);
0074
0075     void (*send_request)(struct fw_card *card, struct fw_packet *packet);
0076     void (*send_response)(struct fw_card *card, struct fw_packet *packet);
0077     /* Calling cancel is valid once a packet has been submitted. */
0078     int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
0079
0080     /*
0081      * Allow the specified node ID to do direct DMA out and in of
0082      * host memory.  The card will disable this for all node when
0083      * a bus reset happens, so driver need to reenable this after
0084      * bus reset.  Returns 0 on success, -ENODEV if the card
0085      * doesn't support this, -ESTALE if the generation doesn't
0086      * match.
0087      */
0088     int (*enable_phys_dma)(struct fw_card *card,
0089                    int node_id, int generation);
0090
0091     u32 (*read_csr)(struct fw_card *card, int csr_offset);
0092     void (*write_csr)(struct fw_card *card, int csr_offset, u32 value);
0093
0094     struct fw_iso_context *
0095     (*allocate_iso_context)(struct fw_card *card,
0096                 int type, int channel, size_t header_size);
0097     void (*free_iso_context)(struct fw_iso_context *ctx);
0098
0099     int (*start_iso)(struct fw_iso_context *ctx,
0100              s32 cycle, u32 sync, u32 tags);
0101
0102     int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels);
0103
0104     int (*queue_iso)(struct fw_iso_context *ctx,
0105              struct fw_iso_packet *packet,
0106              struct fw_iso_buffer *buffer,
0107              unsigned long payload);
0108
0109     void (*flush_queue_iso)(struct fw_iso_context *ctx);
0110
0111     int (*flush_iso_completions)(struct fw_iso_context *ctx);
0112
0113     int (*stop_iso)(struct fw_iso_context *ctx);
0114 };
0115
0116 void fw_card_initialize(struct fw_card *card,
0117         const struct fw_card_driver *driver, struct device *device);
0118 int fw_card_add(struct fw_card *card,
0119         u32 max_receive, u32 link_speed, u64 guid);
0120 void fw_core_remove_card(struct fw_card *card);
0121 int fw_compute_block_crc(__be32 *block);
0122 void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
0123
0124 /* -cdev */
0125
0126 extern const struct file_operations fw_device_ops;
0127
0128 void fw_device_cdev_update(struct fw_device *device);
0129 void fw_device_cdev_remove(struct fw_device *device);
0130 void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p);
0131
0132
0133 /* -device */
0134
0135 extern struct rw_semaphore fw_device_rwsem;
0136 extern struct idr fw_device_idr;
0137 extern int fw_cdev_major;
0138
0139 static inline struct fw_device *fw_device_get(struct fw_device *device)
0140 {
0141     get_device(&device->device);
0142
0143     return device;
0144 }
0145
0146 static inline void fw_device_put(struct fw_device *device)
0147 {
0148     put_device(&device->device);
0149 }
0150
0151 struct fw_device *fw_device_get_by_devt(dev_t devt);
0152 int fw_device_set_broadcast_channel(struct device *dev, void *gen);
0153 void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
0154
0155
0156 /* -iso */
0157
0158 int fw_iso_buffer_alloc(struct fw_iso_buffer *buffer, int page_count);
0159 int fw_iso_buffer_map_dma(struct fw_iso_buffer *buffer, struct fw_card *card,
0160               enum dma_data_direction direction);
0161
0162
0163 /* -topology */
0164
0165 enum {
0166     FW_NODE_CREATED,
0167     FW_NODE_UPDATED,
0168     FW_NODE_DESTROYED,
0169     FW_NODE_LINK_ON,
0170     FW_NODE_LINK_OFF,
0171     FW_NODE_INITIATED_RESET,
0172 };
0173
0174 struct fw_node {
0175     u16 node_id;
0176     u8 color;
0177     u8 port_count;
0178     u8 link_on:1;
0179     u8 initiated_reset:1;
0180     u8 b_path:1;
0181     u8 phy_speed:2; /* As in the self ID packet. */
0182     u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
0183              * local node to this node. */
0184     u8 max_depth:4; /* Maximum depth to any leaf node */
0185     u8 max_hops:4;  /* Max hops in this sub tree */
0186     refcount_t ref_count;
0187
0188     /* For serializing node topology into a list. */
0189     struct list_head link;
0190
0191     /* Upper layer specific data. */
0192     void *data;
0193
0194     struct fw_node *ports[];
0195 };
0196
0197 static inline struct fw_node *fw_node_get(struct fw_node *node)
0198 {
0199     refcount_inc(&node->ref_count);
0200
0201     return node;
0202 }
0203
0204 static inline void fw_node_put(struct fw_node *node)
0205 {
0206     if (refcount_dec_and_test(&node->ref_count))
0207         kfree(node);
0208 }
0209
0210 void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
0211     int generation, int self_id_count, u32 *self_ids, bool bm_abdicate);
0212 void fw_destroy_nodes(struct fw_card *card);
0213
0214 /*
0215  * Check whether new_generation is the immediate successor of old_generation.
0216  * Take counter roll-over at 255 (as per OHCI) into account.
0217  */
0218 static inline bool is_next_generation(int new_generation, int old_generation)
0219 {
0220     return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
0221 }
0222
0223
0224 /* -transaction */
0225
0226 #define TCODE_LINK_INTERNAL     0xe
0227
0228 #define TCODE_IS_READ_REQUEST(tcode)    (((tcode) & ~1) == 4)
0229 #define TCODE_IS_BLOCK_PACKET(tcode)    (((tcode) &  1) != 0)
0230 #define TCODE_IS_LINK_INTERNAL(tcode)   ((tcode) == TCODE_LINK_INTERNAL)
0231 #define TCODE_IS_REQUEST(tcode)     (((tcode) &  2) == 0)
0232 #define TCODE_IS_RESPONSE(tcode)    (((tcode) &  2) != 0)
0233 #define TCODE_HAS_REQUEST_DATA(tcode)   (((tcode) & 12) != 4)
0234 #define TCODE_HAS_RESPONSE_DATA(tcode)  (((tcode) & 12) != 0)
0235
0236 #define LOCAL_BUS 0xffc0
0237
0238 /* OHCI-1394's default upper bound for physical DMA: 4 GB */
0239 #define FW_MAX_PHYSICAL_RANGE       (1ULL << 32)
0240
0241 void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
0242 void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
0243 int fw_get_response_length(struct fw_request *request);
0244 void fw_fill_response(struct fw_packet *response, u32 *request_header,
0245               int rcode, void *payload, size_t length);
0246
0247 #define FW_PHY_CONFIG_NO_NODE_ID    -1
0248 #define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1
0249 void fw_send_phy_config(struct fw_card *card,
0250             int node_id, int generation, int gap_count);
0251
0252 static inline bool is_ping_packet(u32 *data)
0253 {
0254     return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1];
0255 }
0256
0257 #endif /* _FIREWIRE_CORE_H */