ide-tape: fix vendor strings
[linux-3.10.git] / 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/types.h>
8 #include <asm/atomic.h>
9
10 #include "hosts.h"
11 #include "ieee1394_types.h"
12
13 struct hpsb_packet {
14         /* This struct is basically read-only for hosts with the exception of
15          * the data buffer contents and driver_list. */
16
17         /* This can be used for host driver internal linking.
18          *
19          * NOTE: This must be left in init state when the driver is done
20          * with it (e.g. by using list_del_init()), since the core does
21          * some sanity checks to make sure the packet is not on a
22          * driver_list when free'ing it. */
23         struct list_head driver_list;
24
25         nodeid_t node_id;
26
27         /* hpsb_raw = send as-is, do not CRC (but still byte-swap it) */
28         enum { hpsb_async, hpsb_raw } __attribute__((packed)) type;
29
30         /* Okay, this is core internal and a no care for hosts.
31          * queued   = queued for sending
32          * pending  = sent, waiting for response
33          * complete = processing completed, successful or not
34          */
35         enum {
36                 hpsb_unused, hpsb_queued, hpsb_pending, hpsb_complete
37         } __attribute__((packed)) state;
38
39         /* These are core-internal. */
40         signed char tlabel;
41         signed char ack_code;
42         unsigned char tcode;
43
44         unsigned expect_response:1;
45         unsigned no_waiter:1;
46
47         /* Speed to transmit with: 0 = 100Mbps, 1 = 200Mbps, 2 = 400Mbps */
48         unsigned speed_code:2;
49
50         struct hpsb_host *host;
51         unsigned int generation;
52
53         atomic_t refcnt;
54         struct list_head queue;
55
56         /* Function (and possible data to pass to it) to call when this
57          * packet is completed.  */
58         void (*complete_routine)(void *);
59         void *complete_data;
60
61         /* Store jiffies for implementing bus timeouts. */
62         unsigned long sendtime;
63
64         /* Core-internal.  */
65         size_t allocated_data_size;     /* as allocated */
66
67         /* Sizes are in bytes. To be set by caller of hpsb_alloc_packet. */
68         size_t data_size;               /* as filled in */
69         size_t header_size;             /* as filled in, not counting the CRC */
70
71         /* Buffers */
72         quadlet_t *data;                /* can be DMA-mapped */
73         quadlet_t header[5];
74         quadlet_t embedded_data[0];     /* keep as last member */
75 };
76
77 void hpsb_set_packet_complete_task(struct hpsb_packet *packet,
78                                    void (*routine)(void *), void *data);
79 static inline struct hpsb_packet *driver_packet(struct list_head *l)
80 {
81         return list_entry(l, struct hpsb_packet, driver_list);
82 }
83 void abort_timedouts(unsigned long __opaque);
84 struct hpsb_packet *hpsb_alloc_packet(size_t data_size);
85 void hpsb_free_packet(struct hpsb_packet *packet);
86
87 /**
88  * get_hpsb_generation - generation counter for the complete 1394 subsystem
89  *
90  * Generation gets incremented on every change in the subsystem (notably on bus
91  * resets). Use the functions, not the variable.
92  */
93 static inline unsigned int get_hpsb_generation(struct hpsb_host *host)
94 {
95         return atomic_read(&host->generation);
96 }
97
98 int hpsb_send_phy_config(struct hpsb_host *host, int rootid, int gapcnt);
99 int hpsb_send_packet(struct hpsb_packet *packet);
100 int hpsb_send_packet_and_wait(struct hpsb_packet *packet);
101 int hpsb_reset_bus(struct hpsb_host *host, int type);
102 int hpsb_read_cycle_timer(struct hpsb_host *host, u32 *cycle_timer,
103                           u64 *local_time);
104
105 int hpsb_bus_reset(struct hpsb_host *host);
106 void hpsb_selfid_received(struct hpsb_host *host, quadlet_t sid);
107 void hpsb_selfid_complete(struct hpsb_host *host, int phyid, int isroot);
108 void hpsb_packet_sent(struct hpsb_host *host, struct hpsb_packet *packet,
109                       int ackcode);
110 void hpsb_packet_received(struct hpsb_host *host, quadlet_t *data, size_t size,
111                           int write_acked);
112
113 /*
114  * CHARACTER DEVICE DISPATCHING
115  *
116  * All ieee1394 character device drivers share the same major number
117  * (major 171).  The 256 minor numbers are allocated to the various
118  * task-specific interfaces (raw1394, video1394, dv1394, etc) in
119  * blocks of 16.
120  *
121  * The core ieee1394.o module allocates the device number region
122  * 171:0-255, the various drivers must then cdev_add() their cdev
123  * objects to handle their respective sub-regions.
124  *
125  * Minor device number block allocations:
126  *
127  * Block 0  (  0- 15)  raw1394
128  * Block 1  ( 16- 31)  video1394
129  * Block 2  ( 32- 47)  dv1394
130  *
131  * Blocks 3-14 free for future allocation
132  *
133  * Block 15 (240-255)  reserved for drivers under development, etc.
134  */
135
136 #define IEEE1394_MAJOR                   171
137
138 #define IEEE1394_MINOR_BLOCK_RAW1394       0
139 #define IEEE1394_MINOR_BLOCK_VIDEO1394     1
140 #define IEEE1394_MINOR_BLOCK_DV1394        2
141 #define IEEE1394_MINOR_BLOCK_EXPERIMENTAL 15
142
143 #define IEEE1394_CORE_DEV         MKDEV(IEEE1394_MAJOR, 0)
144 #define IEEE1394_RAW1394_DEV      MKDEV(IEEE1394_MAJOR, \
145                                         IEEE1394_MINOR_BLOCK_RAW1394 * 16)
146 #define IEEE1394_VIDEO1394_DEV    MKDEV(IEEE1394_MAJOR, \
147                                         IEEE1394_MINOR_BLOCK_VIDEO1394 * 16)
148 #define IEEE1394_DV1394_DEV       MKDEV(IEEE1394_MAJOR, \
149                                         IEEE1394_MINOR_BLOCK_DV1394 * 16)
150 #define IEEE1394_EXPERIMENTAL_DEV MKDEV(IEEE1394_MAJOR, \
151                                         IEEE1394_MINOR_BLOCK_EXPERIMENTAL * 16)
152
153 /**
154  * ieee1394_file_to_instance - get the index within a minor number block
155  */
156 static inline unsigned char ieee1394_file_to_instance(struct file *file)
157 {
158         return file->f_path.dentry->d_inode->i_cindex;
159 }
160
161 extern int hpsb_disable_irm;
162
163 /* Our sysfs bus entry */
164 extern struct bus_type ieee1394_bus_type;
165 extern struct class hpsb_host_class;
166 extern struct class *hpsb_protocol_class;
167
168 #endif /* _IEEE1394_CORE_H */