lkrn.h

Go to the documentation of this file.

#ifndef _IPXE_LKRN_H
#define _IPXE_LKRN_H

/** @file
 *
 * Linux kernel images
 *
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

#include <stdint.h>

/** Kernel image header */
struct lkrn_header {
        /** Executable code */
        uint32_t code[2];
        /** Image load offset */
        uint64_t text_offset;
        /** Image size */
        uint64_t image_size;
        /** Flags */
        uint64_t flags;
        /** Reserved */
        uint8_t reserved_a[24];
        /** Magic */
        uint32_t magic;
        /** Reserved */
        uint8_t reserved_b[4];
} __attribute__ (( packed ));

/** Kernel magic value */
#define LKRN_MAGIC( a, b, c, d ) \
        ( ( (a) << 0 ) | ( (b) << 8 ) | ( (c) << 16 ) | ( (d) << 24 ) )

/** Kernel magic value for AArch64 */
#define LKRN_MAGIC_AARCH64 LKRN_MAGIC ( 'A', 'R', 'M', 0x64 )

/** Kernel magic value for RISC-V */
#define LKRN_MAGIC_RISCV LKRN_MAGIC ( 'R', 'S', 'C', 0x05 )

/** Kernel image context */
struct lkrn_context {
        /** Load offset */
        size_t offset;
        /** File size */
        size_t filesz;
        /** Memory size */
        size_t memsz;

        /** Start of RAM */
        physaddr_t ram;
        /** Entry point */
        physaddr_t entry;
        /** Initial ramdisk (if any) */
        physaddr_t initrd;
        /** Device tree */
        physaddr_t fdt;
};

/** Compressed kernel image header */
struct zimg_header {
        /** Reserved */
        uint8_t reserved_a[4];
        /** Magic */
        uint32_t magic;
        /** Offset to payload */
        uint32_t offset;
        /** Length of payload */
        uint32_t len;
        /** Reserved */
        uint8_t reserved_b[8];
        /** Compression type */
        uint32_t type;
} __attribute__ (( packed ));

/** Compressed kernel image magic value */
#define ZIMG_MAGIC LKRN_MAGIC ( 'z', 'i', 'm', 'g' )

/** Compressed kernel image context */
struct zimg_context {
        /** Offset to compressed data */
        size_t offset;
        /** Length of compressed data */
        size_t len;
        /** Compression type */
        union {
                /** Raw type */
                uint32_t raw;
                /** Printable string */
                char string[5];
        } type;
};

#include <bits/lkrn.h>

/**
 * Jump to kernel entry point
 *
 * @v entry             Kernel entry point
 * @v fdt               Device tree
 */
void lkrn_jump ( physaddr_t entry, physaddr_t fdt );

#endif /* _IPXE_LKRN_H */