blob: 27af7f8bbb8da6245f7c5d0f971c7c07ba9d1fea [file] [log] [blame]
Kyle Swenson8d8f6542021-03-15 11:02:55 -06001#ifndef __MACIO_ASIC_H__
2#define __MACIO_ASIC_H__
3#ifdef __KERNEL__
4
5#include <linux/of_device.h>
6
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 platform_device ofdev;
42 struct device_dma_parameters dma_parms; /* ide needs that */
43 int n_resources;
44 struct resource resource[MACIO_DEV_COUNT_RESOURCES];
45 int n_interrupts;
46 struct resource interrupt[MACIO_DEV_COUNT_IRQS];
47};
48#define to_macio_device(d) container_of(d, struct macio_dev, ofdev.dev)
49#define of_to_macio_device(d) container_of(d, struct macio_dev, ofdev)
50
51extern struct macio_dev *macio_dev_get(struct macio_dev *dev);
52extern void macio_dev_put(struct macio_dev *dev);
53
54/*
55 * Accessors to resources & interrupts and other device
56 * fields
57 */
58
59static inline int macio_resource_count(struct macio_dev *dev)
60{
61 return dev->n_resources;
62}
63
64static inline unsigned long macio_resource_start(struct macio_dev *dev, int resource_no)
65{
66 return dev->resource[resource_no].start;
67}
68
69static inline unsigned long macio_resource_end(struct macio_dev *dev, int resource_no)
70{
71 return dev->resource[resource_no].end;
72}
73
74static inline unsigned long macio_resource_len(struct macio_dev *dev, int resource_no)
75{
76 struct resource *res = &dev->resource[resource_no];
77 if (res->start == 0 || res->end == 0 || res->end < res->start)
78 return 0;
79 return resource_size(res);
80}
81
82extern int macio_enable_devres(struct macio_dev *dev);
83
84extern int macio_request_resource(struct macio_dev *dev, int resource_no, const char *name);
85extern void macio_release_resource(struct macio_dev *dev, int resource_no);
86extern int macio_request_resources(struct macio_dev *dev, const char *name);
87extern void macio_release_resources(struct macio_dev *dev);
88
89static inline int macio_irq_count(struct macio_dev *dev)
90{
91 return dev->n_interrupts;
92}
93
94static inline int macio_irq(struct macio_dev *dev, int irq_no)
95{
96 return dev->interrupt[irq_no].start;
97}
98
99static inline void macio_set_drvdata(struct macio_dev *dev, void *data)
100{
101 dev_set_drvdata(&dev->ofdev.dev, data);
102}
103
104static inline void* macio_get_drvdata(struct macio_dev *dev)
105{
106 return dev_get_drvdata(&dev->ofdev.dev);
107}
108
109static inline struct device_node *macio_get_of_node(struct macio_dev *mdev)
110{
111 return mdev->ofdev.dev.of_node;
112}
113
114#ifdef CONFIG_PCI
115static inline struct pci_dev *macio_get_pci_dev(struct macio_dev *mdev)
116{
117 return mdev->bus->pdev;
118}
119#endif
120
121/*
122 * A driver for a mac-io chip based device
123 */
124struct macio_driver
125{
126 int (*probe)(struct macio_dev* dev, const struct of_device_id *match);
127 int (*remove)(struct macio_dev* dev);
128
129 int (*suspend)(struct macio_dev* dev, pm_message_t state);
130 int (*resume)(struct macio_dev* dev);
131 int (*shutdown)(struct macio_dev* dev);
132
133#ifdef CONFIG_PMAC_MEDIABAY
134 void (*mediabay_event)(struct macio_dev* dev, int mb_state);
135#endif
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
143#endif /* __KERNEL__ */
144#endif /* __MACIO_ASIC_H__ */