core.h 7.3 KB

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