Subversion Repositories HelenOS

Rev

Rev 3846 | Rev 4192 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 3846 Rev 3912
Line 1... Line 1...
1 
/*
 1 
/*
2 
 * Copyright (c) 2008 Lukas Mejdrech
 2 
 * Copyright (c) 2009 Lukas Mejdrech
3 
 * All rights reserved.
 3 
 * All rights reserved.
4 
 *
 4 
 *
5 
 * Redistribution and use in source and binary forms, with or without
 5 
 * Redistribution and use in source and binary forms, with or without
6 
 * modification, are permitted provided that the following conditions
 6 
 * modification, are permitted provided that the following conditions
7 
 * are met:
 7 
 * are met:
Line 24... Line 24...
24 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 24 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 25 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 26 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
 */
 27 
 */
28 
 
 28 
 
29 
/** @addtogroup net
 29 
/** @addtogroup netif
30 
 * @{
 30 
 *  @{
31 
 */
 31 
 */
32 
 
 32 
 
33 
/**
 - 
 
34 
 * @file
 33 
/** @file
- 
 
 34 
 *  Network interface module skeleton.
35 
 */
 35 
 */
36 
 
 36 
 
37 
#ifndef __NET_NETIF_H__
 37 
#ifndef __NET_NETIF_H__
38 
#define __NET_NETIF_H__
 38 
#define __NET_NETIF_H__
39 
 
 39 
 
40 
#include "device.h"
 40 
#include "device.h"
41 
 
 41 
 
- 
 
 42 
/** Sends the notification message to the registered network interface layer module.
- 
 
 43 
 *  Wrapper of the async_msg_3().
- 
 
 44 
 *  The first message argument is always the device identifier.
- 
 
 45 
 *  @param device The device specific data. Input parameter.
- 
 
 46 
 *  @param message The message to be sent. Input parameter.
- 
 
 47 
 *  @param arg2 The second message argument. Input parameter.
- 
 
 48 
 *  @param arg3 The third message argument. Input parameter.
- 
 
 49 
 */
42 
#define nil_message( device, message, arg2, arg3, result1, result2, result3 )   \
 50 
#define nil_message( device, message, arg2, arg3 )  \
43 
    if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 )
 51 
    if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 )
44 
 
 52 
 
45 
typedef struct device       device_t;
 53 
/** Network interface module skeleton global data.
46 
typedef device_t *      device_ref;
 54 
 */
47 
typedef struct netif_globals    netif_globals_t;
 55 
typedef struct netif_globals    netif_globals_t;
48 
 
 56 
 
- 
 
 57 
/** Type definition of the device specific data.
- 
 
 58 
 *  @see netif_device
- 
 
 59 
 */
- 
 
 60 
typedef struct netif_device device_t;
- 
 
 61 
 
- 
 
 62 
/** Type definition of the device specific data pointer.
- 
 
 63 
 *  @see netif_device
- 
 
 64 
 */
- 
 
 65 
typedef device_t *          device_ref;
- 
 
 66 
 
- 
 
 67 
/** Device map.
- 
 
 68 
 *  Maps device identifiers to the network interface device specific data.
- 
 
 69 
 *  @see device.h
- 
 
 70 
 */
49 
DEVICE_MAP_DECLARE( device_map, device_t );
 71 
DEVICE_MAP_DECLARE( device_map, device_t );
50 
 
 72 
 
- 
 
 73 
/** Network interface device specific data.
- 
 
 74 
 */
51 
struct  device{
 75 
struct  netif_device{
- 
 
 76 
    /** Device identifier.
- 
 
 77 
     */
52 
    device_id_t device_id;
 78 
    device_id_t device_id;
- 
 
 79 
    /** Receiving network interface layer phone.
- 
 
 80 
     */
53 
    int     nil_phone;
 81 
    int     nil_phone;
- 
 
 82 
    /** Usage statistics.
- 
 
 83 
     */
54 
    device_stats_t  stats;
 84 
    device_stats_t  stats;
- 
 
 85 
    /** Actual device state.
- 
 
 86 
     */
55 
    device_state_t  state;
 87 
    device_state_t  state;
- 
 
 88 
//  TODO needed?
- 
 
 89 
    /** Various device flags.
- 
 
 90 
     */
56 
    int     flags;
 91 
    int     flags;
- 
 
 92 
    /** Maximum transmission unit.
- 
 
 93 
     *  The maximum packet content to be transmited.
- 
 
 94 
     */
57 
    size_t      mtu;
 95 
    size_t      mtu;
- 
 
 96 
    /** Driver specific data.
- 
 
 97 
     */
58 
    void *      specific;
 98 
    void *      specific;
59 
};
 99 
};
60 
 
 100 
 
- 
 
 101 
/** Network interface module skeleton global data.
- 
 
 102 
 */
61 
struct  netif_globals{
 103 
struct  netif_globals{
- 
 
 104 
    /** Networking module phone.
- 
 
 105 
     */
62 
    int     networking_phone;
 106 
    int     networking_phone;
- 
 
 107 
    /** Device map.
- 
 
 108 
     */
63 
    device_map_t    device_map;
 109 
    device_map_t    device_map;
64 
};
 110 
};
65 
 
 111 
 
- 
 
 112 
/** Finds the device specific data.
- 
 
 113 
 *  @param device_id The device identifier. Input parameter.
- 
 
 114 
 *  @param device The device specific data. Output parameter.
- 
 
 115 
 *  @returns EOK on success.
- 
 
 116 
 *  @returns ENOENT if device is not found.
- 
 
 117 
 *  @returns EPERM if the device is not initialized.
- 
 
 118 
 */
66 
int find_device( device_id_t device_id, device_ref * device );
 119 
int find_device( device_id_t device_id, device_ref * device );
- 
 
 120 
 
- 
 
 121 
/** Clears the usage statistics.
- 
 
 122 
 *  @param stats The usage statistics. Input parameter.
- 
 
 123 
 */
67 
void    null_device_stats( device_stats_ref stats );
 124 
void    null_device_stats( device_stats_ref stats );
68 
 
 125 
 
69 
#endif
 126 
#endif
70 
 
 127 
 
71 
/** @}
 128 
/** @}