summaryrefslogtreecommitdiffhomepage
path: root/dev/libDDK/DriverKit/ddk.h
blob: 45f7d356f3cb38c4224b6e36ddc3eec130a82cbd (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* ========================================

  Copyright Amlal El Mahrouss 2025, licensed under the Apache 2.0 license.

  FILE: ddk.h
  PURPOSE: DDK Driver model base header.

======================================== */

#pragma once

#include <DriverKit/macros.h>

struct DDK_STATUS_STRUCT;
struct DDK_OBJECT_MANIFEST;

/// \brief Object handle manifest.
struct DDK_OBJECT_MANIFEST DDK_FINAL {
  char*   p_name;
  int32_t p_kind;
  void*   p_object;
};

/// \brief DDK status ping structure.
struct DDK_STATUS_STRUCT DDK_FINAL {
  int32_t                     s_action_id;
  int32_t                     s_issuer_id;
  int32_t                     s_group_id;
  struct DDK_OBJECT_MANIFEST* s_object;
};

typedef void* ptr_t;

/// @brief Call Kernel procedure.
/// @param name the procedure name.
/// @param cnt number of elements in **dat**
/// @param dat data argument pointer.
/// @param sz sz of whole data argument pointer.
/// @return result of call
DDK_EXTERN void* ke_call_dispatch(const char* name, int32_t cnt, void* dat, size_t sz);

/// @brief add a system call.
/// @param slot system call slot id.
/// @param slotFn, syscall slot.
DDK_EXTERN void ke_set_syscall(const int32_t slot, void (*slotFn)(void* a0));

/// @brief Allocates an heap ptr.
/// @param sz size of the allocated struct/type.
/// @return the pointer allocated or **nil**.
DDK_EXTERN void* kalloc(size_t sz);

/// @brief Frees an heap ptr.
/// @param pointer kernel pointer to free.
DDK_EXTERN void kfree(void* the_ptr);

/// @brief Gets a Kernel object.
/// @param slot object id (can be 0)
/// @param name the property's name.
/// @return DDK_OBJECT_MANIFEST.
DDK_EXTERN struct DDK_OBJECT_MANIFEST* ke_get_obj(const int slot, const char* name);

/// @brief Set a Kernel object.
/// @param slot object id (can be 0)
/// @param name the property's name.
/// @param ddk_pr pointer to a object's DDK_OBJECT_MANIFEST.
/// @return returned object.
DDK_EXTERN void* ke_set_obj(const int32_t slot, const struct DDK_OBJECT_MANIFEST* ddk_pr);

/// @brief The highest API version of the DDK.
DDK_EXTERN uint32_t kApiVersionHighest;

/// @brief The lowest API version of the DDK.
DDK_EXTERN uint32_t kApiVersionLowest;

/// @brief API version in BCD.
DDK_EXTERN uint32_t kApiVersion;