[apple/xnu.git] / pexpert / pexpert / i386 / boot.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
#ifndef _PEXPERT_I386_BOOT_H
#define _PEXPERT_I386_BOOT_H

/*
 * What the booter leaves behind for the kernel.
 */

/*
 * Maximum number of boot drivers that can be loaded.
 */
#define NDRIVERS  500

/*
 * Types of boot driver that may be loaded by the booter.
 */
enum {
    kBootDriverTypeInvalid = 0,
    kBootDriverTypeKEXT    = 1,
    kBootDriverTypeMKEXT   = 2
};

typedef struct {
    unsigned long address;  // address where driver was loaded
    unsigned long size;     // number of bytes
    unsigned long type;     // driver type
} driver_config_t;

/*
 * APM BIOS information.
 */
typedef struct {
    unsigned short major_vers;    // == 0 if not present
    unsigned short minor_vers;
    unsigned long  cs32_base;
    unsigned long  cs16_base;
    unsigned long  ds_base;
    unsigned long  cs_length;
    unsigned long  ds_length;
    unsigned long  entry_offset;
    union {
        struct {
            unsigned long mode_16        :1;
            unsigned long mode_32        :1;
            unsigned long idle_slows_cpu :1;
            unsigned long reserved       :29;
        } f;
        unsigned long data;
    } flags;
    unsigned long connected;
} APM_config_t;

/*
 * PCI bus information.
 */
typedef struct _PCI_bus_info_t {
    union {
        struct {
            unsigned char configMethod1 :1;
            unsigned char configMethod2 :1;
            unsigned char               :2;
            unsigned char specialCycle1 :1;
            unsigned char specialCycle2 :1;
        } s;
        unsigned char d;
    } u_bus;
    unsigned char maxBusNum;
    unsigned char majorVersion;
    unsigned char minorVersion;
    unsigned char BIOSPresent;
} PCI_bus_info_t;

/*
 * Video information.
 */
struct boot_video {
    unsigned long v_baseAddr;	// Base address of video memory
    unsigned long v_display;    // Display Code (if Applicable
    unsigned long v_rowBytes;   // Number of bytes per pixel row
    unsigned long v_width;      // Width
    unsigned long v_height;     // Height
    unsigned long v_depth;      // Pixel Depth
};

typedef struct boot_video  boot_video;

#define GRAPHICS_MODE     1
#define TEXT_MODE         0

#define BOOT_STRING_LEN   160
#define CONFIG_SIZE       (12 * 4096)

typedef struct {
    short            version;
    char             bootString[BOOT_STRING_LEN];  // boot arguments
    int              magicCookie;                  // KERNBOOTMAGIC
    int              numIDEs;                      // number of IDE drives
    int              rootdev;                      // root device
    int              convmem;                      // conventional memory
    int              extmem;                       // extended memory
    char             bootFile[128];                // kernel file name
    int              firstAddr0;                   // first address for kern convmem
    int              diskInfo[4];                  // info for bios dev 80-83
    int              graphicsMode;                 // booted in graphics mode?
    int              kernDev;                      // device kernel was fetched from
    int              numBootDrivers;               // number of drivers loaded
    char *           configEnd;                    // pointer to end of config files
    int              kaddr;                        // kernel load address
    int              ksize;                        // size of kernel
    driver_config_t  driverConfig[NDRIVERS];
    char             _reserved[2052];
    boot_video       video;
    PCI_bus_info_t   pciInfo;
    APM_config_t     apmConfig;
    char             config[CONFIG_SIZE];
} KERNBOOTSTRUCT;

#define KERNSTRUCT_ADDR   ((KERNBOOTSTRUCT *) 0x11000)
#define KERNBOOTMAGIC     0xa7a7a7a7

#ifndef KERNEL
extern KERNBOOTSTRUCT *   kernBootStruct;
#endif

#define BOOT_LINE_LENGTH        256

/*
 * Video information.. 
 */

struct Boot_Video {
	unsigned long	v_baseAddr;	/* Base address of video memory */
	unsigned long	v_display;	/* Display Code (if Applicable */
	unsigned long	v_rowBytes;	/* Number of bytes per pixel row */
	unsigned long	v_width;	/* Width */
	unsigned long	v_height;	/* Height */
	unsigned long	v_depth;	/* Pixel Depth */
};

typedef struct Boot_Video	Boot_Video;

