-
Notifications
You must be signed in to change notification settings - Fork 6
Headers
From this page you can find concise documentation about each file and function in Xinu. Development of this page is ongoing at the moment. If you are part of the Xinu development team, feel free to add to this page whenever you are able.
The documentation regarding the files is intentionally brief; since the Xinu code base is very well-commented, most necessary information can be found within the files themselves.
Please note that this page only contains documentation about files and functions that are present within the master branch of the Xinu codebase. For documentation about project-specific code(for example, ssh.h or pthread_wrapper.h), visit the projects page of the Xinu wiki.
Defines constants and structures related to the Address Resolution Protocol(ARP).
Defines constants and structures needed for buffer pool management, which provides synchronous access to partitioned memory. From Vol. 1 of Operating System Design - The Xinu Approach:
The mechanism we have chosen to handle partitioned memory is known as a buffer pool manager. Memory is divided into a set of buffer pools. Each buffer pool contains a fixed number of memory blocks, and all blocks in a given pool are the same size.
Contains constants needed to interface with the Intel 8254 Programmable Interval Timer. The datasheet for this chip can be downloaded here.
Defines constants and functions used to store and convert dates. Xinu follows the UNIX convention of storing the time as the number of seconds since the Epoch(January 1, 1970 GMT).
Defines two delay functions, DELAY and MDELAY, which force Xinu to delay for a given number of microseconds or milliseconds respectively.
Defines constants and functions used for the Dynamic Host Configuration Protocol(DHCP).
Defines constants and structures used for the Domain Name Service(DNS).
Defines constants, structures and functions related to the Ethernet packet format. For more information about Ethernet packets, see the Ethernet Frame RFC.
Defines constants needed for file permissions and control functions on local and remote file systems.
Defines constants and structures needed for the Internet Control Message Protocol(ICMP).
Code related to the interrupt controller. The icu.h file defines constants for C functions, and the icu.s file defines constants for assembly language.
Defines constants and structures related to version 4 of the Internet Protocol, commonly known as IPv4.
Defines types, constants and system calls used throughout the Xinu kernel. Curious Xinu developers may want to start reading the Xinu code here, since the declarations within this file are used throughout the rest of the Xinu codebase. A reference sheet for these declarations can be found here.
Clears the incoming message and returns the message if there is a message waiting. The recvclr function is a non-blocking version of the receive function.