This commit was manufactured by cvs2svn to create branch 'vserver'.
[linux-2.6.git] / include / asm-powerpc / pmac_feature.h
diff --git a/include/asm-powerpc/pmac_feature.h b/include/asm-powerpc/pmac_feature.h
new file mode 100644 (file)
index 0000000..d3599cc
--- /dev/null
@@ -0,0 +1,397 @@
+/*
+ * Definition of platform feature hooks for PowerMacs
+ *
+ * This file is subject to the terms and conditions of the GNU General Public
+ * License.  See the file "COPYING" in the main directory of this archive
+ * for more details.
+ *
+ * Copyright (C) 1998 Paul Mackerras &
+ *                    Ben. Herrenschmidt.
+ *
+ *
+ * Note: I removed media-bay details from the feature stuff, I believe it's
+ *       not worth it, the media-bay driver can directly use the mac-io
+ *       ASIC registers.
+ *
+ * Implementation note: Currently, none of these functions will block.
+ * However, they may internally protect themselves with a spinlock
+ * for way too long. Be prepared for at least some of these to block
+ * in the future.
+ *
+ * Unless specifically defined, the result code is assumed to be an
+ * error when negative, 0 is the default success result. Some functions
+ * may return additional positive result values.
+ *
+ * To keep implementation simple, all feature calls are assumed to have
+ * the prototype parameters (struct device_node* node, int value).
+ * When either is not used, pass 0.
+ */
+
+#ifdef __KERNEL__
+#ifndef __PPC_ASM_PMAC_FEATURE_H
+#define __PPC_ASM_PMAC_FEATURE_H
+
+#include <asm/macio.h>
+#include <asm/machdep.h>
+
+/*
+ * Known Mac motherboard models
+ *
+ * Please, report any error here to benh@kernel.crashing.org, thanks !
+ *
+ * Note that I don't fully maintain this list for Core99 & MacRISC2
+ * and I'm considering removing all NewWorld entries from it and
+ * entirely rely on the model string.
+ */
+
+/* PowerSurge are the first generation of PCI Pmacs. This include
+ * all of the Grand-Central based machines. We currently don't
+ * differenciate most of them.
+ */
+#define PMAC_TYPE_PSURGE               0x10    /* PowerSurge */
+#define PMAC_TYPE_ANS                  0x11    /* Apple Network Server */
+
+/* Here is the infamous serie of OHare based machines
+ */
+#define PMAC_TYPE_COMET                        0x20    /* Beleived to be PowerBook 2400 */
+#define PMAC_TYPE_HOOPER               0x21    /* Beleived to be PowerBook 3400 */
+#define PMAC_TYPE_KANGA                        0x22    /* PowerBook 3500 (first G3) */
+#define PMAC_TYPE_ALCHEMY              0x23    /* Alchemy motherboard base */
+#define PMAC_TYPE_GAZELLE              0x24    /* Spartacus, some 5xxx/6xxx */
+#define PMAC_TYPE_UNKNOWN_OHARE                0x2f    /* Unknown, but OHare based */
+
+/* Here are the Heathrow based machines
+ * FIXME: Differenciate wallstreet,mainstreet,wallstreetII
+ */
+#define PMAC_TYPE_GOSSAMER             0x30    /* Gossamer motherboard */
+#define PMAC_TYPE_SILK                 0x31    /* Desktop PowerMac G3 */
+#define PMAC_TYPE_WALLSTREET           0x32    /* Wallstreet/Mainstreet PowerBook*/
+#define PMAC_TYPE_UNKNOWN_HEATHROW     0x3f    /* Unknown but heathrow based */
+
+/* Here are newworld machines based on Paddington (heathrow derivative)
+ */
+#define PMAC_TYPE_101_PBOOK            0x40    /* 101 PowerBook (aka Lombard) */
+#define PMAC_TYPE_ORIG_IMAC            0x41    /* First generation iMac */
+#define PMAC_TYPE_YOSEMITE             0x42    /* B&W G3 */
+#define PMAC_TYPE_YIKES                        0x43    /* Yikes G4 (PCI graphics) */
+#define PMAC_TYPE_UNKNOWN_PADDINGTON   0x4f    /* Unknown but paddington based */
+
+/* Core99 machines based on UniNorth 1.0 and 1.5
+ *
+ * Note: A single entry here may cover several actual models according
+ * to the device-tree. (Sawtooth is most tower G4s, FW_IMAC is most
+ * FireWire based iMacs, etc...). Those machines are too similar to be
+ * distinguished here, when they need to be differencied, use the
+ * device-tree "model" or "compatible" property.
+ */
+#define PMAC_TYPE_ORIG_IBOOK           0x40    /* First iBook model (no firewire) */
+#define PMAC_TYPE_SAWTOOTH             0x41    /* Desktop G4s */
+#define PMAC_TYPE_FW_IMAC              0x42    /* FireWire iMacs (except Pangea based) */
+#define PMAC_TYPE_FW_IBOOK             0x43    /* FireWire iBooks (except iBook2) */
+#define PMAC_TYPE_CUBE                 0x44    /* Cube PowerMac */
+#define PMAC_TYPE_QUICKSILVER          0x45    /* QuickSilver G4s */
+#define PMAC_TYPE_PISMO                        0x46    /* Pismo PowerBook */
+#define PMAC_TYPE_TITANIUM             0x47    /* Titanium PowerBook */
+#define PMAC_TYPE_TITANIUM2            0x48    /* Titanium II PowerBook (no L3, M6) */
+#define PMAC_TYPE_TITANIUM3            0x49    /* Titanium III PowerBook (with L3 & M7) */
+#define PMAC_TYPE_TITANIUM4            0x50    /* Titanium IV PowerBook (with L3 & M9) */
+#define PMAC_TYPE_EMAC                 0x50    /* eMac */
+#define PMAC_TYPE_UNKNOWN_CORE99       0x5f
+
+/* MacRisc2 with UniNorth 2.0 */
+#define PMAC_TYPE_RACKMAC              0x80    /* XServe */
+#define PMAC_TYPE_WINDTUNNEL           0x81
+
+/* MacRISC2 machines based on the Pangea chipset
+ */
+#define PMAC_TYPE_PANGEA_IMAC          0x100   /* Flower Power iMac */
+#define PMAC_TYPE_IBOOK2               0x101   /* iBook2 (polycarbonate) */
+#define PMAC_TYPE_FLAT_PANEL_IMAC      0x102   /* Flat panel iMac */
+#define PMAC_TYPE_UNKNOWN_PANGEA       0x10f
+
+/* MacRISC2 machines based on the Intrepid chipset
+ */
+#define PMAC_TYPE_UNKNOWN_INTREPID     0x11f   /* Generic */
+
+/* MacRISC4 / G5 machines. We don't have per-machine selection here anymore,
+ * but rather machine families
+ */
+#define PMAC_TYPE_POWERMAC_G5          0x150   /* U3 & U3H based */
+#define PMAC_TYPE_POWERMAC_G5_U3L      0x151   /* U3L based desktop */
+#define PMAC_TYPE_IMAC_G5              0x152   /* iMac G5 */
+#define PMAC_TYPE_XSERVE_G5            0x153   /* Xserve G5 */
+#define PMAC_TYPE_UNKNOWN_K2           0x19f   /* Any other K2 based */
+#define PMAC_TYPE_UNKNOWN_SHASTA               0x19e   /* Any other Shasta based */
+
+/*
+ * Motherboard flags
+ */
+
+#define PMAC_MB_CAN_SLEEP              0x00000001
+#define PMAC_MB_HAS_FW_POWER           0x00000002
+#define PMAC_MB_OLD_CORE99             0x00000004
+#define PMAC_MB_MOBILE                 0x00000008
+#define PMAC_MB_MAY_SLEEP              0x00000010
+
+/*
+ * Feature calls supported on pmac
+ *
+ */
+
+/*
+ * Use this inline wrapper
+ */
+struct device_node;
+
+static inline long pmac_call_feature(int selector, struct device_node* node,
+                                       long param, long value)
+{
+       if (!ppc_md.feature_call)
+               return -ENODEV;
+       return ppc_md.feature_call(selector, node, param, value);
+}
+
+/* PMAC_FTR_SERIAL_ENABLE      (struct device_node* node, int param, int value)
+ * enable/disable an SCC side. Pass the node corresponding to the
+ * channel side as a parameter.
+ * param is the type of port
+ * if param is ored with PMAC_SCC_FLAG_XMON, then the SCC is locked enabled
+ * for use by xmon.
+ */
+#define PMAC_FTR_SCC_ENABLE            PMAC_FTR_DEF(0)
+       #define PMAC_SCC_ASYNC          0
+       #define PMAC_SCC_IRDA           1
+       #define PMAC_SCC_I2S1           2
+       #define PMAC_SCC_FLAG_XMON      0x00001000
+
+/* PMAC_FTR_MODEM_ENABLE       (struct device_node* node, 0, int value)
+ * enable/disable the internal modem.
+ */
+#define PMAC_FTR_MODEM_ENABLE          PMAC_FTR_DEF(1)
+
+/* PMAC_FTR_SWIM3_ENABLE       (struct device_node* node, 0,int value)
+ * enable/disable the swim3 (floppy) cell of a mac-io ASIC
+ */
+#define PMAC_FTR_SWIM3_ENABLE          PMAC_FTR_DEF(2)
+
+/* PMAC_FTR_MESH_ENABLE                (struct device_node* node, 0, int value)
+ * enable/disable the mesh (scsi) cell of a mac-io ASIC
+ */
+#define PMAC_FTR_MESH_ENABLE           PMAC_FTR_DEF(3)
+
+/* PMAC_FTR_IDE_ENABLE         (struct device_node* node, int busID, int value)
+ * enable/disable an IDE port of a mac-io ASIC
+ * pass the busID parameter
+ */
+#define PMAC_FTR_IDE_ENABLE            PMAC_FTR_DEF(4)
+
+/* PMAC_FTR_IDE_RESET          (struct device_node* node, int busID, int value)
+ * assert(1)/release(0) an IDE reset line (mac-io IDE only)
+ */
+#define PMAC_FTR_IDE_RESET             PMAC_FTR_DEF(5)
+
+/* PMAC_FTR_BMAC_ENABLE                (struct device_node* node, 0, int value)
+ * enable/disable the bmac (ethernet) cell of a mac-io ASIC, also drive
+ * it's reset line
+ */
+#define PMAC_FTR_BMAC_ENABLE           PMAC_FTR_DEF(6)
+
+/* PMAC_FTR_GMAC_ENABLE                (struct device_node* node, 0, int value)
+ * enable/disable the gmac (ethernet) cell of an uninorth ASIC. This
+ * control the cell's clock.
+ */
+#define PMAC_FTR_GMAC_ENABLE           PMAC_FTR_DEF(7)
+
+/* PMAC_FTR_GMAC_PHY_RESET     (struct device_node* node, 0, 0)
+ * Perform a HW reset of the PHY connected to a gmac controller.
+ * Pass the gmac device node, not the PHY node.
+ */
+#define PMAC_FTR_GMAC_PHY_RESET                PMAC_FTR_DEF(8)
+
+/* PMAC_FTR_SOUND_CHIP_ENABLE  (struct device_node* node, 0, int value)
+ * enable/disable the sound chip, whatever it is and provided it can
+ * acually be controlled
+ */
+#define PMAC_FTR_SOUND_CHIP_ENABLE     PMAC_FTR_DEF(9)
+
+/* -- add various tweaks related to sound routing -- */
+
+/* PMAC_FTR_AIRPORT_ENABLE     (struct device_node* node, 0, int value)
+ * enable/disable the airport card
+ */
+#define PMAC_FTR_AIRPORT_ENABLE                PMAC_FTR_DEF(10)
+
+/* PMAC_FTR_RESET_CPU          (NULL, int cpu_nr, 0)
+ * toggle the reset line of a CPU on an uninorth-based SMP machine
+ */
+#define PMAC_FTR_RESET_CPU             PMAC_FTR_DEF(11)
+
+/* PMAC_FTR_USB_ENABLE         (struct device_node* node, 0, int value)
+ * enable/disable an USB cell, along with the power of the USB "pad"
+ * on keylargo based machines
+ */
+#define PMAC_FTR_USB_ENABLE            PMAC_FTR_DEF(12)
+
+/* PMAC_FTR_1394_ENABLE                (struct device_node* node, 0, int value)
+ * enable/disable the firewire cell of an uninorth ASIC.
+ */
+#define PMAC_FTR_1394_ENABLE           PMAC_FTR_DEF(13)
+
+/* PMAC_FTR_1394_CABLE_POWER   (struct device_node* node, 0, int value)
+ * enable/disable the firewire cable power supply of the uninorth
+ * firewire cell
+ */
+#define PMAC_FTR_1394_CABLE_POWER      PMAC_FTR_DEF(14)
+
+/* PMAC_FTR_SLEEP_STATE                (struct device_node* node, 0, int value)
+ * set the sleep state of the motherboard.
+ *
+ * Pass -1 as value to query for sleep capability
+ * Pass 1 to set IOs to sleep
+ * Pass 0 to set IOs to wake
+ */
+#define PMAC_FTR_SLEEP_STATE           PMAC_FTR_DEF(15)
+
+/* PMAC_FTR_GET_MB_INFO                (NULL, selector, 0)
+ *
+ * returns some motherboard infos.
+ * selector: 0  - model id
+ *           1  - model flags (capabilities)
+ *           2  - model name (cast to const char *)
+ */
+#define PMAC_FTR_GET_MB_INFO           PMAC_FTR_DEF(16)
+#define   PMAC_MB_INFO_MODEL   0
+#define   PMAC_MB_INFO_FLAGS   1
+#define   PMAC_MB_INFO_NAME    2
+
+/* PMAC_FTR_READ_GPIO          (NULL, int index, 0)
+ *
+ * read a GPIO from a mac-io controller of type KeyLargo or Pangea.
+ * the value returned is a byte (positive), or a negative error code
+ */
+#define PMAC_FTR_READ_GPIO             PMAC_FTR_DEF(17)
+
+/* PMAC_FTR_WRITE_GPIO         (NULL, int index, int value)
+ *
+ * write a GPIO of a mac-io controller of type KeyLargo or Pangea.
+ */
+#define PMAC_FTR_WRITE_GPIO            PMAC_FTR_DEF(18)
+
+/* PMAC_FTR_ENABLE_MPIC
+ *
+ * Enable the MPIC cell
+ */
+#define PMAC_FTR_ENABLE_MPIC           PMAC_FTR_DEF(19)
+
+/* PMAC_FTR_AACK_DELAY_ENABLE  (NULL, int enable, 0)
+ *
+ * Enable/disable the AACK delay on the northbridge for systems using DFS
+ */
+#define PMAC_FTR_AACK_DELAY_ENABLE             PMAC_FTR_DEF(20)
+
+/* PMAC_FTR_DEVICE_CAN_WAKE
+ *
+ * Used by video drivers to inform system that they can actually perform
+ * wakeup from sleep
+ */
+#define PMAC_FTR_DEVICE_CAN_WAKE       PMAC_FTR_DEF(22)
+
+
+/* Don't use those directly, they are for the sake of pmac_setup.c */
+extern long pmac_do_feature_call(unsigned int selector, ...);
+extern void pmac_feature_init(void);
+
+/* Video suspend tweak */
+extern void pmac_set_early_video_resume(void (*proc)(void *data), void *data);
+extern void pmac_call_early_video_resume(void);
+
+#define PMAC_FTR_DEF(x) ((0x6660000) | (x))
+
+/* The AGP driver registers itself here */
+extern void pmac_register_agp_pm(struct pci_dev *bridge,
+                                int (*suspend)(struct pci_dev *bridge),
+                                int (*resume)(struct pci_dev *bridge));
+
+/* Those are meant to be used by video drivers to deal with AGP
+ * suspend resume properly
+ */
+extern void pmac_suspend_agp_for_card(struct pci_dev *dev);
+extern void pmac_resume_agp_for_card(struct pci_dev *dev);
+
+/*
+ * The part below is for use by macio_asic.c only, do not rely
+ * on the data structures or constants below in a normal driver
+ *
+ */
+
+#define MAX_MACIO_CHIPS                2
+
+enum {
+       macio_unknown = 0,
+       macio_grand_central,
+       macio_ohare,
+       macio_ohareII,
+       macio_heathrow,
+       macio_gatwick,
+       macio_paddington,
+       macio_keylargo,
+       macio_pangea,
+       macio_intrepid,
+       macio_keylargo2,
+       macio_shasta,
+};
+
+struct macio_chip
+{
+       struct device_node      *of_node;
+       int                     type;
+       const char              *name;
+       int                     rev;
+       volatile u32            __iomem *base;
+       unsigned long           flags;
+
+       /* For use by macio_asic PCI driver */
+       struct macio_bus        lbus;
+};
+
+extern struct macio_chip macio_chips[MAX_MACIO_CHIPS];
+
+#define MACIO_FLAG_SCCA_ON     0x00000001
+#define MACIO_FLAG_SCCB_ON     0x00000002
+#define MACIO_FLAG_SCC_LOCKED  0x00000004
+#define MACIO_FLAG_AIRPORT_ON  0x00000010
+#define MACIO_FLAG_FW_SUPPORTED        0x00000020
+
+extern struct macio_chip* macio_find(struct device_node* child, int type);
+
+#define MACIO_FCR32(macio, r)  ((macio)->base + ((r) >> 2))
+#define MACIO_FCR8(macio, r)   (((volatile u8 __iomem *)((macio)->base)) + (r))
+
+#define MACIO_IN32(r)          (in_le32(MACIO_FCR32(macio,r)))
+#define MACIO_OUT32(r,v)       (out_le32(MACIO_FCR32(macio,r), (v)))
+#define MACIO_BIS(r,v)         (MACIO_OUT32((r), MACIO_IN32(r) | (v)))
+#define MACIO_BIC(r,v)         (MACIO_OUT32((r), MACIO_IN32(r) & ~(v)))
+#define MACIO_IN8(r)           (in_8(MACIO_FCR8(macio,r)))
+#define MACIO_OUT8(r,v)                (out_8(MACIO_FCR8(macio,r), (v)))
+
+/*
+ * Those are exported by pmac feature for internal use by arch code
+ * only like the platform function callbacks, do not use directly in drivers
+ */
+extern spinlock_t feature_lock;
+extern struct device_node *uninorth_node;
+extern u32 __iomem *uninorth_base;
+
+/*
+ * Uninorth reg. access. Note that Uni-N regs are big endian
+ */
+
+#define UN_REG(r)      (uninorth_base + ((r) >> 2))
+#define UN_IN(r)       (in_be32(UN_REG(r)))
+#define UN_OUT(r,v)    (out_be32(UN_REG(r), (v)))
+#define UN_BIS(r,v)    (UN_OUT((r), UN_IN(r) | (v)))
+#define UN_BIC(r,v)    (UN_OUT((r), UN_IN(r) & ~(v)))
+
+
+#endif /* __PPC_ASM_PMAC_FEATURE_H */
+#endif /* __KERNEL__ */