/* DRAM Bank definitions - describes physical memory layout.
 */
#define	kMaxDRAMBanks	26		/* maximum number of DRAM banks */

struct DRAMBank
{
	unsigned long	base;		/* physical base of DRAM bank */
	unsigned long	size;		/* size of bank */
};
typedef struct DRAMBank DRAMBank;


/* Boot argument structure - passed into Mach kernel at boot time.
 */
#define kBootArgsVersion		1
#define kBootArgsRevision		1

typedef struct boot_args {
  unsigned short	Revision;	/* Revision of boot_args structure */
  unsigned short	Version;	/* Version of boot_args structure */
  char		CommandLine[BOOT_LINE_LENGTH];	/* Passed in command line */
  DRAMBank	PhysicalDRAM[kMaxDRAMBanks];	/* base and range pairs for the 26 DRAM banks */
  Boot_Video	Video;		/* Video Information */
    unsigned long	machineType;	/* Machine Type (gestalt) */
    void		*deviceTreeP;	/* Base of flattened device tree */
    unsigned long	deviceTreeLength;/* Length of flattened tree */
    unsigned long	topOfKernelData;/* Highest address used in kernel data area */
} boot_args;

extern boot_args passed_args;

#endif /* _PEXPERT_I386_BOOT_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
de355530 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
de355530 A	12	* This Original Code and all software distributed under the License are
de355530 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
de355530 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	#ifndef _PEXPERT_I386_BOOT_H
	23	#define _PEXPERT_I386_BOOT_H
	24
	25	/*
	26	* What the booter leaves behind for the kernel.
	27	*/
	28
0b4e3aa0 A	29	/*
0b4e3aa0 A	30	* Maximum number of boot drivers that can be loaded.
1c79356b	31	*/
0b4e3aa0	32	#define NDRIVERS 500
1c79356b	33
0b4e3aa0 A	34	/*
0b4e3aa0 A	35	* Types of boot driver that may be loaded by the booter.
1c79356b	36	*/
0b4e3aa0 A	37	enum {
	38	kBootDriverTypeInvalid = 0,
	39	kBootDriverTypeKEXT = 1,
	40	kBootDriverTypeMKEXT = 2
	41	};
1c79356b A	42
1c79356b A	43	typedef struct {
0b4e3aa0 A	44	unsigned long address; // address where driver was loaded
	45	unsigned long size; // number of bytes
	46	unsigned long type; // driver type
1c79356b A	47	} driver_config_t;
1c79356b A	48
0b4e3aa0 A	49	/*
	50	* APM BIOS information.
	51	*/
1c79356b	52	typedef struct {
0b4e3aa0 A	53	unsigned short major_vers; // == 0 if not present
	54	unsigned short minor_vers;
	55	unsigned long cs32_base;
	56	unsigned long cs16_base;
	57	unsigned long ds_base;
	58	unsigned long cs_length;
	59	unsigned long ds_length;
	60	unsigned long entry_offset;
1c79356b	61	union {
0b4e3aa0 A	62	struct {
	63	unsigned long mode_16 :1;
	64	unsigned long mode_32 :1;
	65	unsigned long idle_slows_cpu :1;
	66	unsigned long reserved :29;
	67	} f;
	68	unsigned long data;
1c79356b	69	} flags;
0b4e3aa0	70	unsigned long connected;
1c79356b A	71	} APM_config_t;
1c79356b A	72
0b4e3aa0 A	73	/*
	74	* PCI bus information.
	75	*/
1c79356b A	76	typedef struct _PCI_bus_info_t {
1c79356b A	77	union {
0b4e3aa0 A	78	struct {
	79	unsigned char configMethod1 :1;
	80	unsigned char configMethod2 :1;
	81	unsigned char :2;
	82	unsigned char specialCycle1 :1;
	83	unsigned char specialCycle2 :1;
	84	} s;
	85	unsigned char d;
1c79356b A	86	} u_bus;
	87	unsigned char maxBusNum;
	88	unsigned char majorVersion;
	89	unsigned char minorVersion;
	90	unsigned char BIOSPresent;
	91	} PCI_bus_info_t;
	92
	93	/*
0b4e3aa0	94	* Video information.
1c79356b	95	*/
1c79356b	96	struct boot_video {
0b4e3aa0 A	97	unsigned long v_baseAddr; // Base address of video memory
	98	unsigned long v_display; // Display Code (if Applicable
	99	unsigned long v_rowBytes; // Number of bytes per pixel row
	100	unsigned long v_width; // Width
	101	unsigned long v_height; // Height
	102	unsigned long v_depth; // Pixel Depth
1c79356b A	103	};
1c79356b A	104
0b4e3aa0 A	105	typedef struct boot_video boot_video;
	106
	107	#define GRAPHICS_MODE 1
	108	#define TEXT_MODE 0
