EPM.h

Go to the documentation of this file.

/* ========================================
 
  Copyright (C) 2024-2025, Amlal El Mahrouss, licensed under the Apache 2.0 license.
 
======================================== */

 
#ifndef FIRMWAREKIT_EPM_H
#define FIRMWAREKIT_EPM_H
 
#include <NeKit/Config.h>
 
#define kEPMNameLength (32)
#define kEPMFilesystemLength (16)
#define kEPMMagicLength (5)
 
/* @brief AMD64 magic for EPM */
#define kEPMMagic86 "EPMAM"
 
/* @brief RISC-V magic for EPM */
#define kEPMMagicRISCV "EPMRV"
 
/* @brief ARM magic for EPM */
#define kEPMMagicARM "EPMAR"
 
/* @brief 64x0 magic for EPM */
#define kEPMMagic64k "EPM64"
 
/* @brief 32x0 magic for EPM */
#define kEPMMagic32k "EPM32"
 
/* @brief POWER magic for EPM */
#define kEPMMagicPPC "EPMPC"
 
/* @brief Invalid magic for EPM */
#define kEPMMagicError "EPM??"
 
#ifdef __NE_AMD64__
#define kEPMMagic kEPMMagic86
#else
#ifdef __NE_ARM64__
#define kEPMMagic kEPMMagicARM
#else
#define kEPMMagic kEPMMagicError
#endif
#endif

#define kEPMPartBlockLba (sizeof(EPM_PART_BLOCK))

#define kEPMRevisionBcd (0x0100)

#define kEPMBootBlockLba (0U)
 
#define kEPMReserveLen (399)
 
struct EPM_GUID;
struct EPM_PART_BLOCK;
 
/* The first 0 > 128 addresses of a disk contains these headers. */

typedef struct EPM_GUID {
  Kernel::UInt32 Data1;
  Kernel::UInt16 Data2;
  Kernel::UInt16 Data3;
  Kernel::UInt8  Data4[8];
} PACKED EPM_GUID;

struct PACKED EPM_PART_BLOCK {
  Kernel::Char  Magic[kEPMMagicLength];
  Kernel::Char  Name[kEPMNameLength];
  EPM_GUID      Guid;
  Kernel::Int32 Version;
  Kernel::Int64 NumBlocks;
  Kernel::Int64 SectorSz;
  Kernel::Int64 LbaStart;  // base offset
  Kernel::Int64 LbaEnd;    // end offset
  Kernel::Int16 Kind;
  Kernel::Int16 Flags;
  Kernel::Int32 FsVersion;
  Kernel::Char  Fs[kEPMFilesystemLength];  /* NeFS, OpenHeFS... */
  Kernel::Char  Reserved[kEPMReserveLen];  // to fill a full sector.
};

 
enum {
  kEPMInvalid  = 0x00,
  kEPMGeneric  = 0xcf,  
  kEPMLinux    = 0x8f,  
  kEPMBSD      = 0x9f,  
  kEPMNeKernel = 0x1f,  
  kEPMLegacy   = 0x2f,  
  kEPMInvalidOS = 0xff,
};
 
inline EPM_GUID kEPMNilGuid = {0x0U, 0x0U, 0x0U, {0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}};
 
#endif  // ifndef FIRMWAREKIT_EPM_H