2 * Definition of platform feature hooks for PowerMacs
4 * This file is subject to the terms and conditions of the GNU General Public
5 * License. See the file "COPYING" in the main directory of this archive
8 * Copyright (C) 1998 Paul Mackerras &
12 * Note: I removed media-bay details from the feature stuff, I beleive it's
13 * not worth it, the media-bay driver can directly use the mac-io
16 * Implementation note: Currently, none of these functions will block.
17 * However, they may internally protect themselves with a spinlock
18 * for way too long. Be prepared for at least some of these to block
21 * Unless specifically defined, the result code is assumed to be an
22 * error when negative, 0 is the default success result. Some functions
23 * may return additional positive result values.
25 * To keep implementation simple, all feature calls are assumed to have
26 * the prototype parameters (struct device_node* node, int value).
27 * When either is not used, pass 0.
31 #ifndef __PPC_ASM_PMAC_FEATURE_H
32 #define __PPC_ASM_PMAC_FEATURE_H
34 #include <asm/macio.h>
37 * Known Mac motherboard models
39 * Please, report any error here to benh@kernel.crashing.org, thanks !
41 * Note that I don't fully maintain this list for Core99 & MacRISC2
42 * and I'm considering removing all NewWorld entries from it and
43 * entirely rely on the model string.
46 /* PowerSurge are the first generation of PCI Pmacs. This include
47 * all of the Grand-Central based machines. We currently don't
48 * differenciate most of them.
50 #define PMAC_TYPE_PSURGE 0x10 /* PowerSurge */
51 #define PMAC_TYPE_ANS 0x11 /* Apple Network Server */
53 /* Here is the infamous serie of OHare based machines
55 #define PMAC_TYPE_COMET 0x20 /* Beleived to be PowerBook 2400 */
56 #define PMAC_TYPE_HOOPER 0x21 /* Beleived to be PowerBook 3400 */
57 #define PMAC_TYPE_KANGA 0x22 /* PowerBook 3500 (first G3) */
58 #define PMAC_TYPE_ALCHEMY 0x23 /* Alchemy motherboard base */
59 #define PMAC_TYPE_GAZELLE 0x24 /* Spartacus, some 5xxx/6xxx */
60 #define PMAC_TYPE_UNKNOWN_OHARE 0x2f /* Unknown, but OHare based */
62 /* Here are the Heathrow based machines
63 * FIXME: Differenciate wallstreet,mainstreet,wallstreetII
65 #define PMAC_TYPE_GOSSAMER 0x30 /* Gossamer motherboard */
66 #define PMAC_TYPE_SILK 0x31 /* Desktop PowerMac G3 */
67 #define PMAC_TYPE_WALLSTREET 0x32 /* Wallstreet/Mainstreet PowerBook*/
68 #define PMAC_TYPE_UNKNOWN_HEATHROW 0x3f /* Unknown but heathrow based */
70 /* Here are newworld machines based on Paddington (heathrow derivative)
72 #define PMAC_TYPE_101_PBOOK 0x40 /* 101 PowerBook (aka Lombard) */
73 #define PMAC_TYPE_ORIG_IMAC 0x41 /* First generation iMac */
74 #define PMAC_TYPE_YOSEMITE 0x42 /* B&W G3 */
75 #define PMAC_TYPE_YIKES 0x43 /* Yikes G4 (PCI graphics) */
76 #define PMAC_TYPE_UNKNOWN_PADDINGTON 0x4f /* Unknown but paddington based */
78 /* Core99 machines based on UniNorth 1.0 and 1.5
80 * Note: A single entry here may cover several actual models according
81 * to the device-tree. (Sawtooth is most tower G4s, FW_IMAC is most
82 * FireWire based iMacs, etc...). Those machines are too similar to be
83 * distinguished here, when they need to be differencied, use the
84 * device-tree "model" or "compatible" property.
86 #define PMAC_TYPE_ORIG_IBOOK 0x40 /* First iBook model (no firewire) */
87 #define PMAC_TYPE_SAWTOOTH 0x41 /* Desktop G4s */
88 #define PMAC_TYPE_FW_IMAC 0x42 /* FireWire iMacs (except Pangea based) */
89 #define PMAC_TYPE_FW_IBOOK 0x43 /* FireWire iBooks (except iBook2) */
90 #define PMAC_TYPE_CUBE 0x44 /* Cube PowerMac */
91 #define PMAC_TYPE_QUICKSILVER 0x45 /* QuickSilver G4s */
92 #define PMAC_TYPE_PISMO 0x46 /* Pismo PowerBook */
93 #define PMAC_TYPE_TITANIUM 0x47 /* Titanium PowerBook */
94 #define PMAC_TYPE_TITANIUM2 0x48 /* Titanium II PowerBook (no L3, M6) */
95 #define PMAC_TYPE_TITANIUM3 0x49 /* Titanium III PowerBook (with L3 & M7) */
96 #define PMAC_TYPE_TITANIUM4 0x50 /* Titanium IV PowerBook (with L3 & M9) */
97 #define PMAC_TYPE_EMAC 0x50 /* eMac */
98 #define PMAC_TYPE_UNKNOWN_CORE99 0x5f
100 /* MacRisc2 with UniNorth 2.0 */
101 #define PMAC_TYPE_RACKMAC 0x80 /* XServe */
102 #define PMAC_TYPE_WINDTUNNEL 0x81
104 /* MacRISC2 machines based on the Pangea chipset
106 #define PMAC_TYPE_PANGEA_IMAC 0x100 /* Flower Power iMac */
107 #define PMAC_TYPE_IBOOK2 0x101 /* iBook2 (polycarbonate) */
108 #define PMAC_TYPE_FLAT_PANEL_IMAC 0x102 /* Flat panel iMac */
109 #define PMAC_TYPE_UNKNOWN_PANGEA 0x10f
111 /* MacRISC2 machines based on the Intrepid chipset
113 #define PMAC_TYPE_UNKNOWN_INTREPID 0x11f /* Generic */
115 /* MacRISC4 / G5 machines
117 #define PMAC_TYPE_POWERMAC_G5 0x150 /* First tower */
118 #define PMAC_TYPE_UNKNOWN_K2 0x19f /* Any other K2 based */
124 #define PMAC_MB_CAN_SLEEP 0x00000001
125 #define PMAC_MB_HAS_FW_POWER 0x00000002
126 #define PMAC_MB_OLD_CORE99 0x00000004
127 #define PMAC_MB_MOBILE 0x00000008
130 * Feature calls supported on pmac
135 * Use this inline wrapper
139 static inline long pmac_call_feature(int selector, struct device_node* node,
140 long param, long value)
142 if (!ppc_md.feature_call)
144 return ppc_md.feature_call(selector, node, param, value);
147 /* PMAC_FTR_SERIAL_ENABLE (struct device_node* node, int param, int value)
148 * enable/disable an SCC side. Pass the node corresponding to the
149 * channel side as a parameter.
150 * param is the type of port
151 * if param is ored with PMAC_SCC_FLAG_XMON, then the SCC is locked enabled
154 #define PMAC_FTR_SCC_ENABLE PMAC_FTR_DEF(0)
155 #define PMAC_SCC_ASYNC 0
156 #define PMAC_SCC_IRDA 1
157 #define PMAC_SCC_I2S1 2
158 #define PMAC_SCC_FLAG_XMON 0x00001000
160 /* PMAC_FTR_MODEM_ENABLE (struct device_node* node, 0, int value)
161 * enable/disable the internal modem.
163 #define PMAC_FTR_MODEM_ENABLE PMAC_FTR_DEF(1)
165 /* PMAC_FTR_SWIM3_ENABLE (struct device_node* node, 0,int value)
166 * enable/disable the swim3 (floppy) cell of a mac-io ASIC
168 #define PMAC_FTR_SWIM3_ENABLE PMAC_FTR_DEF(2)
170 /* PMAC_FTR_MESH_ENABLE (struct device_node* node, 0, int value)
171 * enable/disable the mesh (scsi) cell of a mac-io ASIC
173 #define PMAC_FTR_MESH_ENABLE PMAC_FTR_DEF(3)
175 /* PMAC_FTR_IDE_ENABLE (struct device_node* node, int busID, int value)
176 * enable/disable an IDE port of a mac-io ASIC
177 * pass the busID parameter
179 #define PMAC_FTR_IDE_ENABLE PMAC_FTR_DEF(4)
181 /* PMAC_FTR_IDE_RESET (struct device_node* node, int busID, int value)
182 * assert(1)/release(0) an IDE reset line (mac-io IDE only)
184 #define PMAC_FTR_IDE_RESET PMAC_FTR_DEF(5)
186 /* PMAC_FTR_BMAC_ENABLE (struct device_node* node, 0, int value)
187 * enable/disable the bmac (ethernet) cell of a mac-io ASIC, also drive
190 #define PMAC_FTR_BMAC_ENABLE PMAC_FTR_DEF(6)
192 /* PMAC_FTR_GMAC_ENABLE (struct device_node* node, 0, int value)
193 * enable/disable the gmac (ethernet) cell of an uninorth ASIC. This
194 * control the cell's clock.
196 #define PMAC_FTR_GMAC_ENABLE PMAC_FTR_DEF(7)
198 /* PMAC_FTR_GMAC_PHY_RESET (struct device_node* node, 0, 0)
199 * Perform a HW reset of the PHY connected to a gmac controller.
200 * Pass the gmac device node, not the PHY node.
202 #define PMAC_FTR_GMAC_PHY_RESET PMAC_FTR_DEF(8)
204 /* PMAC_FTR_SOUND_CHIP_ENABLE (struct device_node* node, 0, int value)
205 * enable/disable the sound chip, whatever it is and provided it can
206 * acually be controlled
208 #define PMAC_FTR_SOUND_CHIP_ENABLE PMAC_FTR_DEF(9)
210 /* -- add various tweaks related to sound routing -- */
212 /* PMAC_FTR_AIRPORT_ENABLE (struct device_node* node, 0, int value)
213 * enable/disable the airport card
215 #define PMAC_FTR_AIRPORT_ENABLE PMAC_FTR_DEF(10)
217 /* PMAC_FTR_RESET_CPU (NULL, int cpu_nr, 0)
218 * toggle the reset line of a CPU on an uninorth-based SMP machine
220 #define PMAC_FTR_RESET_CPU PMAC_FTR_DEF(11)
222 /* PMAC_FTR_USB_ENABLE (struct device_node* node, 0, int value)
223 * enable/disable an USB cell, along with the power of the USB "pad"
224 * on keylargo based machines
226 #define PMAC_FTR_USB_ENABLE PMAC_FTR_DEF(12)
228 /* PMAC_FTR_1394_ENABLE (struct device_node* node, 0, int value)
229 * enable/disable the firewire cell of an uninorth ASIC.
231 #define PMAC_FTR_1394_ENABLE PMAC_FTR_DEF(13)
233 /* PMAC_FTR_1394_CABLE_POWER (struct device_node* node, 0, int value)
234 * enable/disable the firewire cable power supply of the uninorth
237 #define PMAC_FTR_1394_CABLE_POWER PMAC_FTR_DEF(14)
239 /* PMAC_FTR_SLEEP_STATE (struct device_node* node, 0, int value)
240 * set the sleep state of the motherboard.
241 * Pass -1 as value to query for sleep capability
243 #define PMAC_FTR_SLEEP_STATE PMAC_FTR_DEF(15)
245 /* PMAC_FTR_GET_MB_INFO (NULL, selector, 0)
247 * returns some motherboard infos.
248 * selector: 0 - model id
249 * 1 - model flags (capabilities)
250 * 2 - model name (cast to const char *)
252 #define PMAC_FTR_GET_MB_INFO PMAC_FTR_DEF(16)
253 #define PMAC_MB_INFO_MODEL 0
254 #define PMAC_MB_INFO_FLAGS 1
255 #define PMAC_MB_INFO_NAME 2
257 /* PMAC_FTR_READ_GPIO (NULL, int index, 0)
259 * read a GPIO from a mac-io controller of type KeyLargo or Pangea.
260 * the value returned is a byte (positive), or a negative error code
262 #define PMAC_FTR_READ_GPIO PMAC_FTR_DEF(17)
264 /* PMAC_FTR_WRITE_GPIO (NULL, int index, int value)
266 * write a GPIO of a mac-io controller of type KeyLargo or Pangea.
268 #define PMAC_FTR_WRITE_GPIO PMAC_FTR_DEF(18)
270 /* PMAC_FTR_ENABLE_MPIC
272 * Enable the MPIC cell
274 #define PMAC_FTR_ENABLE_MPIC PMAC_FTR_DEF(19)
276 /* PMAC_FTR_AACK_DELAY_ENABLE (NULL, int enable, 0)
278 * Enable/disable the AACK delay on the northbridge for systems using DFS
280 #define PMAC_FTR_AACK_DELAY_ENABLE PMAC_FTR_DEF(20)
283 /* Don't use those directly, they are for the sake of pmac_setup.c */
284 extern long pmac_do_feature_call(unsigned int selector, ...);
285 extern void pmac_feature_init(void);
287 #define PMAC_FTR_DEF(x) ((_MACH_Pmac << 16) | (x))
291 * The part below is for use by macio_asic.c only, do not rely
292 * on the data structures or constants below in a normal driver
296 #define MAX_MACIO_CHIPS 2
314 struct device_node *of_node;
321 /* For use by macio_asic PCI driver */
322 struct macio_bus lbus;
325 extern struct macio_chip macio_chips[MAX_MACIO_CHIPS];
327 #define MACIO_FLAG_SCCA_ON 0x00000001
328 #define MACIO_FLAG_SCCB_ON 0x00000002
329 #define MACIO_FLAG_SCC_LOCKED 0x00000004
330 #define MACIO_FLAG_AIRPORT_ON 0x00000010
331 #define MACIO_FLAG_FW_SUPPORTED 0x00000020
333 extern struct macio_chip* macio_find(struct device_node* child, int type);
335 #define MACIO_FCR32(macio, r) ((macio)->base + ((r) >> 2))
336 #define MACIO_FCR8(macio, r) (((volatile u8*)((macio)->base)) + (r))
338 #define MACIO_IN32(r) (in_le32(MACIO_FCR32(macio,r)))
339 #define MACIO_OUT32(r,v) (out_le32(MACIO_FCR32(macio,r), (v)))
340 #define MACIO_BIS(r,v) (MACIO_OUT32((r), MACIO_IN32(r) | (v)))
341 #define MACIO_BIC(r,v) (MACIO_OUT32((r), MACIO_IN32(r) & ~(v)))
342 #define MACIO_IN8(r) (in_8(MACIO_FCR8(macio,r)))
343 #define MACIO_OUT8(r,v) (out_8(MACIO_FCR8(macio,r), (v)))
345 #endif /* __PPC_ASM_PMAC_FEATURE_H */
346 #endif /* __KERNEL__ */