src/firmware/gigaboot/src/osboot.h

// Copyright 2017 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_FIRMWARE_GIGABOOT_SRC_OSBOOT_H_
#define SRC_FIRMWARE_GIGABOOT_SRC_OSBOOT_H_

#include <stdbool.h>
#include <stdint.h>
#include <zircon/compiler.h>

#include <efi/protocol/graphics-output.h>
#include <efi/system-table.h>

__BEGIN_CDECLS

#define PAGE_SIZE (4096)
#define PAGE_MASK (PAGE_SIZE - 1)

#define BYTES_TO_PAGES(n) (((n) + PAGE_MASK) / PAGE_SIZE)
#define ROUNDUP(size, align) (((size) + ((align)-1)) & ~((align)-1))

#define CMDLINE_MAX PAGE_SIZE

// Space for extra ZBI items.
#define EXTRA_ZBI_ITEM_SPACE (8 * PAGE_SIZE)
// TODO(fxbug.dev/93333): Remove this once DFv2 is the default.
#define DFV2_CMDLINE                                                  \
  "devmgr.enable-ephemeral=true "                                     \
  "driver_manager.root-driver=fuchsia-boot:///#meta/platform-bus.cm " \
  "driver_manager.use_driver_framework_v2=true"
uint64_t find_acpi_root(efi_handle img, efi_system_table* sys);
uint64_t find_smbios(efi_handle img, efi_system_table* sys);

uint32_t get_zx_pixel_format(efi_graphics_output_protocol* gop);

int boot_deprecated(efi_handle img, efi_system_table* sys, void* image, size_t sz, void* ramdisk,
                    size_t rsz, void* cmdline, size_t csz);

int zbi_boot(efi_handle img, efi_system_table* sys, void* image, size_t sz);

bool image_is_valid(void* image, size_t sz);

// sz may be just one block or sector
// if the header looks like a kernel image, return expected size
// otherwise returns 0
size_t image_getsize(void* imageheader, size_t sz);

// Where to start the kernel from
extern size_t kernel_zone_size;
extern efi_physical_addr kernel_zone_base;

// Selection for how to boot the device.
typedef enum {
  kBootActionDefault,
  kBootActionFastboot,
  kBootActionNetboot,
  kBootActionSlotA,
  kBootActionSlotB,
  kBootActionSlotR,
} BootAction;

// Determines what boot action to take.
//
// Priority order goes:
//   1. use the bootbyte if set (e.g. via `dm reboot-bootloader`)
//   2. let the user select from a boot menu
//   3. use "bootloader.default" commandline arg
//
// Args:
//   have_network: true if we have a working network interface.
//   have_fb: true if we have a framebuffer.
//   use_dfv2: updated by get_boot_action, true if boot should be done with DFv2.
//
// Returns the chosen boot action.
BootAction get_boot_action(bool have_network, bool have_fb, bool* use_dfv2);

__END_CDECLS

#endif  // SRC_FIRMWARE_GIGABOOT_SRC_OSBOOT_H_