From e6795eb552a6be88b7870dae14a958ab391bfae8 Mon Sep 17 00:00:00 2001 From: John Hodge Date: Sun, 25 Sep 2011 11:39:39 +0800 Subject: [PATCH] Renamed tpl_drv_* to api_drv_* (a more fitting name) --- .gitignore | 2 ++ Kernel/Doxyfile.api | 15 ++++++++------- Kernel/drv/vterm.c | 6 +++--- Kernel/drvutil.c | 4 ++-- .../{tpl_drv_common.h => api_drv_common.h} | 16 ++++++++-------- .../include/{tpl_drv_disk.h => api_drv_disk.h} | 8 ++++---- .../{tpl_drv_joystick.h => api_drv_joystick.h} | 8 ++++---- .../{tpl_drv_keyboard.h => api_drv_keyboard.h} | 8 ++++---- .../{tpl_drv_network.h => api_drv_network.h} | 8 ++++---- .../{tpl_drv_terminal.h => api_drv_terminal.h} | 8 ++++---- .../{tpl_drv_video.h => api_drv_video.h} | 10 +++++----- Kernel/include/apidoc_mainpage.h | 18 +++++++++--------- Modules/Display/BochsGA/bochsvbe.c | 2 +- Modules/Display/VESA/main.c | 2 +- Modules/IPStack/interface.c | 4 ++-- Modules/IPStack/routing.c | 2 +- Modules/IPStack/sctp.c | 2 +- Modules/IPStack/udp.c | 2 +- Modules/Input/PS2KbMouse/kb.c | 4 ++-- Modules/Input/PS2KbMouse/ps2mouse.c | 4 ++-- Modules/Network/NE2000/ne2000.c | 2 +- Modules/Network/PCnet-FASTIII/pcnet-fast3.c | 2 +- Modules/Network/RTL8139/rtl8139.c | 2 +- Modules/Sound/SoundBlaster16/main.c | 2 +- Modules/Storage/ATA/main.c | 4 ++-- Modules/Storage/FDD/fdd.c | 2 +- Modules/x86/VGAText/vga.c | 2 +- 27 files changed, 76 insertions(+), 73 deletions(-) rename Kernel/include/{tpl_drv_common.h => api_drv_common.h} (92%) rename Kernel/include/{tpl_drv_disk.h => api_drv_disk.h} (94%) rename Kernel/include/{tpl_drv_joystick.h => api_drv_joystick.h} (94%) rename Kernel/include/{tpl_drv_keyboard.h => api_drv_keyboard.h} (93%) rename Kernel/include/{tpl_drv_network.h => api_drv_network.h} (91%) rename Kernel/include/{tpl_drv_terminal.h => api_drv_terminal.h} (93%) rename Kernel/include/{tpl_drv_video.h => api_drv_video.h} (95%) diff --git a/.gitignore b/.gitignore index 05ecdad8..c2b64113 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,5 @@ obj-*/ *.bin Makefile.user.cfg +QemuLog.txt +Screenshots/ diff --git a/Kernel/Doxyfile.api b/Kernel/Doxyfile.api index 18c15372..1f406f0e 100644 --- a/Kernel/Doxyfile.api +++ b/Kernel/Doxyfile.api @@ -574,12 +574,13 @@ INPUT = include/apidoc_mainpage.h \ include/iocache.h \ arch/archdoc.h \ include/apidoc/arch_x86.h \ - include/tpl_drv_common.h \ - include/tpl_drv_video.h \ - include/tpl_drv_terminal.h \ - include/tpl_drv_disk.h \ - include/tpl_drv_keyboard.h \ - include/tpl_drv_network.h + include/api_drv_common.h \ + include/api_drv_video.h \ + include/api_drv_terminal.h \ + include/api_drv_disk.h \ + include/api_drv_keyboard.h \ + include/api_drv_joystick.h \ + include/api_drv_network.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -596,7 +597,7 @@ INPUT_ENCODING = UTF-8 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 -FILE_PATTERNS = tpl_drv_*.h +FILE_PATTERNS = api_drv_*.h #*.c *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories diff --git a/Kernel/drv/vterm.c b/Kernel/drv/vterm.c index 277d6c52..85ab0e16 100644 --- a/Kernel/drv/vterm.c +++ b/Kernel/drv/vterm.c @@ -5,9 +5,9 @@ #include #include #include -#include -#include -#include +#include +#include +#include #include #include diff --git a/Kernel/drvutil.c b/Kernel/drvutil.c index 1bc6b785..e86f9a87 100644 --- a/Kernel/drvutil.c +++ b/Kernel/drvutil.c @@ -4,8 +4,8 @@ */ #define DEBUG 0 #include -#include -#include +#include +#include // === CODE === // --- Video Driver Helpers --- diff --git a/Kernel/include/tpl_drv_common.h b/Kernel/include/api_drv_common.h similarity index 92% rename from Kernel/include/tpl_drv_common.h rename to Kernel/include/api_drv_common.h index ebc9130d..a8da516c 100644 --- a/Kernel/include/tpl_drv_common.h +++ b/Kernel/include/api_drv_common.h @@ -1,5 +1,5 @@ /** - * \file tpl_drv_common.h + * \file api_drv_common.h * \brief Common Driver Interface Definitions * \author John Hodge (thePowersGang) * @@ -31,8 +31,8 @@ * These device types are described in their own files, which are liked * from their entries in ::eTplDrv_Type. */ -#ifndef _TPL_COMMON_H -#define _TPL_COMMON_H +#ifndef _API_DRV_COMMON_H +#define _API_DR_COMMON_H /** * \enum eTplDrv_IOCtl @@ -123,14 +123,14 @@ enum eTplDrv_IOCtl { enum eTplDrv_Type { DRV_TYPE_NULL, //!< NULL Type - Custom Interface DRV_TYPE_MISC, //!< Miscelanious Compilant - Supports the core calls - DRV_TYPE_TERMINAL, //!< Terminal - see tpl_drv_terminal.h - DRV_TYPE_VIDEO, //!< Video - see tpl_drv_video.h + DRV_TYPE_TERMINAL, //!< Terminal - see api_drv_terminal.h + DRV_TYPE_VIDEO, //!< Video - see api_drv_video.h DRV_TYPE_SOUND, //!< Audio - DRV_TYPE_DISK, //!< Disk - see tpl_drv_disk.h - DRV_TYPE_KEYBOARD, //!< Keyboard - see tpl_drv_keyboard.h + DRV_TYPE_DISK, //!< Disk - see api_drv_disk.h + DRV_TYPE_KEYBOARD, //!< Keyboard - see api_drv_keyboard.h DRV_TYPE_MOUSE, //!< Mouse DRV_TYPE_JOYSTICK, //!< Joystick / Gamepad - DRV_TYPE_NETWORK //!< Network Device - see tpl_drv_network.h + DRV_TYPE_NETWORK //!< Network Device - see api_drv_network.h }; #endif diff --git a/Kernel/include/tpl_drv_disk.h b/Kernel/include/api_drv_disk.h similarity index 94% rename from Kernel/include/tpl_drv_disk.h rename to Kernel/include/api_drv_disk.h index 47efb049..68e5330d 100644 --- a/Kernel/include/tpl_drv_disk.h +++ b/Kernel/include/api_drv_disk.h @@ -1,5 +1,5 @@ /** - * \file tpl_drv_disk.h + * \file api_drv_disk.h * \brief Disk Driver Interface Definitions * \author John Hodge (thePowersGang) * @@ -21,10 +21,10 @@ * to improve speed (this can be aided by using ::DrvUtil_ReadBlock and * ::DrvUtil_WriteBlock) */ -#ifndef _TPL_DRV_DISK_H -#define _TPL_DRV_DISK_H +#ifndef _API_DRV_DISK_H +#define _API_DRV_DISK_H -#include +#include /** * \enum eTplDisk_IOCtl diff --git a/Kernel/include/tpl_drv_joystick.h b/Kernel/include/api_drv_joystick.h similarity index 94% rename from Kernel/include/tpl_drv_joystick.h rename to Kernel/include/api_drv_joystick.h index 2f4249b8..9225c5e4 100644 --- a/Kernel/include/tpl_drv_joystick.h +++ b/Kernel/include/api_drv_joystick.h @@ -1,5 +1,5 @@ /** - * \file tpl_drv_joystick + * \file api_drv_joystick * \brief Joystick Driver Interface Definitions * \author John Hodge (thePowersGang) * @@ -16,10 +16,10 @@ * 0xFF is fully depressed - intermediate values are valid in the case of * variable-pressure buttons) */ -#ifndef _TPL_JOYSTICK_H -#define _TPL_JOYSTICK_H +#ifndef _API_DRV_JOYSTICK_H +#define _API_DRV_JOYSTICK_H -#include +#include /** * \enum eTplJoystick_IOCtl diff --git a/Kernel/include/tpl_drv_keyboard.h b/Kernel/include/api_drv_keyboard.h similarity index 93% rename from Kernel/include/tpl_drv_keyboard.h rename to Kernel/include/api_drv_keyboard.h index c93c147e..8aa32634 100644 --- a/Kernel/include/tpl_drv_keyboard.h +++ b/Kernel/include/api_drv_keyboard.h @@ -1,5 +1,5 @@ /** - * \file tpl_drv_keyboard.h + * \file api_drv_keyboard.h * \brief Keyboard Driver Interface Definitions * \author John Hodge (thePowersGang) * @@ -8,10 +8,10 @@ * node with a size of zero. All reads and writes to this node are ignored * (tVFS_Node.Read and tVFS_Node.Write are NULL) */ -#ifndef _TPL_KEYBOARD_H -#define _TPL_KEYBOARD_H +#ifndef _API_DRV_KEYBOARD_H +#define _API_KEYBOARD_H -#include +#include /** * \enum eTplKeyboard_IOCtl diff --git a/Kernel/include/tpl_drv_network.h b/Kernel/include/api_drv_network.h similarity index 91% rename from Kernel/include/tpl_drv_network.h rename to Kernel/include/api_drv_network.h index 6b7493ac..6cb8c349 100644 --- a/Kernel/include/tpl_drv_network.h +++ b/Kernel/include/api_drv_network.h @@ -1,5 +1,5 @@ /** - * \file tpl_drv_network.h + * \file api_drv_network.h * \brief Network Interface Driver Interface Definitions * * \section dirs VFS Layout @@ -26,10 +26,10 @@ * is too small, or if it is too large) -1 should be returned and the packet * will not be sent. */ -#ifndef _TPL_NETWORK_H -#define _TPL_NETWORK_H +#ifndef _API_DRV_NETWORK_H +#define _API_DRV_NETWORK_H -#include +#include /** * \enum eTplNetwork_IOCtl diff --git a/Kernel/include/tpl_drv_terminal.h b/Kernel/include/api_drv_terminal.h similarity index 93% rename from Kernel/include/tpl_drv_terminal.h rename to Kernel/include/api_drv_terminal.h index b32b83d5..7e53bbc3 100644 --- a/Kernel/include/tpl_drv_terminal.h +++ b/Kernel/include/api_drv_terminal.h @@ -1,11 +1,11 @@ /** - * \file tpl_drv_terminal.h + * \file api_drv_terminal.h * \brief Terminal Driver Interface Definitions */ -#ifndef _TPL_TERMINAL_H -#define _TPL_TERMINAL_H +#ifndef _API_DRV_TERMINAL_H +#define _API_DRV_TERMINAL_H -#include +#include /** * \brief Common Terminal IOCtl Calls diff --git a/Kernel/include/tpl_drv_video.h b/Kernel/include/api_drv_video.h similarity index 95% rename from Kernel/include/tpl_drv_video.h rename to Kernel/include/api_drv_video.h index f518e74a..a4eb46c0 100644 --- a/Kernel/include/tpl_drv_video.h +++ b/Kernel/include/api_drv_video.h @@ -1,9 +1,9 @@ /** - * \file tpl_drv_video.h + * \file api_drv_video.h * \brief Video Driver Interface Definitions * \note For AcessOS Version 1 * - * Video drivers extend the common driver interface tpl_drv_common.h + * Video drivers extend the common driver interface api_drv_common.h * and must support _at least_ the IOCtl numbers defined in this file * to be compatable with Acess. * @@ -24,10 +24,10 @@ * text mode with the same resolution, this mode will be used when the * user switches to a text Virtual Terminal while in graphics mode. */ -#ifndef _TPL_VIDEO_H -#define _TPL_VIDEO_H +#ifndef _API_DRV_VIDEO_H +#define _API_DRV_VIDEO_H -#include +#include /** * \enum eTplVideo_IOCtl diff --git a/Kernel/include/apidoc_mainpage.h b/Kernel/include/apidoc_mainpage.h index ca6a5da7..0060bafa 100644 --- a/Kernel/include/apidoc_mainpage.h +++ b/Kernel/include/apidoc_mainpage.h @@ -46,7 +46,7 @@ * capabilities for the the user. * * The device driver interfaces are all based on the core specifcation - * in tpl_drv_common.h (Common Device Driver definitions). + * in api_drv_common.h (Common Device Driver definitions). * The following subsections define the various specific types of driver * interfaces. These definitions only define the bare minimum of what the * driver must implement, if the driver author so wants to, they can add @@ -58,7 +58,7 @@ * identify itself as a miscelanious device by returning DRV_TYPE_MISC * from \ref DRV_IOCTL_TYPE. * A misc device must at least implement the IOCtl calls defined in the - * \ref tpl_drv_common.h "Common Device Driver definitions", allowing it + * \ref api_drv_common.h "Common Device Driver definitions", allowing it * to be identified easily by the user and for interfacing programs to * utilise the DRV_IOCTL_LOOKUP call. * @@ -67,7 +67,7 @@ * which is not yet fully standardised, so should be ignored). * The driver will contain only one VFS node, that exposes the video * framebuffer (this may not be the true framebuffer, to allow for double-buffering) - * to the user. See the full documentation in tpl_drv_video.h for the + * to the user. See the full documentation in api_drv_video.h for the * complete specifcation. * * \subsection drv_disk Disk/Storage Devices @@ -78,10 +78,10 @@ * The functions DrvUtil_ReadBlock and DrvUtil_WriteBlock are provided * to storage drivers to assist in handling non-alinged reads and writes. * - * \see tpl_drv_common.h Common Spec. - * \see tpl_drv_video.h Video Device Spec. - * \see tpl_drv_keyboard.h Keyboard Device Spec. - * \see tpl_drv_disk.h Disk/Storage Device Spec. - * \see tpl_drv_network.h Network Device Spec. - * \see tpl_drv_terminal.h Virtual Terminal Spec. + * \see api_drv_common.h Common Spec. + * \see api_drv_video.h Video Device Spec. + * \see api_drv_keyboard.h Keyboard Device Spec. + * \see api_drv_disk.h Disk/Storage Device Spec. + * \see api_drv_network.h Network Device Spec. + * \see api_drv_terminal.h Virtual Terminal Spec. */ diff --git a/Modules/Display/BochsGA/bochsvbe.c b/Modules/Display/BochsGA/bochsvbe.c index df4072b3..5508e3f4 100644 --- a/Modules/Display/BochsGA/bochsvbe.c +++ b/Modules/Display/BochsGA/bochsvbe.c @@ -10,7 +10,7 @@ #include #include #include -#include +#include #define INT diff --git a/Modules/Display/VESA/main.c b/Modules/Display/VESA/main.c index 848351a0..c18891f4 100644 --- a/Modules/Display/VESA/main.c +++ b/Modules/Display/VESA/main.c @@ -7,7 +7,7 @@ #include #include -#include +#include #include #include #include diff --git a/Modules/IPStack/interface.c b/Modules/IPStack/interface.c index 74f0cf83..e08d6505 100644 --- a/Modules/IPStack/interface.c +++ b/Modules/IPStack/interface.c @@ -6,8 +6,8 @@ #define VERSION VER2(0,10) #include "ipstack.h" #include "link.h" -#include -#include +#include +#include // === CONSTANTS === //! Default timeout value, 30 seconds diff --git a/Modules/IPStack/routing.c b/Modules/IPStack/routing.c index 63793027..9e298a0e 100644 --- a/Modules/IPStack/routing.c +++ b/Modules/IPStack/routing.c @@ -5,7 +5,7 @@ #define DEBUG 0 #define VERSION VER2(0,10) #include -#include +#include #include "ipstack.h" #include "link.h" diff --git a/Modules/IPStack/sctp.c b/Modules/IPStack/sctp.c index a09b153d..d130933f 100644 --- a/Modules/IPStack/sctp.c +++ b/Modules/IPStack/sctp.c @@ -3,7 +3,7 @@ * - SCTP (Stream Control Transmission Protocol) Handling */ #include "ipstack.h" -#include +#include #include "sctp.h" #define SCTP_ALLOC_BASE 0xC000 diff --git a/Modules/IPStack/udp.c b/Modules/IPStack/udp.c index 9e54701f..c75aab0c 100644 --- a/Modules/IPStack/udp.c +++ b/Modules/IPStack/udp.c @@ -3,7 +3,7 @@ * - UDP Handling */ #include "ipstack.h" -#include +#include #include "udp.h" #define UDP_ALLOC_BASE 0xC000 diff --git a/Modules/Input/PS2KbMouse/kb.c b/Modules/Input/PS2KbMouse/kb.c index d8ef32ee..db0ee220 100644 --- a/Modules/Input/PS2KbMouse/kb.c +++ b/Modules/Input/PS2KbMouse/kb.c @@ -5,8 +5,8 @@ #include #include #include -#include -#include +#include +#include #include "kb_kbdus.h" // === CONSTANTS === diff --git a/Modules/Input/PS2KbMouse/ps2mouse.c b/Modules/Input/PS2KbMouse/ps2mouse.c index f67c8b15..cb26efe5 100644 --- a/Modules/Input/PS2KbMouse/ps2mouse.c +++ b/Modules/Input/PS2KbMouse/ps2mouse.c @@ -6,8 +6,8 @@ #include #include #include -#include -#include +#include +#include static inline int MIN(int a, int b) { return (a < b) ? a : b; } static inline int MAX(int a, int b) { return (a > b) ? a : b; } diff --git a/Modules/Network/NE2000/ne2000.c b/Modules/Network/NE2000/ne2000.c index cb760d66..eb3673f2 100644 --- a/Modules/Network/NE2000/ne2000.c +++ b/Modules/Network/NE2000/ne2000.c @@ -9,7 +9,7 @@ #include #include #include -#include +#include #include // === CONSTANTS === diff --git a/Modules/Network/PCnet-FASTIII/pcnet-fast3.c b/Modules/Network/PCnet-FASTIII/pcnet-fast3.c index ebb40114..bb4f83a8 100644 --- a/Modules/Network/PCnet-FASTIII/pcnet-fast3.c +++ b/Modules/Network/PCnet-FASTIII/pcnet-fast3.c @@ -8,7 +8,7 @@ #include #include #include -#include +#include #include // === CONSTANTS === diff --git a/Modules/Network/RTL8139/rtl8139.c b/Modules/Network/RTL8139/rtl8139.c index 707b2eb1..bb479554 100644 --- a/Modules/Network/RTL8139/rtl8139.c +++ b/Modules/Network/RTL8139/rtl8139.c @@ -8,7 +8,7 @@ #include #include #include -#include +#include #include // === CONSTANTS === diff --git a/Modules/Sound/SoundBlaster16/main.c b/Modules/Sound/SoundBlaster16/main.c index 52883999..f2d056c6 100644 --- a/Modules/Sound/SoundBlaster16/main.c +++ b/Modules/Sound/SoundBlaster16/main.c @@ -8,7 +8,7 @@ #include #include #include -#include +#include #define INT diff --git a/Modules/Storage/ATA/main.c b/Modules/Storage/ATA/main.c index 7f8964d2..11498da9 100644 --- a/Modules/Storage/ATA/main.c +++ b/Modules/Storage/ATA/main.c @@ -8,8 +8,8 @@ #include #include #include -#include -#include +#include +#include #include "common.h" // === MACROS === diff --git a/Modules/Storage/FDD/fdd.c b/Modules/Storage/FDD/fdd.c index 42150a95..a7b20f7d 100644 --- a/Modules/Storage/FDD/fdd.c +++ b/Modules/Storage/FDD/fdd.c @@ -6,7 +6,7 @@ #include #include #include -#include +#include #include #include diff --git a/Modules/x86/VGAText/vga.c b/Modules/x86/VGAText/vga.c index 1ae1ece6..d958956b 100644 --- a/Modules/x86/VGAText/vga.c +++ b/Modules/x86/VGAText/vga.c @@ -4,7 +4,7 @@ #define DEBUG 0 #include #include -#include +#include #include // === CONSTANTS === -- 2.20.1