blob: 2b7b39294a6a90700b6d443ccdf66c6f92c9466c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __MACIO_ASIC_H__
2#define __MACIO_ASIC_H__
Arnd Bergmann88ced032005-12-16 22:43:46 +01003#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
Stephen Rothwell4b1d99b2008-04-14 12:08:47 +10005#include <linux/of_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7extern struct bus_type macio_bus_type;
8
9/* MacIO device driver is defined later */
10struct macio_driver;
11struct macio_chip;
12
13#define MACIO_DEV_COUNT_RESOURCES 8
14#define MACIO_DEV_COUNT_IRQS 8
15
16/*
17 * the macio_bus structure is used to describe a "virtual" bus
18 * within a MacIO ASIC. It's typically provided by a macio_pci_asic
19 * PCI device, but could be provided differently as well (nubus
20 * machines using a fake OF tree).
21 *
22 * The pdev field can be NULL on non-PCI machines
23 */
24struct macio_bus
25{
26 struct macio_chip *chip; /* macio_chip (private use) */
27 int index; /* macio chip index in system */
28#ifdef CONFIG_PCI
29 struct pci_dev *pdev; /* PCI device hosting this bus */
30#endif
31};
32
33/*
34 * the macio_dev structure is used to describe a device
35 * within an Apple MacIO ASIC.
36 */
37struct macio_dev
38{
39 struct macio_bus *bus; /* macio bus this device is on */
40 struct macio_dev *media_bay; /* Device is part of a media bay */
41 struct of_device ofdev;
42 int n_resources;
43 struct resource resource[MACIO_DEV_COUNT_RESOURCES];
44 int n_interrupts;
45 struct resource interrupt[MACIO_DEV_COUNT_IRQS];
46};
47#define to_macio_device(d) container_of(d, struct macio_dev, ofdev.dev)
48#define of_to_macio_device(d) container_of(d, struct macio_dev, ofdev)
49
50extern struct macio_dev *macio_dev_get(struct macio_dev *dev);
51extern void macio_dev_put(struct macio_dev *dev);
52
53/*
54 * Accessors to resources & interrupts and other device
55 * fields
56 */
57
58static inline int macio_resource_count(struct macio_dev *dev)
59{
60 return dev->n_resources;
61}
62
63static inline unsigned long macio_resource_start(struct macio_dev *dev, int resource_no)
64{
65 return dev->resource[resource_no].start;
66}
67
68static inline unsigned long macio_resource_end(struct macio_dev *dev, int resource_no)
69{
70 return dev->resource[resource_no].end;
71}
72
73static inline unsigned long macio_resource_len(struct macio_dev *dev, int resource_no)
74{
75 struct resource *res = &dev->resource[resource_no];
76 if (res->start == 0 || res->end == 0 || res->end < res->start)
77 return 0;
78 return res->end - res->start + 1;
79}
80
Benjamin Herrenschmidt7fb19ea2009-12-01 14:36:26 +000081extern int macio_enable_devres(struct macio_dev *dev);
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083extern int macio_request_resource(struct macio_dev *dev, int resource_no, const char *name);
84extern void macio_release_resource(struct macio_dev *dev, int resource_no);
85extern int macio_request_resources(struct macio_dev *dev, const char *name);
86extern void macio_release_resources(struct macio_dev *dev);
87
88static inline int macio_irq_count(struct macio_dev *dev)
89{
90 return dev->n_interrupts;
91}
92
93static inline int macio_irq(struct macio_dev *dev, int irq_no)
94{
95 return dev->interrupt[irq_no].start;
96}
97
98static inline void macio_set_drvdata(struct macio_dev *dev, void *data)
99{
100 dev_set_drvdata(&dev->ofdev.dev, data);
101}
102
103static inline void* macio_get_drvdata(struct macio_dev *dev)
104{
105 return dev_get_drvdata(&dev->ofdev.dev);
106}
107
108static inline struct device_node *macio_get_of_node(struct macio_dev *mdev)
109{
110 return mdev->ofdev.node;
111}
112
113#ifdef CONFIG_PCI
114static inline struct pci_dev *macio_get_pci_dev(struct macio_dev *mdev)
115{
116 return mdev->bus->pdev;
117}
118#endif
119
120/*
121 * A driver for a mac-io chip based device
122 */
123struct macio_driver
124{
125 char *name;
Jeff Mahoney5e655772005-07-06 15:44:41 -0400126 struct of_device_id *match_table;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 struct module *owner;
128
Jeff Mahoney5e655772005-07-06 15:44:41 -0400129 int (*probe)(struct macio_dev* dev, const struct of_device_id *match);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 int (*remove)(struct macio_dev* dev);
131
Pavel Machekb1c42852005-04-16 15:25:34 -0700132 int (*suspend)(struct macio_dev* dev, pm_message_t state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 int (*resume)(struct macio_dev* dev);
134 int (*shutdown)(struct macio_dev* dev);
135
136 struct device_driver driver;
137};
138#define to_macio_driver(drv) container_of(drv,struct macio_driver, driver)
139
140extern int macio_register_driver(struct macio_driver *);
141extern void macio_unregister_driver(struct macio_driver *);
142
Arnd Bergmann88ced032005-12-16 22:43:46 +0100143#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144#endif /* __MACIO_ASIC_H__ */