Nut/OS API

Collaboration diagram for Nut/OS API:

---

Detailed Description

Operating System API.

This API supports the following features:

• Cooperative multithreading
• Synchronization mechanisms
• Dynamic memory management
• Asynchronous timers
• I/O Drivers

Modules
	System Initialization
	Nut/OS initialization.
	System Configuration
	Nut/OS configuration structure.
	Thread Management
	Cooperative multi-threading support.
	Event Management
	Thread synchronization support.
	Timer Management
	Asynchronous timer support.
	Memory Management
	Dynamic memory management.
	Device Management
	Device driver support.
	Interrupt Management
	Interrupt support.
	Version Information
	Nut/OS version number.
	Application Candies
Defines
#define	__byte_swap2(val)
#define	__byte_swap4(val)
#define	htons(x)   __byte_swap2(x)
	Convert short value from host to network byte order.
#define	htonl(x)   __byte_swap4(x)
	Convert long value from host to network byte order.
#define	ntohs(x)   __byte_swap2(x)
	Convert short value from network to host byte order.
#define	ntohl(x)   __byte_swap4(x)
	Convert long value from network to host byte order.
Typedefs
typedef unsigned char	u_char
	Unsigned 8-bit value.
typedef unsigned short	u_short
	Unsigned 16-bit value.
typedef unsigned int	u_int
	Unsigned int value.
typedef unsigned long	u_long
	Unsigned 32-bit value.
typedef unsigned long long	u_longlong
	Unsigned 64-bit value.
typedef void *	HANDLE
	Void pointer.
typedef unsigned __PTRDIFF_TYPE__	uptr_t
	Unsigned register type. Signed register type. Unsigned pointer value type.

---

Define Documentation

#define __byte_swap2 (  val   )

Value: ((((val) & 0xff) << 8) | \ (((val) & 0xff00) >> 8))

#define __byte_swap4 (  val   )

Value: ((((val) & 0xff) << 24) | \ (((val) & 0xff00) << 8) | \ (((val) & 0xff0000) >> 8) | \ (((val) & 0xff000000) >> 24))

---

Typedef Documentation

typedef unsigned char u_char

Unsigned 8-bit value. Todo: We should switch to stdint.h as suggested by Dirk Kaufmann. See feature request #1282721.

typedef unsigned __PTRDIFF_TYPE__ uptr_t

Unsigned register type. Signed register type. Unsigned pointer value type. The size of this type is at least the size of a memory pointer. For CPUs with 16 address bits this will be an unsigned short.

---