Nut/OS API

Detailed Description


Data Structures
struct	_NUTDEVICE
	Device structure. More...
struct	_NUTVIRTUALDEVICE
	Virtual device structure. More...
struct	_IFSTREAM
	Stream interface information structure. More...
struct	_NUTFILE
	File structure. More...
struct	_NUTFILE
	File structure. More...
Defines
#define	IFTYP_RAM 0
	RAM device.
#define	IFTYP_ROM 1
	ROM device.
#define	IFTYP_STREAM 2
	Stream device.
#define	IFTYP_NET 3
	Net device.
#define	IFTYP_TCPSOCK 4
	TCP socket.
#define	IFTYP_CHAR 5
	Character stream device.
#define	IFTYP_CAN 6
	CAN device.
#define	IFTYP_FS 16
	file system device
#define	NUTFILE_EOF ((NUTFILE *)(-1))
Typedefs
typedef _NUTDEVICE	NUTDEVICE
	Device structure type.
typedef _NUTVIRTUALDEVICE	NUTVIRTUALDEVICE
	Device structure type.
typedef _IFSTREAM	IFSTREAM
	Stream interface type.
typedef _NUTFILE	NUTFILE
	File structure type.
Functions
NUTDEVICE *	NutDeviceLookup (CONST char *name)
	Find device entry by name.
int	NutRegisterDevice (NUTDEVICE *dev, uptr_t base, u_char irq)
	Register and initialize a device.
int	NullIOCTL (NUTDEVICE dev, int req, void conf)
	Perform control functions.
Variables
NUTDEVICE *	nutDeviceList = 0
	Linked list of all registered devices.
NUTDEVICE	devNull
	Null device information structure.

Function Documentation

NUTDEVICE* NutDeviceLookup

(

CONST char *

name

)

Find device entry by name.

Parameters:

name

Unique device name.

Returns:: Pointer to the NUTDEVICE structure.

int NutRegisterDevice	(	NUTDEVICE *	dev,
		uptr_t	base,
		u_char	irq
	)

Initializes the device and adds it to the system device list. Applications should call this function during initialization for each device they intend to use.

Parameters:

	dev	Pointer to the NUTDEVICE structure, which is provided by the device driver. This structure contains a hardware device name, which must be unique among all registered devices. Drivers may operate in a different mode using the same hardware, like interrupt driven or polling UART drivers. Only one of those drivers can be registered, because they specify the same hardware device name.
	base	Hardware base address of this device. Set to 0, if the device driver has a fixed hardware address.
	irq	Hardware interrupt used by this device. Set to 0, if the device driver doesn't support configurable interupts.

Returns:: 0 if the device has been registered for the first time and initialization was successful. The function returns -1 if any device with the same name had been registered previously, if the NUTDEVICE structure is invalid or if the device initialization failed.

int NullIOCTL	(	NUTDEVICE *	dev,
		int	req,
		void *	conf
	)

Perform control functions.

This function is called by the ioctl() function of the C runtime library.

Parameters:

	dev	Identifies the device that receives the device-control function.
	req	Requested control function. We do return ok for any function
	conf	Points to a buffer that contains any data required for the given control function or receives data from that function.

Returns:: 0 on success, -1 otherwise.

Variable Documentation

NUTDEVICE devNull

Initial value:

 {
    0,                          
    {'n', 'u', 'l', 'l', 0, 0, 0, 0, 0},
                                
    0,                          
    0,                          
    0,                          
    0,                          

    0,                          
    0,                          
    
    NullIOCTL,                  
    NullRead,
    NullWrite,

    NullWriteP,

    NullOpen,
    NullClose,
    0
}

Null device information structure.

Device Management [Nut/OS API]

Detailed Description

Data Structures

Defines

Typedefs

Functions

Variables

Function Documentation

Variable Documentation

Device Management
[Nut/OS API]