This commit was generated by cvs2svn to compensate for changes in r10,
[reactos.git] / reactos / doc / modules.txt
1 ** Introduction
2
3 This is (an incomplete) guide to writing device drivers (and other kernel
4 extensions) for ReactOS.
5
6 ** Setting up the build environment
7
8 Create a new subdirectory in the modules directory and copy one of the
9 existing module makefiles into it. Customize the makefile to compile the
10 source files for the module. Note: generally it is not necessary to specify
11 the compiler or compiler flags to use.
12
13 ** Initializing a module
14
15 On loading the kernel will call the module function
16
17 PROTOTYPE:
18
19 NTSTATUS ModuleEntry(PDRIVER_OBJECT DriverObject,
20 PUNICODE_STRING RegistryPath)
21
22 PURPOSE:
23
24 Initializing the module
25
26 ARGUMENTS:
27
28 DriverObject = Pointer to an object describing the driver
29 RegistryPath = Currently NULL
30
31 RETURNS:
32
33 STATUS_SUCCESS = If the module initialized successfully