/* loader.h - OS loaders */
/*
 *  VAS_EBOOT  --  GRand Unified Bootloader
 *  Copyright (C) 2002,2003,2004,2006,2007,2009  Free Software Foundation, Inc.
 *
 *  VAS_EBOOT is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  VAS_EBOOT is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with VAS_EBOOT.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef VAS_EBOOT_LOADER_HEADER
#define VAS_EBOOT_LOADER_HEADER	1

#include <VasEBoot/file.h>
#include <VasEBoot/symbol.h>
#include <VasEBoot/err.h>
#include <VasEBoot/types.h>

/* Check if a loader is loaded.  */
int EXPORT_FUNC (VasEBoot_loader_is_loaded) (void);

/* Set loader functions.  */
enum
{
  VAS_EBOOT_LOADER_FLAG_NORETURN = 1,
  VAS_EBOOT_LOADER_FLAG_PXE_NOT_UNLOAD = 2,
  VAS_EBOOT_LOADER_FLAG_EFI_KEEP_ALLOCATED_MEMORY = 4,
};

void EXPORT_FUNC (VasEBoot_loader_set) (VasEBoot_err_t (*boot) (void),
				    VasEBoot_err_t (*unload) (void),
				    int flags);

void EXPORT_FUNC (VasEBoot_loader_set_ex) (VasEBoot_err_t (*boot) (void *context),
				       VasEBoot_err_t (*unload) (void *context),
				       void *context,
				       int flags);

/* Unset current loader, if any.  */
void EXPORT_FUNC (VasEBoot_loader_unset) (void);

/* Call the boot hook in current loader. This may or may not return,
   depending on the setting by VasEBoot_loader_set.  */
VasEBoot_err_t VasEBoot_loader_boot (void);

/* The space between numbers is intentional for the simplicity of adding new
   values even if external modules use them. */
typedef enum {
  /* A preboot hook which can use everything and turns nothing off. */
  VAS_EBOOT_LOADER_PREBOOT_HOOK_PRIO_NORMAL = 400,
  /* A preboot hook which can't use disks and may stop disks. */
  VAS_EBOOT_LOADER_PREBOOT_HOOK_PRIO_DISK = 300,
  /* A preboot hook which can't use disks or console and may stop console. */
  VAS_EBOOT_LOADER_PREBOOT_HOOK_PRIO_CONSOLE = 200,
  /* A preboot hook which can't use disks or console, can't modify memory map
     and may stop memory services or finalize memory map. */
  VAS_EBOOT_LOADER_PREBOOT_HOOK_PRIO_MEMORY = 100,
} VasEBoot_loader_preboot_hook_prio_t;

/* Register a preboot hook. */
struct VasEBoot_preboot;

struct VasEBoot_preboot *EXPORT_FUNC(VasEBoot_loader_register_preboot_hook) (VasEBoot_err_t (*preboot_func) (int noret),
								     VasEBoot_err_t (*preboot_rest_func) (void),
								     VasEBoot_loader_preboot_hook_prio_t prio);

/* Unregister given preboot hook. */
void EXPORT_FUNC (VasEBoot_loader_unregister_preboot_hook) (struct VasEBoot_preboot *hnd);

#ifndef VAS_EBOOT_MACHINE_EMU
void VasEBoot_boot_init (void);
void VasEBoot_boot_fini (void);
#endif

#endif /* ! VAS_EBOOT_LOADER_HEADER */