1c79356b	109
0b4e3aa0 A	110	#define BOOT_STRING_LEN 160
0b4e3aa0 A	111	#define CONFIG_SIZE (12 * 4096)
1c79356b A	112
1c79356b A	113	typedef struct {
0b4e3aa0 A	114	short version;
	115	char bootString[BOOT_STRING_LEN]; // boot arguments
	116	int magicCookie; // KERNBOOTMAGIC
	117	int numIDEs; // number of IDE drives
	118	int rootdev; // root device
	119	int convmem; // conventional memory
	120	int extmem; // extended memory
	121	char bootFile[128]; // kernel file name
	122	int firstAddr0; // first address for kern convmem
	123	int diskInfo[4]; // info for bios dev 80-83
	124	int graphicsMode; // booted in graphics mode?
	125	int kernDev; // device kernel was fetched from
	126	int numBootDrivers; // number of drivers loaded
	127	char * configEnd; // pointer to end of config files
	128	int kaddr; // kernel load address
	129	int ksize; // size of kernel
	130	driver_config_t driverConfig[NDRIVERS];
	131	char _reserved[2052];
	132	boot_video video;
	133	PCI_bus_info_t pciInfo;
	134	APM_config_t apmConfig;
	135	char config[CONFIG_SIZE];
1c79356b A	136	} KERNBOOTSTRUCT;
1c79356b A	137
0b4e3aa0 A	138	#define KERNSTRUCT_ADDR ((KERNBOOTSTRUCT *) 0x11000)
0b4e3aa0 A	139	#define KERNBOOTMAGIC 0xa7a7a7a7
1c79356b A	140
1c79356b A	141	#ifndef KERNEL
0b4e3aa0	142	extern KERNBOOTSTRUCT * kernBootStruct;
1c79356b A	143	#endif
	144
	145	#define BOOT_LINE_LENGTH 256
	146
	147	/*
	148	* Video information..
	149	*/
	150
	151	struct Boot_Video {
	152	unsigned long v_baseAddr; /* Base address of video memory */
	153	unsigned long v_display; /* Display Code (if Applicable */
	154	unsigned long v_rowBytes; /* Number of bytes per pixel row */
	155	unsigned long v_width; /* Width */
	156	unsigned long v_height; /* Height */
	157	unsigned long v_depth; /* Pixel Depth */
	158	};
	159
	160	typedef struct Boot_Video Boot_Video;
	161
	162	/* DRAM Bank definitions - describes physical memory layout.
	163	*/
	164	#define kMaxDRAMBanks 26 /* maximum number of DRAM banks */
	165
	166	struct DRAMBank
	167	{
	168	unsigned long base; /* physical base of DRAM bank */
	169	unsigned long size; /* size of bank */
	170	};
	171	typedef struct DRAMBank DRAMBank;
	172
	173
	174	/* Boot argument structure - passed into Mach kernel at boot time.
	175	*/
	176	#define kBootArgsVersion 1
	177	#define kBootArgsRevision 1
	178
	179	typedef struct boot_args {
	180	unsigned short Revision; /* Revision of boot_args structure */
	181	unsigned short Version; /* Version of boot_args structure */
	182	char CommandLine[BOOT_LINE_LENGTH]; /* Passed in command line */
	183	DRAMBank PhysicalDRAM[kMaxDRAMBanks]; /* base and range pairs for the 26 DRAM banks */
	184	Boot_Video Video; /* Video Information */
	185	unsigned long machineType; /* Machine Type (gestalt) */
	186	void deviceTreeP; / Base of flattened device tree */
	187	unsigned long deviceTreeLength;/* Length of flattened tree */
	188	unsigned long topOfKernelData;/* Highest address used in kernel data area */
	189	} boot_args;
	190
	191	extern boot_args passed_args;
	192
	193	#endif /* _PEXPERT_I386_BOOT_H */
	194