roxy-loader 0.2.3

Lightweight Rust bootloader for kernel development.
Documentation 
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

#ifndef ROXY_LOADER_H
#define ROXY_LOADER_H

#pragma once

/* This file is generated by cbindgen. Do not edit this file directly. */

#include <stdbool.h>
#include <stdint.h>

typedef enum PixelFormat {
  Rgb,
  Bgr,
  Bitmask,
  BltOnly,
} PixelFormat;

/**
 * A framebuffer provided to the kernel at boot time.
 *
 * Kernels can use this value to find the framebuffer memory and understand its
 * basic layout.
 */
typedef struct Framebuffer {
  uintptr_t ptr;
  /**
   * The total size of the framebuffer in bytes.
   */
  uintptr_t size;
  /**
   * The number of pixels in each row of the framebuffer.
   */
  uintptr_t stride;
  /**
   * Pixel format of the framebuffer.
   */
  enum PixelFormat pixel_format;
  /**
   * Width of the framebuffer in pixels.
   */
  uintptr_t width;
  /**
   * Height of the framebuffer in pixels.
   */
  uintptr_t height;
} Framebuffer;

/**
 * Boot-time data provided by `roxy-loader`.
 *
 * This is the main value passed to the kernel entry point. It groups together
 * the information a kernel can use immediately after startup.
 */
typedef struct BootInfo {
  /**
   * Information about the framebuffer that the kernel can draw to.
   */
  struct Framebuffer framebuffer;
} BootInfo;

#endif  /* ROXY_LOADER_H */