[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / asm-alpha / pci.h
blob4e115f368d5fdd966a52cfc18d195724f2e03482
1 #ifndef __ALPHA_PCI_H
2 #define __ALPHA_PCI_H
4 #ifdef __KERNEL__
6 #include <linux/spinlock.h>
7 #include <asm/scatterlist.h>
8 #include <asm/machvec.h>
11 * The following structure is used to manage multiple PCI busses.
14 struct pci_dev;
15 struct pci_bus;
16 struct resource;
17 struct pci_iommu_arena;
18 struct page;
20 /* A controller. Used to manage multiple PCI busses. */
22 struct pci_controller {
23 struct pci_controller *next;
24 struct pci_bus *bus;
25 struct resource *io_space;
26 struct resource *mem_space;
28 /* The following are for reporting to userland. The invariant is
29 that if we report a BWX-capable dense memory, we do not report
30 a sparse memory at all, even if it exists. */
31 unsigned long sparse_mem_base;
32 unsigned long dense_mem_base;
33 unsigned long sparse_io_base;
34 unsigned long dense_io_base;
36 /* This one's for the kernel only. It's in KSEG somewhere. */
37 unsigned long config_space_base;
39 unsigned int index;
40 /* For compatibility with current (as of July 2003) pciutils
41 and XFree86. Eventually will be removed. */
42 unsigned int need_domain_info;
44 struct pci_iommu_arena *sg_pci;
45 struct pci_iommu_arena *sg_isa;
47 void *sysdata;
50 /* Override the logic in pci_scan_bus for skipping already-configured
51 bus numbers. */
53 #define pcibios_assign_all_busses() 1
54 #define pcibios_scan_all_fns(a, b) 0
56 #define PCIBIOS_MIN_IO alpha_mv.min_io_address
57 #define PCIBIOS_MIN_MEM alpha_mv.min_mem_address
59 extern void pcibios_set_master(struct pci_dev *dev);
61 extern inline void pcibios_penalize_isa_irq(int irq, int active)
63 /* We don't do dynamic PCI IRQ allocation */
66 /* IOMMU controls. */
68 /* The PCI address space does not equal the physical memory address space.
69 The networking and block device layers use this boolean for bounce buffer
70 decisions. */
71 #define PCI_DMA_BUS_IS_PHYS 0
73 /* Allocate and map kernel buffer using consistent mode DMA for PCI
74 device. Returns non-NULL cpu-view pointer to the buffer if
75 successful and sets *DMA_ADDRP to the pci side dma address as well,
76 else DMA_ADDRP is undefined. */
78 extern void *pci_alloc_consistent(struct pci_dev *, size_t, dma_addr_t *);
80 /* Free and unmap a consistent DMA buffer. CPU_ADDR and DMA_ADDR must
81 be values that were returned from pci_alloc_consistent. SIZE must
82 be the same as what as passed into pci_alloc_consistent.
83 References to the memory and mappings associated with CPU_ADDR or
84 DMA_ADDR past this call are illegal. */
86 extern void pci_free_consistent(struct pci_dev *, size_t, void *, dma_addr_t);
88 /* Map a single buffer of the indicate size for PCI DMA in streaming mode.
89 The 32-bit PCI bus mastering address to use is returned. Once the device
90 is given the dma address, the device owns this memory until either
91 pci_unmap_single or pci_dma_sync_single_for_cpu is performed. */
93 extern dma_addr_t pci_map_single(struct pci_dev *, void *, size_t, int);
95 /* Likewise, but for a page instead of an address. */
96 extern dma_addr_t pci_map_page(struct pci_dev *, struct page *,
97 unsigned long, size_t, int);
99 /* Test for pci_map_single or pci_map_page having generated an error. */
101 static inline int
102 pci_dma_mapping_error(dma_addr_t dma_addr)
104 return dma_addr == 0;
107 /* Unmap a single streaming mode DMA translation. The DMA_ADDR and
108 SIZE must match what was provided for in a previous pci_map_single
109 call. All other usages are undefined. After this call, reads by
110 the cpu to the buffer are guaranteed to see whatever the device
111 wrote there. */
113 extern void pci_unmap_single(struct pci_dev *, dma_addr_t, size_t, int);
114 extern void pci_unmap_page(struct pci_dev *, dma_addr_t, size_t, int);
116 /* pci_unmap_{single,page} is not a nop, thus... */
117 #define DECLARE_PCI_UNMAP_ADDR(ADDR_NAME) \
118 dma_addr_t ADDR_NAME;
119 #define DECLARE_PCI_UNMAP_LEN(LEN_NAME) \
120 __u32 LEN_NAME;
121 #define pci_unmap_addr(PTR, ADDR_NAME) \
122 ((PTR)->ADDR_NAME)
123 #define pci_unmap_addr_set(PTR, ADDR_NAME, VAL) \
124 (((PTR)->ADDR_NAME) = (VAL))
125 #define pci_unmap_len(PTR, LEN_NAME) \
126 ((PTR)->LEN_NAME)
127 #define pci_unmap_len_set(PTR, LEN_NAME, VAL) \
128 (((PTR)->LEN_NAME) = (VAL))
130 /* Map a set of buffers described by scatterlist in streaming mode for
131 PCI DMA. This is the scatter-gather version of the above
132 pci_map_single interface. Here the scatter gather list elements
133 are each tagged with the appropriate PCI dma address and length.
134 They are obtained via sg_dma_{address,length}(SG).
136 NOTE: An implementation may be able to use a smaller number of DMA
137 address/length pairs than there are SG table elements. (for
138 example via virtual mapping capabilities) The routine returns the
139 number of addr/length pairs actually used, at most nents.
141 Device ownership issues as mentioned above for pci_map_single are
142 the same here. */
144 extern int pci_map_sg(struct pci_dev *, struct scatterlist *, int, int);
146 /* Unmap a set of streaming mode DMA translations. Again, cpu read
147 rules concerning calls here are the same as for pci_unmap_single()
148 above. */
150 extern void pci_unmap_sg(struct pci_dev *, struct scatterlist *, int, int);
152 /* Make physical memory consistent for a single streaming mode DMA
153 translation after a transfer and device currently has ownership
154 of the buffer.
156 If you perform a pci_map_single() but wish to interrogate the
157 buffer using the cpu, yet do not wish to teardown the PCI dma
158 mapping, you must call this function before doing so. At the next
159 point you give the PCI dma address back to the card, you must first
160 perform a pci_dma_sync_for_device, and then the device again owns
161 the buffer. */
163 static inline void
164 pci_dma_sync_single_for_cpu(struct pci_dev *dev, dma_addr_t dma_addr,
165 long size, int direction)
167 /* Nothing to do. */
170 static inline void
171 pci_dma_sync_single_for_device(struct pci_dev *dev, dma_addr_t dma_addr,
172 size_t size, int direction)
174 /* Nothing to do. */
177 /* Make physical memory consistent for a set of streaming mode DMA
178 translations after a transfer. The same as pci_dma_sync_single_*
179 but for a scatter-gather list, same rules and usage. */
181 static inline void
182 pci_dma_sync_sg_for_cpu(struct pci_dev *dev, struct scatterlist *sg,
183 int nents, int direction)
185 /* Nothing to do. */
188 static inline void
189 pci_dma_sync_sg_for_device(struct pci_dev *dev, struct scatterlist *sg,
190 int nents, int direction)
192 /* Nothing to do. */
195 /* Return whether the given PCI device DMA address mask can
196 be supported properly. For example, if your device can
197 only drive the low 24-bits during PCI bus mastering, then
198 you would pass 0x00ffffff as the mask to this function. */
200 extern int pci_dma_supported(struct pci_dev *hwdev, u64 mask);
202 /* True if the machine supports DAC addressing, and DEV can
203 make use of it given MASK. */
204 extern int pci_dac_dma_supported(struct pci_dev *hwdev, u64 mask);
206 /* Convert to/from DAC dma address and struct page. */
207 extern dma64_addr_t pci_dac_page_to_dma(struct pci_dev *, struct page *,
208 unsigned long, int);
209 extern struct page *pci_dac_dma_to_page(struct pci_dev *, dma64_addr_t);
210 extern unsigned long pci_dac_dma_to_offset(struct pci_dev *, dma64_addr_t);
212 static inline void
213 pci_dac_dma_sync_single_for_cpu(struct pci_dev *pdev, dma64_addr_t dma_addr,
214 size_t len, int direction)
216 /* Nothing to do. */
219 static inline void
220 pci_dac_dma_sync_single_for_device(struct pci_dev *pdev, dma64_addr_t dma_addr,
221 size_t len, int direction)
223 /* Nothing to do. */
226 #ifdef CONFIG_PCI
227 static inline void pci_dma_burst_advice(struct pci_dev *pdev,
228 enum pci_dma_burst_strategy *strat,
229 unsigned long *strategy_parameter)
231 unsigned long cacheline_size;
232 u8 byte;
234 pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &byte);
235 if (byte == 0)
236 cacheline_size = 1024;
237 else
238 cacheline_size = (int) byte * 4;
240 *strat = PCI_DMA_BURST_BOUNDARY;
241 *strategy_parameter = cacheline_size;
243 #endif
245 /* TODO: integrate with include/asm-generic/pci.h ? */
246 static inline int pci_get_legacy_ide_irq(struct pci_dev *dev, int channel)
248 return channel ? 15 : 14;
251 extern void pcibios_resource_to_bus(struct pci_dev *, struct pci_bus_region *,
252 struct resource *);
254 extern void pcibios_bus_to_resource(struct pci_dev *dev, struct resource *res,
255 struct pci_bus_region *region);
257 static inline struct resource *
258 pcibios_select_root(struct pci_dev *pdev, struct resource *res)
260 struct resource *root = NULL;
262 if (res->flags & IORESOURCE_IO)
263 root = &ioport_resource;
264 if (res->flags & IORESOURCE_MEM)
265 root = &iomem_resource;
267 return root;
270 #define pci_domain_nr(bus) ((struct pci_controller *)(bus)->sysdata)->index
272 static inline int pci_proc_domain(struct pci_bus *bus)
274 struct pci_controller *hose = bus->sysdata;
275 return hose->need_domain_info;
278 static inline void
279 pcibios_add_platform_entries(struct pci_dev *dev)
283 struct pci_dev *alpha_gendev_to_pci(struct device *dev);
285 #endif /* __KERNEL__ */
287 /* Values for the `which' argument to sys_pciconfig_iobase. */
288 #define IOBASE_HOSE 0
289 #define IOBASE_SPARSE_MEM 1
290 #define IOBASE_DENSE_MEM 2
291 #define IOBASE_SPARSE_IO 3
292 #define IOBASE_DENSE_IO 4
293 #define IOBASE_ROOT_BUS 5
294 #define IOBASE_FROM_HOSE 0x10000
296 #endif /* __ALPHA_PCI_H */