Kernel/armv7 - Fixed lack of in*/out* functions
[tpg/acess2.git] / Kernel / include / apidoc_mainpage.h
1 /**
2  * \file apidoc_mainpage.h
3  * \brief API Documentation Home Page
4  * \author John Hodge (thePowersGang)
5  * 
6  * \mainpage Acess 2 Kernel API Documentation
7  * 
8  * \section intro Introduction
9  * These documents attempt to describe the standard Acess 2 (and hopefully
10  * future versions) Kernel mode API.
11  * The documentation covers filesystem drivers, binary formats and the
12  * various device driver interface standards.
13  * 
14  * \section index       "Sections"
15  * - \ref modules.h "Module Definitions"
16  *  - Describes how a module is defined in Acess
17  * - \ref binary.h      "Binary Formats"
18  *  - Explains how to register a new binary format with the kernel
19  * - \ref vfs.h "VFS - The Virtual File System"
20  *  - The VFS is the core of Acess's driver architecture
21  * - \ref drivers       "Device Drivers"
22  *  - Describes how drivers should use the VFS to expose themselves to the
23  *    user.
24  *  - Drivers for specific types of hardware must behave in the specific
25  *    way described here.
26  * 
27  * \page drivers Device Drivers
28  * 
29  * \section toc Contents
30  * - \ref drvintro      "Introduction"
31  * - \ref drv_misc "Miscelanious Devices"
32  * - \ref drv_video     "Video Drivers"
33  * 
34  * \section drvintro    Introduction
35  * All Acess2 device drivers communicate with user-level (and other parts
36  * of the greater kernel) via the VFS. They register themselves in a similar
37  * way to how filesystem drivers do, however instead of registering with
38  * the VFS core, they register with a special filesystem driver called the
39  * \ref fs_devfs.h "Device Filesystem" (devfs). The DevFS provides the
40  * ::DevFS_AddDevice function that takes a ::tDevFS_Driver structure as
41  * an agument. This structure specifies the driver's name and its root
42  * VFS node. This node is used to provide the user access to the
43  * driver's functions via IOCtl calls and Reading or Writing to the driver
44  * file. Drivers are also able to expose a readonly buffer by using
45  * \ref fs_sysfs.h "ProcDev", usually to provide state information or device
46  * capabilities for the the user.
47  * 
48  * The device driver interfaces are all based on the core specifcation
49  * in api_drv_common.h (Common Device Driver definitions).
50  * The following subsections define the various specific types of driver
51  * interfaces. These definitions only define the bare minimum of what the
52  * driver must implement, if the driver author so wants to, they can add
53  * IOCtl calls and/or files (where allowed by the type specifcation) to
54  * their device's VFS layout.
55  * 
56  * \subsection drv_misc Miscelanious Devices
57  * If a device type does not have a specifcation for it, the driver can
58  * identify itself as a miscelanious device by returning DRV_TYPE_MISC
59  * from \ref DRV_IOCTL_TYPE.
60  * A misc device must at least implement the IOCtl calls defined in the
61  * \ref api_drv_common.h "Common Device Driver definitions", allowing it
62  * to be identified easily by the user and for interfacing programs to
63  * utilise the DRV_IOCTL_LOOKUP call.
64  * 
65  * \subsection drv_video Video Devices
66  * Video drivers are based on a framebuffer model (unless in 3D mode,
67  * which is not yet fully standardised, so should be ignored).
68  * The driver will contain only one VFS node, that exposes the video
69  * framebuffer (this may not be the true framebuffer, to allow for double-buffering)
70  * to the user. See the full documentation in api_drv_video.h for the
71  * complete specifcation.
72  * 
73  * \subsection drv_disk Disk/Storage Devices
74  * Storage devices present themselves as a linear collection of bytes.
75  * Reads and writes to the device need not be aligned to the stated block
76  * size, but it is suggested that users of a storage device file align
77  * their accesses to block boundaries.
78  * The functions DrvUtil_ReadBlock and DrvUtil_WriteBlock are provided
79  * to storage drivers to assist in handling non-alinged reads and writes.
80  * 
81  * \see api_drv_common.h Common Spec.
82  * \see api_drv_video.h Video Device Spec.
83  * \see api_drv_keyboard.h Keyboard Device Spec.
84  * \see api_drv_disk.h Disk/Storage Device Spec.
85  * \see api_drv_network.h Network Device Spec.
86  * \see api_drv_terminal.h Virtual Terminal Spec.
87  */

UCC git Repository :: git.ucc.asn.au