Subversion Repositories HelenOS

Compare Revisions

Ignore whitespace Rev 3911 → Rev 3912

/branches/network/uspace/srv/net/netif/netif.h
1,5 → 1,5
/*
* Copyright (c) 2008 Lukas Mejdrech
* Copyright (c) 2009 Lukas Mejdrech
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
26,12 → 26,12
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
/** @addtogroup net
* @{
/** @addtogroup netif
* @{
*/
 
/**
* @file
/** @file
* Network interface module skeleton.
*/
 
#ifndef __NET_NETIF_H__
39,31 → 39,88
 
#include "device.h"
 
#define nil_message( device, message, arg2, arg3, result1, result2, result3 ) \
/** Sends the notification message to the registered network interface layer module.
* Wrapper of the async_msg_3().
* The first message argument is always the device identifier.
* @param device The device specific data. Input parameter.
* @param message The message to be sent. Input parameter.
* @param arg2 The second message argument. Input parameter.
* @param arg3 The third message argument. Input parameter.
*/
#define nil_message( device, message, arg2, arg3 ) \
if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 )
 
typedef struct device device_t;
typedef device_t * device_ref;
/** Network interface module skeleton global data.
*/
typedef struct netif_globals netif_globals_t;
 
/** Type definition of the device specific data.
* @see netif_device
*/
typedef struct netif_device device_t;
 
/** Type definition of the device specific data pointer.
* @see netif_device
*/
typedef device_t * device_ref;
 
/** Device map.
* Maps device identifiers to the network interface device specific data.
* @see device.h
*/
DEVICE_MAP_DECLARE( device_map, device_t );
 
struct device{
/** Network interface device specific data.
*/
struct netif_device{
/** Device identifier.
*/
device_id_t device_id;
/** Receiving network interface layer phone.
*/
int nil_phone;
/** Usage statistics.
*/
device_stats_t stats;
/** Actual device state.
*/
device_state_t state;
// TODO needed?
/** Various device flags.
*/
int flags;
/** Maximum transmission unit.
* The maximum packet content to be transmited.
*/
size_t mtu;
/** Driver specific data.
*/
void * specific;
};
 
/** Network interface module skeleton global data.
*/
struct netif_globals{
/** Networking module phone.
*/
int networking_phone;
/** Device map.
*/
device_map_t device_map;
};
 
/** Finds the device specific data.
* @param device_id The device identifier. Input parameter.
* @param device The device specific data. Output parameter.
* @returns EOK on success.
* @returns ENOENT if device is not found.
* @returns EPERM if the device is not initialized.
*/
int find_device( device_id_t device_id, device_ref * device );
 
/** Clears the usage statistics.
* @param stats The usage statistics. Input parameter.
*/
void null_device_stats( device_stats_ref stats );
 
#endif