From 02f592ede943ce1d276f058d82d5a6a2f8473670 Mon Sep 17 00:00:00 2001 From: Alex Date: Sun, 18 Dec 2022 14:30:44 +0200 Subject: [PATCH] Updated Driver API --- DAPI.hpp | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/DAPI.hpp b/DAPI.hpp index 2b5a390..5c5d947 100644 --- a/DAPI.hpp +++ b/DAPI.hpp @@ -1,6 +1,17 @@ #ifndef __FENNIX_DRIVER_API_H__ #define __FENNIX_DRIVER_API_H__ +/** + * @brief The driver API is a set of functions that the kernel provides to the drivers. + * + * - The driver is responsible for the memory management. + * - The kernel will NOT free any memory allocated by the driver. On @see StopReason the driver must free all the memory it allocated and disable the hardware it uses. + * - The driver image will be freed after the driver is unloaded. + * - The kernel will unbind the interrupt handlers and the process handlers. + * - Kernel API will be freed after the driver is unloaded. + * + */ + enum DriverReturnCode { ERROR,