/*
 * Copyright (c) 1999-2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Portions Copyright (c) 1999-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 __BOOT_MEMORY_H
#define __BOOT_MEMORY_H

/* Memory addresses used by booter and friends */

/*  DFE 2007-12-21: Changed BASE_SEG to be conditional
    This allows boot1u and other planned first-stage booters to avoid
    maintaining their own copies of asm.s and bios.s and instead
    simply build the files from libsaio with the right preprocessor
    definitions.

    This affects BASE_ADDR and OFFSET16() thus obviating the need for
    separate BASE1U_ADDR and OFFSET1U16() macros.

    Be careful though as changing these values with preprocessor macros
    obviously requires rebuilding the source files.  That means in particular
    that libsaio.a is only suitable for boot2.
 */
#if defined(BASE_SEG)
/* assume user knows what he's doing */
#elif defined(COMPILING_BOOT1PXE)
# define BASE_SEG          BOOT1PXE_SEG
#elif defined(BOOT1)
# define BASE_SEG          BOOT1U_SEG
#else
# define BASE_SEG          BOOT2_SEG
#endif

#define STACK_SEG         0x5000
#define STACK_OFS         0xFFF0      // stack pointer

#define BOOT1PXE_SEG      0x0000
#define BOOT1PXE_OFS      0x7C00

#define BOOT1U_SEG        0x1000
#define BOOT1U_OFS        0x0200

#define BOOT2_SEG         0x2000
#define BOOT2_OFS         0x0200      // 512 byte disk sector offset

#define BIOS_ADDR         0x8000      // BIOS disk I/O buffer
#define BIOS_LEN          0x8000      // 32K - divisible by 512 and 2048

#define BOOT0_ADDR        0x7E00      // boot0 gets loaded here


/* These are all "virtual" addresses...
 * which are physical addresses plus MEMBASE.
 */
#define ADDR32(seg, ofs)  (((seg) << 4 ) + (ofs))

#define MEMBASE           0x0

#define BOOTSTRUCT_ADDR   0x00011000    // it's slightly smaller
#define BOOTSTRUCT_LEN    0x0000F000

#define BASE_ADDR         ADDR32(BASE_SEG, 0)
#define BOOT1PXE_ADDR     ADDR32(BOOT1PXE_SEG, BOOT1PXE_OFS)
#define BOOT1U_ADDR       ADDR32(BOOT1U_SEG, BOOT1U_OFS)
#define BOOT2_ADDR        ADDR32(BOOT2_SEG, BOOT2_OFS)
// TODO: BOOT_ADDR ?

#define HIB_ADDR          0x00040000    // special hibernation area
#define HIB_LEN           0x00060000

#define VIDEO_ADDR        0x000A0000    // unusable space
#define VIDEO_LEN         0x00060000

#define KERNEL_ADDR       0x00100000   // 64M kernel + drivers
#define KERNEL_LEN        0x04000000

#define ZALLOC_ADDR       0x04100000   // 39M zalloc area
#define ZALLOC_LEN        0x02700000

#define LOAD_ADDR         0x06800000   // 24M File load buffer
#define LOAD_LEN          0x01800000

// Location of data fed to boot2 by the prebooter
#define PREBOOT_DATA      0x08000000

#define TFTP_ADDR         LOAD_ADDR   // tftp download buffer
#define TFTP_LEN          LOAD_LEN

#define kLoadAddr         LOAD_ADDR
#define kLoadSize         LOAD_LEN

#define CONVENTIONAL_LEN  0x0A0000    // 640k
#define EXTENDED_ADDR     0x100000    // 1024k

#define ptov(paddr)       ((paddr) - MEMBASE)
#define vtop(vaddr)       ((vaddr) + MEMBASE)

/*
 * Extract segment/offset from a linear address.
 */
#define OFFSET16(addr)    ((addr) - BASE_ADDR)
#define OFFSET(addr)      ((addr) & 0xFFFF)
#define SEGMENT(addr)     (((addr) & 0xF0000) >> 4)

/*  Extract segment/offset in normalized form so that the resulting far pointer
    will point to something that is very unlikely to straddle a segment.
    This is sometimes known as a "huge" pointer.
 */
#define NORMALIZED_OFFSET(addr)      ((addr) & 0x000F)
#define NORMALIZED_SEGMENT(addr)     (((addr) & 0xFFFF0) >> 4)

/*
 * We need a minimum of 32MB of system memory.
 */
#define MIN_SYS_MEM_KB  (32 * 1024)

/*
 * The number of descriptor entries in the GDT.
 */
#define NGDTENT   7

/*
 * The total size of the GDT in bytes.
 * Each descriptor entry require 8 bytes.
 */
#define GDTLIMIT  ( NGDTENT * 8 )

/* --------------------------------------------------------------------- */
/* Mach-O sections:
 *
 * The traditional format is __SEG__sect__begin and __SEG__sect__end which
 * can be directly represented as a C symbol by simply leaving off the first
 * underscore of the segment name since the C compiler adds it when outputting
 * assembler names.
 *
 * The modern format uses section$start$__SEG$__sect and section$end$__SEG$__sect
 * which requires an asm symbol override expression.
 *
 * It is recommended to declare these like:
 * extern struct {} _SEG__sect__begin ASM_MACHO_SECTION_BEGIN(__SEG,__sect);
 * extern struct {} _SEG__sect__end ASM_MACHO_SECTION_END(__SEG,__sect);
 *
 * This forces you to use the address-of (&) operator.
 */

/*
 * Produces the asm symbol override for a Mach-O section start
 */
#ifdef __clang__
#define ASM_MACHO_SECTION_BEGIN(segname,sectname) asm("section$start$" #segname "$" #sectname)
#else
#define ASM_MACHO_SECTION_BEGIN(segname,sectname) asm(#segname #sectname "__begin")
#endif

/*
 * Produces the asm symbol override for a Mach-O section end
 */
#ifdef __clang__
#define ASM_MACHO_SECTION_END(segname,sectname) asm("section$end$" #segname "$" #sectname)
#else
#define ASM_MACHO_SECTION_END(segname,sectname) asm(#segname #sectname "__end")
#endif

#endif /* !__BOOT_MEMORY_H */