Device Management
[Nut/OS API]

Device driver support. More...

Collaboration diagram for Device Management:

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...

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_BLKIO   7
 Block I/O device.
#define IFTYP_FS   16
 file system device
#define NUTFILE_EOF   ((NUTFILE *)(-1))

Functions

NUTDEVICE * NutDeviceLookup (CONST char *name)
 Find device entry by name.
int NutRegisterDevice (NUTDEVICE *dev, uintptr_t base, uint8_t 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.

Detailed Description

Device driver support.


Define Documentation

#define IFTYP_RAM   0

RAM device.

Definition at line 135 of file device.h.

#define IFTYP_ROM   1

ROM device.

Definition at line 136 of file device.h.

#define IFTYP_STREAM   2

Stream device.

Definition at line 137 of file device.h.

Referenced by AceInit(), and UartAvrInit().

#define IFTYP_NET   3

Net device.

Definition at line 138 of file device.h.

Referenced by AhdlcAt91IOCtl(), AhdlcAvrIOCtl(), NutDhcpIfConfig(), NutIpOutput(), and NutNetIfConfig2().

#define IFTYP_TCPSOCK   4

TCP socket.

Definition at line 139 of file device.h.

Referenced by NutTcpCreateSocket().

#define IFTYP_CHAR   5

Character stream device.

Definition at line 140 of file device.h.

Referenced by AhdlcAt91IOCtl(), and AhdlcAvrIOCtl().

#define IFTYP_CAN   6

CAN device.

Definition at line 141 of file device.h.

#define IFTYP_BLKIO   7

Block I/O device.

Definition at line 142 of file device.h.

#define IFTYP_FS   16

file system device

Definition at line 143 of file device.h.

Referenced by MmCardMount(), NutBlockDeviceOpen(), and SpiMmcMount().

#define NUTFILE_EOF   ((NUTFILE *)(-1))

Function Documentation

NUTDEVICE* NutDeviceLookup ( CONST char *  name  ) 

Find device entry by name.

Parameters:
name Unique device name.
Returns:
Pointer to the NUTDEVICE structure.

Definition at line 90 of file devreg.c.

References NUTASSERT, nutDeviceList, and strcmp().

Referenced by _open(), NutBlockDeviceOpen(), NutDhcpIfConfig(), NutNetIfConfig2(), NutRegisterDevice(), opendir(), rename(), and stat().

int NutRegisterDevice ( NUTDEVICE *  dev,
uintptr_t  base,
uint8_t  irq 
)

Register and initialize a device.

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.

Definition at line 129 of file devreg.c.

References NUTASSERT, nutDeviceList, and NutDeviceLookup().

Referenced by InitDebugDevice(), main(), and NutRegisterSpiDevice().

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.

Definition at line 136 of file null.c.


Variable Documentation

NUTDEVICE* nutDeviceList = 0

Linked list of all registered devices.

Definition at line 81 of file devreg.c.

Referenced by MmCardMount(), NutDeviceLookup(), NutIpOutput(), NutRegisterDevice(), and SpiMmcMount().

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.

Definition at line 145 of file null.c.


© 2000-2010 by contributors - visit http://www.ethernut.de/