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