Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
1da177e4 LT |
2 | /* |
3 | nubus.h: various definitions and prototypes for NuBus drivers to use. | |
4 | ||
5 | Originally written by Alan Cox. | |
6 | ||
7 | Hacked to death by C. Scott Ananian and David Huggins-Daines. | |
1ff2775a FT |
8 | */ |
9 | ||
1da177e4 LT |
10 | #ifndef LINUX_NUBUS_H |
11 | #define LINUX_NUBUS_H | |
12 | ||
7f86c765 | 13 | #include <linux/device.h> |
1da177e4 | 14 | #include <asm/nubus.h> |
607ca46e | 15 | #include <uapi/linux/nubus.h> |
1da177e4 | 16 | |
2f7dd07e FT |
17 | struct proc_dir_entry; |
18 | struct seq_file; | |
19 | ||
1ff2775a FT |
20 | struct nubus_dir { |
21 | unsigned char *base; | |
22 | unsigned char *ptr; | |
23 | int done; | |
24 | int mask; | |
2f7dd07e | 25 | struct proc_dir_entry *procdir; |
1ff2775a FT |
26 | }; |
27 | ||
28 | struct nubus_dirent { | |
29 | unsigned char *base; | |
30 | unsigned char type; | |
31 | __u32 data; /* Actually 24 bits used */ | |
32 | int mask; | |
33 | }; | |
34 | ||
1da177e4 | 35 | struct nubus_board { |
7f86c765 | 36 | struct device dev; |
4bccc4b6 | 37 | |
f8779588 | 38 | /* Only 9-E actually exist, though 0-8 are also theoretically |
1da177e4 LT |
39 | possible, and 0 is a special case which represents the |
40 | motherboard and onboard peripherals (Ethernet, video) */ | |
41 | int slot; | |
42 | /* For slot 0, this is bogus. */ | |
43 | char name[64]; | |
44 | ||
45 | /* Format block */ | |
4bccc4b6 | 46 | unsigned char *fblock; |
1da177e4 | 47 | /* Root directory (does *not* always equal fblock + doffset!) */ |
4bccc4b6 FT |
48 | unsigned char *directory; |
49 | ||
1da177e4 LT |
50 | unsigned long slot_addr; |
51 | /* Offset to root directory (sometimes) */ | |
52 | unsigned long doffset; | |
53 | /* Length over which to compute the crc */ | |
54 | unsigned long rom_length; | |
55 | /* Completely useless most of the time */ | |
56 | unsigned long crc; | |
57 | unsigned char rev; | |
58 | unsigned char format; | |
59 | unsigned char lanes; | |
6c8b89ea FT |
60 | |
61 | /* Directory entry in /proc/bus/nubus */ | |
62 | struct proc_dir_entry *procdir; | |
1da177e4 LT |
63 | }; |
64 | ||
189e19e8 | 65 | struct nubus_rsrc { |
41b84816 | 66 | struct list_head list; |
1da177e4 | 67 | |
189e19e8 | 68 | /* The functional resource ID */ |
1da177e4 LT |
69 | unsigned char resid; |
70 | /* These are mostly here for convenience; we could always read | |
71 | them from the ROMs if we wanted to */ | |
72 | unsigned short category; | |
73 | unsigned short type; | |
74 | unsigned short dr_sw; | |
75 | unsigned short dr_hw; | |
4bccc4b6 | 76 | |
1da177e4 | 77 | /* Functional directory */ |
4bccc4b6 | 78 | unsigned char *directory; |
1da177e4 | 79 | /* Much of our info comes from here */ |
4bccc4b6 | 80 | struct nubus_board *board; |
1da177e4 LT |
81 | }; |
82 | ||
189e19e8 | 83 | /* This is all NuBus functional resources (used to find devices later on) */ |
41b84816 | 84 | extern struct list_head nubus_func_rsrcs; |
7f86c765 FT |
85 | |
86 | struct nubus_driver { | |
87 | struct device_driver driver; | |
88 | int (*probe)(struct nubus_board *board); | |
89 | int (*remove)(struct nubus_board *board); | |
90 | }; | |
91 | ||
92 | extern struct bus_type nubus_bus_type; | |
1da177e4 LT |
93 | |
94 | /* Generic NuBus interface functions, modelled after the PCI interface */ | |
11db656a | 95 | #ifdef CONFIG_PROC_FS |
2f7dd07e FT |
96 | void nubus_proc_init(void); |
97 | struct proc_dir_entry *nubus_proc_add_board(struct nubus_board *board); | |
98 | struct proc_dir_entry *nubus_proc_add_rsrc_dir(struct proc_dir_entry *procdir, | |
99 | const struct nubus_dirent *ent, | |
100 | struct nubus_board *board); | |
101 | void nubus_proc_add_rsrc_mem(struct proc_dir_entry *procdir, | |
102 | const struct nubus_dirent *ent, | |
103 | unsigned int size); | |
104 | void nubus_proc_add_rsrc(struct proc_dir_entry *procdir, | |
105 | const struct nubus_dirent *ent); | |
11db656a DH |
106 | #else |
107 | static inline void nubus_proc_init(void) {} | |
2f7dd07e FT |
108 | static inline |
109 | struct proc_dir_entry *nubus_proc_add_board(struct nubus_board *board) | |
110 | { return NULL; } | |
111 | static inline | |
112 | struct proc_dir_entry *nubus_proc_add_rsrc_dir(struct proc_dir_entry *procdir, | |
113 | const struct nubus_dirent *ent, | |
114 | struct nubus_board *board) | |
115 | { return NULL; } | |
116 | static inline void nubus_proc_add_rsrc_mem(struct proc_dir_entry *procdir, | |
117 | const struct nubus_dirent *ent, | |
118 | unsigned int size) {} | |
119 | static inline void nubus_proc_add_rsrc(struct proc_dir_entry *procdir, | |
120 | const struct nubus_dirent *ent) {} | |
11db656a | 121 | #endif |
9f97977d | 122 | |
41b84816 FT |
123 | struct nubus_rsrc *nubus_first_rsrc_or_null(void); |
124 | struct nubus_rsrc *nubus_next_rsrc_or_null(struct nubus_rsrc *from); | |
189e19e8 | 125 | |
41b84816 FT |
126 | #define for_each_func_rsrc(f) \ |
127 | for (f = nubus_first_rsrc_or_null(); f; f = nubus_next_rsrc_or_null(f)) | |
1da177e4 | 128 | |
7f86c765 FT |
129 | #define for_each_board_func_rsrc(b, f) \ |
130 | for_each_func_rsrc(f) if (f->board != b) {} else | |
131 | ||
1da177e4 LT |
132 | /* These are somewhat more NuBus-specific. They all return 0 for |
133 | success and -1 for failure, as you'd expect. */ | |
134 | ||
135 | /* The root directory which contains the board and functional | |
136 | directories */ | |
4bccc4b6 FT |
137 | int nubus_get_root_dir(const struct nubus_board *board, |
138 | struct nubus_dir *dir); | |
1da177e4 | 139 | /* The board directory */ |
4bccc4b6 FT |
140 | int nubus_get_board_dir(const struct nubus_board *board, |
141 | struct nubus_dir *dir); | |
1da177e4 | 142 | /* The functional directory */ |
189e19e8 | 143 | int nubus_get_func_dir(const struct nubus_rsrc *fres, struct nubus_dir *dir); |
1da177e4 LT |
144 | |
145 | /* These work on any directory gotten via the above */ | |
4bccc4b6 FT |
146 | int nubus_readdir(struct nubus_dir *dir, |
147 | struct nubus_dirent *ent); | |
148 | int nubus_find_rsrc(struct nubus_dir *dir, | |
1da177e4 | 149 | unsigned char rsrc_type, |
4bccc4b6 FT |
150 | struct nubus_dirent *ent); |
151 | int nubus_rewinddir(struct nubus_dir *dir); | |
1da177e4 LT |
152 | |
153 | /* Things to do with directory entries */ | |
4bccc4b6 FT |
154 | int nubus_get_subdir(const struct nubus_dirent *ent, |
155 | struct nubus_dir *dir); | |
2f828fb2 FT |
156 | void nubus_get_rsrc_mem(void *dest, const struct nubus_dirent *dirent, |
157 | unsigned int len); | |
2f7dd07e FT |
158 | unsigned int nubus_get_rsrc_str(char *dest, const struct nubus_dirent *dirent, |
159 | unsigned int len); | |
160 | void nubus_seq_write_rsrc_mem(struct seq_file *m, | |
161 | const struct nubus_dirent *dirent, | |
162 | unsigned int len); | |
163 | unsigned char *nubus_dirptr(const struct nubus_dirent *nd); | |
1ff2775a | 164 | |
7f86c765 FT |
165 | /* Declarations relating to driver model objects */ |
166 | int nubus_bus_register(void); | |
167 | int nubus_device_register(struct nubus_board *board); | |
168 | int nubus_driver_register(struct nubus_driver *ndrv); | |
169 | void nubus_driver_unregister(struct nubus_driver *ndrv); | |
170 | int nubus_proc_show(struct seq_file *m, void *data); | |
171 | ||
172 | static inline void nubus_set_drvdata(struct nubus_board *board, void *data) | |
173 | { | |
174 | dev_set_drvdata(&board->dev, data); | |
175 | } | |
176 | ||
177 | static inline void *nubus_get_drvdata(struct nubus_board *board) | |
178 | { | |
179 | return dev_get_drvdata(&board->dev); | |
180 | } | |
181 | ||
1ff2775a FT |
182 | /* Returns a pointer to the "standard" slot space. */ |
183 | static inline void *nubus_slot_addr(int slot) | |
184 | { | |
185 | return (void *)(0xF0000000 | (slot << 24)); | |
186 | } | |
187 | ||
1da177e4 | 188 | #endif /* LINUX_NUBUS_H */ |