summaryrefslogtreecommitdiffhomepage
path: root/dev/kernel/FirmwareKit/NeBoot/BootNet.h
blob: ab0328088c43ec5d2fe704c325a32762b6497fb9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
/* -------------------------------------------

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

------------------------------------------- */

#pragma once

#include <NeKit/Defines.h>

#define kBootNetINetMagic "ONET"
#define kBootNetINetMagicLength (4)
#define kBootNetVersion (0x001)
#define kBootNetNameLen (256U)

struct _BOOTNET_INTERNET_HEADER;

/// @brief Netboot Internet Header
/// Consists of 4 magic characters, and a set of fields describing the current patch that's being
/// sent (if m_preflight = 0)
/// @note Can be used to patch ROMs too (if ImpliesProgram = 1)
typedef struct _BOOTNET_INTERNET_HEADER {
  Kernel::Char NB1;  /// magic char 1 'O'
  Kernel::Char NB2;  /// magic char 2 'N'
  Kernel::Char NB3;  /// magic char 3 'E'
  Kernel::Char NB4;  /// magic char 4 'T'

  Kernel::UInt16 Version;

  Kernel::Char Name[kBootNetNameLen];  /// example: Modjo

  Kernel::Int32 Length;                   /// the patch length.
  Kernel::Char  Target[kBootNetNameLen];  /// the target file.

  Kernel::Boolean ImpliesProgram : 1;  /// does it imply reprogramming?

  Kernel::Boolean Preflight : 1;  /// is it a preflight packet.
  Kernel::Char    Data[1];        /// non preflight packet has a patch blob for a **PatchTarget**
} PACKED BOOTNET_INTERNET_HEADER;

using BOOTNET_INTERNET_HEADER_PTR = BOOTNET_INTERNET_HEADER*;