drivers/ieee1394/ieee1394_core.h

   1 #ifndef _IEEE1394_CORE_H
   2 #define _IEEE1394_CORE_H
   3
   4 #include <linux/device.h>
   5 #include <linux/fs.h>
   6 #include <linux/list.h>
   7 #include <linux/skbuff.h>
   8 #include <linux/types.h>
   9 #include <asm/atomic.h>
  10
  11 #include "hosts.h"
  12 #include "ieee1394_types.h"
  13
  14 struct hpsb_packet {
  15         /* This struct is basically read-only for hosts with the exception of
  16          * the data buffer contents and xnext - see below. */
  17
  18         /* This can be used for host driver internal linking.
  19          *
  20          * NOTE: This must be left in init state when the driver is done
  21          * with it (e.g. by using list_del_init()), since the core does
  22          * some sanity checks to make sure the packet is not on a
  23          * driver_list when free'ing it. */
  24         struct list_head driver_list;
  25
  26         nodeid_t node_id;
  27
  28         /* Async and Iso types should be clear, raw means send-as-is, do not
  29          * CRC!  Byte swapping shall still be done in this case. */
  30         enum { hpsb_async, hpsb_iso, hpsb_raw } __attribute__((packed)) type;
  31
  32         /* Okay, this is core internal and a no care for hosts.
  33          * queued   = queued for sending
  34          * pending  = sent, waiting for response
  35          * complete = processing completed, successful or not
  36          */
  37         enum {
  38                 hpsb_unused, hpsb_queued, hpsb_pending, hpsb_complete
  39         } __attribute__((packed)) state;
  40
  41         /* These are core internal. */
  42         signed char tlabel;
  43         signed char ack_code;
  44         unsigned char tcode;
  45
  46         unsigned expect_response:1;
  47         unsigned no_waiter:1;
  48
  49         /* Speed to transmit with: 0 = 100Mbps, 1 = 200Mbps, 2 = 400Mbps */
  50         unsigned speed_code:2;
  51
  52         /*
  53          * *header and *data are guaranteed to be 32-bit DMAable and may be
  54          * overwritten to allow in-place byte swapping.  Neither of these is
  55          * CRCed (the sizes also don't include CRC), but contain space for at
  56          * least one additional quadlet to allow in-place CRCing.  The memory is
  57          * also guaranteed to be DMA mappable.
  58          */
  59         quadlet_t *header;
  60         quadlet_t *data;
  61         size_t header_size;
  62         size_t data_size;
  63
  64         struct hpsb_host *host;
  65         unsigned int generation;
  66
  67         atomic_t refcnt;
  68
  69         /* Function (and possible data to pass to it) to call when this
  70          * packet is completed.  */
  71         void (*complete_routine)(void *);
  72         void *complete_data;
  73
  74         /* XXX This is just a hack at the moment */
  75         struct sk_buff *skb;
  76
  77         /* Store jiffies for implementing bus timeouts. */
  78         unsigned long sendtime;
  79
  80         quadlet_t embedded_header[5];
  81 };
  82
  83 /* Set a task for when a packet completes */
  84 void hpsb_set_packet_complete_task(struct hpsb_packet *packet,
  85                                    void (*routine)(void *), void *data);
  86
  87 static inline struct hpsb_packet *driver_packet(struct list_head *l)
  88 {
  89         return list_entry(l, struct hpsb_packet, driver_list);
  90 }
  91
  92 void abort_timedouts(unsigned long __opaque);
  93
  94 struct hpsb_packet *hpsb_alloc_packet(size_t data_size);
  95 void hpsb_free_packet(struct hpsb_packet *packet);
  96
  97 /*
  98  * Generation counter for the complete 1394 subsystem.  Generation gets
  99  * incremented on every change in the subsystem (e.g. bus reset).
 100  *
 101  * Use the functions, not the variable.
 102  */
 103 static inline unsigned int get_hpsb_generation(struct hpsb_host *host)
 104 {
 105         return atomic_read(&host->generation);
 106 }
 107
 108 /*
 109  * Send a PHY configuration packet, return 0 on success, negative
 110  * errno on failure.
 111  */
 112 int hpsb_send_phy_config(struct hpsb_host *host, int rootid, int gapcnt);
 113
 114 /*
 115  * Queue packet for transmitting, return 0 on success, negative errno
 116  * on failure.
 117  */
 118 int hpsb_send_packet(struct hpsb_packet *packet);
 119
 120 /*
 121  * Queue packet for transmitting, and block until the transaction
 122  * completes. Return 0 on success, negative errno on failure.
 123  */
 124 int hpsb_send_packet_and_wait(struct hpsb_packet *packet);
 125
 126 /* Initiate bus reset on the given host.  Returns 1 if bus reset already in
 127  * progress, 0 otherwise. */
 128 int hpsb_reset_bus(struct hpsb_host *host, int type);
 129
 130 int hpsb_read_cycle_timer(struct hpsb_host *host, u32 *cycle_timer,
 131                           u64 *local_time);
 132
 133 /*
 134  * The following functions are exported for host driver module usage.  All of
 135  * them are safe to use in interrupt contexts, although some are quite
 136  * complicated so you may want to run them in bottom halves instead of calling
 137  * them directly.
 138  */
 139
 140 /* Notify a bus reset to the core.  Returns 1 if bus reset already in progress,
 141  * 0 otherwise. */
 142 int hpsb_bus_reset(struct hpsb_host *host);
 143
 144 /*
 145  * Hand over received selfid packet to the core.  Complement check (second
 146  * quadlet is complement of first) is expected to be done and successful.
 147  */
 148 void hpsb_selfid_received(struct hpsb_host *host, quadlet_t sid);
 149
 150 /*
 151  * Notify completion of SelfID stage to the core and report new physical ID
 152  * and whether host is root now.
 153  */
 154 void hpsb_selfid_complete(struct hpsb_host *host, int phyid, int isroot);
 155
 156 /*
 157  * Notify core of sending a packet.  Ackcode is the ack code returned for async
 158  * transmits or ACKX_SEND_ERROR if the transmission failed completely; ACKX_NONE
 159  * for other cases (internal errors that don't justify a panic).  Safe to call
 160  * from within a transmit packet routine.
 161  */
 162 void hpsb_packet_sent(struct hpsb_host *host, struct hpsb_packet *packet,
 163                       int ackcode);
 164
 165 /*
 166  * Hand over received packet to the core.  The contents of data are expected to
 167  * be the full packet but with the CRCs left out (data block follows header
 168  * immediately), with the header (i.e. the first four quadlets) in machine byte
 169  * order and the data block in big endian.  *data can be safely overwritten
 170  * after this call.
 171  *
 172  * If the packet is a write request, write_acked is to be set to true if it was
 173  * ack_complete'd already, false otherwise.  This arg is ignored for any other
 174  * packet type.
 175  */
 176 void hpsb_packet_received(struct hpsb_host *host, quadlet_t *data, size_t size,
 177                           int write_acked);
 178
 179
 180 /*
 181  * CHARACTER DEVICE DISPATCHING
 182  *
 183  * All ieee1394 character device drivers share the same major number
 184  * (major 171).  The 256 minor numbers are allocated to the various
 185  * task-specific interfaces (raw1394, video1394, dv1394, etc) in
 186  * blocks of 16.
 187  *
 188  * The core ieee1394.o module allocates the device number region
 189  * 171:0-255, the various drivers must then cdev_add() their cdev
 190  * objects to handle their respective sub-regions.
 191  *
 192  * Minor device number block allocations:
 193  *
 194  * Block 0  (  0- 15)  raw1394
 195  * Block 1  ( 16- 31)  video1394
 196  * Block 2  ( 32- 47)  dv1394
 197  *
 198  * Blocks 3-14 free for future allocation
 199  *
 200  * Block 15 (240-255)  reserved for drivers under development, etc.
 201  */
 202
 203 #define IEEE1394_MAJOR                   171
 204
 205 #define IEEE1394_MINOR_BLOCK_RAW1394       0
 206 #define IEEE1394_MINOR_BLOCK_VIDEO1394     1
 207 #define IEEE1394_MINOR_BLOCK_DV1394        2
 208 #define IEEE1394_MINOR_BLOCK_EXPERIMENTAL 15
 209
 210 #define IEEE1394_CORE_DEV         MKDEV(IEEE1394_MAJOR, 0)
 211 #define IEEE1394_RAW1394_DEV      MKDEV(IEEE1394_MAJOR, \
 212                                         IEEE1394_MINOR_BLOCK_RAW1394 * 16)
 213 #define IEEE1394_VIDEO1394_DEV    MKDEV(IEEE1394_MAJOR, \
 214                                         IEEE1394_MINOR_BLOCK_VIDEO1394 * 16)
 215 #define IEEE1394_DV1394_DEV       MKDEV(IEEE1394_MAJOR, \
 216                                         IEEE1394_MINOR_BLOCK_DV1394 * 16)
 217 #define IEEE1394_EXPERIMENTAL_DEV MKDEV(IEEE1394_MAJOR, \
 218                                         IEEE1394_MINOR_BLOCK_EXPERIMENTAL * 16)
 219
 220 /* return the index (within a minor number block) of a file */
 221 static inline unsigned char ieee1394_file_to_instance(struct file *file)
 222 {
 223         return file->f_path.dentry->d_inode->i_cindex;
 224 }
 225
 226 extern int hpsb_disable_irm;
 227
 228 /* Our sysfs bus entry */
 229 extern struct bus_type ieee1394_bus_type;
 230 extern struct class hpsb_host_class;
 231 extern struct class *hpsb_protocol_class;
 232
 233 #endif /* _IEEE1394_CORE_H */