zircon/system/ulib/zbi-bootfs/include/zbi-bootfs/zbi-bootfs.h

// Copyright 2019 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.

#pragma once

#include <fuchsia/hardware/skipblock/c/fidl.h>
#include <lib/zx/vmo.h>
#include <zircon/types.h>

namespace zbi_bootfs {

// This library loads a compressed ZBI Image from "input"
// decompresses it and enable parsing files in its payload.
// Only ZBI_TYPE_STORAGE_BOOTFS type payloads are supported currently.
class ZbiBootfsParser {
public:
    // This loads the ZBI image from "input" to a vmo. It takes an optional parameter
    // byte_offset
    // byte_offset = 0 implies that bytes will be read without any offset
    // relative to the start of the file/partition
    zx_status_t Init(const char* input, size_t byte_offset = 0);

    // This parses the VMO for "filename" and writes its contents to "vmo_out"
    zx_status_t ProcessZbi(zx::vmo& vmo_out, const char* filename);

protected:
    zx_status_t LoadZbi(const char* input, size_t byte_offset);

private:
    bool IsSkipBlock(const char* path, fuchsia_hardware_skipblock_PartitionInfo* partition_info);
    zx::vmo zbi_vmo;
};

} // namespace zbi_bootfs