[apple/boot.git] / i386 / libsaio / bootstruct.h

/*
 * Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Portions Copyright (c) 2002-2003 Apple Computer, Inc.  All Rights
 * Reserved.  This file contains Original Code and/or Modifications of
 * Original Code as defined in and that are subject to the Apple Public
 * Source License Version 2.0 (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.
 * 
 * The 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 __BOOTSTRUCT_H
#define __BOOTSTRUCT_H

#include <pexpert/i386/boot.h>

#include "bios.h"
#include "device_tree.h"

extern boot_args *bootArgs;
extern Node *gMemoryMapNode;

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

#define CONFIG_SIZE (12 * 4096)

#define kMemoryMapCountMax 40

/*
 * 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;

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

/*
 * INT15, E820h - Query System Address Map.
 *
 * Documented in ACPI Specification Rev 2.0,
 * Chapter 15 (System Address Map Interfaces).
 */

/*
 * ACPI defined memory range types.
 */
enum {
    kMemoryRangeUsable   = 1,    // RAM usable by the OS.
    kMemoryRangeReserved = 2,    // Reserved. (Do not use)
    kMemoryRangeACPI     = 3,    // ACPI tables. Can be reclaimed.
    kMemoryRangeNVS      = 4,    // ACPI NVS memory. (Do not use)

    /* Undefined types should be treated as kMemoryRangeReserved */
};

typedef struct PrivateBootInfo {
    int              kernDev;                      // device kernel was fetched from

    int              convmem;                      // conventional memory
    int              extmem;                       // extended memory
    int              numBootDrivers;               // number of drivers loaded
    char             bootFile[128];                // kernel file name

    unsigned long    memoryMapCount;
    MemoryRange      memoryMap[kMemoryMapCountMax];

    PCI_bus_info_t   pciInfo;

    driver_config_t  driverConfig[NDRIVERS];
    char *           configEnd;                    // pointer to end of config files
    char             config[CONFIG_SIZE];
} PrivateBootInfo_t;

extern PrivateBootInfo_t *bootInfo;

#endif /* __BOOTSTRUCT_H */
Commit	Line	Data
f083c6c3	1	/*
57c72a9a	2	* Copyright (c) 2002-2003 Apple Computer, Inc. All rights reserved.
f083c6c3 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
57c72a9a	6	* Portions Copyright (c) 2002-2003 Apple Computer, Inc. All Rights
4f6e3300 A	7	* Reserved. This file contains Original Code and/or Modifications of
4f6e3300 A	8	* Original Code as defined in and that are subject to the Apple Public
57c72a9a	9	* Source License Version 2.0 (the "License"). You may not use this file
4f6e3300 A	10	* except in compliance with the License. Please obtain a copy of the
	11	* License at http://www.apple.com/publicsource and read it before using
	12	* this file.
f083c6c3 A	13	*
f083c6c3 A	14	* The Original Code and all software distributed under the License are
4f6e3300	15	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
f083c6c3 A	16	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
f083c6c3 A	17	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
4f6e3300 A	18	* FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT. Please see the
	19	* License for the specific language governing rights and limitations
	20	* under the License.
f083c6c3 A	21	*
	22	* @APPLE_LICENSE_HEADER_END@
	23	*/
	24
bba600dd A	25	#ifndef __BOOTSTRUCT_H
	26	#define __BOOTSTRUCT_H
	27
f083c6c3 A	28	#include <pexpert/i386/boot.h>
f083c6c3 A	29
bba600dd A	30	#include "bios.h"
	31	#include "device_tree.h"
	32
	33	extern boot_args *bootArgs;
	34	extern Node *gMemoryMapNode;
	35
	36	/*
	37	* Maximum number of boot drivers that can be loaded.
	38	*/
	39	#define NDRIVERS 500
	40
	41	#define CONFIG_SIZE (12 * 4096)
	42
	43	#define kMemoryMapCountMax 40
	44
	45	/*
	46	* PCI bus information.
	47	*/
	48	typedef struct _PCI_bus_info_t {
	49	union {
	50	struct {
	51	unsigned char configMethod1 :1;
	52	unsigned char configMethod2 :1;
	53	unsigned char :2;
	54	unsigned char specialCycle1 :1;
	55	unsigned char specialCycle2 :1;
	56	} s;
	57	unsigned char d;
	58	} u_bus;
	59	unsigned char maxBusNum;
	60	unsigned char majorVersion;
	61	unsigned char minorVersion;
	62	unsigned char BIOSPresent;
	63	} PCI_bus_info_t;
	64
	65	typedef struct {
	66	unsigned long address; // address where driver was loaded
	67	unsigned long size; // number of bytes
	68	unsigned long type; // driver type
	69	} driver_config_t;
	70
	71	/*
	72	* INT15, E820h - Query System Address Map.
	73	*
	74	* Documented in ACPI Specification Rev 2.0,
	75	* Chapter 15 (System Address Map Interfaces).
	76	*/
	77
	78	/*
	79	* ACPI defined memory range types.
	80	*/
	81	enum {
	82	kMemoryRangeUsable = 1, // RAM usable by the OS.
	83	kMemoryRangeReserved = 2, // Reserved. (Do not use)
	84	kMemoryRangeACPI = 3, // ACPI tables. Can be reclaimed.
	85	kMemoryRangeNVS = 4, // ACPI NVS memory. (Do not use)
	86
	87	/* Undefined types should be treated as kMemoryRangeReserved */
	88	};
	89
	90	typedef struct PrivateBootInfo {
	91	int kernDev; // device kernel was fetched from
	92
	93	int convmem; // conventional memory
94	int extmem; // extended memory
95	int numBootDrivers; // number of drivers loaded
96	char bootFile[128]; // kernel file name
97
98	unsigned long memoryMapCount;
99	MemoryRange memoryMap[kMemoryMapCountMax];
100
101	PCI_bus_info_t pciInfo;
102
103	driver_config_t driverConfig[NDRIVERS];
104	char * configEnd; // pointer to end of config files
105	char config[CONFIG_SIZE];
106	} PrivateBootInfo_t;
107
108	extern PrivateBootInfo_t *bootInfo;
109
110	#endif /* __BOOTSTRUCT_H */